@owney/sdk 0.2.5 → 0.2.7

package/README.md

@@ -232,6 +232,8 @@ Returns: `AccountAgentApy` (single agent) or `OwneyAccountApy` (all agents)
 const apy = await sdk.getAccountApy({ agentId: "zyfai", days: "30D" });
 console.log(apy.walletAddress);       // "0x..."
 console.log(apy.weightedApyAfterFee); // 5.2
+// Per chain + token breakdown, when the agent reports it
+console.log(apy.weightedApyAfterFeeDetails?.apyPerAsset[8453]?.USDC);  // 5.4
 
 // All agents (balance-weighted)
 const allApy = await sdk.getAccountApy({ days: "30D" });
@@ -336,7 +338,7 @@ console.log(allProfiles.agentUserProfile.zyfai.smartWallet); // "0x..."
 console.log(allProfiles.agentUserProfile.sail.smartWallet);  // "0x..."
 ```
 
-### `getAgentApy({ agentId?, days })`
+### `getAgentApy({ agentId?, days, tokenSymbol?, chainId? })`
 
 Get the agent's average APY performance over a time period. Does not require a wallet connection.
 
@@ -344,18 +346,35 @@ Get the agent's average APY performance over a time period. Does not require a w
 |-------|------|-------------|
 | `agentId` | `"zyfai" \| "sail"` (optional) | Agent to query. Omit for all agents. |
 | `days` | `"7D" \| "14D" \| "30D"` | Lookback period |
+| `tokenSymbol` | `string` (optional) | Asset symbol (e.g. `"USDC"`, `"WETH"`). Scopes the upstream request to a specific asset when the agent's backend supports it. Zyfai forwards this; Sail currently ignores it at the API level. |
+| `chainId` | `number` (optional) | Chain id. Typically paired with `tokenSymbol` for per-asset+chain APY. Zyfai forwards this; Sail currently ignores it at the API level. |
 
 Returns: `AgentApy` (single agent) or `OwneyAgentApy` (all agents)
 
+Both agents populate `detailedApys.apyPerAsset` with a per-chain, per-token
+breakdown when available. `tokenSymbol` / `chainId` only affect whether the
+upstream query is scoped — the breakdown is built from whatever the agent
+returns.
+
 ```typescript
 // Single agent
 const apy = await sdk.getAgentApy({ agentId: "zyfai", days: "30D" });
 console.log(apy.averageApy);  // 8.5
+console.log(apy.detailedApys?.apyPerAsset[8453]?.USDC); // 8.7
 
 // All agents
 const allApy = await sdk.getAgentApy({ days: "30D" });
 console.log(allApy.agentApy.zyfai.averageApy); // 8.5
 console.log(allApy.agentApy.sail.averageApy);  // 6.2
+console.log(allApy.agentApy.sail.detailedApys?.apyPerAsset[42161]?.USDT); // 6.4
+
+// Scope the upstream query to USDC on Base (Zyfai-aware; Sail ignores the filter)
+const usdcBaseApy = await sdk.getAgentApy({
+  days: "30D",
+  tokenSymbol: "USDC",
+  chainId: 8453,
+});
+console.log(usdcBaseApy.agentApy.zyfai.averageApy); // APY scoped to USDC on Base
 ```
 
 ### `getAgentAllocation()`
@@ -428,6 +447,8 @@ type AccountApyOptions = {
 type AgentsApyOptions = {
   agentId?: AgentId;
   days: DailyApyDays;
+  tokenSymbol?: string;  // e.g. "USDC", "WETH"
+  chainId?: number;      // typically paired with tokenSymbol
 };
 ```
 
@@ -485,6 +506,7 @@ interface OwneyEarnings {
 interface AccountAgentApy {
   walletAddress: string;
   weightedApyAfterFee?: number;
+  weightedApyAfterFeeDetails?: AgentApyDetails;
 }
 
 interface OwneyAccountApy {
@@ -545,6 +567,16 @@ interface OwneyUserProfile {
 
 interface AgentApy {
   averageApy: number;
+  detailedApys?: AgentApyDetails;
+}
+
+interface AgentApyDetails {
+  // Per-chain, per-token APY breakdown. Only populated for the chain/token
+  // pairs that appear in SupportedAssets — entries may be missing when the
+  // upstream agent doesn't report APY for a given chain or token.
+  apyPerAsset: Partial<
+    Record<OwneySupportedChainId, Partial<Record<OwneySupportedTokens, number>>>
+  >;
 }
 
 interface OwneyAgentApy {