@owney/sdk 0.2.5 → 0.2.7

package/dist/index.d.cts

@@ -29,8 +29,18 @@ interface IAgent {
     pause(state: ConnectionState, chainId: number): Promise<OwneyAgentStatus>;
     resume(state: ConnectionState, chainId: number): Promise<OwneyAgentStatus>;
     getUserProfile(state: ConnectionState, chainId: number): Promise<AgentUserProfile>;
-    getAgentApy(days: DailyApyDays): Promise<AgentApy>;
+    getAgentApy(days: DailyApyDays, options?: AgentApyOptions): Promise<AgentApy>;
 }
+/**
+ * Optional filters for per-agent APY lookups.
+ * - `tokenSymbol` / `chainId` scope the APY to a specific asset+chain when
+ *   the underlying provider supports it (Zyfai). Agents whose backends do
+ *   not yet support per-asset APY (Sail) will ignore these options.
+ */
+type AgentApyOptions = {
+    tokenSymbol?: string;
+    chainId?: number;
+};
 
 type AgentId = "zyfai" | "sail";
 type Asset = string;
@@ -60,6 +70,17 @@ type AccountApyOptions = {
 type AgentsApyOptions = {
     agentId?: AgentId;
     days: DailyApyDays;
+    /**
+     * Optional asset symbol (e.g. "USDC", "WETH") to scope the APY to a
+     * specific asset+chain. Ignored by agents whose backends do not yet
+     * support per-asset APY.
+     */
+    tokenSymbol?: string;
+    /**
+     * Optional chain id for per-asset APY lookups. Typically paired with
+     * `tokenSymbol`.
+     */
+    chainId?: number;
 };
 type DepositOptions = {
     amount: string;
@@ -110,6 +131,7 @@ interface OwneyEarnings {
 interface AccountAgentApy {
     walletAddress: string;
     weightedApyAfterFee?: number;
+    weightedApyAfterFeeDetails?: AgentApyDetails;
 }
 interface OwneyAccountApy {
     totalApy: string;
@@ -158,8 +180,12 @@ interface AgentUserProfile {
 interface OwneyUserProfile {
     agentUserProfile: Record<AgentId, AgentUserProfile>;
 }
+interface AgentApyDetails {
+    apyPerAsset: Partial<Record<OwneySupportedChainId, Partial<Record<OwneySupportedTokens, number>>>>;
+}
 interface AgentApy {
     averageApy: number;
+    detailedApys?: AgentApyDetails;
 }
 interface OwneyAgentApy {
     agentApy: Record<AgentId, AgentApy>;
@@ -177,6 +203,7 @@ declare class OwneySDK {
     private activeAgents;
     private state;
     private apiKey;
+    private initializingAgentsPromise;
     constructor(config: OwneySDKConfig);
     /**
      * Establish connection state for all subsequent SDK calls.
@@ -203,6 +230,7 @@ declare class OwneySDK {
     private requireChainId;
     private getAgent;
     private getActiveAgents;
+    private ensureAgentsInitialized;
     /**
      * Activate the user's smart wallet for the specified agents, or all chain-compatible agents if omitted.
      * Deploys the Safe contract and creates a session key if not already set up.
@@ -291,9 +319,14 @@ declare class OwneySDK {
      * @param options - Contains agentId (optional) and days ("7D", "14D", or "30D")
      * @param options.agentId - Optional. Agent to query. Omit for all agents.
      * @param options.days - Lookback period: "7D", "14D", or "30D"
+     * @param options.tokenSymbol - Optional asset symbol ("USDC" / "WETH") to
+     *   scope the APY to a specific asset+chain. Agents whose backends do not
+     *   support per-asset APY (currently Sail) ignore this.
+     * @param options.chainId - Optional chain id for per-asset APY lookups.
+     *   Typically paired with `tokenSymbol`.
      * @returns {AgentApy} for a single agent, or {OwneyAgentApy} with per-agent APY
      */
-    getAgentApy({ agentId, days, }: AgentsApyOptions): Promise<OwneyAgentApy | AgentApy>;
+    getAgentApy({ agentId, days, tokenSymbol, chainId, }: AgentsApyOptions): Promise<OwneyAgentApy | AgentApy>;
     /**
      * Get the current fund allocation percentages across agents.
      * @returns Object with agent names as keys and allocation percentages as values
@@ -301,13 +334,19 @@ declare class OwneySDK {
     getAgentAllocation(): Promise<OwneyAgentAllocation>;
 }
 
-declare class AgentNotFoundError extends Error {
+type OwneyErrorCode = "NOT_CONNECTED" | "NO_ACTIVE_CHAIN" | "WALLET_NO_ACCOUNTS" | "WALLET_ADDRESS_REQUIRED" | "AGENT_NOT_FOUND" | "AGENT_CHAIN_INCOMPATIBLE" | "AGENT_EMPTY_LIST" | "CHAIN_UNSUPPORTED" | "CHAIN_NO_COMPATIBLE_AGENTS" | "ASSET_UNSUPPORTED" | "ASSET_NO_COMPATIBLE_AGENTS" | "DEPOSIT_AMOUNT_TOO_SMALL" | "DEPOSIT_CALLBACK_REQUIRED" | "DEPOSIT_CALLBACK_INVALID" | "DEPOSIT_NO_PERMITTED_TOKENS" | "WITHDRAW_NO_PERMITTED_TOKENS" | "API_ROUTING_ERROR" | "API_ROUTING_FAILED" | "API_SAIL_ERROR" | "API_SAIL_TIMEOUT" | "API_NO_AGENTS" | "BALANCE_ALL_FAILED" | "ALLOCATION_ALL_FAILED" | "VALIDATION_INVALID_DAYS";
+declare class OwneyError extends Error {
+    readonly code: OwneyErrorCode;
+    readonly details?: Record<string, unknown>;
+    constructor(code: OwneyErrorCode, message: string, details?: Record<string, unknown>);
+}
+declare class AgentNotFoundError extends OwneyError {
     constructor(agentId: string, available: string[]);
 }
-declare class NotConnectedError extends Error {
+declare class NotConnectedError extends OwneyError {
     constructor();
 }
-declare class AgentChainIncompatibleError extends Error {
+declare class AgentChainIncompatibleError extends OwneyError {
     readonly incompatibleAgents: Array<{
         agentId: string;
         supportedChainIds: readonly number[];
@@ -319,4 +358,4 @@ declare class AgentChainIncompatibleError extends Error {
     }>, connectedChainId: number);
 }
 
-export { AccountAgentApy, AccountApyOptions, AgentApy, AgentBalance, AgentChainIncompatibleError, AgentEarnings, AgentHistoryEntry, AgentId, AgentNotFoundError, AgentSupportedAssets, AgentUserProfile, AgentWithdrawResult, AgentsApyOptions, Asset, ConnectionState, DailyApyDays, DepositCallback, DepositOptions, HistoryAction, HistoryFilters, HistoryOptions, HistoryTransaction, IAgent, NotConnectedError, OwneyAccountApy, OwneyAgentAllocation, OwneyAgentApy, OwneyAgentHistory, OwneyAgentStatus, OwneyBalances, OwneyDepositResult, OwneyEarnings, OwneyMultiDepositResult, OwneyRouteResponse, OwneySDK, OwneySDKConfig, OwneyToken, OwneyUserProfile, OwneyWithdrawResult, RebalanceLog, WithdrawOptions };
+export { AccountAgentApy, AccountApyOptions, AgentApy, AgentApyDetails, AgentBalance, AgentChainIncompatibleError, AgentEarnings, AgentHistoryEntry, AgentId, AgentNotFoundError, AgentSupportedAssets, AgentUserProfile, AgentWithdrawResult, AgentsApyOptions, Asset, ConnectionState, DailyApyDays, DepositCallback, DepositOptions, HistoryAction, HistoryFilters, HistoryOptions, HistoryTransaction, IAgent, NotConnectedError, OwneyAccountApy, OwneyAgentAllocation, OwneyAgentApy, OwneyAgentHistory, OwneyAgentStatus, OwneyBalances, OwneyDepositResult, OwneyEarnings, OwneyError, OwneyErrorCode, OwneyMultiDepositResult, OwneyRouteResponse, OwneySDK, OwneySDKConfig, OwneyToken, OwneyUserProfile, OwneyWithdrawResult, RebalanceLog, WithdrawOptions };

package/dist/index.d.ts

@@ -29,8 +29,18 @@ interface IAgent {
     pause(state: ConnectionState, chainId: number): Promise<OwneyAgentStatus>;
     resume(state: ConnectionState, chainId: number): Promise<OwneyAgentStatus>;
     getUserProfile(state: ConnectionState, chainId: number): Promise<AgentUserProfile>;
-    getAgentApy(days: DailyApyDays): Promise<AgentApy>;
+    getAgentApy(days: DailyApyDays, options?: AgentApyOptions): Promise<AgentApy>;
 }
+/**
+ * Optional filters for per-agent APY lookups.
+ * - `tokenSymbol` / `chainId` scope the APY to a specific asset+chain when
+ *   the underlying provider supports it (Zyfai). Agents whose backends do
+ *   not yet support per-asset APY (Sail) will ignore these options.
+ */
+type AgentApyOptions = {
+    tokenSymbol?: string;
+    chainId?: number;
+};
 
 type AgentId = "zyfai" | "sail";
 type Asset = string;
@@ -60,6 +70,17 @@ type AccountApyOptions = {
 type AgentsApyOptions = {
     agentId?: AgentId;
     days: DailyApyDays;
+    /**
+     * Optional asset symbol (e.g. "USDC", "WETH") to scope the APY to a
+     * specific asset+chain. Ignored by agents whose backends do not yet
+     * support per-asset APY.
+     */
+    tokenSymbol?: string;
+    /**
+     * Optional chain id for per-asset APY lookups. Typically paired with
+     * `tokenSymbol`.
+     */
+    chainId?: number;
 };
 type DepositOptions = {
     amount: string;
@@ -110,6 +131,7 @@ interface OwneyEarnings {
 interface AccountAgentApy {
     walletAddress: string;
     weightedApyAfterFee?: number;
+    weightedApyAfterFeeDetails?: AgentApyDetails;
 }
 interface OwneyAccountApy {
     totalApy: string;
@@ -158,8 +180,12 @@ interface AgentUserProfile {
 interface OwneyUserProfile {
     agentUserProfile: Record<AgentId, AgentUserProfile>;
 }
+interface AgentApyDetails {
+    apyPerAsset: Partial<Record<OwneySupportedChainId, Partial<Record<OwneySupportedTokens, number>>>>;
+}
 interface AgentApy {
     averageApy: number;
+    detailedApys?: AgentApyDetails;
 }
 interface OwneyAgentApy {
     agentApy: Record<AgentId, AgentApy>;
@@ -177,6 +203,7 @@ declare class OwneySDK {
     private activeAgents;
     private state;
     private apiKey;
+    private initializingAgentsPromise;
     constructor(config: OwneySDKConfig);
     /**
      * Establish connection state for all subsequent SDK calls.
@@ -203,6 +230,7 @@ declare class OwneySDK {
     private requireChainId;
     private getAgent;
     private getActiveAgents;
+    private ensureAgentsInitialized;
     /**
      * Activate the user's smart wallet for the specified agents, or all chain-compatible agents if omitted.
      * Deploys the Safe contract and creates a session key if not already set up.
@@ -291,9 +319,14 @@ declare class OwneySDK {
      * @param options - Contains agentId (optional) and days ("7D", "14D", or "30D")
      * @param options.agentId - Optional. Agent to query. Omit for all agents.
      * @param options.days - Lookback period: "7D", "14D", or "30D"
+     * @param options.tokenSymbol - Optional asset symbol ("USDC" / "WETH") to
+     *   scope the APY to a specific asset+chain. Agents whose backends do not
+     *   support per-asset APY (currently Sail) ignore this.
+     * @param options.chainId - Optional chain id for per-asset APY lookups.
+     *   Typically paired with `tokenSymbol`.
      * @returns {AgentApy} for a single agent, or {OwneyAgentApy} with per-agent APY
      */
-    getAgentApy({ agentId, days, }: AgentsApyOptions): Promise<OwneyAgentApy | AgentApy>;
+    getAgentApy({ agentId, days, tokenSymbol, chainId, }: AgentsApyOptions): Promise<OwneyAgentApy | AgentApy>;
     /**
      * Get the current fund allocation percentages across agents.
      * @returns Object with agent names as keys and allocation percentages as values
@@ -301,13 +334,19 @@ declare class OwneySDK {
     getAgentAllocation(): Promise<OwneyAgentAllocation>;
 }
 
-declare class AgentNotFoundError extends Error {
+type OwneyErrorCode = "NOT_CONNECTED" | "NO_ACTIVE_CHAIN" | "WALLET_NO_ACCOUNTS" | "WALLET_ADDRESS_REQUIRED" | "AGENT_NOT_FOUND" | "AGENT_CHAIN_INCOMPATIBLE" | "AGENT_EMPTY_LIST" | "CHAIN_UNSUPPORTED" | "CHAIN_NO_COMPATIBLE_AGENTS" | "ASSET_UNSUPPORTED" | "ASSET_NO_COMPATIBLE_AGENTS" | "DEPOSIT_AMOUNT_TOO_SMALL" | "DEPOSIT_CALLBACK_REQUIRED" | "DEPOSIT_CALLBACK_INVALID" | "DEPOSIT_NO_PERMITTED_TOKENS" | "WITHDRAW_NO_PERMITTED_TOKENS" | "API_ROUTING_ERROR" | "API_ROUTING_FAILED" | "API_SAIL_ERROR" | "API_SAIL_TIMEOUT" | "API_NO_AGENTS" | "BALANCE_ALL_FAILED" | "ALLOCATION_ALL_FAILED" | "VALIDATION_INVALID_DAYS";
+declare class OwneyError extends Error {
+    readonly code: OwneyErrorCode;
+    readonly details?: Record<string, unknown>;
+    constructor(code: OwneyErrorCode, message: string, details?: Record<string, unknown>);
+}
+declare class AgentNotFoundError extends OwneyError {
     constructor(agentId: string, available: string[]);
 }
-declare class NotConnectedError extends Error {
+declare class NotConnectedError extends OwneyError {
     constructor();
 }
-declare class AgentChainIncompatibleError extends Error {
+declare class AgentChainIncompatibleError extends OwneyError {
     readonly incompatibleAgents: Array<{
         agentId: string;
         supportedChainIds: readonly number[];
@@ -319,4 +358,4 @@ declare class AgentChainIncompatibleError extends Error {
     }>, connectedChainId: number);
 }
 
-export { AccountAgentApy, AccountApyOptions, AgentApy, AgentBalance, AgentChainIncompatibleError, AgentEarnings, AgentHistoryEntry, AgentId, AgentNotFoundError, AgentSupportedAssets, AgentUserProfile, AgentWithdrawResult, AgentsApyOptions, Asset, ConnectionState, DailyApyDays, DepositCallback, DepositOptions, HistoryAction, HistoryFilters, HistoryOptions, HistoryTransaction, IAgent, NotConnectedError, OwneyAccountApy, OwneyAgentAllocation, OwneyAgentApy, OwneyAgentHistory, OwneyAgentStatus, OwneyBalances, OwneyDepositResult, OwneyEarnings, OwneyMultiDepositResult, OwneyRouteResponse, OwneySDK, OwneySDKConfig, OwneyToken, OwneyUserProfile, OwneyWithdrawResult, RebalanceLog, WithdrawOptions };
+export { AccountAgentApy, AccountApyOptions, AgentApy, AgentApyDetails, AgentBalance, AgentChainIncompatibleError, AgentEarnings, AgentHistoryEntry, AgentId, AgentNotFoundError, AgentSupportedAssets, AgentUserProfile, AgentWithdrawResult, AgentsApyOptions, Asset, ConnectionState, DailyApyDays, DepositCallback, DepositOptions, HistoryAction, HistoryFilters, HistoryOptions, HistoryTransaction, IAgent, NotConnectedError, OwneyAccountApy, OwneyAgentAllocation, OwneyAgentApy, OwneyAgentHistory, OwneyAgentStatus, OwneyBalances, OwneyDepositResult, OwneyEarnings, OwneyError, OwneyErrorCode, OwneyMultiDepositResult, OwneyRouteResponse, OwneySDK, OwneySDKConfig, OwneyToken, OwneyUserProfile, OwneyWithdrawResult, RebalanceLog, WithdrawOptions };