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] Upgrade list #928

Merged
merged 8 commits into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from 5 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
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,13 @@ source ~/.bashrc

## Start up the full node


Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[linter-name (fail-on-found)] reported by reviewdog 🐶
sed -i -e s/NODE_HOSTNAME=/NODE_HOSTNAME=$EXTERNAL_IP/g .env

:::warn
okdas marked this conversation as resolved.
Show resolved Hide resolved
The Alpha TestNet currently requires manual steps to sync the node to the latest block. Please find the affected block(s)
in [this document](../../protocol/upgrades/upgrade_list.md), which leads to the manual upgrade instructions.
:::


```bash
docker compose up -d full-node
# Optional: watch the block height sync up & logs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,11 @@ sed -i -e s/NODE_HOSTNAME=/NODE_HOSTNAME=69.42.690.420/g .env

### Launch the Node <!-- omit in toc -->

:::warn
okdas marked this conversation as resolved.
Show resolved Hide resolved
The Alpha TestNet currently requires manual steps to sync the node to the latest block. Please find the affected block(s)
in [this document](../../protocol/upgrades/upgrade_list.md), which leads to the manual upgrade instructions.
:::

_Note: You may need to replace `docker-compose` with `docker compose` if you are
running a newer version of Docker where `docker-compose` is integrated into `docker` itself._

Expand Down
33 changes: 20 additions & 13 deletions docusaurus/docs/protocol/upgrades/upgrade_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ sidebar_position: 1
The tables below provide a list of past and upcoming protocol upgrades. For more detailed information about what upgrades are, how they work, and what changes they bring to the protocol, please refer to our [upgrade overview page](./protocol_upgrades.md).

- [Legend](#legend)
- [TestNet](#testnet)
- [MainNet](#mainnet)
- [Beta TestNet](#beta-testnet)
- [Alpha TestNet](#alpha-testnet)
- [Syncing from genesis - manual steps](#syncing-from-genesis---manual-steps)

## Legend

Expand All @@ -18,21 +20,26 @@ The tables below provide a list of past and upcoming protocol upgrades. For more
- ❓ - Unknown/To Be Determined
- ⚠️ - Warning/Caution Required

## TestNet
## MainNet
Coming...

## Beta TestNet
Expected to launch on November 21, 2024.

## Alpha TestNet
:::warning
This table is currently incomplete and does not include all protocol upgrades. Our recent TestNet upgrades, which were performed via a regenesis, are not listed here.
Some manual steps are currently required to sync to the latest block. Please follow instructions below.
:::

<!-- DEVELOPER: if important information about the release is changing (e.g. upgrade hight is changed) - make sure to update the information in GitHub relase as well. -->
<!-- DEVELOPER: if important information about the release is changing (e.g. upgrade height is changed) - make sure to update the information in GitHub release as well. -->

| Version | Planned | Breaking | Requires Manual Intervention | Upgrade Height |
| ------------------------------------------------------------------------ | :-----: | :------: | :---------------------------------: | -------------- |
| [`v0.0.7`](https://github.com/pokt-network/poktroll/releases/tag/v0.0.7) | ❓ | ❓ | ✅ (Alpha TestNet Participants Only) | ❓ |
| [`v0.0.6`](https://github.com/pokt-network/poktroll/releases/tag/v0.0.6) | ❓ | ❓ | ✅ (Alpha TestNet Participants Only) | ❓ |
| [`v0.0.5`](https://github.com/pokt-network/poktroll/releases/tag/v0.0.5) | ❓ | ❓ | ✅ (Alpha TestNet Participants Only) | ❓ |
| [`v0.0.4`](https://github.com/pokt-network/poktroll/releases/tag/v0.0.4) | ❓ | ❓ | ✅ (Alpha TestNet Participants Only) | ❓ |
| Version | Planned | Breaking | Requires Manual Intervention | Upgrade Height |
| ---------------------------------------------------------------------------- | :-----: | :------: | :--------------------------------------------------------------------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------- |
| [`v0.0.10`](https://github.com/pokt-network/poktroll/releases/tag/v0.0.10) | ✅ | ✅ | ❌ (automatic upgrade) | ❓ [56860](https://shannon.testnet.pokt.network/poktroll/tx/4E201E5C397AB881F417266154C907D38404BE00BE9A443DE28E44A2B09C5CFB) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is there a ❓ in the "height" column for this row?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call!

| [`v0.0.9-4`](https://github.com/pokt-network/poktroll/releases/tag/v0.0.9-4) | ❌ | ✅ | ⚠️ [follow manual upgrade instructions](https://github.com/pokt-network/poktroll/releases/tag/v0.0.9-4) ⚠️ | `46329` |
| [`v0.0.9-3`](https://github.com/pokt-network/poktroll/releases/tag/v0.0.9-3) | ❌ | ✅ | ❌ Active Alpha TestNet Participants Only: [follow manual upgrade instructions](https://github.com/pokt-network/poktroll/releases/tag/v0.0.9-3) | `17102` |
| [`v0.0.9`](https://github.com/pokt-network/poktroll/releases/tag/v0.0.9) | N/A | N/A | ❌ genesis version | N/A |
### Syncing from genesis - manual steps
okdas marked this conversation as resolved.
Show resolved Hide resolved
<!-- TODO(@okdas): when the next cosmovisor version released with `https://github.com/cosmos/cosmos-sdk/pull/21790` included - provide automated solution (csv file + pre-downloaded binaries) that will add hot-fixes automatically, allowing to sync from block #1 without any intervention -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is wonderful


## MainNet

Coming...
When syncing Alpha TestNet from the first block, the node will fail at height `46329`. Some manual steps are required in order for it to continue. Please [follow manual upgrade instructions](https://github.com/pokt-network/poktroll/releases/tag/v0.0.9-4).
18 changes: 18 additions & 0 deletions tools/scripts/tx_jsons/staking_params.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just wanted to add these into the repo. I'll make use of them in the validator staking documentation.

"body": {
"messages": [
{
"@type": "/cosmos.staking.v1beta1.MsgUpdateParams",
"authority": "pokt10d07y265gmmuvt4z0w9aw880jnsr700j8yv32t",
"params": {
"bond_denom": "upokt",
"historical_entries": 10000,
"max_entries": 7,
"max_validators": 3,
"min_commission_rate": "0",
"unbonding_time": "504h0m0s"
}
}
]
}
}
16 changes: 16 additions & 0 deletions tools/scripts/tx_jsons/staking_validator2.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"pubkey": {
"@type": "/cosmos.crypto.ed25519.PubKey",
"key": "ojUaD7c/Ssmor53eOMl0BNczr4u1VdgVnUL+IQFcC/g="
},
"amount": "900000000upokt",
"moniker": "validator2",
"identity": "",
"website": "",
"security": "",
"details": "",
"commission-rate": "0.100000000000000000",
"commission-max-rate": "0.200000000000000000",
"commission-max-change-rate": "0.01000000000000000",
"min-self-delegation": "1"
}
16 changes: 16 additions & 0 deletions tools/scripts/tx_jsons/staking_validator3.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"pubkey": {
"@type": "/cosmos.crypto.ed25519.PubKey",
"key": "U+Qi//fZhYtbr25PsWqFQZpxft3erzyrg2cWbLOj6+A="
},
"amount": "900000000upokt",
"moniker": "validator3",
"identity": "",
"website": "",
"security": "",
"details": "",
"commission-rate": "0.100000000000000000",
"commission-max-rate": "0.200000000000000000",
"commission-max-change-rate": "0.01000000000000000",
"min-self-delegation": "1"
}
Loading