Debug tools for loading SSZ object from file

[hwwhww]

Installation

cd consensus-specs/scripts

pip3 install -r requirements.txt

Example code

Load JSON file from Beacon API into Remerkleable Python SSZ object

import eth2spec.capella.mainnet as spec
from eth2spec.debug.tools import get_ssz_object_from_json_file

file_dir = '<YOUR DIR PATH>'

# Load JSON file from Beacon API into Remerkleable Python SSZ object
pre_state = get_ssz_object_from_json_file(spec.BeaconState, f"{file_dir}/state_1.ssz")
post_state = get_ssz_object_from_json_file(spec.BeaconState, f"{file_dir}/state_2.ssz")
signed_block = get_ssz_object_from_json_file(spec.SignedBeaconBlock, f"{file_dir}/block_2.ssz")

state = pre_state.copy()
spec.state_transition(state, signed_block)

assert state == post_state

Load SSZ-snappy file into Remerkleable Python SSZ object

import eth2spec.capella.mainnet as spec
from eth2spec.debug.tools import get_ssz_object_from_ssz_encoded

file_dir = '<YOUR DIR PATH>'

# Load SSZ-snappy file into Remerkleable Python SSZ object
pre_state = get_ssz_object_from_ssz_encoded(spec.BeaconState, f"{file_dir}/state_1.ssz_snappy")
post_state = get_ssz_object_from_ssz_encoded(spec.BeaconState, f"{file_dir}/state_2.ssz_snappy")

Dump SSZ to JSON file

python inspect_state.py --state-path=<The path of ssz_snappy state file> --output-dir=. --fork=capella --field=validators --is-snappy

See

consensus-specs/scripts/inspect_state.py

Lines 79 to 82 in 28a45b0

	# Output specific field to file
	if field is not None and field in state.fields():
	value = state.__getattr__(field)
	output_ssz_to_file(output_dir, value, dump_yaml_fn)

[ralexstokes]

haven't reviewed in depth but have written various versions of these utilities over the years and I'd support having a standard collection somewhere

[jtraglia]

This is neat but not really necessary. Clients have tools for this too. Eg teku's pretty-print does this: https://github.com/Consensys/teku/blob/master/teku/src/main/java/tech/pegasys/teku/cli/subcommand/debug/PrettyPrintCommand.java