-
Notifications
You must be signed in to change notification settings - Fork 232
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add support for encoding/decoding inputs from JSON (#1325)
* chore: move `parse_str_to_field` into `mod.rs` * chore: clean up stale comment * feat: add support for reading/writing arguments from json * chore: update errors to be generic over file formats * fix: make `AbiTYpeMismatch` generic to abi type * chore: run serialization tests on all `Format` variants * chore: cspell * chore: update error message * chore: add comments explaining limits on number size
- Loading branch information
1 parent
a6de557
commit 84673ef
Showing
6 changed files
with
268 additions
and
37 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| use super::{parse_str_to_field, InputValue}; | ||
| use crate::{errors::InputParserError, Abi, AbiType, MAIN_RETURN_NAME}; | ||
| use acvm::FieldElement; | ||
| use iter_extended::{btree_map, try_btree_map, try_vecmap, vecmap}; | ||
| use serde::{Deserialize, Serialize}; | ||
| use std::collections::BTreeMap; | ||
|
|
||
| pub(crate) fn parse_json( | ||
| input_string: &str, | ||
| abi: &Abi, | ||
| ) -> Result<BTreeMap<String, InputValue>, InputParserError> { | ||
| // Parse input.json into a BTreeMap. | ||
| let data: BTreeMap<String, JsonTypes> = serde_json::from_str(input_string)?; | ||
|
|
||
| // Convert arguments to field elements. | ||
| let mut parsed_inputs = try_btree_map(abi.to_btree_map(), |(arg_name, abi_type)| { | ||
| // Check that json contains a value for each argument in the ABI. | ||
| let value = data | ||
| .get(&arg_name) | ||
| .ok_or_else(|| InputParserError::MissingArgument(arg_name.clone()))?; | ||
|
|
||
| InputValue::try_from_json(value.clone(), &abi_type, &arg_name) | ||
| .map(|input_value| (arg_name, input_value)) | ||
| })?; | ||
|
|
||
| // If the json file also includes a return value then we parse it as well. | ||
| // This isn't required as the prover calculates the return value itself. | ||
| if let (Some(return_type), Some(json_return_value)) = | ||
| (&abi.return_type, data.get(MAIN_RETURN_NAME)) | ||
| { | ||
| let return_value = | ||
| InputValue::try_from_json(json_return_value.clone(), return_type, MAIN_RETURN_NAME)?; | ||
| parsed_inputs.insert(MAIN_RETURN_NAME.to_owned(), return_value); | ||
| } | ||
|
|
||
| Ok(parsed_inputs) | ||
| } | ||
|
|
||
| pub(crate) fn serialize_to_json( | ||
| w_map: &BTreeMap<String, InputValue>, | ||
| ) -> Result<String, InputParserError> { | ||
| let to_map: BTreeMap<_, _> = | ||
| w_map.iter().map(|(key, value)| (key, JsonTypes::from(value.clone()))).collect(); | ||
|
|
||
| let json_string = serde_json::to_string(&to_map)?; | ||
|
|
||
| Ok(json_string) | ||
| } | ||
|
|
||
| #[derive(Debug, Deserialize, Serialize, Clone)] | ||
| #[serde(untagged)] | ||
| enum JsonTypes { | ||
| // This is most likely going to be a hex string | ||
| // But it is possible to support UTF-8 | ||
| String(String), | ||
| // Just a regular integer, that can fit in 64 bits. | ||
| // | ||
| // The JSON spec does not specify any limit on the size of integer number types, | ||
| // however we restrict the allowable size. Values which do not fit in a u64 should be passed | ||
| // as a string. | ||
| Integer(u64), | ||
| // Simple boolean flag | ||
| Bool(bool), | ||
| // Array of regular integers | ||
| ArrayNum(Vec<u64>), | ||
| // Array of hexadecimal integers | ||
| ArrayString(Vec<String>), | ||
| // Array of booleans | ||
| ArrayBool(Vec<bool>), | ||
| // Struct of JsonTypes | ||
| Table(BTreeMap<String, JsonTypes>), | ||
| } | ||
|
|
||
| impl From<InputValue> for JsonTypes { | ||
| fn from(value: InputValue) -> Self { | ||
| match value { | ||
| InputValue::Field(f) => { | ||
| let f_str = format!("0x{}", f.to_hex()); | ||
| JsonTypes::String(f_str) | ||
| } | ||
| InputValue::Vec(v) => { | ||
| let array = v.iter().map(|i| format!("0x{}", i.to_hex())).collect(); | ||
| JsonTypes::ArrayString(array) | ||
| } | ||
| InputValue::String(s) => JsonTypes::String(s), | ||
| InputValue::Struct(map) => { | ||
| let map_with_json_types = | ||
| btree_map(map, |(key, value)| (key, JsonTypes::from(value))); | ||
| JsonTypes::Table(map_with_json_types) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl InputValue { | ||
| fn try_from_json( | ||
| value: JsonTypes, | ||
| param_type: &AbiType, | ||
| arg_name: &str, | ||
| ) -> Result<InputValue, InputParserError> { | ||
| let input_value = match value { | ||
| JsonTypes::String(string) => match param_type { | ||
| AbiType::String { .. } => InputValue::String(string), | ||
| AbiType::Field | AbiType::Integer { .. } | AbiType::Boolean => { | ||
| InputValue::Field(parse_str_to_field(&string)?) | ||
| } | ||
|
|
||
| AbiType::Array { .. } | AbiType::Struct { .. } => { | ||
| return Err(InputParserError::AbiTypeMismatch(param_type.clone())) | ||
| } | ||
| }, | ||
| JsonTypes::Integer(integer) => { | ||
| let new_value = FieldElement::from(i128::from(integer)); | ||
|
|
||
| InputValue::Field(new_value) | ||
| } | ||
| JsonTypes::Bool(boolean) => InputValue::Field(boolean.into()), | ||
| JsonTypes::ArrayNum(arr_num) => { | ||
| let array_elements = | ||
| vecmap(arr_num, |elem_num| FieldElement::from(i128::from(elem_num))); | ||
|
|
||
| InputValue::Vec(array_elements) | ||
| } | ||
| JsonTypes::ArrayString(arr_str) => { | ||
| let array_elements = try_vecmap(arr_str, |elem_str| parse_str_to_field(&elem_str))?; | ||
|
|
||
| InputValue::Vec(array_elements) | ||
| } | ||
| JsonTypes::ArrayBool(arr_bool) => { | ||
| let array_elements = vecmap(arr_bool, FieldElement::from); | ||
|
|
||
| InputValue::Vec(array_elements) | ||
| } | ||
|
|
||
| JsonTypes::Table(table) => match param_type { | ||
| AbiType::Struct { fields } => { | ||
| let native_table = try_btree_map(fields, |(field_name, abi_type)| { | ||
| // Check that json contains a value for each field of the struct. | ||
| let field_id = format!("{arg_name}.{field_name}"); | ||
| let value = table | ||
| .get(field_name) | ||
| .ok_or_else(|| InputParserError::MissingArgument(field_id.clone()))?; | ||
| InputValue::try_from_json(value.clone(), abi_type, &field_id) | ||
| .map(|input_value| (field_name.to_string(), input_value)) | ||
| })?; | ||
|
|
||
| InputValue::Struct(native_table) | ||
| } | ||
| _ => return Err(InputParserError::AbiTypeMismatch(param_type.clone())), | ||
| }, | ||
| }; | ||
|
|
||
| Ok(input_value) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.