chore: custom cargo config to reduce build time

.cargo/config.toml

@@ -0,0 +1,29 @@
+[alias]
+b = "build"
+c = "check"
+d = "doc"
+t = "test"
+r = "run"
+
+[build]
+incremental = true
+# might be helpful but we don't enforce sccache installation atm
+# https://github.com/mozilla/sccache
+# rustc-wrapper = "sccache"
+
+# For details checkout https://jondot.medium.com/8-steps-for-troubleshooting-your-rust-build-times-2ffc965fd13e
+[target.x86_64-unknown-linux-gnu]
+# clang has been listed as prerequisite in the doc
+linker    = "clang"
+rustflags = ["-Clink-arg=-fuse-ld=lld", "-Zshare-generics=y"]
+
+[target.x86_64-apple-darwin]
+# zld might help here
+# brew install michaeleisel/zld/zld
+# "-Clink-arg=-fuse-ld=zld"
+# For details checkout https://jondot.medium.com/8-steps-for-troubleshooting-your-rust-build-times-2ffc965fd13e
+rustflags = ["-Zshare-generics=y"]
+
+[net]
+git-fetch-with-cli = true
+retry              = 5

.github/workflows/coverage.yml

@@ -10,15 +10,13 @@ jobs:
     name: Cover
     runs-on: buildjet-8vcpu-ubuntu-2004
     timeout-minutes: 30
-    steps:
-      - name: Install Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
+    steps:      
       - name: Checkout Sources
         uses: actions/checkout@v3
         with:
           submodules: true
+      - name: Install Dependencies
+        run: sudo make install-deps
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         timeout-minutes: 5

.github/workflows/docs.yml

@@ -16,13 +16,11 @@ jobs:
   check-publish-docs:
     name: Publish
     runs-on: ubuntu-latest
-    steps:
-      - name: Apt Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
+    steps:      
       - name: Checkout Sources
         uses: actions/checkout@v3
+      - name: Apt Dependencies
+        run: sudo make install-deps
       - name: Link Checker (Repo)
         uses: lycheeverse/lychee-action@v1.5.1
         with:

.github/workflows/release.yml

@@ -17,17 +17,15 @@ jobs:
           - os: macos-latest
             file: forest-${{ github.ref_name }}-macos-amd64.zip
     steps:
+      - name: Checkout Sources
+        uses: actions/checkout@v3
       - name: Apt Dependencies
         if: startsWith(matrix.os, 'Ubuntu')
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
+        run: sudo make install-deps
       - name: Homebrew Utils
         if: startsWith(matrix.os, 'macOS')
         run: |
           brew install --verbose coreutils
-      - name: Checkout Sources
-        uses: actions/checkout@v3
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         timeout-minutes: 5

.github/workflows/rust.yml

@@ -23,12 +23,10 @@ jobs:
     env:
       RUSTFLAGS: "-D warnings"
     steps:
-      - name: Install Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
       - name: Checkout Sources
         uses: actions/checkout@v3
+      - name: Install Dependencies
+        run: sudo make install-deps
       - name: install nextest
         uses: taiki-e/install-action@nextest
       - name: Rust Cache
@@ -44,12 +42,10 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - name: Apt Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
       - name: Checkout Sources
         uses: actions/checkout@v3
+      - name: Apt Dependencies
+        run: sudo make install-deps
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         timeout-minutes: ${{ fromJSON(env.CACHE_TIMEOUT_MINUTES) }}
@@ -110,36 +106,47 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        #rv: [1.58.1, stable, beta, nightly]
-        rv: [nightly]
     steps:
-      - name: Install Dependencies
-        if: startsWith(matrix.os, 'Ubuntu')
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
       - name: Checkout Sources
         uses: actions/checkout@v3
+      - uses: visvirial/sccache-action@v1
+        if: startsWith(matrix.os, 'Ubuntu')
+        with:
+          arch: x86_64-unknown-linux-musl
+      - uses: visvirial/sccache-action@v1
+        if: startsWith(matrix.os, 'macOS')
+        with:
+          arch: x86_64-apple-darwin
+      - name: Install Linux Dependencies
+        if: startsWith(matrix.os, 'Ubuntu')
+        run: |
+          lscpu # the job may run on different CPUs, list cpu here for analysing build time
+          sudo make install-deps
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         timeout-minutes: ${{ fromJSON(env.CACHE_TIMEOUT_MINUTES) }}
         continue-on-error: true
+      - uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cache/sccache/
+          key: ${{ runner.os }}-sccache-${{ hashFiles('**/Cargo.lock') }}
       - name: Cargo Build
         run: cargo build --profile dev
+        env:
+          CC: "/tmp/sccache/sccache clang"
 
   calibnet-check:
     name: Calibnet sync check
     runs-on: buildjet-8vcpu-ubuntu-2004
     timeout-minutes: 30
     steps:
-      - name: Install Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y build-essential clang ocl-icd-opencl-dev
       - name: Checkout Sources
         uses: actions/checkout@v3
         with:
           submodules: true
+      - name: Install Dependencies
+        run: sudo make install-deps
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
         timeout-minutes: ${{ fromJSON(env.CACHE_TIMEOUT_MINUTES) }}

.gitignore

@@ -9,6 +9,7 @@ config*.toml
 *.orig
 criterion
 genesis.json
-/.cargo
+/.cargo/*
+!/.cargo/*.toml
 node/rpc-api/static/ast.ron
 documentation/book/**/*

Dockerfile

@@ -18,7 +18,7 @@
 FROM rust:1-buster AS build-env
 
 # Install dependencies
-RUN apt-get update && apt-get install --no-install-recommends -y build-essential clang ocl-icd-opencl-dev cmake
+RUN apt-get update && apt-get install --no-install-recommends -y build-essential clang lld ocl-icd-opencl-dev cmake
 
 WORKDIR /usr/src/forest
 COPY . .

Makefile

@@ -8,6 +8,10 @@ install-daemon:
 
 install: install-cli install-daemon
 
+install-deps:
+	apt-get update -y
+	apt-get install --no-install-recommends -y build-essential clang lld ocl-icd-opencl-dev cmake
+
 clean-all:
 	cargo clean
 
@@ -115,4 +119,4 @@ mdbook-build:
 rustdoc:
 	cargo doc --workspace --all-features --no-deps
 
-.PHONY: clean clean-all lint build release test test-all test-release license test-vectors run-vectors pull-serialization-tests install-cli install-daemon install docs run-serialization-vectors rustdoc
+.PHONY: clean clean-all lint build release test test-all test-release license test-vectors run-vectors pull-serialization-tests install-cli install-daemon install install-deps docs run-serialization-vectors rustdoc

README.md

@@ -63,6 +63,8 @@ rustup install nightly
 
 ```shell
 # Ubuntu
+sudo make install-deps
+# Or
 sudo apt install build-essential clang ocl-icd-opencl-dev libssl-dev
 
 # Archlinux