Skip to content

Latest commit

 

History

History
181 lines (141 loc) · 9.45 KB

README.md

File metadata and controls

181 lines (141 loc) · 9.45 KB
Raw

cosmos-kit


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

🏁 Quickstart

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

⚙️ Configuration

Check out our docs here to configure CosmosKit.

⚛️ CosmJS Signers

If you want to get a cosmjs stargate or cosmwasm signer, here are docs for our hooks

📦 Packages

Name Description
cosmos-kit Single package for React developers to install Cosmos Kit
@cosmos-kit/core Core Cosmos Kit functionality
@cosmos-kit/walletconnect Mobile WalletConnect support for the Cosmos ecosystem
@cosmos-kit/react React integration with Interchain UI Modal for simple usage
@cosmos-kit/react-lite A lightweight version of React integration without UI for customization

📦 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-cosmos-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 Next.js Example

This example demonstrates a Next.js project that integrates the @cosmos-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.

  • /wallet-manager - Index page for wallet functionality
  • /wallet-manager/wallet-operate - Operate Wallet Directly
  • /wallet-manager/main-wallets - Show All Main Wallets
  • /wallet-manager/wallet-manager - Wallet Manager Without Hook
  • /wallet-manager/wallet-repos - Show All Wallet Repos
  • /wallet-manager/wallet-repo - Show One Wallet Repo

🛠 Developing

Checkout the repository and bootstrap the yarn workspace:

# Clone the repo.
git clone https://github.com/cosmology-tech/cosmos-kit
cd cosmos-kit
yarn

Building

yarn build

Publishing

lerna publish
# lerna publish minor
# lerna publish major

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.