docs(agglayer): sync spec, diagram & comments with #2771#2980
Merged
Conversation
mmagician
added
no changelog
mmagician
commented
Jun 8, 2026
mmagician
commented
Jun 8, 2026
mmagician
commented
Jun 8, 2026
PR #2771 moved faucet metadata onto the bridge (faucet_metadata_map), removed the faucet's asset_to_origin_asset / get_metadata_hash / get_scale procs, added the native lock/unlock path, and grew CONFIG_AGG_BRIDGE to 18 felts -- but left several docs referring to the old FPI-based design. - SPEC.md 3.1: drop FPI references in bridge_out/bridge_in, fix register_faucet inputs and the [1, is_native, 0, 0] registry value, add store_faucet_metadata_hash + internal metadata-reader proc docs, add the faucet_metadata_map storage row, document the native lock/unlock branch. - SPEC.md 3.2: faucet component now re-exports only mint_and_send + receive_and_burn; delete the removed proc subsections and the dead faucet storage slots. - SPEC.md 4.3: CONFIG_AGG_BRIDGE is 18 felts; fix the layout table and consumption (register_faucet + store_faucet_metadata_hash). - bridge_out.masm / bridge_out.rs: drop 'via FPI' wording. - bridge-out diagram: 'FPI: get amount/metadata' -> bridge-storage reads; regenerate PNG. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-authored-by: Marti <marcin.gorny.94@protonmail.com>
Co-authored-by: Marti <marcin.gorny.94@protonmail.com>
mmagician
force-pushed
the
mmagician-claude/agglayer-doc-fixes
branch
from
83c0c6f to
39b7059
Compare
partylikeits1983
approved these changes
Jun 10, 2026
partylikeits1983
left a comment
partylikeits1983
left a comment
Contributor
There was a problem hiding this comment.
Very nice! Thanks for updating the chart!
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
#2771 moved faucet metadata onto the bridge (
faucet_metadata_map), removed the faucet'sasset_to_origin_asset/get_metadata_hash/get_scaleprocedures, added the native lock/unlock path, and grewCONFIG_AGG_BRIDGEto 18 felts. Several docs, the spec, and a few comments were left describing the old FPI-based design. This PR brings them in line with the merged code. Docs/comments only - no logic changes.Changes
SPEC.md§3.1 (Bridge Account Component):bridge_out/bridge_in::claim(metadata is now read fromfaucet_metadata_mapviabridge_config::get_faucet_conversion_info/get_faucet_scale/get_faucet_metadata_hash).register_faucetinputs and the[1, is_native, 0, 0]registry value; documented thefaucet_metadata_mapwrites.store_faucet_metadata_hashand the internal metadata-reader helper docs, plus afaucet_metadata_mapstorage row.SPEC.md§3.2 (Faucet Account Component): the component now re-exports onlymint_and_send+receive_and_burnon top ofOwnable2Step+OwnerControlled. Deleted the removed proc subsections and the dead faucet storage slots.SPEC.md§4.3 (CONFIG_AGG_BRIDGE): note is 18 felts now - fixed the layout table and consumption description (register_faucet+store_faucet_metadata_hash).bridge_out.masm/tests/agglayer/bridge_out.rs: dropped the stale "via FPI" wording.diagrams/bridge-out: replaced "FPI: get amount / FPI: get metadata" with bridge-storage reads; regenerated the PNG viamake agglayer-spec.Verification
cargo build -p miden-agglayer(compiles the edited embedded MASM comments).cargo +nightly fmt --all --checkandtyposclean.bridge-out.pngvisually verified.🤖 Generated with Claude Code