@pooled-nft/token-list

This GitHub repo contains the default token list used in the Pooled NFT interface, along with the source code and configuration files for managing and building the token list.

Development

Prerequisites

• NVM
• Yarn package manager

Set Up

1. Clone the repository:

$ git clone https://github.com/hifi-finance/pooled-nft-token-list.git
$ cd pooled-nft-token-list

2. Set the version of Node to use locally within the project:

$ nvm use

3. Install the dependencies with Yarn:

$ yarn install

The repo includes the following scripts:

• test: Runs the test suite using Mocha and Chai.
• build: Cleans the build directory, creates a new build directory, and generates the token list JSON file.

Integration

To integrate the token list into your project, use the following API:

GET https://raw.githubusercontent.com/hifi-finance/pooled-nft-token-list/main/build/pooled-nft.tokenlist.json

Adding a token

To request that we add a token to the list, file an issue.

Disclaimer

Note filing an issue does not guarantee addition to this default token list. We do not review token addition requests in any particular order, and we do not guarantee that we will review your request to add the token to the default list.