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

Consider making it clearer how to consume the celo-token-list #56

Open
arthurgousset opened this issue Mar 27, 2024 · 0 comments
Open

Comments

@arthurgousset
Copy link
Contributor

arthurgousset commented Mar 27, 2024

I noticed the Github repo publishes a Github Page at https://celo-org.github.io/celo-token-list. I assume that's to make the celo.tokenlist.json accessible via HTTP requests to https://celo-org.github.io/celo-token-list/celo.tokenlist.json.

To start I added the URL in the repo description

image

  1. Consider highlighting the URL more clearly in the README, like we did with @celo/compliance:

You can make an API call to retrieve the latest OFAC sanctions list from

https://celo-org.github.io/compliance/ofac.sanctions.json

For example:

export async function getSanctionedAddresses(): Promise<string[]> {
    return await fetch("https://celo-org.github.io/compliance/ofac.sanctions.json")
        .then((response) => {
            return response.json();
        })
        .catch((err) => {
            console.log(err);
        });
}

[!TIP]
No changes to your code will be necessary when the list is updated as this API will always
return the latest version.

Source: celo-org/compliance > README.md

  1. Confirm we are not intending to publish this package to NPM like Uniswap does @uniswap/token-lists

I think we are intentionally not publishing this to NPM, but just double-checking.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant