@chain-registry/interfaces

The @chain-registry/interfaces module provides TypeScript interfaces that represent the structured data types as defined in the original JSON schema from the cosmos/chain-registry repository. These interfaces are generated to facilitate type-safe development when interacting with chain registry data within TypeScript projects.

Installation

To install the @chain-registry/interfaces module, run the following command in your project directory:

npm install @chain-registry/interfaces

Usage

Once installed, you can import the interfaces into your TypeScript project to ensure type safety and auto-completion within your IDE.

Example of using an interface:

import { Chain } from '@chain-registry/interfaces';

function displayChainInfo(chain: Chain) {
    console.log(`Chain Name: ${chain.chain_name}`);
    console.log(`Chain ID: ${chain.chain_id}`);
    // Add more fields as necessary
}

// Example usage with dummy data
const cosmosHub: Chain = {
    chain_name: "Cosmos Hub",
    chain_id: "cosmoshub-4",
    bech32_prefix: "cosmos",
    // Assume other necessary fields are filled in
};

displayChainInfo(cosmosHub);

Checkout these related projects:

@cosmology/telescope Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
@cosmwasm/ts-codegen Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.
chain-registry Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
cosmos-kit Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
create-cosmos-app Set up a modern Cosmos app by running one command.
interchain-ui The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
starship Unified Testing and Development for the Interchain.

Credits

🛠 Built by Cosmology — if you like our tools, please consider delegating to our validator ⚛️

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.