@alphafi/alphafi-sdk 0.0.46 → 0.0.47

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 (239) hide show
  1. package/dist/cjs/common/constants.d.ts +48 -0
  2. package/dist/cjs/common/constants.d.ts.map +1 -1
  3. package/dist/cjs/common/constants.js +40 -2
  4. package/dist/cjs/common/constants.js.map +1 -1
  5. package/dist/cjs/common/maps.d.ts.map +1 -1
  6. package/dist/cjs/common/maps.js +18 -0
  7. package/dist/cjs/common/maps.js.map +1 -1
  8. package/dist/cjs/common/types.d.ts +2 -2
  9. package/dist/cjs/common/types.d.ts.map +1 -1
  10. package/dist/cjs/common/types.js.map +1 -1
  11. package/dist/cjs/index.d.ts +1 -0
  12. package/dist/cjs/index.d.ts.map +1 -1
  13. package/dist/cjs/index.js +5 -2
  14. package/dist/cjs/index.js.map +1 -1
  15. package/dist/cjs/transactions/blueRewards.d.ts +9 -0
  16. package/dist/cjs/transactions/blueRewards.d.ts.map +1 -0
  17. package/dist/cjs/transactions/blueRewards.js +94 -0
  18. package/dist/cjs/transactions/blueRewards.js.map +1 -0
  19. package/dist/cjs/transactions/bluefin.d.ts.map +1 -1
  20. package/dist/cjs/transactions/bluefin.js +215 -158
  21. package/dist/cjs/transactions/bluefin.js.map +1 -1
  22. package/dist/cjs/transactions/collect_rewards.d.ts.map +1 -1
  23. package/dist/cjs/transactions/collect_rewards.js.map +1 -1
  24. package/dist/cjs/transactions/zapDeposit.d.ts.map +1 -1
  25. package/dist/cjs/transactions/zapDeposit.js +110 -100
  26. package/dist/cjs/transactions/zapDeposit.js.map +1 -1
  27. package/dist/esm/common/constants.d.ts +48 -0
  28. package/dist/esm/common/constants.d.ts.map +1 -1
  29. package/dist/esm/common/constants.js +40 -2
  30. package/dist/esm/common/constants.js.map +1 -1
  31. package/dist/esm/common/maps.d.ts.map +1 -1
  32. package/dist/esm/common/maps.js +18 -0
  33. package/dist/esm/common/maps.js.map +1 -1
  34. package/dist/esm/common/types.d.ts +2 -2
  35. package/dist/esm/common/types.d.ts.map +1 -1
  36. package/dist/esm/common/types.js.map +1 -1
  37. package/dist/esm/index.d.ts +1 -0
  38. package/dist/esm/index.d.ts.map +1 -1
  39. package/dist/esm/index.js +1 -0
  40. package/dist/esm/index.js.map +1 -1
  41. package/dist/esm/transactions/blueRewards.d.ts +9 -0
  42. package/dist/esm/transactions/blueRewards.d.ts.map +1 -0
  43. package/dist/esm/transactions/blueRewards.js +67 -0
  44. package/dist/esm/transactions/blueRewards.js.map +1 -0
  45. package/dist/esm/transactions/bluefin.d.ts.map +1 -1
  46. package/dist/esm/transactions/bluefin.js +215 -158
  47. package/dist/esm/transactions/bluefin.js.map +1 -1
  48. package/dist/esm/transactions/collect_rewards.d.ts.map +1 -1
  49. package/dist/esm/transactions/collect_rewards.js.map +1 -1
  50. package/dist/esm/transactions/zapDeposit.d.ts.map +1 -1
  51. package/dist/esm/transactions/zapDeposit.js +110 -100
  52. package/dist/esm/transactions/zapDeposit.js.map +1 -1
  53. package/docs/assets/highlight.css +74 -51
  54. package/docs/assets/icons.js +20 -17
  55. package/docs/assets/main.js +2163 -5
  56. package/docs/assets/navigation.js +2 -1
  57. package/docs/assets/search.js +2 -1
  58. package/docs/assets/style.css +846 -850
  59. package/docs/functions/alphaLpBreakdown.html +253 -1
  60. package/docs/functions/cetusLpBreakdown.html +253 -1
  61. package/docs/functions/claimRewardTxb.html +243 -1
  62. package/docs/functions/coinAmountToXTokensDoubleAsset.html +267 -1
  63. package/docs/functions/coinAmountToXTokensSingleAsset.html +260 -1
  64. package/docs/functions/coinsInPool.html +438 -1
  65. package/docs/functions/collectRewards.html +242 -1
  66. package/docs/functions/deposit.html +246 -1
  67. package/docs/functions/depositDoubleAssetTxb.html +270 -1
  68. package/docs/functions/depositSingleAssetTxb.html +263 -1
  69. package/docs/functions/fetchAfterTransactionEvents.html +306 -1
  70. package/docs/functions/fetchAutoCompoundingEvents.html +257 -1
  71. package/docs/functions/fetchAutoCompoundingEventsGql.html +251 -1
  72. package/docs/functions/fetchCetusPools.html +231 -1
  73. package/docs/functions/fetchChainIdentifier.html +233 -1
  74. package/docs/functions/fetchCheckRatioEvents.html +249 -1
  75. package/docs/functions/fetchLiquidityChangeEvents.html +257 -1
  76. package/docs/functions/fetchMultiReceipts.html +261 -1
  77. package/docs/functions/fetchNftHolders.html +233 -1
  78. package/docs/functions/fetchPools.html +230 -1
  79. package/docs/functions/fetchPortfolioData.html +243 -1
  80. package/docs/functions/fetchProtocolData.html +231 -1
  81. package/docs/functions/fetchTVL.html +253 -1
  82. package/docs/functions/fetchUserVaultBalances.html +245 -1
  83. package/docs/functions/fetchUserVaults.html +243 -1
  84. package/docs/functions/fetchUserWalletData.html +243 -1
  85. package/docs/functions/fetchWithdrawV2Events.html +255 -1
  86. package/docs/functions/getAirdropShare.html +243 -1
  87. package/docs/functions/getAllDoubleAssetVaults.html +235 -1
  88. package/docs/functions/getAllSingleAssetVaults.html +235 -1
  89. package/docs/functions/getAllVaultBalances.html +265 -1
  90. package/docs/functions/getAllVaults.html +233 -1
  91. package/docs/functions/getAlphaUnlocks.html +245 -1
  92. package/docs/functions/getAlphaVaultBalance.html +255 -1
  93. package/docs/functions/getAmounts.html +272 -1
  94. package/docs/functions/getApr.html +243 -1
  95. package/docs/functions/getAprs.html +255 -1
  96. package/docs/functions/getApy.html +243 -1
  97. package/docs/functions/getApys.html +255 -1
  98. package/docs/functions/getCetusInvestorTicksMap.html +284 -1
  99. package/docs/functions/getCetusSqrtPriceMap.html +249 -1
  100. package/docs/functions/getCoinAmountsFromLiquidity.html +273 -1
  101. package/docs/functions/getConf.html +11763 -1
  102. package/docs/functions/getCurrentTick.html +247 -1
  103. package/docs/functions/getDoubleAssetVaultBalance.html +268 -1
  104. package/docs/functions/getDoubleAssetVaults.html +253 -1
  105. package/docs/functions/getHoldersFromTransactions.html +299 -1
  106. package/docs/functions/getInvestor.html +259 -1
  107. package/docs/functions/getInvestorPoolMap.html +241 -1
  108. package/docs/functions/getLastAutoCompoundTime.html +249 -1
  109. package/docs/functions/getLatestPrices.html +253 -1
  110. package/docs/functions/getLiquidity.html +260 -1
  111. package/docs/functions/getMultiInvestor.html +231 -1
  112. package/docs/functions/getMultiLatestPrices.html +233 -1
  113. package/docs/functions/getMultiParentPool.html +231 -1
  114. package/docs/functions/getMultiPool.html +231 -1
  115. package/docs/functions/getMultiReceipts.html +243 -1
  116. package/docs/functions/getParentPool.html +266 -1
  117. package/docs/functions/getPool.html +262 -1
  118. package/docs/functions/getPoolExchangeRateMap.html +249 -1
  119. package/docs/functions/getPositionRange.html +283 -1
  120. package/docs/functions/getPositionRanges.html +289 -1
  121. package/docs/functions/getPositionTicks.html +249 -1
  122. package/docs/functions/getPriceToTick.html +254 -1
  123. package/docs/functions/getRebalanceHistories.html +269 -1
  124. package/docs/functions/getRebalanceHistory.html +255 -1
  125. package/docs/functions/getReceipts.html +268 -1
  126. package/docs/functions/getSingleAssetVaultBalance.html +268 -1
  127. package/docs/functions/getSingleAssetVaults.html +253 -1
  128. package/docs/functions/getSuiClient.html +247 -3
  129. package/docs/functions/getSuiNodeUrl.html +232 -3
  130. package/docs/functions/getTVLs-1.html +243 -1
  131. package/docs/functions/getTickToPrice.html +254 -1
  132. package/docs/functions/getTvls.html +259 -1
  133. package/docs/functions/getUserTokensFromTransactions.html +269 -1
  134. package/docs/functions/getUserTokensInUsdFromTransactions.html +263 -1
  135. package/docs/functions/getVaultBalance.html +277 -1
  136. package/docs/functions/getVaultBalanceForActiveUsers.html +261 -1
  137. package/docs/functions/getVaults.html +250 -1
  138. package/docs/functions/getXTokenVaultBalanceForActiveUsers.html +261 -1
  139. package/docs/functions/getZapAmounts.html +323 -1
  140. package/docs/functions/lastAutocompoundTime.html +249 -1
  141. package/docs/functions/liquidityToTokens.html +253 -1
  142. package/docs/functions/multiLiquidityToTokens.html +271 -1
  143. package/docs/functions/multiTokensToUsd.html +262 -1
  144. package/docs/functions/multiXTokensToLiquidity.html +257 -1
  145. package/docs/functions/parseUserWalletData.html +243 -1
  146. package/docs/functions/setSuiClient.html +255 -7
  147. package/docs/functions/setSuiNodeUrl.html +249 -5
  148. package/docs/functions/withdraw.html +249 -1
  149. package/docs/functions/withdrawAlphaTxb.html +257 -1
  150. package/docs/functions/withdrawTxb.html +260 -1
  151. package/docs/functions/zapDepositTxb.html +300 -1
  152. package/docs/index.html +587 -41
  153. package/docs/interfaces/Coin.html +474 -12
  154. package/docs/interfaces/CoinPair.html +358 -3
  155. package/docs/interfaces/NaviVoloData.html +514 -3
  156. package/docs/interfaces/RebalanceHistoryType.html +652 -9
  157. package/docs/modules.html +1315 -179
  158. package/docs/types/AfterTransactionEventNode.html +305 -1
  159. package/docs/types/Allocator.html +321 -1
  160. package/docs/types/AlphaFiDoubleAssetVault.html +258 -1
  161. package/docs/types/AlphaFiMultiVaultBalance.html +219 -1
  162. package/docs/types/AlphaFiSingleAssetVault.html +244 -1
  163. package/docs/types/AlphaFiVault.html +214 -1
  164. package/docs/types/AlphaFiVaultBalance.html +220 -1
  165. package/docs/types/AlphaPoolType.html +383 -1
  166. package/docs/types/AlphaReceipt.html +220 -1
  167. package/docs/types/AlphaReceiptFields.html +421 -1
  168. package/docs/types/AlphaVaultBalance.html +245 -1
  169. package/docs/types/AutoCompoundingEventNode.html +225 -1
  170. package/docs/types/BluefinInvestor.html +209 -1
  171. package/docs/types/BluefinPoolType.html +440 -1
  172. package/docs/types/BucketInvestor.html +249 -1
  173. package/docs/types/CetusInvestor.html +240 -1
  174. package/docs/types/CetusPoolType.html +433 -1
  175. package/docs/types/CetusSwapOptions.html +209 -1
  176. package/docs/types/CoinAmounts.html +216 -1
  177. package/docs/types/CoinName.html +290 -1
  178. package/docs/types/CoinType.html +291 -1
  179. package/docs/types/CommonInvestorFields.html +276 -1
  180. package/docs/types/CreatePoolOptions.html +246 -1
  181. package/docs/types/Distributor.html +341 -1
  182. package/docs/types/DoubleAssetMultiVaultBalance.html +236 -1
  183. package/docs/types/DoubleAssetPoolNames.html +289 -1
  184. package/docs/types/DoubleAssetTokenHoldings.html +232 -1
  185. package/docs/types/DoubleAssetVaultBalance.html +229 -1
  186. package/docs/types/GetHoldersParams.html +221 -1
  187. package/docs/types/GetTokenHoldingsParams.html +227 -1
  188. package/docs/types/GetUserTokensFromTransactionsParams.html +233 -1
  189. package/docs/types/GetUserTokensInUsdFromTransactionsParams.html +244 -1
  190. package/docs/types/GetVaultBalanceForActiveUsersParams.html +231 -1
  191. package/docs/types/GetVaultBalanceParams.html +217 -1
  192. package/docs/types/HoldingsObj.html +223 -1
  193. package/docs/types/Icon.html +266 -1
  194. package/docs/types/Investor.html +245 -1
  195. package/docs/types/LiquidityChangeEventNode.html +220 -1
  196. package/docs/types/LiquidityToTokensParams.html +255 -1
  197. package/docs/types/LiquidityToUsdParams.html +267 -1
  198. package/docs/types/LoopingDebt.html +258 -1
  199. package/docs/types/LpBreakdownType.html +238 -1
  200. package/docs/types/MemberPoolDataType.html +276 -1
  201. package/docs/types/MemberType.html +269 -1
  202. package/docs/types/MultiGetVaultBalancesParams.html +229 -1
  203. package/docs/types/NaviInvestor.html +235 -1
  204. package/docs/types/OtherReceiptFields.html +373 -1
  205. package/docs/types/PoolName.html +326 -1
  206. package/docs/types/PoolReceipt.html +253 -1
  207. package/docs/types/PoolType.html +388 -1
  208. package/docs/types/Receipt.html +475 -1
  209. package/docs/types/ReceiptGQL.html +374 -1
  210. package/docs/types/SingleAssetMultiVaultBalance.html +232 -1
  211. package/docs/types/SingleAssetPoolNames.html +247 -1
  212. package/docs/types/SingleAssetTokenHoldings.html +228 -1
  213. package/docs/types/SingleAssetVaultBalance.html +223 -1
  214. package/docs/types/SingleGetVaultBalancesParams.html +224 -1
  215. package/docs/types/StrategyType.html +217 -1
  216. package/docs/types/SuiNetwork.html +213 -1
  217. package/docs/types/SwapOptions.html +248 -1
  218. package/docs/types/TickSpacing.html +212 -1
  219. package/docs/types/TotalWeightType.html +246 -1
  220. package/docs/types/TransactionBlockType.html +358 -1
  221. package/docs/types/UserPoolLiquidity.html +221 -1
  222. package/docs/types/UserPoolTokenHoldings.html +217 -1
  223. package/docs/types/UserUsdHoldings.html +223 -1
  224. package/docs/types/VaultBalance.html +216 -1
  225. package/docs/types/WithdrawV2EventNode.html +208 -1
  226. package/docs/variables/bluefinPoolMap.html +214 -1
  227. package/docs/variables/cetusPoolMap.html +214 -1
  228. package/docs/variables/coinsList.html +220 -1
  229. package/docs/variables/defunctPoolsSet.html +209 -1
  230. package/docs/variables/doubleAssetPoolCoinMap.html +237 -1
  231. package/docs/variables/ignoredWalletsForDailyRevenue.html +218 -1
  232. package/docs/variables/loopingAccountAddresses.html +219 -1
  233. package/docs/variables/loopingPoolCoinMap.html +233 -1
  234. package/docs/variables/naviAssetMap.html +215 -1
  235. package/docs/variables/poolIdPoolNameMap.html +218 -1
  236. package/docs/variables/poolInfo.html +304 -1
  237. package/docs/variables/singleAssetPoolCoinMap.html +229 -1
  238. package/docs/variables/stableCoins.html +207 -1
  239. package/package.json +4 -3
