refactor: enforce component metadata in account component by igamigo · Pull Request #2373 · 0xMiden/protocol

igamigo · 2026-01-30T21:27:42Z

This PR:

Makes AccountComponentMetadata a required parameter in AccountComponent::new(), enforcing that all components have metadata (also adds them to the standard components)
Removes supported_types from AccountComponent struct - now delegated to metadata.supported_types()
Simplifies AccountComponentMetadata::new() to only require a name, with sensible defaults (empty description, version 0.1.0, empty supported types, empty storage schema); adds mutators for simplicity
Changes AccountSchemaCommitment::new() to return AccountError instead of AccountComponentTemplateError
Validates that the metadata's storage schema is consistent with the component's actual storage slots during construction. For now, I've made it so metadata can be a subset of the specified account component storage slots.

Error rename was pushed to a different PR: #2395

igamigo · 2026-02-03T20:09:59Z

crates/miden-protocol/src/account/component/metadata/mod.rs

-            storage_schema,
+            name: name.into(),
+            description: String::new(),
+            version: Version::new(0, 1, 0),


This may be better suited to be a parameter of AccountComponentMetadata::new instead

Maybe defaulting to 1.0 would be a better approach? Most components will be shipped as that stable version for the first time so it seems it would be the best default. For V2, V3, ... we can then overwrite explicitly.

Where do we actually display or use this version?

I changed it to 1.0. I don't think this gets explicitly used other than just being there for metadata purposes right now.

PhilippGackstatter

Looks good to me!

PhilippGackstatter · 2026-02-04T12:28:41Z

