Class ActionsBuilder

Utility class for composing actions

Index

Methods

all allButManageAuthority get manageAuthority programAll programCurated programLimit programScopeBasic programScopeLimit programScopeRecurringLimit solLimit solRecurringLimit stakeAll stakeLimit stakeRecurringLimit subAccount tokenLimit tokenRecurringLimit new

Methods

all

all(): this
Enable root action

Returns this
- Defined in lib/dist/index.d.ts:112

allButManageAuthority

allButManageAuthority(): this
Enable AllButMangeAuthority action

Returns this
- Defined in lib/dist/index.d.ts:120

get

get(): Actions
Gets the composed actions

Returns Actions
Actions
- Defined in lib/dist/index.d.ts:107

manageAuthority

manageAuthority(): this
Enable Manager action

Returns this
- Defined in lib/dist/index.d.ts:116

programAll

programAll(): this
Enable all programs

Returns this
- Defined in lib/dist/index.d.ts:131

programCurated

programCurated(): this
Enable curated programs

Returns this
- Defined in lib/dist/index.d.ts:135

programLimit

programLimit(payload: { programId: SolPublicKeyData }): this
Enable a program scope
Parameters
- payload: { programId: SolPublicKeyData }
  - programId: SolPublicKeyData
    ID of the program to enable
Returns this
- Defined in lib/dist/index.d.ts:125

programScopeBasic

programScopeBasic(
    payload: {
        programId: SolPublicKeyData;
        targetAccount: SolPublicKeyData;
    },
): this
Basic program scope
Parameters
- payload: { programId: SolPublicKeyData; targetAccount: SolPublicKeyData }
  - programId: SolPublicKeyData
    Program ID
  - targetAccount: SolPublicKeyData
    Program Account to target
Returns this
Basic ProgramScope action
- Defined in lib/dist/index.d.ts:142

programScopeLimit

programScopeLimit(
    payload: {
        amount: bigint;
        numericType: NumericType;
        programId: SolPublicKeyData;
        targetAccount: SolPublicKeyData;
    },
): this
Limit ProgramScope
Parameters
- payload: {
      amount: bigint;
      numericType: NumericType;
      programId: SolPublicKeyData;
      targetAccount: SolPublicKeyData;
  }
  - amount: bigint
    Max amount spendable
  - numericType: NumericType
    Numeric type of the amount. i.e u8, u32, u64 or u128
  - programId: SolPublicKeyData
    Program ID
  - targetAccount: SolPublicKeyData
    Program Account to target
Returns this
Limit ProgramScope
- Defined in lib/dist/index.d.ts:154

programScopeRecurringLimit

programScopeRecurringLimit(
    payload: {
        amount: bigint;
        numericType: NumericType;
        programId: SolPublicKeyData;
        targetAccount: SolPublicKeyData;
        window: bigint;
    },
): this
RecurringLimit ProgramScope
Parameters
- payload: {
      amount: bigint;
      numericType: NumericType;
      programId: SolPublicKeyData;
      targetAccount: SolPublicKeyData;
      window: bigint;
  }
  - amount: bigint
    Max amount spendable
  - numericType: NumericType
    Numeric type of the amount. i.e u8, u32, u64 or u128
  - programId: SolPublicKeyData
    Program ID
  - targetAccount: SolPublicKeyData
    Program Account to target
  - window: bigint
    Duration in slot between limits reset
Returns this
RecurringLimit ProgramScope
- Defined in lib/dist/index.d.ts:169

solLimit

solLimit(payload: { amount: bigint }): this
Enables a Spend-once SOL Spend
Parameters
- payload: { amount: bigint }
  - amount: bigint
    ID of the program to enable
Returns this
- Defined in lib/dist/index.d.ts:204

solRecurringLimit

solRecurringLimit(payload: { recurringAmount: bigint; window: bigint }): this
Enables a Spend-recurring SOL Spend
Parameters
- payload: { recurringAmount: bigint; window: bigint }
  - recurringAmount: bigint
    recurring amount per window
  - window: bigint
    period in slots until amount reset.
Returns this
- Defined in lib/dist/index.d.ts:212

stakeAll

stakeAll(): this
Enables a StakeAll action

Returns this
- Defined in lib/dist/index.d.ts:183

stakeLimit

stakeLimit(payload: { amount: bigint }): this
Enables a Spend-once SOL Spend
Parameters
- payload: { amount: bigint }
  - amount: bigint
    ID of the program to enable
Returns this
- Defined in lib/dist/index.d.ts:188

stakeRecurringLimit

stakeRecurringLimit(payload: { recurringAmount: bigint; window: bigint }): this
Enables a Spend-recurring SOL Spend
Parameters
- payload: { recurringAmount: bigint; window: bigint }
  - recurringAmount: bigint
    recurring amount per window
  - window: bigint
    period in slots until amount reset.
Returns this
- Defined in lib/dist/index.d.ts:196

subAccount

subAccount(): this
controls a subaccount

Returns this
- Defined in lib/dist/index.d.ts:179

tokenLimit

tokenLimit(payload: { amount: bigint; mint: SolPublicKeyData }): this
Enables a Spend-once Token Spend
Parameters
- payload: { amount: bigint; mint: SolPublicKeyData }
  - amount: bigint
    amount allowed to spend
  - mint: SolPublicKeyData
    token mint public key
Returns this
- Defined in lib/dist/index.d.ts:221

tokenRecurringLimit

tokenRecurringLimit(
    payload: {
        mint: SolPublicKeyData;
        recurringAmount: bigint;
        window: bigint;
    },
): this
Enables a Spend-recurring Token Spend
Parameters
- payload: { mint: SolPublicKeyData; recurringAmount: bigint; window: bigint }
  - mint: SolPublicKeyData
    token mint public key
  - recurringAmount: bigint
    recurring amount per window
  - window: bigint
    period in slots until amount reset
Returns this
- Defined in lib/dist/index.d.ts:231

`Static`new

new(): ActionsBuilder
Returns ActionsBuilder
- Defined in lib/dist/index.d.ts:100

Class ActionsBuilder

Index

Methods

Methods

all

Returns this

allButManageAuthority

Returns this

get

Returns Actions

manageAuthority

Returns this

programAll

Returns this

programCurated

Returns this

programLimit

Parameters

programId: SolPublicKeyData

Returns this

programScopeBasic

Parameters

programId: SolPublicKeyData

targetAccount: SolPublicKeyData

Returns this

programScopeLimit

Parameters

amount: bigint

numericType: NumericType

programId: SolPublicKeyData

targetAccount: SolPublicKeyData

Returns this

programScopeRecurringLimit

Parameters

amount: bigint

numericType: NumericType

programId: SolPublicKeyData

targetAccount: SolPublicKeyData

window: bigint

Returns this

solLimit

Parameters

amount: bigint

Returns this

solRecurringLimit

Parameters

recurringAmount: bigint

window: bigint

Returns this

stakeAll

Returns this

stakeLimit

Parameters

amount: bigint

Returns this

stakeRecurringLimit

Parameters

recurringAmount: bigint

window: bigint

Returns this

subAccount

Returns this

tokenLimit

Parameters

amount: bigint

mint: SolPublicKeyData

Returns this

tokenRecurringLimit

Parameters

mint: SolPublicKeyData

recurringAmount: bigint

window: bigint

Returns this

Staticnew

Returns ActionsBuilder

Settings

On This Page

`Static`new