feat: add the ProtocolLib's masp Package as artifact

Author: lima-limon-inc

.github/workflows/workspace-publish.yml

@@ -34,3 +34,43 @@ jobs:
           release-branch: ${{ github.event.release.target_commitish }}
         env:
           CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}
+
+  # Upload the pre-compiled artifacts (miden-protocol.masp) on the
+  # GitHub release page.
+  # Used by midenup to speed up installs.
+  upload-artifacts:
+    name: upload pre-built miden-protocol library artifacts
+    if: ${{ github.repository_owner == '0xMiden' }}
+    permissions:
+      contents: write
+      id-token: write
+      attestations: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.release.tag_name }}
+          persist-credentials: false
+      - uses: ./.github/actions/cleanup-runner
+      - name: Install Rust
+        run: |
+          rustup update --no-self-update
+          rustc --version
+      - name: Build miden-core.masp
+        run: |
+          make packages
+      - name: Prepare artifact
+        run: |
+          mv target/packages/miden-protocol.masp miden-protocol.masp
+      - name: Attest miden-core.masp
+        uses: actions/attest-build-provenance@96278af6caaf10aea03fd8d33a09a777ca52d62f # v3.2.0
+        with:
+          subject-path: miden-core.masp
+      - name: Upload miden-core.masp
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          set -e
+          gh release upload ${RELEASE_TAG} miden-protocol.masp

Cargo.lock

@@ -146,6 +146,10 @@ build-no-std: ## Build without the standard library
 build-no-std-testing: ## Build without the standard library. Includes the `testing` feature
 	$(BUILD_GENERATED_FILES_IN_SRC) cargo build --no-default-features --target wasm32-unknown-unknown --workspace --exclude bench-transaction --features testing
 
+.PHONY: packages
+packages: ## Builds .masp packages and store them in target/packages
+	cargo +nightly -Zscript scripts/generate-package.rs
+
 # --- test vectors --------------------------------------------------------------------------------
 
 .PHONY: generate-solidity-test-vectors

Makefile

@@ -1,5 +1,8 @@
+use alloc::boxed::Box;
 use alloc::sync::Arc;
 
+use miden_mast_package::{Package, TargetType, Version};
+
 use crate::assembly::Library;
 use crate::assembly::mast::MastForest;
 use crate::utils::serde::Deserializable;
@@ -10,6 +13,8 @@ use crate::utils::sync::LazyLock;
 
 const PROTOCOL_LIB_BYTES: &[u8] = include_bytes!(concat!(env!("OUT_DIR"), "/assets/protocol.masl"));
 
+const PROTOCOL_PACKAGE_NAME: &str = "miden-protocol";
+
 // PROTOCOL LIBRARY
 // ================================================================================================
 
@@ -21,6 +26,23 @@ impl ProtocolLib {
     pub fn mast_forest(&self) -> &Arc<MastForest> {
         self.0.mast_forest()
     }
+
+    /// Wraps this library into a [`Package`] named `PROTOCOL_PACKAGE_NAME`,
+    /// versioned with the `miden-protocol` crate's version.
+    pub fn into_package(self) -> Box<Package> {
+        // The ProtocolLib's version is the same as the crate's as per the miden-protocol's
+        // Cargo.toml.
+        let version = Version::parse(env!("CARGO_PKG_VERSION"))
+            .expect("CARGO_PKG_VERSION must be valid semver");
+
+        Package::from_library(
+            PROTOCOL_PACKAGE_NAME.into(),
+            version,
+            TargetType::Library,
+            Arc::new(self.0),
+            [],
+        )
+    }
 }
 
 impl AsRef<Library> for ProtocolLib {

crates/miden-protocol/src/protocol.rs

@@ -21,8 +21,9 @@ testing = ["dep:rand", "miden-assembly/testing", "miden-protocol/testing"]
 
 [dependencies]
 # Miden dependencies
-miden-processor = { workspace = true }
-miden-protocol  = { workspace = true }
+miden-processor       = { workspace = true }
+miden-protocol        = { workspace = true }
+miden-mast-package    = { workspace = true }
 
 # External dependencies
 bon       = { workspace = true }

crates/miden-standards/Cargo.toml

@@ -1,5 +1,7 @@
+use alloc::boxed::Box;
 use alloc::sync::Arc;
 
+use miden_mast_package::{Package, TargetType, Version};
 use miden_protocol::assembly::Library;
 use miden_protocol::assembly::mast::MastForest;
 use miden_protocol::utils::serde::Deserializable;
@@ -11,6 +13,8 @@ use miden_protocol::utils::sync::LazyLock;
 const STANDARDS_LIB_BYTES: &[u8] =
     include_bytes!(concat!(env!("OUT_DIR"), "/assets/standards.masl"));
 
+const STANDARDS_LIB_NAME: &str = "standars";
+
 // MIDEN STANDARDS LIBRARY
 // ================================================================================================
 
@@ -22,6 +26,23 @@ impl StandardsLib {
     pub fn mast_forest(&self) -> &Arc<MastForest> {
         self.0.mast_forest()
     }
+
+    /// Wraps this library into a [`Package`] named `PROTOCOL_PACKAGE_NAME`,
+    /// versioned with the `miden-protocol` crate's version.
+    pub fn into_package(self) -> Box<Package> {
+        // The ProtocolLib's version is the same as the crate's as per the miden-standars's
+        // Cargo.toml.
+        let version = Version::parse(env!("CARGO_PKG_VERSION"))
+            .expect("CARGO_PKG_VERSION must be valid semver");
+
+        Package::from_library(
+            STANDARDS_LIB_NAME.into(),
+            version,
+            TargetType::Library,
+            Arc::new(self.0),
+            [],
+        )
+    }
 }
 
 impl AsRef<Library> for StandardsLib {

crates/miden-standards/src/standards_lib.rs

@@ -0,0 +1,24 @@
+#!/usr/bin/env cargo
+
+---
+[dependencies]
+miden-protocol = { path = "../crates/miden-protocol" }
+semver = "1"
+---
+
+use std::env;
+
+use miden_protocol::ProtocolLib;
+
+fn main() -> std::io::Result<()> {
+    // Must be run from the workspace root (CARGO_TARGET_DIR is not set for cargo scripts).
+    let workspace_root = env::current_dir().expect("could not read PWD");
+    let packages_dir = workspace_root.join("target").join("packages");
+    std::fs::create_dir_all(&packages_dir)?;
+
+    let package = ProtocolLib::default().into_package();
+    package.write_masp_file(&packages_dir)?;
+
+    println!("wrote {}.masp to {}", package.name, packages_dir.display());
+    Ok(())
+}