Class Currency

Readonly bump

Readonly kind

Readonly mint

Readonly project

pretty

• pretty(): {
      bump: number;
      kind: "Permissioned" | "Wrapped";
      mint: string;
      project: string;
  }

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

  Returns {
      bump: number;
      kind: "Permissioned" | "Wrapped";
      mint: string;
      project: string;
  }

  • bump: number

  • kind: "Permissioned" | "Wrapped"

  • mint: string

  • project: string

serialize

• serialize(): [Buffer, number]

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

  Parameters

  • args: CurrencyArgs

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

  Returns number

Static deserialize

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

• Deserializes the Currency from the provided data Buffer.

  Parameters

  • buf: Buffer

  • Optional offset: number

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

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

  Parameters

  • connection: Connection

  • address: PublicKey

  • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<Currency>

  Throws

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

Static fromAccountInfo

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

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

  Parameters

  • accountInfo: AccountInfo<Buffer>

  • Optional offset: number

  Returns [Currency, number]

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

Static fromArgs

• fromArgs(args): Currency

• Creates a Currency instance from the provided args.

  Parameters

  • args: CurrencyArgs

  Returns Currency

Static getMinimumBalanceForRentExemption

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

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

  Parameters

  • args: CurrencyArgs

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