Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cosmjs removal #1

Merged
merged 12 commits into from
Jan 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
22 changes: 11 additions & 11 deletions .github/workflows/run-tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,66 +24,66 @@ jobs:
- name: Install Dependencies
run: |
echo "YARN_ENABLE_IMMUTABLE_INSTALLS=false" >> $GITHUB_ENV
npm install -g create-cosmos-app
npm install -g create-interchain-app

- name: asset-list
run: |
cca --example asset-list --name asset-list
cia --example asset-list --name asset-list
cd asset-list
yarn build

- name: vote-proposal
run: |
cca --example vote-proposal --name vote-proposal
cia --example vote-proposal --name vote-proposal
cd vote-proposal
yarn build

- name: ibc-transfer
run: |
cca --example ibc-transfer --name ibc-transfer
cia --example ibc-transfer --name ibc-transfer
cd ibc-transfer
yarn build

- name: swap-tokens
run: |
cca --example swap-tokens --name swap-tokens
cia --example swap-tokens --name swap-tokens
cd swap-tokens
yarn build

- name: provide-liquidity
run: |
cca --example provide-liquidity --name provide-liquidity
cia --example provide-liquidity --name provide-liquidity
cd provide-liquidity
yarn build

- name: nft
run: |
cca --example nft --name nft
cia --example nft --name nft
cd nft
touch yarn.lock
yarn install
yarn build

- name: authz
run: |
cca --example authz --name authz
cia --example authz --name authz
cd authz
yarn build

- name: connect-chain
run: |
cca --template connect-chain --name connect-chain
cia --template connect-chain --name connect-chain
cd connect-chain
yarn build

- name: connect-multi-chain
run: |
cca --template connect-multi-chain --name connect-multi-chain
cia --template connect-multi-chain --name connect-multi-chain
cd connect-multi-chain
yarn build

- name: website
run: |
cca --boilerplate website --name website
cia --boilerplate website --name website
cd website
yarn build
62 changes: 31 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# create-cosmos-app
# create-interchain-app

<p align="center" width="100%">
<img height="148" src="https://user-images.githubusercontent.com/545047/186589196-e75c9540-86a7-4a71-8096-207be9a4216f.svg" />
</p>

<p align="center" width="100%">
<a href="https://www.npmjs.com/package/create-cosmos-app"><img height="20" src="https://img.shields.io/npm/dt/create-cosmos-app"></a>
<a href="https://github.com/cosmology-tech/create-cosmos-app/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
<a href="https://www.npmjs.com/package/create-cosmos-app"><img height="20" src="https://img.shields.io/github/package-json/v/cosmology-tech/create-cosmos-app?filename=packages%2Fcreate-cosmos-app%2Fpackage.json"></a>
<a href="https://www.npmjs.com/package/create-interchain-app"><img height="20" src="https://img.shields.io/npm/dt/create-interchain-app"></a>
<a href="https://github.com/cosmology-tech/create-interchain-app/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
<a href="https://www.npmjs.com/package/create-interchain-app"><img height="20" src="https://img.shields.io/github/package-json/v/cosmology-tech/create-interchain-app?filename=packages%2Fcreate-interchain-app%2Fpackage.json"></a>
</p>

Set up a modern Cosmos app by running one command ⚛️
Expand All @@ -24,17 +24,17 @@ https://user-images.githubusercontent.com/545047/192061992-f0e1106d-f4b2-4879-ab

## Overview

First, install `create-cosmos-app` globally using npm:
First, install `create-interchain-app` globally using npm:

```sh
npm install -g create-cosmos-app
npm install -g create-interchain-app
```

Then, create your new Cosmos app by running the following command:

```sh
# you can also use `cca` instead of `create-cosmos-app` for shortcut ;)
create-cosmos-app
# you can also use `cia` instead of `create-interchain-app` for shortcut ;)
create-interchain-app
```

During the setup process, you'll be prompted to enter the name of your app. For example:
Expand All @@ -58,17 +58,17 @@ You don’t need to install or configure cosmjs, keplr, nextjs, webpack or Babel

Everything is preconfigured, ready-to-go, so you can focus on your code!

