SSZ 2: acct-types and ee-chain-types #1101

krsnapaudel · 2025-10-16T09:02:21Z

Description

SSZ support for acct-types and ee-chain-types.

The PR was created with help from Claude Code.

Type of Change

Bug fix (non-breaking change which fixes an issue)
New feature/Enhancement (non-breaking change which adds functionality or enhances an existing one)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update
Refactor
New or updated tests
Dependency Update

Notes to Reviewers

Checklist

I have performed a self-review of my code.
I have commented my code where necessary.
I have updated the documentation if needed.
My changes do not introduce new warnings.
I have added (where necessary) tests that prove my changes are effective or that my feature works.
New and existing tests pass with my changes.
I have disclosed my use of AI
in the body of this PR.

Related Issues

github-actions · 2025-10-16T09:29:55Z

Commit: c41fd74

SP1 Execution Results

program	cycles	success
EVM EE STF	1,324,852	✅
CL STF	330,723	✅
Checkpoint	2,422	✅

codecov · 2025-10-16T09:33:36Z

Codecov Report

❌ Patch coverage is 73.45133% with 90 lines in your changes missing coverage. Please review.
✅ Project coverage is 74.80%. Comparing base (fd6164d) to head (b447b1b).
⚠️ Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
crates/acct-ssz-types/src/id.rs	17.33%	62 Missing ⚠️
crates/btc-types/src/btc.rs	67.74%	10 Missing ⚠️
crates/acct-types/src/state.rs	86.66%	6 Missing ⚠️
crates/ee-chain-ssz-types/src/block.rs	0.00%	6 Missing ⚠️
crates/acct-ssz-types/src/messages.rs	0.00%	3 Missing ⚠️
crates/acct-ssz-types/src/state.rs	0.00%	3 Missing ⚠️

@@            Coverage Diff             @@
##             main    #1101      +/-   ##
==========================================
+ Coverage   74.62%   74.80%   +0.17%     
==========================================
  Files         510      514       +4     
  Lines       42807    43412     +605     
==========================================
+ Hits        31946    32474     +528     
- Misses      10861    10938      +77

