From 7be69e8f7fd65861c9634f6fcb821ad75540eee7 Mon Sep 17 00:00:00 2001 From: Theo Date: Sun, 30 Jul 2023 01:37:18 -0700 Subject: [PATCH] Add verification instructions for users --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 07871c5..dab51a1 100644 --- a/README.md +++ b/README.md @@ -32,3 +32,31 @@ or ```text npm run test:linux ``` + +### 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)