Reusable server module

.vscode/launch.json

@@ -8,7 +8,7 @@
       "type": "node",
       "request": "launch",
       "name": "Server - without build",
-      "program": "${workspaceFolder}/services/server/dist/server/server.js",
+      "program": "${workspaceFolder}/services/server/dist/server/cli.js",
       "envFile": "${workspaceFolder}/services/server/.env",
       "outFiles": [
         "${workspaceFolder}/services/server/dist/**/*.js",

package.json

@@ -10,7 +10,7 @@
   "scripts": {
     "build:clean": "rm -rf node_modules services/monitor/node_modules services/server/node_modules packages/bytecode-utils/node_modules/ packages/lib-sourcify/node_modules/ && npm install && npx lerna run build",
     "build:lerna": "lerna run build",
-    "server:start": "cd services/server && node ./dist/server/server.js",
+    "server:start": "cd services/server && node ./dist/server/cli.js",
     "monitor:start": "node ./services/monitor/dist/index.js",
     "update-chains": "node --experimental-fetch scripts/updateChains.mjs && prettier --write services/server/src/chains.json",
     "test:chains": "cd services/server && npm run test:chains",

packages/lib-sourcify/test/compiler/solidityCompiler.ts

@@ -176,8 +176,8 @@ export async function getSolcExecutable(
   version: string,
 ): Promise<string | null> {
   const fileName = `solc-${platform}-v${version}`;
-  const repoPath = path.join('/tmp', 'solc-repo');
-  const solcPath = path.join(repoPath, fileName);
+  const compilersPath = path.join('/tmp', 'solc-repo');
+  const solcPath = path.join(compilersPath, fileName);
   if (fs.existsSync(solcPath) && validateSolcPath(solcPath)) {
     logDebug('Found solc binary', {
       version,

serverless/compiler-lambda/index.js

@@ -166,8 +166,8 @@ async function getAllMetadataAndSourcesFromSolcJson(solcJson, compilerVersion) {
 
 async function getSolcExecutable(platform, version) {
   const fileName = `solc-${platform}-v${version}`;
-  const repoPath = process.env.SOLC_REPO || path.join("/tmp", "solc-repo");
-  const solcPath = path.join(repoPath, fileName);
+  const compilersPath = process.env.SOLC_REPO || path.join("/tmp", "solc-repo");
+  const solcPath = path.join(compilersPath, fileName);
   if (fs.existsSync(solcPath) && validateSolcPath(solcPath)) {
     console.debug(
       `Found solc ${version} with platform ${platform} at ${solcPath}`,

services/server/Dockerfile.debug

@@ -1,11 +1,11 @@
 # Runs the server in a linux/amd64 container with debug port exposed
 # Used in debugging solidity linux-amd64 binary executables on MacOS
 
-# From project root: docker build --platform=linux/amd64 --file ./services/server/Dockerfile.debug -t sourcify-server-debug ./services/server 
+# From project root: docker build --platform=linux/amd64 --file ./services/server/Dockerfile.debug -t sourcify-server-debug ./services/server
 # Assuming server is running on port 5555
 # Run with: docker run -it -p 9229:9229 -p 5555:5555 --volume /path/to/local/sourcify/git/repo:/home/app sourcify-server-debug
 # Finally run "Docker: Attach to Server" in VSCode debugger
 FROM node:22.5.1-bullseye
 WORKDIR /home/app/services/server
 
-CMD ["node", "--inspect=0.0.0.0:9229", "./dist/server/server.js"]
+CMD ["node", "--inspect=0.0.0.0:9229", "./dist/server/cli.js"]

services/server/README.md

@@ -26,12 +26,13 @@ See the [Config](#config) section below for details.
 const {
   RWStorageIdentifiers,
 } = require("../server/services/storageServices/identifiers");
-
+  
 module.exports = {
   storage: {
     read: RWStorageIdentifiers.RepositoryV1,
+    writeOrWarn: [],
     writeOrErr: [
-    read: RWStorageIdentifiers.RepositoryV1
+      RWStorageIdentifiers.RepositoryV1
     ]
   }
 }

services/server/package.json

@@ -2,15 +2,17 @@
   "name": "sourcify-server",
   "version": "2.2.1",
   "description": "Solidity metadata-based re-compilation and source verification tool",
-  "private": true,
+  "main": "dist/server/server.js",
+  "types": "dist/server/server.d.ts",
+  "bin": "dist/server/cli.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ethereum/sourcify.git"
   },
   "scripts": {
     "prebuild": "copyfiles -u 1 src/**/*.yaml src/*.json dist",
     "build": "tsc",
-    "start": "node ./dist/server/server.js",
+    "start": "node ./dist/server/cli.js",
     "postgres-test:start": "docker-compose -f test/docker-compose.yml up -d",
     "postgres-test:stop": "docker-compose -f test/docker-compose.yml rm -fsv",
     "postgres-test:migrate": "cd ../database && npm run migrate:up -- --env test",

services/server/src/common/errors/GenericErrorHandler.ts

@@ -6,6 +6,7 @@ export default function genericErrorHandler(
   _req: Request,
   res: Response,
   // Next function is required for Express to recognize this as an error handler. Error handlers must have 4 parameters.
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   _next: any,
 ): void {
   const errorCode = +err.code || err.status || 500;

services/server/src/server/cli.ts

@@ -0,0 +1,266 @@
+// !!! SHOULD NOT BE IMPORTED IN ANY OTHER MODULES on top of the files
+// Module to be run when running the server from the CLI
+
+import path from "path";
+// First env vars need to be loaded before config
+import dotenv from "dotenv";
+dotenv.config({ path: path.resolve(__dirname, "..", "..", ".env") });
+// Make sure config is relative to index.ts and not where the server is run from
+process.env["NODE_CONFIG_DIR"] = path.resolve(__dirname, "..", "config");
+import config from "config";
+import swaggerUi from "swagger-ui-express";
+import yamljs from "yamljs";
+import expressSession from "express-session";
+import createMemoryStore from "memorystore";
+import { Pool } from "pg";
+import genFunc from "connect-pg-simple";
+
+// local imports
+import logger from "../common/logger";
+import { sourcifyChainsMap } from "../sourcify-chains";
+import { Server } from "./server";
+import { ChainRepository } from "../sourcify-chain-repository";
+import { ISolidityCompiler } from "@ethereum-sourcify/lib-sourcify";
+import { SolcLambdaWithLocalFallback } from "./services/compiler/lambda-with-fallback/SolcLambdaWithLocalFallback";
+import { SolcLocal } from "./services/compiler/local/SolcLocal";
+import session from "express-session";
+
+// Supported Chains
+
+const chainRepository = new ChainRepository(sourcifyChainsMap);
+
+logger.info("SourcifyChains.Initialized", {
+  supportedChainsCount: chainRepository.supportedChainsArray.length,
+  allChainsCount: chainRepository.sourcifyChainsArray.length,
+  supportedChains: chainRepository.supportedChainsArray.map((c) => c.chainId),
+  allChains: chainRepository.sourcifyChainsArray.map((c) => c.chainId),
+});
+
+// Solidity Compiler
+
+const solcRepoPath =
+  (config.get("solcRepo") as string) || path.join("/tmp", "solc-repo");
+const solJsonRepoPath =
+  (config.get("solJsonRepo") as string) || path.join("/tmp", "soljson-repo");
+
+let selectedSolidityCompiler: ISolidityCompiler;
+if (config.get("lambdaCompiler.enabled")) {
+  logger.info("Using lambda solidity compiler with local fallback");
+  if (
+    process.env.AWS_REGION === undefined ||
+    process.env.AWS_ACCESS_KEY_ID === undefined ||
+    process.env.AWS_SECRET_ACCESS_KEY === undefined
+  ) {
+    throw new Error(
+      "AWS credentials not set. Please set them to run the compiler on AWS Lambda.",
+    );
+  }
+  selectedSolidityCompiler = new SolcLambdaWithLocalFallback(
+    process.env.AWS_REGION as string,
+    process.env.AWS_ACCESS_KEY_ID as string,
+    process.env.AWS_SECRET_ACCESS_KEY as string,
+    config.get("lambdaCompiler.functionName"),
+    solcRepoPath,
+    solJsonRepoPath,
+  );
+} else {
+  logger.info("Using local solidity compiler");
+  selectedSolidityCompiler = new SolcLocal(solcRepoPath, solJsonRepoPath);
+}
+
+export const solc = selectedSolidityCompiler;
+
+// To print regexes in the config object logs below
+Object.defineProperty(RegExp.prototype, "toJSON", {
+  value: RegExp.prototype.toString,
+});
+// Start Server
+logger.info("Starting server with config", {
+  config: JSON.stringify(config.util.toObject(), null, 2),
+});
+const server = new Server(
+  {
+    port: config.get("server.port"),
+    maxFileSize: config.get("server.maxFileSize"),
+    rateLimit: {
+      enabled: config.get("rateLimit.enabled"),
+      windowMs: config.get("rateLimit.enabled")
+        ? config.get("rateLimit.windowMs")
+        : undefined,
+      max: config.get("rateLimit.enabled")
+        ? config.get("rateLimit.max")
+        : undefined,
+      whitelist: config.get("rateLimit.enabled")
+        ? config.get("rateLimit.whitelist")
+        : undefined,
+      // Don't log IPs in production master
+      hideIpInLogs: process.env.NODE_ENV === "production",
+    },
+    corsAllowedOrigins: config.get("corsAllowedOrigins"),
+    solc,
+    chains: chainRepository.sourcifyChainMap,
+    verifyDeprecated: config.get("verifyDeprecated"),
+    sessionOptions: getSessionOptions(),
+    loggingToken: process.env.SETLOGGING_TOKEN,
+  },
+  {
+    initCompilers: config.get("initCompilers") || false,
+    solcRepoPath,
+    solJsonRepoPath,
+  },
+  {
+    enabledServices: {
+      read: config.get("storage.read"),
+      writeOrWarn: config.get("storage.writeOrWarn"),
+      writeOrErr: config.get("storage.writeOrErr"),
+    },
+    repositoryV1ServiceOptions: {
+      ipfsApi: process.env.IPFS_API as string,
+      repositoryPath: config.get("repositoryV1.path"),
+      repositoryServerUrl: config.get("repositoryV1.serverUrl") as string,
+    },
+    repositoryV2ServiceOptions: {
+      ipfsApi: process.env.IPFS_API as string,
+      repositoryPath: config.has("repositoryV2.path")
+        ? config.get("repositoryV2.path")
+        : undefined,
+    },
+    sourcifyDatabaseServiceOptions: {
+      postgres: {
+        host: process.env.SOURCIFY_POSTGRES_HOST as string,
+        database: process.env.SOURCIFY_POSTGRES_DB as string,
+        user: process.env.SOURCIFY_POSTGRES_USER as string,
+        password: process.env.SOURCIFY_POSTGRES_PASSWORD as string,
+        port: parseInt(process.env.SOURCIFY_POSTGRES_PORT || "5432"),
+      },
+      schema: process.env.SOURCIFY_POSTGRES_SCHEMA as string,
+    },
+    allianceDatabaseServiceOptions: {
+      postgres: {
+        host: process.env.ALLIANCE_POSTGRES_HOST as string,
+        database: process.env.ALLIANCE_POSTGRES_DB as string,
+        user: process.env.ALLIANCE_POSTGRES_USER as string,
+        password: process.env.ALLIANCE_POSTGRES_PASSWORD as string,
+        port: parseInt(process.env.ALLIANCE_POSTGRES_PORT || "5432"),
+      },
+      schema: process.env.ALLIANCE_POSTGRES_SCHEMA as string,
+    },
+  },
+);
+
+// Generate the swagger.json and serve it with SwaggerUI at /api-docs
+server.services.init().then(() => {
+  server
+    .loadSwagger(yamljs.load(path.join(__dirname, "..", "openapi.yaml"))) // load the openapi file with the $refs resolved
+    .then((swaggerDocument: any) => {
+      server.app.get("/api-docs/swagger.json", (req, res) =>
+        res.json(swaggerDocument),
+      );
+      server.app.use(
+        "/api-docs",
+        swaggerUi.serve,
+        swaggerUi.setup(swaggerDocument, {
+          customSiteTitle: "Sourcify API",
+          customfavIcon: "https://sourcify.dev/favicon.ico",
+        }),
+      );
+      server.app.listen(server.port, () => {
+        logger.info("Server listening", { port: server.port });
+      });
+    });
+});
+
+function initMemoryStore() {
+  const MemoryStore = createMemoryStore(expressSession);
+
+  logger.warn(
+    "Using memory based session. Don't use memory session in production!",
+  );
+  return new MemoryStore({
+    checkPeriod: config.get("session.maxAge"),
+  });
+}
+
+function initDatabaseStore() {
+  const pool = new Pool({
+    host: process.env.SOURCIFY_POSTGRES_HOST,
+    database: process.env.SOURCIFY_POSTGRES_DB,
+    user: process.env.SOURCIFY_POSTGRES_USER,
+    password: process.env.SOURCIFY_POSTGRES_PASSWORD,
+    port: parseInt(process.env.SOURCIFY_POSTGRES_PORT || "5432"),
+  });
+
+  // This listener is necessary otherwise the sourcify process crashes if the database is closed
+  pool.prependListener("error", (e) => {
+    logger.error("Database connection lost for session pool", {
+      error: e,
+    });
+    throw new Error("Database connection lost for session pool");
+  });
+
+  const PostgresqlStore = genFunc(expressSession);
+
+  logger.info("Using database based session");
+  return new PostgresqlStore({
+    pool: pool,
+    // Pruning expired sessions every 12 hours
+    pruneSessionInterval: 12 * 60 * 60,
+    schemaName: process.env.SOURCIFY_POSTGRES_SCHEMA as string,
+  });
+}
+
+function getSessionStore() {
+  const sessionStoreType = config.get("session.storeType");
+
+  switch (sessionStoreType) {
+    case "database": {
+      if (
+        process.env.SOURCIFY_POSTGRES_HOST &&
+        process.env.SOURCIFY_POSTGRES_DB &&
+        process.env.SOURCIFY_POSTGRES_USER &&
+        process.env.SOURCIFY_POSTGRES_PASSWORD
+      ) {
+        return initDatabaseStore();
+      } else {
+        logger.error(
+          "Database session enabled in config but the environment variables are not specified",
+        );
+        throw new Error(
+          "Database session enabled in config but the environment variables are not specified",
+        );
+      }
+    }
+
+    case "memory": {
+      return initMemoryStore();
+    }
+    default:
+      // Throw an error if an unrecognized session storage type is selected
+      throw new Error(
+        `Selected session storage type '${sessionStoreType}' doesn't exist.`,
+      );
+  }
+}
+
+export function getSessionOptions(): session.SessionOptions {
+  if (config.get("session.secret") === "CHANGE_ME") {
+    const msg =
+      "The session secret is not set, please set it in the config file";
+    process.env.NODE_ENV === "production"
+      ? logger.error(msg)
+      : logger.warn(msg);
+  }
+  return {
+    secret: config.get("session.secret"),
+    name: "sourcify_vid",
+    rolling: true,
+    resave: false,
+    saveUninitialized: true,
+    cookie: {
+      maxAge: config.get("session.maxAge"),
+      secure: config.get("session.secure"),
+      sameSite: "lax",
+    },
+    store: getSessionStore(),
+  };
+}