@lombard.finance/sdk 3.1.0 → 3.2.0

package/README.md

@@ -82,6 +82,15 @@ Read more about Lombard's mission: https://www.lombard.finance
 
      9.4. [Getting the withdrawal history (checking withdrawal status)](#94-getting-the-withdrawal-history-checking-withdrawal-status)
 
+  10. [Metrics](#10-metrics)
+
+      10.1. [Getting the vault's TVL](#101-getting-the-vaults-tvl)
+
+      10.2. [Getting the vault's performance data](#102-getting-the-vaults-performance-data)
+      
+      10.3. [Getting the LBTC statistics](#103-getting-the-lbtc-statistics)
+
+
 
 ## Installation
 
@@ -93,11 +102,12 @@ The SDK depends on the following packages:
 * bignumber.js@9
 * bitcoinjs-lib@6.1.5
 * @bitcoin-js/tiny-secp256k1-asmjs@2.2.3
+* @layerzerolabs/lz-v2-utilities@3.0.17
 
 You may install them by running the following command:
 
 ```bash
-npm i --save viem@^2.23.15 axios@^1 bignumber.js@^9 @bitcoin-js/tiny-secp256k1-asmjs@2.2.3 bitcoinjs-lib@6.1.5
+npm i --save viem@^2.23.15 axios@^1 bignumber.js@^9 @bitcoin-js/tiny-secp256k1-asmjs@2.2.3 bitcoinjs-lib@6.1.5 @layerzerolabs/lz-v2-utilities@3.0.17
 ```
 
 ### 2. SDK installation
@@ -581,3 +591,51 @@ The function returns an array of:
 * `status` - the withdrawal status,
 * `estimatedTimeSent` - the estimated time when the funds are sent,
 * `timestamp` - the timestamp.
+
+### 10. Metrics
+
+#### 10.1. Getting the vault's TVL
+
+The vault's TVL can be obtained by calling the `getVaultTVL` function.
+
+```javascript
+const data = await getVaultTVL({ vaultKey: Vault.Veda });
+```
+
+The above returns:
+* `btcBalance` - the amount of BTC locked into the vault,
+* `btcPrice` - the current price of BTC,
+* `tvl` - the amount of USD locked into the vault.
+
+#### 10.2. Getting the vault's performance data.
+
+The performance of the vault can be checked via the `getVaultApy` function.
+As in the example below:
+
+```javascript
+const APYs = await getVaultApy({
+  aggregationPeriod: 7, // The aggregation period in days, only 7, 14, and 30 are allowed.
+  chainId: ChainId.ethereum, // The vault's chain - can be omitted, defaults to `Ethereum`.
+  vaultKey: Vault.Veda // The vault identifier - can be omitted, default to `Vault.Veda`
+});
+```
+
+The above returns an array of APY entries sorted in descending order (newest first).
+Each entry contains:
+
+* `apy` - the APY value,
+* `allocations` - the record of general allocations in protocols used by the vault,
+* `breakdown` - the detailed record of allocations and APY values broken down by chain and protocol,
+* `timestamp` - the timestamp of the entry.
+
+#### 10.3. Getting the LBTC statistics.
+
+The simple set of LBTC statistics is accessible via `getLBTCStats` function.
+
+The stats contain:
+
+* `historicalHolders` - the number of all-time LBTC holders,
+* `holders` - the number of current LBTC holders,
+* `price` - the current BTC price,
+* `supply` - the number of LBTC minted,
+* `tvl` - the Lombard's TVL in USD.

package/dist/index.cjs

@@ -1,2 +1,2 @@
-"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.n;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.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.Vault=e.Vault;exports.approveLBTC=e.approveLBTC;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.getApiConfig=e.getApiConfig;exports.getBasculeDepositStatus=e.getBasculeDepositStatus;exports.getBaseNetworkByEnv=e.getBaseNetworkByEnv;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.getLBTCExchangeRate=e.getLBTCExchangeRate;exports.getLBTCMintingFee=e.getLBTCMintingFee;exports.getLBTCTotalSupply=e.getLBTCTotalSupply;exports.getLbtcContractAddresses=e.getLbtcContractAddresses;exports.getNetworkFeeSignature=e.getNetworkFeeSignature;exports.getPermitNonce=e.getPermitNonce;exports.getPointsByAddress=e.getPointsByAddress;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.getSonicNetworkByEnv=e.getSonicNetworkByEnv;exports.getStakeAndBakeFee=e.getStakeAndBakeFee;exports.getSuiNetworkByEnv=e.getSuiNetworkByEnv;exports.getUnstakesByAddress=e.getUnstakesByAddress;exports.getUserStakeAndBakeSignature=e.getUserStakeAndBakeSignature;exports.getVaultDeposits=e.getVaultDeposits;exports.getVaultPoints=e.getVaultPoints;exports.getVaultWithdrawals=e.getVaultWithdrawals;exports.isRewardTokenSupported=e.isRewardTokenSupported;exports.isValidChain=e.isValidChain;exports.queueWithdraw=e.queueWithdraw;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.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.n;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.Vault=e.Vault;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.getApiConfig=e.getApiConfig;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.getLBTCExchangeRate=e.getLBTCExchangeRate;exports.getLBTCMintingFee=e.getLBTCMintingFee;exports.getLBTCStats=e.getLBTCStats;exports.getLBTCTotalSupply=e.getLBTCTotalSupply;exports.getLbtcContractAddresses=e.getLbtcContractAddresses;exports.getNetworkFeeSignature=e.getNetworkFeeSignature;exports.getPermitNonce=e.getPermitNonce;exports.getPointsByAddress=e.getPointsByAddress;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.isRewardTokenSupported=e.isRewardTokenSupported;exports.isValidChain=e.isValidChain;exports.queueWithdraw=e.queueWithdraw;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.toSatoshi=e.toSatoshi;exports.unstakeLBTC=e.unstakeLBTC;
 //# sourceMappingURL=index.cjs.map

package/dist/index.js

@@ -1,71 +1,82 @@
-import { ai as s, D as t, a3 as r, ag as i, af as n, E as d, r as g, n as o, X as S, a1 as B, $ as A, S as N, aj as k, ab as w, ad as C, ae as l, ac as c, V as u, L as E, h as I, M as T, U as h, f as p, ak as _, m as D, a2 as y, F as L, a7 as R, a6 as m, aa as V, a4 as v, o as f, p as F, t as H, a5 as U, u as W, G as M, I as O, am as P, v as b, J as x, w as j, W as q, Y as z, Z as G, _ as J, R as K, T as Q, a9 as X, K as Y, a8 as Z, x as $, y as aa, j as ea, l as sa, k as ta, a0 as ra, ah as ia, q as na, z as da, N as ga, O as oa, P as Sa, A as Ba, C as Aa, al as Na, Q as ka } from "./index2.js";
+import { au as s, K as t, ag as r, ar as i, aq as g, E as n, x as d, n as o, a8 as S, ae as A, ac as N, t as B, av as C, S as T, f as E, h as I, j as l, ap as w, k, l as u, Z as _, Q as c, p as h, q as p, r as L, a1 as D, R as y, a6 as R, _ as V, aw as v, u as H, af as m, L as O, ak as f, o as F, aj as M, ao as U, ah as W, v as b, w as P, y as x, ai as q, z as j, M as z, m as G, N as J, at as K, A as Q, O as X, C as Y, a7 as Z, a9 as $, aa, ab as ea, X as sa, Y as ta, an as ra, am as ia, P as ga, al as na, D as da, F as oa, a5 as Sa, $ as Aa, a3 as Na, a4 as Ba, a2 as Ca, ad as Ta, as as Ea, a0 as Ia, G as la, T as wa, U as ka, V as ua, I as _a, J as ca, ax as ha, W as pa } from "./index2.js";
 export {
   s as BTC_DECIMALS,
   t as BasculeDepositStatus,
   r as BlockchainIdentifier,
   i as CHAIN_ID_TO_VIEM_CHAIN_MAP,
-  n as ChainId,
-  d as ENotarizationStatus,
-  g as ESessionState,
+  g as ChainId,
+  n as ENotarizationStatus,
+  d as ESessionState,
   o as Env,
   S as RewardBlockchainType,
-  B as RewardToken,
-  A as RewardWithdrawalStatus,
-  N as SANCTIONED_ADDRESS,
-  k as SATOSHI_SCALE,
-  w as SUI_DEVNET_CHAIN,
-  C as SUI_LOCALNET_CHAIN,
-  l as SUI_MAINNET_CHAIN,
-  c as SUI_TESTNET_CHAIN,
-  u as Vault,
-  E as approveLBTC,
-  I as cancelWithdraw,
-  T as claimLBTC,
-  h as claimReward,
-  p as deposit,
-  _ as fromSatoshi,
-  D as generateDepositBtcAddress,
-  y as getApiConfig,
-  L as getBasculeDepositStatus,
-  R as getBaseNetworkByEnv,
-  m as getBscNetworkByEnv,
-  V as getChainIdByName,
-  v as getChainNameById,
-  f as getDepositBtcAddress,
-  F as getDepositBtcAddresses,
-  H as getDepositsByAddress,
-  U as getEthNetworkByEnv,
-  W as getLBTCExchangeRate,
-  M as getLBTCMintingFee,
-  O as getLBTCTotalSupply,
-  P as getLbtcContractAddresses,
-  b as getNetworkFeeSignature,
-  x as getPermitNonce,
-  j as getPointsByAddress,
-  q as getRewardBalances,
-  z as getRewardSigningData,
-  G as getRewardWithdrawalFee,
-  J as getRewardWithdrawals,
-  K as getShareValue,
-  Q as getSharesByAddress,
-  X as getSonicNetworkByEnv,
-  Y as getStakeAndBakeFee,
-  Z as getSuiNetworkByEnv,
-  $ as getUnstakesByAddress,
-  aa as getUserStakeAndBakeSignature,
-  ea as getVaultDeposits,
-  sa as getVaultPoints,
-  ta as getVaultWithdrawals,
-  ra as isRewardTokenSupported,
-  ia as isValidChain,
-  na as queueWithdraw,
-  da as setReferral,
-  ga as signLbtcDestinationAddr,
-  oa as signNetworkFee,
-  Sa as signStakeAndBake,
-  Ba as storeNetworkFeeSignature,
-  Aa as storeStakeAndBakeSignature,
-  Na as toSatoshi,
-  ka as unstakeLBTC
+  A as RewardToken,
+  N as RewardWithdrawalStatus,
+  B as SANCTIONED_ADDRESS,
+  C as SATOSHI_SCALE,
+  T as SOLANA_DEVNET_CHAIN,
+  E as SOLANA_MAINNET_CHAIN,
+  I as SOLANA_TESTNET_CHAIN,
+  l as SUI_DEVNET_CHAIN,
+  w as SUI_LOCALNET_CHAIN,
+  k as SUI_MAINNET_CHAIN,
+  u as SUI_TESTNET_CHAIN,
+  _ as Vault,
+  c as approveLBTC,
+  h as bridge,
+  p as bridgeCCIP,
+  L as bridgeOFT,
+  D as cancelWithdraw,
+  y as claimLBTC,
+  R as claimReward,
+  V as deposit,
+  v as fromSatoshi,
+  H as generateDepositBtcAddress,
+  m as getApiConfig,
+  O as getBasculeDepositStatus,
+  f as getBaseNetworkByEnv,
+  F as getBridgeInfo,
+  M as getBscNetworkByEnv,
+  U as getChainIdByName,
+  W as getChainNameById,
+  b as getDepositBtcAddress,
+  P as getDepositBtcAddresses,
+  x as getDepositsByAddress,
+  q as getEthNetworkByEnv,
+  j as getLBTCExchangeRate,
+  z as getLBTCMintingFee,
+  G as getLBTCStats,
+  J as getLBTCTotalSupply,
+  K as getLbtcContractAddresses,
+  Q as getNetworkFeeSignature,
+  X as getPermitNonce,
+  Y as getPointsByAddress,
+  Z as getRewardBalances,
+  $ as getRewardSigningData,
+  aa as getRewardWithdrawalFee,
+  ea as getRewardWithdrawals,
+  sa as getShareValue,
+  ta as getSharesByAddress,
+  ra as getSolanaNetworkByEnv,
+  ia as getSonicNetworkByEnv,
+  ga as getStakeAndBakeFee,
+  na as getSuiNetworkByEnv,
+  da as getUnstakesByAddress,
+  oa as getUserStakeAndBakeSignature,
+  Sa as getVaultApy,
+  Aa as getVaultDeposits,
+  Na as getVaultPoints,
+  Ba as getVaultTVL,
+  Ca as getVaultWithdrawals,
+  Ta as isRewardTokenSupported,
+  Ea as isValidChain,
+  Ia as queueWithdraw,
+  la as setReferral,
+  wa as signLbtcDestinationAddr,
+  ka as signNetworkFee,
+  ua as signStakeAndBake,
+  _a as storeNetworkFeeSignature,
+  ca as storeStakeAndBakeSignature,
+  ha as toSatoshi,
+  pa as unstakeLBTC
 };
 //# sourceMappingURL=index.js.map