Skip to content

Commit

Permalink
docs: network command (ignite#2890)
Browse files Browse the repository at this point in the history
* docs: `network` command

I've decided to have the most straightforward tutorial in the command description, mainly because users need to know what to look for in the documentation. It may be extracted into a separate article in the docs. In that case, we'll still need to have a link to that article in this cmd doc.

* Update ignite/cmd/network.go

Co-authored-by: Lucas Bertrand <[email protected]>

* format

Co-authored-by: Lucas Bertrand <[email protected]>
Co-authored-by: Alex Johnson <[email protected]>
  • Loading branch information
3 people authored Oct 13, 2022
1 parent 3e4356a commit 2a3c5b6
Showing 1 changed file with 49 additions and 2 deletions.
51 changes: 49 additions & 2 deletions ignite/cmd/network.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,55 @@ func NewNetwork() *cobra.Command {
c := &cobra.Command{
Use: "network [command]",
Aliases: []string{"n"},
Short: "Launch a blockchain network in production",
Args: cobra.ExactArgs(1),
Short: "Launch a blockchain in production",
Long: `
Ignite Network commands allow to coordinate the launch of sovereign Cosmos blockchains.
To launch a Cosmos blockchain you need someone to be a coordinator and others to
be validators. These are just roles, anyone can be a coordinator or a validator.
A coordinator publishes information about a chain to be launched on the Ignite
blockchain, approves validator requests and coordinates the launch. Validators
send requests to join a chain and start their nodes when a blockchain is ready
for launch.
To publish the information about your chain as a coordinator run the following
command (the URL should point to a repository with a Cosmos SDK chain):
ignite network chain publish github.com/ignite/example
This command will return a launch identifier you will be using in the following
commands. Let's say this identifier is 42.
Next, ask validators to initialize their nodes and request to join the network
as validators. For a testnet you can use the default values suggested by the
CLI.
ignite network chain init 42
ignite network chain join 42 --amount 95000000stake
As a coordinator list all validator requests:
ignite network request list 42
Approve validator requests:
ignite network request approve 42 1,2
Once you've approved all validators you need in the validator set, announce that
the chain is ready for launch:
ignite network chain launch 42
Validators can now prepare their nodes for launch:
ignite network chain prepare 42
The output of this command will show a command that a validator would use to
launch their node, for example “exampled --home ~/.example”. After enough
validators launch their nodes, a blockchain will be live.
`,
Args: cobra.ExactArgs(1),
}

// configure flags.
Expand Down

0 comments on commit 2a3c5b6

Please sign in to comment.