Class SpendingLimit

Readonly amount

Readonly bump

Readonly createKey

Readonly destinations

Readonly lastReset

Readonly members

Readonly mint

Readonly multisig

Readonly period

Readonly remainingAmount

Readonly vaultIndex

pretty

• pretty(): {
      amount: number | {
          toNumber: (() => number);
      };
      bump: number;
      createKey: string;
      destinations: PublicKey[];
      lastReset: number | {
          toNumber: (() => number);
      };
      members: PublicKey[];
      mint: string;
      multisig: string;
      period: string;
      remainingAmount: number | {
          toNumber: (() => number);
      };
      vaultIndex: number;
  }

• Returns a readable version of SpendingLimit properties and can be used to convert to JSON and/or logging

  Returns {
      amount: number | {
          toNumber: (() => number);
      };
      bump: number;
      createKey: string;
      destinations: PublicKey[];
      lastReset: number | {
          toNumber: (() => number);
      };
      members: PublicKey[];
      mint: string;
      multisig: string;
      period: string;
      remainingAmount: number | {
          toNumber: (() => number);
      };
      vaultIndex: number;
  }

  • amount: number | {
        toNumber: (() => number);
    }

  • bump: number

  • createKey: string

  • destinations: PublicKey[]

  • lastReset: number | {
        toNumber: (() => number);
    }

  • members: PublicKey[]

  • mint: string

  • multisig: string

  • period: string

  • remainingAmount: number | {
        toNumber: (() => number);
    }

  • vaultIndex: number

serialize

• serialize(): [Buffer, number]

• Serializes the SpendingLimit into a Buffer.

  Returns [Buffer, number]

  a tuple of the created Buffer and the offset up to which the buffer was written to store it.

Static byteSize

• byteSize(args): number

• Returns the byteSize of a Buffer holding the serialized data of SpendingLimit for the provided args.

  Parameters

  • args: SpendingLimitArgs

    need to be provided since the byte size for this account depends on them

  Returns number

Static deserialize

• deserialize(buf, offset?): [SpendingLimit, number]

• Deserializes the SpendingLimit from the provided data Buffer.

  Parameters

  • buf: Buffer

  • offset: number = 0

  Returns [SpendingLimit, number]

  a tuple of the account data and the offset up to which the buffer was read to obtain it.

Static fromAccountAddress

• fromAccountAddress(connection, address, commitmentOrConfig?): Promise<SpendingLimit>

• Retrieves the account info from the provided address and deserializes the SpendingLimit from its data.

  Parameters

  • connection: Connection

  • address: PublicKey

  • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<SpendingLimit>

  Throws

  Error if no account info is found at the address or if deserialization fails

Static fromAccountInfo

• fromAccountInfo(accountInfo, offset?): [SpendingLimit, number]

• Deserializes the SpendingLimit from the data of the provided web3.AccountInfo.

  Parameters

  • accountInfo: AccountInfo<Buffer>

  • offset: number = 0

  Returns [SpendingLimit, number]

  a tuple of the account data and the offset up to which the buffer was read to obtain it.

Static fromArgs

• fromArgs(args): SpendingLimit

• Creates a SpendingLimit instance from the provided args.

  Parameters

  • args: SpendingLimitArgs

  Returns SpendingLimit

Static getMinimumBalanceForRentExemption

• getMinimumBalanceForRentExemption(args, connection, commitment?): Promise<number>

• Fetches the minimum balance needed to exempt an account holding SpendingLimit data from rent

  Parameters

  • args: SpendingLimitArgs

    need to be provided since the byte size for this account depends on them

  • connection: Connection

    used to retrieve the rent exemption information

  • Optional commitment: Commitment

  Returns Promise<number>

Static gpaBuilder

• gpaBuilder(programId?): GpaBuilder<SpendingLimitArgs & {
      accountDiscriminator: number[];
  }>

• Provides a web3.Connection.getProgramAccounts config builder, to fetch accounts matching filters that can be specified via that builder.

  Parameters

  • programId: PublicKey = ...

    the program that owns the accounts we are filtering

  Returns GpaBuilder<SpendingLimitArgs & {
      accountDiscriminator: number[];
  }>