Skip to content

Commit

Permalink
[Docs] Upgrade list (#928)
Browse files Browse the repository at this point in the history
## 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 <[email protected]>
  • Loading branch information
okdas and Olshansk authored Nov 27, 2024
1 parent afa7c86 commit fa86fe8
Show file tree
Hide file tree
Showing 6 changed files with 85 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ olshansky ALL=(ALL) NOPASSWD:ALL

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

:::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._

Expand Down
35 changes: 23 additions & 12 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,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.
:::

<!-- 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.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
<!-- 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 -->

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 @@
{
"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"
}

0 comments on commit fa86fe8

Please sign in to comment.