@unlink-xyz/react 0.1.3-canary.f8763d3 → 0.1.3-canary.fd96273

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode } from 'react';
-import { BrowserWalletOptions, SupportedChain, UnlinkWallet, AccountInfo, Account, NoteRecord, BurnerAccount, HistoryStatus, TransferResult, TransferPlanResult, DepositRelayResult, WithdrawalInput, WithdrawResult, WithdrawPlanResult, BurnerSendParams, SimpleBurnerFundParams, SimpleBurnerSweepToPoolParams, SimpleAdapterExecuteParams, AdapterExecuteResult, RelayState, HistoryEntry } from '@unlink-xyz/core';
-export { Account, AccountInfo, AdapterExecuteResult, AdapterExecutionCall, BurnerAccount, BurnerSendParams, Chain, HistoryEntry, InputTokenSpec, NoteRecord, ParsedZkAddress, ReshieldInput, SimpleAdapterExecuteParams, SimpleBurnerFundParams, SimpleBurnerSweepToPoolParams, SupportedChain, TransferPlanResult, TransferResult, TxStatusChangedEvent, UnlinkWallet, WalletSDKEvent, WithdrawPlanResult, WithdrawResult, computeBalances, decodeAddress, encodeAddress, formatAmount, normalizeAddress, parseAmount, parseZkAddress, randomHex, shortenHex } from '@unlink-xyz/core';
+import { BrowserWalletOptions, SupportedChain, UnlinkWallet, AccountInfo, Account, NoteRecord, BurnerAccount, HistoryStatus, SignerOverride, TransferResult, TransferPlanResult, DepositRelayResult, WithdrawalInput, WithdrawResult, WithdrawPlanResult, BurnerSendParams, SimpleBurnerFundParams, SimpleBurnerSweepToPoolParams, SimpleAdapterExecuteParams, AdapterExecuteResult, RelayState, HistoryEntry } from '@unlink-xyz/core';
+export { Account, AccountInfo, AdapterExecuteResult, AdapterExecutionCall, BurnerAccount, BurnerSendParams, Chain, HistoryEntry, InputTokenSpec, NoteRecord, ParsedZkAddress, ReceiveInput, ReshieldInput, SignerOverride, SimpleAdapterExecuteParams, SimpleBurnerFundParams, SimpleBurnerSweepToPoolParams, SpendInput, SupportedChain, TransactionLike, TransferPlanResult, TransferResult, TxStatusChangedEvent, UnlinkWallet, WalletSDKEvent, WithdrawPlanResult, WithdrawResult, approve, buildApproveCall, computeBalances, contract, decodeAddress, encodeAddress, formatAmount, normalizeAddress, parseAmount, parseZkAddress, randomHex, shortenHex, toCall } from '@unlink-xyz/core';
 
 /**
  * Wallet note with value as bigint for convenience.
@@ -103,7 +103,7 @@ type UnlinkState = {
  */
 type TransferInput = {
     token: string;
-    /** Unlink address (0zk1... bech32m) */
+    /** Unlink address (unlink1... bech32m) */
     recipient: string;
     amount: bigint;
 };
