BM-136: Rename "aggregation set" guest to "set builder" (github#21)

Fixes
https://linear.app/risczero/issue/BM-136/rename-aggregation-set-guest-to-set-builder

Co-authored-by: Victor Graf <[email protected]>

Author: nuke-web3

.gitignore

@@ -19,12 +19,12 @@ target/
 .idea
 
 # Ignore generated files
-contracts/src/AggregationSetImageID.sol
+contracts/src/SetBuilderImageID.sol
 contracts/src/AssessorImageID.sol
 contracts/src/EchoImageID.sol
 contracts/src/ResolveImageID.sol
 contracts/src/UtilImageID.sol
-contracts/test/AggregationSetElf.sol
+contracts/test/SetBuilderElf.sol
 contracts/test/AssessorElf.sol
 contracts/test/EchoElf.sol
 contracts/test/ResolveElf.sol

Cargo.lock

@@ -7,8 +7,8 @@ members = [
     "crates/bento-client",
     "crates/boundless-market",
     "crates/broker",
-    "crates/guest/aggregation-set",
     "crates/guest/assessor",
+    "crates/guest/set-builder",
     "crates/guest/util",
     "crates/taskdb",
     "crates/workflow",
@@ -20,7 +20,7 @@ aggregation-set = { path = "crates/aggregation-set" }
 assessor = { path = "crates/assessor" }
 bento-client = { path = "crates/bento-client" }
 boundless-market = { path = "crates/boundless-market" }
-guest-aggregation-set = { path = "crates/guest/aggregation-set" }
+guest-set-builder = { path = "crates/guest/set-builder" }
 guest-assessor = { path = "crates/guest/assessor" }
 guest-util = { path = "crates/guest/util" }
 taskdb = { path = "crates/taskdb" }

Cargo.toml

@@ -13,7 +13,7 @@ max_file_size = 50_000_000
 status_poll_ms = 1000
 bonsai_r0_zkvm_ver = "1.1.1"
 req_retry_count = 3
-agg_set_guest_path = "./target/riscv-guest/riscv32im-risc0-zkvm-elf/release/aggregation-set-guest"
+set_builder_guest_path = "./target/riscv-guest/riscv32im-risc0-zkvm-elf/release/set-builder-guest"
 assessor_set_guest_path = "./target/riscv-guest/riscv32im-risc0-zkvm-elf/release/assessor-guest"
 
 [batcher]

broker.toml

@@ -14,7 +14,7 @@ import {RiscZeroSetVerifier} from "../src/RiscZeroSetVerifier.sol";
 
 // For local testing:
 import {ImageID as AssesorImgId} from "../src/AssessorImageID.sol";
-import {ImageID as AggImgId} from "../src/AggregationSetImageID.sol";
+import {ImageID as SetBuidlerId} from "../src/SetBuilderImageID.sol";
 
 contract Deploy is Script, RiscZeroCheats {
     function run() external {
@@ -33,7 +33,7 @@ contract Deploy is Script, RiscZeroCheats {
             setBuilderGuestUrl = string.concat(
                 "file://",
                 cwd,
-                "/target/riscv-guest/riscv32im-risc0-zkvm-elf/release/aggregation-set-guest"
+                "/target/riscv-guest/riscv32im-risc0-zkvm-elf/release/set-builder-guest"
             );
             console2.log("Set builder URI", setBuilderGuestUrl);
             assessorGuestUrl = string.concat(
@@ -44,7 +44,7 @@ contract Deploy is Script, RiscZeroCheats {
             console2.log("Assessor URI", assessorGuestUrl);
         }
 
-        RiscZeroSetVerifier setVerifier = new RiscZeroSetVerifier(verifier, AggImgId.AGGREGATION_SET_GUEST_ID, setBuilderGuestUrl);
+        RiscZeroSetVerifier setVerifier = new RiscZeroSetVerifier(verifier, SetBuidlerId.SET_BUILDER_GUEST_ID, setBuilderGuestUrl);
         console2.log("Deployed SetVerifier to,", address(setVerifier));
 
         ProofMarket market = new ProofMarket(setVerifier, AssesorImgId.ASSESSOR_GUEST_ID, assessorGuestUrl);

contracts/scripts/Deploy.s.sol

@@ -26,6 +26,6 @@ interface IRiscZeroSetVerifier is IRiscZeroVerifier {
     /// Returns whether `root` has been submitted.
     function containsRoot(bytes32 root) external view returns (bool);
 
-    /// Returns the aggregator imageId and its url.
+    /// Returns the set builder imageId and its url.
     function imageInfo() external view returns (bytes32, string memory);
 }

contracts/src/IRiscZeroSetVerifier.sol

@@ -7,7 +7,7 @@ edition = "2021"
 alloy-primitives = { workspace = true }
 alloy-sol-types = { workspace = true }
 anyhow = { workspace = true }
-guest-aggregation-set = { workspace = true, optional = true }
+guest-set-builder = { workspace = true, optional = true }
 hex = { workspace = true }
 risc0-binfmt = { workspace = true }
 risc0-zkvm = { workspace = true }
@@ -19,4 +19,4 @@ tokio = { workspace = true, features = ["rt-multi-thread"] }
 
 [features]
 default = ["verify"]
-verify = ["dep:guest-aggregation-set"]
+verify = ["dep:guest-set-builder"]

crates/aggregation-set/Cargo.toml

@@ -132,7 +132,11 @@ where
             if root_receipt.claim()?.digest::<sha::Impl>()
                 != expected_root_claim.digest::<sha::Impl>()
             {
-                bail!("root receipt claim does not match expected aggregation set builder claim: {:#?} != {:#?}", root_receipt.claim()?, expected_root_claim);
+                bail!(
+                    "root receipt claim does not match expected set builder claim: {:#?} != {:#?}",
+                    root_receipt.claim()?,
+                    expected_root_claim
+                );
             }
             return Ok(());
         }
@@ -211,14 +215,15 @@ impl Digestible for SetInclusionReceiptVerifierParameters {
 #[cfg(feature = "verify")]
 mod verify {
     use super::SetInclusionReceiptVerifierParameters;
-    pub use guest_aggregation_set::{
-        AGGREGATION_SET_GUEST_ELF, AGGREGATION_SET_GUEST_ID, AGGREGATION_SET_GUEST_PATH,
+    pub use guest_set_builder::{
+        SET_BUILDER_GUEST_ELF, SET_BUILDER_GUEST_ID, SET_BUILDER_GUEST_PATH,
     };
 
     impl Default for SetInclusionReceiptVerifierParameters {
-        /// Default set of parameters used to verify a [SetInclusionReceipt][super::SetInclusionReceipt].
+        /// Default set of parameters used to verify a
+        /// [SetInclusionReceipt][super::SetInclusionReceipt].
         fn default() -> Self {
-            Self { image_id: AGGREGATION_SET_GUEST_ID.into() }
+            Self { image_id: SET_BUILDER_GUEST_ID.into() }
         }
     }
 }
@@ -236,7 +241,7 @@ pub struct RecursionVerifierParamters {
     pub control_root: Option<Digest>,
 }
 
-/// Input of the aggregation set guest.
+/// Input of the aggregation set builder guest.
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub enum GuestInput {
     /// Input is a leaf of the Merkle tree.
@@ -348,7 +353,7 @@ fn commutative_keccak256(a: &Digest, b: &Digest) -> Digest {
 }
 
 alloy_sol_types::sol! {
-    /// Journal output of aggregation set guest.
+    /// Journal output of aggregation set builder guest.
     #[sol(all_derives)]
     struct GuestOutput {
         /// Image ID used to verify the assumptions.

crates/aggregation-set/src/lib.rs

@@ -10,8 +10,8 @@ use risc0_zkvm::{sha::Digest, ReceiptClaim};
 use serde::{Deserialize, Serialize};
 
 /// Fulfillment contains a signed request, including offer and requirements,
-/// that the prover has completed, and the journal
-/// committed (via ReceiptClaim) into the Merkle tree of the aggregation set builder.
+/// that the prover has completed, and the journal committed
+/// into the Merkle tree of the aggregated set of proofs.
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct Fulfillment {
     pub request: ProvingRequest,
@@ -70,9 +70,7 @@ impl AssessorInput {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use aggregation_set::{
-        GuestInput, GuestOutput, AGGREGATION_SET_GUEST_ELF, AGGREGATION_SET_GUEST_ID,
-    };
+    use aggregation_set::{GuestInput, GuestOutput, SET_BUILDER_GUEST_ELF, SET_BUILDER_GUEST_ID};
     use alloy::{
         primitives::{aliases::U96, Address, B256},
         signers::local::PrivateKeySigner,
@@ -179,7 +177,7 @@ mod tests {
     fn singleton(assumption: Receipt) -> Receipt {
         let claim = assumption.claim().unwrap().value().unwrap();
         let guest_input = GuestInput::Singleton {
-            self_image_id: Digest::from(AGGREGATION_SET_GUEST_ID),
+            self_image_id: Digest::from(SET_BUILDER_GUEST_ID),
             claim: claim.clone(),
         };
         let env = ExecutorEnv::builder()
@@ -188,15 +186,15 @@ mod tests {
             .add_assumption(assumption)
             .build()
             .unwrap();
-        let session = default_executor().execute(env, AGGREGATION_SET_GUEST_ELF).unwrap();
+        let session = default_executor().execute(env, SET_BUILDER_GUEST_ELF).unwrap();
         assert_eq!(session.exit_code, ExitCode::Halted(0));
         let journal = &session.journal.bytes;
         let guest_output = GuestOutput::abi_decode(journal, true).unwrap();
-        assert_eq!(guest_output.image_id(), Digest::from(AGGREGATION_SET_GUEST_ID));
+        assert_eq!(guest_output.image_id(), Digest::from(SET_BUILDER_GUEST_ID));
         assert_eq!(guest_output.root(), claim.digest());
         Receipt::new(
             InnerReceipt::Fake(FakeReceipt::new(ReceiptClaim::ok(
-                AGGREGATION_SET_GUEST_ID,
+                SET_BUILDER_GUEST_ID,
                 MaybePruned::Pruned(journal.digest()),
             ))),
             journal.clone(),
@@ -210,7 +208,7 @@ mod tests {
         let guest_output_right = GuestOutput::abi_decode(&journal_right, true).unwrap();
 
         let guest_input = GuestInput::Join {
-            self_image_id: Digest::from(AGGREGATION_SET_GUEST_ID),
+            self_image_id: Digest::from(SET_BUILDER_GUEST_ID),
             left_set_root: guest_output_left.root(),
             right_set_root: guest_output_right.root(),
         };
@@ -221,15 +219,15 @@ mod tests {
             .add_assumption(right)
             .build()
             .unwrap();
-        let session = default_executor().execute(env, AGGREGATION_SET_GUEST_ELF).unwrap();
+        let session = default_executor().execute(env, SET_BUILDER_GUEST_ELF).unwrap();
         assert_eq!(session.exit_code, ExitCode::Halted(0));
         let journal = &session.journal.bytes;
 
         let guest_output = GuestOutput::abi_decode(journal, true).unwrap();
-        assert_eq!(guest_output.image_id(), Digest::from(AGGREGATION_SET_GUEST_ID));
+        assert_eq!(guest_output.image_id(), Digest::from(SET_BUILDER_GUEST_ID));
         Receipt::new(
             InnerReceipt::Fake(FakeReceipt::new(ReceiptClaim::ok(
-                AGGREGATION_SET_GUEST_ID,
+                SET_BUILDER_GUEST_ID,
                 MaybePruned::Pruned(journal.digest()),
             ))),
             journal.clone(),

crates/assessor/src/lib.rs

@@ -436,7 +436,7 @@ pub fn encode_seal(receipt: &risc0_zkvm::Receipt) -> anyhow::Result<Vec<u8>> {
 
 #[cfg(feature = "test-utils")]
 pub mod test_utils {
-    use aggregation_set::AGGREGATION_SET_GUEST_ID;
+    use aggregation_set::SET_BUILDER_GUEST_ID;
     use alloy::{
         network::{Ethereum, EthereumWallet},
         node_bindings::AnvilInstance,
@@ -519,7 +519,7 @@ pub mod test_utils {
             let set_verifier = SetVerifier::deploy(
                 &deployer_provider,
                 *verifier.address(),
-                <[u8; 32]>::from(Digest::from(AGGREGATION_SET_GUEST_ID)).into(),
+                <[u8; 32]>::from(Digest::from(SET_BUILDER_GUEST_ID)).into(),
                 String::new(),
             )
             .await