DepositOptions
Defined in: packages/synapse-sdk/src/payments/service.ts:23
Options for deposit operation
Properties
Section titled “Properties”onAllowanceCheck()?
Section titled “onAllowanceCheck()?”optional onAllowanceCheck: (current, required) => void;Defined in: packages/synapse-sdk/src/payments/service.ts:27
Called when checking current allowance
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
current | bigint |
required | bigint |
Returns
Section titled “Returns”void
onApprovalConfirmed()?
Section titled “onApprovalConfirmed()?”optional onApprovalConfirmed: (receipt) => void;Defined in: packages/synapse-sdk/src/payments/service.ts:31
Called when approval is confirmed
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
receipt | TransactionReceipt |
Returns
Section titled “Returns”void
onApprovalTransaction()?
Section titled “onApprovalTransaction()?”optional onApprovalTransaction: (tx) => void;Defined in: packages/synapse-sdk/src/payments/service.ts:29
Called when approval transaction is sent
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
tx | TransactionResponse |
Returns
Section titled “Returns”void
onDepositStarting()?
Section titled “onDepositStarting()?”optional onDepositStarting: () => void;Defined in: packages/synapse-sdk/src/payments/service.ts:33
Called before deposit transaction is sent
Returns
Section titled “Returns”void
optional to: string;Defined in: packages/synapse-sdk/src/payments/service.ts:25
Optional recipient address (defaults to signer address if not provided)