core

Install

Using npm:

npm install @interchain-kit/core

Using yarn;

yarn add @interchain-kit/core 

Usage

Query

import { assetLists, chains } from '@chain-registry/v2';
import { keplrWallet } from '@interchain-kit/keplr-extension';
import { WalletManager } from '@interchain-kit/core';

const chainName = 'cosmoshub'
const walletName = 'keplr-extension'

const _chains = chains.filter(c => c.chainName === chainName)
const _assetLists = assetLists.filter(c => c.chainName === chainName)
const _wallets = [keplrWallet]

const wm = await WalletManager.create(_chains, _assetLists, _wallets)

const queryClient = await wm.getQueryClient(walletName, chainName)

const account = await wm.getAccount(walletName, chainName)

const { balance } = await queryClient.balance({ address: account.address, denom: 'uosmo' })

console.log(`i have ${balance?.amount}${balance?.denom} in ${chainName}`)

//i have 26589633uosmo in osmosis

Signing

import { assetLists, chains } from '@chain-registry/v2';
import { keplrWallet } from '@interchain-kit/keplr-extension';
import { WalletManager } from '@interchain-kit/core';

const chainName = 'osmosis'
const walletName = 'keplr-extension'

const _chains = chains.filter(c => c.chainName === chainName)
const _assetLists = assetLists.filter(c => c.chainName === chainName)
const _wallets = [keplrWallet]

const wm = await WalletManager.create(_chains, _assetLists, _wallets)

const cosmosSigningClient = await wm.getSigningCosmosClient(walletName, chainName)

const signerAccount = await wm.getAccount(walletName, chainName)

const receiveAddress = 'osmo1zx6zx6zx6zx6zx6zx6z6zx6xz6zx6zx6'

const fee = {
    amount: [
        {
            denom: 'uosmo',
            amount: '2500',
        },
    ],
    gas: '550000',
};

const token = {
    amount: '1000',
    denom: 'uosmo',
};

const message = { fromAddress: signerAccount.address, toAddress: receiveAddress, amount: [token] }

await cosmosSigningClient.helpers.send(signerAccount.address, message, fee, 'hello world')

Developing

When first cloning the repo:

yarn
yarn build

Related

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.

Overview

flowchart TD

    D(Chain Registry - Chain) --- F(Wallet Manager)
    E(Chain Registry - Asset) --- F(Wallet Manager)

    A(Keplr Wallet Extension) --- AA(Keplr Wallet Class) --- F(Wallet Manager)
    B(Leap Wallet Extension) --- BB(Leap Wallet Class) --- F(Wallet Manager)
    C(Wallet Connect Extension) --- CC(Wallet Connect Class) --- F(Wallet Manager)


    F(Wallet Manager) --- G(Query Client)
    F(Wallet Manager) --- H(Transaction Client)

UML

classDiagram
    class BaseWallet{
        <<abstract>>
        +init(meta?: unknown)

        +connect(chainId: string | string[])

        +disconnect(chainId: string | string[])

        +getAccount(chainId: string)

        +getAccounts(chainIds: string[])

        +getSimpleAccount(chainId: string) 

        +getOfflineSignerAmino(chainId: string)

        +getOfflineSignerDirect(chainId: string)

        +signAmino(chainId: string, signer: string, signDoc: StdSignDoc, signOptions?: SignOptions)

        +signArbitrary(chainId: string, signer: string, data: string | Uint8Array)

        +verifyArbitrary(chainId: string, signer: string, data: string | Uint8Array)

        +signDirect(chainId: string, signer: string, signDoc: DirectSignDoc, signOptions?: SignOptions)

        +sendTx(chainId: string, tx: Uint8Array, mode: BroadcastMode): Promise<Uint8Array>

        +addSuggestChain(chainInfo: ChainInfo)

        +bindingEvent()

        +unbindingEvent()
    }

    BaseWallet <|-- ExtensionWallet
    BaseWallet <|-- MobileWallet

    class ExtensionWallet {

    }
    class MobileWallet {
      +ISignClient singClient
    }

    ExtensionWallet <|-- KeplrExtensionWallet
    ExtensionWallet <|-- LeapExtensionWallet

    MobileWallet <|-- KeplrMobileWallet
    MobileWallet <|-- LeapMobileWallet

    class KeplrExtensionWallet {

    }
    class KeplrMobileWallet {
  
    }

    class LeapExtensionWallet {

    }
    class LeapMobileWallet {
  
    }

    class CosmosSigner {
      <<interface>>
    }
    class EthereumSinger {
      <<interface>>
    }
    class EthermintSIgner {
      <<interface>>
    }