From fa86fe8716101dedfbdd98b3e5a2e3a68bd85bb5 Mon Sep 17 00:00:00 2001 From: "Dima K." Date: Wed, 27 Nov 2024 15:13:37 -0800 Subject: [PATCH] [Docs] Upgrade list (#928) ## Summary Add recent Alpha TestNet upgrades ## Type of change Select one or more from the following: - [ ] New feature, functionality or library - [ ] Consensus breaking; add the `consensus-breaking` label if so. See #791 for details - [ ] Bug fix - [ ] Code health or cleanup - [x] Documentation - [ ] Other (specify) ## Testing - [x] **Documentation**: `make docusaurus_start`; only needed if you make doc changes - [ ] **Unit Tests**: `make go_develop_and_test` - [ ] **LocalNet E2E Tests**: `make test_e2e` - [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR. ## Sanity Checklist - [x] I have tested my changes using the available tooling - [ ] I have commented my code - [x] I have performed a self-review of my own code; both comments & source code - [ ] I create and reference any new tickets, if applicable - [x] I have left TODOs throughout the codebase, if applicable --------- Co-authored-by: Daniel Olshansky --- .../docker_compose_debian_cheatsheet.md | 7 ++++ .../quickstart/docker_compose_walkthrough.md | 5 +++ .../docs/protocol/upgrades/upgrade_list.md | 35 ++++++++++++------- tools/scripts/tx_jsons/staking_params.json | 18 ++++++++++ .../scripts/tx_jsons/staking_validator2.json | 16 +++++++++ .../scripts/tx_jsons/staking_validator3.json | 16 +++++++++ 6 files changed, 85 insertions(+), 12 deletions(-) create mode 100644 tools/scripts/tx_jsons/staking_params.json create mode 100644 tools/scripts/tx_jsons/staking_validator2.json create mode 100644 tools/scripts/tx_jsons/staking_validator3.json diff --git a/docusaurus/docs/operate/quickstart/docker_compose_debian_cheatsheet.md b/docusaurus/docs/operate/quickstart/docker_compose_debian_cheatsheet.md index ad7d2b632..c75358cb1 100644 --- a/docusaurus/docs/operate/quickstart/docker_compose_debian_cheatsheet.md +++ b/docusaurus/docs/operate/quickstart/docker_compose_debian_cheatsheet.md @@ -119,6 +119,13 @@ source ~/.bashrc ## Start up the full node + +:::warning +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 diff --git a/docusaurus/docs/operate/quickstart/docker_compose_walkthrough.md b/docusaurus/docs/operate/quickstart/docker_compose_walkthrough.md index 1d0518d7f..e2a83d340 100644 --- a/docusaurus/docs/operate/quickstart/docker_compose_walkthrough.md +++ b/docusaurus/docs/operate/quickstart/docker_compose_walkthrough.md @@ -192,6 +192,11 @@ olshansky ALL=(ALL) NOPASSWD:ALL ### Launch the Node +:::warning +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._ diff --git a/docusaurus/docs/protocol/upgrades/upgrade_list.md b/docusaurus/docs/protocol/upgrades/upgrade_list.md index f4b2c8d19..6480086c3 100644 --- a/docusaurus/docs/protocol/upgrades/upgrade_list.md +++ b/docusaurus/docs/protocol/upgrades/upgrade_list.md @@ -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 @@ -18,21 +20,30 @@ 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 +| Version | Planned | Breaking | Requires Manual Intervention | Upgrade Height | +| -------------------------------------------------------------------------------- | :-----: | :------: | :--------------------------: | -------------- | +| [`v0.0.11-rc`](https://github.com/pokt-network/poktroll/releases/tag/v0.0.11-rc) | N/A | N/A | ❌ genesis version | N/A | + +## 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. ::: - + -| 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.alpha.testnet.pokt.network/poktroll/tx/4E201E5C397AB881F417266154C907D38404BE00BE9A443DE28E44A2B09C5CFB) | +| [`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 | -## MainNet +### Syncing from genesis - manual steps + -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). diff --git a/tools/scripts/tx_jsons/staking_params.json b/tools/scripts/tx_jsons/staking_params.json new file mode 100644 index 000000000..fc5074a44 --- /dev/null +++ b/tools/scripts/tx_jsons/staking_params.json @@ -0,0 +1,18 @@ +{ + "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" + } + } + ] + } +} \ No newline at end of file diff --git a/tools/scripts/tx_jsons/staking_validator2.json b/tools/scripts/tx_jsons/staking_validator2.json new file mode 100644 index 000000000..d64e2db42 --- /dev/null +++ b/tools/scripts/tx_jsons/staking_validator2.json @@ -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" +} \ No newline at end of file diff --git a/tools/scripts/tx_jsons/staking_validator3.json b/tools/scripts/tx_jsons/staking_validator3.json new file mode 100644 index 000000000..86c76a7a1 --- /dev/null +++ b/tools/scripts/tx_jsons/staking_validator3.json @@ -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" +} \ No newline at end of file