Class TokenBalance

Concrete implementation of ITokenBalance for managing token balances with configuration.

Implements

ITokenBalance

Index

Constructors

Methods

getCurrencyAmount getTokenConfig toString fromCreditNotice

Constructors

constructor

new TokenBalance(params: TokenBalanceConstructorParams): TokenBalance
Creates a new TokenBalance instance.
Parameters
- params: TokenBalanceConstructorParams
  Constructor parameters containing currencyAmount and tokenConfig
Returns TokenBalance
- Defined in models/financial/token-balance/TokenBalance.ts:43

Methods

getCurrencyAmount

getCurrencyAmount(): CurrencyAmount
Gets the currency amount for this token balance.

Returns CurrencyAmount
The CurrencyAmount representing the balance
Implementation of ITokenBalance.getCurrencyAmount
- Defined in models/financial/token-balance/TokenBalance.ts:52

getTokenConfig

getTokenConfig(): TokenConfig
Gets the token configuration including metadata.

Returns TokenConfig
The TokenConfig with logo and name information
Implementation of ITokenBalance.getTokenConfig
- Defined in models/financial/token-balance/TokenBalance.ts:61

toString

toString(): string
Returns string
Implementation of ITokenBalance.toString
- Defined in models/financial/token-balance/TokenBalance.ts:66

`Static`fromCreditNotice

fromCreditNotice(
creditNotice: CreditNotice,
tokenConfig: TokenConfig,
): TokenBalance
Creates a TokenBalance from a credit notice and token configuration
Parameters
- creditNotice: CreditNotice
  The credit notice containing quantity information
- tokenConfig: TokenConfig
  The token configuration for the balance
Returns TokenBalance
A new TokenBalance instance
- Defined in models/financial/token-balance/TokenBalance.ts:24