Skip to content

Commit

Permalink
add unsub guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Marketen committed Nov 28, 2023
1 parent 686d6d9 commit ec1c966
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/smooth/subscribe-to-smooth/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ Change the fee recipient of your validator to Smooth's address, just as if you w
:::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
### 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
### 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.

#### Possible Dialog 1: Validator is not registered to any MEV relay
#### Possible Dialog 1: Validator is not registered to any MEV relay.

<p align="center">
<img src="/img/smooth_no_relays.png" alt="no_relays" width="400"/>
Expand Down Expand Up @@ -55,7 +55,7 @@ Relays that you no longer use won't reflect the fee recipient changes you did fo
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
### Step 4: Confirm Relays check.

<p align="center">
<img src="/img/smooth_mev_blocks.png" alt="mev_blocks" width="400"/>
Expand All @@ -76,7 +76,7 @@ Once the deposit transaction is processed by the chain, your validator will be s
<img src="/img/smooth_subscribe_success.png" alt="subscription_success" width="400"/>
</p>

## Troubleshooting
## Troubleshooting.

<details>
<summary><strong>I have changed my fee recipient but the <i>"Fee recipient warning"</i> warning still appears!</strong></summary>
Expand Down
36 changes: 36 additions & 0 deletions docs/smooth/unsubscribe-from-smooth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Unsubscribing from Smooth.

Unsubscribing from Smooth is as simple as subscribing to it. You can unsubscribe from Smooth at any time, it is done through **[Smooth's website](https://smooth.dappnode.io/)** and it only takes one simple transaction.

:::caution
When unsubscribing a validator from Smooth, you will lose all pending rewards attached to it. We recommend subscribing to Smooth just after successfully proposing a block to Smooth, so lost pending rewards are minimized.
:::

## Step 1: 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 2: Click on the "Unsubscribe" button of the validator you want to unsubscribe.

Once logged in, click on the "Unsubscribe" button of the validator you want to unsubscribe from Smooth.

![Alt text](/img/smooth-unsub-table.png)

## Step 3: Follow the dialog instructions.

<p align="center">
<img src="/img/smooth-unsub-initial-dialog.png" alt="no_relays" width="400"/>
</p>

Once clicking on the "Unsubscribe" button, a dialog will appear warning you that you are about to unsubscribe from Smooth, and that it is recommended to do it when pending rewards are low. Click on <em>"Claim my rewards"</em> to continue and follow the dialog instructions. If you have any claimable rewards, a transaction that claims them will be prepared. If no claimable rewards are available, you will jump directly into the unsubscribe transaction.


<p align="center">
<img src="/img/smooth-unsubscribe-done.png" alt="no_relays" width="400"/>
</p>

Once the subscription transaction is processed by the chain, your validator will have been unsubscribed sucessfully from Smooth. You can check it by reloading your validator's table.

:::caution
After unsubscribing, we recommend to change your validator's fee recipient back to another address as soon as possible, in order to avoid automatically subscribing to Smooth again.
:::
5 changes: 5 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,11 @@ const sidebars = {
},
],
},
{
type: "doc",
label: "Unsubscribe from Smooth",
id: "smooth/unsubscribe-from-smooth",
},
],
daoSidebar: ["dao", "dao/node-basics", "dao/liquidity-mining", "dao/faq"],
};
Expand Down
Binary file added static/img/smooth-unsub-initial-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/smooth-unsub-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/smooth-unsubscribe-done.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ec1c966

Please sign in to comment.