@owney/sdk 0.7.24-beta.0 → 0.7.25-beta.0

package/dist/index.d.cts

@@ -1,5 +1,155 @@
 import { SIWXConfig } from '@reown/appkit-controllers';
 
+/**
+ * Swap-to-yield types (ROUT-242).
+ *
+ * The SDK never talks to 1inch directly — the API key is a paid credential and
+ * lives in the routing API. Everything here describes the routing API's
+ * `/api/v1/swap/*` contract.
+ */
+/**
+ * Which rail a swap rides, decided server-side from the chains.
+ *
+ * `classic` — same chain. One atomic transaction: it either completes or
+ * nothing moved.
+ *
+ * `fusion-plus` — crossing chains. The user's funds sit in an escrow while a
+ * resolver fills the other side, so the order has a lifecycle and can end in
+ * `expired` → `refunding` → `refunded` without ever depositing.
+ */
+type SwapRail = "classic" | "fusion-plus";
+type SwapTokenInfo = {
+    readonly symbol: string;
+    readonly address: string;
+    readonly decimals: number;
+    /** Native asset (ETH). A swap SOURCE only — never a deposit target. */
+    readonly isNative?: true;
+};
+type SwapChainTokens = {
+    readonly chainId: number;
+    /** What the user may pay with. */
+    readonly sources: readonly SwapTokenInfo[];
+    /** What a swap may resolve into — what Owney actually deposits. */
+    readonly depositTargets: readonly SwapTokenInfo[];
+};
+type SwapQuote = {
+    rail: SwapRail;
+    src: {
+        chainId: number;
+        symbol: string;
+        address: string;
+        amount: string;
+    };
+    dst: {
+        chainId: number;
+        symbol: string;
+        address: string;
+        amount: string;
+    };
+    /**
+     * Worst-case output once the Dutch auction has fully decayed. Gate minimum
+     * deposit checks on THIS, not `dst.amount` — a fill at auction end that lands
+     * under the agent's floor would leave the user swapped but not deposited.
+     */
+    dstAmountMin: string;
+    /** Cross-chain only. Per-order escrow schedule in seconds, set by 1inch. */
+    timeLocks?: Record<string, number>;
+    /**
+     * Cross-chain only. How many preimages to mint before building an order.
+     * Building with the wrong number produces escrows the user's secrets cannot
+     * unlock, stranding the swap until its cancellation timelock.
+     */
+    secretsCount?: number;
+    /**
+     * Cross-chain only. The contract the source token must be approved to (the
+     * 1inch Limit Order Protocol) before a resolver can fill the order.
+     *
+     * Absent on the classic rail, where the router address arrives with the swap
+     * calldata instead.
+     */
+    spender?: string;
+    /**
+     * True only for a cross-chain swap FROM native ETH, which needs an on-chain
+     * order creation carrying the full amount as msg.value. The user's funds
+     * leave the wallet before any fill, so the UI must say so. ERC-20 sources are
+     * signature-only after their one-time approval.
+     */
+    requiresOnchainOrder: boolean;
+    /**
+     * What the swap costs, as the provider reports it on this quote.
+     *
+     * Surfaced rather than derived: a fee the UI computes from its own constant
+     * drifts from the one actually charged the moment the two disagree, and they
+     * did — the integrator fee was configured on our side for days while the
+     * provider had it switched off, so the real charge was zero.
+     *
+     * Cross-chain only. The classic rail reports no breakdown.
+     */
+    feeInfo?: {
+        /** Owney's cut. Absent until a fee receiver is configured. */
+        integratorFee?: {
+            receiver: string;
+            bps: number;
+            share: number;
+        };
+        /** The filler's cut, charged either way. */
+        resolverFee?: {
+            receiver: string;
+            bps: number;
+        };
+    };
+    /**
+     * Owney's cut in basis points, for display.
+     *
+     * Distinct from `feeInfo`, which is what the provider measured on this
+     * quote. When the provider applies the fee at settlement it reports nothing
+     * here, and this carries the agreed figure instead so the UI can still name
+     * one. Stated, not verified.
+     */
+    integratorFeeBps?: number;
+};
+/**
+ * Terminal states are `executed`, `expired`, `cancelled` and `refunded`.
+ * `refunding` is the window the returning-funds screen renders: the order has
+ * failed and the money is on its way back, but is not back yet.
+ */
+type SwapOrderStatus = "pending" | "executed" | "expired" | "cancelled" | "refunding" | "refunded" | "unpublished";
+/**
+ * Stage reported to the UI while a swap runs, in either direction.
+ *
+ * `withdrawing` and `withdrawn` belong to the withdrawal path only: the
+ * withdrawal is acknowledged by the agent long before the tokens appear in the
+ * wallet, and the swap cannot start until they have. That wait is a visible
+ * stage rather than dead time inside "quoting", because it is the longest part
+ * of the flow and the one place a user would otherwise think nothing is
+ * happening.
+ */
+type SwapStage = "withdrawing" | "withdrawn" | "quoting" | "approving" | "signing" | "swapping" | "swapped" | "depositing" | "refunding" | "refunded";
+/**
+ * Which way the funds travel, which decides what each side may be.
+ *
+ * On a `deposit` the source is any wallet asset and the destination must be
+ * depositable. On a `withdraw` that reverses, and the destination widens to
+ * anything the wallet can receive — native ETH and USDT included. The routing
+ * API enforces both, so this has to be stated rather than inferred.
+ */
+type SwapDirection = "deposit" | "withdraw";
+type SwapQuoteParams = {
+    /** Asset being spent: a wallet asset on a deposit, an Owney asset on a withdrawal. */
+    from: {
+        chainId: number;
+        symbol: string;
+        amount: string;
+    };
+    /** Asset being received: a deposit target on a deposit, any wallet asset on a withdrawal. */
+    to: {
+        chainId: number;
+        symbol: string;
+    };
+    /** Defaults to `deposit`. */
+    direction?: SwapDirection;
+};
+
 type ZyfaiRpcUrlsConfig = Partial<Record<(typeof SUPPORTED_CHAIN_IDS)[number], string>>;
 interface OwneySDKConfig {
     apiKey: string;
@@ -690,6 +840,137 @@ declare class OwneySDK {
     private hasExistingBalance;
     private validateAssetSupport;
     private getEligibleAgents;
+    /** Lazily built so an app that never swaps pays nothing for it. */
+    private swapApiClient?;
+    private swapApi;
+    /**
+     * Put the wallet on `chainId`, or fail with something actionable.
+     *
+     * Reuses the same guard the deposit rail uses, which re-reads the chain after
+     * switching — some wallets resolve wallet_switchEthereumChain before the
+     * network has actually changed.
+     */
+    private ensureSwapChain;
+    /**
+     * Binds the executor's abstract deps to this client's wallet.
+     *
+     * Kept as a builder rather than baked into the executor so the whole swap
+     * flow stays testable without a provider — the executor never imports viem.
+     */
+    private buildSwapDeps;
+    /**
+     * Assets the user may pay with, and what each chain deposits into.
+     *
+     * The source list is deliberately wider than the deposit list: it includes
+     * native ETH and USDT, which Owney never holds but users often do.
+     */
+    getSwapTokens(): Promise<{
+        chains: SwapChainTokens[];
+    }>;
+    /**
+     * Price a swap without committing to it.
+     *
+     * `dstAmountMin` is the number to validate against a deposit minimum —
+     * `dst.amount` is an estimate that a decaying auction or slippage can undercut,
+     * and a swap landing below the floor leaves the user swapped but not
+     * deposited.
+     */
+    getSwapQuote(params: SwapQuoteParams): Promise<SwapQuote>;
+    /**
+     * Swap an asset the user holds into a deposit asset, then deposit it.
+     *
+     * Kept separate from `deposit()` rather than bolted on as an option: the
+     * return shape differs, the staging callback is meaningless on the plain
+     * path, and integrators who never swap should not have to reason about any
+     * of it.
+     *
+     * The deposit runs on the MEASURED arrival, not the quote. A quote is an
+     * estimate, so depositing the quoted figure would either strand dust or try
+     * to move funds that never came.
+     *
+     * Failure modes differ in a way callers must respect. A same-chain swap is
+     * atomic — if it fails, nothing moved. A cross-chain swap escrows the user's
+     * funds first, so SWAP_ORDER_EXPIRED / REFUNDED / CANCELLED all mean the
+     * money left the wallet. Only the former can honestly say "nothing has left
+     * your wallet".
+     */
+    swapAndDeposit(options: {
+        from: {
+            chainId: number;
+            symbol: string;
+            amount: string;
+        };
+        /** Deposit target. Defaults to the active chain's asset when omitted. */
+        to: {
+            chainId: number;
+            symbol: string;
+        };
+        agentId?: AgentId;
+        /** Percent, classic rail only. Fusion+ prices through its auction. */
+        slippage?: number;
+        onSwapProgress?: (stage: SwapStage) => void;
+    }): Promise<{
+        swap: {
+            received: string;
+            orderHash?: string;
+            txHash?: string;
+        };
+        deposit: OwneyDepositResult | OwneyMultiDepositResult;
+    }>;
+    /**
+     * Withdraw from an agent and swap the proceeds into whatever the user wants
+     * to hold, delivered to their own wallet.
+     *
+     * The mirror of `swapAndDeposit()`, with one structural difference that
+     * drives the whole implementation: a deposit swap starts from funds already
+     * sitting in the wallet, but a withdrawal has to wait for them. The agent's
+     * provider acknowledges a withdrawal and *then* queues the on-chain transfer
+     * to the EOA, so `withdraw()` resolving means "accepted", not "arrived".
+     * Quoting before the tokens land would size the swap against a balance that
+     * is not there yet.
+     *
+     * The swap is therefore sized from the MEASURED arrival, exactly as the
+     * deposit path sizes its deposit from the measured swap output. On a full
+     * withdrawal there is no other number available — "MAX" has no figure until
+     * the agent picks one.
+     *
+     * **Failure here is not symmetrical with the deposit path.** A failed
+     * deposit-swap leaves the user holding what they started with. A failed
+     * withdrawal-swap leaves them holding the AGENT'S asset in their own wallet:
+     * the money is out, safe, and in the wrong denomination. Both
+     * `WITHDRAW_ARRIVAL_TIMEOUT` and `WITHDRAW_SWAP_FAILED` carry `withdrawn` for
+     * that reason — the UI has to tell the user where their money actually is,
+     * and must never present either as a lost withdrawal.
+     */
+    withdrawAndSwap(options: {
+        /** The agent's asset. Must be on the active chain. */
+        from: {
+            chainId: number;
+            symbol: string;
+        };
+        /** What to deliver to the wallet. Any swappable asset, including native ETH. */
+        to: {
+            chainId: number;
+            symbol: string;
+        };
+        /** Human units ("10.5"). Omit to withdraw the full agent balance. */
+        amount?: string;
+        agentId?: AgentId;
+        /** Percent, classic rail only. Fusion+ prices through its auction. */
+        slippage?: number;
+        onSwapProgress?: (stage: SwapStage) => void;
+        /** How long to wait for the withdrawal to land before giving up on the swap. */
+        arrivalTimeoutMs?: number;
+    }): Promise<{
+        withdraw: OwneyWithdrawResult | AgentWithdrawResult;
+        /** What actually arrived in the wallet, smallest unit of the agent's asset. */
+        withdrawn: string;
+        swap: {
+            received: string;
+            orderHash?: string;
+            txHash?: string;
+        };
+    }>;
     /**
      * Withdraw funds from a specific agent, or all agents that support the active chain+asset if agentId is omitted.
      * Validates that the asset is supported by the target agent(s) on the active chain.
@@ -802,7 +1083,7 @@ declare class OwneySDK {
     getAllocationApy({ agentId, }?: AllocationApyOptions): Promise<OwneyAllocationApy>;
 }
 
-type OwneyErrorCode = "NOT_CONNECTED" | "NO_ACTIVE_CHAIN" | "WALLET_NO_ACCOUNTS" | "WALLET_ADDRESS_REQUIRED" | "WALLET_NOT_DEPLOYED" | "AGENT_NOT_FOUND" | "AGENT_CHAIN_INCOMPATIBLE" | "AGENT_EMPTY_LIST" | "AGENT_DISABLED" | "CHAIN_UNSUPPORTED" | "CHAIN_NO_COMPATIBLE_AGENTS" | "CHAIN_MISMATCH" | "ASSET_UNSUPPORTED" | "ASSET_NO_COMPATIBLE_AGENTS" | "DEPOSIT_BALANCE_UNAVAILABLE" | "DEPOSIT_PARTIAL_FAILURE" | "DEPOSIT_AMOUNT_BELOW_MINIMUM" | "DEPOSIT_CALLBACK_REQUIRED" | "DEPOSIT_CALLBACK_INVALID" | "DEPOSIT_NO_PERMITTED_TOKENS" | "DEPOSIT_INSUFFICIENT_BALANCE" | "WITHDRAW_NO_PERMITTED_TOKENS" | "WITHDRAW_INSUFFICIENT_BALANCE" | "WITHDRAW_ALL_FAILED" | "WITHDRAW_PARTIAL_FAILURE" | "WITHDRAW_FAILED" | "AGENT_RATE_LIMITED" | "API_ROUTING_ERROR" | "API_ROUTING_FAILED" | "API_NO_AGENTS" | "SPONSOR_REQUEST_FAILED" | "PERMIT2_APPROVAL_REQUIRED" | "SPONSORED_CALLS_UNSUPPORTED" | "SPONSORED_CALLS_NO_ID" | "SPONSORED_CALLS_NO_RECEIPT" | "BALANCE_ALL_FAILED" | "ALLOCATION_ALL_FAILED" | "VALIDATION_INVALID_DAYS";
+type OwneyErrorCode = "NOT_CONNECTED" | "NO_ACTIVE_CHAIN" | "WALLET_NO_ACCOUNTS" | "WALLET_ADDRESS_REQUIRED" | "WALLET_NOT_DEPLOYED" | "AGENT_NOT_FOUND" | "AGENT_CHAIN_INCOMPATIBLE" | "AGENT_EMPTY_LIST" | "AGENT_DISABLED" | "CHAIN_UNSUPPORTED" | "CHAIN_NO_COMPATIBLE_AGENTS" | "CHAIN_MISMATCH" | "ASSET_UNSUPPORTED" | "ASSET_NO_COMPATIBLE_AGENTS" | "DEPOSIT_BALANCE_UNAVAILABLE" | "DEPOSIT_PARTIAL_FAILURE" | "DEPOSIT_AMOUNT_BELOW_MINIMUM" | "DEPOSIT_CALLBACK_REQUIRED" | "DEPOSIT_CALLBACK_INVALID" | "DEPOSIT_NO_PERMITTED_TOKENS" | "DEPOSIT_INSUFFICIENT_BALANCE" | "WITHDRAW_NO_PERMITTED_TOKENS" | "WITHDRAW_INSUFFICIENT_BALANCE" | "WITHDRAW_ALL_FAILED" | "WITHDRAW_PARTIAL_FAILURE" | "WITHDRAW_FAILED" | "AGENT_RATE_LIMITED" | "API_ROUTING_ERROR" | "API_ROUTING_FAILED" | "API_NO_AGENTS" | "SPONSOR_REQUEST_FAILED" | "PERMIT2_APPROVAL_REQUIRED" | "SPONSORED_CALLS_UNSUPPORTED" | "SPONSORED_CALLS_NO_ID" | "SPONSORED_CALLS_NO_RECEIPT" | "SWAP_DISABLED" | "SWAP_RATE_LIMITED" | "SWAP_REQUEST_FAILED" | "SWAP_QUOTE_FAILED" | "SWAP_UNSUPPORTED_PAIR" | "SWAP_APPROVAL_REQUIRED" | "SWAP_BELOW_DEPOSIT_MINIMUM" | "SWAP_ORDER_EXPIRED" | "SWAP_ORDER_REFUNDED" | "SWAP_ORDER_CANCELLED" | "WITHDRAW_ARRIVAL_TIMEOUT" | "WITHDRAW_SWAP_FAILED" | "BALANCE_ALL_FAILED" | "ALLOCATION_ALL_FAILED" | "VALIDATION_INVALID_DAYS";
 declare class OwneyError extends Error {
     readonly code: OwneyErrorCode;
     readonly details?: Record<string, unknown>;
@@ -868,4 +1149,40 @@ type OwneySIWXConfig = {
  */
 declare function createOwneySIWX(config: OwneySIWXConfig): SIWXConfig;
 
-export { type AccountAgentApy, type AccountApyOptions, type AccountDailyEarnings, type AgentApy, type AgentApyDetails, type AgentBalance, AgentChainIncompatibleError, type AgentEarnings, type AgentHistoryEntry, type AgentHistoryPosition, type AgentId, AgentNotFoundError, type AgentSupportedAsset, type AgentSupportedAssets, type AgentUserProfile, type AgentWithdrawResult, type AgentsApyOptions, type AllocationAgentApy, type AllocationApyOptions, type ApyByChainAndAsset, type ApyHistoryPoint, type Asset, type AssetDailyEarnings, type AvailableAgent, type AvailableAgentsOptions, type ConnectionState, type DailyApyDays, type DailyEarningsOptions, type DailyEarningsPoint, type DepositCallback, type DepositOptions, type HistoryAction, type HistoryFilters, type HistoryOptions, type HistoryTransaction, type IAgent, InvalidHistoryCursorError, type LookbackDays, NotConnectedError, type OwneyAccountApy, type OwneyAgentApy, type OwneyAgentHistory, type OwneyAllocationApy, type OwneyBalances, type OwneyDepositResult, type OwneyEarnings, OwneyError, type OwneyErrorCode, type OwneyMultiDepositResult, type OwneyPosition, OwneySDK, type OwneySDKConfig, type OwneySIWXConfig, type OwneySupportedChainId, type OwneySupportedChains, type OwneySupportedTokens, type OwneyToken, type OwneyUserProfile, type OwneyWithdrawResult, type RebalanceLog, type WithdrawOptions, createOwneySIWX, setOwneyDebug };
+/**
+ * Persists cross-chain swap secrets so an in-flight order survives a reload.
+ *
+ * This is not a convenience. A Fusion+ order is only completable by whoever
+ * holds the secret preimages: the resolver deploys escrows, then waits for the
+ * secret before it can claim and release funds to the user. Lose the secrets
+ * mid-order and the swap cannot complete — the user waits out the cancellation
+ * timelock for a refund instead.
+ *
+ * That matters here because the UI explicitly tells the user "you can safely
+ * close this window", so surviving a reload is a requirement, not a nicety.
+ *
+ * Trade-off: the same one `zyfai.auth-cache` makes. Secrets in `localStorage`
+ * are exposed to XSS, but they are single-use, worthless once the order
+ * settles, and only ever unlock funds back to the user's own wallet.
+ */
+type StoredOrder = {
+    orderHash: string;
+    /** Preimages, one per fill. Index matters — fill N needs secret N. */
+    secrets: string[];
+    /** Chain the funds left from, so a resumed session can report it. */
+    srcChainId: number;
+    /** For the resumed UI: what the user was paying with and expecting. */
+    srcSymbol: string;
+    dstSymbol: string;
+    dstChainId: number;
+    amount: string;
+    /** Epoch ms. Used to drop orders far past any plausible timelock. */
+    createdAt: number;
+};
+/**
+ * Every stored order, newest first, dropping anything past MAX_AGE_MS.
+ * Used on mount to resume orders the user left in flight.
+ */
+declare function listOrders(now?: number): StoredOrder[];
+
+export { type AccountAgentApy, type AccountApyOptions, type AccountDailyEarnings, type AgentApy, type AgentApyDetails, type AgentBalance, AgentChainIncompatibleError, type AgentEarnings, type AgentHistoryEntry, type AgentHistoryPosition, type AgentId, AgentNotFoundError, type AgentSupportedAsset, type AgentSupportedAssets, type AgentUserProfile, type AgentWithdrawResult, type AgentsApyOptions, type AllocationAgentApy, type AllocationApyOptions, type ApyByChainAndAsset, type ApyHistoryPoint, type Asset, type AssetDailyEarnings, type AvailableAgent, type AvailableAgentsOptions, type ConnectionState, type DailyApyDays, type DailyEarningsOptions, type DailyEarningsPoint, type DepositCallback, type DepositOptions, type HistoryAction, type HistoryFilters, type HistoryOptions, type HistoryTransaction, type IAgent, InvalidHistoryCursorError, type LookbackDays, NotConnectedError, type OwneyAccountApy, type OwneyAgentApy, type OwneyAgentHistory, type OwneyAllocationApy, type OwneyBalances, type OwneyDepositResult, type OwneyEarnings, OwneyError, type OwneyErrorCode, type OwneyMultiDepositResult, type OwneyPosition, OwneySDK, type OwneySDKConfig, type OwneySIWXConfig, type OwneySupportedChainId, type OwneySupportedChains, type OwneySupportedTokens, type OwneyToken, type OwneyUserProfile, type OwneyWithdrawResult, type RebalanceLog, type SwapChainTokens, type SwapDirection, type SwapOrderStatus, type SwapQuote, type SwapQuoteParams, type SwapRail, type SwapStage, type SwapTokenInfo, type WithdrawOptions, createOwneySIWX, listOrders as listPendingSwaps, setOwneyDebug };