@@ -1,3 +1,358 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CoinPair | @alphafi/alphafi-sdk - v0.0.46</title><meta name="description" content="Documentation for @alphafi/alphafi-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@alphafi/alphafi-sdk - v0.0.46</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@alphafi/alphafi-sdk</a></li><li><a href="CoinPair.html">CoinPair</a></li></ul><h1>Interface CoinPair</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CoinPair</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="CoinPair.html#coinA">coinA</a><span class="tsd-signature-symbol">: </span><a href="Coin.html" class="tsd-signature-type tsd-kind-interface">Coin</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="CoinPair.html#coinB">coinB</a><span class="tsd-signature-symbol">: </span><a href="Coin.html" class="tsd-signature-type tsd-kind-interface">Coin</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AlphaFiTech/alphafi-sdk/blob/ad45856aec52bc553dbb631704dbf058dd03f3af/src/common/types.ts#L612">common/types.ts:612</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="CoinPair.html#coinA" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>coinA</span></a>
2
- <a href="CoinPair.html#coinB" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>coinB</span></a>
3
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="coinA" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>coinA</span><a href="#coinA" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">coinA</span><span class="tsd-signature-symbol">:</span> <a href="Coin.html" class="tsd-signature-type tsd-kind-interface">Coin</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AlphaFiTech/alphafi-sdk/blob/ad45856aec52bc553dbb631704dbf058dd03f3af/src/common/types.ts#L613">common/types.ts:613</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="coinB" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>coinB</span><a href="#coinB" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">coinB</span><span class="tsd-signature-symbol">:</span> <a href="Coin.html" class="tsd-signature-type tsd-kind-interface">Coin</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AlphaFiTech/alphafi-sdk/blob/ad45856aec52bc553dbb631704dbf058dd03f3af/src/common/types.ts#L614">common/types.ts:614</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#coinA" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>coinA</span></a><a href="#coinB" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>coinB</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@alphafi/alphafi-sdk - v0.0.46</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
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>CoinPair | @alphafi/alphafi-sdk - v0.0.46</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.46</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="CoinPair.html">CoinPair</a></li>
65
+ </ul>
66
+ <h1>Interface CoinPair</h1>
67
+ </div>
68
+ <div class="tsd-signature">
69
+ <span class="tsd-signature-keyword">interface </span
70
+ ><span class="tsd-kind-interface">CoinPair</span>
71
+ <span class="tsd-signature-symbol">{ </span><br /><span>    </span
72
+ ><a class="tsd-kind-property" href="CoinPair.html#coinA">coinA</a
73
+ ><span class="tsd-signature-symbol">: </span
74
+ ><a href="Coin.html" class="tsd-signature-type tsd-kind-interface"
75
+ >Coin</a
76
+ ><span class="tsd-signature-symbol">; </span><br /><span>    </span
77
+ ><a class="tsd-kind-property" href="CoinPair.html#coinB">coinB</a
78
+ ><span class="tsd-signature-symbol">: </span
79
+ ><a href="Coin.html" class="tsd-signature-type tsd-kind-interface"
80
+ >Coin</a
81
+ ><span class="tsd-signature-symbol">; </span><br /><span
82
+ class="tsd-signature-symbol"
83
+ >}</span
84
+ >
85
+ </div>
86
+ <aside class="tsd-sources">
87
+ <ul>
88
+ <li>
89
+ Defined in
90
+ <a
91
+ href="https://github.com/AlphaFiTech/alphafi-sdk/blob/ad45856aec52bc553dbb631704dbf058dd03f3af/src/common/types.ts#L612"
92
+ >common/types.ts:612</a
93
+ >
94
+ </li>
95
+ </ul>
96
+ </aside>
97
+ <section class="tsd-panel-group tsd-index-group">
98
+ <section class="tsd-panel tsd-index-panel">
99
+ <details class="tsd-index-content tsd-accordion" open>
100
+ <summary class="tsd-accordion-summary tsd-index-summary">
101
+ <h5
102
+ class="tsd-index-heading uppercase"
103
+ role="button"
104
+ aria-expanded="false"
105
+ tabindex="0"
106
+ >
107
+ <svg width="16" height="16" viewBox="0 0 16 16" fill="none">
108
+ <use href="../assets/icons.svg#icon-chevronSmall"></use>
109
+ </svg>
110
+ Index
111
+ </h5>
112
+ </summary>
113
+ <div class="tsd-accordion-details">
114
+ <section class="tsd-index-section">
115
+ <h3 class="tsd-index-heading">Properties</h3>
116
+ <div class="tsd-index-list">
117
+ <a href="CoinPair.html#coinA" class="tsd-index-link"
118
+ ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
119
+ <use href="../assets/icons.svg#icon-1024"></use></svg
120
+ ><span>coinA</span></a
121
+ >
122
+ <a href="CoinPair.html#coinB" class="tsd-index-link"
123
+ ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
124
+ <use href="../assets/icons.svg#icon-1024"></use></svg
125
+ ><span>coinB</span></a
126
+ >
127
+ </div>
128
+ </section>
129
+ </div>
130
+ </details>
131
+ </section>
132
+ </section>
133
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
134
+ <summary class="tsd-accordion-summary" data-key="section-Properties">
135
+ <h2>
136
+ <svg width="20" height="20" viewBox="0 0 24 24" fill="none">
137
+ <use href="../assets/icons.svg#icon-chevronDown"></use>
138
+ </svg>
139
+ Properties
140
+ </h2>
141
+ </summary>
142
+ <section>
143
+ <section class="tsd-panel tsd-member">
144
+ <a id="coinA" class="tsd-anchor"></a>
145
+ <h3 class="tsd-anchor-link">
146
+ <span>coinA</span
147
+ ><a href="#coinA" aria-label="Permalink" class="tsd-anchor-icon"
148
+ ><svg viewBox="0 0 24 24">
149
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
150
+ ></a>
151
+ </h3>
152
+ <div class="tsd-signature">
153
+ <span class="tsd-kind-property">coinA</span
154
+ ><span class="tsd-signature-symbol">:</span>
155
+ <a
156
+ href="Coin.html"
157
+ class="tsd-signature-type tsd-kind-interface"
158
+ >Coin</a
159
+ >
160
+ </div>
161
+ <aside class="tsd-sources">
162
+ <ul>
163
+ <li>
164
+ Defined in
165
+ <a
166
+ href="https://github.com/AlphaFiTech/alphafi-sdk/blob/ad45856aec52bc553dbb631704dbf058dd03f3af/src/common/types.ts#L613"
167
+ >common/types.ts:613</a
168
+ >
169
+ </li>
170
+ </ul>
171
+ </aside>
172
+ </section>
173
+ <section class="tsd-panel tsd-member">
174
+ <a id="coinB" class="tsd-anchor"></a>
175
+ <h3 class="tsd-anchor-link">
176
+ <span>coinB</span
177
+ ><a href="#coinB" aria-label="Permalink" class="tsd-anchor-icon"
178
+ ><svg viewBox="0 0 24 24">
179
+ <use href="../assets/icons.svg#icon-anchor"></use></svg
180
+ ></a>
181
+ </h3>
182
+ <div class="tsd-signature">
183
+ <span class="tsd-kind-property">coinB</span
184
+ ><span class="tsd-signature-symbol">:</span>
185
+ <a
186
+ href="Coin.html"
187
+ class="tsd-signature-type tsd-kind-interface"
188
+ >Coin</a
189
+ >
190
+ </div>
191
+ <aside class="tsd-sources">
192
+ <ul>
193
+ <li>
194
+ Defined in
195
+ <a
196
+ href="https://github.com/AlphaFiTech/alphafi-sdk/blob/ad45856aec52bc553dbb631704dbf058dd03f3af/src/common/types.ts#L614"
197
+ >common/types.ts:614</a
198
+ >
199
+ </li>
200
+ </ul>
201
+ </aside>
202
+ </section>
203
+ </section>
204
+ </details>
205
+ </div>
206
+ <div class="col-sidebar">
207
+ <div class="page-menu">
208
+ <div class="tsd-navigation settings">
209
+ <details class="tsd-accordion">
210
+ <summary class="tsd-accordion-summary">
211
+ <h3>
212
+ <svg width="20" height="20" viewBox="0 0 24 24" fill="none">
213
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
214
+ >Settings
215
+ </h3>
216
+ </summary>
217
+ <div class="tsd-accordion-details">
218
+ <div class="tsd-filter-visibility">
219
+ <span class="settings-label">Member Visibility</span>
220
+ <ul id="tsd-filter-options">
221
+ <li class="tsd-filter-item">
222
+ <label class="tsd-filter-input"
223
+ ><input
224
+ type="checkbox"
225
+ id="tsd-filter-inherited"
226
+ name="inherited"
227
+ checked
228
+ /><svg
229
+ width="32"
230
+ height="32"
231
+ viewBox="0 0 32 32"
232
+ aria-hidden="true"
233
+ >
234
+ <rect
235
+ class="tsd-checkbox-background"
236
+ width="30"
237
+ height="30"
238
+ x="1"
239
+ y="1"
240
+ rx="6"
241
+ fill="none"
242
+ ></rect>
243
+ <path
244
+ class="tsd-checkbox-checkmark"
245
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
246
+ stroke="none"
247
+ stroke-width="3.5"
248
+ stroke-linejoin="round"
249
+ fill="none"
250
+ ></path></svg
251
+ ><span>Inherited</span></label
252
+ >
253
+ </li>
254
+ <li class="tsd-filter-item">
255
+ <label class="tsd-filter-input"
256
+ ><input
257
+ type="checkbox"
258
+ id="tsd-filter-external"
259
+ name="external"
260
+ /><svg
261
+ width="32"
262
+ height="32"
263
+ viewBox="0 0 32 32"
264
+ aria-hidden="true"
265
+ >
266
+ <rect
267
+ class="tsd-checkbox-background"
268
+ width="30"
269
+ height="30"
270
+ x="1"
271
+ y="1"
272
+ rx="6"
273
+ fill="none"
274
+ ></rect>
275
+ <path
276
+ class="tsd-checkbox-checkmark"
277
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
278
+ stroke="none"
279
+ stroke-width="3.5"
280
+ stroke-linejoin="round"
281
+ fill="none"
282
+ ></path></svg
283
+ ><span>External</span></label
284
+ >
285
+ </li>
286
+ </ul>
287
+ </div>
288
+ <div class="tsd-theme-toggle">
289
+ <label class="settings-label" for="tsd-theme">Theme</label
290
+ ><select id="tsd-theme">
291
+ <option value="os">OS</option>
292
+ <option value="light">Light</option>
293
+ <option value="dark">Dark</option>
294
+ </select>
295
+ </div>
296
+ </div>
297
+ </details>
298
+ </div>
299
+ <details open class="tsd-accordion tsd-page-navigation">
300
+ <summary class="tsd-accordion-summary">
301
+ <h3>
302
+ <svg width="20" height="20" viewBox="0 0 24 24" fill="none">
303
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
304
+ >On This Page
305
+ </h3>
306
+ </summary>
307
+ <div class="tsd-accordion-details">
308
+ <details open class="tsd-accordion tsd-page-navigation-section">
309
+ <summary
310
+ class="tsd-accordion-summary"
311
+ data-key="tsd-otp-Properties"
312
+ >
313
+ <svg width="20" height="20" viewBox="0 0 24 24" fill="none">
314
+ <use href="../assets/icons.svg#icon-chevronDown"></use></svg
315
+ >Properties
316
+ </summary>
317
+ <div>
318
+ <a href="#coinA" class=""
319
+ ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
320
+ <use href="../assets/icons.svg#icon-1024"></use></svg
321
+ ><span>coinA</span></a
322
+ ><a href="#coinB" class=""
323
+ ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
324
+ <use href="../assets/icons.svg#icon-1024"></use></svg
325
+ ><span>coinB</span></a
326
+ >
327
+ </div>
328
+ </details>
329
+ </div>
330
+ </details>
331
+ </div>
332
+ <div class="site-menu">
333
+ <nav class="tsd-navigation">
334
+ <a href="../modules.html"
335
+ ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
336
+ <use href="../assets/icons.svg#icon-1"></use></svg
337
+ ><span>@alphafi/alphafi-sdk - v0.0.46</span></a
338
+ >
339
+ <ul
340
+ class="tsd-small-nested-navigation"
341
+ id="tsd-nav-container"
342
+ data-base=".."
343
+ >
344
+ <li>Loading...</li>
345
+ </ul>
346
+ </nav>
347
+ </div>
348
+ </div>
349
+ </div>
350
+ <footer>
351
+ <p class="tsd-generator">
352
+ Generated using
353
+ <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
354
+ </p>
355
+ </footer>
356
+ <div class="overlay"></div>
357
+ </body>
358
+ </html>