@chain-registry/utils

@chain-registry/utils

Utility functions for the chain-registry

Usage

import { ChainRegistry, ChainRegistryOptions } from '@chain-registry/utils';

const options: ChainRegistryOptions = {
  urls: [
    'https://raw.githubusercontent.com/cosmos/chain-registry/master/osmosis/chain.json',
    'https://raw.githubusercontent.com/cosmos/chain-registry/master/osmosis/assetlist.json',
    'https://raw.githubusercontent.com/cosmos/chain-registry/master/juno/assetlist.json',
    'https://raw.githubusercontent.com/cosmos/chain-registry/master/secretnetwork/assetlist.json',
    'https://raw.githubusercontent.com/cosmos/chain-registry/master/_IBC/juno-osmosis.json',
    'https://raw.githubusercontent.com/cosmos/chain-registry/master/_IBC/osmosis-secretnetwork.json'
  ]
};
const registry = new ChainRegistry(options);
await registry.fetchUrls();

Fetching Schemata

We currently only support fetching JSON schemas as defined in https://github.com/cosmos/chain-registry. Supported are assetlist.schema.json, chain.schema.json and ibc_data.schema.json.

fetchUrls

You can set the ChainRegistry.urls property and call ChainRegistry.fetchUrls()

registry.urls = [
  // urls to fetch
];
await registry.fetchUrls();

fetch

Or, you can simply call ChainRegistry.fetch()

await registry.fetch('https://some-json-schema.com/some-schema.json');

Asset lists

// generated asset lists
const generated = registry.getGeneratedAssetLists('osmosis');

// you can also get generated assets from ChainInfo object
const chainInfo = registry.getChainInfo('osmosis');
const generatedAssets = chainInfo.assetLists();

Chain info

const chainInfo = registry.getChainInfo('osmosis');

// AssetList[] of the generated assets
chainInfo.assetLists();

// Chain 
chainInfo.chain();

// AssetList[] of the native assets
chainInfo.nativeAssetLists();