@owney/sdk 0.7.7 → 0.7.8

package/README.md

@@ -263,6 +263,25 @@ console.log(allEarnings.agentEarnings.zyfai.lifetimeEarnings); // 42.5
 console.log(allEarnings.agentEarnings.zyfai.tokens); // per-chain, per-asset breakdown
 ```
 
+### `refreshEarnings(agentId?)`
+
+Refresh earnings for agents whose earnings data may be outdated. If the latest
+snapshot is less than one hour old, the SDK returns it without recalculating.
+
+| Param     | Type                 | Description                          |
+| --------- | -------------------- | ------------------------------------ |
+| `agentId` | `"zyfai"` (optional) | Agent to refresh. Omit for all agents. |
+
+Returns: `AgentEarnings` (single agent) or `OwneyEarnings` (all agents)
+
+```typescript
+// Single agent
+const refreshed = await sdk.refreshEarnings("zyfai");
+
+// All agents
+const allRefreshed = await sdk.refreshEarnings();
+```
+
 ### `getAccountApy({ agentId?, days })`
 
 Get the weighted APY for the user's account. When querying all agents, the total APY is a balance-weighted average.

package/dist/index.cjs

@@ -871,6 +871,7 @@ var WETH_ADDRESS_BY_CHAIN = {
 var VIEM_CHAIN = { 8453: import_chains.base, 42161: import_chains.arbitrum, 1: import_chains.mainnet };
 var SPLITTING_ASSETS = ["USDC", "WETH"];
 var POOL_POLICY_CHAIN_IDS = [8453, 42161, 1];
+var EARNINGS_REFRESH_COOLDOWN_MS = 60 * 60 * 1e3;
 var ZyfaiAgent = class {
   id = "zyfai";
   supportedChainIds = [8453, 42161, 1];
@@ -922,6 +923,7 @@ var ZyfaiAgent = class {
   // successful decode is cached forever; failures are NOT cached so a transient
   // RPC error retries on the next fetch.
   withdrawAmountCache = /* @__PURE__ */ new Map();
+  earningsRefreshInFlight = null;
   constructor(apiKey, rpcUrls, referralSource) {
     this.rpcUrls = rpcUrls ?? DEFAULT_ZYFAI_RPC_URLS;
     this.sdk = new import_sdk.ZyfaiSDK({
@@ -1719,6 +1721,22 @@ var ZyfaiAgent = class {
     const raw = await this.sdk.getOnchainEarnings(smartWallet);
     return mapEarnings(raw, smartWallet);
   }
+  async refreshEarnings(state, chainId) {
+    if (this.earningsRefreshInFlight) return this.earningsRefreshInFlight;
+    this.earningsRefreshInFlight = (async () => {
+      const { smartWallet } = await this.resolveSmartWallet(state, chainId);
+      const current = await this.sdk.getOnchainEarnings(smartWallet);
+      const lastCheck = current.data.lastCheckTimestamp ? Date.parse(current.data.lastCheckTimestamp) : Number.NaN;
+      const isFresh = Number.isFinite(lastCheck) && Date.now() - lastCheck < EARNINGS_REFRESH_COOLDOWN_MS;
+      const earnings = isFresh ? current : await this.sdk.calculateOnchainEarnings(smartWallet);
+      return mapEarnings(earnings, smartWallet);
+    })();
+    try {
+      return await this.earningsRefreshInFlight;
+    } finally {
+      this.earningsRefreshInFlight = null;
+    }
+  }
   async getAccountApy(state, chainId, days, tokenSymbol) {
     const { smartWallet } = await this.resolveSmartWallet(state, chainId);
     const raw = await this.sdk.getDailyApyHistory(smartWallet, days);
@@ -3419,6 +3437,28 @@ var OwneySDK = class {
       agentEarnings: results
     };
   }
+  /**
+   * Return refreshed earnings while letting each agent own its refresh policy.
+   * Agents without a refresh capability fall back to their current snapshot.
+   */
+  async refreshEarnings(agentId) {
+    const state = this.requireState();
+    const chainId = this.requireChainId();
+    const refreshAgent = (agent) => agent.refreshEarnings?.(state, chainId) ?? agent.getEarnings(state, chainId);
+    if (agentId) return refreshAgent(this.getAgent(agentId));
+    let totalEarnings = 0;
+    const agentEarnings = {};
+    const refreshed = await Promise.all(
+      [...this.getActiveAgents().entries()].map(
+        async ([id, agent]) => [id, await refreshAgent(agent)]
+      )
+    );
+    for (const [id, earnings] of refreshed) {
+      agentEarnings[id] = earnings;
+      totalEarnings += Number(earnings.lifetimeEarnings);
+    }
+    return { totalEarnings: String(totalEarnings), agentEarnings };
+  }
   /**
    * Get the weighted APY for the user's account over a time period.
    * When querying all agents, the total APY is a balance-weighted average.

package/dist/index.d.cts

@@ -383,6 +383,11 @@ 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>;
+    /**
+     * Refresh the agent's earnings snapshot when its backend supports doing so.
+     * Implementations own freshness and request-deduplication policy.
+     */
+    refreshEarnings?(state: ConnectionState, chainId: number): Promise<AgentEarnings>;
     getAccountApy(state: ConnectionState, chainId: number, days: DailyApyDays, 
     /**
      * Optional asset symbol ("USDC" / "WETH") scoping the daily series to a
@@ -581,6 +586,11 @@ declare class OwneySDK {
      * @returns {AgentEarnings} for a single agent, or {OwneyEarnings} with totalEarnings and per-agent breakdown
      */
     getEarnings(agentId?: AgentId): Promise<OwneyEarnings | AgentEarnings>;
+    /**
+     * Return refreshed earnings while letting each agent own its refresh policy.
+     * Agents without a refresh capability fall back to their current snapshot.
+     */
+    refreshEarnings(agentId?: AgentId): Promise<OwneyEarnings | AgentEarnings>;
     /**
      * Get the weighted APY for the user's account over a time period.
      * When querying all agents, the total APY is a balance-weighted average.

package/dist/index.d.ts

@@ -383,6 +383,11 @@ 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>;
+    /**
+     * Refresh the agent's earnings snapshot when its backend supports doing so.
+     * Implementations own freshness and request-deduplication policy.
+     */
+    refreshEarnings?(state: ConnectionState, chainId: number): Promise<AgentEarnings>;
     getAccountApy(state: ConnectionState, chainId: number, days: DailyApyDays, 
     /**
      * Optional asset symbol ("USDC" / "WETH") scoping the daily series to a
@@ -581,6 +586,11 @@ declare class OwneySDK {
      * @returns {AgentEarnings} for a single agent, or {OwneyEarnings} with totalEarnings and per-agent breakdown
      */
     getEarnings(agentId?: AgentId): Promise<OwneyEarnings | AgentEarnings>;
+    /**
+     * Return refreshed earnings while letting each agent own its refresh policy.
+     * Agents without a refresh capability fall back to their current snapshot.
+     */
+    refreshEarnings(agentId?: AgentId): Promise<OwneyEarnings | AgentEarnings>;
     /**
      * Get the weighted APY for the user's account over a time period.
      * When querying all agents, the total APY is a balance-weighted average.

package/dist/index.js

@@ -838,6 +838,7 @@ var WETH_ADDRESS_BY_CHAIN = {
 var VIEM_CHAIN = { 8453: base, 42161: arbitrum, 1: mainnet };
 var SPLITTING_ASSETS = ["USDC", "WETH"];
 var POOL_POLICY_CHAIN_IDS = [8453, 42161, 1];
+var EARNINGS_REFRESH_COOLDOWN_MS = 60 * 60 * 1e3;
 var ZyfaiAgent = class {
   id = "zyfai";
   supportedChainIds = [8453, 42161, 1];
@@ -889,6 +890,7 @@ var ZyfaiAgent = class {
   // successful decode is cached forever; failures are NOT cached so a transient
   // RPC error retries on the next fetch.
   withdrawAmountCache = /* @__PURE__ */ new Map();
+  earningsRefreshInFlight = null;
   constructor(apiKey, rpcUrls, referralSource) {
     this.rpcUrls = rpcUrls ?? DEFAULT_ZYFAI_RPC_URLS;
     this.sdk = new ZyfaiSDK({
@@ -1686,6 +1688,22 @@ var ZyfaiAgent = class {
     const raw = await this.sdk.getOnchainEarnings(smartWallet);
     return mapEarnings(raw, smartWallet);
   }
+  async refreshEarnings(state, chainId) {
+    if (this.earningsRefreshInFlight) return this.earningsRefreshInFlight;
+    this.earningsRefreshInFlight = (async () => {
+      const { smartWallet } = await this.resolveSmartWallet(state, chainId);
+      const current = await this.sdk.getOnchainEarnings(smartWallet);
+      const lastCheck = current.data.lastCheckTimestamp ? Date.parse(current.data.lastCheckTimestamp) : Number.NaN;
+      const isFresh = Number.isFinite(lastCheck) && Date.now() - lastCheck < EARNINGS_REFRESH_COOLDOWN_MS;
+      const earnings = isFresh ? current : await this.sdk.calculateOnchainEarnings(smartWallet);
+      return mapEarnings(earnings, smartWallet);
+    })();
+    try {
+      return await this.earningsRefreshInFlight;
+    } finally {
+      this.earningsRefreshInFlight = null;
+    }
+  }
   async getAccountApy(state, chainId, days, tokenSymbol) {
     const { smartWallet } = await this.resolveSmartWallet(state, chainId);
     const raw = await this.sdk.getDailyApyHistory(smartWallet, days);
@@ -3390,6 +3408,28 @@ var OwneySDK = class {
       agentEarnings: results
     };
   }
+  /**
+   * Return refreshed earnings while letting each agent own its refresh policy.
+   * Agents without a refresh capability fall back to their current snapshot.
+   */
+  async refreshEarnings(agentId) {
+    const state = this.requireState();
+    const chainId = this.requireChainId();
+    const refreshAgent = (agent) => agent.refreshEarnings?.(state, chainId) ?? agent.getEarnings(state, chainId);
+    if (agentId) return refreshAgent(this.getAgent(agentId));
+    let totalEarnings = 0;
+    const agentEarnings = {};
+    const refreshed = await Promise.all(
+      [...this.getActiveAgents().entries()].map(
+        async ([id, agent]) => [id, await refreshAgent(agent)]
+      )
+    );
+    for (const [id, earnings] of refreshed) {
+      agentEarnings[id] = earnings;
+      totalEarnings += Number(earnings.lifetimeEarnings);
+    }
+    return { totalEarnings: String(totalEarnings), agentEarnings };
+  }
   /**
    * Get the weighted APY for the user's account over a time period.
    * When querying all agents, the total APY is a balance-weighted average.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@owney/sdk",
-  "version": "0.7.7",
+  "version": "0.7.8",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",