OptionsType
OptionsType =
object
Defined in: packages/synapse-core/src/pay/set-operator-approval.ts:25
Properties
Section titled “Properties”approve
Section titled “approve”approve:
boolean
Defined in: packages/synapse-core/src/pay/set-operator-approval.ts:31
Whether to approve (true) or revoke (false) the operator.
contractAddress?
Section titled “contractAddress?”
optionalcontractAddress?:Address
Defined in: packages/synapse-core/src/pay/set-operator-approval.ts:39
Payments contract address. If not provided, the default is the payments contract address for the chain.
lockupAllowance?
Section titled “lockupAllowance?”
optionallockupAllowance?:bigint
Defined in: packages/synapse-core/src/pay/set-operator-approval.ts:35
Maximum lockup amount the operator can use (in token base units). Defaults to maxUint256 when approving, 0n when revoking.
maxLockupPeriod?
Section titled “maxLockupPeriod?”
optionalmaxLockupPeriod?:bigint
Defined in: packages/synapse-core/src/pay/set-operator-approval.ts:37
Maximum lockup period in epochs the operator can set for payment rails. Defaults to the chain’s getPriceList().lockups.defaultLockupPeriod when approving, 0n when revoking.
operator?
Section titled “operator?”
optionaloperator?:Address
Defined in: packages/synapse-core/src/pay/set-operator-approval.ts:29
The address of the operator to approve/revoke. If not provided, the Warm Storage contract address will be used.
rateAllowance?
Section titled “rateAllowance?”
optionalrateAllowance?:bigint
Defined in: packages/synapse-core/src/pay/set-operator-approval.ts:33
Maximum rate the operator can use per epoch (in token base units). Defaults to maxUint256 when approving, 0n when revoking.
token?
Section titled “token?”
optionaltoken?:Address
Defined in: packages/synapse-core/src/pay/set-operator-approval.ts:27
The address of the ERC20 token. If not provided, the USDFC token address will be used.