- ⚡️ Connect easily to 20+ wallets via [Cosmos Kit](https://github.com/cosmology-tech/cosmos-kit) — including Ledger, Keplr, Cosmostation, Leap, Trust Wallet, OKX, XDEFI, Exodus, Wallet Connect and more!
- ⚡️ Connect easily to 20+ wallets via [Interchain Kit](https://github.com/cosmology-tech/interchain-kit) — including Ledger, Keplr, Cosmostation, Leap, Trust Wallet, OKX, XDEFI, Exodus, Wallet Connect and more!
- ⚛️ Sign and broadcast with [cosmjs](https://github.com/cosmos/cosmjs) stargate + cosmwasm signers
- 🎨 Build awesome UI with [Interchain UI](https://cosmology.zone/products/interchain-ui) and [Explore Components](https://cosmology.zone/components)
- 🛠 Render pages with [next.js](https://nextjs.org/) hybrid static & server rendering
- 📝 Leverage [chain-registry](https://github.com/cosmology-tech/chain-registry) for Chain and Asset info for all Cosmos chains

## Education & Resources

🎥 [Checkout our videos](https://cosmology.zone/learn) to learn to learn more about `create-cosmos-app` and tooling for building frontends in the Cosmos!
🎥 [Checkout our videos](https://cosmology.zone/learn) to learn to learn more about `create-interchain-app` and tooling for building frontends in the Cosmos!

Checkout [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit) for more docs as well as [cosmos-kit/react](https://github.com/cosmology-tech/cosmos-kit/tree/main/packages/react#signing-clients) for getting cosmjs stargate and cosmjs signers.
Checkout [interchain-kit](https://github.com/cosmology-tech/interchain-kit) for more docs as well as [interchain-kit/react](https://github.com/cosmology-tech/interchain-kit/tree/main/packages/react#signing-clients) for getting cosmjs stargate and cosmjs signers.

## Creating an App

Expand All @@ -77,25 +77,25 @@ To create a new app, you may choose one of the following methods:
### global install

```sh
npm install -g create-cosmos-app
npm install -g create-interchain-app
```

Then run the command:

```sh
create-cosmos-app
create-interchain-app
```

we also made an alias `cca` if you don't want to type `create-cosmos-app`:
we also made an alias `cia` if you don't want to type `create-interchain-app`:

```sh
cca
cia
```

### npx

```sh
npx create-cosmos-app
npx create-interchain-app
```

### npm
Expand All @@ -112,22 +112,22 @@ yarn create cosmos-app

## Examples

The `create-cosmos-app` tool provides a range of examples to help you understand and test various features and integrations. By executing the examples, you can quickly see how to implement specific functionalities in your Cosmos app.
The `create-interchain-app` tool provides a range of examples to help you understand and test various features and integrations. By executing the examples, you can quickly see how to implement specific functionalities in your Cosmos app.

```
cca --example
cia --example
```

If you know the example name, you can do

```
cca --example <example-name>
cia --example <example-name>
```

Alternatively, you can use the shorthand `-e` flag to achieve the same:

```
cca -e <example-name>
cia -e <example-name>
```

This command will generate a new project configured with the selected example, allowing you to dive into the code and functionality right away.
Expand All @@ -142,7 +142,7 @@ Initiate and manage staking operations directly within your application, allowin


```
cca --name stake-example --example stake-tokens
cia --name stake-example --example stake-tokens
```

### Vote Proposal
Expand All @@ -154,7 +154,7 @@ cca --name stake-example --example stake-tokens
Facilitate on-chain governance by enabling users to vote on proposals, enhancing community engagement and decision-making.

```
cca --name vote-example --example vote-proposal
cia --name vote-example --example vote-proposal
```

### Authz
Expand All @@ -166,7 +166,7 @@ cca --name vote-example --example vote-proposal
Leverage the Authz module to grant and manage authorizations, allowing users to perform actions on behalf of others.

```
cca --name authz-example --example authz
cia --name authz-example --example authz
```

### grpc-web and grpc-gateway
Expand All @@ -178,7 +178,7 @@ cca --name authz-example --example authz
Integrate gRPC-web and gRPC-gateway in your app for robust and efficient communication between your Cosmos SDK blockchain and web clients.

```
cca --name grpc-example --example grpc-web-grpc-gateway
cia --name grpc-example --example grpc-web-grpc-gateway
```

### Swap Tokens
Expand All @@ -190,7 +190,7 @@ cca --name grpc-example --example grpc-web-grpc-gateway
Utilize [osmojs](https://github.com/osmosis-labs/osmojs) for streamlined token swapping capabilities within your Osmosis app.

```
cca --name swap-example --example swap-tokens
cia --name swap-example --example swap-tokens
```

### Provide Liquidity
Expand All @@ -202,7 +202,7 @@ cca --name swap-example --example swap-tokens
Use [osmojs](https://github.com/osmosis-labs/osmojs) to enable liquidity provision features, enhancing the DeFi experience in your app.

```
cca --name liquidity-example --example provide-liquidity
cia --name liquidity-example --example provide-liquidity
```

### Asset List
Expand All @@ -214,7 +214,7 @@ cca --name liquidity-example --example provide-liquidity
Create and manage an asset list, offering comprehensive insights into the available assets, and empower your application with Inter-Blockchain Communication (IBC) capabilities for transferring tokens across different chains.

```
cca --name asset-list-example --example asset-list
cia --name asset-list-example --example asset-list
```

### NFT
Expand All @@ -226,14 +226,14 @@ cca --name asset-list-example --example asset-list
Incorporate NFT functionalities into your Stargaze app using [stargazejs](https://github.com/cosmology-tech/stargazejs), enabling seamless NFT minting, transfer, and management.

```
cca --name nft-example --example nft
cia --name nft-example --example nft
```

## Options

| Argument | Description | Default |
|----------------------|------------------------------------------------|------------|
| `--repo` | Set custom repository for cca templates | None |
| `--repo` | Set custom repository for cia templates | None |
| `--install` | Automatically install dependencies | `true` |
| `--printCmd` | Print the command to run after setup | `true` |
| `-n`, `--name` | Provide a project name | None |
Expand Down Expand Up @@ -266,8 +266,8 @@ 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-kit](https://github.com/cosmology-tech/interchain-kit) Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
- [create-interchain-app](https://github.com/cosmology-tech/create-interchain-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.

Expand Down
4 changes: 2 additions & 2 deletions boilerplates/lerna-module/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ 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-kit](https://github.com/cosmology-tech/interchain-kit) Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
* [create-interchain-app](https://github.com/cosmology-tech/create-interchain-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.

Expand Down
4 changes: 2 additions & 2 deletions boilerplates/lerna-tsx-module/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ 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-kit](https://github.com/cosmology-tech/interchain-kit) Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
* [create-interchain-app](https://github.com/cosmology-tech/create-interchain-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.

Expand Down
4 changes: 2 additions & 2 deletions boilerplates/lerna-workspace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ 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-kit](https://github.com/cosmology-tech/interchain-kit) Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
* [create-interchain-app](https://github.com/cosmology-tech/create-interchain-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.

Expand Down
10 changes: 5 additions & 5 deletions boilerplates/telescope/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,9 @@ const {

## Connecting with Wallets and Signing Messages

⚡️ For web interfaces, we recommend using [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit). Continue below to see how to manually construct signers and clients.
⚡️ For web interfaces, we recommend using [interchain-kit](https://github.com/cosmology-tech/interchain-kit). Continue below to see how to manually construct signers and clients.

Here are the docs on [creating signers](https://docs.cosmology.zone/cosmos-kit) in cosmos-kit that can be used with Keplr and other wallets.
Here are the docs on [creating signers](https://docs.cosmology.zone/interchain-kit) in interchain-kit that can be used with Keplr and other wallets.

### Initializing the Stargate Client

Expand All @@ -153,7 +153,7 @@ const stargateClient = await getSigning__CHAIN_UPPER__Client({

To broadcast messages, you can create signers with a variety of options:

* [cosmos-kit](https://docs.cosmology.zone/cosmos-kit) (recommended)
* [interchain-kit](https://docs.cosmology.zone/interchain-kit) (recommended)
* [keplr](https://docs.keplr.app/api/cosmjs.html)
* [cosmjs](https://gist.github.com/webmaster128/8444d42a7eceeda2544c8a59fbd7e1d9)
### Amino Signer
Expand Down Expand Up @@ -306,8 +306,8 @@ 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-kit](https://github.com/cosmology-tech/interchain-kit) Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
* [create-interchain-app](https://github.com/cosmology-tech/create-interchain-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.

Expand Down
Loading
Loading