@alphafi/alphafi-sdk 0.0.39 → 0.0.40

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (291) hide show
  1. package/dist/cjs/adminFunctions.d.ts.map +1 -1
  2. package/dist/cjs/adminFunctions.js +9 -1
  3. package/dist/cjs/adminFunctions.js.map +1 -1
  4. package/dist/cjs/common/coins.d.ts.map +1 -1
  5. package/dist/cjs/common/coins.js +12 -0
  6. package/dist/cjs/common/coins.js.map +1 -1
  7. package/dist/cjs/common/constants.d.ts +135 -0
  8. package/dist/cjs/common/constants.d.ts.map +1 -1
  9. package/dist/cjs/common/constants.js +98 -7
  10. package/dist/cjs/common/constants.js.map +1 -1
  11. package/dist/cjs/common/maps.d.ts.map +1 -1
  12. package/dist/cjs/common/maps.js +103 -16
  13. package/dist/cjs/common/maps.js.map +1 -1
  14. package/dist/cjs/common/types.d.ts +58 -5
  15. package/dist/cjs/common/types.d.ts.map +1 -1
  16. package/dist/cjs/common/types.js.map +1 -1
  17. package/dist/cjs/index.d.ts +2 -1
  18. package/dist/cjs/index.d.ts.map +1 -1
  19. package/dist/cjs/index.js +9 -2
  20. package/dist/cjs/index.js.map +1 -1
  21. package/dist/cjs/sui-sdk/functions/fetchUserVaultBalances.d.ts.map +1 -1
  22. package/dist/cjs/sui-sdk/functions/fetchUserVaultBalances.js +2 -3
  23. package/dist/cjs/sui-sdk/functions/fetchUserVaultBalances.js.map +1 -1
  24. package/dist/cjs/sui-sdk/functions/getPortfolioAmounts.d.ts.map +1 -1
  25. package/dist/cjs/sui-sdk/functions/getPortfolioAmounts.js +5 -11
  26. package/dist/cjs/sui-sdk/functions/getPortfolioAmounts.js.map +1 -1
  27. package/dist/cjs/sui-sdk/functions/getReceipts.d.ts +2 -2
  28. package/dist/cjs/sui-sdk/functions/getReceipts.d.ts.map +1 -1
  29. package/dist/cjs/sui-sdk/functions/getReceipts.js +1 -1
  30. package/dist/cjs/sui-sdk/functions/getReceipts.js.map +1 -1
  31. package/dist/cjs/transactions/bluefin.d.ts +6 -0
  32. package/dist/cjs/transactions/bluefin.d.ts.map +1 -1
  33. package/dist/cjs/transactions/bluefin.js +411 -34
  34. package/dist/cjs/transactions/bluefin.js.map +1 -1
  35. package/dist/cjs/transactions/cetus.d.ts +1 -1
  36. package/dist/cjs/transactions/cetus.d.ts.map +1 -1
  37. package/dist/cjs/transactions/cetus.js +3 -3
  38. package/dist/cjs/transactions/cetus.js.map +1 -1
  39. package/dist/cjs/transactions/deposit.d.ts.map +1 -1
  40. package/dist/cjs/transactions/deposit.js +9 -1
  41. package/dist/cjs/transactions/deposit.js.map +1 -1
  42. package/dist/cjs/transactions/withdraw.d.ts.map +1 -1
  43. package/dist/cjs/transactions/withdraw.js +9 -1
  44. package/dist/cjs/transactions/withdraw.js.map +1 -1
  45. package/dist/esm/adminFunctions.d.ts.map +1 -1
  46. package/dist/esm/adminFunctions.js +10 -2
  47. package/dist/esm/adminFunctions.js.map +1 -1
  48. package/dist/esm/common/coins.d.ts.map +1 -1
  49. package/dist/esm/common/coins.js +12 -0
  50. package/dist/esm/common/coins.js.map +1 -1
  51. package/dist/esm/common/constants.d.ts +135 -0
  52. package/dist/esm/common/constants.d.ts.map +1 -1
  53. package/dist/esm/common/constants.js +98 -7
  54. package/dist/esm/common/constants.js.map +1 -1
  55. package/dist/esm/common/maps.d.ts.map +1 -1
  56. package/dist/esm/common/maps.js +103 -16
  57. package/dist/esm/common/maps.js.map +1 -1
  58. package/dist/esm/common/types.d.ts +58 -5
  59. package/dist/esm/common/types.d.ts.map +1 -1
  60. package/dist/esm/common/types.js.map +1 -1
  61. package/dist/esm/index.d.ts +2 -1
  62. package/dist/esm/index.d.ts.map +1 -1
  63. package/dist/esm/index.js +2 -1
  64. package/dist/esm/index.js.map +1 -1
  65. package/dist/esm/sui-sdk/functions/fetchUserVaultBalances.d.ts.map +1 -1
  66. package/dist/esm/sui-sdk/functions/fetchUserVaultBalances.js +2 -3
  67. package/dist/esm/sui-sdk/functions/fetchUserVaultBalances.js.map +1 -1
  68. package/dist/esm/sui-sdk/functions/getPortfolioAmounts.d.ts.map +1 -1
  69. package/dist/esm/sui-sdk/functions/getPortfolioAmounts.js +5 -11
  70. package/dist/esm/sui-sdk/functions/getPortfolioAmounts.js.map +1 -1
  71. package/dist/esm/sui-sdk/functions/getReceipts.d.ts +2 -2
  72. package/dist/esm/sui-sdk/functions/getReceipts.d.ts.map +1 -1
  73. package/dist/esm/sui-sdk/functions/getReceipts.js +1 -1
  74. package/dist/esm/sui-sdk/functions/getReceipts.js.map +1 -1
  75. package/dist/esm/transactions/bluefin.d.ts +6 -0
  76. package/dist/esm/transactions/bluefin.d.ts.map +1 -1
  77. package/dist/esm/transactions/bluefin.js +408 -33
  78. package/dist/esm/transactions/bluefin.js.map +1 -1
  79. package/dist/esm/transactions/cetus.d.ts +1 -1
  80. package/dist/esm/transactions/cetus.d.ts.map +1 -1
  81. package/dist/esm/transactions/cetus.js +3 -3
  82. package/dist/esm/transactions/cetus.js.map +1 -1
  83. package/dist/esm/transactions/deposit.d.ts.map +1 -1
  84. package/dist/esm/transactions/deposit.js +10 -2
  85. package/dist/esm/transactions/deposit.js.map +1 -1
  86. package/dist/esm/transactions/withdraw.d.ts.map +1 -1
  87. package/dist/esm/transactions/withdraw.js +10 -2
  88. package/dist/esm/transactions/withdraw.js.map +1 -1
  89. package/docs/assets/highlight.css +101 -0
  90. package/docs/assets/icons.js +21 -0
  91. package/docs/assets/icons.svg +1 -0
  92. package/docs/assets/main.js +2218 -0
  93. package/docs/assets/navigation.js +2 -0
  94. package/docs/assets/search.js +2 -0
  95. package/docs/assets/style.css +1489 -0
  96. package/docs/functions/alphaLpBreakdown.html +253 -0
  97. package/docs/functions/bucketDepositTx.html +267 -0
  98. package/docs/functions/bucketWithdrawTx.html +267 -0
  99. package/docs/functions/cetusLpBreakdown.html +253 -0
  100. package/docs/functions/claimRewardTxb.html +243 -0
  101. package/docs/functions/coinAmountToXTokensDoubleAsset.html +267 -0
  102. package/docs/functions/coinAmountToXTokensSingleAsset.html +260 -0
  103. package/docs/functions/coinsInPool.html +438 -0
  104. package/docs/functions/collectRewards.html +242 -0
  105. package/docs/functions/deposit.html +246 -0
  106. package/docs/functions/depositAlphaTxb.html +250 -0
  107. package/docs/functions/depositBluefinSuiFirstTxb.html +302 -0
  108. package/docs/functions/depositBluefinType1Txb.html +300 -0
  109. package/docs/functions/depositBluefinType2Txb.html +300 -0
  110. package/docs/functions/depositCetusAlphaSuiTxb.html +300 -0
  111. package/docs/functions/depositCetusSuiTxb.html +298 -0
  112. package/docs/functions/depositCetusTxb.html +298 -0
  113. package/docs/functions/depositDoubleAssetTxb.html +270 -0
  114. package/docs/functions/depositSingleAssetTxb.html +263 -0
  115. package/docs/functions/fetchAfterTransactionEvents.html +306 -0
  116. package/docs/functions/fetchAutoCompoundingEvents.html +257 -0
  117. package/docs/functions/fetchAutoCompoundingEventsGql.html +251 -0
  118. package/docs/functions/fetchCetusPools.html +231 -0
  119. package/docs/functions/fetchChainIdentifier.html +233 -0
  120. package/docs/functions/fetchCheckRatioEvents.html +249 -0
  121. package/docs/functions/fetchLiquidityChangeEvents.html +257 -0
  122. package/docs/functions/fetchMultiReceipts.html +261 -0
  123. package/docs/functions/fetchNftHolders.html +233 -0
  124. package/docs/functions/fetchPools.html +230 -0
  125. package/docs/functions/fetchPortfolioData.html +243 -0
  126. package/docs/functions/fetchProtocolData.html +231 -0
  127. package/docs/functions/fetchTVL.html +253 -0
  128. package/docs/functions/fetchUserVaultBalances.html +245 -0
  129. package/docs/functions/fetchUserVaults.html +243 -0
  130. package/docs/functions/fetchUserWalletData.html +243 -0
  131. package/docs/functions/fetchWithdrawV2Events.html +255 -0
  132. package/docs/functions/getAirdropShare.html +243 -0
  133. package/docs/functions/getAllDoubleAssetVaults.html +235 -0
  134. package/docs/functions/getAllSingleAssetVaults.html +235 -0
  135. package/docs/functions/getAllVaultBalances.html +265 -0
  136. package/docs/functions/getAllVaults.html +233 -0
  137. package/docs/functions/getAlphaUnlocks.html +245 -0
  138. package/docs/functions/getAlphaVaultBalance.html +255 -0
  139. package/docs/functions/getAmounts.html +272 -0
  140. package/docs/functions/getApr.html +243 -0
  141. package/docs/functions/getAprs.html +255 -0
  142. package/docs/functions/getApy.html +243 -0
  143. package/docs/functions/getApys.html +255 -0
  144. package/docs/functions/getCetusInvestorTicksMap.html +284 -0
  145. package/docs/functions/getCetusSqrtPriceMap.html +249 -0
  146. package/docs/functions/getCoinAmountsFromLiquidity.html +266 -0
  147. package/docs/functions/getConf.html +9882 -0
  148. package/docs/functions/getCurrentTick.html +247 -0
  149. package/docs/functions/getDoubleAssetVaultBalance.html +268 -0
  150. package/docs/functions/getDoubleAssetVaults.html +253 -0
  151. package/docs/functions/getHoldersFromTransactions.html +299 -0
  152. package/docs/functions/getInvestor.html +259 -0
  153. package/docs/functions/getInvestorPoolMap.html +241 -0
  154. package/docs/functions/getLastAutoCompoundTime.html +249 -0
  155. package/docs/functions/getLiquidity.html +260 -0
  156. package/docs/functions/getParentPool.html +256 -0
  157. package/docs/functions/getPool.html +262 -0
  158. package/docs/functions/getPoolExchangeRateMap.html +249 -0
  159. package/docs/functions/getPositionTicks.html +249 -0
  160. package/docs/functions/getPriceToTick.html +254 -0
  161. package/docs/functions/getRebalanceHistories.html +269 -0
  162. package/docs/functions/getRebalanceHistory.html +255 -0
  163. package/docs/functions/getReceipts.html +268 -0
  164. package/docs/functions/getSingleAssetVaultBalance.html +268 -0
  165. package/docs/functions/getSingleAssetVaults.html +253 -0
  166. package/docs/functions/getSuiClient.html +247 -0
  167. package/docs/functions/getSuiNodeUrl.html +232 -0
  168. package/docs/functions/getTVLs.html +243 -0
  169. package/docs/functions/getTickToPrice.html +254 -0
  170. package/docs/functions/getUserTokensFromTransactions.html +269 -0
  171. package/docs/functions/getUserTokensInUsdFromTransactions.html +263 -0
  172. package/docs/functions/getVaultBalance.html +277 -0
  173. package/docs/functions/getVaultBalanceForActiveUsers.html +261 -0
  174. package/docs/functions/getVaults.html +250 -0
  175. package/docs/functions/getXTokenVaultBalanceForActiveUsers.html +261 -0
  176. package/docs/functions/lastAutocompoundTime.html +249 -0
  177. package/docs/functions/liquidityToTokens.html +253 -0
  178. package/docs/functions/loopingDeposit.html +277 -0
  179. package/docs/functions/loopingWithdraw.html +278 -0
  180. package/docs/functions/multiLiquidityToTokens.html +271 -0
  181. package/docs/functions/multiTokensToUsd.html +262 -0
  182. package/docs/functions/multiXTokensToLiquidity.html +257 -0
  183. package/docs/functions/naviDepositTx.html +278 -0
  184. package/docs/functions/naviHasuiSuiLoopDepositTx.html +271 -0
  185. package/docs/functions/naviHasuiSuiLoopWithdrawTx.html +271 -0
  186. package/docs/functions/naviSuiVsuiLoopDepositTx.html +271 -0
  187. package/docs/functions/naviSuiVsuiLoopWithdrawTx.html +271 -0
  188. package/docs/functions/naviUsdcUsdtLoopDepositTx.html +271 -0
  189. package/docs/functions/naviUsdcUsdtLoopWithdrawTx.html +271 -0
  190. package/docs/functions/naviUsdtUsdcLoopDepositTx.html +271 -0
  191. package/docs/functions/naviUsdtUsdcLoopWithdrawTx.html +271 -0
  192. package/docs/functions/naviWithdrawTx.html +278 -0
  193. package/docs/functions/parseUserWalletData.html +243 -0
  194. package/docs/functions/setSuiClient.html +255 -0
  195. package/docs/functions/setSuiNodeUrl.html +249 -0
  196. package/docs/functions/withdraw.html +249 -0
  197. package/docs/functions/withdrawAlphaTxb.html +257 -0
  198. package/docs/functions/withdrawBluefinSuiFirstTxb.html +282 -0
  199. package/docs/functions/withdrawBluefinType1Txb.html +280 -0
  200. package/docs/functions/withdrawBluefinType2Txb.html +280 -0
  201. package/docs/functions/withdrawCetusAlphaSuiTxb.html +282 -0
  202. package/docs/functions/withdrawCetusSuiTxb.html +278 -0
  203. package/docs/functions/withdrawCetusTxb.html +278 -0
  204. package/docs/functions/withdrawTxb.html +260 -0
  205. package/docs/index.html +622 -0
  206. package/docs/interfaces/Coin.html +474 -0
  207. package/docs/interfaces/CoinPair.html +358 -0
  208. package/docs/interfaces/NaviVoloData.html +514 -0
  209. package/docs/interfaces/RebalanceHistoryType.html +652 -0
  210. package/docs/modules.html +1440 -0
  211. package/docs/types/AfterTransactionEventNode.html +305 -0
  212. package/docs/types/Allocator.html +321 -0
  213. package/docs/types/AlphaFiDoubleAssetVault.html +258 -0
  214. package/docs/types/AlphaFiMultiVaultBalance.html +219 -0
  215. package/docs/types/AlphaFiSingleAssetVault.html +244 -0
  216. package/docs/types/AlphaFiVault.html +214 -0
  217. package/docs/types/AlphaFiVaultBalance.html +220 -0
  218. package/docs/types/AlphaPoolType.html +383 -0
  219. package/docs/types/AlphaReceipt.html +220 -0
  220. package/docs/types/AlphaReceiptFields.html +421 -0
  221. package/docs/types/AlphaVaultBalance.html +245 -0
  222. package/docs/types/AutoCompoundingEventNode.html +225 -0
  223. package/docs/types/BluefinInvestor.html +209 -0
  224. package/docs/types/BluefinPoolType.html +209 -0
  225. package/docs/types/BucketInvestor.html +249 -0
  226. package/docs/types/CetusInvestor.html +240 -0
  227. package/docs/types/CetusPoolType.html +433 -0
  228. package/docs/types/CetusSwapOptions.html +209 -0
  229. package/docs/types/CoinAmounts.html +216 -0
  230. package/docs/types/CoinName.html +281 -0
  231. package/docs/types/CoinType.html +282 -0
  232. package/docs/types/CommonInvestorFields.html +276 -0
  233. package/docs/types/CreatePoolOptions.html +246 -0
  234. package/docs/types/Distributor.html +341 -0
  235. package/docs/types/DoubleAssetMultiVaultBalance.html +236 -0
  236. package/docs/types/DoubleAssetPoolNames.html +267 -0
  237. package/docs/types/DoubleAssetTokenHoldings.html +232 -0
  238. package/docs/types/DoubleAssetVaultBalance.html +229 -0
  239. package/docs/types/GetHoldersParams.html +221 -0
  240. package/docs/types/GetTokenHoldingsParams.html +227 -0
  241. package/docs/types/GetUserTokensFromTransactionsParams.html +233 -0
  242. package/docs/types/GetUserTokensInUsdFromTransactionsParams.html +244 -0
  243. package/docs/types/GetVaultBalanceForActiveUsersParams.html +231 -0
  244. package/docs/types/GetVaultBalanceParams.html +217 -0
  245. package/docs/types/HoldingsObj.html +223 -0
  246. package/docs/types/Icon.html +266 -0
  247. package/docs/types/Investor.html +245 -0
  248. package/docs/types/LiquidityChangeEventNode.html +220 -0
  249. package/docs/types/LiquidityToTokensParams.html +255 -0
  250. package/docs/types/LiquidityToUsdParams.html +267 -0
  251. package/docs/types/LoopingDebt.html +258 -0
  252. package/docs/types/LpBreakdownType.html +238 -0
  253. package/docs/types/MemberPoolDataType.html +276 -0
  254. package/docs/types/MemberType.html +269 -0
  255. package/docs/types/MultiGetVaultBalancesParams.html +229 -0
  256. package/docs/types/NaviInvestor.html +235 -0
  257. package/docs/types/OtherReceiptFields.html +373 -0
  258. package/docs/types/PoolName.html +304 -0
  259. package/docs/types/PoolReceipt.html +253 -0
  260. package/docs/types/PoolType.html +388 -0
  261. package/docs/types/Receipt.html +475 -0
  262. package/docs/types/ReceiptGQL.html +374 -0
  263. package/docs/types/SingleAssetMultiVaultBalance.html +232 -0
  264. package/docs/types/SingleAssetPoolNames.html +247 -0
  265. package/docs/types/SingleAssetTokenHoldings.html +228 -0
  266. package/docs/types/SingleAssetVaultBalance.html +223 -0
  267. package/docs/types/SingleGetVaultBalancesParams.html +224 -0
  268. package/docs/types/StrategyType.html +217 -0
  269. package/docs/types/SuiNetwork.html +213 -0
  270. package/docs/types/SwapOptions.html +248 -0
  271. package/docs/types/TickSpacing.html +212 -0
  272. package/docs/types/TotalWeightType.html +246 -0
  273. package/docs/types/TransactionBlockType.html +358 -0
  274. package/docs/types/UserPoolLiquidity.html +221 -0
  275. package/docs/types/UserPoolTokenHoldings.html +217 -0
  276. package/docs/types/UserUsdHoldings.html +223 -0
  277. package/docs/types/VaultBalance.html +216 -0
  278. package/docs/types/WithdrawV2EventNode.html +208 -0
  279. package/docs/variables/bluefinPoolMap.html +214 -0
  280. package/docs/variables/cetusPoolMap.html +214 -0
  281. package/docs/variables/coinsList.html +220 -0
  282. package/docs/variables/defunctPoolsSet.html +209 -0
  283. package/docs/variables/doubleAssetPoolCoinMap.html +237 -0
  284. package/docs/variables/loopingAccountAddresses.html +219 -0
  285. package/docs/variables/loopingPoolCoinMap.html +233 -0
  286. package/docs/variables/naviAssetMap.html +215 -0
  287. package/docs/variables/poolIdPoolNameMap.html +218 -0
  288. package/docs/variables/poolInfo.html +304 -0
  289. package/docs/variables/singleAssetPoolCoinMap.html +229 -0
  290. package/docs/variables/stableCoins.html +207 -0
  291. package/package.json +1 -1
