From e1101712ac32ecbea367e077cc2a7140bf295925 Mon Sep 17 00:00:00 2001 From: Marketen Date: Tue, 28 Nov 2023 21:04:34 +0100 Subject: [PATCH] refactor smooth sub guide --- docs/smooth/subscribe-to-smooth/automatic.md | 9 +++++ .../manual.md} | 34 +++++++------------ docs/smooth/subscribe-to-smooth/overview.md | 9 +++++ sidebars.js | 20 +++++++++-- 4 files changed, 48 insertions(+), 24 deletions(-) create mode 100644 docs/smooth/subscribe-to-smooth/automatic.md rename docs/smooth/{subscribe_to_smooth.md => subscribe-to-smooth/manual.md} (65%) create mode 100644 docs/smooth/subscribe-to-smooth/overview.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..51a70d725 --- /dev/null +++ b/docs/smooth/subscribe-to-smooth/automatic.md @@ -0,0 +1,9 @@ +# Automatic Subscription + +### Step 1: Change your fee recipient to Smooth's address. + +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. +::: diff --git a/docs/smooth/subscribe_to_smooth.md b/docs/smooth/subscribe-to-smooth/manual.md similarity index 65% rename from docs/smooth/subscribe_to_smooth.md rename to docs/smooth/subscribe-to-smooth/manual.md index c8ba212fa..27bd50f0c 100644 --- a/docs/smooth/subscribe_to_smooth.md +++ b/docs/smooth/subscribe-to-smooth/manual.md @@ -1,40 +1,30 @@ -# Subscribing to Smooth +# Manual Subscription -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. +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. -## 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/). +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 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. + :::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. +It is crucial 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. +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. ![my_validators](/img/smooth_my_validators.png) -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. +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 +#### Possible Dialog 1: Validator is not registered to any MEV relay

no_relays @@ -44,7 +34,7 @@ When doing a manual subscription, it is obligatory to be registered in at least -#### Dialog 2: Validator does not have the Smooth's address as fee recipient in relays. +#### Possible Dialog 2: Validator does not have the Smooth's address as fee recipient in relays.

incorrect_fee_recipient @@ -54,7 +44,7 @@ When registered to a MEV relay, Smooth can check if your validator has the Smoot 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. +#### Possible Dialog 3: Validator is registered to at least one MEV relay and has the correct fee recipient set.

correct_fee_recipient @@ -76,7 +66,7 @@ This step is just a confirmation of the relays your validators has the correct f deposit

-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. +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! diff --git a/docs/smooth/subscribe-to-smooth/overview.md b/docs/smooth/subscribe-to-smooth/overview.md new file mode 100644 index 000000000..fe6f65740 --- /dev/null +++ b/docs/smooth/subscribe-to-smooth/overview.md @@ -0,0 +1,9 @@ +# 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. + +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 use the Smooth's website to subscribe right now, without waiting for your validators to propose a block. Start earning rewards right now! \ 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"],