Class HyperBeamTokenClient`Experimental`

Hierarchy (View Summary)

AOProcessClient
- HyperBeamTokenClient

Implements

IAOTokenClient

Index

Constructors

Methods

balance getInfo getProcessId mint setProcessId transfer

Constructors

constructor

new HyperBeamTokenClient(
config: AOProcessClientConfig & Partial<BaseClientConfig>,
): HyperBeamTokenClient
Experimental
Parameters
- config: AOProcessClientConfig & Partial<BaseClientConfig>
Returns HyperBeamTokenClient
Overrides AOProcessClient.constructor
- Defined in clients/ao/token/implementations/hyperbeam-token-client/HyperBeamTokenClient.ts:22

Methods

balance

balance(entityId: string): Promise<string>
Experimental
Gets the balance of a specific identifier (address) in the token ledger. This is a read-only operation that queries the current state of the ledger.
Parameters
- entityId: string
Returns Promise<string>
Promise resolving to the current balance as a string
Implementation of IAOTokenClient.balance
- Defined in clients/ao/token/implementations/hyperbeam-token-client/HyperBeamTokenClient.ts:44

getInfo

getInfo(token?: string): Promise<TokenInfo>
Experimental
Gets information about a token process including name, ticker, logo, and denomination. These are immutable parameters set when the token process was spawned.
Parameters
- Optionaltoken: string
  Optional token process ID to get information for. If not provided, uses the current process ID.
Returns Promise<TokenInfo>
Promise resolving to TokenInfo with token information
Implementation of IAOTokenClient.getInfo
- Defined in clients/ao/token/implementations/hyperbeam-token-client/HyperBeamTokenClient.ts:77

getProcessId

getProcessId(): string
Experimental
Returns string
Inherited from AOProcessClient.getProcessId
- Defined in clients/common/implementations/AOProcessClient.ts:12

mint

mint(quantity: string): Promise<boolean>
Experimental
Mints new tokens, increasing the total supply. This operation can only be performed on the root token process.
Parameters
- quantity: string
  The amount of new tokens to create
Returns Promise<boolean>
Promise resolving to true if minting was successful
Implementation of IAOTokenClient.mint
- Defined in clients/ao/token/implementations/hyperbeam-token-client/HyperBeamTokenClient.ts:109

setProcessId

setProcessId(processId: string): void
Experimental
Parameters
- processId: string
Returns void
Inherited from AOProcessClient.setProcessId
- Defined in clients/common/implementations/AOProcessClient.ts:9

transfer

transfer(
    recipient: string,
    quantity: string,
    forwardedTags?: Tags,
): Promise<boolean>
Experimental
Transfers tokens from the caller's balance to one or more target addresses. This operation modifies the ledger state by updating balances.
Parameters
- recipient: string
  The target address to receive the tokens
- quantity: string
  The amount of tokens to transfer
- OptionalforwardedTags: Tags
  Optional tags to include with the transfer message for additional metadata or notifications
Returns Promise<boolean>
Promise resolving to true if the transfer was successful
Implementation of IAOTokenClient.transfer
- Defined in clients/ao/token/implementations/hyperbeam-token-client/HyperBeamTokenClient.ts:50