Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: enhanced and fixed typos in README.md #101

Merged
merged 2 commits into from
Aug 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,43 @@ LI.FI supports any token passed to the API as long as we can validate it and fin

The API exposes a list of tokens that UIs can use as default to give their users tokens to choose from. e.g. our widget uses that list: https://li.quest/v1/tokens

We automatically include tokens in that token list if they are listed in one of the token list we support:
- lists of assets the bridges suppoert
- offical lists of exchanges we support
- in own custom token list (this repository)
We automatically include tokens in that token list if they are listed in one of the token lists we support:
- lists of assets the bridges support
- official lists of exchanges we support
- our own custom token list (this repository)

And if we can validate the token:
- we can find usd prices via debank or zerion APIs
- the token is not a spam/fee taking token
- we can find USD prices via Debank or Zerion APIs
- the token is not a spam/fee-taking token

You can also add scam tokens to /denyTokens/network.json and we will block this token in our system.

## How to add your token

To add your token find the file representing the chain your token is in in the **tokens** folder.
To add your token find the file representing the chain your token is in in the **tokens** folder.

Add your token as the last element in the list (don't forget the `,` after the previous token):

```json
}, <== Add the comma
{
"address": "0x155f0DD04424939368972f4e1838687d6a831151",
"chainId": 42161,
"logoURI": "https://yoursite.com/token.svg", <= permanent link to an image of your token
"decimals": 18,
"name": "nice Name",
"name": "Nice Name",
"symbol": "SYMBOL"
}
]

```

## How to block a token

To add a scam token find the file representing the chain the token is in in the **denyTokens** folder.

Add the token as the last element in the list (don't forget the `,` after the previous token):

```json
}, <== Add the comma
{
Expand All @@ -48,4 +51,4 @@ Add the token as the last element in the list (don't forget the `,` after the pr
]
```

Create a PR with the change describing why we should add that token. Link your project, coingecko and profiles so we can validate the token.
Create a PR with the change describing why we should add that token. Link your project, CoinGecko and profiles so we can validate the token.
Loading