cargo doc

cli/src/commands/run_datalake.rs

@@ -17,7 +17,7 @@ pub struct RunDatalakeArgs {
     pub aggregate_fn_id: AggregationFunction,
     /// Optional context for applying conditions on the aggregate function "count".
     /// Format: "{operator}.{value}" (e.g., "eq.100" for equality, "gt.100" for greater-than).
-    /// Supported operators are in the [`Operator`] enum.
+    /// Supported operators are in the Operator enum.
     pub aggregate_fn_ctx: Option<FunctionContext>,
 
     #[command(subcommand)]

hdp/src/lib.rs

@@ -1,3 +1,8 @@
+//! The Data Processor CLI serves as an essential tool for developers working with Cairo programs and zkVM environments.
+//! Its primary function is to translate human-readable requests into a format compatible with Cairo programs,
+//! enabling commands to be executed over the Cairo VM and generating executable outputs.
+//! This transformation is a crucial preprocessing step that prepares data for off-chain computations in zkVM environments.
+
 pub mod cairo_runner;
 pub mod constant;
 pub mod hdp_run;

hdp/src/primitives/block/header.rs

@@ -131,7 +131,6 @@ impl Header {
     }
 
     /// Heavy function that will calculate hash of data and will *not* save the change to metadata.
-    /// Use [`Header::seal`], [`SealedHeader`] and unlock if you need hash to be persistent.
     pub fn hash_slow(&self) -> B256 {
         keccak256(alloy_rlp::encode(self))
     }
@@ -343,7 +342,7 @@ impl Header {
 }
 
 /// Block header returned from RPC
-/// https://ethereum.org/en/developers/docs/apis/json-rpc#eth_getblockbynumber
+/// <https://ethereum.org/en/developers/docs/apis/json-rpc#eth_getblockbynumber>
 #[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(rename_all = "camelCase")]
 pub struct BlockHeaderFromRpc {

hdp/src/primitives/solidity_types/datalake_compute/datalake/transactions_in_block.rs

@@ -49,13 +49,13 @@ impl DatalakeCodecs for TransactionsInBlockDatalake {
         }
     }
 
-    /// Get the commitment hash of the [`TransactionsDatalake`]
+    /// Get the commitment hash of the [`TransactionsInBlockDatalake`]
     fn commit(&self) -> B256 {
         let encoded_datalake = self.encode().expect("Encoding failed");
         keccak256(encoded_datalake)
     }
 
-    /// Decode the encoded transactions datalake hex string into a [`TransactionsDatalake`]
+    /// Decode the encoded transactions datalake hex string into a [`TransactionsInBlockDatalake`]
     fn decode(encoded: &[u8]) -> Result<Self> {
         let abi_type: DynSolType =
             "(uint256,uint256, uint256, uint256, uint256, uint256, uint256, bytes)".parse()?;

hdp/src/primitives/solidity_types/traits.rs

@@ -22,7 +22,7 @@ pub trait Codecs {
         Self: Sized;
 }
 
-/// Codecs for [`DatalakeCompute`]
+/// Codecs for datalake task
 pub trait DatalakeComputeCodecs {
     fn decode(encoded_datalake: &[u8], encoded_compute: &[u8]) -> Result<Self>
     where
@@ -31,7 +31,7 @@ pub trait DatalakeComputeCodecs {
     fn commit(&self) -> B256;
 }
 
-/// Codecs for [`BatchedDatalakeCompute`]
+/// Codecs for vector of datalake task
 pub trait BatchedDatalakeComputeCodecs {
     fn decode(encoded_datalake: &[u8], encoded_compute: &[u8]) -> Result<Self>
     where

hdp/src/primitives/task/datalake/datalake_type.rs

@@ -2,10 +2,10 @@ use anyhow::{bail, Result};
 use serde::{Deserialize, Serialize};
 use std::str::FromStr;
 
-/// Identifier for a [`BlockSampledDatalake`] type.
+/// Identifier for a BlockSampledDatalake
 pub const BLOCK_SAMPLED_DATALAKE_TYPE_ID: u8 = 0;
 
-/// Identifier for an [`TransactionsDatalake`] type.
+/// Identifier for a TransactionsDatalake
 pub const TRANSACTIONS_IN_BLOCK_DATALAKE_TYPE_ID: u8 = 1;
 
 #[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq)]

hdp/src/provider/error.rs

@@ -18,11 +18,11 @@ pub enum ProviderError {
     #[error("MMR not found")]
     MmrNotFound,
 
-    /// Error from the [`Indexer`]
+    /// Error from the [`IndexerError`]
     #[error("Failed from indexer")]
     IndexerError(#[from] IndexerError),
 
-    /// Error from [`RpcProvider`]
+    /// Error from [`RpcProviderError`]
     #[error("Failed to get proofs: {0}")]
     EvmRpcProviderError(#[from] RpcProviderError),
 
@@ -34,7 +34,7 @@ pub enum ProviderError {
     FetchKeyError(String),
 }
 
-/// Error from [`RpcProvider`]
+/// Error from rpc
 #[derive(Error, Debug)]
 pub enum RpcProviderError {
     #[error("Failed to send proofs with mpsc")]

hdp/src/provider/indexer.rs

@@ -53,7 +53,7 @@ impl ChainId {
 
 /// Indexer client for fetching MMR and headers proof from Herodotus Indexer
 ///
-/// For more information, see: https://rs-indexer.api.herodotus.cloud/swagger
+/// For more information, see: <https://rs-indexer.api.herodotus.cloud/swagger>
 ///
 /// How to use:
 /// ```rust

hdp/src/provider/starknet/types.rs

@@ -2,7 +2,7 @@ use serde::{Deserialize, Serialize};
 use serde_with::skip_serializing_none;
 use starknet_types_core::{felt::Felt, hash::StarkHash};
 
-/// Codebase is from https://github.com/eqlabs/pathfinder/tree/ae81d84b7c4157891069bd02ef810a29b60a94e3
+/// Codebase is from <https://github.com/eqlabs/pathfinder/tree/ae81d84b7c4157891069bd02ef810a29b60a94e3>
 
 /// Holds the membership/non-membership of a contract and its associated
 /// contract contract if the contract exists.

justfile

@@ -13,10 +13,14 @@ clean:
 clippy:
     cargo clippy --all-targets --all-features -- -Dwarnings
 
+# Generate documentation for the project
+docs:
+    cargo doc --no-deps
+
 # Execute all unit tests in the workspace
 test:
     cargo llvm-cov nextest --features test_utils
 
-# Run the entire CI pipeline including format, clippy, and test checks
-run-ci-flow: format clippy test
+# Run the entire CI pipeline including format, clippy, docs, and test checks
+run-ci-flow: format clippy docs test
     @echo "CI flow completed"