Holds the data for the HolderAccount Account and provides de/serialization functionality for that data

Hierarchy

  • HolderAccount

Implements

Properties

bump: number
createdAt: bignum
currency: PublicKey
owner: PublicKey
status: HolderStatus
tokenAccount: PublicKey

Accessors

  • get byteSize(): number
  • Returns the byteSize of a Buffer holding the serialized data of HolderAccount

    Returns number

Methods

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

    Returns {
        bump: number;
        createdAt: number | {
            toNumber: (() => number);
        };
        currency: string;
        owner: string;
        status: string;
        tokenAccount: string;
    }

    • bump: number
    • createdAt: number | {
          toNumber: (() => number);
      }
    • currency: string
    • owner: string
    • status: string
    • tokenAccount: string
  • Serializes the HolderAccount 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.

  • Deserializes the HolderAccount from the provided data Buffer.

    Parameters

    • buf: Buffer
    • Optional offset: number

    Returns [HolderAccount, number]

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

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

    Parameters

    • connection: Connection
    • address: PublicKey
    • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

    Returns Promise<HolderAccount>

    Throws

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

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

    Parameters

    • accountInfo: AccountInfo<Buffer>
    • Optional offset: number

    Returns [HolderAccount, number]

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

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

    Parameters

    • connection: Connection

      used to retrieve the rent exemption information

    • Optional commitment: Commitment

    Returns Promise<number>

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

    Parameters

    • Optional programId: PublicKey

      the program that owns the accounts we are filtering

    Returns GpaBuilder<{
        accountDiscriminator: any;
        bump: any;
        createdAt: any;
        currency: any;
        owner: any;
        status: any;
        tokenAccount: any;
    }>

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

    Parameters

    • buf: Buffer
    • Optional offset: number

    Returns boolean

Generated using TypeDoc