You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The npm package for the Official Cosmos [chain registry](https://github.com/cosmos/chain-registry)
@@ -30,11 +30,11 @@ A unified store of chains info, assets, asset lists, and IBC channels for the Co
30
30
31
31
## Features
32
32
33
-
- 🌐 **Dynamic Loading via [ChainRegistryClient](https://github.com/hyperweb-io/chain-registry/tree/main/v1/packages/client)** - Utilize the client for dynamic data fetching.
33
+
- 🌐 **Dynamic Loading via [ChainRegistryClient](https://github.com/hyperweb-io/chain-registry/tree/main/v2/packages/client)** - Utilize the client for dynamic data fetching.
34
34
- 📦 **Tree-Shaking Support** - Optimize your bundles and [include only what you need](#tree-shaking-imports-from-chain-registry).
35
35
- 🔌 **Module Compatibility** - Supports both CommonJS and ES Module formats, ensuring compatibility with various JavaScript environments and tools.
36
-
- 🛠 **Utilities for Working with Assets and Chains** - [Comprehensive tools](https://github.com/hyperweb-io/chain-registry/tree/main/v1/packages/client) to manage assets and chains efficiently.
37
-
- 🌎 **Pre-generated Asset Lists with IBC Denominations for All Chains** - Access ready-to-use [asset lists](ttps://github.com/hyperweb-io/chain-registry/tree/main/v1/packages/assets) across all chains.
36
+
- 🛠 **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.
37
+
- 🌎 **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.
38
38
- 🔄 **Conversions for Keplr, Cosmostation** - Easily convert data for use with Keplr and Cosmostation wallets.
39
39
40
40
## Versions
@@ -46,14 +46,6 @@ A unified store of chains info, assets, asset lists, and IBC channels for the Co
46
46
47
47
*We encourage developers to migrate to v2 for improved consistency and readability.
48
48
49
-
## Developing
50
-
51
-
First ensure you have the submodules initialized out before developing:
52
-
53
-
```
54
-
make init-submodules
55
-
```
56
-
57
49
## Usage
58
50
59
51
### Using the `chain-registry`
@@ -73,26 +65,26 @@ will output:
73
65
```js
74
66
{
75
67
'$schema':'../assetlist.schema.json',
76
-
chain_name:'osmosis',
68
+
chainName:'osmosis',
77
69
assets: [
78
70
{
79
71
description:'The native token of Osmosis',
80
-
denom_units: [Array],
72
+
denomUnits: [Array],
81
73
base:'uosmo',
82
74
name:'Osmosis',
83
75
display:'osmo',
84
76
symbol:'OSMO',
85
-
logo_URIs: [Object],
86
-
coingecko_id:'osmosis'
77
+
logoURIs: [Object],
78
+
coingeckoId:'osmosis'
87
79
},
88
80
{
89
-
denom_units: [Array],
81
+
denomUnits: [Array],
90
82
base:'uion',
91
83
name:'Ion',
92
84
display:'ion',
93
85
symbol:'ION',
94
-
logo_URIs: [Object],
95
-
coingecko_id:'ion'
86
+
logoURIs: [Object],
87
+
coingeckoId:'ion'
96
88
}
97
89
]
98
90
}
@@ -179,35 +171,35 @@ import { assets } from 'chain-registry/noncosmos';
Copy file name to clipboardExpand all lines: v2/packages/chain-registry/README.md
+42-10Lines changed: 42 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,15 @@ A unified store of chains info, assets, asset lists, and IBC channels for the Co
37
37
- 🌎 **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.
38
38
- 🔄 **Conversions for Keplr, Cosmostation** - Easily convert data for use with Keplr and Cosmostation wallets.
39
39
40
+
## Versions
41
+
42
+
⚠️ This repository now contains two versions of the chain-registry:
43
+
44
+
-**v1**: The original version using `snake_case` naming conventions.
45
+
-**v2**: The new, updated version using `camelCase` naming conventions based on developer feedback.
46
+
47
+
*We encourage developers to migrate to v2 for improved consistency and readability.
48
+
40
49
## Usage
41
50
42
51
### Using the `chain-registry`
@@ -65,7 +74,7 @@ will output:
65
74
name:'Osmosis',
66
75
display:'osmo',
67
76
symbol:'OSMO',
68
-
logoUris: [Object],
77
+
logoURIs: [Object],
69
78
coingeckoId:'osmosis'
70
79
},
71
80
{
@@ -74,7 +83,7 @@ will output:
74
83
name:'Ion',
75
84
display:'ion',
76
85
symbol:'ION',
77
-
logoUris: [Object],
86
+
logoURIs: [Object],
78
87
coingeckoId:'ion'
79
88
}
80
89
]
@@ -162,35 +171,35 @@ import { assets } from 'chain-registry/noncosmos';
First ensure you have the submodules initialized out before developing:
217
+
218
+
```
219
+
make init-submodules
220
+
```
221
+
206
222
### Building
207
223
208
224
```sh
@@ -236,6 +252,22 @@ git commit -am "new registry updates"
236
252
lerna publish
237
253
```
238
254
255
+
### Updating Submodule Data
256
+
257
+
Use 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.
258
+
259
+
-**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.
260
+
261
+
```
262
+
make update-registry
263
+
```
264
+
265
+
-**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.
266
+
267
+
```
268
+
make update-fixtures
269
+
```
270
+
239
271
## Interchain JavaScript Stack ⚛️
240
272
241
273
A unified toolkit for building applications and smart contracts in the Interchain ecosystem
0 commit comments