Class HplHolderAccount

constructor

• new HplHolderAccount(_currency, address, _holderAccount, _tokenAccount): HplHolderAccount

• Parameters

  • _currency: HplCurrency

  • address: PublicKey

  • _holderAccount: HolderAccount

  • _tokenAccount: Account

  Returns HplHolderAccount

Readonly address

amount

• get amount(): BN

• Gets the total amount (including perceived amount) of the holder account.

  Returns BN

delegate

• get delegate(): PublicKey

• Gets the delegate of the holder account.

  Returns PublicKey

delegatedAmount

• get delegatedAmount(): bigint

• Gets the delegated amount of the holder account.

  Returns bigint

isActive

• get isActive(): boolean

• Checks if the holder account is active.

  Returns boolean

owner

• get owner(): PublicKey

• Gets the owner of the holder account.

  Returns PublicKey

status

• get status(): HolderStatus

• Gets the status of the holder account.

  Returns HolderStatus

tokenAccount

• get tokenAccount(): PublicKey

• Gets the associated token account of the holder account.

  Returns PublicKey

approveDelegate

• approveDelegate(amount, delegate, confirmOptions?): Promise<ConfirmedContext>

• Approves a delegate for the holder account.

  Parameters

  • amount: number

    The amount to approve for delegation.

  • delegate: PublicKey

    The delegate to approve.

  • Optional confirmOptions: ConfirmOptions

    Optional confirm options for the transaction.

  Returns Promise<ConfirmedContext>

burn

• burn(amount, confirmOptions?): Promise<ConfirmedContext>

• Burns tokens from the holder account.

  Parameters

  • amount: number

    The amount to burn.

  • Optional confirmOptions: ConfirmOptions

    Optional confirm options for the transaction.

  Returns Promise<ConfirmedContext>

currency

• currency(): HplCurrency

• Gets the associated HplCurrency instance.

  Returns HplCurrency

fund

• fund(amount, confirmOptions?): Promise<ConfirmedContext>

• Funds tokens to the holder account.

  Parameters

  • amount: number

    The amount to fund.

  • Optional confirmOptions: ConfirmOptions

    Optional confirm options for the transaction.

  Returns Promise<ConfirmedContext>

mint

• mint(amount, confirmOptions?): Promise<ConfirmedContext>

• Mints new tokens for the holder account.

  Parameters

  • amount: number

    The amount to mint.

  • Optional confirmOptions: ConfirmOptions

    Optional confirm options for the transaction.

  Returns Promise<ConfirmedContext>

revokeDelegate

• revokeDelegate(confirmOptions?): Promise<ConfirmedContext>

• Revokes the delegate approval for the holder account.

  Parameters

  • Optional confirmOptions: ConfirmOptions

    Optional confirm options for the transaction.

  Returns Promise<ConfirmedContext>

setHolderStatus

• setHolderStatus(status, confirmOptions?): Promise<ConfirmedContext>

• Sets the status of the holder account.

  Parameters

  • status: HolderStatus

    The new status to set.

  • Optional confirmOptions: ConfirmOptions

    Optional confirm options for the transaction.

  Returns Promise<ConfirmedContext>

transfer

• transfer(amount, to, confirmOptions?): Promise<ConfirmedContext>

• Transfers tokens to another holder account.

  Parameters

  • amount: number

    The amount to transfer.

  • to: PublicKey | HplHolderAccount

    The destination holder account or its public key.

  • Optional confirmOptions: ConfirmOptions

    Optional confirm options for the transaction.

  Returns Promise<ConfirmedContext>