@miden-sdk/react 0.15.1 → 0.15.2

package/dist/mt/lazy.d.ts

@@ -1,8 +1,8 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { AccountId, Account, AccountHeader, AccountStorageMode, AccountComponent, NoteId, InputNoteRecord, Note, StorageMode, AuthScheme, TransactionScript, AdviceInputs, AccountStorageRequirements, TransactionRequest, WasmWebClient, AccountFile, NoteVisibility, ConsumableNoteRecord, NoteInput, TransactionId, TransactionFilter, TransactionRecord, TransactionProver, CompileComponentOptions, CompileTxScriptOptions, CompileNoteScriptOptions, NoteScript, NoteAttachment } from '@miden-sdk/miden-sdk';
-export { Account, AccountFile, AccountHeader, AccountId, AccountStorageMode, AuthScheme, ConsumableNoteRecord, InputNoteRecord, Note, NoteType, TransactionFilter, TransactionId, TransactionRecord, TransactionRequest, WasmWebClient as WebClient } from '@miden-sdk/miden-sdk';
+import { AccountId, Account, AccountHeader, AccountStorageMode, AccountComponent, NoteId, InputNoteRecord, Note, StorageMode, AuthScheme, TransactionScript, AdviceInputs, AccountStorageRequirements, TransactionRequest, WasmWebClient, AccountFile, NoteVisibility, ConsumableNoteRecord, NoteInput, PswapLineageRecord, TransactionId, TransactionFilter, TransactionRecord, TransactionProver, CompileComponentOptions, CompileTxScriptOptions, CompileNoteScriptOptions, NoteScript, NoteAttachment } from '@miden-sdk/miden-sdk';
+export { Account, AccountFile, AccountHeader, AccountId, AccountStorageMode, AuthScheme, ConsumableNoteRecord, InputNoteRecord, Note, NoteType, PswapLineageRecord, TransactionFilter, TransactionId, TransactionRecord, TransactionRequest, WasmWebClient as WebClient } from '@miden-sdk/miden-sdk';
 
 declare module "@miden-sdk/miden-sdk" {
     interface Account {
@@ -462,6 +462,29 @@ interface PswapCancelOptions {
      */
     note: NoteInput;
 }
+interface PswapCancelByOrderOptions {
+    /**
+     * Stable order id of the lineage to cancel (decimal string or bigint).
+     * `number` is not accepted: a PSWAP order id is `u64`-shaped and routinely
+     * exceeds `Number.MAX_SAFE_INTEGER`, which a JS `number` cannot represent
+     * without silent precision loss.
+     */
+    orderId: string | bigint;
+}
+interface PswapLineagesResult {
+    /** Tracked PSWAP lineages. */
+    lineages: PswapLineageRecord[];
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+}
+interface PswapLineageResult {
+    /** The tracked lineage, or `null` if not tracked. */
+    lineage: PswapLineageRecord | null;
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+}
 interface ExecuteTransactionOptions {
     /** Account ID the transaction applies to */
     accountId: AccountRef;
@@ -814,6 +837,74 @@ declare function useAssetMetadata(assetIds?: string[]): {
     assetMetadata: Map<string, AssetMetadata>;
 };
 
+/**
+ * Hook to list 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. The list refreshes
+ * after each successful sync.
+ *
+ * @example
+ * ```tsx
+ * function LineageList() {
+ *   const { lineages, isLoading } = usePswapLineages();
+ *   if (isLoading) return <div>Loading...</div>;
+ *   return (
+ *     <ul>
+ *       {lineages.map((l) => (
+ *         <li key={l.orderId()}>
+ *           {l.orderId()} — {l.remainingOffered().toString()} remaining
+ *         </li>
+ *       ))}
+ *     </ul>
+ *   );
+ * }
+ * ```
+ */
+declare function usePswapLineages(): PswapLineagesResult;
+type UsePswapLineagesResult = PswapLineagesResult;
+
+/**
+ * Hook to list the partial-swap (PSWAP) lineages created by a specific local
+ * account. Refreshes after each successful sync.
+ *
+ * @param account - Creator account (hex, bech32, `Account`, or `AccountId`).
+ *
+ * @example
+ * ```tsx
+ * function MyLineages({ accountId }: { accountId: string }) {
+ *   const { lineages, isLoading } = usePswapLineagesFor(accountId);
+ *   if (isLoading) return <div>Loading...</div>;
+ *   return <div>{lineages.length} open orders</div>;
+ * }
+ * ```
+ */
+declare function usePswapLineagesFor(account: AccountRef | null | undefined): PswapLineagesResult;
+type UsePswapLineagesForResult = PswapLineagesResult;
+
+/**
+ * Hook to fetch a single partial-swap (PSWAP) lineage by its stable order id.
+ * Returns `null` if this client is not tracking the order. Refreshes after each
+ * successful sync.
+ *
+ * @param orderId - Stable order id (decimal string or bigint). `number` is
+ *   not accepted: a PSWAP order id is `u64`-shaped and routinely exceeds
+ *   `Number.MAX_SAFE_INTEGER`, which a JS `number` cannot represent without
+ *   silent precision loss.
+ *
+ * @example
+ * ```tsx
+ * function OrderStatus({ orderId }: { orderId: string }) {
+ *   const { lineage, isLoading } = usePswapLineage(orderId);
+ *   if (isLoading) return <div>Loading...</div>;
+ *   if (!lineage) return <div>Not tracked</div>;
+ *   return <div>State: {lineage.state()}</div>;
+ * }
+ * ```
+ */
+declare function usePswapLineage(orderId: string | bigint | null | undefined): PswapLineageResult;
+type UsePswapLineageResult = PswapLineageResult;
+
 interface UseCreateWalletResult {
     /** Create a new wallet with optional configuration */
     createWallet: (options?: CreateWalletOptions) => Promise<Account>;
@@ -1296,6 +1387,40 @@ interface UsePswapCancelResult {
  */
 declare function usePswapCancel(): UsePswapCancelResult;
 
+interface UsePswapCancelByOrderResult {
+    /** Cancel a PSWAP lineage by its stable order id, reclaiming the unfilled offered asset. */
+    pswapCancelByOrder: (options: PswapCancelByOrderOptions) => Promise<TransactionResult>;
+    /** The transaction result */
+    result: TransactionResult | null;
+    /** Whether the transaction is in progress */
+    isLoading: boolean;
+    /** Current stage of the transaction */
+    stage: TransactionStage;
+    /** Error if transaction failed */
+    error: Error | null;
+    /** Reset the hook state */
+    reset: () => void;
+}
+/**
+ * Hook to cancel a PSWAP lineage by its stable order id and reclaim the
+ * unfilled offered asset on the lineage's current tip. Unlike
+ * {@link usePswapCancel}, the creator account and tip note are resolved from
+ * the locally tracked lineage, so only the order id is required.
+ *
+ * @example
+ * ```tsx
+ * function CancelOrderButton({ orderId }: { orderId: string }) {
+ *   const { pswapCancelByOrder, isLoading, stage } = usePswapCancelByOrder();
+ *   return (
+ *     <button onClick={() => pswapCancelByOrder({ orderId })} disabled={isLoading}>
+ *       {isLoading ? stage : "Cancel order"}
+ *     </button>
+ *   );
+ * }
+ * ```
+ */
+declare function usePswapCancelByOrder(): UsePswapCancelByOrderResult;
+
 interface UseTransactionResult {
     /** Execute a transaction request end-to-end */
     execute: (options: ExecuteTransactionOptions) => Promise<TransactionResult>;
@@ -1715,4 +1840,4 @@ declare function createMidenStorage(prefix: string): {
     clear(): void;
 };
 
-export { type AccountRef, type AccountResult, type AccountsResult, type AssetBalance, type AssetMetadata, type ConsumeOptions, type CreateFaucetOptions, type CreateWalletOptions, DEFAULTS, type ExecuteProgramOptions, type ExecuteProgramResult, type ExecuteTransactionOptions, type ImportAccountOptions, type ImportStoreOptions, type MidenConfig, MidenError, type MidenErrorCode, MidenProvider, type MidenState, type MigrateStorageOptions, type MintOptions, type MultiSendOptions, type MultiSendRecipient, type MultiSignerContextValue, MultiSignerProvider, type MutationResult, type NoteAsset, type NoteAttachmentData, type NoteSummary, type NotesFilter, type NotesResult, type ProverConfig, type ProverTarget, type ProverUrls, type PswapCancelOptions, type PswapConsumeOptions, type PswapCreateOptions, type QueryResult, type RpcUrlConfig, type SendOptions, type SendResult, type SessionAccountStep, type SignCallback, type SignerAccountConfig, type SignerAccountType, SignerContext, type SignerContextValue, SignerSlot, type StreamedNote, type SwapOptions, type SyncState, type TransactionHistoryOptions, type TransactionHistoryResult, type TransactionResult, type TransactionStage, type TransactionStatus, type UseCompileResult, type UseConsumeResult, type UseCreateFaucetResult, type UseCreateWalletResult, type UseExecuteProgramResult, type UseExportNoteResult, type UseExportStoreResult, type UseImportAccountResult, type UseImportNoteResult, type UseImportStoreResult, type UseMintResult, type UseMultiSendResult, type UseNoteStreamOptions, type UseNoteStreamReturn, type UsePswapCancelResult, type UsePswapConsumeResult, type UsePswapCreateResult, type UseSendResult, type UseSessionAccountOptions, type UseSessionAccountReturn, type UseSwapResult, type UseSyncControlResult, type UseSyncStateResult, type UseTransactionHistoryResult, type UseTransactionResult, type UseWaitForCommitResult, type UseWaitForNotesResult, type WaitForCommitOptions, type WaitForNotesOptions, type WalletAdapterLike, accountIdsEqual, bigIntToBytes, bytesToBigInt, clearMidenStorage, concatBytes, createMidenStorage, createNoteAttachment, ensureAccountBech32, formatAssetAmount, formatNoteSummary, getNoteSummary, installAccountBech32, migrateStorage, normalizeAccountId, parseAssetAmount, readNoteAttachment, toBech32AccountId, useAccount, useAccounts, useAssetMetadata, useCompile, useConsume, useCreateFaucet, useCreateWallet, useExecuteProgram, useExportNote, useExportStore, useImportAccount, useImportNote, useImportStore, useMiden, useMidenClient, useMint, useMultiSend, useMultiSigner, useNoteStream, useNotes, usePswapCancel, usePswapConsume, usePswapCreate, useSend, useSessionAccount, useSigner, useSwap, useSyncControl, useSyncState, useTransaction, useTransactionHistory, useWaitForCommit, useWaitForNotes, waitForWalletDetection, wrapWasmError };
+export { type AccountRef, type AccountResult, type AccountsResult, type AssetBalance, type AssetMetadata, type ConsumeOptions, type CreateFaucetOptions, type CreateWalletOptions, DEFAULTS, type ExecuteProgramOptions, type ExecuteProgramResult, type ExecuteTransactionOptions, type ImportAccountOptions, type ImportStoreOptions, type MidenConfig, MidenError, type MidenErrorCode, MidenProvider, type MidenState, type MigrateStorageOptions, type MintOptions, type MultiSendOptions, type MultiSendRecipient, type MultiSignerContextValue, MultiSignerProvider, type MutationResult, type NoteAsset, type NoteAttachmentData, type NoteSummary, type NotesFilter, type NotesResult, type ProverConfig, type ProverTarget, type ProverUrls, type PswapCancelByOrderOptions, type PswapCancelOptions, type PswapConsumeOptions, type PswapCreateOptions, type PswapLineageResult, type PswapLineagesResult, type QueryResult, type RpcUrlConfig, type SendOptions, type SendResult, type SessionAccountStep, type SignCallback, type SignerAccountConfig, type SignerAccountType, SignerContext, type SignerContextValue, SignerSlot, type StreamedNote, type SwapOptions, type SyncState, type TransactionHistoryOptions, type TransactionHistoryResult, type TransactionResult, type TransactionStage, type TransactionStatus, type UseCompileResult, type UseConsumeResult, type UseCreateFaucetResult, type UseCreateWalletResult, type UseExecuteProgramResult, type UseExportNoteResult, type UseExportStoreResult, type UseImportAccountResult, type UseImportNoteResult, type UseImportStoreResult, type UseMintResult, type UseMultiSendResult, type UseNoteStreamOptions, type UseNoteStreamReturn, type UsePswapCancelByOrderResult, type UsePswapCancelResult, type UsePswapConsumeResult, type UsePswapCreateResult, type UsePswapLineageResult, type UsePswapLineagesForResult, type UsePswapLineagesResult, type UseSendResult, type UseSessionAccountOptions, type UseSessionAccountReturn, type UseSwapResult, type UseSyncControlResult, type UseSyncStateResult, type UseTransactionHistoryResult, type UseTransactionResult, type UseWaitForCommitResult, type UseWaitForNotesResult, type WaitForCommitOptions, type WaitForNotesOptions, type WalletAdapterLike, accountIdsEqual, bigIntToBytes, bytesToBigInt, clearMidenStorage, concatBytes, createMidenStorage, createNoteAttachment, ensureAccountBech32, formatAssetAmount, formatNoteSummary, getNoteSummary, installAccountBech32, migrateStorage, normalizeAccountId, parseAssetAmount, readNoteAttachment, toBech32AccountId, useAccount, useAccounts, useAssetMetadata, useCompile, useConsume, useCreateFaucet, useCreateWallet, useExecuteProgram, useExportNote, useExportStore, useImportAccount, useImportNote, useImportStore, useMiden, useMidenClient, useMint, useMultiSend, useMultiSigner, useNoteStream, useNotes, usePswapCancel, usePswapCancelByOrder, usePswapConsume, usePswapCreate, usePswapLineage, usePswapLineages, usePswapLineagesFor, useSend, useSessionAccount, useSigner, useSwap, useSyncControl, useSyncState, useTransaction, useTransactionHistory, useWaitForCommit, useWaitForNotes, waitForWalletDetection, wrapWasmError };