@chain-registry/types 0.50.151 → 2.0.2

package/README.md

@@ -10,8 +10,87 @@
   </a>
    <a href="https://github.com/hyperweb-io/chain-registry/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
    <a href="https://www.npmjs.com/package/@chain-registry/types"><img height="20" src="https://img.shields.io/npm/dt/@chain-registry/types"></a>
-   <a href="https://www.npmjs.com/package/@chain-registry/types"><img height="20" src="https://img.shields.io/github/package-json/v/hyperweb-io/chain-registry?filename=v1%2Fpackages%2Ftypes%2Fpackage.json"></a>
+   <a href="https://www.npmjs.com/package/@chain-registry/types"><img height="20" src="https://img.shields.io/github/package-json/v/hyperweb-io/chain-registry?filename=v2%2Fpackages%2Ftypes%2Fpackage.json"></a>
 </p>
 
-types for the chain-registry 
+The `@chain-registry/types` module provides TypeScript types derived from the [`cosmos/chain-registry`](https://github.com/cosmos/chain-registry), formatted with camelCase properties for better integration in JavaScript and TypeScript projects. This module is designed to offer developers easy-to-use types for building applications that interact with blockchain data.
+
+## Installation
+
+To add these types to your project, run the following command:
+
+```sh
+npm install @chain-registry/types
+```
+
+## Usage
+
+The types provided by this package can be imported into your TypeScript files. This allows you to utilize autocomplete features and enhance type-checking in your IDE, making your development process faster and reducing runtime errors.
+
+Here’s how you can use these types in your code:
+
+
+```js
+import { Chain, AssetList } from '@chain-registry/types';
+
+function displayChainDetails(chain: Chain) {
+    console.log(`Chain Name: ${chain.chainName}`);
+    console.log(`Chain ID: ${chain.chainId}`);
+    console.log(`Bech32 Prefix: ${chain.bech32Prefix}`);
+}
+
+function displayAssetDetails(assetList: AssetList) {
+    assetList.assets.forEach(asset => {
+        console.log(`Asset Name: ${asset.name}`);
+        console.log(`Base Denom: ${asset.base}`);
+        console.log(`Display Denom: ${asset.display}`);
+    });
+}
+
+// Usage with hypothetical data
+const sampleChain: Chain = {
+    chainName: "Osmosis",
+    chainId: "osmosis-1",
+    bech32Prefix: "osmo",
+    // Other necessary properties...
+};
+
+const sampleAssetList: AssetList = {
+    chainName: "Osmosis",
+    assets: [
+        { name: "Osmo", symbol: "OSMO", base: "uosmo", display: "osmo" },
+        // More assets...
+    ],
+};
+
+displayChainDetails(sampleChain);
+displayAssetDetails(sampleAssetList);
+```
+
+
+## Interchain JavaScript Stack ⚛️
+
+A unified toolkit for building applications and smart contracts in the Interchain ecosystem
+
+| Category              | Tools                                                                                                                  | Description                                                                                           |
+|----------------------|------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
+| **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. |
+| **Wallet Connectors**| [**Interchain Kit**](https://github.com/hyperweb-io/interchain-kit)<sup>beta</sup>, [**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. |
+| **Signing Clients**          | [**InterchainJS**](https://github.com/hyperweb-io/interchainjs)<sup>beta</sup>, [**CosmJS**](https://github.com/cosmos/cosmjs) | A single, universal signing interface for any network |
+| **SDK Clients**              | [**Telescope**](https://github.com/hyperweb-io/telescope)                                                          | Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules. |
+| **Starter Kits**     | [**Create Interchain App**](https://github.com/hyperweb-io/create-interchain-app)<sup>beta</sup>, [**Create Cosmos App**](https://github.com/hyperweb-io/create-cosmos-app) | Set up a modern Interchain app by running one command. |
+| **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. |
+| **Testing Frameworks**          | [**Starship**](https://github.com/hyperweb-io/starship)                                                             | Unified Testing and Development for the Interchain. |
+| **TypeScript Smart Contracts** | [**Create Hyperweb App**](https://github.com/hyperweb-io/create-hyperweb-app)                              | Build and deploy full-stack blockchain applications with TypeScript |
+| **CosmWasm Contracts** | [**CosmWasm TS Codegen**](https://github.com/CosmWasm/ts-codegen)                                                   | Convert your CosmWasm smart contracts into dev-friendly TypeScript classes. |
+
+## Credits
+
+🛠 Built by Hyperweb (formerly Cosmology) — if you like our tools, please checkout and contribute to [our github ⚛️](https://github.com/hyperweb-io)
+
+## Disclaimer
+
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+
+No 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.
 

package/assetlist.schema.d.ts

@@ -1,9 +1,9 @@
 export interface Asset {
     deprecated?: boolean;
     description?: string;
-    extended_description?: string;
-    denom_units: DenomUnit[];
-    type_asset: "sdk.coin" | "cw20" | "erc20" | "ics20" | "snip20" | "snip25" | "bitcoin-like" | "evm-base" | "svm-base" | "substrate" | "unknown";
+    extendedDescription?: string;
+    denomUnits: DenomUnit[];
+    typeAsset: "sdk.coin" | "cw20" | "erc20" | "ics20" | "snip20" | "snip25" | "bitcoin-like" | "evm-base" | "svm-base" | "substrate" | "sdk.factory" | "bitsong" | "unknown";
     address?: string;
     base: string;
     name: string;
@@ -11,27 +11,27 @@ export interface Asset {
     symbol: string;
     traces?: (IbcTransition | IbcCw20Transition | IbcBridgeTransition | NonIbcTransition)[];
     ibc?: {
-        source_channel: string;
-        dst_channel: string;
-        source_denom: string;
+        sourceChannel: string;
+        dstChannel: string;
+        sourceDenom: string;
     };
-    logo_URIs?: {
+    logoURIs?: {
         png?: string;
         svg?: string;
     };
     images?: {
-        image_sync?: Pointer;
+        imageSync?: Pointer;
         png?: string;
         svg?: string;
         theme?: {
-            primary_color_hex?: string;
-            background_color_hex?: string;
+            primaryColorHex?: string;
+            backgroundColorHex?: string;
             circle?: boolean;
-            dark_mode?: boolean;
+            darkMode?: boolean;
             monochrome?: boolean;
         };
     }[];
-    coingecko_id?: string;
+    coingeckoId?: string;
     keywords?: string[];
     socials?: {
         website?: string;
@@ -49,55 +49,55 @@ export interface DenomUnit {
     aliases?: string[];
 }
 export interface Pointer {
-    chain_name: string;
-    base_denom?: string;
+    chainName: string;
+    baseDenom?: string;
 }
 export interface IbcTransition {
     type: "ibc";
     counterparty: {
-        chain_name: string;
-        base_denom: string;
-        channel_id: string;
+        chainName: string;
+        baseDenom: string;
+        channelId: string;
     };
     chain: {
-        channel_id: string;
+        channelId: string;
         path?: string;
     };
 }
 export interface IbcCw20Transition {
-    type: 'ibc-cw20';
+    type: "ibc-cw20";
     counterparty: {
-        chain_name: string;
-        base_denom: string;
+        chainName: string;
+        baseDenom: string;
         port: string;
-        channel_id: string;
+        channelId: string;
     };
     chain: {
         port: string;
-        channel_id: string;
+        channelId: string;
         path?: string;
     };
 }
 export interface IbcBridgeTransition {
-    type: 'ibc-bridge';
+    type: "ibc-bridge";
     counterparty: {
-        chain_name: string;
-        base_denom: string;
+        chainName: string;
+        baseDenom: string;
         port?: string;
-        channel_id: string;
+        channelId: string;
     };
     chain: {
         port?: string;
-        channel_id: string;
+        channelId: string;
         path?: string;
     };
     provider: string;
 }
 export interface NonIbcTransition {
-    type: 'bridge' | 'liquid-stake' | 'synthetic' | 'wrapped' | 'additional-mintage' | 'test-mintage' | 'legacy-mintage';
+    type: "bridge" | "liquid-stake" | "synthetic" | "wrapped" | "additional-mintage" | "test-mintage" | "legacy-mintage";
     counterparty: {
-        chain_name: string;
-        base_denom: string;
+        chainName: string;
+        baseDenom: string;
         contract?: string;
     };
     chain?: {
@@ -107,6 +107,6 @@ export interface NonIbcTransition {
 }
 export interface AssetList {
     $schema?: string;
-    chain_name: string;
+    chainName: string;
     assets: Asset[];
 }

package/chain.schema.d.ts

@@ -11,21 +11,21 @@ export interface Endpoint {
 export interface Explorer {
     kind?: string;
     url?: string;
-    tx_page?: string;
-    account_page?: string;
-    validator_page?: string;
-    proposal_page?: string;
-    block_page?: string;
+    txPage?: string;
+    accountPage?: string;
+    validatorPage?: string;
+    proposalPage?: string;
+    blockPage?: string;
 }
 export interface FeeToken {
     denom: string;
-    fixed_min_gas_price?: number;
-    low_gas_price?: number;
-    average_gas_price?: number;
-    high_gas_price?: number;
-    gas_costs?: {
-        cosmos_send?: number;
-        ibc_transfer?: number;
+    fixedMinGasPrice?: number;
+    lowGasPrice?: number;
+    averageGasPrice?: number;
+    highGasPrice?: number;
+    gasCosts?: {
+        cosmosSend?: number;
+        ibcTransfer?: number;
     };
 }
 export interface StakingToken {
@@ -35,17 +35,17 @@ export type Repo = string;
 export type Version = string;
 export type Tag = string;
 export interface Sdk {
-    type: 'cosmos' | 'penumbra' | 'other';
+    type: "cosmos" | "penumbra" | "other";
     version?: Version;
     repo?: Repo;
     tag?: Tag;
 }
 export interface Ibc {
-    type: 'go' | 'rust' | 'other';
+    type: "go" | "rust" | "other";
     version?: Version;
     repo?: Repo;
     tag?: Tag;
-    ics_enabled?: ('ics20-1' | 'ics27-1' | 'mauth')[];
+    icsEnabled?: ("ics20-1" | "ics27-1" | "mauth")[];
 }
 export interface Cosmwasm {
     version?: Version;
@@ -55,42 +55,41 @@ export interface Cosmwasm {
     path?: string;
 }
 export interface Consensus {
-    type: 'tendermint' | 'cometbft' | 'sei-tendermint';
+    type: "tendermint" | "cometbft" | "sei-tendermint";
     version?: Version;
     repo?: Repo;
     tag?: Tag;
 }
 export interface Language {
-    type: 'go' | 'rust' | 'solidity' | 'other';
+    type: "go" | "rust" | "solidity" | "other";
     version?: Version;
     repo?: Repo;
     tag?: Tag;
 }
 export interface Binaries {
-    'linux/amd64'?: string;
-    'linux/arm64'?: string;
-    'darwin/amd64'?: string;
-    'darwin/arm64'?: string;
-    'windows/amd64'?: string;
-    'windows/arm64'?: string;
+    "linux/amd64"?: string;
+    "linux/arm64"?: string;
+    "darwin/amd64"?: string;
+    "darwin/arm64"?: string;
+    "windows/amd64"?: string;
+    "windows/arm64"?: string;
 }
 export interface Pointer {
-    chain_name: string;
-    base_denom?: string;
+    chainName: string;
+    baseDenom?: string;
 }
 export interface Chain {
     $schema?: string;
-    chain_name: string;
-    chain_type: 'cosmos' | 'eip155' | 'bip122' | 'polkadot' | 'solana' | 'algorand' | 'arweave' | 'ergo' | 'fil' | 'hedera' | 'monero' | 'reef' | 'stacks' | 'starknet' | 'stellar' | 'tezos' | 'vechain' | 'waves' | 'xrpl' | 'unknown';
-    chain_id: string;
-    pre_fork_chain_name?: string;
-    pretty_name?: string;
+    chainName: string;
+    chainType: "cosmos" | "eip155" | "bip122" | "polkadot" | "solana" | "algorand" | "arweave" | "ergo" | "fil" | "hedera" | "monero" | "reef" | "stacks" | "starknet" | "stellar" | "tezos" | "vechain" | "waves" | "xrpl" | "unknown";
+    chainId?: string;
+    preForkChainName?: string;
+    prettyName?: string;
     website?: string;
-    update_link?: string;
-    status?: 'live' | 'upcoming' | 'killed';
-    network_type?: 'mainnet' | 'testnet' | 'devnet';
-    bech32_prefix?: string;
-    bech32_config?: {
+    status?: "live" | "upcoming" | "killed";
+    networkType?: "mainnet" | "testnet" | "devnet";
+    bech32Prefix?: string;
+    bech32Config?: {
         bech32PrefixAccAddr?: string;
         bech32PrefixAccPub?: string;
         bech32PrefixValAddr?: string;
@@ -98,91 +97,91 @@ export interface Chain {
         bech32PrefixConsAddr?: string;
         bech32PrefixConsPub?: string;
     };
-    daemon_name?: string;
-    node_home?: string;
-    key_algos?: ('secp256k1' | 'ethsecp256k1' | 'ed25519' | 'sr25519' | 'bn254')[];
+    daemonName?: string;
+    nodeHome?: string;
+    keyAlgos?: ("secp256k1" | "ethsecp256k1" | "ed25519" | "sr25519" | "bn254")[];
     slip44?: number;
-    alternative_slip44s?: number[];
+    alternativeSlip44s?: number[];
     fees?: {
-        fee_tokens: FeeToken[];
+        feeTokens: FeeToken[];
     };
     staking?: {
-        staking_tokens: StakingToken[];
-        lock_duration?: {
+        stakingTokens: StakingToken[];
+        lockDuration?: {
             blocks?: number;
             time?: string;
         };
     };
     codebase?: {
-        git_repo?: string;
-        recommended_version?: string;
-        compatible_versions?: string[];
+        gitRepo?: string;
+        recommendedVersion?: string;
+        compatibleVersions?: string[];
         language?: Language;
         binaries?: Binaries;
-        cosmos_sdk_version?: string;
+        cosmosSdkVersion?: string;
         sdk?: Sdk;
         consensus?: Consensus;
-        cosmwasm_version?: string;
-        cosmwasm_enabled?: boolean;
-        cosmwasm_path?: string;
+        cosmwasmVersion?: string;
+        cosmwasmEnabled?: boolean;
+        cosmwasmPath?: string;
         cosmwasm?: Cosmwasm;
         ibc?: Ibc;
         genesis?: {
             name?: string;
-            genesis_url: string;
-            ics_ccv_url?: string;
+            genesisUrl: string;
+            icsCcvUrl?: string;
         };
         versions?: {
             name: string;
             tag?: string;
             height?: number;
             proposal?: number;
-            previous_version_name?: string;
-            next_version_name?: string;
-            recommended_version?: string;
-            compatible_versions?: string[];
+            previousVersionName?: string;
+            nextVersionName?: string;
+            recommendedVersion?: string;
+            compatibleVersions?: string[];
             language?: Language;
-            cosmos_sdk_version?: string;
+            cosmosSdkVersion?: string;
             sdk?: Sdk;
             consensus?: Consensus;
-            cosmwasm_version?: string;
-            cosmwasm_enabled?: boolean;
-            cosmwasm_path?: string;
+            cosmwasmVersion?: string;
+            cosmwasmEnabled?: boolean;
+            cosmwasmPath?: string;
             cosmwasm?: Cosmwasm;
             ibc?: Ibc;
             binaries?: Binaries;
         }[];
     };
     images?: {
-        image_sync?: Pointer;
+        imageSync?: Pointer;
         png?: string;
         svg?: string;
         theme?: {
-            primary_color_hex?: string;
-            background_color_hex?: string;
+            primaryColorHex?: string;
+            backgroundColorHex?: string;
             circle?: boolean;
-            dark_mode?: boolean;
+            darkMode?: boolean;
             monochrome?: boolean;
         };
     }[];
-    logo_URIs?: {
+    logoURIs?: {
         png?: string;
         svg?: string;
     };
     description?: string;
     peers?: {
         seeds?: Peer[];
-        persistent_peers?: Peer[];
+        persistentPeers?: Peer[];
     };
     apis?: {
         rpc?: Endpoint[];
         rest?: Endpoint[];
         grpc?: Endpoint[];
         wss?: Endpoint[];
-        'grpc-web'?: Endpoint[];
-        'evm-http-jsonrpc'?: Endpoint[];
+        grpcWeb?: Endpoint[];
+        evmHttpJsonrpc?: Endpoint[];
     };
     explorers?: Explorer[];
     keywords?: string[];
-    extra_codecs?: ('ethermint' | 'injective')[];
+    extraCodecs?: ("ethermint" | "injective")[];
 }

package/esm/index.js

@@ -1 +1 @@
-export * from './registry';
+export {};

package/esm/versions.schema.js

@@ -0,0 +1 @@
+export {};

package/ibc_data.schema.d.ts

@@ -2,39 +2,39 @@ export interface ChainOperatorInfo {
     address?: string;
 }
 export interface ChainInfo {
-    chain_name: string;
-    client_id: string;
-    connection_id: string;
+    chainName: string;
+    clientId: string;
+    connectionId: string;
 }
 export interface ChannelInfo {
-    channel_id: string;
-    port_id: string;
-    client_id?: string;
-    connection_id?: string;
+    channelId: string;
+    portId: string;
+    clientId?: string;
+    connectionId?: string;
 }
 export interface IBCData {
     $schema?: string;
-    chain_1: ChainInfo;
-    chain_2: ChainInfo;
+    chain1: ChainInfo;
+    chain2: ChainInfo;
     channels: {
-        chain_1: ChannelInfo;
-        chain_2: ChannelInfo;
-        ordering: 'ordered' | 'unordered';
+        chain1: ChannelInfo;
+        chain2: ChannelInfo;
+        ordering: "ordered" | "unordered";
         version: string;
-        fee_version?: string;
+        feeVersion?: string;
         description?: string;
         tags?: {
-            status?: 'live' | 'upcoming' | 'killed';
+            status?: "live" | "upcoming" | "killed";
             preferred?: boolean;
             dex?: string;
             properties?: string;
         };
     }[];
     operators?: {
-        chain_1: ChainOperatorInfo;
-        chain_2: ChainOperatorInfo;
+        chain1: ChainOperatorInfo;
+        chain2: ChainOperatorInfo;
         memo: string;
         name: string;
-        discord_handle?: string;
+        discordHandle?: string;
     }[];
 }

package/index.d.ts

@@ -1,4 +1,5 @@
-export { Asset, AssetList, DenomUnit } from './assetlist.schema';
-export { Chain } from './chain.schema';
-export { ChannelInfo, IBCData as IBCInfo } from './ibc_data.schema';
-export * from './registry';
+export { Asset, AssetList, DenomUnit, Pointer, IbcTransition, IbcCw20Transition, NonIbcTransition } from './assetlist.schema';
+export { Chain, Peer, Endpoint, Explorer, FeeToken, StakingToken } from './chain.schema';
+export { IBCData, ChainOperatorInfo, ChainInfo, ChannelInfo } from './ibc_data.schema';
+export { MemoKeys } from './memo_keys.schema';
+export { Versions } from './versions.schema';

package/index.js

@@ -1,17 +1,2 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./registry"), exports);

package/memo_keys.schema.d.ts

@@ -0,0 +1,11 @@
+export interface MemoKeys {
+    $schema?: string;
+    memoKeys: {
+        key: string;
+        description: string;
+        gitRepo: string;
+        memo: {
+            [key: string]: unknown;
+        };
+    }[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chain-registry/types",
-  "version": "0.50.151",
+  "version": "2.0.2",
   "description": "Chain Registry types",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "homepage": "https://github.com/hyperweb-io/chain-registry",
@@ -33,5 +33,5 @@
     "cosmos",
     "interchain"
   ],
-  "gitHead": "1f1d8c99437916d1762e9af9835f7984fc36c8a7"
+  "gitHead": "06d713a3dcbfd99af7b11a3e8bc542d681d48d71"
 }

package/versions.schema.d.ts

@@ -0,0 +1,69 @@
+export type Repo = string;
+export type Version = string;
+export type Tag = string;
+export interface Sdk {
+    type: "cosmos" | "penumbra" | "other";
+    version?: Version;
+    repo?: Repo;
+    tag?: Tag;
+}
+export interface Ibc {
+    type: "go" | "rust" | "other";
+    version?: Version;
+    repo?: Repo;
+    tag?: Tag;
+    icsEnabled?: ("ics20-1" | "ics27-1" | "mauth")[];
+}
+export interface Cosmwasm {
+    version?: Version;
+    repo?: Repo;
+    tag?: Tag;
+    enabled?: boolean;
+    path?: string;
+}
+export interface Consensus {
+    type: "tendermint" | "cometbft" | "sei-tendermint";
+    version?: Version;
+    repo?: Repo;
+    tag?: Tag;
+}
+export interface Language {
+    type: "go" | "rust" | "solidity" | "other";
+    version?: Version;
+    repo?: Repo;
+    tag?: Tag;
+}
+export interface Binaries {
+    "linux/amd64"?: string;
+    "linux/arm64"?: string;
+    "darwin/amd64"?: string;
+    "darwin/arm64"?: string;
+    "windows/amd64"?: string;
+    "windows/arm64"?: string;
+}
+export interface Versions {
+    $schema?: string;
+    chainName: string;
+    versions: {
+        name: string;
+        tag?: string;
+        height?: number;
+        proposal?: number;
+        previousVersionName?: string;
+        nextVersionName?: string;
+        recommendedVersion?: string;
+        compatibleVersions?: string[];
+        cosmosSdkVersion?: string;
+        sdk?: Sdk;
+        consensus?: Consensus;
+        cosmwasmVersion?: string;
+        cosmwasmEnabled?: boolean;
+        cosmwasmPath?: string;
+        cosmwasm?: Cosmwasm;
+        ibcGoVersion?: string;
+        ibc?: Ibc;
+        language?: Language;
+        icsEnabled?: ("ics20-1" | "ics27-1" | "mauth")[];
+        binaries?: Binaries;
+    }[];
+}

package/versions.schema.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/registry.d.ts

@@ -1,8 +0,0 @@
-import { AssetList } from './assetlist.schema';
-import { Chain } from './chain.schema';
-import { IBCData } from './ibc_data.schema';
-export interface ChainRegistry {
-    assetLists: AssetList[];
-    chains: Chain[];
-    ibcData: IBCData[];
-}