@owney/sdk 0.6.5-beta.0 → 0.6.5-beta.2

package/dist/index.d.cts

@@ -8,6 +8,13 @@ interface OwneySDKConfig {
      * Example: { 8453: "https://...", 42161: "https://..." }
      */
     zyfaiRpcUrls?: ZyfaiRpcUrlsConfig;
+    /**
+     * Optional override for the Owney routing API base URL used by the sponsored
+     * deposit callbacks (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.
+     */
+    routingApiBaseUrl?: string;
 }
 interface ConnectionState {
     provider: any;
@@ -15,8 +22,8 @@ interface ConnectionState {
     chainId: number | null;
 }
 declare const SUPPORTED_TOKENS: readonly ["USDC", "USDT", "WETH"];
-declare const SUPPORTED_CHAIN_IDS: readonly [8453, 42161];
-declare const SUPPORTED_CHAINS: readonly ["BASE", "ARBITRUM"];
+declare const SUPPORTED_CHAIN_IDS: readonly [8453, 42161, 1];
+declare const SUPPORTED_CHAINS: readonly ["BASE", "ARBITRUM", "ETHEREUM"];
 type OwneySupportedChainId = (typeof SUPPORTED_CHAIN_IDS)[number];
 type OwneySupportedChains = (typeof SUPPORTED_CHAINS)[number];
 type OwneySupportedTokens = (typeof SUPPORTED_TOKENS)[number];
@@ -53,6 +60,14 @@ type WithdrawOptions = {
 type AccountApyOptions = {
     agentId?: AgentId;
     days: DailyApyDays;
+    /**
+     * Optional asset symbol (e.g. "USDC", "WETH") to scope the daily APY series
+     * to a specific asset on the active chain. Without it the series blends every
+     * position on the chain, so two assets sharing a chain (USDC and WETH on
+     * Base/Arbitrum) would render one merged line. Agents whose backends do not
+     * expose per-asset positions ignore this. (ROUT-186)
+     */
+    tokenSymbol?: string;
 };
 type AllocationApyOptions = {
     agentId?: AgentId;
@@ -257,7 +272,12 @@ interface IAgent {
     withdraw(state: ConnectionState, chainId: number, token: OwneySupportedTokens, amount?: string): Promise<AgentWithdrawResult>;
     getBalances(state: ConnectionState, chainId: number): Promise<AgentBalance>;
     getEarnings(state: ConnectionState, chainId: number): Promise<AgentEarnings>;
-    getAccountApy(state: ConnectionState, chainId: number, days: DailyApyDays): Promise<AccountAgentApy>;
+    getAccountApy(state: ConnectionState, chainId: number, days: DailyApyDays, 
+    /**
+     * Optional asset symbol ("USDC" / "WETH") scoping the daily series to a
+     * single asset on the chain. Agents without per-asset positions ignore it.
+     */
+    tokenSymbol?: string): Promise<AccountAgentApy>;
     getHistory(state: ConnectionState, chainId: number, options?: HistoryFilters): Promise<OwneyAgentHistory>;
     getUserProfile(state: ConnectionState, chainId: number): Promise<AgentUserProfile>;
     /**
@@ -292,6 +312,7 @@ declare class OwneySDK {
     private state;
     private apiKey;
     private zyfaiRpcUrls?;
+    private routingApiBaseUrl?;
     private cachedSponsoredCallback;
     private cachedWethSponsoredCallback;
     private initializingAgentsPromise;
@@ -431,7 +452,7 @@ declare class OwneySDK {
      * @param options.days - Lookback period: "7D", "14D", or "30D"
      * @returns {AccountAgentApy} for a single agent, or {OwneyAccountApy} with totalApy and per-agent breakdown
      */
-    getAccountApy({ agentId, days, }: AccountApyOptions): Promise<OwneyAccountApy | AccountAgentApy>;
+    getAccountApy({ agentId, days, tokenSymbol, }: AccountApyOptions): Promise<OwneyAccountApy | AccountAgentApy>;
     /**
      * Get transaction history for a specific agent, or all agents.
      *

package/dist/index.d.ts

@@ -8,6 +8,13 @@ interface OwneySDKConfig {
      * Example: { 8453: "https://...", 42161: "https://..." }
      */
     zyfaiRpcUrls?: ZyfaiRpcUrlsConfig;
+    /**
+     * Optional override for the Owney routing API base URL used by the sponsored
+     * deposit callbacks (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.
+     */
+    routingApiBaseUrl?: string;
 }
 interface ConnectionState {
     provider: any;
@@ -15,8 +22,8 @@ interface ConnectionState {
     chainId: number | null;
 }
 declare const SUPPORTED_TOKENS: readonly ["USDC", "USDT", "WETH"];
-declare const SUPPORTED_CHAIN_IDS: readonly [8453, 42161];
-declare const SUPPORTED_CHAINS: readonly ["BASE", "ARBITRUM"];
+declare const SUPPORTED_CHAIN_IDS: readonly [8453, 42161, 1];
+declare const SUPPORTED_CHAINS: readonly ["BASE", "ARBITRUM", "ETHEREUM"];
 type OwneySupportedChainId = (typeof SUPPORTED_CHAIN_IDS)[number];
 type OwneySupportedChains = (typeof SUPPORTED_CHAINS)[number];
 type OwneySupportedTokens = (typeof SUPPORTED_TOKENS)[number];
@@ -53,6 +60,14 @@ type WithdrawOptions = {
 type AccountApyOptions = {
     agentId?: AgentId;
     days: DailyApyDays;
+    /**
+     * Optional asset symbol (e.g. "USDC", "WETH") to scope the daily APY series
+     * to a specific asset on the active chain. Without it the series blends every
+     * position on the chain, so two assets sharing a chain (USDC and WETH on
+     * Base/Arbitrum) would render one merged line. Agents whose backends do not
+     * expose per-asset positions ignore this. (ROUT-186)
+     */
+    tokenSymbol?: string;
 };
 type AllocationApyOptions = {
     agentId?: AgentId;
@@ -257,7 +272,12 @@ interface IAgent {
     withdraw(state: ConnectionState, chainId: number, token: OwneySupportedTokens, amount?: string): Promise<AgentWithdrawResult>;
     getBalances(state: ConnectionState, chainId: number): Promise<AgentBalance>;
     getEarnings(state: ConnectionState, chainId: number): Promise<AgentEarnings>;
-    getAccountApy(state: ConnectionState, chainId: number, days: DailyApyDays): Promise<AccountAgentApy>;
+    getAccountApy(state: ConnectionState, chainId: number, days: DailyApyDays, 
+    /**
+     * Optional asset symbol ("USDC" / "WETH") scoping the daily series to a
+     * single asset on the chain. Agents without per-asset positions ignore it.
+     */
+    tokenSymbol?: string): Promise<AccountAgentApy>;
     getHistory(state: ConnectionState, chainId: number, options?: HistoryFilters): Promise<OwneyAgentHistory>;
     getUserProfile(state: ConnectionState, chainId: number): Promise<AgentUserProfile>;
     /**
@@ -292,6 +312,7 @@ declare class OwneySDK {
     private state;
     private apiKey;
     private zyfaiRpcUrls?;
+    private routingApiBaseUrl?;
     private cachedSponsoredCallback;
     private cachedWethSponsoredCallback;
     private initializingAgentsPromise;
@@ -431,7 +452,7 @@ declare class OwneySDK {
      * @param options.days - Lookback period: "7D", "14D", or "30D"
      * @returns {AccountAgentApy} for a single agent, or {OwneyAccountApy} with totalApy and per-agent breakdown
      */
-    getAccountApy({ agentId, days, }: AccountApyOptions): Promise<OwneyAccountApy | AccountAgentApy>;
+    getAccountApy({ agentId, days, tokenSymbol, }: AccountApyOptions): Promise<OwneyAccountApy | AccountAgentApy>;
     /**
      * Get transaction history for a specific agent, or all agents.
      *