wip

Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>

.cargo/config.toml

@@ -15,6 +15,3 @@ rustflags = [
     "-Clink-arg=-sSTACK_SIZE=128kb",
     "-Clink-arg=-sNODEJS_CATCH_EXIT=0"
 ]
-
-[build]
-rustdocflags = ["-D", "warnings"]

.github/actions/get-llvm/action.yml

@@ -7,54 +7,23 @@ name: "Download LLVM"
 inputs:
   target:
     required: true
-  version:
-    description: "LLVM release version (e.g., 'llvm-18.1.8'). If not specified, uses the latest LLVM release."
-    required: false
-    default: ""
 
 runs:
   using: "composite"
   steps:
-    - name: detect llvm version from submodule
-      id: detect-version
-      shell: bash
-      run: |
-        if [ -z "${{ inputs.version }}" ]; then
-          # Get the full version from the LLVM submodule.
-          git submodule update --init --recursive
-          cd llvm
-          # Try to get the most recent tag (e.g., "llvmorg-18.1.8")
-          LLVM_TAG=$(git describe --tags --abbrev=0 2>/dev/null)
-          if [ -n "$LLVM_TAG" ]; then
-            echo "Detected LLVM version from submodule: $LLVM_TAG"
-            # Convert "llvmorg-x.y.z" to "llvm-x.y.z"
-            LLVM_VERSION=$(echo "$LLVM_TAG" | sed 's/^llvmorg-/llvm-/')
-            echo "Detected LLVM version from submodule: $LLVM_VERSION"
-            echo "version_prefix=$LLVM_VERSION" >> $GITHUB_OUTPUT
-          else
-            echo "Could not detect LLVM version from submodule, will use latest release"
-            echo "version_prefix=" >> $GITHUB_OUTPUT
-          fi
-          cd ..
-        else
-          echo "Using explicitly provided version: ${{ inputs.version }}"
-          echo "version_prefix=${{ inputs.version }}" >> $GITHUB_OUTPUT
-        fi
-
     - name: find asset
       id: find
       uses: actions/github-script@v7
       env:
         target: ${{ inputs.target }}
-        version_prefix: ${{ steps.detect-version.outputs.version_prefix }}
       with:
         result-encoding: string
         script: |
           let page = 1;
           let releases = [];
 
+          let releasePrefix = "llvm-"
           let target = process.env.target