crates/miden-protocol/src/account/component/mod.rs

    pub fn new(
        code: impl Into<AccountComponentCode>,
        storage_slots: Vec<StorageSlot>,
+        metadata: AccountComponentMetadata,
    ) -> Result<Self, AccountError> {


It would be nice if we could enforce that metadata.name matches the library path of the library, e.g. something like:

let code = code.into(); for export in code.as_library().exports() { let path = export.path(); if !path.as_str().starts_with(metadata.name()) { todo!("path {} does not start with {}", path.as_str(), metadata.name()) } }

This doesn't work exactly like that (because paths start with ::), but conceptually I think it could. I'm not sure if there's a real downside to enforcing this. I think it could be a nice benefit for DevX to see a component's name be x::y::z and be able to use the same path in code. For example, currently we have things like library_path = ::incr_nonce::auth_incr_nonce and metadata_name = miden::testing::incr_nonce_auth, which don't quite line up and this would enforce consistency.

I think it may make sense to do this after we have changed standard account component paths to be prefixed with miden::standards, e.g. from ::ecdsa_k256_keccak::auth_tx_ecdsa_k256_keccak to something like ::miden::standards::auth::ecdsa_k256_keccak. I have opened #2399 for this. Once we've done that, we could change the component names in one go.

Also, there may be cases where it makes sense for the name to be different, and I just can't think of it, so not really a strong opinion. Just wanted to bring it up.

Thanks for opening the issue! I think that makes sense

PhilippGackstatter · 2026-02-04T12:36:11Z

crates/miden-agglayer/src/lib.rs

 pub fn agglayer_faucet_component(storage_slots: Vec<StorageSlot>) -> AccountComponent {
    let library = agglayer_faucet_library();
+    let metadata = AccountComponentMetadata::new("agglayer::faucet")
+        .with_description("AggLayer faucet component with bridge validation")
+        .with_supports_all_types();


Not from this PR, but the agglayer faucet probably shouldn't support regular accounts? Iiuc, it should only support accounts of type fungible faucet.

I changed this to just be supported on faucets, (ccing @mmagician and @partylikeits1983 as a heads up)

PhilippGackstatter · 2026-02-04T12:42:59Z

crates/miden-standards/src/account/auth/ecdsa_k256_keccak_acl.rs

-        AccountComponent::new(ecdsa_k256_keccak_acl_library(), storage_slots)
-            .expect(
-                "ACL auth component should satisfy the requirements of a valid account component",
+        let metadata = AccountComponentMetadata::new("miden::auth::ecdsa_k256_keccak_acl")


I think it would make sense to make these names constants on their respective types, e.g.:

impl AuthEcdsaK256KeccakAcl { pub const NAME: &str = "miden::auth::ecdsa_k256_keccak_acl"; }

I think we might want to access the name from other contexts as well and this would easily allow for that, e.g. for #2399. It may also be useful when we implement an AccountComponentInterface trait that has a name method. Applies to all standard components.

Good point as well, changed

PhilippGackstatter · 2026-02-04T12:51:26Z

crates/miden-testing/src/kernel_tests/tx/mod.rs

+/// Creates a test metadata for account components that supports all account types.
+pub fn test_metadata(name: &str) -> AccountComponentMetadata {


Nit: Could this be AccountComponentMetadata::mock instead, defined somewhere in crates/miden-protocol/src/testing/? This would be more consistent with other such mock methods like NoteScript::mock, StorageSlotName::mock, AccountStorage::mock, etc.

I debated removing this altogether but kept it for now at least

…nto igamigo-enforce-metadata

…ename test consturctor to mock()

igamigo · 2026-02-04T21:43:59Z

All comments should be addressed so leaving it up in case @bobbinth wants to take a look

bobbinth

Looks good! Thank you!

bobbinth · 2026-02-05T08:05:48Z

crates/miden-protocol/src/account/component/mod.rs

nit: in other places we name this just metadata.

bobbinth

Looks good! Thank you! I left a couple of comments above - but we can also do them in a follow-up PR.

bobbinth · 2026-02-06T20:39:55Z

crates/miden-standards/src/account/faucets/basic_fungible.rs

+        let token_symbol_type =
+            SchemaTypeId::new("miden::standards::fungible_faucets::metadata::token_symbol")
+                .expect("valid");
+        let storage_schema = StorageSchema::new([(
+            BasicFungibleFaucet::metadata_slot().clone(),
+            StorageSlotSchema::value(
+                "Token metadata",
+                [
+                    FeltSchema::felt("token_supply").with_default(Felt::new(0)),
+                    FeltSchema::felt("max_supply"),
+                    FeltSchema::u8("decimals"),
+                    FeltSchema::new_typed(token_symbol_type, "symbol"),
+                ],
+            ),
+        )])
+        .expect("storage schema should be valid");


A couple of comments here:

It may be good to define miden::standards::fungible_faucets::metadata::token_symbol as a constant at the top of the file.

To improve readability, it may be good to create accessor methods that return the slot schema - something like BasicFungibleFaucet::metadata_slot_schema(). And then the cod here could look like:

let storage_schema = StorageSchema::new([ BasicFungibleFaucet::metadata_slot_schema(), ]) .expect("storage schema should be valid");

bobbinth · 2026-02-06T20:40:30Z

crates/miden-standards/src/account/auth/falcon_512_rpo_multisig.rs

+        let pub_key_type =
+            SchemaTypeId::new("miden::standards::auth::falcon512_rpo::pub_key").expect("valid");
+        let storage_schema = StorageSchema::new([
+            (
+                AuthFalcon512RpoMultisig::threshold_config_slot().clone(),
+                StorageSlotSchema::value(
+                    "Threshold configuration",


Same comment as above. And this is also applicable to other standard components.

…nto igamigo-enforce-metadata

bobbinth

All looks good! Thank you!

igamigo added 5 commits January 30, 2026 12:20

reviews: refactor file into multiple files, pass impl tryinto<> for name

4a6e844

refactor: parse mod

917dcb4

chore: merge

15580ca

reviews: fix changelog and remove derives in errors

54325e6

chore: merge

c609095

igamigo force-pushed the igamigo-enforce-metadata branch 2 times, most recently from f579a7d to 021d423 Compare February 3, 2026 20:08

refactor: enforce component metadata in account component

7358008

igamigo force-pushed the igamigo-enforce-metadata branch from 53c8f94 to 7358008 Compare February 3, 2026 20:11

igamigo commented Feb 3, 2026

View reviewed changes

igamigo marked this pull request as ready for review February 3, 2026 20:25

igamigo requested review from PhilippGackstatter and bobbinth and removed request for bobbinth February 3, 2026 20:34

PhilippGackstatter mentioned this pull request Feb 4, 2026

Prefix standard account components with miden::standards #2399

Closed

PhilippGackstatter approved these changes Feb 4, 2026

View reviewed changes

Base automatically changed from igamigo-init-refactor-followups to next February 4, 2026 14:19

igamigo added 2 commits February 4, 2026 18:19

Merge branch 'next' of https://github.com/0xPolygonMiden/miden-base i…

73619ad

…nto igamigo-enforce-metadata

reviews: only fungible faucet for agglayer faucet, component names, r…

0863f17

…ename test consturctor to mock()

bobbinth approved these changes Feb 5, 2026

View reviewed changes

crates/miden-protocol/src/account/component/mod.rs Outdated

Copy link
Copy Markdown

Contributor

bobbinth Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: in other places we name this just metadata.

PhilippGackstatter mentioned this pull request Feb 5, 2026

feat(standards): prefix account components with miden::standards namespace #2400

Merged

Merge branch 'next' into igamigo-enforce-metadata

7c694e8

bobbinth approved these changes Feb 6, 2026

View reviewed changes

igamigo added 4 commits February 6, 2026 17:41

chore: rename var

eb32fd4

feat: component schema

338af96

chore: ergonomics

9d4e708

Merge branch 'next' of https://github.com/0xPolygonMiden/miden-base i…

d40b962

…nto igamigo-enforce-metadata

igamigo force-pushed the igamigo-enforce-metadata branch from b33dbe4 to d40b962 Compare February 6, 2026 20:45

reviews: literals and functions

2f10491

bobbinth approved these changes Feb 6, 2026

View reviewed changes

bobbinth merged commit 33aff09 into next Feb 6, 2026
17 checks passed

bobbinth deleted the igamigo-enforce-metadata branch February 6, 2026 22:45

afa7789 pushed a commit to afa7789/miden-base that referenced this pull request Mar 9, 2026

refactor: enforce component metadata in account component (0xMiden#2373)

aa115d5

		/// Creates a test metadata for account components that supports all account types.
		pub fn test_metadata(name: &str) -> AccountComponentMetadata {

Conversation

igamigo commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

PhilippGackstatter 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!

igamigo commented Feb 4, 2026

Uh oh!

bobbinth left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bobbinth 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!

bobbinth left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

igamigo commented Jan 30, 2026 •

edited

Loading