Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements to AccountComponentMetadata #1050

Open
igamigo opened this issue Jan 8, 2025 · 0 comments
Open

Improvements to AccountComponentMetadata #1050

igamigo opened this issue Jan 8, 2025 · 0 comments

Comments

@igamigo
Copy link
Collaborator

igamigo commented Jan 8, 2025

Currently, the AccountComponentMetadata contains the following fields:

pub struct AccountComponentMetadata {
    /// The human-readable name of the component.
    name: String,
    /// A brief description of what this component is and how it works.
    description: String,
    /// The semantic version of the component.
    /// This can be used to track and manage component upgrades.
    version: Version,
    /// A set of supported target account types for this component.
    targets: BTreeSet<AccountType>,
    /// A list of storage entries defining the component's storage layout and initialization
    /// values.
    storage: Vec<StorageEntry>,
}

This struct can be serialized to and deserialized from TOML files.

There are some things that we could add to make this more useful, specially in the context of other systems "outside" of the protocol itself, like component registries.

As suggested during the PR review, some of these could build toward something like what the Rust ecosystem does (one can think of links to documentation, authors, categories, etc.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant