diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..b89041f --- /dev/null +++ b/.env.example @@ -0,0 +1,2 @@ +PINATA_API_KEY= +PINATA_SECRET_API_KEY= \ No newline at end of file diff --git a/.gitbook/assets/Claim.png b/.gitbook/assets/Claim.png deleted file mode 100644 index d5b1d52..0000000 Binary files a/.gitbook/assets/Claim.png and /dev/null differ diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9c35804 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.env +node_modules +_book +build \ No newline at end of file diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000..11c9723 --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +v10.24.1 \ No newline at end of file diff --git a/README.md b/README.md index a7c1ab8..cb35706 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,24 @@ -# Introduction to Tornado Cash +# Tornado Cash Documentation -![](/.gitbook/assets/image.png) +> UI for non-custodial Ethereum Privacy solution -{% hint style="danger" %} -*Tornado Cash was sanctioned by the US Treasury on 08/08/2022, making it illegal for US citizens to interact with the core and governance contracts.* -{% endhint %} -Tornado Cash is a **non-custodial** **privacy protocol** allowing **permissionless** shielded transactions on Ethereum and derivative networks. **Tornado Cash is not a mixer, as assets are never commingled due to the presence of zero knowledge cryptography**. The core of the protocol is ungovernable and immutable, given Ethereum's distributed state and the provenance of the contracts, they can neither be changed nor tampered with. -Therefore, nobody - including the original developers - can modify or inhibit the protocol. All governance and associated smart contracts are deployed by the community. As a non-custodial protocol, users keep custody of their cryptocurrencies while using Tornado Cash. This means that at each deposit, they are provided with a secret "note" that grants the access to the deposited funds, allowing self-soverginity over one's assets. +### Read static content -## How is anonymity achieved? +Entrypoint here: [docs](book/README.md) -Tornado Cash achives anonymity by breaking the on-chain link between source and destination addresses through "anonymity pools". These are immutable smart contracts that accepts fixed denominations of a currency, acting as what is known as a mix network. Although anonymity is only obtained with use of a "relayer", which acts as a withdrawal proxy to mask the link between destination and source addresses. +### Building locally -Learn more about [_How does Tornado Cash work?_](general/how-does-it-work.md) and [Tips to remain anonymous](general/guides/opsec.md). +* Install [Node.js](https://nodejs.org) version 10.24 + * If you are using [nvm](https://github.com/nvm-sh/nvm) (recommended) running `nvm use` will automatically choose the right node version for you. +* Install dependencies: `npm i` +* Install gitbook dependencies: `npm run prepare` +* Build gitbook to static content: `npm run build` -## Where is Tornado Cash deployed? +## Deploy on IPFS -Since its inception in 2019, Tornado Cash has been mainly operating **on the Ethereum network**, with anonymity pools for ETH, DAI, cDAI, USDC, USDT and WBTC. +* Copy `.env.example` file to `.env` -Since June 2021, the smart contracts **have also been deployed on other side-chains & blockchains**. These deployments enabled network agnostic functionality, allowing for faster and cheaper transactions. - -* **Ethereum** - * **ETH** (Ethereum) - * **DAI** (Dai) - * **cDAI** (Compound Dai) - * **USDC** (USD Coin) - * **USDT** (Tether) - * **WBTC** (Wrapped Bitcoin) -* **Binance Smart Chain** - * **BNB** (Binance Coin) -* **Polygon** - * **MATIC** (Polygon) -* **Gnosis Chain (formerly xDAI)** - * **xDAI** (xDai) -* **Avalanche** - * **AVAX** (Avalanche) -* **Optimism** - * **ETH** (Ethereum) -* **Arbitrum One** - * **ETH** (Ethereum) - -Until December 2021, governance enabled "anonymity mining" - a mechanism to incentivise proactive usage of selected anonymity sets to compliment pool entropy, allowing depositors to earn the native governance token (**TORN**). - -_See sections_ [_Anonymity mining_](circuits/anonymity-mining) _and the_ [_TORN token_](general/token/index.md) for more information. - -**The protocol's native governance token, TORN, allows open and decentralized collaboration to shape the direction of the protocol through voting.**. The community has a strong influence over the evolution of Tornado Cash, it's development and management of the protocol's treasury. - -Anonymity pools operate **under the principle of fixed-amount deposits and withdrawals**. Meaning that each supported asset has multiple pools which make up an "anonymity set", each pool restricts transactions to be a fixed amount _(e.g. ETH has four different pools, one for each of these amounts: 0.1, 1, 10 and 100 ETH)_. - -### Tornado Cash Nova - -With the release of a [**new __experimental__ version of Tornado Cash; Nova**](https://tornado-cash.medium.com/tornado-cash-introduces-arbitrary-amounts-shielded-transfers-8df92d93c37c), provides an **upgraded expierence for anonymity pools**. Users are no longer constrained by fixed-amount transactions, possible through the UXTO model alllowing **arbitrary (customized) amounts and shielded internal transfers**. - -Tornado Cash Nova is deployed on Gnosis Chain (formerly xDAI) with the original hopes to improve speed and cost by bridging from Ethereum mainnet using the AMB Omnibridge. - -__Please note Tornado Cash Nova has a low relayer count, is in an experimental state and regularly faces issues with Omnibridge because of bridge limits and validator censorship__. - -## How does Tornado Cash function? - -Tornado Cash is represented by it's community, collaboration is facilitated through the governance contract or Decentralized Autonomous Organisation (DAO). **No singular entity or person controls Tornado Cash.** - -All protocol related code is open-source and is published to two independent git instances: - -* [Community git](https://git.tornado.ws): store of the latest community maintained repositories -* [Sanctioned Github](https://github.com/tornadocash): public archive after the OFAC sanctions - -The existence of zero knowledge in the protocol was based **on open-source research authored by ZCash**. To implement a zero knowledge scheme, [a trusted setup is required](https://tornado-cash.medium.com/tornado-cash-trusted-setup-ceremony-b846e1e00be1), which is essentially a store of random data from various sources defining robustness in generation of proving and verifying keys. Which successfully occured for the protocol on [May 2020 with 1114 contributions](https://tornado-cash.medium.com/the-biggest-trusted-setup-ceremony-in-the-world-3c6ab9c8fffa). This significant number of contributors makes it implausible to compromise the protocol by faking zero-knowledge proofs. - -Tornado Cash user interfaces are hosted on **IPFS** (InterPlanetary File System) deployed by the community, minimizing the risk of censorship. These interfaces will be accessible as long as IPFS nodes pin the content, the latest IPFS content hashes are available at [tornadocash.eth](https://app.ens.domains/name/tornadocash.eth/details) and [nova.tornadocash.eth](https://app.ens.domains/name/nova.tornadocash.eth/details). Please see [how to pin IPFS content](https://docs.ipfs.tech/how-to/pin-files/) if you wish to contribute. +- Make sure you set `PINATA_API_KEY` and `PINATA_SECRET_API_KEY` environment variables in `.env` +- To deploy a production build run `npm run deploy:ipfs` \ No newline at end of file diff --git a/.gitbook/assets/1 (1).png b/book/.gitbook/assets/1 (1).png similarity index 100% rename from .gitbook/assets/1 (1).png rename to book/.gitbook/assets/1 (1).png diff --git a/.gitbook/assets/1 (2).png b/book/.gitbook/assets/1 (2).png similarity index 100% rename from .gitbook/assets/1 (2).png rename to book/.gitbook/assets/1 (2).png diff --git a/.gitbook/assets/1 (3).png b/book/.gitbook/assets/1 (3).png similarity index 100% rename from .gitbook/assets/1 (3).png rename to book/.gitbook/assets/1 (3).png diff --git a/.gitbook/assets/1-bje88nlnkbe29-zcs5agkw-2x.png b/book/.gitbook/assets/1-bje88nlnkbe29-zcs5agkw-2x.png similarity index 100% rename from .gitbook/assets/1-bje88nlnkbe29-zcs5agkw-2x.png rename to book/.gitbook/assets/1-bje88nlnkbe29-zcs5agkw-2x.png diff --git a/.gitbook/assets/1-bjggju1rn4_qoxgcljfneq.png b/book/.gitbook/assets/1-bjggju1rn4_qoxgcljfneq.png similarity index 100% rename from .gitbook/assets/1-bjggju1rn4_qoxgcljfneq.png rename to book/.gitbook/assets/1-bjggju1rn4_qoxgcljfneq.png diff --git a/.gitbook/assets/1-gmc0jw8zr5xfvrk5zyqmya.png b/book/.gitbook/assets/1-gmc0jw8zr5xfvrk5zyqmya.png similarity index 100% rename from .gitbook/assets/1-gmc0jw8zr5xfvrk5zyqmya.png rename to book/.gitbook/assets/1-gmc0jw8zr5xfvrk5zyqmya.png diff --git a/.gitbook/assets/1-megm4amqrrkx0qxva9iska-2x.png b/book/.gitbook/assets/1-megm4amqrrkx0qxva9iska-2x.png similarity index 100% rename from .gitbook/assets/1-megm4amqrrkx0qxva9iska-2x.png rename to book/.gitbook/assets/1-megm4amqrrkx0qxva9iska-2x.png diff --git a/.gitbook/assets/1-ogfrad8p3gez14zh4jndiq-2x.png b/book/.gitbook/assets/1-ogfrad8p3gez14zh4jndiq-2x.png similarity index 100% rename from .gitbook/assets/1-ogfrad8p3gez14zh4jndiq-2x.png rename to book/.gitbook/assets/1-ogfrad8p3gez14zh4jndiq-2x.png diff --git a/.gitbook/assets/1-qwu2v6lalrldd28prupvlq.png b/book/.gitbook/assets/1-qwu2v6lalrldd28prupvlq.png similarity index 100% rename from .gitbook/assets/1-qwu2v6lalrldd28prupvlq.png rename to book/.gitbook/assets/1-qwu2v6lalrldd28prupvlq.png diff --git a/.gitbook/assets/1.png b/book/.gitbook/assets/1.png similarity index 100% rename from .gitbook/assets/1.png rename to book/.gitbook/assets/1.png diff --git a/.gitbook/assets/181d612b6c57964bab59c8e5b766f5247211083d.png b/book/.gitbook/assets/181d612b6c57964bab59c8e5b766f5247211083d.png similarity index 100% rename from .gitbook/assets/181d612b6c57964bab59c8e5b766f5247211083d.png rename to book/.gitbook/assets/181d612b6c57964bab59c8e5b766f5247211083d.png diff --git a/.gitbook/assets/1add.png b/book/.gitbook/assets/1add.png similarity index 100% rename from .gitbook/assets/1add.png rename to book/.gitbook/assets/1add.png diff --git a/.gitbook/assets/2 (2).png b/book/.gitbook/assets/2 (2).png similarity index 100% rename from .gitbook/assets/2 (2).png rename to book/.gitbook/assets/2 (2).png diff --git a/.gitbook/assets/2.png b/book/.gitbook/assets/2.png similarity index 100% rename from .gitbook/assets/2.png rename to book/.gitbook/assets/2.png diff --git a/.gitbook/assets/200.gif b/book/.gitbook/assets/200.gif similarity index 100% rename from .gitbook/assets/200.gif rename to book/.gitbook/assets/200.gif diff --git a/.gitbook/assets/2add.png b/book/.gitbook/assets/2add.png similarity index 100% rename from .gitbook/assets/2add.png rename to book/.gitbook/assets/2add.png diff --git a/.gitbook/assets/3 (1).png b/book/.gitbook/assets/3 (1).png similarity index 100% rename from .gitbook/assets/3 (1).png rename to book/.gitbook/assets/3 (1).png diff --git a/.gitbook/assets/3 (2).png b/book/.gitbook/assets/3 (2).png similarity index 100% rename from .gitbook/assets/3 (2).png rename to book/.gitbook/assets/3 (2).png diff --git a/.gitbook/assets/4 (1).png b/book/.gitbook/assets/4 (1).png similarity index 100% rename from .gitbook/assets/4 (1).png rename to book/.gitbook/assets/4 (1).png diff --git a/.gitbook/assets/43c05d176d7f75a336af7a865565c9b23786b98c.png b/book/.gitbook/assets/43c05d176d7f75a336af7a865565c9b23786b98c.png similarity index 100% rename from .gitbook/assets/43c05d176d7f75a336af7a865565c9b23786b98c.png rename to book/.gitbook/assets/43c05d176d7f75a336af7a865565c9b23786b98c.png diff --git a/.gitbook/assets/4R1HHWy8j2kTwjugeFCfj2NzatB.png b/book/.gitbook/assets/4R1HHWy8j2kTwjugeFCfj2NzatB.png similarity index 100% rename from .gitbook/assets/4R1HHWy8j2kTwjugeFCfj2NzatB.png rename to book/.gitbook/assets/4R1HHWy8j2kTwjugeFCfj2NzatB.png diff --git a/.gitbook/assets/4remove.png b/book/.gitbook/assets/4remove.png similarity index 100% rename from .gitbook/assets/4remove.png rename to book/.gitbook/assets/4remove.png diff --git a/.gitbook/assets/5remove.png b/book/.gitbook/assets/5remove.png similarity index 100% rename from .gitbook/assets/5remove.png rename to book/.gitbook/assets/5remove.png diff --git a/.gitbook/assets/claim.png b/book/.gitbook/assets/Claim.png similarity index 100% rename from .gitbook/assets/claim.png rename to book/.gitbook/assets/Claim.png diff --git a/.gitbook/assets/Stake.png b/book/.gitbook/assets/Stake.png similarity index 100% rename from .gitbook/assets/Stake.png rename to book/.gitbook/assets/Stake.png diff --git a/.gitbook/assets/Unstake.png b/book/.gitbook/assets/Unstake.png similarity index 100% rename from .gitbook/assets/Unstake.png rename to book/.gitbook/assets/Unstake.png diff --git a/.gitbook/assets/aaaaaaaa (1) (1) (1) (1).gif b/book/.gitbook/assets/aaaaaaaa (1) (1) (1) (1).gif similarity index 100% rename from .gitbook/assets/aaaaaaaa (1) (1) (1) (1).gif rename to book/.gitbook/assets/aaaaaaaa (1) (1) (1) (1).gif diff --git a/.gitbook/assets/aaaaaaaa (1) (1) (1).gif b/book/.gitbook/assets/aaaaaaaa (1) (1) (1).gif similarity index 100% rename from .gitbook/assets/aaaaaaaa (1) (1) (1).gif rename to book/.gitbook/assets/aaaaaaaa (1) (1) (1).gif diff --git a/.gitbook/assets/aaaaaaaa (1) (1).gif b/book/.gitbook/assets/aaaaaaaa (1) (1).gif similarity index 100% rename from .gitbook/assets/aaaaaaaa (1) (1).gif rename to book/.gitbook/assets/aaaaaaaa (1) (1).gif diff --git a/.gitbook/assets/aaaaaaaa (1).gif b/book/.gitbook/assets/aaaaaaaa (1).gif similarity index 100% rename from .gitbook/assets/aaaaaaaa (1).gif rename to book/.gitbook/assets/aaaaaaaa (1).gif diff --git a/.gitbook/assets/aaaaaaaa (2).gif b/book/.gitbook/assets/aaaaaaaa (2).gif similarity index 100% rename from .gitbook/assets/aaaaaaaa (2).gif rename to book/.gitbook/assets/aaaaaaaa (2).gif diff --git a/.gitbook/assets/aaaaaaaa.gif b/book/.gitbook/assets/aaaaaaaa.gif similarity index 100% rename from .gitbook/assets/aaaaaaaa.gif rename to book/.gitbook/assets/aaaaaaaa.gif diff --git a/.gitbook/assets/aaaab.gif b/book/.gitbook/assets/aaaab.gif similarity index 100% rename from .gitbook/assets/aaaab.gif rename to book/.gitbook/assets/aaaab.gif diff --git a/.gitbook/assets/abdaaaa.png b/book/.gitbook/assets/abdaaaa.png similarity index 100% rename from .gitbook/assets/abdaaaa.png rename to book/.gitbook/assets/abdaaaa.png diff --git a/.gitbook/assets/abdce.gif b/book/.gitbook/assets/abdce.gif similarity index 100% rename from .gitbook/assets/abdce.gif rename to book/.gitbook/assets/abdce.gif diff --git a/.gitbook/assets/aboutconfig.png b/book/.gitbook/assets/aboutconfig.png similarity index 100% rename from .gitbook/assets/aboutconfig.png rename to book/.gitbook/assets/aboutconfig.png diff --git a/.gitbook/assets/aboutconfig2.png b/book/.gitbook/assets/aboutconfig2.png similarity index 100% rename from .gitbook/assets/aboutconfig2.png rename to book/.gitbook/assets/aboutconfig2.png diff --git a/.gitbook/assets/addmetamask.png b/book/.gitbook/assets/addmetamask.png similarity index 100% rename from .gitbook/assets/addmetamask.png rename to book/.gitbook/assets/addmetamask.png diff --git a/.gitbook/assets/ahrjxbq.png b/book/.gitbook/assets/ahrjxbq.png similarity index 100% rename from .gitbook/assets/ahrjxbq.png rename to book/.gitbook/assets/ahrjxbq.png diff --git a/.gitbook/assets/aid86cj.png b/book/.gitbook/assets/aid86cj.png similarity index 100% rename from .gitbook/assets/aid86cj.png rename to book/.gitbook/assets/aid86cj.png diff --git a/.gitbook/assets/allowprivateclickokay.png b/book/.gitbook/assets/allowprivateclickokay.png similarity index 100% rename from .gitbook/assets/allowprivateclickokay.png rename to book/.gitbook/assets/allowprivateclickokay.png diff --git a/.gitbook/assets/apdk.png b/book/.gitbook/assets/apdk.png similarity index 100% rename from .gitbook/assets/apdk.png rename to book/.gitbook/assets/apdk.png diff --git a/.gitbook/assets/azpoj.gif b/book/.gitbook/assets/azpoj.gif similarity index 100% rename from .gitbook/assets/azpoj.gif rename to book/.gitbook/assets/azpoj.gif diff --git a/.gitbook/assets/bpdk.png b/book/.gitbook/assets/bpdk.png similarity index 100% rename from .gitbook/assets/bpdk.png rename to book/.gitbook/assets/bpdk.png diff --git a/.gitbook/assets/bpsqxxr.png b/book/.gitbook/assets/bpsqxxr.png similarity index 100% rename from .gitbook/assets/bpsqxxr.png rename to book/.gitbook/assets/bpsqxxr.png diff --git a/.gitbook/assets/c05e5a1813edad280544b627b24002dc8d5adcf2 (1).png b/book/.gitbook/assets/c05e5a1813edad280544b627b24002dc8d5adcf2 (1).png similarity index 100% rename from .gitbook/assets/c05e5a1813edad280544b627b24002dc8d5adcf2 (1).png rename to book/.gitbook/assets/c05e5a1813edad280544b627b24002dc8d5adcf2 (1).png diff --git a/.gitbook/assets/c05e5a1813edad280544b627b24002dc8d5adcf2.png b/book/.gitbook/assets/c05e5a1813edad280544b627b24002dc8d5adcf2.png similarity index 100% rename from .gitbook/assets/c05e5a1813edad280544b627b24002dc8d5adcf2.png rename to book/.gitbook/assets/c05e5a1813edad280544b627b24002dc8d5adcf2.png diff --git a/.gitbook/assets/capture-de-cran-2021-08-17-a-15.57.00.png b/book/.gitbook/assets/capture-de-cran-2021-08-17-a-15.57.00.png similarity index 100% rename from .gitbook/assets/capture-de-cran-2021-08-17-a-15.57.00.png rename to book/.gitbook/assets/capture-de-cran-2021-08-17-a-15.57.00.png diff --git a/.gitbook/assets/capture-de-cran-2021-08-24-a-16.41.23.png b/book/.gitbook/assets/capture-de-cran-2021-08-24-a-16.41.23.png similarity index 100% rename from .gitbook/assets/capture-de-cran-2021-08-24-a-16.41.23.png rename to book/.gitbook/assets/capture-de-cran-2021-08-24-a-16.41.23.png diff --git a/.gitbook/assets/capture-de-cran-2021-09-02-a-14.57.11.png b/book/.gitbook/assets/capture-de-cran-2021-09-02-a-14.57.11.png similarity index 100% rename from .gitbook/assets/capture-de-cran-2021-09-02-a-14.57.11.png rename to book/.gitbook/assets/capture-de-cran-2021-09-02-a-14.57.11.png diff --git a/.gitbook/assets/capture-de-cran-2021-09-02-a-15.07.01.png b/book/.gitbook/assets/capture-de-cran-2021-09-02-a-15.07.01.png similarity index 100% rename from .gitbook/assets/capture-de-cran-2021-09-02-a-15.07.01.png rename to book/.gitbook/assets/capture-de-cran-2021-09-02-a-15.07.01.png diff --git a/.gitbook/assets/capture-de-cran-2021-09-02-a-15.12.23.png b/book/.gitbook/assets/capture-de-cran-2021-09-02-a-15.12.23.png similarity index 100% rename from .gitbook/assets/capture-de-cran-2021-09-02-a-15.12.23.png rename to book/.gitbook/assets/capture-de-cran-2021-09-02-a-15.12.23.png diff --git a/.gitbook/assets/capture-de-cran-2021-09-02-a-15.12.53.png b/book/.gitbook/assets/capture-de-cran-2021-09-02-a-15.12.53.png similarity index 100% rename from .gitbook/assets/capture-de-cran-2021-09-02-a-15.12.53.png rename to book/.gitbook/assets/capture-de-cran-2021-09-02-a-15.12.53.png diff --git a/.gitbook/assets/cast-the-vote.png b/book/.gitbook/assets/cast-the-vote.png similarity index 100% rename from .gitbook/assets/cast-the-vote.png rename to book/.gitbook/assets/cast-the-vote.png diff --git a/.gitbook/assets/check-relayer-ens-subdomains.png b/book/.gitbook/assets/check-relayer-ens-subdomains.png similarity index 100% rename from .gitbook/assets/check-relayer-ens-subdomains.png rename to book/.gitbook/assets/check-relayer-ens-subdomains.png diff --git a/.gitbook/assets/claim (1).png b/book/.gitbook/assets/claim (1).png similarity index 100% rename from .gitbook/assets/claim (1).png rename to book/.gitbook/assets/claim (1).png diff --git a/.gitbook/assets/confirm-the-vote.png b/book/.gitbook/assets/confirm-the-vote.png similarity index 100% rename from .gitbook/assets/confirm-the-vote.png rename to book/.gitbook/assets/confirm-the-vote.png diff --git a/.gitbook/assets/connect-wallet.png b/book/.gitbook/assets/connect-wallet.png similarity index 100% rename from .gitbook/assets/connect-wallet.png rename to book/.gitbook/assets/connect-wallet.png diff --git a/.gitbook/assets/d2d37d169a94f09156e76fa522b7974cb7c9ac3f.png b/book/.gitbook/assets/d2d37d169a94f09156e76fa522b7974cb7c9ac3f.png similarity index 100% rename from .gitbook/assets/d2d37d169a94f09156e76fa522b7974cb7c9ac3f.png rename to book/.gitbook/assets/d2d37d169a94f09156e76fa522b7974cb7c9ac3f.png diff --git a/.gitbook/assets/d8dmxjj.png b/book/.gitbook/assets/d8dmxjj.png similarity index 100% rename from .gitbook/assets/d8dmxjj.png rename to book/.gitbook/assets/d8dmxjj.png diff --git a/.gitbook/assets/dE13HsA.png b/book/.gitbook/assets/dE13HsA.png similarity index 100% rename from .gitbook/assets/dE13HsA.png rename to book/.gitbook/assets/dE13HsA.png diff --git a/.gitbook/assets/dknasj.png b/book/.gitbook/assets/dknasj.png similarity index 100% rename from .gitbook/assets/dknasj.png rename to book/.gitbook/assets/dknasj.png diff --git a/.gitbook/assets/downloadinstall.png b/book/.gitbook/assets/downloadinstall.png similarity index 100% rename from .gitbook/assets/downloadinstall.png rename to book/.gitbook/assets/downloadinstall.png diff --git a/.gitbook/assets/e9jyqhu.png b/book/.gitbook/assets/e9jyqhu.png similarity index 100% rename from .gitbook/assets/e9jyqhu.png rename to book/.gitbook/assets/e9jyqhu.png diff --git a/.gitbook/assets/eHuzorT5lslrOoxKKvRPxLtAHy7.png b/book/.gitbook/assets/eHuzorT5lslrOoxKKvRPxLtAHy7.png similarity index 100% rename from .gitbook/assets/eHuzorT5lslrOoxKKvRPxLtAHy7.png rename to book/.gitbook/assets/eHuzorT5lslrOoxKKvRPxLtAHy7.png diff --git a/.gitbook/assets/enregistrement-de-le-cran-2021-08-24-a-17.18.35.gif b/book/.gitbook/assets/enregistrement-de-le-cran-2021-08-24-a-17.18.35.gif similarity index 100% rename from .gitbook/assets/enregistrement-de-le-cran-2021-08-24-a-17.18.35.gif rename to book/.gitbook/assets/enregistrement-de-le-cran-2021-08-24-a-17.18.35.gif diff --git a/.gitbook/assets/enregistrement-de-le-cran-2021-08-25-a-16.15.15-1-.gif b/book/.gitbook/assets/enregistrement-de-le-cran-2021-08-25-a-16.15.15-1-.gif similarity index 100% rename from .gitbook/assets/enregistrement-de-le-cran-2021-08-25-a-16.15.15-1-.gif rename to book/.gitbook/assets/enregistrement-de-le-cran-2021-08-25-a-16.15.15-1-.gif diff --git a/.gitbook/assets/enregistrement-de-le-cran-2021-08-25-a-16.15.15.gif b/book/.gitbook/assets/enregistrement-de-le-cran-2021-08-25-a-16.15.15.gif similarity index 100% rename from .gitbook/assets/enregistrement-de-le-cran-2021-08-25-a-16.15.15.gif rename to book/.gitbook/assets/enregistrement-de-le-cran-2021-08-25-a-16.15.15.gif diff --git a/.gitbook/assets/ezgif-2-ab5e0860a5d4.gif b/book/.gitbook/assets/ezgif-2-ab5e0860a5d4.gif similarity index 100% rename from .gitbook/assets/ezgif-2-ab5e0860a5d4.gif rename to book/.gitbook/assets/ezgif-2-ab5e0860a5d4.gif diff --git a/.gitbook/assets/gov.jpg b/book/.gitbook/assets/gov.jpg similarity index 100% rename from .gitbook/assets/gov.jpg rename to book/.gitbook/assets/gov.jpg diff --git a/.gitbook/assets/head.png b/book/.gitbook/assets/head.png similarity index 100% rename from .gitbook/assets/head.png rename to book/.gitbook/assets/head.png diff --git a/.gitbook/assets/i6qtr0f.png b/book/.gitbook/assets/i6qtr0f.png similarity index 100% rename from .gitbook/assets/i6qtr0f.png rename to book/.gitbook/assets/i6qtr0f.png diff --git a/.gitbook/assets/image (1).png b/book/.gitbook/assets/image (1).png similarity index 100% rename from .gitbook/assets/image (1).png rename to book/.gitbook/assets/image (1).png diff --git a/.gitbook/assets/image (2).png b/book/.gitbook/assets/image (2).png similarity index 100% rename from .gitbook/assets/image (2).png rename to book/.gitbook/assets/image (2).png diff --git a/.gitbook/assets/image (3).png b/book/.gitbook/assets/image (3).png similarity index 100% rename from .gitbook/assets/image (3).png rename to book/.gitbook/assets/image (3).png diff --git a/.gitbook/assets/image (4).png b/book/.gitbook/assets/image (4).png similarity index 100% rename from .gitbook/assets/image (4).png rename to book/.gitbook/assets/image (4).png diff --git a/.gitbook/assets/image (5).png b/book/.gitbook/assets/image (5).png similarity index 100% rename from .gitbook/assets/image (5).png rename to book/.gitbook/assets/image (5).png diff --git a/.gitbook/assets/image.png b/book/.gitbook/assets/image.png similarity index 100% rename from .gitbook/assets/image.png rename to book/.gitbook/assets/image.png diff --git a/.gitbook/assets/indexeddb.png b/book/.gitbook/assets/indexeddb.png similarity index 100% rename from .gitbook/assets/indexeddb.png rename to book/.gitbook/assets/indexeddb.png diff --git a/.gitbook/assets/k6juetp.png b/book/.gitbook/assets/k6juetp.png similarity index 100% rename from .gitbook/assets/k6juetp.png rename to book/.gitbook/assets/k6juetp.png diff --git a/.gitbook/assets/kokikou.gif b/book/.gitbook/assets/kokikou.gif similarity index 100% rename from .gitbook/assets/kokikou.gif rename to book/.gitbook/assets/kokikou.gif diff --git a/.gitbook/assets/logos.png b/book/.gitbook/assets/logos.png similarity index 100% rename from .gitbook/assets/logos.png rename to book/.gitbook/assets/logos.png diff --git a/.gitbook/assets/lskzkgk.png b/book/.gitbook/assets/lskzkgk.png similarity index 100% rename from .gitbook/assets/lskzkgk.png rename to book/.gitbook/assets/lskzkgk.png diff --git a/.gitbook/assets/m3fh0gl.png b/book/.gitbook/assets/m3fh0gl.png similarity index 100% rename from .gitbook/assets/m3fh0gl.png rename to book/.gitbook/assets/m3fh0gl.png diff --git a/.gitbook/assets/metamaskhome.png b/book/.gitbook/assets/metamaskhome.png similarity index 100% rename from .gitbook/assets/metamaskhome.png rename to book/.gitbook/assets/metamaskhome.png diff --git a/.gitbook/assets/metamaskicon(1).gif b/book/.gitbook/assets/metamaskicon(1).gif similarity index 100% rename from .gitbook/assets/metamaskicon(1).gif rename to book/.gitbook/assets/metamaskicon(1).gif diff --git a/.gitbook/assets/non-custodial-anonymous-transactions-on-ethereum-2-.png b/book/.gitbook/assets/non-custodial-anonymous-transactions-on-ethereum-2-.png similarity index 100% rename from .gitbook/assets/non-custodial-anonymous-transactions-on-ethereum-2-.png rename to book/.gitbook/assets/non-custodial-anonymous-transactions-on-ethereum-2-.png diff --git a/.gitbook/assets/non-custodial-anonymous-transactions-on-ethereum-3- (1).png b/book/.gitbook/assets/non-custodial-anonymous-transactions-on-ethereum-3- (1).png similarity index 100% rename from .gitbook/assets/non-custodial-anonymous-transactions-on-ethereum-3- (1).png rename to book/.gitbook/assets/non-custodial-anonymous-transactions-on-ethereum-3- (1).png diff --git a/.gitbook/assets/non-custodial-anonymous-transactions-on-ethereum-3-.png b/book/.gitbook/assets/non-custodial-anonymous-transactions-on-ethereum-3-.png similarity index 100% rename from .gitbook/assets/non-custodial-anonymous-transactions-on-ethereum-3-.png rename to book/.gitbook/assets/non-custodial-anonymous-transactions-on-ethereum-3-.png diff --git a/.gitbook/assets/non-custodial-anonymous-transactions-on-ethereum.png b/book/.gitbook/assets/non-custodial-anonymous-transactions-on-ethereum.png similarity index 100% rename from .gitbook/assets/non-custodial-anonymous-transactions-on-ethereum.png rename to book/.gitbook/assets/non-custodial-anonymous-transactions-on-ethereum.png diff --git a/.gitbook/assets/o04px38SoXt0G5IVTxr5rEeI588.png b/book/.gitbook/assets/o04px38SoXt0G5IVTxr5rEeI588.png similarity index 100% rename from .gitbook/assets/o04px38SoXt0G5IVTxr5rEeI588.png rename to book/.gitbook/assets/o04px38SoXt0G5IVTxr5rEeI588.png diff --git a/.gitbook/assets/ozxj.png b/book/.gitbook/assets/ozxj.png similarity index 100% rename from .gitbook/assets/ozxj.png rename to book/.gitbook/assets/ozxj.png diff --git a/.gitbook/assets/page-daccueil.png b/book/.gitbook/assets/page-daccueil.png similarity index 100% rename from .gitbook/assets/page-daccueil.png rename to book/.gitbook/assets/page-daccueil.png diff --git a/.gitbook/assets/register-relayer-summary.png b/book/.gitbook/assets/register-relayer-summary.png similarity index 100% rename from .gitbook/assets/register-relayer-summary.png rename to book/.gitbook/assets/register-relayer-summary.png diff --git a/.gitbook/assets/relayer-stake-permit.png b/book/.gitbook/assets/relayer-stake-permit.png similarity index 100% rename from .gitbook/assets/relayer-stake-permit.png rename to book/.gitbook/assets/relayer-stake-permit.png diff --git a/.gitbook/assets/set-relayer-link.png b/book/.gitbook/assets/set-relayer-link.png similarity index 100% rename from .gitbook/assets/set-relayer-link.png rename to book/.gitbook/assets/set-relayer-link.png diff --git a/.gitbook/assets/set-up-relayer-workers.png b/book/.gitbook/assets/set-up-relayer-workers.png similarity index 100% rename from .gitbook/assets/set-up-relayer-workers.png rename to book/.gitbook/assets/set-up-relayer-workers.png diff --git a/.gitbook/assets/time-window.png b/book/.gitbook/assets/time-window.png similarity index 100% rename from .gitbook/assets/time-window.png rename to book/.gitbook/assets/time-window.png diff --git a/.gitbook/assets/vhustru.png b/book/.gitbook/assets/vhustru.png similarity index 100% rename from .gitbook/assets/vhustru.png rename to book/.gitbook/assets/vhustru.png diff --git a/.gitbook/assets/wasm.png b/book/.gitbook/assets/wasm.png similarity index 100% rename from .gitbook/assets/wasm.png rename to book/.gitbook/assets/wasm.png diff --git a/.gitbook/assets/wo55lao.png b/book/.gitbook/assets/wo55lao.png similarity index 100% rename from .gitbook/assets/wo55lao.png rename to book/.gitbook/assets/wo55lao.png diff --git a/.gitbook/assets/xcNzhNG.png b/book/.gitbook/assets/xcNzhNG.png similarity index 100% rename from .gitbook/assets/xcNzhNG.png rename to book/.gitbook/assets/xcNzhNG.png diff --git a/.gitbook/assets/yIT7YcJf1Kc9T7rCcdZW3bZd0mx.png b/book/.gitbook/assets/yIT7YcJf1Kc9T7rCcdZW3bZd0mx.png similarity index 100% rename from .gitbook/assets/yIT7YcJf1Kc9T7rCcdZW3bZd0mx.png rename to book/.gitbook/assets/yIT7YcJf1Kc9T7rCcdZW3bZd0mx.png diff --git a/.gitbook/assets/zOwfk4k.gif b/book/.gitbook/assets/zOwfk4k.gif similarity index 100% rename from .gitbook/assets/zOwfk4k.gif rename to book/.gitbook/assets/zOwfk4k.gif diff --git a/.gitbook/assets/zdizdijz.gif b/book/.gitbook/assets/zdizdijz.gif similarity index 100% rename from .gitbook/assets/zdizdijz.gif rename to book/.gitbook/assets/zdizdijz.gif diff --git a/.gitbook/assets/zrY5GEi.png b/book/.gitbook/assets/zrY5GEi.png similarity index 100% rename from .gitbook/assets/zrY5GEi.png rename to book/.gitbook/assets/zrY5GEi.png diff --git a/book/README.md b/book/README.md new file mode 100644 index 0000000..a7c1ab8 --- /dev/null +++ b/book/README.md @@ -0,0 +1,72 @@ +# Introduction to Tornado Cash + +![](/.gitbook/assets/image.png) + +{% hint style="danger" %} +*Tornado Cash was sanctioned by the US Treasury on 08/08/2022, making it illegal for US citizens to interact with the core and governance contracts.* +{% endhint %} + +Tornado Cash is a **non-custodial** **privacy protocol** allowing **permissionless** shielded transactions on Ethereum and derivative networks. **Tornado Cash is not a mixer, as assets are never commingled due to the presence of zero knowledge cryptography**. The core of the protocol is ungovernable and immutable, given Ethereum's distributed state and the provenance of the contracts, they can neither be changed nor tampered with. + +Therefore, nobody - including the original developers - can modify or inhibit the protocol. All governance and associated smart contracts are deployed by the community. As a non-custodial protocol, users keep custody of their cryptocurrencies while using Tornado Cash. This means that at each deposit, they are provided with a secret "note" that grants the access to the deposited funds, allowing self-soverginity over one's assets. + +## How is anonymity achieved? + +Tornado Cash achives anonymity by breaking the on-chain link between source and destination addresses through "anonymity pools". These are immutable smart contracts that accepts fixed denominations of a currency, acting as what is known as a mix network. Although anonymity is only obtained with use of a "relayer", which acts as a withdrawal proxy to mask the link between destination and source addresses. + +Learn more about [_How does Tornado Cash work?_](general/how-does-it-work.md) and [Tips to remain anonymous](general/guides/opsec.md). + +## Where is Tornado Cash deployed? + +Since its inception in 2019, Tornado Cash has been mainly operating **on the Ethereum network**, with anonymity pools for ETH, DAI, cDAI, USDC, USDT and WBTC. + +Since June 2021, the smart contracts **have also been deployed on other side-chains & blockchains**. These deployments enabled network agnostic functionality, allowing for faster and cheaper transactions. + +* **Ethereum** + * **ETH** (Ethereum) + * **DAI** (Dai) + * **cDAI** (Compound Dai) + * **USDC** (USD Coin) + * **USDT** (Tether) + * **WBTC** (Wrapped Bitcoin) +* **Binance Smart Chain** + * **BNB** (Binance Coin) +* **Polygon** + * **MATIC** (Polygon) +* **Gnosis Chain (formerly xDAI)** + * **xDAI** (xDai) +* **Avalanche** + * **AVAX** (Avalanche) +* **Optimism** + * **ETH** (Ethereum) +* **Arbitrum One** + * **ETH** (Ethereum) + +Until December 2021, governance enabled "anonymity mining" - a mechanism to incentivise proactive usage of selected anonymity sets to compliment pool entropy, allowing depositors to earn the native governance token (**TORN**). + +_See sections_ [_Anonymity mining_](circuits/anonymity-mining) _and the_ [_TORN token_](general/token/index.md) for more information. + +**The protocol's native governance token, TORN, allows open and decentralized collaboration to shape the direction of the protocol through voting.**. The community has a strong influence over the evolution of Tornado Cash, it's development and management of the protocol's treasury. + +Anonymity pools operate **under the principle of fixed-amount deposits and withdrawals**. Meaning that each supported asset has multiple pools which make up an "anonymity set", each pool restricts transactions to be a fixed amount _(e.g. ETH has four different pools, one for each of these amounts: 0.1, 1, 10 and 100 ETH)_. + +### Tornado Cash Nova + +With the release of a [**new __experimental__ version of Tornado Cash; Nova**](https://tornado-cash.medium.com/tornado-cash-introduces-arbitrary-amounts-shielded-transfers-8df92d93c37c), provides an **upgraded expierence for anonymity pools**. Users are no longer constrained by fixed-amount transactions, possible through the UXTO model alllowing **arbitrary (customized) amounts and shielded internal transfers**. + +Tornado Cash Nova is deployed on Gnosis Chain (formerly xDAI) with the original hopes to improve speed and cost by bridging from Ethereum mainnet using the AMB Omnibridge. + +__Please note Tornado Cash Nova has a low relayer count, is in an experimental state and regularly faces issues with Omnibridge because of bridge limits and validator censorship__. + +## How does Tornado Cash function? + +Tornado Cash is represented by it's community, collaboration is facilitated through the governance contract or Decentralized Autonomous Organisation (DAO). **No singular entity or person controls Tornado Cash.** + +All protocol related code is open-source and is published to two independent git instances: + +* [Community git](https://git.tornado.ws): store of the latest community maintained repositories +* [Sanctioned Github](https://github.com/tornadocash): public archive after the OFAC sanctions + +The existence of zero knowledge in the protocol was based **on open-source research authored by ZCash**. To implement a zero knowledge scheme, [a trusted setup is required](https://tornado-cash.medium.com/tornado-cash-trusted-setup-ceremony-b846e1e00be1), which is essentially a store of random data from various sources defining robustness in generation of proving and verifying keys. Which successfully occured for the protocol on [May 2020 with 1114 contributions](https://tornado-cash.medium.com/the-biggest-trusted-setup-ceremony-in-the-world-3c6ab9c8fffa). This significant number of contributors makes it implausible to compromise the protocol by faking zero-knowledge proofs. + +Tornado Cash user interfaces are hosted on **IPFS** (InterPlanetary File System) deployed by the community, minimizing the risk of censorship. These interfaces will be accessible as long as IPFS nodes pin the content, the latest IPFS content hashes are available at [tornadocash.eth](https://app.ens.domains/name/tornadocash.eth/details) and [nova.tornadocash.eth](https://app.ens.domains/name/nova.tornadocash.eth/details). Please see [how to pin IPFS content](https://docs.ipfs.tech/how-to/pin-files/) if you wish to contribute. diff --git a/SUMMARY.md b/book/SUMMARY.md similarity index 100% rename from SUMMARY.md rename to book/SUMMARY.md diff --git a/book.json b/book/book.json similarity index 100% rename from book.json rename to book/book.json diff --git a/circuits/README.md b/book/circuits/README.md similarity index 100% rename from circuits/README.md rename to book/circuits/README.md diff --git a/circuits/anonymity-mining/README.md b/book/circuits/anonymity-mining/README.md similarity index 100% rename from circuits/anonymity-mining/README.md rename to book/circuits/anonymity-mining/README.md diff --git a/circuits/anonymity-mining/mining-rewards.md b/book/circuits/anonymity-mining/mining-rewards.md similarity index 100% rename from circuits/anonymity-mining/mining-rewards.md rename to book/circuits/anonymity-mining/mining-rewards.md diff --git a/circuits/anonymity-mining/tornado-trees.md b/book/circuits/anonymity-mining/tornado-trees.md similarity index 100% rename from circuits/anonymity-mining/tornado-trees.md rename to book/circuits/anonymity-mining/tornado-trees.md diff --git a/circuits/core-deposit-circuit.md b/book/circuits/core-deposit-circuit.md similarity index 100% rename from circuits/core-deposit-circuit.md rename to book/circuits/core-deposit-circuit.md diff --git a/general/community/contributing.md b/book/general/community/contributing.md similarity index 100% rename from general/community/contributing.md rename to book/general/community/contributing.md diff --git a/general/community/governance.md b/book/general/community/governance.md similarity index 100% rename from general/community/governance.md rename to book/general/community/governance.md diff --git a/general/deployments.md b/book/general/deployments.md similarity index 100% rename from general/deployments.md rename to book/general/deployments.md diff --git a/general/guides/local-ui.md b/book/general/guides/local-ui.md similarity index 100% rename from general/guides/local-ui.md rename to book/general/guides/local-ui.md diff --git a/general/guides/opsec.md b/book/general/guides/opsec.md similarity index 100% rename from general/guides/opsec.md rename to book/general/guides/opsec.md diff --git a/general/guides/post-censorship/es.md b/book/general/guides/post-censorship/es.md similarity index 100% rename from general/guides/post-censorship/es.md rename to book/general/guides/post-censorship/es.md diff --git a/general/guides/post-censorship/index.md b/book/general/guides/post-censorship/index.md similarity index 100% rename from general/guides/post-censorship/index.md rename to book/general/guides/post-censorship/index.md diff --git a/general/guides/post-censorship/ru.md b/book/general/guides/post-censorship/ru.md similarity index 100% rename from general/guides/post-censorship/ru.md rename to book/general/guides/post-censorship/ru.md diff --git a/general/guides/post-censorship/zh.md b/book/general/guides/post-censorship/zh.md similarity index 100% rename from general/guides/post-censorship/zh.md rename to book/general/guides/post-censorship/zh.md diff --git a/general/guides/relayer.md b/book/general/guides/relayer.md similarity index 100% rename from general/guides/relayer.md rename to book/general/guides/relayer.md diff --git a/general/guides/tor.md b/book/general/guides/tor.md similarity index 100% rename from general/guides/tor.md rename to book/general/guides/tor.md diff --git a/general/how-does-it-work.md b/book/general/how-does-it-work.md similarity index 100% rename from general/how-does-it-work.md rename to book/general/how-does-it-work.md diff --git a/general/resources/analytics.md b/book/general/resources/analytics.md similarity index 100% rename from general/resources/analytics.md rename to book/general/resources/analytics.md diff --git a/general/resources/compliance-tool.md b/book/general/resources/compliance-tool.md similarity index 100% rename from general/resources/compliance-tool.md rename to book/general/resources/compliance-tool.md diff --git a/general/resources/tutela.md b/book/general/resources/tutela.md similarity index 100% rename from general/resources/tutela.md rename to book/general/resources/tutela.md diff --git a/general/token/anonymity-mining.md b/book/general/token/anonymity-mining.md similarity index 100% rename from general/token/anonymity-mining.md rename to book/general/token/anonymity-mining.md diff --git a/general/token/index.md b/book/general/token/index.md similarity index 100% rename from general/token/index.md rename to book/general/token/index.md diff --git a/general/token/staking.md b/book/general/token/staking.md similarity index 100% rename from general/token/staking.md rename to book/general/token/staking.md diff --git a/tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713377.gif b/book/tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713377.gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713377.gif rename to book/tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713377.gif diff --git a/tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713666.gif b/book/tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713666.gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713666.gif rename to book/tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713666.gif diff --git a/tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713746.gif b/book/tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713746.gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713746.gif rename to book/tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713746.gif diff --git a/tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713870.gif b/book/tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713870.gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713870.gif rename to book/tornado-cash-classic/.gitbook/assets/RPReplay_Final1652713870.gif diff --git a/tornado-cash-classic/.gitbook/assets/Screen Recording 2022-05-16 at 3.49.20 PM.mov b/book/tornado-cash-classic/.gitbook/assets/Screen Recording 2022-05-16 at 3.49.20 PM.mov similarity index 100% rename from tornado-cash-classic/.gitbook/assets/Screen Recording 2022-05-16 at 3.49.20 PM.mov rename to book/tornado-cash-classic/.gitbook/assets/Screen Recording 2022-05-16 at 3.49.20 PM.mov diff --git a/tornado-cash-classic/.gitbook/assets/Screen Recording 2022-05-16 at 4.05.59 PM.gif b/book/tornado-cash-classic/.gitbook/assets/Screen Recording 2022-05-16 at 4.05.59 PM.gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/Screen Recording 2022-05-16 at 4.05.59 PM.gif rename to book/tornado-cash-classic/.gitbook/assets/Screen Recording 2022-05-16 at 4.05.59 PM.gif diff --git a/tornado-cash-classic/.gitbook/assets/Screen Recording 2022-05-16 at 4.07.52 PM.gif b/book/tornado-cash-classic/.gitbook/assets/Screen Recording 2022-05-16 at 4.07.52 PM.gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/Screen Recording 2022-05-16 at 4.07.52 PM.gif rename to book/tornado-cash-classic/.gitbook/assets/Screen Recording 2022-05-16 at 4.07.52 PM.gif diff --git a/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-16 at 3.54.57 PM (1).png b/book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-16 at 3.54.57 PM (1).png similarity index 100% rename from tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-16 at 3.54.57 PM (1).png rename to book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-16 at 3.54.57 PM (1).png diff --git a/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-16 at 3.54.57 PM.png b/book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-16 at 3.54.57 PM.png similarity index 100% rename from tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-16 at 3.54.57 PM.png rename to book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-16 at 3.54.57 PM.png diff --git a/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-16 at 5.47.11 PM.png b/book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-16 at 5.47.11 PM.png similarity index 100% rename from tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-16 at 5.47.11 PM.png rename to book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-16 at 5.47.11 PM.png diff --git a/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.08.50 AM.png b/book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.08.50 AM.png similarity index 100% rename from tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.08.50 AM.png rename to book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.08.50 AM.png diff --git a/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.18.08 AM.png b/book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.18.08 AM.png similarity index 100% rename from tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.18.08 AM.png rename to book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.18.08 AM.png diff --git a/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.34.57 AM (1).png b/book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.34.57 AM (1).png similarity index 100% rename from tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.34.57 AM (1).png rename to book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.34.57 AM (1).png diff --git a/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.34.57 AM (2).png b/book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.34.57 AM (2).png similarity index 100% rename from tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.34.57 AM (2).png rename to book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.34.57 AM (2).png diff --git a/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.34.57 AM.png b/book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.34.57 AM.png similarity index 100% rename from tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.34.57 AM.png rename to book/tornado-cash-classic/.gitbook/assets/Screen Shot 2022-05-18 at 1.34.57 AM.png diff --git a/tornado-cash-classic/.gitbook/assets/argen.gif b/book/tornado-cash-classic/.gitbook/assets/argen.gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/argen.gif rename to book/tornado-cash-classic/.gitbook/assets/argen.gif diff --git a/tornado-cash-classic/.gitbook/assets/argent (1) (1).gif b/book/tornado-cash-classic/.gitbook/assets/argent (1) (1).gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/argent (1) (1).gif rename to book/tornado-cash-classic/.gitbook/assets/argent (1) (1).gif diff --git a/tornado-cash-classic/.gitbook/assets/argent (1).gif b/book/tornado-cash-classic/.gitbook/assets/argent (1).gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/argent (1).gif rename to book/tornado-cash-classic/.gitbook/assets/argent (1).gif diff --git a/tornado-cash-classic/.gitbook/assets/argent (2).gif b/book/tornado-cash-classic/.gitbook/assets/argent (2).gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/argent (2).gif rename to book/tornado-cash-classic/.gitbook/assets/argent (2).gif diff --git a/tornado-cash-classic/.gitbook/assets/argent.gif b/book/tornado-cash-classic/.gitbook/assets/argent.gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/argent.gif rename to book/tornado-cash-classic/.gitbook/assets/argent.gif diff --git a/tornado-cash-classic/.gitbook/assets/ezgif-3-e888cf338a (1).gif b/book/tornado-cash-classic/.gitbook/assets/ezgif-3-e888cf338a (1).gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/ezgif-3-e888cf338a (1).gif rename to book/tornado-cash-classic/.gitbook/assets/ezgif-3-e888cf338a (1).gif diff --git a/tornado-cash-classic/.gitbook/assets/ezgif-3-e888cf338a.gif b/book/tornado-cash-classic/.gitbook/assets/ezgif-3-e888cf338a.gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/ezgif-3-e888cf338a.gif rename to book/tornado-cash-classic/.gitbook/assets/ezgif-3-e888cf338a.gif diff --git a/tornado-cash-classic/.gitbook/assets/imtoken (1) (1) (1).gif b/book/tornado-cash-classic/.gitbook/assets/imtoken (1) (1) (1).gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/imtoken (1) (1) (1).gif rename to book/tornado-cash-classic/.gitbook/assets/imtoken (1) (1) (1).gif diff --git a/tornado-cash-classic/.gitbook/assets/imtoken (1) (1).gif b/book/tornado-cash-classic/.gitbook/assets/imtoken (1) (1).gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/imtoken (1) (1).gif rename to book/tornado-cash-classic/.gitbook/assets/imtoken (1) (1).gif diff --git a/tornado-cash-classic/.gitbook/assets/imtoken.gif b/book/tornado-cash-classic/.gitbook/assets/imtoken.gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/imtoken.gif rename to book/tornado-cash-classic/.gitbook/assets/imtoken.gif diff --git a/tornado-cash-classic/.gitbook/assets/metamask.gif b/book/tornado-cash-classic/.gitbook/assets/metamask.gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/metamask.gif rename to book/tornado-cash-classic/.gitbook/assets/metamask.gif diff --git a/tornado-cash-classic/.gitbook/assets/trust (1) (1).gif b/book/tornado-cash-classic/.gitbook/assets/trust (1) (1).gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/trust (1) (1).gif rename to book/tornado-cash-classic/.gitbook/assets/trust (1) (1).gif diff --git a/tornado-cash-classic/.gitbook/assets/trust.gif b/book/tornado-cash-classic/.gitbook/assets/trust.gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/trust.gif rename to book/tornado-cash-classic/.gitbook/assets/trust.gif diff --git a/tornado-cash-classic/.gitbook/assets/which.gif b/book/tornado-cash-classic/.gitbook/assets/which.gif similarity index 100% rename from tornado-cash-classic/.gitbook/assets/which.gif rename to book/tornado-cash-classic/.gitbook/assets/which.gif diff --git a/tornado-cash-classic/connect-wallet.md b/book/tornado-cash-classic/connect-wallet.md similarity index 100% rename from tornado-cash-classic/connect-wallet.md rename to book/tornado-cash-classic/connect-wallet.md diff --git a/tornado-cash-classic/deposit-withdraw.md b/book/tornado-cash-classic/deposit-withdraw.md similarity index 100% rename from tornado-cash-classic/deposit-withdraw.md rename to book/tornado-cash-classic/deposit-withdraw.md diff --git a/tornado-cash-nova/connect-wallet.md b/book/tornado-cash-nova/connect-wallet.md similarity index 100% rename from tornado-cash-nova/connect-wallet.md rename to book/tornado-cash-nova/connect-wallet.md diff --git a/tornado-cash-nova/deposit-withdraw.md b/book/tornado-cash-nova/deposit-withdraw.md similarity index 100% rename from tornado-cash-nova/deposit-withdraw.md rename to book/tornado-cash-nova/deposit-withdraw.md diff --git a/tornado-cash-nova/shielded-transfers.md b/book/tornado-cash-nova/shielded-transfers.md similarity index 100% rename from tornado-cash-nova/shielded-transfers.md rename to book/tornado-cash-nova/shielded-transfers.md diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..7325abd --- /dev/null +++ b/package-lock.json @@ -0,0 +1,77 @@ +{ + "name": "tornado-docs", + "version": "1.0.0", + "lockfileVersion": 1, + "requires": true, + "dependencies": { + "asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==" + }, + "axios": { + "version": "0.21.4", + "resolved": "https://registry.npmjs.org/axios/-/axios-0.21.4.tgz", + "integrity": "sha512-ut5vewkiu8jjGBdqpM44XxjuCjq9LAKeHVmoVfHVzy8eHgxxq8SbAVQNovDA8mVi05kP0Ea/n/UzcSHcTJQfNg==", + "requires": { + "follow-redirects": "^1.14.0" + } + }, + "base-path-converter": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/base-path-converter/-/base-path-converter-1.0.2.tgz", + "integrity": "sha512-51R8JiuXadknn6ouVUteOhDpmI3G5u5GqjruL7bPJpfxUHVgosaO5uPAvRP4FeR4VyyH4sSvsN78Ci6ouoRYqQ==" + }, + "combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "requires": { + "delayed-stream": "~1.0.0" + } + }, + "delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==" + }, + "dotenv": { + "version": "16.3.1", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.3.1.tgz", + "integrity": "sha512-IPzF4w4/Rd94bA9imS68tZBaYyBWSCE47V1RGuMrB94iyTOIEwRmVL2x/4An+6mETpLrKJ5hQkB8W4kFAadeIQ==" + }, + "follow-redirects": { + "version": "1.15.2", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.2.tgz", + "integrity": "sha512-VQLG33o04KaQ8uYi2tVNbdrWp1QWxNNea+nmIB4EVM28v0hmP17z7aG1+wAkNzVq4KeXTq3221ye5qTJP91JwA==" + }, + "form-data": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.0.tgz", + "integrity": "sha512-ETEklSGi5t0QMZuiXoA/Q6vcnxcLQP5vdugSpuAyi6SVGi2clPPp+xgEhuMaHC+zGgn31Kd235W35f7Hykkaww==", + "requires": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "mime-types": "^2.1.12" + } + }, + "mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==" + }, + "mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "requires": { + "mime-db": "1.52.0" + } + }, + "recursive-fs": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/recursive-fs/-/recursive-fs-2.1.0.tgz", + "integrity": "sha512-oed3YruYsD52Mi16s/07eYblQOLi5dTtxpIJNdfCEJ7S5v8dDgVcycar0pRWf4IBuPMIkoctC8RTqGJzIKMNAQ==" + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..10a63ad --- /dev/null +++ b/package.json @@ -0,0 +1,30 @@ +{ + "name": "tornado-docs", + "version": "1.0.0", + "description": "Documentation for Tornado Cash protocol and services", + "main": "empty.js", + "scripts": { + "prepare": "cd book && npm i -g gitbook-cli && gitbook install", + "build": "cd book && gitbook build && cp -R ./_book ../build", + "upload:ipfs": "node scripts/ipfsUpload.js", + "deploy:ipfs": "npm run build && npm run upload:ipfs" + }, + "repository": { + "type": "git", + "url": "https://git.tornado.ws/tornadocash/docs" + }, + "keywords": [ + "tornado", + "documentation-tornado", + "docs" + ], + "author": "tornadocash", + "license": "MIT", + "dependencies": { + "axios": "^0.21.4", + "base-path-converter": "^1.0.2", + "dotenv": "^16.3.1", + "form-data": "^4.0.0", + "recursive-fs": "^2.1.0" + } +} diff --git a/scripts/ipfsUpload.js b/scripts/ipfsUpload.js new file mode 100644 index 0000000..44ef9b9 --- /dev/null +++ b/scripts/ipfsUpload.js @@ -0,0 +1,74 @@ +require("dotenv").config(); +const fs = require("fs"); +const path = require("path"); +const axios = require("axios"); +const FormData = require("form-data"); +const recursive = require("recursive-fs"); +const basePathConverter = require("base-path-converter"); + +// it's dangerous to set MAX_PINS to 1 +const MAX_PINS = 5; + +const baseUrl = `https://api.pinata.cloud`; +const src = process.argv[2] || "./build"; +const headers = { + pinata_api_key: process.env.PINATA_API_KEY, + pinata_secret_api_key: process.env.PINATA_SECRET_API_KEY, +}; + +async function removeOldPins() { + const maxPins = MAX_PINS - 1; + + const res = await axios.get(`${baseUrl}/data/pinList?pageOffset=${maxPins}&status=pinned`, { + headers, + }); + + const { count, rows } = res.data; + + if (count && count > maxPins) { + for (const { ipfs_pin_hash: ipfsPinHash } of rows) { + await axios.delete(`${baseUrl}/pinning/unpin/${ipfsPinHash}`, { + headers, + }); + console.log(`Successfully removed pin: ${ipfsPinHash}`); + } + } +} + +async function pinBuild() { + console.log("Make sure you have latest build. Run `npm run build` if necessary."); + const { files } = await recursive.readdirr(src); + const data = new FormData(); + files.forEach((file) => { + // for each file stream, we need to include the correct relative file path + data.append(`file`, fs.createReadStream(file), { + filepath: basePathConverter(src, file), + }); + }); + + const res = await axios.post(`${baseUrl}/pinning/pinFileToIPFS`, data, { + maxContentLength: "Infinity", + maxBodyLength: "Infinity", // this is needed to prevent axios from erroring out with large directories + headers: { + "Content-Type": `multipart/form-data; boundary=${data.getBoundary()}`, + ...headers, + }, + }); + + const ipfsHash = res.data.IpfsHash; + + console.log(`Your site is ready! IPFS hash: ${ipfsHash}`); + console.log(`output for github-actions:`); + console.log(`::set-output name=ipfs_hash::${ipfsHash}`); + console.log(`https://gateway.pinata.cloud/ipfs/${ipfsHash}`); +} + +async function main() { + await removeOldPins(); + await pinBuild(); +} + +main().catch((e) => { + console.log(e); + process.exit(1); +});