-          let versionPrefix = process.env.version_prefix
 
           do {
             const res = await github.rest.repos.listReleases({
@@ -69,31 +38,15 @@ runs:
               return (a.published_at < b.published_at) ? 1 : ((a.published_at > b.published_at) ? -1 : 0);
             });
 
-            let llvmRelease;
+            let llvmLatestRelease = releases.find(release => {
-            if (versionPrefix) {
+              return release.tag_name.startsWith(releasePrefix);
-              // Search for latest release matching the version prefix
+            });
-              llvmRelease = releases.find(release => {
+            if (llvmLatestRelease){
-                return release.tag_name.startsWith(versionPrefix);
+                let asset = llvmLatestRelease.assets.find(asset =>{
-              });
-              if (llvmRelease) {
-                core.info(`Found LLVM release matching prefix '${versionPrefix}': ${llvmRelease.tag_name}`);
-              }
-            } else {
-              // Find latest LLVM release
-              llvmRelease = releases.find(release => {
-                return release.tag_name.startsWith('llvm-');
-              });
-              if (llvmRelease) {
-                core.info(`Found latest LLVM version: ${llvmRelease.tag_name}`);
-              }
-            }
-
-            if (llvmRelease){
-                let asset = llvmRelease.assets.find(asset =>{
                     return asset.name.includes(target);
                 });
                 if (!asset){
-                  core.setFailed(`Artifact for '${target}' not found in release ${llvmRelease.tag_name} (${llvmRelease.html_url})`);
+                  core.setFailed(`Artifact for '${target}' not found in release ${llvmLatestRelease.tag_name} (${llvmLatestRelease.html_url})`);
                   process.exit();
                 }
                 return asset.browser_download_url;
@@ -102,11 +55,7 @@ runs:
             page++;
           } while(releases.length > 0);
 
-          if (versionPrefix) {
+          core.setFailed(`No LLVM releases with '${releasePrefix}' atifacts found! Please release LLVM before running this workflow.`);
-            core.setFailed(`No LLVM releases matching prefix '${versionPrefix}' found! Please check the version.`);
-          } else {
-            core.setFailed(`No LLVM releases found! Please release LLVM before running this workflow.`);
-          }
           process.exit();
 
     - name: download

.github/actions/get-solc/action.yml

@@ -19,7 +19,7 @@ runs:
       shell: bash
       run: |
         mkdir -p solc
-        curl -sSL --output solc/solc https://github.com/ethereum/solidity/releases/download/v0.8.31/${SOLC_NAME}
+        curl -sSL --output solc/solc https://github.com/ethereum/solidity/releases/download/v0.8.30/${SOLC_NAME}
 
     - name: Make Solc Executable
       if: ${{ runner.os == 'Windows' }}

.github/workflows/book.yml

@@ -1,42 +0,0 @@
-name: Check docs up-to-date
-on:
-  push:
-    branches: ["main"]
-    paths:
-      - 'book/**'
-      - 'docs/**'
-      - '.gitignore'
-      - 'Makefile'
-      - '.github/workflows/book.yml'
-  pull_request:
-    branches: ["main"]
-    types: [opened, synchronize]
-    paths:
-      - 'book/**'
-      - 'docs/**'
-      - '.gitignore'
-      - 'Makefile'
-      - '.github/workflows/book.yml'
-
-jobs:
-  check-docs:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with: { fetch-depth: 0 }
-
-      - name: Install and test the mdBook
-        run: make test-book
-
-      - name: Build book
-        run: mdbook build book
-
-      - name: Build book to tmp
-        run: mdbook build book -d docs-tmp
-
-      - name: Compare with committed docs
-        run: |
-          if ! diff -r docs-tmp docs 2>/dev/null; then
-            echo "docs/ is not up-to-date. Run make test-book and commit the docs/ directory"
-            exit 1
-          fi

.github/workflows/release-llvm.yml

@@ -54,13 +54,11 @@ jobs:
           - target: aarch64-apple-darwin
             builder-arg: gnu
             host: macos
-            runner: macos-15
+            runner: macos-14
           - target: x86_64-apple-darwin
             builder-arg: gnu
             host: macos
-            # `macos-15-intel` will be the last x86_64 `macos` image supported by GHA.
+            runner: macos-13
-            # It will be available until Aug. 2027 (see https://github.com/actions/runner-images/issues/13045).
-            runner: macos-15-intel
           - target: x86_64-pc-windows-msvc
             builder-arg: gnu
             host: windows
@@ -82,10 +80,7 @@ jobs:
       - name: Install Dependencies
         if: ${{ matrix.host == 'linux' }}
         run: |
-          cat /etc/apt/sources.list
+          sudo apt-get update && sudo apt-get install -y cmake ninja-build curl git libssl-dev pkg-config clang lld musl
-          sudo sed -i 's/jammy/noble/g' /etc/apt/sources.list
-          cat /etc/apt/sources.list
-          sudo apt-get update && sudo apt-get install -y cmake ninja-build curl git libssl-dev pkg-config clang lld musl xz-utils libc6-dev gcc-multilib
 
       - name: Install Dependencies
         if: ${{ matrix.host == 'macos' }}
@@ -101,6 +96,10 @@ jobs:
         run: |
           cargo install --locked --force --path crates/llvm-builder
 
+      - name: Clone LLVM
+        run: |
+          revive-llvm --target-env ${{ matrix.builder-arg }} clone
+
       - name: Build LLVM
         if: ${{ matrix.target != 'wasm32-unknown-emscripten' }}
         run: |
@@ -109,7 +108,6 @@ jobs:
       - name: Build LLVM
         if: ${{ matrix.target == 'wasm32-unknown-emscripten' }}
         run: |
-          revive-llvm emsdk
           source emsdk/emsdk_env.sh
           revive-llvm --target-env ${{ matrix.builder-arg }} build --llvm-projects lld
 

.github/workflows/release-nightly.yml

@@ -1,5 +1,4 @@
 name: Nightly Release
-
 on:
   schedule:
     # Run every day at 01:00 UTC
@@ -11,8 +10,10 @@ concurrency:
 
 env:
   CARGO_TERM_COLOR: always
+  RUST_MUSL_CROSS_IMAGE: messense/rust-musl-cross@sha256:c0154e992adb791c3b848dd008939d19862549204f8cb26f5ca7a00f629e6067
 
 jobs:
+  # check if there were commits yesterday
   check_commits:
     runs-on: ubuntu-latest
     outputs:
@@ -21,7 +22,7 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          fetch-depth: 0 # Fetch full history to check previous commits
           ref: "main"
 
       - name: Check for commits from yesterday
@@ -46,12 +47,229 @@ jobs:
           fi
 
   build:
+    # github actions matrix jobs don't support multiple outputs
+    # ugly workaround from https://github.com/orgs/community/discussions/17245#discussioncomment-11222880
     if: ${{ needs.check_commits.outputs.has_commits == 'true' }}
+    outputs:
+      resolc-x86_64-unknown-linux-musl_url: ${{ steps.set-output.outputs.resolc-x86_64-unknown-linux-musl_url }}
+      resolc-x86_64-unknown-linux-musl_sha: ${{ steps.set-output.outputs.resolc-x86_64-unknown-linux-musl_sha }}
+      resolc-aarch64-apple-darwin_url: ${{ steps.set-output.outputs.resolc-aarch64-apple-darwin_url }}
+      resolc-aarch64-apple-darwin_sha: ${{ steps.set-output.outputs.resolc-aarch64-apple-darwin_sha }}
+      resolc-x86_64-apple-darwin_url: ${{ steps.set-output.outputs.resolc-x86_64-apple-darwin_url }}
+      resolc-x86_64-apple-darwin_sha: ${{ steps.set-output.outputs.resolc-x86_64-apple-darwin_sha }}
+      resolc-x86_64-pc-windows-msvc_url: ${{ steps.set-output.outputs.resolc-x86_64-pc-windows-msvc_url }}
+      resolc-x86_64-pc-windows-msvc_sha: ${{ steps.set-output.outputs.resolc-x86_64-pc-windows-msvc_sha }}
+    strategy:
+      matrix:
+        target:
+          [
+            x86_64-unknown-linux-musl,
+            aarch64-apple-darwin,
+            x86_64-apple-darwin,
+            x86_64-pc-windows-msvc,
+          ]
+        include:
+          - target: x86_64-unknown-linux-musl
+            type: musl
+            runner: ubuntu-24.04
+          - target: aarch64-apple-darwin
+            type: native
+            runner: macos-14
+          - target: x86_64-apple-darwin
+            type: native
+            runner: macos-13
+          - target: x86_64-pc-windows-msvc
+            type: native
+            runner: windows-2022
+    runs-on: ${{ matrix.runner }}
     needs: [check_commits]
-    uses: ./.github/workflows/reusable-build.yml
+    steps:
-    with:
+      - uses: actions/checkout@v4
-      is_release: false
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
-      retention_days: 40
+        with:
+          # without this it will override our rust flags
+          rustflags: ""
+          cache-key: ${{ matrix.target }}
+
+      - name: Download LLVM
+        uses: ./.github/actions/get-llvm
+        with:
+          target: ${{ matrix.target }}
+
+      - name: Build
+        if: ${{ matrix.type == 'native' }}
+        shell: bash
+        run: |
+          export LLVM_SYS_181_PREFIX=$PWD/llvm-${{ matrix.target }}
+          make install-bin
+          mv target/release/resolc resolc-${{ matrix.target }} || mv target/release/resolc.exe resolc-${{ matrix.target }}.exe
+
+      - name: Build
+        if: ${{ matrix.type == 'musl' }}
+        run: |
+          docker run -v $PWD:/opt/revive $RUST_MUSL_CROSS_IMAGE /bin/bash -c "
+           cd /opt/revive
+           chown -R root:root .
+           apt update && apt upgrade -y && apt install -y pkg-config
+           export LLVM_SYS_181_PREFIX=/opt/revive/llvm-${{ matrix.target }}
+           make install-bin
+           mv target/${{ matrix.target }}/release/resolc resolc-${{ matrix.target }}
+           "
+          sudo chown -R $(id -u):$(id -g) .
+
+      - name: Install Solc
+        uses: ./.github/actions/get-solc
+
+      - name: Basic Sanity Check
+        shell: bash
+        run: |
+          result=$(./resolc-${{ matrix.target }} --bin crates/integration/contracts/flipper.sol)
+          echo $result
+          if [[ $result == *'0x50564d'* ]]; then exit 0; else exit 1; fi
+
+      - name: Upload artifacts (nightly)
+        uses: actions/upload-artifact@v4
+        id: artifact-upload-step
+        with:
+          name: resolc-${{ matrix.target }}
+          path: resolc-${{ matrix.target }}*
+          retention-days: 40
+
+      - name: Set output variables (nightly)
+        id: set-output
+        shell: bash
+        run: |
+          echo "Artifact URL is ${{ steps.artifact-upload-step.outputs.artifact-url }}"
+          echo "Artifact SHA is ${{ steps.artifact-upload-step.outputs.artifact-digest }}"
+          echo "resolc-${{ matrix.target }}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}"
+          echo "resolc-${{ matrix.target }}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}" >> "$GITHUB_OUTPUT"
+          echo "resolc-${{ matrix.target }}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}"
+          echo "resolc-${{ matrix.target }}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}" >> "$GITHUB_OUTPUT"
+
+  build-wasm:
+    runs-on: ubuntu-24.04
+    needs: [check_commits]
+    if: ${{ needs.check_commits.outputs.has_commits == 'true' }}
+    outputs:
+      resolc-web.js_url: ${{ steps.set-output.outputs.resolc_web_js_url }}
+      resolc-web.js_sha: ${{ steps.set-output.outputs.resolc_web_js_sha }}
+    env:
+      RELEASE_RESOLC_WASM_URI: https://github.com/paritytech/revive/releases/download/${{ github.ref_name }}/resolc.wasm
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          target: wasm32-unknown-emscripten
+          # without this it will override our rust flags
+          rustflags: ""
+
+      - name: Download Host LLVM
+        uses: ./.github/actions/get-llvm
+        with:
+          target: x86_64-unknown-linux-gnu
+
+      - name: Download Wasm LLVM
+        uses: ./.github/actions/get-llvm
+        with:
+          target: wasm32-unknown-emscripten
+
+      - name: Download EMSDK
+        uses: ./.github/actions/get-emsdk
+
+      - name: Build
+        run: |
+          export LLVM_SYS_181_PREFIX=$PWD/llvm-x86_64-unknown-linux-gnu
+          export REVIVE_LLVM_TARGET_PREFIX=$PWD/llvm-wasm32-unknown-emscripten
+          source emsdk/emsdk_env.sh
+          make install-wasm
+          chmod -x ./target/wasm32-unknown-emscripten/release/resolc.wasm
+
+      - name: Set Up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+
+      - name: Basic Sanity Check
+        run: |
+          mkdir -p solc
+          curl -sSLo solc/soljson.js https://github.com/ethereum/solidity/releases/download/v0.8.30/soljson.js
+          node -e "
+          const soljson = require('solc/soljson');
+          const createRevive = require('./target/wasm32-unknown-emscripten/release/resolc.js');
+
+          const compiler = createRevive();
+          compiler.soljson = soljson;
+
+          const standardJsonInput =
+          {
+            language: 'Solidity',
+            sources: {
+              'MyContract.sol': {
+                content: 'pragma solidity ^0.8.0; contract MyContract { function greet() public pure returns (string memory) { return \'Hello\'; } }',
+              },
+            },
+            settings: { optimizer: { enabled: false } }
+          };
+
+          compiler.writeToStdin(JSON.stringify(standardJsonInput));
+          compiler.callMain(['--standard-json']);
+
+          // Collect output
+          const stdout = compiler.readFromStdout();
+          const stderr = compiler.readFromStderr();
+
+          if (stderr) { console.error(stderr); process.exit(1); }
+
+          let out = JSON.parse(stdout);
+          let bytecode = out.contracts['MyContract.sol']['MyContract'].evm.bytecode.object
+          console.log(bytecode);
+
+          if(!bytecode.startsWith('50564d')) { process.exit(1); }
+          "
+
+      - name: Compress Artifact
+        run: |
+          mkdir -p resolc-wasm32-unknown-emscripten
+          mv ./target/wasm32-unknown-emscripten/release/resolc.js ./resolc-wasm32-unknown-emscripten/
+          mv ./target/wasm32-unknown-emscripten/release/resolc.wasm ./resolc-wasm32-unknown-emscripten/
+          mv ./target/wasm32-unknown-emscripten/release/resolc_web.js ./resolc-wasm32-unknown-emscripten/
+
+      # There is no way to upload several files as several artifacts with a single upload-artifact step
+      # It's needed to have resolc_web.js separately for night builds for resolc-bin repo
+      # https://github.com/actions/upload-artifact/issues/331
+      - name: Upload artifact resolc.js (nightly)
+        uses: actions/upload-artifact@v4
+        with:
+          name: resolc.js
+          path: resolc-wasm32-unknown-emscripten/resolc.js
+          retention-days: 40
+
+      - name: Upload artifacts resolc.wasm (nightly)
+        uses: actions/upload-artifact@v4
+        with:
+          name: resolc.wasm
+          path: resolc-wasm32-unknown-emscripten/resolc.wasm
+          retention-days: 40
+
+      - name: Upload artifacts resolc_web.js (nightly)
+        uses: actions/upload-artifact@v4
+        id: artifact-upload-step
+        with:
+          name: resolc_web.js
+          path: resolc-wasm32-unknown-emscripten/resolc_web.js
+          retention-days: 40
+
+      - name: Set output variables
+        id: set-output
+        env:
+          TARGET: resolc_web_js
+        run: |
+          echo "Artifact URL is ${{ steps.artifact-upload-step.outputs.artifact-url }}"
+          echo "Artifact SHA is ${{ steps.artifact-upload-step.outputs.artifact-digest }}"
+          echo "${TARGET}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}"
+          echo "${TARGET}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}" >> "$GITHUB_OUTPUT"
+          echo "${TARGET}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}""
+          echo "${TARGET}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}"" >> "$GITHUB_OUTPUT"
 
   create-macos-fat-binary:
     if: ${{ needs.check_commits.outputs.has_commits == 'true' }}
@@ -59,7 +277,7 @@ jobs:
     outputs:
       resolc-universal-apple-darwin_url: ${{ steps.set-output.outputs.resolc-universal-apple-darwin_url }}
       resolc-universal-apple-darwin_sha: ${{ steps.set-output.outputs.resolc-universal-apple-darwin_sha }}
-    runs-on: macos-15
+    runs-on: macos-14
     steps:
       - uses: actions/download-artifact@v4
         with:
@@ -85,14 +303,18 @@ jobs:
         env:
           TARGET: resolc-universal-apple-darwin
         run: |
+          echo "Artifact URL is ${{ steps.artifact-upload-step.outputs.artifact-url }}"
+          echo "Artifact SHA is ${{ steps.artifact-upload-step.outputs.artifact-digest }}"
+          echo "${TARGET}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}"
           echo "${TARGET}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}" >> "$GITHUB_OUTPUT"
-          echo "${TARGET}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}" >> "$GITHUB_OUTPUT"
+          echo "${TARGET}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}""
+          echo "${TARGET}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}"" >> "$GITHUB_OUTPUT"
 
   generate-nightly-json:
     runs-on: ubuntu-24.04
     if: ${{ needs.check_commits.outputs.has_commits == 'true' }}
     environment: tags
-    needs: [build, create-macos-fat-binary, check_commits]
+    needs: [build-wasm, build, create-macos-fat-binary, check_commits]
     steps:
       - name: Checkout revive
         uses: actions/checkout@v4
@@ -130,6 +352,8 @@ jobs:
           echo '[' > data.json
           echo '${{ toJSON(needs.build.outputs) }}' >> data.json
           echo ',' >> data.json
+          echo '${{ toJSON(needs.build-wasm.outputs) }}' >> data.json
+          echo ',' >> data.json
           echo '${{ toJSON(needs.create-macos-fat-binary.outputs) }}' >> data.json
           echo ']' >> data.json
           chmod +x bins/resolc-x86_64-unknown-linux-musl

.github/workflows/release.yml

@@ -1,5 +1,4 @@
 name: Build & Release
-
 on:
   push:
     branches: ["main"]
@@ -15,6 +14,8 @@ concurrency:
 
 env:
   CARGO_TERM_COLOR: always
+  # if changed, dont forget to update the env var in release-nightly.yml
+  RUST_MUSL_CROSS_IMAGE: messense/rust-musl-cross@sha256:c0154e992adb791c3b848dd008939d19862549204f8cb26f5ca7a00f629e6067
 
 jobs:
   check-version-changed:
@@ -28,28 +29,33 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      # Check that tag and version in Cargo.toml match
       - name: Check versions
         id: versions
         run: |
-          if [[ $CURRENT_TAG == 'main' ]]; then
+          if [[ $CURRENT_TAG == 'main' ]];
-            echo "::notice::Tag $CURRENT_TAG is not a release tag, skipping the check in the main branch"
+            then
-            exit 0
+              echo "::notice::Tag $CURRENT_TAG is not a release tag, skipping the check in the main branch";
-          fi
+              exit 0
+            fi
 
-          if [[ $CURRENT_TAG != "v"* ]]; then
+          if [[ $CURRENT_TAG != "v"* ]];
-            echo "::notice::Tag $CURRENT_TAG is not a release tag, skipping the check in a PR"
+            then
-            exit 0
+              echo "::notice::Tag $CURRENT_TAG is not a release tag, skipping the check in a PR";
-          fi
+              exit 0
+            fi
 
           export PKG_VER=v$(cat crates/resolc/Cargo.toml | grep -A 5 package] | grep version | cut -d '=' -f 2 | tr -d '"' | tr -d " ")
           echo "Current tag $CURRENT_TAG"
           echo "Package version $PKG_VER"
+          #
+          if [[ $CURRENT_TAG != $PKG_VER  ]];
+            then
+              echo "::error::Tag $CURRENT_TAG doesn't match package version $PKG_VER in Cargo.toml, please fix";
+              exit 1
+            fi
 
-          if [[ $CURRENT_TAG != $PKG_VER ]]; then
+          # Generating release notes early, in order to avoid checkout at the last step
-            echo "::error::Tag $CURRENT_TAG doesn't match package version $PKG_VER in Cargo.toml, please fix"
-            exit 1
-          fi
-
           export RELEASE_NOTES="$(sed '/^## '${CURRENT_TAG}'/,/^## v/!d' CHANGELOG.md | sed -e '1d' -e '$d')"
 
           echo "Release notes:"
@@ -60,16 +66,174 @@ jobs:
           echo 'EOF' >> $GITHUB_OUTPUT
 
   build:
+    strategy:
+      matrix:
+        target:
+          [
+            x86_64-unknown-linux-musl,
+            aarch64-apple-darwin,
+            x86_64-apple-darwin,
+            x86_64-pc-windows-msvc,
+          ]
+        include:
+          - target: x86_64-unknown-linux-musl
+            type: musl
+            runner: ubuntu-24.04
+          - target: aarch64-apple-darwin
+            type: native
+            runner: macos-14
+          - target: x86_64-apple-darwin
+            type: native
+            runner: macos-13
+          - target: x86_64-pc-windows-msvc
+            type: native
+            runner: windows-2022
+    runs-on: ${{ matrix.runner }}
     needs: [check-version-changed]
-    uses: ./.github/workflows/reusable-build.yml
+    steps:
-    with:
+      - uses: actions/checkout@v4
-      is_release: true
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
-      retention_days: 1
+        with:
+          # without this it will override our rust flags
+          rustflags: ""
+          cache-key: ${{ matrix.target }}
+
+      - name: Download LLVM
+        uses: ./.github/actions/get-llvm
+        with:
+          target: ${{ matrix.target }}
+
+      - name: Build
+        if: ${{ matrix.type == 'native' }}
+        shell: bash
+        run: |
+          export LLVM_SYS_181_PREFIX=$PWD/llvm-${{ matrix.target }}
+          make install-bin
+          mv target/release/resolc resolc-${{ matrix.target }} || mv target/release/resolc.exe resolc-${{ matrix.target }}.exe
+
+      - name: Build
+        if: ${{ matrix.type == 'musl' }}
+        run: |
+          docker run -v $PWD:/opt/revive $RUST_MUSL_CROSS_IMAGE /bin/bash -c "
+           cd /opt/revive
+           chown -R root:root .
+           apt update && apt upgrade -y && apt install -y pkg-config
+           export LLVM_SYS_181_PREFIX=/opt/revive/llvm-${{ matrix.target }}
+           make install-bin
+           mv target/${{ matrix.target }}/release/resolc resolc-${{ matrix.target }}
+           "
+          sudo chown -R $(id -u):$(id -g) .
+
+      - name: Install Solc
+        uses: ./.github/actions/get-solc
+
+      - name: Basic Sanity Check
+        shell: bash
+        run: |
+          result=$(./resolc-${{ matrix.target }} --bin crates/integration/contracts/flipper.sol)
+          echo $result
+          if [[ $result == *'0x50564d'* ]]; then exit 0; else exit 1; fi
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: resolc-${{ matrix.target }}
+          path: resolc-${{ matrix.target }}*
+          retention-days: 1
+
+  build-wasm:
+    runs-on: ubuntu-24.04
+    needs: [check-version-changed]
+    env:
+      RELEASE_RESOLC_WASM_URI: https://github.com/paritytech/revive/releases/download/${{ github.ref_name }}/resolc.wasm
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          target: wasm32-unknown-emscripten
+          # without this it will override our rust flags
+          rustflags: ""
+
+      - name: Download Host LLVM
+        uses: ./.github/actions/get-llvm
+        with:
+          target: x86_64-unknown-linux-gnu
+
+      - name: Download Wasm LLVM
+        uses: ./.github/actions/get-llvm
+        with:
+          target: wasm32-unknown-emscripten
+
+      - name: Download EMSDK
+        uses: ./.github/actions/get-emsdk
+
+      - name: Build
+        run: |
+          export LLVM_SYS_181_PREFIX=$PWD/llvm-x86_64-unknown-linux-gnu
+          export REVIVE_LLVM_TARGET_PREFIX=$PWD/llvm-wasm32-unknown-emscripten
+          source emsdk/emsdk_env.sh
+          make install-wasm
+          chmod -x ./target/wasm32-unknown-emscripten/release/resolc.wasm
+
+      - name: Set Up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+
+      - name: Basic Sanity Check
+        run: |
+          mkdir -p solc
+          curl -sSLo solc/soljson.js https://github.com/ethereum/solidity/releases/download/v0.8.30/soljson.js
+          node -e "
+          const soljson = require('solc/soljson');
+          const createRevive = require('./target/wasm32-unknown-emscripten/release/resolc.js');
+
+          const compiler = createRevive();
+          compiler.soljson = soljson;
+
+          const standardJsonInput =
+          {
+            language: 'Solidity',
+            sources: {
+              'MyContract.sol': {
+                content: 'pragma solidity ^0.8.0; contract MyContract { function greet() public pure returns (string memory) { return \'Hello\'; } }',
+              },
+            },
+            settings: { optimizer: { enabled: false } }
+          };
+
+          compiler.writeToStdin(JSON.stringify(standardJsonInput));
+          compiler.callMain(['--standard-json']);
+
+          // Collect output
+          const stdout = compiler.readFromStdout();
+          const stderr = compiler.readFromStderr();
+
+          if (stderr) { console.error(stderr); process.exit(1); }
+
+          let out = JSON.parse(stdout);
+          let bytecode = out.contracts['MyContract.sol']['MyContract'].evm.bytecode.object
+          console.log(bytecode);
+
+          if(!bytecode.startsWith('50564d')) { process.exit(1); }
+          "
+
+      - name: Compress Artifact
+        run: |
+          mkdir -p resolc-wasm32-unknown-emscripten
+          mv ./target/wasm32-unknown-emscripten/release/resolc.js ./resolc-wasm32-unknown-emscripten/
+          mv ./target/wasm32-unknown-emscripten/release/resolc.wasm ./resolc-wasm32-unknown-emscripten/
+          mv ./target/wasm32-unknown-emscripten/release/resolc_web.js ./resolc-wasm32-unknown-emscripten/
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: resolc-wasm32-unknown-emscripten
+          path: resolc-wasm32-unknown-emscripten/*
+          retention-days: 1
 
   create-release:
     if: startsWith(github.ref_name, 'v')
-    needs: [check-version-changed, build]
+    needs: [check-version-changed, build-wasm]
-    runs-on: macos-15
+    runs-on: macos-14
     environment: tags
     steps:
       - name: Download Artifacts
@@ -126,7 +290,7 @@ jobs:
 
   npm-release:
     needs: [create-release]
-    runs-on: macos-15
+    runs-on: macos-14
     environment: tags
     steps:
       - uses: actions/checkout@v4

.github/workflows/reusable-build.yml

@@ -1,264 +0,0 @@
-name: Reusable Build
-
-on:
-  workflow_call:
-    inputs:
-      is_release:
-        description: "Whether this is a release build"
-        required: true
-        type: boolean
-      retention_days:
-        description: "Artifact retention days"
-        required: false
-        type: number
-        default: 1
-    outputs:
-      resolc-x86_64-unknown-linux-musl_url:
-        value: ${{ jobs.build.outputs.resolc-x86_64-unknown-linux-musl_url }}
-      resolc-x86_64-unknown-linux-musl_sha:
-        value: ${{ jobs.build.outputs.resolc-x86_64-unknown-linux-musl_sha }}
-      resolc-aarch64-apple-darwin_url:
-        value: ${{ jobs.build.outputs.resolc-aarch64-apple-darwin_url }}
-      resolc-aarch64-apple-darwin_sha:
-        value: ${{ jobs.build.outputs.resolc-aarch64-apple-darwin_sha }}
-      resolc-x86_64-apple-darwin_url:
-        value: ${{ jobs.build.outputs.resolc-x86_64-apple-darwin_url }}
-      resolc-x86_64-apple-darwin_sha:
-        value: ${{ jobs.build.outputs.resolc-x86_64-apple-darwin_sha }}
-      resolc-x86_64-pc-windows-msvc_url:
-        value: ${{ jobs.build.outputs.resolc-x86_64-pc-windows-msvc_url }}
-      resolc-x86_64-pc-windows-msvc_sha:
-        value: ${{ jobs.build.outputs.resolc-x86_64-pc-windows-msvc_sha }}
-      resolc-web_js_url:
-        value: ${{ jobs.build-wasm.outputs.resolc_web_js_url }}
-      resolc-web_js_sha:
-        value: ${{ jobs.build-wasm.outputs.resolc_web_js_sha }}
-
-env:
-  CARGO_TERM_COLOR: always
-  RUST_MUSL_CROSS_IMAGE: messense/rust-musl-cross@sha256:c0154e992adb791c3b848dd008939d19862549204f8cb26f5ca7a00f629e6067
-
-jobs:
-  build:
-    # github actions matrix jobs don't support multiple outputs
-    # ugly workaround from https://github.com/orgs/community/discussions/17245#discussioncomment-11222880
-    outputs:
-      resolc-x86_64-unknown-linux-musl_url: ${{ steps.set-output.outputs.resolc-x86_64-unknown-linux-musl_url }}
-      resolc-x86_64-unknown-linux-musl_sha: ${{ steps.set-output.outputs.resolc-x86_64-unknown-linux-musl_sha }}
-      resolc-aarch64-apple-darwin_url: ${{ steps.set-output.outputs.resolc-aarch64-apple-darwin_url }}
-      resolc-aarch64-apple-darwin_sha: ${{ steps.set-output.outputs.resolc-aarch64-apple-darwin_sha }}
-      resolc-x86_64-apple-darwin_url: ${{ steps.set-output.outputs.resolc-x86_64-apple-darwin_url }}
-      resolc-x86_64-apple-darwin_sha: ${{ steps.set-output.outputs.resolc-x86_64-apple-darwin_sha }}
-      resolc-x86_64-pc-windows-msvc_url: ${{ steps.set-output.outputs.resolc-x86_64-pc-windows-msvc_url }}
-      resolc-x86_64-pc-windows-msvc_sha: ${{ steps.set-output.outputs.resolc-x86_64-pc-windows-msvc_sha }}
-    strategy:
-      matrix:
-        target:
-          [
-            x86_64-unknown-linux-musl,
-            aarch64-apple-darwin,
-            x86_64-apple-darwin,
-            x86_64-pc-windows-msvc,
-          ]
-        include:
-          - target: x86_64-unknown-linux-musl
-            type: musl
-            runner: ubuntu-24.04
-          - target: aarch64-apple-darwin
-            type: native
-            runner: macos-15
-          - target: x86_64-apple-darwin
-            type: native
-            # `macos-15-intel` will be the last x86_64 `macos` image supported by GHA.
-            # It will be available until Aug. 2027 (see https://github.com/actions/runner-images/issues/13045).
-            runner: macos-15-intel
-          - target: x86_64-pc-windows-msvc
-            type: native
-            runner: windows-2022
-    runs-on: ${{ matrix.runner }}
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions-rust-lang/setup-rust-toolchain@v1
-        with:
-          rustflags: ""
-          cache-key: ${{ matrix.target }}
-
-      - name: Download LLVM
-        uses: ./.github/actions/get-llvm
-        with:
-          target: ${{ matrix.target }}
-
-      - name: Build (Native)
-        if: ${{ matrix.type == 'native' }}
-        shell: bash
-        run: |
-          export LLVM_SYS_181_PREFIX=$PWD/llvm-${{ matrix.target }}
-          make install-bin
-          mv target/release/resolc resolc-${{ matrix.target }} || mv target/release/resolc.exe resolc-${{ matrix.target }}.exe
-
-      - name: Build (MUSL)
-        if: ${{ matrix.type == 'musl' }}
-        run: |
-          docker run -v $PWD:/opt/revive $RUST_MUSL_CROSS_IMAGE /bin/bash -c "
-           cd /opt/revive
-           chown -R root:root .
-           apt update && apt upgrade -y && apt install -y pkg-config
-           export LLVM_SYS_181_PREFIX=/opt/revive/llvm-${{ matrix.target }}
-           make install-bin
-           mv target/${{ matrix.target }}/release/resolc resolc-${{ matrix.target }}
-           "
-          sudo chown -R $(id -u):$(id -g) .
-
-      - name: Install Solc
-        uses: ./.github/actions/get-solc
-
-      - name: Basic Sanity Check
-        shell: bash
-        run: |
-          result=$(./resolc-${{ matrix.target }} --bin crates/integration/contracts/flipper.sol)
-          echo $result
-          if [[ $result == *'50564d'* ]]; then exit 0; else exit 1; fi
-
-      - uses: actions/upload-artifact@v4
-        id: artifact-upload-step
-        with:
-          name: resolc-${{ matrix.target }}
-          path: resolc-${{ matrix.target }}*
-          retention-days: ${{ inputs.retention_days }}
-
-      - name: Set output variables
-        if: ${{ !inputs.is_release }}
-        id: set-output
-        shell: bash
-        run: |
-          echo "resolc-${{ matrix.target }}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}" >> "$GITHUB_OUTPUT"
-          echo "resolc-${{ matrix.target }}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}" >> "$GITHUB_OUTPUT"
-
-  build-wasm:
-    runs-on: ubuntu-24.04
-    outputs:
-      resolc_web_js_url: ${{ steps.set-output.outputs.resolc_web_js_url }}
-      resolc_web_js_sha: ${{ steps.set-output.outputs.resolc_web_js_sha }}
-    env:
-      RELEASE_RESOLC_WASM_URI: https://github.com/paritytech/revive/releases/download/${{ github.ref_name }}/resolc.wasm
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions-rust-lang/setup-rust-toolchain@v1
-        with:
-          target: wasm32-unknown-emscripten
-          rustflags: ""
-
-      - name: Download Host LLVM
-        uses: ./.github/actions/get-llvm
-        with:
-          target: x86_64-unknown-linux-gnu
-
-      - name: Download Wasm LLVM
-        uses: ./.github/actions/get-llvm
-        with:
-          target: wasm32-unknown-emscripten
-
-      - name: Download EMSDK
-        uses: ./.github/actions/get-emsdk
-
-      - name: Build
-        run: |
-          export LLVM_SYS_181_PREFIX=$PWD/llvm-x86_64-unknown-linux-gnu
-          export REVIVE_LLVM_TARGET_PREFIX=$PWD/llvm-wasm32-unknown-emscripten
-          source emsdk/emsdk_env.sh
-          make install-wasm
-          chmod -x ./target/wasm32-unknown-emscripten/release/resolc.wasm
-
-      - name: Set Up Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: "20"
-
-      - name: Basic Sanity Check
-        run: |
-          mkdir -p solc
-          curl -sSLo solc/soljson.js https://github.com/ethereum/solidity/releases/download/v0.8.31/soljson.js
-          node -e "
-          const soljson = require('solc/soljson');
-          const createRevive = require('./target/wasm32-unknown-emscripten/release/resolc.js');
-
-          const compiler = createRevive();
-          compiler.soljson = soljson;
-
-          const standardJsonInput =
-          {
-            language: 'Solidity',
-            sources: {
-              'MyContract.sol': {
-                content: 'pragma solidity ^0.8.0; contract MyContract { function greet() public pure returns (string memory) { return \'Hello\'; } }',
-              },
-            },
-            settings: { optimizer: { enabled: false } }
-          };
-
-          compiler.writeToStdin(JSON.stringify(standardJsonInput));
-          compiler.callMain(['--standard-json']);
-
-          const stdout = compiler.readFromStdout();
-          const stderr = compiler.readFromStderr();
-
-          if (stderr) { console.error(stderr); process.exit(1); }
-
-          let out = JSON.parse(stdout);
-          let bytecode = out.contracts['MyContract.sol']['MyContract'].evm.bytecode.object
-          console.log(bytecode);
-
-          if(!bytecode.startsWith('50564d')) { process.exit(1); }
-          "
-
-      - name: Compress Artifact
-        run: |
-          mkdir -p resolc-wasm32-unknown-emscripten
-          mv ./target/wasm32-unknown-emscripten/release/resolc.js ./resolc-wasm32-unknown-emscripten/
-          mv ./target/wasm32-unknown-emscripten/release/resolc.wasm ./resolc-wasm32-unknown-emscripten/
-          mv ./target/wasm32-unknown-emscripten/release/resolc_web.js ./resolc-wasm32-unknown-emscripten/
-
-      - name: Upload artifacts (Release)
-        if: ${{ inputs.is_release }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: resolc-wasm32-unknown-emscripten
-          path: resolc-wasm32-unknown-emscripten/*
-          retention-days: ${{ inputs.retention_days }}
-
-      # There is no way to upload several files as several artifacts with a single upload-artifact step
-      # It's needed to have resolc_web.js separately for night builds for resolc-bin repo
-      # https://github.com/actions/upload-artifact/issues/331
-      - name: Upload artifact resolc.js (Nightly)
-        if: ${{ !inputs.is_release }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: resolc.js
-          path: resolc-wasm32-unknown-emscripten/resolc.js
-          retention-days: ${{ inputs.retention_days }}
-
-      - name: Upload artifacts resolc.wasm (Nightly)
-        if: ${{ !inputs.is_release }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: resolc.wasm
-          path: resolc-wasm32-unknown-emscripten/resolc.wasm
-          retention-days: ${{ inputs.retention_days }}
-
-      - name: Upload artifacts resolc_web.js (Nightly)
-        if: ${{ !inputs.is_release }}
-        uses: actions/upload-artifact@v4
-        id: artifact-upload-step
-        with:
-          name: resolc_web.js
-          path: resolc-wasm32-unknown-emscripten/resolc_web.js
-          retention-days: ${{ inputs.retention_days }}
-
-      - name: Set output variables
-        if: ${{ !inputs.is_release }}
-        id: set-output
-        env:
-          TARGET: resolc_web_js
-        run: |
-          echo "${TARGET}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}" >> "$GITHUB_OUTPUT"
-          echo "${TARGET}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}" >> "$GITHUB_OUTPUT"

.github/workflows/test-llvm-builder.yml

@@ -4,6 +4,7 @@ on:
     branches: ["main"]
     types: [opened, synchronize]
     paths:
+      - 'LLVM.lock'
       - 'crates/llvm-builder/**'
       - '.github/workflows/test-llvm-builder.yml'
 
@@ -18,12 +19,10 @@ jobs:
   test:
     strategy:
       matrix:
-        runner: [parity-large, macos-15, windows-2022]
+        runner: [parity-large, macos-14, windows-2022]
     runs-on: ${{ matrix.runner }}
     steps:
       - uses: actions/checkout@v4
-        with:
-          submodules: true
       - uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
           # without this it will override our rust flags
@@ -36,7 +35,7 @@ jobs:
           sudo apt update && sudo apt-get install -y cmake ninja-build curl git libssl-dev pkg-config clang lld musl
 
       - name: Install Dependencies
-        if: matrix.runner == 'macos-15'
+        if: matrix.runner == 'macos-14'
         run: |
           brew install ninja
 

.github/workflows/test-wasm.yml

@@ -2,13 +2,9 @@ name: Test Wasm Version
 on:
   push:
     branches: ["main"]
-    paths-ignore:
-      - "**.md"
   pull_request:
     branches: ["main"]
     types: [opened, synchronize]
-    paths-ignore:
-      - "**.md"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -68,7 +64,7 @@ jobs:
     needs: build
     strategy:
       matrix:
-        os: ["ubuntu-24.04", "macos-15", "windows-2022"]
+        os: ["ubuntu-24.04", "macos-14", "windows-2022"]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4

.github/workflows/test.yml

@@ -2,13 +2,9 @@ name: Test
 on:
   push:
     branches: ["main"]
-    paths-ignore:
-      - "**.md"
   pull_request:
     branches: ["main"]
     types: [opened, synchronize]
-    paths-ignore:
-      - "**.md"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -26,7 +22,6 @@ jobs:
         with:
           # without this it will override our rust flags
           rustflags: ""
-          components: rustfmt, clippy
 
       - name: Install Solc
         uses: ./.github/actions/get-solc
@@ -58,5 +53,5 @@ jobs:
       - name: Test cargo workspace
         run: make test-workspace
 
-      - name: Test docs
+      - name: Test CLI
-        run: make doc
+        run: make test-cli

.gitignore

@@ -3,15 +3,12 @@
 target-llvm
 *.dot
 .vscode/
-.zed/
 .DS_Store
 /*.sol
 /*.yul
 /*.ll
 /*.s
-/llvm-*
+/llvm*
-# Allow llvm submodule directory
-!/llvm
 node_modules
 artifacts
 tmp
@@ -22,4 +19,3 @@ test-results
 playwright-report
 .cache
 emsdk
-docs-tmp

.gitmodules

@@ -1,4 +0,0 @@
-[submodule "llvm"]
-	path = llvm
-	url = https://github.com/llvm/llvm-project.git
-	branch = release/18.x

.ignore

@@ -1,3 +0,0 @@
-# This is no longer in .gitignore; we add it here (honored by tools like rg and fd).
-llvm/
-docs/

CHANGELOG.md

@@ -4,76 +4,20 @@
 
 This is a development pre-release.
 
-Supported `polkadot-sdk` rev: `unstable2507`
-
-### Added
-- The comprehensive revive compiler book documentation page: https://paritytech.github.io/revive/
-- Support for solc v0.8.31.
-- Support for the `clz` Yul builtin.
-
-### Changed
-- Instruct the LLVM backend and linker to `--relax` (may lead to smaller contract code size).
-- Standard JSON mode: Don't forward EVM bytecode related output selections to solc.
-- The supported `polkadot-sdk` release is `unstable2507`.
-- The `INVALID` opcode and OOB memory accesses now consume all remaining gas.
-- Emit the `call_evm` and `delegate_call_evm` syscalls for contract calls.
-
-### Fixed:
-- The missing `STOP` instruction at the end of `code` blocks.
-- The missing bounds check in the internal sbrk implementation.
-- The call gas is no longer ignored.
-
-## v0.5.0
-
-This is a development pre-release.
-
-Supported `polkadot-sdk` rev: `2509.0.0`
-
-### Added
-- Support for `SELFDESTRUCT`.
-
-### Changed
-- Emulated EVM heap memory accesses of zero length are never out of bounds.
-- Switched to newer and cheaper storage syscalls (omits reads and writes of `0` values).
-
-### Fixed
-- Introduced a workaround avoiding compiler crashes caused by a bug in LLVM affecting `SDIV`.
-- An off-by-one bug affecting `SDIV` overflow semantics.
-
-## v0.4.1
-
-This is a development pre-release.
-
 Supported `polkadot-sdk` rev: `2503.0.1`
 
-### Changed
-- The `ast` output is no longer pruned in standard JSON mode (required for foundry).
-- Support `standard_json.output_selection` to also look at per file settings.
-
 ## v0.4.0
 
 This is a development pre-release.
 
 Supported `polkadot-sdk` rev: `2503.0.1`
 
-### Changed
-- Remove the broken `--llvm-ir` mode.
-- Remove the unused fallback for size optimization setting.
-- Unlinked contract binaries are emitted as raw ELF objects.
-
 ### Added
 - Line debug information per YUL builtin and for `if` statements.
-- Column numbers in debug information.
 - Support for the YUL optimizer details in the standard json input definition.
-- The `revive-explorer` compiler utility.
-- `revive-yul`: The AST visitor interface.
-- The `--link` deploy time linking mode.
 
 ### Fixed
 - The debug info source file matches the YUL path in `--debug-output-dir`, allowing tools to display the source line. 
-- Incosistent type forwarding in JSON output (empty string vs. null object).
-- The solc automatic import resolution.
-- Compiler panic on missing libraries definition.
 
 ## v0.3.0
 

Cargo.toml

@@ -14,69 +14,67 @@ repository = "https://github.com/paritytech/revive"
 rust-version = "1.85.0"
 
 [workspace.dependencies]
-lld-sys = { version = "0.1.0", path = "crates/lld-sys" }
+resolc = { version = "0.3.0", path = "crates/resolc" }
-resolc = { version = "0.5.0", path = "crates/resolc", default-features = false }
 revive-benchmarks = { version = "0.1.0", path = "crates/benchmarks" }
-revive-build-utils = { version = "0.2.0", path = "crates/build-utils" }
 revive-builtins = { version = "0.1.0", path = "crates/builtins" }
-revive-common = { version = "0.2.1", path = "crates/common" }
+revive-common = { version = "0.1.0", path = "crates/common" }
-revive-differential = { version = "0.2.0", path = "crates/differential" }
+revive-differential = { version = "0.1.0", path = "crates/differential" }
-revive-explorer = { version = "0.1.0", path = "crates/explore" }
+revive-integration = { version = "0.1.1", path = "crates/integration" }
-revive-integration = { version = "0.3.0", path = "crates/integration" }
+revive-linker = { version = "0.1.0", path = "crates/linker" }
-revive-linker = { version = "0.2.0", path = "crates/linker" }
+lld-sys = { version = "0.1.0", path = "crates/lld-sys" }
-revive-llvm-context = { version = "0.5.0", path = "crates/llvm-context" }
+revive-llvm-context = { version = "0.3.0", path = "crates/llvm-context" }
-revive-runner = { version = "0.3.0", path = "crates/runner" }
+revive-runtime-api = { version = "0.2.0", path = "crates/runtime-api" }
-revive-runtime-api = { version = "0.4.0", path = "crates/runtime-api" }
+revive-runner = { version = "0.1.0", path = "crates/runner" }
-revive-solc-json-interface = { version = "0.4.0", path = "crates/solc-json-interface", default-features = false }
+revive-solc-json-interface = { version = "0.2.0", path = "crates/solc-json-interface" }
-revive-stdlib = { version = "0.2.0", path = "crates/stdlib" }
+revive-stdlib = { version = "0.1.1", path = "crates/stdlib" }
-revive-yul = { version = "0.4.0", path = "crates/yul" }
+revive-build-utils = { version = "0.1.0", path = "crates/build-utils" }
+revive-yul = { version = "0.2.1", path = "crates/yul" }
 
 hex = "0.4.3"
 cc = "1.2"
 libc = "0.2.172"
-tempfile = "3.23"
+tempfile = "3.20"
 anyhow = "1.0"
 semver = { version = "1.0", features = ["serde"] }
 itertools = "0.14"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = { version = "1.0", features = ["arbitrary_precision"] }
-regex = "1.12"
+regex = "1.11"
 once_cell = "1.21"
 num = "0.4.3"
 sha1 = "0.10"
 sha3 = "0.10"
 thiserror = "2.0"
-which = "8.0"
+which = "7.0"
 path-slash = "0.2"
-rayon = "1.11"
+rayon = "1.10"
 clap = { version = "4", default-features = false, features = ["derive"] }
-polkavm-common = "0.30.0"
+polkavm-common = "0.24.0"
-polkavm-linker = "0.30.0"
+polkavm-linker = "0.24.0"
-polkavm-disassembler = "0.30.0"
+polkavm-disassembler = "0.24.0"
-polkavm = "0.30.0"
+polkavm = "0.24.0"
-alloy-primitives = { version = "1.4", features = ["serde"] }
+alloy-primitives = { version = "1.1", features = ["serde"] }
-alloy-sol-types = "1.4"
+alloy-sol-types = "1.1"
-alloy-genesis = "1.1.2"
+alloy-genesis = "1.0"
-alloy-serde = "1.1"
+alloy-serde = "1.0"
 env_logger = { version = "0.11.8", default-features = false }
-serde_stacker = "0.1.14"
+serde_stacker = "0.1.12"
-criterion = { version = "0.7", features = ["html_reports"] }
+criterion = { version = "0.6", features = ["html_reports"] }
-log = { version = "0.4.28" }
+log = { version = "0.4.27" }
 git2 = { version = "0.20.2", default-features = false }
 downloader = "0.2.8"
 flate2 = "1.1"
 fs_extra = "1.3"
 num_cpus = "1"
 tar = "0.4"
-toml = "0.9"
+toml = "0.8"
-assert_cmd = "2"
+assert_cmd = "2.0"
 assert_fs = "1.1"
-normpath = "1.5"
 
 # polkadot-sdk and friends
 codec = { version = "3.7.5", default-features = false, package = "parity-scale-codec" }
 scale-info = { version = "2.11.6", default-features = false }
-polkadot-sdk = { version = "=2507.4.0" }
+polkadot-sdk = { version = "2503.0.1" }
 
 # llvm
 [workspace.dependencies.inkwell]

LLVM.lock

@@ -0,0 +1,3 @@
+url = "https://github.com/llvm/llvm-project.git"
+branch = "release/18.x"
+ref = "3b5b5c1ec4a3095ab096dd780e84d7ab81f3d7ff"

Makefile

@@ -6,25 +6,19 @@
 	install-llvm-builder \
 	install-llvm \
 	install-revive-runner \
-	install-revive-explorer \
 	format \
 	clippy \
-	doc \
-	book \
 	machete \
 	test \
 	test-integration \
 	test-resolc \
-	test-yul \
 	test-workspace \
+	test-cli \
 	test-wasm \
-	test-llvm-builder \
+	test-llvm-builder
-	test-book \
 	bench \
 	bench-pvm \
 	bench-evm \
-	bench-resolc \
-	bench-yul \
 	clean
 
 install: install-bin install-npm
@@ -43,44 +37,35 @@ install-llvm-builder:
 	cargo install --force --locked --path crates/llvm-builder
 
 install-llvm: install-llvm-builder
-	git submodule update --init --recursive --depth 1
+	revive-llvm clone
 	revive-llvm build --llvm-projects lld --llvm-projects clang
 
 install-revive-runner:
 	cargo install --locked --force --path crates/runner --no-default-features
 
-install-revive-explorer:
-	cargo install --locked --force --path crates/explorer --no-default-features
-
 format:
 	cargo fmt --all --check
 
 clippy:
 	cargo clippy --all-features --workspace --tests --benches -- --deny warnings
 
-doc:
-	cargo doc --all-features --workspace --document-private-items --no-deps
-
-book: test-book
-	mdbook serve book --open
-
 machete:
 	cargo install cargo-machete
 	cargo machete
 
-test: format clippy machete test-workspace install-revive-runner install-revive-explorer doc test-book
+test: format clippy machete test-cli test-workspace install-revive-runner
 
 test-integration: install-bin
 	cargo test --package revive-integration
 
 test-resolc: install
-	cargo test --package resolc --all-targets
+	cargo test --package resolc
-
-test-yul:
-	cargo test --package revive-yul --all-targets
 
 test-workspace: install
-	cargo test --workspace --all-targets --exclude revive-llvm-builder
+	cargo test --workspace --exclude revive-llvm-builder
+
+test-cli: install
+	npm run test:cli
 
 test-wasm: install-wasm
 	npm run test:wasm
@@ -89,10 +74,6 @@ test-llvm-builder:
 	@echo "warning: the llvm-builder tests will take many hours"
 	cargo test --package revive-llvm-builder -- --test-threads=1
 
-test-book:
-	cargo install mdbook --version 0.5.1 --locked
-	mdbook test book
-
 bench: install-bin
 	cargo criterion --all --all-features --message-format=json \
 	| criterion-table > crates/benchmarks/BENCHMARKS.md
@@ -105,21 +86,10 @@ bench-evm: install-bin
 	cargo criterion --bench execute --features bench-evm --message-format=json \
 	| criterion-table > crates/benchmarks/EVM.md
 
-bench-resolc: test-resolc
-	cargo criterion --package resolc --bench compile --message-format=json \
-	| criterion-table > crates/resolc/BENCHMARKS_M4PRO.md
-
-bench-yul: test-yul
-	cargo criterion --package revive-yul --bench parse --message-format=json \
-	| criterion-table > crates/yul/BENCHMARKS_PARSE_M4PRO.md
-	cargo criterion --package revive-yul --bench lower --message-format=json \
-	| criterion-table > crates/yul/BENCHMARKS_LOWER_M4PRO.md
-
 clean:
 	cargo clean ; \
 	revive-llvm clean ; \
 	rm -rf node_modules ; \
-	rm -rf crates/resolc/src/tests/cli/artifacts ; \
+	rm -rf crates/resolc/src/tests/cli-tests/artifacts ; \
 	cargo uninstall resolc ; \
 	cargo uninstall revive-llvm-builder ;
-	mdbook clean book

README.md

@@ -1,11 +1,11 @@
 ![CI](https://github.com/paritytech/revive/actions/workflows/test.yml/badge.svg)
-[![Docs](https://img.shields.io/badge/paritytech.github.io/revive-brightgreen.svg)](https://paritytech.github.io/revive/)
+[![Docs](https://img.shields.io/badge/Docs-contracts.polkadot.io-brightgreen.svg)](https://contracts.polkadot.io/revive_compiler/)
 
 # revive
 
-Yul recompiler to LLVM, targetting RISC-V on [PolkaVM](https://github.com/koute/polkavm).
+YUL recompiler to LLVM, targetting RISC-V on [PolkaVM](https://github.com/koute/polkavm).
 
-Check the [docs](https://paritytech.github.io/revive/) or visit [contracts.polkadot.io](https://docs.polkadot.com/develop/smart-contracts/) to learn more about `revive` and contracts on Polkadot!
+Visit [contracts.polkadot.io](https://contracts.polkadot.io) to learn more about contracts on Polkadot!
 
 ## Status
 
@@ -14,13 +14,11 @@ This is experimental software in active development and not ready just yet for p
 Discussion around the development is hosted on the [Polkadot Forum](https://forum.polkadot.network/t/contracts-update-solidity-on-polkavm/6949#a-new-solidity-compiler-1).
 
 ## Installation
-
 Building Solidity contracts for PolkaVM requires installing the following two compilers:
-- `resolc`: The revive Solidity compiler Yul frontend and PolkaVM code generator (provided by this repository).
+- `resolc`: The revive Solidity compiler YUL frontend and PolkaVM code generator (provided by this repository).
 - `solc`: The [Ethereum Solidity reference compiler](https://github.com/ethereum/solidity/) implemenation.`resolc` uses `solc` during the compilation process, please refer to the [Ethereum Solidity documentation](https://docs.soliditylang.org/en/latest/installing-solidity.html) for installation instructions.
 
 ### `resolc` binary releases
-
 `resolc` is distributed as a standalone binary (with `solc` as the only external dependency). Please download one of our [binary releases](https://github.com/paritytech/revive/releases) for your target platform and mind the platform specific instructions below.
 
 <details>
@@ -46,7 +44,6 @@ Building Solidity contracts for PolkaVM requires installing the following two co
 
 
 ### `resolc` NPM package
-
 We distribute the revive compiler as [node.js module](https://www.npmjs.com/package/@parity/resolc) and [hardhat plugin](https://www.npmjs.com/package/@parity/hardhat-polkadot-resolc).
 
 Note: The `solc` dependency is bundled via NPM packaging and defaults to the latest supported version.
@@ -79,7 +76,9 @@ export LLVM_SYS_181_PREFIX=</path/to/the/extracted/archive>/target-llvm/gnu/targ
 <details>
   <summary>Building from source</summary>
 
-The `Makefile` provides a shortcut target to obtain a compatible LLVM build, using the provided [revive-llvm](crates/llvm-builder/README.md) utility. Once installed, point `$LLVM_SYS_181_PREFIX` to the installation afterwards:
+ Use the provided [revive-llvm](crates/llvm-builder/README.md) utility to compile a compatible LLVM build locally and point `$LLVM_SYS_181_PREFIX` to the installation afterwards.
+
+The `Makefile` provides a shortcut target to obtain a compatible LLVM build:
 
 ```sh
 make install-llvm
@@ -99,10 +98,47 @@ make install-bin
 resolc --version
 ```
 
+### Cross-compilation to Wasm
+
+Cross-compile the `resolc.js` frontend executable to Wasm for running it in a Node.js or browser environment. The `REVIVE_LLVM_TARGET_PREFIX` environment variable is used to control the target environment LLVM dependency.
+
+<details>
+  <summary>Instructions for cross-compilation to wasm32-unknown-emscripten</summary>
+
+```sh
+# Build the host LLVM dependency with PolkaVM target support
+make install-llvm
+export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final
+
+# Build the target LLVM dependency with PolkaVM target support
+revive-llvm --target-env emscripten clone
+source emsdk/emsdk_env.sh
+revive-llvm --target-env emscripten build --llvm-projects lld
+export REVIVE_LLVM_TARGET_PREFIX=${PWD}/target-llvm/emscripten/target-final
+
+# Build the resolc frontend executable
+make install-wasm
+make test-wasm
+```
+
+</details>
+
 ## Development
 
-Please consult the [Developer Guide](https://paritytech.github.io/revive/developer_guide/contributing.html) to learn more about how contribute to the project.
+Please consult the [Makefile](Makefile) targets to learn how to run tests and benchmarks. 
+Ensure that your branch passes `make test` locally when submitting a pull request.
 
+### Design overview
+See the [relevant section in our documentation](https://contracts.polkadot.io/revive_compiler/architecture) to learn more about how the compiler works. 
+
+### Tests
+
+Before running the tests, ensure that Geth (Go Ethereum) is installed on your system. Follow the installation guide here: [Installing Geth](https://geth.ethereum.org/docs/getting-started/installing-geth).
+Once Geth is installed, you can run the tests using the following command:
+
+```sh
+make test
+```
 # Acknowledgements
 
 The revive compiler project, after some early experiments with EVM bytecode translations, decided to fork the `era-compiler` framework.

book/.gitignore

@@ -1 +0,0 @@
-book

book/book.toml

@@ -1,7 +0,0 @@
-[book]
-title = "revive compiler book"
-authors = ["xermicus"]
-language = "en"
-
-[build]
-build-dir = "../docs"

book/src/SUMMARY.md

@@ -1,21 +0,0 @@
-# Summary
-
-- [Welcome](./welcome.md)
-- [`resolc` user guide](./user_guide.md)
-  - [Installation](./user_guide/installation.md)
-  - [Command Line Interface](./user_guide/cli.md)
-  - [JS NPM package](./user_guide/js.md)
-  - [Tooling integration](./user_guide/tooling.md)
-  - [Standard JSON interface](./user_guide/std_json.md)
-  - [Differences to EVM](./user_guide/differences.md)
-  - [Rust contract libraries](./user_guide/rust_libraries.md)
-- [`revive-runner` sandbox](./revive_runner.md)
-- [Developer Guide](./developer_guide.md)
-  - [Contributor guide](./developer_guide/contributing.md)
-  - [Compiler architecture](./developer_guide/architecture.md)
-  - [PVM and the pallet-revive runtime target](./developer_guide/target.md)
-  - [Testing strategy](./developer_guide/testing.md)
-  - [Cross compilation](./developer_guide/cross_compilation.md)
-- [FAQ](./faq.md)
-- [Roadmap and Vision](./roadmap.md)
-

book/src/developer_guide.md

@@ -1,4 +0,0 @@
-# Developer guide
-
-This chapter covers internal aspects of the compiler and helps contributors getting started with the `revive` codebase.
-

book/src/developer_guide/architecture.md

@@ -1,55 +0,0 @@
-# Compiler architecture and internals
-
-`revive` relies on `solc`, the [Ethereum Solidity compiler](https://github.com/argotorg/solidity), as the Solidity frontend to process smart contracts written in Solidity. [LLVM](https://github.com/llvm/llvm-project), a popular and powerful compiler framework, is used as the compiler backend and does the heavy lifting in terms of optimizitations and RISC-V code generation.
-
-`revive` mainly takes care of lowering the Yul intermediate representation (IR) produced by `solc` to LLVM IR. This approach provides a good balance between maintaining a high level of Ethereum compatibility, good contract performance and feasible engineering efforts.
-
-## `resolc`
-
-`resolc` is the overarching compiler driver library and binary.
-
-When compiling a Solidity source file with `resolc`, the following steps happen under the hood:
-1. `solc` is used to lower the Solidity source code into [YUL intermediate representation](https://docs.soliditylang.org/en/latest/yul.html).
-2. `revive` lowers the YUL IR into LLVM IR.
-3. LLVM optimizes the code and emits a RISC-V ELF shared object (through LLD).
-4. The [PolkaVM](https://github.com/paritytech/polkavm) linker finally links the ELF shared object into a PolkaVM blob.
-
-This compilation process can be visualized as follows:
-
-![Architecture Overview](images/resolc.svg)
-
-## Reproducible contract builds
-
-Because on-chain contract code is identified via its code blob hash, it is crucial to maintain reproducible contract builds. A given compiler version must reproduce the contract build _exactly_ on every target platform `resolc` supports via the official binary releases.
-
-To ensure this, we employ the following measures:
-- The code generation must be fully deterministic. For example iterating over standard `HashMap` invalidates this due to its internal state, making it an invalid operation in `revive`. To circumvent that, a `BTreeMap` can be used instead.
-- We release fully statically linked `resolc` binaries. This prevents dynamic linking of potentially differentiating libraries.
-- The only non-bundled dependency is the `solc` compiler. This is considered fine because the same properties apply to `solc`.
-
-## The `revive` compiler libraries
-
-The main compiler logic is implemented in the `revive-yul` and `revive-llvm-context` crates.
-
-The Yul library implements a lexer and parser and lowers the resulting tree into LLVM IR. It does so by emitting LL using the LLVM builder and our own `revive-llvm-context` compiler context crate. The revive LLVM context crate encapsulates code generation logic (decoupled from the parser).
-
-The Yul library also implements a simple [visitor](https://en.wikipedia.org/wiki/Visitor_pattern) interface (see [visitor.rs](https://github.com/paritytech/revive/blob/main/crates/yul/src/visitor.rs)). If you want to work with the AST, it is strongly recommended to implement visitors. The LLVM code generation is implemented using a dedicated trait for historical reasons only.
-
-## EVM heap memory
-
-PVM doesn't offer a similar API. Hence the emitted contract code emulates the linear EVM heap memory using a static byte buffer. Data inside this byte buffer is kept big endian for EVM compatibility reasons (unaligned access is allowed and makes optimizing this non-trivial).
-
-Unlike with the EVM, where heap memory usage is gas metered, our heap size is static (the size is user controllable via a setting flag). The compiler emits bound checks to prevent overflows.
-
-## The LLVM dependency
-
-LLVM is a special non Rust dependency. We interface its builder interface via the [inkwell](https://crates.io/crates/inkwell) wrapper crate.
-
-We use upstream LLVM, but release and use our custom builds. We require the compiler builtins specifically built for the PVM `rv64emacb` target and always leave assertions on. Furthermore, we need cross builds because `resolc` itself targets emscripten and musl. The [revive-llvm-builer](https://crates.io/crates/revive-llvm-builder) functions as a cross-platform build script and is used to build and release the LLVM dependency.
-
-We also maintain the [lld-sys crate](https://crates.io/crates/lld-sys) for interfacing with `LLD`. The LLVM linker is used during the compilation process, but we don't want to distribute another binary.
-
-
-## Custom optimizations
-
-At the moment, no significant custom optimizations are implemented. Thus, we are missing some optimization opportunities that neither `solc` nor LLVM can realize (due to their lack of domain specific knowledge about the semantics of our target environment). Furthermore, `solc` optimizes for EVM gas and a target machine orthogonal to our target (BE 256-bit stack machine EVM vs. 64-bit LE RISC architecture PVM). We have started working on an additional IR layer between Yul and LLVM to capture missed optimization opportunities, though.

book/src/developer_guide/contributing.md

@@ -1,65 +0,0 @@
-# Contributor guide
-
-The `revive` compiler is an open source software project and we gladly accept quality contributions from anyone!
-
-## Getting started
-
-A quick reference on how to build the Solidity compiler is maintained in the project's [README.md](https://github.com/paritytech/revive?tab=readme-ov-file#building-from-source).
-
-### Using the `Makefile`
-
-The [Makefile](https://github.com/paritytech/revive/blob/main/Makefile) comprehensively encapsulates all development aspects of this codebase. It is kept concise and readable. Please read and use it! You'll learn for example:
-
-- How to build and install a `resolc` development version.
-- How to run tests and benchmarks.
-- How to cross-compile `resolc`.
-
-As a general rule-of-thumb: If `make test` runs fine locally, chances for green CI pipelines are good.
-
-### Codebase organization
-
-For the most parts, `revive` is a rather standard Rust workspace codebase. There are some non-Rust dependencies, which sometimes complicates things a little bit.
-
-#### The `crates/` dir
-
-All Rust crates live under the `crates/` directory. The workspace automatically considers any crate found therein. If you need to add a new create, please implement it there.
-
-Compiler library crates should be named with the `revive-` prefix. The crate location doesn't need the prefix.
-
-#### Dependencies
-
-Dependencies should be added as workspace dependencies. Try to avoid pinning dependencies whenever possible. If possible, add dev dependencies as `dev-dependencies` only.
-
-Please do always include the `Cargo.lock` dependency lock file with your PR. Please don't run `cargo update` together with other changes (it is preferred to update the lock file in a dedicated dependency update PR).
-
-## Contribution rules
-
-1. Changes must be submitted via a pull request (PR) to the github upstream repository.
-2. Ensure that your branch passes `make test` locally when submitting a pull request.
-3. A PR must not be merged until CI fully passes. Exceptions can be made (for example to fix CI issues itself).
-4. No force pushes to the `main` branch and open PR branches.
-5. Maintainers can request changes or deny contributions at their own discretion.
-
-## Style guide
-
-We require the official Rust formatter and clippy linter. In addition to that, please also consider the following best-effort aspects:
-
-- Avoid [magic numbers](https://en.wikipedia.org/wiki/Magic_number_(programming)) and strings. Instead, add them as module constants.
-- Avoid abbreviated variable and function names. Always provide meaningful and readable symbols.
-- Don't write macros and don't use third party macros for things that can easily be expressed in few lines of code or outlined into functions.
-- Avoid import aliasing. Please use the parent or fully qualified path for conflicting symbols.
-- Any inline comments must provide additional semantic meaning, explain counter-intuitive behavior or highlight non-obvious design decisions. In other words, try to make the code expressive enough to a degree it doesn't need comments expressing the same thing again in the English language. Delete such comments if your AI assistant generated them.
-- Public items must have a meaningful doc comment.
-- Provide meaningful panic messages to `.expect()` or just use `.unwrap()`.
-
-## AI policy
-
-Contributors may use whatever AI assistance tools they wish to whatever degree they wish in the process of creating their contribution, __given they acknowledge the following__:
-
-_Project maintainers may reject any contribution (or portions of it) if the contribution shows signs of problematic involvement of generative AI_.
-
-Judgement of "problematic involvement" lies at the sole discretion of project maintainers. No proof (whether a contribution was in fact AI generated or not) is required. Rationale:
-
-- No one enjoys reading soulless and uncanny LLM slop. Please review and fix any AI slop yourself prior to submitting a PR.
-- A Solidity compiler is security sensitive software. Even miniscule mistakes can ultimately lead to loss of funds. AI models are inherently stochastic. They regurarly fail to capture important nuances or produce straight hallucinations. Code that was "blindly" generated has no home here.
-- `revive` is a large codebase. Generative AI assistants may not have enough "context window" to sufficiently capture correctness, consistency and style aspects of the codebase. We'd like to keep this codebase maintainable _by humans_ for the forseeable future.

book/src/developer_guide/cross_compilation.md

@@ -1,30 +0,0 @@
-# Cross compilation
-
-We cross-compile the `resolc.js` frontend executable to Wasm for running it in a Node.js or browser environment.
-
-The [musl](https://www.musl-libc.org/) target is used to obtain statically linked ELF binaries for Linux.
-
-## Wasm via emscripten
-
-The `REVIVE_LLVM_TARGET_PREFIX` environment variable is used to control the target environment LLVM dependency. This requires a compatible LLVM build, obtainable via the `revive-llvm` build script. Example:
-
-```sh
-# Build the host LLVM dependency with PolkaVM target support
-make install-llvm
-export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final
-
-# Build the target LLVM dependency with PolkaVM target support
-revive-llvm emsdk
-source emsdk/emsdk_env.sh
-revive-llvm --target-env emscripten build --llvm-projects lld
-export REVIVE_LLVM_TARGET_PREFIX=${PWD}/target-llvm/emscripten/target-final
-
-# Build the resolc frontend executable
-make install-wasm
-make test-wasm
-```
-
-## musl libc
-
-[rust-musl-cross](https://github.com/rust-cross/rust-musl-cross) is a straightforward way to cross compile Rust to musl. The [Dockerfile](https://github.com/paritytech/revive/blob/main/Dockerfile) is an executable example of how to do that. 
-

book/src/developer_guide/target.md

@@ -1,29 +0,0 @@
-# PVM and the pallet-revive runtime target
-
-The `revive` compiler targets [PolkaVM (PVM)](https://github.com/paritytech/polkavm) via [pallet-revive](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/revive) on Polkadot.
-
-## Target CPU configuration
-
-The exact target CPU configuration can be found [here](https://github.com/paritytech/revive/blob/8cd10a613625428956eb33c39c9022a91bfbf103/crates/llvm-context/src/target_machine/mod.rs#L22-L32).
-
-> [!NOTE]
->
-> The PVM linker requires fully relocatable ELF objects.
-
-## Why PVM
-
-PVM is a RISC-V based VM designed to overcome the flaws of [WebAssebmly (Wasm)](https://webassembly.org/). Wasm was believed to be a more efficient successor to the rather slow EVM. However, Wasm is far from an ideal target for smart contracts as some of its design decisions are unfavorable for short-lived workloads. The main problem is on-chain Wasm bytecode compilation or interpretation overhead. Prior benchmarks consistently ignoring this overhead seeded the blockchain industry with flawed assumptions: _Only when ignoring the startup overhead_ Wasm is much faster than the slow computing EVM. In practice however, gains are nullified entirely and Wasm loses completely even against very slow VMs like the EVM. Executing Wasm contracts is in fact so inefficient that typical contract workloads are _orders of magnitude_ more expensive than the equivalent EVM variant.
-
-On the other hand, since RISC-V is similar to CPUs found in validator hardware (x86 and ARM), bytecode translation mostly boils down to a linear mapping from one instruction to another. The _embedded_ ISA specification reduces the number of general purpose registers, in turn removing the need for expensive register allocation. This guarantees single-pass `O(n)` JIT compilation of contract bytecode. The close proximity of PVM bytecode with actual validator CPU bytecode effectively allows to move all expensive compilation workload off-chain. Benchmarks ([1](https://hackmd.io/@XXX9CM1uSSCWVNFRYaSB5g/HJarTUhJA#Results-execute), [2](https://github.com/paritytech/polkavm/blob/master/BENCHMARKS.md)) show that with the PVM JIT, sandboxed PVM code executes at around half the speed of native code, which falls into the same ballpark of the state-of-the-art `wasmtime` Wasm implementation (while EVM sits somewhere around 1/10 to less than 1/100 of native speed). However, the PVM JIT compiler only uses a fraction of the time `wasmtime` requires to compile the code.
-
-> [!NOTE]
->
-> The PVM JIT isn't available yet in `pallet-revive`. At the time of writing, the contract code is interpreted, which is orders of magnitude slower than the JIT.
-
-## Host environment: `pallet-revive`
-
-The `revive` compiler targets the [`pallet-revive` runtime environment](https://docs.rs/pallet-revive/).
-
-`pallet-revive` exposes a [syscall like interface](https://docs.rs/pallet-revive/latest/pallet_revive/trait.SyscallDoc.html) for contract interactions with the host environment. This is provided by the [revive-runtime-api](https://crates.io/crates/revive-runtime-api) library. 
-
-After the initial launch on the Polkadot Asset Hub blockchain, the runtime API is considered stable and backwards compatible indefinitively.

book/src/developer_guide/testing.md

@@ -1,67 +0,0 @@
-# Testing strategy
-
-Contributors are encouraged to implement some appropriate unit and integration tests together with any bug fixes or new feature implementations. However, when it comes to testing the code generation logic, our testing strategy goes way beyond simple unit and integration tests. This chapter explains how the `revive` compiler implementation is tested for correctness and how we define correctness.
-
-> [!TIP]
->
-> Running the integration tests require the `evm` tool from `go-ethereum` in your `$PATH`.
->
-> Either install it using your package manager or to build it from source:
-> ```bash
-> git clone https://github.com/ethereum/go-ethereum/
-> cd go-ethereum
-> make all
-> export PATH=/path/to/go-ethereum/build/bin/:$PATH
-> ```
-
-## Bug compatibility with Ethereum Solidity
-
-As a Solidity compiler, we aim to preserve contract code semantics as close as possible to Solidity compiled to EVM with the `solc` reference implementation. As highlighted in the user guide, due to the underlying target difference, this isn't always possible. However, wherever it is possible, we follow the philosophy of [**bug compatibility**](https://en.wikipedia.org/wiki/Bug_compatibility) with the Ethereum contracts stack.
-
-## Differential integration tests
-
-A high level of bug compatibility with Ethereum is ensured through [**differential testing**](https://en.wikipedia.org/wiki/Differential_testing) with the Ethereum `solc` and EVM contracts stack. The [revive-integration](https://crates.io/crates/revive-integration) library is the central integration test utility, providing a set of Solidity integration test cases. Further, it implements differential tests against the reference implementation by combining the [revive-runner](https://crates.io/crates/revive-runner) sandbox, the [go-ethereum EVM tool](https://github.com/ethereum/go-ethereum/tree/master/cmd/evm) and the [revive-differential](https://crates.io/crates/revive-differential).
-  
-The `revive-runner` library provides a [**declarative**](https://en.wikipedia.org/wiki/Declarative_programming) test [specification format](https://github.com/paritytech/revive/blob/main/crates/runner/src/specs.rs). This vastly simplifies writing differential test cases and removes a lot of room for errors in test logic. Example:
-
-```json
-{
-    "differential": true,
-    "actions": [
-        {
-            "Instantiate": {
-                "code": {
-                    "Solidity": {
-                        "contract": "Bitwise"
-                    }
-                }
-            }
-        },
-        {
-            "Call": {
-                "dest": {
-                    "Instantiated": 0
-                },
-                "data": "3fa4f245"
-            }
-        }
-    ]
-}
-```
-
-Above example instantiates the `Bitwise` contract and calls it with some defined calldata. The `revive-runner` library implements a helper wrapper to execute test specs on the go-ethereum standalone `evm` tool. This allows the `revive-runner` to execute specs against the EVM and the `pallet-revive` runtime. Key to differential testing is setting `"differential": true`, resulting in the following:
-
-1. The `Bitwise` contract is compiled to EVM and PVM code.
-2. The runner executes the defined `actions` on the EVM and collects all state changes (storage, balance) and execution results.
-3. The runner executes each action on the PVM. Observed state changes _after each step_ as well as the final execution result is asserted to  match the EVM counterparts __exactly__.
-
-__Note how we never defined any expected outcome manually.__ Instead, we simply observe and collect the data defining the "correct" outcome.
-
-Differential testing in combination with declarative test specifications proved to be simple, yet very effective, in ensuring expected Ethereum Solidity semantics on `pallet-revive`.
-
-## The differential testing utility
-
-A lot of nuanced bugs caused by tiny implementation details inside the `revive` compiler _and_ the `pallet-revive` runtime could be identified and eliminated early on thanks to the differential testing strategy. Thus, we decided to take this approach further and created a comprehensive test runner and a large suite of more complex test cases.
-
-The [Revive Differential Tests](https://github.com/paritytech/revive-differential-tests/) follow the exact same strategy but implement a much more powerful test spec format, spec runner and reports. This allows differentially testing much more complex test cases (for example testing Uniswap pair creations and swaps), executed via transactions sent to actual blockchain nodes.
-

book/src/faq.md

@@ -1,28 +0,0 @@
-# FAQ
-
-## What EVM version do you support?
-
-We neither do nor don't support any EVM version. We support Solidity versions, starting from `solc` version 0.8.0 onwards.
-
-## Is inline assembly supported
-
-Yes, almost all inline assembly features are supported ([see the differences in Yul translation chapter](user_guide/differences.md)).
-
-## Do you support opcode `XY`?
-
-See above, the same applies.
-
-## In what Solidity version should I write my dApp?
-
-We generally recommend to always use the latest supported version to profit from latest bugfixes, features and performance improvements.
-
-Find out about the latest supported version by running `resolc --supported-solc-versions` or checking [here](https://github.com/paritytech/resolc-bin).
-
-## Tool `XY` says the contract size is larger than 24kb and will fail to deploy?
-
-The 24kb code size restriction only exist for the EVM. Our limit is currently around 1mb and may increase further in the future.
-
-## Is `resolc` a drop-in replacement for `solc`?
-
-No. `resolc` aims to work similarly to `solc`, but it's not considered a drop-in replacement.
-

book/src/revive_runner.md

@@ -1,45 +0,0 @@
-# `revive-runner` sandbox
-
-Running contract code usually requires a blockchain node. While local dev nodes can be used, sometimes it's just not desirable to do so. Instead, it can be much more convenient to run and debug contract code with a stripped down environment.
-
-This is where the `revive-runner` comes in handy. In a nutshell, it is a single-binary no-blockchain `pallet-revive` runtime.
-
-## Installation and usage
-
-Inside the root `revive` repository directory, install it from source (requires Rust installed):
-
-```bash
-make install-revive-runner
-```
-
-After installing, see `revive-runner --help` for usage help.
-
-## Trace logs
-
-The standard `RUST_LOG` environment variable controls the log output from the contract execution. This includes `revive` runtime logs and PVM execution trace logs. Sometimes it's convenient to have more fine granular insight. Some useful filters:
-- `RUST_LOG=runtime=trace`: The `pallet-revive` runtime trace logs.
-- `RUST_LOG=polkavm=trace`: Low level PolkaVM instruction tracing.
-
-## Automatic contract instantiation
-
-To avoid running the constract in an unitialized state, `revive-runner` automatically instantiates the contract before calling it (constructor arguments can be provided).
-
-## Example
-
-Suppose we want to trace the syscalls of the execution of a compiled contract file `Flipper.pvm`:
-
-```bash
-RUST_LOG=runtime=trace revive-runner -f Flipper.pvm
-[DEBUG runtime::revive] Contract memory usage: purgable=6144/3145728 KB baseline=103063/1572864
-[TRACE runtime::revive::strace] call_data_size() = Ok(0) gas_consumed: Weight { ref_time: 985209, proof_size: 0 }
-[TRACE runtime::revive::strace] value_transferred(out_ptr: 4294836096) = Ok(()) gas_consumed: Weight { ref_time: 2937634, proof_size: 0 }
-[TRACE runtime::revive::strace] call_data_copy(out_ptr: 131216, out_len: 0, offset: 0) = Ok(()) gas_consumed: Weight { ref_time: 4084483, proof_size: 0 }
-[TRACE runtime::revive::strace] seal_return(flags: 0, data_ptr: 131216, data_len: 0) = Err(TrapReason::Return(ReturnData { flags: 0, data: [] })) gas_consumed: Weight { ref_time: 5510615, proof_size: 0 }
-[TRACE runtime::revive] frame finished with: Ok(ExecReturnValue { flags: (empty), data: [] })
-[TRACE runtime::revive::strace] call_data_size() = Ok(0) gas_consumed: Weight { ref_time: 985209, proof_size: 0 }
-[TRACE runtime::revive::strace] seal_return(flags: 1, data_ptr: 131088, data_len: 0) = Err(TrapReason::Return(ReturnData { flags: 1, data: [] })) gas_consumed: Weight { ref_time: 2456669, proof_size: 0 }
-[TRACE runtime::revive] frame finished with: Ok(ExecReturnValue { flags: REVERT, data: [] })
-```
-
-
-

book/src/roadmap.md

@@ -1,16 +0,0 @@
-# Roadmap and Vision
-
-The `revive` compiler speeds up Solidity contracts by orders of magnitude. `revive` provides a decisive edge over other contract platforms. Notably, the compiler eliminates the need of rewriting Solidity dApps as single dApp parachains for scaling reasons. Retaining as high compatibility with Ethereum Solidity as possible keeps entry barriers low.
-
-We believe in Dr. Gavin Wood's [ĐApps: What Web 3.0 Looks Like](https://gavwood.com/dappsweb3.html) manifesto and the ecosystem of the Solidity programming language. Our motivation lies in the realization that for a _true_ web3 revolution, significant scaling efforts, like the ones provided by the PVM and this project, are necessary to unfold.
-
-## Roadmap
-
-The first major release, `resolc` v1.0.0, emits functional PVM code from given Solidity sources. It relies on `solc` and LLVM for optimizations. The main priority of this release was delivering a mostly feature complete and safe Solidity v0.8.0 compiler.
-
-Focus for the second major release is on the custom optimization pipeline, which aims to significantly improve emitted code blob sizes.
-
-The below roadmap gives a rough overview of the project's development timeline.
-
-![Roadmap](images/roadmap.svg)
-

book/src/user_guide.md

@@ -1,11 +0,0 @@
-# `resolc` user guide
-
-`resolc` is a Solidity `v0.8` compiler for [Polkadot `native` smart contracts](https://docs.polkadot.com/develop/smart-contracts/overview/#native-smart-contracts). Solidity compiled with `resolc` executes orders of magnitude faster than the EVM. `resolc`  also supports almost all Solidity `v0.8` features including inline assembly, offering a high level of comptability with the Ethereum Solidity reference implementation.
-
-## `revive` vs. `resolc` nomenclature
-
-`revive` is the name of the overarching "Solidity to PolkaVM" compiler project, which contains multiple components (for example the Yul parser, the code generation library, the `resolc` executable itself, and many more things).
-
-`resolc` is the name of the compiler driver executable, combining many `revive` components in a single and easy to use binary application.
-
-In other words, `revive` is the whole compiler infrastructure (more like `LLVM`) and `resolc` is a user-facing single-entrypoint compiler frontend (more like `clang`).

book/src/user_guide/cli.md

@@ -1,113 +0,0 @@
-# CLI usage
-
-We aim to keep the `resolc` CLI usage close to `solc`. There are a few things and options worthwhile to know about in `resolc` which do not exist in the Ethereum world. This chapter explains those in more detail than the CLI help message.
-
-> [!TIP]
->
-> For the complete help about CLI options, please see `resolc --help`.
-
-### LLVM optimization levels
-```bash
--O, --optimization <OPTIMIZATION>
-```
-
-`resolc` exposes the optimization level setting for the LLVM backend. The performance and size of compiled contracts varies wiedly between different optimization levels.
-
-Valid levels are the following:
-- `0`: No optimizations are applied.
-- `1`: Basic optimizations for execution time.
-- `2`: Advanced optimizations for execution time.
-- `3`: Aggressive optimizations for execution time.
-- `s`: Optimize for code size.
-- `z`: Aggressively optimize for code size.
-
-By default, `-Oz` is applied.
-
-### Stack size
-```bash
---stack-size <STACK_SIZE>
-```
-
-PVM is a register machine with a traditional stack memory space for local variables. This controls the total amount of stack space the contract can use.
-          
-You are incentivized to keep this value as small as possible:
-1. Increasing the stack size will increase gas costs due to increased startup costs.
-2. The stack size contributes to the total memory size a contract can use, which includes the contract's code size.
-
-Default value: 32768
-
-> [!WARNING]
->
-> If the contract uses more stack memory than configured, it will compile fine but eventually revert execution at runtime!
-
-### Heap size
-```bash
---heap-size <HEAP_SIZE>
-```
-
-Unlike the EVM, due to the lack of dynamic memory metering, PVM contracts emulate the EVM heap memory with a static buffer. Consequentially, instead of infinite memory with exponentially growing gas costs, PVM contracts have a finite amount of memory with constant gas costs available.
-
-You are incentivized to keep this value as small as possible:
-1.Increasing the heap size will increase startup costs.
-2.The heap size contributes to the total memory size a contract can use, which includes the contract's code size
-
-Default value: 65536
-
-> [!WARNING]
->
-> If the contract uses more heap memory than configured, it will compile fine but eventually revert execution at runtime!
-
-### solc
-```bash
---solc <SOLC>
-```
-
-Specify the path to the `solc` executable. By default, the one in `${PATH}` is used.
-
-### Debug artifacts
-```bash
---debug-output-dir <DEBUG_OUTPUT_DIRECTORY>
-```
-
-Dump all intermediary compiler artifacts to files in the specified directory. This includes the YUL IR, optimized and unoptimized LLVM IR, the ELF object and the PVM assembly. Useful for debugging and development purposes.
-
-### Debug info
-```bash
--g
-```
-Generate source based debug information in the output code file. Useful for debugging and development purposes and disabled by default.
-
-### Deploy time linking
-```bash
---link [--libraries <LIBRARIES>] <INPUT_FILES>
-```
-
-In Solidity, 3 things can happen with libraries:
-
-1. They are not `extern`ally callable and thus can be inlined.
-    1. The solc Solidity optimizer inlines those (usually the case). Note: `resolc` always activates the solc Solidity optimizer.
-    2. If the solc Solidity optimizer is disabled or for some reason fails to inline them (both rare), they are not inlined and require linking.
-2. They are `extern`ally callable but still linked at compile time. This is the case if at compile time the library address is known (i.e. `--libraries` supplied in CLI or the corresponding setting in STD JSON input).
-3. They are linked at deploy time. This happens when the compiler does not know the library address (i.e. `--libraries` flag is missing or the provided libraries are incomplete, same for STD JSON input). This case is rare because it's discourage and should never be used by production dApps.
-
-In cases `1.2` and `3`:
-- Some of the produced code blobs will be in the "unlinked" raw `ELF` object format and not yet deployable.
-- To make them deployable, they need to be "linked" (done using the `resolc --link` linker mode explained below).
-- The compiler emitted `DELEGATECALL` instructions to call non-inlined (unlinked) libraries. The contract deployer must make sure to deploy any libraries prior to contract deployment.
-
-> [!WARNING]
-> 
-> Using deploy time linking is officially **discouraged**. Mainly due to bytecode hashes changing after the fact. We decided to support it in `resolc` regardless, due to popular request.
-
-Similar to how it works in `solc`, `--libraries` may be used to provide libraries during linking mode.
-
-Unlike with `solc`, where linking implies a simple string substitution mechanism, `resolc` needs to resolve actual missing `ELF` symbols. This is due to how factory dependencies work in PVM. As a consequence, it isn't sufficient to just provide the unlinked blobs to the linker. Instead, they must be provided in the exact same directory structure the Solidity source code was found during compile time.
-
-Example:
-- The contract `src/foo/bar.sol:Bar` is involved in deploy time linking. It may be a factory dependency.
-- The contract blob needs to be provided inside a relative `src/foo/` directory to `--link`. Otherwise symbol resolution may fail.
-
-> [!NOTE]
->
-> Tooling is supposed to take care of this. In the future, we may append explicit linkage data to simplify the deploy time linking feature.
-

book/src/user_guide/differences.md

@@ -1,94 +0,0 @@
-# Differences to EVM
-
-This section highlights some potentially observable differences in the [YUL EVM dialect](https://docs.soliditylang.org/en/latest/yul.html#evm-dialect) translation compared to Ethereum Solidity.
-
-Solidity developers deploying dApps to [`pallet-revive`](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/revive) ought to read and understand this section well.
-
-## Deploy code vs. runtime code
-
-Our contract runtime does not differentiate between runtime code and deploy (constructor) code.
-Instead, both are emitted into a single PVM contract code blob and live on-chain.
-Therefore, in EVM terminology, the deploy code equals the runtime code.
-
-> [!TIP]
->
-> In constructor code, the `codesize` instruction will return the call data size instead of the actual code blob size.
-
-## Solidity
-
-We are aware of the following differences in the translation of Solidity code.
-
-### `address.creationCode`
-
-This returns the bytecode keccak256 hash instead.
-
-## YUL functions
-
-The below list contains noteworthy differences in the translation of YUL functions.
-
-> [!NOTE]
->
-> Many functions receive memory buffer offset pointer or size arguments. Since the PVM pointer size is 32 bit, supplying memory offset or buffer size values above `2^32-1` will trap the contract immediately.
-
-The `solc` compiler ought to always emit valid memory references, so Solidity dApp authors don't need to worry about this unless they deal with low level `assembly` code.
-
-### `mload`, `mstore`, `msize`, `mcopy` (memory related functions) 
-
-In general, revive preserves the memory layout, meaning low level memory operations are supported. However, a few caveats apply:
-- The EVM linear heap memory is emulated using a fixed byte buffer of 64kb. This implies that the maximum memory a contract can use is limited to 64kbit (on Ethereum, contract memory is capped by gas and therefore varies).
-- Thus, accessing memory offsets larger than the fixed buffer size will trap the contract at runtime with an `OutOfBound` error.
-- The compiler might detect and optimize unused memory reads and writes, leading to a different `msize` compared to what the EVM would see. 
-
-### `calldataload`, `calldatacopy`
-
-In the constructor code, the offset is ignored and this always returns `0`.
-
-### `codecopy`
-
-Only supported in constructor code.
-
-### `invalid`
-
-Traps the contract but does not consume the remaining gas.
-
-### `create`, `create2`
-
-Deployments on revive work different than on EVM. In a nutshell: Instead of supplying the deploy code concatenated with the constructor arguments (the EVM deploy model), the [revive runtime expects two pointers](https://docs.rs/pallet-revive/latest/pallet_revive/trait.SyscallDoc.html#tymethod.instantiate):
-1. A buffer containing the code hash to deploy.
-2. The constructor arguments buffer.
-
-To make contract instantiation using the `new` keyword in Solidity work seamlessly,
-`revive` translates the `dataoffset` and `datasize` instructions so that they assume the contract hash instead of the contract code.
-The hash is always of constant size.
-Thus, `revive` is able to supply the expected code hash and constructor arguments pointer to the runtime. 
-
-> [!WARNING]
->
-> This might fall apart in code creating contracts inside `assembly` blocks. **We strongly discourage using the `create` family opcodes to manually craft deployments in `assembly` blocks!** Usually, the reason for using `assembly` blocks is to save gas, which is futile on revive anyways due to lower transaction costs.
-
-### `dataoffset`
-
-Returns the contract hash.
-
-### `datasize`
-
-Returns the contract hash size (constant value of `32`).
-
-### `prevrandao`, `difficulty`
-
-Translates to a constant value of `2500000000000000`.
-
-### `pc`, `extcodecopy`
-
-Only valid to use in EVM (they also have no use case in PVM) and produce a compile time error.
-
-### `blobhash`, `blobbasefee`
-
-Related to the Ethereum rollup model and produce a compile time error. Polkadot offers a superior rollup model, removing the use case for blob data related opcodes.
-
-## Difference regarding the `solc` `via-ir` mode
-
-There are two different compilation pipelines available in `solc` and [there are small differences between them](https://docs.soliditylang.org/en/latest/ir-breaking-changes.html).
-
-Since `resolc` processes the YUL IR, always assume the `solc` IR based codegen behavior for contracts compiled with the `revive` compiler.
-

book/src/user_guide/installation.md

@@ -1,27 +0,0 @@
-# Installation
-
-Building Solidity contracts for PolkaVM requires installing the following two compilers:
-- `solc`: The [Ethereum Solidity reference compiler](https://github.com/argotorg/solidity) implementation. 
-- `resolc`: The revive Solidity compiler YUL frontend and PolkaVM code generator.
-
-## `resolc` binary releases
-
-`resolc` is supported an all major operating systems and installation is straightforward.
-Please find our [binary releases](https://github.com/paritytech/revive/releases) for the following platforms:
-- Linux (MUSL)
-- MacOS (universal)
-- Windows
-- Wasm via emscripten
-
-## Installing the `solc` dependency
-
-`resolc` uses `solc` during the compilation process, please refer to the [Ethereum Solidity documentation](https://docs.soliditylang.org/en/latest/installing-solidity.html) for installation instructions.
-
-## `revive` NPM package
-
-We distribute the revive compiler as [node.js module](https://github.com/paritytech/revive/tree/main/js/resolc).
-
-## Buidling `resolc` from source
-
-Please follow the build [instructions in the revive `README.md`](https://github.com/paritytech/revive?tab=readme-ov-file#building-from-source).
-

book/src/user_guide/js.md

@@ -1,13 +0,0 @@
-# JS NPM package
-
-The `resolc` compiler driver is published as an NPM package under [@parity/resolc](https://www.npmjs.com/package/@parity/resolc). 
-
-It's usable from `Node.js` code or directly from the command line:
-
-```shell
-npx @parity/resolc@latest --bin crates/integration/contracts/flipper.sol -o /tmp/out
-```
-
-> [!NOTE]
->
-> While the npm package makes a nice portable option, it doesn't expose all options.

book/src/user_guide/rust_libraries.md

@@ -1,15 +0,0 @@
-# Rust contract libraries
-
-> [!NOTE]
->
-> This is not yet implemented but something for consideration on the roadmap.
-
-Solidity - tightly coupled to the EVM - introduces some inherent inefficiencies that are by design and either needs to be followed or can't be easily worked around, even with efforts like better optimized compiler and VM implementations. This represents a technical dead end. So far the EVM sees no adoption beyond the blockchain industry. Chances are that [the EVM end up deprecated](https://ethereum-magicians.org/t/long-term-l1-execution-layer-proposal-replace-the-evm-with-risc-v) for technical reasons (or maybe not and the RISC-V idea gets abandoned, who knows).
-
-PVM, however, is a general purpose VM. It supports LLVM based mainstream programming languages like Rust. It's a common software engineering practice to compose applications from pieces written in multiple languages, using each to their own strength. For example, AI solutions traditionally use the python scripting language for convenient developer experience, while the underlying AI models get implemented in a lower level language such as C++.
-
-The same pattern can of course be applied to dApps, where we'd expect application specific languages like Solidity mixed with libraries implementing computationally complex algorithms in a lower level language. Business logic and user interfaces are naturally implemented as regular Solidity dApps which can include (link against) Rust libraries. Rust is a fast, safe low level language and the Polkadot SDK is written in Rust itself, making it an excellent choice.
-
-For example, [ZK proof verifiers](https://en.wikipedia.org/wiki/Zero-knowledge_proof) or expensive [DeFi](https://en.wikipedia.org/wiki/Decentralized_finance) primitives would benefit greatly from Rust implementations. 
-
-`revive` provides tooling support and a small Rust contracts SDK for seamless integration with Rust libraries.

book/src/user_guide/std_json.md

@@ -1,36 +0,0 @@
-# Standard JSON interface
-
-The `revive` compiler is mostly compatible with the `solc` standard JSON interface. There are a few additional (PVM related) __input__ configurations:
-
-## The `settings.polkavm` object
-
-Used to configure PVM specific compiler settings.
-
-### `settings.polkavm.debugInformation`
-
-A boolean value allowing to enable debug information. Corresponds to `resolc -g`.
-
-### The `settings.polkavm.memoryConfig` object
-
-Used to apply PVM specific memory configuration settings.
-
-#### `settings.polkavm.heapSize`
-
-A numerical value allowing to configure the contract heap size. Corresponds to `resolc --heap-size`.
-
-#### `settings.polkavm.stackSize`
-
-A numerical value allowing to configure the contract stack size. Corresponds to `resolc --stack-size`.
-
-## The `settings.optimizer` object
-
-The `settings.optimizer` object is augmented with support for PVM specific optimization settings.
-
-### `settings.optimizer.mode`
-
-A single char value to configure the LLVM optimizer settings. Corresponds to `resolc -O`.
-
-## `settings.llvmArguments`
-
-Allows to specify arbitrary command line arguments to LLVM initialization. Used mainly for development and debugging purposes.
-

book/src/user_guide/tooling.md

@@ -1,19 +0,0 @@
-# Tooling integration
-
-`resolc` achieved successful integration with a variety of third party developer tools.
-
-## Solidity toolkits
-
-Support for `resolc` is available in forks of the [hardhat](https://hardhat.org) and [foundry](https://getfoundry.sh) Solidity toolkits:
-
-- [The Parity Hardhat fork](https://github.com/paritytech/hardhat-polkadot)
-- [The Parity Foundry fork](https://github.com/paritytech/foundry-polkadot?tab=readme-ov-file#2-resolc-compiler-integration)
-
-## Compiler explorer
-
-`resolc` is available on [godbolt.org](https://godbolt.org/z/6GM6n4Ka3) for the Solidity and Yul input languages. See also the announcement post on the [forum](https://forum.polkadot.network/t/resolc-is-live-on-compiler-explorer).
-
-## Remix IDE
-
-There is remix IDE fork with `resolc` support at [remix.polkadot.io](https://remix.polkadot.io). Unfortunately this is no longer actively maintained (there might be bugs and outdated `resolc` versions).
-

book/src/welcome.md

@@ -1,16 +0,0 @@
-# Welcome
-
-Hello and a warm welcome to the `revive` Solidity compiler book!
-
-## Target audience
-
-- **Solidity dApp developers** should read the [user guide](./user_guide.md). Solidity on PolkaVM introduces important differences to EVM which should be well understood.
-- **Contributors** will find the [developer guide](./developer_guide.md) helpful for getting up to speed.
-
-## Other Polkadot contracts resources
-
-Head to [contracts.polkadot.io](https://docs.polkadot.com/develop/smart-contracts/) for more general information about contracts on Polkadot.
-
-## About
-
-This [mdBook](https://github.com/rust-lang/mdBook) documents the revive Solidity compiler project. The content is found under `book/`. Run `make book` to observe changes.

clippy.toml

@@ -1 +0,0 @@
-large-error-threshold = 192

crates/benchmarks/BENCHMARKS.md

@@ -4,7 +4,7 @@
 
 - [Benchmark Results](#benchmark-results)
     - [Baseline](#baseline)
-    - [OddProduct](#oddproduct)
+    - [OddPorduct](#oddporduct)
     - [TriangleNumber](#trianglenumber)
     - [FibonacciRecursive](#fibonaccirecursive)
     - [FibonacciIterative](#fibonacciiterative)
@@ -19,7 +19,7 @@
 |:--------|:-------------------------|:-------------------------------- |
 | **`0`** | `10.08 us` (✅ **1.00x**) | `10.32 us` (✅ **1.02x slower**)  |
 
-### OddProduct
+### OddPorduct
 
 |              | `EVM`                     | `PVMInterpreter`                 |
 |:-------------|:--------------------------|:-------------------------------- |
@@ -70,3 +70,4 @@
 
 ---
 Made with [criterion-table](https://github.com/nu11ptr/criterion-table)
+

crates/benchmarks/benches/execute.rs

@@ -57,7 +57,7 @@ fn bench_baseline(c: &mut Criterion) {
 }
 
 fn bench_odd_product(c: &mut Criterion) {
-    let group = group(c, "OddProduct");
+    let group = group(c, "OddPorduct");
     let parameters = &[10_000, 100_000, 300000];
 
     bench(group, parameters, parameters, Contract::odd_product);

crates/build-utils/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "revive-build-utils"
-version = "0.2.0"
+version.workspace = true
 license.workspace = true
 edition.workspace = true
 repository.workspace = true

crates/build-utils/src/lib.rs

@@ -6,10 +6,6 @@ pub const REVIVE_LLVM_HOST_PREFIX: &str = "LLVM_SYS_181_PREFIX";
 /// The revive LLVM target dependency directory prefix environment variable.
 pub const REVIVE_LLVM_TARGET_PREFIX: &str = "REVIVE_LLVM_TARGET_PREFIX";
 
-/// The revive LLVM host tool help link.
-pub const REVIVE_LLVM_BUILDER_HELP_LINK: &str =
-    "https://github.com/paritytech/revive?tab=readme-ov-file#building-from-source";
-
 /// Constructs a path to the LLVM tool `name`.
 ///
 /// Respects the [`REVIVE_LLVM_HOST_PREFIX`] environment variable.
@@ -17,7 +13,9 @@ pub fn llvm_host_tool(name: &str) -> std::path::PathBuf {
     std::env::var_os(REVIVE_LLVM_HOST_PREFIX)
         .map(Into::<std::path::PathBuf>::into)
         .unwrap_or_else(|| {
-            panic!("install LLVM using the revive-llvm builder and export '{REVIVE_LLVM_HOST_PREFIX}'; see also: {REVIVE_LLVM_BUILDER_HELP_LINK}")
+            panic!(
+                "install LLVM using the revive-llvm builder and export {REVIVE_LLVM_HOST_PREFIX}",
+            )
         })
         .join("bin")
         .join(name)

crates/common/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "revive-common"
-version = "0.2.1"
+version.workspace = true
 license.workspace = true
 edition.workspace = true
 repository.workspace = true
@@ -15,8 +15,6 @@ doctest = false
 
 [dependencies]
 anyhow = { workspace = true }
-hex = { workspace = true }
-sha3 = { workspace = true }
 serde = { workspace = true, features = ["derive"] }
 serde_json = { workspace = true, features = [ "arbitrary_precision", "unbounded_depth" ] }
 serde_stacker = { workspace = true }

crates/common/src/contract_identifier.rs

@@ -1,33 +0,0 @@
-//! The contract identifier helper library.
-
-use serde::{Deserialize, Serialize};
-
-/// This structure simplifies passing the contract identifiers through the compilation pipeline.
-#[derive(Debug, Clone, Serialize, Deserialize)]
-pub struct ContractIdentifier {
-    /// The absolute file path.
-    pub path: String,
-    /// The contract name.
-    /// Is set for Solidity contracts only. Otherwise it would be equal to the file name.
-    pub name: Option<String>,
-    /// The full contract identifier.
-    /// For Solidity, The format is `<absolute file path>:<contract name>`.
-    /// For other languages, `<absolute file path>`.
-    pub full_path: String,
-}
-
-impl ContractIdentifier {
-    /// A shortcut constructor.
-    pub fn new(path: String, name: Option<String>) -> Self {
-        let full_path = match name {
-            Some(ref name) => format!("{path}:{name}"),
-            None => path.clone(),
-        };
-
-        Self {
-            path,
-            name,
-            full_path,
-        }
-    }
-}

crates/common/src/evm_version.rs

@@ -43,12 +43,6 @@ pub enum EVMVersion {
     /// The corresponding EVM version.
     #[serde(rename = "cancun")]
     Cancun,
-    /// The corresponding EVM version.
-    #[serde(rename = "prague")]
-    Prague,
-    /// The corresponding EVM version.
-    #[serde(rename = "osaka")]
-    Osaka,
 }
 
 impl TryFrom<&str> for EVMVersion {
@@ -68,8 +62,6 @@ impl TryFrom<&str> for EVMVersion {
             "paris" => Self::Paris,
             "shanghai" => Self::Shanghai,
             "cancun" => Self::Cancun,
-            "prague" => Self::Prague,
-            "osaka" => Self::Osaka,
             _ => anyhow::bail!("Invalid EVM version: {}", value),
         })
     }
@@ -90,8 +82,6 @@ impl std::fmt::Display for EVMVersion {
             Self::Paris => write!(f, "paris"),
             Self::Shanghai => write!(f, "shanghai"),
             Self::Cancun => write!(f, "cancun"),
-            Self::Prague => write!(f, "prague"),
-            Self::Osaka => write!(f, "osaka"),
         }
     }
 }

crates/common/src/extension.rs

@@ -37,4 +37,4 @@ pub static EXTENSION_POLKAVM_ASSEMBLY: &str = "pvmasm";
 pub static EXTENSION_POLKAVM_BINARY: &str = "pvm";
 
 /// The ELF shared object file extension.
-pub static EXTENSION_OBJECT: &str = "o";
+pub static EXTENSION_SHARED_OBJECT: &str = "so";

crates/common/src/keccak256.rs

@@ -1,68 +0,0 @@
-//! Keccak-256 hash utilities.
-
-use serde::{Deserialize, Serialize};
-use sha3::digest::FixedOutput;
-use sha3::Digest;
-
-pub const DIGEST_BYTES: usize = 32;
-
-/// Keccak-256 hash utilities.
-#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
-pub struct Keccak256 {
-    /// Binary representation.
-    bytes: [u8; DIGEST_BYTES],
-    /// Hexadecimal string representation.
-    string: String,
-}
-
-impl Keccak256 {
-    /// Computes the `keccak256` hash for `preimage`.
-    pub fn from_slice(preimage: &[u8]) -> Self {
-        let bytes = sha3::Keccak256::digest(preimage).into();
-        let string = format!("0x{}", hex::encode(bytes));
-        Self { bytes, string }
-    }
-
-    /// Computes the `keccak256` hash for an array of `preimages`.
-    pub fn from_slices<R: AsRef<[u8]>>(preimages: &[R]) -> Self {
-        let mut hasher = sha3::Keccak256::new();
-        for preimage in preimages.iter() {
-            hasher.update(preimage);
-        }
-        let bytes: [u8; DIGEST_BYTES] = hasher.finalize_fixed().into();
-        let string = format!("0x{}", hex::encode(bytes));
-        Self { bytes, string }
-    }
-
-    /// Returns a reference to the 32-byte SHA-3 hash.
-    pub fn as_bytes(&self) -> &[u8] {
-        self.bytes.as_slice()
-    }
-
-    /// Returns a reference to the hexadecimal string representation.
-    pub fn as_str(&self) -> &str {
-        self.string.as_str()
-    }
-
-    /// Extracts the binary representation.
-    pub fn to_vec(&self) -> Vec<u8> {
-        self.bytes.to_vec()
-    }
-}
-
-impl std::fmt::Display for Keccak256 {
-    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
-        write!(f, "{}", self.as_str())
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    #[test]
-    fn hash_and_stringify_works() {
-        assert_eq!(
-            super::Keccak256::from_slices(&["foo".as_bytes(), "bar".as_bytes(),]).as_str(),
-            "0x38d18acb67d25c8bb9942764b62f18e17054f66a817bd4295423adf9ed98873e"
-        );
-    }
-}

crates/common/src/lib.rs

@@ -3,13 +3,9 @@
 pub(crate) mod base;
 pub(crate) mod bit_length;
 pub(crate) mod byte_length;
-pub(crate) mod contract_identifier;
 pub(crate) mod evm_version;
 pub(crate) mod exit_code;
 pub(crate) mod extension;
-pub(crate) mod keccak256;
-pub(crate) mod metadata;
-pub(crate) mod object;
 pub(crate) mod utils;
 
 pub use self::base::*;
@@ -18,8 +14,4 @@ pub use self::byte_length::*;
 pub use self::evm_version::EVMVersion;
 pub use self::exit_code::*;
 pub use self::extension::*;
-pub use self::keccak256::*;
-pub use self::metadata::*;
-pub use self::object::*;
 pub use self::utils::*;
-pub use contract_identifier::*;

crates/common/src/metadata.rs

@@ -1,42 +0,0 @@
-//! The metadata hash type.
-
-use std::str::FromStr;
-
-use serde::{Deserialize, Serialize};
-
-/// The metadata hash type.
-#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
-pub enum MetadataHash {
-    /// Do not include bytecode hash.
-    #[serde(rename = "none")]
-    None,
-    /// Include the `ipfs` hash.
-    #[serde(rename = "ipfs")]
-    IPFS,
-    /// Include the `keccak256`` hash.
-    #[serde(rename = "keccak256")]
-    Keccak256,
-}
-
-impl FromStr for MetadataHash {
-    type Err = anyhow::Error;
-
-    fn from_str(string: &str) -> Result<Self, Self::Err> {
-        match string {
-            "none" => Ok(Self::None),
-            "ipfs" => Ok(Self::IPFS),
-            "keccak256" => Ok(Self::Keccak256),
-            string => anyhow::bail!("unknown bytecode hash mode: `{string}`"),
-        }
-    }
-}
-
-impl std::fmt::Display for MetadataHash {
-    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
-        match self {
-            Self::None => write!(f, "none"),
-            Self::IPFS => write!(f, "ipfs"),
-            Self::Keccak256 => write!(f, "keccak256"),
-        }
-    }
-}

crates/common/src/object.rs

@@ -1,61 +0,0 @@
-//! The revive binary object helper module.
-
-use std::str::FromStr;
-
-use serde::{Deserialize, Serialize};
-
-/// The binary object format.
-///
-/// Unlinked contracts are stored in a different object format
-/// than final (linked) contract blobs.
-#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
-pub enum ObjectFormat {
-    /// The unlinked ELF object format.
-    ELF,
-    /// The fully linked PVM format.
-    PVM,
-}
-
-impl ObjectFormat {
-    pub const PVM_MAGIC: [u8; 4] = [b'P', b'V', b'M', b'\0'];
-    pub const ELF_MAGIC: [u8; 4] = [0x7f, b'E', b'L', b'F'];
-}
-
-impl FromStr for ObjectFormat {
-    type Err = anyhow::Error;
-
-    fn from_str(value: &str) -> Result<Self, Self::Err> {
-        match value {
-            "ELF" => Ok(Self::ELF),
-            "PVM" => Ok(Self::PVM),
-            _ => anyhow::bail!(
-                "Unknown object format: {value}. Supported formats: {}, {}",
-                Self::ELF,
-                Self::PVM,
-            ),
-        }
-    }
-}
-
-impl TryFrom<&[u8]> for ObjectFormat {
-    type Error = &'static str;
-
-    fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
-        if value.starts_with(&Self::PVM_MAGIC) {
-            return Ok(Self::PVM);
-        }
-        if value.starts_with(&Self::ELF_MAGIC) {
-            return Ok(Self::ELF);
-        }
-        Err("expected a contract object")
-    }
-}
-
-impl std::fmt::Display for ObjectFormat {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
-        match self {
-            Self::ELF => write!(f, "ELF"),
-            Self::PVM => write!(f, "PVM"),
-        }
-    }
-}

crates/common/src/utils.rs

@@ -1,45 +1,25 @@
 //! The compiler common utils.
 
 /// Deserializes a `serde_json` object from slice with the recursion limit disabled.
-///
 /// Must be used for all JSON I/O to avoid crashes due to the aforementioned limit.
 pub fn deserialize_from_slice<O>(input: &[u8]) -> anyhow::Result<O>
 where
     O: serde::de::DeserializeOwned,
 {
-    let deserializer = serde_json::Deserializer::from_slice(input);
+    let mut deserializer = serde_json::Deserializer::from_slice(input);
-    deserialize(deserializer)
+    deserializer.disable_recursion_limit();
-}
+    let deserializer = serde_stacker::Deserializer::new(&mut deserializer);
-
+    let result = O::deserialize(deserializer)?;
-/// Deserializes a `serde_json` object from string with the recursion limit disabled.
+    Ok(result)
-///
+}
-/// Must be used for all JSON I/O to avoid crashes due to the aforementioned limit.
+
-pub fn deserialize_from_str<O>(input: &str) -> anyhow::Result<O>
+/// Deserializes a `serde_json` object from string with the recursion limit disabled.
-where
+/// Must be used for all JSON I/O to avoid crashes due to the aforementioned limit.
-    O: serde::de::DeserializeOwned,
+pub fn deserialize_from_str<O>(input: &str) -> anyhow::Result<O>
-{
+where
-    let deserializer = serde_json::Deserializer::from_str(input);
+    O: serde::de::DeserializeOwned,
-    deserialize(deserializer)
+{
-}
+    let mut deserializer = serde_json::Deserializer::from_str(input);
-
-/// Deserializes a `serde_json` object from reader with the recursion limit disabled.
-///
-/// Must be used for all JSON I/O to avoid crashes due to the aforementioned limit.
-pub fn deserialize_from_reader<R, O>(reader: R) -> anyhow::Result<O>
-where
-    R: std::io::Read,
-    O: serde::de::DeserializeOwned,
-{
-    let deserializer = serde_json::Deserializer::from_reader(reader);
-    deserialize(deserializer)
-}
-
-/// Runs the generic deserializer.
-pub fn deserialize<'de, R, O>(mut deserializer: serde_json::Deserializer<R>) -> anyhow::Result<O>
-where
-    R: serde_json::de::Read<'de>,
-    O: serde::de::DeserializeOwned,
-{
     deserializer.disable_recursion_limit();
     let deserializer = serde_stacker::Deserializer::new(&mut deserializer);
     let result = O::deserialize(deserializer)?;

crates/differential/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "revive-differential"
 description = "utilities for differential testing the revive compiler against EVM"
-version = "0.2.0"
+version.workspace = true
 license.workspace = true
 edition.workspace = true
 authors.workspace = true

crates/differential/genesis.json

@@ -15,8 +15,6 @@
         "grayGlacierBlock": 0,
         "shanghaiTime": 0,
         "cancunTime": 0,
-        "pragueTime": 0,
-        "osakaTime": 0,
         "terminalTotalDifficulty": 0,
         "terminalTotalDifficultyPassed": true,
         "blobSchedule": {
@@ -24,16 +22,6 @@
                 "target": 3,
                 "max": 6,
                 "baseFeeUpdateFraction": 3338477
-            },
-            "prague": {
-                "target": 6,
-                "max": 9,
-                "baseFeeUpdateFraction": 5007716
-            },
-            "osaka": {
-                "target": 6,
-                "max": 9,
-                "baseFeeUpdateFraction": 5007716
             }
         }
     },
@@ -56,4 +44,4 @@
             "balance": "1000000000"
         }
     }
-}
+}

crates/differential/src/go_duration.rs

@@ -3,8 +3,8 @@ use std::time::Duration;
 /// Parse a go formatted duration.
 ///
 /// Sources:
-/// - <https://crates.io/crates/go-parse-duration> (fixed an utf8 bug)
+/// - https://crates.io/crates/go-parse-duration (fixed an utf8 bug)
-/// - <https://github.com/golang/go/blob/master/src/time/format.go>
+/// - https://github.com/golang/go/blob/master/src/time/format.go
 pub fn parse_go_duration(value: &str) -> Result<Duration, String> {
     parse_duration(value).map(|ns| Duration::from_nanos(ns.unsigned_abs()))
 }

crates/explorer/Cargo.toml

@@ -1,20 +0,0 @@
-[package]
-name = "revive-explorer"
-version = "0.1.0"
-license.workspace = true
-edition.workspace = true
-repository.workspace = true
-authors.workspace = true
-description = "Helper utility to inspect debug builds"
-
-[[bin]]
-name = "revive-explorer"
-path = "src/main.rs"
-
-[dependencies]
-anyhow = { workspace = true }
-clap = { workspace = true, features = ["help", "std", "derive"] }
-num_cpus = { workspace = true }
-
-revive-yul = { workspace = true }
-

crates/explorer/README.md

@@ -1,49 +0,0 @@
-# revive-explorer
-
-The `revive-explorer` is a helper utility for exploring the compilers YUL lowering unit.
-
-It analyzes a given shared objects from the debug dump and outputs:
-- The count of each YUL statement translated.
-- A per YUL statement break-down of bytecode size contributed per.
-- Estimated `yul-phaser` cost parameters.
-
-Example:
-
-```
-statements count:
-	block 532
-	Caller 20
-	Not 73
-	Gas 24
-	Shr 2
-    ...
-	Shl 259
-	SetImmutable 2
-	CodeSize 1
-	CallDataLoad 87
-	Return 56
-bytes per statement:
-	Or 756
-	CodeCopy 158
-	Log3 620
-	Return 1562
-	MStore 36128
-	...
-	ReturnDataCopy 2854
-	DataOffset 28
-	assignment 1194
-	Number 540
-	CallValue 4258
-yul-phaser parameters:
-	--break-cost 1
-	--variable-declaration-cost 3
-	--function-call-cost 8
-	--if-cost 4
-	--expression-statement-cost 6
-	--function-definition-cost 11
-	--switch-cost 3
-	--block-cost 1
-	--leave-cost 1
-	--assignment-cost 1
-```
-

crates/explorer/src/dwarfdump.rs

@@ -1,68 +0,0 @@
-//! The `llvm-dwarfdump` utility helper library.
-
-use std::{
-    path::{Path, PathBuf},
-    process::{Command, Stdio},
-};
-
-pub static EXECUTABLE: &str = "llvm-dwarfdump";
-pub static DEBUG_LINES_ARGUMENTS: [&str; 1] = ["--debug-line"];
-pub static SOURCE_FILE_ARGUMENTS: [&str; 1] = ["--show-sources"];
-
-/// Calls the `llvm-dwarfdump` tool to extract debug line information
-/// from the shared object at `path`. Returns the output.
-///
-/// Provide `Some(dwarfdump_exectuable)` to override the default executable.
-pub fn debug_lines(
-    shared_object: &Path,
-    dwarfdump_executable: &Option<PathBuf>,
-) -> anyhow::Result<String> {
-    dwarfdump(shared_object, dwarfdump_executable, &DEBUG_LINES_ARGUMENTS)
-}
-
-/// Calls the `llvm-dwarfdump` tool to extract the source file name.
-/// Returns the source file path.
-///
-/// Provide `Some(dwarfdump_exectuable)` to override the default executable.
-pub fn source_file(
-    shared_object: &Path,
-    dwarfdump_executable: &Option<PathBuf>,
-) -> anyhow::Result<PathBuf> {
-    let output = dwarfdump(shared_object, dwarfdump_executable, &SOURCE_FILE_ARGUMENTS)?;
-    let output = output.trim();
-
-    if output.is_empty() {
-        anyhow::bail!(
-            "the shared object at path `{}` doesn't contain the source file name. Hint: compile with debug information (-g)?",
-            shared_object.display()
-        );
-    }
-
-    Ok(output.into())
-}
-
-/// The internal `llvm-dwarfdump` helper function.
-fn dwarfdump(
-    shared_object: &Path,
-    dwarfdump_executable: &Option<PathBuf>,
-    arguments: &[&str],
-) -> anyhow::Result<String> {
-    let executable = dwarfdump_executable
-        .to_owned()
-        .unwrap_or_else(|| PathBuf::from(EXECUTABLE));
-
-    let output = Command::new(executable)
-        .args(arguments)
-        .arg(shared_object)
-        .stdin(Stdio::null())
-        .stdout(Stdio::piped())
-        .stderr(Stdio::piped())
-        .spawn()?
-        .wait_with_output()?;
-
-    if !output.status.success() {
-        anyhow::bail!(String::from_utf8_lossy(&output.stderr).to_string());
-    }
-
-    Ok(String::from_utf8_lossy(&output.stdout).to_string())
-}

crates/explorer/src/dwarfdump_analyzer.rs

@@ -1,222 +0,0 @@
-//! The core dwarf dump analyzer library.
-
-use std::{
-    collections::HashMap,
-    path::{Path, PathBuf},
-};
-
-use revive_yul::lexer::token::location::Location;
-
-use crate::location_mapper::{self, LocationMapper};
-
-/// The dwarf dump analyzer.
-///
-/// Loads debug information from `llvm-dwarfdump` and calculates statistics
-/// about the compiled YUL statements:
-/// - Statements count
-/// - Per-statement
-#[derive(Debug, Default)]
-pub struct DwarfdumpAnalyzer {
-    /// The YUL source file path.
-    source: PathBuf,
-
-    /// The YUL location to statements map.
-    location_map: HashMap<Location, String>,
-
-    /// The `llvm-dwarfdump --debug-lines` output.
-    debug_lines: String,
-
-    /// The observed statements.
-    statements_count: HashMap<String, usize>,
-    /// The observed statement to instructions size.
-    statements_size: HashMap<String, u64>,
-}
-
-impl DwarfdumpAnalyzer {
-    /// The debug info analyzer constructor.
-    ///
-    /// `source` is the path to the YUL source file.
-    /// `debug_lines` is the `llvm-dwarfdump --debug-lines` output.
-    pub fn new(source: &Path, debug_lines: String) -> Self {
-        Self {
-            source: source.to_path_buf(),
-            debug_lines,
-            ..Default::default()
-        }
-    }
-
-    /// Run the analysis.
-    pub fn analyze(&mut self) -> anyhow::Result<()> {
-        self.map_locations()?;
-        self.analyze_statements()?;
-        Ok(())
-    }
-
-    /// Populate the maps so that we can always unwrap later.
-    fn map_locations(&mut self) -> anyhow::Result<()> {
-        self.location_map = LocationMapper::map_locations(&self.source)?;
-
-        self.statements_count = HashMap::with_capacity(self.location_map.len());
-        self.statements_size = HashMap::with_capacity(self.location_map.len());
-
-        for statement in self.location_map.values() {
-            if !self.statements_size.contains_key(statement) {
-                self.statements_size.insert(statement.clone(), 0);
-            }
-
-            *self.statements_count.entry(statement.clone()).or_insert(0) += 1;
-        }
-
-        Ok(())
-    }
-
-    /// Analyze how much bytes of insturctions each statement contributes.
-    fn analyze_statements(&mut self) -> anyhow::Result<()> {
-        let mut previous_offset = 0;
-        let mut previous_location = Location::new(0, 0);
-
-        for line in self
-            .debug_lines
-            .lines()
-            .skip_while(|line| !line.starts_with("Address"))
-            .skip(2)
-        {
-            let mut parts = line.split_whitespace();
-            let (Some(offset), Some(line), Some(column)) =
-                (parts.next(), parts.next(), parts.next())
-            else {
-                continue;
-            };
-
-            let current_offset = u64::from_str_radix(offset.trim_start_matches("0x"), 16)?;
-            let mut current_location = Location::new(line.parse()?, column.parse()?);
-
-            // TODO: A bug? Needs further investigation.
-            if current_location.line == 0 && current_location.column != 0 {
-                current_location.line = previous_location.line;
-            }
-
-            if let Some(statement) = self.location_map.get(&previous_location) {
-                let contribution = current_offset - previous_offset;
-                *self.statements_size.get_mut(statement).unwrap() += contribution;
-            }
-
-            previous_offset = current_offset;
-            previous_location = current_location;
-        }
-
-        Ok(())
-    }
-
-    /// Print the per-statement count break-down.
-    pub fn display_statement_count(&self) {
-        println!("statements count:");
-        for (statement, count) in self.statements_count.iter() {
-            println!("\t{statement} {count}");
-        }
-    }
-
-    /// Print the per-statement byte size contribution break-down.
-    pub fn display_statement_size(&self) {
-        println!("bytes per statement:");
-        for (statement, size) in self.statements_size.iter() {
-            println!("\t{statement} {size}");
-        }
-    }
-
-    /// Print the estimated `yul-phaser` cost parameters.
-    pub fn display_phaser_costs(&self, yul_phaser_scale: u64) {
-        println!("yul-phaser parameters:");
-        for (parameter, cost) in self.phaser_costs(yul_phaser_scale) {
-            println!("\t{parameter} {cost}");
-        }
-    }
-
-    /// Estimate the `yul-phaser` costs using the simplified weight function:
-    /// `Total size / toal count = cost`
-    pub fn phaser_costs(&self, yul_phaser_scale: u64) -> Vec<(String, u64)> {
-        let mut costs: HashMap<String, (usize, u64)> = HashMap::with_capacity(16);
-        for (statement, count) in self
-            .statements_count
-            .iter()
-            .filter(|(_, count)| **count > 0)
-        {
-            let size = self.statements_size.get(statement).unwrap();
-            let cost = match statement.as_str() {
-                location_mapper::FOR => "--for-loop-cost",
-                location_mapper::OTHER => continue,
-                location_mapper::INTERNAL => continue,
-                location_mapper::BLOCK => "--block-cost",
-                location_mapper::FUNCTION_CALL => "--function-call-cost",
-                location_mapper::IF => "--if-cost",
-                location_mapper::SWITCH => "--switch-cost",
-                location_mapper::DECLARATION => "--variable-declaration-cost",
-                location_mapper::ASSIGNMENT => "--assignment-cost",
-                location_mapper::FUNCTION_DEFINITION => "--function-definition-cost",
-                location_mapper::IDENTIFIER => "--identifier-cost",
-                location_mapper::LITERAL => "--literal-cost",
-                _ => "--expression-statement-cost",
-            };
-
-            let entry = costs.entry(cost.to_string()).or_default();
-            entry.0 += count;
-            entry.1 += size;
-        }
-
-        let costs = costs
-            .iter()
-            .map(|(cost, (count, size))| {
-                let ratio = *size / *count as u64;
-                (cost.to_string(), ratio.min(100))
-            })
-            .collect::<Vec<_>>();
-
-        let scaled_costs = scale_to(
-            costs
-                .iter()
-                .map(|(_, ratio)| *ratio)
-                .collect::<Vec<_>>()
-                .as_slice(),
-            yul_phaser_scale,
-        );
-
-        costs
-            .iter()
-            .zip(scaled_costs)
-            .map(|((cost, _), scaled_ratio)| (cost.to_string(), scaled_ratio))
-            .collect()
-    }
-}
-
-/// Given a slice of u64 values, returns a `Vec<u64>` where each element
-/// is linearly scaled into the closed interval [1, 10].
-fn scale_to(data: &[u64], scale_max: u64) -> Vec<u64> {
-    if data.is_empty() {
-        return Vec::new();
-    }
-
-    let mut min = data[0];
-    let mut max = data[0];
-    for &x in &data[1..] {
-        if x < min {
-            min = x;
-        }
-        if x > max {
-            max = x;
-        }
-    }
-    if max < scale_max {
-        return data.to_vec();
-    }
-
-    let range = max - min;
-    data.iter()
-        .map(|&x| {
-            if range == 0 {
-                1
-            } else {
-                1 + (x - min) * scale_max / range
-            }
-        })
-        .collect()
-}

crates/explorer/src/lib.rs

@@ -1,6 +0,0 @@
-//! The revive explorer leverages debug info to get insights into emitted code.
-
-pub mod dwarfdump;
-pub mod dwarfdump_analyzer;
-pub mod location_mapper;
-pub mod yul_phaser;

crates/explorer/src/location_mapper.rs

@@ -1,123 +0,0 @@
-//! The location mapper utility maps YUL source locations to AST statements.
-
-use std::{collections::HashMap, path::Path};
-
-use revive_yul::{
-    lexer::{token::location::Location, Lexer},
-    parser::{
-        identifier::Identifier,
-        statement::{
-            assignment::Assignment,
-            block::Block,
-            expression::{function_call::FunctionCall, literal::Literal},
-            for_loop::ForLoop,
-            function_definition::FunctionDefinition,
-            if_conditional::IfConditional,
-            object::Object,
-            switch::Switch,
-            variable_declaration::VariableDeclaration,
-        },
-    },
-    visitor::{AstNode, AstVisitor},
-};
-
-/// Code attributed to an unknown location.
-pub const OTHER: &str = "other";
-/// Code attributed to a compiler internal location.
-pub const INTERNAL: &str = "internal";
-/// Code attributed to a block.
-pub const BLOCK: &str = "block";
-/// Code attributed to a function call.
-pub const FUNCTION_CALL: &str = "function_call";
-/// Code attributed to a for loop.
-pub const FOR: &str = "for";
-/// Code attributed to an if statement.
-pub const IF: &str = "if";
-/// Code attributed to a switch statement.
-pub const SWITCH: &str = "switch";
-/// Code attributed to a variable declaration.
-pub const DECLARATION: &str = "let";
-/// Code attributed to a variable assignement.
-pub const ASSIGNMENT: &str = "assignment";
-/// Code attributed to a function definition.
-pub const FUNCTION_DEFINITION: &str = "function_definition";
-/// Code attributed to an identifier.
-pub const IDENTIFIER: &str = "identifier";
-/// Code attributed to a literal.
-pub const LITERAL: &str = "literal";
-
-/// The location to statements mapper.
-pub struct LocationMapper(HashMap<Location, String>);
-
-impl LocationMapper {
-    /// Construct a node location map from the given YUL `source` file.
-    pub fn map_locations(source: &Path) -> anyhow::Result<HashMap<Location, String>> {
-        let mut lexer = Lexer::new(std::fs::read_to_string(source)?);
-        let ast = Object::parse(&mut lexer, None).map_err(|error| {
-            anyhow::anyhow!("Contract `{}` parsing error: {:?}", source.display(), error)
-        })?;
-
-        let mut location_map = Self(Default::default());
-        ast.accept(&mut location_map);
-        location_map.0.insert(Location::new(0, 0), OTHER.into());
-        location_map.0.insert(Location::new(1, 0), INTERNAL.into());
-
-        Ok(location_map.0)
-    }
-}
-
-impl AstVisitor for LocationMapper {
-    fn visit(&mut self, node: &impl AstNode) {
-        node.visit_children(self);
-    }
-
-    fn visit_block(&mut self, node: &Block) {
-        node.visit_children(self);
-        self.0.insert(node.location, BLOCK.into());
-    }
-
-    fn visit_assignment(&mut self, node: &Assignment) {
-        node.visit_children(self);
-        self.0.insert(node.location, ASSIGNMENT.into());
-    }
-
-    fn visit_if_conditional(&mut self, node: &IfConditional) {
-        node.visit_children(self);
-        self.0.insert(node.location, IF.into());
-    }
-
-    fn visit_variable_declaration(&mut self, node: &VariableDeclaration) {
-        node.visit_children(self);
-        self.0.insert(node.location, DECLARATION.into());
-    }
-
-    fn visit_function_call(&mut self, node: &FunctionCall) {
-        node.visit_children(self);
-        self.0.insert(node.location, node.name.to_string());
-    }
-
-    fn visit_function_definition(&mut self, node: &FunctionDefinition) {
-        node.visit_children(self);
-        self.0.insert(node.location, FUNCTION_DEFINITION.into());
-    }
-
-    fn visit_identifier(&mut self, node: &Identifier) {
-        node.visit_children(self);
-        self.0.insert(node.location, IDENTIFIER.into());
-    }
-
-    fn visit_literal(&mut self, node: &Literal) {
-        node.visit_children(self);
-        self.0.insert(node.location, LITERAL.into());
-    }
-
-    fn visit_for_loop(&mut self, node: &ForLoop) {
-        node.visit_children(self);
-        self.0.insert(node.location, FOR.into());
-    }
-
-    fn visit_switch(&mut self, node: &Switch) {
-        node.visit_children(self);
-        self.0.insert(node.location, SWITCH.into());
-    }
-}

crates/explorer/src/main.rs

@@ -1,59 +0,0 @@
-use std::path::PathBuf;
-
-use clap::Parser;
-
-use revive_explorer::{dwarfdump, dwarfdump_analyzer::DwarfdumpAnalyzer, yul_phaser};
-
-/// The `revive-explorer` is a helper utility for exploring the compilers YUL lowering unit.
-///
-/// It analyzes a given shared objects from the debug dump and outputs:
-/// - The count of each YUL statement translated.
-/// - A per YUL statement break-down of bytecode size contributed per.
-/// - Estimated `yul-phaser` cost parameters.
-///
-/// Note: This tool might not be fully accurate, especially when the code was optimized.
-#[derive(Parser, Debug)]
-#[command(version, about, long_about = None)]
-struct Args {
-    /// Path of the dwarfdump executable.
-    #[arg(short, long)]
-    dwarfdump: Option<PathBuf>,
-
-    /// The YUL phaser cost scale maximum value.
-    #[arg(short, long, default_value_t = 10)]
-    cost_scale: u64,
-
-    /// Run the provided yul-phaser executable using the estimated costs.
-    #[arg(short, long)]
-    yul_phaser: Option<PathBuf>,
-
-    /// Path of the shared object to analyze.
-    /// It must have been compiled with debug info (-g).
-    file: PathBuf,
-}
-
-fn main() -> anyhow::Result<()> {
-    let args = Args::parse();
-
-    let source_file = dwarfdump::source_file(&args.file, &args.dwarfdump)?;
-    let debug_lines = dwarfdump::debug_lines(&args.file, &args.dwarfdump)?;
-    let mut analyzer = DwarfdumpAnalyzer::new(source_file.as_path(), debug_lines);
-
-    analyzer.analyze()?;
-
-    if let Some(path) = args.yul_phaser.as_ref() {
-        yul_phaser::run(
-            path,
-            source_file.as_path(),
-            analyzer.phaser_costs(args.cost_scale).as_slice(),
-            num_cpus::get() / 2, // TODO: should be configurable.
-        )?;
-        return Ok(());
-    }
-
-    analyzer.display_statement_count();
-    analyzer.display_statement_size();
-    analyzer.display_phaser_costs(args.cost_scale);
-
-    Ok(())
-}

crates/explorer/src/yul_phaser.rs

@@ -1,79 +0,0 @@
-//! The revive explorer YUL phaser utility library.
-//!
-//! This can be used to invoke the `yul-phaser` utility,
-//! used to find better YUL optimizer sequences.
-
-use std::{
-    path::{Path, PathBuf},
-    process::{Command, Stdio},
-    thread,
-    time::{SystemTime, UNIX_EPOCH},
-};
-
-/// The `yul-phaser` sane default arguments:
-/// - Less verbose output.
-/// - Sufficient rounds.
-/// - Sufficient random population start.
-const ARGUMENTS: [&str; 6] = [
-    "--hide-round",
-    "--rounds",
-    "1000",
-    "--random-population",
-    "100",
-    "--show-only-top-chromosome",
-];
-
-/// Run multiple YUL phaser executables in parallel.
-pub fn run(
-    executable: &Path,
-    source: &Path,
-    costs: &[(String, u64)],
-    n_threads: usize,
-) -> anyhow::Result<()> {
-    let mut handles = Vec::with_capacity(n_threads);
-
-    for n in 0..n_threads {
-        let executable = executable.to_path_buf();
-        let source = source.to_path_buf();
-        let costs = costs.to_vec();
-
-        handles.push(thread::spawn(move || {
-            spawn_process(executable, source, costs, n)
-        }));
-    }
-
-    for handle in handles {
-        let _ = handle.join();
-    }
-
-    Ok(())
-}
-
-/// The `yul-phaser` process spawning helper function.
-fn spawn_process(
-    executable: PathBuf,
-    source: PathBuf,
-    costs: Vec<(String, u64)>,
-    seed: usize,
-) -> anyhow::Result<()> {
-    let cost_parameters = costs
-        .iter()
-        .flat_map(|(parameter, cost)| vec![parameter.clone(), cost.to_string()]);
-
-    let secs = SystemTime::now()
-        .duration_since(UNIX_EPOCH)
-        .expect("Time went backwards")
-        .as_secs();
-
-    Command::new(executable)
-        .args(cost_parameters)
-        .args(ARGUMENTS)
-        .arg("--seed")
-        .arg((seed + secs as usize).to_string())
-        .arg(source)
-        .stdin(Stdio::null())
-        .spawn()?
-        .wait()?;
-
-    Ok(())
-}

crates/integration/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "revive-integration"
-version = "0.3.0"
+version = "0.1.1"
 license.workspace = true
 edition.workspace = true
 repository.workspace = true

crates/integration/codesize.json

@@ -1,10 +1,10 @@
 {
-  "Baseline": 911,
+  "Baseline": 945,
-  "Computation": 2337,
+  "Computation": 2308,
-  "DivisionArithmetics": 14488,
+  "DivisionArithmetics": 2334,
-  "ERC20": 17041,
+  "ERC20": 21363,
-  "Events": 1672,
+  "Events": 1677,
-  "FibonacciIterative": 1454,
+  "FibonacciIterative": 1516,
-  "Flipper": 2106,
+  "Flipper": 2099,
-  "SHA1": 7814
+  "SHA1": 8268
 }

crates/integration/contracts/AddModMulMod.sol

@@ -1,81 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0
-
-pragma solidity ^0.8;
-
-/* runner.json
-{
-    "differential": true,
-    "actions": [
-        {
-            "Upload": {
-                "code": {
-                    "Solidity": {
-                        "contract": "AddModMulMod"
-                    }
-                }
-            }
-        },
-        {
-            "Instantiate": {
-                "value": 123123,
-                "code": {
-                    "Solidity": {
-                        "contract": "AddModMulModTester"
-                    }
-                }
-            }
-        },
-        {
-            "VerifyCall": {
-                "success": true
-            }
-        }
-    ]
-}
-*/
-
-contract AddModMulMod {
-    function test() public returns (uint256) {
-        // Note that this only works because computation on literals is done using
-        // unbounded integers.
-        if ((2**255 + 2**255) % 7 != addmod(2**255, 2**255, 7)) return 1;
-        if ((2**255 + 2**255) % 7 != addmod(2**255, 2**255, 7)) return 2;
-        return 0;
-    }
-
-    function f(uint256 d) public pure returns (uint256) {
-        addmod(1, 2, d);
-        return 2;
-    }
-
-    function g(uint256 d) public pure returns (uint256) {
-        mulmod(1, 2, d);
-        return 2;
-    }
-
-    function h() public pure returns (uint256) {
-        mulmod(0, 1, 2);
-        mulmod(1, 0, 2);
-        addmod(0, 1, 2);
-        addmod(1, 0, 2);
-        return 2;
-    }
-}
-
-contract AddModMulModTester {
-    constructor() payable {
-        AddModMulMod c = new AddModMulMod();
-
-        assert(c.test() == 0);
-
-        try c.f(0) returns (uint m) { revert(); } catch Panic(uint errorCode) {
-            assert(errorCode == 0x12);
-        }
-
-        try c.g(0) returns (uint m) { revert(); } catch Panic(uint errorCode) {
-            assert(errorCode == 0x12);
-        }
-
-        assert(c.h() == 2);
-    } 
-}

crates/integration/contracts/BaseFee.sol

@@ -26,6 +26,6 @@ pragma solidity ^0.8;
 
 contract BaseFee {
     constructor() payable {
-        assert(block.basefee > 0);
+        assert(block.basefee == 0);
     }
 }

crates/integration/contracts/CallGas.sol

@@ -1,50 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity ^0.8;
-
-// Use a non-zero call gas that works with call gas clipping but not with a truncate. 
-
-/* runner.json
-{
-    "differential": true,
-    "actions": [
-        {
-            "Upload": {
-                "code": {
-                    "Solidity": {
-                        "contract": "Other"
-                    }
-                }
-            }
-        },
-        {
-            "Instantiate": {
-                "code": {
-                    "Solidity": {
-                        "contract": "CallGas"
-                    }
-                },
-                "data": "1000000000000000000000000000000000000000000000000000000000000001"
-            }
-        }
-    ]
-}
-*/
-
-contract Other {
-    address public last;
-    uint public foo;
-
-    fallback() external {
-        last = msg.sender; 
-        foo += 1;
-    }
-}
-
-contract CallGas {
-    constructor(uint _gas) payable {
-        Other other = new Other();
-        address(other).call{ gas: _gas }(hex"");
-        assert(other.last() == address(this));
-    }
-}

crates/integration/contracts/CountLeadingZeros.sol

@@ -1,57 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity ^0.8.31;
-
-/* runner.json
-{
-    "differential": true,
-    "actions": [
-        {
-            "Instantiate": {
-                "code": {
-                    "Solidity": {
-                        "contract": "CountLeadingZeros"
-                    }
-                }
-            }
-        }
-    ]
-}
-*/
-
-/// The EIP-7939 test vectors:
-/// https://eips.ethereum.org/EIPS/eip-7939#test-cases
-contract CountLeadingZeros {
-    function clz(uint256 x) internal pure returns (uint256 r) {
-        assembly {
-            r := clz(x)
-        }
-    }
-
-    constructor() payable {
-        assert(
-            clz(0x000000000000000000000000000000000000000000000000000000000000000)
-                == 0x0000000000000000000000000000000000000000000000000000000000000100
-        );
-        assert(
-            clz(0x8000000000000000000000000000000000000000000000000000000000000000)
-                == 0x0000000000000000000000000000000000000000000000000000000000000000
-        );
-        assert(
-            clz(0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff)
-                == 0x0000000000000000000000000000000000000000000000000000000000000000
-        );
-        assert(
-            clz(0x4000000000000000000000000000000000000000000000000000000000000000)
-                == 0x0000000000000000000000000000000000000000000000000000000000000001
-        );
-        assert(
-            clz(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff)
-                == 0x0000000000000000000000000000000000000000000000000000000000000001
-        );
-        assert(
-            clz(0x0000000000000000000000000000000000000000000000000000000000000001)
-                == 0x00000000000000000000000000000000000000000000000000000000000000ff
-        );
-    }
-}

crates/integration/contracts/GasLeft.sol

@@ -26,6 +26,7 @@ pragma solidity ^0.8;
 
 contract GasLeft {
     constructor() payable {
+        assert(gasleft() > gasleft());
         assert(gasleft() > 0 && gasleft() < 0xffffffffffffffff);
     }
 }

crates/integration/contracts/GasLimit.sol

@@ -26,6 +26,6 @@ pragma solidity ^0.8;
 
 contract GasLimit {
     constructor() payable {
-        assert(block.gaslimit > 0);
+        assert(block.gaslimit == 2000000000000);
     }
 }

crates/integration/contracts/GasPrice.sol

@@ -26,6 +26,6 @@ pragma solidity ^0.8;
 
 contract GasPrice {
     constructor() payable {
-        assert(tx.gasprice > 1000);
+        assert(tx.gasprice == 1000);
     }
 }

crates/integration/contracts/MLoad.sol

@@ -20,7 +20,7 @@ pragma solidity ^0.8.28;
                 "dest": {
                     "Instantiated": 0
                 },
-                "data": "0be0e4a60000000000000000000000000000000000000000000000000000000000000000"
+                "data": "e2179b8e"
             }
         }
     ]
