wip

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

.github/scripts/json_generator.py

@@ -1,3 +1,13 @@
+#!/usr/bin/env python3
+"""
+This script generates JSON files for different platforms based on GitHub release data.
+It fetches release information from a specified GitHub repository and tag,
+parses the release assets, and generates JSON files for each platform with relevant metadata.
+It also handles checksum files and updates a list.json file for each platform.
+It requires the GITHUB_TOKEN environment variable to be set for authentication.
+Usage:
+    python json_generator.py <repo> <tag>
+"""
 import os
 import sys
 import json

.github/scripts/json_generator_nightly.py

@@ -0,0 +1,155 @@
+#!/usr/bin/env python3
+"""
+This script generates JSON files for different platforms based on GitHub data.
+Requires the GITHUB_SHA, FIRST_SOLC_VERSION, LAST_SOLC_VERSION, TAG and FILEPATH environment variables to be set.
+Usage:
+    python json_generator_nightly.py
+"""
+import os
+import sys
+import json
+from datetime import datetime
+
+def validate_env_variables():
+    """Validate that environment variables are set."""
+    if "GITHUB_SHA" not in os.environ:
+        print("Error: GITHUB_SHA environment variable is not set.")
+        sys.exit(1)
+    if "FIRST_SOLC_VERSION" not in os.environ:
+        print("Error: FIRST_SOLC_VERSION environment variable is not set.")
+        sys.exit(1)
+    if "LAST_SOLC_VERSION" not in os.environ:
+        print("Error: LAST_SOLC_VERSION environment variable is not set.")
+        sys.exit(1)
+    if "TAG" not in os.environ:
+        print("Error: TAG environment variable is not set.")
+        sys.exit(1)
+    if "FILEPATH" not in os.environ:
+        print("Error: FILEPATH environment variable is not set.")
+        sys.exit(1)
+
+
+def fetch_data_file():
+    """
+    Fetch the data.json file with artifacts urls and sha256 checksums
+    and parse it into a single dictionary mapping artifact names to their URLs and SHAs.
+    """
+    # read data.json file
+    artifacts_data = {}
+    data_file_path = os.environ["FILEPATH"]
+    if not os.path.exists(data_file_path):
+        print("Error: data.json file not found.")
+        sys.exit(1)
+    with open(data_file_path, 'r') as f:
+        try:
+            artifacts_data = json.load(f)
+        except json.JSONDecodeError:
+            print("Error: data.json file is not a valid JSON.")
+            sys.exit(1)
+
+    result = {}
+
+    for item in artifacts_data:
+        for key, value in item.items():
+            if key.endswith('_url'):
+                base_key = key.rsplit('_url', 1)[0]
+                if base_key not in result:
+                    result[base_key] = {}
+                result[base_key]['url'] = value
+            elif key.endswith('_sha'):
+                base_key = key.rsplit('_sha', 1)[0]
+                if base_key not in result:
+                    result[base_key] = {}
+                result[base_key]['sha'] = value
+
+    return result
+
+
+
+
+
+def extract_build_hash():
+    """Extract the first 8 characters of the commit hash."""
+    sha = os.environ.get("GITHUB_SHA")
+    return f"commit.{sha[:8]}"
+
+def generate_asset_json_nightly(name, url, checksum):
+    """Generate JSON for a specific asset."""
+    # Date in format YYYY-MM-DD
+    date = datetime.now().strftime("%Y.%-m.%-d")
+    last_version = os.environ.get("TAG").replace('v','')
+    version = f"{last_version}-nightly.{date}"
+    SHA = os.environ.get("GITHUB_SHA", "")[:8]
+    build = f"commit.{SHA}"
+    long_version = f"{version}+{build}"
+
+    return {
+        "name": name,
+        "version": version,
+        "build": build,
+        "longVersion": long_version,
+        "url": url,
+        "sha256": checksum,
+        "firstSolcVersion": os.environ.get("FIRST_SOLC_VERSION"),
+        "lastSolcVersion": os.environ.get("LAST_SOLC_VERSION")
+    }
+
+def save_platform_json(platform_folder, asset_json):
+    """Save asset JSON and update list.json for a specific platform."""
+    # Create platform folder if it doesn't exist
+    os.makedirs(platform_folder, exist_ok=True)
+
+    # Update or create list.json
+    list_file_path = os.path.join(platform_folder, "list.json")
+
+    if os.path.exists(list_file_path):
+        with open(list_file_path, 'r') as f:
+            try:
+                list_data = json.load(f)
+            except json.JSONDecodeError:
+                list_data = {"builds": [], "releases": {}, "latestRelease": ""}
+    else:
+        list_data = {"builds": [], "releases": {}, "latestRelease": ""}
+
+    # Remove any existing entry with the same path
+    list_data['builds'] = [
+        build for build in list_data['builds']
+        if build['version'] != asset_json['version']
+    ]
+    # Add the new build
+    list_data['builds'].append(asset_json)
+
+    # Update releases
+    version = asset_json['version']
+    list_data['releases'][version] = f"{asset_json['name']}+{asset_json['longVersion']}"
+
+    # Update latest release
+    list_data['latestRelease'] = version
+
+    with open(list_file_path, 'w') as f:
+        json.dump(list_data, f, indent=4)
+
+def main():
+
+    validate_env_variables()
+    data = fetch_data_file()
+
+    # Mapping of asset names to platform folders
+    platform_mapping = {
+        'resolc-x86_64-unknown-linux-musl': 'linux',
+        'resolc-universal-apple-darwin': 'macos',
+        'resolc-x86_64-pc-windows-msvc': 'windows',
+        'resolc-web.js': 'wasm'
+    }
+
+    # Process each asset
+    for asset in data.keys():
+        platform_name = platform_mapping.get(asset)
+        if platform_name:
+            platform_folder = os.path.join(platform_name)
+            asset_json = generate_asset_json_nightly(asset, data[asset]['url'], data[asset]['sha'])
+            save_platform_json(platform_folder, asset_json)
+            print(f"Processed {asset} for {platform_name}")
+
+if __name__ == "__main__":
+    main()

.github/workflows/release-nightly.yml

@@ -0,0 +1,385 @@
+name: Nightly Release
+on:
+  schedule:
+    # Run every day at 01:00 UTC
+    - cron: "0 1 * * *"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+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:
+      has_commits: ${{ steps.check_commits.outputs.has_commits }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch full history to check previous commits
+          ref: "main"
+
+      - name: Check for commits from yesterday
+        id: check_commits
+        run: |
+          # Get yesterday's date in YYYY-MM-DD format
+          YESTERDAY=$(date -d "yesterday" +%Y-%m-%d)
+          echo "Checking for commits from: $YESTERDAY"
+
+          # Check if there were any commits yesterday
+          COMMIT_COUNT=$(git log --oneline --since="$YESTERDAY 00:00:00" --until="$YESTERDAY 23:59:59" | wc -l)
+
+          echo "Found $COMMIT_COUNT commits from yesterday"
+
+          if [ $COMMIT_COUNT -gt 0 ]; then
+            echo "has_commits=true" >> $GITHUB_OUTPUT
+            echo "✅ Found $COMMIT_COUNT commits from yesterday - continuing workflow"
+          else
+            echo "has_commits=false" >> $GITHUB_OUTPUT
+            echo "❌ No commits found from yesterday - skipping remaining steps"
+            echo "::notice::❌ No commits found from yesterday - skipping remaining steps"
+          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]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        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' }}
+    needs: [build]
+    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-14
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          merge-multiple: true
+
+      - name: Create macOS Fat Binary
+        run: |
+          lipo resolc-aarch64-apple-darwin resolc-x86_64-apple-darwin -create -output resolc-universal-apple-darwin
+
+      - name: Make Executable
+        run: |
+          chmod +x resolc-universal-apple-darwin
+
+      - uses: actions/upload-artifact@v4
+        id: artifact-upload-step
+        with:
+          name: resolc-universal-apple-darwin
+          path: resolc-universal-apple-darwin
+          retention-days: 40
+
+      - name: Set output variables
+        id: set-output
+        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 }}""
+          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-wasm, build, create-macos-fat-binary, check_commits]
+    steps:
+      - name: Checkout revive
+        uses: actions/checkout@v4
+        with:
+          path: revive
+
+      - name: Checkout resolc-bin
+        uses: actions/checkout@v4
+        with:
+          repository: paritytech/resolc-bin
+          path: resolc-bin
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v4
+        with:
+          merge-multiple: true
+          path: bins
+
+      - uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          app-id: ${{ secrets.REVIVE_JSON_APP_ID }}
+          private-key: ${{ secrets.REVIVE_JSON_APP_KEY }}
+          owner: paritytech
+          repositories: resolc-bin
+
+      - name: Generate JSON
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          TOKEN: ${{ steps.app-token.outputs.token }}
+          APP_NAME: "paritytech-revive-json"
+          Green: "\e[32m"
+          NC: "\e[0m"
+        run: |
+          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
+          export FIRST_SOLC_VERSION=$(./bins/resolc-x86_64-unknown-linux-musl --supported-solc-versions | cut -f 1 -d "," | tr -d ">=")
+          export LAST_SOLC_VERSION=$(./bins/resolc-x86_64-unknown-linux-musl --supported-solc-versions | cut -f 2 -d "," | tr -d "<=")
+          export FILEPATH=$(readlink -f data.json)
+          export TAG=$(cd revive;gh release list --json name,isLatest --jq '.[] | select(.isLatest)|.name')
+          cd resolc-bin
+          mkdir -p nightly
+          cd nightly
+          python3 ../../revive/.github/scripts/json_generator_nightly.py
+          cd ..
+          git status
+
+          echo "${Green}Add new remote with gh app token${NC}"
+          git remote set-url origin $(git config remote.origin.url | sed "s/github.com/${APP_NAME}:${TOKEN}@github.com/g")
+
+          echo "${Green}Remove http section that causes issues with gh app auth token${NC}"
+          sed -i.bak '/\[http/d' ./.git/config
+          sed -i.bak '/extraheader/d' ./.git/config
+
+          git config user.email "ci@parity.io"
+          git config user.name "${APP_NAME}"
+
+          git add nightly/
+          git commit -m "Update nightly json"
+          git push origin main
+
+          echo "::notice::nightly info.list files were successfully published to https://github.com/paritytech/resolc-bin"

.github/workflows/release.yml

@@ -14,6 +14,7 @@ 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:

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

@@ -7,6 +7,8 @@ on:
       - 'LLVM.lock'
       - 'crates/llvm-builder/**'
       - '.github/workflows/test-llvm-builder.yml'
+    paths-ignore:
+      - "**.md"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}

.github/workflows/test-wasm.yml

@@ -2,9 +2,13 @@ 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 }}

.github/workflows/test.yml

@@ -2,9 +2,13 @@ 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 }}
@@ -52,6 +56,3 @@ jobs:
 
       - name: Test cargo workspace
         run: make test-workspace
-
-      - name: Test CLI
-        run: make test-cli

CHANGELOG.md

@@ -6,6 +6,22 @@ This is a development pre-release.
 
 Supported `polkadot-sdk` rev: `2503.0.1`
 
+## v0.4.0
+
+This is a development pre-release.
+
+Supported `polkadot-sdk` rev: `2503.0.1`
+
+### 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.
+
+### Fixed
+- The debug info source file matches the YUL path in `--debug-output-dir`, allowing tools to display the source line. 
+
 ## v0.3.0
 
 This is a development pre-release.

Cargo.lock

@@ -105,13 +105,26 @@ version = "0.8.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9d8bcce99ad10fe02640cfaec1c6bc809b837c783c1d52906aa5af66e2a196f6"
 dependencies = [
- "alloy-dyn-abi",
+ "alloy-dyn-abi 0.8.25",
  "alloy-json-abi 0.8.25",
  "alloy-primitives 0.8.25",
  "alloy-rlp",
  "alloy-sol-types 0.8.25",
 ]
 
+[[package]]
+name = "alloy-core"
+version = "1.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bfe6c56d58fbfa9f0f6299376e8ce33091fc6494239466814c3f54b55743cb09"
+dependencies = [
+ "alloy-dyn-abi 1.3.1",
+ "alloy-json-abi 1.3.1",
+ "alloy-primitives 1.3.1",
+ "alloy-rlp",
+ "alloy-sol-types 1.3.1",
+]
+
 [[package]]
 name = "alloy-dyn-abi"
 version = "0.8.25"
@@ -129,13 +142,29 @@ dependencies = [
  "winnow",
 ]
 
