Skip to content

docs(cheatcodes): add docs for serializeJson #1001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Evalir merged 1 commit into from
Sep 9, 2023
Merged

docs(cheatcodes): add docs for serializeJson #1001

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/cheatcodes/serialize-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
### Signature

```solidity
function serializeJson(string calldata objectKey, string calldata value)
external
returns (string memory json);

function serializeBool(string calldata objectKey, string calldata valueKey, bool value)
external
returns (string memory json);
Expand Down Expand Up @@ -72,7 +76,9 @@ The idea is that the user serializes the values of the JSON file and finally wri
- A key for the _value_ which will be its key in the JSON file
- The value to be serialized

The keys does not need to be of some specific form. They are of type `string` to enable for intuitive human interpretation. Semantically, they are not important other than to be used as keys.
An exception to this is the `serializeJson` function, which only receives an `objectKey` and a json string `value`. This allows the user to serialize an existing json object and directly assign it to the provided `objectKey`. If the `objectKey` is already in use, the whole serialized json is overwritten.

The keys do not need to be of some specific form. They are of type `string` to enable for intuitive human interpretation. Semantically, they are not important other than to be used as keys.

The cheatcodes return the JSON object that is being serialized **up to that point**. That way the user can serialize inner JSON objects and then serialize them in bigger JSON objects, enabling the user to create arbitrary JSON objects.

Expand Down