DepositAndApproveOptions
DepositAndApproveOptions =
object
Defined in: packages/synapse-core/src/pay/payments.ts:25
Properties
Section titled “Properties”address?
Section titled “address?”
optionaladdress?:Address
Defined in: packages/synapse-core/src/pay/payments.ts:45
The address of the account to deposit from. If not provided, the client account address will be used.
amount
Section titled “amount”amount:
bigint
Defined in: packages/synapse-core/src/pay/payments.ts:29
The amount to deposit.
deadline?
Section titled “deadline?”
optionaldeadline?:bigint
Defined in: packages/synapse-core/src/pay/payments.ts:49
The deadline of the permit. If not provided, the deadline will be set to 1 hour from now.
lockupAllowance?
Section titled “lockupAllowance?”
optionallockupAllowance?:bigint
Defined in: packages/synapse-core/src/pay/payments.ts:57
The lockup allowance to approve. If not provided, the maxUint256 will be used.
maxLockupPeriod?
Section titled “maxLockupPeriod?”
optionalmaxLockupPeriod?:bigint
Defined in: packages/synapse-core/src/pay/payments.ts:62
The max lockup period to approve. If not provided, the chain’s
getPriceList().lockups.defaultLockupPeriod will be used.
operator?
Section titled “operator?”
optionaloperator?:Address
Defined in: packages/synapse-core/src/pay/payments.ts:33
The address of the operator to approve.
rateAllowance?
Section titled “rateAllowance?”
optionalrateAllowance?:bigint
Defined in: packages/synapse-core/src/pay/payments.ts:53
The rate allowance to approve. If not provided, the maxUint256 will be used.
spender?
Section titled “spender?”
optionalspender?:Address
Defined in: packages/synapse-core/src/pay/payments.ts:41
The address of the spender to approve. If not provided, the payments contract address will be used.
token?
Section titled “token?”
optionaltoken?:Address
Defined in: packages/synapse-core/src/pay/payments.ts:37
The address of the token to deposit. If not provided, the USDFC token address will be used.