@@ -29,12 +29,12 @@ pragma solidity ^0.8.28;
 
 contract MLoad {
     constructor() payable {
-        assert(loadAt(0) == 0);
+        assert(g() == 0);
     }
 
-    function loadAt(uint _offset) public payable returns (uint m) {
+    function g() public payable returns (uint m) {
         assembly {
-            m := mload(_offset)
+            m := mload(0)
         }
     }
 }

crates/integration/contracts/MemoryBounds.sol

@@ -1,36 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity ^0.8.24;
-
-/* runner.json
-{
-  "differential": true,
-  "actions": [
-    {
-      "Instantiate": {
-        "code": {
-          "Solidity": {
-            "contract": "MemoryBounds"
-          }
-        }
-      }
-    },
-    {
-      "Call": {
-        "dest": {
-          "Instantiated": 0
-        }
-      }
-    }
-  ]
-}
-*/
-
-contract MemoryBounds {
-    fallback() external {
-        assembly {
-            // Accessing OOB offsets should always work when the length is 0.
-            return(100000, 0)
-        }
-    }
-}

crates/integration/contracts/Selfdestruct.sol

@@ -1,66 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity ^0.8;
-
-// TODO: This currently fails the differential test.
-// The pallet doesn't send the correct balance back.
-
-/* runner.json
-{
-    "differential": false,
-    "actions": [
-        {
-            "Upload": {
-                "code": {
-                    "Solidity": {
-                        "contract": "SelfdestructTester"
-                    }
-                }
-            }
-        },
-        {
-            "Instantiate": {
-                "code": {
-                    "Solidity": {
-                        "contract": "Selfdestruct"
-                    }
-                },
-                "value": 123456789
-            }
-        },
-        {
-            "Call": {
-                "dest": {
-                    "Instantiated": 0
-                }
-            }
-        }
-    ]
-}
-*/
-
-contract Selfdestruct {
-    address tester;
-    uint value;
-
-    constructor() payable {
-        require(msg.value > 0, "the test should have value");
-        value = msg.value;
-
-        SelfdestructTester s = new SelfdestructTester{value: msg.value}();
-        tester = address(s);
-    }
-
-    fallback() external {
-        (bool success, ) = tester.call(hex"");
-        require(success, "the call to the self destructing contract should succeed");
-    }
-}
-
-contract SelfdestructTester {
-    constructor() payable {}
-
-    fallback() external {
-        selfdestruct(payable(msg.sender));
-    }
-}

crates/integration/contracts/Send.sol

@@ -23,6 +23,11 @@ pragma solidity ^0.8;
                 "data": "1c8d16b30000000000000000000000000303030303030303030303030303030303030303000000000000000000000000000000000000000000000000000000000000000a"
             }
         },
