@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/index.html ADDED
@@ -0,0 +1,622 @@
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>@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">@alphafi/alphafi-sdk - v0.0.39</a>
44
+ </div>
45
+ <div class="table-cell" id="tsd-widgets">
46
+ <a
47
+ href="#"
48
+ class="tsd-widget tsd-toolbar-icon menu no-caption"
49
+ data-toggle="menu"
50
+ aria-label="Menu"
51
+ ><svg width="16" height="16" viewBox="0 0 16 16" fill="none">
52
+ <use href="assets/icons.svg#icon-menu"></use></svg
53
+ ></a>
54
+ </div>
55
+ </div>
56
+ </header>
57
+ <div class="container container-main">
58
+ <div class="col-content">
59
+ <div class="tsd-page-title">
60
+ <h1>@alphafi/alphafi-sdk - v0.0.39</h1>
61
+ </div>
62
+ <div class="tsd-panel tsd-typography">
63
+ <a id="md:alphafi-typescript-sdk" class="tsd-anchor"></a>
64
+ <h1 class="tsd-anchor-link">
65
+ AlphaFi TypeScript SDK<a
66
+ href="#md:alphafi-typescript-sdk"
67
+ aria-label="Permalink"
68
+ class="tsd-anchor-icon"
69
+ ><svg viewBox="0 0 24 24">
70
+ <use href="assets/icons.svg#icon-anchor"></use></svg
71
+ ></a>
72
+ </h1>
73
+ <a id="md:installation" class="tsd-anchor"></a>
74
+ <h2 class="tsd-anchor-link">
75
+ Installation<a
76
+ href="#md:installation"
77
+ aria-label="Permalink"
78
+ class="tsd-anchor-icon"
79
+ ><svg viewBox="0 0 24 24">
80
+ <use href="assets/icons.svg#icon-anchor"></use></svg
81
+ ></a>
82
+ </h2>
83
+ <pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">i</span><span class="hl-1"> </span><span class="hl-2">@alphafi/alphafi-sdk</span>
84
+ </code><button type="button">Copy</button></pre>
85
+
86
+ <a id="md:api-reference" class="tsd-anchor"></a>
87
+ <h2 class="tsd-anchor-link">
88
+ API Reference<a
89
+ href="#md:api-reference"
90
+ aria-label="Permalink"
91
+ class="tsd-anchor-icon"
92
+ ><svg viewBox="0 0 24 24">
93
+ <use href="assets/icons.svg#icon-anchor"></use></svg
94
+ ></a>
95
+ </h2>
96
+ <a id="md:getvaults" class="tsd-anchor"></a>
97
+ <h2 class="tsd-anchor-link">
98
+ <code>getVaults</code
99
+ ><a
100
+ href="#md:getvaults"
101
+ aria-label="Permalink"
102
+ class="tsd-anchor-icon"
103
+ ><svg viewBox="0 0 24 24">
104
+ <use href="assets/icons.svg#icon-anchor"></use></svg
105
+ ></a>
106
+ </h2>
107
+ <p>
108
+ Call this to get all Vaults that a particular user has deposited in.
109
+ </p>
110
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">getVaults</span><span class="hl-1">, </span><span class="hl-4">AlphaFiVault</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">vaults</span><span class="hl-1">: </span><span class="hl-7">AlphaFiVault</span><span class="hl-1">[] | </span><span class="hl-7">undefined</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">getVaults</span><span class="hl-1">(</span><span class="hl-4">address</span><span class="hl-1">);</span>
111
+ </code><button type="button">Copy</button></pre>
112
+
113
+ <a id="md:getsingleassetvaults" class="tsd-anchor"></a>
114
+ <h2 class="tsd-anchor-link">
115
+ <code>getSingleAssetVaults</code
116
+ ><a
117
+ href="#md:getsingleassetvaults"
118
+ aria-label="Permalink"
119
+ class="tsd-anchor-icon"
120
+ ><svg viewBox="0 0 24 24">
121
+ <use href="assets/icons.svg#icon-anchor"></use></svg
122
+ ></a>
123
+ </h2>
124
+ <p>
125
+ Call this to get all Single Asset Vaults that a particular user has
126
+ deposited in.
127
+ </p>
128
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">getSingleAssetVaults</span><span class="hl-1">, </span><span class="hl-4">AlphaFiVault</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">vaults</span><span class="hl-1">: </span><span class="hl-7">AlphaFiVault</span><span class="hl-1">[] | </span><span class="hl-7">undefined</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">getSingleAssetVaults</span><span class="hl-1">(</span><span class="hl-4">address</span><span class="hl-1">);</span>
129
+ </code><button type="button">Copy</button></pre>
130
+
131
+ <a id="md:getdoubleassetvaults" class="tsd-anchor"></a>
132
+ <h2 class="tsd-anchor-link">
133
+ <code>getDoubleAssetVaults</code
134
+ ><a
135
+ href="#md:getdoubleassetvaults"
136
+ aria-label="Permalink"
137
+ class="tsd-anchor-icon"
138
+ ><svg viewBox="0 0 24 24">
139
+ <use href="assets/icons.svg#icon-anchor"></use></svg
140
+ ></a>
141
+ </h2>
142
+ <p>
143
+ Call this to get all Double Asset Vaults that a particular user has
144
+ deposited in.
145
+ </p>
146
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">getDoubleAssetVaults</span><span class="hl-1">, </span><span class="hl-4">AlphaFiVault</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">vaults</span><span class="hl-1">: </span><span class="hl-7">AlphaFiVault</span><span class="hl-1">[] | </span><span class="hl-7">undefined</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">getDoubleAssetVaults</span><span class="hl-1">(</span><span class="hl-4">address</span><span class="hl-1">);</span>
147
+ </code><button type="button">Copy</button></pre>
148
+
149
+ <a id="md:getallvaults" class="tsd-anchor"></a>
150
+ <h2 class="tsd-anchor-link">
151
+ <code>getAllVaults</code
152
+ ><a
153
+ href="#md:getallvaults"
154
+ aria-label="Permalink"
155
+ class="tsd-anchor-icon"
156
+ ><svg viewBox="0 0 24 24">
157
+ <use href="assets/icons.svg#icon-anchor"></use></svg
158
+ ></a>
159
+ </h2>
160
+ <p>Call this to get all Vaults on AlphaFi Protocol.</p>
161
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">getAllVaults</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">vaults</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">[] = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">getAllVaults</span><span class="hl-1">();</span>
162
+ </code><button type="button">Copy</button></pre>
163
+
164
+ <a id="md:getallsingleassetvaults" class="tsd-anchor"></a>
165
+ <h2 class="tsd-anchor-link">
166
+ <code>getAllSingleAssetVaults</code
167
+ ><a
168
+ href="#md:getallsingleassetvaults"
169
+ aria-label="Permalink"
170
+ class="tsd-anchor-icon"
171
+ ><svg viewBox="0 0 24 24">
172
+ <use href="assets/icons.svg#icon-anchor"></use></svg
173
+ ></a>
174
+ </h2>
175
+ <p>Call this to get all Single Asset Vaults on AlphaFi Protocol.</p>
176
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">getAllSingleAssetVaults</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">vaults</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">[] = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">getAllSingleAssetVaults</span><span class="hl-1">();</span>
177
+ </code><button type="button">Copy</button></pre>
178
+
179
+ <a id="md:getalldoubleassetvaults" class="tsd-anchor"></a>
180
+ <h2 class="tsd-anchor-link">
181
+ <code>getAllDoubleAssetVaults</code
182
+ ><a
183
+ href="#md:getalldoubleassetvaults"
184
+ aria-label="Permalink"
185
+ class="tsd-anchor-icon"
186
+ ><svg viewBox="0 0 24 24">
187
+ <use href="assets/icons.svg#icon-anchor"></use></svg
188
+ ></a>
189
+ </h2>
190
+ <p>Call this to get all Double Asset Vaults on AlphaFi Protocol.</p>
191
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">getAllDoubleAssetVaults</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">vaults</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">[] = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">getAllDoubleAssetVaults</span><span class="hl-1">();</span>
192
+ </code><button type="button">Copy</button></pre>
193
+
194
+ <a id="md:getalphavaultbalance" class="tsd-anchor"></a>
195
+ <h2 class="tsd-anchor-link">
196
+ <code>getAlphaVaultBalance</code
197
+ ><a
198
+ href="#md:getalphavaultbalance"
199
+ aria-label="Permalink"
200
+ class="tsd-anchor-icon"
201
+ ><svg viewBox="0 0 24 24">
202
+ <use href="assets/icons.svg#icon-anchor"></use></svg
203
+ ></a>
204
+ </h2>
205
+ <p>Call this to get user balance in Alpha Vault.</p>
206
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">getAlphaVaultBalance</span><span class="hl-1">, </span><span class="hl-4">AlphaVaultBalance</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">balance</span><span class="hl-1">: </span><span class="hl-7">AlphaVaultBalance</span><span class="hl-1"> | </span><span class="hl-7">undefined</span><span class="hl-1"> =</span><br/><span class="hl-1"> </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">getAlphaVaultBalance</span><span class="hl-1">(</span><span class="hl-4">address</span><span class="hl-1">);</span>
207
+ </code><button type="button">Copy</button></pre>
208
+
209
+ <a id="md:getsingleassetvaultbalance" class="tsd-anchor"></a>
210
+ <h2 class="tsd-anchor-link">
211
+ <code>getSingleAssetVaultBalance</code
212
+ ><a
213
+ href="#md:getsingleassetvaultbalance"
214
+ aria-label="Permalink"
215
+ class="tsd-anchor-icon"
216
+ ><svg viewBox="0 0 24 24">
217
+ <use href="assets/icons.svg#icon-anchor"></use></svg
218
+ ></a>
219
+ </h2>
220
+ <p>Call this to get user balance in Single Asset Vaults.</p>
221
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">getSingleAssetVaultBalance</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">SingleAssetVaultBalance</span><span class="hl-1">,</span><br/><span class="hl-1">} </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">balance</span><span class="hl-1">: </span><span class="hl-7">SingleAssetVaultBalance</span><span class="hl-1"> | </span><span class="hl-7">undefined</span><span class="hl-1"> =</span><br/><span class="hl-1"> </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">getSingleAssetVaultBalance</span><span class="hl-1">(</span><span class="hl-4">address</span><span class="hl-1">, </span><span class="hl-4">poolName</span><span class="hl-1">);</span>
222
+ </code><button type="button">Copy</button></pre>
223
+
224
+ <a id="md:getdoubleassetvaultbalance" class="tsd-anchor"></a>
225
+ <h2 class="tsd-anchor-link">
226
+ <code>getDoubleAssetVaultBalance</code
227
+ ><a
228
+ href="#md:getdoubleassetvaultbalance"
229
+ aria-label="Permalink"
230
+ class="tsd-anchor-icon"
231
+ ><svg viewBox="0 0 24 24">
232
+ <use href="assets/icons.svg#icon-anchor"></use></svg
233
+ ></a>
234
+ </h2>
235
+ <p>Call this to get user balance in Double Asset Vaults.</p>
236
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">getDoubleAssetVaultBalance</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">DoubleAssetVaultBalance</span><span class="hl-1">,</span><br/><span class="hl-1">} </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">balance</span><span class="hl-1">: </span><span class="hl-7">DoubleAssetVaultBalance</span><span class="hl-1"> | </span><span class="hl-7">undefined</span><span class="hl-1"> =</span><br/><span class="hl-1"> </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">getDoubleAssetVaultBalance</span><span class="hl-1">(</span><span class="hl-4">address</span><span class="hl-1">, </span><span class="hl-4">poolName</span><span class="hl-1">);</span>
237
+ </code><button type="button">Copy</button></pre>
238
+
239
+ <a id="md:getallvaultbalances" class="tsd-anchor"></a>
240
+ <h2 class="tsd-anchor-link">
241
+ <code>getAllVaultBalances</code
242
+ ><a
243
+ href="#md:getallvaultbalances"
244
+ aria-label="Permalink"
245
+ class="tsd-anchor-icon"
246
+ ><svg viewBox="0 0 24 24">
247
+ <use href="assets/icons.svg#icon-anchor"></use></svg
248
+ ></a>
249
+ </h2>
250
+ <p>Call this to get user balance for all vaults.</p>
251
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">PoolName</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">AlphaFiVaultBalance</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">getAllVaultBalances</span><span class="hl-1">,</span><br/><span class="hl-1">} </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">balance</span><span class="hl-1">: </span><span class="hl-7">Map</span><span class="hl-1">&lt;</span><span class="hl-7">PoolName</span><span class="hl-1">, </span><span class="hl-7">AlphaFiVaultBalance</span><span class="hl-1">&gt; =</span><br/><span class="hl-1"> </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">getAllVaultBalances</span><span class="hl-1">(</span><span class="hl-4">address</span><span class="hl-1">);</span>
252
+ </code><button type="button">Copy</button></pre>
253
+
254
+ <a id="md:claimrewardtxb" class="tsd-anchor"></a>
255
+ <h2 class="tsd-anchor-link">
256
+ <code>claimRewardTxb</code
257
+ ><a
258
+ href="#md:claimrewardtxb"
259
+ aria-label="Permalink"
260
+ class="tsd-anchor-icon"
261
+ ><svg viewBox="0 0 24 24">
262
+ <use href="assets/icons.svg#icon-anchor"></use></svg
263
+ ></a>
264
+ </h2>
265
+ <p>Call this to withdraw from Vaults on AlphaFi Protocol.</p>
266
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">claimRewardTxb</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Transaction</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@mysten/sui/transactions&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">vaults</span><span class="hl-1">: </span><span class="hl-7">Transaction</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">claimRewardTxb</span><span class="hl-1">(</span><span class="hl-4">address</span><span class="hl-1">);</span>
267
+ </code><button type="button">Copy</button></pre>
268
+
269
+ <a id="md:depositsingleassettxb" class="tsd-anchor"></a>
270
+ <h2 class="tsd-anchor-link">
271
+ <code>depositSingleAssetTxb</code
272
+ ><a
273
+ href="#md:depositsingleassettxb"
274
+ aria-label="Permalink"
275
+ class="tsd-anchor-icon"
276
+ ><svg viewBox="0 0 24 24">
277
+ <use href="assets/icons.svg#icon-anchor"></use></svg
278
+ ></a>
279
+ </h2>
280
+ <p>
281
+ Call this to deposit in Single Asset Vaults on AlphaFi Protocol.
282
+ </p>
283
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">depositSingleAssetTxb</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Transaction</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@mysten/sui/transactions&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">vaults</span><span class="hl-1">: </span><span class="hl-7">Transaction</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">depositSingleAssetTxb</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-4">poolName</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">address</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">amount</span><span class="hl-1">,</span><br/><span class="hl-1">);</span>
284
+ </code><button type="button">Copy</button></pre>
285
+
286
+ <a id="md:depositdoubleassettxb" class="tsd-anchor"></a>
287
+ <h2 class="tsd-anchor-link">
288
+ <code>depositDoubleAssetTxb</code
289
+ ><a
290
+ href="#md:depositdoubleassettxb"
291
+ aria-label="Permalink"
292
+ class="tsd-anchor-icon"
293
+ ><svg viewBox="0 0 24 24">
294
+ <use href="assets/icons.svg#icon-anchor"></use></svg
295
+ ></a>
296
+ </h2>
297
+ <p>
298
+ Call this to deposit in Double Asset Vaults on AlphaFi Protocol.
299
+ </p>
300
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">depositDoubleAssetTxb</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Transaction</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@mysten/sui/transactions&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">vaults</span><span class="hl-1">: </span><span class="hl-7">Transaction</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">depositDoubleAssetTxb</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-4">poolName</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">address</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">amount</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">isAmountA</span><span class="hl-1">,</span><br/><span class="hl-1">);</span>
301
+ </code><button type="button">Copy</button></pre>
302
+
303
+ <a id="md:withdrawtxb" class="tsd-anchor"></a>
304
+ <h2 class="tsd-anchor-link">
305
+ <code>withdrawTxb</code
306
+ ><a
307
+ href="#md:withdrawtxb"
308
+ aria-label="Permalink"
309
+ class="tsd-anchor-icon"
310
+ ><svg viewBox="0 0 24 24">
311
+ <use href="assets/icons.svg#icon-anchor"></use></svg
312
+ ></a>
313
+ </h2>
314
+ <p>
315
+ Call this to withdraw from Vaults on AlphaFi Protocol. xTokensAmount
316
+ can be calculated using coinAmountToXTokensSingleAsset or
317
+ coinAmountToXTokensDoubleAsset function depending on whether the
318
+ pool is singleAsset or doubleAsset.
319
+ </p>
320
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">withdrawTxb</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Transaction</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@mysten/sui/transactions&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">vaults</span><span class="hl-1">: </span><span class="hl-7">Transaction</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">withdrawTxb</span><span class="hl-1">(</span><span class="hl-4">xTokensAmount</span><span class="hl-1">, </span><span class="hl-4">poolName</span><span class="hl-1">, </span><span class="hl-4">address</span><span class="hl-1">);</span>
321
+ </code><button type="button">Copy</button></pre>
322
+
323
+ <a id="md:withdrawalphatxb" class="tsd-anchor"></a>
324
+ <h2 class="tsd-anchor-link">
325
+ <code>withdrawAlphaTxb</code
326
+ ><a
327
+ href="#md:withdrawalphatxb"
328
+ aria-label="Permalink"
329
+ class="tsd-anchor-icon"
330
+ ><svg viewBox="0 0 24 24">
331
+ <use href="assets/icons.svg#icon-anchor"></use></svg
332
+ ></a>
333
+ </h2>
334
+ <p>
335
+ Call this to withdraw from Alpha Vault on AlphaFi Protocol.
336
+ xTokensAmount can be calculated using coinAmountToXTokensSingleAsset
337
+ function. If you want to withdraw from locked alpha tokens then pass
338
+ withdrawFromLocked as true, otherwise false.
339
+ </p>
340
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">withdrawAlphaTxb</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Transaction</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@mysten/sui/transactions&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">vaults</span><span class="hl-1">: </span><span class="hl-7">Transaction</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">withdrawAlphaTxb</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-4">xTokensAmount</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">withdrawFromLocked</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">address</span><span class="hl-1">,</span><br/><span class="hl-1">);</span>
341
+ </code><button type="button">Copy</button></pre>
342
+
343
+ <a id="md:coinamounttoxtokenssingleasset" class="tsd-anchor"></a>
344
+ <h2 class="tsd-anchor-link">
345
+ <code>coinAmountToXTokensSingleAsset</code
346
+ ><a
347
+ href="#md:coinamounttoxtokenssingleasset"
348
+ aria-label="Permalink"
349
+ class="tsd-anchor-icon"
350
+ ><svg viewBox="0 0 24 24">
351
+ <use href="assets/icons.svg#icon-anchor"></use></svg
352
+ ></a>
353
+ </h2>
354
+ <p>
355
+ Call this to convert coin amount to xTokenAmount for any Single
356
+ Asset pool on AlphaFi Protocol.
357
+ </p>
358
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">coinAmountToXTokensSingleAsset</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Transaction</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@mysten/sui/transactions&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">vaults</span><span class="hl-1">: </span><span class="hl-7">Transaction</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">coinAmountToXTokensSingleAsset</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-4">amount</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">poolName</span><span class="hl-1">,</span><br/><span class="hl-1">);</span>
359
+ </code><button type="button">Copy</button></pre>
360
+
361
+ <a id="md:coinamounttoxtokensdoubleasset" class="tsd-anchor"></a>
362
+ <h2 class="tsd-anchor-link">
363
+ <code>coinAmountToXTokensDoubleAsset</code
364
+ ><a
365
+ href="#md:coinamounttoxtokensdoubleasset"
366
+ aria-label="Permalink"
367
+ class="tsd-anchor-icon"
368
+ ><svg viewBox="0 0 24 24">
369
+ <use href="assets/icons.svg#icon-anchor"></use></svg
370
+ ></a>
371
+ </h2>
372
+ <p>
373
+ Call this to convert coin amount to xTokenAmount for any Double
374
+ Asset pool on AlphaFi Protocol. isAmountA parameter is true if you
375
+ have passed amount of 1st coin, otherwise its false.
376
+ </p>
377
+ <pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">coinAmountToXTokensDoubleAsset</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@alphafi/alphafi-sdk&quot;</span><span class="hl-1">;</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Transaction</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@mysten/sui/transactions&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">vaults</span><span class="hl-1">: </span><span class="hl-7">Transaction</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">coinAmountToXTokensDoubleAsset</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-4">amount</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">poolName</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">isAmountA</span><span class="hl-1">,</span><br/><span class="hl-1">);</span>
378
+ </code><button type="button">Copy</button></pre>
379
+ </div>
380
+ </div>
381
+ <div class="col-sidebar">
382
+ <div class="page-menu">
383
+ <div class="tsd-navigation settings">
384
+ <details class="tsd-accordion">
385
+ <summary class="tsd-accordion-summary">
386
+ <h3>
387
+ <svg width="20" height="20" viewBox="0 0 24 24" fill="none">
388
+ <use href="assets/icons.svg#icon-chevronDown"></use></svg
389
+ >Settings
390
+ </h3>
391
+ </summary>
392
+ <div class="tsd-accordion-details">
393
+ <div class="tsd-filter-visibility">
394
+ <span class="settings-label">Member Visibility</span>
395
+ <ul id="tsd-filter-options">
396
+ <li class="tsd-filter-item">
397
+ <label class="tsd-filter-input"
398
+ ><input
399
+ type="checkbox"
400
+ id="tsd-filter-inherited"
401
+ name="inherited"
402
+ checked
403
+ /><svg
404
+ width="32"
405
+ height="32"
406
+ viewBox="0 0 32 32"
407
+ aria-hidden="true"
408
+ >
409
+ <rect
410
+ class="tsd-checkbox-background"
411
+ width="30"
412
+ height="30"
413
+ x="1"
414
+ y="1"
415
+ rx="6"
416
+ fill="none"
417
+ ></rect>
418
+ <path
419
+ class="tsd-checkbox-checkmark"
420
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
421
+ stroke="none"
422
+ stroke-width="3.5"
423
+ stroke-linejoin="round"
424
+ fill="none"
425
+ ></path></svg
426
+ ><span>Inherited</span></label
427
+ >
428
+ </li>
429
+ <li class="tsd-filter-item">
430
+ <label class="tsd-filter-input"
431
+ ><input
432
+ type="checkbox"
433
+ id="tsd-filter-external"
434
+ name="external"
435
+ /><svg
436
+ width="32"
437
+ height="32"
438
+ viewBox="0 0 32 32"
439
+ aria-hidden="true"
440
+ >
441
+ <rect
442
+ class="tsd-checkbox-background"
443
+ width="30"
444
+ height="30"
445
+ x="1"
446
+ y="1"
447
+ rx="6"
448
+ fill="none"
449
+ ></rect>
450
+ <path
451
+ class="tsd-checkbox-checkmark"
452
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
453
+ stroke="none"
454
+ stroke-width="3.5"
455
+ stroke-linejoin="round"
456
+ fill="none"
457
+ ></path></svg
458
+ ><span>External</span></label
459
+ >
460
+ </li>
461
+ </ul>
462
+ </div>
463
+ <div class="tsd-theme-toggle">
464
+ <label class="settings-label" for="tsd-theme">Theme</label
465
+ ><select id="tsd-theme">
466
+ <option value="os">OS</option>
467
+ <option value="light">Light</option>
468
+ <option value="dark">Dark</option>
469
+ </select>
470
+ </div>
471
+ </div>
472
+ </details>
473
+ </div>
474
+ <details open class="tsd-accordion tsd-page-navigation">
475
+ <summary class="tsd-accordion-summary">
476
+ <h3>
477
+ <svg width="20" height="20" viewBox="0 0 24 24" fill="none">
478
+ <use href="assets/icons.svg#icon-chevronDown"></use></svg
479
+ >On This Page
480
+ </h3>
481
+ </summary>
482
+ <div class="tsd-accordion-details">
483
+ <a href="#md:alphafi-typescript-sdk"
484
+ ><span>Alpha<wbr />Fi <wbr />Type<wbr />Script SDK</span></a
485
+ >
486
+ <ul>
487
+ <li>
488
+ <a href="#md:installation"><span>Installation</span></a>
489
+ </li>
490
+ <li>
491
+ <a href="#md:api-reference"
492
+ ><span>API <wbr />Reference</span></a
493
+ >
494
+ </li>
495
+ <li>
496
+ <a href="#md:getvaults"
497
+ ><span>get<wbr />Vaults</span></a
498
+ >
499
+ </li>
500
+ <li>
501
+ <a href="#md:getsingleassetvaults"
502
+ ><span>get<wbr />Single<wbr />Asset<wbr />Vaults</span></a
503
+ >
504
+ </li>
505
+ <li>
506
+ <a href="#md:getdoubleassetvaults"
507
+ ><span>get<wbr />Double<wbr />Asset<wbr />Vaults</span></a
508
+ >
509
+ </li>
510
+ <li>
511
+ <a href="#md:getallvaults"
512
+ ><span>get<wbr />All<wbr />Vaults</span></a
513
+ >
514
+ </li>
515
+ <li>
516
+ <a href="#md:getallsingleassetvaults"
517
+ ><span
518
+ >get<wbr />All<wbr />Single<wbr />Asset<wbr />Vaults</span
519
+ ></a
520
+ >
521
+ </li>
522
+ <li>
523
+ <a href="#md:getalldoubleassetvaults"
524
+ ><span
525
+ >get<wbr />All<wbr />Double<wbr />Asset<wbr />Vaults</span
526
+ ></a
527
+ >
528
+ </li>
529
+ <li>
530
+ <a href="#md:getalphavaultbalance"
531
+ ><span>get<wbr />Alpha<wbr />Vault<wbr />Balance</span></a
532
+ >
533
+ </li>
534
+ <li>
535
+ <a href="#md:getsingleassetvaultbalance"
536
+ ><span
537
+ >get<wbr />Single<wbr />Asset<wbr />Vault<wbr />Balance</span
538
+ ></a
539
+ >
540
+ </li>
541
+ <li>
542
+ <a href="#md:getdoubleassetvaultbalance"
543
+ ><span
544
+ >get<wbr />Double<wbr />Asset<wbr />Vault<wbr />Balance</span
545
+ ></a
546
+ >
547
+ </li>
548
+ <li>
549
+ <a href="#md:getallvaultbalances"
550
+ ><span>get<wbr />All<wbr />Vault<wbr />Balances</span></a
551
+ >
552
+ </li>
553
+ <li>
554
+ <a href="#md:claimrewardtxb"
555
+ ><span>claim<wbr />Reward<wbr />Txb</span></a
556
+ >
557
+ </li>
558
+ <li>
559
+ <a href="#md:depositsingleassettxb"
560
+ ><span>deposit<wbr />Single<wbr />Asset<wbr />Txb</span></a
561
+ >
562
+ </li>
563
+ <li>
564
+ <a href="#md:depositdoubleassettxb"
565
+ ><span>deposit<wbr />Double<wbr />Asset<wbr />Txb</span></a
566
+ >
567
+ </li>
568
+ <li>
569
+ <a href="#md:withdrawtxb"
570
+ ><span>withdraw<wbr />Txb</span></a
571
+ >
572
+ </li>
573
+ <li>
574
+ <a href="#md:withdrawalphatxb"
575
+ ><span>withdraw<wbr />Alpha<wbr />Txb</span></a
576
+ >
577
+ </li>
578
+ <li>
579
+ <a href="#md:coinamounttoxtokenssingleasset"
580
+ ><span
581
+ >coin<wbr />Amount<wbr />ToXTokens<wbr />Single<wbr />Asset</span
582
+ ></a
583
+ >
584
+ </li>
585
+ <li>
586
+ <a href="#md:coinamounttoxtokensdoubleasset"
587
+ ><span
588
+ >coin<wbr />Amount<wbr />ToXTokens<wbr />Double<wbr />Asset</span
589
+ ></a
590
+ >
591
+ </li>
592
+ </ul>
593
+ </div>
594
+ </details>
595
+ </div>
596
+ <div class="site-menu">
597
+ <nav class="tsd-navigation">
598
+ <a href="modules.html" class="current"
599
+ ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
600
+ <use href="assets/icons.svg#icon-1"></use></svg
601
+ ><span>@alphafi/alphafi-sdk - v0.0.39</span></a
602
+ >
603
+ <ul
604
+ class="tsd-small-nested-navigation"
605
+ id="tsd-nav-container"
606
+ data-base="."
607
+ >
608
+ <li>Loading...</li>
609
+ </ul>
610
+ </nav>
611
+ </div>
612
+ </div>
613
+ </div>
614
+ <footer>
615
+ <p class="tsd-generator">
616
+ Generated using
617
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
618
+ </p>
619
+ </footer>
620
+ <div class="overlay"></div>
621
+ </body>
622
+ </html>