@owney/sdk 0.7.11 → 0.7.12-beta.0

package/dist/index.d.cts

@@ -21,6 +21,16 @@ interface OwneySDKConfig {
      * `createOwneySIWX` for apps that don't use the AppKit SIWX modal.
      */
     referralSource?: string;
+    /**
+     * Optional override for the SurfLiquid API base URL (defaults to the
+     * SurfLiquid SDK's production URL). SurfLiquid auth is an httpOnly
+     * SameSite=None cookie set by api.surfliquid.com — a THIRD-PARTY cookie from
+     * the embedding app's origin, which WebKit (all iOS browsers) discards, so
+     * every authenticated SurfLiquid call 401s on iOS. Point this at a
+     * same-origin reverse proxy (e.g. "/api/surf") so the session cookie becomes
+     * first-party. Relative paths resolve against the page origin.
+     */
+    surfliquidApiBaseUrl?: string;
     /**
      * Turn on the SDK's debug logging (default false). Traces the decisions that
      * are otherwise invisible — notably how the organization's agent policy is
@@ -54,7 +64,7 @@ type OwneySupportedChainId = (typeof SUPPORTED_CHAIN_IDS)[number];
 type OwneySupportedChains = (typeof SUPPORTED_CHAINS)[number];
 type OwneySupportedTokens = (typeof SUPPORTED_TOKENS)[number];
 
-type AgentId = "zyfai" | "sail";
+type AgentId = "zyfai" | "sail" | "surfliquid";
 type Asset = string;
 type AgentSupportedAsset = {
     readonly symbol: string;
@@ -170,6 +180,12 @@ interface OwneyDepositResult {
 }
 interface OwneyMultiDepositResult {
     agentResults: Record<string, OwneyDepositResult>;
+    /**
+     * Per-agent failure messages for agents that errored during a diversified
+     * deposit. Present only when at least one (but not all) agents failed —
+     * the deposit is partial, not total. Omitted when every agent succeeded.
+     */
+    agentErrors?: Record<string, string>;
 }
 interface AgentWithdrawResult {
     txHash?: string;
@@ -441,6 +457,7 @@ declare class OwneySDK {
     private zyfaiRpcUrls?;
     private routingApiBaseUrl?;
     private referralSource?;
+    private surfliquidApiBaseUrl?;
     private cachedSponsoredCallback;
     private cachedWethSponsoredCallback;
     private paymasterServiceUrl?;
@@ -573,6 +590,17 @@ declare class OwneySDK {
     private hasExistingBalance;
     private validateAssetSupport;
     private getEligibleAgents;
+    /**
+     * Agent ids the routing API provisioned for this org that support the given
+     * chain + asset, ordered by preference ({@link AGENT_ELIGIBILITY_ORDER},
+     * surfliquid first). Returns `[]` when the org has no compatible agent — never
+     * throws on an empty org. Loads agent keys on first call (apiKey only, no
+     * wallet), so the UI can resolve which agent to use before the user connects.
+     *
+     * This is the source of truth for agent availability: an agent appears here
+     * iff the routing API returned its key. No per-app feature flags.
+     */
+    getEligibleAgentIds(chainId: number, asset: string): Promise<AgentId[]>;
     /**
      * 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.
@@ -673,7 +701,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_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" | "API_ROUTING_ERROR" | "API_ROUTING_FAILED" | "API_SAIL_ERROR" | "API_SAIL_TIMEOUT" | "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_AMOUNT_BELOW_MINIMUM" | "DEPOSIT_CALLBACK_REQUIRED" | "DEPOSIT_CALLBACK_INVALID" | "DEPOSIT_NO_PERMITTED_TOKENS" | "DEPOSIT_ALL_FAILED" | "DEPOSIT_INSUFFICIENT_BALANCE" | "WITHDRAW_NO_PERMITTED_TOKENS" | "WITHDRAW_INSUFFICIENT_BALANCE" | "WITHDRAW_ALL_FAILED" | "WITHDRAW_PARTIAL_FAILURE" | "WITHDRAW_FAILED" | "API_ROUTING_ERROR" | "API_ROUTING_FAILED" | "API_SAIL_ERROR" | "API_SAIL_TIMEOUT" | "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";
 declare class OwneyError extends Error {
     readonly code: OwneyErrorCode;
     readonly details?: Record<string, unknown>;

package/dist/index.d.ts

@@ -21,6 +21,16 @@ interface OwneySDKConfig {
      * `createOwneySIWX` for apps that don't use the AppKit SIWX modal.
      */
     referralSource?: string;
+    /**
+     * Optional override for the SurfLiquid API base URL (defaults to the
+     * SurfLiquid SDK's production URL). SurfLiquid auth is an httpOnly
+     * SameSite=None cookie set by api.surfliquid.com — a THIRD-PARTY cookie from
+     * the embedding app's origin, which WebKit (all iOS browsers) discards, so
+     * every authenticated SurfLiquid call 401s on iOS. Point this at a
+     * same-origin reverse proxy (e.g. "/api/surf") so the session cookie becomes
+     * first-party. Relative paths resolve against the page origin.
+     */
+    surfliquidApiBaseUrl?: string;
     /**
      * Turn on the SDK's debug logging (default false). Traces the decisions that
      * are otherwise invisible — notably how the organization's agent policy is
@@ -54,7 +64,7 @@ type OwneySupportedChainId = (typeof SUPPORTED_CHAIN_IDS)[number];
 type OwneySupportedChains = (typeof SUPPORTED_CHAINS)[number];
 type OwneySupportedTokens = (typeof SUPPORTED_TOKENS)[number];
 
-type AgentId = "zyfai" | "sail";
+type AgentId = "zyfai" | "sail" | "surfliquid";
 type Asset = string;
 type AgentSupportedAsset = {
     readonly symbol: string;
@@ -170,6 +180,12 @@ interface OwneyDepositResult {
 }
 interface OwneyMultiDepositResult {
     agentResults: Record<string, OwneyDepositResult>;
+    /**
+     * Per-agent failure messages for agents that errored during a diversified
+     * deposit. Present only when at least one (but not all) agents failed —
+     * the deposit is partial, not total. Omitted when every agent succeeded.
+     */
+    agentErrors?: Record<string, string>;
 }
 interface AgentWithdrawResult {
     txHash?: string;
@@ -441,6 +457,7 @@ declare class OwneySDK {
     private zyfaiRpcUrls?;
     private routingApiBaseUrl?;
     private referralSource?;
+    private surfliquidApiBaseUrl?;
     private cachedSponsoredCallback;
     private cachedWethSponsoredCallback;
     private paymasterServiceUrl?;
@@ -573,6 +590,17 @@ declare class OwneySDK {
     private hasExistingBalance;
     private validateAssetSupport;
     private getEligibleAgents;
+    /**
+     * Agent ids the routing API provisioned for this org that support the given
+     * chain + asset, ordered by preference ({@link AGENT_ELIGIBILITY_ORDER},
+     * surfliquid first). Returns `[]` when the org has no compatible agent — never
+     * throws on an empty org. Loads agent keys on first call (apiKey only, no
+     * wallet), so the UI can resolve which agent to use before the user connects.
+     *
+     * This is the source of truth for agent availability: an agent appears here
+     * iff the routing API returned its key. No per-app feature flags.
+     */
+    getEligibleAgentIds(chainId: number, asset: string): Promise<AgentId[]>;
     /**
      * 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.
@@ -673,7 +701,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_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" | "API_ROUTING_ERROR" | "API_ROUTING_FAILED" | "API_SAIL_ERROR" | "API_SAIL_TIMEOUT" | "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_AMOUNT_BELOW_MINIMUM" | "DEPOSIT_CALLBACK_REQUIRED" | "DEPOSIT_CALLBACK_INVALID" | "DEPOSIT_NO_PERMITTED_TOKENS" | "DEPOSIT_ALL_FAILED" | "DEPOSIT_INSUFFICIENT_BALANCE" | "WITHDRAW_NO_PERMITTED_TOKENS" | "WITHDRAW_INSUFFICIENT_BALANCE" | "WITHDRAW_ALL_FAILED" | "WITHDRAW_PARTIAL_FAILURE" | "WITHDRAW_FAILED" | "API_ROUTING_ERROR" | "API_ROUTING_FAILED" | "API_SAIL_ERROR" | "API_SAIL_TIMEOUT" | "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";
 declare class OwneyError extends Error {
     readonly code: OwneyErrorCode;
     readonly details?: Record<string, unknown>;