masm-proc-type-signatures

name	masm-proc-type-signatures
description	Enforce type-signature conventions for public Miden Assembly (.masm) procedures. Use when adding, editing, or reviewing a `pub proc` signature — parameter and return types, semantic type aliases, struct/array/tuple types, and how the signature maps onto the operand stack and the doc-comment Inputs/Outputs.

MASM Procedure Type Signatures

Overview

Public MASM procedures carry a type signature on the pub proc line, mirroring the Rust API:

pub proc get_map_item(slot_id: StorageSlotId, key: StorageMapKey) -> word

The signature names each stack input as a typed parameter and declares the return type, using semantic aliases (AccountId, NoteRecipient, AssetAmount, …) named after the corresponding Rust types. It is ABI/AST metadata only: adding or changing a signature does not change the procedure's behavior, its MAST root, or the transaction-kernel commitment. The signature complements — it does not replace — the doc-comment Inputs: / Outputs: stack notation.

Syntax

The signature attaches to the procedure name, after any @-attributes and after the doc comment:

#! ...doc comment...
#!
#! Invocation: exec
pub proc name(param_a: TypeA, param_b: TypeB) -> ReturnType
    ...
end

• No parameters: keep the empty parens — pub proc get_nonce() -> felt.
• No return value: omit the arrow — pub proc mint(asset: Asset).
• Multiple return values: a tuple — pub proc find_attachment(attachment_scheme: u16) -> (Bool, u8).
• Long signatures may wrap across lines: