Add syscall_reponse docs (#827)

* Add syscall_reponse docs

* Typo

* Update syscall_response docs

---------

Co-authored-by: Matías Ignacio González <[email protected]>

Author: xqft

src/syscalls/syscall_response.rs

@@ -1,6 +1,7 @@
 use cairo_vm::felt::Felt252;
 use cairo_vm::types::relocatable::{MaybeRelocatable, Relocatable};
 
+/// Abstracts every response variant body for each syscall.
 pub(crate) enum ResponseBody {
     StorageReadResponse { value: Option<Felt252> },
     GetBlockNumber { number: Felt252 },
@@ -11,6 +12,7 @@ pub(crate) enum ResponseBody {
     GetExecutionInfo { exec_info_ptr: Relocatable },
     GetBlockHash(GetBlockHashResponse),
 }
+/// Wraps around any response body. It also contains the remaining gas after the execution.
 #[allow(unused)]
 pub(crate) struct SyscallResponse {
     /// The amount of gas left after the syscall execution.
@@ -20,6 +22,7 @@ pub(crate) struct SyscallResponse {
 }
 
 impl SyscallResponse {
+    /// Converts a response into cairo args for writing in memory.
     pub(crate) fn to_cairo_compatible_args(&self) -> Vec<MaybeRelocatable> {
         let mut cairo_args = Vec::<MaybeRelocatable>::with_capacity(5);
         cairo_args.push(Felt252::from(self.gas).into());
@@ -64,32 +67,46 @@ impl SyscallResponse {
 //   Response objects
 // ----------------------
 
+/// Represents the response of get_block_timestamp syscall.
 #[derive(Clone, Debug, PartialEq)]
 pub struct GetBlockTimestampResponse {
+    /// The block timestamp.
     pub timestamp: Felt252,
 }
 
+/// Represents the response of deploy syscall.
 pub struct DeployResponse {
+    /// Address of the deployed contract.
     pub contract_address: Felt252,
+    /// The retdata segment start.
     pub retdata_start: Relocatable,
+    /// The retdata segment end.
     pub retdata_end: Relocatable,
 }
 
+/// Represents error data of any syscall response.
 pub struct FailureReason {
+    /// The retdata segment start.
     pub retdata_start: Relocatable,
+    /// The retdata segment end.
     pub retdata_end: Relocatable,
     // Syscall specific response fields.
     // TODO: this cause circular dependency
     //pub(crate) body: Option<ResponseBody>,
 }
 
+/// Represents the response of call_contract syscall
 #[derive(Clone, Debug, PartialEq)]
 pub struct CallContractResponse {
+    /// The retdata segment start.
     pub retdata_start: Relocatable,
+    /// The retdata segment end.
     pub retdata_end: Relocatable,
 }
 
+/// Represents the response of get_block_hash syscall
 #[derive(Clone, Debug, PartialEq)]
 pub struct GetBlockHashResponse {
+    /// The returned hash.
     pub block_hash: Felt252,
 }