ApproveOperatorProps

ApproveOperatorProps = { lockupAllowance?: bigint; maxLockupPeriod?: bigint; mutation?: Omit<MutateOptions<TransactionReceipt, Error>, "mutationFn">; onHash?: (hash) => void; operator?: Address; rateAllowance?: bigint; token?: Address; } | undefined

Defined in: synapse-react/src/payments/index.ts:214

Union Members

Type Literal

{ lockupAllowance?: bigint; maxLockupPeriod?: bigint; mutation?: Omit<MutateOptions<TransactionReceipt, Error>, "mutationFn">; onHash?: (hash) => void; operator?: Address; rateAllowance?: bigint; token?: Address; }

lockupAllowance?

optional lockupAllowance?: bigint

Maximum lockup amount the operator can use (in token base units). If not provided, maxUint256 will be used.

maxLockupPeriod?

optional maxLockupPeriod?: bigint

Maximum lockup period in epochs the operator can set for payment rails. If not provided, the chain’s default lockup period will be used.

mutation?

optional mutation?: Omit<MutateOptions<TransactionReceipt, Error>, "mutationFn">

The mutation options.

onHash?

optional onHash?: (hash) => void

Parameters

Parameter	Type
hash	string

Returns

void

operator?

optional operator?: Address

The address of the operator to approve. If not provided, the operator will be the Warm Storage contract.

rateAllowance?

optional rateAllowance?: bigint

Maximum rate the operator can use per epoch (in token base units). If not provided, maxUint256 will be used.

token?

optional token?: Address

The address of the ERC20 token to query. If not provided, the USDFC token address will be used.

---

undefined