1.0.56 • Published 7 months ago

@gitcoin/gitcoin-chain-data v1.0.56

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

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:

npm i "@gitcoin/gitcoin-chain-data"

Functions

The package exposes the following functions, found in 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.

Adding a New Chain

To add a new chain, follow these steps:

  1. Run the following command:
    npm run new-chain <CHAIN_ID>
  2. A new file will be created at src/data/chains/<CHAIN_ID>/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_ID>/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:

npm i

Build

Build the project with:

npm run build

Publish

To publish the package, use:

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.

1.0.44

9 months ago

1.0.48

8 months ago

1.0.47

8 months ago

1.0.46

8 months ago

1.0.45

8 months ago

1.0.49

8 months ago

1.0.51

8 months ago

1.0.50

8 months ago

1.0.55

7 months ago

1.0.54

8 months ago

1.0.53

8 months ago

1.0.52

8 months ago

1.0.56

7 months ago

1.0.43

12 months ago

1.0.42

12 months ago

1.0.41

1 year ago

1.0.39

1 year ago

1.0.38

1 year ago

1.0.40

1 year ago

1.0.36-a

1 year ago

1.0.37

1 year ago

1.0.36

1 year ago

1.0.35

1 year ago

1.0.34

1 year ago

1.0.33

1 year ago

1.0.32

1 year ago

1.0.31

1 year ago

1.0.30

1 year ago

1.0.29

1 year ago

1.0.28

1 year ago

1.0.27

1 year ago

1.0.26

1 year ago

1.0.25

1 year ago

1.0.24

1 year ago

1.0.23

1 year ago

1.0.22

1 year ago

1.0.21

1 year ago

1.0.20

1 year ago

1.0.19

1 year ago

1.0.18

1 year ago

1.0.17

1 year ago

1.0.16

1 year ago

1.0.15

1 year ago

1.0.14

1 year ago

1.0.13

1 year ago

1.0.12

1 year ago

1.0.11

1 year ago

1.0.10

1 year ago

1.0.9

1 year ago

1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3-t3

1 year ago

1.0.3-t1

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago