@owney/sdk 0.6.9-beta.0 → 0.6.9-beta.1

package/dist/index.d.cts

@@ -34,7 +34,7 @@ type OwneySupportedChainId = (typeof SUPPORTED_CHAIN_IDS)[number];
 type OwneySupportedChains = (typeof SUPPORTED_CHAINS)[number];
 type OwneySupportedTokens = (typeof SUPPORTED_TOKENS)[number];
 
-type AgentId = "zyfai" | "sail" | "surfliquid";
+type AgentId = "zyfai" | "sail";
 type Asset = string;
 type AgentSupportedAsset = {
     readonly symbol: string;
@@ -101,6 +101,16 @@ type DepositOptions = {
     onApproved?: () => void;
 };
 
+/**
+ * The organization's agent execution policy, or null when the partner has never
+ * configured one — in which case the agents leave the user's profile alone.
+ * Currently capital splitting only (ROUT-229).
+ */
+type OrgAgentConfig = {
+    splittingMode: "none" | "automatic" | "force";
+    minSplits: number | null;
+};
+
 interface OwneyDepositResult {
     txHash: string;
     smartWallet: string;
@@ -108,12 +118,6 @@ 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;
@@ -281,6 +285,19 @@ interface IAgent {
     readonly supportedAssets: readonly AgentSupportedAssets[];
     disconnect(): Promise<void>;
     activateAgent(state: ConnectionState, chainId: number): Promise<void>;
+    /**
+     * Apply the organization's agent policy to this user's account.
+     *
+     * Optional: an agent that has no equivalent knob simply omits it, which is why
+     * this is not part of `activateAgent`'s signature. Declared on the interface
+     * rather than only on ZyfaiAgent so the contract stays agent-neutral — the
+     * ticket asks for a design that can also cover Surf, which has no adapter yet.
+     *
+     * Implementations must be **non-fatal**: this runs during activation as a side
+     * effect, so a failure has to leave the user connected and their profile
+     * unchanged rather than break the connect.
+     */
+    applyOrgPolicy?(state: ConnectionState, chainId: number, policy: OrgAgentConfig): Promise<void>;
     deposit(state: ConnectionState, chainId: number, amount: string, asset: OwneySupportedTokens, depositCallback?: DepositCallback): Promise<OwneyDepositResult>;
     withdraw(state: ConnectionState, chainId: number, token: OwneySupportedTokens, amount?: string): Promise<AgentWithdrawResult>;
     getBalances(state: ConnectionState, chainId: number): Promise<AgentBalance>;
@@ -324,6 +341,8 @@ declare class OwneySDK {
     private disabledAgents;
     private state;
     private apiKey;
+    private orgAgentConfig;
+    private orgAgentConfigPromise;
     private zyfaiRpcUrls?;
     private routingApiBaseUrl?;
     private referralSource?;
@@ -372,6 +391,20 @@ declare class OwneySDK {
     private getDefaultWethSponsoredCallback;
     private getAgent;
     private getActiveAgents;
+    /**
+     * Read the org's agent policy once and reuse it. fetchOrgAgentConfig never
+     * throws — it degrades to null — so this cannot break activation.
+     */
+    private getOrgAgentConfig;
+    /**
+     * Apply the org policy to one agent, after it has activated.
+     *
+     * Sequenced after activation rather than alongside it because applying the
+     * policy needs the authenticated session activation establishes. Every failure
+     * mode is swallowed: a partner's splitting preference is not worth failing a
+     * user's connect over.
+     */
+    private applyOrgPolicyTo;
     private ensureAgentsInitialized;
     private createAgent;
     /**
@@ -436,17 +469,6 @@ 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.
@@ -542,7 +564,7 @@ declare class OwneySDK {
     getAllocationApy({ agentId, }?: AllocationApyOptions): Promise<OwneyAllocationApy>;
 }
 
-type OwneyErrorCode = "NOT_CONNECTED" | "NO_ACTIVE_CHAIN" | "WALLET_NO_ACCOUNTS" | "WALLET_ADDRESS_REQUIRED" | "AGENT_NOT_FOUND" | "AGENT_CHAIN_INCOMPATIBLE" | "AGENT_EMPTY_LIST" | "AGENT_DISABLED" | "CHAIN_UNSUPPORTED" | "CHAIN_NO_COMPATIBLE_AGENTS" | "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" | "BALANCE_ALL_FAILED" | "ALLOCATION_ALL_FAILED" | "VALIDATION_INVALID_DAYS";
+type OwneyErrorCode = "NOT_CONNECTED" | "NO_ACTIVE_CHAIN" | "WALLET_NO_ACCOUNTS" | "WALLET_ADDRESS_REQUIRED" | "AGENT_NOT_FOUND" | "AGENT_CHAIN_INCOMPATIBLE" | "AGENT_EMPTY_LIST" | "AGENT_DISABLED" | "CHAIN_UNSUPPORTED" | "CHAIN_NO_COMPATIBLE_AGENTS" | "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" | "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

@@ -34,7 +34,7 @@ type OwneySupportedChainId = (typeof SUPPORTED_CHAIN_IDS)[number];
 type OwneySupportedChains = (typeof SUPPORTED_CHAINS)[number];
 type OwneySupportedTokens = (typeof SUPPORTED_TOKENS)[number];
 
-type AgentId = "zyfai" | "sail" | "surfliquid";
+type AgentId = "zyfai" | "sail";
 type Asset = string;
 type AgentSupportedAsset = {
     readonly symbol: string;
@@ -101,6 +101,16 @@ type DepositOptions = {
     onApproved?: () => void;
 };
 
+/**
+ * The organization's agent execution policy, or null when the partner has never
+ * configured one — in which case the agents leave the user's profile alone.
+ * Currently capital splitting only (ROUT-229).
+ */
+type OrgAgentConfig = {
+    splittingMode: "none" | "automatic" | "force";
+    minSplits: number | null;
+};
+
 interface OwneyDepositResult {
     txHash: string;
     smartWallet: string;
@@ -108,12 +118,6 @@ 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;
@@ -281,6 +285,19 @@ interface IAgent {
     readonly supportedAssets: readonly AgentSupportedAssets[];
     disconnect(): Promise<void>;
     activateAgent(state: ConnectionState, chainId: number): Promise<void>;
+    /**
+     * Apply the organization's agent policy to this user's account.
+     *
+     * Optional: an agent that has no equivalent knob simply omits it, which is why
+     * this is not part of `activateAgent`'s signature. Declared on the interface
+     * rather than only on ZyfaiAgent so the contract stays agent-neutral — the
+     * ticket asks for a design that can also cover Surf, which has no adapter yet.
+     *
+     * Implementations must be **non-fatal**: this runs during activation as a side
+     * effect, so a failure has to leave the user connected and their profile
+     * unchanged rather than break the connect.
+     */
+    applyOrgPolicy?(state: ConnectionState, chainId: number, policy: OrgAgentConfig): Promise<void>;
     deposit(state: ConnectionState, chainId: number, amount: string, asset: OwneySupportedTokens, depositCallback?: DepositCallback): Promise<OwneyDepositResult>;
     withdraw(state: ConnectionState, chainId: number, token: OwneySupportedTokens, amount?: string): Promise<AgentWithdrawResult>;
     getBalances(state: ConnectionState, chainId: number): Promise<AgentBalance>;
@@ -324,6 +341,8 @@ declare class OwneySDK {
     private disabledAgents;
     private state;
     private apiKey;
+    private orgAgentConfig;
+    private orgAgentConfigPromise;
     private zyfaiRpcUrls?;
     private routingApiBaseUrl?;
     private referralSource?;
@@ -372,6 +391,20 @@ declare class OwneySDK {
     private getDefaultWethSponsoredCallback;
     private getAgent;
     private getActiveAgents;
+    /**
+     * Read the org's agent policy once and reuse it. fetchOrgAgentConfig never
+     * throws — it degrades to null — so this cannot break activation.
+     */
+    private getOrgAgentConfig;
+    /**
+     * Apply the org policy to one agent, after it has activated.
+     *
+     * Sequenced after activation rather than alongside it because applying the
+     * policy needs the authenticated session activation establishes. Every failure
+     * mode is swallowed: a partner's splitting preference is not worth failing a
+     * user's connect over.
+     */
+    private applyOrgPolicyTo;
     private ensureAgentsInitialized;
     private createAgent;
     /**
@@ -436,17 +469,6 @@ 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.
@@ -542,7 +564,7 @@ declare class OwneySDK {
     getAllocationApy({ agentId, }?: AllocationApyOptions): Promise<OwneyAllocationApy>;
 }
 
-type OwneyErrorCode = "NOT_CONNECTED" | "NO_ACTIVE_CHAIN" | "WALLET_NO_ACCOUNTS" | "WALLET_ADDRESS_REQUIRED" | "AGENT_NOT_FOUND" | "AGENT_CHAIN_INCOMPATIBLE" | "AGENT_EMPTY_LIST" | "AGENT_DISABLED" | "CHAIN_UNSUPPORTED" | "CHAIN_NO_COMPATIBLE_AGENTS" | "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" | "BALANCE_ALL_FAILED" | "ALLOCATION_ALL_FAILED" | "VALIDATION_INVALID_DAYS";
+type OwneyErrorCode = "NOT_CONNECTED" | "NO_ACTIVE_CHAIN" | "WALLET_NO_ACCOUNTS" | "WALLET_ADDRESS_REQUIRED" | "AGENT_NOT_FOUND" | "AGENT_CHAIN_INCOMPATIBLE" | "AGENT_EMPTY_LIST" | "AGENT_DISABLED" | "CHAIN_UNSUPPORTED" | "CHAIN_NO_COMPATIBLE_AGENTS" | "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" | "BALANCE_ALL_FAILED" | "ALLOCATION_ALL_FAILED" | "VALIDATION_INVALID_DAYS";
 declare class OwneyError extends Error {
     readonly code: OwneyErrorCode;
     readonly details?: Record<string, unknown>;