ci: clippy (#227)

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

.github/workflows/get-release-artifact.js

@@ -0,0 +1,36 @@
+module.exports = async ({
+  octokit,
+  context,
+  releasePrefix,
+  artifactSuffix,
+}) => {
+  let page = 1;
+
+  while (true) {
+    const res = await octokit.rest.repos.listReleases({
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      per_page: 100,
+      page,
+    });
+    if (res.data.length === 0) {
+      throw new Error(
+        `No LLVM releases with '${artifactSuffix}' atifacts found! Please release LLVM before running this workflow.`,
+      );
+    }
+
+    for (let release of res.data) {
+      if (release.tag_name.startsWith(releasePrefix)) {
+        for (let asset of release.assets) {
+          if (asset.name.includes(artifactSuffix)) {
+            return asset.browser_download_url;
+          }
+        }
+        console.warn(
+          `LLVM release ${release.tag_name} doesn't have a '${artifactSuffix}' artifact; searching for older releases...`,
+        );
+      }
+    }
+    page++;
+  }
+};

.github/workflows/release-llvm.yml

@@ -0,0 +1,167 @@
+name: Release LLVM
+
+on:
+  workflow_dispatch:
+    inputs:
+      llvm_version:
+        type: string
+        required: true
+        description: llvm version in "x.x.x" format, e.g. "18.1.8"
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    outputs:
+      version: ${{ steps.resolve-version.outputs.version }}
+    steps:
+      - id: resolve-version
+        run: |
+          echo "version=llvm-${{ inputs.llvm_version }}-revive.${GITHUB_SHA:0:7}" >> $GITHUB_OUTPUT
+
+      - name: create release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: "LLVM binaries release: ${{ steps.resolve-version.outputs.version }}"
+          body: "This release includes binaries of LLVM, used to compile revive itself"
+          make_latest: "false"
+          tag_name: ${{ steps.resolve-version.outputs.version }}
+
+  build-macos:
+    strategy:
+      matrix:
+        os: [macos-14, macos-13]
+        include:
+          - os: macos-13
+            arch: x64
+          - os: macos-14
+            arch: arm64
+    needs: create-release
+    runs-on: ${{ matrix.os }}
+    name: "build-macos-${{ matrix.arch }}"
+    env:
+      RUST_LOG: trace
+    permissions:
+      contents: write # for uploading assets to release
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: install macos deps
+        run: |
+          brew install ninja
+
+      - name: versions
+        run: |
+          rustup show
+          cargo --version
+          cmake --version
+          echo "bash:" && bash --version
+          echo "ninja:" && ninja --version
+          echo "clang:" && clang --version
+
+      - name: Build LLVM
+        run: |
+          make install-llvm
+
+      - name: clean
+        # check removed files
+        run: |
+          cd target-llvm/gnu/target-final/bin/
+          rm diagtool llvm-libtool-darwin llvm-lipo llvm-pdbutil llvm-dwarfdump llvm-nm llvm-readobj llvm-cfi-verify \
+             sancov llvm-debuginfo-analyzer llvm-objdump llvm-profgen llvm-extract llvm-jitlink llvm-c-test llvm-gsymutil llvm-dwp \
+             dsymutil llvm-dwarfutil llvm-exegesis lli clang-rename bugpoint clang-extdef-mapping clang-refactor c-index-test \
+             llvm-reduce llvm-lto clang-linker-wrapper llc llvm-lto2
+
+      - name: package artifacts
+        run: |
+          tar -czf "${{ needs.create-release.outputs.version }}-macos-${{ matrix.arch }}.tar.gz" target-llvm/gnu/target-final
+
+      - name: upload archive to release
+        uses: softprops/action-gh-release@v2
+        with:
+          make_latest: "false"
+          tag_name: ${{ needs.create-release.outputs.version }}
+          files: |
+            ${{ needs.create-release.outputs.version }}-macos-${{ matrix.arch }}.tar.gz
+
+
+  build-linux-all:
+    needs: create-release
+    runs-on: parity-large
+    env:
+      RUST_LOG: trace
+    permissions:
+      contents: write # for uploading assets to release
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: install linux deps
+        run: |
+          sudo apt-get update && sudo apt-get install -y cmake ninja-build curl git libssl-dev pkg-config clang lld musl
+
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+          components: rust-src
+          target: wasm32-unknown-emscripten
+          rustflags: ""
+
+      - name: versions
+        run: |
+          rustup show
+          cargo --version
+          cmake --version
+          echo "bash:" && bash --version
+          echo "ninja:" && ninja --version
+          echo "clang:" && clang --version
+
+      - name: Build host LLVM
+        run: |
+          make install-llvm
+
+      - name: Build gnu LLVM
+        run: |
+          revive-llvm clone
+          revive-llvm build --llvm-projects lld --llvm-projects clang
+
+      - name: Build musl LLVM
+        run: |
+          revive-llvm --target-env musl build --llvm-projects lld --llvm-projects clang
+
+      - name: Build emscripten LLVM
+        run: |
+          revive-llvm --target-env emscripten clone
+          source emsdk/emsdk_env.sh
+          revive-llvm --target-env emscripten build --llvm-projects lld
+
+      - name: clean
+        # check removed files
+        run: |
+          for target in gnu emscripten musl; do
+            cd target-llvm/${target}/target-final/bin/
+            rm -rf diagtool llvm-libtool-darwin llvm-lipo llvm-pdbutil llvm-dwarfdump llvm-nm llvm-readobj llvm-cfi-verify \
+               sancov llvm-debuginfo-analyzer llvm-objdump llvm-profgen llvm-extract llvm-jitlink llvm-c-test llvm-gsymutil llvm-dwp \
+               dsymutil llvm-dwarfutil llvm-exegesis lli clang-rename bugpoint clang-extdef-mapping clang-refactor c-index-test \
+               llvm-reduce llvm-lto clang-linker-wrapper llc llvm-lto2 llvm-otool llvm-readelf
+            cd -
+          done
+
+      - name: package artifacts
+        run: |
+          tar -czf "${{ needs.create-release.outputs.version }}-x86_64-linux-gnu-linux.tar.gz" target-llvm/gnu/target-final
+          tar -czf "${{ needs.create-release.outputs.version }}-x86_64-linux-musl.tar.gz" target-llvm/musl/target-final
+          tar -czf "${{ needs.create-release.outputs.version }}-wasm32-unknown-emscripten.tar.gz" target-llvm/emscripten/target-final
+
+      - name: upload archive to release
+        uses: softprops/action-gh-release@v2
+        with:
+          make_latest: "false"
+          tag_name: ${{ needs.create-release.outputs.version }}
+          files: |
+            ${{ needs.create-release.outputs.version }}-x86_64-linux-gnu-linux.tar.gz
+            ${{ needs.create-release.outputs.version }}-x86_64-linux-musl.tar.gz
+            ${{ needs.create-release.outputs.version }}-wasm32-unknown-emscripten.tar.gz

.github/workflows/release.yml

@@ -3,7 +3,7 @@ run-name: Release ${{ github.ref_name }}
 on:
   push:
     branches:
-      - 'main'
+      - "main"
 
 concurrency:
   group: ${{ github.ref }}-${{ github.workflow }}
@@ -12,12 +12,9 @@ concurrency:
 env:
   #rust-musl-cross:x86_64-musl
   RUST_MUSL_CROSS_IMAGE: messense/rust-musl-cross@sha256:68b86bc7cb2867259e6b233415a665ff4469c28b57763e78c3bfea1c68091561
+  RUST_LOG: trace
 
 jobs:
-
-  #
-  #
-  #
   tag:
     runs-on: ubuntu-24.04
     permissions:
@@ -25,11 +22,12 @@ jobs:
     outputs:
       TAG: ${{ steps.versions.outputs.TAG }}
       PKG_VER: ${{ steps.versions.outputs.PKG_VER }}
+      RELEASE_NOTES: ${{ steps.versions.outputs.RELEASE_NOTES }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          fetch-tags: 'true'
+          fetch-tags: "true"
           fetch-depth: 0
 
       - name: Versions
@@ -41,7 +39,7 @@ jobs:
           echo "Package version $PKG_VER"
           #
           echo "PKG_VER=$PKG_VER" >> $GITHUB_OUTPUT
-          if [ $CURRENT_TAG == $PKG_VER  ];
+          if [[ $CURRENT_TAG == $PKG_VER  ]];
             then
               echo "Tag is up to date. Nothing to do.";
               export TAG=old;
@@ -51,28 +49,56 @@ jobs:
             fi
           echo "TAG=$TAG" >> $GITHUB_OUTPUT
           
-  #
-  #
-  #
-  build-linux-all:
+          # Generating release notes early, in order to avoid checkout at the last step
+          export RELEASE_NOTES="$(sed '/^## '${PKG_VER}'/,/^## v/!d' CHANGELOG.md | sed -e '1d' -e '$d')"
+          
+          echo "Release notes:"
+          echo "$RELEASE_NOTES"
+          
+          echo 'RELEASE_NOTES<<EOF' >> $GITHUB_OUTPUT
+          echo "$RELEASE_NOTES" >> $GITHUB_OUTPUT
+          echo 'EOF' >> $GITHUB_OUTPUT
+
+  build-macos:
+    strategy:
+      matrix:
+        os: [macos-14, macos-13]
+        include:
+          - os: macos-13
+            arch: x64
+          - os: macos-14
+            arch: arm64
     if: ${{ needs.tag.outputs.TAG == 'new' }}
-    runs-on: parity-large
+    runs-on: ${{ matrix.os }}
+    name: "build-macos-${{ matrix.arch }}"
     needs: [tag]
     steps:
       - uses: actions/checkout@v4
 
-      - name: install linux deps
-        run: |
-          sudo apt-get update && sudo apt-get install -y cmake ninja-build \
-          curl git libssl-dev pkg-config clang lld musl
-
-      - name: Install Rust stable toolchain
-        uses: actions-rs/toolchain@v1
+      - name: Get latest macos ${{ matrix.arch }} LLVM release artifact
+        id: get-llvm-artifact
+        uses: actions/github-script@v7
+        with:
+          result-encoding: string
+          script: |
+            const getReleaseArtifact = require("./.github/workflows/get-release-artifact.js");
+            return await getReleaseArtifact({ 
+              octokit: github, 
+              context, 
+              releasePrefix: "llvm-",
+              artifactSuffix: "-macos-${{ matrix.arch }}"
+            });
+
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
-          profile: minimal
           toolchain: stable
           components: rust-src
           target: wasm32-unknown-emscripten
+          rustflags: ""
+
+      - name: install macos deps
+        run: |
+          brew install ninja
 
       - name: versions
         run: |
@@ -83,57 +109,104 @@ jobs:
           echo "ninja:" && ninja --version
           echo "clang:" && clang --version
 
-      - name: build revive-llvm
-        run: make install-llvm-builder
-
-      # musl LLVM
-
-      - name: llvm-musl-cache restore
-        id: llvm-musl-cache
-        uses: actions/cache/restore@v4
-        with:
-          path: target-llvm/musl/target-final
-          key: llvm-linux-musl-${{ hashFiles('crates/solidity/**') }}
-
-      - name: Build musl LLVM
-        if: steps.llvm-musl-cache.outputs.cache-hit != 'true'
+      - name: download llvm
         run: |
-          revive-llvm --target-env musl clone
-          revive-llvm --target-env musl build --llvm-projects lld --llvm-projects clang
+          curl -L -o llvm.tar.gz "${{ steps.get-llvm-artifact.outputs.result }}"
+          tar -xvf llvm.tar.gz
 
-      - name: llvm-musl-cache save
-        if: steps.llvm-musl-cache.outputs.cache-hit != 'true'
-        uses: actions/cache/save@v4
-        with:
-          path: target-llvm/musl/target-final
-          key: llvm-linux-musl-${{ hashFiles('crates/solidity/**') }}
-
-      # emscripten LLVM
-
-      - name: llvm-emscripten-cache restore
-        id: llvm-emscripten-cache
-        uses: actions/cache/restore@v4
-        with:
-          path: |
-            target-llvm/emscripten/target-final
-            emsdk
-          key: llvm-linux-emscripten-${{ hashFiles('crates/solidity/**') }}
-
-      - name: Build emscripten LLVM
-        if: steps.llvm-emscripten-cache.outputs.cache-hit != 'true'
+      - name: build revive
         run: |
-          revive-llvm --target-env emscripten clone
-          source emsdk/emsdk_env.sh
-          revive-llvm --target-env emscripten build --llvm-projects lld
+          export LLVM_SYS_181_PREFIX=$PWD/target-llvm/gnu/target-final
+          make install-bin
+          cp ./target/release/resolc ./target/release/resolc-${{ matrix.arch }}
 
-      - name: llvm-emscripten-cache save
-        if: steps.llvm-emscripten-cache.outputs.cache-hit != 'true'
-        uses: actions/cache/save@v4
+      - name: check revive
+        run: |
+          mkdir solc
+          curl -sSLo solc/solc https://github.com/ethereum/solidity/releases/download/v0.8.28/solc-macos
+          chmod +x solc/solc
+          PATH=$PWD/solc:$PATH
+          result=$(./target/release/resolc-${{ matrix.arch }} --bin crates/integration/contracts/flipper.sol)
+          echo $result
+          if [[ $result == *'0x50564d'* ]]; then exit 0; else exit 1; fi
+
+      - uses: actions/upload-artifact@v4
         with:
+          name: "revive-macos-${{ matrix.arch }}"
           path: |
-            target-llvm/emscripten/target-final
-            emsdk
-          key: llvm-linux-emscripten-${{ hashFiles('crates/solidity/**') }}
+            ./target/release/resolc-${{ matrix.arch }}
+          retention-days: 1
+
+  macos-universal-binary:
+    runs-on: macos-14
+    needs: [build-macos]
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: revive-macos-*
+          path: revive-macos
+
+      - name: run lipo
+        run: |
+          lipo revive-macos/revive-macos-arm64/resolc-arm64 revive-macos/revive-macos-x64/resolc-x64 -create -output resolc-macos
+
+      - name: compress macos artifact
+        run: |
+          tar -czf resolc-macos.tar.gz ./resolc-macos
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: revive-macos
+          path: |
+            resolc-macos.tar.gz
+          retention-days: 1
+
+  build-linux-all:
+    if: ${{ needs.tag.outputs.TAG == 'new' }}
+    runs-on: parity-large
+    needs: [tag]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Get latest linux LLVM release artifact
+        id: get-llvm-musl-artifact
+        uses: actions/github-script@v7
+        with:
+          result-encoding: string
+          script: |
+            const getReleaseArtifact = require("./.github/workflows/get-release-artifact.js")
+            return await getReleaseArtifact({
+              octokit: github,
+              context,
+              releasePrefix: "llvm-",
+              artifactSuffix: "-x86_64-linux-musl"
+            })
+
+      - name: install linux deps
+        run: |
+          sudo apt-get update && sudo apt-get install -y cmake ninja-build \
+          curl git libssl-dev pkg-config clang lld musl
+
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+          components: rust-src
+          target: wasm32-unknown-emscripten
+          rustflags: ""
+
+      - name: versions
+        run: |
+          rustup show
+          cargo --version
+          cmake --version
+          echo "bash:" && bash --version
+          echo "ninja:" && ninja --version
+          echo "clang:" && clang --version
+
+      - name: download llvm
+        run: |
+          curl -L -o llvm.tar.gz "${{ steps.get-llvm-musl-artifact.outputs.result }}"
+          tar -xvf llvm.tar.gz
 
       # Build revive
 
@@ -145,7 +218,7 @@ jobs:
            apt update && apt upgrade -y && apt install -y pkg-config
            export LLVM_SYS_181_PREFIX=/opt/revive/target-llvm/musl/target-final
            make install-bin
-           cp /root/.cargo/bin/resolc /opt/revive/resolc-out/resolc
+           cp /root/.cargo/bin/resolc /opt/revive/resolc-out/resolc-static-linux
            "
 
       - name: check musl
@@ -154,17 +227,49 @@ jobs:
           curl -sSLo solc/solc https://github.com/ethereum/solidity/releases/download/v0.8.28/solc-static-linux
           chmod +x solc/solc
           PATH=$PWD/solc:$PATH
-          result=$(./resolc-out/resolc --bin crates/integration/contracts/flipper.sol)
+          result=$(./resolc-out/resolc-static-linux --bin crates/integration/contracts/flipper.sol)
           echo $result
           if [[ $result == *'0x50564d'* ]]; then exit 0; else exit 1; fi
 
+      - name: compress musl artifact
+        run: |
+          tar --strip-components 1 -czf resolc-static-linux.tar.gz ./resolc-out/resolc-static-linux
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: revive-linux
+          path: |
+            ./resolc-static-linux.tar.gz
+          retention-days: 1
+
       - name: Set Up Node.js
         uses: actions/setup-node@v3
         with:
           node-version: "20"
 
+      - name: Get latest emscripten LLVM release artifact
+        id: get-llvm-emscripten-artifact
+        uses: actions/github-script@v7
+        with:
+          result-encoding: string
+          script: |
+            const getReleaseArtifact = require("./.github/workflows/get-release-artifact.js")
+            return await getReleaseArtifact({
+              octokit: github,
+              context,
+              releasePrefix: "llvm-",
+              artifactSuffix: "-wasm32-unknown-emscripten"
+            })
+
+      - name: download llvm
+        run: |
+          curl -L -o llvm.tar.gz "${{ steps.get-llvm-emscripten-artifact.outputs.result }}"
+          tar -xvf llvm.tar.gz
+
       - name: build wasm
         run: |
+          make install-llvm-builder
+          revive-llvm --target-env emscripten clone
           export LLVM_SYS_181_PREFIX=$PWD/target-llvm/musl/target-final
           export REVIVE_LLVM_TARGET_PREFIX=$PWD/target-llvm/emscripten/target-final
           source emsdk/emsdk_env.sh
@@ -208,140 +313,54 @@ jobs:
           if(!bytecode.startsWith('50564d')) { process.exit(1); }
           "
 
+      - name: compress wasm artifact
+        run: |
+          tar --strip-components 3 -czf resolc-wasm.tar.gz \
+            ./target/wasm32-unknown-emscripten/release/resolc.js \
+            ./target/wasm32-unknown-emscripten/release/resolc.wasm \
+            ./target/wasm32-unknown-emscripten/release/resolc_web.js
+
       - uses: actions/upload-artifact@v4
         with:
           name: revive-wasm
           path: |
-            ./target/wasm32-unknown-emscripten/release/resolc.js
-            ./target/wasm32-unknown-emscripten/release/resolc.wasm
-            ./target/wasm32-unknown-emscripten/release/resolc_web.js
+            resolc-wasm.tar.gz
           retention-days: 1
 
-      - uses: actions/upload-artifact@v4
-        with:
-          name: revive-linux
-          path: |
-            ./resolc-out/resolc
-          retention-days: 1
-
-  #
-  #
-  #
   create-release:
-    needs: [tag, build-linux-all]
+    needs: [tag, build-linux-all, macos-universal-binary]
     runs-on: ubuntu-24.04
     permissions:
       contents: write
     outputs:
       upload_url: ${{ steps.create_release.outputs.result }}
     steps:
-      - uses: actions/checkout@v4
-
-      - name: Create/update tag
-        id: tag
-        uses: actions/github-script@v7
-        with:
-          result-encoding: string
-          script: |
-            await github.rest.git.createRef({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              ref: 'refs/tags/${{ needs.tag.outputs.PKG_VER }}',
-              sha: context.sha
-            })
-
-      - name: get relese notes
-        id: get-notes
-        run: |
-          {
-            echo 'releaseNotes<<EOF'
-            sed '/^## ${{ needs.tag.outputs.PKG_VER }}/,/^## v/!d' CHANGELOG.md | sed -e '1d' -e '$d'
-            echo EOF
-          } >> "$GITHUB_OUTPUT"
-
-
-      - name: Create release
-        id: create_release
-        env:
-         releaseNotes: ${{ steps.get-notes.outputs.releaseNotes }}
-         version: ${{ needs.tag.outputs.PKG_VER }}
-        uses: actions/github-script@v7
-        with:
-          result-encoding: string
-          script: |
-            let response = await github.rest.repos.createRelease({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                tag_name: process.env.version,
-                name: process.env.version,
-                body: process.env.releaseNotes,
-                draft: true,
-                prerelease: true
-            });
-            console.log(response);
-            return response.data.upload_url;
-
-      - name: Log
-        run: |
-          echo "tag result:   ${{ needs.tag.outputs.TAG }}"
-          echo "pkg version:  ${{ needs.tag.outputs.PKG_VER }}"
-
-  #
-  #
-  #
-  upload-assets:
-    runs-on: ubuntu-24.04
-    needs: [create-release]
-    steps:
-
-      - name: Download Artifact
+      - name: Download revive-wasm
         uses: actions/download-artifact@v4
         with:
           name: revive-wasm
-          path: resolc/
+          path: resolc-wasm/
 
-      - name: Download Artifact
+      - name: Download revive-linux
         uses: actions/download-artifact@v4
         with:
           name: revive-linux
-          path: resolc/
+          path: resolc-linux/
 
-      - name: upload resolc
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Download revive-macos
+        uses: actions/download-artifact@v4
         with:
-          upload_url: ${{ needs.create-release.outputs.upload_url }}
-          asset_path: ./resolc/resolc
-          asset_name: resolc-static-linux
-          asset_content_type: application/octet-stream
+          name: revive-macos
+          path: resolc-macos/
 
-      - name: upload resolc.js
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: create-release
+        uses: softprops/action-gh-release@v2
         with:
-          upload_url: ${{ needs.create-release.outputs.upload_url }}
-          asset_path: ./resolc/resolc.js
-          asset_name: resolc.js
-          asset_content_type: application/octet-stream
-
-      - name: upload resolc.wasm
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ needs.create-release.outputs.upload_url }}
-          asset_path: ./resolc/resolc.wasm
-          asset_name: resolc.wasm
-          asset_content_type: application/octet-stream
-
-      - name: upload resolc_web.js
-        uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ needs.create-release.outputs.upload_url }}
-          asset_path: ./resolc/resolc_web.js
-          asset_name: resolc_web.js
-          asset_content_type: application/octet-stream
+          body: ${{ needs.tag.outputs.RELEASE_NOTES }}
+          tag_name: ${{ needs.tag.outputs.PKG_VER }}
+          name: ${{ needs.tag.outputs.PKG_VER }}
+          draft: true
+          files: |
+            ./resolc-linux/resolc-static-linux.tar.gz
+            ./resolc-macos/resolc-macos.tar.gz
+            ./resolc-wasm/resolc-wasm.tar.gz

