Skip to content

Document v0.14 asset encoding in core-concepts/protocol/asset.md #270

@BrianSeong99

Description

@BrianSeong99

Not a protocol bug — the v0.14 asset encoding works as expected. The docs just don't define the canonical layout anywhere readable, so the Zoro team had to dig through Rust source to figure it out (context).

Add an "Asset encoding" section to docs/core-concepts/protocol/asset.md covering:

  • The ASSET_KEY / ASSET_VALUE layout for fungible and non-fungible assets.
  • When asset_id_* is zero (fungible) vs. taken from DATA_HASH[0..2] (non-fungible).
  • The metadata low-byte on faucet_id_suffix and how AssetCallbackFlag packs into it.

Source of truth: AssetVaultKey::to_word() in miden-protocol/src/asset/vault/vault_key.rs.

While in flight:

  • Fix docs/core-concepts/protocol/protocol_library.md:168create_non_fungible_asset stdlib helper is missing the enable_callbacks flag in its Inputs row. Should mirror the fungible helper one row above.
  • docs/builder/migration/05-asset-vault-faucet.md can keep its summary; just link out to the new asset.md section instead of redefining field semantics inline.

Mirror all changes in versioned_docs/version-0.14/.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions