docs: tooling (#22049)

This commit is contained in:
Julien Robert
2024-10-03 05:05:39 +00:00
committed by GitHub
parent bf95c814f8
commit 3a5a619e9d
6 changed files with 122 additions and 137 deletions
+6 -5
View File
@@ -23,7 +23,7 @@ import "cosmossdk.io/tools/confix/cmd"
Find the following line:
```go
initRootCmd(rootCmd, encodingConfig)
initRootCmd(rootCmd, moduleManager)
```
After that line, add the following:
@@ -39,10 +39,10 @@ An implementation example can be found in `simapp`.
The command will be available as `simd config`.
```tip
:::tip
Using confix directly in the application can have less features than using it standalone.
This is because confix is versioned with the SDK, while `latest` is the standalone version.
```
:::
### Using Confix Standalone
@@ -138,7 +138,7 @@ confix view ~/.simapp/config/client.toml # views the current app client conf
### Maintainer
At each SDK modification of the default configuration, add the default SDK config under `data/v0.XX-app.toml`.
At each SDK modification of the default configuration, add the default SDK config under `data/vXX-app.toml`.
This allows users to use the tool standalone.
### Compatibility
@@ -149,7 +149,8 @@ The recommended standalone version is `latest`, which is using the latest develo
| ----------- | -------------- |
| v0.50 | v0.1.x |
| v0.52 | v0.2.x |
| v2 | v0.2.x |
## Credits
This project is based on the [CometBFT RFC 019](https://github.com/cometbft/cometbft/blob/5013bc3f4a6d64dcc2bf02ccc002ebc9881c62e4/docs/rfc/rfc-019-config-version.md) and their own implementation of [confix](https://github.com/cometbft/cometbft/blob/v0.36.x/scripts/confix/confix.go).
This project is based on the [CometBFT RFC 019](https://github.com/cometbft/cometbft/blob/5013bc3f4a6d64dcc2bf02ccc002ebc9881c62e4/docs/rfc/rfc-019-config-version.md) and their never released own implementation of [confix](https://github.com/cometbft/cometbft/blob/v0.36.x/scripts/confix/confix.go).
+7 -8
View File
@@ -7,22 +7,21 @@ sidebar_position: 1
`cosmovisor` is a process manager for Cosmos SDK application binaries that automates application binary switch at chain upgrades.
It polls the `upgrade-info.json` file that is created by the x/upgrade module at upgrade height, and then can automatically download the new binary, stop the current binary, switch from the old binary to the new one, and finally restart the node with the new binary.
* [Cosmovisor](#cosmovisor)
* [Design](#design)
* [Contributing](#contributing)
* [Setup](#setup)
* [Design](#design)
* [Contributing](#contributing)
* [Setup](#setup)
* [Installation](#installation)
* [Command Line Arguments And Environment Variables](#command-line-arguments-and-environment-variables)
* [Folder Layout](#folder-layout)
* [Usage](#usage)
* [Usage](#usage)
* [Initialization](#initialization)
* [Detecting Upgrades](#detecting-upgrades)
* [Adding Upgrade Binary](#adding-upgrade-binary)
* [Preparing for an Upgrade](#preparing-for-an-upgrade)
* [Auto-Download](#auto-download)
* [Example: SimApp Upgrade](#example-simapp-upgrade)
* [Preparing for an Upgrade](#preparing-for-an-upgrade)
* [Example: SimApp Upgrade](#example-simapp-upgrade)
* [Chain Setup](#chain-setup)
* [Prepare Cosmovisor and Start the Chain](#prepare-cosmovisor-and-start-the-chain)
* [Prepare Cosmovisor and Start the Chain](#prepare-cosmovisor-and-start-the-chain)
* [Update App](#update-app)
## Design