[ERC Registry EPIC] Phase 1: Develop and implement a tool for indexing the Hedera network to detect ERC-20 and ERC-721 contracts.

[quiet-node]

Problem

The ERC Registry is an initiative aimed at creating a comprehensive registry of contracts that are widely recognized and believed to be standard ERC token contracts with a high degree of confidence. At this early phase of the project, it requires a design document to highlight and outline the approach.

Solution

As a first pass to accelerate improved UX we can produce a registry of contracts that are beleived with high confidence to be ERC's. The Mirror node explorer and other apps can take this list as a starting point to build out their UX for users.

Simple approach is to

• create a self contained runnable npm project erc-repository-indexer under tools.
• Index the networks contracts and verify they are ERC20 or ERC721 by matching the presence of interface function bytes. Utilize current POC on 1st pass if applicable and then sevm soon after. Ensure the tool support the specification of env, mirrorNodeUrlandstartingContractId` to allow for flexibility.
• Create an ERC20s_.json and an ERC721s_.json file each with the appropriate but minimal details. Files should be placed under tools/erc-repository-indexer/registry. Entries should be sorted in ascending order of contractId
• For additional confidence one may simulate an eth_call on the functions also. Consider pros and cons based on accuracy to this point
• Make the tool runnable in CI with the output being a new PR with the file updates for approval and merge

A starting schema for an ERC20 may be

{
    "address": "0x....",  // Address of the ERC20 contract/token
    "contractId": "0.0.x",  // contract id of the ERC20 contract/token
  }

A starting schema for an ERC721 may be

{
    "address": "0x....",  // Address of the ERC20 contract/token
    "contractId": "0.0.x",  // contract id of the ERC20 contract/token
  }

Alternatives

No response

Tasks

Preview Give feedback

1. [ERC Registry] Add design document to outline the approach. #1029
   documentation enhancement +2
   
2. [ERC Registry] Init a new NPM project for the indexer tool #1036
   enhancement +1
   
3. [ERC Registry] Add ContractScanner service class to handle fetching contracts from mirror node #1038
   enhancement +1
   
4. [ERC Registry] Add BytecodeAnalyzer service class to perform interface signature matching for ERC contracts #1039
   enhancement +1
   
5. [ERC Registry] Add RegistryGenerator service class to handle exporting ERC contracts into JSON files #1040
   enhancement +1
   
6. [ERC Registry] Add mechanism to evaluate STARTING_POINT variable #1041
   enhancement +1
   
7. [ERC Registry] add new method to persist the value of next pointer in case interupted #1056
   enhancement +1
   
8. [ERC Registry] Add a Runner class to the ERC Registry that combines all services for the final indexing product. #1042
   enhancement +1