Skip to content

Payments Contract Operations

import * as Pay from '@filoz/synapse-core/pay'
NamespaceDescription
accounts-
accountsCall-
deposit-
depositCall-
depositSync-
getRail-
getRailCall-
getRailsForPayeeAndToken-
getRailsForPayeeAndTokenCall-
getRailsForPayerAndToken-
getRailsForPayerAndTokenCall-
operatorApprovals-
operatorApprovalsCall-
setOperatorApproval-
setOperatorApprovalCall-
setOperatorApprovalSync-
settleRail-
settleRailCall-
settleRailSync-
settleTerminatedRailWithoutValidation-
settleTerminatedRailWithoutValidationCall-
settleTerminatedRailWithoutValidationSync-
withdraw-
withdrawCall-
withdrawSync-
Type AliasDescription
DepositAndApproveOptions-
FunctionDescription
accountsGet account information from the Filecoin Pay contract
accountsCallCreate a call to the accounts function
depositDeposit funds into the Filecoin Pay contract
depositAndApproveDeposit funds to the payments contract and approve an operator.
depositCallCreate a call to the deposit function
depositSyncDeposit funds into the Filecoin Pay contract and wait for confirmation
extractDepositEventExtracts the DepositRecorded event from transaction logs
extractSetOperatorApprovalEventExtracts the OperatorApprovalUpdated event from transaction logs
extractSettleRailEventExtracts the RailSettled event from transaction logs
extractSettleTerminatedRailWithoutValidationEventExtracts the RailSettled event from transaction logs
extractWithdrawEventExtracts the WithdrawRecorded event from transaction logs
getRailGet rail information from the Filecoin Pay contract
getRailCallCreate a call to the getRail function
getRailsForPayeeAndTokenGet rails for a payee and token with pagination
getRailsForPayeeAndTokenCallCreate a call to the getRailsForPayeeAndToken function
getRailsForPayerAndTokenGet rails for a payer and token with pagination
getRailsForPayerAndTokenCallCreate a call to the getRailsForPayerAndToken function
operatorApprovalsGet operator approval information from the Filecoin Pay contract
operatorApprovalsCallCreate a call to the operatorApprovals function
parseAccountsParse the contract output into the accounts output type
parseGetRailsForPayeeAndTokenParse the contract output into the getRailsForPayeeAndToken output type
parseGetRailsForPayerAndTokenParse the contract output into the getRailsForPayerAndToken output type
parseOperatorApprovalsParse the contract output into the operatorApprovals output type
setOperatorApprovalSet operator approval on the Filecoin Pay contract
setOperatorApprovalCallCreate a call to the setOperatorApproval function
setOperatorApprovalSyncSet operator approval on the Filecoin Pay contract and wait for confirmation
settleRailSettle a payment rail up to a specific epoch
settleRailCallCreate a call to the settleRail function
settleRailSyncSettle a payment rail up to a specific epoch and wait for confirmation
settleTerminatedRailWithoutValidationSettle a terminated payment rail without validation
settleTerminatedRailWithoutValidationCallCreate a call to the settleTerminatedRailWithoutValidation function
settleTerminatedRailWithoutValidationSyncSettle a terminated payment rail without validation and wait for confirmation
withdrawWithdraw funds from the Filecoin Pay contract
withdrawCallCreate a call to the withdraw function
withdrawSyncWithdraw funds from the Filecoin Pay contract and wait for confirmation