classic-ui/README.md

60 lines
1.6 KiB
Markdown
Raw Normal View History

2022-04-22 03:04:16 -04:00
# Tornado Cash Classic UI
2022-04-21 23:05:56 -04:00
> UI for non-custodial Ethereum Privacy solution
2022-04-22 03:04:16 -04:00
## Building locally
2022-04-21 23:05:56 -04:00
2022-04-22 03:04:16 -04:00
- Install [Node.js](https://nodejs.org) version 14
2022-06-15 02:24:13 -04:00
- If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you.
2022-04-22 03:04:16 -04:00
- Install [Yarn](https://yarnpkg.com/en/docs/install)
- Install dependencies: `yarn`
- Copy the `.env.example` file to `.env`
2022-06-15 02:24:13 -04:00
- Replace environment variables with your own personal.
2022-04-22 03:04:16 -04:00
- Build the project to the `./dist/` folder with `yarn generate`.
2022-04-21 23:05:56 -04:00
2022-04-22 03:04:16 -04:00
## Development builds
2022-04-21 23:05:56 -04:00
2022-04-22 03:04:16 -04:00
To start a development build (e.g. with logging and file watching) run `yarn dev`.
2022-04-21 23:05:56 -04:00
2022-04-22 03:04:16 -04:00
## Deploy on IPFS
- Make sure you set `PINATA_API_KEY` and `PINATA_SECRET_API_KEY` environment variables in `.env`
- To deploy a production build run `yarn deploy-ipfs`.
## Architecture
2022-04-21 23:05:56 -04:00
For detailed explanation on how things work, checkout [Nuxt.js docs](https://nuxtjs.org).
2022-06-15 02:24:13 -04:00
## Audit
[TornadoCash_Classic_dApp_audit_Decurity.pdf](https://ipfs.io/ipfs/QmXzmwfsb4GwzmPD7W9VDNHh7ttyYKgXCY74973QMZqBDA)
## Update cached files
- For update deposits and withdrawals events use `yarn update:events {chainId}`
- For update encrypted notes use `yarn update:encrypted {chainId}`
- For update merkle tree use `yarn update:tree {chainId}`
#### NOTE!
After update cached files do not forget to use `yarn update:zip`
### Example for Ethereum Mainnet:
```
yarn update:events 1
yarn update:encrypted 1
yarn update:tree 1
yarn update:zip
```
### Example for Binance Smart Chain:
```
yarn update:events 56
2022-06-13 03:13:54 -04:00
yarn update:encrypted 56
yarn update:zip
```