From 1e53389358c865a6c329b892d50b44966a65aa73 Mon Sep 17 00:00:00 2001 From: filipdjokic Date: Thu, 7 Aug 2025 11:54:42 +0200 Subject: [PATCH 1/7] docs: Add instructions for v4 mainnet upgrade --- docs/upgrades/upgrade-guides/v4.x-upgrade.md | 87 ++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 docs/upgrades/upgrade-guides/v4.x-upgrade.md diff --git a/docs/upgrades/upgrade-guides/v4.x-upgrade.md b/docs/upgrades/upgrade-guides/v4.x-upgrade.md new file mode 100644 index 0000000..f665b24 --- /dev/null +++ b/docs/upgrades/upgrade-guides/v4.x-upgrade.md @@ -0,0 +1,87 @@ +# Introducing the v4.x Protocol Release! 🚀 + +This upgrade moved cheqd to support **Cosmos SDK v0.50 "Eden"**. + +**Cosmos SDK v0.50** is a long-term support version bringing major improvements in performance, developer experience, and modularity. Key features include **ABCI++** for more flexible and efficient consensus and **IAVL 1.0** for faster and more efficient data storage. It also adds **Optimistic Execution** to reduce block times and **Sign Mode Textual** for clearer, more secure transaction signing. This release sets a solid foundation for building faster, more customizable applications on cheqd. + +We also **enhanced our DIDs** to support a more flexible **service section**, enabling direct connections to `did:cheqd` DIDs using **DIDComm**. This enhancement brings full cheqd support for **DIDComm endpoint discovery**, making it easier for apps and SDKs like **ACA-Py** and **Credo** to integrate seamless messaging and communication. + +You can find more technical details about this upgrade on our [product docs page](https://docs.cheqd.io/product/network/upgrades/2025/4.x). + +## Actions that should be taken + +- If you're running your node with Cosmovisor and have the binary auto-download feature enabled, **no action is required**. + +- In case you run standalone node, you can download the `v4.1.1` binary from our [GitHub Releases page](https://github.com/cheqd/cheqd-node/releases/tag/v4.1.1) and replace them manually on your node. + +### ⚠️ Potential errors with binary auto download on Cosmovisor v1.7.1 + +In case you are running Cosmovisor **v1.7.1**, you might see one potential error when upgrade height is reached. +Apparently, even though binary is correctly downloaded to `/home/cheqd/.cheqdnode/cosmovisor/upgrades/v4`, the wrong file (the LICENSE file) gets copied to `bin/cheqd-noded`. As a result, your node won’t start after the upgrade. + +We suspect this issue is related to upstream Cosmos SDK `x/upgrade` module, and we will investigate separately of this release. + +> **ℹ️** This does not present a danger to your node state, but node won't start until you replace binaries. + +### 🛠️ How to Prevent This Issue + +You have two options: + +1) **Re-run [interactive installer](https://raw.githubusercontent.com/cheqd/cheqd-node/refs/heads/main/installer/installer.py)** to make sure you're running Cosmovisor v1.3.0 **before upgrade height is reached**. If you already used interactive installer, just make sure to download the latest one from the link above. + +2) Alternatively, you can **replace binaries when upgrade height is reached**. You can achieve this with one simple command: + + ```bash + cp -P /home/cheqd/.cheqdnode/cosmovisor/upgrades/v4/cheqd-noded /home/cheqd/.cheqdnode/cosmovisor/upgrades/v4/bin/cheqd-noded + ``` + + To confirm this resolved you issue, just run this: + + ```bash + cheqd-noded version + ``` + +### Check Cosmovisor version + +To determine whether you need to take any action, check your current Cosmovisor version: + +```bash + cosmovisor --help +``` + +If you're running version **later than v1.3.0**, you will see output like this: + +```text + Available Commands: + add-batch-upgrade Add multiple upgrade binaries at specified heights to cosmovisor + add-upgrade Add APP upgrade binary to cosmovisor + completion Generate the autocompletion script for the specified shell + config Display cosmovisor config. + help Help about any command + init Initialize a cosmovisor daemon home directory. + prepare-upgrade Prepare for the next upgrade + run Run an APP command. + show-upgrade-info Display current upgrade-info.json from data directory + version Display cosmovisor and APP version. +``` + +**In v1.3.0**, these upgrade-related commands are **not available** (add-batch-upgrade, add-upgrade, prepare-upgrade): + +```text + Available Commands: + completion Generate the autocompletion script for the specified shell + help Help about any command + init Initializes a cosmovisor daemon home directory. + run Run an APP command. + version Prints the version of Cosmovisor. +``` + +To summarize, If you see the second (shorter) output above, you're good to go! ✅ + +If not, refer back to the previous section and either: + +- Roll back to v1.3.0, or +- Manually replace the binaries at the upgrade height. + +If anything's unclear or if you face any additional issues, you can always ask for support on our [#mainnet-operators](https://discord.com/channels/879754359859216394/943432923565154354) Discord channel! +Also, follow the updates on [our status page](https://status.cheqd.net) and [🔊mainnet-upgrades](https://discord.com/channels/879754359859216394/1394975809139249215) Discord channel. From cc719569d92220492c4ecbfa90d23f053f8ee328 Mon Sep 17 00:00:00 2001 From: filipdjokic Date: Thu, 7 Aug 2025 11:58:40 +0200 Subject: [PATCH 2/7] Addtional exlpanation --- docs/upgrades/upgrade-guides/v4.x-upgrade.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/upgrades/upgrade-guides/v4.x-upgrade.md b/docs/upgrades/upgrade-guides/v4.x-upgrade.md index f665b24..7156668 100644 --- a/docs/upgrades/upgrade-guides/v4.x-upgrade.md +++ b/docs/upgrades/upgrade-guides/v4.x-upgrade.md @@ -27,7 +27,7 @@ We suspect this issue is related to upstream Cosmos SDK `x/upgrade` module, and You have two options: -1) **Re-run [interactive installer](https://raw.githubusercontent.com/cheqd/cheqd-node/refs/heads/main/installer/installer.py)** to make sure you're running Cosmovisor v1.3.0 **before upgrade height is reached**. If you already used interactive installer, just make sure to download the latest one from the link above. +1) **Re-run [interactive installer](https://raw.githubusercontent.com/cheqd/cheqd-node/refs/heads/main/installer/installer.py)** to make sure you're running Cosmovisor v1.3.0 **before upgrade height is reached**. You will get asked if you want to roll back to Cosmovisor v1.3.0. If you already used interactive installer, just make sure to download the latest one from the link above, before the execution. 2) Alternatively, you can **replace binaries when upgrade height is reached**. You can achieve this with one simple command: From 78ad7c986c518706db35e04afa5fc06ab3799397 Mon Sep 17 00:00:00 2001 From: filipdjokic Date: Thu, 7 Aug 2025 12:06:53 +0200 Subject: [PATCH 3/7] Fix dead links --- docs/validator-guide/backup-and-restore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/validator-guide/backup-and-restore.md b/docs/validator-guide/backup-and-restore.md index 3daadfb..b2dc254 100644 --- a/docs/validator-guide/backup-and-restore.md +++ b/docs/validator-guide/backup-and-restore.md @@ -68,7 +68,7 @@ nano ### Pre-requisites -Before you get started with this guide, make sure you've [installed HashiCorp Vault CLI](https://developer.hashicorp.com/vault/docs/install) on the validator you want to run backups from. +Before you get started with this guide, make sure you've [installed HashiCorp Vault CLI](https://developer.hashicorp.com/vault/docs/commands) on the validator you want to run backups from. You also need a running HashiCorp Vault server cluster you can use to proceed with this guide. From 6a1e4cf12bd3076942cd4910c7b9c4f04036166f Mon Sep 17 00:00:00 2001 From: filipdjokic Date: Thu, 7 Aug 2025 12:08:11 +0200 Subject: [PATCH 4/7] Add v4.x guide to summary --- docs/upgrades/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/upgrades/README.md b/docs/upgrades/README.md index b5db1b6..994c721 100644 --- a/docs/upgrades/README.md +++ b/docs/upgrades/README.md @@ -24,3 +24,4 @@ You can find more details on the actual upgrade process under in our [Upgrade Pr - [v2.x Upgrade Guide](upgrade-guides/v2.x-upgrade.md) - [v3.x Upgrade Guide](upgrade-guides/v3.x-upgrade.md) - [v3.1.x Upgrade Guide](upgrade-guides/v3.1.x-upgrade.md) +- [v4.x Upgrade Guide](upgrade-guides/v4.x-upgrade.md) From 365ffaaedda093b6da2eec695214881b0bb85645 Mon Sep 17 00:00:00 2001 From: filipdjokic Date: Thu, 7 Aug 2025 12:09:51 +0200 Subject: [PATCH 5/7] Add v4.x guide to README --- docs/upgrades/upgrade-guides/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/upgrades/upgrade-guides/README.md b/docs/upgrades/upgrade-guides/README.md index a0cf0e9..41cddc5 100644 --- a/docs/upgrades/upgrade-guides/README.md +++ b/docs/upgrades/upgrade-guides/README.md @@ -8,3 +8,4 @@ This section lists **previous** software upgrade proposals and specific instruct - [v2.x Upgrade Guide](./v2.x-upgrade.md) - [v3.x Upgrade Guide](./v3.x-upgrade.md) - [v3.1.x Upgrade Guide](./v3.1.x-upgrade.md) +- [v4.x Upgrade Guide](./v4.x-upgrade.md) From da5caf9b451069650bfe91c7ac3acfb54a6c70f2 Mon Sep 17 00:00:00 2001 From: filipdjokic Date: Thu, 7 Aug 2025 12:11:45 +0200 Subject: [PATCH 6/7] Add v4.x guide to root README.md --- SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/SUMMARY.md b/SUMMARY.md index 750c2da..6b0da71 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -31,6 +31,7 @@ * [Upgrade to v2.x (with Ubuntu 24.04 LTS upgrade)](docs/upgrades/upgrade-guides/v2.x-upgrade.md) * [Upgrade to v3.x](docs/upgrades/upgrade-guides/v3.x-upgrade.md) * [Upgrade to v3.1.x](docs/upgrades/upgrade-guides/v3.1.x-upgrade.md) + * [Upgrade to v4.x](docs/upgrades/upgrade-guides/v4.x-upgrade.md) * [Creating a software upgrade proposal](docs/upgrades/propose-software-upgrade.md) * [Upgrade Process](docs/upgrades/upgrade-process.md) From ebebf295ece65d3e0c447259c5e9fed1f5cffa8d Mon Sep 17 00:00:00 2001 From: filipdjokic Date: Thu, 7 Aug 2025 12:21:35 +0200 Subject: [PATCH 7/7] Another dead link --- CONTRIBUTING.md | 2 +- docs/upgrades/upgrade-guides/v4.x-upgrade.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f43e789..6dd0f83 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ You can get help for any questions or problems that you have on through the foll - Check if your question/problem is already covered under our documentation sites: - [Node / cheqd network](https://docs.cheqd.io/node) - [Identity features / SDKs](https://docs.cheqd.io/identity) - - [Governance Framework](https://docs.cheqd.io/governance/) + - [Governance Framework](https://learn.cheqd.io/governance/start/) - [Product Suite & Updates](https://product.cheqd.io) - [Learn about cheqd](https://learn.cheqd.io) (basics for general audience) - Raise a bug report or feature request using the "Issue" tab on Github diff --git a/docs/upgrades/upgrade-guides/v4.x-upgrade.md b/docs/upgrades/upgrade-guides/v4.x-upgrade.md index 7156668..43759cd 100644 --- a/docs/upgrades/upgrade-guides/v4.x-upgrade.md +++ b/docs/upgrades/upgrade-guides/v4.x-upgrade.md @@ -76,7 +76,7 @@ If you're running version **later than v1.3.0**, you will see output like this: version Prints the version of Cosmovisor. ``` -To summarize, If you see the second (shorter) output above, you're good to go! ✅ +To summarize, if you see the second (shorter) output above, you're good to go! ✅ If not, refer back to the previous section and either: