feat(rpc): decouple v07 from v06 types and methods

crates/rpc/src/dto/simulation.rs

@@ -6,6 +6,10 @@ use super::serialize::SerializeStruct;
 use super::FeeEstimate;
 use crate::RpcVersion;
 
+/// A transaction trace.
+///
+/// This is a wrapper around the transaction trace type from the executor,
+/// with added serialization methods.
 #[derive(Debug)]
 pub struct TransactionTrace {
     pub trace: pathfinder_executor::types::TransactionTrace,
@@ -120,6 +124,10 @@ impl crate::dto::serialize::SerializeForVersion for TransactionTrace {
     }
 }
 
+/// A function invocation.
+///
+/// This is a wrapper around the function invocation type from the executor,
+/// with added serialization methods.
 #[derive(Debug)]
 pub(crate) struct FunctionInvocation<'a>(&'a pathfinder_executor::types::FunctionInvocation);
 
@@ -192,6 +200,10 @@ impl crate::dto::serialize::SerializeForVersion for FunctionInvocation<'_> {
     }
 }
 
+/// An event.
+///
+/// This is a wrapper around the event type from the executor,
+/// with added serialization methods.
 struct Event<'a>(&'a pathfinder_executor::types::Event);
 
 impl crate::dto::serialize::SerializeForVersion for Event<'_> {
@@ -215,6 +227,10 @@ impl crate::dto::serialize::SerializeForVersion for Event<'_> {
     }
 }
 
+/// A message to L1.
+///
+/// This is a wrapper around the message to L1 type from the executor,
+/// with added serialization methods.
 struct MsgToL1<'a>(&'a pathfinder_executor::types::MsgToL1);
 
 impl crate::dto::serialize::SerializeForVersion for MsgToL1<'_> {
@@ -235,6 +251,10 @@ impl crate::dto::serialize::SerializeForVersion for MsgToL1<'_> {
     }
 }
 
+/// Computation resources.
+///
+/// This is a wrapper around the computation resources type from the executor,
+/// with added serialization methods.
 struct ComputationResources<'a>(&'a pathfinder_executor::types::ComputationResources);
 
 impl crate::dto::serialize::SerializeForVersion for ComputationResources<'_> {
@@ -296,6 +316,10 @@ impl crate::dto::serialize::SerializeForVersion for ComputationResources<'_> {
     }
 }
 
+/// Inner call execution resources.
+///
+/// This is a wrapper around the inner call execution resources type from the
+/// executor, with added serialization methods.
 struct InnerCallExecutionResources<'a>(&'a pathfinder_executor::types::InnerCallExecutionResources);
 
 impl crate::dto::serialize::SerializeForVersion for InnerCallExecutionResources<'_> {
@@ -310,6 +334,10 @@ impl crate::dto::serialize::SerializeForVersion for InnerCallExecutionResources<
     }
 }
 
+/// State diff.
+///
+/// This is a wrapper around the state diff type from the executor,
+/// with added serialization methods.
 struct StateDiff<'a>(&'a pathfinder_executor::types::StateDiff);
 
 impl crate::dto::serialize::SerializeForVersion for StateDiff<'_> {
@@ -356,6 +384,10 @@ impl crate::dto::serialize::SerializeForVersion for StateDiff<'_> {
     }
 }
 
+/// Storage diff.
+///
+/// This is a wrapper around the storage diff type from the executor,
+/// with added serialization methods.
 struct StorageDiff<'a>(
     (
         &'a ContractAddress,
@@ -379,6 +411,7 @@ impl crate::dto::serialize::SerializeForVersion for StorageDiff<'_> {
     }
 }
 
+/// Storage entry.
 struct StorageEntry<'a>(&'a pathfinder_executor::types::StorageDiff);
 
 impl crate::dto::serialize::SerializeForVersion for StorageEntry<'_> {
@@ -393,6 +426,10 @@ impl crate::dto::serialize::SerializeForVersion for StorageEntry<'_> {
     }
 }
 
+/// Declared Sierra class.
+///
+/// This is a wrapper around the declared Sierra class type from the executor,
+/// with added serialization methods.
 struct DeclaredSierraClass<'a>(&'a pathfinder_executor::types::DeclaredSierraClass);
 
 impl crate::dto::serialize::SerializeForVersion for DeclaredSierraClass<'_> {
@@ -410,6 +447,10 @@ impl crate::dto::serialize::SerializeForVersion for DeclaredSierraClass<'_> {
     }
 }
 
+/// Deployed contract.
+///
+/// This is a wrapper around the deployed contract type from the executor,
+/// with added serialization methods.
 struct DeployedContract<'a>(&'a pathfinder_executor::types::DeployedContract);
 
 impl crate::dto::serialize::SerializeForVersion for DeployedContract<'_> {
@@ -424,6 +465,10 @@ impl crate::dto::serialize::SerializeForVersion for DeployedContract<'_> {
     }
 }
 
+/// Replaced class.
+///
+/// This is a wrapper around the replaced class type from the executor,
+/// with added serialization methods.
 struct ReplacedClass<'a>(&'a pathfinder_executor::types::ReplacedClass);
 
 impl crate::dto::serialize::SerializeForVersion for ReplacedClass<'_> {
@@ -441,6 +486,10 @@ impl crate::dto::serialize::SerializeForVersion for ReplacedClass<'_> {
     }
 }
 
+/// Nonce.
+///
+/// This is a wrapper around the nonce type from the executor,
+/// with added serialization methods.
 struct Nonce<'a>((&'a ContractAddress, &'a ContractNonce));
 
 impl crate::dto::serialize::SerializeForVersion for Nonce<'_> {
@@ -455,6 +504,10 @@ impl crate::dto::serialize::SerializeForVersion for Nonce<'_> {
     }
 }
 
+/// Execution resources.
+///
+/// This is a wrapper around the execution resources type from the executor,
+/// with added serialization methods.
 struct ExecutionResources<'a>(&'a pathfinder_executor::types::ExecutionResources);
 
 impl crate::dto::serialize::SerializeForVersion for ExecutionResources<'_> {
@@ -483,6 +536,10 @@ impl crate::dto::serialize::SerializeForVersion for ExecutionResources<'_> {
     }
 }
 
+/// Data availability resources.
+///
+/// This is a wrapper around the data availability resources type from the
+/// executor, with added serialization methods.
 struct DataAvailabilityResources<'a>(&'a pathfinder_executor::types::DataAvailabilityResources);
 
 impl crate::dto::serialize::SerializeForVersion for DataAvailabilityResources<'_> {
@@ -497,6 +554,10 @@ impl crate::dto::serialize::SerializeForVersion for DataAvailabilityResources<'_
     }
 }
 
+/// Execute invocation.
+///
+/// This is a wrapper around the execute invocation type from the executor,
+/// with added serialization methods.
 struct ExecuteInvocation<'a>(&'a pathfinder_executor::types::ExecuteInvocation);
 
 impl crate::dto::serialize::SerializeForVersion for ExecuteInvocation<'_> {