Module json 

Shared JSON output primitives for Foundry CLIs.

Re-exports

use alloy_dyn_abi::DynSolValue; 🔒

use eyre::Result; 🔒

use foundry_common::fmt::format_tokens; 🔒

use foundry_common::fmt::serialize_value_as_json; 🔒

use foundry_common::sh_println; 🔒

use foundry_common::shell; 🔒

use serde::Deserialize; 🔒

use serde::Deserialize; 🔒

use serde::Serialize; 🔒

use serde::Serialize; 🔒

use serde_json::Value; 🔒

use serde_json::to_string; 🔒

Structs

JsonEnvelope

Stable top-level envelope for complete machine-readable command output.

JsonError

A terminal JSON command failure that preserves command-specific output data.

JsonMessage

Structured diagnostic entry for JSON output.

Enums

JsonMessageLevel

Severity level for a structured JSON diagnostic.

Constants

JSON_SCHEMA_VERSION

The current version of Foundry’s top-level JSON output envelope.

Functions

print_json

Prints a value as one compact JSON line on stdout and flushes.

print_json_object

Prints a serializable object: envelope-wrapped in --json mode, pretty-printed otherwise.

print_json_success

Prints a successful JSON envelope to stdout.

print_json_success_with_warnings

Prints a successful JSON envelope with warnings to stdout.

print_json_value_or_scalar

Prints command output that may already be JSON: parsed and envelope-wrapped in --json mode, plain text otherwise. If the output is not valid JSON, it is wrapped as a scalar string.

print_list

Prints a list of serializable items: JSON envelope wrapping an array in --json mode, one item per line otherwise.

print_scalar

Prints a scalar value: JSON envelope in --json mode, plain text otherwise.

print_tokens

Prints ABI-decoded tokens: JSON envelope wrapping a value array in --json mode, one formatted token per line otherwise.