@interchainjs/cosmos
Transaction codec and client to communicate with any cosmos blockchain.
Usage
npm install @interchainjs/cosmos
Example for signing client here:
import { SigningClient as CosmosSigningClient } from "@interchainjs/cosmos/signing-client";
const signingClient = await CosmosSigningClient.connectWithSigner(
await getRpcEndpoint(),
new DirectGenericOfflineSigner(directSigner),
{
registry: [
// as many as possible encoders registered here.
MsgDelegate,
MsgSend,
],
broadcast: {
checkTx: true,
},
}
);
// sign and broadcast
const result = await signingClient.signAndBroadcast(<MESSAGE>[]);
console.log(result.hash); // the hash of TxRaw
Or use the tree shakable helper functions (Most Recommended) we generate in interchainjs libs:
import { SigningClient as CosmosSigningClient } from "@interchainjs/cosmos/signing-client";
import { submitProposal } from "interchainjs/cosmos/gov/v1beta1/tx.rpc.func";
const signingClient = await CosmosSigningClient.connectWithSigner(
await getRpcEndpoint(),
new DirectGenericOfflineSigner(directSigner),
{
// no registry needed here anymore
// registry: [
// ],
broadcast: {
checkTx: true,
},
}
);
// Necessary typeurl and codecs will be registered automatically in the helper functions. Meaning users don't have to register them all at once.
const result = await submitProposal(
signingClient,
directAddress,
{
proposer: directAddress,
initialDeposit: [
{
amount: "1000000",
denom: denom,
},
],
content: {
typeUrl: "/cosmos.gov.v1beta1.TextProposal",
value: TextProposal.encode(contentMsg).finish(),
},
},
fee,
"submit proposal"
);
console.log(result.hash); // the hash of TxRaw
Examples for direct and amino signers here:
import { DirectSigner } from "@interchainjs/cosmos/signers/direct";
// const signer = new DirectSigner(<AUTH>, <ENCODER>[], <RPC_ENDPOINT>); // **ONLY** rpc endpoint is supported for now
const signer = new DirectSigner(
directAuth,
// as many as possible encoders registered here.
[MsgDelegate, TextProposal, MsgSubmitProposal, MsgVote],
rpcEndpoint,
{ prefix: chainInfo.chain.bech32_prefix }
);
const aminoSigner = new AminoSigner(
aminoAuth,
// as many as possible encoders registered here.
[MsgDelegate, TextProposal, MsgSubmitProposal, MsgVote],
// as many as possible converters registered here.
[MsgDelegate, TextProposal, MsgSubmitProposal, MsgVote],
rpcEndpoint,
{ prefix: chainInfo.chain.bech32_prefix }
);
const result = await signer.signAndBroadcast(<MESSAGE>[]);
console.log(result.hash); // the hash of TxRaw
- See @interchainjs/auth to construct
<AUTH>
- See @interchainjs/cosmos-types to construct
<ENCODER>
s and<CONVERTER>
s, and also different message types.
Implementations
- direct signer from
@interchainjs/cosmos/signers/direct
- amino signer from
@interchainjs/cosmos/signers/amino
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)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 Clients | InterchainJS (opens in a new tab)beta, 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)beta, 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.