forked from tornadocash/docs
general changes
This commit is contained in:
gozzy
parent
14c336f24b
commit
f81f1be712
26
README.md
26
README.md
@ -22,13 +22,25 @@ Since June 2021, the smart contracts **have also been deployed on other side-cha
|
||||
|
||||
Nework deployments:
|
||||
|
||||
* **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 (former xDAI Chain)**: **xDAI** (xDai),
|
||||
* **Avalanche**: **AVAX** (Avalanche),
|
||||
* **Optimism**, as a Layer-2 for **ETH** (Ethereum),
|
||||
* **Arbitrum One**, as a Layer-2 **ETH** (Ethereum).
|
||||
* **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)
|
||||
|
||||
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
## General
|
||||
|
||||
* [Introduction to Tornado Cash](README.md)
|
||||
* [Introduction](README.md)
|
||||
* [How does it work?](general/how-does-it-work.md)
|
||||
* [TORN](general/token/index.md)
|
||||
* [Governance](general/community/governance.md)
|
||||
@ -11,6 +11,7 @@
|
||||
|
||||
## Guides
|
||||
|
||||
* [Usage post-censorship](general/guides/post-censorship.md)
|
||||
* [How to become a relayer?](general/guides/relayer.md)
|
||||
* [Local UI deployment](general/guides/local-ui.md)
|
||||
* [Tips to remain anonymous](general/guides/opsec.md)
|
||||
@ -20,6 +21,9 @@
|
||||
|
||||
* [How to connect your wallet](tornado-cash-classic/connect-wallet.md)
|
||||
* [Deposit / Withdraw](tornado-cash-classic/deposit-withdraw.md)
|
||||
|
||||
#
|
||||
|
||||
* [Circuits](circuits/README.md)
|
||||
* [Core](circuits/core-deposit-circuit.md)
|
||||
* [Anonymity Mining](circuits/anonymity-mining/README.md)
|
||||
@ -36,4 +40,5 @@
|
||||
## Resources
|
||||
|
||||
* [Compliance tool](general/resources/compliance-tool.md)
|
||||
* [Analytics](general/resources/analytics.md)
|
||||
* [Analytics](general/resources/analytics.md)
|
||||
* [Deployments](general/deployments.md)
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Community
|
||||
# Contributing
|
||||
|
||||
In a Decentralized Autonomous Organization (DAO), community involvement dictates the forward motion of the organization through governance proposals. These requests can often relate to protocol development but can be more abstract to such contexts of remuneration, economic strategising or accelerating funding of public goods.
|
||||
|
||||
|
||||
@ -163,19 +163,3 @@
|
||||
| Poseidon 3 | [0xd82ed8786d7c69dc7e052f7a542ab047971e73d2](https://etherscan.io/address/0xd82ed8786d7c69dc7e052f7a542ab047971e73d2) |
|
||||
| Gitcoin Grants | [0xdd4c48c0b24039969fc16d1cdf626eab821d3384](https://etherscan.io/address/0xdd4c48c0b24039969fc16d1cdf626eab821d3384) |
|
||||
|
||||
## GitHub links
|
||||
|
||||
* Tornado Cash core code:
|
||||
|
||||
|
||||
* Tornado Cash Command Line to make transactions in the protocol:
|
||||
|
||||
* To become a relayer for Tornado Cash:
|
||||
|
||||
* Minified web UI for Tornado Cash protocol:
|
||||
|
||||
* All about the TORN token:
|
||||
|
||||
* All about the anonymity mining program (this program has ended mid-December 2021):
|
||||
|
||||
_Written by_ [_@ayefda_](https://torn.community/u/ayefda) _&_ [_@bt11ba_](https://torn.community/u/bt11ba/)
|
||||
@ -1,69 +1,36 @@
|
||||
# Local UI deployment
|
||||
This is a walkthrough to locally host the static builds for Classic and Nova user interfaces, circumventing any surveilence and censorship that can occur. This document is meant for individuals with little technical knowledge. If you want to build the source and host a development enviroment, look to the associated repositories for more details.
|
||||
|
||||
Tornado Cash protocol can be launched locally on your computer through a minified User Interface version made available by the core developers team.
|
||||
_If you have privacy concerns about using this extension in this tutorial, you [should know it is open source](https://github.com/kzahel/web-server-chrome)._
|
||||
|
||||
### Step #1: Clone the Github repository on your computer
|
||||
### Requirements
|
||||
|
||||
By opening your Command Line Interface, you can run the following commands to, first, clone the repository, then go inside the newly copied folder:
|
||||
* Desktop enviroment (Windows, Mac or Linux)
|
||||
* Google Chrome browser
|
||||
|
||||
```
|
||||
git clone https://github.com/tornadocash/ui-minified.git
|
||||
cd ui-minified
|
||||
```
|
||||
### Step #1: Download the static source
|
||||
For this part you'll need to be able to open .zip files, most operating systems allow this. Head to either the Nova or Classic release page on the community git to download the static files.
|
||||
|
||||
### Step #2: Serve the Folder with Your Favorite HTTP Server
|
||||
Nova: https://development.tornadocash.community/tornadocash/nova-ui-minified/releases
|
||||
Classic: https://development.tornadocash.community/tornadocash/classic-ui/releases
|
||||
|
||||
```
|
||||
python -m SimpleHTTPServer 8080
|
||||
```
|
||||
Click the version named zip file download option to download the zip file, as seen below. It should download locally to your machine.
|
||||
|
||||
You can obviously use any other http web server, such as[ npmjs.com/package/http-server](https://www.npmjs.com/package/http-server).
|
||||
|
||||
|
||||
### Step #3: Run the UI on Localhost on your Favorite Web Browser
|
||||
### Step #2: Open and unpack the .zip file
|
||||
As mentioned before most operating systems support unpacking .zip files, so open the file that was previously downloaded in the last step. It should create a folder in the same location with the resulting files, take note of the folder location for the next step.
|
||||
|
||||
To finish, you just need to run [http://localhost:8080](http://localhost:8080) on your Web Browser & let the magic happens 🪄
|
||||
### Step #3: Install the Web Server extension
|
||||
Open up Google Chrome and navigate to the [Web Server extension page](https://chrome.google.com/webstore/detail/web-server-for-chrome/ofhbbkphhbklhfoeikjpcbhemlocgigb/related?hl=en), click the button highlighted in the image to install. Once installed, click the same button which should now say ¨Launch app¨ to launch the extension.
|
||||
|
||||
## Running a TOR service
|
||||
|
||||
|
||||
If you wish to serve tornado cash UI on an .onion domain, there is an easy way to do it using docker-compose.
|
||||
### Step #4: Configure the Web Server extension
|
||||
If everything is going correctly you should see a similar screen, firstly click the "Select folder" button (1) and select the folder that was created after the .zip file was opened. It should be in the same location where you downloaded it to. Then once it has been loaded click the link underneath (2) to view the hosted content.
|
||||
|
||||
* You need to paste the following into `docker-compose.yml`
|
||||
|
||||
|
||||
```
|
||||
version: '2'
|
||||
### Step #5: Achieve privacy
|
||||
If you can see the frontend interface after clicking the link in the extension then you've successfully done everything correctly and you can use the protocol like normal.
|
||||
|
||||
services:
|
||||
tornado_ui:
|
||||
image: tornadocash/ui
|
||||
restart: always
|
||||
container_name: tornado_ui
|
||||
watchtower:
|
||||
image: v2tec/watchtower
|
||||
restart: always
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
command: --interval 60 tornado_ui
|
||||
tor:
|
||||
image: strm/tor
|
||||
restart: always
|
||||
depends_on: [ tornado_ui ]
|
||||
environment:
|
||||
LISTEN_PORT: 80
|
||||
REDIRECT: tornado_ui:80
|
||||
# Generate a new key with
|
||||
# docker run --rm --entrypoint shallot strm/tor-hiddenservice-nginx ^torn
|
||||
PRIVATE_KEY: |
|
||||
-----BEGIN RSA PRIVATE KEY-----
|
||||
...
|
||||
-----END RSA PRIVATE KEY-----
|
||||
```
|
||||
|
||||
* Then, just run the following command:`docker-compose up -d`
|
||||
|
||||
Enjoy your Tornado Cash UI 🌪
|
||||
|
||||
_This tutorial is inspired from the_[ _README.md document_](https://github.com/tornadocash/ui-minified/blob/gh-pages/README.md) _present in the Github repository._
|
||||
|
||||
__
|
||||
|
||||
_Written by_ [_@ayefda_](https://torn.community/u/ayefda)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user