Tokens app
This is an app connector for the Tokens app (
token-manager.aragonpm.eth). It only supports The Graph for now.To connect a Tokens app, you need to pass it to
connectTokens():import connect from '@aragon/connect'
import connectTokens from '@aragon/connect-tokens'
const org = await connect('myorg.aragonid.eth', 'thegraph')
const tokens = await connectTokens(org.app('token-manager'))
It extends the
App object, which means that every method and property of App is also available on this object.Connects and returns a
Tokens instance.Name | Type | Description |
|---|---|---|
app | App or Promise<App> | The app to extend with connected capabilities. |
connector | ["thegraph", Object] or "thegraph" | Accepts either a string describing the desired connector (only "thegraph" for now), or a tuple to also pass a configuration object to the connector. |
returns | Promise<Tokens> | An Tokens instance (see below). |
It can throw the following errors:
Error type | Description |
|---|---|
Either the passed value is not a valid app object, or its name is not token-manager. | |
Either the connector configuration format is not valid, or the connector name is not supported. | |
A subgraph couldn’t be found with the current network. Pass a subgraphUrl directly, or use one of the supported networks. |
An object representing the Tokens app, returned by
connectTokens(). Use the following API to retrieve its data:Get the
Token instance used with the app.Name | Type | Description |
|---|---|---|
returns | Promise<Token> | A Token object. |
This method can throw one of the following errors:
Error type | Description |
|---|---|
The response seems incorrect. | |
The connection to the remote source failed. |
Get a list of token holders.
Name | Type | Description |
|---|---|---|
filters | Object | Optional object allowing to filter the token holders. |
filters.first | Number | Maximum number of token holders. Defaults to 1000. |
filters.skip | Number | Skip a number of token holders. Defaults to 0. |
returns | Promise<TokenHolder[]> | List of token holders. |
This method can throw one of the following errors:
Error type | Description |
|---|---|
The response seems incorrect. | |
The connection to the remote source failed. |
Subscribe to a list of token holders. The callback is optional, not passing it will return a partially applied function.
Name | Type | Description |
|---|---|---|
filters | Object | Optional object allowing to filter the token holders. See Tokens#holders() for details. |
callback | (error: Error, tokenHolders: TokenHolder[]) => void | A callback that will get called every time the result gets updated. |
returns | { unsubscribe: () => void } | Unsubscribe function. |
The error passed to
callback can be null (no error) or one of the following:Error type | Description |
|---|---|
The data couldn’t be fetched. | |
The connection to the remote source failed. |
This object represents the token contract (based on MiniMe) used by the Tokens app. It gets returned by
Tokens#token() for example.Name | Type | Description |
|---|---|---|
id | String | Unique identifier representing this token. |
address | Address | |
name | String | The token name (e.g. “Aragon Network Token”). |
symbol | String | The token symbol (e.g. “ANT”). |
totalSupply | String | The total supply for the token. |
transferable | Boolean | Whether the token is transferable. |
This object represents a single token holder. It gets returned by
Tokens#holders() for example.Name | Type | Description |
|---|---|---|
id | String | Unique identifier representing the token holder. |
address | Address | Address of the token holder. |
balance | String | Current balance. |
Do you have a question? Leave your comments here at our Discourse forum 👇
Last modified 7mo ago