From 4883251aca901b3c5b1b626ca4475e6a09d81f98 Mon Sep 17 00:00:00 2001 From: Srijan Samridh Date: Thu, 18 Jul 2024 23:20:56 +0530 Subject: [PATCH] first commit --- README.md | 182 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 182 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..daad969 --- /dev/null +++ b/README.md @@ -0,0 +1,182 @@ +# 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](https://github.com/cosmology-tech/create-cosmos-app) to help you build high-quality Cosmos apps fast! + +## βš™οΈ Configuration + +Check out [our docs here](https://docs.cosmology.zone/cosmos-kit/get-started) to configure CosmosKit. + +## βš›οΈ CosmJS Signers + +If you want to get a cosmjs stargate or cosmwasm signer, [here are docs for our hooks](https://docs.cosmology.zone/cosmos-kit/hooks) + +## πŸ“¦ Packages + +| Name | Description | +| --- | --- | +| [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit/tree/main/packages/cosmos-kit) | Single package for React developers to install Cosmos Kit | +| [@cosmos-kit/core](https://github.com/cosmology-tech/cosmos-kit/tree/main/packages/core) | Core Cosmos Kit functionality | +| [@cosmos-kit/walletconnect](https://github.com/cosmology-tech/cosmos-kit/tree/main/packages/walletconnect) | Mobile WalletConnect support for the Cosmos ecosystem | +| [@cosmos-kit/react](https://github.com/cosmology-tech/cosmos-kit/tree/main/packages/react) | React integration with Interchain UI Modal for simple usage | +| [@cosmos-kit/react-lite](https://github.com/cosmology-tech/cosmos-kit/tree/main/packages/react-lite) | A lightweight version of React integration without UI for customization | + +## πŸ“¦ Wallets + +Explore the range of wallet adapters available in our [wallets directory](https://github.com/cosmology-tech/cosmos-kit/tree/main/wallets). + +

+ + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +

+ + +## πŸ”Œ Integrating Wallets + +See our docs on [integrating your wallet](https://docs.cosmology.zone/cosmos-kit/integrating-wallets) + +### πŸš€ Running Example + +For high-level examples suitable for most developers, explore our [create-cosmos-app](https://github.com/cosmology-tech/create-cosmos-app). For a deeper, more technical understanding, this repository contains an example, which is also useful when integrating new wallets. + +```sh +yarn build +cd packages/example +yarn dev +``` + +#### [Basic Next.js Example](https://github.com/cosmology-tech/cosmos-kit/tree/main/packages/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](https://github.com/cosmology-tech/cosmos-kit/tree/main/packages/example/pages/wallet-manager) + +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: + +```sh +# Clone the repo. +git clone https://github.com/cosmology-tech/cosmos-kit +cd cosmos-kit +yarn +``` + +### Building + +```sh +yarn build +``` + +### Publishing + +``` +lerna publish +# lerna publish minor +# lerna publish major +``` + +## Related + +Checkout these related projects: + +- [@cosmology/telescope](https://github.com/cosmology-tech/telescope) Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules. +- [@cosmwasm/ts-codegen](https://github.com/CosmWasm/ts-codegen) Convert your CosmWasm smart contracts into dev-friendly TypeScript classes. +- [chain-registry](https://github.com/cosmology-tech/chain-registry) Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application. +- [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit) Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface. +- [create-cosmos-app](https://github.com/cosmology-tech/create-cosmos-app) Set up a modern Cosmos app by running one command. +- [interchain-ui](https://github.com/cosmology-tech/interchain-ui) The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit. +- [starship](https://github.com/cosmology-tech/starship) Unified Testing and Development for the Interchain. + +## Credits + +πŸ›  Built by Cosmology β€”Β if you like our tools, please consider delegating to [our validator βš›οΈ](https://cosmology.zone/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. +# Cosmos-Adaptor-POC