@miden-sdk/miden-sdk 0.15.0-alpha.4 → 0.15.0-alpha.5

package/dist/st/docs-entry.d.ts

@@ -0,0 +1,38 @@
+/**
+ * TypeDoc entry point — curated subset of the public API.
+ * Only types listed here (or transitively referenced) appear in generated docs.
+ * Runtime consumers should import from index.d.ts, not this file.
+ */
+
+// Curated WASM re-exports: only types referenced in the public API
+export {
+  Account,
+  AccountCode,
+  AccountFile,
+  AccountHeader,
+  AccountId,
+  AccountStorage,
+  AssetVault,
+  Felt,
+  InputNoteRecord,
+  Note,
+  NoteExportFormat,
+  NoteFile,
+  NoteId,
+  NoteTag,
+  RawOutputNote,
+  OutputNoteRecord,
+  SyncSummary,
+  TransactionId,
+  TransactionProver,
+  TransactionRecord,
+  TransactionRequest,
+  TransactionSummary,
+  Word,
+} from "./crates/miden_client_web.js";
+
+// All simplified API types
+export * from "./api-types.js";
+
+// Storage utilities
+export { StorageView, StorageResult, wordToBigInt } from "./index.js";

package/dist/{eager.js → st/eager.js}

@@ -1,6 +1,6 @@
 import { getWasmOrThrow } from './index.js';
 export { AccountType, AuthScheme, CompilerResource, Linking, MidenArrays, MidenClient, MockWasmWebClient, MockWasmWebClient as MockWebClient, NoteVisibility, StorageMode, StorageResult, StorageView, WasmWebClient, buildSwapTag, createP2IDENote, createP2IDNote, wordToBigInt } from './index.js';
