check.yml

name: Check

on:
  workflow_call:

env:
  TERM: xterm-256color
  RUST_BACKTRACE: short
  RUST_LIB_BACKTRACE: 1
  CARGO_TERM_COLOR: always
  CARGO_PROFILE_DEV_DEBUG: 0
  CARGO_PROFILE_TEST_DEBUG: 0
  CARGO_INCREMENTAL: 0
  NEXTEST_PROFILE: ci

jobs:
  unused-deps:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: cargo-bins/cargo-binstall@main
      - run: cargo binstall --no-confirm cargo-shear
      - run: cargo shear --exclude=gear-workspace-hack

  fmt:
    runs-on: ubuntu-latest
    steps:
      - name: "ACTIONS: Checkout"
        uses: actions/checkout@v4

      - name: "Install: Rust toolchain"
        uses: ./.github/actions/install-rust

      - name: "Check formatting: Gear"
        run: ./scripts/gear.sh format gear --check

  typos:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: recursive
      - name: typos-action
        uses: crate-ci/typos@master

  ethexe-contracts:
    runs-on: ubuntu-latest
    steps:
      - name: "ACTIONS: Checkout"
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: "Install: Rust toolchain"
        uses: ./.github/actions/install-rust

      - name: "Install: rustup stable"
        run: |
          rustup show
          rustup install stable

      - name: "Install rust-script"
        run: cargo install rust-script

      - name: "Install: Foundry"
        uses: foundry-rs/foundry-toolchain@v1
        with:
          version: v1.5.1

      - name: "Install: Node.js"
        uses: actions/setup-node@v4
        with:
          node-version: 22.x

      - name: "Show: Versioning"
        run: forge --version

      - name: "Check: ethexe contracts"
        run: |
          npm cache clean --force

          # version from ethexe/contracts/lib/openzeppelin-foundry-upgrades/src/internal/Versions.sol
          npx @openzeppelin/upgrades-core@^1.37.0

          forge fmt --check
          forge build --sizes
          forge test -vvv
        working-directory: ethexe/contracts

      - name: "Check: ABI files are updated"
        run: |
          cp ./ethexe/contracts/out/POAMiddleware.sol/POAMiddleware.json ./ethexe/ethereum/abi
          cp ./ethexe/contracts/out/Middleware.sol/Middleware.json ./ethexe/ethereum/abi
          cp ./ethexe/contracts/out/Mirror.sol/Mirror.json ./ethexe/ethereum/abi
          cp ./ethexe/contracts/out/MirrorWithInstrumentation.sol/MirrorWithInstrumentation.json ./ethexe/ethereum/abi
          cp ./ethexe/contracts/out/Router.sol/Router.json ./ethexe/ethereum/abi
          cp ./ethexe/contracts/out/RouterWithInstrumentation.sol/RouterWithInstrumentation.json ./ethexe/ethereum/abi
          cp ./ethexe/contracts/out/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy.json ./ethexe/ethereum/abi
          cp ./ethexe/contracts/out/WrappedVara.sol/WrappedVara.json ./ethexe/ethereum/abi

          git diff --exit-code ./ethexe/ethereum/abi/*.json || (echo "Some abi files have been modified. Please commit the changes." && exit 1)

      - name: "Check: Clones.sol is updated"
        run: |
          ../scripts/update-clones-sol.rs \
          --mirror-proxy out/MirrorProxy.sol/MirrorProxy.json \
          --clones src/libraries/Clones.sol
          forge fmt
          git diff --exit-code src/libraries/Clones.sol || (echo "Clones.sol has been modified. Please commit the changes." && exit 1)
        working-directory: ethexe/contracts

  clippy:
    strategy:
      fail-fast: false
      matrix:
        include:
          - name: macos-aarch64
            target: aarch64-apple-darwin
            runs-on: macos-latest
          - name: macos-x86_64
            target: x86_64-apple-darwin
            runs-on: macos-latest
          - name: linux-x86_64
            target: x86_64-unknown-linux-gnu
            runs-on: ubuntu-24.04-arm
          - name: linux-aarch64
            target: aarch64-unknown-linux-gnu
            runs-on: ubuntu-24.04-arm
          - name: windows-x86_64
            target: x86_64-pc-windows-msvc
            runs-on: ubuntu-24.04-arm
    runs-on: ${{ matrix.runs-on }}
    name: clippy (${{ matrix.name }})
    steps:
      - name: "ACTIONS: Checkout"
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: "Install: Setup linker"
        uses: ./.github/actions/setup-linker

      - name: "Install: Rust toolchain"
        uses: ./.github/actions/install-rust

      - name: "Install: Compilation environment"
        uses: ./.github/actions/setup-compilation-env
        with:
          target: "${{ matrix.target }}"

      - name: "ACTIONS: Setup caching"
        uses: ./.github/actions/rust-cache
        with:
          eu-access-key-id: "${{ secrets.GEAR_CI_S3_EU_ACCESS_KEY_ID }}"
          eu-secret-access-key: "${{ secrets.GEAR_CI_S3_EU_SECRET_ACCESS_KEY }}"
          key: "${{ matrix.name }}"

      - name: "Check clippy"
        run: ./scripts/gear.sh clippy gear --all-targets --all-features --locked

  workspace-hack:
    runs-on: ubuntu-latest
    steps:
      - name: "ACTIONS: Checkout"
        uses: actions/checkout@v4
        with:
          submodules: recursive

      - name: "Install: Setup linker"
        uses: ./.github/actions/setup-linker

      - name: "Install: Rust toolchain"
        uses: ./.github/actions/install-rust

      - name: "Install: Rust stable toolchain"
        uses: dtolnay/rust-toolchain@stable
        with:
          targets: wasm32v1-none

      - name: "Install: Compilation environment"
        uses: ./.github/actions/setup-compilation-env
        with:
          target: x86_64-unknown-linux-gnu

      - name: "Check if workspace hack Cargo.toml is up-to-date"
        run: |
          cargo hakari generate && ./scripts/hakari-post-process.sh
          git diff --exit-code utils/gear-workspace-hack/Cargo.toml || {
            echo "::error::workspace hack Cargo.toml is out of date. Run 'make workspace-hack' and commit the result."
            exit 1
          }

      - name: "Check if all workspace crates depend on workspace hack"
        uses: ./.github/actions/cargo-hakari
        with:
          args: manage-deps --dry-run

      - name: "ACTIONS: Setup caching"
        uses: ./.github/actions/rust-cache
        with:
          eu-access-key-id: "${{ secrets.GEAR_CI_S3_EU_ACCESS_KEY_ID }}"
          eu-secret-access-key: "${{ secrets.GEAR_CI_S3_EU_SECRET_ACCESS_KEY }}"
          # we want to test the hack that doesn't interfere with some Substrate features
          keep-workspace-hack: true

      - name: "Check clippy with workspace hack enabled"
        run: ./scripts/gear.sh clippy gear --all-targets --all-features --locked

      - name: "Check `try-runtime` and `benchmarks` features aren't required for node"
        run: __GEAR_WASM_BUILDER_NO_BUILD=1 SKIP_WASM_BUILD=1 cargo clippy -p gear-cli

  wasm:
    runs-on: ubuntu-latest
    steps:
      - name: "ACTIONS: Checkout"
        uses: actions/checkout@v4

      - name: "Install: Setup linker"
        uses: ./.github/actions/setup-linker

      - name: "Install: Rust toolchain"
        uses: ./.github/actions/install-rust

      - name: "Install: Rust stable toolchain"
        uses: dtolnay/rust-toolchain@stable
        with:
          targets: wasm32v1-none

      - name: "ACTIONS: Setup caching"
        uses: ./.github/actions/rust-cache
        with:
          eu-access-key-id: "${{ secrets.GEAR_CI_S3_EU_ACCESS_KEY_ID }}"
          eu-secret-access-key: "${{ secrets.GEAR_CI_S3_EU_SECRET_ACCESS_KEY }}"

      - name: "Check: Wasm-builder recommended toolchain matches rust-toolchain.toml"
        run: |
          TOOLCHAIN=$(grep 'channel' rust-toolchain.toml | cut -d '"' -f 2)
          CARGO_TOOLCHAIN="utils/wasm-optimizer/src/cargo_toolchain.rs"
          if ! grep -q "$TOOLCHAIN" $CARGO_TOOLCHAIN; then
            echo "Please update PINNED_NIGHTLY_TOOLCHAIN constant in $CARGO_TOOLCHAIN to match rust-toolchain.toml."
            exit 1
          fi

      - name: "Check clippy: Examples"
        run: ./scripts/gear.sh clippy examples --all-targets --locked

      - name: "Check clippy: no_std crates"
        run: ./scripts/gear.sh clippy no_std --locked

      - run: cargo +stable check -p gstd --target wasm32v1-none
      - run: cargo +stable check --manifest-path utils/wasm-builder/test-program/Cargo.toml
      - run: cargo +stable check --manifest-path utils/cargo-gbuild/test-program/Cargo.toml --workspace --target wasm32v1-none

  vara-runtime-imports:
    runs-on: ubuntu-latest
    needs: [clippy, wasm]
    steps:
      - name: "ACTIONS: Checkout"
        uses: actions/checkout@v4

      - name: "Install: Setup linker"
        uses: ./.github/actions/setup-linker

      - name: "Install: Rust toolchain"
        uses: ./.github/actions/install-rust

      - name: "Install: Compilation environment"
        uses: ./.github/actions/setup-compilation-env
        with:
          target: x86_64-unknown-linux-gnu

      - name: "ACTIONS: Setup caching"
        uses: ./.github/actions/rust-cache
        with:
          eu-access-key-id: "${{ secrets.GEAR_CI_S3_EU_ACCESS_KEY_ID }}"
          eu-secret-access-key: "${{ secrets.GEAR_CI_S3_EU_SECRET_ACCESS_KEY }}"
          key: "${{ matrix.name }}"

      - name: "Build: Vara runtime and wasm-proc"
        run: cargo build -p vara-runtime -p wasm-proc --release

      - name: "Check: Vara runtime imports"
        run: >-
          ./target/x86_64-unknown-linux-gnu/release/wasm-proc
          --check-runtime-imports
          target/x86_64-unknown-linux-gnu/release/wbuild/vara-runtime/vara_runtime.compact.wasm

  stack-height:
    strategy:
      fail-fast: false
      matrix:
        include:
          - name: macos-aarch64
            target: aarch64-apple-darwin
            runs-on: macos-latest
          - name: macos-x86_64
            target: x86_64-apple-darwin
            runs-on: macos-15-intel
          - name: linux-x86_64
            target: x86_64-unknown-linux-gnu
            runs-on: ubuntu-latest
          - name: linux-aarch64
            target: aarch64-unknown-linux-gnu
            runs-on: ubuntu-24.04-arm
          - name: windows-x86_64
            target: x86_64-pc-windows-msvc
            runs-on: windows-latest
    runs-on: ${{ matrix.runs-on }}
    needs: [clippy, wasm]
    name: stack-height (${{ matrix.name }})
    steps:
      - name: "ACTIONS: Checkout"
        uses: actions/checkout@v4

      - name: "Install: Setup linker"
        if: matrix.name != 'macos-x86_64'
        uses: ./.github/actions/setup-linker

      - name: "Install: Rust toolchain"
        if: matrix.name != 'macos-x86_64'
        uses: ./.github/actions/install-rust

      - name: "ACTIONS: Setup caching"
        if: matrix.name != 'macos-x86_64'
        uses: ./.github/actions/rust-cache
        with:
          eu-access-key-id: "${{ secrets.GEAR_CI_S3_EU_ACCESS_KEY_ID }}"
          eu-secret-access-key: "${{ secrets.GEAR_CI_S3_EU_SECRET_ACCESS_KEY }}"
          key: "${{ matrix.name }}"

      - name: "Run: Calculate stack height"
        if: matrix.name != 'macos-x86_64'
        run: cargo run -p calc-stack-height --release --locked

  gsdk-metadata:
    runs-on: ubuntu-latest
    needs: [clippy, wasm]
    steps:
      - name: "ACTIONS: Checkout"
        uses: actions/checkout@v4

      - name: "Install: Setup linker"
        uses: ./.github/actions/setup-linker

      - name: "Install: Rust toolchain"
        uses: ./.github/actions/install-rust

      - name: "Install: Compilation environment"
        uses: ./.github/actions/setup-compilation-env
        with:
          target: x86_64-unknown-linux-gnu

      - name: "ACTIONS: Setup caching"
        uses: ./.github/actions/rust-cache
        with:
          eu-access-key-id: "${{ secrets.GEAR_CI_S3_EU_ACCESS_KEY_ID }}"
          eu-secret-access-key: "${{ secrets.GEAR_CI_S3_EU_SECRET_ACCESS_KEY }}"

      - name: "Check: Changes in vara_runtime.scale file"
        run: |
          SCALE_FILE="gsdk/vara_runtime.scale"
          ./scripts/update-gsdk-metadata.sh
          if [[ $(git diff --stat $SCALE_FILE) != '' ]]; then
            echo "Changes found in the SCALE metadata ($SCALE_FILE). Please update it following the instructions in \`gsdk/HOW-TO-UPDATE.md\`."
            exit 1
          fi