InterchainJS (Beta ⚡️)
Libraries
Interchain React
Overview

@interchainjs/react

React query helper hooks(Tx, Query) generated by Telescope.

Tree Shakable Helpers

InterchainJS provides tree shakable helper functions to optimize your application's bundle size. These helpers follow a factory pattern that allows modern JavaScript bundlers to eliminate unused code through tree shaking. These helpers improve modularity and optimize performance by allowing you to import only the functionality you need. Tree shakable tutorial video: https://youtu.be/3dRm9HEklMo (opens in a new tab)

How Tree Shakable Helpers Work

Each helper function is individually exported using a create* prefix (e.g., getAllBalances). Each customized hook is individually exported using a use* prefix (e.g., useGetBalance) This pattern enables:

  1. Bundle Size Optimization: Only the functions you import and use are included in your final bundle
  2. Lazy Initialization: Helper functions are only constructed when explicitly called
  3. Customizable Configuration: Each helper can be configured with specific parameters

For example, query helpers are functions that return other functions, constructed with specific parameters:

// Import only what you need
import { getAllBalances } from "@interchainjs/cosmos/bank/v1beta1/query.rpc.func";
 
// Now you can query the blockchain
const balance = await getAllBalances(endpoint, {
  address: "cosmos1addresshere",
});

For example, customized hooks are functions that return the result you want:

// Import only what you need
import { defaultContext } from "@tanstack/react-query";
import { useGetBalance } from "@interchainjs/react/cosmos/bank/v1beta1/query.rpc.react";
 
// Initialize RPC endpoint and address
const { rpcEndpoint } = useQueryHooks(defaultChainName, {
  context: defaultContext,
  enabled: !!address,
});
 
//Now you can get balance by tree shakable hooks
const balanceRes = useGetBalance({
  request: {
    address: address || "",
    denom: "osmo",
  },
  options: {
    context: defaultContext,
    enabled: !!address && !!rpcEndpoint,
    select: ({ balance }) => balance?.amount,
    staleTime: 0,
  },
  clientResolver: rpcEndpoint,
});
 
const balance = balanceRes?.data;

Available Helper Types

InterchainJS provides two main types of tree shakable helpers and customized hooks:

  1. Query Helpers/Customized Hooks: For retrieving data from the blockchain

    import { getValidator } from "@interchainjs/cosmos/staking/v1beta1/query.rpc.func";
import { useGetValidators } from "@interchainjs/react/cosmos/staking/v1beta1/query.rpc.react";

  2. Transaction Helpers/Customized Hooks: For broadcasting transactions

    import { delegate } from "@interchainjs/cosmos/staking/v1beta1/tx.rpc.func";
import { useDelegate } from "@interchainjs/react/cosmos/staking/v1beta1/tx.rpc.react";

Example: Combining Query and Transaction Helpers

Here's how you might use both types together in a staking scenario:

// Import helpers
import { createQueryRpc } from "@interchainjs/cosmos/utils";
import { getValidator } from "@interchainjs/cosmos/staking/v1beta1/query.rpc.func";
import { delegate } from "@interchainjs/cosmos/staking/v1beta1/tx.rpc.func";
 
// Query validator info
const { validator } = await getValidator(endpoint, {
  validatorAddr: "cosmosvaloper1...",
});
 
// Execute delegation
const result = await delegate(
  signingClient,
  signerAddress,
  {
    delegatorAddress: signerAddress,
    validatorAddress: validator.operatorAddress,
    amount: { denom: "uatom", amount: "1000000" },
  },
  fee,
  "Delegation via InterchainJS"
);

By importing only the specific helpers you need, you ensure that your application bundle remains as small and efficient as possible.

Example: Working with keplr using interchainjs-react helper hooks

import { SigningClient } from "@interchainjs/cosmos/signing-client";
import { DirectGenericOfflineSigner } from "@interchainjs/cosmos/types/wallet";
import { MsgSend } from 'interchainjs/cosmos/bank/v1beta1/tx'
import { send } from "interchainjs/cosmos/bank/v1beta1/tx.rpc.func";
 
// Get Keplr offline signer
const keplrOfflineSigner = window.keplr.getOfflineSigner(chainId);
const offlineSigner = new DirectGenericOfflineSigner(keplrOfflineSigner);
 
// Create signing client
const signingClient = await SigningClient.connectWithSigner(
  rpcEndpoint,
  offlineSigner,
  {
    broadcast: {
      checkTx: true,
      deliverTx: true
    }
  }
);
signingClient.addEncoders([MsgSend])
signingClient.addConverters([MsgSend])
 
// Get account info
const accounts = await offlineSigner.getAccounts();
const senderAddress = accounts[0].address;
 
// Build transfer message
const amount = [{
  denom: "uatom",
  amount: (parseFloat(form.amount) * 1000000).toString() // Convert to uatom
}]
 
// Set fee
const fee = {
  amount: [{
    denom: "uatom",
    amount: "5000" // 0.005 ATOM fee
  }],
  gas: "200000"
};
 
// Sign and broadcast transaction
const result = await send(
  signingClient,
  senderAddress,
  { fromAddress: senderAddress, toAddress: form.toAddress, amount },
  fee,
  form.memo || "Transfer ATOM via InterchainJS"
);
 
console.log(result.transactionHash);

Example: Working with keplr using siging client

const transferMsg = {
  typeUrl: "/cosmos.bank.v1beta1.MsgSend",
  value: {
    fromAddress: senderAddress,
    toAddress: form.toAddress,
    amount // amount is the same as in the code above
  }
};
 
// signingClient is the same as in the code above
const result = await signingClient.signAndBroadcast(
  senderAddress,
  [transferMsg],
  fee,
  form.memo || "Transfer ATOM via InterchainJS"
);
console.log(result.transactionHash);

Interchain JavaScript Stack ⚛️

A unified toolkit for building applications and smart contracts in the Interchain ecosystem

CategoryToolsDescription
Chain InformationChain Registry (opens in a new tab), Utils (opens in a new tab), Client (opens in a new tab)Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
Wallet ConnectorsInterchain Kit (opens in a new tab)beta, Cosmos Kit (opens in a new tab)Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
Signing ClientsInterchainJS (opens in a new tab)beta, CosmJS (opens in a new tab)A single, universal signing interface for any network
SDK ClientsTelescope (opens in a new tab)Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
Starter KitsCreate Interchain App (opens in a new tab)beta, Create Cosmos App (opens in a new tab)Set up a modern Interchain app by running one command.
UI KitsInterchain UI (opens in a new tab)The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
Testing FrameworksStarship (opens in a new tab)Unified Testing and Development for the Interchain.
TypeScript Smart ContractsCreate Hyperweb App (opens in a new tab)Build and deploy full-stack blockchain applications with TypeScript
CosmWasm ContractsCosmWasm TS Codegen (opens in a new tab)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 ⚛️ (opens in a new tab)

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.

OverviewOverview