resolc crate (#328)

- Factor the YUL crate out of `revive-solidity`. - `revive-solidity` is in reality not a Solidity implementation but the revive solidity compiler driver (`resolc`). By renaming we not only get this straight but also a binary with the same name as the crate which should be less confusing. --------- Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
2026-06-15 06:51:07 +00:00 · 2025-05-27 09:48:43 +02:00
parent 090e3ac13c
commit bd4e108bb0
99 changed files with 599 additions and 624 deletions
@@ -0,0 +1,4 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites name="jest tests" tests="27" failures="0" errors="0" time="2.146">
+  <testsuite name="Run with --yul by default" errors="0" failures="0" skipped="1" timestamp="2024-10-24T17:08:50" time="1.508" tests="6">
+    <testcase classname="Run with --yul by default Valid command exit code = 0" name="Run with --yul by default Valid command exit code = 0" time="0.003">
+    </testcase>
+    <testcase classname="Run with --yul by default --yul output is presented" name="Run with --yul by default --yul output is presented" time="0">
+    </testcase>
+    <testcase classname="Run with --yul by default solc exit code == resolc exit code" name="Run with --yul by default solc exit code == resolc exit code" time="0">
+      <skipped/>
+    </testcase>
+    <testcase classname="Run with --yul by default run invalid: resolc --yul" name="Run with --yul by default run invalid: resolc --yul" time="0.001">
+    </testcase>
+    <testcase classname="Run with --yul by default Invalid command exit code = 1" name="Run with --yul by default Invalid command exit code = 1" time="0">
+    </testcase>
+    <testcase classname="Run with --yul by default Invalid solc exit code == Invalid resolc exit code" name="Run with --yul by default Invalid solc exit code == Invalid resolc exit code" time="0.041">
+    </testcase>
+  </testsuite>
+  <testsuite name="Run with --asm by default" errors="0" failures="0" skipped="0" timestamp="2024-10-24T17:08:50" time="1.512" tests="6">
+    <testcase classname="Run with --asm by default Valid command exit code = 0" name="Run with --asm by default Valid command exit code = 0" time="0.002">
+    </testcase>
+    <testcase classname="Run with --asm by default --asm output is presented" name="Run with --asm by default --asm output is presented" time="0.001">
+    </testcase>
+    <testcase classname="Run with --asm by default solc exit code == resolc exit code" name="Run with --asm by default solc exit code == resolc exit code" time="0.044">
+    </testcase>
+    <testcase classname="Run with --asm by default run invalid: resolc --asm" name="Run with --asm by default run invalid: resolc --asm" time="0">
+    </testcase>
+    <testcase classname="Run with --asm by default Invalid command exit code = 1" name="Run with --asm by default Invalid command exit code = 1" time="0.001">
+    </testcase>
+    <testcase classname="Run with --asm by default Invalid solc exit code == Invalid resolc exit code" name="Run with --asm by default Invalid solc exit code == Invalid resolc exit code" time="0.04">
+    </testcase>
+  </testsuite>
+  <testsuite name="Run resolc without any options" errors="0" failures="0" skipped="2" timestamp="2024-10-24T17:08:50" time="2.016" tests="15">
+    <testcase classname="Run resolc without any options Info with help is presented" name="Run resolc without any options Info with help is presented" time="0.002">
+    </testcase>
+    <testcase classname="Run resolc without any options Exit code = 1" name="Run resolc without any options Exit code = 1" time="0">
+    </testcase>
+    <testcase classname="Run resolc without any options solc exit code == resolc exit code" name="Run resolc without any options solc exit code == resolc exit code" time="0.044">
+    </testcase>
+    <testcase classname="Default run a command from the help Compiler run successful" name="Default run a command from the help Compiler run successful" time="0">
+    </testcase>
+    <testcase classname="Default run a command from the help Exit code = 0" name="Default run a command from the help Exit code = 0" time="0.001">
+    </testcase>
+    <testcase classname="Default run a command from the help Output dir is created" name="Default run a command from the help Output dir is created" time="0">
+    </testcase>
+    <testcase classname="Default run a command from the help Output file is created" name="Default run a command from the help Output file is created" time="0">
+      <skipped/>
+    </testcase>
+    <testcase classname="Default run a command from the help the output file is not empty" name="Default run a command from the help the output file is not empty" time="0">
+    </testcase>
+    <testcase classname="Default run a command from the help No &apos;Error&apos;/&apos;Warning&apos;/&apos;Fail&apos; in the output" name="Default run a command from the help No &apos;Error&apos;/&apos;Warning&apos;/&apos;Fail&apos; in the output" time="0">
+    </testcase>
+    <testcase classname="Default run a command from the help Compiler run successful" name="Default run a command from the help Compiler run successful" time="0.001">
+    </testcase>
+    <testcase classname="Default run a command from the help Exit code = 0" name="Default run a command from the help Exit code = 0" time="0">
+    </testcase>
+    <testcase classname="Default run a command from the help Output dir is created" name="Default run a command from the help Output dir is created" time="0">
+    </testcase>
+    <testcase classname="Default run a command from the help Output files are created" name="Default run a command from the help Output files are created" time="0">
+      <skipped/>
+    </testcase>
+    <testcase classname="Default run a command from the help the output files are not empty" name="Default run a command from the help the output files are not empty" time="0.003">
+    </testcase>
+    <testcase classname="Default run a command from the help No &apos;Error&apos;/&apos;Warning&apos;/&apos;Fail&apos; in the output" name="Default run a command from the help No &apos;Error&apos;/&apos;Warning&apos;/&apos;Fail&apos; in the output" time="0">
+    </testcase>
+  </testsuite>
+</testsuites>
@@ -0,0 +1,26 @@
+{
+  "name": "cli-tests",
+  "version": "1.0.0",
+  "title": "resolc CLI Tests",
+  "description": "Auto tests for verifying resolc CLI",
+  "repository": "https://github.com/paritytech/revive",
+  "main": "index.js",
+  "private": true,
+  "scripts": {
+    "test": "npx jest --verbose --testPathPattern="
+  },
+  "keywords": [],
+  "author": "Matter Labs",
+  "contributors": [
+    "cyrill@parity.io"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/shelljs": "^0.8.15",
+    "jest": "^29.7.0",
+    "shelljs": "^0.8.5",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.3"
+  }
+}
@@ -0,0 +1,3 @@
+// SPDX-License-Identifier: GPL-3.0
+pragma solidity >=0.0;
+contract C {}
@@ -0,0 +1,54 @@
+object "Test" {
+    code {
+        {
+            mstore(64, 128)
+            if callvalue() { revert(0, 0) }
+            let _1 := datasize("Test_deployed")
+            codecopy(0, dataoffset("Test_deployed"), _1)
+            return(0, _1)
+        }
+    }
+    object "Test_deployed" {
+        code {
+            {
+                mstore(64, 128)
+                if iszero(lt(calldatasize(), 4))
+                {
+                    let _1 := 0
+                    switch shr(224, calldataload(_1))
+                    case 0x3df4ddf4 {
+                        if callvalue() { revert(_1, _1) }
+                        if slt(add(calldatasize(), not(3)), _1) { revert(_1, _1) }
+                        let memPos := allocate_memory(_1)
+                        mstore(memPos, 0x2a)
+                        return(memPos, 32)
+                    }
+                    case 0x5a8ac02d {
+                        if callvalue() { revert(_1, _1) }
+                        if slt(add(calldatasize(), not(3)), _1) { revert(_1, _1) }
+                        let memPos_1 := allocate_memory(_1)
+                        return(memPos_1, sub(abi_encode_uint256(memPos_1, 0x63), memPos_1))
+                    }
+                }
+                revert(0, 0)
+            }
+            function abi_encode_uint256(headStart, value0) -> tail
+            {
+                tail := add(headStart, 32)
+                mstore(headStart, value0)
+            }
+            function allocate_memory(size) -> memPtr
+            {
+                memPtr := mload(64)
+                let newFreePtr := add(memPtr, and(add(size, 31), not(31)))
+                if or(gt(newFreePtr, 0xffffffffffffffff), lt(newFreePtr, memPtr))
+                {
+                    mstore(0, shl(224, 0x4e487b71))
+                    mstore(4, 0x41)
+                    revert(0, 0x24)
+                }
+                mstore(64, newFreePtr)
+            }
+        }
+    }
+}
@@ -0,0 +1,47 @@
+import * as path from 'path'
+
+const outputDir = 'artifacts'
+const binExtension = ':C.pvm'
+const asmExtension = ':C.pvmasm'
+const llvmExtension = '.ll'
+const contractSolFilename = 'contract.sol'
+const contractYulFilename = 'contract.yul'
+const contractOptimizedLLVMFilename = contractSolFilename + '.C.optimized'
+const contractUnoptimizedLLVMFilename = contractSolFilename + '.C.unoptimized'
+const pathToOutputDir = path.join(__dirname, '..', outputDir)
+const pathToContracts = path.join(__dirname, '..', 'src', 'contracts')
+const pathToBasicYulContract = path.join(
+  pathToContracts,
+  'yul',
+  contractYulFilename
+)
+const pathToBasicSolContract = path.join(
+  pathToContracts,
+  'solidity',
+  contractSolFilename
+)
+const pathToSolBinOutputFile = path.join(
+  pathToOutputDir,
+  contractSolFilename + binExtension
+)
+const pathToSolAsmOutputFile = path.join(
+  pathToOutputDir,
+  contractSolFilename + asmExtension
+)
+
+export const paths = {
+  outputDir: outputDir,
+  binExtension: binExtension,
+  asmExtension: asmExtension,
+  llvmExtension: llvmExtension,
+  contractSolFilename: contractSolFilename,
+  contractYulFilename: contractYulFilename,
+  contractOptimizedLLVMFilename: contractOptimizedLLVMFilename,
+  contractUnoptimizedLLVMFilename: contractUnoptimizedLLVMFilename,
+  pathToOutputDir: pathToOutputDir,
+  pathToContracts: pathToContracts,
+  pathToBasicSolContract: pathToBasicSolContract,
+  pathToBasicYulContract: pathToBasicYulContract,
+  pathToSolBinOutputFile: pathToSolBinOutputFile,
+  pathToSolAsmOutputFile: pathToSolAsmOutputFile,
+}
@@ -0,0 +1,51 @@
+import * as shell from 'shelljs'
+import * as fs from 'fs'
+import { spawnSync } from 'child_process'
+
+interface CommandResult {
+  output: string
+  exitCode: number
+}
+
+export const executeCommand = (
+  command: string,
+  stdin?: string
+): CommandResult => {
+  if (stdin) {
+    const process = spawnSync(command, [], {
+      input: stdin,
+      shell: true,
+      encoding: 'utf8',
+      maxBuffer: 30 * 1024 * 1024,
+    })
+
+    return {
+      exitCode: process.status || 0,
+      output: (process.stdout || process.stderr || '').toString(),
+    }
+  }
+
+  const result = shell.exec(command, { silent: true, async: false })
+  return {
+    exitCode: result.code,
+    output: result.stdout || result.stderr || '',
+  }
+}
+
+export const isFolderExist = (folder: string): boolean => {
+  return shell.test('-d', folder)
+}
+
+export const isFileExist = (
+  pathToFileDir: string,
+  fileName: string,
+  fileExtension: string
+): boolean => {
+  return shell.ls(pathToFileDir).stdout.includes(fileName + fileExtension)
+}
+
+export const isFileEmpty = (file: string): boolean => {
+  if (fs.existsSync(file)) {
+    return fs.readFileSync(file).length === 0
+  }
+}
@@ -0,0 +1,44 @@
+import { executeCommand } from '../src/helper'
+import { paths } from '../src/entities'
+
+//id1746
+describe('Run with --asm by default', () => {
+  const command = `resolc ${paths.pathToBasicSolContract} --asm`
+  const result = executeCommand(command)
+  const commandInvalid = 'resolc --asm'
+  const resultInvalid = executeCommand(commandInvalid)
+
+  it('Valid command exit code = 0', () => {
+    expect(result.exitCode).toBe(0)
+  })
+
+  it('--asm output is presented', () => {
+    const expectedPatterns = [/(deploy)/i, /(call)/i, /(seal_return)/i]
+
+    for (const pattern of expectedPatterns) {
+      expect(result.output).toMatch(pattern)
+    }
+  })
+
+  it('solc exit code == resolc exit code', () => {
+    const command = `solc ${paths.pathToBasicSolContract} --asm`
+    const solcResult = executeCommand(command)
+    expect(solcResult.exitCode).toBe(result.exitCode)
+  })
+
+  it('run invalid: resolc --asm', () => {
+    expect(resultInvalid.output).toMatch(
+      /(No input sources specified|Compilation aborted)/i
+    )
+  })
+
+  it('Invalid command exit code = 1', () => {
+    expect(resultInvalid.exitCode).toBe(1)
+  })
+
+  it('Invalid solc exit code == Invalid resolc exit code', () => {
+    const command = 'solc --asm'
+    const solcResult = executeCommand(command)
+    expect(solcResult.exitCode).toBe(resultInvalid.exitCode)
+  })
+})
@@ -0,0 +1,241 @@
+import {
+  executeCommand,
+  isFolderExist,
+  isFileExist,
+  isFileEmpty,
+} from '../src/helper'
+import { paths } from '../src/entities'
+import * as shell from 'shelljs'
+import * as path from 'path'
+
+//id1762
+describe('Run resolc without any options', () => {
+  const command = 'resolc'
+  const result = executeCommand(command)
+
+  it('Info with help is presented', () => {
+    expect(result.output).toMatch(/(Usage: resolc)/i)
+  })
+
+  it('Exit code = 1', () => {
+    expect(result.exitCode).toBe(1)
+  })
+
+  it('solc exit code == resolc exit code', () => {
+    const command = 'solc'
+    const solcResult = executeCommand(command)
+    expect(solcResult.exitCode).toBe(result.exitCode)
+  })
+})
+
+//#1713
+describe('Default run a command from the help', () => {
+  const command = `resolc ${paths.pathToBasicSolContract} --overwrite -O3 --bin --output-dir "${paths.pathToOutputDir}"` // potential issue on resolc with full path on Windows cmd
+  const result = executeCommand(command)
+
+  it('Compiler run successful', () => {
+    expect(result.output).toMatch(/(Compiler run successful.)/i)
+  })
+  it('Exit code = 0', () => {
+    expect(result.exitCode).toBe(0)
+  })
+  it('Output dir is created', () => {
+    expect(isFolderExist(paths.pathToOutputDir)).toBe(true)
+  })
+  xit('Output file is created', () => {
+    // a bug on windows
+    expect(
+      isFileExist(
+        paths.pathToOutputDir,
+        paths.contractSolFilename,
+        paths.binExtension
+      )
+    ).toBe(true)
+  })
+  it('the output file is not empty', () => {
+    expect(isFileEmpty(paths.pathToSolBinOutputFile)).toBe(false)
+  })
+  it("No 'Error'/'Warning'/'Fail' in the output", () => {
+    expect(result.output).not.toMatch(/([Ee]rror|[Ww]arning|[Ff]ail)/i)
+  })
+})
+
+//#1818
+describe('Default run a command from the help', () => {
+  const command = `resolc ${paths.pathToBasicSolContract} --overwrite -O3 --bin --asm --output-dir "${paths.pathToOutputDir}"` // potential issue on resolc with full path on Windows cmd
+  const result = executeCommand(command)
+
+  it('Compiler run successful', () => {
+    expect(result.output).toMatch(/(Compiler run successful.)/i)
+  })
+  it('Exit code = 0', () => {
+    expect(result.exitCode).toBe(0)
+  })
+  it('Output dir is created', () => {
+    expect(isFolderExist(paths.pathToOutputDir)).toBe(true)
+  })
+  xit('Output files are created', () => {
+    // a bug on windows
+    expect(
+      isFileExist(
+        paths.pathToOutputDir,
+        paths.contractSolFilename,
+        paths.binExtension
+      )
+    ).toBe(true)
+    expect(
+      isFileExist(
+        paths.pathToOutputDir,
+        paths.contractSolFilename,
+        paths.asmExtension
+      )
+    ).toBe(true)
+  })
+  it('the output files are not empty', () => {
+    expect(isFileEmpty(paths.pathToSolBinOutputFile)).toBe(false)
+    expect(isFileEmpty(paths.pathToSolAsmOutputFile)).toBe(false)
+  })
+  it("No 'Error'/'Warning'/'Fail' in the output", () => {
+    expect(result.output).not.toMatch(/([Ee]rror|[Ww]arning|[Ff]ail)/i)
+  })
+})
+
+describe('Run resolc with source debug information', () => {
+  const commands = [
+    `resolc -g ${paths.pathToBasicSolContract} --overwrite --bin --asm --output-dir "${paths.pathToOutputDir}"`,
+    `resolc --disable-solc-optimizer -g ${paths.pathToBasicSolContract} --overwrite --bin --asm --output-dir "${paths.pathToOutputDir}"`,
+  ] // potential issue on resolc with full path on Windows cmd`;
+
+  for (var idx in commands) {
+    const command = commands[idx]
+    const result = executeCommand(command)
+
+    it('Compiler run successful', () => {
+      expect(result.output).toMatch(/(Compiler run successful.)/i)
+    })
+    it('Exit code = 0', () => {
+      expect(result.exitCode).toBe(0)
+    })
+    it('Output dir is created', () => {
+      expect(isFolderExist(paths.pathToOutputDir)).toBe(true)
+    })
+    it('Output files are created', () => {
+      // a bug on windows
+      expect(
+        isFileExist(
+          paths.pathToOutputDir,
+          paths.contractSolFilename,
+          paths.binExtension
+        )
+      ).toBe(true)
+      expect(
+        isFileExist(
+          paths.pathToOutputDir,
+          paths.contractSolFilename,
+          paths.asmExtension
+        )
+      ).toBe(true)
+    })
+    it('the output files are not empty', () => {
+      expect(isFileEmpty(paths.pathToSolBinOutputFile)).toBe(false)
+      expect(isFileEmpty(paths.pathToSolAsmOutputFile)).toBe(false)
+    })
+    it("No 'Error'/'Fail' in the output", () => {
+      expect(result.output).not.toMatch(/([Ee]rror|[Ff]ail)/i)
+    })
+  }
+})
+
+describe('Run resolc with source debug information, check LLVM debug-info', () => {
+  const commands = [
+    `resolc -g ${paths.pathToBasicSolContract} --overwrite --debug-output-dir="${paths.pathToOutputDir}"`,
+    `resolc -g --disable-solc-optimizer ${paths.pathToBasicSolContract} --overwrite --debug-output-dir="${paths.pathToOutputDir}"`,
+  ] // potential issue on resolc with full path on Windows cmd`;
+
+  for (var idx in commands) {
+    const command = commands[idx]
+    const result = executeCommand(command)
+
+    it('Compiler run successful', () => {
+      expect(result.output).toMatch(/(Compiler run successful.)/i)
+    })
+    it('Exit code = 0', () => {
+      expect(result.exitCode).toBe(0)
+    })
+    it('Output dir is created', () => {
+      expect(isFolderExist(paths.pathToOutputDir)).toBe(true)
+    })
+    it('Output files are created', () => {
+      // a bug on windows
+      expect(
+        isFileExist(
+          paths.pathToOutputDir,
+          paths.contractOptimizedLLVMFilename,
+          paths.llvmExtension
+        )
+      ).toBe(true)
+      expect(
+        isFileExist(
+          paths.pathToOutputDir,
+          paths.contractUnoptimizedLLVMFilename,
+          paths.llvmExtension
+        )
+      ).toBe(true)
+    })
+    it('the output files are not empty', () => {
+      expect(isFileEmpty(paths.pathToSolBinOutputFile)).toBe(false)
+      expect(isFileEmpty(paths.pathToSolAsmOutputFile)).toBe(false)
+    })
+    it("No 'Error'/'Fail' in the output", () => {
+      expect(result.output).not.toMatch(/([Ee]rror|[Ff]ail)/i)
+    })
+  }
+})
+
+describe('Standard JSON compilation with path options', () => {
+  const contractsDir = path.join(shell.tempdir(), 'contracts-test')
+  const inputFile = path.join(__dirname, '..', 'src/contracts/compiled/1.json')
+
+  beforeAll(() => {
+    shell.mkdir('-p', contractsDir)
+
+    const input = JSON.parse(shell.cat(inputFile).toString())
+
+    Object.entries(input.sources).forEach(
+      ([sourcePath, source]: [string, any]) => {
+        const filePath = path.join(contractsDir, sourcePath)
+        shell.mkdir('-p', path.dirname(filePath))
+        shell.ShellString(source.content).to(filePath)
+      }
+    )
+  })
+
+  afterAll(() => {
+    shell.rm('-rf', contractsDir)
+  })
+
+  describe('Output with all path options', () => {
+    let result: { exitCode: number; output: string }
+
+    beforeAll(() => {
+      const tempInputFile = path.join(contractsDir, 'temp-input.json')
+      shell.cp(inputFile, tempInputFile)
+      const inputContent = shell.cat(inputFile).toString()
+
+      const command = `resolc --standard-json --base-path "${contractsDir}" --include-path "${contractsDir}" --allow-paths "${contractsDir}"`
+
+      result = executeCommand(command, inputContent)
+
+      shell.rm(tempInputFile)
+    })
+
+    it('Compiler run successful without emiting warnings', () => {
+      const parsedResults = JSON.parse(result.output)
+      expect(
+        parsedResults.errors.filter(
+          (error: { type: string }) => error.type != 'Warning'
+        )
+      ).toEqual([])
+    })
+  })
+})
@@ -0,0 +1,39 @@
+import { executeCommand } from '../src/helper'
+import { paths } from '../src/entities'
+
+//id1743
+describe('Run with --yul by default', () => {
+  const command = `resolc ${paths.pathToBasicYulContract} --yul`
+  const result = executeCommand(command)
+  const commandInvalid = 'resolc --yul'
+  const resultInvalid = executeCommand(commandInvalid)
+
+  it('Valid command exit code = 0', () => {
+    expect(result.exitCode).toBe(0)
+  })
+
+  it('--yul output is presented', () => {
+    expect(result.output).toMatch(/(Compiler run successful)/i)
+    expect(result.output).toMatch(/(No output requested)/i)
+  })
+
+  xit('solc exit code == resolc exit code', () => {
+    // unknown solc issue for datatype of the contract
+    const command = `solc ${paths.pathToBasicSolContract} --yul`
+    const solcResult = executeCommand(command)
+    expect(solcResult.exitCode).toBe(result.exitCode)
+  })
+
+  it('run invalid: resolc --yul', () => {
+    expect(resultInvalid.output).toMatch(/(The input file is missing)/i)
+  })
+  it('Invalid command exit code = 1', () => {
+    expect(resultInvalid.exitCode).toBe(1)
+  })
+
+  it('Invalid solc exit code == Invalid resolc exit code', () => {
+    const command = 'solc --yul'
+    const solcResult = executeCommand(command)
+    expect(solcResult.exitCode).toBe(resultInvalid.exitCode)
+  })
+})
@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "CommonJS",
+    "outDir": "./dist",
+  }
+}