How ethereum/sourcify works
Project Type & Purpose
• This is a monorepo for a distributed, open-source smart-contract verification platform (Sourcify).
• Core services:
– sourcify-server: HTTP API for full/partial contract verification and storage
– sourcify-monitor: listener that watches EVM chains, fetches new deployments, and calls the server
– database service: PostgreSQL with migrations, schema upgrades, and ETL scripts
• Auxiliary packages: bytecode-utils, compilers-types, compilers, lib-sourcify
File-Structure Analysis
• Top-level “services/…” folders for each microservice (server, monitor, database).
• “packages/…” contains core libraries and compiler wrappers used by services.
• CI/CD: .circleci workflows, Dockerfiles, shell scripts for deployment to GCP, npm, multi-arch Docker, nightly tests.
• Scripts directory houses git utilities, chain updates, verification loops.
README Insights
• Overview of platform components and their roles.
• References to API docs and playground.
• Mentions Solc/Vyper metadata–based full verification.
a) Main components:
• Client/UI (external: Sourcify UI, CLI)
• sourcify-monitor service
• sourcify-server service (API)
• Verification core (lib-sourcify + compilers + bytecode-utils)
• Database (PostgreSQL)
• Object storage (S3 or local FS)
• External systems: EVM nodes, IPFS, Etherscan, Verifier-Alliance chains
b) Relationships & Data Flows:
1. Client/UI → HTTP → sourcify-server
2. monitor polls chain RPC / Etherscan for new contract creations
3. monitor fetches bytecode from decentralized storage (IPFS/Swarm)
4. monitor → HTTP → sourcify-server for automated verification
5. server invokes Verification core:
– uses bytecode-utils to extract metadata
– uses Solidity/Vyper compiler wrappers to recompile sources
6. server stores results & source files in DB + object storage
7. client queries server to retrieve verified contract files/details
c) Architectural Patterns & Principles:
• Microservices: separated monitor, server, database
• Hexagonal/ports-and-adapters in server (API adapters, storage adapters, compiler adapters)
• Event-driven triggers: monitor → server → database updates
• Shared libraries: code reuse via monorepo packages
d) Key Technologies:
• Node.js/TypeScript
• Hardhat config for local chain tests
• PostgreSQL with Knex-style migrations
• Docker/Docker-Compose for container orchestration
• CircleCI for CI/CD pipelines
• IPFS/Swarm for decentralized storage
• Ethers.js/chain RPC and Etherscan SDK
Detail Level
• Internal modules of each service only if relevant (e.g., server’s storageServices vs. generic DB adapter)
• Essential data stores (source files, verification results, chain metadata)
• Extensibility points: chain-support JSON configs, plug-in compilers, storage backends