-export { Account, AccountArray, AccountBuilder, AccountBuilderResult, AccountCode, AccountComponent, AccountComponentCode, AccountDelta, AccountFile, AccountHeader, AccountId, AccountIdArray, AccountInterface, AccountProof, AccountReader, AccountStatus, AccountStorage, AccountStorageDelta, AccountStorageMode, AccountStorageRequirements, AccountVaultDelta, Address, AdviceInputs, AdviceMap, AssetVault, AuthFalcon512RpoMultisigConfig, AuthSecretKey, BasicFungibleFaucetComponent, BlockHeader, CodeBuilder, CommittedNote, ConsumableNoteRecord, Endpoint, ExecutedTransaction, Felt, FeltArray, FetchedAccount, FetchedNote, FlattenedU8Vec, ForeignAccount, ForeignAccountArray, FungibleAsset, FungibleAssetDelta, FungibleAssetDeltaItem, GetProceduresResultItem, InputNote, InputNoteRecord, InputNoteState, InputNotes, IntoUnderlyingByteSource, IntoUnderlyingSink, IntoUnderlyingSource, JsAccountUpdate, JsStateSyncUpdate, JsStorageMapEntry, JsStorageSlot, JsVaultAsset, Library, MerklePath, NetworkId, NetworkNoteStatusInfo, NetworkType, Note, NoteAndArgs, NoteAndArgsArray, NoteArray, NoteAssets, NoteAttachment, NoteAttachmentKind, NoteAttachmentScheme, NoteConsumability, NoteConsumptionStatus, NoteDetails, NoteDetailsAndTag, NoteDetailsAndTagArray, NoteExecutionHint, NoteExportFormat, NoteFile, NoteFilter, NoteFilterTypes, NoteHeader, NoteId, NoteIdAndArgs, NoteIdAndArgsArray, NoteInclusionProof, NoteLocation, NoteMetadata, NoteRecipient, NoteRecipientArray, NoteScript, NoteStorage, NoteSyncBlock, NoteSyncInfo, NoteTag, NoteType, OutputNote, OutputNoteArray, OutputNoteRecord, OutputNoteState, OutputNotes, Package, PartialNote, Poseidon2, ProcedureThreshold, Program, ProvenTransaction, PublicKey, RpcClient, Rpo256, SerializedInputNoteData, SerializedOutputNoteData, SerializedTransactionData, Signature, SigningInputs, SigningInputsType, SlotAndKeys, SparseMerklePath, StorageMap, StorageMapEntry, StorageMapEntryJs, StorageMapInfo, StorageMapUpdate, StorageSlot, StorageSlotArray, SyncSummary, TestUtils, TokenSymbol, TransactionArgs, TransactionFilter, TransactionId, TransactionProver, TransactionRecord, TransactionRequest, TransactionRequestBuilder, TransactionResult, TransactionScript, TransactionScriptInputPair, TransactionScriptInputPairArray, TransactionStatus, TransactionStoreUpdate, TransactionSummary, WebClient, WebKeystoreApi, Word, createAuthFalcon512RpoMultisig, exportStore, importStore, initSync, setupLogging } from './Cargo-CVlXCH_2.js';
+export { Account, AccountArray, AccountBuilder, AccountBuilderResult, AccountCode, AccountComponent, AccountComponentCode, AccountDelta, AccountFile, AccountHeader, AccountId, AccountIdArray, AccountInterface, AccountProof, AccountReader, AccountStatus, AccountStorage, AccountStorageDelta, AccountStorageMode, AccountStorageRequirements, AccountVaultDelta, Address, AdviceInputs, AdviceMap, AssetVault, AuthFalcon512RpoMultisigConfig, AuthSecretKey, BasicFungibleFaucetComponent, BlockHeader, CodeBuilder, CommittedNote, ConsumableNoteRecord, Endpoint, ExecutedTransaction, Felt, FeltArray, FetchedAccount, FetchedNote, FlattenedU8Vec, ForeignAccount, ForeignAccountArray, FungibleAsset, FungibleAssetDelta, FungibleAssetDeltaItem, GetProceduresResultItem, InputNote, InputNoteRecord, InputNoteState, InputNotes, IntoUnderlyingByteSource, IntoUnderlyingSink, IntoUnderlyingSource, JsAccountUpdate, JsStateSyncUpdate, JsStorageMapEntry, JsStorageSlot, JsVaultAsset, Library, MerklePath, NetworkId, NetworkNoteStatusInfo, NetworkType, Note, NoteAndArgs, NoteAndArgsArray, NoteArray, NoteAssets, NoteAttachment, NoteAttachmentScheme, NoteConsumability, NoteConsumptionStatus, NoteDetails, NoteDetailsAndTag, NoteDetailsAndTagArray, NoteExecutionHint, NoteExportFormat, NoteFile, NoteFilter, NoteFilterTypes, NoteHeader, NoteId, NoteIdAndArgs, NoteIdAndArgsArray, NoteInclusionProof, NoteLocation, NoteMetadata, NoteRecipient, NoteRecipientArray, NoteScript, NoteStorage, NoteSyncBlock, NoteSyncInfo, NoteTag, NoteType, OutputNote, OutputNoteArray, OutputNoteRecord, OutputNoteState, OutputNotes, Package, PartialNote, Poseidon2, ProcedureThreshold, Program, ProvenTransaction, PublicKey, RpcClient, Rpo256, SerializedInputNoteData, SerializedOutputNoteData, SerializedTransactionData, Signature, SigningInputs, SigningInputsType, SlotAndKeys, SparseMerklePath, StorageMap, StorageMapEntry, StorageMapEntryJs, StorageMapInfo, StorageMapUpdate, StorageSlot, StorageSlotArray, SyncSummary, TestUtils, TokenSymbol, TransactionArgs, TransactionFilter, TransactionId, TransactionProver, TransactionRecord, TransactionRequest, TransactionRequestBuilder, TransactionResult, TransactionScript, TransactionScriptInputPair, TransactionScriptInputPairArray, TransactionStatus, TransactionStoreUpdate, TransactionSummary, WebClient, WebKeystoreApi, Word, createAuthFalcon512RpoMultisig, exportStore, importStore, initSync, sequentialSumBench, setupLogging } from './Cargo-CG4XszZo.js';
 import './wasm.js';
 
 // Eager entry point for @miden-sdk/miden-sdk (browser builds).