README.md

@@ -1,5 +1,5 @@
 ![CI](https://github.com/paritytech/revive/actions/workflows/rust.yml/badge.svg)
-[![Docs](https://img.shields.io/badge/Docs-contracts.polkadot.io-brightgreen.svg)](https://contracts.polkadot.io)
+[![Docs](https://img.shields.io/badge/Docs-contracts.polkadot.io-brightgreen.svg)](https://contracts.polkadot.io/revive_compiler/)
 
 # revive
 
@@ -14,10 +14,7 @@ This is experimental software in active development and not ready just yet for p
 Discussion around the development is hosted on the [Polkadot Forum](https://forum.polkadot.network/t/contracts-update-solidity-on-polkavm/6949#a-new-solidity-compiler-1).
 
 ## Installation
-
-`resolc` depends on the [solc](https://github.com/ethereum/solidity) binary installed on your system.
-
-Download and install the `resolc` frontend executable for your platform from our [releases](https://github.com/paritytech/revive/releases).
+Please consult [the documentation](https://contracts.polkadot.io/revive_compiler/installation) for installation instructions.
 
 ## Building from source
 
@@ -25,22 +22,46 @@ Building revive requires a [stable Rust installation](https://rustup.rs/) and a
 
 ### LLVM
 
-`revive` depends on a custom build of LLVM `v18.1.8` with the RISC-V _embedded_ target, including the `compiler-rt` builtins. 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.
+`revive` depends on a custom build of LLVM `v18.1.8` with the RISC-V _embedded_ target, including the `compiler-rt` builtins. You can either download a build from our releases (recommended for older hardware) or build it from source.
+
+<details>
+  <summary>Download from our LLVM releases</summary>
+
+Download the [latest LLVM build](https://github.com/paritytech/revive/releases?q=LLVM+binaries+release&expanded=true) from our releases.
+
+> **MacOS** users need to clear the `downloaded` attribute from all binaries after extracting the archive:
+> ```sh
+> xattr -rc </path/to/the/extracted/archive>/target-llvm/gnu/target-final/bin/*
+> ```
+
+After extracting the archive, point `$LLVM_SYS_181_PREFIX` to it:
+```sh
+export LLVM_SYS_181_PREFIX=</path/to/the/extracted/archive>/target-llvm/gnu/target-final
+```
+
+</details>
+
+<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:
 
-```bash
+```sh
 make install-llvm
 export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final
 ```
 
+</details>
+
 ### The `resolc` Solidity frontend
 
-To build the `resolc` Solidity frontend executable, make sure you have obtained a compatible LLVM build using [revive-llvm](crates/llvm-builder/README.md) and did export the `LLVM_SYS_181_PREFIX` environment variable pointing to it (see [above](#LLVM)).
+To build the `resolc` Solidity frontend executable, make sure you have obtained a compatible LLVM build and did export the `LLVM_SYS_181_PREFIX` environment variable pointing to it (see [above](#LLVM)).
 
 To install the `resolc` Solidity frontend executable:
 
-```bash
+```sh
 make install-bin
 resolc --version
 ```
@@ -49,7 +70,10 @@ resolc --version
 
 Cross-compile the `resolc.js` frontend executable to Wasm for running it in a Node.js or browser environment. The `REVIVE_LLVM_TARGET_PREFIX` environment variable is used to control the target environment LLVM dependency.
 
-```bash
+<details>
+  <summary>Instructions for cross-compilation to wasm32-unknown-emscripten</summary>
+
+```sh
 # Build the host LLVM dependency with PolkaVM target support
 make install-llvm
 export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final
@@ -65,21 +89,23 @@ make install-wasm
 make test-wasm
 ```
 
-### Development
+</details>
+
+## Development
 
 Please consult the [Makefile](Makefile) targets to learn how to run tests and benchmarks. 
 Ensure that your branch passes `make test` locally when submitting a pull request.
 
-## Design overview
+### Design overview
+See the [relevant section in our documentation](https://contracts.polkadot.io/revive_compiler/architecture) to learn more about how the compiler works. 
 
-`revive` uses [solc](https://github.com/ethereum/solidity/), the Ethereum Solidity compiler, as the [Solidity frontend](crates/solidity/src/lib.rs) to process smart contracts written in Solidity. The YUL IR code (or legacy EVM assembly as a fallback for older `solc` versions) emitted by `solc` is then translated to LLVM IR, targetting [Polkadots `revive` pallet](https://docs.rs/pallet-revive/latest/pallet_revive/trait.SyscallDoc.html).
-[Frontend](https://github.com/matter-labs/era-compiler-solidity) and [code generator](https://github.com/matter-labs/era-compiler-llvm-context) are based of ZKSync `zksolc`.
+[Frontend](https://github.com/matter-labs/era-compiler-solidity) and [code generator](https://github.com/matter-labs/era-compiler-llvm-context) are based of ZKSync `zksolc` (the project started as a fork of the era compiler).
 
-## Tests
+### Tests
 
 Before running the tests, ensure that Geth (Go Ethereum) is installed on your system. Follow the installation guide here: [Installing Geth](https://geth.ethereum.org/docs/getting-started/installing-geth).
 Once Geth is installed, you can run the tests using the following command:
 
-```bash
+```sh
 make test
 ```

RELEASE.md

@@ -8,3 +8,10 @@ To create a new pre-release:
 2. Wait for the `Release` workflow to finish. If the workflow fails after the `build-linux-all` step, check if a tag has been created and delete it before restarting or pushing updates. Note: It's more convenient to debug the release workflow in a fork (the fork has to be under the `paritytech` org to access `parity-large` runners).
 3. Check draft release on [Releases page](https://github.com/paritytech/revive/releases) and publish (should contain `resolc.js`, `resolc.wasm`, `resolc-web.js`, and `resolc-static-linux` release assets)
 4. Update the [contract-docs](https://github.com/paritytech/contract-docs/) accordingly
+
+# LLVM release
+
+To create a new LLVM release, run "Release LLVM" workflow. Use current LLVM version as parameter, e.g. `18.1.8`.
+Version suffix will be resolved automatically.  
+The workflows will create new GitHub release, and upload LLVM binaries.
+Next release of resolc will use newly created binaries.  

crates/llvm-builder/tests/build.rs

@@ -83,6 +83,7 @@ fn clone_build_and_clean_musl() -> anyhow::Result<()> {
 /// This test verifies that the LLVM repository can be successfully cloned and built in debug mode
 /// with tests and coverage enabled.
 #[test]
+#[cfg(target_os = "linux")]
 fn debug_build_with_tests_coverage() -> anyhow::Result<()> {
     let test_dir = common::TestDir::with_lockfile(None)?;
 
@@ -107,6 +108,7 @@ fn debug_build_with_tests_coverage() -> anyhow::Result<()> {
 
 /// This test verifies that the LLVM repository can be successfully built with address sanitizer.
 #[test]
+#[cfg(target_os = "linux")]
 fn build_with_sanitizers() -> anyhow::Result<()> {
     let test_dir = common::TestDir::with_lockfile(None)?;
 
@@ -129,7 +131,7 @@ fn build_with_sanitizers() -> anyhow::Result<()> {
 
 /// Tests the clone, build, and clean process of the LLVM repository for the emscripten target.
 #[test]
-#[cfg(any(target_os = "linux", target_os = "macos"))]
+#[cfg(target_os = "linux")]
 fn clone_build_and_clean_emscripten() -> anyhow::Result<()> {
     let test_dir = common::TestDir::with_lockfile(None)?;
     let command = Command::cargo_bin(common::REVIVE_LLVM)?;

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

@@ -212,22 +212,6 @@ impl<'ctx> Function<'ctx> {
         }
     }
 
-    /// Sets the exception handler attributes.
-    pub fn set_exception_handler_attributes(
-        llvm: &'ctx inkwell::context::Context,
-        declaration: Declaration<'ctx>,
-    ) {
-        Self::set_attributes(llvm, declaration, vec![Attribute::NoInline], false);
-    }
-
-    /// Sets the CXA-throw attributes.
-    pub fn set_cxa_throw_attributes(
-        llvm: &'ctx inkwell::context::Context,
-        declaration: Declaration<'ctx>,
-    ) {
-        Self::set_attributes(llvm, declaration, vec![Attribute::NoProfile], false);
-    }
-
     /// Sets the pure function attributes.
     pub fn set_pure_function_attributes(
         llvm: &'ctx inkwell::context::Context,

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

@@ -943,7 +943,7 @@ impl FunctionCall {
             Name::BlobHash => {
                 let _arguments = self.pop_arguments_llvm::<D, 1>(context)?;
                 anyhow::bail!(
-                    "{} The `BLOBHASH` instruction is not supported until zkVM v1.5.0",
+                    "{} The `BLOBHASH` instruction is not supported in revive",
                     location
                 );
             }
@@ -958,7 +958,7 @@ impl FunctionCall {
             }
             Name::BlobBaseFee => {
                 anyhow::bail!(
-                    "{} The `BLOBBASEFEE` instruction is not supported until zkVM v1.5.0",
+                    "{} The `BLOBBASEFEE` instruction is not supported in revive",
                     location
                 );
             }