chore: merge v0.5.0 release

0xPolygonMiden · Aug 27, 2024 · 0ee8657 · 0ee8657
2 parents 13724e9 + 1af2cfa
commit 0ee8657
Show file tree

Hide file tree

Showing 155 changed files with 8,186 additions and 5,775 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -2,6 +2,11 @@
 
 name: build
 
+# Limits workflow concurrency to only the latest commit in the PR.
+concurrency:
+  group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"
+  cancel-in-progress: true
+
 on:
   push:
     branches: [main, next]
@@ -10,30 +15,32 @@ on:
 
 jobs:
   async:
-    name: Build using `async` feature
+    name: build using async feature
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        toolchain: [stable, nightly]
     steps:
       - uses: actions/checkout@main
-      - name: Build using `async` feature
+      - uses: Swatinem/rust-cache@v2
+        with:
+          # Only update the cache on push onto the next branch. This strikes a nice balance between
+          # cache hits and cache evictions (github has a 10GB cache limit). 
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
+      - name: build
         run: |
-          rustup update --no-self-update ${{ matrix.toolchain }}
+          rustup update --no-self-update
           make build-async
 
   no-std:
-    name: Build for no-std
+    name: build for no-std
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        toolchain: [stable, nightly]
     steps:
       - uses: actions/checkout@main
-      - name: Build for no-std
+      - uses: Swatinem/rust-cache@v2
+        with:
+          # Only update the cache on push onto the next branch. This strikes a nice balance between
+          # cache hits and cache evictions (github has a 10GB cache limit). 
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
+      - name: build
         run: |
-          rustup update --no-self-update ${{ matrix.toolchain }}
+          rustup update --no-self-update
           rustup target add wasm32-unknown-unknown
           make build-no-std
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -0,0 +1,23 @@
+# Runs changelog related jobs.
+# CI job heavily inspired by: https://github.com/tarides/changelog-check-action
+
+name: changelog
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, labeled, unlabeled]
+
+jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@main
+        with:
+          fetch-depth: 0
+      - name: Check for changes in changelog
+        env:
+          BASE_REF: ${{ github.event.pull_request.base.ref }}
+          NO_CHANGELOG_LABEL: ${{ contains(github.event.pull_request.labels.*.name, 'no changelog') }}
+        run: ./scripts/check-changelog.sh "${{ inputs.changelog }}"
+        shell: bash
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -2,52 +2,72 @@
 
 name: lint
 
+# Limits workflow concurrency to only the latest commit in the PR.
+concurrency:
+  group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"
+  cancel-in-progress: true
+
 on:
   push:
     branches: [main, next]
   pull_request:
     types: [opened, reopened, synchronize]
 
 jobs:
-  version:
-    name: check rust version consistency
+  clippy:
+    name: clippy
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@main
+      - uses: Swatinem/rust-cache@v2
         with:
-          profile: minimal
-          override: true
-      - name: check rust versions
-        run: ./scripts/check-rust-version.sh
+          # Only update the cache on push onto the next branch. This strikes a nice balance between
+          # cache hits and cache evictions (github has a 10GB cache limit). 
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
+      - name: Clippy
+        run: |
+          rustup update --no-self-update
+          rustup component add clippy
+          make clippy
 
   rustfmt:
-    name: rustfmt check nightly on ubuntu-latest
+    name: rustfmt
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@main
+      - uses: Swatinem/rust-cache@v2
+        with:
+          # Only update the cache on push onto the next branch. This strikes a nice balance between
+          # cache hits and cache evictions (github has a 10GB cache limit). 
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
       - name: Rustfmt
         run: |
           rustup update --no-self-update nightly
           rustup +nightly component add rustfmt
           make format-check
 
-  clippy:
-    name: clippy nightly on ubuntu-latest
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@main
-      - name: Clippy
-        run: |
-          rustup update --no-self-update nightly
-          rustup +nightly component add clippy
-          make clippy
-
   doc:
-    name: doc stable on ubuntu-latest
+    name: doc
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@main
+      - uses: Swatinem/rust-cache@v2
+        with:
+          # Only update the cache on push onto the next branch. This strikes a nice balance between
+          # cache hits and cache evictions (github has a 10GB cache limit). 
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
       - name: Build docs
         run: |
           rustup update --no-self-update
           make doc
