@owney/sdk 0.7.25-beta.4 → 0.7.25-beta.7

package/dist/index.d.cts

@@ -1,12 +1,23 @@
 import { Hex } from 'viem';
 import { SIWXConfig } from '@reown/appkit-controllers';
 
-type ZyfaiRpcUrlsConfig = Partial<Record<(typeof SUPPORTED_CHAIN_IDS)[number], string>>;
+type RpcUrlsConfig = Partial<Record<(typeof SUPPORTED_CHAIN_IDS)[number], string>>;
+/** @deprecated Use RpcUrlsConfig. */
+type ZyfaiRpcUrlsConfig = RpcUrlsConfig;
 interface OwneySDKConfig {
     apiKey: string;
+    /**
+     * Optional per-chain RPC overrides used for application-owned reads and
+     * transaction receipt polling. Missing chains use the Owney routing API's
+     * read-only RPC proxy. No upstream RPC credentials are included in the SDK.
+     * Wallet providers remain responsible for account access, chain switching,
+     * signatures, and transaction submission.
+     */
+    rpcUrls?: RpcUrlsConfig;
     /**
      * Optional per-chain RPC overrides for Zyfai SDK network calls.
      * Example: { 8453: "https://...", 42161: "https://..." }
+     * @deprecated Use rpcUrls so every agent shares the same read transport.
      */
     zyfaiRpcUrls?: ZyfaiRpcUrlsConfig;
     /** Optional Owney Yieldseeker proxy base URL override for integration tests. */
@@ -15,9 +26,9 @@ interface OwneySDKConfig {
     yieldseekerSiweOrigin?: string;
     /**
      * Optional override for the Owney routing API base URL used by all routing
-     * calls (defaults to the OWNEY_ROUTING_API_BASE_URL env var, then the
-     * production URL). Set this to point at a local/staging routing API,
-     * e.g. "http://localhost:3000", when testing sponsor changes.
+     * calls. RPC proxy requests use OWNEY_ROUTING_API_BASE_URL when this is
+     * omitted; without either value, all rpcUrls must be configured.
+     * Set this to a local/staging routing API when testing sponsor changes.
      */
     routingApiBaseUrl?: string;
     /**
@@ -483,6 +494,12 @@ interface IAgent {
      * withdrawal planning must add matching position amounts.
      */
     readonly balanceComposition?: "tokens-include-positions" | "tokens-plus-positions";
+    /**
+     * Whether a withdrawal requires an owner-approved wallet transaction.
+     * Aggregate withdrawals run these agents before relayer-only agents so a
+     * rejected wallet request cannot happen after another leg has committed.
+     */
+    readonly withdrawalRequiresWalletApproval?: boolean;
     disconnect(): Promise<void>;
     activateAgent(state: ConnectionState, chainId: number, asset?: OwneySupportedTokens): Promise<void>;
     /**
@@ -554,6 +571,7 @@ declare class OwneySDK {
     private apiKey;
     private orgAgentConfig;
     private orgAgentConfigPromise;
+    private rpcUrls?;
     private zyfaiRpcUrls?;
     private yieldseekerApiBaseUrl?;
     private yieldseekerSiweOrigin?;
@@ -593,6 +611,7 @@ declare class OwneySDK {
     private requireState;
     private requireChainId;
     private requireConnectedProvider;
+    private getPaidRpcClient;
     /** Builds the default USDC batch callback for the connected wallet. */
     private getDefaultSponsoredCallback;
     /** Builds the wallet-native sponsored calls callback for compatible paymasters. */
@@ -676,10 +695,12 @@ declare class OwneySDK {
      * Invokes `agent.deposit` with the resolved sponsored callback, composing
      * two independent auto-recovery mechanisms:
      *
-     * 1. Missing Permit2 allowance: when the app did not supply its own
-     *    callback and the attempt fails with `PERMIT2_APPROVAL_REQUIRED` on a
-     *    token deposit, this is the wallet's first Permit2 deposit for that token. We send
-     *    the one-time (user-paid) Permit2 approval via `approvePermit2()` and
+     * 1. Missing Permit2 allowance outside the atomic Base-USDC path: when the
+     *    app did not supply its own callback and the attempt fails with
+     *    `PERMIT2_APPROVAL_REQUIRED`, this is the wallet's first Permit2 deposit
+     *    for that token. Base USDC bundles a gasless ERC-2612 approval inside
+     *    its sponsored deposit and never reaches this branch. Other tokens send
+     *    the one-time user-paid Permit2 approval via `approvePermit2()` and
      *    retry the SAME sponsored attempt once. Bounded to one approval attempt
      *    per call so a wallet/agent that keeps reporting the allowance as
      *    missing can't loop forever. If `approvePermit2()` itself throws (e.g.
@@ -711,6 +732,13 @@ declare class OwneySDK {
     private hasExistingBalance;
     private validateAssetSupport;
     private getEligibleAgents;
+    /**
+     * Run owner-approved withdrawals before relayer-only withdrawals. Wallet
+     * approval is the only point at which the user can cancel the aggregate
+     * operation, so no relayer leg should commit before it has completed.
+     */
+    private orderAgentsForWithdrawal;
+    private isUserRejectedWithdrawal;
     /**
      * 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.
@@ -846,6 +874,8 @@ type YieldseekerAgentOptions = {
     baseUrl?: string;
     fetchFn?: YieldseekerFetch;
     auth?: YieldseekerAuthDependencies;
+    /** Dedicated read transport; Base is used for receipt polling. */
+    rpcUrls?: RpcUrlsConfig;
     /** Test seam for the wallet-submission/receipt boundary. */
     transactionExecutor?: (state: ConnectionState, chainId: number, transaction: YieldseekerTransaction) => Promise<Hex>;
     /** Test seam for transactions submitted outside transactionExecutor. */
@@ -854,6 +884,7 @@ type YieldseekerAgentOptions = {
 declare class YieldseekerAgent implements IAgent {
     readonly id = "yieldseeker";
     readonly balanceComposition: "tokens-plus-positions";
+    readonly withdrawalRequiresWalletApproval = true;
     readonly supportedChainIds: readonly [8453];
     readonly supportedAssets: readonly [{
         readonly chainId: 8453;
@@ -868,14 +899,21 @@ declare class YieldseekerAgent implements IAgent {
     }];
     private readonly api;
     private readonly auth;
+    private readonly rpcUrls?;
+    private receiptClient?;
     private readonly transactionExecutor?;
     private readonly unwindReceiptWaiter?;
     private readonly agentContexts;
     private readonly users;
     private readonly pendingAgents;
+    private readonly pendingWalletContexts;
+    private readonly readCache;
+    private readonly pendingReads;
+    private readGeneration;
     private readonly yieldOptions;
     private readonly pendingYieldOptions;
     constructor(owneyApiKey: string, options?: YieldseekerAgentOptions);
+    private getReceiptClient;
     disconnect(): Promise<void>;
     activateAgent(state: ConnectionState, chainId: number, asset?: OwneySupportedTokens): Promise<void>;
     deposit(state: ConnectionState, chainId: number, amount: string, asset: OwneySupportedTokens, depositCallback?: DepositCallback): Promise<OwneyDepositResult>;
@@ -889,6 +927,10 @@ declare class YieldseekerAgent implements IAgent {
     private loadYieldOptions;
     private userKey;
     private contextKey;
+    private cachedRead;
+    private agentListKey;
+    private listAgents;
+    private contextForAgent;
     private resolveUser;
     private forgetUser;
     private ensureAgent;
@@ -981,4 +1023,4 @@ 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, YieldseekerAgent, createOwneySIWX, setOwneyDebug };
+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 RpcUrlsConfig, type WithdrawOptions, YieldseekerAgent, type ZyfaiRpcUrlsConfig, createOwneySIWX, setOwneyDebug };

package/dist/index.d.ts

@@ -1,12 +1,23 @@
 import { Hex } from 'viem';
 import { SIWXConfig } from '@reown/appkit-controllers';
 
-type ZyfaiRpcUrlsConfig = Partial<Record<(typeof SUPPORTED_CHAIN_IDS)[number], string>>;
+type RpcUrlsConfig = Partial<Record<(typeof SUPPORTED_CHAIN_IDS)[number], string>>;
+/** @deprecated Use RpcUrlsConfig. */
+type ZyfaiRpcUrlsConfig = RpcUrlsConfig;
 interface OwneySDKConfig {
     apiKey: string;
+    /**
+     * Optional per-chain RPC overrides used for application-owned reads and
+     * transaction receipt polling. Missing chains use the Owney routing API's
+     * read-only RPC proxy. No upstream RPC credentials are included in the SDK.
+     * Wallet providers remain responsible for account access, chain switching,
+     * signatures, and transaction submission.
+     */
+    rpcUrls?: RpcUrlsConfig;
     /**
      * Optional per-chain RPC overrides for Zyfai SDK network calls.
      * Example: { 8453: "https://...", 42161: "https://..." }
+     * @deprecated Use rpcUrls so every agent shares the same read transport.
      */
     zyfaiRpcUrls?: ZyfaiRpcUrlsConfig;
     /** Optional Owney Yieldseeker proxy base URL override for integration tests. */
@@ -15,9 +26,9 @@ interface OwneySDKConfig {
     yieldseekerSiweOrigin?: string;
     /**
      * Optional override for the Owney routing API base URL used by all routing
-     * calls (defaults to the OWNEY_ROUTING_API_BASE_URL env var, then the
-     * production URL). Set this to point at a local/staging routing API,
-     * e.g. "http://localhost:3000", when testing sponsor changes.
+     * calls. RPC proxy requests use OWNEY_ROUTING_API_BASE_URL when this is
+     * omitted; without either value, all rpcUrls must be configured.
+     * Set this to a local/staging routing API when testing sponsor changes.
      */
     routingApiBaseUrl?: string;
     /**
@@ -483,6 +494,12 @@ interface IAgent {
      * withdrawal planning must add matching position amounts.
      */
     readonly balanceComposition?: "tokens-include-positions" | "tokens-plus-positions";
+    /**
+     * Whether a withdrawal requires an owner-approved wallet transaction.
+     * Aggregate withdrawals run these agents before relayer-only agents so a
+     * rejected wallet request cannot happen after another leg has committed.
+     */
+    readonly withdrawalRequiresWalletApproval?: boolean;
     disconnect(): Promise<void>;
     activateAgent(state: ConnectionState, chainId: number, asset?: OwneySupportedTokens): Promise<void>;
     /**
@@ -554,6 +571,7 @@ declare class OwneySDK {
     private apiKey;
     private orgAgentConfig;
     private orgAgentConfigPromise;
+    private rpcUrls?;
     private zyfaiRpcUrls?;
     private yieldseekerApiBaseUrl?;
     private yieldseekerSiweOrigin?;
@@ -593,6 +611,7 @@ declare class OwneySDK {
     private requireState;
     private requireChainId;
     private requireConnectedProvider;
+    private getPaidRpcClient;
     /** Builds the default USDC batch callback for the connected wallet. */
     private getDefaultSponsoredCallback;
     /** Builds the wallet-native sponsored calls callback for compatible paymasters. */
@@ -676,10 +695,12 @@ declare class OwneySDK {
      * Invokes `agent.deposit` with the resolved sponsored callback, composing
      * two independent auto-recovery mechanisms:
      *
-     * 1. Missing Permit2 allowance: when the app did not supply its own
-     *    callback and the attempt fails with `PERMIT2_APPROVAL_REQUIRED` on a
-     *    token deposit, this is the wallet's first Permit2 deposit for that token. We send
-     *    the one-time (user-paid) Permit2 approval via `approvePermit2()` and
+     * 1. Missing Permit2 allowance outside the atomic Base-USDC path: when the
+     *    app did not supply its own callback and the attempt fails with
+     *    `PERMIT2_APPROVAL_REQUIRED`, this is the wallet's first Permit2 deposit
+     *    for that token. Base USDC bundles a gasless ERC-2612 approval inside
+     *    its sponsored deposit and never reaches this branch. Other tokens send
+     *    the one-time user-paid Permit2 approval via `approvePermit2()` and
      *    retry the SAME sponsored attempt once. Bounded to one approval attempt
      *    per call so a wallet/agent that keeps reporting the allowance as
      *    missing can't loop forever. If `approvePermit2()` itself throws (e.g.
@@ -711,6 +732,13 @@ declare class OwneySDK {
     private hasExistingBalance;
     private validateAssetSupport;
     private getEligibleAgents;
+    /**
+     * Run owner-approved withdrawals before relayer-only withdrawals. Wallet
+     * approval is the only point at which the user can cancel the aggregate
+     * operation, so no relayer leg should commit before it has completed.
+     */
+    private orderAgentsForWithdrawal;
+    private isUserRejectedWithdrawal;
     /**
      * 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.
@@ -846,6 +874,8 @@ type YieldseekerAgentOptions = {
     baseUrl?: string;
     fetchFn?: YieldseekerFetch;
     auth?: YieldseekerAuthDependencies;
+    /** Dedicated read transport; Base is used for receipt polling. */
+    rpcUrls?: RpcUrlsConfig;
     /** Test seam for the wallet-submission/receipt boundary. */
     transactionExecutor?: (state: ConnectionState, chainId: number, transaction: YieldseekerTransaction) => Promise<Hex>;
     /** Test seam for transactions submitted outside transactionExecutor. */
@@ -854,6 +884,7 @@ type YieldseekerAgentOptions = {
 declare class YieldseekerAgent implements IAgent {
     readonly id = "yieldseeker";
     readonly balanceComposition: "tokens-plus-positions";
+    readonly withdrawalRequiresWalletApproval = true;
     readonly supportedChainIds: readonly [8453];
     readonly supportedAssets: readonly [{
         readonly chainId: 8453;
@@ -868,14 +899,21 @@ declare class YieldseekerAgent implements IAgent {
     }];
     private readonly api;
     private readonly auth;
+    private readonly rpcUrls?;
+    private receiptClient?;
     private readonly transactionExecutor?;
     private readonly unwindReceiptWaiter?;
     private readonly agentContexts;
     private readonly users;
     private readonly pendingAgents;
+    private readonly pendingWalletContexts;
+    private readonly readCache;
+    private readonly pendingReads;
+    private readGeneration;
     private readonly yieldOptions;
     private readonly pendingYieldOptions;
     constructor(owneyApiKey: string, options?: YieldseekerAgentOptions);
+    private getReceiptClient;
     disconnect(): Promise<void>;
     activateAgent(state: ConnectionState, chainId: number, asset?: OwneySupportedTokens): Promise<void>;
     deposit(state: ConnectionState, chainId: number, amount: string, asset: OwneySupportedTokens, depositCallback?: DepositCallback): Promise<OwneyDepositResult>;
@@ -889,6 +927,10 @@ declare class YieldseekerAgent implements IAgent {
     private loadYieldOptions;
     private userKey;
     private contextKey;
+    private cachedRead;
+    private agentListKey;
+    private listAgents;
+    private contextForAgent;
     private resolveUser;
     private forgetUser;
     private ensureAgent;
@@ -981,4 +1023,4 @@ 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, YieldseekerAgent, createOwneySIWX, setOwneyDebug };
+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 RpcUrlsConfig, type WithdrawOptions, YieldseekerAgent, type ZyfaiRpcUrlsConfig, createOwneySIWX, setOwneyDebug };