Skip to main content

​
IBC

Inter-Blockchain Communication Protocol (IBC) is a blockchain interoperability protocol used by 110+ chains. It enables secure, permissionless, feature-rich cross-chain interactions.

​
Creating the SDK instance

I’ll be using the Stargaze testnet for the examples. 
import { IBC } from "@kynesyslabs/demosdk/xm-websdk"

const rpc_url = "https://rpc.elgafar-1.stargaze-apis.com"

const instance = await IBC.create(rpc_url)
The instance is now connected to the Stargaze testnet and ready to be used.

​
Connecting your wallet

You can connect your wallet using a mnemonic or a private key as shown below. 
const mnemonic = "stumble august fancy ..."

await instance.connectWallet(mnemonic, {
    prefix: "stars",
    gasPrice: "0.012ustars",
})
When connecting your wallet, you also need to specify the address prefix for your chain and the gas price to be used when creating transactions.

​
Getting your address

You can get your address using the getAddress method. 
const address = instance.getAddress()

​
Preparing a transaction

You can prepare a transaction using the preparePay method. 
const tx = await instance.preparePay(address, "1", {
    denom: "ustars",
})
When creating a transaction, you need to specify the recipient address, the amount to be transferred, and the token denomination.

​
Preparing multiple transactions

You can prepare multiple transactions using the preparePays method. 
const txs = await instance.preparePays(
    [
        { address: "stars1zyxw...", amount: "1" },
        { address: "stars1abcd...", amount: "1" },
    ],
    {
        denom: "ustars",
    },
)
The preparePays method returns an array of signed transactions ready to be sent to a DEMOS node. The transactions are signed with an incrementing nonce derived from the ledger sequence.

​
Signing Messages

const message = "Hello, world!"

// Signing
const signature = await instance.signMessage(message, {
    privateKey: "<mnemonic here>",
})

console.log(signature)

​
Verifying signature


// Get account public key
const sep256k1HdWallet = await DirectSecp256k1HdWallet.fromMnemonic(
    wallets.ibc.privateKey,
    {
        prefix: "stars", // network prefix here
    },
)

const walletAccounts = await sep256k1HdWallet.getAccounts()
const currentAccount = walletAccounts.find(account =>
    account.address.startsWith("stars"),
)

const pubKey = currentAccount?.pubkey
const ibcBase64PublicKey = Buffer.from(pubKey).toString("base64")

// Verifying signature
const verified = await instance.verifyMessage(
    message,
    signature,
    ibcBase64PublicKey,
)

expect(verified).toBe(true)

​
Cleaning up

When you’re done with the SDK instance, you can disconnect your wallet and RPC connection. 
await instance.disconnect()

​
Hacking

The DEMOS IBC SDK is built on top of the CosmJS library, and only provides a limited set of methods to interact with the blockchain. You can access the underlying CosmJS objects to have more control over the transactions and interactions with the blockchain. Here is a list of the objects you can access:
PropertyTypeDescription
instance.providerStargateClientProvides read-only access to blockchain data
instance.walletSigningStargateClientAllows for signing and broadcasting transactions
instance.signerDirectSecp256k1Wallet or DirectSecp256k1HdWalletManages the private key and signing operations

​
Example

To get the latest block, you can use the getBlock method. 
const block = await instance.provider.getBlock()

​
API Reference

https://kynesyslabs.github.io/demosdk-api-ref/classes/xmwebsdk.IBC.html