\n\nThe npm package for the Official Cosmos [chain registry](https://github.com/cosmos/chain-registry)\n\n```\nnpm install theta-registry\n```\n\nA 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.\n\n\n## Features \n\n- 🌐 **Dynamic Loading via [ChainRegistryClient](https://github.com/hyperweb-io/chain-registry/tree/main/v2/packages/client)** - Utilize the client for dynamic data fetching.\n- 📦 **Tree-Shaking Support** - Optimize your bundles and [include only what you need](#tree-shaking-imports-from-chain-registry).\n- 🔌 **Module Compatibility** - Supports both CommonJS and ES Module formats, ensuring compatibility with various JavaScript environments and tools.\n- 🛠 **Utilities for Working with Assets and Chains** - [Comprehensive tools](https://github.com/hyperweb-io/chain-registry/tree/main/v2/packages/client) to manage assets and chains efficiently.\n- 🌎 **Pre-generated Asset Lists with IBC Denominations for All Chains** - Access ready-to-use [asset lists](https://github.com/hyperweb-io/chain-registry/tree/main/v2/packages/assets) across all chains.\n- 🔄 **Conversions for Keplr, Cosmostation** - Easily convert data for use with Keplr and Cosmostation wallets.\n\n## Versions\n\n⚠️ This repository now contains two versions of the chain-registry:\n\n- **v1**: The original version using `snake_case` naming conventions.\n- **v2**: The new, updated version using `camelCase` naming conventions based on developer feedback.\n\n*We encourage developers to migrate to v2 for improved consistency and readability.\n\n## Usage\n\n### Using the `theta-registry`\n\nFetch data from `theta-registry`:\n\n```js\nimport { assets, chains, ibc } from 'theta-registry';\n\nconst assetList = assets.find(({chain_name})=>chain_name==='osmosis');\n\nconsole.log(assetList);\n```\n\nwill output:\n\n```js\n{\n '$schema': '../assetlist.schema.json',\n chainName: 'osmosis',\n assets: [\n {\n description: 'The native token of Osmosis',\n denomUnits: [Array],\n base: 'uosmo',\n name: 'Osmosis',\n display: 'osmo',\n symbol: 'OSMO',\n logoURIs: [Object],\n coingeckoId: 'osmosis'\n },\n {\n denomUnits: [Array],\n base: 'uion',\n name: 'Ion',\n display: 'ion',\n symbol: 'ION',\n logoURIs: [Object],\n coingeckoId: 'ion'\n }\n ]\n}\n```\n\n### Using the `@chain-registry/client` for dynamic data\n\nDynamically fetch data:\n\n```js\nimport { ChainRegistryClient } from '@chain-registry/client';\n\n// create an instance of ChainRegistryClient by passing in the chain names\nconst client = new ChainRegistryClient({\n chainNames: [\n 'osmosis',\n 'juno',\n 'stargaze'\n ]\n});\n\n// chain info, assets and ibc data will be downloaded dynamically by invoking fetchUrls method\nawait client.fetchUrls();\n// get chain data\nconst chain = client.getChain('osmosis');\n// get asset list\nconst assetList = client.getChainAssetList('osmosis');\n// get ibc data\nconst ibcData = client.getChainIbcData('osmosis');\n// get asset list (including ibc assets)\nconst generatedAssetList = client.getGeneratedAssetLists('osmosis');\n```\n\n### Tree-Shaking Imports from `theta-registry`\n\nTree-shaking is a modern JavaScript feature that allows for smaller bundle sizes by only including the code that is actually used in your project. The `theta-registry` package supports tree-shaking, ensuring that only the specified imports are included in your bundle. Below are examples of how to import different datasets according to your needs.\n\n#### Importing Data from Mainnets, Testnets, and Devnets\n\nYou can directly import assets and chain information based on the network type - mainnet, testnet, or devnet. Here’s how you can import data for each network type:\n\n- **Mainnet Chains and Assets**\n```js\nimport { assets, chains } from 'theta-registry/mainnet';\n```\n\n- **Testnet Chains and Assets**\n```js\nimport { assets, chains } from 'theta-registry/testnet';\n```\n\n- **Devnet Chains and Assets**\n```js\nimport { assets, chains } from 'theta-registry/devnet';\n```\n\n#### Importing Specific Data from a Particular Chain\n\nIf you are interested in a specific chain, such as Osmosis on the mainnet, you can import data related to that particular chain only:\n\n- **Chains and Assets from a Specific Mainnet Chain (e.g., Osmosis)**\n```js\nimport { assets, chain } from 'theta-registry/mainnet/osmosis';\n```\n\n- **Only Assets from a Specific Mainnet Chain (e.g., Osmosis)**\n```js\nimport assets from 'theta-registry/mainnet/osmosis/assets';\n```\n\n- **Only Chain Information from a Specific Mainnet Chain (e.g., Osmosis)**\n```js\nimport chain from 'theta-registry/mainnet/osmosis/chain';\n```\n\n#### Importing Data from Non-Cosmos Chains\n\nTo include data from non-Cosmos chains, use the following import:\n\n- **Assets from Non-Cosmos Chains**\n```js\nimport { assets } from 'theta-registry/noncosmos';\n```\n\n## Packages\n\n#### [theta-registry](https://github.com/hyperweb-io/chain-registry/tree/main/v2/packages/chain-registry)\n\nAn npm module for the Official `theta-registry` package for the Cosmos ⚛️\n\n#### [@chain-registry/client](https://github.com/hyperweb-io/chain-registry/tree/main/v2/packages/client)\n\nA Client for `theta-registry` that allows you to dynamically fetch data.\n\n#### [@chain-registry/types](https://github.com/hyperweb-io/chain-registry/tree/main/v2/packages/types)\n\nTypes for `theta-registry`.\n\n#### [@chain-registry/keplr](https://github.com/hyperweb-io/chain-registry/tree/main/v2/packages/keplr)\n\nKeplr integration for the chain-registry returning keplr's `ChainInfo` type from `@chain-registry/types` `Chain` type.\n\n#### [@chain-registry/assets](https://github.com/hyperweb-io/chain-registry/tree/main/v2/packages/assets)\n\nAsset lists for the Cosmos ⚛️\n\n#### [@chain-registry/osmosis](https://github.com/hyperweb-io/chain-registry/tree/main/v2/packages/osmosis)\n\nChain Registry info for Osmosis, including asset lists.\n\n#### [@chain-registry/juno](https://github.com/hyperweb-io/chain-registry/tree/main/v2/packages/juno)\n\nChain Registry info for Juno, including asset lists.\n\n#### [@chain-registry/utils](https://github.com/hyperweb-io/chain-registry/tree/main/v2/packages/utils)\n\nUtility functions for `theta-registry`.\n\n## Developing\n\nCheckout the repository run yarn to initialize the workspace:\n\n```sh\n# Clone the repo.\ngit clone https://github.com/hyperweb-io/chain-registry\nyarn\n```\n\nFirst ensure you have the submodules initialized out before developing:\n\n```\nmake init-submodules\n```\n\n### Building\n\n```sh\nyarn build\n```\n\n### Publishing\n\nFirst, `cd` into the root folder of the project:\n\n```sh\ncd /your/path/to/chain-registry\n```\n\nSecond, update the git submodules:\n\n```sh\ngit submodule update --remote\n```\n\nThird, generate the code:\n\n```sh\nyarn codegen\n```\n\nFinally, commit and publish the code!\n\n```sh\ngit commit -am \"new registry updates\"\nlerna publish\n```\n\n### Updating Submodule Data\n\nUse the following Makefile commands to update the data in the submodules. These commands will ensure that your submodules are synchronized with their respective remote repositories.\n\n- **update-registry**: Updates the submodule to the latest commits of the `cosmos/chain-registry` repository. This should be used to pull the most current production data into your local environment.\n\n```\nmake update-registry\n```\n\n- **update-fixtures**: Updates the submodule to the latest commits of the `hyperweb-io/chain-registry-fixtures` repository. Use this for testing purposes to ensure that your tests are running against stable, controlled data sets.\n\n```\nmake update-fixtures\n```\n\n## Interchain JavaScript Stack ⚛️\n\nA unified toolkit for building applications and smart contracts in the Interchain ecosystem\n\n| Category | Tools | Description |\n|----------------------|------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|\n| **Chain Information** | [**Chain Registry**](https://github.com/hyperweb-io/chain-registry), [**Utils**](https://www.npmjs.com/package/@chain-registry/utils), [**Client**](https://www.npmjs.com/package/@chain-registry/client) | Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application. |\n| **Wallet Connectors**| [**Interchain Kit**](https://github.com/hyperweb-io/interchain-kit)beta, [**Cosmos Kit**](https://github.com/hyperweb-io/cosmos-kit) | Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface. |\n| **Signing Clients** | [**InterchainJS**](https://github.com/hyperweb-io/interchainjs)beta, [**CosmJS**](https://github.com/cosmos/cosmjs) | A single, universal signing interface for any network |\n| **SDK Clients** | [**Telescope**](https://github.com/hyperweb-io/telescope) | Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules. |\n| **Starter Kits** | [**Create Interchain App**](https://github.com/hyperweb-io/create-interchain-app)beta, [**Create Cosmos App**](https://github.com/hyperweb-io/create-cosmos-app) | Set up a modern Interchain app by running one command. |\n| **UI Kits** | [**Interchain UI**](https://github.com/hyperweb-io/interchain-ui) | The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit. |\n| **Testing Frameworks** | [**Starship**](https://github.com/hyperweb-io/starship) | Unified Testing and Development for the Interchain. |\n| **TypeScript Smart Contracts** | [**Create Hyperweb App**](https://github.com/hyperweb-io/create-hyperweb-app) | Build and deploy full-stack blockchain applications with TypeScript |\n| **CosmWasm Contracts** | [**CosmWasm TS Codegen**](https://github.com/CosmWasm/ts-codegen) | Convert your CosmWasm smart contracts into dev-friendly TypeScript classes. |\n\n## Credits\n\n🛠 Built by the [Constructive](https://constructive.io) team — makers of [Hyperweb](https://hyperweb.io)\n\n\n## Disclaimer\n\nAS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.\n\nNo developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.\n","readmeFilename":"README.md"}
![](\"https://user-images.githubusercontent.com/545047/190171475-b416f99e-2831-4786-9ba3-a7ff4d95b0d3.svg\")
\n![](\"https://github.com/hyperweb-io/chain-registry/actions/workflows/run-tests.yml/badge.svg\"){kind=icon}
\n ![](\"https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fconstructive-io%2Flib-count%2Fmain%2Foutput%2Fbadges%2Fproducts%2Fchain-registry%2Ftotal.json\")
\n ![](\"https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fconstructive-io%2Flib-count%2Fmain%2Foutput%2Fbadges%2Fproducts%2Fchain-registry%2Fmonthly.json\")
\n ![](\"https://img.shields.io/badge/license-MIT-blue.svg\"){kind=icon}
![](\"https://img.shields.io/github/package-json/v/hyperweb-io/chain-registry?filename=v2%2Fpackages%2Fchain-registry%2Fpackage.json\")