Class Batch

Readonly bump

Readonly creator

Readonly executedTransactionIndex

Readonly index

Readonly multisig

Readonly size

Readonly vaultBump

Readonly vaultIndex

Static byteSize

• get byteSize(): number

• Returns the byteSize of a Buffer holding the serialized data of Batch

  Returns number

pretty

• pretty(): {
      bump: number;
      creator: string;
      executedTransactionIndex: number;
      index: number | {
          toNumber: (() => number);
      };
      multisig: string;
      size: number;
      vaultBump: number;
      vaultIndex: number;
  }

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

  Returns {
      bump: number;
      creator: string;
      executedTransactionIndex: number;
      index: number | {
          toNumber: (() => number);
      };
      multisig: string;
      size: number;
      vaultBump: number;
      vaultIndex: number;
  }

  • bump: number

  • creator: string

  • executedTransactionIndex: number

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

  • multisig: string

  • size: number

  • vaultBump: number

  • vaultIndex: number

serialize

• serialize(): [Buffer, number]

• Serializes the Batch 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 deserialize

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

• Deserializes the Batch from the provided data Buffer.

  Parameters

  • buf: Buffer

  • offset: number = 0

  Returns [Batch, 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<Batch>

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

  Parameters

  • connection: Connection

  • address: PublicKey

  • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<Batch>

  Throws

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

Static fromAccountInfo

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

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

  Parameters

  • accountInfo: AccountInfo<Buffer>

  • offset: number = 0

  Returns [Batch, number]

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

Static fromArgs

• fromArgs(args): Batch

• Creates a Batch instance from the provided args.

  Parameters

  • args: BatchArgs

  Returns Batch

Static getMinimumBalanceForRentExemption

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

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

  Parameters

  • connection: Connection

    used to retrieve the rent exemption information

  • Optional commitment: Commitment

  Returns Promise<number>

Static gpaBuilder

• gpaBuilder(programId?): GpaBuilder<{
      accountDiscriminator: any;
      bump: any;
      creator: any;
      executedTransactionIndex: any;
      index: any;
      multisig: any;
      size: any;
      vaultBump: any;
      vaultIndex: any;
  }>

• 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<{
      accountDiscriminator: any;
      bump: any;
      creator: any;
      executedTransactionIndex: any;
      index: any;
      multisig: any;
      size: any;
      vaultBump: any;
      vaultIndex: any;
  }>

Static hasCorrectByteSize

• hasCorrectByteSize(buf, offset?): boolean

• Determines if the provided Buffer has the correct byte size to hold Batch data.

  Parameters

  • buf: Buffer

  • offset: number = 0

  Returns boolean