update README
Signed-off-by: AlienTornadosaurusHex <>
This commit is contained in:
parent
02f79a0de0
commit
03543f87a8
35
README.md
35
README.md
@ -1,6 +1,6 @@
|
||||
# Tornado Cash Classic UI
|
||||
|
||||
> UI for non-custodial Ethereum Privacy solution
|
||||
> Self-hostable Tornado Cash UI software for interacting with the protocol
|
||||
|
||||
## Building locally
|
||||
|
||||
@ -31,29 +31,42 @@ For detailed explanation on how things work, checkout [Nuxt.js docs](https://nux
|
||||
|
||||
## 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}`
|
||||
- To update deposit and withdrawal events use `yarn update:events {chainId} {optional: tokenOrEvent} {optional: tokenOrEvent}`
|
||||
- To update encrypted notes use `yarn update:encrypted {chainId}`
|
||||
- To update merkle tree use `yarn update:tree {chainId}`
|
||||
|
||||
#### NOTE!
|
||||
|
||||
After update cached files do not forget to use `yarn update:zip`
|
||||
After updating 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
|
||||
You may set in [`networkConfig.js`](./networkConfig.js) the `blockSyncInterval` (def: 10_000) to the maximum value allowed by your RPC provider. Command usage follows below.
|
||||
|
||||
```bash
|
||||
# Updating events with just the required chain id parameter
|
||||
yarn update:events 1
|
||||
# Updating events for only one token across all instances on that network
|
||||
yarn update:events 1 dai
|
||||
# Updating events for only one event on only some network
|
||||
yarn update:events 1 deposit
|
||||
# Both
|
||||
yarn update:events 1 dai deposit
|
||||
# Updating encrypted notes for some chain id
|
||||
yarn update:encrypted 1
|
||||
# Updating trees for some chain id
|
||||
yarn update:tree 1
|
||||
# Finally zips must be updated
|
||||
yarn update:zip
|
||||
```
|
||||
|
||||
### Example for Binance Smart Chain:
|
||||
|
||||
```
|
||||
```bash
|
||||
yarn update:events 56
|
||||
yarn update:events 56 bnb
|
||||
yarn update:events 56 bnb deposit
|
||||
yarn update:encrypted 56
|
||||
|
||||
yarn update:tree 56
|
||||
yarn update:zip
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user