Merge pull request #29 from Garf1eld99/patch-1

Added altornado staking documentation

SUMMARY.md

@@ -8,7 +8,9 @@
 * [How to use Tornado Cash with TOR](general/how-to-use-tornado-cash-with-tor.md)
 * [TORN](general/torn.md)
 * [Governance](general/governance.md)
-* [Staking](general/staking.md)
+* [Staking](general/staking/README.md)
+  * [Tornado Cash](general/staking/tornado-cash.md)
+  * [Altornado](general/staking/altornado.md)
 * [How to add or remove liquidity on Uniswap v2](general/how-to-add-or-remove-liquidity-on-uniswapv2.md)
 * [How to become a relayer?](general/how-to-become-a-relayer.md)
 * [Community Involvement](general/community-involvement.md)
@@ -35,5 +37,6 @@
 * [More anonymity tips](tornado-cash-nova/more-anonymity-tips.md)
 
 ## They talk about us
+
 * [Articles](medias/articles.md)
 * [Videos](medias/videos.md)

general/how-to-become-a-relayer.md

@@ -1,4 +1,4 @@
-# How to Become a Relayer?
+# How to become a relayer?
 
 Following the execution of [Tornado Cash 10th governance proposal](https://tornadocash.eth.link/governance/10), anyone can become a relayer for Tornado Cash users.
 
@@ -104,7 +104,7 @@ The minimum staked amount is currently set by Tornado Cash governance at **`300
 
 When a relayer is used in the Tornado Cash pool, a small amount of TORN is automatically collected from this staked balance by the `StakingReward` contract. This element is essential to keep in mind as relayers will need to keep enough TORN locked (\~`40 TORN` at the moment in April 2022) to be able to pay back the transaction fee to the staking contract.
 
-The collected fees are subsequently distributed among DAO members with locked TORN tokens. TORN are usually locked to participate in on-chain governance (submitting & voting on proposals). You can find more information both on this [forum post](https://torn.community/t/proposal-relayer-registry-setting-parameters-after-audit/2134) & in the [Staking TORN documentation page](staking.md).
+The collected fees are subsequently distributed among DAO members with locked TORN tokens. TORN are usually locked to participate in on-chain governance (submitting & voting on proposals). You can find more information both on this [forum post](https://torn.community/t/proposal-relayer-registry-setting-parameters-after-audit/2134) & in the [Staking TORN documentation page](staking/).
 
 {% hint style="warning" %}
 Your staked TORN amount is not claimable, and it is non-refundable.

general/staking.md

@@ -1,44 +0,0 @@
-# Staking
-
-Since its inception, the TORN token is used by Tornado Cash users for governance. Its main utility is to allow the suggestion of proposals & voting both in-chain (through locked TORN for governance proposals) and off-chain (on Snapshot).
-
-Since the execution of [Tornado Cash 10th governance proposal](https://tornadocash.eth.limo/governance/10), TORN token has gained one other useful utility. Indeed, **with the introduction of a decentralized relayer register,** **a staking reward has been implemented for all holders with locked TORN in the governance contract.**
-
-[TORN](torn.md) holders can still lock their tokens into the governance contract as they used to for governance purposes. The significant difference is that they are now able to receive a portion of the fees collected by the protocol from relayers. Obviously, the proportion of the reward will be equal to the proportion of their locked TORN.
-
-#### **FROM WHERE THESE COLLECTED FEES COME FROM ?**
-
-The collection of these fees was made possible by the implementation of a decentralized relayer registry. In order to be listed on the protocol UI, relayers need to stake a given amount of TORN (currently set by governance at `300 TORN`) and keep enough TORN locked (\~`40 TORN` at the moment in April 2022) to be able to pay back the transaction fee to the staking contract. The functioning of this relayer registry is more extensively explained [on this forum post](https://torn.community/t/proposal-relayer-registry-setting-parameters-after-audit/2134) & on the [Relayer Registry documentation page](how-to-become-a-relayer.md).
-
-In a nutshell, for each withdrawal through the relayer method, the chosen relayer has to pay a fee to the protocol from the staked balance (that should still be maintained above the `300 TORN` threshold). Currently, this fee has been fixed at `0.3%` by the governance and can be changed at any time through an on-chain proposal & vote.
-
-### How to Stake TORN token ?
-
-First, [connect your wallet to Tornado Cash](../tornado-cash-classic/how-to-connect-your-wallet.md).
-
-As mentioned above, the process to lock TORN tokens has remained unchanged.
-
-* It happens here ➡️ [https://tornadocash.eth.limo/governance](https://tornadocash.eth.limo/governance) ⬅️, by clicking on **`Manage`**, then going on the **`Lock`** tab
-* The governance contract need to be approved in order to allow the transfer of your tokens to the smart contract. To do so, you need to click on the **`Approve`** button
-* Once the approval is confirmed, you can chose the amount of token to lock, then click on **`Lock`**
-* All you have to do after that is to confirm the transaction in your wallet & wait for the confirmation to come through
-
-![](../.gitbook/assets/c05e5a1813edad280544b627b24002dc8d5adcf2.png)
-
-### How to Claim Your Staking Reward ?
-
-Now that your TORN tokens have stayed nice & warm locked in the governance contract, you are able to claim your staking reward. How to do that? Everything is still happening here ➡️ [https://tornadocash.eth.link/governance](https://tornadocash.eth.limo/governance) ⬅️
-
-As soon as you log in the page, you will be able to see your staking reward at the top, just waiting for you to collect it 💰
-
-![](../.gitbook/assets/head.png)
-
-* Click **`Manage`** -> **`Claim`** tab -> **`Claim`** _button._
-
-![](<../.gitbook/assets/claim (1).png>)
-
-_That's it, we're done, easy peasy lemon squeezy_ :wink:
-
-\_\_
-
-_Written by_ [_**@bt11ba**_](https://torn.community/u/bt11ba/) _&_ [_**@ayefda**_](https://torn.community/u/ayefda)

general/staking/README.md

@@ -0,0 +1,36 @@
+---
+description: Staking options for $TORN
+---
+
+# Staking
+
+Since its inception, the TORN token is used by Tornado Cash users for governance. Its main utility is to allow the suggestion of proposals & voting both in-chain (through locked TORN for governance proposals) and off-chain (on Snapshot).
+
+Since the execution of [Tornado Cash 10th governance proposal](https://tornadocash.eth.limo/governance/10), TORN token has gained one other useful utility. Indeed, **with the introduction of a decentralized relayer register,** **a staking reward has been implemented for all holders with locked TORN in the governance contract.**
+
+[TORN](../torn.md) holders can still lock their tokens into the governance contract as they used to for governance purposes. The significant difference is that they are now able to receive a portion of the fees collected by the protocol from relayers. Obviously, the proportion of the reward will be equal to the proportion of their locked TORN.
+
+#### **FROM WHERE THESE COLLECTED FEES COME FROM ?**
+
+The collection of these fees was made possible by the implementation of a decentralized relayer registry. In order to be listed on the protocol UI, relayers need to stake a given amount of TORN (currently set by governance at `300 TORN`) and keep enough TORN locked (\~`40 TORN` at the moment in April 2022) to be able to pay back the transaction fee to the staking contract. The functioning of this relayer registry is more extensively explained [on this forum post](https://torn.community/t/proposal-relayer-registry-setting-parameters-after-audit/2134) & on the [Relayer Registry documentation page](../how-to-become-a-relayer.md).
+
+In a nutshell, for each withdrawal through the relayer method, the chosen relayer has to pay a fee to the protocol from the staked balance (that should still be maintained above the `300 TORN` threshold). Currently, this fee has been fixed at `0.3%` by the governance and can be changed at any time through an on-chain proposal & vote.
+
+### Where to stake $TORN ?
+
+#### 1. Tornado Cash
+
+The first option to stake is the usual URL for Tornado Cash. This has been available since February 2022. You will find a step-by-step tutorial here.
+
+{% content-ref url="tornado-cash.md" %}
+[tornado-cash.md](tornado-cash.md)
+{% endcontent-ref %}
+
+#### 2. Altornado
+
+An alternative option to stake $TORN has been brought by the community. The need for a staking UI and in the long run, the necessity for a Tornado Cash full **alternative UI** made this happen. Altornado provides the community with an intuitive and rich user experience, using the same Tornado Cash contracts.\
+You will always have information about your wallet as well as information about your future rewards depending on the amount you want to stake.
+
+{% content-ref url="altornado.md" %}
+[altornado.md](altornado.md)
+{% endcontent-ref %}

general/staking/altornado.md

@@ -0,0 +1,49 @@
+---
+description: Staking on Altornado
+---
+
+# Altornado
+
+## Alternative staking UI
+
+Since the deployment of [Altornado](https://altornado.com/#/stake) **TORN** holders have now an alternative open-source staking UI made by Tornado Cash Community, for the Tornado Cash community.
+
+Yes, hence the name altornado: from “alternative” and “tornado” 🌝
+
+From the approval of [this](https://snapshot.org/#/torn-community.eth/proposal/0x331caa7b479669e8b836bd87ba9d91427c212ec29a2ede13d84c7190af18c931) snapshot proposal, they will be funded to deliver an amazing roadmap full of new features in the subsequent versions.
+
+Altornado’s source code is and will always be free to access. Altornado do not and will never have access to users data.
+
+The site will always remain accessible to everyone, without any restrictions.
+
+### Ok, this sounds awesome, how do I stake ?
+
+* Let's start here ➡️ [https://altornado.com/#/stake](https://altornado.com/#/stake) ⬅️, connect your wallet clicking on **`Connect your wallet`**.
+* You will need to approve the staking contract, so click on the **`Approve`** button.
+* After approving, you're ready to stake! You can choose the amount of TORN to stake, then click on **`Stake`** or choose the max amount available in your wallet by clicking **`Max`**.
+* Confirm the transaction in your wallet and start enjoying your staking rewards.
+
+![](../../.gitbook/assets/Stake.png)
+
+### Hmmm, maybe not yet, now you need to claim your rewards in order to do so 😼
+
+* In order to claim your rewards, head over the [Claim](https://altornado.com/#/claim) tab.
+* Click on the **`Claim`** button.
+* Confirm the transaction in your wallet and wait until your fresh $TORN hits your wallet balance.
+
+![](../../.gitbook/assets/Claim.png)
+
+### So far so good, but what if I need to unstake ?
+
+* To unstake your [TORN](https://etherscan.io/token/0x77777feddddffc19ff86db637967013e6c6a116c) tokens go to the [Unstake](https://altornado.com/#/unstake) tab.
+* Choose the amount of TORN you want to unstake.
+* You will now see the **`Unstake`** button, click it.
+* Finally, confirm the transaction in your wallet in order to complete the transaction.
+
+![](../../.gitbook/assets/Unstake.png)
+
+_That's it, we're done, easy peasy lemon squeezy_ :wink:
+
+\_\_
+
+_Written by_ [_**@bt11ba**_](https://torn.community/u/bt11ba/) _&_ [_**@ayefda**_](https://torn.community/u/ayefda)

general/staking/tornado-cash.md

@@ -0,0 +1,32 @@
+---
+description: Staking on Tornado Cash
+---
+
+# Tornado Cash
+
+### How to Stake TORN token ?
+
+First, [connect your wallet to Tornado Cash](../../tornado-cash-classic/how-to-connect-your-wallet.md).
+
+As mentioned above, the process to lock TORN tokens has remained unchanged.
+
+* It happens here ➡️ [https://tornadocash.eth.limo/governance](https://tornadocash.eth.limo/governance) ⬅️, by clicking on **`Manage`**, then going on the **`Lock`** tab
+* The governance contract need to be approved in order to allow the transfer of your tokens to the smart contract. To do so, you need to click on the **`Approve`** button
+* Once the approval is confirmed, you can chose the amount of token to lock, then click on **`Lock`**
+* All you have to do after that is to confirm the transaction in your wallet & wait for the confirmation to come through
+
+![](../../.gitbook/assets/c05e5a1813edad280544b627b24002dc8d5adcf2.png)
+
+### How to Claim Your Staking Reward ?
+
+Now that your TORN tokens have stayed nice & warm locked in the governance contract, you are able to claim your staking reward. How to do that? Everything is still happening here ➡️ [https://tornadocash.eth.link/governance](https://tornadocash.eth.limo/governance) ⬅️
+
+As soon as you log in the page, you will be able to see your staking reward at the top, just waiting for you to collect it 💰
+
+![](../../.gitbook/assets/head.png)
+
+* Click **`Manage`** -> **`Claim`** tab -> **`Claim`** _button._
+
+![](<../../.gitbook/assets/claim (1).png>)
+
+##