Flag	Coverage Δ
functional	`53.68% <0.00%> (+0.21%)`	⬆️
unit	`54.79% <73.45%> (+0.17%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
crates/acct-types/src/id.rs	`97.95% <100.00%> (+97.95%)`	⬆️
crates/acct-types/src/messages.rs	`83.33% <100.00%> (+16.66%)`	⬆️
crates/ee-chain-types/src/block.rs	`100.00% <100.00%> (ø)`
crates/acct-ssz-types/src/messages.rs	`0.00% <0.00%> (ø)`
crates/acct-ssz-types/src/state.rs	`0.00% <0.00%> (ø)`
crates/acct-types/src/state.rs	`64.54% <86.66%> (+64.54%)`	⬆️
crates/ee-chain-ssz-types/src/block.rs	`0.00% <0.00%> (ø)`
crates/btc-types/src/btc.rs	`80.34% <67.74%> (-0.12%)`	⬇️
crates/acct-ssz-types/src/id.rs	`17.33% <17.33%> (ø)`

... and 32 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

delbonis

We want to use pythonic SSZ schemas for all of these. I am not against having a acct-ssz-types crate and then reexporting the generated types from the acct-types crate.

delbonis · 2025-10-16T15:22:08Z

crates/ee-chain-types/src/block.rs

+/// Variable-length list for subject deposits (max 65536 deposits per block)
+type SubjectDepositList = VariableList<SubjectDepositData, 65536>;
+
+/// Variable-length list for output transfers (max 65536 transfers per block)
+type OutputTransferList = VariableList<OutputTransfer, 65536>;
+
+/// Variable-length list for output messages (max 65536 messages per block)
+type OutputMessageList = VariableList<SentMessage, 65536>;


These consts should be defined somewhere.

krsnapaudel · 2025-10-17T08:06:14Z

We want to use pythonic SSZ schemas for all of these. I am not against having a acct-ssz-types crate and then reexporting the generated types from the acct-types crate.

@delbonis : After implementing separate *-ssz-types crates, I hit an issue: due to Rust's orphan rule (can't implement traits on foreign types), I had to move all the implementation (types + business logic + errors) into the *-ssz-types crates, not just SSZ serialization. This creates confusion about where to add new functionality. I am considering consolidating everything back into the original crates (acct-types, ee-chain-types) with pythonic schemas in an ssz/ or ssz-schemas/ subdirectory. The trade-off is that acct-types and ee-chain-types will depend on SSZ libraries. Would this consolidated approach work?

delbonis · 2025-10-17T17:57:05Z

@krsnapaudel

due to Rust's orphan rule (can't implement traits on foreign types), I had to move all the implementation (types + business logic + errors) into the *-ssz-types crates, not just SSZ serialization. This creates confusion about where to add new functionality.

Yeah that is a little annoying, but a structure like this would work, wouldn't it?

include!(".../whatever/ssz.rs");

impl Foo { // type defined in ssz.ssz, so this impl is able to be defined here
  // ...
}

#[cfg(test)]
mod tests {
  // ...
}

ssz/ or ssz-schemas/ subdirectory

I'm in favor of just ssz/, no need to be unnecessarily verbose.

The trade-off is that acct-types and ee-chain-types will depend on SSZ libraries.

The standard SSZ libraries being included in the dep tree is fine. The proc macros would be a dev-dependency so not actually make it into the actual built binaries.

Would this consolidated approach work?

Part of the motivation suggesting a un-consolidated -ssz-types structure was because sometimes editor tooling gets confused about how to generate the warnings/completions/etc about types generated by macros when in the same crate, but are fine in downstream crates. It also feels better to have the different kinds of definitions separated, so it's clear what kinds of definitions go where. But that's more of vibes-based reason, they're still in separate files, so it shouldn't really matter.

But that being said, these crates are already broken down pretty far, so the above points maybe don't apply strongly. Not sure how I feel about it.

krsnapaudel · 2025-10-22T10:59:11Z

@delbonis I have used include! from a separate crate. Other than the relative path for include!, this looks fine. For BitcoinAmount, we don't have a separate ssz schema, although it does appear in acct-types.ssz. It comes from btc-types. The SSZ support is directly added to it.

storopoli

All the "roundtrip" tests can be done using proptest!.

See https://proptest-rs.github.io/proptest/ and for examples:

storopoli · 2025-10-24T17:36:44Z

crates/acct-ssz-types/src/id.rs

+    fn ssz_fixed_len() -> usize {
+        2
+    }
+
+    fn ssz_bytes_len(&self) -> usize {
+        2
+    }
+
+    fn ssz_append(&self, buf: &mut Vec<u8>) {
+        (*self as u16).ssz_append(buf);
+    }
+}
+
+impl ssz::Decode for AccountTypeId {
+    fn is_ssz_fixed_len() -> bool {
+        true
+    }
+
+    fn ssz_fixed_len() -> usize {
+        2


Can we move all these 2 into a const with proper docstrings?

storopoli · 2025-10-24T17:38:22Z

crates/btc-types/src/btc.rs

+    ssz_derive::Encode,
+    ssz_derive::Decode,


Can we import these Encode/Decode in the top of the file with use?

storopoli · 2025-10-24T17:39:02Z

crates/btc-types/src/btc.rs

+    fn test_bitcoin_amount_tree_hash() {
+        use tree_hash::TreeHash;
+
+        let amount = BitcoinAmount::from_sat(1000);


Suggested change

let amount = BitcoinAmount::from_sat(1000);

let amount = BitcoinAmount::from_sat(1_000);

storopoli · 2025-10-24T17:41:50Z

crates/btc-types/src/btc.rs

+    fn test_bitcoin_amount_ssz_roundtrip() {
+        use ssz::{Decode, Encode};
+
+        let amount = BitcoinAmount::from_sat(12345);
+        let encoded = amount.as_ssz_bytes();
+        let decoded = BitcoinAmount::from_ssz_bytes(&encoded).unwrap();
+        assert_eq!(amount, decoded);
+    }


This could be a property test proptest!. See https://github.com/alpenlabs/bitcoin-bosd/blob/21c257df5c45cac22b91b0c5b1ed78b9fd3dc25f/src/serde.rs#L62-L85

Check the intro in https://proptest-rs.github.io/proptest/intro.html
for a quick introduction on what are property tests if you want.

storopoli · 2025-10-24T17:43:22Z

crates/acct-types/src/id.rs

+    fn test_account_id_ssz_roundtrip() {
+        let id = AccountId([42u8; 32]);
+        let encoded = id.as_ssz_bytes();
+        let decoded = AccountId::from_ssz_bytes(&encoded).unwrap();
+        assert_eq!(id, decoded);
+    }


proptest! as well

storopoli · 2025-10-24T17:50:10Z

crates/ee-chain-types/src/block.rs

+    }
+
+    #[test]
+    fn test_subject_deposit_data_ssz_roundtrip() {


another roundtrip test the can be done with proptest!

storopoli · 2025-10-24T17:50:23Z

crates/ee-chain-types/src/block.rs

+    }
+
+    #[test]
+    fn test_block_inputs_ssz_roundtrip_with_deposits() {


another roundtrip test the can be done with proptest!

storopoli · 2025-10-24T17:50:28Z

crates/ee-chain-types/src/block.rs

+    }
+
+    #[test]
+    fn test_output_transfer_ssz_roundtrip() {


another roundtrip test the can be done with proptest!

storopoli · 2025-10-24T17:50:35Z

crates/ee-chain-types/src/block.rs

+    }
+
+    #[test]
+    fn test_block_outputs_ssz_roundtrip_with_data() {


another roundtrip test the can be done with proptest!

storopoli · 2025-10-24T17:50:41Z

crates/ee-chain-types/src/block.rs

+    }
+
+    #[test]
+    fn test_exec_block_notpackage_ssz_roundtrip() {


another roundtrip test the can be done with proptest!

krsnapaudel requested review from a team as code owners October 16, 2025 09:02

krsnapaudel marked this pull request as draft October 16, 2025 09:02

krsnapaudel force-pushed the ssz-2 branch from fa3df40 to 3038350 Compare October 16, 2025 09:04

krsnapaudel self-assigned this Oct 16, 2025

krsnapaudel force-pushed the ssz-2 branch from 3038350 to 93a99eb Compare October 16, 2025 09:04

krsnapaudel force-pushed the ssz-2 branch from 93a99eb to 783cc82 Compare October 16, 2025 09:39

krsnapaudel changed the title ~~SSZ 2: acct-types~~ SSZ 2: acct-types and ee-chain-types Oct 16, 2025

krsnapaudel force-pushed the ssz-2 branch 2 times, most recently from 5ee7052 to 64813cb Compare October 16, 2025 10:17

delbonis requested changes Oct 16, 2025

View reviewed changes

delbonis mentioned this pull request Oct 16, 2025

SSZ 3: snark-acct-types #1102

Draft

14 tasks

krsnapaudel added 4 commits October 22, 2025 16:18

feat: add SSZ for acct-types

291a9ae

feat: acct-types use acct-ssz-types

0d4b574

feat: add ee-chain-ssz-types

20b5abc

feat: ee-chain-types use ee-chain-ssz-types

b447b1b

krsnapaudel force-pushed the ssz-2 branch from 64813cb to b447b1b Compare October 22, 2025 10:58

krsnapaudel marked this pull request as ready for review October 22, 2025 11:51

storopoli requested changes Oct 24, 2025

View reviewed changes

	let amount = BitcoinAmount::from_sat(1000);
	let amount = BitcoinAmount::from_sat(1_000);

SSZ 2: acct-types and ee-chain-types #1101

Are you sure you want to change the base?

SSZ 2: acct-types and ee-chain-types #1101

Uh oh!

Conversation

krsnapaudel commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Notes to Reviewers

Checklist

Related Issues

Uh oh!

github-actions bot commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

delbonis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

krsnapaudel commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

delbonis commented Oct 17, 2025

Uh oh!

krsnapaudel commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

storopoli left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

krsnapaudel commented Oct 16, 2025 •

edited

Loading

github-actions bot commented Oct 16, 2025 •

edited

Loading

codecov bot commented Oct 16, 2025 •

edited

Loading

krsnapaudel commented Oct 17, 2025 •

edited

Loading

krsnapaudel commented Oct 22, 2025 •

edited

Loading