@miden-sdk/miden-sdk 0.15.6 → 0.16.0-alpha.1

package/dist/mt/api-types.d.ts

@@ -26,16 +26,13 @@ import type {
   NoteExportFormat,
   StorageSlot,
   AccountComponent,
+  Library,
   AuthSecretKey,
   AccountStorageRequirements,
   TransactionScript,
   NoteScript,
-  NoteRecipient,
-  NoteExecutionHint,
-  NetworkAccountTarget,
   AdviceInputs,
   FeltArray,
-  PswapLineageRecord,
 } from "./crates/miden_client_web.js";
 
 // Import the full namespace for the MidenArrayConstructors type
@@ -190,8 +187,6 @@ export interface ClientOptions {
   storeName?: string;
   /** Sync state on creation (default: false). */
   autoSync?: boolean;
-  /** Enable debug mode for transaction execution (default: false). */
-  debugMode?: boolean;
   /** External keystore callbacks. */
   keystore?: {
     getKey: GetKeyCallback;
@@ -360,48 +355,6 @@ export interface SendResult {
   result: TransactionResult;
 }
 
-/**
- * Options for {@link TransactionsResource.createNetworkNote} and the standalone
- * {@link buildNetworkNote}. Builds a Public, custom-script note carrying a
- * `NetworkAccountTarget` attachment so a public network account auto-consumes it.
- *
- * Provide exactly one of `recipient` or `script`.
- */
-export interface NetworkNoteOptions extends TransactionOptions {
-  /** Account that creates, funds, and submits the note (the executing sender). */
-  account: AccountRef;
-  /**
-   * The network account the note targets. Any account reference, or a pre-built
-   * `NetworkAccountTarget`. Encoded as the note's `NetworkAccountTarget`
-   * attachment — this is what makes `isNetworkNote()` true.
-   */
-  target: AccountRef | NetworkAccountTarget;
-  /** Execution hint when `target` is an account reference. Defaults to `always`. */
-  executionHint?: NoteExecutionHint;
-  /**
-   * Recipient carrying the note's custom consumption script. Build with
-   * `new NoteRecipient(serialNum, noteScript, noteStorage)`, or omit and pass
-   * `script` to have the recipient built for you.
-   */
-  recipient?: NoteRecipient;
-  /** Custom consumption script; the recipient is built with a fresh serial number. */
-  script?: NoteScript;
-  /** Note storage / inputs the script reads (used with `script`). */
-  inputs?: bigint[];
-  /** Assets locked into the note. Optional — a note may carry no assets. */
-  assets?: Asset | Asset[];
-  /** Extra attachment payload appended AFTER the required `NetworkAccountTarget`. */
-  attachment?: bigint[];
-}
-
-/** Result of {@link TransactionsResource.createNetworkNote}. */
-export interface NetworkNoteResult {
-  txId: TransactionId;
-  /** The built network note (read its id / attachments). */
-  note: Note;
-  result: TransactionResult;
-}
-
 /** Result of methods that previously returned bare TransactionId. */
 export interface TransactionSubmitResult {
   txId: TransactionId;
@@ -419,21 +372,6 @@ export interface MintOptions extends TransactionOptions {
   type?: NoteVisibility;
 }
 
-export interface BridgeOptions extends TransactionOptions {
-  /** Account that creates and funds the bridge note (the sender / executing account). */
-  account: AccountRef;
-  /** Bridge account that consumes the note and burns the bridged asset. */
-  bridgeAccount: AccountRef;
-  /** Faucet / token ID of the fungible asset to bridge. */
-  token: AccountRef;
-  /** Amount of the asset to bridge. */
-  amount: number | bigint;
-  /** AggLayer-assigned network ID of the destination chain. */
-  destinationNetwork: number;
-  /** Destination Ethereum address on the destination network (0x-prefixed hex). */
-  destinationAddress: string;
-}
-
 export interface ConsumeOptions extends TransactionOptions {
   account: AccountRef;
   notes: NoteInput | NoteInput[];
@@ -444,73 +382,6 @@ export interface ConsumeAllOptions extends TransactionOptions {
   maxNotes?: number;
 }
 
-/**
- * A single operation inside a transaction batch. The shape mirrors the
- * singular options types (`SendOptions`, `MintOptions`, ...) minus the
- * `account` field — the executing account is set once at the batch level
- * and shared by every operation (V1 single-account constraint).
- */
-export type BatchOperation =
-  | {
-      kind: "send";
-      to: AccountRef;
-      token: AccountRef;
-      amount: number | bigint;
-      type?: NoteVisibility;
-      reclaimAfter?: number;
-      timelockUntil?: number;
-    }
-  | {
-      kind: "mint";
-      to: AccountRef;
-      amount: number | bigint;
-      type?: NoteVisibility;
-    }
-  | {
-      kind: "consume";
-      notes: NoteInput | NoteInput[];
-    }
-  | {
-      kind: "swap";
-      offer: Asset;
-      request: Asset;
-      type?: NoteVisibility;
-      paybackType?: NoteVisibility;
-    }
-  | {
-      kind: "execute";
-      script: TransactionScript;
-      foreignAccounts?: (
-        | AccountRef
-        | { id: AccountRef; storage?: AccountStorageRequirements }
-      )[];
-    }
-  | {
-      /** Escape hatch for pre-built TransactionRequests. */
-      kind: "custom";
-      request: TransactionRequest;
-    };
-
-export interface BatchOptions {
-  /** The account executing every operation in the batch (single-account in V1). */
-  account: AccountRef;
-  /** Operations to execute atomically as a batch. Must be non-empty. */
-  operations: BatchOperation[];
-  /**
-   * Wait until the batch's block has been observed in the local sync height.
-   * Differs from singular `waitForConfirmation`: the V1 batch API returns
-   * only a block number, so we poll chain height rather than per-tx status.
-   */
-  waitForConfirmation?: boolean;
-  /** Wall-clock polling timeout for `waitForConfirmation` (default 60_000ms). */
-  timeout?: number;
-}
-
-export interface BatchSubmitResult {
-  /** The block number the batch was accepted into. */
-  blockNumber: number;
-}
-
 export interface SwapOptions extends TransactionOptions {
   account: AccountRef;
   offer: Asset;
@@ -554,18 +425,6 @@ export interface PswapCancelOptions extends TransactionOptions {
   note: NoteInput;
 }
 
-export interface PswapCancelByOrderOptions extends TransactionOptions {
-  /**
-   * Stable order id of the lineage to cancel, as reported by
-   * {@link PswapLineageRecord.orderId}. Accepts the decimal string or a
-   * `bigint`. `number` is rejected: a PSWAP order id is `u64`-shaped and
-   * routinely exceeds `Number.MAX_SAFE_INTEGER`, which a JS `number` cannot
-   * represent without silent precision loss. The creator account and current
-   * tip note are resolved from the tracked lineage.
-   */
-  orderId: string | bigint;
-}
-
 export interface ExecuteOptions extends TransactionOptions {
   /** Account executing the custom script. */
   account: AccountRef;
@@ -611,16 +470,6 @@ export interface PreviewMintOptions {
   type?: NoteVisibility;
 }
 
-export interface PreviewBridgeOptions {
-  operation: "bridge";
-  account: AccountRef;
-  bridgeAccount: AccountRef;
-  token: AccountRef;
-  amount: number | bigint;
-  destinationNetwork: number;
-  destinationAddress: string;
-}
-
 export interface PreviewConsumeOptions {
   operation: "consume";
   account: AccountRef;
@@ -668,7 +517,6 @@ export interface PreviewCustomOptions {
 export type PreviewOptions =
   | PreviewSendOptions
   | PreviewMintOptions
-  | PreviewBridgeOptions
   | PreviewConsumeOptions
   | PreviewSwapOptions
   | PreviewPswapCreateOptions
@@ -724,7 +572,7 @@ export type NoteQuery =
 export interface NoteOptions {
   from: AccountRef;
   to: AccountRef;
-  assets: Asset | Asset[];
+  assets: Asset | [Asset, ...Asset[]];
   type?: NoteVisibility;
   attachment?: Felt[];
 }
@@ -868,22 +716,6 @@ export interface TransactionsResource {
    * @param options - Mint options including the faucet, recipient, and amount.
    */
   mint(options: MintOptions): Promise<TransactionSubmitResult>;
-  /**
-   * Builds a Public custom-script note carrying a `NetworkAccountTarget`
-   * attachment, submits it as an own output note, and (optionally) waits for
-   * confirmation. The submitted note satisfies `Note.isNetworkNote()`, so a
-   * public network account will auto-consume it.
-   */
-  createNetworkNote(options: NetworkNoteOptions): Promise<NetworkNoteResult>;
-  /**
-   * Bridge a fungible asset out to another network via the AggLayer. Emits a
-   * single public B2AGG (Bridge-to-AggLayer) note that the bridge account
-   * consumes, burning the asset so it can be claimed at the destination
-   * Ethereum address on the destination network.
-   *
-   * @param options - Sender, bridge account, token, amount, and destination.
-   */
-  bridge(options: BridgeOptions): Promise<TransactionSubmitResult>;
   /**
    * Consume one or more notes for an account.
    *
@@ -936,8 +768,18 @@ export interface TransactionsResource {
   execute(options: ExecuteOptions): Promise<TransactionSubmitResult>;
 
   /**
-   * Dry-run a transaction to preview its effects without submitting it to
-   * the network.
+   * Dry-run a transaction to obtain the {@link TransactionSummary} the
+   * account is being asked to authorize, without submitting anything to the
+   * network.
+   *
+   * The summary only exists while authorization is pending: it is returned
+   * when the account's auth procedure aborts with the unauthorized event
+   * (e.g. a multisig below its signing threshold), so it can be signed
+   * out-of-band. If the transaction is already fully authorized, execution
+   * succeeds without producing a summary and this method rejects with an
+   * error whose `code` is `"TRANSACTION_ALREADY_AUTHORIZED"` (on Node.js the
+   * code prefixes the error message instead) — submit the transaction with
+   * `execute` instead.
    *
    * @param options - Preview options discriminated by `operation` field.
    */
@@ -957,34 +799,6 @@ export interface TransactionsResource {
     options?: TransactionOptions
   ): Promise<TransactionSubmitResult>;
 
-  /**
-   * Execute a heterogeneous batch of operations against a single account.
-   * Each operation is built, proven individually and as a batch, and all
-   * operations are submitted atomically — either every tx in the batch
-   * lands or none does.
-   *
-   * V1 supports only same-account batches (mirrors the underlying Rust
-   * `Client::new_transaction_batch()` constraint).
-   *
-   * @param options - Batch options including the account and operations.
-   */
-  batch(options: BatchOptions): Promise<BatchSubmitResult>;
-
-  /**
-   * Submit pre-built TransactionRequests as an atomic batch. Plural
-   * counterpart of {@link submit} — for callers that already have built
-   * requests in hand and want to skip the high-level operation builders.
-   *
-   * @param account - The account executing every transaction in the batch.
-   * @param requests - Pre-built transaction requests (must be non-empty).
-   * @param options - Optional batch settings (waitForConfirmation, timeout, prover).
-   */
-  submitBatch(
-    account: AccountRef,
-    requests: TransactionRequest[],
-    options?: Omit<BatchOptions, "account" | "operations">
-  ): Promise<BatchSubmitResult>;
-
   /** Execute a program (view call) and return the resulting stack output. */
   executeProgram(options: ExecuteProgramOptions): Promise<FeltArray>;
 
@@ -1005,46 +819,6 @@ export interface TransactionsResource {
   waitFor(txId: string | TransactionId, options?: WaitOptions): Promise<void>;
 }
 
-export interface PswapResource {
-  /**
-   * Returns every partial-swap (PSWAP) lineage tracked by this client. A
-   * lineage records how a PSWAP note has been filled round by round, from the
-   * original note through each remainder to the current tip.
-   */
-  lineages(): Promise<PswapLineageRecord[]>;
-  /**
-   * Returns the PSWAP lineages created by a specific local account.
-   *
-   * @param account - Creator account (hex, bech32, `Account`, or `AccountId`).
-   */
-  lineagesFor(account: AccountRef): Promise<PswapLineageRecord[]>;
-  /**
-   * Returns the lineage for a single order, or `null` if this client is not
-   * tracking it — either because the order was not created by this client, or
-   * because tracking did not register when it was created. Registration runs as
-   * a transaction observer at create time and does not block the create
-   * transaction if it fails.
-   *
-   * @param orderId - Stable order id (decimal string or bigint). `number` is
-   *   rejected: a PSWAP order id is `u64`-shaped and routinely exceeds
-   *   `Number.MAX_SAFE_INTEGER`, which a JS `number` cannot represent without
-   *   silent precision loss.
-   */
-  lineage(orderId: string | bigint): Promise<PswapLineageRecord | null>;
-  /**
-   * Reclaim the unfilled offered asset on the current tip of an active
-   * lineage, identified by its stable order id. Builds the cancel transaction,
-   * resolves the creator account from the tracked lineage, and submits it
-   * through the same prove/submit path as the other transaction helpers.
-   * Throws if no lineage is tracked for the order.
-   *
-   * @param options - Order id and optional transaction options.
-   */
-  cancelByOrder(
-    options: PswapCancelByOrderOptions
-  ): Promise<TransactionSubmitResult>;
-}
-
 export interface NotesResource {
   /**
    * List received (input) notes, optionally filtered by status or IDs.
@@ -1113,6 +887,11 @@ export interface NotesResource {
 export interface CompileComponentOptions {
   /** MASM source code for the component. */
   code: string;
+  /**
+   * Module path used to derive procedure identities. Use the same namespace when
+   * linking this component into transaction scripts.
+   */
+  namespace?: string;
   /** Initial storage slots for the component. */
   slots?: StorageSlot[];
   /**
@@ -1139,18 +918,35 @@ export interface CompileTxScriptLibrary {
   linking?: Linking;
 }
 
+/** Links the exact compiled code installed by an account component. */
+export interface CompileAccountComponentLibrary {
+  /** Account component whose installed code should be linked. */
+  component: AccountComponent;
+  /**
+   * `Linking.Dynamic` (default) — procedures are linked via DYNCALL at runtime.
+   * `Linking.Static` — procedures are inlined at compile time.
+   */
+  linking?: Linking;
+}
+
+/** A script library supplied inline, pre-built, or from an installed account component. */
+export type CompileScriptLibrary =
+  | CompileTxScriptLibrary
+  | CompileAccountComponentLibrary
+  | Library;
+
 export interface CompileTxScriptOptions {
   /** MASM source code for the transaction script. */
   code: string;
   /** Component libraries to link. */
-  libraries?: CompileTxScriptLibrary[];
+  libraries?: CompileScriptLibrary[];
 }
 
 export interface CompileNoteScriptOptions {
   /** MASM source code for the note script. */
   code: string;
   /** Component libraries to link. */
-  libraries?: CompileTxScriptLibrary[];
+  libraries?: CompileScriptLibrary[];
 }
 
 export declare class CompilerResource {
@@ -1281,7 +1077,6 @@ export declare class MidenClient {
   readonly settings: SettingsResource;
   readonly compile: CompilerResource;
   readonly keystore: KeystoreResource;
-  readonly pswap: PswapResource;
 
   /** Syncs the client: fetches private notes from the Note Transport Layer, then syncs on-chain state. Fails fast on either. */
   sync(): Promise<SyncSummary>;
@@ -1355,13 +1150,6 @@ export declare function createP2IDENote(
   options: P2IDEOptions
 ): ReturnType<WasmModule["Note"]["createP2IDENote"]>;
 
-/**
- * Builds (without submitting) a Public custom-script note carrying a
- * `NetworkAccountTarget` attachment. Provide exactly one of `recipient` or
- * `script`.
- */
-export declare function buildNetworkNote(opts: NetworkNoteOptions): Note;
-
 /** Builds a swap tag for note matching. Returns a NoteTag (use `.asU32()` for the numeric value). */
 export declare function buildSwapTag(
   options: BuildSwapTagOptions