|
| 1 | +--- |
| 2 | +sidebar_position: 1 |
| 3 | +--- |
| 4 | + |
| 5 | +# Create an ICS chain with Spawn |
| 6 | + |
| 7 | +## Requirements |
| 8 | + |
| 9 | +- [`go 1.22+`](https://go.dev/doc/install) |
| 10 | +- [`Docker`](https://docs.docker.com/get-docker/) |
| 11 | + |
| 12 | +[MacOS + Ubuntu Setup](https://github.com/rollchains/spawn/blob/release/v0.50/docs/versioned_docs/version-v0.50.x/01-setup/01-system-setup.md) |
| 13 | + |
| 14 | +## Getting Started |
| 15 | + |
| 16 | +**Note:** This tutorial focuses on using the Spawn CLI to create an ICS consumer chain. For more complete documentation on Spawn, see the [Spawn documentation](https://rollchains.github.io/spawn/v0.50/). |
| 17 | + |
| 18 | +In this tutorial, we'll create and interact with a new Interchain security enabled blockchain called "consumer", with the token denomination "uconsu". |
| 19 | + |
| 20 | +1. Clone this repo and install |
| 21 | + |
| 22 | +```shell |
| 23 | +git clone https://github.com/rollchains/spawn.git |
| 24 | +cd spawn |
| 25 | +git checkout v0.50.4 |
| 26 | +make install |
| 27 | +``` |
| 28 | + |
| 29 | +2. Create your chain using the `spawn` command and customize it to your needs! |
| 30 | + |
| 31 | +```shell |
| 32 | +GITHUB_USERNAME=<your-github-username> |
| 33 | + |
| 34 | +spawn new consumer \ |
| 35 | +--consensus=interchain-security \ |
| 36 | +--bech32=consu `# the prefix for addresses` \ |
| 37 | +--denom=uconsu `# the coin denomination to create` \ |
| 38 | +--bin=consumerd `# the name of the binary` \ |
| 39 | +--disabled=tokenfactory,globalfee,ibc-packetforward,ibc-ratelimit,cosmwasm,wasm-light-client,optimistic-execution,ignite-cli `# disable features. [tokenfactory,globalfee,ibc-packetforward,ibc-ratelimit,cosmwasm,wasm-light-client,ignite-cli]` \ |
| 40 | +--org=${GITHUB_USERNAME} `# the github username or organization to use for the module imports, optional` |
| 41 | +``` |
| 42 | + |
| 43 | +> _NOTE:_ `spawn` creates a ready to use repository complete with `git` and GitHub CI. It can be quickly pushed to a new repository getting you and your team up and running quickly. |
| 44 | +
|
| 45 | +3. Spin up a local testnet for your chain |
| 46 | + |
| 47 | +```shell |
| 48 | +cd consumer |
| 49 | + |
| 50 | +# Starts 2 networks for the IBC testnet at http://127.0.0.1:8080. |
| 51 | +# - Builds the docker image of your chain |
| 52 | +# - Launches a testnet with IBC automatically connected and relayed |
| 53 | +# |
| 54 | +# Note: you can run a single node, non IBC testnet, with `make sh-testnet`. |
| 55 | +make testnet |
| 56 | +``` |
| 57 | + |
| 58 | +4. Open a new terminal window and send a transaction on your new chain |
| 59 | + |
| 60 | +```shell |
| 61 | +# list the keys that have been provisioned with funds in genesis |
| 62 | +consumerd keys list |
| 63 | + |
| 64 | +# send a transaction from one account to another |
| 65 | +consumerd tx bank send acc0 $(consumerd keys show acc1 -a) 1337uconsu --chain-id=localchain-1 |
| 66 | + |
| 67 | +# enter "y" to confirm the transaction |
| 68 | +# then query your balances tfor proof the transaction executed successfully |
| 69 | +consumerd q bank balances $(consumerd keys show acc1 -a) |
| 70 | +``` |
| 71 | + |
| 72 | +5. (optional) Send an IBC transaction |
| 73 | + |
| 74 | +```shell |
| 75 | +# submit a cross chain transfer from acc0 to the other address |
| 76 | +consumerd tx ibc-transfer transfer transfer channel-0 cosmos1hj5fveer5cjtn4wd6wstzugjfdxzl0xpxvjjvr 7uconsu --from=acc0 --chain-id=localchain-1 --yes |
| 77 | + |
| 78 | +# Query the other side to confirm it went through |
| 79 | +sleep 10 |
| 80 | + |
| 81 | +# Interact with the other chain without having to install the cosmos binary |
| 82 | +# - Endpoints found at: GET http://127.0.0.1:8080/info |
| 83 | +local-ic interact localcosmos-1 query 'bank balances cosmos1hj5fveer5cjtn4wd6wstzugjfdxzl0xpxvjjvr' --api-endpoint=http://127.0.0.1:8080 |
| 84 | +``` |
| 85 | + |
| 86 | +6. Push your new chain to a github repository |
| 87 | + |
| 88 | +```shell |
| 89 | +# Create a new repository on GitHub from the gh cli |
| 90 | +gh repo create ics-consumer --source=. --remote=origin --push |
| 91 | +``` |
| 92 | + |
| 93 | +> You can also push it the old fashioned way with https://github.com/new and `git push origin main`. |
| 94 | +
|
| 95 | +In this tutorial, we configured a new custom chain, launched a testnet for it, tested a simple token transfer, and confirmed it was successful. |
| 96 | +This tutorial demonstrates just how easy it is to create a brand new custom Cosmos-SDK blockchain from scratch, saving developers time. |
| 97 | + |
| 98 | +## Modify your chain |
| 99 | + |
| 100 | +New module code is usually added in the `x/` directory of your repository. |
| 101 | +Check out the [Cosmos SDK documentation](https://docs.cosmos.network/v0.50/build/building-modules/intro) for more information on how to add modules to your chain. |
| 102 | + |
| 103 | +Once you're ready you can preview your chain using the section below. |
| 104 | + |
| 105 | +## List your chain |
| 106 | + |
| 107 | +You can [list your chain on Forge](https://forge.cosmos.network/list-your-chain), even if it's not finished, in the **pre-launch** stage. |
0 commit comments