+[[package]]
+name = "alloy-dyn-abi"
+version = "1.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a3f56873f3cac7a2c63d8e98a4314b8311aa96adb1a0f82ae923eb2119809d2c"
+dependencies = [
+ "alloy-json-abi 1.3.1",
+ "alloy-primitives 1.3.1",
+ "alloy-sol-type-parser 1.3.1",
+ "alloy-sol-types 1.3.1",
+ "itoa",
+ "serde",
+ "serde_json",
+ "winnow",
+]
+
 [[package]]
 name = "alloy-eip2124"
 version = "0.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "741bdd7499908b3aa0b159bba11e71c8cddd009a2c2eb7a06e825f1ec87900a5"
 dependencies = [
- "alloy-primitives 1.1.2",
+ "alloy-primitives 1.3.1",
  "alloy-rlp",
  "crc",
  "serde",
@@ -148,7 +177,7 @@ version = "0.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "7b82752a889170df67bbb36d42ca63c531eb16274f0d7299ae2a680facba17bd"
 dependencies = [
- "alloy-primitives 1.1.2",
+ "alloy-primitives 1.3.1",
  "alloy-rlp",
  "serde",
 ]
@@ -159,7 +188,7 @@ version = "0.6.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9d4769c6ffddca380b0070d71c8b7f30bed375543fe76bb2f74ec0acf4b7cd16"
 dependencies = [
- "alloy-primitives 1.1.2",
+ "alloy-primitives 1.3.1",
  "alloy-rlp",
  "serde",
  "thiserror 2.0.12",
@@ -174,7 +203,7 @@ dependencies = [
  "alloy-eip2124",
  "alloy-eip2930",
  "alloy-eip7702",
- "alloy-primitives 1.1.2",
+ "alloy-primitives 1.3.1",
  "alloy-rlp",
  "alloy-serde",
  "auto_impl",
@@ -192,7 +221,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "c98fb40f07997529235cc474de814cd7bd9de561e101716289095696c0e4639d"
 dependencies = [
  "alloy-eips",
- "alloy-primitives 1.1.2",
+ "alloy-primitives 1.3.1",
  "alloy-serde",
  "alloy-trie",
  "serde",
@@ -212,12 +241,12 @@ dependencies = [
 
 [[package]]
 name = "alloy-json-abi"
-version = "1.1.2"
+version = "1.3.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3ccaa79753d7bf15f06399ea76922afbfaf8d18bebed9e8fc452984b4a90dcc9"
+checksum = "125a1c373261b252e53e04d6e92c37d881833afc1315fceab53fd46045695640"
 dependencies = [
- "alloy-primitives 1.1.2",
- "alloy-sol-type-parser 1.1.2",
+ "alloy-primitives 1.3.1",
+ "alloy-sol-type-parser 1.3.1",
  "serde",
  "serde_json",
 ]
@@ -251,9 +280,9 @@ dependencies = [
 
 [[package]]
 name = "alloy-primitives"
-version = "1.1.2"
+version = "1.3.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "18c35fc4b03ace65001676358ffbbaefe2a2b27ee50fe777c345082c7c888be8"
+checksum = "bc9485c56de23438127a731a6b4c87803d49faf1a7068dcd1d8768aca3a9edb9"
 dependencies = [
  "alloy-rlp",
  "bytes",
@@ -304,7 +333,7 @@ version = "1.0.9"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "730e8f2edf2fc224cabd1c25d090e1655fa6137b2e409f92e5eec735903f1507"
 dependencies = [
- "alloy-primitives 1.1.2",
+ "alloy-primitives 1.3.1",
  "serde",
  "serde_json",
 ]
@@ -325,12 +354,12 @@ dependencies = [
 
 [[package]]
 name = "alloy-sol-macro"
-version = "1.1.2"
+version = "1.3.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8612e0658964d616344f199ab251a49d48113992d81b92dab93ed855faa66383"
+checksum = "d20d867dcf42019d4779519a1ceb55eba8d7f3d0e4f0a89bcba82b8f9eb01e48"
 dependencies = [
- "alloy-sol-macro-expander 1.1.2",
- "alloy-sol-macro-input 1.1.2",
+ "alloy-sol-macro-expander 1.3.1",
+ "alloy-sol-macro-input 1.3.1",
  "proc-macro-error2",
  "proc-macro2",
  "quote",
@@ -357,11 +386,11 @@ dependencies = [
 
 [[package]]
 name = "alloy-sol-macro-expander"
-version = "1.1.2"
+version = "1.3.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7a384edac7283bc4c010a355fb648082860c04b826bb7a814c45263c8f304c74"
+checksum = "b74e91b0b553c115d14bd0ed41898309356dc85d0e3d4b9014c4e7715e48c8ad"
 dependencies = [
- "alloy-sol-macro-input 1.1.2",
+ "alloy-sol-macro-input 1.3.1",
  "const-hex",
  "heck",
  "indexmap 2.9.0",
@@ -369,7 +398,7 @@ dependencies = [
  "proc-macro2",
  "quote",
  "syn 2.0.101",
- "syn-solidity 1.1.2",
+ "syn-solidity 1.3.1",
  "tiny-keccak",
 ]
 
@@ -391,9 +420,9 @@ dependencies = [
 
 [[package]]
 name = "alloy-sol-macro-input"
-version = "1.1.2"
+version = "1.3.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0dd588c2d516da7deb421b8c166dc60b7ae31bca5beea29ab6621fcfa53d6ca5"
+checksum = "84194d31220803f5f62d0a00f583fd3a062b36382e2bea446f1af96727754565"
 dependencies = [
  "const-hex",
  "dunce",
@@ -402,7 +431,7 @@ dependencies = [
  "proc-macro2",
  "quote",
  "syn 2.0.101",
- "syn-solidity 1.1.2",
+ "syn-solidity 1.3.1",
 ]
 
 [[package]]
@@ -417,9 +446,9 @@ dependencies = [
 
 [[package]]
 name = "alloy-sol-type-parser"
-version = "1.1.2"
+version = "1.3.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e86ddeb70792c7ceaad23e57d52250107ebbb86733e52f4a25d8dc1abc931837"
+checksum = "fe8c27b3cf6b2bb8361904732f955bc7c05e00be5f469cec7e2280b6167f3ff0"
 dependencies = [
  "serde",
  "winnow",
@@ -440,13 +469,13 @@ dependencies = [
 
 [[package]]
 name = "alloy-sol-types"
-version = "1.1.2"
+version = "1.3.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "584cb97bfc5746cb9dcc4def77da11694b5d6d7339be91b7480a6a68dc129387"
+checksum = "f5383d34ea00079e6dd89c652bcbdb764db160cef84e6250926961a0b2295d04"
 dependencies = [
- "alloy-json-abi 1.1.2",
- "alloy-primitives 1.1.2",
- "alloy-sol-macro 1.1.2",
+ "alloy-json-abi 1.3.1",
+ "alloy-primitives 1.3.1",
+ "alloy-sol-macro 1.3.1",
  "serde",
 ]
 
@@ -456,7 +485,7 @@ version = "0.8.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "983d99aa81f586cef9dae38443245e585840fcf0fc58b09aee0b1f27aed1d500"
 dependencies = [
- "alloy-primitives 1.1.2",
+ "alloy-primitives 1.3.1",
  "alloy-rlp",
  "arrayvec",
  "derive_more 2.0.1",
@@ -6490,7 +6519,7 @@ version = "0.5.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "895fe6f50f621a69132697b8b43d29d1db4d9ff445eec410bf1fc98cd7e9412c"
 dependencies = [
- "alloy-core",
+ "alloy-core 0.8.25",
  "derive_more 0.99.20",
  "environmental",
  "ethabi-decode",
@@ -6505,8 +6534,8 @@ dependencies = [
  "num-integer",
  "num-traits",
  "pallet-revive-fixtures",
- "pallet-revive-proc-macro",
- "pallet-revive-uapi",
+ "pallet-revive-proc-macro 0.3.0",
+ "pallet-revive-uapi 0.4.0",
  "pallet-transaction-payment",
  "parity-scale-codec",
  "paste",
@@ -6539,7 +6568,7 @@ checksum = "dc1df19ca809f036d6ddf1632039e9db312f92dbe8f9390e6722ad808cd95377"
 dependencies = [
  "anyhow",
  "cargo_metadata",
- "pallet-revive-uapi",
+ "pallet-revive-uapi 0.4.0",
  "polkavm-linker 0.21.0",
  "sp-core",
  "sp-io",
@@ -6558,7 +6587,7 @@ dependencies = [
  "pallet-balances",
  "pallet-message-queue",
  "pallet-revive",
- "pallet-revive-uapi",
+ "pallet-revive-uapi 0.4.0",
  "pallet-timestamp",
  "pallet-xcm",
  "parity-scale-codec",
@@ -6587,6 +6616,17 @@ dependencies = [
  "syn 2.0.101",
 ]
 
+[[package]]
+name = "pallet-revive-proc-macro"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "feb9c42c125790dd4bb0132312bb1a9d3a890b4720c7696d636194311f948e36"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn 2.0.101",
+]
+
 [[package]]
 name = "pallet-revive-uapi"
 version = "0.4.0"
@@ -6594,12 +6634,25 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "0cb8f45102c6279f59f55e0051fc6c26b996619d7842800dfaf3a2583459a1c7"
 dependencies = [
  "bitflags 1.3.2",
- "pallet-revive-proc-macro",
+ "pallet-revive-proc-macro 0.3.0",
  "parity-scale-codec",
  "polkavm-derive 0.21.0",
  "scale-info",
 ]
 
+[[package]]
+name = "pallet-revive-uapi"
+version = "0.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e340813d94f380bc531d4cd5f28685065a14dbbff87ab23507f72c7d2792b82c"
+dependencies = [
+ "bitflags 1.3.2",
+ "pallet-revive-proc-macro 0.4.0",
+ "parity-scale-codec",
+ "polkavm-derive 0.27.0",
+ "scale-info",
+]
+
 [[package]]
 name = "pallet-root-offences"
 version = "37.0.0"
@@ -7927,6 +7980,12 @@ dependencies = [
  "polkavm-assembler 0.24.0",
 ]
 
+[[package]]
+name = "polkavm-common"
+version = "0.27.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a19805789e7bf778ac5855f6fe9350353f6a1697c2aab9bfb6fc7c831be54fad"
+
 [[package]]
 name = "polkavm-derive"
 version = "0.18.0"
@@ -7945,6 +8004,15 @@ dependencies = [
  "polkavm-derive-impl-macro 0.21.0",
 ]
 
+[[package]]
+name = "polkavm-derive"
+version = "0.27.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4eea46a17d87cbf3c0f3f6156f6300f60cec67cf9eaca296c770e0873f8389d6"
+dependencies = [
+ "polkavm-derive-impl-macro 0.27.0",
+]
+
 [[package]]
 name = "polkavm-derive-impl"
 version = "0.18.1"
@@ -7969,6 +8037,18 @@ dependencies = [
  "syn 2.0.101",
 ]
 
+[[package]]
+name = "polkavm-derive-impl"
+version = "0.27.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8abdd1210d96b1dda9ac21199ec469448fd628cea102e2ff0e0df1667c4c3b5f"
+dependencies = [
+ "polkavm-common 0.27.0",
+ "proc-macro2",
+ "quote",
+ "syn 2.0.101",
+]
+
 [[package]]
 name = "polkavm-derive-impl-macro"
 version = "0.18.0"
@@ -7989,6 +8069,16 @@ dependencies = [
  "syn 2.0.101",
 ]
 
+[[package]]
+name = "polkavm-derive-impl-macro"
+version = "0.27.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8a45173d70138aa1879892c50777ed0d8b0c8556f7678372f09fa1d89bbbddb4"
+dependencies = [
+ "polkavm-derive-impl 0.27.0",
+ "syn 2.0.101",
+]
+
 [[package]]
 name = "polkavm-disassembler"
 version = "0.24.0"
@@ -8573,7 +8663,7 @@ dependencies = [
 name = "revive-benchmarks"
 version = "0.1.0"
 dependencies = [
- "alloy-primitives 1.1.2",
+ "alloy-primitives 1.3.1",
  "criterion",
  "hex",
  "revive-differential",
@@ -8607,7 +8697,7 @@ name = "revive-differential"
 version = "0.1.0"
 dependencies = [
  "alloy-genesis",
- "alloy-primitives 1.1.2",
+ "alloy-primitives 1.3.1",
  "alloy-serde",
  "hex",
  "serde",
@@ -8615,12 +8705,22 @@ dependencies = [
  "tempfile",
 ]
 
+[[package]]
+name = "revive-explorer"
+version = "0.1.0"
+dependencies = [
+ "anyhow",
+ "clap",
+ "num_cpus",
+ "revive-yul",
+]
+
 [[package]]
 name = "revive-integration"
 version = "0.1.1"
 dependencies = [
- "alloy-primitives 1.1.2",
- "alloy-sol-types 1.1.2",
+ "alloy-primitives 1.3.1",
+ "alloy-sol-types 1.3.1",
  "hex",
  "rayon",
  "resolc",
@@ -8687,11 +8787,27 @@ dependencies = [
  "sha3",
 ]
 
+[[package]]
+name = "revive-rul"
+version = "0.1.0"
+dependencies = [
+ "anyhow",
+ "pallet-revive-uapi 0.7.0",
+ "polkavm-linker 0.24.0",
+]
+
+[[package]]
+name = "revive-rul-runtime-library"
+version = "0.1.0"
+dependencies = [
+ "alloy-core 1.3.1",
+]
+
 [[package]]
 name = "revive-runner"
 version = "0.1.0"
 dependencies = [
- "alloy-primitives 1.1.2",
+ "alloy-primitives 1.3.1",
  "anyhow",
  "clap",
  "env_logger 0.11.8",
@@ -10742,9 +10858,9 @@ dependencies = [
 
 [[package]]
 name = "syn-solidity"
-version = "1.1.2"
+version = "1.3.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1b5d879005cc1b5ba4e18665be9e9501d9da3a9b95f625497c4cb7ee082b532e"
+checksum = "a0b198d366dbec045acfcd97295eb653a7a2b40e4dc764ef1e79aafcad439d3c"
 dependencies = [
  "paste",
  "proc-macro2",

Cargo.toml

@@ -19,6 +19,7 @@ revive-benchmarks = { version = "0.1.0", path = "crates/benchmarks" }
 revive-builtins = { version = "0.1.0", path = "crates/builtins" }
 revive-common = { version = "0.1.0", path = "crates/common" }
 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-linker = { version = "0.1.0", path = "crates/linker" }
 lld-sys = { version = "0.1.0", path = "crates/lld-sys" }
@@ -57,6 +58,7 @@ alloy-primitives = { version = "1.1", features = ["serde"] }
 alloy-sol-types = "1.1"
 alloy-genesis = "1.0"
 alloy-serde = "1.0"
+alloy-core = "1.3"
 env_logger = { version = "0.11.8", default-features = false }
 serde_stacker = "0.1.12"
 criterion = { version = "0.6", features = ["html_reports"] }
@@ -70,6 +72,7 @@ tar = "0.4"
 toml = "0.8"
 assert_cmd = "2.0"
 assert_fs = "1.1"
+pallet-revive-uapi = "0.7.0"
 
 # polkadot-sdk and friends
 codec = { version = "3.7.5", default-features = false, package = "parity-scale-codec" }

Makefile

@@ -6,6 +6,7 @@
 	install-llvm-builder \
 	install-llvm \
 	install-revive-runner \
+	install-revive-explorer \
 	format \
 	clippy \
 	machete \
@@ -13,7 +14,6 @@
 	test-integration \
 	test-resolc \
 	test-workspace \
-	test-cli \
 	test-wasm \
 	test-llvm-builder
 	bench \
@@ -43,6 +43,9 @@ install-llvm: install-llvm-builder
 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
 
@@ -53,7 +56,7 @@ machete:
 	cargo install cargo-machete
 	cargo machete
 
-test: format clippy machete test-cli test-workspace install-revive-runner
+test: format clippy machete test-workspace install-revive-runner install-revive-explorer
 
 test-integration: install-bin
 	cargo test --package revive-integration
@@ -64,9 +67,6 @@ test-resolc: install
 test-workspace: install
 	cargo test --workspace --exclude revive-llvm-builder
 
-test-cli: install
-	npm run test:cli
-
 test-wasm: install-wasm
 	npm run test:wasm
 
@@ -90,6 +90,6 @@ clean:
 	cargo clean ; \
 	revive-llvm clean ; \
 	rm -rf node_modules ; \
-	rm -rf crates/resolc/src/tests/cli-tests/artifacts ; \
+	rm -rf crates/resolc/src/tests/cli/artifacts ; \
 	cargo uninstall resolc ; \
 	cargo uninstall revive-llvm-builder ;

README.md

@@ -76,9 +76,7 @@ export LLVM_SYS_181_PREFIX=</path/to/the/extracted/archive>/target-llvm/gnu/targ
 <details>
   <summary>Building from source</summary>
 
- 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:
+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:
 
 ```sh
 make install-llvm

crates/explorer/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+name = "revive-explorer"
+version.workspace = true
+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

@@ -0,0 +1,49 @@
+# 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

@@ -0,0 +1,68 @@
+//! 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

@@ -0,0 +1,222 @@
+//! 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

@@ -0,0 +1,6 @@
+//! 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

@@ -0,0 +1,123 @@
+//! 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

@@ -0,0 +1,59 @@
+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

@@ -0,0 +1,79 @@
+//! 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/codesize.json

@@ -1,10 +1,10 @@
 {
-  "Baseline": 939,
-  "Computation": 2282,
-  "DivisionArithmetics": 8849,
-  "ERC20": 18308,
-  "Events": 1640,
-  "FibonacciIterative": 1497,
-  "Flipper": 2099,
-  "SHA1": 8243
+  "Baseline": 960,
+  "Computation": 2367,
+  "DivisionArithmetics": 9108,
+  "ERC20": 17655,
+  "Events": 1680,
+  "FibonacciIterative": 1536,
+  "Flipper": 2137,
+  "SHA1": 8299
 }

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 --git https://github.com/paritytech/revive-llvm-builder --force --locked
+      cargo install --force --locked --path crates/llvm-builder
       ```
 
       > 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`.
@@ -88,7 +88,12 @@ 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`: `export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final`
+      You now need to export the final target directory `$LLVM_SYS_181_PREFIX`:
+
+      ```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-context/src/debug_config/mod.rs

@@ -2,6 +2,7 @@
 
 pub mod ir_type;
 
+use std::path::Path;
 use std::path::PathBuf;
 
 use serde::Deserialize;
@@ -16,6 +17,14 @@ pub struct DebugConfig {
     pub output_directory: Option<PathBuf>,
     /// Whether debug info should be emitted.
     pub emit_debug_info: bool,
+    /// The YUL debug output file path.
+    ///
+    /// Is expected to be configured when running in YUL mode.
+    pub contract_path: Option<PathBuf>,
+    /// The YUL input file path.
+    ///
+    /// Is expected to be configured when not running in YUL mode.
+    pub yul_path: Option<PathBuf>,
 }
 
 impl DebugConfig {
@@ -24,15 +33,41 @@ impl DebugConfig {
         Self {
             output_directory,
             emit_debug_info,
+            contract_path: None,
+            yul_path: None,
         }
     }
 
+    /// Set the current YUL path.
+    pub fn set_yul_path(&mut self, yul_path: &Path) {
+        self.yul_path = yul_path.to_path_buf().into();
+    }
+
+    /// Set the current contract path.
+    pub fn set_contract_path(&mut self, contract_path: &str) {
+        self.contract_path = self.yul_source_path(contract_path);
+    }
+
+    /// Returns with the following precedence:
+    /// 1. The YUL source path if it was configured.
+    /// 2. The source YUL path from the debug output dir if it was configured.
+    /// 3. `None` if there is no debug output directory.
+    pub fn yul_source_path(&self, contract_path: &str) -> Option<PathBuf> {
+        if let Some(path) = self.yul_path.as_ref() {
+            return Some(path.clone());
+        }
+
+        self.output_directory.as_ref().map(|output_directory| {
+            let mut file_path = output_directory.to_owned();
+            let full_file_name = Self::full_file_name(contract_path, None, IRType::Yul);
+            file_path.push(full_file_name);
+            file_path
+        })
+    }
+
     /// Dumps the Yul IR.
     pub fn dump_yul(&self, contract_path: &str, code: &str) -> anyhow::Result<()> {
-        if let Some(output_directory) = self.output_directory.as_ref() {
-            let mut file_path = output_directory.to_owned();
-            let full_file_name = Self::full_file_name(contract_path, None, IRType::Yul);
-            file_path.push(full_file_name);
+        if let Some(file_path) = self.yul_source_path(contract_path) {
             std::fs::write(file_path, code)?;
         }
 

crates/llvm-context/src/polkavm/context/debug_info.rs

@@ -51,11 +51,20 @@ pub struct DebugInfo<'ctx> {
 
 impl<'ctx> DebugInfo<'ctx> {
     /// A shortcut constructor.
-    pub fn new(module: &inkwell::module::Module<'ctx>) -> Self {
+    pub fn new(
+        module: &inkwell::module::Module<'ctx>,
+        debug_config: &crate::debug_config::DebugConfig,
+    ) -> Self {
+        let module_name = module.get_name().to_string_lossy();
+        let yul_name = debug_config
+            .contract_path
+            .as_ref()
+            .map(|path| path.display().to_string());
+
         let (builder, compile_unit) = module.create_debug_info_builder(
             true,
             inkwell::debug_info::DWARFSourceLanguage::C,
-            module.get_name().to_string_lossy().as_ref(),
+            yul_name.as_deref().unwrap_or_else(|| module_name.as_ref()),
             "",
             "",
             false,

crates/llvm-context/src/polkavm/context/function/runtime/deploy_code.rs

@@ -48,6 +48,7 @@ where
             function_type,
             0,
             Some(inkwell::module::Linkage::External),
+            None,
         )?;
 
         self.inner.declare(context)
@@ -74,7 +75,6 @@ where
         }
 
         context.set_basic_block(context.current_function().borrow().return_block());
-        context.set_debug_location(0, 0, None)?;
         context.build_return(None);
 
         context.pop_debug_scope();

crates/llvm-context/src/polkavm/context/function/runtime/entry.rs

@@ -145,6 +145,7 @@ where
             entry_function_type,
             0,
             Some(inkwell::module::Linkage::External),
+            None,
         )?;
 
         context.declare_global(

crates/llvm-context/src/polkavm/context/function/runtime/runtime_code.rs

@@ -48,6 +48,7 @@ where
             function_type,
             0,
             Some(inkwell::module::Linkage::External),
+            None,
         )?;
 
         self.inner.declare(context)

crates/llvm-context/src/polkavm/context/mod.rs

@@ -247,7 +247,7 @@ where
         let intrinsics = Intrinsics::new(llvm, &module);
         let llvm_runtime = LLVMRuntime::new(llvm, &module, &optimizer);
         let debug_info = debug_config.emit_debug_info.then(|| {
-            let debug_info = DebugInfo::new(&module);
+            let debug_info = DebugInfo::new(&module, &debug_config);
             debug_info.initialize_module(llvm, &module);
             debug_info
         });
@@ -463,6 +463,7 @@ where
         r#type: inkwell::types::FunctionType<'ctx>,
         return_values_length: usize,
         linkage: Option<inkwell::module::Linkage>,
+        location: Option<(u32, u32)>,
     ) -> anyhow::Result<Rc<RefCell<Function<'ctx>>>> {
         let value = self.module().add_function(name, r#type, linkage);
 
@@ -478,7 +479,8 @@ where
                 Some(scp) => scp,
             };
             self.push_debug_scope(func_scope.as_debug_info_scope());
-            self.set_debug_location(0, 0, Some(func_scope.as_debug_info_scope()))?;
+            let (line, column) = location.unwrap_or((0, 0));
+            self.set_debug_location(line, column, Some(func_scope.as_debug_info_scope()))?;
         }
 
         let entry_block = self.llvm.append_basic_block(value, "entry");
@@ -533,7 +535,11 @@ where
 
     /// Sets the current active function. If debug-info generation is enabled,
     /// constructs a debug-scope and pushes in on the scope-stack.
-    pub fn set_current_function(&mut self, name: &str, line: Option<u32>) -> anyhow::Result<()> {
+    pub fn set_current_function(
+        &mut self,
+        name: &str,
+        location: Option<(u32, u32)>,
+    ) -> anyhow::Result<()> {
         let function = self.functions.get(name).cloned().ok_or_else(|| {
             anyhow::anyhow!("Failed to activate an undeclared function `{}`", name)
         })?;
@@ -542,7 +548,8 @@ where
         if let Some(scope) = self.current_function().borrow().get_debug_scope() {
             self.push_debug_scope(scope);
         }
-        self.set_debug_location(line.unwrap_or_default(), 0, None)?;
+        let (line, column) = location.unwrap_or_default();
+        self.set_debug_location(line, column, None)?;
 
         Ok(())
     }
@@ -723,17 +730,23 @@ where
         r#type: T,
         name: &str,
     ) -> Pointer<'ctx> {
-        let current_block = self.basic_block();
-        let entry_block = self.current_function().borrow().entry_block();
+        // TODO: Revisit. While at entry should be preferred in theory:
+        // - It has negligible code size impact on real word contracts.
+        // - Sometimes has negative impact on code size.
+        // - Messes up debug information used to analyze code size issues.
+        self.build_alloca(r#type, name)
 
-        match entry_block.get_first_instruction() {
-            Some(instruction) => self.builder().position_before(&instruction),
-            None => self.builder().position_at_end(entry_block),
-        }
+        // let current_block = self.basic_block();
+        // let entry_block = self.current_function().borrow().entry_block();
 
-        let pointer = self.build_alloca(r#type, name);
-        self.set_basic_block(current_block);
-        pointer
+        // match entry_block.get_first_instruction() {
+        //     Some(instruction) => self.builder().position_before(&instruction),
+        //     None => self.builder().position_at_end(entry_block),
+        // }
+
+        // let pointer = self.build_alloca(r#type, name);
+        // self.set_basic_block(current_block);
+        // pointer
     }
 
     /// Builds an aligned stack allocation at the current position.

crates/llvm-context/src/polkavm/context/runtime.rs

@@ -35,6 +35,7 @@ where
             Self::r#type(context),
             0,
             Some(inkwell::module::Linkage::External),
+            None,
         )?;
 
         let mut attributes = Self::ATTRIBUTES.to_vec();

crates/llvm-context/src/polkavm/context/tests.rs

@@ -9,7 +9,7 @@ use crate::polkavm::DummyDependency;
 pub fn create_context(
     llvm: &inkwell::context::Context,
     optimizer_settings: OptimizerSettings,
-) -> Context<DummyDependency> {
+) -> Context<'_, DummyDependency> {
     crate::initialize_llvm(crate::Target::PVM, "resolc", Default::default());
 
     let module = llvm.create_module("test");
@@ -40,6 +40,7 @@ pub fn check_attribute_null_pointer_is_invalid() {
                 .fn_type(&[context.word_type().into()], false),
             1,
             Some(inkwell::module::Linkage::External),
+            None,
         )
         .expect("Failed to add function");
     assert!(!function
@@ -63,6 +64,7 @@ pub fn check_attribute_optimize_for_size_mode_3() {
                 .fn_type(&[context.word_type().into()], false),
             1,
             Some(inkwell::module::Linkage::External),
+            None,
         )
         .expect("Failed to add function");
     assert!(!function
@@ -86,6 +88,7 @@ pub fn check_attribute_optimize_for_size_mode_z() {
                 .fn_type(&[context.word_type().into()], false),
             1,
             Some(inkwell::module::Linkage::External),
+            None,
         )
         .expect("Failed to add function");
     assert!(function
@@ -109,6 +112,7 @@ pub fn check_attribute_min_size_mode_3() {
                 .fn_type(&[context.word_type().into()], false),
             1,
             Some(inkwell::module::Linkage::External),
+            None,
         )
         .expect("Failed to add function");
     assert!(!function
@@ -132,6 +136,7 @@ pub fn check_attribute_min_size_mode_z() {
                 .fn_type(&[context.word_type().into()], false),
             1,
             Some(inkwell::module::Linkage::External),
+            None,
         )
         .expect("Failed to add function");
     assert!(function

crates/llvm-context/src/polkavm/evm/arithmetic.rs

@@ -2,13 +2,13 @@
 
 use inkwell::values::BasicValue;
 
-//use crate::polkavm::context::runtime::RuntimeFunction;
+use crate::polkavm::context::runtime::RuntimeFunction;
 use crate::polkavm::context::Context;
 use crate::polkavm::Dependency;
-//use crate::PolkaVMDivisionFunction;
-//use crate::PolkaVMRemainderFunction;
-//use crate::PolkaVMSignedDivisionFunction;
-//use crate::PolkaVMSignedRemainderFunction;
+use crate::PolkaVMDivisionFunction;
+use crate::PolkaVMRemainderFunction;
+use crate::PolkaVMSignedDivisionFunction;
+use crate::PolkaVMSignedRemainderFunction;
 
 /// Translates the arithmetic addition.
 pub fn addition<'ctx, D>(
@@ -64,21 +64,11 @@ pub fn division<'ctx, D>(
 where
     D: Dependency + Clone,
 {
-    let result_pointer = context.build_alloca_at_entry(context.word_type(), "div_result_pointer");
-    let operand_1_pointer = context.build_alloca_at_entry(context.word_type(), "operand_1_pointer");
-    let operand_2_pointer = context.build_alloca_at_entry(context.word_type(), "operand_2_pointer");
-
-    context.build_store(operand_1_pointer, operand_1)?;
-    context.build_store(operand_2_pointer, operand_2)?;
-
-    let arguments = &[
-        result_pointer.to_int(context).into(),
-        operand_1_pointer.to_int(context).into(),
-        operand_2_pointer.to_int(context).into(),
-    ];
-
-    context.build_runtime_call(revive_runtime_api::polkavm_imports::DIV, arguments);
-    context.build_load(result_pointer, "div_result")
+    let name = <PolkaVMDivisionFunction as RuntimeFunction<D>>::NAME;
+    let declaration = <PolkaVMDivisionFunction as RuntimeFunction<D>>::declaration(context);
+    Ok(context
+        .build_call(declaration, &[operand_1.into(), operand_2.into()], "div")
+        .unwrap_or_else(|| panic!("revive runtime function {name} should return a value",)))
 }
 
 /// Translates the arithmetic remainder.
@@ -90,21 +80,11 @@ pub fn remainder<'ctx, D>(
 where
     D: Dependency + Clone,
 {
-    let result_pointer = context.build_alloca_at_entry(context.word_type(), "rem_result_pointer");
-    let operand_1_pointer = context.build_alloca_at_entry(context.word_type(), "operand_1_pointer");
-    let operand_2_pointer = context.build_alloca_at_entry(context.word_type(), "operand_2_pointer");
-
-    context.build_store(operand_1_pointer, operand_1)?;
-    context.build_store(operand_2_pointer, operand_2)?;
-
-    let arguments = &[
-        result_pointer.to_int(context).into(),
-        operand_1_pointer.to_int(context).into(),
-        operand_2_pointer.to_int(context).into(),
-    ];
-
-    context.build_runtime_call(revive_runtime_api::polkavm_imports::MOD, arguments);
-    context.build_load(result_pointer, "rem_result")
+    let name = <PolkaVMRemainderFunction as RuntimeFunction<D>>::NAME;
+    let declaration = <PolkaVMRemainderFunction as RuntimeFunction<D>>::declaration(context);
+    Ok(context
+        .build_call(declaration, &[operand_1.into(), operand_2.into()], "rem")
+        .unwrap_or_else(|| panic!("revive runtime function {name} should return a value",)))
 }
 
 /// Translates the signed arithmetic division.
@@ -119,21 +99,11 @@ pub fn division_signed<'ctx, D>(
 where
     D: Dependency + Clone,
 {
-    let result_pointer = context.build_alloca_at_entry(context.word_type(), "sdiv_result_pointer");
-    let operand_1_pointer = context.build_alloca_at_entry(context.word_type(), "operand_1_pointer");
-    let operand_2_pointer = context.build_alloca_at_entry(context.word_type(), "operand_2_pointer");
-
-    context.build_store(operand_1_pointer, operand_1)?;
-    context.build_store(operand_2_pointer, operand_2)?;
-
-    let arguments = &[
-        result_pointer.to_int(context).into(),
-        operand_1_pointer.to_int(context).into(),
-        operand_2_pointer.to_int(context).into(),
-    ];
-
-    context.build_runtime_call(revive_runtime_api::polkavm_imports::SDIV, arguments);
-    context.build_load(result_pointer, "sdiv_result")
+    let name = <PolkaVMSignedDivisionFunction as RuntimeFunction<D>>::NAME;
+    let declaration = <PolkaVMSignedDivisionFunction as RuntimeFunction<D>>::declaration(context);
+    Ok(context
+        .build_call(declaration, &[operand_1.into(), operand_2.into()], "sdiv")
+        .unwrap_or_else(|| panic!("revive runtime function {name} should return a value",)))
 }
 
 /// Translates the signed arithmetic remainder.
@@ -145,19 +115,9 @@ pub fn remainder_signed<'ctx, D>(
 where
     D: Dependency + Clone,
 {
-    let result_pointer = context.build_alloca_at_entry(context.word_type(), "srem_result_pointer");
-    let operand_1_pointer = context.build_alloca_at_entry(context.word_type(), "operand_1_pointer");
-    let operand_2_pointer = context.build_alloca_at_entry(context.word_type(), "operand_2_pointer");
-
-    context.build_store(operand_1_pointer, operand_1)?;
-    context.build_store(operand_2_pointer, operand_2)?;
-
-    let arguments = &[
-        result_pointer.to_int(context).into(),
-        operand_1_pointer.to_int(context).into(),
-        operand_2_pointer.to_int(context).into(),
-    ];
-
-    context.build_runtime_call(revive_runtime_api::polkavm_imports::SMOD, arguments);
-    context.build_load(result_pointer, "rsem_result")
+    let name = <PolkaVMSignedRemainderFunction as RuntimeFunction<D>>::NAME;
+    let declaration = <PolkaVMSignedRemainderFunction as RuntimeFunction<D>>::declaration(context);
+    Ok(context
+        .build_call(declaration, &[operand_1.into(), operand_2.into()], "srem")
+        .unwrap_or_else(|| panic!("revive runtime function {name} should return a value",)))
 }

crates/llvm-context/src/polkavm/evm/math.rs

@@ -1,5 +1,7 @@
 //! Translates the mathematical operations.
 
+use inkwell::values::BasicValue;
+
 use crate::polkavm::context::Context;
 use crate::polkavm::Dependency;
 
@@ -13,26 +15,17 @@ pub fn add_mod<'ctx, D>(
 where
     D: Dependency + Clone,
 {
-    let result_pointer =
-        context.build_alloca_at_entry(context.word_type(), "addmod_result_pointer");
-    let operand_1_pointer = context.build_alloca_at_entry(context.word_type(), "addmod_operand_1");
-    let operand_2_pointer = context.build_alloca_at_entry(context.word_type(), "addmod_operand_2");
-    let modulo_pointer =
-        context.build_alloca_at_entry(context.word_type(), "addmod_modulo_operand");
-
-    context.build_store(operand_2_pointer, operand_2)?;
-    context.build_store(operand_1_pointer, operand_1)?;
-    context.build_store(modulo_pointer, modulo)?;
-
-    let arguments = &[
-        result_pointer.to_int(context).into(),
-        operand_1_pointer.to_int(context).into(),
-        operand_2_pointer.to_int(context).into(),
-        modulo_pointer.to_int(context).into(),
-    ];
-
-    context.build_runtime_call(revive_runtime_api::polkavm_imports::ADDMOD, arguments);
-    context.build_load(result_pointer, "addmod_result")
+    Ok(context
+        .build_call(
+            context.llvm_runtime().add_mod,
+            &[
+                operand_1.as_basic_value_enum(),
+                operand_2.as_basic_value_enum(),
+                modulo.as_basic_value_enum(),
+            ],
+            "add_mod_call",
+        )
+        .expect("Always exists"))
 }
 
 /// Translates the `mulmod` instruction.
@@ -45,26 +38,17 @@ pub fn mul_mod<'ctx, D>(
 where
     D: Dependency + Clone,
 {
-    let result_pointer =
-        context.build_alloca_at_entry(context.word_type(), "mulmod_result_pointer");
-    let operand_1_pointer = context.build_alloca_at_entry(context.word_type(), "mulmod_operand_1");
-    let operand_2_pointer = context.build_alloca_at_entry(context.word_type(), "mulmod_operand_2");
-    let modulo_pointer =
-        context.build_alloca_at_entry(context.word_type(), "mulmod_modulo_operand");
-
-    context.build_store(operand_2_pointer, operand_2)?;
-    context.build_store(operand_1_pointer, operand_1)?;
-    context.build_store(modulo_pointer, modulo)?;
-
-    let arguments = &[
-        result_pointer.to_int(context).into(),
-        operand_1_pointer.to_int(context).into(),
-        operand_2_pointer.to_int(context).into(),
-        modulo_pointer.to_int(context).into(),
-    ];
-
-    context.build_runtime_call(revive_runtime_api::polkavm_imports::MULMOD, arguments);
-    context.build_load(result_pointer, "addmod_result")
+    Ok(context
+        .build_call(
+            context.llvm_runtime().mul_mod,
+            &[
+                operand_1.as_basic_value_enum(),
+                operand_2.as_basic_value_enum(),
+                modulo.as_basic_value_enum(),
+            ],
+            "mul_mod_call",
+        )
+        .expect("Always exists"))
 }
 
 /// Translates the `exp` instruction.
@@ -76,22 +60,13 @@ pub fn exponent<'ctx, D>(
 where
     D: Dependency + Clone,
 {
-    let result_pointer = context.build_alloca_at_entry(context.word_type(), "exp_result_pointer");
-    let value_pointer = context.build_alloca_at_entry(context.word_type(), "exp_value_pointer");
-    let exponent_pointer =
-        context.build_alloca_at_entry(context.word_type(), "exp_exponent_pointer");
-
-    context.build_store(value_pointer, value)?;
-    context.build_store(exponent_pointer, exponent)?;
-
-    let arguments = &[
-        result_pointer.to_int(context).into(),
-        value_pointer.to_int(context).into(),
-        exponent_pointer.to_int(context).into(),
-    ];
-
-    context.build_runtime_call(revive_runtime_api::polkavm_imports::EXP, arguments);
-    context.build_load(result_pointer, "exponent_result")
+    Ok(context
+        .build_call(
+            context.llvm_runtime().exp,
+            &[value.as_basic_value_enum(), exponent.as_basic_value_enum()],
+            "exp_call",
+        )
+        .expect("Always exists"))
 }
 
 /// Translates the `signextend` instruction.
@@ -103,20 +78,11 @@ pub fn sign_extend<'ctx, D>(
 where
     D: Dependency + Clone,
 {
-    let result_pointer =
-        context.build_alloca_at_entry(context.word_type(), "signext_result_pointer");
-    let bytes_pointer = context.build_alloca_at_entry(context.word_type(), "bytes_pointer");
-    let value_pointer = context.build_alloca_at_entry(context.word_type(), "signext_value_pointer");
-
-    context.build_store(bytes_pointer, bytes)?;
-    context.build_store(value_pointer, value)?;
-
-    let arguments = &[
-        result_pointer.to_int(context).into(),
-        bytes_pointer.to_int(context).into(),
-        value_pointer.to_int(context).into(),
-    ];
-
-    context.build_runtime_call(revive_runtime_api::polkavm_imports::EXP, arguments);
-    context.build_load(result_pointer, "signext_mod_result")
+    Ok(context
+        .build_call(
+            context.llvm_runtime().sign_extend,
+            &[bytes.as_basic_value_enum(), value.as_basic_value_enum()],
+            "sign_extend_call",
+        )
+        .expect("Always exists"))
 }

crates/resolc/src/lib.rs

@@ -54,7 +54,7 @@ pub fn yul<T: Compiler>(
     solc: &mut T,
     optimizer_settings: revive_llvm_context::OptimizerSettings,
     include_metadata_hash: bool,
-    debug_config: revive_llvm_context::DebugConfig,
+    mut debug_config: revive_llvm_context::DebugConfig,
     llvm_arguments: &[String],
     memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
 ) -> anyhow::Result<Build> {
@@ -77,6 +77,7 @@ pub fn yul<T: Compiler>(
     let solc_validator = Some(&*solc);
     let project = Project::try_from_yul_path(path, solc_validator)?;
 
+    debug_config.set_yul_path(path);
     let build = project.compile(
         optimizer_settings,
         include_metadata_hash,

crates/resolc/src/project/contract/mod.rs

@@ -77,7 +77,7 @@ impl Contract {
         project: Project,
         optimizer_settings: revive_llvm_context::OptimizerSettings,
         include_metadata_hash: bool,
-        debug_config: revive_llvm_context::DebugConfig,
+        mut debug_config: revive_llvm_context::DebugConfig,
         llvm_arguments: &[String],
         memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
     ) -> anyhow::Result<ContractBuild> {
@@ -117,6 +117,7 @@ impl Contract {
             _ => llvm.create_module(self.path.as_str()),
         };
 
+        debug_config.set_contract_path(&self.path);
         let mut context = revive_llvm_context::PolkaVMContext::new(
             &llvm,
             module,

crates/resolc/src/solc/solc_compiler.rs

@@ -45,8 +45,6 @@ impl Compiler for SolcCompiler {
         include_paths: Vec<String>,
         allow_paths: Option<String>,
     ) -> anyhow::Result<SolcStandardJsonOutput> {
-        let version = self.version()?.validate(&include_paths)?.default;
-
         let mut command = std::process::Command::new(self.executable.as_str());
         command.stdin(std::process::Stdio::piped());
         command.stdout(std::process::Stdio::piped());
@@ -65,7 +63,7 @@ impl Compiler for SolcCompiler {
             command.arg(allow_paths);
         }
 
-        input.normalize(&version);
+        input.normalize();
 
         let suppressed_warnings = input.suppressed_warnings.take().unwrap_or_default();
 

crates/resolc/src/solc/soljson_compiler.rs

@@ -40,8 +40,7 @@ impl Compiler for SoljsonCompiler {
             anyhow::bail!("configuring allow paths is not supported with solJson")
         }
 
-        let version = self.version()?.validate(&include_paths)?.default;
-        input.normalize(&version);
+        input.normalize();
 
         let suppressed_warnings = input.suppressed_warnings.take().unwrap_or_default();
 

crates/resolc/src/tests/cli-tests/jest.config.js

@@ -1,4 +0,0 @@
-module.exports = {
-  preset: "ts-jest",
-  testEnvironment: "node",
-};

crates/resolc/src/tests/cli-tests/junit.xml

@@ -1,66 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<testsuites name="jest tests" tests="27" failures="0" errors="0" time="2.146">
-  <testsuite name="Run with --yul by default" errors="0" failures="0" skipped="1" timestamp="2024-10-24T17:08:50" time="1.508" tests="6">
-    <testcase classname="Run with --yul by default Valid command exit code = 0" name="Run with --yul by default Valid command exit code = 0" time="0.003">
-    </testcase>
-    <testcase classname="Run with --yul by default --yul output is presented" name="Run with --yul by default --yul output is presented" time="0">
-    </testcase>
-    <testcase classname="Run with --yul by default solc exit code == resolc exit code" name="Run with --yul by default solc exit code == resolc exit code" time="0">
-      <skipped/>
-    </testcase>
-    <testcase classname="Run with --yul by default run invalid: resolc --yul" name="Run with --yul by default run invalid: resolc --yul" time="0.001">
-    </testcase>
-    <testcase classname="Run with --yul by default Invalid command exit code = 1" name="Run with --yul by default Invalid command exit code = 1" time="0">
-    </testcase>
-    <testcase classname="Run with --yul by default Invalid solc exit code == Invalid resolc exit code" name="Run with --yul by default Invalid solc exit code == Invalid resolc exit code" time="0.041">
-    </testcase>
-  </testsuite>
-  <testsuite name="Run with --asm by default" errors="0" failures="0" skipped="0" timestamp="2024-10-24T17:08:50" time="1.512" tests="6">
-    <testcase classname="Run with --asm by default Valid command exit code = 0" name="Run with --asm by default Valid command exit code = 0" time="0.002">
-    </testcase>
-    <testcase classname="Run with --asm by default --asm output is presented" name="Run with --asm by default --asm output is presented" time="0.001">
-    </testcase>
-    <testcase classname="Run with --asm by default solc exit code == resolc exit code" name="Run with --asm by default solc exit code == resolc exit code" time="0.044">
-    </testcase>
-    <testcase classname="Run with --asm by default run invalid: resolc --asm" name="Run with --asm by default run invalid: resolc --asm" time="0">
-    </testcase>
-    <testcase classname="Run with --asm by default Invalid command exit code = 1" name="Run with --asm by default Invalid command exit code = 1" time="0.001">
-    </testcase>
-    <testcase classname="Run with --asm by default Invalid solc exit code == Invalid resolc exit code" name="Run with --asm by default Invalid solc exit code == Invalid resolc exit code" time="0.04">
-    </testcase>
-  </testsuite>
-  <testsuite name="Run resolc without any options" errors="0" failures="0" skipped="2" timestamp="2024-10-24T17:08:50" time="2.016" tests="15">
-    <testcase classname="Run resolc without any options Info with help is presented" name="Run resolc without any options Info with help is presented" time="0.002">
-    </testcase>
-    <testcase classname="Run resolc without any options Exit code = 1" name="Run resolc without any options Exit code = 1" time="0">
-    </testcase>
-    <testcase classname="Run resolc without any options solc exit code == resolc exit code" name="Run resolc without any options solc exit code == resolc exit code" time="0.044">
-    </testcase>
-    <testcase classname="Default run a command from the help Compiler run successful" name="Default run a command from the help Compiler run successful" time="0">
-    </testcase>
-    <testcase classname="Default run a command from the help Exit code = 0" name="Default run a command from the help Exit code = 0" time="0.001">
-    </testcase>
-    <testcase classname="Default run a command from the help Output dir is created" name="Default run a command from the help Output dir is created" time="0">
-    </testcase>
-    <testcase classname="Default run a command from the help Output file is created" name="Default run a command from the help Output file is created" time="0">
-      <skipped/>
-    </testcase>
-    <testcase classname="Default run a command from the help the output file is not empty" name="Default run a command from the help the output file is not empty" time="0">
-    </testcase>
-    <testcase classname="Default run a command from the help No &apos;Error&apos;/&apos;Warning&apos;/&apos;Fail&apos; in the output" name="Default run a command from the help No &apos;Error&apos;/&apos;Warning&apos;/&apos;Fail&apos; in the output" time="0">
-    </testcase>
-    <testcase classname="Default run a command from the help Compiler run successful" name="Default run a command from the help Compiler run successful" time="0.001">
-    </testcase>
-    <testcase classname="Default run a command from the help Exit code = 0" name="Default run a command from the help Exit code = 0" time="0">
-    </testcase>
-    <testcase classname="Default run a command from the help Output dir is created" name="Default run a command from the help Output dir is created" time="0">
-    </testcase>
-    <testcase classname="Default run a command from the help Output files are created" name="Default run a command from the help Output files are created" time="0">
-      <skipped/>
-    </testcase>
-    <testcase classname="Default run a command from the help the output files are not empty" name="Default run a command from the help the output files are not empty" time="0.003">
-    </testcase>
-    <testcase classname="Default run a command from the help No &apos;Error&apos;/&apos;Warning&apos;/&apos;Fail&apos; in the output" name="Default run a command from the help No &apos;Error&apos;/&apos;Warning&apos;/&apos;Fail&apos; in the output" time="0">
-    </testcase>
-  </testsuite>
-</testsuites>

crates/resolc/src/tests/cli-tests/package.json

@@ -1,26 +0,0 @@
-{
-  "name": "cli-tests",
-  "version": "1.0.0",
-  "title": "resolc CLI Tests",
-  "description": "Auto tests for verifying resolc CLI",
-  "repository": "https://github.com/paritytech/revive",
-  "main": "index.js",
-  "private": true,
-  "scripts": {
-    "test": "npx jest --verbose --testPathPattern="
-  },
-  "keywords": [],
-  "author": "Matter Labs",
-  "contributors": [
-    "cyrill@parity.io"
-  ],
-  "license": "MIT",
-  "devDependencies": {
-    "@types/jest": "^29.5.14",
-    "@types/shelljs": "^0.8.15",
-    "jest": "^29.7.0",
-    "shelljs": "^0.8.5",
-    "ts-jest": "^29.2.5",
-    "typescript": "^5.7.3"
-  }
-}

crates/resolc/src/tests/cli-tests/src/contracts/yul/memset.yul

@@ -1,22 +0,0 @@
-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 {                                                                                                                                                 
-{                                                                                                                                                              
-        let test:=0x5                                                                                                                                          
-        mstore(2,signextend(0x8,0x0))                                                                                                                          
-        mstore(8,lt(0xc,test))                                                 
-}                                                                                                                                                              
-                                                                                                                                                               
-    return(0, 65536)                                                                                                                                           
-}}}

crates/resolc/src/tests/cli-tests/src/entities.ts

@@ -1,53 +0,0 @@
-import * as path from 'path'
-
-const outputDir = 'artifacts'
-const binExtension = ':C.pvm'
-const asmExtension = ':C.pvmasm'
-const llvmExtension = '.ll'
-const contractSolFilename = 'contract.sol'
-const contractYulFilename = 'contract.yul'
-const contractOptimizedLLVMFilename = contractSolFilename + '.C.optimized'
-const contractUnoptimizedLLVMFilename = contractSolFilename + '.C.unoptimized'
-const pathToOutputDir = path.join(__dirname, '..', outputDir)
-const pathToContracts = path.join(__dirname, '..', 'src', 'contracts')
-const pathToBasicYulContract = path.join(
-  pathToContracts,
-  'yul',
-  contractYulFilename
-)
-const pathToMemsetYulContract = path.join(
-  pathToContracts,
-  'yul',
-  'memset.yul'
-)
-const pathToBasicSolContract = path.join(
-  pathToContracts,
-  'solidity',
-  contractSolFilename
-)
-const pathToSolBinOutputFile = path.join(
-  pathToOutputDir,
-  contractSolFilename + binExtension
-)
-const pathToSolAsmOutputFile = path.join(
-  pathToOutputDir,
-  contractSolFilename + asmExtension
-)
-
-export const paths = {
-  outputDir: outputDir,
-  binExtension: binExtension,
-  asmExtension: asmExtension,
-  llvmExtension: llvmExtension,
-  contractSolFilename: contractSolFilename,
-  contractYulFilename: contractYulFilename,
-  contractOptimizedLLVMFilename: contractOptimizedLLVMFilename,
-  contractUnoptimizedLLVMFilename: contractUnoptimizedLLVMFilename,
-  pathToOutputDir: pathToOutputDir,
-  pathToContracts: pathToContracts,
-  pathToBasicSolContract: pathToBasicSolContract,
-  pathToBasicYulContract: pathToBasicYulContract,
-  pathToMemsetYulContract: pathToMemsetYulContract,
-  pathToSolBinOutputFile: pathToSolBinOutputFile,
-  pathToSolAsmOutputFile: pathToSolAsmOutputFile,
-}

crates/resolc/src/tests/cli-tests/src/helper.ts

@@ -1,51 +0,0 @@
-import * as shell from 'shelljs'
-import * as fs from 'fs'
-import { spawnSync } from 'child_process'
-
-interface CommandResult {
-  output: string
-  exitCode: number
-}
-
-export const executeCommand = (
-  command: string,
-  stdin?: string
-): CommandResult => {
-  if (stdin) {
-    const process = spawnSync(command, [], {
-      input: stdin,
-      shell: true,
-      encoding: 'utf8',
-      maxBuffer: 30 * 1024 * 1024,
-    })
-
-    return {
-      exitCode: process.status || 0,
-      output: (process.stdout || process.stderr || '').toString(),
-    }
-  }
-
-  const result = shell.exec(command, { silent: true, async: false })
-  return {
-    exitCode: result.code,
-    output: result.stdout || result.stderr || '',
-  }
-}
-
-export const isFolderExist = (folder: string): boolean => {
-  return shell.test('-d', folder)
-}
-
-export const isFileExist = (
-  pathToFileDir: string,
-  fileName: string,
-  fileExtension: string
-): boolean => {
-  return shell.ls(pathToFileDir).stdout.includes(fileName + fileExtension)
-}
-
-export const isFileEmpty = (file: string): boolean => {
-  if (fs.existsSync(file)) {
-    return fs.readFileSync(file).length === 0
-  }
-}

crates/resolc/src/tests/cli-tests/tests/asm.test.ts

@@ -1,44 +0,0 @@
-import { executeCommand } from '../src/helper'
-import { paths } from '../src/entities'
-
-//id1746
-describe('Run with --asm by default', () => {
-  const command = `resolc ${paths.pathToBasicSolContract} --asm`
-  const result = executeCommand(command)
-  const commandInvalid = 'resolc --asm'
-  const resultInvalid = executeCommand(commandInvalid)
-
-  it('Valid command exit code = 0', () => {
-    expect(result.exitCode).toBe(0)
-  })
-
-  it('--asm output is presented', () => {
-    const expectedPatterns = [/(deploy)/i, /(call)/i, /(seal_return)/i]
-
-    for (const pattern of expectedPatterns) {
-      expect(result.output).toMatch(pattern)
-    }
-  })
-
-  it('solc exit code == resolc exit code', () => {
-    const command = `solc ${paths.pathToBasicSolContract} --asm`
-    const solcResult = executeCommand(command)
-    expect(solcResult.exitCode).toBe(result.exitCode)
-  })
-
-  it('run invalid: resolc --asm', () => {
-    expect(resultInvalid.output).toMatch(
-      /(No input sources specified|Compilation aborted)/i
-    )
-  })
-
-  it('Invalid command exit code = 1', () => {
-    expect(resultInvalid.exitCode).toBe(1)
-  })
-
-  it('Invalid solc exit code == Invalid resolc exit code', () => {
-    const command = 'solc --asm'
-    const solcResult = executeCommand(command)
-    expect(solcResult.exitCode).toBe(resultInvalid.exitCode)
-  })
-})

crates/resolc/src/tests/cli-tests/tests/common.test.ts

@@ -1,241 +0,0 @@
-import {
-  executeCommand,
-  isFolderExist,
-  isFileExist,
-  isFileEmpty,
-} from '../src/helper'
-import { paths } from '../src/entities'
-import * as shell from 'shelljs'
-import * as path from 'path'
-
-//id1762
-describe('Run resolc without any options', () => {
-  const command = 'resolc'
-  const result = executeCommand(command)
-
-  it('Info with help is presented', () => {
-    expect(result.output).toMatch(/(Usage: resolc)/i)
-  })
-
-  it('Exit code = 1', () => {
-    expect(result.exitCode).toBe(1)
-  })
-
-  it('solc exit code == resolc exit code', () => {
-    const command = 'solc'
-    const solcResult = executeCommand(command)
-    expect(solcResult.exitCode).toBe(result.exitCode)
-  })
-})
-
-//#1713
-describe('Default run a command from the help', () => {
-  const command = `resolc ${paths.pathToBasicSolContract} --overwrite -O3 --bin --output-dir "${paths.pathToOutputDir}"` // potential issue on resolc with full path on Windows cmd
-  const result = executeCommand(command)
-
-  it('Compiler run successful', () => {
-    expect(result.output).toMatch(/(Compiler run successful.)/i)
-  })
-  it('Exit code = 0', () => {
-    expect(result.exitCode).toBe(0)
-  })
-  it('Output dir is created', () => {
-    expect(isFolderExist(paths.pathToOutputDir)).toBe(true)
-  })
-  xit('Output file is created', () => {
-    // a bug on windows
-    expect(
-      isFileExist(
-        paths.pathToOutputDir,
-        paths.contractSolFilename,
-        paths.binExtension
-      )
-    ).toBe(true)
-  })
-  it('the output file is not empty', () => {
-    expect(isFileEmpty(paths.pathToSolBinOutputFile)).toBe(false)
-  })
-  it("No 'Error'/'Warning'/'Fail' in the output", () => {
-    expect(result.output).not.toMatch(/([Ee]rror|[Ww]arning|[Ff]ail)/i)
-  })
-})
-
-//#1818
-describe('Default run a command from the help', () => {
-  const command = `resolc ${paths.pathToBasicSolContract} --overwrite -O3 --bin --asm --output-dir "${paths.pathToOutputDir}"` // potential issue on resolc with full path on Windows cmd
-  const result = executeCommand(command)
-
-  it('Compiler run successful', () => {
-    expect(result.output).toMatch(/(Compiler run successful.)/i)
-  })
-  it('Exit code = 0', () => {
-    expect(result.exitCode).toBe(0)
-  })
-  it('Output dir is created', () => {
-    expect(isFolderExist(paths.pathToOutputDir)).toBe(true)
-  })
-  xit('Output files are created', () => {
-    // a bug on windows
-    expect(
-      isFileExist(
-        paths.pathToOutputDir,
-        paths.contractSolFilename,
-        paths.binExtension
-      )
-    ).toBe(true)
-    expect(
-      isFileExist(
-        paths.pathToOutputDir,
-        paths.contractSolFilename,
-        paths.asmExtension
-      )
-    ).toBe(true)
-  })
-  it('the output files are not empty', () => {
-    expect(isFileEmpty(paths.pathToSolBinOutputFile)).toBe(false)
-    expect(isFileEmpty(paths.pathToSolAsmOutputFile)).toBe(false)
-  })
-  it("No 'Error'/'Warning'/'Fail' in the output", () => {
-    expect(result.output).not.toMatch(/([Ee]rror|[Ww]arning|[Ff]ail)/i)
-  })
-})
-
-describe('Run resolc with source debug information', () => {
-  const commands = [
-    `resolc -g ${paths.pathToBasicSolContract} --overwrite --bin --asm --output-dir "${paths.pathToOutputDir}"`,
-    `resolc --disable-solc-optimizer -g ${paths.pathToBasicSolContract} --overwrite --bin --asm --output-dir "${paths.pathToOutputDir}"`,
-  ] // potential issue on resolc with full path on Windows cmd`;
-
-  for (var idx in commands) {
-    const command = commands[idx]
-    const result = executeCommand(command)
-
-    it('Compiler run successful', () => {
-      expect(result.output).toMatch(/(Compiler run successful.)/i)
-    })
-    it('Exit code = 0', () => {
-      expect(result.exitCode).toBe(0)
-    })
-    it('Output dir is created', () => {
-      expect(isFolderExist(paths.pathToOutputDir)).toBe(true)
-    })
-    it('Output files are created', () => {
-      // a bug on windows
-      expect(
-        isFileExist(
-          paths.pathToOutputDir,
-          paths.contractSolFilename,
-          paths.binExtension
-        )
-      ).toBe(true)
-      expect(
-        isFileExist(
-          paths.pathToOutputDir,
-          paths.contractSolFilename,
-          paths.asmExtension
-        )
-      ).toBe(true)
-    })
-    it('the output files are not empty', () => {
-      expect(isFileEmpty(paths.pathToSolBinOutputFile)).toBe(false)
-      expect(isFileEmpty(paths.pathToSolAsmOutputFile)).toBe(false)
-    })
-    it("No 'Error'/'Fail' in the output", () => {
-      expect(result.output).not.toMatch(/([Ee]rror|[Ff]ail)/i)
-    })
-  }
-})
-
-describe('Run resolc with source debug information, check LLVM debug-info', () => {
-  const commands = [
-    `resolc -g ${paths.pathToBasicSolContract} --overwrite --debug-output-dir="${paths.pathToOutputDir}"`,
-    `resolc -g --disable-solc-optimizer ${paths.pathToBasicSolContract} --overwrite --debug-output-dir="${paths.pathToOutputDir}"`,
-  ] // potential issue on resolc with full path on Windows cmd`;
-
-  for (var idx in commands) {
-    const command = commands[idx]
-    const result = executeCommand(command)
-
-    it('Compiler run successful', () => {
-      expect(result.output).toMatch(/(Compiler run successful.)/i)
-    })
-    it('Exit code = 0', () => {
-      expect(result.exitCode).toBe(0)
-    })
-    it('Output dir is created', () => {
-      expect(isFolderExist(paths.pathToOutputDir)).toBe(true)
-    })
-    it('Output files are created', () => {
-      // a bug on windows
-      expect(
-        isFileExist(
-          paths.pathToOutputDir,
-          paths.contractOptimizedLLVMFilename,
-          paths.llvmExtension
-        )
-      ).toBe(true)
-      expect(
-        isFileExist(
-          paths.pathToOutputDir,
-          paths.contractUnoptimizedLLVMFilename,
-          paths.llvmExtension
-        )
-      ).toBe(true)
-    })
-    it('the output files are not empty', () => {
-      expect(isFileEmpty(paths.pathToSolBinOutputFile)).toBe(false)
-      expect(isFileEmpty(paths.pathToSolAsmOutputFile)).toBe(false)
-    })
-    it("No 'Error'/'Fail' in the output", () => {
-      expect(result.output).not.toMatch(/([Ee]rror|[Ff]ail)/i)
-    })
-  }
-})
-
-describe('Standard JSON compilation with path options', () => {
-  const contractsDir = path.join(shell.tempdir(), 'contracts-test')
-  const inputFile = path.join(__dirname, '..', 'src/contracts/compiled/1.json')
-
-  beforeAll(() => {
-    shell.mkdir('-p', contractsDir)
-
-    const input = JSON.parse(shell.cat(inputFile).toString())
-
-    Object.entries(input.sources).forEach(
-      ([sourcePath, source]: [string, any]) => {
-        const filePath = path.join(contractsDir, sourcePath)
-        shell.mkdir('-p', path.dirname(filePath))
-        shell.ShellString(source.content).to(filePath)
-      }
-    )
-  })
-
-  afterAll(() => {
-    shell.rm('-rf', contractsDir)
-  })
-
-  describe('Output with all path options', () => {
-    let result: { exitCode: number; output: string }
-
-    beforeAll(() => {
-      const tempInputFile = path.join(contractsDir, 'temp-input.json')
-      shell.cp(inputFile, tempInputFile)
-      const inputContent = shell.cat(inputFile).toString()
-
-      const command = `resolc --standard-json --base-path "${contractsDir}" --include-path "${contractsDir}" --allow-paths "${contractsDir}"`
-
-      result = executeCommand(command, inputContent)
-
-      shell.rm(tempInputFile)
-    })
-
-    it('Compiler run successful without emiting warnings', () => {
-      const parsedResults = JSON.parse(result.output)
-      expect(
-        parsedResults.errors.filter(
-          (error: { type: string }) => error.type != 'Warning'
-        )
-      ).toEqual([])
-    })
-  })
-})

crates/resolc/src/tests/cli-tests/tests/memset.test.ts

@@ -1,18 +0,0 @@
-import { executeCommand } from '../src/helper'
-import { paths } from '../src/entities'
-
-describe('tests for the memset builtin to be present', () => {
-  // -O3 is required to reproduce.
-  const command = `resolc ${paths.pathToMemsetYulContract} --yul -O3`
-  const result = executeCommand(command)
-
-  it('Valid command exit code = 0', () => {
-    expect(result.exitCode).toBe(0)
-  })
-
-  it('--yul output is presented', () => {
-    expect(result.output).toMatch(/(Compiler run successful)/i)
-    expect(result.output).toMatch(/(No output requested)/i)
-  })
-
-})

crates/resolc/src/tests/cli-tests/tests/yul.test.ts

@@ -1,39 +0,0 @@
-import { executeCommand } from '../src/helper'
-import { paths } from '../src/entities'
-
-//id1743
-describe('Run with --yul by default', () => {
-  const command = `resolc ${paths.pathToBasicYulContract} --yul`
-  const result = executeCommand(command)
-  const commandInvalid = 'resolc --yul'
-  const resultInvalid = executeCommand(commandInvalid)
-
-  it('Valid command exit code = 0', () => {
-    expect(result.exitCode).toBe(0)
-  })
-
-  it('--yul output is presented', () => {
-    expect(result.output).toMatch(/(Compiler run successful)/i)
-    expect(result.output).toMatch(/(No output requested)/i)
-  })
-
-  xit('solc exit code == resolc exit code', () => {
-    // unknown solc issue for datatype of the contract
-    const command = `solc ${paths.pathToBasicSolContract} --yul`
-    const solcResult = executeCommand(command)
-    expect(solcResult.exitCode).toBe(result.exitCode)
-  })
-
-  it('run invalid: resolc --yul', () => {
-    expect(resultInvalid.output).toMatch(/(The input file is missing)/i)
-  })
-  it('Invalid command exit code = 1', () => {
-    expect(resultInvalid.exitCode).toBe(1)
-  })
-
-  it('Invalid solc exit code == Invalid resolc exit code', () => {
-    const command = 'solc --yul'
-    const solcResult = executeCommand(command)
-    expect(solcResult.exitCode).toBe(resultInvalid.exitCode)
-  })
-})

crates/resolc/src/tests/cli-tests/tsconfig.json

@@ -1,7 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES6",
-    "module": "CommonJS",
-    "outDir": "./dist",
-  }
-}

crates/resolc/src/tests/cli/asm.rs

@@ -0,0 +1,40 @@
+//! The tests for running resolc with asm option.
+
+#![cfg(test)]
+
+use crate::tests::cli::utils;
+
+const ASM_OPTION: &str = "--asm";
+
+#[test]
+fn runs_with_valid_input_file() {
+    let arguments = &[utils::SOLIDITY_CONTRACT_PATH, ASM_OPTION];
+    let resolc_result = utils::execute_resolc(arguments);
+    utils::assert_command_success(&resolc_result, "Providing a valid input file");
+
+    for pattern in &["deploy", "call", "seal_return"] {
+        assert!(
+            resolc_result.stdout.contains(pattern),
+            "Expected the output to contain `{pattern}`."
+        );
+    }
+
+    let solc_result = utils::execute_solc(arguments);
+    utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+}
+
+#[test]
+fn fails_without_input_file() {
+    let arguments = &[ASM_OPTION];
+    let resolc_result = utils::execute_resolc(arguments);
+    utils::assert_command_failure(&resolc_result, "Omitting an input file");
+
+    let output = resolc_result.stderr.to_lowercase();
+    assert!(
+        output.contains("no input sources specified") || output.contains("compilation aborted"),
+        "Expected the output to contain a specific error message."
+    );
+
+    let solc_result = utils::execute_solc(arguments);
+    utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+}

crates/resolc/src/tests/cli/combined_json.rs

@@ -0,0 +1,137 @@
+//! The tests for running resolc with combined JSON option.
+
+#![cfg(test)]
+
+use revive_common;
+
+use crate::tests::cli::utils;
+
+const JSON_OPTION: &str = "--combined-json";
+const JSON_ARGUMENTS: &[&str] = &[
+    "abi",
+    "hashes",
+    "metadata",
+    "devdoc",
+    "userdoc",
+    "storage-layout",
+    "ast",
+    "asm",
+    "bin",
+    "bin-runtime",
+];
+
+#[test]
+fn runs_with_valid_json_argument() {
+    for json_argument in JSON_ARGUMENTS {
+        let arguments = &[utils::SOLIDITY_CONTRACT_PATH, JSON_OPTION, json_argument];
+        let resolc_result = utils::execute_resolc(arguments);
+        assert!(
+            resolc_result.success,
+            "Providing the `{json_argument}` argument should succeed with exit code {}, got {}.\nDetails: {}",
+            revive_common::EXIT_CODE_SUCCESS,
+            resolc_result.code,
+            resolc_result.stderr
+        );
+
+        assert!(
+            resolc_result.stdout.contains("contracts"),
+            "Expected the output to contain a `contracts` field when using the `{json_argument}` argument."
+        );
+
+        let solc_result = utils::execute_solc(arguments);
+        utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+    }
+}
+
+#[test]
+fn fails_with_invalid_json_argument() {
+    let arguments = &[
+        utils::SOLIDITY_CONTRACT_PATH,
+        JSON_OPTION,
+        "invalid-argument",
+    ];
+    let resolc_result = utils::execute_resolc(arguments);
+    utils::assert_command_failure(&resolc_result, "Providing an invalid json argument");
+
+    assert!(
+        resolc_result.stdout.contains("Invalid option"),
+        "Expected the output to contain a specific error message."
+    );
+
+    let solc_result = utils::execute_solc(arguments);
+    utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+}
+
+#[test]
+fn fails_with_multiple_json_arguments() {
+    let arguments = &[
+        utils::SOLIDITY_CONTRACT_PATH,
+        JSON_OPTION,
+        JSON_ARGUMENTS[0],
+        JSON_ARGUMENTS[1],
+    ];
+    let resolc_result = utils::execute_resolc(arguments);
+    utils::assert_command_failure(&resolc_result, "Providing multiple json arguments");
+
+    assert!(
+        resolc_result
+            .stderr
+            .contains("reading error: No such file or directory"),
+        "Expected the output to contain a specific error message."
+    );
+
+    // FIX: Resolc exit code == 101
+    // let solc_result = utils::execute_solc(arguments);
+    // utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+}
+
+#[test]
+fn fails_without_json_argument() {
+    let arguments = &[utils::SOLIDITY_CONTRACT_PATH, JSON_OPTION];
+    let resolc_result = utils::execute_resolc(arguments);
+    utils::assert_command_failure(&resolc_result, "Omitting a JSON argument");
+
+    assert!(
+        resolc_result.stderr.contains(
+            "a value is required for '--combined-json <COMBINED_JSON>' but none was supplied"
+        ),
+        "Expected the output to contain a specific error message."
+    );
+
+    let solc_result = utils::execute_solc(arguments);
+    utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+}
+
+#[test]
+fn fails_without_solidity_input_file() {
+    let arguments = &[JSON_OPTION, JSON_ARGUMENTS[0]];
+    let resolc_result = utils::execute_resolc(arguments);
+    utils::assert_command_failure(&resolc_result, "Omitting a Solidity input file");
+
+    assert!(
+        resolc_result.stderr.contains("No input sources specified"),
+        "Expected the output to contain a specific error message."
+    );
+
+    let solc_result = utils::execute_solc(arguments);
+    utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+}
+
+#[test]
+fn fails_with_yul_input_file() {
+    for json_argument in JSON_ARGUMENTS {
+        let arguments = &[utils::YUL_CONTRACT_PATH, JSON_OPTION, json_argument];
+        let resolc_result = utils::execute_resolc(arguments);
+        utils::assert_command_failure(&resolc_result, "Providing a Yul input file");
+
+        assert!(
+            resolc_result
+                .stderr
+                .contains("ParserError: Expected identifier"),
+            "Expected the output to contain a specific error message."
+        );
+
+        let solc_result = utils::execute_solc(arguments);
+        utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+    }
+}

crates/resolc/src/tests/cli/contracts/yul/memset.yul

@@ -0,0 +1,22 @@
+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 {
+{
+        let test:=0x5
+        mstore(2,signextend(0x8,0x0))
+        mstore(8,lt(0xc,test))
+}
+
+    return(0, 65536)
+}}}

crates/resolc/src/tests/cli/mod.rs

@@ -0,0 +1,12 @@
+//! The CLI tests.
+
+#![cfg(test)]
+
+mod asm;
+mod combined_json;
+mod optimization;
+mod output_dir;
+mod standard_json;
+mod usage;
+mod utils;
+mod yul;

crates/resolc/src/tests/cli/optimization.rs

@@ -0,0 +1,53 @@
+//! The tests for running resolc with explicit optimization.
+
+#![cfg(test)]
+
+use revive_common;
+
+use crate::tests::cli::{utils, yul};
+
+const LEVELS: &[char] = &['0', '1', '2', '3', 's', 'z'];
+
+#[test]
+fn runs_with_valid_level() {
+    for level in LEVELS {
+        let optimization_argument = format!("-O{level}");
+        let arguments = &[
+            utils::YUL_MEMSET_CONTRACT_PATH,
+            yul::YUL_OPTION,
+            &optimization_argument,
+        ];
+        let resolc_result = utils::execute_resolc(arguments);
+        assert!(
+            resolc_result.success,
+            "Providing the level `{optimization_argument}` should succeed with exit code {}, got {}.\nDetails: {}",
+            revive_common::EXIT_CODE_SUCCESS,
+            resolc_result.code,
+            resolc_result.stderr
+        );
+
+        assert!(
+            resolc_result
+                .stderr
+                .contains("Compiler run successful. No output requested"),
+            "Expected the output to contain a success message when providing the level `{optimization_argument}`."
+        );
+    }
+}
+
+#[test]
+fn fails_with_invalid_level() {
+    let arguments = &[utils::YUL_MEMSET_CONTRACT_PATH, yul::YUL_OPTION, "-O9"];
+    let resolc_result = utils::execute_resolc(arguments);
+    utils::assert_command_failure(&resolc_result, "Providing an invalid optimization level");
+
+    assert!(
+        resolc_result
+            .stderr
+            .contains("Unexpected optimization option"),
+        "Expected the output to contain a specific error message."
+    );
+
+    let solc_result = utils::execute_solc(arguments);
+    utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+}

crates/resolc/src/tests/cli/output_dir.rs

@@ -0,0 +1,122 @@
+//! The tests for running resolc with output directory option.
+
+#![cfg(test)]
+
+use std::path::Path;
+
+use crate::tests::cli::utils;
+
+const OUTPUT_DIRECTORY: &str = "src/tests/cli/artifacts";
+const OUTPUT_BIN_FILE_PATH: &str = "src/tests/cli/artifacts/contract.sol:C.pvm";
+const OUTPUT_ASM_FILE_PATH: &str = "src/tests/cli/artifacts/contract.sol:C.pvmasm";
+const OUTPUT_LLVM_OPTIMIZED_FILE_PATH: &str =
+    "src/tests/cli/artifacts/src_tests_cli_contracts_solidity_contract.sol.C.optimized.ll";
+const OUTPUT_LLVM_UNOPTIMIZED_FILE_PATH: &str =
+    "src/tests/cli/artifacts/src_tests_cli_contracts_solidity_contract.sol.C.unoptimized.ll";
+
+fn file_exists(path: &str) -> bool {
+    Path::new(path).try_exists().unwrap()
+}
+
+fn file_is_empty(path: &str) -> bool {
+    Path::new(path).metadata().unwrap().len() == 0
+}
+
+fn assert_valid_output_file(
+    result: &utils::CommandResult,
+    output_file_type: &str,
+    output_file_path: &str,
+) {
+    utils::assert_command_success(result, "Providing an output directory");
+
+    assert!(
+        result.stderr.contains("Compiler run successful"),
+        "Expected the compiler output to contain a success message.",
+    );
+
+    assert!(
+        file_exists(output_file_path),
+        "Expected the {output_file_type} output file `{output_file_path}` to exist."
+    );
+
+    assert!(
+        !file_is_empty(output_file_path),
+        "Expected the {output_file_type} output file `{output_file_path}` to not be empty."
+    );
+}
+
+#[test]
+fn writes_to_file() {
+    let arguments = &[
+        utils::SOLIDITY_CONTRACT_PATH,
+        "--overwrite",
+        "-O3",
+        "--bin",
+        "--asm",
+        "--output-dir",
+        OUTPUT_DIRECTORY,
+    ];
+    let result = utils::execute_resolc(arguments);
+    assert_valid_output_file(&result, "--bin", OUTPUT_BIN_FILE_PATH);
+    assert_valid_output_file(&result, "--asm", OUTPUT_ASM_FILE_PATH);
+}
+
+#[test]
+fn writes_debug_info_to_file_unoptimized() {
+    let arguments = &[
+        utils::SOLIDITY_CONTRACT_PATH,
+        "-g",
+        "--disable-solc-optimizer",
+        "--overwrite",
+        "--bin",
+        "--asm",
+        "--output-dir",
+        OUTPUT_DIRECTORY,
+    ];
+    let result = utils::execute_resolc(arguments);
+    assert_valid_output_file(&result, "--bin", OUTPUT_BIN_FILE_PATH);
+    assert_valid_output_file(&result, "--asm", OUTPUT_ASM_FILE_PATH);
+}
+
+#[test]
+fn writes_debug_info_to_file_optimized() {
+    let arguments = &[
+        utils::SOLIDITY_CONTRACT_PATH,
+        "-g",
+        "--overwrite",
+        "--bin",
+        "--asm",
+        "--output-dir",
+        OUTPUT_DIRECTORY,
+    ];
+    let result = utils::execute_resolc(arguments);
+    assert_valid_output_file(&result, "--bin", OUTPUT_BIN_FILE_PATH);
+    assert_valid_output_file(&result, "--asm", OUTPUT_ASM_FILE_PATH);
+}
+
+#[test]
+fn writes_llvm_debug_info_to_file_unoptimized() {
+    let arguments = &[
+        utils::SOLIDITY_CONTRACT_PATH,
+        "-g",
+        "--disable-solc-optimizer",
+        "--overwrite",
+        "--debug-output-dir",
+        OUTPUT_DIRECTORY,
+    ];
+    let result = utils::execute_resolc(arguments);
+    assert_valid_output_file(&result, "llvm", OUTPUT_LLVM_UNOPTIMIZED_FILE_PATH);
+}
+
+#[test]
+fn writes_llvm_debug_info_to_file_optimized() {
+    let arguments = &[
+        utils::SOLIDITY_CONTRACT_PATH,
+        "-g",
+        "--overwrite",
+        "--debug-output-dir",
+        OUTPUT_DIRECTORY,
+    ];
+    let result = utils::execute_resolc(arguments);
+    assert_valid_output_file(&result, "llvm", OUTPUT_LLVM_OPTIMIZED_FILE_PATH);
+}

crates/resolc/src/tests/cli/standard_json.rs

@@ -0,0 +1,24 @@
+//! The tests for running resolc with standard JSON option.
+
+#![cfg(test)]
+
+use crate::tests::cli::utils;
+
+const JSON_OPTION: &str = "--standard-json";
+
+#[test]
+fn runs_with_valid_input_file() {
+    let arguments = &[JSON_OPTION];
+    let resolc_result =
+        utils::execute_resolc_with_stdin_input(arguments, utils::STANDARD_JSON_CONTRACTS_PATH);
+    utils::assert_command_success(&resolc_result, "Providing a valid input file to stdin");
+
+    assert!(
+        resolc_result.stdout.contains("contracts"),
+        "Expected the output to contain a `contracts` field."
+    );
+
+    let solc_result =
+        utils::execute_solc_with_stdin_input(arguments, utils::STANDARD_JSON_CONTRACTS_PATH);
+    utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+}

crates/resolc/src/tests/cli/usage.rs

@@ -0,0 +1,35 @@
+//! The tests for running resolc when expecting usage output.
+
+#![cfg(test)]
+
+use crate::tests::cli::utils;
+
+#[test]
+#[ignore = "Fix: 'resolc --help' should exit with success exit code"]
+fn shows_usage_with_help() {
+    let arguments = &["--help"];
+    let resolc_result = utils::execute_resolc(arguments);
+    utils::assert_command_success(&resolc_result, "Providing the `--help` option");
+
+    assert!(
+        resolc_result.stdout.contains("Usage: resolc"),
+        "Expected the output to contain usage information."
+    );
+
+    let solc_result = utils::execute_solc(arguments);
+    utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+}
+
+#[test]
+fn fails_without_options() {
+    let resolc_result = utils::execute_resolc(&[]);
+    utils::assert_command_failure(&resolc_result, "Omitting options");
+
+    assert!(
+        resolc_result.stderr.contains("Usage: resolc"),
+        "Expected the output to contain usage information."
+    );
+
+    let solc_result = utils::execute_solc(&[]);
+    utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+}

crates/resolc/src/tests/cli/utils.rs

@@ -0,0 +1,99 @@
+//! Common utilities used for CLI tests.
+
+use std::{
+    fs::File,
+    process::{Command, Stdio},
+};
+
+use revive_common;
+
+use crate::SolcCompiler;
+
+pub const SOLIDITY_CONTRACT_PATH: &str = "src/tests/cli/contracts/solidity/contract.sol";
+pub const YUL_CONTRACT_PATH: &str = "src/tests/cli/contracts/yul/contract.yul";
+pub const YUL_MEMSET_CONTRACT_PATH: &str = "src/tests/cli/contracts/yul/memset.yul";
+pub const STANDARD_JSON_CONTRACTS_PATH: &str =
+    "src/tests/cli/contracts/standard_json/solidity_contracts.json";
+
+/// The result of executing a command.
+pub struct CommandResult {
+    /// The data written to `stdout`.
+    pub stdout: String,
+    /// The data written to `stderr`.
+    pub stderr: String,
+    /// Whether termination was successful.
+    pub success: bool,
+    /// The exit code of the process.
+    pub code: i32,
+}
+
+pub fn execute_resolc(arguments: &[&str]) -> CommandResult {
+    execute_command("resolc", arguments, None)
+}
+
+pub fn execute_resolc_with_stdin_input(arguments: &[&str], stdin_file_path: &str) -> CommandResult {
+    execute_command("resolc", arguments, Some(stdin_file_path))
+}
+
+pub fn execute_solc(arguments: &[&str]) -> CommandResult {
+    execute_command(SolcCompiler::DEFAULT_EXECUTABLE_NAME, arguments, None)
+}
+
+pub fn execute_solc_with_stdin_input(arguments: &[&str], stdin_file_path: &str) -> CommandResult {
+    execute_command(
+        SolcCompiler::DEFAULT_EXECUTABLE_NAME,
+        arguments,
+        Some(stdin_file_path),
+    )
+}
+
+fn execute_command(
+    command: &str,
+    arguments: &[&str],
+    stdin_file_path: Option<&str>,
+) -> CommandResult {
+    let stdin_config = match stdin_file_path {
+        Some(path) => Stdio::from(File::open(path).unwrap()),
+        None => Stdio::null(),
+    };
+    let result = Command::new(command)
+        .args(arguments)
+        .stdin(stdin_config)
+        .stdout(Stdio::piped())
+        .stderr(Stdio::piped())
+        .output()
+        .unwrap();
+
+    CommandResult {
+        stdout: String::from_utf8_lossy(&result.stdout).to_string(),
+        stderr: String::from_utf8_lossy(&result.stderr).to_string(),
+        success: result.status.success(),
+        code: result.status.code().unwrap(),
+    }
+}
+
+pub fn assert_equal_exit_codes(solc_result: &CommandResult, resolc_result: &CommandResult) {
+    assert_eq!(
+        solc_result.code, resolc_result.code,
+        "Expected solc and resolc to have the same exit code."
+    );
+}
+
+pub fn assert_command_success(result: &CommandResult, error_message_prefix: &str) {
+    assert!(
+        result.success,
+        "{error_message_prefix} should succeed with exit code {}, got {}.\nDetails: {}",
+        revive_common::EXIT_CODE_SUCCESS,
+        result.code,
+        result.stderr
+    );
+}
+
+pub fn assert_command_failure(result: &CommandResult, error_message_prefix: &str) {
+    assert!(
+        !result.success,
+        "{error_message_prefix} should fail with exit code {}, got {}.",
+        revive_common::EXIT_CODE_FAILURE,
+        result.code
+    );
+}

crates/resolc/src/tests/cli/yul.rs

@@ -0,0 +1,44 @@
+//! The tests for running resolc with yul option.
+
+#![cfg(test)]
+
+use crate::tests::cli::utils;
+
+pub const YUL_OPTION: &str = "--yul";
+/// The `--yul` option was deprecated in Solidity 0.8.27 in favor of `--strict-assembly`.
+/// See section `--strict-assembly vs. --yul` in https://soliditylang.org/blog/2024/09/04/solidity-0.8.27-release-announcement/
+const SOLC_YUL_OPTION: &str = "--strict-assembly";
+
+#[test]
+fn runs_with_valid_input_file() {
+    let arguments = &[utils::YUL_CONTRACT_PATH, YUL_OPTION];
+    let resolc_result = utils::execute_resolc(arguments);
+    utils::assert_command_success(&resolc_result, "Providing a valid input file");
+
+    assert!(
+        resolc_result
+            .stderr
+            .contains("Compiler run successful. No output requested"),
+        "Expected the output to contain a success message."
+    );
+
+    let solc_arguments = &[utils::YUL_CONTRACT_PATH, SOLC_YUL_OPTION];
+    let solc_result = utils::execute_solc(solc_arguments);
+    utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+}
+
+#[test]
+fn fails_without_input_file() {
+    let arguments = &[YUL_OPTION];
+    let resolc_result = utils::execute_resolc(arguments);
+    utils::assert_command_failure(&resolc_result, "Omitting an input file");
+
+    assert!(
+        resolc_result.stderr.contains("The input file is missing"),
+        "Expected the output to contain a specific error message."
+    );
+
+    let solc_arguments = &[SOLC_YUL_OPTION];
+    let solc_result = utils::execute_solc(solc_arguments);
+    utils::assert_equal_exit_codes(&solc_result, &resolc_result);
+}

crates/resolc/src/tests/combined-json.tests.ts

@@ -1,188 +0,0 @@
-import { executeCommand } from '../src/helper'
-import { paths } from '../src/entities'
-
-describe('Set of --combined-json tests', () => {
-  const zksolcCommand = 'zksolc'
-  const solcCommand = 'solc'
-  const json_args: string[] = [
-    `abi`,
-    `hashes`,
-    `metadata`,
-    `devdoc`,
-    `userdoc`,
-    `storage-layout`,
-    `ast`,
-    `asm`,
-    `bin`,
-    `bin-runtime`,
-  ]
-
-  //id1742:I
-  describe(`Run ${zksolcCommand} with just --combined-json`, () => {
-    const args = [`--combined-json`]
-    const result = executeCommand(zksolcCommand, args)
-
-    it('Valid command exit code = 1', () => {
-      expect(result.exitCode).toBe(1)
-    })
-
-    it('--combined-json error is presented', () => {
-      expect(result.output).toMatch(/(requires a value but none was supplied)/i)
-    })
-
-    it('solc exit code == zksolc exit code', () => {
-      const solcResult = executeCommand(solcCommand, args)
-      expect(solcResult.exitCode).toBe(result.exitCode)
-    })
-  })
-
-  //id1742:II
-  describe(`Run ${zksolcCommand} with Sol contract and --combined-json`, () => {
-    const args = [`${paths.pathToBasicSolContract}`, `--combined-json`]
-    const result = executeCommand(zksolcCommand, args)
-
-    it('Valid command exit code = 1', () => {
-      expect(result.exitCode).toBe(1)
-    })
-
-    it('--combined-json error is presented', () => {
-      expect(result.output).toMatch(/(requires a value but none was supplied)/i)
-    })
-
-    it('solc exit code == zksolc exit code', () => {
-      const solcResult = executeCommand(solcCommand, args)
-      expect(solcResult.exitCode).toBe(result.exitCode)
-    })
-  })
-
-  //id1742:III
-  for (let i = 0; i < json_args.length; i++) {
-    describe(`Run ${zksolcCommand} with Sol, --combined-json and ARG: ${json_args[i]}`, () => {
-      const args = [
-        `${paths.pathToBasicSolContract}`,
-        `--combined-json`,
-        `${json_args[i]}`,
-      ]
-      const result = executeCommand(zksolcCommand, args)
-
-      it('Valid command exit code = 0', () => {
-        expect(result.exitCode).toBe(0)
-      })
-
-      it('--combined-json error is presented', () => {
-        expect(result.output).toMatch(/(contracts)/i)
-      })
-
-      it('solc exit code == zksolc exit code', () => {
-        const solcResult = executeCommand(solcCommand, args)
-        expect(solcResult.exitCode).toBe(result.exitCode)
-      })
-    })
-  }
-
-  //id1829:I
-  for (let i = 0; i < json_args.length; i++) {
-    describe(`Run ${zksolcCommand} with Sol, --combined-json and wrong ARG: --${json_args[i]}`, () => {
-      const args = [
-        `${paths.pathToBasicSolContract}`,
-        `--combined-json`,
-        `--${json_args[i]}`,
-      ]
-      const result = executeCommand(zksolcCommand, args)
-
-      it('Valid command exit code = 1', () => {
-        expect(result.exitCode).toBe(1)
-      })
-
-      it('--combined-json error is presented', () => {
-        expect(result.output).toMatch(/(Invalid option|error)/i)
-      })
-
-      it('solc exit code == zksolc exit code', () => {
-        const solcResult = executeCommand(solcCommand, args)
-        expect(solcResult.exitCode).toBe(result.exitCode)
-      })
-    })
-  }
-
-  //id1829:II
-  for (let i = 0; i < json_args.length; i++) {
-    describe(`Run ${zksolcCommand} with Sol, --combined-json and multiple ARG: ${json_args[i]} ${json_args[i]}`, () => {
-      const args = [
-        `${paths.pathToBasicSolContract}`,
-        `--combined-json`,
-        `${json_args[i]}`,
-        `${json_args[i]}`,
-      ]
-      const result = executeCommand(zksolcCommand, args)
-
-      xit('Valid command exit code = 1', () => {
-        expect(result.exitCode).toBe(1)
-      })
-
-      it('--combined-json error is presented', () => {
-        expect(result.output).toMatch(
-          /(No such file or directory|cannot find the file specified)/i
-        ) // Hopefully we should have more precise message here!
-      })
-
-      xit('solc exit code == zksolc exit code', () => {
-        const solcResult = executeCommand(solcCommand, args)
-        expect(solcResult.exitCode).toBe(result.exitCode)
-      })
-    })
-  }
-
-  //id1829:III
-  for (let i = 0; i < json_args.length; i++) {
-    describe(`Run ${zksolcCommand} with Sol, and multiple (--combined-json ${json_args[i]})`, () => {
-      const args = [
-        `${paths.pathToBasicSolContract}`,
-        `--combined-json`,
-        `${json_args[i]}`,
-        `--combined-json`,
-        `${json_args[i]}`,
-      ]
-      const result = executeCommand(zksolcCommand, args)
-
-      it('Valid command exit code = 1', () => {
-        expect(result.exitCode).toBe(1)
-      })
-
-      it('--combined-json error is presented', () => {
-        expect(result.output).toMatch(/(cannot be used multiple times)/i)
-      })
-
-      it('solc exit code == zksolc exit code', () => {
-        const solcResult = executeCommand(solcCommand, args)
-        expect(solcResult.exitCode).toBe(result.exitCode)
-      })
-    })
-  }
-
-  //id1830
-  for (let i = 0; i < json_args.length; i++) {
-    describe(`Run ${zksolcCommand} with Yul, and --combined-json ${json_args[i]}`, () => {
-      const args = [
-        `${paths.pathToBasicYulContract}`,
-        `--combined-json`,
-        `${json_args[i]}`,
-      ]
-      const result = executeCommand(zksolcCommand, args)
-
-      it('Valid command exit code = 1', () => {
-        expect(result.exitCode).toBe(1)
-      })
-
-      it('--combined-json error is presented', () => {
-        expect(result.output).toMatch(/(ParserError: Expected identifier)/i)
-      })
-      asd
-
-      it('solc exit code == zksolc exit code', () => {
-        const solcResult = executeCommand(solcCommand, args)
-        expect(solcResult.exitCode).toBe(result.exitCode)
-      })
-    })
-  }
-})

crates/resolc/src/tests/mod.rs

@@ -2,6 +2,7 @@
 
 #![cfg(test)]
 
+mod cli;
 mod factory_dependency;
 mod ir_artifacts;
 mod libraries;

crates/rul-runtime-library/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "revive-rul-runtime-library"
+version.workspace = true
+license.workspace = true
+edition.workspace = true
+repository.workspace = true
+authors.workspace = true
+description = "revive compiler rust backend runtime library"
+
+[dependencies]
+alloy-core = { workspace = true, default-features = false }

crates/rul-runtime-library/src/configuration.rs

@@ -0,0 +1,4 @@
+//! The revive Rust backend contract runtime library configuration.
+
+/// The Ethereum Virtual Machine word size in bytes.
+pub const EVM_WORD_SIZE_BYTES: usize = 32;

crates/rul-runtime-library/src/lib.rs

@@ -0,0 +1,6 @@
+//! The revive Rust backend contract runtime library.
+
+#![no_std]
+
+pub mod configuration;
+pub mod memory;

crates/rul-runtime-library/src/memory.rs

@@ -0,0 +1,13 @@
+//! The revive Rust backend contract runtime emulated linear EVM heap memory.
+
+/// The emulated linear EVM heap memory size.
+pub const MEMORY_SIZE: usize = 1024 * 64;
+
+/// The emulated linear EVM heap memory size.
+pub const MEMORY: [u8; MEMORY_SIZE] = [0; MEMORY_SIZE];
+
+pub struct Function<const VARIABLES: usize> {
+    pub variables: [u8; VARIABLES],
+}
+
+impl<const VARIABLES: usize> Function<VARIABLES> {}

crates/rul/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "revive-rul"
+version.workspace = true
+license.workspace = true
+edition.workspace = true
+repository.workspace = true
+authors.workspace = true
+description = "revive compiler rust backend"
+
+[dependencies]
+anyhow = { workspace = true }
+pallet-revive-uapi = { workspace = true }
+polkavm-linker = { workspace = true }
+

crates/rul/src/builder.rs

@@ -0,0 +1,79 @@
+//! The revive rust backend builder module.
+
+const CARGO_TOML: &str = r#"
+[package]
+name = "contracts"
+publish = false
+version = "1.0.0"
+edition = "2021"
+
+# Make sure this is not included into the workspace
+[workspace]
+
+# Binary targets are injected dynamically by the build script.
+[[bin]]
+
+# All paths are injected dynamically by the build script.
+[dependencies]
+uapi = { version = "0.7.0", package = 'pallet-revive-uapi', features = ["unstable-hostfn"], default-features = false }
+hex-literal = { version = "0.4.1", default-features = false }
+polkavm-derive = { version = "0.27.0" }
+
+[profile.release]
+opt-level = z
+lto = true
+codegen-units = 1
+"#;
+
+const HEADER: &str = r#"
+#![no_std]
+#![no_main]
+include!("../panic_handler.rs");
+
+use uapi::{HostFn, HostFnImpl as api, ReturnFlags};
+
+#[panic_handler]
+fn panic(_info: &core::panic::PanicInfo) -> ! {
+	// SAFETY: The unimp instruction is guaranteed to trap
+	unsafe {
+		core::arch::asm!("unimp");
+		core::hint::unreachable_unchecked();
+	}
+}
+
+/// The emulated linear EVM heap memory size.
+pub const MEMORY_SIZE: usize = 1024 * 64;
+
+/// The emulated linear EVM heap memory size.
+pub const MEMORY: [u8; MEMORY_SIZE] = [0; MEMORY_SIZE];
+"#;
+
+const EXPORT_FUNCTION: &str = r#"
+#[no_mangle]
+#[polkavm_derive::polkavm_export]
+pub extern "C" fn "#;
+
+fn emit(constructor_code: &str, runtime_code: &str) -> String {
+    let mut buffer = String::from(HEADER);
+    buffer.reserve(
+        constructor_code.len() + runtime_code.len() + HEADER.len() + EXPORT_FUNCTION.len() * 2,
+    );
+
+    buffer.push_str(EXPORT_FUNCTION);
+    buffer.push_str("deploy() {");
+    buffer.push_str(constructor_code);
+    buffer.push_str("\n}");
+
+    buffer.push_str(EXPORT_FUNCTION);
+    buffer.push_str("call() {");
+    buffer.push_str(runtime_code);
+    buffer.push_str("\n}");
+
+    buffer
+}
+
+/// Build a PVM blob.
+pub fn build(constructor_code: &str, runtime_code: &str) -> Vec<u8> {
+    let code = emit(constructor_code, runtime_code);
+    todo!();
+}

crates/rul/src/lib.rs

@@ -0,0 +1,5 @@
+//! The revive rust backend library.
+
+pub mod builder;
+pub mod yul_library;
+

crates/rul/src/yul_library.rs

@@ -0,0 +1 @@
+//! The revive rust backend YUL auxilliary library functions module.

crates/runtime-api/src/immutable_data.rs

@@ -26,19 +26,19 @@ pub static GLOBAL_IMMUTABLE_DATA_SIZE: &str = "__immutable_data_size";
 pub static IMMUTABLE_DATA_MAX_SIZE: u32 = 4 * 1024;
 
 /// Returns the immutable data global type.
-pub fn data_type(context: &inkwell::context::Context, size: u32) -> inkwell::types::ArrayType {
+pub fn data_type(context: &inkwell::context::Context, size: u32) -> inkwell::types::ArrayType<'_> {
     context
         .custom_width_int_type(revive_common::BIT_LENGTH_WORD as u32)
         .array_type(size)
 }
 
 /// Returns the immutable data size global type.
-pub fn size_type(context: &inkwell::context::Context) -> inkwell::types::IntType {
+pub fn size_type(context: &inkwell::context::Context) -> inkwell::types::IntType<'_> {
     context.custom_width_int_type(revive_common::BIT_LENGTH_X32 as u32)
 }
 
 /// Creates a LLVM module with the immutable data and its `size` in bytes.
-pub fn module(context: &inkwell::context::Context, size: u32) -> inkwell::module::Module {
+pub fn module(context: &inkwell::context::Context, size: u32) -> inkwell::module::Module<'_> {
     let module = context.create_module(MODULE_NAME);
     let length = size / revive_common::BYTE_LENGTH_WORD as u32;
 

crates/runtime-api/src/polkavm_imports.c

@@ -104,19 +104,3 @@ POLKAVM_IMPORT(uint64_t, set_storage, uint32_t, uint32_t, uint32_t, uint32_t, ui
 POLKAVM_IMPORT(void, value_transferred, uint32_t)
 
 POLKAVM_IMPORT(void, weight_to_fee, uint64_t, uint64_t, uint32_t);
-
-POLKAVM_IMPORT(void, div, uint32_t, uint32_t, uint32_t);
-
-POLKAVM_IMPORT(void, sdiv, uint32_t, uint32_t, uint32_t);
-
-POLKAVM_IMPORT(void, addmod, uint32_t, uint32_t, uint32_t, uint32_t);
-
-POLKAVM_IMPORT(void, mulmod, uint32_t, uint32_t, uint32_t, uint32_t);
-
-POLKAVM_IMPORT(void, mod, uint32_t, uint32_t, uint32_t);
-
-POLKAVM_IMPORT(void, smod, uint32_t, uint32_t, uint32_t);
-
-POLKAVM_IMPORT(void, exp, uint32_t, uint32_t, uint32_t);
-
-POLKAVM_IMPORT(void, signext, uint32_t, uint32_t, uint32_t);

crates/runtime-api/src/polkavm_imports.rs

@@ -68,27 +68,9 @@ pub static VALUE_TRANSFERRED: &str = "value_transferred";
 
 pub static WEIGHT_TO_FEE: &str = "weight_to_fee";
 
-pub static DIV: &str = "div";
-pub static SDIV: &str = "sdiv";
-pub static ADDMOD: &str = "addmod";
-pub static MULMOD: &str = "mulmod";
-pub static MOD: &str = "mod";
-pub static SMOD: &str = "smod";
-pub static EXP: &str = "exp";
-pub static SIGNEXT: &str = "signext";
-
 /// All imported runtime API symbols.
 /// Useful for configuring common attributes and linkage.
-pub static IMPORTS: [&str; 41] = [
-    DIV,
-    SDIV,
-    ADDMOD,
-    MULMOD,
-    MOD,
-    SMOD,
-    EXP,
-    SIGNEXT,
-    //
+pub static IMPORTS: [&str; 33] = [
     ADDRESS,
     BALANCE,
     BALANCE_OF,

crates/solc-json-interface/src/lib.rs

@@ -7,6 +7,7 @@ pub use self::combined_json::contract::Contract as CombinedJsonContract;
 pub use self::standard_json::input::language::Language as SolcStandardJsonInputLanguage;
 pub use self::standard_json::input::settings::metadata::Metadata as SolcStandardJsonInputSettingsMetadata;
 pub use self::standard_json::input::settings::metadata_hash::MetadataHash as SolcStandardJsonInputSettingsMetadataHash;
+pub use self::standard_json::input::settings::optimizer::yul_details::YulDetails as SolcStandardJsonInputSettingsYulOptimizerDetails;
 pub use self::standard_json::input::settings::optimizer::Optimizer as SolcStandardJsonInputSettingsOptimizer;
 pub use self::standard_json::input::settings::polkavm::memory::MemoryConfig as SolcStandardJsonInputSettingsPolkaVMMemory;
 pub use self::standard_json::input::settings::polkavm::memory::DEFAULT_HEAP_SIZE as PolkaVMDefaultHeapMemorySize;

crates/solc-json-interface/src/standard_json/input/mod.rs

@@ -140,7 +140,7 @@ impl Input {
     }
 
     /// Sets the necessary defaults.
-    pub fn normalize(&mut self, version: &semver::Version) {
-        self.settings.normalize(version);
+    pub fn normalize(&mut self) {
+        self.settings.normalize();
     }
 }

crates/solc-json-interface/src/standard_json/input/settings/mod.rs

@@ -74,9 +74,9 @@ impl Settings {
     }
 
     /// Sets the necessary defaults.
-    pub fn normalize(&mut self, version: &semver::Version) {
+    pub fn normalize(&mut self) {
         self.polkavm = None;
-        self.optimizer.normalize(version);
+        self.optimizer.normalize();
     }
 
     /// Parses the library list and returns their double hashmap with path and name as keys.

crates/solc-json-interface/src/standard_json/input/settings/optimizer/details.rs

@@ -3,37 +3,54 @@
 use serde::Deserialize;
 use serde::Serialize;
 
+use crate::standard_json::input::settings::optimizer::yul_details::YulDetails;
+
 /// The `solc --standard-json` input settings optimizer details.
 #[derive(Clone, Debug, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct Details {
     /// Whether the pass is enabled.
-    pub peephole: bool,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub peephole: Option<bool>,
     /// Whether the pass is enabled.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub inliner: Option<bool>,
     /// Whether the pass is enabled.
-    pub jumpdest_remover: bool,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub jumpdest_remover: Option<bool>,
     /// Whether the pass is enabled.
-    pub order_literals: bool,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub order_literals: Option<bool>,
     /// Whether the pass is enabled.
-    pub deduplicate: bool,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub deduplicate: Option<bool>,
     /// Whether the pass is enabled.
-    pub cse: bool,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub cse: Option<bool>,
     /// Whether the pass is enabled.
-    pub constant_optimizer: bool,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub constant_optimizer: Option<bool>,
+    /// Whether the YUL optimizer is enabled.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub yul: Option<bool>,
+    /// The YUL optimizer configuration.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub yul_details: Option<YulDetails>,
 }
 
 impl Details {
     /// A shortcut constructor.
+    #[allow(clippy::too_many_arguments)]
     pub fn new(
-        peephole: bool,
+        peephole: Option<bool>,
         inliner: Option<bool>,
-        jumpdest_remover: bool,
-        order_literals: bool,
-        deduplicate: bool,
-        cse: bool,
-        constant_optimizer: bool,
+        jumpdest_remover: Option<bool>,
+        order_literals: Option<bool>,
+        deduplicate: Option<bool>,
+        cse: Option<bool>,
+        constant_optimizer: Option<bool>,
+        yul: Option<bool>,
+        yul_details: Option<YulDetails>,
     ) -> Self {
         Self {
             peephole,
@@ -43,10 +60,11 @@ impl Details {
             deduplicate,
             cse,
             constant_optimizer,
+            yul,
+            yul_details,
         }
     }
 
-    /// Creates a set of disabled optimizations.
     pub fn disabled(version: &semver::Version) -> Self {
         let inliner = if version >= &semver::Version::new(0, 8, 5) {
             Some(false)
@@ -54,6 +72,16 @@ impl Details {
             None
         };
 
-        Self::new(false, inliner, false, false, false, false, false)
+        Self::new(
+            Some(false),
+            inliner,
+            Some(false),
+            Some(false),
+            Some(false),
+            Some(false),
+            Some(false),
+            None,
+            None,
+        )
     }
 }

crates/solc-json-interface/src/standard_json/input/settings/optimizer/mod.rs

@@ -1,6 +1,7 @@
 //! The `solc --standard-json` input settings optimizer.
 
 pub mod details;
+pub mod yul_details;
 
 use serde::Deserialize;
 use serde::Serialize;
@@ -41,13 +42,8 @@ impl Optimizer {
     }
 
     /// Sets the necessary defaults.
-    pub fn normalize(&mut self, version: &semver::Version) {
+    pub fn normalize(&mut self) {
         self.mode = None;
         self.fallback_to_optimizing_for_size = None;
-        self.details = if version >= &semver::Version::new(0, 5, 5) {
-            Some(Details::disabled(version))
-        } else {
-            None
-        };
     }
 }

crates/solc-json-interface/src/standard_json/input/settings/optimizer/yul_details.rs

@@ -0,0 +1,26 @@
+//! The `solc --standard-json` input settings YUL optimizer details.
+
+use serde::Deserialize;
+use serde::Serialize;
+
+/// The `solc --standard-json` input settings optimizer YUL details.
+#[derive(Clone, Debug, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct YulDetails {
+    /// Whether the stack allocation pass is enabled.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub stack_allocation: Option<bool>,
+    /// The optimization step sequence string.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub optimizer_steps: Option<String>,
+}
+
+impl YulDetails {
+    /// A shortcut constructor.
+    pub fn new(stack_allocation: Option<bool>, optimizer_steps: Option<String>) -> Self {
+        Self {
+            stack_allocation,
+            optimizer_steps,
+        }
+    }
+}

crates/yul/src/lexer/token/lexeme/literal/mod.rs

@@ -27,7 +27,7 @@ impl std::fmt::Display for Literal {
         match self {
             Self::Boolean(inner) => write!(f, "{inner}"),
             Self::Integer(inner) => write!(f, "{inner}"),
-            Self::String(inner) => write!(f, "{inner}"),
+            Self::String(inner) => write!(f, "\"{inner}\""),
         }
     }
 }

crates/yul/src/lexer/token/location.rs

@@ -1,5 +1,8 @@
 //! The lexical token location.
 
+use std::hash::Hash;
+use std::hash::Hasher;
+
 use serde::Deserialize;
 use serde::Serialize;
 
@@ -48,6 +51,13 @@ impl PartialEq for Location {
     }
 }
 
+impl Hash for Location {
+    fn hash<H: Hasher>(&self, state: &mut H) {
+        self.line.hash(state);
+        self.column.hash(state);
+    }
+}
+
 impl std::fmt::Display for Location {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         write!(f, "{}:{}", self.line, self.column)

crates/yul/src/lib.rs

@@ -3,3 +3,4 @@
 pub mod error;
 pub mod lexer;
 pub mod parser;
+pub mod visitor;

crates/yul/src/parser/identifier.rs

@@ -10,6 +10,8 @@ use crate::lexer::token::location::Location;
 use crate::lexer::token::Token;
 use crate::lexer::Lexer;
 use crate::parser::r#type::Type;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 /// The YUL source code identifier.
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
@@ -113,3 +115,15 @@ impl Identifier {
         }
     }
 }
+
+impl AstNode for Identifier {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_identifier(self);
+    }
+
+    fn visit_children(&self, _ast_visitor: &mut impl AstVisitor) {}
+
+    fn location(&self) -> Location {
+        self.location
+    }
+}

crates/yul/src/parser/statement/assignment.rs

@@ -15,6 +15,8 @@ use crate::lexer::Lexer;
 use crate::parser::error::Error as ParserError;
 use crate::parser::identifier::Identifier;
 use crate::parser::statement::expression::Expression;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 /// The Yul assignment expression statement.
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
@@ -119,7 +121,7 @@ where
         mut self,
         context: &mut revive_llvm_context::PolkaVMContext<D>,
     ) -> anyhow::Result<()> {
-        context.set_debug_location(self.location.line, 0, None)?;
+        context.set_debug_location(self.location.line, self.location.column, None)?;
 
         let value = match self.initializer.into_llvm(context)? {
             Some(value) => value,
@@ -149,7 +151,7 @@ where
         context.build_store(tuple_pointer, value)?;
 
         for (index, binding) in self.bindings.into_iter().enumerate() {
-            context.set_debug_location(self.location.line, 0, None)?;
+            context.set_debug_location(self.location.line, self.location.column, None)?;
 
             let field_pointer = context.build_gep(
                 tuple_pointer,
@@ -184,3 +186,20 @@ where
         Ok(())
     }
 }
+
+impl AstNode for Assignment {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_assignment(self);
+    }
+
+    fn visit_children(&self, ast_visitor: &mut impl AstVisitor) {
+        for binding in &self.bindings {
+            binding.accept(ast_visitor);
+        }
+        self.initializer.accept(ast_visitor);
+    }
+
+    fn location(&self) -> Location {
+        self.location
+    }
+}

crates/yul/src/parser/statement/block.rs

@@ -17,6 +17,8 @@ use crate::parser::error::Error as ParserError;
 use crate::parser::statement::assignment::Assignment;
 use crate::parser::statement::expression::Expression;
 use crate::parser::statement::Statement;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 /// The Yul source code block.
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
@@ -155,7 +157,10 @@ where
             function.into_llvm(context)?;
         }
 
-        context.set_current_function(current_function.as_str(), Some(self.location.line))?;
+        context.set_current_function(
+            current_function.as_str(),
+            Some((self.location.line, self.location.column)),
+        )?;
 
         if let Some(debug_info) = context.debug_info() {
             let di_builder = debug_info.builder();
@@ -169,12 +174,16 @@ where
                 )
                 .as_debug_info_scope();
             context.push_debug_scope(di_block_scope);
-            context.set_debug_location(self.location.line, 0, None)?;
+            context.set_debug_location(self.location.line, self.location.column, None)?;
         }
 
         context.set_basic_block(current_block);
         for statement in local_statements.into_iter() {
-            context.set_debug_location(statement.location().line, 0, None)?;
+            context.set_debug_location(
+                statement.location().line,
+                statement.location().column,
+                None,
+            )?;
             if context.basic_block().get_terminator().is_some() {
                 break;
             }
@@ -219,6 +228,22 @@ where
     }
 }
 
+impl AstNode for Block {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_block(self);
+    }
+
+    fn visit_children(&self, ast_visitor: &mut impl AstVisitor) {
+        for statement in &self.statements {
+            statement.accept(ast_visitor);
+        }
+    }
+
+    fn location(&self) -> Location {
+        self.location
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use crate::lexer::token::location::Location;

crates/yul/src/parser/statement/code.rs

@@ -13,6 +13,8 @@ use crate::lexer::token::Token;
 use crate::lexer::Lexer;
 use crate::parser::error::Error as ParserError;
 use crate::parser::statement::block::Block;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 /// The YUL code entity, which is the first block of the object.
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
@@ -66,6 +68,20 @@ where
     }
 }
 
+impl AstNode for Code {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_code(self);
+    }
+
+    fn visit_children(&self, ast_visitor: &mut impl AstVisitor) {
+        self.block.accept(ast_visitor);
+    }
+
+    fn location(&self) -> Location {
+        self.location
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use crate::lexer::token::location::Location;

crates/yul/src/parser/statement/expression/function_call/mod.rs

@@ -19,6 +19,8 @@ use crate::lexer::Lexer;
 use crate::parser::error::Error as ParserError;
 use crate::parser::statement::expression::literal::Literal;
 use crate::parser::statement::expression::Expression;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 use self::name::Name;
 
@@ -123,6 +125,7 @@ impl FunctionCall {
         D: revive_llvm_context::PolkaVMDependency + Clone,
     {
         let location = self.location;
+        context.set_debug_location(location.line, location.column, None)?;
 
         match self.name {
             Name::UserDefined(name) => {
@@ -996,6 +999,8 @@ impl FunctionCall {
         }
         arguments.reverse();
 
+        context.set_debug_location(self.location.line, self.location.column, None)?;
+
         Ok(arguments.try_into().expect("Always successful"))
     }
 
@@ -1013,6 +1018,24 @@ impl FunctionCall {
         }
         arguments.reverse();
 
+        context.set_debug_location(self.location.line, self.location.column, None)?;
+
         Ok(arguments.try_into().expect("Always successful"))
     }
 }
+
+impl AstNode for FunctionCall {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_function_call(self);
+    }
+
+    fn visit_children(&self, ast_visitor: &mut impl AstVisitor) {
+        for argument in &self.arguments {
+            argument.accept(ast_visitor);
+        }
+    }
+
+    fn location(&self) -> Location {
+        self.location
+    }
+}

crates/yul/src/parser/statement/expression/function_call/name.rs

@@ -1,10 +1,13 @@
 //! The function name.
 
+use std::fmt;
+
 use serde::Deserialize;
 use serde::Serialize;
 
 /// The function name.
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
+#[serde(rename_all = "lowercase")]
 pub enum Name {
     /// The user-defined function.
     UserDefined(String),
@@ -356,3 +359,130 @@ impl From<&str> for Name {
         }
     }
 }
+
+impl fmt::Display for Name {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        if let Self::Verbatim {
+            input_size,
+            output_size,
+        } = self
+        {
+            return write!(f, "verbatim_{input_size}i_{output_size}o");
+        }
+
+        let token = match self {
+            Self::Add => "add",
+            Self::Sub => "sub",
+            Self::Mul => "mul",
+            Self::Div => "div",
+            Self::Mod => "mod",
+            Self::Sdiv => "sdiv",
+            Self::Smod => "smod",
+
+            Self::Lt => "lt",
+            Self::Gt => "gt",
+            Self::Eq => "eq",
+            Self::IsZero => "iszero",
+            Self::Slt => "slt",
+            Self::Sgt => "sgt",
+
+            Self::Or => "or",
+            Self::Xor => "xor",
+            Self::Not => "not",
+            Self::And => "and",
+            Self::Shl => "shl",
+            Self::Shr => "shr",
+            Self::Sar => "sar",
+            Self::Byte => "byte",
+            Self::Pop => "pop",
+
+            Self::AddMod => "addmod",
+            Self::MulMod => "mulmod",
+            Self::Exp => "exp",
+            Self::SignExtend => "signextend",
+
+            Self::Keccak256 => "keccak256",
+
+            Self::MLoad => "mload",
+            Self::MStore => "mstore",
+            Self::MStore8 => "mstore8",
+            Self::MCopy => "mcopy",
+
+            Self::SLoad => "sload",
+            Self::SStore => "sstore",
+            Self::TLoad => "tload",
+            Self::TStore => "tstore",
+            Self::LoadImmutable => "loadimmutable",
+            Self::SetImmutable => "setimmutable",
+
+            Self::CallDataLoad => "calldataload",
+            Self::CallDataSize => "calldatasize",
+            Self::CallDataCopy => "calldatacopy",
+            Self::CodeSize => "codesize",
+            Self::CodeCopy => "codecopy",
+            Self::ReturnDataSize => "returndatasize",
+            Self::ReturnDataCopy => "returndatacopy",
+            Self::ExtCodeSize => "extcodesize",
+            Self::ExtCodeHash => "extcodehash",
+
+            Self::Return => "return",
+            Self::Revert => "revert",
+
+            Self::Log0 => "log0",
+            Self::Log1 => "log1",
+            Self::Log2 => "log2",
+            Self::Log3 => "log3",
+            Self::Log4 => "log4",
+
+            Self::Call => "call",
+            Self::DelegateCall => "delegatecall",
+            Self::StaticCall => "staticcall",
+            Self::Create => "create",
+            Self::Create2 => "create2",
+
+            Self::DataSize => "datasize",
+            Self::DataOffset => "dataoffset",
+            Self::DataCopy => "datacopy",
+
+            Self::Stop => "stop",
+            Self::Invalid => "invalid",
+
+            Self::LinkerSymbol => "linkersymbol",
+            Self::MemoryGuard => "memoryguard",
+
+            Self::Address => "address",
+            Self::Caller => "caller",
+
+            Self::CallValue => "callvalue",
+            Self::Gas => "gas",
+            Self::Balance => "balance",
+            Self::SelfBalance => "selfbalance",
+
+            Self::GasLimit => "gaslimit",
+            Self::GasPrice => "gasprice",
+            Self::Origin => "origin",
+            Self::ChainId => "chainid",
+            Self::Timestamp => "timestamp",
+            Self::Number => "number",
+            Self::BlockHash => "blockhash",
+            Self::BlobHash => "blobhash",
+            Self::Difficulty => "difficulty",
+            Self::Prevrandao => "prevrandao",
+            Self::CoinBase => "coinbase",
+            Self::BaseFee => "basefee",
+            Self::BlobBaseFee => "blobbasefee",
+            Self::MSize => "msize",
+
+            Self::CallCode => "callcode",
+            Self::Pc => "pc",
+            Self::ExtCodeCopy => "extcodecopy",
+            Self::SelfDestruct => "selfdestruct",
+
+            Self::UserDefined(s) => s.as_str(),
+
+            Self::Verbatim { .. } => unreachable!(),
+        };
+
+        write!(f, "{token}")
+    }
+}

crates/yul/src/parser/statement/expression/literal.rs

@@ -18,6 +18,8 @@ use crate::lexer::token::Token;
 use crate::lexer::Lexer;
 use crate::parser::error::Error as ParserError;
 use crate::parser::r#type::Type;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 /// Represents a literal in YUL without differentiating its type.
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
@@ -221,3 +223,15 @@ impl Literal {
         }
     }
 }
+
+impl AstNode for Literal {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_literal(self);
+    }
+
+    fn visit_children(&self, _ast_visitor: &mut impl AstVisitor) {}
+
+    fn location(&self) -> Location {
+        self.location
+    }
+}

crates/yul/src/parser/statement/expression/mod.rs

@@ -16,6 +16,8 @@ use crate::lexer::token::Token;
 use crate::lexer::Lexer;
 use crate::parser::error::Error as ParserError;
 use crate::parser::identifier::Identifier;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 use self::function_call::FunctionCall;
 use self::literal::Literal;
@@ -144,3 +146,21 @@ impl Expression {
         }
     }
 }
+
+impl AstNode for Expression {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_expression(self);
+    }
+
+    fn visit_children(&self, ast_visitor: &mut impl AstVisitor) {
+        match self {
+            Self::FunctionCall(inner) => inner.accept(ast_visitor),
+            Self::Identifier(inner) => inner.accept(ast_visitor),
+            Self::Literal(inner) => inner.accept(ast_visitor),
+        }
+    }
+
+    fn location(&self) -> Location {
+        self.location()
+    }
+}

crates/yul/src/parser/statement/for_loop.rs

@@ -11,6 +11,8 @@ use crate::lexer::token::Token;
 use crate::lexer::Lexer;
 use crate::parser::statement::block::Block;
 use crate::parser::statement::expression::Expression;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 /// The Yul for-loop statement.
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
@@ -72,6 +74,7 @@ where
         let increment_block = context.append_basic_block("for_increment");
         let join_block = context.append_basic_block("for_join");
 
+        context.set_debug_location(self.location.line, self.location.column, None)?;
         context.build_unconditional_branch(condition_block);
         context.set_basic_block(condition_block);
         let condition = self
@@ -80,6 +83,7 @@ where
             .expect("Always exists")
             .access(context)?
             .into_int_value();
+        context.set_debug_location(self.location.line, self.location.column, None)?;
         let condition = context.builder().build_int_z_extend_or_bit_cast(
             condition,
             context.word_type(),
@@ -98,10 +102,12 @@ where
         context.set_basic_block(body_block);
         self.body.into_llvm(context)?;
         context.build_unconditional_branch(increment_block);
+        context.set_debug_location(self.location.line, self.location.column, None)?;
 
         context.set_basic_block(increment_block);
         self.finalizer.into_llvm(context)?;
         context.build_unconditional_branch(condition_block);
+        context.set_debug_location(self.location.line, self.location.column, None)?;
 
         context.pop_loop();
         context.set_basic_block(join_block);
@@ -109,3 +115,20 @@ where
         Ok(())
     }
 }
+
+impl AstNode for ForLoop {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_for_loop(self);
+    }
+
+    fn visit_children(&self, ast_visitor: &mut impl AstVisitor) {
+        self.initializer.accept(ast_visitor);
+        self.condition.accept(ast_visitor);
+        self.finalizer.accept(ast_visitor);
+        self.body.accept(ast_visitor);
+    }
+
+    fn location(&self) -> Location {
+        self.location
+    }
+}

crates/yul/src/parser/statement/function_definition.rs

@@ -18,6 +18,8 @@ use crate::parser::error::Error as ParserError;
 use crate::parser::identifier::Identifier;
 use crate::parser::statement::block::Block;
 use crate::parser::statement::expression::function_call::name::Name as FunctionName;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 /// The function definition statement.
 /// All functions are translated in two steps:
@@ -196,6 +198,7 @@ where
         &mut self,
         context: &mut revive_llvm_context::PolkaVMContext<D>,
     ) -> anyhow::Result<()> {
+        context.set_debug_location(self.location.line, self.location.column, None)?;
         let argument_types: Vec<_> = self
             .arguments
             .iter()
@@ -212,6 +215,7 @@ where
             function_type,
             self.result.len(),
             Some(inkwell::module::Linkage::External),
+            Some((self.location.line, self.location.column)),
         )?;
         revive_llvm_context::PolkaVMFunction::set_attributes(
             context.llvm(),
@@ -230,7 +234,10 @@ where
         mut self,
         context: &mut revive_llvm_context::PolkaVMContext<D>,
     ) -> anyhow::Result<()> {
-        context.set_current_function(self.identifier.as_str(), Some(self.location.line))?;
+        context.set_current_function(
+            self.identifier.as_str(),
+            Some((self.location.line, self.location.column)),
+        )?;
         context.set_basic_block(context.current_function().borrow().entry_block());
 
         let r#return = context.current_function().borrow().r#return();
@@ -290,7 +297,7 @@ where
         }
 
         self.body.into_llvm(context)?;
-        context.set_debug_location(self.location.line, 0, None)?;
+        context.set_debug_location(self.location.line, self.location.column, None)?;
 
         match context
             .basic_block()
@@ -324,6 +331,28 @@ where
     }
 }
 
+impl AstNode for FunctionDefinition {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_function_definition(self);
+    }
+
+    fn visit_children(&self, ast_visitor: &mut impl AstVisitor) {
+        for argument in &self.arguments {
+            argument.accept(ast_visitor);
+        }
+
+        self.body.accept(ast_visitor);
+
+        for result in &self.result {
+            result.accept(ast_visitor);
+        }
+    }
+
+    fn location(&self) -> Location {
+        self.location
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use std::collections::BTreeSet;

crates/yul/src/parser/statement/if_conditional.rs

@@ -11,6 +11,8 @@ use crate::lexer::token::Token;
 use crate::lexer::Lexer;
 use crate::parser::statement::block::Block;
 use crate::parser::statement::expression::Expression;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 /// The Yul if-conditional statement.
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
@@ -59,6 +61,7 @@ where
             .expect("Always exists")
             .access(context)?
             .into_int_value();
+        context.set_debug_location(self.location.line, self.location.column, None)?;
         let condition = context.builder().build_int_z_extend_or_bit_cast(
             condition,
             context.word_type(),
@@ -81,3 +84,18 @@ where
         Ok(())
     }
 }
+
+impl AstNode for IfConditional {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_if_conditional(self);
+    }
+
+    fn visit_children(&self, ast_visitor: &mut impl AstVisitor) {
+        self.condition.accept(ast_visitor);
+        self.block.accept(ast_visitor);
+    }
+
+    fn location(&self) -> Location {
+        self.location
+    }
+}

crates/yul/src/parser/statement/mod.rs

@@ -23,6 +23,8 @@ use crate::lexer::token::location::Location;
 use crate::lexer::token::Token;
 use crate::lexer::Lexer;
 use crate::parser::error::Error as ParserError;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 use self::assignment::Assignment;
 use self::block::Block;
@@ -177,3 +179,31 @@ impl Statement {
         }
     }
 }
+
+impl AstNode for Statement {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_statement(self);
+    }
+
+    fn visit_children(&self, ast_visitor: &mut impl AstVisitor) {
+        match self {
+            Self::Object(inner) => inner.accept(ast_visitor),
+            Self::Code(inner) => inner.accept(ast_visitor),
+            Self::Block(inner) => inner.accept(ast_visitor),
+            Self::Expression(inner) => inner.accept(ast_visitor),
+            Self::FunctionDefinition(inner) => inner.accept(ast_visitor),
+            Self::VariableDeclaration(inner) => inner.accept(ast_visitor),
+            Self::Assignment(inner) => inner.accept(ast_visitor),
+            Self::IfConditional(inner) => inner.accept(ast_visitor),
+            Self::Switch(inner) => inner.accept(ast_visitor),
+            Self::ForLoop(inner) => inner.accept(ast_visitor),
+            Self::Continue(_location) => {}
+            Self::Break(_location) => {}
+            Self::Leave(_location) => {}
+        }
+    }
+
+    fn location(&self) -> Location {
+        self.location()
+    }
+}

crates/yul/src/parser/statement/object.rs

@@ -17,6 +17,8 @@ use crate::lexer::token::Token;
 use crate::lexer::Lexer;
 use crate::parser::error::Error as ParserError;
 use crate::parser::statement::code::Code;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 /// The upper-level YUL object, representing the deploy code.
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
@@ -204,10 +206,10 @@ where
         revive_llvm_context::PolkaVMEventLogFunction::<3>.declare(context)?;
         revive_llvm_context::PolkaVMEventLogFunction::<4>.declare(context)?;
 
-        //revive_llvm_context::PolkaVMDivisionFunction.declare(context)?;
-        //revive_llvm_context::PolkaVMSignedDivisionFunction.declare(context)?;
-        //revive_llvm_context::PolkaVMRemainderFunction.declare(context)?;
-        //revive_llvm_context::PolkaVMSignedRemainderFunction.declare(context)?;
+        revive_llvm_context::PolkaVMDivisionFunction.declare(context)?;
+        revive_llvm_context::PolkaVMSignedDivisionFunction.declare(context)?;
+        revive_llvm_context::PolkaVMRemainderFunction.declare(context)?;
+        revive_llvm_context::PolkaVMSignedRemainderFunction.declare(context)?;
 
         revive_llvm_context::PolkaVMSbrkFunction.declare(context)?;
 
@@ -258,10 +260,10 @@ where
         revive_llvm_context::PolkaVMEventLogFunction::<3>.into_llvm(context)?;
         revive_llvm_context::PolkaVMEventLogFunction::<4>.into_llvm(context)?;
 
-        //revive_llvm_context::PolkaVMDivisionFunction.into_llvm(context)?;
-        //revive_llvm_context::PolkaVMSignedDivisionFunction.into_llvm(context)?;
-        //revive_llvm_context::PolkaVMRemainderFunction.into_llvm(context)?;
-        //revive_llvm_context::PolkaVMSignedRemainderFunction.into_llvm(context)?;
+        revive_llvm_context::PolkaVMDivisionFunction.into_llvm(context)?;
+        revive_llvm_context::PolkaVMSignedDivisionFunction.into_llvm(context)?;
+        revive_llvm_context::PolkaVMRemainderFunction.into_llvm(context)?;
+        revive_llvm_context::PolkaVMSignedRemainderFunction.into_llvm(context)?;
 
         revive_llvm_context::PolkaVMSbrkFunction.into_llvm(context)?;
 
@@ -279,17 +281,17 @@ where
             context.push_debug_scope(object_scope.as_debug_info_scope());
         }
 
+        context.set_debug_location(self.location.line, self.location.column, None)?;
         if self.identifier.ends_with("_deployed") {
             revive_llvm_context::PolkaVMRuntimeCodeFunction::new(self.code).into_llvm(context)?;
         } else {
             revive_llvm_context::PolkaVMDeployCodeFunction::new(self.code).into_llvm(context)?;
         }
-        context.set_debug_location(self.location.line, 0, None)?;
 
         if let Some(object) = self.inner_object {
             object.into_llvm(context)?;
         }
-        context.set_debug_location(self.location.line, 0, None)?;
+        context.set_debug_location(self.location.line, self.location.column, None)?;
 
         context.pop_debug_scope();
 
@@ -297,6 +299,24 @@ where
     }
 }
 
