@lombard.finance/sdk 3.6.3 → 3.6.4

package/README.md

@@ -557,6 +557,16 @@ The results of the above includes:
     _Formula: `balance * rate = BTC equivalent`_
 * **`lastUpdated: Date`**  
   The timestamp when the position summary was last updated.
+* **`inProgress: boolean`**
+  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.
+
 
 #### 9.6. Getting the LBTC APY
 
@@ -575,6 +585,22 @@ The above returns:
 * **`effectiveApy: BigNumber`**  
   The effective APY for LBTC, including any additional rewards, compounding effects, or protocol-specific incentives.
 
+To retrieve the estimated APY (annual percentage yield) for LBTC in the context of a specific partner integration, use the `getEstimatedApy` function:
+
+```javascript
+const estimated = await getEstimatedApy({
+  partnerId, // Optional partner identifier. Influences the estimated APY.
+  env,       // Optional env flag
+});
+```
+
+The above returns:
+
+* **`estimatedApy: BigNumber`**
+  The estimated APY for LBTC, taking into account partner-specific incentives, compounding assumptions, and projected rewards. This value may differ from the effective APY depending on the partner context.
+
+> **Note**: If no `partnerId` is provided, the function returns a default estimate based on global assumptions.
+
 #### 9.7. Getting the additional rewards data
 
 In order to retrieve the additional rewards that have been distributed or are pending use the below function:

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index2.cjs");exports.BTC_DECIMALS=e.BTC_DECIMALS;exports.BasculeDepositStatus=e.BasculeDepositStatus;exports.BlockchainIdentifier=e.BlockchainIdentifier;exports.CHAIN_ID_TO_VIEM_CHAIN_MAP=e.CHAIN_ID_TO_VIEM_CHAIN_MAP;exports.ChainId=e.ChainId;exports.ENotarizationStatus=e.ENotarizationStatus;exports.ESessionState=e.ESessionState;exports.Env=e.t;exports.OFT_GAS_LIMIT=e.OFT_GAS_LIMIT;exports.OFT_HI_GAS_LIMIT=e.OFT_HI_GAS_LIMIT;exports.OFT_HI_GAS_LIMIT_CHAINS=e.OFT_HI_GAS_LIMIT_CHAINS;exports.PayoutTxStatus=e.PayoutTxStatus;exports.RATIO_TOKEN_MAP=e.RATIO_TOKEN_MAP;exports.RewardBlockchainType=e.RewardBlockchainType;exports.RewardToken=e.RewardToken;exports.RewardWithdrawalStatus=e.RewardWithdrawalStatus;exports.SANCTIONED_ADDRESS=e.SANCTIONED_ADDRESS;exports.SATOSHI_SCALE=e.SATOSHI_SCALE;exports.SOLANA_DEVNET_CHAIN=e.SOLANA_DEVNET_CHAIN;exports.SOLANA_MAINNET_CHAIN=e.SOLANA_MAINNET_CHAIN;exports.SOLANA_TESTNET_CHAIN=e.SOLANA_TESTNET_CHAIN;exports.SUI_DEVNET_CHAIN=e.SUI_DEVNET_CHAIN;exports.SUI_LOCALNET_CHAIN=e.SUI_LOCALNET_CHAIN;exports.SUI_MAINNET_CHAIN=e.SUI_MAINNET_CHAIN;exports.SUI_TESTNET_CHAIN=e.SUI_TESTNET_CHAIN;exports.TOKEN_ADDRESSES=e.TOKEN_ADDRESSES;exports.Token=e.Token;exports.Vault=e.Vault;exports.addChain=e.addChain;exports.approveLBTC=e.approveLBTC;exports.bridge=e.bridge;exports.bridgeCCIP=e.bridgeCCIP;exports.bridgeOFT=e.bridgeOFT;exports.cancelWithdraw=e.cancelWithdraw;exports.claimLBTC=e.claimLBTC;exports.claimReward=e.claimReward;exports.deposit=e.deposit;exports.fromSatoshi=e.fromSatoshi;exports.generateDepositBtcAddress=e.generateDepositBtcAddress;exports.getAdditionalRewards=e.getAdditionalRewards;exports.getApiConfig=e.getApiConfig;exports.getApy=e.getApy;exports.getBasculeDepositStatus=e.getBasculeDepositStatus;exports.getBaseNetworkByEnv=e.getBaseNetworkByEnv;exports.getBridgeInfo=e.getBridgeInfo;exports.getBscNetworkByEnv=e.getBscNetworkByEnv;exports.getChainIdByName=e.getChainIdByName;exports.getChainNameById=e.getChainNameById;exports.getDepositBtcAddress=e.getDepositBtcAddress;exports.getDepositBtcAddresses=e.getDepositBtcAddresses;exports.getDepositsByAddress=e.getDepositsByAddress;exports.getEthNetworkByEnv=e.getEthNetworkByEnv;exports.getExchangeRatio=e.getExchangeRatio;exports.getLBTCBurningFee=e.getLBTCBurningFee;exports.getLBTCExchangeRate=e.getLBTCExchangeRate;exports.getLBTCMintingFee=e.getLBTCMintingFee;exports.getLBTCStats=e.getLBTCStats;exports.getLBTCTotalSupply=e.getLBTCTotalSupply;exports.getLbtcContractAddresses=e.getLbtcContractAddresses;exports.getMintingFee=e.getMintingFee;exports.getNetworkFeeSignature=e.getNetworkFeeSignature;exports.getPermitNonce=e.getPermitNonce;exports.getPointsByAddress=e.getPointsByAddress;exports.getPositionsSummary=e.getPositionsSummary;exports.getRedeemFee=e.getRedeemFee;exports.getRewardBalances=e.getRewardBalances;exports.getRewardSigningData=e.getRewardSigningData;exports.getRewardWithdrawalFee=e.getRewardWithdrawalFee;exports.getRewardWithdrawals=e.getRewardWithdrawals;exports.getShareValue=e.getShareValue;exports.getSharesByAddress=e.getSharesByAddress;exports.getSolanaNetworkByEnv=e.getSolanaNetworkByEnv;exports.getSonicNetworkByEnv=e.getSonicNetworkByEnv;exports.getStakeAndBakeFee=e.getStakeAndBakeFee;exports.getSuiNetworkByEnv=e.getSuiNetworkByEnv;exports.getUnstakesByAddress=e.getUnstakesByAddress;exports.getUserStakeAndBakeSignature=e.getUserStakeAndBakeSignature;exports.getVaultApy=e.getVaultApy;exports.getVaultDeposits=e.getVaultDeposits;exports.getVaultPoints=e.getVaultPoints;exports.getVaultTVL=e.getVaultTVL;exports.getVaultWithdrawals=e.getVaultWithdrawals;exports.isKatanaChain=e.isKatanaChain;exports.isRewardTokenSupported=e.isRewardTokenSupported;exports.isValidChain=e.isValidChain;exports.katana=e.katana;exports.katanaTatara=e.katanaTatara;exports.mintToken=e.mintToken;exports.queueWithdraw=e.queueWithdraw;exports.redeemToken=e.redeemToken;exports.setReferral=e.setReferral;exports.signLbtcDestinationAddr=e.signLbtcDestinationAddr;exports.signNetworkFee=e.signNetworkFee;exports.signStakeAndBake=e.signStakeAndBake;exports.storeNetworkFeeSignature=e.storeNetworkFeeSignature;exports.storeStakeAndBakeSignature=e.storeStakeAndBakeSignature;exports.tac=e.tac;exports.toSatoshi=e.toSatoshi;exports.unstakeLBTC=e.unstakeLBTC;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index2.cjs");exports.BTC_DECIMALS=e.BTC_DECIMALS;exports.BasculeDepositStatus=e.BasculeDepositStatus;exports.BlockchainIdentifier=e.BlockchainIdentifier;exports.CHAIN_ID_TO_VIEM_CHAIN_MAP=e.CHAIN_ID_TO_VIEM_CHAIN_MAP;exports.ChainId=e.ChainId;exports.ENotarizationStatus=e.ENotarizationStatus;exports.ESessionState=e.ESessionState;exports.Env=e.t;exports.OFT_GAS_LIMIT=e.OFT_GAS_LIMIT;exports.OFT_HI_GAS_LIMIT=e.OFT_HI_GAS_LIMIT;exports.OFT_HI_GAS_LIMIT_CHAINS=e.OFT_HI_GAS_LIMIT_CHAINS;exports.PayoutTxStatus=e.PayoutTxStatus;exports.RATIO_TOKEN_MAP=e.RATIO_TOKEN_MAP;exports.RewardBlockchainType=e.RewardBlockchainType;exports.RewardToken=e.RewardToken;exports.RewardWithdrawalStatus=e.RewardWithdrawalStatus;exports.SANCTIONED_ADDRESS=e.SANCTIONED_ADDRESS;exports.SATOSHI_SCALE=e.SATOSHI_SCALE;exports.SOLANA_DEVNET_CHAIN=e.SOLANA_DEVNET_CHAIN;exports.SOLANA_MAINNET_CHAIN=e.SOLANA_MAINNET_CHAIN;exports.SOLANA_TESTNET_CHAIN=e.SOLANA_TESTNET_CHAIN;exports.SUI_DEVNET_CHAIN=e.SUI_DEVNET_CHAIN;exports.SUI_LOCALNET_CHAIN=e.SUI_LOCALNET_CHAIN;exports.SUI_MAINNET_CHAIN=e.SUI_MAINNET_CHAIN;exports.SUI_TESTNET_CHAIN=e.SUI_TESTNET_CHAIN;exports.TOKEN_ADDRESSES=e.TOKEN_ADDRESSES;exports.Token=e.Token;exports.Vault=e.Vault;exports.addChain=e.addChain;exports.approveLBTC=e.approveLBTC;exports.bridge=e.bridge;exports.bridgeCCIP=e.bridgeCCIP;exports.bridgeOFT=e.bridgeOFT;exports.cancelWithdraw=e.cancelWithdraw;exports.claimLBTC=e.claimLBTC;exports.claimReward=e.claimReward;exports.deposit=e.deposit;exports.fromSatoshi=e.fromSatoshi;exports.generateDepositBtcAddress=e.generateDepositBtcAddress;exports.getAdditionalRewards=e.getAdditionalRewards;exports.getApiConfig=e.getApiConfig;exports.getApy=e.getApy;exports.getBasculeDepositStatus=e.getBasculeDepositStatus;exports.getBaseNetworkByEnv=e.getBaseNetworkByEnv;exports.getBridgeInfo=e.getBridgeInfo;exports.getBscNetworkByEnv=e.getBscNetworkByEnv;exports.getChainIdByName=e.getChainIdByName;exports.getChainNameById=e.getChainNameById;exports.getDepositBtcAddress=e.getDepositBtcAddress;exports.getDepositBtcAddresses=e.getDepositBtcAddresses;exports.getDepositsByAddress=e.getDepositsByAddress;exports.getEstimatedApy=e.getEstimatedApy;exports.getEthNetworkByEnv=e.getEthNetworkByEnv;exports.getExchangeRatio=e.getExchangeRatio;exports.getLBTCBurningFee=e.getLBTCBurningFee;exports.getLBTCExchangeRate=e.getLBTCExchangeRate;exports.getLBTCMintingFee=e.getLBTCMintingFee;exports.getLBTCStats=e.getLBTCStats;exports.getLBTCTotalSupply=e.getLBTCTotalSupply;exports.getLbtcContractAddresses=e.getLbtcContractAddresses;exports.getMintingFee=e.getMintingFee;exports.getNetworkFeeSignature=e.getNetworkFeeSignature;exports.getPermitNonce=e.getPermitNonce;exports.getPointsByAddress=e.getPointsByAddress;exports.getPositionsSummary=e.getPositionsSummary;exports.getRedeemFee=e.getRedeemFee;exports.getRewardBalances=e.getRewardBalances;exports.getRewardSigningData=e.getRewardSigningData;exports.getRewardWithdrawalFee=e.getRewardWithdrawalFee;exports.getRewardWithdrawals=e.getRewardWithdrawals;exports.getShareValue=e.getShareValue;exports.getSharesByAddress=e.getSharesByAddress;exports.getSolanaNetworkByEnv=e.getSolanaNetworkByEnv;exports.getSonicNetworkByEnv=e.getSonicNetworkByEnv;exports.getStakeAndBakeFee=e.getStakeAndBakeFee;exports.getSuiNetworkByEnv=e.getSuiNetworkByEnv;exports.getUnstakesByAddress=e.getUnstakesByAddress;exports.getUserStakeAndBakeSignature=e.getUserStakeAndBakeSignature;exports.getVaultApy=e.getVaultApy;exports.getVaultDeposits=e.getVaultDeposits;exports.getVaultPoints=e.getVaultPoints;exports.getVaultTVL=e.getVaultTVL;exports.getVaultWithdrawals=e.getVaultWithdrawals;exports.isKatanaChain=e.isKatanaChain;exports.isRewardTokenSupported=e.isRewardTokenSupported;exports.isValidChain=e.isValidChain;exports.katana=e.katana;exports.katanaTatara=e.katanaTatara;exports.mintToken=e.mintToken;exports.queueWithdraw=e.queueWithdraw;exports.redeemToken=e.redeemToken;exports.setReferral=e.setReferral;exports.signLbtcDestinationAddr=e.signLbtcDestinationAddr;exports.signNetworkFee=e.signNetworkFee;exports.signStakeAndBake=e.signStakeAndBake;exports.storeNetworkFeeSignature=e.storeNetworkFeeSignature;exports.storeStakeAndBakeSignature=e.storeStakeAndBakeSignature;exports.tac=e.tac;exports.toSatoshi=e.toSatoshi;exports.unstakeLBTC=e.unstakeLBTC;

