0xMiden/agent-tools

advice-provider-hygiene

Use when writing kernel, account, or note MASM code that reads from or writes to the advice provider (advice stack / advice map) — validate advice data.

لغة النص الأصلي: الإنجليزية

cheap-masm-equivalents

Use when writing or reviewing MASM hot paths — prefer the cheaper equivalent instruction: `neq.0` over `push.0 gt` for non-zero checks, `cdrop` over an `if/else` selecting between two values, `dup.N` over `loc_load` for a value still on the stack, `eqw` over…

لغة النص الأصلي: الإنجليزية

decouple-component-from-storage

Use when writing a GENERIC MASM storage utility (one that operates over a caller-chosen slot or map) inside a reusable account component — receive the slot id as a parameter so the utility works against any slot, not one hard-coded one.

لغة النص الأصلي: الإنجليزية

felt-construction

Use when constructing a `Felt` from a numeric value in Rust — avoid silently producing a non-canonical Felt that no longer equals the original input.

لغة النص الأصلي: الإنجليزية

frontend-pitfalls

Critical pitfalls and safety rules for Miden frontend development. Covers WASM initialization, concurrent access crashes, COOP/COEP headers, BigInt handling, Bech32 network mismatches, IndexedDB state loss, auto-sync side effects, Vite configuration, and…

لغة النص الأصلي: الإنجليزية

frontend-source-guide

Guide for advanced Miden frontend development using source repo exploration. Covers AI development practices (Plan Mode, verification-driven development, context engineering, sub-agents) and maps the Miden web-sdk source repository for discovering advanced…

لغة النص الأصلي: الإنجليزية

idxdb-patterns

Enforce conventions for the IndexedDB/Dexie persistence layer of the Miden web client, which lives in the web-sdk repo (idxdb-store crate). Use when editing TypeScript in `crates/idxdb-store/src/ts/`, writing Dexie transactions, or modifying the database…

لغة النص الأصلي: الإنجليزية

local-node-validation

Validates Miden contracts against a local node. Covers node setup, Rust binary adaptation, state verification, and troubleshooting. Use after MockChain tests pass to verify contracts work against a real node.

لغة النص الأصلي: الإنجليزية

masm-constants

Enforce constant definition and organization conventions for Miden Assembly (.masm) files. Use when editing, reviewing, or creating .masm files that define or use constants.

لغة النص الأصلي: الإنجليزية

masm-doc-comments

Enforce doc comment conventions for Miden Assembly (.masm) procedures. Use when editing, reviewing, or creating .masm procedures, especially when documenting inputs, outputs, panic conditions, or invocation types.

لغة النص الأصلي: الإنجليزية

masm-error-constants

Use when adding or editing MASM `assert*` instructions — give every assertion a descriptive error (a named `ERR_*` constant or an inline string).

لغة النص الأصلي: الإنجليزية

masm-explicit-stack-inputs

Use when defining the interface for a new MASM procedure — keep its inputs explicit on the stack so the signature reflects what it consumes.

لغة النص الأصلي: الإنجليزية

masm-file-structure

Enforce file structure and section ordering for Miden Assembly (.masm) files. Use when editing, reviewing, or creating .masm files.

لغة النص الأصلي: الإنجليزية

masm-formatting

