OptionsType
OptionsType =
object
Defined in: packages/synapse-core/src/pay/withdraw.ts:26
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/synapse-core/src/pay/withdraw.ts:30
The amount to withdraw (in token base units). Must be greater than 0.
contractAddress?
Section titled “contractAddress?”
optionalcontractAddress?:Address
Defined in: packages/synapse-core/src/pay/withdraw.ts:32
Payments contract address. If not provided, the default is the payments contract address for the chain.
token?
Section titled “token?”
optionaltoken?:Address
Defined in: packages/synapse-core/src/pay/withdraw.ts:28
The address of the ERC20 token to withdraw. If not provided, the USDFC token address will be used.