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

package/dist/index.d.ts

@@ -1,19 +1,19 @@
 // Re-export everything from the WASM module
-export * from "./crates/miden_client_web";
+export * from "./crates/miden_client_web.js";
 
 // Re-export all simplified API types
-export * from "./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";
+} from "./crates/miden_client_web.js";
 import type {
   GetKeyCallback,
   InsertKeyCallback,
   SignCallback,
-} from "./api-types";
+} from "./api-types.js";
 
 export type LogLevel =
   | "error"
@@ -33,6 +33,103 @@ export type LogLevel =
  */
 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)
 // ════════════════════════════════════════════════════════════════
@@ -74,7 +171,10 @@ export declare class MockWasmWebClient extends WasmWebClient {
     logLevel?: LogLevel
   ): Promise<MockWasmWebClient>;
 
-  proveBlock(): void;
-  serializeMockChain(): Uint8Array;
-  serializeMockNoteTransportNode(): Uint8Array;
+  proveBlock(): Promise<void>;
+  serializeMockChain(): Promise<Uint8Array>;
+  serializeMockNoteTransportNode(): Promise<Uint8Array>;
 }
+
+/** Alias for MockWasmWebClient — used by test apps that import MockWebClient directly. */
+export { MockWasmWebClient as MockWebClient };