[Milestone] Refactoring the Verification Flow

[kuzdogan]

While rethinking the verification flow we should keep in mind the following features:

• Multiple languages support: we recently added Vyper support. The new verification flow should abstract away the language of the contract
• Not focused on metadata: we need a “std-json based” verification. Metadata should be an opt-in feature, not the foundation of the verification flow. We should also consider support for alternatives such as Vyper's integrity field.
• Compiler package: we already extracted the compilers code from lib-sourcify. But we are not shipping the compiler code in any package. We need to maintain a new package @ethereum-sourcify/compilation.
• APIV2: it is important to keep in mind all the new fields needed by APIV2. Also, the new verification flow will be executed in an async environment by the server, but it will probably doesn't affect much the architecture of the new verification.

@kuzdogan is currently suggesting the following new structure:

1. Validation step

• 📋MetadataContract object
  • previously CheckedContract and validate.ts
  • Does the validation, source fetching, preparing the compilation with the metadata.json, tryToFindPerfectMetadata()
  • input:
    • metadata.json
    • sources
  • creates:
    • ⚙️Compilation object
• MetadataValidation
• IntegrityValidation

2. Compilation step

• ⚙️Compilation object:
  • input:
    • std-json
    • ISolidityCompiler / IVyperCompiler
    • contract identifier (for the output)
  • compile()
    • output:
      • creationBytecode
      • runtimeBytecode
      • metadata
      • other compilation artifacts
      • compilation metadata: duration, hardware?
• SolidityCompilation
• VyperCompilation

3. Verification step

• ✔Verification object
  • input:
    • SourcifyChain / chainId
    • address
    • ⚙️Compilation
  • output:
    • match status
    • transformations
    • ⚙️Compilation properties
  • Other things like findAuxdataPositions

Tasks

Preview Give feedback

1. Research and plan: Refactoring the verification flow for inconsistencies #1318
   0 of 1
   +0
   
2. Integrate proxy detection into the verification flow #1712
   +0
3. "packagizing" the useCompiler #1348
   0 of 4
   +0
4. Implement new "Validation step" classes and their unit tests #1821
   +0
   
5. Implement new "Compilation step" classes and their unit tests #1822
   +0
   
6. Implement new "Verification step" classes, their unit tests and integrate them in server #1823
   +0
7. Integrate the new verification flow classes into server #1824
   +0