+        {
+            "VerifyCall": {
+                "success": true
+            }
+        },
         {
             "Call": {
                 "dest": {
@@ -31,6 +36,11 @@ pragma solidity ^0.8;
                 "data": "fb9e8d050000000000000000000000000000000000000000000000000000000000000001"
             }
         },
+        {
+            "VerifyCall": {
+                "success": false
+            }
+        },
         {
             "Call": {
                 "dest": {
@@ -38,6 +48,11 @@ pragma solidity ^0.8;
                 },
                 "data": "fb9e8d050000000000000000000000000000000000000000000000000000000000000000"
             }
+        },
+        {
+            "VerifyCall": {
+                "success": false
+            }
         }
     ]
 }

crates/integration/contracts/Transfer.sol

@@ -23,6 +23,11 @@ pragma solidity ^0.8;
                 "data": "1c8d16b30000000000000000000000000303030303030303030303030303030303030303000000000000000000000000000000000000000000000000000000000000000a"
             }
         },
+        {
+            "VerifyCall": {
+                "success": true
+            }
+        },
         {
             "Call": {
                 "dest": {
@@ -31,6 +36,11 @@ pragma solidity ^0.8;
                 "data": "fb9e8d050000000000000000000000000000000000000000000000000000000000000001"
             }
         },
+        {
+            "VerifyCall": {
+                "success": false
+            }
+        },
         {
             "Call": {
                 "dest": {
@@ -38,6 +48,11 @@ pragma solidity ^0.8;
                 },
                 "data": "fb9e8d050000000000000000000000000000000000000000000000000000000000000000"
             }
+        },
+        {
+            "VerifyCall": {
+                "success": false
+            }
         }
     ]
 }

