tornadocontrib/docs
1
0
Fork 0
forked from tornadocash/docs
Code Pull Requests Activity

fix cli conflicts

Browse Source
This commit is contained in:
gozzy 2023-01-16 01:16:04 +00:00
parent b91f1a469f
commit 2e1f372d88
7 changed files with 3 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
book.json Normal file
View File

@ -0,0 +1,3 @@
{
"plugins": ["hints", "tabs2"]
}

4
circuits/README.md
View File

@ -56,14 +56,10 @@ Tornado.cash is best understood as having two separate major components.
The core deposit circuit is what most users interact with, proving that a user has created a commitment representing the deposit of some corresponding asset denomination, that they haven't yet withdrawn that asset, and that they know the secret that they supplied when generating the initial commitment. The core deposit circuit is what most users interact with, proving that a user has created a commitment representing the deposit of some corresponding asset denomination, that they haven't yet withdrawn that asset, and that they know the secret that they supplied when generating the initial commitment.
{% content-ref url="core-deposit-circuit.md" %}
[core-deposit-circuit.md](core-deposit-circuit.md) [core-deposit-circuit.md](core-deposit-circuit.md)
{% endcontent-ref %}
#### Anonymity Mining #### Anonymity Mining
The anonymity mining circuits form the basis for the Anonymity Mining program, which incentivizes users to leave their deposits in the contract for longer periods of time, so as to ensure that the Tornado.cash deposit pools maintain a large number of active deposits (thus increasing [k-anonymity](https://en.wikipedia.org/wiki/K-anonymity) for other users). The anonymity mining circuits form the basis for the Anonymity Mining program, which incentivizes users to leave their deposits in the contract for longer periods of time, so as to ensure that the Tornado.cash deposit pools maintain a large number of active deposits (thus increasing [k-anonymity](https://en.wikipedia.org/wiki/K-anonymity) for other users).
{% content-ref url="anonymity-mining/" %}
[anonymity-mining](anonymity-mining/) [anonymity-mining](anonymity-mining/)
{% endcontent-ref %}

4
circuits/anonymity-mining/README.md
View File

@ -4,12 +4,8 @@ The anonymity mining protocol underpins the [Anonymity Mining Program](../../ano
Anonymity Mining uses a Tornado Trees contract as a ZK-efficient register of deposit and withdrawal transactions, which enables users to make efficient proofs regarding their usage. Anonymity Mining uses a Tornado Trees contract as a ZK-efficient register of deposit and withdrawal transactions, which enables users to make efficient proofs regarding their usage.
{% content-ref url="tornado-trees.md" %}
[tornado-trees.md](tornado-trees.md) [tornado-trees.md](tornado-trees.md)
{% endcontent-ref %}
Once deposits and withdrawals are registered into the Tornado Trees contract, they become eligible for having their rewards claimed into a shielded AP account. Once deposits and withdrawals are registered into the Tornado Trees contract, they become eligible for having their rewards claimed into a shielded AP account.
{% content-ref url="mining-rewards.md" %}
[mining-rewards.md](mining-rewards.md) [mining-rewards.md](mining-rewards.md)
{% endcontent-ref %}

2
general/how-to-become-a-relayer.md
View File

@ -38,8 +38,6 @@ The formula for designating a relayer is as follows:
The first concrete step is to run the Tornado Cash Relayer software for Ethereum Mainnet on your computer. All steps are outlined 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). The first concrete step is to run the Tornado Cash Relayer software for Ethereum Mainnet on your computer. All steps are outlined 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 completed, you will need to insert your url in the input box. Once completed, you will need to insert your url in the input box.
![](<../.gitbook/assets/2 (1).png>) ![](<../.gitbook/assets/2 (1).png>)

2
general/minified-ui-hosted-locally.md
View File

@ -2,8 +2,6 @@
Tornado Cash protocol can be launched locally on your computer through a minified User Interface version made available by the core developers team. Tornado Cash protocol can be launched locally on your computer through a minified User Interface version made available by the core developers team.
{% embed url="https://github.com/tornadocash/ui-minified" %}
### Step #1: Clone the Github repository on your computer ### Step #1: Clone the Github repository on your computer
By opening your Command Line Interface, you can run the following commands to, first, clone the repository, then go inside the newly copied folder: By opening your Command Line Interface, you can run the following commands to, first, clone the repository, then go inside the newly copied folder:

4
general/staking/README.md
View File

@ -22,15 +22,11 @@ In a nutshell, for each withdrawal through the relayer method, the chosen relaye
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. 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) [tornado-cash.md](tornado-cash.md)
{% endcontent-ref %}
#### 2. Altornado #### 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.\ 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. 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) [altornado.md](altornado.md)
{% endcontent-ref %}

11
general/tornado-cash-smart-contracts.md
View File

@ -167,26 +167,15 @@
* Tornado Cash core code: * Tornado Cash core code:
{% embed url="https://github.com/tornadocash/tornado-core" %}
* Tornado Cash Command Line to make transactions in the protocol: * Tornado Cash Command Line to make transactions in the protocol:
{% embed url="https://github.com/tornadocash/tornado-cli" %}
* To become a relayer for Tornado Cash: * To become a relayer for Tornado Cash:
{% embed url="https://github.com/tornadocash/tornado-relayer" %}
* Minified web UI for Tornado Cash protocol: * Minified web UI for Tornado Cash protocol:
{% embed url="https://github.com/tornadocash/ui-minified" %}
* All about the TORN token: * All about the TORN token:
{% embed url="https://github.com/tornadocash/torn-token" %}
* All about the anonymity mining program (this program has ended mid-December 2021): * All about the anonymity mining program (this program has ended mid-December 2021):
{% embed url="https://github.com/tornadocash/tornado-anonymity-mining" %}
_Written by_ [_@ayefda_](https://torn.community/u/ayefda) _&_ [_@bt11ba_](https://torn.community/u/bt11ba/) _Written by_ [_@ayefda_](https://torn.community/u/ayefda) _&_ [_@bt11ba_](https://torn.community/u/bt11ba/)