+impl AstNode for Object {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_object(self);
+    }
+
+    fn visit_children(&self, ast_visitor: &mut impl AstVisitor) {
+        self.code.accept(ast_visitor);
+
+        if let Some(inner_object) = &self.inner_object {
+            inner_object.accept(ast_visitor);
+        }
+    }
+
+    fn location(&self) -> Location {
+        self.location
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use crate::lexer::token::location::Location;

crates/yul/src/parser/statement/switch/case.rs

@@ -13,6 +13,8 @@ use crate::lexer::Lexer;
 use crate::parser::error::Error as ParserError;
 use crate::parser::statement::block::Block;
 use crate::parser::statement::expression::literal::Literal;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 /// The Yul switch statement case.
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
@@ -61,6 +63,21 @@ impl Case {
     }
 }
 
+impl AstNode for Case {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_case(self);
+    }
+
+    fn visit_children(&self, ast_visitor: &mut impl AstVisitor) {
+        self.literal.accept(ast_visitor);
+        self.block.accept(ast_visitor);
+    }
+
+    fn location(&self) -> Location {
+        self.location
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use crate::lexer::token::location::Location;

crates/yul/src/parser/statement/switch/mod.rs

@@ -16,6 +16,8 @@ use crate::lexer::Lexer;
 use crate::parser::error::Error as ParserError;
 use crate::parser::statement::block::Block;
 use crate::parser::statement::expression::Expression;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 use self::case::Case;
 
@@ -123,6 +125,7 @@ where
     D: revive_llvm_context::PolkaVMDependency + Clone,
 {
     fn into_llvm(self, context: &mut revive_llvm_context::PolkaVMContext<D>) -> anyhow::Result<()> {
+        context.set_debug_location(self.location.line, self.location.column, None)?;
         let scrutinee = self.expression.into_llvm(context)?;
 
         if self.cases.is_empty() {
@@ -143,6 +146,7 @@ where
                 .append_basic_block(format!("switch_case_branch_{}_block", index + 1).as_str());
             context.set_basic_block(expression_block);
             case.block.into_llvm(context)?;
+            context.set_debug_location(self.location.line, self.location.column, None)?;
             context.build_unconditional_branch(join_block);
 
             branches.push((constant.into_int_value(), expression_block));
@@ -159,6 +163,7 @@ where
             None => join_block,
         };
 
+        context.set_debug_location(self.location.line, self.location.column, None)?;
         context.set_basic_block(current_block);
         context.builder().build_switch(
             scrutinee
@@ -169,12 +174,35 @@ where
             branches.as_slice(),
         )?;
 
+        context.set_debug_location(self.location.line, self.location.column, None)?;
         context.set_basic_block(join_block);
 
         Ok(())
     }
 }
 
+impl AstNode for Switch {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_switch(self);
+    }
+
+    fn visit_children(&self, ast_visitor: &mut impl AstVisitor) {
+        self.expression.accept(ast_visitor);
+
+        for case in &self.cases {
+            case.accept(ast_visitor);
+        }
+
+        if let Some(default) = self.default.as_ref() {
+            default.accept(ast_visitor);
+        }
+    }
+
+    fn location(&self) -> Location {
+        self.location
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use crate::lexer::token::location::Location;

crates/yul/src/parser/statement/variable_declaration.rs

@@ -17,6 +17,8 @@ use crate::parser::error::Error as ParserError;
 use crate::parser::identifier::Identifier;
 use crate::parser::statement::expression::function_call::name::Name as FunctionName;
 use crate::parser::statement::expression::Expression;
+use crate::visitor::AstNode;
+use crate::visitor::AstVisitor;
 
 /// The Yul variable declaration statement.
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
@@ -101,7 +103,7 @@ where
     ) -> anyhow::Result<()> {
         if self.bindings.len() == 1 {
             let identifier = self.bindings.remove(0);
-            context.set_debug_location(self.location.line, 0, None)?;
+            context.set_debug_location(self.location.line, self.location.column, None)?;
             let identifier_type = identifier.r#type.clone().unwrap_or_default();
             let r#type = identifier_type.into_llvm(context);
             let pointer = context.build_alloca(r#type, identifier.inner.as_str());
@@ -133,7 +135,7 @@ where
         }
 
         for (index, binding) in self.bindings.iter().enumerate() {
-            context.set_debug_location(self.location.line, 0, None)?;
+            context.set_debug_location(self.location.line, self.location.column, None)?;
 
             let yul_type = binding
                 .r#type
@@ -218,6 +220,26 @@ where
     }
 }
 
+impl AstNode for VariableDeclaration {
+    fn accept(&self, ast_visitor: &mut impl AstVisitor) {
+        ast_visitor.visit_variable_declaration(self);
+    }
+
+    fn visit_children(&self, ast_visitor: &mut impl AstVisitor) {
+        for binding in &self.bindings {
+            binding.accept(ast_visitor);
+        }
+
+        if let Some(initializer) = self.expression.as_ref() {
+            initializer.accept(ast_visitor);
+        }
+    }
+
+    fn location(&self) -> Location {
+        self.location
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use crate::lexer::token::location::Location;

crates/yul/src/visitor.rs

@@ -0,0 +1,768 @@
+//! The YUL AST visitor interface definitions.
+
+use crate::{
+    lexer::token::location::Location,
+    parser::{
+        identifier::Identifier,
+        statement::{
+            assignment::Assignment,
+            block::Block,
+            code::Code,
+            expression::{function_call::FunctionCall, literal::Literal, Expression},
+            for_loop::ForLoop,
+            function_definition::FunctionDefinition,
+            if_conditional::IfConditional,
+            object::Object,
+            switch::{case::Case, Switch},
+            variable_declaration::VariableDeclaration,
+            Statement,
+        },
+    },
+};
+
+/// This trait is implemented by all AST node types.
+///
+/// It allows to define how the AST is visited on a per-node basis.
+pub trait AstNode: std::fmt::Debug {
+    /// Accept the given [AstVisitor].
+    ///
+    /// This is supposed to call the corresponding `AstVisitor::visit_*` method.
+    fn accept(&self, ast_visitor: &mut impl AstVisitor);
+
+    /// Let any child nodes accept the given [AstVisitor].
+    ///
+    /// This is supposed visit child nodes in the correct order.
+    ///
+    /// Visitor implementations call this method for traversing.
+    fn visit_children(&self, _ast_visitor: &mut impl AstVisitor) {}
+
+    /// Returns the lexer (source) location of the node.
+    fn location(&self) -> Location;
+}
+
+/// This trait allows implementing custom AST visitor logic for each node type.
+///
+/// The visitor can call the nodes [AstNode::visit_children] method (from any
+/// other trait method). This simplifies the implementation of AST visitors.
+///
+/// Default implementations which do nothing except accepting the visitor via the
+/// [AstVisitor::visit] method are provided for each node type.
+///
+/// The [AstVisitor::visit] method is the generic visitor method, seen by all
+/// nodes.
+///
+/// Visited nodes are given read only access (non-mutable references); it's a
+/// compiler design practice to not mutate the AST after parsing.
+/// Instead, mutable access to the [AstVisitor] instance itself is provided,
+/// allowing to build a new representation if needed.
+///
+/// # Example
+///
+/// ```rust
+/// use revive_yul::visitor::*;
+///
+/// /// A very simple visitor that counts all nodes in the AST.
+/// #[derive(Default, Debug)]
+/// pub struct CountVisitor(usize);
+///
+/// impl AstVisitor for CountVisitor {
+///     /// Increment the counter for ech node we visit.
+///     fn visit(&mut self, node: &impl AstNode) {
+///         node.visit_children(self);
+///         self.0 += 1;
+///     }
+///
+///     /*
+///
+///     /// If we were interested in a per-statement breakdown of the AST,
+///     /// we would implement `visit_*` methods to cover each node like this:
+///     fn visit_block(&mut self, node: &Block) {
+///         self.visit_children(node);
+///         self.block_count += 1;
+///     }
+///
+///     */
+/// }
+///
+/// ```
+pub trait AstVisitor {
+    /// The generic visitor logic for all node types is executed upon visiting any statement.
+    fn visit(&mut self, node: &impl AstNode);
+
+    /// The logic to execute upon visiting [Assignment] statements.
+    fn visit_assignment(&mut self, node: &Assignment) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting any [Block].
+    fn visit_block(&mut self, node: &Block) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting [Case] statements.
+    fn visit_case(&mut self, node: &Case) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting [Code] statements.
+    fn visit_code(&mut self, node: &Code) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting any [Expression].
+    fn visit_expression(&mut self, node: &Expression) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting [ForLoop] statements.
+    fn visit_for_loop(&mut self, node: &ForLoop) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting [FunctionCall] statements.
+    fn visit_function_call(&mut self, node: &FunctionCall) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting any [FunctionDefinition].
+    fn visit_function_definition(&mut self, node: &FunctionDefinition) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting any [Identifier].
+    fn visit_identifier(&mut self, node: &Identifier) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting [IfConditional] statements.
+    fn visit_if_conditional(&mut self, node: &IfConditional) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting any [Literal].
+    fn visit_literal(&mut self, node: &Literal) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting [Object] definitions.
+    fn visit_object(&mut self, node: &Object) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting any YUL [Statement].
+    fn visit_statement(&mut self, node: &Statement) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting [Switch] statements.
+    fn visit_switch(&mut self, node: &Switch) {
+        self.visit(node);
+    }
+
+    /// The logic to execute upon visiting any [VariableDeclaration].
+    fn visit_variable_declaration(&mut self, node: &VariableDeclaration) {
+        self.visit(node);
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::{
+        lexer::Lexer,
+        parser::{
+            identifier::Identifier,
+            statement::{
+                assignment::Assignment,
+                block::Block,
+                code::Code,
+                expression::{function_call::FunctionCall, literal::Literal, Expression},
+                for_loop::ForLoop,
+                function_definition::FunctionDefinition,
+                if_conditional::IfConditional,
+                object::Object,
+                switch::{case::Case, Switch},
+                variable_declaration::VariableDeclaration,
+                Statement,
+            },
+        },
+    };
+
+    use super::{AstNode, AstVisitor};
+
+    /// The [Printer] visitor builds the AST back into its textual representation.
+    #[derive(Default)]
+    struct Printer {
+        /// The print buffer.
+        buffer: String,
+        /// The current indentation level.
+        indentation: usize,
+    }
+
+    impl Printer {
+        /// Append a newline with the current identation to the print buffer.
+        fn newline(&mut self) {
+            self.buffer.push('\n');
+            self.indent();
+        }
+
+        /// Append the current identation to the print buffer.
+        fn indent(&mut self) {
+            for _ in 0..self.indentation {
+                self.buffer.push_str("  ");
+            }
+        }
+
+        /// Append the given `nodes` comma-separated.
+        fn separate(&mut self, nodes: &[impl AstNode]) {
+            for (index, argument) in nodes.iter().enumerate() {
+                argument.accept(self);
+
+                if index < nodes.len() - 1 {
+                    self.buffer.push_str(", ");
+                }
+            }
+        }
+    }
+
+    impl AstVisitor for Printer {
+        fn visit(&mut self, node: &impl AstNode) {
+            node.accept(self);
+        }
+
+        fn visit_assignment(&mut self, node: &Assignment) {
+            self.separate(&node.bindings);
+
+            self.buffer.push_str(" := ");
+
+            node.initializer.visit_children(self);
+        }
+
+        fn visit_block(&mut self, node: &Block) {
+            self.newline();
+            self.buffer.push('{');
+            self.indentation += 1;
+
+            node.visit_children(self);
+
+            self.indentation -= 1;
+            self.newline();
+            self.buffer.push('}');
+        }
+
+        fn visit_case(&mut self, node: &Case) {
+            self.newline();
+            self.buffer.push_str("case ");
+            node.visit_children(self);
+        }
+
+        fn visit_code(&mut self, node: &Code) {
+            self.buffer.push_str("code ");
+            node.visit_children(self);
+        }
+
+        fn visit_expression(&mut self, node: &Expression) {
+            node.visit_children(self);
+        }
+
+        fn visit_for_loop(&mut self, node: &ForLoop) {
+            self.buffer.push_str("for ");
+            node.visit_children(self);
+        }
+
+        fn visit_function_call(&mut self, node: &FunctionCall) {
+            self.buffer.push_str(&format!("{}", node.name));
+            self.buffer.push('(');
+
+            self.separate(&node.arguments);
+
+            self.buffer.push(')');
+        }
+
+        fn visit_function_definition(&mut self, node: &FunctionDefinition) {
+            self.buffer
+                .push_str(&format!("function {}", node.identifier));
+
+            self.buffer.push('(');
+            self.separate(&node.arguments);
+            self.buffer.push(')');
+
+            self.buffer.push_str(" -> ");
+            self.separate(&node.result);
+
+            node.body.accept(self);
+        }
+
+        fn visit_identifier(&mut self, node: &Identifier) {
+            self.buffer.push_str(&node.inner);
+        }
+
+        fn visit_if_conditional(&mut self, node: &IfConditional) {
+            self.buffer.push_str("if ");
+            node.visit_children(self);
+        }
+
+        fn visit_literal(&mut self, node: &Literal) {
+            self.buffer.push_str(&format!("{}", node.inner));
+        }
+
+        fn visit_object(&mut self, node: &Object) {
+            self.newline();
+            self.buffer.push_str("object \"");
+            self.buffer.push_str(&node.identifier);
+            self.buffer.push_str("\" {");
+            self.indentation += 1;
+            self.newline();
+
+            node.visit_children(self);
+
+            self.indentation -= 1;
+            self.newline();
+            self.buffer.push('}');
+        }
+
+        fn visit_statement(&mut self, node: &Statement) {
+            self.newline();
+            node.visit_children(self);
+        }
+
+        fn visit_switch(&mut self, node: &Switch) {
+            self.buffer.push_str("switch ");
+            node.visit_children(self);
+        }
+
+        fn visit_variable_declaration(&mut self, node: &VariableDeclaration) {
+            self.buffer.push_str("let ");
+            self.separate(&node.bindings);
+
+            if let Some(initializer) = node.expression.as_ref() {
+                self.buffer.push_str(" := ");
+                initializer.visit_children(self);
+            }
+        }
+    }
+
+    const ERC20: &str = r#"/// @use-src 0:"crates/integration/contracts/ERC20.sol"
+object "ERC20_247" {
+    code {
+        {
+            /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+            mstore(64, memoryguard(0x80))
+            if callvalue() { revert(0, 0) }
+            let oldLen := extract_byte_array_length(sload(/** @src 0:1542:1563  "\"Solidity by Example\"" */ 0x03))
+            /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+            if gt(oldLen, 31)
+            {
+                mstore(/** @src -1:-1:-1 */ 0, /** @src 0:1542:1563  "\"Solidity by Example\"" */ 0x03)
+                /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                let data := keccak256(/** @src -1:-1:-1 */ 0, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 0x20)
+                let deleteStart := add(data, 1)
+                deleteStart := data
+                let _1 := add(data, shr(5, add(oldLen, 31)))
+                let start := data
+                for { } lt(start, _1) { start := add(start, 1) }
+                {
+                    sstore(start, /** @src -1:-1:-1 */ 0)
+                }
+            }
+            /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+            sstore(/** @src 0:1542:1563  "\"Solidity by Example\"" */ 0x03, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ add("Solidity by Example", 38))
+            let oldLen_1 := extract_byte_array_length(sload(/** @src 0:1592:1601  "\"SOLBYEX\"" */ 0x04))
+            /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+            if gt(oldLen_1, 31)
+            {
+                mstore(/** @src -1:-1:-1 */ 0, /** @src 0:1592:1601  "\"SOLBYEX\"" */ 0x04)
+                /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                let data_1 := keccak256(/** @src -1:-1:-1 */ 0, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 0x20)
+                let deleteStart_1 := add(data_1, 1)
+                deleteStart_1 := data_1
+                let _2 := add(data_1, shr(5, add(oldLen_1, 31)))
+                let start_1 := data_1
+                for { } lt(start_1, _2) { start_1 := add(start_1, 1) }
+                {
+                    sstore(start_1, /** @src -1:-1:-1 */ 0)
+                }
+            }
+            /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+            sstore(/** @src 0:1592:1601  "\"SOLBYEX\"" */ 0x04, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ add("SOLBYEX", 14))
+            sstore(/** @src 0:1631:1633  "18" */ 0x05, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ or(and(sload(/** @src 0:1631:1633  "18" */ 0x05), /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ not(255)), /** @src 0:1631:1633  "18" */ 0x12))
+            /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+            let _3 := mload(64)
+            let _4 := datasize("ERC20_247_deployed")
+            codecopy(_3, dataoffset("ERC20_247_deployed"), _4)
+            return(_3, _4)
+        }
+        function extract_byte_array_length(data) -> length
+        {
+            length := shr(1, data)
+            let outOfPlaceEncoding := and(data, 1)
+            if iszero(outOfPlaceEncoding) { length := and(length, 0x7f) }
+            if eq(outOfPlaceEncoding, lt(length, 32))
+            {
+                mstore(0, shl(224, 0x4e487b71))
+                mstore(4, 0x22)
+                revert(0, 0x24)
+            }
+        }
+    }
+    /// @use-src 0:"crates/integration/contracts/ERC20.sol"
+    object "ERC20_247_deployed" {
+        code {
+            {
+                /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                mstore(64, memoryguard(0x80))
+                if iszero(lt(calldatasize(), 4))
+                {
+                    switch shr(224, calldataload(0))
+                    case 0x06fdde03 {
+                        if callvalue() { revert(0, 0) }
+                        if slt(add(calldatasize(), not(3)), 0) { revert(0, 0) }
+                        /// @src 0:1521:1563  "string public name = \"Solidity by Example\""
+                        let value := /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 0
+                        let offset := 0
+                        offset := 0
+                        let memPtr := mload(64)
+                        let ret := 0
+                        let slotValue := sload(/** @src 0:1521:1563  "string public name = \"Solidity by Example\"" */ 3)
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        let length := 0
+                        length := shr(1, slotValue)
+                        let outOfPlaceEncoding := and(slotValue, 1)
+                        if iszero(outOfPlaceEncoding) { length := and(length, 0x7f) }
+                        if eq(outOfPlaceEncoding, lt(length, 32))
+                        {
+                            mstore(0, shl(224, 0x4e487b71))
+                            mstore(4, 0x22)
+                            revert(0, 0x24)
+                        }
+                        mstore(memPtr, length)
+                        switch outOfPlaceEncoding
+                        case 0 {
+                            mstore(add(memPtr, 32), and(slotValue, not(255)))
+                            ret := add(add(memPtr, shl(5, iszero(iszero(length)))), 32)
+                        }
+                        case 1 {
+                            mstore(0, /** @src 0:1521:1563  "string public name = \"Solidity by Example\"" */ 3)
+                            /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                            let dataPos := keccak256(0, 32)
+                            let i := 0
+                            for { } lt(i, length) { i := add(i, 32) }
+                            {
+                                mstore(add(add(memPtr, i), 32), sload(dataPos))
+                                dataPos := add(dataPos, 1)
+                            }
+                            ret := add(add(memPtr, i), 32)
+                        }
+                        let newFreePtr := add(memPtr, and(add(sub(ret, memPtr), 31), not(31)))
+                        if or(gt(newFreePtr, 0xffffffffffffffff), lt(newFreePtr, memPtr))
+                        {
+                            mstore(0, shl(224, 0x4e487b71))
+                            mstore(4, 0x41)
+                            revert(0, 0x24)
+                        }
+                        mstore(64, newFreePtr)
+                        value := memPtr
+                        let memPos := mload(64)
+                        return(memPos, sub(abi_encode_string(memPos, memPtr), memPos))
+                    }
+                    case 0x095ea7b3 {
+                        if callvalue() { revert(0, 0) }
+                        if slt(add(calldatasize(), not(3)), 64) { revert(0, 0) }
+                        let value0 := abi_decode_address_3473()
+                        let value_1 := calldataload(36)
+                        mstore(0, /** @src 0:1974:1984  "msg.sender" */ caller())
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        mstore(32, /** @src 0:1964:1973  "allowance" */ 0x02)
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        let dataSlot := keccak256(0, 64)
+                        /// @src 0:1964:1994  "allowance[msg.sender][spender]"
+                        let dataSlot_1 := /** @src -1:-1:-1 */ 0
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        mstore(/** @src -1:-1:-1 */ 0, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ and(/** @src 0:1964:1994  "allowance[msg.sender][spender]" */ value0, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ sub(shl(160, 1), 1)))
+                        mstore(0x20, /** @src 0:1964:1985  "allowance[msg.sender]" */ dataSlot)
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        dataSlot_1 := keccak256(/** @src -1:-1:-1 */ 0, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 0x40)
+                        sstore(/** @src 0:1964:1994  "allowance[msg.sender][spender]" */ dataSlot_1, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ value_1)
+                        /// @src 0:2018:2055  "Approval(msg.sender, spender, amount)"
+                        let _1 := /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ mload(64)
+                        mstore(_1, value_1)
+                        /// @src 0:2018:2055  "Approval(msg.sender, spender, amount)"
+                        log3(_1, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 32, /** @src 0:2018:2055  "Approval(msg.sender, spender, amount)" */ 0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925, /** @src 0:1974:1984  "msg.sender" */ caller(), /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ and(/** @src 0:2018:2055  "Approval(msg.sender, spender, amount)" */ value0, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ sub(shl(160, 1), 1)))
+                        let memPos_1 := mload(64)
+                        mstore(memPos_1, 1)
+                        return(memPos_1, 32)
+                    }
+                    case 0x18160ddd {
+                        if callvalue() { revert(0, 0) }
+                        if slt(add(calldatasize(), not(3)), 0) { revert(0, 0) }
+                        let _2 := sload(0)
+                        let memPos_2 := mload(64)
+                        mstore(memPos_2, _2)
+                        return(memPos_2, 32)
+                    }
+                    case 0x23b872dd {
+                        if callvalue() { revert(0, 0) }
+                        if slt(add(calldatasize(), not(3)), 96) { revert(0, 0) }
+                        let value0_1 := abi_decode_address_3473()
+                        let value1 := abi_decode_address()
+                        let value_2 := calldataload(68)
+                        let _3 := and(value0_1, sub(shl(160, 1), 1))
+                        mstore(0, _3)
+                        mstore(32, /** @src 0:2223:2232  "allowance" */ 0x02)
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        let dataSlot_2 := keccak256(0, 64)
+                        /// @src 0:2223:2252  "allowance[sender][msg.sender]"
+                        let dataSlot_3 := /** @src -1:-1:-1 */ 0
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        mstore(/** @src -1:-1:-1 */ 0, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ and(/** @src 0:2241:2251  "msg.sender" */ caller(), /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ sub(shl(160, 1), 1)))
+                        mstore(0x20, /** @src 0:2223:2252  "allowance[sender][msg.sender]" */ dataSlot_2)
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        dataSlot_3 := keccak256(/** @src -1:-1:-1 */ 0, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 0x40)
+                        sstore(/** @src 0:2223:2252  "allowance[sender][msg.sender]" */ dataSlot_3, /** @src 0:2223:2262  "allowance[sender][msg.sender] -= amount" */ checked_sub_uint256(/** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ sload(/** @src 0:2223:2252  "allowance[sender][msg.sender]" */ dataSlot_3), /** @src 0:2223:2262  "allowance[sender][msg.sender] -= amount" */ value_2))
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        mstore(0, _3)
+                        mstore(32, 1)
+                        let dataSlot_4 := keccak256(0, 64)
+                        sstore(dataSlot_4, /** @src 0:2272:2299  "balanceOf[sender] -= amount" */ checked_sub_uint256(/** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ sload(/** @src 0:2272:2299  "balanceOf[sender] -= amount" */ dataSlot_4), value_2))
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        let _4 := and(value1, sub(shl(160, 1), 1))
+                        mstore(0, _4)
+                        mstore(32, 1)
+                        let dataSlot_5 := keccak256(0, 64)
+                        sstore(dataSlot_5, /** @src 0:2309:2339  "balanceOf[recipient] += amount" */ checked_add_uint256(/** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ sload(/** @src 0:2309:2339  "balanceOf[recipient] += amount" */ dataSlot_5), value_2))
+                        /// @src 0:2354:2389  "Transfer(sender, recipient, amount)"
+                        let _5 := /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ mload(64)
+                        mstore(_5, value_2)
+                        /// @src 0:2354:2389  "Transfer(sender, recipient, amount)"
+                        log3(_5, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 32, /** @src 0:2354:2389  "Transfer(sender, recipient, amount)" */ 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef, _3, _4)
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        let memPos_3 := mload(64)
+                        mstore(memPos_3, 1)
+                        return(memPos_3, 32)
+                    }
+                    case 0x313ce567 {
+                        if callvalue() { revert(0, 0) }
+                        if slt(add(calldatasize(), not(3)), 0) { revert(0, 0) }
+                        let value_3 := and(sload(/** @src 0:1607:1633  "uint8 public decimals = 18" */ 5), /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 0xff)
+                        let memPos_4 := mload(64)
+                        mstore(memPos_4, value_3)
+                        return(memPos_4, 32)
+                    }
+                    case 0x42966c68 {
+                        if callvalue() { revert(0, 0) }
+                        if slt(add(calldatasize(), not(3)), 32) { revert(0, 0) }
+                        let value_4 := calldataload(4)
+                        mstore(0, /** @src 0:2655:2665  "msg.sender" */ caller())
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        mstore(32, 1)
+                        let dataSlot_6 := keccak256(0, 64)
+                        sstore(dataSlot_6, /** @src 0:2645:2676  "balanceOf[msg.sender] -= amount" */ checked_sub_uint256(/** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ sload(/** @src 0:2645:2676  "balanceOf[msg.sender] -= amount" */ dataSlot_6), value_4))
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        sstore(0, /** @src 0:2686:2707  "totalSupply -= amount" */ checked_sub_uint256(/** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ sload(0), /** @src 0:2686:2707  "totalSupply -= amount" */ value_4))
+                        /// @src 0:2722:2762  "Transfer(msg.sender, address(0), amount)"
+                        let _6 := /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ mload(64)
+                        mstore(_6, value_4)
+                        /// @src 0:2722:2762  "Transfer(msg.sender, address(0), amount)"
+                        log3(_6, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 32, /** @src 0:2722:2762  "Transfer(msg.sender, address(0), amount)" */ 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef, /** @src 0:2655:2665  "msg.sender" */ caller(), /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 0)
+                        return(0, 0)
+                    }
+                    case 0x70a08231 {
+                        if callvalue() { revert(0, 0) }
+                        if slt(add(calldatasize(), not(3)), 32) { revert(0, 0) }
+                        mstore(0, and(abi_decode_address_3473(), sub(shl(160, 1), 1)))
+                        mstore(32, /** @src 0:1407:1448  "mapping(address => uint) public balanceOf" */ 1)
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        let _7 := sload(keccak256(0, 64))
+                        let memPos_5 := mload(64)
+                        mstore(memPos_5, _7)
+                        return(memPos_5, 32)
+                    }
+                    case 0x95d89b41 {
+                        if callvalue() { revert(0, 0) }
+                        if slt(add(calldatasize(), not(3)), 0) { revert(0, 0) }
+                        /// @src 0:1569:1601  "string public symbol = \"SOLBYEX\""
+                        let value_5 := /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 0
+                        let offset_1 := 0
+                        offset_1 := 0
+                        let memPtr_1 := mload(64)
+                        let ret_1 := 0
+                        let slotValue_1 := sload(4)
+                        let length_1 := 0
+                        length_1 := shr(1, slotValue_1)
+                        let outOfPlaceEncoding_1 := and(slotValue_1, 1)
+                        if iszero(outOfPlaceEncoding_1)
+                        {
+                            length_1 := and(length_1, 0x7f)
+                        }
+                        if eq(outOfPlaceEncoding_1, lt(length_1, 32))
+                        {
+                            mstore(0, shl(224, 0x4e487b71))
+                            mstore(4, 0x22)
+                            revert(0, 0x24)
+                        }
+                        mstore(memPtr_1, length_1)
+                        switch outOfPlaceEncoding_1
+                        case 0 {
+                            mstore(add(memPtr_1, 32), and(slotValue_1, not(255)))
+                            ret_1 := add(add(memPtr_1, shl(5, iszero(iszero(length_1)))), 32)
+                        }
+                        case 1 {
+                            mstore(0, 4)
+                            let dataPos_1 := keccak256(0, 32)
+                            let i_1 := 0
+                            for { } lt(i_1, length_1) { i_1 := add(i_1, 32) }
+                            {
+                                mstore(add(add(memPtr_1, i_1), 32), sload(dataPos_1))
+                                dataPos_1 := add(dataPos_1, 1)
+                            }
+                            ret_1 := add(add(memPtr_1, i_1), 32)
+                        }
+                        let newFreePtr_1 := add(memPtr_1, and(add(sub(ret_1, memPtr_1), 31), not(31)))
+                        if or(gt(newFreePtr_1, 0xffffffffffffffff), lt(newFreePtr_1, memPtr_1))
+                        {
+                            mstore(0, shl(224, 0x4e487b71))
+                            mstore(4, 0x41)
+                            revert(0, 0x24)
+                        }
+                        mstore(64, newFreePtr_1)
+                        value_5 := memPtr_1
+                        let memPos_6 := mload(64)
+                        return(memPos_6, sub(abi_encode_string(memPos_6, memPtr_1), memPos_6))
+                    }
+                    case 0xa0712d68 {
+                        if callvalue() { revert(0, 0) }
+                        if slt(add(calldatasize(), not(3)), 32) { revert(0, 0) }
+                        let value_6 := calldataload(4)
+                        mstore(0, /** @src 0:2479:2489  "msg.sender" */ caller())
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        mstore(32, 1)
+                        let dataSlot_7 := keccak256(0, 64)
+                        sstore(dataSlot_7, /** @src 0:2469:2500  "balanceOf[msg.sender] += amount" */ checked_add_uint256(/** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ sload(/** @src 0:2469:2500  "balanceOf[msg.sender] += amount" */ dataSlot_7), value_6))
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        sstore(0, /** @src 0:2510:2531  "totalSupply += amount" */ checked_add_uint256(/** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ sload(0), /** @src 0:2510:2531  "totalSupply += amount" */ value_6))
+                        /// @src 0:2546:2586  "Transfer(address(0), msg.sender, amount)"
+                        let _8 := /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ mload(64)
+                        mstore(_8, value_6)
+                        /// @src 0:2546:2586  "Transfer(address(0), msg.sender, amount)"
+                        log3(_8, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 32, /** @src 0:2546:2586  "Transfer(address(0), msg.sender, amount)" */ 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 0, /** @src 0:2479:2489  "msg.sender" */ caller())
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        return(0, 0)
+                    }
+                    case 0xa9059cbb {
+                        if callvalue() { revert(0, 0) }
+                        if slt(add(calldatasize(), not(3)), 64) { revert(0, 0) }
+                        let value0_2 := abi_decode_address_3473()
+                        let value_7 := calldataload(36)
+                        mstore(0, /** @src 0:1734:1744  "msg.sender" */ caller())
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        mstore(32, 1)
+                        let dataSlot_8 := keccak256(0, 64)
+                        sstore(dataSlot_8, /** @src 0:1724:1755  "balanceOf[msg.sender] -= amount" */ checked_sub_uint256(/** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ sload(/** @src 0:1724:1755  "balanceOf[msg.sender] -= amount" */ dataSlot_8), value_7))
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        let _9 := and(value0_2, sub(shl(160, 1), 1))
+                        mstore(0, _9)
+                        mstore(32, 1)
+                        let dataSlot_9 := keccak256(0, 64)
+                        sstore(dataSlot_9, /** @src 0:1765:1795  "balanceOf[recipient] += amount" */ checked_add_uint256(/** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ sload(/** @src 0:1765:1795  "balanceOf[recipient] += amount" */ dataSlot_9), value_7))
+                        /// @src 0:1810:1849  "Transfer(msg.sender, recipient, amount)"
+                        let _10 := /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ mload(64)
+                        mstore(_10, value_7)
+                        /// @src 0:1810:1849  "Transfer(msg.sender, recipient, amount)"
+                        log3(_10, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 32, /** @src 0:1810:1849  "Transfer(msg.sender, recipient, amount)" */ 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef, /** @src 0:1734:1744  "msg.sender" */ caller(), /** @src 0:1810:1849  "Transfer(msg.sender, recipient, amount)" */ _9)
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        let memPos_7 := mload(64)
+                        mstore(memPos_7, 1)
+                        return(memPos_7, 32)
+                    }
+                    case 0xdd62ed3e {
+                        if callvalue() { revert(0, 0) }
+                        if slt(add(calldatasize(), not(3)), 64) { revert(0, 0) }
+                        let value0_3 := abi_decode_address_3473()
+                        let value1_1 := abi_decode_address()
+                        mstore(0, and(value0_3, sub(shl(160, 1), 1)))
+                        mstore(32, /** @src 0:1454:1515  "mapping(address => mapping(address => uint)) public allowance" */ 2)
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        let dataSlot_10 := keccak256(0, 64)
+                        /// @src 0:1454:1515  "mapping(address => mapping(address => uint)) public allowance"
+                        let dataSlot_11 := /** @src -1:-1:-1 */ 0
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        mstore(/** @src -1:-1:-1 */ 0, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ and(/** @src 0:1454:1515  "mapping(address => mapping(address => uint)) public allowance" */ value1_1, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ sub(shl(160, 1), 1)))
+                        mstore(0x20, /** @src 0:1454:1515  "mapping(address => mapping(address => uint)) public allowance" */ dataSlot_10)
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        dataSlot_11 := keccak256(/** @src -1:-1:-1 */ 0, /** @src 0:1347:2771  "contract ERC20 is IERC20 {..." */ 0x40)
+                        let _11 := sload(/** @src 0:1454:1515  "mapping(address => mapping(address => uint)) public allowance" */ dataSlot_11)
+                        /// @src 0:1347:2771  "contract ERC20 is IERC20 {..."
+                        let memPos_8 := mload(64)
+                        mstore(memPos_8, _11)
+                        return(memPos_8, 32)
+                    }
+                }
+                revert(0, 0)
+            }
+            function abi_encode_string(headStart, value0) -> tail
+            {
+                mstore(headStart, 32)
+                let length := mload(value0)
+                mstore(add(headStart, 32), length)
+                mcopy(add(headStart, 64), add(value0, 32), length)
+                mstore(add(add(headStart, length), 64), 0)
+                tail := add(add(headStart, and(add(length, 31), not(31))), 64)
+            }
+            function abi_decode_address_3473() -> value
+            {
+                value := calldataload(4)
+                if iszero(eq(value, and(value, sub(shl(160, 1), 1)))) { revert(0, 0) }
+            }
+            function abi_decode_address() -> value
+            {
+                value := calldataload(36)
+                if iszero(eq(value, and(value, sub(shl(160, 1), 1)))) { revert(0, 0) }
+            }
+            function checked_sub_uint256(x, y) -> diff
+            {
+                diff := sub(x, y)
+                if gt(diff, x)
+                {
+                    mstore(0, shl(224, 0x4e487b71))
+                    mstore(4, 0x11)
+                    revert(0, 0x24)
+                }
+            }
+            function checked_add_uint256(x, y) -> sum
+            {
+                sum := add(x, y)
+                if gt(x, sum)
+                {
+                    mstore(0, shl(224, 0x4e487b71))
+                    mstore(4, 0x11)
+                    revert(0, 0x24)
+                }
+            }
+        }
+        data ".metadata" hex"a264697066735822122050b3876a7c06489a119481ba2b8611bfb9d92d0624a61503d2b86a77af8e277164736f6c634300081c0033"
+    }
+}"#;
+
+    /// Parsing the output of the print visitor as a basic integration test.
+    #[test]
+    fn print_visitor_works() {
+        let mut printer = Printer::default();
+        Object::parse(&mut Lexer::new(ERC20.into()), None)
+            .unwrap()
+            .accept(&mut printer);
+
+        let mut printer2 = Printer::default();
+        Object::parse(&mut Lexer::new(printer.buffer.clone()), None)
+            .unwrap()
+            .accept(&mut printer2);
+
+        assert_eq!(
+            printer.buffer, printer2.buffer,
+            "the output from the printers must converge immediately"
+        );
+
+        assert!(
+            !printer.buffer.is_empty(),
+            "the printer must produce output"
+        );
+    }
+}