Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AccountClient<IDL, A, T>

Type parameters

  • IDL: Idl = Idl

  • A: NullableIdlAccount<IDL> = IDL["accounts"] extends undefined ? IdlAccountDef : NonNullable<IDL["accounts"]>[number]

  • T = TypeDef<A, IdlTypes<IDL>>

Hierarchy

  • AccountClient

Index

Constructors

Accessors

  • get coder(): Coder<string, string>
  • get size(): number

Methods

  • Returns all instances of this account type for the program.

    Parameters

    • Optional filters: Buffer | GetProgramAccountsFilter[]

      User-provided filters to narrow the results from connection.getProgramAccounts.

                 When filters are not defined this method returns all
      the account instances.

      When filters are of type `Buffer`, the filters are appended
      after the discriminator.

      When filters are of type `GetProgramAccountsFilter[]`,
      filters are appended after the discriminator filter.

    Returns Promise<ProgramAccount<T>[]>

  • associated(...args: (PublicKey | Buffer)[]): Promise<T>
  • deprecated

    since version 14.0.

    Function returning the associated account. Args are keys to associate. Order matters.

    Parameters

    Returns Promise<T>

  • fetchMultiple(addresses: Address[], commitment?: Commitment): Promise<(null | Object)[]>
  • Returns multiple deserialized accounts. Accounts not found or with wrong discriminator are returned as null.

    Parameters

    • addresses: Address[]

      The addresses of the accounts to fetch.

    • Optional commitment: Commitment

    Returns Promise<(null | Object)[]>

  • subscribe(address: Address, commitment?: Commitment): EventEmitter<string | symbol, any>
  • unsubscribe(address: Address): Promise<void>

Generated using TypeDoc