tornado-withdraw/README.md

53 lines
4.1 KiB
Markdown
Raw Normal View History

2024-10-08 03:21:59 +03:00
<div class="hero" align="center">
<img src="./static/torn2.png" style="max-width: 100px;">
# Tornado Withdraw
Fastest Tornado Cash Withdrawal UI built with Bootstrap and jQuery
</div>
## What is this?
This is a Withdrawal only UI for Tornado Cash Pools built upon [@tornado/core](https://git.tornado.ws/tornadocontrib/tornado-core) package that enables you to interact with [Tovarish Relayer](https://git.tornado.ws/tornadocontrib/tovarish-relayer) which provides historic events API as a replacement of deprecated The Graph Subgraph endpoints.
The UI is built with the simple technical stack of [Bootstrap 5](https://getbootstrap.com/) and [jQuery](https://jquery.com/) and it is based on the modern browser API like [WebAssembly](https://webassembly.org/), [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt), and [WebCrypto](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) and thus this UI wouldn't work on older browsers like IE (Or any older browser that has been released before 2020).
You can run this UI from a single [index.html](./index.html) file or the standalone web server that could be spawned by `yarn dev` command (which should open the page on http://localhost:8080/).
As long as the `index.html` refers to the correct libraries with correct hash values, this UI can be considered uncontaminated.
## Disclaimer
This UI is built with the mindset of transparency, and simplicity. The UI has used the least required libraries ( @tornado/core, ethers.js, bootstrap, jquery, circomlibjs ) to make the withdrawal from Tornado Cash deposit pools happen. Auditing `index.html` and `@tornado/core` library will be enough to guarantee the functionality of the UI working correctly.
Currently, this UI should be considered as an early alpha phase and will fix or add the functionality if required. This UI has not been audited by any trusted party so before using this UI you must understand how it works, and most of all you must use this UI under your liabilities of yours including technical and legal perspectives.
This UI is built with the mindset of [free speech](https://digital-law-online.info/lpdi1.0/treatise50.html) and asset recoverability of deposited assets under Tornado Cash pools. By using this tool you must comply with local regulations and the author or dev of this tool holds no responsibility of your financial assets as you aren't interacting with us but [the world computer called Ethereum](https://inevitableeth.com/en/home/ethereum/world-computer).
## How to use
Simply open [index.html](./index.html) or start `yarn dev` if you have Node.js and yarn installed locally.
## How to Audit
This UI is designed with a focus on transparency which prevents any possible malicious code from being injected on the UI ( and it also prevents from scam sites from popping up. ).
You can audit components by
### @tornado/core
Clone the [@tornado/core](https://git.tornado.ws/tornadocontrib/tornado-core) repository from git and run `yarn && yarn build` command to make sure webpack produces the same result ( if the umd file has some manually added codes running `yarn build` will remove the edited line ).
### This UI
Simply clone this repository and run `yarn && yarn update`. You can audit the script `./scripts/update.ts` which would fetch the latest built @tornado/core from the repository and generate the digest hash of files under the `./static` directory ( can be checked on `./static/hashes.json` file ).
The hash values are included on `index.html` file which compares the fetched files either from remote CDN (jsdelivr) or from `./static` path. This ensures that if you have the correct `index.html` file any remote or local resources fetched will be audited by your local browser.
### Static files
Bootstrap CSS files and @tornado/core files are directly fetched from the respective npm repository. `tornado.json.zip` and `tornadoProvingKey.json.zip` file are fetched from the last commit of [tornado-classic-ui](https://github.com/tornadocash/tornado-classic-ui) repository.
Event files are irregularly updated by [tornado-cli](https://git.tornado.ws/tornadocontrib/tornado-cli) with 6~12 months timespan.