Swig TS — API References
    Preparing search index...

    Class ActionsBuilder

    Utility class for composing actions

    Index

    Methods

    all get manageAuthority programLimit programScopeBasic programScopeLimit programScopeRecurringLimit solLimit solRecurringLimit subAccount tokenLimit tokenReccuringLimit new

    Methods

    • Enable a program scope

      Parameters

      • payload: { programId: PublicKey }
        • programId: PublicKey

          ID of the program to enable

      Returns this

    • Basic program scope

      Parameters

      • payload: { programId: PublicKey; targetAccount: PublicKey }
        • programId: PublicKey

          Program ID

        • targetAccount: PublicKey

          Program Account to target

      Returns ActionsBuilder

      Basic ProgramScope action

    • Limit ProgramScope

      Parameters

      • payload: {
            amount: bigint;
            numericType: NumericType;
            programId: PublicKey;
            targetAccount: PublicKey;
        }
        • amount: bigint

          Max amount spendable

        • numericType: NumericType

          Numeric type of the amount. i.e u8, u32, u64 or u128

        • programId: PublicKey

          Program ID

        • targetAccount: PublicKey

          Program Account to target

      Returns ActionsBuilder

      Limit ProgramScope

    • RecurringLimit ProgramScope

      Parameters

      • payload: {
            amount: bigint;
            numericType: NumericType;
            programId: PublicKey;
            targetAccount: PublicKey;
            window: bigint;
        }
        • amount: bigint

          Max amount spendable

        • numericType: NumericType

          Numeric type of the amount. i.e u8, u32, u64 or u128

        • programId: PublicKey

          Program ID

        • targetAccount: PublicKey

          Program Account to target

        • window: bigint

          Duration in slot between limits reset

      Returns ActionsBuilder

      RecurringLimit ProgramScope

    • Enables a Spend-once SOL Spend

      Parameters

      • payload: { amount: bigint }
        • amount: bigint

          ID of the program to enable

      Returns 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

    • Enables a Spend-once Token Spend

      Parameters

      • payload: { amount: bigint; mint: PublicKey }
        • amount: bigint

          amount allowed to spend

        • mint: PublicKey

          token mint public key

      Returns this

    • Enables a Spend-recurring Token Spend

      Parameters

      • payload: { mint: PublicKey; recurringAmount: bigint; window: bigint }
        • mint: PublicKey

          token mint public key

        • recurringAmount: bigint

          recurring amount per window

        • window: bigint

          period in slots until amount reset

      Returns this

    Settings

    Member Visibility

    On This Page

    Methods