package/dist/index.js

@@ -1,11 +1,11 @@
-import { aR as e, V as t, av as i, aJ as n, aI as r, F as g, G as d, t as o, y as S, z as A, O as T, P as N, aP as B, an as I, at as C, ar as _, A as E, aS as k, S as u, h as w, j as l, k as c, aH as h, m as L, n as p, aQ as y, aO as D, ac as R, aM as O, a2 as F, v as m, w as H, x as M, ag as V, a3 as v, al as P, ad as U, aT as f, C as W, r as b, au as x, q as G, W as K, az as q, u as z, ay as j, aD as J, aw as Q, D as X, E as Y, I as Z, ax as $, K as aa, Y as sa, J as ea, X as ta, o as ia, $ as na, aN as ra, Z as ga, L as da, a0 as oa, M as Sa, p as Aa, _ as Ta, am as Na, ao as Ba, ap as Ia, aq as Ca, aa as _a, ab as Ea, aC as ka, aB as ua, a1 as wa, aA as la, N as ca, Q as ha, ak as La, ae as pa, ai as ya, aj as Da, ah as Ra, aK as Oa, as as Fa, aL as ma, aE as Ha, aF as Ma, a4 as Va, af as va, a9 as Pa, R as Ua, a5 as fa, a6 as Wa, a7 as ba, T as xa, U as Ga, aG as Ka, aU as qa, a8 as za } from "./index2.js";
+import { aS as e, W as t, aw as i, aK as n, aJ as g, G as r, I as d, u as o, z as S, A, O as T, Q as N, aQ as B, ao as I, au as C, as as E, C as _, aT as k, S as u, h as w, j as l, k as c, aI as h, m as L, n as p, aR as y, aP as D, ad as R, aN as O, a3 as m, w as F, x as H, y as V, ah as M, a4 as v, am as P, ae as U, aU as f, D as W, t as b, av as x, q as G, X as K, aA as q, v as z, az as j, aE as J, ax as Q, E as X, F as Y, J as Z, r as $, ay as aa, L as sa, Z as ea, K as ta, Y as ia, o as na, a0 as ga, aO as ra, _ as da, M as oa, a1 as Sa, N as Aa, p as Ta, $ as Na, an as Ba, ap as Ia, aq as Ca, ar as Ea, ab as _a, ac as ka, aD as ua, aC as wa, a2 as la, aB as ca, P as ha, R as La, al as pa, af as ya, aj as Da, ak as Ra, ai as Oa, aL as ma, at as Fa, aM as Ha, aF as Va, aG as Ma, a5 as va, ag as Pa, aa as Ua, T as fa, a6 as Wa, a7 as ba, a8 as xa, U as Ga, V as Ka, aH as qa, aV as za, a9 as ja } from "./index2.js";
 export {
   e as BTC_DECIMALS,
   t as BasculeDepositStatus,
   i as BlockchainIdentifier,
   n as CHAIN_ID_TO_VIEM_CHAIN_MAP,
-  r as ChainId,
-  g as ENotarizationStatus,
+  g as ChainId,
+  r as ENotarizationStatus,
   d as ESessionState,
   o as Env,
   S as OFT_GAS_LIMIT,
@@ -15,8 +15,8 @@ export {
   B as RATIO_TOKEN_MAP,
   I as RewardBlockchainType,
   C as RewardToken,
-  _ as RewardWithdrawalStatus,
-  E as SANCTIONED_ADDRESS,
+  E as RewardWithdrawalStatus,
+  _ as SANCTIONED_ADDRESS,
   k as SATOSHI_SCALE,
   u as SOLANA_DEVNET_CHAIN,
   w as SOLANA_MAINNET_CHAIN,
@@ -29,11 +29,11 @@ export {
   D as Token,
   R as Vault,
   O as addChain,
-  F as approveLBTC,
-  m as bridge,
+  m as approveLBTC,
+  F as bridge,
   H as bridgeCCIP,
-  M as bridgeOFT,
-  V as cancelWithdraw,
+  V as bridgeOFT,
+  M as cancelWithdraw,
   v as claimLBTC,
   P as claimReward,
   U as deposit,
@@ -51,52 +51,53 @@ export {
   X as getDepositBtcAddress,
   Y as getDepositBtcAddresses,
   Z as getDepositsByAddress,
-  $ as getEthNetworkByEnv,
-  aa as getExchangeRatio,
-  sa as getLBTCBurningFee,
-  ea as getLBTCExchangeRate,
-  ta as getLBTCMintingFee,
-  ia as getLBTCStats,
-  na as getLBTCTotalSupply,
+  $ as getEstimatedApy,
+  aa as getEthNetworkByEnv,
+  sa as getExchangeRatio,
+  ea as getLBTCBurningFee,
+  ta as getLBTCExchangeRate,
+  ia as getLBTCMintingFee,
+  na as getLBTCStats,
+  ga as getLBTCTotalSupply,
   ra as getLbtcContractAddresses,
-  ga as getMintingFee,
-  da as getNetworkFeeSignature,
-  oa as getPermitNonce,
-  Sa as getPointsByAddress,
-  Aa as getPositionsSummary,
-  Ta as getRedeemFee,
-  Na as getRewardBalances,
-  Ba as getRewardSigningData,
-  Ia as getRewardWithdrawalFee,
-  Ca as getRewardWithdrawals,
+  da as getMintingFee,
+  oa as getNetworkFeeSignature,
+  Sa as getPermitNonce,
+  Aa as getPointsByAddress,
+  Ta as getPositionsSummary,
+  Na as getRedeemFee,
+  Ba as getRewardBalances,
+  Ia as getRewardSigningData,
+  Ca as getRewardWithdrawalFee,
+  Ea as getRewardWithdrawals,
   _a as getShareValue,
-  Ea as getSharesByAddress,
-  ka as getSolanaNetworkByEnv,
-  ua as getSonicNetworkByEnv,
-  wa as getStakeAndBakeFee,
-  la as getSuiNetworkByEnv,
-  ca as getUnstakesByAddress,
-  ha as getUserStakeAndBakeSignature,
-  La as getVaultApy,
-  pa as getVaultDeposits,
-  ya as getVaultPoints,
-  Da as getVaultTVL,
-  Ra as getVaultWithdrawals,
-  Oa as isKatanaChain,
+  ka as getSharesByAddress,
+  ua as getSolanaNetworkByEnv,
+  wa as getSonicNetworkByEnv,
+  la as getStakeAndBakeFee,
+  ca as getSuiNetworkByEnv,
+  ha as getUnstakesByAddress,
+  La as getUserStakeAndBakeSignature,
+  pa as getVaultApy,
+  ya as getVaultDeposits,
+  Da as getVaultPoints,
+  Ra as getVaultTVL,
+  Oa as getVaultWithdrawals,
+  ma as isKatanaChain,
   Fa as isRewardTokenSupported,
-  ma as isValidChain,
-  Ha as katana,
+  Ha as isValidChain,
+  Va as katana,
   Ma as katanaTatara,
-  Va as mintToken,
-  va as queueWithdraw,
-  Pa as redeemToken,
-  Ua as setReferral,
-  fa as signLbtcDestinationAddr,
-  Wa as signNetworkFee,
-  ba as signStakeAndBake,
-  xa as storeNetworkFeeSignature,
-  Ga as storeStakeAndBakeSignature,
-  Ka as tac,
-  qa as toSatoshi,
-  za as unstakeLBTC
+  va as mintToken,
+  Pa as queueWithdraw,
+  Ua as redeemToken,
+  fa as setReferral,
+  Wa as signLbtcDestinationAddr,
+  ba as signNetworkFee,
+  xa as signStakeAndBake,
+  Ga as storeNetworkFeeSignature,
+  Ka as storeStakeAndBakeSignature,
+  qa as tac,
+  za as toSatoshi,
+  ja as unstakeLBTC
 };