@miden-sdk/miden-sdk 0.13.0-next.1 → 0.13.0-next.3

package/dist/index.d.ts

@@ -1,113 +1,141 @@
-import { WebClient as WasmWebClient } from "./crates/miden_client_web";
-
-export {
-  Account,
-  AccountBuilder,
-  AccountComponent,
-  AccountDelta,
-  AccountFile,
-  AccountHeader,
-  AccountId,
-  AccountInterface,
-  AccountStorageDelta,
-  AccountStorageMode,
-  AccountStorageRequirements,
-  AccountType,
-  AccountVaultDelta,
-  Address,
-  AddressInterface,
-  AdviceMap,
-  Assembler,
-  AssemblerUtils,
-  AuthSecretKey,
-  BasicFungibleFaucetComponent,
-  ConsumableNoteRecord,
-  Endpoint,
-  Felt,
-  FeltArray,
-  ForeignAccount,
-  FungibleAsset,
-  FungibleAssetDelta,
-  InputNoteRecord,
-  InputNoteState,
-  Library,
-  MidenArrays,
-  NetworkId,
-  Note,
-  NoteAndArgs,
-  NoteAndArgsArray,
-  NoteAssets,
-  NoteConsumability,
-  NoteDetails,
-  NoteExecutionHint,
-  NoteExecutionMode,
-  NoteFile,
-  NoteFilter,
-  NoteFilterTypes,
-  NoteId,
-  NoteIdAndArgs,
-  NoteIdAndArgsArray,
-  NoteInputs,
-  NoteMetadata,
-  NoteRecipient,
-  NoteScript,
-  NoteTag,
-  NoteType,
-  OutputNote,
-  OutputNotesArray,
-  Package,
-  PublicKey,
-  Rpo256,
-  RpcClient,
-  SecretKey,
-  ProvenTransaction,
-  SerializedAccountHeader,
-  Signature,
-  SigningInputs,
-  SigningInputsType,
-  SlotAndKeys,
-  SlotAndKeysArray,
-  StorageMap,
-  StorageSlot,
-  TestUtils,
-  TokenSymbol,
-  TransactionFilter,
-  TransactionId,
-  TransactionKernel,
+// Re-export everything from the WASM module
+export * from "./crates/miden_client_web";
+
+// Import types we need for augmentation
+import type {
+  WebClient as WasmWebClient,
+  SyncSummary,
   TransactionProver,
-  TransactionRecord,
-  TransactionRequest,
-  TransactionResult,
-  TransactionStoreUpdate,
-  TransactionRequestBuilder,
-  TransactionScript,
-  TransactionScriptInputPair,
-  TransactionScriptInputPairArray,
-  TransactionSummary,
-  Word,
 } from "./crates/miden_client_web";
 
-// Extend WASM WebClient but override methods that use workers
-export declare class WebClient extends WasmWebClient {
+// Import the full namespace for the MidenArrayConstructors type
+import type * as WasmExports from "./crates/miden_client_web";
+
+// Export the WASM WebClient type alias for users who need to reference it explicitly
+export type { WebClient as WasmWebClient } from "./crates/miden_client_web";
+
+// Callback types for external keystore support
+export type GetKeyCallback = (
+  pubKey: Uint8Array
+) => Promise<Uint8Array | null | undefined> | Uint8Array | null | undefined;
+
+export type InsertKeyCallback = (
+  pubKey: Uint8Array,
+  secretKey: Uint8Array
+) => Promise<void> | void;
+
+export type SignCallback = (
+  pubKey: Uint8Array,
+  signingInputs: Uint8Array
+) => Promise<Uint8Array> | Uint8Array;
+
+type MidenArrayConstructors = {
+  [K in keyof typeof WasmExports as K extends `${string}Array`
+    ? K
+    : never]: (typeof WasmExports)[K];
+};
+
+export declare const MidenArrays: MidenArrayConstructors;
+
+// Module augmentation to add JavaScript wrapper methods to WebClient
+declare module "./crates/miden_client_web" {
+  interface WebClient {
+    /**
+     * Factory method to create and initialize a new wrapped WebClient.
+     *
+     * @param rpcUrl - The RPC URL (optional).
+     * @param noteTransportUrl - The note transport URL (optional).
+     * @param seed - The seed for the account (optional).
+     * @param network - Optional name for the store. Setting this allows multiple clients to be used in the same browser.
+     * @returns A promise that resolves to a fully initialized WebClient.
+     */
+    createClient(
+      rpcUrl?: string,
+      noteTransportUrl?: string,
+      seed?: Uint8Array,
+      network?: string
+    ): Promise<WebClient>;
+
+    /**
+     * Factory method to create and initialize a new wrapped WebClient with a remote keystore.
+     *
+     * @param rpcUrl - The RPC URL (optional).
+     * @param noteTransportUrl - The note transport URL (optional).
+     * @param seed - The seed for the account (optional).
+     * @param storeName - Optional name for the store. Setting this allows multiple clients to be used in the same browser.
+     * @param getKeyCb - Callback used to retrieve secret keys for a given public key.
+     * @param insertKeyCb - Callback used to persist secret keys in the external store.
+     * @param signCb - Callback used to create signatures for the provided inputs.
+     * @returns A promise that resolves to a fully initialized WebClient.
+     */
+    createClientWithExternalKeystore(
+      rpcUrl?: string,
+      noteTransportUrl?: string,
+      seed?: Uint8Array,
+      storeName?: string,
+      getKeyCb?: GetKeyCallback,
+      insertKeyCb?: InsertKeyCallback,
+      signCb?: SignCallback
+    ): Promise<WebClient>;
+
+    /** Returns the default transaction prover configured on the client. */
+    defaultTransactionProver(): TransactionProver;
+
+    /**
+     * Syncs the client state with the Miden node.
+     *
+     * This method coordinates concurrent calls using the Web Locks API:
+     * - If a sync is already in progress, callers wait and receive the same result
+     * - Cross-tab coordination ensures only one sync runs at a time per database
+     *
+     * @returns A promise that resolves to a SyncSummary with the sync results.
+     */
+    syncState(): Promise<SyncSummary>;
+
+    /**
+     * Syncs the client state with the Miden node with an optional timeout.
+     *
+     * This method coordinates concurrent calls using the Web Locks API:
+     * - If a sync is already in progress, callers wait and receive the same result
+     * - Cross-tab coordination ensures only one sync runs at a time per database
+     * - If a timeout is specified and exceeded, the method throws an error
+     *
+     * @param timeoutMs - Optional timeout in milliseconds. If 0 or not provided, waits indefinitely.
+     * @returns A promise that resolves to a SyncSummary with the sync results.
+     */
+    syncStateWithTimeout(timeoutMs?: number): Promise<SyncSummary>;
+
+    /**
+     * Terminates the underlying worker.
+     */
+    terminate(): void;
+  }
+}
+
+// MockWebClient class that extends the augmented WebClient
+export declare class MockWebClient extends WasmWebClient {
   /**
-   * Factory method to create and initialize a new wrapped WebClient.
+   * Factory method to create and initialize a new wrapped MockWebClient.
    *
-   * @param rpcUrl - The RPC URL (optional).
-   * @param noteTransportUrl - The note transport URL (optional).
-   * @param seed - The seed for the account (optional).
-   * @returns A promise that resolves to a fully initialized WebClient.
+   * @param serializedMockChain - Serialized mock chain (optional).
+   * @param serializedMockNoteTransportNode - Serialized mock note transport node (optional).
+   * @param seed - Seed for account initialization (optional).
+   * @returns A promise that resolves to a fully initialized MockWebClient.
    */
   static createClient(
-    rpcUrl?: string,
-    noteTransportUrl?: string,
-    seed?: string
-  ): Promise<WebClient & WasmWebClient>;
+    serializedMockChain?: ArrayBuffer | Uint8Array,
+    serializedMockNoteTransportNode?: ArrayBuffer | Uint8Array,
+    seed?: Uint8Array
+  ): Promise<MockWebClient>;
 
-  /** Returns the default transaction prover configured on the client. */
-  defaultTransactionProver(): TransactionProver;
+  /** Syncs the mock state and returns the resulting summary. */
+  syncState(): Promise<SyncSummary>;
 
   /**
-   * Terminates the underlying worker.
+   * Syncs the client state with the Miden node with an optional timeout.
+   *
+   * @param timeoutMs - Optional timeout in milliseconds. If 0 or not provided, waits indefinitely.
+   * @returns A promise that resolves to a SyncSummary with the sync results.
    */
-  terminate(): void;
+  syncStateWithTimeout(timeoutMs?: number): Promise<SyncSummary>;
 }