Orchestrator for MASM formatting in 0xMiden/protocol and 0xMiden/miden-vm. Consolidates capitalization, the (N) span family, cross-repo doc comment divergences (plural vs singular Inputs/Outputs, Panics if vs

لغة النص الأصلي: الإنجليزية

masm-inline-comments

Enforce inline commenting conventions for Miden Assembly (.masm) files. Use when editing, reviewing, or creating .masm files.

لغة النص الأصلي: الإنجليزية

masm-locals-over-globals

Use when a MASM procedure needs temporary scratch storage — keep it in procedure-local memory so it cannot collide in a shared global region.

لغة النص الأصلي: الإنجليزية

masm-padding

Enforce stack padding conventions for Miden Assembly (.masm) procedures based on invocation type. Use when editing, reviewing, or creating .masm procedures, especially those with Invocation annotations.

لغة النص الأصلي: الإنجليزية

masm-rust-constant-parity

Use when changing a numeric or string constant in Rust or MASM that has a counterpart on the other side — keep the two definitions from drifting apart.

لغة النص الأصلي: الإنجليزية

miden-concepts

Miden architecture and core concepts from a developer perspective. Covers the actor model, accounts, notes, transactions, assets, privacy model, and standard patterns. Use when designing Miden applications or understanding how Miden differs from traditional…

لغة النص الأصلي: الإنجليزية

react-sdk-patterns

Complete guide to building Miden frontends with @miden-sdk/react hooks. Covers MidenProvider setup, all query hooks (useAccounts, useAccount, useNotes, useSyncState, useAssetMetadata), all mutation hooks (useCreateWallet, useSend, useMultiSend, useMint,…

لغة النص الأصلي: الإنجليزية

rust-client-patterns

Enforce coding conventions for the miden-client Rust codebase (rust-client, sqlite-store). Use when editing, reviewing, or creating Rust code in the miden-client workspace — covers error handling, Store trait methods, the Client<AUTH> generic, the Keystore…

لغة النص الأصلي: الإنجليزية

rust-sdk-patterns

Complete guide to writing Miden smart contracts with the Rust SDK. Covers the three-part

لغة النص الأصلي: الإنجليزية

rust-sdk-pitfalls

Critical pitfalls and safety rules for Miden Rust SDK development. Covers felt arithmetic security, comparison operators, argument limits, storage naming, no-std setup, asset layout, P2ID roots, NoteType construction, note-to-component call boundaries, and…

لغة النص الأصلي: الإنجليزية

rust-sdk-source-guide

Guide for advanced Miden smart contract development using source repo exploration. Covers AI development practices (Plan Mode, verification-driven development, context engineering, sub-agents) and maps Miden source repositories for discovering advanced…

لغة النص الأصلي: الإنجليزية

rust-sdk-testing-patterns

Guide to testing Miden smart contracts with MockChain (Miden v0.15). Covers test setup, contract building, account/note creation, transaction execution, storage verification, faucet setup, output note verification, block numbering, multi-transaction tests,…

لغة النص الأصلي: الإنجليزية

signer-integration

Guide to integrating external signers (Para, Turnkey, MidenFi wallet adapter) and building custom signers for Miden React frontends. Covers provider setup, passkey authentication, unified signer interface, custom SignerContext implementation, and custom…

لغة النص الأصلي: الإنجليزية

testing-patterns

Testing conventions, mock factory, fixtures, and TDD workflow for Miden frontend development. Covers Vitest + testing-library setup, @miden-sdk/react module mocking, realistic fixture data, test patterns for query and mutation hooks, and the automated…

لغة النص الأصلي: الإنجليزية

u32-assert-before-u32-ops

Use when writing MASM `u32*` instructions on values from user input or untrusted sources — ensure the operands are valid u32s first.

لغة النص الأصلي: الإنجليزية

vite-wasm-setup

Guide to configuring Vite for Miden WASM applications. Covers the midenVitePlugin() setup, COOP/COEP headers, production deployment headers, TypeScript compatibility, and troubleshooting common Vite + WASM issues. Use when setting up a new Miden frontend,…

لغة النص الأصلي: الإنجليزية

wasm-bridge

Enforce conventions for the Rust<->JavaScript WASM boundary in the web-sdk repo (crate miden-client-web at crates/web-client, split out of miden-client). Use when exposing Rust methods to JS via the

لغة النص الأصلي: الإنجليزية

web-client-usage

Conventions for writing JavaScript/TypeScript code that uses the Miden web SDK (`@miden-sdk/miden-sdk`). Use when building apps on Miden, writing integration tests, or calling MidenClient methods — covers initialization, the resource-based API (accounts,…

لغة النص الأصلي: الإنجليزية