| accounts |
Get account information from the Filecoin Pay contract |
| accountsCall |
Create a call to the accounts function |
| calculateAccountDebt |
Compute account debt — the unsettled lockup amount exceeding available funds. |
| deposit |
Deposit funds into the Filecoin Pay contract |
| depositAndApprove |
Deposit funds to the payments contract and approve an operator. |
| depositCall |
Create a call to the deposit function |
| depositSync |
Deposit funds into the Filecoin Pay contract and wait for confirmation |
| depositWithPermit |
Deposit funds into the Filecoin Pay contract using an ERC-2612 permit |
| depositWithPermitSync |
Deposit funds using an ERC-2612 permit and wait for confirmation |
| extractDepositEvent |
Extracts the DepositRecorded event from transaction logs |
| extractDepositWithPermitEvent |
Extracts the DepositRecorded event from transaction logs |
| extractSetOperatorApprovalEvent |
Extracts the OperatorApprovalUpdated event from transaction logs |
| extractSettleRailEvent |
Extracts the RailSettled event from transaction logs |
| extractSettleTerminatedRailWithoutValidationEvent |
Extracts the RailSettled event from transaction logs |
| extractWithdrawEvent |
Extracts the WithdrawRecorded event from transaction logs |
| fund |
Smart deposit that picks the right contract call based on FWSS approval state |
| fundSync |
Smart deposit and wait for confirmation |
| getAccountSummary |
Get a comprehensive account summary from the Payments contract. |
| getRail |
Get rail information from the Filecoin Pay contract |
| getRailCall |
Create a call to the getRail function |
| getRailsForPayeeAndToken |
Get one bounded page of rails for a payee and token. |
| getRailsForPayeeAndTokenCall |
Create a call to the getRailsForPayeeAndToken function |
| getRailsForPayerAndToken |
Get one bounded page of rails for a payer and token. |
| getRailsForPayerAndTokenCall |
Create a call to the getRailsForPayerAndToken function |
| isFwssMaxApproved |
Check whether FWSS is approved with sufficient rate/lockup allowances and a maxLockupPeriod covering the chain’s default lockup period. |
| operatorApprovals |
Get operator approval information from the Filecoin Pay contract |
| operatorApprovalsCall |
Create a call to the operatorApprovals function |
| parseAccounts |
Parse the contract output into the accounts output type |
| parseGetRailsForPayeeAndToken |
Parse raw payee-rail contract output into a normalized page with a total. |
| parseGetRailsForPayerAndToken |
Parse raw payer-rail contract output into a normalized page with a total. |
| parseOperatorApprovals |
Parse the contract output into the operatorApprovals output type |
| resolveAccountState |
Project account state forward to currentEpoch by simulating settlement locally. |
| setOperatorApproval |
Set operator approval on the Filecoin Pay contract |
| setOperatorApprovalCall |
Create a call to the setOperatorApproval function |
| setOperatorApprovalSync |
Set operator approval on the Filecoin Pay contract and wait for confirmation |
| settleRail |
Settle a payment rail up to a specific epoch |
| settleRailCall |
Create a call to the settleRail function |
| settleRailSync |
Settle a payment rail up to a specific epoch and wait for confirmation |
| settleTerminatedRailWithoutValidation |
Settle a terminated payment rail without validation |
| settleTerminatedRailWithoutValidationCall |
Create a call to the settleTerminatedRailWithoutValidation function |
| settleTerminatedRailWithoutValidationSync |
Settle a terminated payment rail without validation and wait for confirmation |
| totalAccountFixedLockup |
Get the total fixed lockup across all rails for an account. |
| withdraw |
Withdraw funds from the Filecoin Pay contract |
| withdrawCall |
Create a call to the withdraw function |
| withdrawSync |
Withdraw funds from the Filecoin Pay contract and wait for confirmation |