@@ -145,7 +145,7 @@ type UnlinkActions = {
      * @param params - Array of transfers (token + amount + recipient)
      * @returns TransferResult with array of plans
      */
-    send(params: TransferInput[]): Promise<TransferResult>;
+    send(params: TransferInput[], overrides?: SignerOverride): Promise<TransferResult>;
     /**
      * Get a transfer plan without executing (for preview).
      * Validates balances and returns plans for each transfer.
@@ -155,7 +155,7 @@ type UnlinkActions = {
      */
     planTransfer(params: TransferInput[]): Promise<TransferPlanResult>;
     /** Execute a pre-built transfer plan */
-    executeTransfer(plans: TransferPlanResult): Promise<TransferResult>;
+    executeTransfer(plans: TransferPlanResult, overrides?: SignerOverride): Promise<TransferResult>;
     /**
      * Request a deposit (1 or more tokens).
      * Returns calldata that the user must submit on-chain via their EOA.
@@ -173,7 +173,7 @@ type UnlinkActions = {
      * @param params - Array of withdrawals (token + amount + recipient)
      * @returns WithdrawResult with array of plans
      */
-    requestWithdraw(params: WithdrawInput[]): Promise<WithdrawResult>;
+    requestWithdraw(params: WithdrawInput[], overrides?: SignerOverride): Promise<WithdrawResult>;
     /**
      * Get a withdrawal plan without executing (for preview).
      * Validates balances and returns plans for each withdrawal.
@@ -183,7 +183,7 @@ type UnlinkActions = {
      */
     planWithdraw(params: WithdrawInput[]): Promise<WithdrawPlanResult>;
     /** Execute a pre-built withdrawal plan */
-    executeWithdraw(plans: WithdrawPlanResult): Promise<WithdrawResult>;
+    executeWithdraw(plans: WithdrawPlanResult, overrides?: SignerOverride): Promise<WithdrawResult>;
     /** Derive and track burner account at index */
     createBurner(index: number): Promise<BurnerAccount>;
     /** Remove tracked burner account (client-side only) */
@@ -462,8 +462,8 @@ declare function useUnlinkBalances(): {
 declare function useTxStatus(txId: string | null): UseTxStatusResult;
 
 type UseOperationMutationResult<TInput, TOutput> = {
-    /** Execute the mutation */
-    mutate: (input: TInput) => Promise<TOutput>;
+    /** Execute the operation */
+    execute: (input: TInput) => Promise<TOutput>;
     /** Last successful result */
     data: TOutput | null;
     /** Whether the mutation is currently running */
@@ -487,10 +487,10 @@ type UseOperationMutationResult<TInput, TOutput> = {
  * ```tsx
  * function DepositButton() {
  *   const { requestDeposit } = useUnlink();
- *   const { mutate, isPending, error } = useOperationMutation(requestDeposit);
+ *   const { execute, isPending, error } = useOperationMutation(requestDeposit);
  *
  *   return (
- *     <button onClick={() => mutate(params)} disabled={isPending}>
+ *     <button onClick={() => execute(params)} disabled={isPending}>
  *       {isPending ? "Depositing..." : "Deposit"}
  *     </button>
  *   );
@@ -527,6 +527,8 @@ declare function useDeposit(): UseOperationMutationResult<DepositInput[], Deposi
 /**
  * Hook for sending private transfers with loading/error state.
  *
+ * @param overrides - Optional signer override for multisig transactions
+ *
  * @example
  * ```tsx
  * function SendForm() {
@@ -534,7 +536,7 @@ declare function useDeposit(): UseOperationMutationResult<DepositInput[], Deposi
  *
  *   const handleSend = async () => {
  *     const result = await send([
- *       { token: "0x...", recipient: "0zk1...", amount: 100n },
+ *       { token: "0x...", recipient: "unlink1...", amount: 100n },
  *     ]);
  *     console.log("Relay ID:", result.relayId);
  *   };
@@ -547,11 +549,13 @@ declare function useDeposit(): UseOperationMutationResult<DepositInput[], Deposi
  * }
  * ```
  */
-declare function useTransfer(): UseOperationMutationResult<TransferInput[], TransferResult>;
+declare function useTransfer(overrides?: SignerOverride): UseOperationMutationResult<TransferInput[], TransferResult>;
 
 /**
  * Hook for requesting withdrawals with loading/error state.
  *
+ * @param overrides - Optional signer override for multisig transactions
+ *
  * @example
  * ```tsx
  * function WithdrawForm() {
@@ -572,7 +576,7 @@ declare function useTransfer(): UseOperationMutationResult<TransferInput[], Tran
  * }
  * ```
  */
-declare function useWithdraw(): UseOperationMutationResult<WithdrawInput[], WithdrawResult>;
+declare function useWithdraw(overrides?: SignerOverride): UseOperationMutationResult<WithdrawInput[], WithdrawResult>;
 
 /**
  * Hook for executing private DeFi adapter operations with loading/error state.
@@ -586,10 +590,9 @@ declare function useWithdraw(): UseOperationMutationResult<WithdrawInput[], With
  *
  *   const handleSwap = async () => {
  *     const result = await executeAdapter({
- *       adapterAddress: "0x...",
- *       inputs: [{ token: "0x...", amount: 1000n }],
+ *       spend: [{ token: "0x...", amount: 1000n }],
  *       calls: [approveCall, swapCall],
- *       reshields: [{ token: "0x...", minAmount: 500n }],
+ *       receive: [{ token: "0x...", minAmount: 500n }],
  *     });
  *     console.log("Relay ID:", result.relayId);
  *   };