@lombard.finance/sdk 3.6.3 → 3.6.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lombard.finance/sdk",
-  "version": "3.6.3",
+  "version": "3.6.5",
   "dependencies": {
     "@lombard.finance/sdk-common": "^3.0.0",
     "viem": "^2.23.15",

package/src/index.ts

@@ -35,7 +35,12 @@ export {
   getPositionsSummary,
   type PositionsSummary,
 } from './metrics/get-positions-summary';
-export { getApy, type LbtcApy } from './metrics/get-lbtc-apy';
+export {
+  getApy,
+  type LbtcApy,
+  getEstimatedApy,
+  type LbtcEstimatedApy,
+} from './metrics/get-lbtc-apy';
 export {
   getAdditionalRewards,
   type RewardsDistribution,

package/src/metrics/get-lbtc-apy.ts

@@ -43,5 +43,31 @@ export async function getApy({
   return apy;
 }
 
-// url: https://bft-dev.stage.lombard.finance/api/v1/analytics/0x2513196b4fD01Ed5888d1dB49AB9a42208E9fF90/apy
-// {"lbtc_base_apy":0.18849167223827507, "lbtc_effective_apy":0.6828761605761976}
+type EstimatedApyResponse = { lbtc_estimated_apy: number };
+export type LbtcEstimatedApy = {
+  /**
+   * The estimated APY for LBTC based on the specified partner context.
+   *
+   * This value reflects a projected annual percentage yield that may vary
+   * depending on the `partnerId`, taking into account potential partner-specific
+   * incentives, compounding assumptions, or estimated future rewards.
+   */
+  estimatedApy: BigNumber;
+};
+
+/** Returns the estimated APY for LBTC. */
+export async function getEstimatedApy({
+  partnerId,
+  env,
+}: { partnerId?: string } & IEnvParam) {
+  const { baseApiUrl } = getApiConfig(env);
+
+  const url = `${baseApiUrl}/api/v1/analytics/estimated-apy?partner_id=${partnerId || ''}`;
+  const { data } = await axios.get<EstimatedApyResponse>(url);
+
+  const apy: LbtcEstimatedApy = {
+    estimatedApy: BigNumber(data.lbtc_estimated_apy),
+  };
+
+  return apy;
+}

package/src/metrics/get-positions-summary.ts

@@ -22,6 +22,7 @@ type Response = {
     },
   ];
   last_updated: string;
+  in_progress: boolean;
 };
 
 function mapRewardAssetToToken(asset: PositionAsset) {
@@ -83,6 +84,19 @@ export type PositionsSummary = {
    * The timestamp when the PnL data was last updated.
    */
   lastUpdated: Date;
+  /**
+   * Indicates whether the backend is currently processing the PnL calculation.
+   *
+   * - `true`: A new calculation request was received, but the backend is experiencing high load
+   *   or processing is not yet complete. The latest data is not yet available.
+   *
+   * - `false`: The most recent calculation has been completed and cached.
+   *   Use `lastUpdated` to understand how fresh the data is:
+   *   - If `lastUpdated` is recent (e.g., within the last few seconds), you're seeing the latest data.
+   *   - If `lastUpdated` is up to 30 minutes old, you're seeing cached data from a recent request.
+   *     The backend avoids recalculating within this caching window.
+   */
+  inProgress: boolean;
 };
 
 /** Retrieves the yield positions summary for the specified account address. */
@@ -110,25 +124,8 @@ export async function getPositionsSummary({
       rate: BigNumber(ds.rate || 0),
     })),
     lastUpdated: new Date(data.last_updated),
+    inProgress: Boolean(data.in_progress),
   };
 
   return info;
 }
-
-// Response example:
-// url: https://bft-dev.stage.lombard.finance/api/v1/analytics/0x2513196b4fD01Ed5888d1dB49AB9a42208E9fF90/summary
-// {
-//   btc_price_usd: { price: 118395.552997, timestamp: '2025-07-23T11:01:59Z' },
-//   btc_value: 0.0003895271690089053,
-//   btc_pnl: 8.716900890527854e-8,
-//   snapshot: [
-//     {
-//       asset: 'ASSET_LBTC',
-//       type: 'BALANCE_TYPE_HOLDING',
-//       balance: 0.00038944,
-//       pnl: 8.716900890527854e-8,
-//       rate: 1.0002238316785776,
-//     },
-//   ],
-//   last_updated: '2025-07-23T11:38:52.516364988Z',
-// }

package/src/tokens/token-addresses.ts

@@ -39,6 +39,7 @@ export const TOKEN_ADDRESSES: TokenAddresses = {
       [ChainId.berachain]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
       [ChainId.binanceSmartChain]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
       [ChainId.corn]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
+      [ChainId.etherlink]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
       [ChainId.katana]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
       [ChainId.morph]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',
       [ChainId.sonic]: '0xecAc9C5F704e954931349Da37F60E39f515c11c1',