package/dist/st/eager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eager.js","sources":["../../js/eager.js"],"sourcesContent":["// Eager entry point for @miden-sdk/miden-sdk (browser builds).\n//\n// Awaits WASM initialization at module top level, so importing this module\n// guarantees that any wasm-bindgen constructor (`new RpcClient(...)`,\n// `AccountId.fromHex(...)`, `TransactionProver.newRemoteProver(...)`, etc.)\n// is safe to call synchronously on the next line. No explicit\n// `await MidenClient.ready()` / `isReady` gate is required.\n//\n// This is the default entry for browser bundlers (`@miden-sdk/miden-sdk`\n// → `./dist/eager.js`). Node.js consumers resolve the `node` exports\n// condition instead and get the napi binding via `./js/node-index.js`,\n// bypassing this file entirely.\n//\n// When NOT to use this entry:\n// - **Capacitor mobile apps** (Miden Wallet iOS/Android): Capacitor's\n//   `capacitor://localhost` scheme handler interacts poorly with top-level\n//   await in the main WKWebView. Verified empirically: TLA in a Capacitor\n//   host WKWebView hangs module evaluation indefinitely, while the same\n//   TLA in the dApp-browser WKWebView (vanilla HTTPS) resolves in <100ms.\n// - **Next.js / SSR**: TLA blocks server-side module evaluation.\n// - **Framework adapters (@miden-sdk/react, etc.)**: they manage readiness\n//   via their own state machine (e.g. `isReady`) and should not impose\n//   TLA on consumer bundles.\n//\n// For those contexts, import from `@miden-sdk/miden-sdk/lazy` — identical\n// API surface, no top-level await, callers are responsible for awaiting\n// `MidenClient.ready()` (or the equivalent) before touching wasm-bindgen\n// types.\nimport { getWasmOrThrow } from \"./index.js\";\n\nawait getWasmOrThrow();\n\nexport * from \"./index.js\";\n"],"names":[],"mappings":";;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,MAAM,cAAc,EAAE;;;;"}

package/dist/st/index.d.ts

