proposal-29-update-ipfs/README.md

67 lines
2.9 KiB
Markdown

# Proposal to update Tornado IPFS hashes in ENS
### Changes / effect description
- Change owner of ENS domains [staking-rewards.contract.tornadocash.eth](https://app.ens.domains/staking-rewards.contract.tornadocash.eth) and [contract.tornadocash.eth](https://app.ens.domains/contract.tornadocash.eth) to Tornado Cash Governance
- Change address on staking-rewards.contract.tornadocash.eth to new staking address (has been changed in [proposal 22](https://tornado.ws/governance/22))
- Update IPFS content hashes on ENS domains for docs (docs.tornadocash.eth), Classic UI (tornadocash.eth), Nova UI (nova.tornadocash.eth) and relayers UI (relayers-network.tornadocash.eth)
### Requirements
- Rust ([Need only for Windows](https://doc.rust-lang.org/cargo/getting-started/installation.html))
- Foundryup ([Windows](https://github.com/altugbakan/foundryup-windows), [Linux](https://book.getfoundry.sh/getting-started/installation))
- Node 20 or higher ([Windows](https://github.com/coreybutler/nvm-windows), [Linux](https://github.com/nvm-sh/nvm))
### Installation
```text
git clone --recurse-submodules https://git.tornado.ws/Theo/proposal-27-update-ipfs.git
cd proposal-27-update-ipfs
npm install
npm run init
```
### Testing
```text
npm run test:windows
```
or
```text
npm run test:linux
```
### Contracts
Proposal deployed contract: [etherscan link](https://etherscan.io/address/0x86d5f637f7cc0e55334439d0495de3b7daa62baa#code)
### Verification
Since the proposal code can be confusing because it relies on numerous specifications and EIPs, users can use scripts to verify the correctness of the data, see the output in the corresponding files, and insert the code directly into Solidity, comparing it with the existing code in the proposal (there should be no discrepancies be).
1. Verification of the transformation of eth domains into [ENS nodes](https://docs.ens.domains/ens-improvement-proposals/ensip-1-ens):
Script source: [calculateENSNodes.ts](scripts/calculateENSNodes.ts)
Command to run: `npm run calculateENS`
Result data: [ensNodesDeclarations.txt](data/ensNodesDeclarations.txt)
2. Verification of the transformation of IPFS CIDs to ENS [content hashes](https://eips.ethereum.org/EIPS/eip-1577)
Script source: [calculateIPFSContenthashes.ts](scripts/calculateIPFSContenthashes.ts)
Command to run: `npm run calculateIPFS`
Result data: [ensDomainsIPFSContenthashes.txt](data/ensDomainsIPFSContenthashes.txt)
3. Verification of the equality [IPFS CIDs](https://docs.ipfs.tech/concepts/content-addressing/) v0 with v1 (because ENS on its interface shows v1 CIDs, but Pinata and contenthash library uses v0)
Script source: [calculateIpfsV1Cids.ts](scripts/calculateIpfsV1Cids.ts)
Command to run: `npm run calculateIpfsV1Cids`
Result data: [ipfsV1CIDs.txt](data/ipfsV1CIDs.txt)