Document new value format

fluencelabs · Mar 9, 2023 · bf6b643 · bf6b643
1 parent cabf985
commit bf6b643
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/crates/air-lib/interpreter-data/src/executed_state.rs b/crates/air-lib/interpreter-data/src/executed_state.rs
@@ -63,6 +63,24 @@ pub enum CallResult {
     Failed(Rc<CID<ServiceResultAggregate>>),
 }
 
+/*
+ * Previous data scheme was (Scalar as an example, other cases are similar):
+ *
+ * Scalar(CID<JValue>) ---<CID>----> JValue
+ *
+ * New data scheme is much more sofisticated:
+ *
+ * ```
+ * Scalar(CID<ServiceResultAggregate>) ---+
+ *                                        |
+ *             +--------------------------+
+ *             |
+ *             +---<CID>----> ServiceResultAggregate:
+ *                                value_cid -------------<CID>----> JValue
+ *                                tetraplet_cid ---------<CID>----> SecurityTetraplet
+ *                                argument_hash
+ * ```
+ */
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
 #[serde(rename_all = "snake_case")]
 pub enum ValueRef {