chore: docs

Author: klkvr

crates/cheatcodes/src/json.rs

@@ -328,6 +328,7 @@ pub(super) fn parse_json_coerce(json: &str, path: &str, ty: &DynSolType) -> Resu
     parse_json_as(&value, ty).map(|v| v.abi_encode())
 }
 
+/// Parses given [serde_json::Value] as a [DynSolValue].
 pub(super) fn parse_json_as(value: &Value, ty: &DynSolType) -> Result<DynSolValue> {
     let to_string = |v: &Value| {
         let mut s = v.to_string();
@@ -351,7 +352,7 @@ pub(super) fn parse_json_array(array: &[Value], ty: &DynSolType) -> Result<DynSo
     let (inner, fixed_len) = match ty {
         DynSolType::FixedArray(inner, len) => (inner, Some(*len)),
         DynSolType::Array(inner) => (inner, None),
-        _ => bail!("expected array type"),
+        _ => bail!("expected {ty}, found array"),
     };
 
     let values = array.iter().map(|e| parse_json_as(e, inner)).collect::<Result<Vec<_>>>()?;
@@ -366,7 +367,7 @@ pub(super) fn parse_json_array(array: &[Value], ty: &DynSolType) -> Result<DynSo
 
 pub(super) fn parse_json_map(map: &Map<String, Value>, ty: &DynSolType) -> Result<DynSolValue> {
     let Some((_, fields, types)) = ty.as_custom_struct() else {
-        bail!("expected struct type");
+        bail!("expected {ty}, found JSON object");
     };
 
     let mut values = Vec::with_capacity(fields.len());
@@ -571,6 +572,7 @@ where
     s
 }
 
+/// Resolves a [DynSolType] from user input.
 fn resolve_type(type_description: &str) -> Result<DynSolType> {
     if let Ok(ty) = DynSolType::parse(type_description) {
         return Ok(ty);

crates/cheatcodes/src/toml.rs

@@ -45,7 +45,7 @@ impl Cheatcode for parseTomlUintCall {
 impl Cheatcode for parseTomlUintArrayCall {
     fn apply(&self, _state: &mut Cheatcodes) -> Result {
         let Self { toml, key } = self;
-        parse_toml_coerce(toml, key, &DynSolType::Uint(256))
+        parse_toml_coerce(toml, key, &DynSolType::Array(Box::new(DynSolType::Uint(256))))
     }
 }
 
@@ -59,7 +59,7 @@ impl Cheatcode for parseTomlIntCall {
 impl Cheatcode for parseTomlIntArrayCall {
     fn apply(&self, _state: &mut Cheatcodes) -> Result {
         let Self { toml, key } = self;
-        parse_toml_coerce(toml, key, &DynSolType::Int(256))
+        parse_toml_coerce(toml, key, &DynSolType::Array(Box::new(DynSolType::Int(256))))
     }
 }
 
@@ -73,7 +73,7 @@ impl Cheatcode for parseTomlBoolCall {
 impl Cheatcode for parseTomlBoolArrayCall {
     fn apply(&self, _state: &mut Cheatcodes) -> Result {
         let Self { toml, key } = self;
-        parse_toml_coerce(toml, key, &DynSolType::Bool)
+        parse_toml_coerce(toml, key, &DynSolType::Array(Box::new(DynSolType::Bool)))
     }
 }
 
@@ -87,7 +87,7 @@ impl Cheatcode for parseTomlAddressCall {
 impl Cheatcode for parseTomlAddressArrayCall {
     fn apply(&self, _state: &mut Cheatcodes) -> Result {
         let Self { toml, key } = self;
-        parse_toml_coerce(toml, key, &DynSolType::Address)
+        parse_toml_coerce(toml, key, &DynSolType::Array(Box::new(DynSolType::Address)))
     }
 }
 
@@ -101,7 +101,7 @@ impl Cheatcode for parseTomlStringCall {
 impl Cheatcode for parseTomlStringArrayCall {
     fn apply(&self, _state: &mut Cheatcodes) -> Result {
         let Self { toml, key } = self;
-        parse_toml_coerce(toml, key, &DynSolType::String)
+        parse_toml_coerce(toml, key, &DynSolType::Array(Box::new(DynSolType::String)))
     }
 }
 
@@ -115,7 +115,7 @@ impl Cheatcode for parseTomlBytesCall {
 impl Cheatcode for parseTomlBytesArrayCall {
     fn apply(&self, _state: &mut Cheatcodes) -> Result {
         let Self { toml, key } = self;
-        parse_toml_coerce(toml, key, &DynSolType::Bytes)
+        parse_toml_coerce(toml, key, &DynSolType::Array(Box::new(DynSolType::Bytes)))
     }
 }
 
@@ -129,7 +129,7 @@ impl Cheatcode for parseTomlBytes32Call {
 impl Cheatcode for parseTomlBytes32ArrayCall {
     fn apply(&self, _state: &mut Cheatcodes) -> Result {
         let Self { toml, key } = self;
-        parse_toml_coerce(toml, key, &DynSolType::FixedBytes(32))
+        parse_toml_coerce(toml, key, &DynSolType::Array(Box::new(DynSolType::FixedBytes(32))))
     }
 }
 

crates/forge/bin/cmd/eip712.rs

@@ -74,6 +74,7 @@ impl Eip712Args {
     }
 }
 
+/// AST [Visitor] used for collecting struct definitions.
 #[derive(Debug, Clone, Default)]
 struct StructCollector(BTreeMap<usize, StructDefinition>);
 
@@ -86,7 +87,7 @@ impl Visitor for StructCollector {
 /// Collects mapping from AST id of type definition to representation of this type for EIP-712
 /// encoding.
 ///
-/// For now, maps contract definitions to address and enums to uint8
+/// For now, maps contract definitions to `address` and enums to `uint8`.
 #[derive(Debug, Clone, Default)]
 struct SimpleCustomTypesCollector(BTreeMap<usize, String>);
 
@@ -123,6 +124,10 @@ impl Resolver {
         Self { simple_types, structs }
     }
 
+    /// Converts a given struct definition into EIP-712 `encodeType` representation.
+    ///
+    /// Returns `None` if struct contains any fields that are not supported by EIP-712 (e.g.
+    /// mappings or function pointers).
     pub fn resolve_struct_eip712(
         &self,
         id: usize,
@@ -229,8 +234,8 @@ fn parse_array_length(type_description: &TypeDescriptions) -> Result<Option<&str
     };
 
     if inside_brackets.is_empty() {
-        return Ok(None)
+        Ok(None)
     } else {
-        return Ok(Some(inside_brackets))
+        Ok(Some(inside_brackets))
     }
 }

testdata/default/cheats/Json.t.sol

@@ -97,7 +97,7 @@ contract ParseJsonTest is DSTest {
     }
 
     function test_coercionRevert() public {
-        vm._expectCheatcodeRevert("values at \".nestedObject\" must not be JSON objects");
+        vm._expectCheatcodeRevert("expected uint256, found JSON object");
         vm.parseJsonUint(json, ".nestedObject");
     }
 

testdata/default/cheats/Toml.t.sol

@@ -116,7 +116,7 @@ contract ParseTomlTest is DSTest {
     }
 
     function test_coercionRevert() public {
-        vm._expectCheatcodeRevert("values at \".nestedObject\" must not be JSON objects");
+        vm._expectCheatcodeRevert("expected uint256, found JSON object");
         vm.parseTomlUint(toml, ".nestedObject");
     }