Skip to content

Latest commit

 

History

History
257 lines (179 loc) · 12.4 KB

README.md

File metadata and controls

257 lines (179 loc) · 12.4 KB

Interchain Kit


Interchain Kit is a universal wallet adapter for developers to build apps that quickly and easily interact with blockchains and wallets.

Interchain Kit is Cosmos Kit 3.0! This is the new and improved version of Cosmos Kit.

🏁 Quickstart

Get started quickly by using create-interchain-app to help you build high-quality web3 apps fast!

⚙️ Configuration

Check out our docs here to configure Interchain Kit.

⚛️ InterchainJS Signers

If you want to get a interchainjs signer, here are docs for our hooks

🖼️ Supported Frameworks

Whether you're developing with React or Vue, Interchain Kit offers tools and components to accelerate your development process and ensure compatibility with multiple blockchains:

React Vue

📦 Packages

Name Description
@interchain-kit/core Core Interchain Kit functionality
@interchain-kit/react React integration with Interchain UI Modal for simple usage
@interchain-kit/vue Vue integration with Interchain UI Modal for simple usage

📦 Wallets

Explore the range of wallet adapters available in our wallets directory.



🔌 Integrating Wallets

See our docs on integrating your wallet

🚀 Running Example

For high-level examples suitable for most developers, explore our create-interchain-app. For a deeper, more technical understanding, this repository contains an example, which is also useful when integrating new wallets.

yarn build
cd packages/example
yarn dev

Basic Vanilla Example

This example demonstrates a Next.js project that integrates the @interchain-kit/react wallet adapter. Note that this example has historically been used by multiple teams to test PRs.

"vanilla" example showing how WalletManager works

This example is ideal for developers looking to create integrations for Vue.js, Svelte, or other frameworks. It uses a basic Next.js setup without relying on React-specific hooks, providing a clear model for building custom integrations.

  • /connect.html - show how WalletManager connect to wallet
  • /account.html - show how WalletManager get account
  • /balance.html = show how to query (get balance)
  • /signing.html = show how to sign (send token)

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(Offline Signer)
    F(Wallet Manager) --- H(Chain Rpc Endpoint)
    F(Wallet Manager) --- J(Chain Bech Address)
Loading

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 <|-- WalletConnect
    BaseWallet <|-- LegerWallet

    class ExtensionWallet {

    }
    class WalletConnect {
      +ISignClient singClient
    }
    class LegerWallet {

    }

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

  
    class KeplrExtensionWallet {

    }
    class KeplrMobileWallet {
  
    }
Loading

🛠 Developing

Checkout the repository and bootstrap the yarn workspace:

# Clone the repo.
git clone https://github.com/hyperweb-io/interchain-kit
cd interchain-kit
yarn
yarn dev:watch

Building

yarn build

Publishing

lerna publish
# lerna publish minor
# lerna publish major

Interchain JavaScript Stack

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

Category Tools Description
Chain Information Chain Registry, Utils, Client Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
Wallet Connectors Interchain Kitbeta, Cosmos Kit Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
Signing Clients InterchainJSbeta, CosmJS A single, universal signing interface for any network
SDK Clients Telescope Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
Starter Kits Create Interchain Appbeta, Create Cosmos App Set up a modern Interchain app by running one command.
UI Kits Interchain UI The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
Testing Frameworks Starship Unified Testing and Development for the Interchain.
TypeScript Smart Contracts Create Hyperweb App Build and deploy full-stack blockchain applications with TypeScript
CosmWasm Contracts CosmWasm TS Codegen 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 ⚛️

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.