apollo_committer_types: add patricia proofs request and response types

Author: ArielElp

crates/apollo_committer_types/Cargo.toml

@@ -7,6 +7,7 @@ license.workspace = true
 description = "Type definitions and interfaces for the Apollo committer component."
 
 [features]
+os_input = ["starknet_committer/os_input"]
 testing = ["mockall", "tokio"]
 
 [dependencies]
@@ -17,6 +18,7 @@ mockall = { workspace = true, optional = true }
 serde.workspace = true
 starknet_api.workspace = true
 starknet_committer.workspace = true
+starknet-types-core = { workspace = true, features = ["serde"] }
 strum = { workspace = true, features = ["derive"] }
 thiserror.workspace = true
 tokio = { workspace = true, optional = true }

crates/apollo_committer_types/src/committer_types.rs

@@ -1,7 +1,16 @@
+#[cfg(feature = "os_input")]
+use std::collections::HashMap;
+
 use serde::{Deserialize, Serialize};
 use starknet_api::block::BlockNumber;
+#[cfg(feature = "os_input")]
+use starknet_api::core::{ClassHash, ContractAddress};
 use starknet_api::core::{GlobalRoot, StateDiffCommitment};
 use starknet_api::state::ThinStateDiff;
+#[cfg(feature = "os_input")]
+use starknet_committer::block_committer::input::StarknetStorageKey;
+#[cfg(feature = "os_input")]
+use starknet_committer::patricia_merkle_tree::types::StarknetForestProofs;
 
 #[derive(Clone, Debug, Serialize, Deserialize)]
 pub struct CommitBlockRequest {
@@ -32,3 +41,21 @@ pub enum RevertBlockResponse {
     // Nothing to revert. A future block that has not been committed.
     Uncommitted,
 }
+
+/// Commit a block and return merged Patricia witness proofs for OS input (pre- and post-commit
+/// paths).
+#[cfg(feature = "os_input")]
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct ReadPathsAndCommitBlockRequest {
+    pub commit: CommitBlockRequest,
+    pub class_hashes: Vec<ClassHash>,
+    pub contract_addresses: Vec<ContractAddress>,
+    pub contract_storage_keys: HashMap<ContractAddress, Vec<StarknetStorageKey>>,
+}
+
+#[cfg(feature = "os_input")]
+#[derive(Clone, Serialize, Deserialize)]
+pub struct ReadPathsAndCommitBlockResponse {
+    pub global_root: GlobalRoot,
+    pub patricia_proofs: StarknetForestProofs,
+}

crates/apollo_committer_types/src/errors.rs

@@ -48,6 +48,20 @@ pub enum CommitterError {
         calculated_commitment: StateDiffCommitment,
         height: BlockNumber,
     },
+    /// Patricia trie path collection for OS input failed.
+    #[cfg(feature = "os_input")]
+    #[error("Failed Patricia paths collection at block {height}: {message}")]
+    PatriciaPathsCollectionFailed { height: BlockNumber, message: String },
+    /// Stored accessed-keys digest does not match the request (or no digest was stored).
+    #[cfg(feature = "os_input")]
+    #[error(
+        "Accessed-keys digest mismatch at block {height}: expected {expected:?}, stored {stored:?}"
+    )]
+    AccessedKeysDigestMismatch { height: BlockNumber, stored: Option<[u8; 32]>, expected: [u8; 32] },
+    /// Merged Patricia witness paths are missing for replay.
+    #[cfg(feature = "os_input")]
+    #[error("Missing Patricia paths for block {height}")]
+    MissingPatriciaPaths { height: BlockNumber },
 }
 
 pub type CommitterResult<T> = Result<T, CommitterError>;