Class SpendController

Index

Accessors

isAllowed lastReset recurringLimit spendLimit window

Methods

canSpend canSpendMax get max none once recurring

Accessors

isAllowed

get isAllowed(): boolean
Returns boolean
- Defined in classic/src/actions/control.ts:7

lastReset

get lastReset(): undefined | bigint
Returns undefined | bigint
- Defined in classic/src/actions/control.ts:24

recurringLimit

get recurringLimit(): undefined | bigint
Returns undefined | bigint
- Defined in classic/src/actions/control.ts:28

spendLimit

get spendLimit(): null | bigint
max spendable amount.

returns null if there is no limit

Returns null | bigint
- Defined in classic/src/actions/control.ts:15

window

get window(): null | bigint
Returns null | bigint
- Defined in classic/src/actions/control.ts:20

Methods

canSpend

canSpend(amount?: bigint): boolean
Check if allowed to spend a given amount, or spend at all if no amount is provided
Parameters
- Optionalamount: bigint
  Token amount
Returns boolean
boolean
- Defined in classic/src/actions/control.ts:45

canSpendMax

canSpendMax(): boolean
Check if a spend in uncapped

Returns boolean
boolean
- Defined in classic/src/actions/control.ts:36

`Static`get

get(action: ActionPayload): SpendController
Parameters
- action: ActionPayload
Returns SpendController
- Defined in classic/src/actions/control.ts:55

`Static`max

max(): SpendController
Spend Max controller

Returns SpendController
- Defined in classic/src/actions/control.ts:90

`Static`none

none(): SpendController
Returns SpendController
- Defined in classic/src/actions/control.ts:80

`Static`once

once(amount: bigint): SpendController
Spend Once controller
Parameters
- amount: bigint
Returns SpendController
- Defined in classic/src/actions/control.ts:100

`Static`recurring

recurring(
    args: {
        amount: bigint;
        lastReset: bigint;
        recurringAmount: bigint;
        window: bigint;
    },
): SpendController
Spend Recurring controller
Parameters
- args: { amount: bigint; lastReset: bigint; recurringAmount: bigint; window: bigint }
Returns SpendController
- Defined in classic/src/actions/control.ts:110