0xMiden / 0xMiden/docs

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

Offen Anfängerfreundlich
#270 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
documentation
Vorherrschende Sprache
TypeScript
Sterne
10
Forks
50
Ø Merge
22 T. 23 Std.
Gemergte PRs (30 T.)
1

Beschreibung

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](https://github.com/0xMiden/protocol/issues/2844)).

**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:168` — `create_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/`.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginnen Sie mit dem Lesen der bestehenden `docs/core-concepts/protocol/asset.md`, um den Kontext zu verstehen. Untersuchen Sie die maßgebliche Quelle in `miden-protocol/src/asset/vault/vault_key.rs` bei der Funktion `AssetVaultKey::to_word()`, um das Kodierungslayout zu lernen. Aktualisieren Sie die Dokumentation mit den angegebenen Abschnitten und korrigieren Sie auch die Dateien `protocol_library.md` und `05-asset-vault-faucet.md` wie angegeben. Stellen Sie sicher, dass alle Änderungen im Verzeichnis `versioned_docs/version-0.14/` gespiegelt werden. Führen Sie einen lokalen Dokumentations-Build aus, um die Formatierung zu überprüfen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
rust, typescript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Aktiv
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
75/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.