+
+  version:
+    name: check rust version consistency
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@main
+        with:
+          profile: minimal
+          override: true
+      - name: check rust versions
+        run: ./scripts/check-rust-version.sh
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -2,6 +2,11 @@
 
 name: test
 
+# Limits workflow concurrency to only the latest commit in the PR.
+concurrency:
+  group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"
+  cancel-in-progress: true
+
 on:
   push:
     branches: [main, next]
@@ -10,19 +15,19 @@ on:
 
 jobs:
   test:
-    name: test ${{matrix.toolchain}} on ${{matrix.os}} with ${{matrix.args}}
-    runs-on: ${{matrix.os}}-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        toolchain: [stable, nightly]
-        os: [ubuntu]
-        args: [default, prove]
-    timeout-minutes: 30
+    name: test
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@main
       - uses: taiki-e/install-action@nextest 
-      - name: Perform tests
-        run: |
-          rustup update --no-self-update ${{matrix.toolchain}} 
-          make test-${{matrix.args}}
+      - uses: Swatinem/rust-cache@v2
+        with:
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
+      - name: Install rust
+        run: rustup update --no-self-update 
+      - name: Build tests
+        run: make test-build
+      - name: test-default
+        run: make test-default
+      - name: test-prove
+        run: make test-prove
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,33 @@
 # Changelog
 
+## 0.5.0 (2024-08-27)
+
+### Features
+
+- [BREAKING] Increase of nonce does not require changes in account state any more (#796).
+- Changed `AccountCode` procedures from merkle tree to sequential hash + added storage_offset support (#763).
+- Implemented merging of account deltas (#797).
+- Implemented `create_note` and `move_asset_into_note` basic wallet procedures (#808).
+- Made `miden_lib::notes::build_swap_tag()` function public (#817).
+- [BREAKING] Changed the `NoteFile::NoteDetails` type to struct and added a `after_block_num` field (#823).
+
+### Changes
+
+- Renamed "consumed" and "created" notes into "input" and "output" respectively (#791).
+- [BREAKING] Renamed `NoteType::OffChain` into `NoteType::Private`.
+- [BREAKING] Renamed public accessors of the `Block` struct to match the updated fields (#791).
+- [BREAKING] Changed the `TransactionArgs` to use `AdviceInputs` (#793).
+- Setters in `memory` module don't drop the setting `Word` anymore (#795).
+- Added `CHANGELOG.md` warning message on CI (#799).
+- Added high-level methods for `MockChain` and related structures (#807).
+- [BREAKING] Renamed `NoteExecutionHint` to `NoteExecutionMode` and added new `NoteExecutionHint` to `NoteMetadata` (#812, #816).
+- [BREAKING] Changed the interface of the `miden::tx::add_asset_to_note` (#808).
+- [BREAKING] Refactored and simplified `NoteOrigin` and `NoteInclusionProof` structs (#810, #814).
+- [BREAKING] Refactored account storage and vault deltas (#822).
+- Added serialization and equality comparison for `TransactionScript` (#824).
+- [BREAKING] Migrated to Miden VM v0.10 (#826).
+- Added conversions for `NoteExecutionHint` (#827).
+
 ## 0.4.0 (2024-07-03)
 
 ### Features
@@ -34,9 +62,9 @@
 
 ## 0.3.1 (2024-06-12)
 
-* Replaced `cargo-make` with just `make` for running tasks (#696).
-* Made `DataStore` conditionally async using `winter-maybe-async` (#725)
-* Fixed `StorageMap`s implementation and included into apply_delta (#745)
+- Replaced `cargo-make` with just `make` for running tasks (#696).
+- Made `DataStore` conditionally async using `winter-maybe-async` (#725)
+- Fixed `StorageMap`s implementation and included into apply_delta (#745)
 
 ## 0.3.0 (2024-05-14)
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -106,7 +106,7 @@ To make sure all commits adhere to our programming standards we use [pre-commit]
 2. Commit messages and code style follow conventions.
 3. Tests added for new functionality.
 4. Documentation/comments updated for all changes according to our documentation convention.
-5. Rustfmt, Clippy and Rustdoc linting passed (Will be ran automatically by pre-commit).
+5. Rustfmt, Clippy and Rustdoc linting passed (Will be run automatically by pre-commit).
 6. New branch rebased from `next`.
 
 &nbsp;