commentary

Author: Shubham8287

crates/core/src/host/module_host.rs

@@ -546,6 +546,7 @@ pub struct CallViewParams {
     /// The expected return type of the view, used for deserialization.
     /// This type information is obtained from the [`ModuleDef`].
     pub return_type: AlgebraicType,
+    /// Whether the view is being called anonymously (i.e., without a client identity).
     pub is_anonymous: bool,
 }
 

crates/core/src/host/wasm_common/module_host_actor.rs

@@ -726,6 +726,7 @@ impl InstanceCommon {
         }
     }
 
+    /// Calls a function (reducer, view) and performs energy monitoring.
     fn call_function<F, R: FunctionResult>(
         &mut self,
         caller_identity: Identity,
@@ -768,6 +769,11 @@ impl InstanceCommon {
         (tx, result)
     }
 
+    /// Execute a view.
+    ///
+    /// Similar to `call_reducer_with_tx`, but for views.
+    /// unlike to `call_reducer_with_tx`, It does not handle `tx`creation or commit,
+    /// It returns the updated `tx` instead.
     fn call_view_with_tx(
         &mut self,
         replica_ctx: &ReplicaContext,

crates/core/src/host/wasmtime/wasm_instance_env.rs

@@ -126,6 +126,7 @@ const STANDARD_BYTES_SINK: u32 = 1;
 type WasmResult<T> = Result<T, WasmError>;
 type RtResult<T> = anyhow::Result<T>;
 
+/// The type of function call being performed.
 pub enum FuncCallType {
     Reducer,
     Procedure,

crates/core/src/host/wasmtime/wasmtime_module.rs

@@ -97,6 +97,10 @@ fn handle_error_sink_code(code: i32, error: Vec<u8>) -> Result<(), Box<str>> {
     }
 }
 
+/// Handle the return code from a function using a result sink.
+///
+/// On success, returns the result bytes.
+/// On failure, returns the error message.
 fn handle_result_sink_code(code: i32, result: Vec<u8>) -> Result<Vec<u8>, Box<str>> {
     match code {
         0 => Ok(result),

crates/core/src/subscription/module_subscription_actor.rs

@@ -197,6 +197,7 @@ impl ModuleSubscriptions {
         }
     }
 
+    /// Should be called once to initialize the `ModuleSubscriptions` with a `ModuleHost` receiver.
     pub fn init(&self, module_host: watch::Receiver<ModuleHost>) {
         self.module_rx
             .set(module_host)