Skip to content

Commit 956aede

Browse files
authored
docs: update spawn install instructions (#2379)
update spawn install instructions
1 parent 3c3db71 commit 956aede

File tree

1 file changed

+48
-9
lines changed

1 file changed

+48
-9
lines changed

docs/docs/consumer-development/create-with-spawn.md

+48-9
Original file line numberDiff line numberDiff line change
@@ -17,27 +17,66 @@ sidebar_position: 1
1717

1818
In this tutorial, we'll create and interact with a new Interchain security enabled blockchain called "consumer", with the token denomination "uconsu".
1919

20-
1. Clone this repo and install
20+
1. Install Spawn
2121

2222
```shell
23-
git clone https://github.com/rollchains/spawn.git
23+
# Install from latest source
24+
git clone https://github.com/rollchains/spawn.git --depth 1 --branch v0.50.10
25+
26+
# Change to this directory
2427
cd spawn
25-
git checkout v0.50.4
28+
29+
# Clear Go modules cache for a fresh install
30+
go clean -modcache
31+
32+
# Install Spawn
2633
make install
34+
35+
# Install Local Interchain (testnet runner)
36+
make get-localic
37+
38+
# Install docker container builder
39+
make get-heighliner
40+
41+
# Verify installations were successful
42+
spawn
43+
44+
local-ic
45+
46+
heighliner
47+
48+
# If you get "command 'spawn' not found", run the following
49+
# Linux / Windows / Some MacOS
50+
echo 'export PATH=$PATH:$(go env GOPATH)/bin' >> ~/.bashrc
51+
source ~/.bashrc
52+
53+
# MacOS
54+
echo 'export PATH=$PATH:$(go env GOPATH)/bin' >> ~/.zshrc
55+
source ~/.zshrc
56+
57+
# Legacy MacOS Go
58+
echo 'export PATH=$PATH:$HOME/go/bin' >> ~/.zshrc
59+
source ~/.zshrc
60+
61+
# Sometimes it can be good to also clear your cache
62+
# especially WSL users
63+
go clean -cache
64+
65+
2766
```
2867

2968
2. Create your chain using the `spawn` command and customize it to your needs!
3069

3170
```shell
32-
GITHUB_USERNAME=<your-github-username>
71+
GITHUB_USERNAME=<your github username>
3372

3473
spawn new consumer \
3574
--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`
75+
--bech32=consu \
76+
--denom=uconsu \
77+
--bin=consumerd \
78+
--disabled=tokenfactory,ibc-packetforward,ibc-ratelimit,cosmwasm,wasm-light-client \
79+
--org=${GITHUB_USERNAME}
4180
```
4281

4382
> _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.

0 commit comments

Comments
 (0)