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

docs(network): add chain documentation #3084

Merged
merged 9 commits into from
Nov 11, 2022
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
- [#3068](https://github.com/ignite/cli/pull/3068) Add configs to generated TS code for working with JS projects
- [#3071](https://github.com/ignite/cli/pull/3071) Refactor `ignite/templates` package.
- [#2892](https://github.com/ignite/cli/pull/2982/) `ignite scaffold vue` and `ignite scaffold react` use v0.4.2 templates
- [#2892](https://github.com/ignite/cli/pull/2982/) `removeSigner()` method added to generated `ts-client`
- [#2892](https://github.com/ignite/cli/pull/2982/) `removeSigner()` method added to generated `ts-client`
- [#3035](https://github.com/ignite/cli/pull/3035) Bump Cosmos SDK to `v0.46.4`.
- [#3037](https://github.com/ignite/cli/pull/3037) Bump `ibc-go` to `v5.0.1`.
- [#2957](https://github.com/ignite/cli/pull/2957) Change generate commands to print the path to the generated code.
Expand All @@ -34,16 +34,18 @@
- [#2944](https://github.com/ignite/cli/pull/2944) Add a new event "update" status option to `pkg/cliui`.
- [#3030](https://github.com/ignite/cli/issues/3030) Remove colon syntax from module scaffolding `--dep` flag.
- [#3025](https://github.com/ignite/cli/issues/3025) Improve config version error handling.
- [#3084](https://github.com/ignite/cli/pull/3084) Add Ignite Chain documentation.

### Breaking Changes

- [#3033](https://github.com/ignite/cli/pull/3033) Remove Cosmos SDK Launchpad version support.

### Fixes


- [#3068](https://github.com/ignite/cli/pull/3068) Fix REST codegen method casing bug
- [#3031](https://github.com/ignite/cli/pull/3031) Move keeper hooks to after all keepers initialized in `app.go`
template.
- [#3031](https://github.com/ignite/cli/pull/3031) Move keeper hooks to after all keepers initialized in `app.go`
template.

## [`v0.25.1`](https://github.com/ignite/cli/releases/tag/v0.25.1)

Expand Down Expand Up @@ -311,10 +313,10 @@ Our new name is **Ignite CLI**!

Updates are required if your chain uses these packages:

- `spm/ibckeeper` is now `pkg/cosmosibckeeper`
- `spm/cosmoscmd` is now `pkg/cosmoscmd`
- `spm/openapiconsole` is now `pkg/openapiconsole`
- `testutil/sample` is now `cosmostestutil/sample`
- `spm/ibckeeper` is now `pkg/cosmosibckeeper`
- `spm/cosmoscmd` is now `pkg/cosmoscmd`
- `spm/openapiconsole` is now `pkg/openapiconsole`
- `testutil/sample` is now `cosmostestutil/sample`

- Updated the faucet HTTP API schema. See API changes
in [fix: improve faucet reliability #1974](https://github.com/ignite/cli/pull/1974/files#diff-0e157f4f60d6fbd95e695764df176c8978d85f1df61475fbfa30edef62fe35cd)
Expand All @@ -335,7 +337,7 @@ Our new name is **Ignite CLI**!
- Added `starport scaffold flutter` to scaffold a Flutter mobile app template
- Parameters can be specified with a new `--params` flag when scaffolding modules (#1716)
- Simulations can be run with `starport chain simulate`
- Set `cointype` for accounts in `config.yml` (#1663)
- Set `cointype` for accounts in `config.yml` (#1663)

### Fixes

Expand Down Expand Up @@ -517,8 +519,7 @@ Our new name is **Ignite CLI**!
automatically take care of building proto files without a need of script in the app's source code.
- Integrated third-party proto-files used by Cosmos SDK modules into Ignite CLI
- Added ability to customize binary name with `build.binary` in `config.yml`
- Added ability to change path to home directory with `
.home` in `config.yml`
- Added ability to change path to home directory with ` .home` in `config.yml`
- Added ability to add accounts by `address` with in `config.yml`
- Added faucet functionality available on port 4500 and configurable with `faucet` in `config.yml`
- Added `starport faucet [address] [coins]` command
Expand Down
237 changes: 237 additions & 0 deletions docs/docs/network/01-chain.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 2
description: Introduction to Ignite Network commands.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 3
description: Ignite Network commands for coordinators.
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 4
description: Ignite Network commands for validators.
---

Expand Down Expand Up @@ -32,9 +32,9 @@ Launch Id Chain Id Source Phase
practice but doesn't need to be unique on Ignite.
- `Source` is the repository URL of the project.
- `Phase` is the current phase of the chain launch. A chain can have 3 different phases:
- `coordinating`: means the chain is open to receive requests from validators
- `launching`: means the chain no longer receives requests but it hasn't been launched yet
- `launched`: means the chain network has been launched
- `coordinating`: means the chain is open to receive requests from validators
- `launching`: means the chain no longer receives requests but it hasn't been launched yet
- `launched`: means the chain network has been launched

---

Expand Down
Binary file added docs/docs/network/assets/generation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/network/assets/genesis.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/network/assets/launch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/network/assets/process.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/network/assets/requests.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.