Interface ITokenService

Interface for token service operations

interface ITokenService {
    disperseTokens(
        amount: CurrencyAmount,
        wallets: string[],
    ): Promise<string[]>;
    getAllBalances(): Promise<TokenBalanceS[]>;
    getAllCreditNoticesTo(entityId: string): Promise<CreditNotice[]>;
    getBalance(address: string): Promise<bigint>;
    getProcessId(): string;
    getTotalHolders(): Promise<number>;
    getTransactionVolume(from: Date, to: Date): Promise<bigint>;
}

Implemented by

TokenService

Index

Methods

disperseTokens getAllBalances getAllCreditNoticesTo getBalance getProcessId getTotalHolders getTransactionVolume

Methods

disperseTokens

disperseTokens(amount: CurrencyAmount, wallets: string[]): Promise<string[]>
Evenly disperses tokens among the provided wallet addresses
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
- Defined in services/token-service/abstract/ITokenService.ts:43

getAllBalances

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

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

getAllCreditNoticesTo

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

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
- Defined in services/token-service/abstract/ITokenService.ts:20

getProcessId

getProcessId(): string
Returns string
- Defined in services/token-service/abstract/ITokenService.ts:35

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
- Defined in services/token-service/abstract/ITokenService.ts:26

getTransactionVolume

getTransactionVolume(from: Date, to: Date): Promise<bigint>
Gets the transaction volume for a date range
Parameters
- from: Date
- to: Date
Returns Promise<bigint>
- Defined in services/token-service/abstract/ITokenService.ts:31