Skip to content

Commit d0f60ef

Browse files
authored
feat: add v7.0 upgrade guide (#2297)
1 parent 63ea97f commit d0f60ef

6 files changed

Lines changed: 115 additions & 20 deletions

File tree

app/client/docs/config.json

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,6 @@
2828
{
2929
"url": "./app/client/docs/regen/ecocredit/marketplace/v1/query.swagger.json"
3030
},
31-
{
32-
"url": "./app/client/docs/regen/intertx/v1/query.swagger.json",
33-
"operationIds": {
34-
"rename": {
35-
"InterchainAccount": "Intertx/InterchainAccount"
36-
}
37-
}
38-
},
3931
{
4032
"url": "./app/client/docs/swagger-sdk.yaml",
4133
"dereference": {

docs/.vuepress/config.ts

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -131,17 +131,6 @@ export default defineUserConfig({
131131
'/modules/ecocredit/features/',
132132
],
133133
},
134-
{
135-
text: 'Intertx Module',
136-
children: [
137-
{
138-
text: 'Overview',
139-
link: '/modules/intertx/',
140-
},
141-
'/modules/intertx/01_messages',
142-
'/modules/intertx/02_queries',
143-
],
144-
},
145134
],
146135
'/validators/': [
147136
{

docs/README_modules.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ Regen Ledger includes native modules built and maintained within the [regen-ledg
66

77
- [Data Module](data/)
88
- [Ecocredit Module](ecocredit/)
9-
- [Intertx Module](intertx/)
109

1110
## Cosmos SDK
1211

docs/scripts/pre.sh

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,18 @@ for FILE in modules/**/features/server/*; do
4343
sed -i 's/<tradable-credits>/[tradable-credits]/g' $FILE
4444
sed -i 's/<balance-amount>/[balance-amount]/g' $FILE
4545
sed -i 's/<error>/[error]/g' $FILE
46+
sed -i 's/<project-id>/[project-id]/g' $FILE
47+
sed -i 's/<credit-type-abbrev>/[credit-type-abbrev]/g' $FILE
48+
sed -i 's/<class-sequence>/[class-sequence]/g' $FILE
49+
sed -i 's/<country-code>/[country-code]/g' $FILE
50+
sed -i 's/<region-code>/[region-code]/g' $FILE
51+
sed -i 's/<postal-code>/[postal-code]/g' $FILE
52+
sed -i 's/<class-id>/[class-id]/g' $FILE
53+
sed -i 's/<project-sequence>/[project-sequence]/g' $FILE
54+
sed -i 's/<authority>/[authority]/g' $FILE
55+
sed -i 's/<recipient>/[recipient]/g' $FILE
56+
sed -i 's/<exponent-prefix>/[exponent-prefix]/g' $FILE
57+
sed -i 's/<name>/[name]/g' $FILE
4658
done
4759

4860
# TODO: better solution for closing end tag errors

docs/validators/upgrades/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ This document provides an overview of the upgrade process for software upgrades
99
- [Upgrade Guide v5.0](v5.0-upgrade.md)
1010
- [Upgrade Guide v5.1](v5.1-upgrade.md)
1111
- [Upgrade Guide v6.0](v6.0-upgrade.md)
12+
- [Upgrade Guide v7.0](v7.0-upgrade.md)
1213

1314
## Software Upgrade
1415

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Upgrade Guide v7.0
2+
3+
This document provides guidelines for node operators upgrading from Regen Ledger v6.x.x to v7.0. For a general overview of the upgrade process, please refer to [Upgrade Overview](README.md).
4+
5+
## Upgrade Info
6+
7+
### Regen Ledger v7.0
8+
9+
- [Release Notes](https://github.com/regen-network/regen-ledger/releases/tag/v7.0.0)
10+
11+
### Regen Mainnet
12+
13+
- Upgrade Height: `25303838`
14+
15+
## Upgrade Guidelines
16+
17+
### Update Go
18+
19+
**Go `1.23` or later is required.**
20+
21+
For available downloads, see [Go Downloads](https://go.dev/dl/).
22+
23+
24+
### Option 1: Using Cosmovisor
25+
26+
**Cosmovisor `v1.0` or later is required.**
27+
28+
The following instructions assume the `cosmovisor` binary is already installed and `cosmovisor` is set up as a systemd service. If this is not the case, please refer to [Using Cosmovisor](../get-started/using-cosmovisor.md) for instructions on how to install and set up `cosmovisor`.
29+
30+
::: warning Auto-Download Not Recommended
31+
Cosmovisor provides an auto-download option that prevents the need for the following steps in preparing for the upgrade. Although available to validators, this feature should only be used for non-validator nodes and validators should build the binary from source.
32+
:::
33+
34+
Build the upgrade binary (`v7.0.0`) from source:
35+
36+
```bash
37+
cd regen-ledger
38+
git fetch --tags
39+
git checkout v7.0.0
40+
make build
41+
```
42+
43+
Ensure the `regen` binary has been built:
44+
45+
```bash
46+
./build/regen version
47+
```
48+
49+
You should see the following:
50+
51+
```bash
52+
v7.0.0
53+
```
54+
55+
Create a `v7_0` directory and copy the upgrade binary (`v7.0.0`) to the directory:
56+
57+
```bash
58+
mkdir -p $HOME/.regen/cosmovisor/upgrades/v7_0/bin
59+
cp ./build/regen $HOME/.regen/cosmovisor/upgrades/v7_0/bin
60+
```
61+
Ensure the right `regen` binary has been placed in the directory:
62+
63+
```bash
64+
$HOME/.regen/cosmovisor/upgrades/v7_0/bin/regen version
65+
```
66+
67+
You should see the following:
68+
69+
```bash
70+
v7.0.0
71+
```
72+
73+
At the proposed block height, `cosmovisor` will automatically stop the current binary (`v6.x.x`), set the upgrade binary as the current binary (`v7.0.0`), and then (depending on the cosmovisor settings) perform a backup and restart the node.
74+
75+
### Option 2: Without Cosmovisor
76+
77+
Using `cosmovisor` to perform the upgrade is not required. Node operators also have the option to manually update the `regen` binary at the time of the upgrade.
78+
79+
First Build the upgrade binary (`v7.0.0`) from source:
80+
81+
```bash
82+
cd regen-ledger
83+
git fetch --tags
84+
git checkout v7.0.0
85+
make install
86+
```
87+
88+
Ensure the `regen` binary has been updated:
89+
90+
```bash
91+
regen version
92+
```
93+
94+
You should see the following:
95+
96+
```bash
97+
v7.0.0
98+
```
99+
100+
When the chain halts at the proposed upgrade height, stop the current process running `regen`.
101+
102+
Restart the process running `regen`.

0 commit comments

Comments
 (0)