Skip to content

OptionsType

OptionsType = object

Defined in: packages/synapse-core/src/pay/set-operator-approval.ts:25

approve: boolean

Defined in: packages/synapse-core/src/pay/set-operator-approval.ts:31

Whether to approve (true) or revoke (false) the operator.


optional contractAddress?: 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.


optional lockupAllowance?: 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.


optional maxLockupPeriod?: 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.


optional operator?: 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.


optional rateAllowance?: 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.


optional token?: 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.