From 686d6d9f3cf61819b8abd37423317c4ae3e8b5f8 Mon Sep 17 00:00:00 2001
From: Marc Font <36164126+Marketen@users.noreply.github.com>
Date: Tue, 28 Nov 2023 22:08:38 +0100
Subject: [PATCH] Refactor smooth sub guide (#338)
refactor smooth sub guide
---
docs/smooth/subscribe-to-smooth/automatic.md | 14 +++
docs/smooth/subscribe-to-smooth/manual.md | 90 ++++++++++++++++++
docs/smooth/subscribe-to-smooth/overview.md | 14 +++
docs/smooth/subscribe_to_smooth.md | 98 --------------------
sidebars.js | 20 +++-
5 files changed, 136 insertions(+), 100 deletions(-)
create mode 100644 docs/smooth/subscribe-to-smooth/automatic.md
create mode 100644 docs/smooth/subscribe-to-smooth/manual.md
create mode 100644 docs/smooth/subscribe-to-smooth/overview.md
delete mode 100644 docs/smooth/subscribe_to_smooth.md
diff --git a/docs/smooth/subscribe-to-smooth/automatic.md b/docs/smooth/subscribe-to-smooth/automatic.md
new file mode 100644
index 000000000..0908692ae
--- /dev/null
+++ b/docs/smooth/subscribe-to-smooth/automatic.md
@@ -0,0 +1,14 @@
+# Automatic Subscription
+
+This is the simplest way to subscribe to Smooth. It consists of changing the fee recipient of your validator to Smooth's address and subscribing automatically when proposing your next block.
+
+### Step 1: Change your fee recipient to Smooth's address.
+
+Go to your dappnode's [staking brain](http://brain.web3signer.dappnode/) and change the fee recipient of the validators you want to subscribe to Smooth's address (`0xAdFb8D27671F14f297eE94135e266aAFf8752e35`). Once Smooth recieves the rewards from your validator, it will automatically subscribe your validator to Smooth, and you will start receiving rewards from other members of Smooth!
+
+:::danger Keep the fee recipient set to Smooth's address!
+It is extremely important that you keep the fee recipient of your validator set to Smooth's address (`0xAdFb8D27671F14f297eE94135e266aAFf8752e35`) as long as it is subscribed to Smooth. If, at any point, you change the fee recipient of your validator and propose a block without unsubscribing first, you will be banned from Smooth and will not be able to participate in it again.
+:::
+
+:::info Check your subscription status in Smooth's website
+You can check the subscription status of your validators in [Smooth's website](https://smooth.dappnode.io/). Once logged in with your wallet, your validators will appear in the "My Validators" section.
\ No newline at end of file
diff --git a/docs/smooth/subscribe-to-smooth/manual.md b/docs/smooth/subscribe-to-smooth/manual.md
new file mode 100644
index 000000000..c5ebdec6a
--- /dev/null
+++ b/docs/smooth/subscribe-to-smooth/manual.md
@@ -0,0 +1,90 @@
+# Manual Subscription
+
+Would you rather not wait until your next proposed block to subscribe and begin earning rewards? You can take a proactive step and opt for manual subscription right away. During this process, you'll change your validator's fee recipient to Smooth's address, just like in the automatic subscription. However, instead of waiting for your next proposed block, you'll immediately start accumulating rewards from Smooth.
+
+The manual subscription is done through **[Smooth's website](https://smooth.dappnode.io/)**.
+
+### Step 1: Change your fee recipient to Smooth's address.
+
+Change the fee recipient of your validator to Smooth's address, just as if you were subscribing automatically. In dappnode, this process is as simple as changing the fee recipient in your [staking brain](http://brain.web3signer.dappnode/).
+
+**This step is extremely important**. Make sure you're changing the fee recipient of the validators you are going to manually subscribe and that the fee recipient is correctly set to Smooth's address (`0xAdFb8D27671F14f297eE94135e266aAFf8752e35`). If a subscribed validator proposes a block with an incorrect fee recipient, it will be banned from Smooth and will not be able to participate in it again.
+
+:::danger Keep the fee recipient set to Smooth's address!
+It is crucial that you keep the fee recipient of your validator set to Smooth's address (`0xAdFb8D27671F14f297eE94135e266aAFf8752e35`) as long as it is subscribed to Smooth. If, at any point, you change the fee recipient of your validator and propose a block without unsubscribing first, you will be banned from Smooth and will not be able to participate in it again.
+:::
+### Step 2: Log in to Smooth's website
+
+Go to [Smooth's website](https://smooth.dappnode.io/) and log in with your wallet. A list of all the validators with the same withdrawal address as your logged in wallet will appear.
+
+### Step 3: Select your validator
+
+Select the validator you want to subscribe to Smooth by clicking on the "Subscribe" button.
+
+
+When clicking on the "Subscribe" button, Smooth will check if your validator is registered to any MEV relay. If it is, it will also check if the fee recipient of your validator is set to Smooth's address in each relay. **Three different dialogs can appear**, depending on the state of your validator and the MEV relays it is registered to.
+
+#### Possible Dialog 1: Validator is not registered to any MEV relay
+
+
+ 
+
+
+When doing a manual subscription, it is obligatory to be registered in at least one MEV relay. In dappnode, registering and using a relay is as simple as selecting the desired relay in the "MEV Boost" Card at the [Stakers UI](http://my.dappnode/stakers/ethereum/). Once you have selected at least one relay, you can go back to the Smooth website and click on the "Subscribe" button again.
+
+
+
+#### Possible Dialog 2: Validator does not have the Smooth's address as fee recipient in relays.
+
+
+ 
+
+
+If this dialog appears, it means that the fee recipient of your validator is not set to Smooth's address in at least one relay. Please make sure that you have done step 1 correctly, and that the fee recipient of your validator is set to Smooth's address in your [staking brain](http://brain.web3signer.dappnode/).
+
+:::info
+Relays that you no longer use won't reflect the fee recipient changes you did for each validator in your staking brain. If you have already changed your fee recipient but the warning still appears, please check the "Troubleshooting" section down below for more information.
+:::
+
+#### Possible Dialog 3: Validator is registered to at least one MEV relay and has the correct fee recipient set.
+
+
+ 
+
+
+This is the dialog you want to see! If you see this dialog, it means that your validator is registered to at least one MEV relay, and that the fee recipient of your validator is set to Smooth's address all relays it has been registered to. In other words, this means that your validator is ready to subscribe to Smooth!
+
+
+### Step 4: Confirm Relays check
+
+
+ 
+
+
+This step is just a confirmation of the relays your validators has the correct fee recipient set in. Click on "Next" to continue the subscription process, we're almost there!
+
+### Step 5: Make the deposit and subscribe!
+
+ 
+
+
+This is the last step! In this step, you will make the deposit to subscribe your validator to Smooth. The deposit is a one-time upfront payment that will be returned to you as Claimable rewards when proposing your first block to Smooth. The deposit is 0.01 ETH, and it is used to prevent spam and malicious validators from subscribing to Smooth.
+
+Once the deposit transaction is processed by the chain, your validator will be subscribed to Smooth and you will start recieving rewards from other members of Smooth!
+
+
+ 
+
+
+## Troubleshooting
+
+
+ I have changed my fee recipient but the "Fee recipient warning" warning still appears!
+
+If you have changed your fee recipient to Smooth's address (0xAdFb8D27671F14f297eE94135e266aAFf8752e35) but this warning still appears, it could be because of two reasons:
+
+ - The relays you are registered to are not reflecting the change in the fee recipient yet. It can take up to a few minutes for the relays to reflect your fee recipient update. This is something that is out of Smooth's control. We recommend you to wait a few minutes and try again.
+ - The fee recipient is only updated in your current active relays. This means that if you used to be registered to a relay, but you are not using it anymore, the fee recipient of your validator will not be updated in that relay. This is something expected and that it wont affect your validator's subscription to Smooth. If you want to update the fee recipient in the relays you are no longer registered to, you can quickly register and unregister again to the outdated relays to force an update the fee recipient there.
+
+ To clarify: As long as the fee recipient of your validator is set to Smooth's address in your staking brain, you can continue the subscription process normally.
+
\ No newline at end of file
diff --git a/docs/smooth/subscribe-to-smooth/overview.md b/docs/smooth/subscribe-to-smooth/overview.md
new file mode 100644
index 000000000..6cee3cff8
--- /dev/null
+++ b/docs/smooth/subscribe-to-smooth/overview.md
@@ -0,0 +1,14 @@
+# Subscribing to Smooth
+
+Hello! In this section you will find all the information on how to subscribe your Validators to Smooth. Even though the process is simple, it is important to follow the steps carefully.
+
+:::danger Before subscibing to Smooth!
+Only validators with ETH1 withdrawal addresses can be subscribed to Smooth. If you have a validator with a BLS withdrawal address, please update it to an ETH1 withdrawal address before subscribing to Smooth.
+
+Ensure that you have control over the ETH1 withdrawal address of the validators you plan to subscribe to Smooth. This address is the one you will need to use when logging into Smooth's website and manage your validators going forward. Only the withdrawal address has the capability to claim rewards generated by your validators from Smooth.
+:::
+You have **two options** to subscribe to Smooth:
+
+1. [**Automatic subscription**](/docs/smooth/subscribe-to-smooth/automatic.md): The simplest way to subscribe, change the fee recipient of your validators to Smooth's address and subscribe automatically when proposing your next block!
+
+2. [**Manual subscription**](/docs/smooth/subscribe-to-smooth/manual.md): Change the fee recipient of your validators to Smooth's address and use the Smooth's website to subscribe right now, without waiting for your validators to propose a block. Start earning rewards right away!
diff --git a/docs/smooth/subscribe_to_smooth.md b/docs/smooth/subscribe_to_smooth.md
deleted file mode 100644
index c8ba212fa..000000000
--- a/docs/smooth/subscribe_to_smooth.md
+++ /dev/null
@@ -1,98 +0,0 @@
-# Subscribing to Smooth
-
-The following is a guide to subscribing to Smooth, where you will find all the information on how to subscribe your Validators to Smooth. Even though the process is simple, it is important to follow the steps carefully.
-
-## Automatic Subscription
-
-The simplest way to subscribe to Smooth is to do it automatically when giving your next proposed block rewards to Smooth. This can be done easily by just changing the fee recipient of your validator to Smooth's address. In dappnode, this process is as simple as changing the fee recipient in your [staking brain](http://brain.web3signer.dappnode/). Once Smooth recieves the rewards from your validator, it will automatically subscribe your validator to Smooth, and you will start receiving rewards from other members of Smooth!
-
-:::caution Keep the fee recipient set to Smooth's address!
-It is extremely important that you keep the fee recipient of your validator set to Smooth's address (`0xAdFb8D27671F14f297eE94135e266aAFf8752e35`). If, at any point, you change the fee recipient of your validator and propose a block without unsubscribing from Smooth first, you will be banned from Smooth and will not be able to participate in it again.
-:::
-
-
-
-## Manual Subscription
-
-If you dont want to wait until your next proposed block to start accumulating rewards, you can go a step further and subscribe manually. In this process, you will change your validator's fee recipient to Smooth's address, just like in automatic subscription, but you will also manually subscribe your validator through [Smooth's website](https://smooth.dappnode.io/).
-
-### Step 1: Change your fee recipient to Smooth's address.
-
-Change the fee recipient of your validator to Smooth's address, just as if you were subscribing automatically. In dappnode, this process is as simple as changing the fee recipient in your [staking brain](http://brain.web3signer.dappnode/).
-
-:::caution Keep the fee recipient set to Smooth's address!
-It is extremely important that you keep the fee recipient of your validator set to Smooth's address(`0xAdFb8D27671F14f297eE94135e266aAFf8752e35`). If, at any point, you change the fee recipient of your validator and propose a block without unsubscribing from Smooth first, you will be banned from Smooth and will not be able to participate in it again.
-:::
-### Step 2: Log in to Smooth's website
-
-Go to [Smooth's website](https://smooth.dappnode.io/) and log in with your wallet. A list of all the validators with the same withdrawal address as your logged in wallet will appear.
-
-### Step 3: Select your validator
-
-Select the validator you want to subscribe to Smooth by clicking on the "Subscribe" button.
-
-
-When clicking on the "Subscribe" button, Smooth will check if your validator is registered to any MEV relay. If it is, it will also check if the fee recipient of your validator is set to Smooth's address in each relay. Three different dialogs can appear, depending on the state of your validator and the MEV relays it is registered to.
-
-#### Dialog 1: Validator is not registered to any MEV relay
-
-
-
-
-
-When doing a manual subscription, it is obligatory to be registered in at least one MEV relay. In dappnode, registering and using a relay is as simple as selecting the desired relay in the "MEV Boost" Card at the [Stakers UI](http://my.dappnode/stakers/ethereum/). Once you have selected at least one relay, you can go back to the Smooth website and click on the "Subscribe" button again.
-
-
-
-#### Dialog 2: Validator does not have the Smooth's address as fee recipient in relays.
-
-
-
-
-
-When registered to a MEV relay, Smooth can check if your validator has the Smooth's address as the fee recipient in each relay registered to. Since having the correct fee recipient (Smooth's address) is crucial to not get banned and participate in Smooth correctly, we will warn you if your validator does not have the correct fee recipient set in any of the relays it is registered to. If this warning appears, please make sure that you have done step 1 correctly, and that the fee recipient of your validator is set to Smooth's address in your [staking brain](http://brain.web3signer.dappnode/).
-
-If you have already changed your fee recipient but the warning still appears, please check the "Troubleshooting" section down below.
-
-#### Dialog 3: Validator is registered to at least one MEV relay and has the correct fee recipient set.
-
-
-
-
-
-This is the dialog you want to see! If you see this dialog, it means that your validator is registered to at least one MEV relay, and that the fee recipient of your validator is set to Smooth's address all relays it has been registered to. In other words, this means that your validator is ready to subscribe to Smooth!
-
-
-### Step 4: Confirm Relays check
-
-
-
-
-
-This step is just a confirmation of the relays your validators has the correct fee recipient set in. Click on "Next" to continue the subscription process, we're almost there!
-
-### Step 5: Make the deposit and subscribe!
-
-
-
-
-This is the last step! In this step, you will make the deposit to subscribe your validator to Smooth. The deposit is a one-time upfront payment that will be returned to you as Claimable rewards when proposing your first block to Smooth. The deposit is 0.1 ETH, and it is used to prevent spam and malicious validators from subscribing to Smooth.
-
-Once the deposit transaction is processed by the chain, your validator will be subscribed to Smooth and you will start recieving rewards from other members of Smooth!
-
-
-
-
-
-## Troubleshooting
-
-
- I have changed my fee recipient but the "Fee recipient warning" warning still appears!
-
-If you have changed your fee recipient to Smooth's address (0xAdFb8D27671F14f297eE94135e266aAFf8752e35) but this warning still appears, it could be because of two reasons:
-
- - The relays you are registered to are not reflecting the change in fee recipient yet. It can take up to a few hours for the relays to reflect your change in fee recipient. This is something that is out of Smooth's control. We recommend you to wait a few hours and try again.
- - The fee recipient is only updated in your current active relays. This means that if you used to be registered to a relay, but you are not anymore, the fee recipient of your validator will not be updated in that relay. To solve this, you can either quickly register and unregister again to the outdated relays to force an update the fee recipient there, or continue the subscription normally, since inactive relays won't be used by your validator when submitting a block.
-
- To clarify: As long as the fee recipient of your validator is set to Smooth's address in your staking brain, you can continue the subscription process normally.
-
\ No newline at end of file
diff --git a/sidebars.js b/sidebars.js
index 40343dbeb..15d1a0452 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -378,9 +378,25 @@ const sidebars = {
id: "smooth/overview",
},
{
- type: "doc",
+ type: "category",
label: "Subscribe to Smooth!",
- id: "smooth/subscribe_to_smooth",
+ items: [
+ {
+ type: "doc",
+ label: "Overview",
+ id: "smooth/subscribe-to-smooth/overview",
+ },
+ {
+ type: "doc",
+ label: "Automatic subscription",
+ id: "smooth/subscribe-to-smooth/automatic",
+ },
+ {
+ type: "doc",
+ label: "Manual subscription",
+ id: "smooth/subscribe-to-smooth/manual",
+ },
+ ],
},
],
daoSidebar: ["dao", "dao/node-basics", "dao/liquidity-mining", "dao/faq"],