2022-11-03 08:45:16 -07:00
|
|
|
# Overview
|
|
|
|
|
2022-07-19 11:08:06 -07:00
|
|
|
This tool can be used to generate the list of tokens to be monitored by the chain governor.
|
2022-11-03 08:45:16 -07:00
|
|
|
It works by querying the notional TVL data from Portal and populating the generated_tokens.go file in
|
2022-07-19 11:08:06 -07:00
|
|
|
the governor package with everything over the hard coded minimal notional value.
|
|
|
|
|
2022-11-03 08:45:16 -07:00
|
|
|
## Configuration
|
2022-07-19 11:08:06 -07:00
|
|
|
To update the minimal notional value, edit src/index.ts and change the value of MinNotional.
|
|
|
|
|
2022-11-03 08:45:16 -07:00
|
|
|
## Always Included Tokens
|
2022-08-16 13:22:24 -07:00
|
|
|
Additionally, you can create an include_list.csv file in this directory where the contents are
|
|
|
|
of the form "<originChain>,<nativeTokenAddress>", and all tokens listed there will be included
|
|
|
|
in the generated token list, regardless of their notional value.
|
|
|
|
|
2022-11-03 08:45:16 -07:00
|
|
|
## Running the script
|
2022-07-19 11:08:06 -07:00
|
|
|
To run this tool, do:
|
|
|
|
|
|
|
|
```
|
|
|
|
npm ci
|
|
|
|
npm run start
|
|
|
|
```
|
|
|
|
|
2022-11-03 08:45:16 -07:00
|
|
|
## Manually Included Tokens
|
|
|
|
The governor also makes use of a list of manually added tokens. These are tokens that do not exist
|
|
|
|
in the notional TVL data. These tokens are listed in wormhole/node/pkg/governor/manual_tokens.go
|
|
|
|
|
|
|
|
## Verifying the Token Lists
|
2022-08-30 09:28:18 -07:00
|
|
|
To verify that the Coin Gecko query still works with the new token list, do:
|
|
|
|
```
|
|
|
|
go run check_query.go
|
|
|
|
```
|
|
|
|
|
2022-11-03 08:45:16 -07:00
|
|
|
Before committing the generated file, you should run the governor tests and ensure that they pass:
|
|
|
|
```
|
|
|
|
cd wormhole/node/pkg/governor
|
|
|
|
go test
|
|
|
|
```
|
|
|
|
|
|
|
|
## Committing the Changes
|
|
|
|
You can then commit the updated version of node/pkg/governor/generated_tokens.go.
|