package/docs/functions/getApr.html ADDED
@@ -0,0 +1,243 @@
1
+ <!doctype html>
2
+ <html class="default" lang="en">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <meta http-equiv="x-ua-compatible" content="IE=edge" />
6
+ <title>getApr | @alphafi/alphafi-sdk - v0.0.39</title>
7
+ <meta name="description" content="Documentation for @alphafi/alphafi-sdk" />
8
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
9
+ <link rel="stylesheet" href="../assets/style.css" />
10
+ <link rel="stylesheet" href="../assets/highlight.css" />
11
+ <script defer src="../assets/main.js"></script>
12
+ <script async src="../assets/icons.js" id="tsd-icons-script"></script>
13
+ <script async src="../assets/search.js" id="tsd-search-script"></script>
14
+ <script async src="../assets/navigation.js" id="tsd-nav-script"></script>
15
+ </head>
16
+ <body>
17
+ <script>
18
+ document.documentElement.dataset.theme =
19
+ localStorage.getItem("tsd-theme") || "os";
20
+ document.body.style.display = "none";
21
+ setTimeout(
22
+ () =>
23
+ app ? app.showPage() : document.body.style.removeProperty("display"),
24
+ 500,
25
+ );
26
+ </script>
27
+ <header class="tsd-page-toolbar">
28
+ <div class="tsd-toolbar-contents container">
29
+ <div class="table-cell" id="tsd-search" data-base="..">
30
+ <div class="field">
31
+ <label
32
+ for="tsd-search-field"
33
+ class="tsd-widget tsd-toolbar-icon search no-caption"
34
+ ><svg width="16" height="16" viewBox="0 0 16 16" fill="none">
35
+ <use href="../assets/icons.svg#icon-search"></use></svg></label
36
+ ><input type="text" id="tsd-search-field" aria-label="Search" />
37
+ </div>
38
+ <div class="field"><div id="tsd-toolbar-links"></div></div>
39
+ <ul class="results">
40
+ <li class="state loading">Preparing search index...</li>
41
+ <li class="state failure">The search index is not available</li>
42
+ </ul>
43
+ <a href="../index.html" class="title"
44
+ >@alphafi/alphafi-sdk - v0.0.39</a
45
+ >
46
+ </div>
47
+ <div class="table-cell" id="tsd-widgets">
48
+ <a
49
+ href="#"
50
+ class="tsd-widget tsd-toolbar-icon menu no-caption"
51
+ data-toggle="menu"
52
+ aria-label="Menu"
53
+ ><svg width="16" height="16" viewBox="0 0 16 16" fill="none">
54
+ <use href="../assets/icons.svg#icon-menu"></use></svg
55
+ ></a>
56
+ </div>
57
+ </div>
58
+ </header>
59
+ <div class="container container-main">
60
+ <div class="col-content">
61
+ <div class="tsd-page-title">
62
+ <ul class="tsd-breadcrumb">
63
+ <li><a href="../modules.html">@alphafi/alphafi-sdk</a></li>
64
+ <li><a href="getApr.html">getApr</a></li>
65
+ </ul>
66
+ <h1>Function getApr</h1>
67
+ </div>
68
+ <section class="tsd-panel">
69
+ <ul class="tsd-signatures">
70
+ <li class="tsd-signature tsd-anchor-link">
71
+ <a id="getApr" class="tsd-anchor"></a
72
+ ><span class="tsd-kind-call-signature">get<wbr />Apr</span
73
+ ><span class="tsd-signature-symbol">(</span
74
+ ><span class="tsd-kind-parameter">poolName</span
75
+ ><span class="tsd-signature-symbol">)</span
76
+ ><span class="tsd-signature-symbol">: </span
77
+ ><span class="tsd-signature-type">Promise</span
78
+ ><span class="tsd-signature-symbol">&lt;</span
79
+ ><span class="tsd-signature-type">number</span
80
+ ><span class="tsd-signature-symbol">&gt;</span
81
+ ><a href="#getApr" aria-label="Permalink" class="tsd-anchor-icon"
82
+ ><svg viewBox="0 0 24 24">
83
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
84
+ ></a>
85
+ </li>
86
+ <li class="tsd-description">
87
+ <div class="tsd-parameters">
88
+ <h4 class="tsd-parameters-title">Parameters</h4>
89
+ <ul class="tsd-parameter-list">
90
+ <li>
91
+ <span
92
+ ><span class="tsd-kind-parameter">poolName</span>:
93
+ <a
94
+ href="../types/PoolName.html"
95
+ class="tsd-signature-type tsd-kind-type-alias"
96
+ >PoolName</a
97
+ ></span
98
+ >
99
+ </li>
100
+ </ul>
101
+ </div>
102
+ <h4 class="tsd-returns-title">
103
+ Returns <span class="tsd-signature-type">Promise</span
104
+ ><span class="tsd-signature-symbol">&lt;</span
105
+ ><span class="tsd-signature-type">number</span
106
+ ><span class="tsd-signature-symbol">&gt;</span>
107
+ </h4>
108
+ <aside class="tsd-sources">
109
+ <ul>
110
+ <li>
111
+ Defined in
112
+ <a
113
+ href="https://github.com/AlphaFiTech/alphafi-sdk/blob/8d127b965a29120c71291bb27e989d4b06161cbc/src/getAprs.ts#L8"
114
+ >getAprs.ts:8</a
115
+ >
116
+ </li>
117
+ </ul>
118
+ </aside>
119
+ </li>
120
+ </ul>
121
+ </section>
122
+ </div>
123
+ <div class="col-sidebar">
124
+ <div class="page-menu">
125
+ <div class="tsd-navigation settings">
126
+ <details class="tsd-accordion">
127
+ <summary class="tsd-accordion-summary">
128
+ <h3>
129
+ <svg width="20" height="20" viewBox="0 0 24 24" fill="none">
130
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
131
+ >Settings
132
+ </h3>
133
+ </summary>
134
+ <div class="tsd-accordion-details">
135
+ <div class="tsd-filter-visibility">
136
+ <span class="settings-label">Member Visibility</span>
137
+ <ul id="tsd-filter-options">
138
+ <li class="tsd-filter-item">
139
+ <label class="tsd-filter-input"
140
+ ><input
141
+ type="checkbox"
142
+ id="tsd-filter-inherited"
143
+ name="inherited"
144
+ checked
145
+ /><svg
146
+ width="32"
147
+ height="32"
148
+ viewBox="0 0 32 32"
149
+ aria-hidden="true"
150
+ >
151
+ <rect
152
+ class="tsd-checkbox-background"
153
+ width="30"
154
+ height="30"
155
+ x="1"
156
+ y="1"
157
+ rx="6"
158
+ fill="none"
159
+ ></rect>
160
+ <path
161
+ class="tsd-checkbox-checkmark"
162
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
163
+ stroke="none"
164
+ stroke-width="3.5"
165
+ stroke-linejoin="round"
166
+ fill="none"
167
+ ></path></svg
168
+ ><span>Inherited</span></label
169
+ >
170
+ </li>
171
+ <li class="tsd-filter-item">
172
+ <label class="tsd-filter-input"
173
+ ><input
174
+ type="checkbox"
175
+ id="tsd-filter-external"
176
+ name="external"
177
+ /><svg
178
+ width="32"
179
+ height="32"
180
+ viewBox="0 0 32 32"
181
+ aria-hidden="true"
182
+ >
183
+ <rect
184
+ class="tsd-checkbox-background"
185
+ width="30"
186
+ height="30"
187
+ x="1"
188
+ y="1"
189
+ rx="6"
190
+ fill="none"
191
+ ></rect>
192
+ <path
193
+ class="tsd-checkbox-checkmark"
194
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
195
+ stroke="none"
196
+ stroke-width="3.5"
197
+ stroke-linejoin="round"
198
+ fill="none"
199
+ ></path></svg
200
+ ><span>External</span></label
201
+ >
202
+ </li>
203
+ </ul>
204
+ </div>
205
+ <div class="tsd-theme-toggle">
206
+ <label class="settings-label" for="tsd-theme">Theme</label
207
+ ><select id="tsd-theme">
208
+ <option value="os">OS</option>
209
+ <option value="light">Light</option>
210
+ <option value="dark">Dark</option>
211
+ </select>
212
+ </div>
213
+ </div>
214
+ </details>
215
+ </div>
216
+ </div>
217
+ <div class="site-menu">
218
+ <nav class="tsd-navigation">
219
+ <a href="../modules.html"
220
+ ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
221
+ <use href="../assets/icons.svg#icon-1"></use></svg
222
+ ><span>@alphafi/alphafi-sdk - v0.0.39</span></a
223
+ >
224
+ <ul
225
+ class="tsd-small-nested-navigation"
226
+ id="tsd-nav-container"
227
+ data-base=".."
228
+ >
229
+ <li>Loading...</li>
230
+ </ul>
231
+ </nav>
232
+ </div>
233
+ </div>
234
+ </div>
235
+ <footer>
236
+ <p class="tsd-generator">
237
+ Generated using
238
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
239
+ </p>
240
+ </footer>
241
+ <div class="overlay"></div>
242
+ </body>
243
+ </html>
package/docs/functions/getAprs.html ADDED
@@ -0,0 +1,255 @@
1
+ <!doctype html>
2
+ <html class="default" lang="en">
3
+ <head>
4
+ <meta charset="utf-8" />
5
+ <meta http-equiv="x-ua-compatible" content="IE=edge" />
6
+ <title>getAprs | @alphafi/alphafi-sdk - v0.0.39</title>
7
+ <meta name="description" content="Documentation for @alphafi/alphafi-sdk" />
8
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
9
+ <link rel="stylesheet" href="../assets/style.css" />
10
+ <link rel="stylesheet" href="../assets/highlight.css" />
11
+ <script defer src="../assets/main.js"></script>
12
+ <script async src="../assets/icons.js" id="tsd-icons-script"></script>
13
+ <script async src="../assets/search.js" id="tsd-search-script"></script>
14
+ <script async src="../assets/navigation.js" id="tsd-nav-script"></script>
15
+ </head>
16
+ <body>
17
+ <script>
18
+ document.documentElement.dataset.theme =
19
+ localStorage.getItem("tsd-theme") || "os";
20
+ document.body.style.display = "none";
21
+ setTimeout(
22
+ () =>
23
+ app ? app.showPage() : document.body.style.removeProperty("display"),
24
+ 500,
25
+ );
26
+ </script>
27
+ <header class="tsd-page-toolbar">
28
+ <div class="tsd-toolbar-contents container">
29
+ <div class="table-cell" id="tsd-search" data-base="..">
30
+ <div class="field">
31
+ <label
32
+ for="tsd-search-field"
33
+ class="tsd-widget tsd-toolbar-icon search no-caption"
34
+ ><svg width="16" height="16" viewBox="0 0 16 16" fill="none">
35
+ <use href="../assets/icons.svg#icon-search"></use></svg></label
36
+ ><input type="text" id="tsd-search-field" aria-label="Search" />
37
+ </div>
38
+ <div class="field"><div id="tsd-toolbar-links"></div></div>
39
+ <ul class="results">
40
+ <li class="state loading">Preparing search index...</li>
41
+ <li class="state failure">The search index is not available</li>
42
+ </ul>
43
+ <a href="../index.html" class="title"
44
+ >@alphafi/alphafi-sdk - v0.0.39</a
45
+ >
46
+ </div>
47
+ <div class="table-cell" id="tsd-widgets">
48
+ <a
49
+ href="#"
50
+ class="tsd-widget tsd-toolbar-icon menu no-caption"
51
+ data-toggle="menu"
52
+ aria-label="Menu"
53
+ ><svg width="16" height="16" viewBox="0 0 16 16" fill="none">
54
+ <use href="../assets/icons.svg#icon-menu"></use></svg
55
+ ></a>
56
+ </div>
57
+ </div>
58
+ </header>
59
+ <div class="container container-main">
60
+ <div class="col-content">
61
+ <div class="tsd-page-title">
62
+ <ul class="tsd-breadcrumb">
63
+ <li><a href="../modules.html">@alphafi/alphafi-sdk</a></li>
64
+ <li><a href="getAprs.html">getAprs</a></li>
65
+ </ul>
66
+ <h1>Function getAprs</h1>
67
+ </div>
68
+ <section class="tsd-panel">
69
+ <ul class="tsd-signatures">
70
+ <li class="tsd-signature tsd-anchor-link">
71
+ <a id="getAprs" class="tsd-anchor"></a
72
+ ><span class="tsd-kind-call-signature">get<wbr />Aprs</span
73
+ ><span class="tsd-signature-symbol">(</span
74
+ ><span class="tsd-kind-parameter">poolNames</span
75
+ ><span class="tsd-signature-symbol">?</span
76
+ ><span class="tsd-signature-symbol">)</span
77
+ ><span class="tsd-signature-symbol">: </span
78
+ ><span class="tsd-signature-type">Promise</span
79
+ ><span class="tsd-signature-symbol">&lt;</span
80
+ ><span class="tsd-signature-type">Record</span
81
+ ><span class="tsd-signature-symbol">&lt;</span
82
+ ><span class="tsd-signature-type">string</span
83
+ ><span class="tsd-signature-symbol">, </span
84
+ ><span class="tsd-signature-type">number</span
85
+ ><span class="tsd-signature-symbol">&gt;</span
86
+ ><span class="tsd-signature-symbol">&gt;</span
87
+ ><a href="#getAprs" aria-label="Permalink" class="tsd-anchor-icon"
88
+ ><svg viewBox="0 0 24 24">
89
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
90
+ ></a>
91
+ </li>
92
+ <li class="tsd-description">
93
+ <div class="tsd-parameters">
94
+ <h4 class="tsd-parameters-title">Parameters</h4>
95
+ <ul class="tsd-parameter-list">
96
+ <li>
97
+ <span
98
+ ><code class="tsd-tag">Optional</code
99
+ ><span class="tsd-kind-parameter">poolNames</span>:
100
+ <a
101
+ href="../types/PoolName.html"
102
+ class="tsd-signature-type tsd-kind-type-alias"
103
+ >PoolName</a
104
+ ><span class="tsd-signature-symbol">[]</span></span
105
+ >
106
+ </li>
107
+ </ul>
108
+ </div>
109
+ <h4 class="tsd-returns-title">
110
+ Returns <span class="tsd-signature-type">Promise</span
111
+ ><span class="tsd-signature-symbol">&lt;</span
112
+ ><span class="tsd-signature-type">Record</span
113
+ ><span class="tsd-signature-symbol">&lt;</span
114
+ ><span class="tsd-signature-type">string</span
115
+ ><span class="tsd-signature-symbol">, </span
116
+ ><span class="tsd-signature-type">number</span
117
+ ><span class="tsd-signature-symbol">&gt;</span
118
+ ><span class="tsd-signature-symbol">&gt;</span>
119
+ </h4>
120
+ <aside class="tsd-sources">
121
+ <ul>
122
+ <li>
123
+ Defined in
124
+ <a
125
+ href="https://github.com/AlphaFiTech/alphafi-sdk/blob/8d127b965a29120c71291bb27e989d4b06161cbc/src/getAprs.ts#L14"
126
+ >getAprs.ts:14</a
127
+ >
128
+ </li>
129
+ </ul>
130
+ </aside>
131
+ </li>
132
+ </ul>
133
+ </section>
134
+ </div>
135
+ <div class="col-sidebar">
136
+ <div class="page-menu">
137
+ <div class="tsd-navigation settings">
138
+ <details class="tsd-accordion">
139
+ <summary class="tsd-accordion-summary">
140
+ <h3>
141
+ <svg width="20" height="20" viewBox="0 0 24 24" fill="none">
142
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
143
+ >Settings
144
+ </h3>
145
+ </summary>
146
+ <div class="tsd-accordion-details">
147
+ <div class="tsd-filter-visibility">
148
+ <span class="settings-label">Member Visibility</span>
149
+ <ul id="tsd-filter-options">
150
+ <li class="tsd-filter-item">
151
+ <label class="tsd-filter-input"
152
+ ><input
153
+ type="checkbox"
154
+ id="tsd-filter-inherited"
155
+ name="inherited"
156
+ checked
157
+ /><svg
158
+ width="32"
159
+ height="32"
160
+ viewBox="0 0 32 32"
161
+ aria-hidden="true"
162
+ >
163
+ <rect
164
+ class="tsd-checkbox-background"
165
+ width="30"
166
+ height="30"
167
+ x="1"
168
+ y="1"
169
+ rx="6"
170
+ fill="none"
171
+ ></rect>
172
+ <path
173
+ class="tsd-checkbox-checkmark"
174
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
175
+ stroke="none"
176
+ stroke-width="3.5"
177
+ stroke-linejoin="round"
178
+ fill="none"
179
+ ></path></svg
180
+ ><span>Inherited</span></label
181
+ >
182
+ </li>
183
+ <li class="tsd-filter-item">
184
+ <label class="tsd-filter-input"
185
+ ><input
186
+ type="checkbox"
187
+ id="tsd-filter-external"
188
+ name="external"
189
+ /><svg
190
+ width="32"
191
+ height="32"
192
+ viewBox="0 0 32 32"
193
+ aria-hidden="true"
194
+ >
195
+ <rect
196
+ class="tsd-checkbox-background"
197
+ width="30"
198
+ height="30"
199
+ x="1"
200
+ y="1"
201
+ rx="6"
202
+ fill="none"
203
+ ></rect>
204
+ <path
205
+ class="tsd-checkbox-checkmark"
206
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
207
+ stroke="none"
208
+ stroke-width="3.5"
209
+ stroke-linejoin="round"
210
+ fill="none"
211
+ ></path></svg
212
+ ><span>External</span></label
213
+ >
214
+ </li>
215
+ </ul>
216
+ </div>
217
+ <div class="tsd-theme-toggle">
218
+ <label class="settings-label" for="tsd-theme">Theme</label
219
+ ><select id="tsd-theme">
220
+ <option value="os">OS</option>
221
+ <option value="light">Light</option>
222
+ <option value="dark">Dark</option>
223
+ </select>
224
+ </div>
225
+ </div>
226
+ </details>
227
+ </div>
228
+ </div>
229
+ <div class="site-menu">
230
+ <nav class="tsd-navigation">
231
+ <a href="../modules.html"
232
+ ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
233
+ <use href="../assets/icons.svg#icon-1"></use></svg
234
+ ><span>@alphafi/alphafi-sdk - v0.0.39</span></a
235
+ >
236
+ <ul
237
+ class="tsd-small-nested-navigation"
238
+ id="tsd-nav-container"
239
+ data-base=".."
240
+ >
241
+ <li>Loading...</li>
242
+ </ul>
243
+ </nav>
244
+ </div>
245
+ </div>
246
+ </div>
247
+ <footer>
248
+ <p class="tsd-generator">
249
+ Generated using
250
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
251
+ </p>
252
+ </footer>
253
+ <div class="overlay"></div>
254
+ </body>
255
+ </html>