Check compiled contracts are within EIP-3860 limits

.github/workflows/checks.yml

@@ -39,6 +39,8 @@ jobs:
         uses: ./.github/actions/setup
       - name: Run tests and generate gas report
         run: npm run test
+      - name: Check EIP-3860 limits
+        run: npm run test:artifacts-size
       - name: Check linearisation of the inheritance graph
         run: npm run test:inheritance
       - name: Check proceduraly generated contracts are up-to-date
@@ -66,6 +68,10 @@ jobs:
         run: bash scripts/upgradeable/transpile.sh
       - name: Run tests
         run: npm run test
+        env:
+          UNLIMITED: true
+      - name: Check EIP-3860 limits
+        run: npm run test:artifacts-size
       - name: Check linearisation of the inheritance graph
         run: npm run test:inheritance
       - name: Check storage layout

hardhat.config.js

@@ -1,12 +1,13 @@
 /// ENVVAR
-// - COMPILE_VERSION:   compiler version (default: 0.8.20)
-// - SRC:               contracts folder to compile (default: contracts)
-// - COMPILE_MODE:      production modes enables optimizations (default: development)
-// - IR:                enable IR compilation (default: false)
-// - COVERAGE:          enable coverage report
-// - ENABLE_GAS_REPORT: enable gas report
-// - COINMARKETCAP:     coinmarkercat api key for USD value in gas report
-// - CI:                output gas report to file instead of stdout
+// - COMPILER:      compiler version (default: 0.8.20)
+// - SRC:           contracts folder to compile (default: contracts)
+// - RUNS:          number of optimization runs (default: 200)
+// - IR:            enable IR compilation (default: false)
+// - UNLIMITED:     allow deployment of contracts larger than 24k (default: false)
+// - COVERAGE:      enable coverage report (default: false)
+// - GAS:           enable gas report (default: false)
+// - COINMARKETCAP: coinmarketcap api key for USD value in gas report
+// - CI:            output gas report to file instead of stdout
 
 const fs = require('fs');
 const path = require('path');
@@ -25,17 +26,21 @@ const { argv } = require('yargs/yargs')()
       type: 'string',
       default: 'contracts',
     },
-    mode: {
-      alias: 'compileMode',
-      type: 'string',
-      choices: ['production', 'development'],
-      default: 'development',
+    runs: {
+      alias: 'optimizationRuns',
+      type: 'number',
+      default: 200,
     },
     ir: {
       alias: 'enableIR',
       type: 'boolean',
       default: false,
     },
+    unlimited: {
+      alias: 'allowUnlimitedContractSize',
+      type: 'boolean',
+      default: false,
+    },
     // Extra modules
     coverage: {
       type: 'boolean',
@@ -64,9 +69,6 @@ for (const f of fs.readdirSync(path.join(__dirname, 'hardhat'))) {
   require(path.join(__dirname, 'hardhat', f));
 }
 
-const withOptimizations = argv.gas || argv.coverage || argv.compileMode === 'production';
-const allowUnlimitedContractSize = argv.gas || argv.coverage || argv.compileMode === 'development';
-
 /**
  * @type import('hardhat/config').HardhatUserConfig
  */
@@ -75,10 +77,11 @@ module.exports = {
     version: argv.compiler,
     settings: {
       optimizer: {
-        enabled: withOptimizations,
-        runs: 200,
+        enabled: true,
+        runs: argv.runs,
+        details: { yul: true },
       },
-      viaIR: withOptimizations && argv.ir,
+      viaIR: argv.ir,
       outputSelection: { '*': { '*': ['storageLayout'] } },
     },
   },
@@ -88,14 +91,14 @@ module.exports = {
       'initcode-size': 'off',
     },
     '*': {
-      'code-size': withOptimizations,
+      'code-size': true,
       'unused-param': !argv.coverage, // coverage causes unused-param warnings
       default: 'error',
     },
   },
   networks: {
     hardhat: {
-      allowUnlimitedContractSize,
+      allowUnlimitedContractSize: argv.gas || argv.coverage || argv.unlimited,
       initialBaseFeePerGas: argv.coverage ? 0 : undefined,
     },
   },

package.json

@@ -25,6 +25,7 @@
     "generate": "scripts/generate/run.js",
     "version": "scripts/release/version.sh",
     "test": "hardhat test",
+    "test:artifacts-size": "scripts/checks/artifacts-size.js artifacts/build-info/*",
     "test:inheritance": "scripts/checks/inheritance-ordering.js artifacts/build-info/*",
     "test:generation": "scripts/checks/generation.sh",
     "gas-report": "env ENABLE_GAS_REPORT=true npm run test",

scripts/checks/artifacts-size.js

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+
+const path = require('path');
+const { _: artifacts } = require('yargs').argv;
+
+// Constants from EIP-3860
+const MAX_CODE_SIZE = 24576;
+
+// Get all compiled contracts from compilation artifacts
+const contracts = Object.fromEntries(
+  artifacts
+    .map(artifact => require(path.resolve(__dirname, '../..', artifact)))
+    .flatMap(buildInfo =>
+      Object.entries(buildInfo.output.contracts).flatMap(([file, contracts]) =>
+        Object.entries(contracts).map(([name, details]) => [
+          `${file}:${name}`,
+          Object.assign(details, { extra: { file, name, compilerSettings: buildInfo.input.settings } }),
+        ]),
+      ),
+    ),
+);
+
+for (const [id, details] of Object.entries(contracts)) {
+  // Skip "exposed" contracts
+  if (details.extra.name.startsWith('$')) {
+    continue;
+  }
+
+  // Skip (with warning) contracts that were not compiled with optimizations
+  if (!details.extra.compilerSettings.optimizer.enabled) {
+    console.warn(`[Warning] ${id} was compiled without optimizations. Skipped.`);
+    continue;
+  }
+
+  // Check deployed bytecode length is within limits
+  const { length: deployedBytecodeLength } = Buffer.from(details.evm.deployedBytecode.object, 'hex');
+  if (deployedBytecodeLength > MAX_CODE_SIZE) {
+    console.log('[deployedBytecode over limit]', id, deployedBytecodeLength);
+    process.exitCode = 1;
+  }
+}

scripts/checks/compare-layout.js

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 const fs = require('fs');
 const { getStorageUpgradeReport } = require('@openzeppelin/upgrades-core/dist/storage');
 

scripts/checks/extract-layout.js

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 const fs = require('fs');
 const { findAll, astDereferencer, srcDecoder } = require('solidity-ast/utils');
 const { extractStorageLayout } = require('@openzeppelin/upgrades-core/dist/storage/extract');