mirror of https://github.com/tornadocash/docs
GitBook: [#89] No subject
This commit is contained in:
bt11ba
gitbook-bot
parent
b928c558ea
commit
f1629c1906
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 91 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 68 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
|
|
@ -9,6 +9,7 @@
|
|||
* [TORN](general/torn.md)
|
||||
* [Governance](general/governance.md)
|
||||
* [Staking](general/staking.md)
|
||||
* [How to Become a Relayer?](general/how-to-become-a-relayer.md)
|
||||
* [Community Involvement](general/community-involvement.md)
|
||||
* [Minified UI Hosted Locally](general/minified-ui-hosted-locally.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,109 @@
|
|||
# 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.
|
||||
|
||||
{% hint style="success" %}
|
||||
The only condition to be included on the Tornado Cash Relayer Registry UI is to hold a min. of `300 TORN`. This minimum stake can be changed by Tornado.Cash governance at all time.
|
||||
{% endhint %}
|
||||
|
||||
Relayers form an essential & necessary part of the Tornado.Cash ecosystem. Their use guarantees privacy as they solve the infamous “fee payment dilemma” : how to pay fees for token withdrawals from a pool while maintaining anonymity?
|
||||
|
||||
Therefore, relayers act as a third parties and take care of the whole withdrawal. They pay for transaction fees by deducing them directly from the transferred amount. They also take an additional fee for their services.
|
||||
|
||||
Since [Relayer Registry proposal](https://tornadocash.eth.link/governance/10), the protocol will collect a fee directly from the relayer’s staked balance through the `StakingReward` contract for each withdrawal. This fee percentage may vary from one pool to the other and is also subject to change through on-chain governance. It’s fixed at 0.3% for now.
|
||||
|
||||
## How to Become a Relayer ?
|
||||
|
||||
Any TORN holder can become a relayer for the protocol in **6 simple steps** through a Relayer Registry User Interface (UI).
|
||||
|
||||
You will find below everything your need to join our relayers' club & be listed on Tornado Cash decentralized relayer registry.
|
||||
|
||||
### 1. Requirements: Be Aware & Accept Potential Risks
|
||||
|
||||
Before you commit to sharing part of your journey with Tornado Cash users as a relayer, you need to be aware & accept all potential risks of being a relayer for the protocol.
|
||||
|
||||
### 2. Set up Relayer
|
||||
|
||||
The first concrete step is to run Tornado Cash Relayer software for Ethereum Mainnet on your computer. All steps are explained in the protocol's github. To complete this task successfully, you will have to carefully follow [these instructions](https://github.com/tornadocash/tornado-relayer#deploy-with-docker-compose).
|
||||
|
||||
{% embed url="https://github.com/tornadocash/tornado-relayer#deploy-with-docker-compose" %}
|
||||
|
||||
Once you are done, you will need to insert your url in the input box.
|
||||
|
||||
|
||||
|
||||
### 3. Set Up ENS Subdomain
|
||||
|
||||
The next step consists in:
|
||||
|
||||
* Creating an ENS domain for your relayer,
|
||||
* Setting up its mainnet subdomain,
|
||||
* Adding a TXT record with the Relayer URL to the mainnet subdomain according to this specific format:
|
||||
|
||||
#### Ethereum Relayers (Mandatory)
|
||||
|
||||
| TXT record |
|
||||
| ----------------------- |
|
||||
| mainnet-tornado.xxx.eth |
|
||||
| goerli-tornado.xxx.eth |
|
||||
|
||||
#### **Sidechains Relayers (Optional)**
|
||||
|
||||
You also have the possibility to add subdomains with their corresponding TXT records to support other chains than Ethereum. Sidechains relayers use a different version of the Relayer software. You have all required instructions to do so [here](https://github.com/tornadocash/tornado-relayer/blob/light/README.md).
|
||||
|
||||
| TXT record |
|
||||
| ------------------------- |
|
||||
| bsc-tornado.xxx.eth |
|
||||
| gnosis-tornado.xxx.eth |
|
||||
| polygon-tornado.xxx.eth |
|
||||
| optimism-tornado.xxx.eth |
|
||||
| arbitrum-tornado.xxx.eth |
|
||||
| avalanche-tornado.xxx.eth |
|
||||
|
||||
#### Nova Relayer (Optional)
|
||||
|
||||
Tornado Cash Nova uses its own version of the software. If you wish to become a relayer for Tornado Cash Nova, you will find instructions to follow [here](https://github.com/tornadocash/tornado-pool-relayer#deploy-with-docker-compose).
|
||||
|
||||
| TXT record |
|
||||
| ------------------- |
|
||||
| gnosis-nova.xxx.eth |
|
||||
|
||||
|
||||
|
||||
#### 4. Set Up Workers
|
||||
|
||||
Workers are the addresses that will allow your relayer to send ZK-proofs to users. By default, the first worker is the ENS domain owner's address.
|
||||
|
||||
To ensure an extra level of security, we advise you to set up more than one worker.
|
||||
|
||||
Only the mainnet requires you to register workers. All other networks do not require the usage of registered workers.
|
||||
|
||||
.png>)
|
||||
|
||||
#### 5. Stake
|
||||
|
||||
With the implementation of a decentralized relaye registry, a staking condition has been introduced to become a relayer for Tornado Cash users. Indeed, **staking TORN is now necessary to be added to the recommended list of relayers.**
|
||||
|
||||
The minimum stacked amount is currently set by Tornado Cash governance at **`300 TORN`**. This threshold can be changed by Tornado.Cash governance at all time.
|
||||
|
||||
When a relayer is used on a 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 maintain their stakes balance above `300 TORN` at all time.
|
||||
|
||||
These collected fees are, afterwards, distributed among DAO members that have their TORN tokens locked. TORN are usually locked to participate in on-chain governance (suggesting & voting for 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).
|
||||
|
||||
{% hint style="warning" %}
|
||||
Your staked TORN amount is not claimable, and it is non-refundable.
|
||||
{% endhint %}
|
||||
|
||||
|
||||
|
||||
#### 6. Summary: Last Verification & Registration
|
||||
|
||||
The last, but not the least, we advise you to **double-check all information** present on the Summary before registering.
|
||||
|
||||
|
||||
|
||||
_Welcome to the relayer team! Thanks to you, privacy can be better respected_ 💚
|
||||
|
||||
|
||||
|
||||
_Written by_ [_**@bt11ba**_](https://torn.community/u/bt11ba/) _**** &_ [_**@ayefda**_](https://torn.community/u/ayefda)****
|
||||
|
|
@ -1,35 +1,42 @@
|
|||
# Staking
|
||||
|
||||
Thanks to [Proposal #10](https://tornadocash.eth.link/governance/10), any [$TORN](torn.md) holder can lock their [$TORN](torn.md) token into Governance contract like before, but are now able to receive a portion of the fees collected by relayers proportionately to their stake.
|
||||
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).
|
||||
|
||||
As explained [here](https://torn.community/t/proposal-relayer-registry-setting-parameters-after-audit/2134), on every withdrawal via relayer, the relayer has to pay a fee from his staked balance. Currently, this fee is fixed at 0.3% and can be changed at any time by a governance vote.
|
||||
Since the execution of [Tornado Cash 10th governance proposal](https://tornadocash.eth.link/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.** 
|
||||
|
||||
### How to lock $TORN token ?
|
||||
[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.
|
||||
|
||||
In order to lock $TORN token,
|
||||
#### FROM WHERE THESE COLLECTED FEES COME FROM ?
|
||||
|
||||
Go to: [https://tornadocash.eth.link/governance](https://tornadocash.eth.link/governance)
|
||||
The collection of these fees was made possible by the implementation of a decentralized relayer registry. In order to be listed on the protocol, relayers need to stake a given amount of TORN (currently set by governance at `300 TORN`). 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](broken-reference).
|
||||
|
||||
Click `Manage` -> `Lock Tab`
|
||||
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.
|
||||
|
||||
Approve the governance contract to transfer your TORN tokens by clicking on the `Approve` button. Once the approve is confirmed, chose the amount you want to deposit and click `Lock`. Confirm the transaction in your wallet and wait for the confirmation.
|
||||
### How to Stake TORN token ?
|
||||
|
||||
As mentioned above, the process to lock TORN tokens has remained unchanged.
|
||||
|
||||
* It happens here ➡️ [https://app.tornado.cash/governance](https://app.tornado.cash/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
|
||||
|
||||
|
||||
|
||||
### How to claim staking reward ?
|
||||
### How to Claim Your Staking Reward ?
|
||||
|
||||
To claim staking reward, go to [https://tornadocash.eth.link/governance](https://tornadocash.eth.link/governance)
|
||||
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.link/governance) ⬅️
|
||||
|
||||
You will be able to see your staking reward at the top of the page:
|
||||
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 💰
|
||||
|
||||
|
||||
|
||||
Click **`Manage`** -> **`Claim`** tab -> **`Claim`** _button._
|
||||
* Click **`Manage`** -> **`Claim`** tab -> **`Claim`** _button._
|
||||
|
||||
.png>)
|
||||
|
||||
_That's it, we're done._ :wink:__
|
||||
_That's it, we're done, easy peasy lemon squeezy_ :wink:__
|
||||
|
||||
__
|
||||
|
||||
_Written by_ [_@bt11ba_](https://torn.community/u/bt11ba/)
|
||||
_Written by_ [_**@bt11ba**_](https://torn.community/u/bt11ba/) _**** &_ [_**@ayefda**_](https://torn.community/u/ayefda)****
|
||||
|
|
|
|||
Loading…
Reference in New Issue