Class AddressContainer

Readonly addresses

Readonly associatedWith

Readonly bump

Readonly role

pretty

• pretty(): {
      addresses: PublicKey[];
      associatedWith: string;
      bump: number;
      role: string;
  }

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

  Returns {
      addresses: PublicKey[];
      associatedWith: string;
      bump: number;
      role: string;
  }

  • addresses: PublicKey[]

  • associatedWith: string

  • bump: number

  • role: string

serialize

• serialize(): [Buffer, number]

• Serializes the AddressContainer 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 AddressContainer for the provided args.

  Parameters

  • args: AddressContainerArgs

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

  Returns number

Static deserialize

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

• Deserializes the AddressContainer from the provided data Buffer.

  Parameters

  • buf: Buffer

  • Optional offset: number

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

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

  Parameters

  • connection: Connection

  • address: PublicKey

  • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<AddressContainer>

  Throws

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

Static fromAccountInfo

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

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

  Parameters

  • accountInfo: AccountInfo<Buffer>

  • Optional offset: number

  Returns [AddressContainer, number]

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

Static fromArgs

• fromArgs(args): AddressContainer

• Creates a AddressContainer instance from the provided args.

  Parameters

  • args: AddressContainerArgs

  Returns AddressContainer

Static getMinimumBalanceForRentExemption

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

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

  Parameters

  • args: AddressContainerArgs

    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<AddressContainerArgs & {
      accountDiscriminator: 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<AddressContainerArgs & {
      accountDiscriminator: number[];
  }>