From b9cec073e9255378f281cd9720e4c365aa05b6bc Mon Sep 17 00:00:00 2001 From: Thom Ivy <38070512+thomivy@users.noreply.github.com> Date: Tue, 5 Dec 2023 14:30:00 -0600 Subject: [PATCH 1/4] added validator upgrade guide --- pages/docs/node/_meta.json | 1 + pages/docs/node/upgrade-node.mdx | 58 ++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 pages/docs/node/upgrade-node.mdx diff --git a/pages/docs/node/_meta.json b/pages/docs/node/_meta.json index 0732c517..a034198b 100644 --- a/pages/docs/node/_meta.json +++ b/pages/docs/node/_meta.json @@ -6,6 +6,7 @@ "docker-node": "Deploy with Docker", "monitoring": "Node Monitoring", "validator": "Validate", + "upgrade-node": "Upgrade your Validator", "flags": "Flags", "troubleshooting": "Troubleshooting", "quicknode": "Launch a Quick Node" diff --git a/pages/docs/node/upgrade-node.mdx b/pages/docs/node/upgrade-node.mdx new file mode 100644 index 00000000..9eed9200 --- /dev/null +++ b/pages/docs/node/upgrade-node.mdx @@ -0,0 +1,58 @@ +# Validator Upgrade Guide + +## Introduction + +Validators are crucial to the stability and security of the Tangle Network. This guide provides detailed steps for upgrading validators while maintaining strict uptime requirements to avoid slashing. + + +## Preparation + +- Stay informed [about new releases](https://github.com/webb-tools/tangle/) from the Tangle Network community. We publish these on the [Webb twitter, and in Discord.](../community) +- Plan the upgrade process to minimize downtime. + +## Key Components + +### Session Keys + +- Stored in the client, linking your node to the staking proxy. +- Changing keys requires waiting for the current session to finish plus two more sessions. + +### Keystore + +- Located at `/chains/Tangle/keystore`. +- Contains private keys for signing transactions. +- **Do not clone or copy** the keystore; generate new keys for each validator instance. + +## Upgrade Steps + +### Setting Up Validator B (Your New Validator) + +1. Start and sync a second node (Validator B) with the `--validator` flag. +2. Generate session keys for Validator B. +3. Submit a `set_key` extrinsic from your staking proxy with Validator B’s session key. +4. Note the session when this extrinsic is executed. +5. Keep Validator A running until two full sessions have elapsed after the current one. + +### Switching to Validator B + +1. After Session N+3, Validator B will act as your validator. +2. Perform maintenance on Validator A. + +### Restoring Validator A + +1. Restart Validator A with the `--validator` flag and sync it. +2. Generate new session keys for Validator A. +3. Submit a `set_key` extrinsic with Validator A’s new session key. +4. Keep Validator B running until two full sessions have elapsed after the current session. + +## Monitoring the Transition + +Verify the session change by looking for log messages like: + +``` +2019-10-28 21:44:13 Applying authority set change scheduled at block #450092 +2019-10-28 21:44:13 Applying GRANDPA set change to new set with 20 authorities +``` + +## Troubleshooting and Support +For additional support, [join our Validator channel in Discord.](../community) From 7439939eafd861b29a0c1b9c3b2605d552fc7a4c Mon Sep 17 00:00:00 2001 From: Thom Ivy <38070512+thomivy@users.noreply.github.com> Date: Tue, 5 Dec 2023 14:57:18 -0600 Subject: [PATCH 2/4] moved validator guide to validate folder under node --- pages/docs/node/_meta.json | 1 - pages/docs/node/validator/_meta.json | 1 + pages/docs/node/{ => validator}/upgrade-node.mdx | 0 3 files changed, 1 insertion(+), 1 deletion(-) rename pages/docs/node/{ => validator}/upgrade-node.mdx (100%) diff --git a/pages/docs/node/_meta.json b/pages/docs/node/_meta.json index a034198b..0732c517 100644 --- a/pages/docs/node/_meta.json +++ b/pages/docs/node/_meta.json @@ -6,7 +6,6 @@ "docker-node": "Deploy with Docker", "monitoring": "Node Monitoring", "validator": "Validate", - "upgrade-node": "Upgrade your Validator", "flags": "Flags", "troubleshooting": "Troubleshooting", "quicknode": "Launch a Quick Node" diff --git a/pages/docs/node/validator/_meta.json b/pages/docs/node/validator/_meta.json index 149c229c..d7bfd11f 100644 --- a/pages/docs/node/validator/_meta.json +++ b/pages/docs/node/validator/_meta.json @@ -1,5 +1,6 @@ { "requirements": "Start Validating", + "upgrade-node": "Upgrade your Validator", "proxyaccount": "Proxy Accounts", "validator-rewards": "Rewards" } diff --git a/pages/docs/node/upgrade-node.mdx b/pages/docs/node/validator/upgrade-node.mdx similarity index 100% rename from pages/docs/node/upgrade-node.mdx rename to pages/docs/node/validator/upgrade-node.mdx From 820165e536222bc23d283b93d8ed346cb56ed5d0 Mon Sep 17 00:00:00 2001 From: Thom Ivy <38070512+thomivy@users.noreply.github.com> Date: Tue, 5 Dec 2023 15:13:44 -0600 Subject: [PATCH 3/4] prettier-ed --- pages/docs/node/validator/upgrade-node.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/docs/node/validator/upgrade-node.mdx b/pages/docs/node/validator/upgrade-node.mdx index 9eed9200..f42bd100 100644 --- a/pages/docs/node/validator/upgrade-node.mdx +++ b/pages/docs/node/validator/upgrade-node.mdx @@ -4,7 +4,6 @@ Validators are crucial to the stability and security of the Tangle Network. This guide provides detailed steps for upgrading validators while maintaining strict uptime requirements to avoid slashing. - ## Preparation - Stay informed [about new releases](https://github.com/webb-tools/tangle/) from the Tangle Network community. We publish these on the [Webb twitter, and in Discord.](../community) @@ -55,4 +54,5 @@ Verify the session change by looking for log messages like: ``` ## Troubleshooting and Support + For additional support, [join our Validator channel in Discord.](../community) From 9f4c97319394e4e5da94b6d8e1110f2453571e30 Mon Sep 17 00:00:00 2001 From: Thom Ivy <38070512+thomivy@users.noreply.github.com> Date: Tue, 5 Dec 2023 15:26:55 -0600 Subject: [PATCH 4/4] fixed link in guide --- pages/docs/node/validator/upgrade-node.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pages/docs/node/validator/upgrade-node.mdx b/pages/docs/node/validator/upgrade-node.mdx index f42bd100..7973b340 100644 --- a/pages/docs/node/validator/upgrade-node.mdx +++ b/pages/docs/node/validator/upgrade-node.mdx @@ -6,7 +6,7 @@ Validators are crucial to the stability and security of the Tangle Network. This ## Preparation -- Stay informed [about new releases](https://github.com/webb-tools/tangle/) from the Tangle Network community. We publish these on the [Webb twitter, and in Discord.](../community) +- Stay informed [about new releases](https://github.com/webb-tools/tangle/) from the Tangle Network community. We publish these on the [Webb twitter, and in Discord.](../../community.mdx) - Plan the upgrade process to minimize downtime. ## Key Components @@ -55,4 +55,4 @@ Verify the session change by looking for log messages like: ## Troubleshooting and Support -For additional support, [join our Validator channel in Discord.](../community) +For additional support, [join our Validator channel in Discord.](../../community.mdx)