Skip to content

Fix typos and broken links in docs #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jayadiki wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix typos and broken links in docs #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The protocol provides six main functions that handle the complete payment lifecy
- **[Capture](operations/Capture.md)** - Transfer previously authorized funds from escrow to merchants. Supports partial captures and flexible fee distribution.

### Payment Cancellation
- **[Void](operations/Void.md)** - Cancel payment authorizations and return escrowed funds to payerss. Only callable by the operator, but can be used to cancel a payment at any time.
- **[Void](operations/Void.md)** - Cancel payment authorizations and return escrowed funds to payers. Only callable by the operator, but can be used to cancel a payment at any time.

- **[Reclaim](operations/Reclaim.md)** - Allow payers to recover funds from expired authorizations. Payer-initiated safety mechanism callable only after authorization expiry.

Expand Down
2 changes: 1 addition & 1 deletion docs/operations/Authorize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Track authorizations using the `paymentInfoHash` which uniquely identifies each
| `ExceedsMaxAmount` | Amount exceeds paymentInfo.maxAmount |
| `AfterPreApprovalExpiry` | Called after signature expiry |
| `InvalidExpiries` | Expiry timestamps are improperly ordered |
| `FeeBpsOverFlow` | maxFeeBps exceeds maximum value |
| `FeeBpsOverflow` | maxFeeBps exceeds maximum value |
| `InvalidFeeBpsRange` | minFeeBps exceeds maxFeeBps |
| `PaymentAlreadyCollected` | Payment already authorized or charged |
| `InvalidCollectorForOperation` | Wrong collector type specified |
Expand Down
2 changes: 1 addition & 1 deletion docs/operations/Capture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ function capture(
```

### Process Flow
1. **Fee Validation**: Ensures fee parameters are within allowed ranges and recipient is valid (see [Fees](Fees.md))
1. **Fee Validation**: Ensures fee parameters are within allowed ranges and recipient is valid (see [Fees](../Fees.md))
2. **Timing Check**: Verifies capture occurs before authorization expiry
3. **Availability Check**: Confirms sufficient authorized funds are available
4. **State Update**: Reduces `capturableAmount` and increases `refundableAmount` by captured `amount`
Expand Down
4 changes: 2 additions & 2 deletions docs/operations/Charge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ function charge(

### Process Flow
1. **Payment Validation**: Ensures payment info is valid and timing constraints are met
2. **Fee Validation**: Confirms fee parameters are within allowed ranges (see [Fees](Fees.md))
2. **Fee Validation**: Confirms fee parameters are within allowed ranges (see [Fees](../Fees.md))
3. **Uniqueness Check**: Verifies this payment hasn't already been collected
4. **State Update**: Records payment as collected with `refundableAmount`
5. **Token Collection**: Uses token collector to pull funds from payer
Expand Down Expand Up @@ -100,7 +100,7 @@ The `PaymentCharged` event includes more details than `PaymentCaptured` since it
| `ExceedsMaxAmount` | Amount exceeds paymentInfo.maxAmount |
| `AfterPreApprovalExpiry` | Called after signature expiry |
| `InvalidExpiries` | Expiry timestamps are improperly ordered |
| `FeeBpsOverFlow` | maxFeeBps exceeds maximum value |
| `FeeBpsOverflow` | maxFeeBps exceeds maximum value |
| `InvalidFeeBpsRange` | minFeeBps exceeds maxFeeBps |
| `FeeBpsOutOfRange` | Fee outside min/max range |
| `ZeroFeeReceiver` | Fee recipient is zero address with non-zero fee |
Expand Down