An open API service indexing awesome lists of open source software.

https://github.com/setprotocol/uniswap-tokenlist


https://github.com/setprotocol/uniswap-tokenlist

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# 🔍  Set-Uniswap Token List

Not sure how to submit a pull request with the changes outlined below? Use our Customisation Request form for a hands off approach.

**[Request Form](https://docs.google.com/forms/d/e/1FAIpQLSeVH39SmQOOl11mDgqDKc1np9ks65giYXye1JYI1T5gSjBGOA/viewform)**

## 🕵️  Custom Set Details v0.1

In order to add your own custom details for your Set, please follow these steps:

1. Get started by forking this repository
2. Add a new file into the `set-details` folder that is named: `[insert-your-set-address].setdetails.json` (i.e. 0x1494CA1F11D487c2bBe4543E90080AeBa4BA3C2b.setdetails.json). A template can be found at `set-details/template.setdetails.json`. THIS MUST BE THE CHECKSUMMED ADDRESS.
4. Be sure to include any required media such as token or manager icons in the `/assets` directory under their respective folders
5. Verify that the details match the required schema [here](https://github.com/SetProtocol/uniswap-tokenlist/blob/main/set-details.schema.json) by pasting the entire entry into this [schema validator](https://www.jsonschemavalidator.net) and see if your input JSON matches properly. See below if you need multi line descriptions
6. Create a pull request against the master branch and follow the pull request template to submit the proper signature (signed current version number [i.e. 1] via TokenSets UI)
7. Join our [Discord](https://discord.gg/p7cHp9CG) and ping a team member to review your submission

#### 🦄  Uniswap TokenList Details (Optional)
To add your Set details to our Uniswap Tokenlist, add an entry to the details in the `set.tokenlist.json` file, follow other submissions

#### 🛂  Generating a Valid Signature
Each pull request must be accompanied by a valid signature signing the next monotomically increasing version number. To generate a signature:
1. Head over to your Set page on Tokensets `tokensets.com/v2/set/your_set_address`
2. Once logged in, the name of your Set should appear in blue with an edit icon
3. Tap on your Set's name and follow the steps in the popup

#### 📰  Multi Line Descriptions
If you need to have multi-line JSON, you can use a HJSON converter to help with writing it.

1. Head over to this [tool](https://hjson.github.io/try.html)
2. On the left pannel, paste your multi line description under the `multiline string` comment, replacing the JSON Haiku
3. Copy the output from the right pannel under `haiku`, omitting the trailing comma and paste into your `setdetails.json` file.