[pull] main from dfinity:main

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @dfinity/sdk

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+# Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. 
+
+Fixes # (issue)
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
+
+# Checklist:
+
+- [ ] The title of this PR complies with [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+- [ ] I have edited the CHANGELOG accordingly.
+- [ ] I have made corresponding changes to the documentation.

.github/workflows/ci.yml

@@ -0,0 +1,158 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  schedule:
+    - cron: "0 4 * * 0,3" # 4 a.m. UTC every Sun and Wed, keep actions-cache available
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: cargo build
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-build-${{ hashFiles('Cargo.lock', 'rust-toolchain.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+      - name: Run builds
+        run: |
+          cargo build --workspace --exclude ic-cdk-e2e-tests --exclude candid-extractor --target wasm32-unknown-unknown
+          cargo build --workspace --exclude ic-cdk-e2e-tests --exclude candid-extractor --target wasm32-unknown-unknown --release
+          cargo build --example=work
+
+  test:
+    name: cargo test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-24.04, macos-13-large]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-test-${{ hashFiles('Cargo.lock', 'rust-toolchain.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - name: Download pocket-ic
+        run: |
+          bash scripts/download_pocket_ic.sh
+      - name: Run tests
+        run:
+          | # https://github.com/rust-lang/cargo/issues/6669 we have to run ALL tests with two commands
+          cargo test --all-targets
+          cargo test --doc
+
+  fmt:
+    name: cargo fmt
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-fmt-${{ hashFiles('Cargo.lock', 'rust-toolchain.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-fmt-
+            ${{ runner.os }}-
+      - name: Check formatting
+        run: |
+          cargo fmt --all -- --check
+
+  clippy:
+    name: cargo clippy
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-clippy-${{ hashFiles('Cargo.lock', 'rust-toolchain.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-clippy-
+            ${{ runner.os }}-
+      - name: Run clippy
+        run: |
+          cargo clippy --tests --benches -- -D warnings
+
+  doc:
+    name: cargo doc
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-doc-${{ hashFiles('Cargo.lock', 'rust-toolchain.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-doc-
+            ${{ runner.os }}-
+      - name: Run doc
+        run: |
+          RUSTDOCFLAGS="-D warnings" cargo doc
+
+  aggregate:
+    name: ci:required
+    if: ${{ always() }}
+    needs: [build, test, fmt, clippy, doc]
+    runs-on: ubuntu-24.04
+    steps:
+      - name: check build result
+        if: ${{ needs.build.result != 'success' }}
+        run: exit 1
+      - name: check test result
+        if: ${{ needs.test.result != 'success' }}
+        run: exit 1
+      - name: check fmt result
+        if: ${{ needs.fmt.result != 'success' }}
+        run: exit 1
+      - name: check clippy result
+        if: ${{ needs.clippy.result != 'success' }}
+        run: exit 1

.github/workflows/conventional-commits.yml

@@ -1,4 +1,5 @@
 name: Check PR title
+
 on:
   pull_request_target:
     types:
@@ -7,15 +8,30 @@ on:
       - edited
       - synchronize
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   check:
-    runs-on: ubuntu-latest
+    name: conventional-pr-title:required
+    runs-on: ubuntu-24.04
     steps:
-      - uses: dfinity/[email protected]
-        with:
-          success-state: Title follows the specification.
-          failure-state: Title does not follow the specification.
-          context-name: conventional-pr-title
-          preset: conventional-changelog-angular@latest
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Conventional commit patterns:
+      #   verb: description
+      #   verb!: description of breaking change
+      #   verb(scope): Description of change to $scope
+      #   verb(scope)!: Description of breaking change to $scope
+      # verb: feat, fix, ...
+      # scope: refers to the part of code being changed.  E.g. " (accounts)" or " (accounts,canisters)"
+      # !: Indicates that the PR contains a breaking change.
+      - env:
+          TITLE: ${{ github.event.pull_request.title }}
+        run: |
+          echo "PR title: $TITLE"
+          if [[ "$TITLE" =~ ^(feat|fix|chore|build|ci|docs|style|refactor|perf|test)(\([-a-zA-Z0-9,]+\))?\!?\: ]]; then
+              echo pass
+          else
+              echo "PR title does not match conventions"
+              exit 1
+          fi

.github/workflows/examples.yml

@@ -1,67 +1,132 @@
-
 name: Examples
 
 on:
   push:
     branches:
       - main
   pull_request:
+  schedule:
+    - cron: "0 4 * * 0,3" # 4 a.m. UTC every Sun and Wed, keep actions-cache available
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  ic-wasm-version: 0.4.0
 
 jobs:
+  build-candid-extractor:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-candid-extractor-${{ hashFiles('Cargo.lock', 'rust-toolchain.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-candid-extractor-
+            ${{ runner.os }}-
+
+      - name: Build candid-extractor
+        run: cargo build -p candid-extractor --release
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: candid-extractor
+          path: target/release/candid-extractor
+
   test:
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-24.04
+    needs: build-candid-extractor
     strategy:
+      fail-fast: false
       matrix:
-        build: [ linux-stable ]
-        include:
-          - build: linux-stable
-            os: ubuntu-latest
-            rust: 1.52.1
-            dfx: 0.8.1
+        project-name:
+          [asset_storage, chess, counter, management_canister, print, profile]
 
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
 
-      - uses: actions/cache@v2
+      - name: Cache
+        uses: actions/cache@v4
         with:
           path: |
-            ~/.cargo/registry
-            ~/.cargo/git
-            **/target
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}-1
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            examples/${{ matrix.project-name }}/target/
+          key: ${{ runner.os }}-${{ matrix.project-name }}-${{ hashFiles('Cargo.lock', 'rust-toolchain.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.project-name }}-
+            ${{ runner.os }}-
 
-      - name: Install Rust
+      - name: Install ic-wasm
+        # might already in cache
         run: |
-          rustup update ${{ matrix.rust }} --no-self-update
-          rustup default ${{ matrix.rust }}
-          rustup target add wasm32-unknown-unknown
+          wget https://github.com/dfinity/ic-wasm/releases/download/${{env.ic-wasm-version }}/ic-wasm-linux64
+          chmod 755 ic-wasm-linux64
+          mv ic-wasm-linux64 /usr/local/bin/ic-wasm
 
-      - name: Install DFX
+      - name: Download candid-extractor
+        uses: actions/download-artifact@v4
+        with:
+          name: candid-extractor
+
+      - name: Install candid-extractor
         run: |
-          export DFX_VERSION=${{ matrix.dfx }}
-          echo Install DFX Version: $DFX_VERSION
-          yes | sh -ci "$(curl -fsSL https://sdk.dfinity.org/install.sh)"
+          chmod 755 candid-extractor
+          mv candid-extractor /usr/local/bin/candid-extractor
 
-      - name: Setup BATS
-        uses: mig4/[email protected]
-        with:
-          bats-version: 1.2.1
+      - name: Install DFX
+        uses: dfinity/setup-dfx@main
+
+      - name: Install bitcoin
+        if: ${{ matrix.project-name == 'management_canister' }}
+        run: |
+          CWD=$(pwd)
+          cd "$(mktemp -d)"
+          BITCOIN_CORE_VERSION=22.0
+          BITCOIN_CORE_FILENAME="bitcoin-$BITCOIN_CORE_VERSION-x86_64-linux-gnu.tar.gz"
+          BITCOIN_CORE_TARBALL_SHA="59ebd25dd82a51638b7a6bb914586201e67db67b919b2a1ff08925a7936d1b16"
+          wget -nv "https://bitcoin.org/bin/bitcoin-core-$BITCOIN_CORE_VERSION/$BITCOIN_CORE_FILENAME"
+          echo "$BITCOIN_CORE_TARBALL_SHA  $BITCOIN_CORE_FILENAME" | shasum -c
+          tar xzf "$BITCOIN_CORE_FILENAME"
+          cd "bitcoin-$BITCOIN_CORE_VERSION/bin"
+          sudo install -m 0755 -o root -g root -t /usr/local/bin *
+          cd "$CWD"
 
       - name: Run Tests
         shell: bash
         run: |
-          echo CWD: $(pwd)
-          export PATH=$PATH:$HOME/bin
-          bats -r examples
+          ./examples/bats/bats-core/bin/bats -r examples/${{ matrix.project-name }}
         env:
           RUST_BACKTRACE: 1
 
-      - name: Purge for OSX
-        if: matrix.os == 'macos-latest'
+      - name: cargo fmt # no clippy because build.rs using ic-cdk-bindgen would fail
         run: |
-          # There is a bug with BSD tar on macOS where the first 8MB of the file are
-          # sometimes all NUL bytes. See https://github.com/actions/cache/issues/403
-          # and https://github.com/rust-lang/cargo/issues/8603 for some more
-          # information. An alternative solution here is to install GNU tar, but
-          # flushing the disk cache seems to work, too.
-          sudo /usr/sbin/purge
+          pushd examples/${{ matrix.project-name }}
+          cargo fmt --check
+          popd
+
+  aggregate:
+    name: examples:required
+    if: ${{ always() }}
+    needs: test
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Check step result directly
+        if: ${{ needs.test.result != 'success' }}
+        run: exit 1