InterchainJS
A single, universal signing interface for any network. Birthed from the interchain ecosystem for builders. Create adapters for any Web3 network.
Table of Contents
- Introduction
- Overview
- Installation
- Quick Start
- Supported Networks
- Interchain JavaScript Stack ⚛️
- Credits
- Disclaimer
InterchainJS: Universal Signing for Web3
InterchainJS (opens in a new tab) is a universal signing interface designed for seamless interoperability across blockchain networks. It is one of the core libraries of the Interchain JavaScript Stack (opens in a new tab), a modular framework that brings Web3 development to millions of JavaScript developers.
At its core, InterchainJS provides a flexible adapter pattern that abstracts away blockchain signing complexities, making it easy to integrate new networks, manage accounts, and support diverse authentication protocols and signing algorithms—all in a unified, extensible framework.
Overview
InterchainJS sits at the foundation of the Interchain JavaScript Stack (opens in a new tab), a set of tools that work together like nested building blocks:
- InterchainJS (opens in a new tab) → Powers signing across Cosmos, Ethereum (EIP-712), and beyond.
- Interchain Kit (opens in a new tab) → Wallet adapters that connect dApps to multiple blockchain networks.
- Interchain UI (opens in a new tab) → A flexible UI component library for seamless app design.
- Create Interchain App (opens in a new tab) → A developer-friendly starter kit for cross-chain applications.
This modular architecture ensures compatibility, extensibility, and ease of use, allowing developers to compose powerful blockchain applications without deep protocol-specific knowledge.
Visualizing InterchainJS Components
The diagram below illustrates how InterchainJS connects different signer types to various network classes, showcasing its adaptability for a wide range of blockchain environments.
Installation
This guide will walk you through the process of installing and setting up interchainjs for your project.
You can install interchainjs using Yarn:
yarn add interchainjs
yarn add @interchainjs/cosmos
or npm
npm i interchainjs
npm i @interchainjs/cosmos
Quick Start
Using Signers Directly
Create and use signers for transaction signing and broadcasting:
import { DirectSigner } from '@interchainjs/cosmos';
import { Secp256k1HDWallet } from '@interchainjs/cosmos';
import { HDPath } from '@interchainjs/types';
// Create wallet from mnemonic
const wallet = await Secp256k1HDWallet.fromMnemonic(
"your twelve word mnemonic phrase here",
{
derivations: [{
prefix: "cosmos",
hdPath: HDPath.cosmos(0, 0, 0).toString(), // m/44'/118'/0'/0/0
}]
}
);
// Create signer
const signer = new DirectSigner(wallet, {
chainId: 'cosmoshub-4',
queryClient: queryClient,
addressPrefix: 'cosmos'
});
// Sign and broadcast transaction
const result = await signer.signAndBroadcast({
messages: [{
typeUrl: '/cosmos.bank.v1beta1.MsgSend',
value: {
fromAddress: 'cosmos1...',
toAddress: 'cosmos1...',
amount: [{ denom: 'uatom', amount: '1000000' }]
}
}],
fee: {
amount: [{ denom: 'uatom', amount: '5000' }],
gas: '200000'
},
memo: 'Transfer via InterchainJS'
});
console.log('Transaction hash:', result.transactionHash);
Using with External Wallets
For integration with browser wallets like Keplr:
import { DirectSigner } from '@interchainjs/cosmos';
// Get offline signer from Keplr
await window.keplr.enable(chainId);
const offlineSigner = window.keplr.getOfflineSigner(chainId);
// Create signer with offline signer
const signer = new DirectSigner(offlineSigner, {
chainId: 'cosmoshub-4',
queryClient: queryClient,
addressPrefix: 'cosmos'
});
// Use the same signing interface
const result = await signer.signAndBroadcast({
messages: [/* your messages */],
fee: { amount: [{ denom: 'uatom', amount: '5000' }], gas: '200000' }
});
Quick Setup with create-interchain-app
The easiest way to get started is by using the create-interchain-app tool, which sets up a complete project with all necessary dependencies:
npm install -g create-interchain-app
cia --example authz
Then an authz example website will be created and users can take a look how signing clients and helper functions are used.
Supported Networks
Cosmos Network
Feature | Package |
---|---|
Transactions | @interchainjs/cosmos (opens in a new tab) |
Cosmos Types | @interchainjs/cosmos-types (opens in a new tab) |
Migration from @cosmjs | Migration Guide (opens in a new tab) |
Injective Network
Feature | Package |
---|---|
Transactions | @interchainjs/injective (opens in a new tab) |
Ethereum Network
Feature | Package |
---|---|
Transactions | @interchainjs/ethereum (opens in a new tab) |
Developer Documentation
For Contributors and Network Implementers
- Network Implementation Guide - Comprehensive guide for implementing new blockchain network support
- Workflow Builder and Plugins Guide - Plugin-based transaction workflow architecture
- Auth vs. Wallet vs. Signer - Understanding the three-layer architecture
- Tutorial - Using and extending signers in the InterchainJS ecosystem
Architecture and Design
InterchainJS follows a modular, three-layer architecture that separates concerns and enables flexible blockchain integration:
- Auth Layer: Cryptographic operations and key management
- Wallet Layer: Account management and address derivation
- Signer Layer: Transaction building, signing, and broadcasting
This separation allows for maximum flexibility while maintaining type safety and consistent interfaces across different blockchain networks.
Interchain JavaScript Stack ⚛️
A unified toolkit for building applications and smart contracts in the Interchain ecosystem
Category | Tools | Description |
---|---|---|
Chain Information | Chain 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 Connectors | Interchain Kit (opens in a new tab), Cosmos Kit (opens in a new tab) | Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface. |
Signing Clients | InterchainJS (opens in a new tab), CosmJS (opens in a new tab) | A single, universal signing interface for any network |
SDK Clients | Telescope (opens in a new tab) | Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules. |
Starter Kits | Create Interchain App (opens in a new tab), Create Cosmos App (opens in a new tab) | Set up a modern Interchain app by running one command. |
UI Kits | Interchain UI (opens in a new tab) | The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit. |
Testing Frameworks | Starship (opens in a new tab) | Unified Testing and Development for the Interchain. |
TypeScript Smart Contracts | Create Hyperweb App (opens in a new tab) | Build and deploy full-stack blockchain applications with TypeScript |
CosmWasm Contracts | CosmWasm 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.