Class: CurrencyNetwork
"CurrencyNetwork".CurrencyNetwork
The CurrencyNetwork class contains all functions relevant for retrieving currency network related information. It is meant to be called via a TLNetwork instance like:
#
Hierarchy- CurrencyNetwork
#
Methods#
getAllâ–¸ getAll(): Promise<NetworkDetails[]>
Defined in src/CurrencyNetwork.ts:52
Returns all registered currency networks.
Returns: Promise<NetworkDetails[]>
#
getInfoâ–¸ getInfo(networkAddress
: string): Promise<NetworkDetails>
Defined in src/CurrencyNetwork.ts:70
Returns detailed information of specific currency network.
#
Parameters:Name | Type | Description |
---|---|---|
networkAddress | string | Address of a currency network. |
Returns: Promise<NetworkDetails>
A network object with information about name, decimals, number of users and address.
#
getUserOverviewâ–¸ getUserOverview(networkAddress
: string, userAddress
: string, options?
: { decimalsOptions?: DecimalsOptions }): Promise<UserOverview>
Defined in src/CurrencyNetwork.ts:100
Returns overview of a user in a specific currency network.
#
Parameters:Name | Type | Default value | Description |
---|---|---|---|
networkAddress | string | - | Address of a currency network. |
userAddress | string | - | Address of a user. |
options | { decimalsOptions?: DecimalsOptions } | {} | - |
Returns: Promise<UserOverview>
#
getUsersâ–¸ getUsers(networkAddress
: string): Promise<string[]>
Defined in src/CurrencyNetwork.ts:88
Returns all addresses of users in a currency network.
#
Parameters:Name | Type | Description |
---|---|---|
networkAddress | string | Address of a currency network. |
Returns: Promise<string[]>