@@ -0,0 +1,182 @@
+// Re-export everything from the WASM module
+export * from "./crates/miden_client_web.js";
+
+// Re-export all simplified API types
+export * from "./api-types.js";
+
+// Import types needed for the @internal class declarations below
+import type {
+  WebClient as WasmWebClientBase,
+  SyncSummary,
+} from "./crates/miden_client_web.js";
+import type {
+  GetKeyCallback,
+  InsertKeyCallback,
+  SignCallback,
+} from "./api-types.js";
+
+export type LogLevel =
+  | "error"
+  | "warn"
+  | "info"
+  | "debug"
+  | "trace"
+  | "off"
+  | "none";
+
+/**
+ * Initializes the tracing subscriber that routes Rust log output to the
+ * browser console. Call once per thread (main thread / Web Worker).
+ * Subsequent calls on the same thread are harmless no-ops.
+ *
+ * @param logLevel - The maximum log level to display.
+ */
+export declare function setupLogging(logLevel: LogLevel): void;
+
+// ════════════════════════════════════════════════════════════════
+// StorageView — wraps WASM AccountStorage with smart getItem()
+// ════════════════════════════════════════════════════════════════
+
+import type { AccountStorage, Word, Felt } from "./crates/miden_client_web.js";
+
+/**
+ * Result of reading a storage slot via `StorageView.getItem()`.
+ * Works for both Value and StorageMap slots.
+ */
+export declare class StorageResult {
+  /** True if this slot is a StorageMap. */
+  get isMap(): boolean;
+
+  /**
+   * All entries from a StorageMap slot.
+   * Each entry has `key` (hex), `value` (hex), and `word` (parsed Word or undefined).
+   * Returns undefined for Value slots.
+   */
+  get entries():
+    | Array<{ key: string; value: string; word: Word | undefined }>
+    | undefined;
+
+  /** The underlying Word value. */
+  get word(): Word | undefined;
+
+  /** Returns all four Felts of the stored Word. Pass-through to Word.toFelts(). */
+  toFelts(): Felt[];
+
+  /** The first Felt of the stored Word. */
+  felt(): Felt | undefined;
+
+  /** First felt as a BigInt. Preserves full u64 precision. */
+  toBigInt(): bigint;
+
+  /** The Word's hex representation. */
+  toHex(): string;
+
+  /** Renders as the BigInt value (lossless). Makes `{result}` work in JSX. */
+  toString(): string;
+
+  /** Returns the value as a string for JSON precision safety. */
+  toJSON(): string;
+
+  /**
+   * Allows arithmetic: `+result`, `result * 2`.
+   * Returns a JS number for values fitting in Number.MAX_SAFE_INTEGER.
+   * Throws RangeError for larger values — use `.toBigInt()` for exact access.
+   */
+  valueOf(): number;
+}
+
+/**
+ * Wraps WASM AccountStorage with a developer-friendly API.
+ *
+ * `getItem()` returns a `StorageResult` that works intuitively for both
+ * Value and StorageMap slots. The raw WASM AccountStorage is accessible
+ * via `.raw`.
+ *
+ * Installed on `Account.prototype.storage()` at WASM load time.
+ */
+export declare class StorageView {
+  /** The raw WASM AccountStorage. */
+  get raw(): AccountStorage;
+
+  /** Returns the commitment to the full account storage. */
+  commitment(): Word;
+
+  /** Returns the names of all storage slots. */
+  getSlotNames(): string[];
+
+  /**
+   * Smart read: returns a `StorageResult` for the given slot.
+   * For Value slots: wraps the stored Word.
+   * For StorageMap slots: wraps the first entry's value, with all entries in `.entries`.
+   */
+  getItem(slotName: string): StorageResult | undefined;
+
+  /** Returns the value for a key in a StorageMap slot. */
+  getMapItem(slotName: string, key: Word): Word | undefined;
+
+  /** Get all key-value pairs from a StorageMap slot. */
+  getMapEntries(
+    slotName: string
+  ): Array<{ key: string; value: string }> | undefined;
+
+  /**
+   * Returns the commitment root of a storage slot.
+   * For Value slots: the stored Word. For StorageMap slots: the Merkle root hash.
+   * Useful for proofs, state comparison, and syncing.
+   */
+  getCommitment(slotName: string): Word | undefined;
+}
+
+/** Convert a Word's first felt to a BigInt (full u64 precision). */
+export declare function wordToBigInt(word: Word): bigint;
+
+// ════════════════════════════════════════════════════════════════
+// Internal exports (not public API — for tests and advanced usage)
+// ════════════════════════════════════════════════════════════════
+
+/** @internal Low-level WebClient wrapper. Use MidenClient instead. */
+export declare class WasmWebClient extends WasmWebClientBase {
+  static createClient(
+    rpcUrl?: string,
+    noteTransportUrl?: string,
+    seed?: Uint8Array,
+    storeName?: string,
+    logLevel?: LogLevel,
+    useWorker?: boolean
+  ): Promise<WasmWebClient>;
+
+  static createClientWithExternalKeystore(
+    rpcUrl?: string,
+    noteTransportUrl?: string,
+    seed?: Uint8Array,
+    storeName?: string,
+    getKeyCb?: GetKeyCallback,
+    insertKeyCb?: InsertKeyCallback,
+    signCb?: SignCallback,
+    logLevel?: LogLevel,
+    useWorker?: boolean
+  ): Promise<WasmWebClient>;
+
+  syncState(): Promise<SyncSummary>;
+  syncStateWithTimeout(timeoutMs: number): Promise<SyncSummary>;
+  setSignCb(signCb: SignCallback | null | undefined): void;
+  onStateChanged(callback: (event: any) => void): (() => void) | undefined;
+  terminate(): void;
+}
+
+/** @internal Low-level MockWebClient wrapper. Use MidenClient.createMock() instead. */
+export declare class MockWasmWebClient extends WasmWebClient {
+  static createClient(
+    serializedMockChain?: Uint8Array,
+    serializedMockNoteTransportNode?: Uint8Array,
+    seed?: Uint8Array,
+    logLevel?: LogLevel
+  ): Promise<MockWasmWebClient>;
+
+  proveBlock(): Promise<void>;
+  serializeMockChain(): Promise<Uint8Array>;
+  serializeMockNoteTransportNode(): Promise<Uint8Array>;
+}
+
+/** Alias for MockWasmWebClient — used by test apps that import MockWebClient directly. */
+export { MockWasmWebClient as MockWebClient };