chain-registry
The npm package for the Official Cosmos chain registry
npm install chain-registry
A unified store of chains info, assets, asset lists, and IBC channels for the Cosmos ecosystem. Get everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
example
import { assets, chains, ibc } from 'chain-registry';
const assetList = assets.find(({chain_name})=>chain_name==='osmosis');
console.log(assetList);
will output:
{
'$schema': '../assetlist.schema.json',
chain_name: 'osmosis',
assets: [
{
description: 'The native token of Osmosis',
denom_units: [Array],
base: 'uosmo',
name: 'Osmosis',
display: 'osmo',
symbol: 'OSMO',
logo_URIs: [Object],
coingecko_id: 'osmosis'
},
{
denom_units: [Array],
base: 'uion',
name: 'Ion',
display: 'ion',
symbol: 'ION',
logo_URIs: [Object],
coingecko_id: 'ion'
}
]
}
packages
chain-registry
An npm module for the Official chain-registry
for the Cosmos ⚛️
@chain-registry/client
A Client for chain-registry
that allows you to dynamically fetch data.
@chain-registry/types
Types for chain-registry
.
@chain-registry/keplr
Keplr integration for the chain-registry returning keplr's ChainInfo
type from @chain-registry/types
Chain
type.
@chain-registry/assets
Asset lists for the Cosmos ⚛️
@chain-registry/osmosis
Chain Registry info for Osmosis, including asset lists.
@chain-registry/juno
Chain Registry info for Juno, including asset lists.
@chain-registry/utils
Utility functions for chain-registry
.
Developing
Checkout the repository and bootstrap the yarn workspace:
# Clone the repo.
git clone https://github.com/cosmology-tech/chain-registry
yarn
yarn bootstrap
Building
yarn build
Publishing
First, cd
into the root folder of the project:
cd /your/path/to/chain-registry
Second, update the git submodules:
git submodule update --remote
Third, generate the code (this takes a bit since it does some linting):
yarn codegen
Finally, commit and publish the code!
git commit -am "new registry updates"
lerna publish
Credits
🛠 Built by Cosmology — if you like our tools, please consider delegating to our validator ⚛️