crates/integration/src/cases.rs

@@ -10,29 +10,6 @@ pub struct Contract {
     pub evm_runtime: Vec<u8>,
     pub pvm_runtime: Vec<u8>,
     pub calldata: Vec<u8>,
-    pub yul: String,
-}
-
-impl Contract {
-    pub fn build(calldata: Vec<u8>, name: &'static str, code: &str) -> Self {
-        Self {
-            name,
-            evm_runtime: compile_evm_bin_runtime(name, code),
-            pvm_runtime: compile_blob(name, code),
-            calldata,
-            yul: compile_to_yul(name, code, true),
-        }
-    }
-
-    pub fn build_size_opt(calldata: Vec<u8>, name: &'static str, code: &str) -> Self {
-        Self {
-            name,
-            evm_runtime: compile_evm_bin_runtime(name, code),
-            pvm_runtime: compile_blob_with_options(name, code, true, OptimizerSettings::size()),
-            calldata,
-            yul: compile_to_yul(name, code, true),
-        }
-    }
 }
 
 macro_rules! case {
@@ -234,15 +211,6 @@ sol!(
 );
 case!("MCopy.sol", MCopy, memcpyCall, memcpy, payload: Bytes);
 
-sol!(
-    contract MLoad {
-        constructor() payable;
-
-        function loadAt(uint _offset) public payable returns (uint m);
-    }
-);
-case!("MLoad.sol", MLoad, loadAtCall, load_at, _offset: U256);
-
 sol!(
     contract Call {
         function value_transfer(address payable destination) public payable;
@@ -293,6 +261,26 @@ sol!(
 case!("AddressPredictor.sol", Predicted, constructorCall, predicted_constructor, salt: U256);
 case!("AddressPredictor.sol", AddressPredictor, constructorCall, address_predictor_constructor, salt: U256, bytecode: Bytes);
 
+impl Contract {
+    pub fn build(calldata: Vec<u8>, name: &'static str, code: &str) -> Self {
+        Self {
+            name,
+            evm_runtime: compile_evm_bin_runtime(name, code),
+            pvm_runtime: compile_blob(name, code),
+            calldata,
+        }
+    }
+
+    pub fn build_size_opt(calldata: Vec<u8>, name: &'static str, code: &str) -> Self {
+        Self {
+            name,
+            evm_runtime: compile_evm_bin_runtime(name, code),
+            pvm_runtime: compile_blob_with_options(name, code, true, OptimizerSettings::size()),
+            calldata,
+        }
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use rayon::iter::{IntoParallelIterator, ParallelIterator};

crates/integration/src/tests.rs

@@ -1,7 +1,6 @@
 use std::str::FromStr;
 
 use alloy_primitives::*;
-use resolc::test_utils::build_yul;
 use revive_runner::*;
 use SpecsAction::*;
 
@@ -62,11 +61,6 @@ test_spec!(delegate_no_contract, "DelegateCaller", "DelegateCaller.sol");
 test_spec!(function_type, "FunctionType", "FunctionType.sol");
 test_spec!(layout_at, "LayoutAt", "LayoutAt.sol");
 test_spec!(shift_arithmetic_right, "SAR", "SAR.sol");
-test_spec!(add_mod_mul_mod, "AddModMulModTester", "AddModMulMod.sol");
-test_spec!(memory_bounds, "MemoryBounds", "MemoryBounds.sol");
-test_spec!(selfdestruct, "Selfdestruct", "Selfdestruct.sol");
-test_spec!(clz, "CountLeadingZeros", "CountLeadingZeros.sol");
-test_spec!(call_gas, "CallGas", "CallGas.sol");
 
 fn instantiate(path: &str, contract: &str) -> Vec<SpecsAction> {
     vec![Instantiate {
@@ -173,8 +167,6 @@ fn signed_division() {
         (minus_five, two),
         (I256::MINUS_ONE, I256::MIN),
         (one, I256::ZERO),
-        (I256::MIN, I256::MINUS_ONE),
-        (I256::MIN + I256::ONE, I256::MINUS_ONE),
     ] {
         actions.push(Call {
             origin: TestAddress::Alice,
@@ -452,6 +444,50 @@ fn ext_code_size() {
     .run();
 }
 
+#[test]
+#[should_panic(expected = "ReentranceDenied")]
+fn send_denies_reentrancy() {
+    let value = 1000;
+    Specs {
+        actions: vec![
+            instantiate("contracts/Send.sol", "Send").remove(0),
+            Call {
+                origin: TestAddress::Alice,
+                dest: TestAddress::Instantiated(0),
+                value,
+                gas_limit: None,
+                storage_deposit_limit: None,
+                data: Contract::send_self(U256::from(value)).calldata,
+            },
+        ],
+        differential: false,
+        ..Default::default()
+    }
+    .run();
+}
+
+#[test]
+#[should_panic(expected = "ReentranceDenied")]
+fn transfer_denies_reentrancy() {
+    let value = 1000;
+    Specs {
+        actions: vec![
+            instantiate("contracts/Transfer.sol", "Transfer").remove(0),
+            Call {
+                origin: TestAddress::Alice,
+                dest: TestAddress::Instantiated(0),
+                value,
+                gas_limit: None,
+                storage_deposit_limit: None,
+                data: Contract::transfer_self(U256::from(value)).calldata,
+            },
+        ],
+        differential: false,
+        ..Default::default()
+    }
+    .run();
+}
+
 #[test]
 fn create2_salt() {
     let salt = U256::from(777);
@@ -479,233 +515,3 @@ fn create2_salt() {
     }
     .run();
 }
-
-#[test]
-fn code_block_stops() {
-    let code = &build_yul(&[(
-        "poc.yul",
-        r#"object "Test"{
-  code {
-    tstore(0x7fd9d641,0x7b1e022)
-    returndatacopy(0x0,0x0,returndatasize())
-  }
-  object "Test_deployed" { code{} }
-}"#,
-    )])
-    .unwrap()["poc.yul:Test"];
-
-    Specs {
-        actions: vec![
-            Instantiate {
-                origin: TestAddress::Alice,
-                value: 0,
-                gas_limit: Some(GAS_LIMIT),
-                storage_deposit_limit: None,
-                code: Code::Bytes(code.to_vec()),
-                data: Default::default(),
-                salt: OptionalHex::default(),
-            },
-            Call {
-                origin: TestAddress::Alice,
-                dest: TestAddress::Instantiated(0),
-                value: Default::default(),
-                gas_limit: None,
-                storage_deposit_limit: None,
-                data: Default::default(),
-            },
-            VerifyCall(Default::default()),
-        ],
-        differential: false,
-        ..Default::default()
-    }
-    .run();
-}
-
-#[test]
-fn code_block_with_nested_object_stops() {
-    let code = &build_yul(&[(
-        "poc.yul",
-        r#"object "Test" {
-    code {
-        function allocate(size) -> ptr {
-            ptr := mload(0x40)
-            if iszero(ptr) { ptr := 0x60 }
-            mstore(0x40, add(ptr, size))
-        }
-        let size := datasize("Test_deployed")
-        let offset := allocate(size)
-        datacopy(offset, dataoffset("Test_deployed"), size)
-        return(offset, size)
-    }
-    object "Test_deployed" {
-        code {
-            sstore(0, 100)
-	 }
-        object "Test" {
-            code {
-	    revert(0,0)
-            }
-        }
-    }
-}"#,
-    )])
-    .unwrap()["poc.yul:Test"];
-
-    Specs {
-        actions: vec![
-            Instantiate {
-                origin: TestAddress::Alice,
-                value: 0,
-                gas_limit: Some(GAS_LIMIT),
-                storage_deposit_limit: None,
-                code: Code::Bytes(code.to_vec()),
-                data: Default::default(),
-                salt: OptionalHex::default(),
-            },
-            Call {
-                origin: TestAddress::Alice,
-                dest: TestAddress::Instantiated(0),
-                value: Default::default(),
-                gas_limit: None,
-                storage_deposit_limit: None,
-                data: Default::default(),
-            },
-            VerifyCall(Default::default()),
-        ],
-        differential: false,
-        ..Default::default()
-    }
-    .run();
-}
-
-#[test]
-fn sbrk_bounds_checks() {
-    let code = &build_yul(&[(
-        "poc.yul",
-        r#"object "Test" {
-    code {
-        return(0x4, 0xffffffff)
-        stop()
-    }
-    object "Test_deployed" {
-        code {
-            stop()
-        }
-    }
-}"#,
-    )])
-    .unwrap()["poc.yul:Test"];
-
-    let results = Specs {
-        actions: vec![
-            Instantiate {
-                origin: TestAddress::Alice,
-                value: 0,
-                gas_limit: Some(GAS_LIMIT),
-                storage_deposit_limit: None,
-                code: Code::Bytes(code.to_vec()),
-                data: Default::default(),
-                salt: OptionalHex::default(),
-            },
-            VerifyCall(VerifyCallExpectation {
-                success: false,
-                ..Default::default()
-            }),
-        ],
-        differential: false,
-        ..Default::default()
-    }
-    .run();
-
-    let CallResult::Instantiate { result, .. } = results.last().unwrap() else {
-        unreachable!()
-    };
-
-    assert!(
-        format!("{result:?}").contains("ContractTrapped"),
-        "not seeing a trap means the contract did not catch the OOB"
-    );
-}
-
-#[test]
-fn invalid_opcode_works() {
-    let code = &build_yul(&[(
-        "invalid.yul",
-        r#"object "Test" {
-    code {
-        invalid()
-    }
-    object "Test_deployed" {
-        code {
-            invalid()
-        }
-    }
-}"#,
-    )])
-    .unwrap()["invalid.yul:Test"];
-
-    let results = Specs {
-        actions: vec![
-            Instantiate {
-                origin: TestAddress::Alice,
-                value: 0,
-                gas_limit: Some(GAS_LIMIT),
-                storage_deposit_limit: None,
-                code: Code::Bytes(code.to_vec()),
-                data: Default::default(),
-                salt: OptionalHex::default(),
-            },
-            VerifyCall(VerifyCallExpectation {
-                success: false,
-                ..Default::default()
-            }),
-        ],
-        differential: false,
-        ..Default::default()
-    }
-    .run();
-
-    let CallResult::Instantiate { result, .. } = results.last().unwrap() else {
-        unreachable!()
-    };
-
-    assert_eq!(result.weight_consumed, GAS_LIMIT);
-}
-
-/// Load from heap memory using an out of bounds offset and expect the
-/// contract to hit the `invalid` syscall to use all gas (like on EVM).
-///
-/// The offset is picked such that a regular truncate would be in bounds.
-#[test]
-fn safe_truncate_int_to_xlen_works() {
-    let offset = 0x10000000_00000000u64;
-    let data = Contract::load_at(Uint::from(offset)).calldata;
-    let mut actions = instantiate("contracts/MLoad.sol", "MLoad");
-    actions.append(&mut vec![
-        Call {
-            origin: TestAddress::Alice,
-            dest: TestAddress::Instantiated(0),
-            value: 0,
-            gas_limit: None,
-            storage_deposit_limit: None,
-            data,
-        },
-        VerifyCall(VerifyCallExpectation {
-            success: false,
-            ..Default::default()
-        }),
-    ]);
-
-    let results = Specs {
-        actions,
-        differential: true,
-        ..Default::default()
-    }
-    .run();
-
-    let CallResult::Exec { result, .. } = results.last().unwrap() else {
-        unreachable!()
-    };
-
-    assert_eq!(result.weight_consumed, GAS_LIMIT);
-}

crates/linker/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "revive-linker"
-version = "0.2.0"
+version.workspace = true
 license.workspace = true
 edition.workspace = true
 repository.workspace = true
@@ -8,10 +8,10 @@ authors.workspace = true
 description = "revive compiler linker utils"
 
 [dependencies]
-anyhow = { workspace = true }
-libc = { workspace = true }
-polkavm-linker = { workspace = true }
 tempfile = { workspace = true }
+polkavm-linker = { workspace = true }
+libc = { workspace = true }
+anyhow = { workspace = true }
 
-lld-sys = { workspace = true }
 revive-builtins = { workspace = true }
+lld-sys = { workspace = true }

crates/linker/src/elf.rs

@@ -1,114 +0,0 @@
-//! The revive ELF object linker library.
-
-use std::{ffi::CString, fs, path::PathBuf, sync::Mutex};
-
-use lld_sys::LLDELFLink;
-use tempfile::TempDir;
-
-use revive_builtins::COMPILER_RT;
-
-static GUARD: Mutex<()> = Mutex::new(());
-
-/// The revive ELF object linker.
-pub struct ElfLinker {
-    temporary_directory: TempDir,
-    output_path: PathBuf,
-    object_path: PathBuf,
-    symbols_path: PathBuf,
-    linker_script_path: PathBuf,
-}
-
-impl ElfLinker {
-    const LINKER_SCRIPT: &str = r#"
-SECTIONS {
-    .text : { KEEP(*(.text.polkavm_export)) *(.text .text.*) }
-}"#;
-
-    const BUILTINS_ARCHIVE_FILE: &str = "libclang_rt.builtins-riscv64.a";
-    const BUILTINS_LIB_NAME: &str = "clang_rt.builtins-riscv64";
-
-    /// The setup routine prepares a temporary working directory.
-    pub fn setup() -> anyhow::Result<Self> {
-        let temporary_directory = TempDir::new()?;
-        let object_path = temporary_directory.path().join("obj.o");
-        let output_path = temporary_directory.path().join("out.o");
-        let symbols_path = temporary_directory.path().join("sym.o");
-        let linker_script_path = temporary_directory.path().join("linker.ld");
-
-        fs::write(&linker_script_path, Self::LINKER_SCRIPT)
-            .map_err(|message| anyhow::anyhow!("{message} {linker_script_path:?}",))?;
-
-        let compiler_rt_path = temporary_directory.path().join(Self::BUILTINS_ARCHIVE_FILE);
-        fs::write(&compiler_rt_path, COMPILER_RT)
-            .map_err(|message| anyhow::anyhow!("{message} {compiler_rt_path:?}"))?;
-
-        Ok(Self {
-            temporary_directory,
-            output_path,
-            object_path,
-            symbols_path,
-            linker_script_path,
-        })
-    }
-
-    /// Link `input` with `symbols` and the `compiler_rt` via `LLD`.
-    pub fn link<T: AsRef<[u8]>>(self, input: T, symbols: T) -> anyhow::Result<Vec<u8>> {
-        fs::write(&self.object_path, input)
-            .map_err(|message| anyhow::anyhow!("{message} {:?}", self.object_path))?;
-
-        fs::write(&self.symbols_path, symbols)
-            .map_err(|message| anyhow::anyhow!("{message} {:?}", self.symbols_path))?;
-
-        if lld(self
-            .create_arguments()
-            .into_iter()
-            .map(|v| v.to_string())
-            .collect())
-        {
-            return Err(anyhow::anyhow!("ld.lld failed"));
-        }
-
-        Ok(fs::read(&self.output_path)?)
-    }
-
-    /// The argument creation helper function.
-    fn create_arguments(&self) -> Vec<String> {
-        [
-            "ld.lld",
-            "--error-limit=0",
-            "--relocatable",
-            "--emit-relocs",
-            "--relax",
-            "--unique",
-            "--gc-sections",
-            self.linker_script_path.to_str().expect("should be utf8"),
-            "-o",
-            self.output_path.to_str().expect("should be utf8"),
-            self.object_path.to_str().expect("should be utf8"),
-            self.symbols_path.to_str().expect("should be utf8"),
-            "--library-path",
-            self.temporary_directory
-                .path()
-                .to_str()
-                .expect("should be utf8"),
-            "--library",
-            Self::BUILTINS_LIB_NAME,
-        ]
-        .iter()
-        .map(ToString::to_string)
-        .collect()
-    }
-}
-
-/// The thread-safe LLD helper function.
-fn lld(arguments: Vec<String>) -> bool {
-    let c_strings = arguments
-        .into_iter()
-        .map(|arg| CString::new(arg).expect("ld.lld args should not contain null bytes"))
-        .collect::<Vec<_>>();
-
-    let args: Vec<*const libc::c_char> = c_strings.iter().map(|arg| arg.as_ptr()).collect();
-
-    let _lock = GUARD.lock().expect("ICE: linker mutex should not poison");
-    unsafe { LLDELFLink(args.as_ptr(), args.len()) == 0 }
-}

crates/linker/src/lib.rs

@@ -1,4 +1,76 @@
-//! The revive ELF object to PVM blob linker library.
+use std::{env, ffi::CString, fs};
 
-pub mod elf;
+use lld_sys::LLDELFLink;
-pub mod pvm;
+use revive_builtins::COMPILER_RT;
+
+const LINKER_SCRIPT: &str = r#"
+SECTIONS {
+    .text : { KEEP(*(.text.polkavm_export)) *(.text .text.*) }
+}"#;
+
+const BUILTINS_ARCHIVE_FILE: &str = "libclang_rt.builtins-riscv64.a";
+const BUILTINS_LIB_NAME: &str = "clang_rt.builtins-riscv64";
+
+fn invoke_lld(cmd_args: &[&str]) -> bool {
+    let c_strings = cmd_args
+        .iter()
+        .map(|arg| CString::new(*arg).expect("ld.lld args should not contain null bytes"))
+        .collect::<Vec<_>>();
+
+    let args: Vec<*const libc::c_char> = c_strings.iter().map(|arg| arg.as_ptr()).collect();
+
+    unsafe { LLDELFLink(args.as_ptr(), args.len()) == 0 }
+}
+
+pub fn polkavm_linker<T: AsRef<[u8]>>(code: T, strip_binary: bool) -> anyhow::Result<Vec<u8>> {
+    let mut config = polkavm_linker::Config::default();
+    config.set_strip(strip_binary);
+    config.set_optimize(true);
+
+    polkavm_linker::program_from_elf(config, code.as_ref())
+        .map_err(|reason| anyhow::anyhow!("polkavm linker failed: {}", reason))
+}
+
+pub fn link<T: AsRef<[u8]>>(input: T) -> anyhow::Result<Vec<u8>> {
+    let dir = tempfile::tempdir().expect("failed to create temp directory for linking");
+    let output_path = dir.path().join("out.so");
+    let object_path = dir.path().join("out.o");
+    let linker_script_path = dir.path().join("linker.ld");
+    let compiler_rt_path = dir.path().join(BUILTINS_ARCHIVE_FILE);
+
+    fs::write(&object_path, input).map_err(|msg| anyhow::anyhow!("{msg} {object_path:?}"))?;
+
+    if env::var("PVM_LINKER_DUMP_OBJ").is_ok() {
+        fs::copy(&object_path, "/tmp/out.o")?;
+    }
+
+    fs::write(&linker_script_path, LINKER_SCRIPT)
+        .map_err(|msg| anyhow::anyhow!("{msg} {linker_script_path:?}"))?;
+
+    fs::write(&compiler_rt_path, COMPILER_RT)
+        .map_err(|msg| anyhow::anyhow!("{msg} {compiler_rt_path:?}"))?;
+
+    let ld_args = [
+        "ld.lld",
+        "--error-limit=0",
+        "--relocatable",
+        "--emit-relocs",
+        "--no-relax",
+        "--unique",
+        "--gc-sections",
+        "--library-path",
+        dir.path().to_str().expect("should be utf8"),
+        "--library",
+        BUILTINS_LIB_NAME,
+        linker_script_path.to_str().expect("should be utf8"),
+        object_path.to_str().expect("should be utf8"),
+        "-o",
+        output_path.to_str().expect("should be utf8"),
+    ];
+
+    if invoke_lld(&ld_args) {
+        return Err(anyhow::anyhow!("ld.lld failed"));
+    }
+
+    Ok(fs::read(&output_path)?)
+}

crates/linker/src/pvm.rs

@@ -1,14 +0,0 @@
-//! The revive PVM blob linker library.
-
-pub fn polkavm_linker<T: AsRef<[u8]>>(code: T, strip_binary: bool) -> anyhow::Result<Vec<u8>> {
-    let mut config = polkavm_linker::Config::default();
-    config.set_strip(strip_binary);
-    config.set_optimize(true);
-
-    polkavm_linker::program_from_elf(
-        config,
-        polkavm_linker::TargetInstructionSet::ReviveV1,
-        code.as_ref(),
-    )
-    .map_err(|reason| anyhow::anyhow!("polkavm linker failed: {}", reason))
-}

crates/llvm-builder/Cargo.toml

@@ -6,7 +6,7 @@ authors = [
     "Anton Baliasnikov <aba@matterlabs.dev>",
     "Cyrill Leutwiler <cyrill@parity.io>",
 ]
-version = "0.4.0"
+version = "0.2.0"
 license.workspace = true
 edition.workspace = true
 repository.workspace = true
@@ -21,6 +21,8 @@ doctest = false
 [dependencies]
 clap = { workspace = true, features = ["help", "std", "derive"] }
 anyhow = { workspace = true }
+serde = { workspace = true, features = [ "derive" ] }
+toml = { workspace = true }
 num_cpus = { workspace = true }
 fs_extra = { workspace = true }
 path-slash = { workspace = true }

crates/llvm-builder/README.md

@@ -59,7 +59,7 @@ Obtain a compatible build for your host platform from the release section of thi
 
    * Install the builder using `cargo`:
       ```shell
-      cargo install --force --locked --path crates/llvm-builder
+      cargo install --git https://github.com/paritytech/revive-llvm-builder --force --locked
       ```
 
       > The builder is not the LLVM framework itself, but a tool that clones its repository and runs a sequence of build commands. By default it is installed in `~/.cargo/bin/`, which is recommended to be added to your `$PATH`.
@@ -67,6 +67,12 @@ Obtain a compatible build for your host platform from the release section of thi
 </details>
 
 <details>
+<summary>4. (Optional) Create the `LLVM.lock` file.</summary>
+
+   * The `LLVM.lock` dictates the LLVM source tree being used.
+     A default `./LLVM.lock` pointing to the release used for development is already provided.
+
+</details>
 
 <details>
 <summary>5. Build LLVM.</summary>
@@ -82,12 +88,7 @@ Obtain a compatible build for your host platform from the release section of thi
 
       Build artifacts end up in the `./target-llvm/gnu/target-final/` directory by default.
       The `gnu` directory depends on the supported archticture and will either be `gnu`, `musl` or `emscripten`.
-      You now need to export the final target directory `$LLVM_SYS_181_PREFIX`:
+      You now need to export the final target directory `$LLVM_SYS_181_PREFIX`: `export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final`
-
-      ```shell
-      export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final
-      ```
-
       If built with the `--enable-tests` option, test tools will be in the `./target-llvm/gnu/build-final/` directory, along with copies of the build artifacts. For all supported build options, run `revive-llvm build --help`.
 
 </details>

crates/llvm-builder/src/builtins.rs

@@ -4,14 +4,13 @@ use crate::utils::path_windows_to_unix as to_unix;
 use std::{env::consts::EXE_EXTENSION, process::Command};
 
 /// Static CFLAGS variable passed to the compiler building the compiler-rt builtins.
-const C_FLAGS: [&str; 7] = [
+const C_FLAGS: [&str; 6] = [
     "--target=riscv64",
     "-march=rv64emac",
     "-mabi=lp64e",
     "-mcpu=generic-rv64",
     "-nostdlib",
     "-nodefaultlibs",
-    "-fuse-ld=lld",
 ];
 
 /// Static CMAKE arguments for building the compiler-rt builtins.

crates/llvm-builder/src/lib.rs

@@ -5,6 +5,7 @@ pub mod builtins;
 pub mod ccache_variant;
 pub mod llvm_path;
 pub mod llvm_project;
+pub mod lock;
 pub mod platforms;
 pub mod sanitizer;
 pub mod target_env;
@@ -13,6 +14,7 @@ pub mod utils;
 
 pub use self::build_type::BuildType;
 pub use self::llvm_path::LLVMPath;
+pub use self::lock::Lock;
 pub use self::platforms::Platform;
 
 use std::collections::HashSet;
@@ -21,25 +23,87 @@ use std::process::Command;
 pub use target_env::TargetEnv;
 pub use target_triple::TargetTriple;
 
-/// Initializes the LLVM submodule if not already done.
+/// Executes the LLVM repository cloning.
-pub fn init(init_emscripten: bool) -> anyhow::Result<()> {
+pub fn clone(lock: Lock, deep: bool, target_env: TargetEnv) -> anyhow::Result<()> {
     utils::check_presence("git")?;
 
-    if init_emscripten {
+    if target_env == TargetEnv::Emscripten {
         utils::install_emsdk()?;
     }
 
     let destination_path = PathBuf::from(LLVMPath::DIRECTORY_LLVM_SOURCE);
-    if destination_path.join(".git").exists() {
+    if destination_path.exists() {
-        log::info!("LLVM submodule already initialized");
+        log::warn!(
-        return Ok(());
+            "LLVM repository directory {} already exists, falling back to checkout",
+            destination_path.display()
+        );
+        return checkout(lock, false);
+    }
+
+    let mut clone_args = vec!["clone", "--branch", lock.branch.as_str()];
+    if !deep {
+        clone_args.push("--depth");
+        clone_args.push("1");
     }
 
     utils::command(
-        Command::new("git").args(["submodule", "update", "--init", "--recursive"]),
+        Command::new("git")
-        "LLVM submodule initialization",
+            .args(clone_args)
+            .arg(lock.url.as_str())
+            .arg(destination_path.to_string_lossy().as_ref()),
+        "LLVM repository cloning",
     )?;
 
+    if let Some(r#ref) = lock.r#ref {
+        utils::command(
+            Command::new("git")
+                .args(["checkout", r#ref.as_str()])
+                .current_dir(destination_path.to_string_lossy().as_ref()),
+            "LLVM repository commit checking out",
+        )?;
+    }
+
+    Ok(())
+}
+
+/// Executes the checkout of the specified branch.
+pub fn checkout(lock: Lock, force: bool) -> anyhow::Result<()> {
+    let destination_path = PathBuf::from(LLVMPath::DIRECTORY_LLVM_SOURCE);
+
+    utils::command(
+        Command::new("git")
+            .current_dir(destination_path.as_path())
+            .args(["fetch", "--all", "--tags"]),
+        "LLVM repository data fetching",
+    )?;
+
+    if force {
+        utils::command(
+            Command::new("git")
+                .current_dir(destination_path.as_path())
+                .args(["clean", "-d", "-x", "--force"]),
+            "LLVM repository cleaning",
+        )?;
+    }
+
+    utils::command(
+        Command::new("git")
+            .current_dir(destination_path.as_path())
+            .args(["checkout", "--force", lock.branch.as_str()]),
+        "LLVM repository data pulling",
+    )?;
+
+    if let Some(r#ref) = lock.r#ref {
+        let mut checkout_command = Command::new("git");
+        checkout_command.current_dir(destination_path.as_path());
+        checkout_command.arg("checkout");
+        if force {
+            checkout_command.arg("--force");
+        }
+        checkout_command.arg(r#ref);
+        utils::command(&mut checkout_command, "LLVM repository checking out")?;
+    }
+
     Ok(())
 }
 
@@ -268,6 +332,8 @@ pub fn clean() -> anyhow::Result<()> {
             .expect("target_env parent directory is target-llvm"),
     )?;
     remove_if_exists(&PathBuf::from(LLVMPath::DIRECTORY_EMSDK_SOURCE))?;
+    remove_if_exists(&PathBuf::from(LLVMPath::DIRECTORY_LLVM_SOURCE))?;
+    remove_if_exists(&PathBuf::from(LLVMPath::DIRECTORY_LLVM_HOST_SOURCE))?;
 
     Ok(())
 }

crates/llvm-builder/src/lock.rs

@@ -0,0 +1,37 @@
+//! The revive LLVM builder lock file.
+
+use anyhow::Context;
+use std::fs::File;
+use std::io::Read;
+use std::path::PathBuf;
+
+use serde::Deserialize;
+use serde::Serialize;
+
+/// The default lock file location.
+pub const LLVM_LOCK_DEFAULT_PATH: &str = "LLVM.lock";
+
+/// The lock file data.
+///
+/// This file describes the exact reference of the LLVM framework.
+#[derive(Debug, Deserialize, Serialize)]
+pub struct Lock {
+    /// The LLVM repository URL.
+    pub url: String,
+    /// The LLVM repository branch.
+    pub branch: String,
+    /// The LLVM repository commit reference.
+    pub r#ref: Option<String>,
+}
+
+impl TryFrom<&PathBuf> for Lock {
+    type Error = anyhow::Error;
+
+    fn try_from(path: &PathBuf) -> Result<Self, Self::Error> {
+        let mut config_str = String::new();
+        let mut config_file =
+            File::open(path).with_context(|| format!("Error opening {path:?} file"))?;
+        config_file.read_to_string(&mut config_str)?;
+        Ok(toml::from_str(&config_str)?)
+    }
+}

crates/llvm-builder/src/revive_llvm/arguments.rs

@@ -18,6 +18,13 @@ pub struct Arguments {
 /// The revive LLVM builder arguments.
 #[derive(Debug, clap::Subcommand)]
 pub enum Subcommand {
+    /// Clone the branch specified in `LLVM.lock`.
+    Clone {
+        /// Clone with full commits history.
+        #[arg(long)]
+        deep: bool,
+    },
+
     /// Build the LLVM framework.
     Build {
         /// LLVM build type (`Debug`, `Release`, `RelWithDebInfo`, or `MinSizeRel`).
@@ -70,8 +77,12 @@ pub enum Subcommand {
         enable_valgrind: bool,
     },
 
-    /// Install emsdk
+    /// Checkout the branch specified in `LLVM.lock`.
-    Emsdk,
+    Checkout {
+        /// Remove all artifacts preventing the checkout (removes all local changes!).
+        #[arg(long)]
+        force: bool,
+    },
 
     /// Clean the build artifacts.
     Clean,

crates/llvm-builder/src/revive_llvm/main.rs

@@ -3,6 +3,7 @@
 pub(crate) mod arguments;
 
 use std::collections::HashSet;
+use std::path::PathBuf;
 use std::str::FromStr;
 
 use anyhow::Context;
@@ -28,6 +29,13 @@ fn main_inner() -> anyhow::Result<()> {
     revive_llvm_builder::utils::directory_target_llvm(arguments.target_env);
 
     match arguments.subcommand {
+        Subcommand::Clone { deep } => {
+            let lock = revive_llvm_builder::Lock::try_from(&PathBuf::from(
+                revive_llvm_builder::lock::LLVM_LOCK_DEFAULT_PATH,
+            ))?;
+            revive_llvm_builder::clone(lock, deep, arguments.target_env)?;
+        }
+
         Subcommand::Build {
             build_type,
             targets,
@@ -42,8 +50,6 @@ fn main_inner() -> anyhow::Result<()> {
             sanitizer,
             enable_valgrind,
         } => {
-            revive_llvm_builder::init(false)?;
-
             let mut targets = targets
                 .into_iter()
                 .map(|target| revive_llvm_builder::Platform::from_str(target.as_str()))
@@ -101,8 +107,11 @@ fn main_inner() -> anyhow::Result<()> {
             )?;
         }
 
-        Subcommand::Emsdk => {
+        Subcommand::Checkout { force } => {
-            revive_llvm_builder::init(true)?;
+            let lock = revive_llvm_builder::Lock::try_from(&PathBuf::from(
+                revive_llvm_builder::lock::LLVM_LOCK_DEFAULT_PATH,
+            ))?;
+            revive_llvm_builder::checkout(lock, force)?;
         }
 
         Subcommand::Clean => {

crates/llvm-builder/tests/build.rs

@@ -2,14 +2,20 @@ pub mod common;
 
 use std::process::Command;
 
-use assert_cmd::{cargo, prelude::*};
+use assert_cmd::prelude::*;
 
-/// This test verifies that the LLVM repository can be successfully built and cleaned.
+/// This test verifies that the LLVM repository can be successfully cloned, built, and cleaned.
 #[test]
-fn build_and_clean() -> anyhow::Result<()> {
+fn clone_build_and_clean() -> anyhow::Result<()> {
-    let test_dir = common::TestDir::new()?;
+    let test_dir = common::TestDir::with_lockfile(None)?;
 
-    Command::new(cargo::cargo_bin!("revive-llvm"))
+    Command::cargo_bin(common::REVIVE_LLVM)?
+        .current_dir(test_dir.path())
+        .arg("clone")
+        .assert()
+        .success();
+
+    Command::cargo_bin(common::REVIVE_LLVM)?
         .current_dir(test_dir.path())
         .arg("build")
         .arg("--llvm-projects")
@@ -19,13 +25,13 @@ fn build_and_clean() -> anyhow::Result<()> {
         .assert()
         .success();
 
-    Command::new(cargo::cargo_bin!("revive-llvm"))
+    Command::cargo_bin(common::REVIVE_LLVM)?
         .current_dir(test_dir.path())
         .arg("builtins")
         .assert()
         .success();
 
-    Command::new(cargo::cargo_bin!("revive-llvm"))
+    Command::cargo_bin(common::REVIVE_LLVM)?
         .current_dir(test_dir.path())
         .arg("clean")
         .assert()
@@ -34,14 +40,20 @@ fn build_and_clean() -> anyhow::Result<()> {
     Ok(())
 }
 
-/// This test verifies that the LLVM repository can be successfully built and cleaned
+/// This test verifies that the LLVM repository can be successfully cloned, built, and cleaned
 /// with 2-staged build using MUSL as sysroot.
 #[test]
 #[cfg(target_os = "linux")]
-fn build_and_clean_musl() -> anyhow::Result<()> {
+fn clone_build_and_clean_musl() -> anyhow::Result<()> {
-    let test_dir = common::TestDir::new()?;
+    let test_dir = common::TestDir::with_lockfile(None)?;
 
-    Command::new(cargo::cargo_bin!("revive-llvm"))
+    Command::cargo_bin(common::REVIVE_LLVM)?
+        .arg("clone")
+        .current_dir(test_dir.path())
+        .assert()
+        .success();
+
+    Command::cargo_bin(common::REVIVE_LLVM)?
         .current_dir(test_dir.path())
         .arg("build")
         .arg("--llvm-projects")
@@ -51,7 +63,7 @@ fn build_and_clean_musl() -> anyhow::Result<()> {
         .assert()
         .success();
 
-    Command::new(cargo::cargo_bin!("revive-llvm"))
+    Command::cargo_bin(common::REVIVE_LLVM)?
         .arg("--target-env")
         .arg("musl")
         .arg("build")
@@ -63,7 +75,7 @@ fn build_and_clean_musl() -> anyhow::Result<()> {
         .assert()
         .success();
 
-    Command::new(cargo::cargo_bin!("revive-llvm"))
+    Command::cargo_bin(common::REVIVE_LLVM)?
         .current_dir(test_dir.path())
         .arg("clean")
         .assert()
@@ -72,14 +84,20 @@ fn build_and_clean_musl() -> anyhow::Result<()> {
     Ok(())
 }
 
-/// This test verifies that the LLVM repository can be successfully built in debug mode
+/// This test verifies that the LLVM repository can be successfully cloned and built in debug mode
 /// with tests and coverage enabled.
 #[test]
 #[cfg(target_os = "linux")]
 fn debug_build_with_tests_coverage() -> anyhow::Result<()> {
-    let test_dir = common::TestDir::new()?;
+    let test_dir = common::TestDir::with_lockfile(None)?;
 
-    Command::new(cargo::cargo_bin!("revive-llvm"))
+    Command::cargo_bin(common::REVIVE_LLVM)?
+        .current_dir(test_dir.path())
+        .arg("clone")
+        .assert()
+        .success();
+
+    Command::cargo_bin(common::REVIVE_LLVM)?
         .current_dir(test_dir.path())
         .arg("build")
         .arg("--enable-coverage")
@@ -100,9 +118,15 @@ fn debug_build_with_tests_coverage() -> anyhow::Result<()> {
 #[test]
 #[cfg(target_os = "linux")]
 fn build_with_sanitizers() -> anyhow::Result<()> {
-    let test_dir = common::TestDir::new()?;
+    let test_dir = common::TestDir::with_lockfile(None)?;
 
-    Command::new(cargo::cargo_bin!("revive-llvm"))
+    Command::cargo_bin(common::REVIVE_LLVM)?
+        .current_dir(test_dir.path())
+        .arg("clone")
+        .assert()
+        .success();
+
+    Command::cargo_bin(common::REVIVE_LLVM)?
         .current_dir(test_dir.path())
         .arg("build")
         .arg("--sanitizer")
@@ -117,28 +141,27 @@ fn build_with_sanitizers() -> anyhow::Result<()> {
     Ok(())
 }
 
-/// Tests the build and clean process of the LLVM repository for the emscripten target.
+/// Tests the clone, build, and clean process of the LLVM repository for the emscripten target.
 #[test]
 #[cfg(target_os = "linux")]
-fn build_and_clean_emscripten() -> anyhow::Result<()> {
+fn clone_build_and_clean_emscripten() -> anyhow::Result<()> {
-    let test_dir = common::TestDir::new()?;
+    let test_dir = common::TestDir::with_lockfile(None)?;
-    let command = Command::new(cargo::cargo_bin!("revive-llvm"));
+    let command = Command::cargo_bin(common::REVIVE_LLVM)?;
     let program = command.get_program().to_string_lossy();
-    let path = test_dir.path();
 
-    Command::new(cargo::cargo_bin!("revive-llvm"))
+    Command::cargo_bin(common::REVIVE_LLVM)?
-        .current_dir(path)
+        .current_dir(test_dir.path())
-        .arg("build")
+        .arg("clone")
-        .arg("--llvm-projects")
-        .arg("clang")
-        .arg("--llvm-projects")
-        .arg("lld")
         .assert()
         .success();
 
-    Command::new(cargo::cargo_bin!("revive-llvm"))
+    Command::cargo_bin(common::REVIVE_LLVM)?
-        .current_dir(path)
+        .current_dir(test_dir.path())
-        .arg("emsdk")
+        .arg("build")
+        .arg("--llvm-projects")
+        .arg("lld")
+        .arg("--llvm-projects")
+        .arg("clang")
         .assert()
         .success();
 
@@ -147,20 +170,22 @@ fn build_and_clean_emscripten() -> anyhow::Result<()> {
     // `cd {} && . ./emsdk_env.sh && cd ..` helps the script to locate `emsdk.py`
     // @see https://github.com/emscripten-core/emsdk/blob/9dbdc4b3437750b85d16931c7c801bb71a782122/emsdk_env.sh#L61-L69
     let emsdk_wrapped_build_command = format!(
-        "cd {} && . ./emsdk_env.sh && cd .. && \
+        "{program} --target-env emscripten clone && \
+        cd {} && . ./emsdk_env.sh && cd .. && \
         {program} --target-env emscripten build --llvm-projects lld",
         revive_llvm_builder::LLVMPath::DIRECTORY_EMSDK_SOURCE,
     );
+
     Command::new("sh")
         .arg("-c")
         .arg(emsdk_wrapped_build_command)
-        .current_dir(path)
+        .current_dir(test_dir.path())
         .assert()
         .success();
 
-    Command::new(cargo::cargo_bin!("revive-llvm"))
+    Command::cargo_bin(common::REVIVE_LLVM)?
         .arg("clean")
-        .current_dir(path)
+        .current_dir(test_dir.path())
         .assert()
         .success();
 

crates/llvm-builder/tests/checkout.rs

@@ -0,0 +1,48 @@
+pub mod common;
+
+use std::process::Command;
+
+use assert_cmd::prelude::*;
+
+/// This test verifies that after cloning the LLVM repository, checking out a specific branch
+/// or reference works as expected.
+#[test]
+fn checkout_after_clone() -> anyhow::Result<()> {
+    let test_dir = common::TestDir::with_lockfile(None)?;
+
+    Command::cargo_bin(common::REVIVE_LLVM)?
+        .current_dir(test_dir.path())
+        .arg("clone")
+        .assert()
+        .success();
+
+    Command::cargo_bin(common::REVIVE_LLVM)?
+        .current_dir(test_dir.path())
+        .arg("checkout")
+        .assert()
+        .success();
+
+    Ok(())
+}
+
+/// This test verifies that after cloning the LLVM repository, checking out a specific branch
+/// or reference with the `--force` option works as expected.
+#[test]
+fn force_checkout() -> anyhow::Result<()> {
+    let test_dir = common::TestDir::with_lockfile(None)?;
+
+    Command::cargo_bin(common::REVIVE_LLVM)?
+        .current_dir(test_dir.path())
+        .arg("clone")
+        .assert()
+        .success();
+
+    Command::cargo_bin(common::REVIVE_LLVM)?
+        .current_dir(test_dir.path())
+        .arg("checkout")
+        .arg("--force")
+        .assert()
+        .success();
+
+    Ok(())
+}

crates/llvm-builder/tests/clone.rs

@@ -0,0 +1,36 @@
+pub mod common;
+
+use std::process::Command;
+
+use assert_cmd::prelude::*;
+
+/// This test verifies that the LLVM repository can be successfully cloned using a specific branch
+/// and reference.
+#[test]
+fn clone() -> anyhow::Result<()> {
+    let test_dir = common::TestDir::with_lockfile(None)?;
+
+    Command::cargo_bin(common::REVIVE_LLVM)?
+        .current_dir(test_dir.path())
+        .arg("clone")
+        .assert()
+        .success();
+
+    Ok(())
+}
+
+/// This test verifies that the LLVM repository can be successfully cloned using a specific branch
+/// and reference with --deep option.
+#[test]
+fn clone_deep() -> anyhow::Result<()> {
+    let test_dir = common::TestDir::with_lockfile(None)?;
+
+    Command::cargo_bin(common::REVIVE_LLVM)?
+        .current_dir(test_dir.path())
+        .arg("clone")
+        .arg("--deep")
+        .assert()
+        .success();
+
+    Ok(())
+}

crates/llvm-builder/tests/common.rs

@@ -1,51 +1,32 @@
-use assert_fs::TempDir;
+use assert_fs::fixture::FileWriteStr;
 
 pub const REVIVE_LLVM: &str = "revive-llvm";
+pub const REVIVE_LLVM_REPO_URL: &str = "https://github.com/llvm/llvm-project";
+pub const REVIVE_LLVM_REPO_TEST_BRANCH: &str = "release/18.x";
 
 pub struct TestDir {
-    _tempdir: TempDir,
+    _lockfile: assert_fs::NamedTempFile,
     path: std::path::PathBuf,
 }
 
-/// Creates a temporary directory for testing with submodule setup.
+/// Creates a temporary lock file for testing.
 impl TestDir {
-    pub fn new() -> anyhow::Result<Self> {
+    pub fn with_lockfile(reference: Option<String>) -> anyhow::Result<Self> {
-        let tempdir = TempDir::new()?;
+        let file =
-        let tmppath = tempdir.path();
+            assert_fs::NamedTempFile::new(revive_llvm_builder::lock::LLVM_LOCK_DEFAULT_PATH)?;
-
+        let lock = revive_llvm_builder::Lock {
-        // Initialize a git repo and add the LLVM submodule
+            url: REVIVE_LLVM_REPO_URL.to_string(),
-        std::process::Command::new("git")
+            branch: REVIVE_LLVM_REPO_TEST_BRANCH.to_string(),
-            .args(["init"])
+            r#ref: reference,
-            .current_dir(tmppath)
+        };
-            .output()?;
+        file.write_str(toml::to_string(&lock)?.as_str())?;
-
-        std::process::Command::new("git")
-            .args([
-                "submodule",
-                "add",
-                "-b",
-                "release/18.x",
-                "https://github.com/llvm/llvm-project.git",
-                "llvm",
-            ])
-            .current_dir(tmppath)
-            .output()?;
-
-        std::process::Command::new("git")
-            .args([
-                "submodule",
-                "update",
-                "--init",
-                "--recursive",
-                "--force",
-                "--depth 1",
-            ])
-            .current_dir(tmppath)
-            .output()?;
 
         Ok(Self {
-            path: tmppath.to_path_buf(),
+            path: file
-            _tempdir: tempdir,
+                .parent()
+                .expect("lockfile parent dir always exists")
+                .into(),
+            _lockfile: file,
         })
     }