Class TokenService

Interface for token service operations

Implements

Index

Constructors

Methods

clearCache disperseTokens getAllBalances getAllCreditNoticesTo getBalance getProcessId getTotalHolders getTransactionVolume

Constructors

constructor

new TokenService(
tokenProcessId: string,
creditNoticeService?: CreditNoticeService,
): TokenService
Parameters
- tokenProcessId: string
- OptionalcreditNoticeService: CreditNoticeService
Returns TokenService
- Defined in services/token-service/TokenService.ts:17

Methods

clearCache

clearCache(): void
Clears the Cache

Returns void
Implementation of ICaching.clearCache
- Defined in services/token-service/TokenService.ts:174

disperseTokens

disperseTokens(amount: CurrencyAmount, wallets: string[]): Promise<string[]>
Evenly disperses tokens among the provided wallet addresses using concurrent batched transfers
Parameters
- amount: CurrencyAmount
  The total amount to disperse
- wallets: string[]
  Array of wallet addresses to receive tokens
Returns Promise<string[]>
Promise resolving to an array of transaction IDs
Implementation of ITokenService.disperseTokens
- Defined in services/token-service/TokenService.ts:112

getAllBalances

getAllBalances(): Promise<TokenBalanceS[]>
Gets all token balances with pagination

Returns Promise<TokenBalanceS[]>
Promise resolving to an array of TokenBalance objects
Implementation of ITokenService.getAllBalances
- Defined in services/token-service/TokenService.ts:38

getAllCreditNoticesTo

getAllCreditNoticesTo(entityId: string): Promise<CreditNotice[]>
Parameters
- entityId: string
Returns Promise<CreditNotice[]>
Implementation of ITokenService.getAllCreditNoticesTo
- Defined in services/token-service/TokenService.ts:34

getBalance

getBalance(address: string): Promise<bigint>
Gets the balance for a specific address
Parameters
- address: string
  The address to get the balance for
Returns Promise<bigint>
Promise resolving to the balance as a bigint
Implementation of ITokenService.getBalance
- Defined in services/token-service/TokenService.ts:61

getProcessId

getProcessId(): string
Returns string
Implementation of ITokenService.getProcessId
- Defined in services/token-service/TokenService.ts:30

getTotalHolders

getTotalHolders(): Promise<number>
Gets the total number of token holders (addresses with positive balances)

Returns Promise<number>
Promise resolving to the number of holders
Implementation of ITokenService.getTotalHolders
- Defined in services/token-service/TokenService.ts:73

getTransactionVolume

getTransactionVolume(from: Date, to: Date): Promise<bigint>
Gets the total transaction volume for the token within a specified date range
Parameters
- from: Date
  Start date for the transaction volume calculation
- to: Date
  End date for the transaction volume calculation
Returns Promise<bigint>
Promise resolving to the total transaction volume as a number
Implementation of ITokenService.getTransactionVolume
- Defined in services/token-service/TokenService.ts:86