Class HplCurrency

constructor

• new HplCurrency(address, _currency, _mint, _metadata): HplCurrency

• Parameters

  • address: PublicKey

  • _currency: Currency

  • _mint: Mint

  • _metadata: Metadata

  Returns HplCurrency

Readonly address

kind

• get kind(): CurrencyKind

• Gets the kind of the currency.

  Returns CurrencyKind

mint

• get mint(): Mint

• Gets the underlying mint of the currency.

  Returns Mint

name

• get name(): string

• Gets the name of the currency.

  Returns string

symbol

• get symbol(): string

• Gets the symbol of the currency.

  Returns string

uri

• get uri(): string

• Gets the URI of the currency.

  Returns string

create

• create(): HplCurrencyCreate

• Gets the create module.

  Returns HplCurrencyCreate

fetch

• fetch(): HplCurrencyFetch

• Gets the fetch module.

  Returns HplCurrencyFetch

holderAccount

• holderAccount(owner?, reFetch?): Promise<HplHolderAccount>

• Gets the holder account for the given owner.

  Parameters

  • Optional owner: PublicKey

    The owner of the holder account. If not provided, uses the identity address.

  • Optional reFetch: boolean

    Set to true to force re-fetching of the holder account data.

  Returns Promise<HplHolderAccount>

honeycomb

• honeycomb(): Honeycomb

• Gets the Honeycomb instance.

  Returns Honeycomb

install

• install(honeycomb): Honeycomb

• Installs the HplCurrency in the given Honeycomb instance.

  Parameters

  • honeycomb: Honeycomb

    The Honeycomb instance to install the currency.

  Returns Honeycomb

project

• project(): HoneycombProject

• Gets the associated HoneycombProject.

  Returns HoneycombProject

update

• update(args, confirmOptions?): Promise<ConfirmedContext>

• Updates the currency with the given arguments.

  Parameters

  • args: UpdateCurrencyArgs

    The arguments for updating the currency.

  • Optional confirmOptions: ConfirmOptions

    Optional confirm options for the transaction.

  Returns Promise<ConfirmedContext>

uriData

• uriData(reFetch?): Promise<any>

• Fetches URI data for the currency.

  Parameters

  • Optional reFetch: boolean

    Set to true to force re-fetching of the data.

  Returns Promise<any>

Static fromAddress

• fromAddress(connection, address): Promise<HplCurrency>

• Creates an HplCurrency instance from the given address.

  Parameters

  • connection: Connection

    The Solana web3 connection.

  • address: PublicKey

    The address of the currency.

  Returns Promise<HplCurrency>

Static new

• new(honeycomb, args, confirmOptions?): Promise<HplCurrency>

• Creates a new HplCurrency instance.

  Parameters

  • honeycomb: Honeycomb

    The Honeycomb instance.

  • args: CreateCurrencyArgs | {
        mint: PublicKey;
    }

    The arguments for creating the currency.

  • Optional confirmOptions: ConfirmOptions

    Optional confirm options for the transaction.

  Returns Promise<HplCurrency>