https://github.com/gitcoinco/gitcoin-chain-data
https://github.com/gitcoinco/gitcoin-chain-data
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gitcoinco/gitcoin-chain-data
- Owner: gitcoinco
- Created: 2024-05-06T23:24:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T08:42:29.000Z (over 1 year ago)
- Last Synced: 2025-06-16T11:48:24.554Z (about 1 year ago)
- Language: TypeScript
- Size: 4.36 MB
- Stars: 3
- Watchers: 5
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gitcoin Common Data Package
The Gitcoin Common Data Package sources all the chains and supported tokens used by Gitcoin for:
- Grants-stack DApps
- Grants-stack-indexer
- Any other side-car aiming to leverage the supported chains/tokens
## Installation
To install the package, use the following command:
```bash
npm i "@gitcoin/gitcoin-chain-data"
```
## Functions
The package exposes the following functions, found in [index.ts](./src/index.ts):
- `getChains()`: Returns `TChain[]`
- `getChainById(chainId)`: Returns `TChain`
- `getTokens()`: Returns `TToken[]`
- `getTokensByChainId(chainId)`: Returns `TToken[]`
- `getTokenByChainIdAndAddress(chainId, address)`: Returns `TToken`
The types can be found in [types.ts](./src/types.ts).
## Adding a New Chain
To add a new chain, follow these steps:
1. Run the following command:
```bash
npm run new-chain
```
2. A new file will be created at `src/data/chains//chain.ts`.
3. Update `chain.ts` with the specific data for the new chain.
4. Update `src/chains/chainImportMap.ts` to add the new chain
## Adding a New Token to a Chain
To add a new token to an existing chain:
1. Open the file at `src/data/chains//chain.ts`.
2. Update the `tokens` array to include the new token information.
## Contributing
To contribute to the project, follow these steps:
### Install Dependencies
Install the necessary dependencies with:
```bash
npm i
```
### Build
Build the project with:
```bash
npm run build
```
### Publish
To publish the package, use:
```bash
npm publish
```
---
This version improves readability, structure, and clarity. It provides clear instructions for installation, usage, adding new chains and tokens, and contributing to the project.