@alphafi/alphafi-sdk 0.0.58 → 0.0.59

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 (220) hide show
  1. package/dist/cjs/common/constants.d.ts.map +1 -1
  2. package/dist/cjs/common/constants.js +2 -1
  3. package/dist/cjs/common/constants.js.map +1 -1
  4. package/dist/cjs/getAprs.d.ts +2 -0
  5. package/dist/cjs/getAprs.d.ts.map +1 -1
  6. package/dist/cjs/getAprs.js +251 -1
  7. package/dist/cjs/getAprs.js.map +1 -1
  8. package/dist/esm/common/constants.d.ts.map +1 -1
  9. package/dist/esm/common/constants.js +2 -1
  10. package/dist/esm/common/constants.js.map +1 -1
  11. package/dist/esm/getAprs.d.ts +2 -0
  12. package/dist/esm/getAprs.d.ts.map +1 -1
  13. package/dist/esm/getAprs.js +249 -2
  14. package/dist/esm/getAprs.js.map +1 -1
  15. package/docs/assets/highlight.css +51 -74
  16. package/docs/assets/icons.js +17 -20
  17. package/docs/assets/main.js +5 -2163
  18. package/docs/assets/navigation.js +1 -2
  19. package/docs/assets/search.js +1 -2
  20. package/docs/assets/style.css +850 -846
  21. package/docs/functions/alphaLpBreakdown.html +1 -253
  22. package/docs/functions/cetusLpBreakdown.html +1 -253
  23. package/docs/functions/claimBlueRewardTxb.html +1 -258
  24. package/docs/functions/claimRewardTxb.html +1 -243
  25. package/docs/functions/coinAmountToXTokensDoubleAsset.html +1 -267
  26. package/docs/functions/coinAmountToXTokensSingleAsset.html +1 -260
  27. package/docs/functions/coinsInPool.html +1 -438
  28. package/docs/functions/collectRewards.html +1 -242
  29. package/docs/functions/deposit.html +1 -246
  30. package/docs/functions/depositDoubleAssetTxb.html +1 -270
  31. package/docs/functions/depositSingleAssetTxb.html +1 -263
  32. package/docs/functions/fetchAfterTransactionEvents.html +1 -328
  33. package/docs/functions/fetchAutoCompoundingEvents.html +1 -257
  34. package/docs/functions/fetchAutoCompoundingEventsGql.html +1 -251
  35. package/docs/functions/fetchCetusPools.html +1 -231
  36. package/docs/functions/fetchChainIdentifier.html +1 -233
  37. package/docs/functions/fetchCheckRatioEvents.html +1 -249
  38. package/docs/functions/fetchLiquidityChangeEvents.html +1 -257
  39. package/docs/functions/fetchMultiCategoryEvents.html +1 -348
  40. package/docs/functions/fetchMultiReceipts.html +1 -261
  41. package/docs/functions/fetchNftHolders.html +1 -233
  42. package/docs/functions/fetchPools.html +1 -230
  43. package/docs/functions/fetchPortfolioData.html +1 -243
  44. package/docs/functions/fetchProtocolData.html +1 -231
  45. package/docs/functions/fetchTVL.html +1 -253
  46. package/docs/functions/fetchUserVaultBalances.html +1 -245
  47. package/docs/functions/fetchUserVaults.html +1 -243
  48. package/docs/functions/fetchUserWalletData.html +1 -243
  49. package/docs/functions/fetchVoloExchangeRate.html +1 -251
  50. package/docs/functions/fetchWithdrawV2Events.html +1 -255
  51. package/docs/functions/getAirdropShare.html +1 -243
  52. package/docs/functions/getAllDoubleAssetVaults.html +1 -235
  53. package/docs/functions/getAllSingleAssetVaults.html +1 -235
  54. package/docs/functions/getAllVaultBalances.html +1 -265
  55. package/docs/functions/getAllVaults.html +1 -233
  56. package/docs/functions/getAlphaUnlocks.html +1 -245
  57. package/docs/functions/getAlphaVaultBalance.html +1 -255
  58. package/docs/functions/getAmounts.html +1 -272
  59. package/docs/functions/getApr.html +1 -243
  60. package/docs/functions/getAprs.html +1 -255
  61. package/docs/functions/getApy.html +1 -243
  62. package/docs/functions/getApys.html +1 -255
  63. package/docs/functions/getCetusInvestorTicksMap.html +1 -284
  64. package/docs/functions/getCetusPool.html +1 -270
  65. package/docs/functions/getCetusSqrtPriceMap.html +1 -249
  66. package/docs/functions/getCoinAmountsFromLiquidity.html +1 -273
  67. package/docs/functions/getConf.html +1 -13163
  68. package/docs/functions/getCurrentTick.html +1 -247
  69. package/docs/functions/getDistributor.html +1 -252
  70. package/docs/functions/getDoubleAssetVaultBalance.html +1 -268
  71. package/docs/functions/getDoubleAssetVaults.html +1 -253
  72. package/docs/functions/getHoldersFromTransactions.html +1 -299
  73. package/docs/functions/getInvestor.html +1 -259
  74. package/docs/functions/getInvestorPoolMap.html +1 -241
  75. package/docs/functions/getLastAutoCompoundTime.html +1 -249
  76. package/docs/functions/getLatestPrices.html +1 -253
  77. package/docs/functions/getLiquidity.html +1 -260
  78. package/docs/functions/getMultiCetusPool.html +1 -231
  79. package/docs/functions/getMultiInvestor.html +1 -231
  80. package/docs/functions/getMultiLatestPrices.html +1 -233
  81. package/docs/functions/getMultiParentPool.html +1 -231
  82. package/docs/functions/getMultiPool.html +1 -231
  83. package/docs/functions/getMultiReceipts.html +1 -243
  84. package/docs/functions/getParentPool.html +1 -266
  85. package/docs/functions/getPool.html +1 -262
  86. package/docs/functions/getPoolExchangeRate.html +1 -254
  87. package/docs/functions/getPoolExchangeRateMap.html +1 -249
  88. package/docs/functions/getPoolsWeightDistribution.html +1 -266
  89. package/docs/functions/getPositionRange.html +1 -283
  90. package/docs/functions/getPositionRanges.html +1 -289
  91. package/docs/functions/getPositionTicks.html +1 -249
  92. package/docs/functions/getPriceToTick.html +1 -264
  93. package/docs/functions/getRebalanceHistories.html +1 -269
  94. package/docs/functions/getRebalanceHistory.html +1 -255
  95. package/docs/functions/getReceipts.html +1 -268
  96. package/docs/functions/getSingleAssetVaultBalance.html +1 -268
  97. package/docs/functions/getSingleAssetVaults.html +1 -253
  98. package/docs/functions/getSuiClient.html +3 -247
  99. package/docs/functions/getSuiNodeUrl.html +3 -232
  100. package/docs/functions/getTVLs-1.html +1 -243
  101. package/docs/functions/getTickSpacing.html +1 -247
  102. package/docs/functions/getTickToPrice.html +1 -248
  103. package/docs/functions/getTvls.html +1 -259
  104. package/docs/functions/getUserTokensFromTransactions.html +1 -269
  105. package/docs/functions/getUserTokensInUsdFromTransactions.html +1 -263
  106. package/docs/functions/getVaultBalance.html +1 -277
  107. package/docs/functions/getVaultBalanceForActiveUsers.html +1 -261
  108. package/docs/functions/getVaults.html +1 -250
  109. package/docs/functions/getXTokenVaultBalanceForActiveUsers.html +1 -261
  110. package/docs/functions/getZapAmounts.html +1 -323
  111. package/docs/functions/lastAutocompoundTime.html +1 -249
  112. package/docs/functions/liquidityToTokens.html +1 -253
  113. package/docs/functions/multiLiquidityToTokens.html +1 -271
  114. package/docs/functions/multiTokensToUsd.html +1 -262
  115. package/docs/functions/multiXTokensToLiquidity.html +1 -257
  116. package/docs/functions/parseUserWalletData.html +1 -243
  117. package/docs/functions/pendingBlueRewardAmount.html +1 -256
  118. package/docs/functions/setCustomSuiClient.html +5 -251
  119. package/docs/functions/setSuiClient.html +7 -255
  120. package/docs/functions/setSuiNodeUrl.html +5 -249
  121. package/docs/functions/setWeights.html +1 -270
  122. package/docs/functions/withdraw.html +1 -249
  123. package/docs/functions/withdrawAlphaTxb.html +1 -257
  124. package/docs/functions/withdrawTxb.html +1 -260
  125. package/docs/functions/zapDepositTxb.html +1 -300
  126. package/docs/index.html +41 -587
  127. package/docs/interfaces/Coin.html +12 -474
  128. package/docs/interfaces/CoinPair.html +3 -358
  129. package/docs/interfaces/NaviVoloData.html +3 -514
  130. package/docs/interfaces/PoolData.html +8 -579
  131. package/docs/interfaces/PoolWeightDistribution.html +4 -414
  132. package/docs/interfaces/RebalanceHistoryType.html +9 -652
  133. package/docs/modules.html +198 -1430
  134. package/docs/types/AfterTransactionEventNode.html +1 -305
  135. package/docs/types/Allocator.html +1 -321
  136. package/docs/types/AlphaFiDoubleAssetVault.html +1 -258
  137. package/docs/types/AlphaFiMultiVaultBalance.html +1 -219
  138. package/docs/types/AlphaFiSingleAssetVault.html +1 -244
  139. package/docs/types/AlphaFiVault.html +1 -214
  140. package/docs/types/AlphaFiVaultBalance.html +1 -220
  141. package/docs/types/AlphaPoolType.html +1 -383
  142. package/docs/types/AlphaReceipt.html +1 -220
  143. package/docs/types/AlphaReceiptFields.html +1 -421
  144. package/docs/types/AlphaVaultBalance.html +1 -245
  145. package/docs/types/AutoBalancePoolNames.html +1 -226
  146. package/docs/types/AutoCompoundingEventNode.html +1 -230
  147. package/docs/types/BluefinInvestor.html +1 -209
  148. package/docs/types/BluefinPoolType.html +1 -440
  149. package/docs/types/BucketInvestor.html +1 -249
  150. package/docs/types/CetusInvestor.html +1 -240
  151. package/docs/types/CetusPoolType.html +1 -433
  152. package/docs/types/CetusSwapOptions.html +1 -209
  153. package/docs/types/CoinAmounts.html +1 -216
  154. package/docs/types/CoinName.html +1 -293
  155. package/docs/types/CoinType.html +1 -294
  156. package/docs/types/CommonInvestorFields.html +1 -276
  157. package/docs/types/CreatePoolOptions.html +1 -246
  158. package/docs/types/Distributor.html +1 -341
  159. package/docs/types/DoubleAssetMultiVaultBalance.html +1 -236
  160. package/docs/types/DoubleAssetPoolNames.html +1 -297
  161. package/docs/types/DoubleAssetTokenHoldings.html +1 -232
  162. package/docs/types/DoubleAssetVaultBalance.html +1 -229
  163. package/docs/types/EventCategory.html +1 -209
  164. package/docs/types/EventNode.html +1 -229
  165. package/docs/types/GetHoldersParams.html +1 -221
  166. package/docs/types/GetTokenHoldingsParams.html +1 -227
  167. package/docs/types/GetUserTokensFromTransactionsParams.html +1 -233
  168. package/docs/types/GetUserTokensInUsdFromTransactionsParams.html +1 -244
  169. package/docs/types/GetVaultBalanceForActiveUsersParams.html +1 -231
  170. package/docs/types/GetVaultBalanceParams.html +1 -217
  171. package/docs/types/HoldingsObj.html +1 -223
  172. package/docs/types/Icon.html +1 -266
  173. package/docs/types/Investor.html +1 -245
  174. package/docs/types/LiquidityChangeEventNode.html +1 -220
  175. package/docs/types/LiquidityToTokensParams.html +1 -255
  176. package/docs/types/LiquidityToUsdParams.html +1 -267
  177. package/docs/types/LoopingDebt.html +1 -258
  178. package/docs/types/LoopingPoolNames.html +1 -216
  179. package/docs/types/LpBreakdownType.html +1 -238
  180. package/docs/types/MemberPoolDataType.html +1 -276
  181. package/docs/types/MemberType.html +1 -269
  182. package/docs/types/MultiGetVaultBalancesParams.html +1 -229
  183. package/docs/types/NaviInvestor.html +1 -235
  184. package/docs/types/OtherReceiptFields.html +1 -373
  185. package/docs/types/PoolName.html +1 -214
  186. package/docs/types/PoolReceipt.html +1 -253
  187. package/docs/types/PoolType.html +1 -388
  188. package/docs/types/Receipt.html +1 -475
  189. package/docs/types/ReceiptGQL.html +1 -374
  190. package/docs/types/SingleAssetMultiVaultBalance.html +1 -232
  191. package/docs/types/SingleAssetPoolNames.html +1 -244
  192. package/docs/types/SingleAssetTokenHoldings.html +1 -228
  193. package/docs/types/SingleAssetVaultBalance.html +1 -223
  194. package/docs/types/SingleGetVaultBalancesParams.html +1 -224
  195. package/docs/types/StrategyType.html +1 -221
  196. package/docs/types/SuiNetwork.html +1 -213
  197. package/docs/types/SwapOptions.html +1 -248
  198. package/docs/types/TickSpacing.html +1 -212
  199. package/docs/types/TotalWeightType.html +1 -246
  200. package/docs/types/TransactionBlockType.html +1 -358
  201. package/docs/types/UserPoolLiquidity.html +1 -221
  202. package/docs/types/UserPoolTokenHoldings.html +1 -217
  203. package/docs/types/UserUsdHoldings.html +1 -223
  204. package/docs/types/VaultBalance.html +1 -216
  205. package/docs/types/WithdrawV2EventNode.html +1 -208
  206. package/docs/variables/bluefinPoolMap.html +1 -214
  207. package/docs/variables/cetusPoolMap.html +1 -214
  208. package/docs/variables/coinsList.html +1 -220
  209. package/docs/variables/defunctPoolsSet.html +1 -209
  210. package/docs/variables/doubleAssetPoolCoinMap.html +1 -237
  211. package/docs/variables/eventCategories.html +1 -210
  212. package/docs/variables/ignoredWalletsForDailyRevenue.html +1 -218
  213. package/docs/variables/loopingAccountAddresses.html +1 -219
  214. package/docs/variables/loopingPoolCoinMap.html +1 -233
  215. package/docs/variables/naviAssetMap.html +1 -215
  216. package/docs/variables/poolIdPoolNameMap.html +1 -218
  217. package/docs/variables/poolInfo.html +1 -319
  218. package/docs/variables/singleAssetPoolCoinMap.html +1 -229
  219. package/docs/variables/stableCoins.html +1 -207
  220. package/package.json +1 -1
@@ -1,474 +1,12 @@
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>Coin | @alphafi/alphafi-sdk - v0.0.56</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.56</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="Coin.html">Coin</a></li>
65
- </ul>
66
- <h1>Interface Coin</h1>
67
- </div>
68
- <section class="tsd-panel tsd-comment">
69
- <div class="tsd-comment tsd-typography">
70
- <p>Represents a coin with its name, type, icon, and exponent.</p>
71
- </div>
72
- <div class="tsd-comment tsd-typography"></div>
73
- </section>
74
- <div class="tsd-signature">
75
- <span class="tsd-signature-keyword">interface </span
76
- ><span class="tsd-kind-interface">Coin</span>
77
- <span class="tsd-signature-symbol">{ </span><br /><span>    </span
78
- ><a class="tsd-kind-property" href="Coin.html#expo">expo</a
79
- ><span class="tsd-signature-symbol">: </span
80
- ><span class="tsd-signature-type">number</span
81
- ><span class="tsd-signature-symbol">; </span><br /><span>    </span
82
- ><a class="tsd-kind-property" href="Coin.html#icon">icon</a
83
- ><span class="tsd-signature-symbol">: </span
84
- ><a
85
- href="../types/Icon.html"
86
- class="tsd-signature-type tsd-kind-type-alias"
87
- >Icon</a
88
- ><span class="tsd-signature-symbol">; </span><br /><span>    </span
89
- ><a class="tsd-kind-property" href="Coin.html#name">name</a
90
- ><span class="tsd-signature-symbol">: </span
91
- ><a
92
- href="../types/CoinName.html"
93
- class="tsd-signature-type tsd-kind-type-alias"
94
- >CoinName</a
95
- ><span class="tsd-signature-symbol">; </span><br /><span>    </span
96
- ><a class="tsd-kind-property" href="Coin.html#type">type</a
97
- ><span class="tsd-signature-symbol">: </span
98
- ><a
99
- href="../types/CoinType.html"
100
- class="tsd-signature-type tsd-kind-type-alias"
101
- >CoinType</a
102
- ><span class="tsd-signature-symbol">; </span><br /><span
103
- class="tsd-signature-symbol"
104
- >}</span
105
- >
106
- </div>
107
- <aside class="tsd-sources">
108
- <ul>
109
- <li>
110
- Defined in
111
- <a
112
- href="https://github.com/AlphaFiTech/alphafi-sdk/blob/d5c5baf4d5ffcf340653cbe7a9a3424d44d5a976/src/common/types.ts#L128"
113
- >common/types.ts:128</a
114
- >
115
- </li>
116
- </ul>
117
- </aside>
118
- <section class="tsd-panel-group tsd-index-group">
119
- <section class="tsd-panel tsd-index-panel">
120
- <details class="tsd-index-content tsd-accordion" open>
121
- <summary class="tsd-accordion-summary tsd-index-summary">
122
- <h5
123
- class="tsd-index-heading uppercase"
124
- role="button"
125
- aria-expanded="false"
126
- tabindex="0"
127
- >
128
- <svg width="16" height="16" viewBox="0 0 16 16" fill="none">
129
- <use href="../assets/icons.svg#icon-chevronSmall"></use>
130
- </svg>
131
- Index
132
- </h5>
133
- </summary>
134
- <div class="tsd-accordion-details">
135
- <section class="tsd-index-section">
136
- <h3 class="tsd-index-heading">Properties</h3>
137
- <div class="tsd-index-list">
138
- <a href="Coin.html#expo" class="tsd-index-link"
139
- ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
140
- <use href="../assets/icons.svg#icon-1024"></use></svg
141
- ><span>expo</span></a
142
- >
143
- <a href="Coin.html#icon" class="tsd-index-link"
144
- ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
145
- <use href="../assets/icons.svg#icon-1024"></use></svg
146
- ><span>icon</span></a
147
- >
148
- <a href="Coin.html#name" class="tsd-index-link"
149
- ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
150
- <use href="../assets/icons.svg#icon-1024"></use></svg
151
- ><span>name</span></a
152
- >
153
- <a href="Coin.html#type" class="tsd-index-link"
154
- ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
155
- <use href="../assets/icons.svg#icon-1024"></use></svg
156
- ><span>type</span></a
157
- >
158
- </div>
159
- </section>
160
- </div>
161
- </details>
162
- </section>
163
- </section>
164
- <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
165
- <summary class="tsd-accordion-summary" data-key="section-Properties">
166
- <h2>
167
- <svg width="20" height="20" viewBox="0 0 24 24" fill="none">
168
- <use href="../assets/icons.svg#icon-chevronDown"></use>
169
- </svg>
170
- Properties
171
- </h2>
172
- </summary>
173
- <section>
174
- <section class="tsd-panel tsd-member">
175
- <a id="expo" class="tsd-anchor"></a>
176
- <h3 class="tsd-anchor-link">
177
- <span>expo</span
178
- ><a href="#expo" aria-label="Permalink" class="tsd-anchor-icon"
179
- ><svg viewBox="0 0 24 24">
180
- <use href="../assets/icons.svg#icon-anchor"></use></svg
181
- ></a>
182
- </h3>
183
- <div class="tsd-signature">
184
- <span class="tsd-kind-property">expo</span
185
- ><span class="tsd-signature-symbol">:</span>
186
- <span class="tsd-signature-type">number</span>
187
- </div>
188
- <div class="tsd-comment tsd-typography">
189
- <p>
190
- The exponent used to scale the coin's value. Typically used to
191
- convert between the smallest unit and the base unit. For
192
- example, SUI has an exponent of 9 because 1 SUI equals 10^9
193
- MISTs.
194
- </p>
195
- </div>
196
- <div class="tsd-comment tsd-typography"></div>
197
- <aside class="tsd-sources">
198
- <ul>
199
- <li>
200
- Defined in
201
- <a
202
- href="https://github.com/AlphaFiTech/alphafi-sdk/blob/d5c5baf4d5ffcf340653cbe7a9a3424d44d5a976/src/common/types.ts#L149"
203
- >common/types.ts:149</a
204
- >
205
- </li>
206
- </ul>
207
- </aside>
208
- </section>
209
- <section class="tsd-panel tsd-member">
210
- <a id="icon" class="tsd-anchor"></a>
211
- <h3 class="tsd-anchor-link">
212
- <span>icon</span
213
- ><a href="#icon" aria-label="Permalink" class="tsd-anchor-icon"
214
- ><svg viewBox="0 0 24 24">
215
- <use href="../assets/icons.svg#icon-anchor"></use></svg
216
- ></a>
217
- </h3>
218
- <div class="tsd-signature">
219
- <span class="tsd-kind-property">icon</span
220
- ><span class="tsd-signature-symbol">:</span>
221
- <a
222
- href="../types/Icon.html"
223
- class="tsd-signature-type tsd-kind-type-alias"
224
- >Icon</a
225
- >
226
- </div>
227
- <div class="tsd-comment tsd-typography">
228
- <p>The icon or logo associated with the coin.</p>
229
- </div>
230
- <div class="tsd-comment tsd-typography"></div>
231
- <aside class="tsd-sources">
232
- <ul>
233
- <li>
234
- Defined in
235
- <a
236
- href="https://github.com/AlphaFiTech/alphafi-sdk/blob/d5c5baf4d5ffcf340653cbe7a9a3424d44d5a976/src/common/types.ts#L142"
237
- >common/types.ts:142</a
238
- >
239
- </li>
240
- </ul>
241
- </aside>
242
- </section>
243
- <section class="tsd-panel tsd-member">
244
- <a id="name" class="tsd-anchor"></a>
245
- <h3 class="tsd-anchor-link">
246
- <span>name</span
247
- ><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"
248
- ><svg viewBox="0 0 24 24">
249
- <use href="../assets/icons.svg#icon-anchor"></use></svg
250
- ></a>
251
- </h3>
252
- <div class="tsd-signature">
253
- <span class="tsd-kind-property">name</span
254
- ><span class="tsd-signature-symbol">:</span>
255
- <a
256
- href="../types/CoinName.html"
257
- class="tsd-signature-type tsd-kind-type-alias"
258
- >CoinName</a
259
- >
260
- </div>
261
- <div class="tsd-comment tsd-typography">
262
- <p>The name of the coin (e.g., SUI, ALPHA, WUSDC, USDT).</p>
263
- </div>
264
- <div class="tsd-comment tsd-typography"></div>
265
- <aside class="tsd-sources">
266
- <ul>
267
- <li>
268
- Defined in
269
- <a
270
- href="https://github.com/AlphaFiTech/alphafi-sdk/blob/d5c5baf4d5ffcf340653cbe7a9a3424d44d5a976/src/common/types.ts#L132"
271
- >common/types.ts:132</a
272
- >
273
- </li>
274
- </ul>
275
- </aside>
276
- </section>
277
- <section class="tsd-panel tsd-member">
278
- <a id="type" class="tsd-anchor"></a>
279
- <h3 class="tsd-anchor-link">
280
- <span>type</span
281
- ><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"
282
- ><svg viewBox="0 0 24 24">
283
- <use href="../assets/icons.svg#icon-anchor"></use></svg
284
- ></a>
285
- </h3>
286
- <div class="tsd-signature">
287
- <span class="tsd-kind-property">type</span
288
- ><span class="tsd-signature-symbol">:</span>
289
- <a
290
- href="../types/CoinType.html"
291
- class="tsd-signature-type tsd-kind-type-alias"
292
- >CoinType</a
293
- >
294
- </div>
295
- <div class="tsd-comment tsd-typography">
296
- <p>The type of the coin object on the Sui blockchain.</p>
297
- </div>
298
- <div class="tsd-comment tsd-typography"></div>
299
- <aside class="tsd-sources">
300
- <ul>
301
- <li>
302
- Defined in
303
- <a
304
- href="https://github.com/AlphaFiTech/alphafi-sdk/blob/d5c5baf4d5ffcf340653cbe7a9a3424d44d5a976/src/common/types.ts#L137"
305
- >common/types.ts:137</a
306
- >
307
- </li>
308
- </ul>
309
- </aside>
310
- </section>
311
- </section>
312
- </details>
313
- </div>
314
- <div class="col-sidebar">
315
- <div class="page-menu">
316
- <div class="tsd-navigation settings">
317
- <details class="tsd-accordion">
318
- <summary class="tsd-accordion-summary">
319
- <h3>
320
- <svg width="20" height="20" viewBox="0 0 24 24" fill="none">
321
- <use href="../assets/icons.svg#icon-chevronDown"></use></svg
322
- >Settings
323
- </h3>
324
- </summary>
325
- <div class="tsd-accordion-details">
326
- <div class="tsd-filter-visibility">
327
- <span class="settings-label">Member Visibility</span>
328
- <ul id="tsd-filter-options">
329
- <li class="tsd-filter-item">
330
- <label class="tsd-filter-input"
331
- ><input
332
- type="checkbox"
333
- id="tsd-filter-inherited"
334
- name="inherited"
335
- checked
336
- /><svg
337
- width="32"
338
- height="32"
339
- viewBox="0 0 32 32"
340
- aria-hidden="true"
341
- >
342
- <rect
343
- class="tsd-checkbox-background"
344
- width="30"
345
- height="30"
346
- x="1"
347
- y="1"
348
- rx="6"
349
- fill="none"
350
- ></rect>
351
- <path
352
- class="tsd-checkbox-checkmark"
353
- d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
354
- stroke="none"
355
- stroke-width="3.5"
356
- stroke-linejoin="round"
357
- fill="none"
358
- ></path></svg
359
- ><span>Inherited</span></label
360
- >
361
- </li>
362
- <li class="tsd-filter-item">
363
- <label class="tsd-filter-input"
364
- ><input
365
- type="checkbox"
366
- id="tsd-filter-external"
367
- name="external"
368
- /><svg
369
- width="32"
370
- height="32"
371
- viewBox="0 0 32 32"
372
- aria-hidden="true"
373
- >
374
- <rect
375
- class="tsd-checkbox-background"
376
- width="30"
377
- height="30"
378
- x="1"
379
- y="1"
380
- rx="6"
381
- fill="none"
382
- ></rect>
383
- <path
384
- class="tsd-checkbox-checkmark"
385
- d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25"
386
- stroke="none"
387
- stroke-width="3.5"
388
- stroke-linejoin="round"
389
- fill="none"
390
- ></path></svg
391
- ><span>External</span></label
392
- >
393
- </li>
394
- </ul>
395
- </div>
396
- <div class="tsd-theme-toggle">
397
- <label class="settings-label" for="tsd-theme">Theme</label
398
- ><select id="tsd-theme">
399
- <option value="os">OS</option>
400
- <option value="light">Light</option>
401
- <option value="dark">Dark</option>
402
- </select>
403
- </div>
404
- </div>
405
- </details>
406
- </div>
407
- <details open class="tsd-accordion tsd-page-navigation">
408
- <summary class="tsd-accordion-summary">
409
- <h3>
410
- <svg width="20" height="20" viewBox="0 0 24 24" fill="none">
411
- <use href="../assets/icons.svg#icon-chevronDown"></use></svg
412
- >On This Page
413
- </h3>
414
- </summary>
415
- <div class="tsd-accordion-details">
416
- <details open class="tsd-accordion tsd-page-navigation-section">
417
- <summary
418
- class="tsd-accordion-summary"
419
- data-key="tsd-otp-Properties"
420
- >
421
- <svg width="20" height="20" viewBox="0 0 24 24" fill="none">
422
- <use href="../assets/icons.svg#icon-chevronDown"></use></svg
423
- >Properties
424
- </summary>
425
- <div>
426
- <a href="#expo" class=""
427
- ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
428
- <use href="../assets/icons.svg#icon-1024"></use></svg
429
- ><span>expo</span></a
430
- ><a href="#icon" class=""
431
- ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
432
- <use href="../assets/icons.svg#icon-1024"></use></svg
433
- ><span>icon</span></a
434
- ><a href="#name" class=""
435
- ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
436
- <use href="../assets/icons.svg#icon-1024"></use></svg
437
- ><span>name</span></a
438
- ><a href="#type" class=""
439
- ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
440
- <use href="../assets/icons.svg#icon-1024"></use></svg
441
- ><span>type</span></a
442
- >
443
- </div>
444
- </details>
445
- </div>
446
- </details>
447
- </div>
448
- <div class="site-menu">
449
- <nav class="tsd-navigation">
450
- <a href="../modules.html"
451
- ><svg class="tsd-kind-icon" viewBox="0 0 24 24">
452
- <use href="../assets/icons.svg#icon-1"></use></svg
453
- ><span>@alphafi/alphafi-sdk - v0.0.56</span></a
454
- >
455
- <ul
456
- class="tsd-small-nested-navigation"
457
- id="tsd-nav-container"
458
- data-base=".."
459
- >
460
- <li>Loading...</li>
461
- </ul>
462
- </nav>
463
- </div>
464
- </div>
465
- </div>
466
- <footer>
467
- <p class="tsd-generator">
468
- Generated using
469
- <a href="https://typedoc.org/" target="_blank">TypeDoc</a>
470
- </p>
471
- </footer>
472
- <div class="overlay"></div>
473
- </body>
474
- </html>
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Coin | @alphafi/alphafi-sdk - v0.0.59</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.59</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="Coin.html">Coin</a></li></ul><h1>Interface Coin</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a coin with its name, type, icon, and exponent.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Coin</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="Coin.html#expo">expo</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Coin.html#icon">icon</a><span class="tsd-signature-symbol">: </span><a href="../types/Icon.html" class="tsd-signature-type tsd-kind-type-alias">Icon</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Coin.html#name">name</a><span class="tsd-signature-symbol">: </span><a href="../types/CoinName.html" class="tsd-signature-type tsd-kind-type-alias">CoinName</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="Coin.html#type">type</a><span class="tsd-signature-symbol">: </span><a href="../types/CoinType.html" class="tsd-signature-type tsd-kind-type-alias">CoinType</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/76847ddad3232249c6cec1773f96f36e3179aea0/src/common/types.ts#L131">common/types.ts:131</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="Coin.html#expo" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>expo</span></a>
3
+ <a href="Coin.html#icon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>icon</span></a>
4
+ <a href="Coin.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
5
+ <a href="Coin.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
6
+ </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="expo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>expo</span><a href="#expo" 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">expo</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The exponent used to scale the coin's value.
7
+ Typically used to convert between the smallest unit and the base unit.
8
+ For example, SUI has an exponent of 9 because 1 SUI equals 10^9 MISTs.</p>
9
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AlphaFiTech/alphafi-sdk/blob/76847ddad3232249c6cec1773f96f36e3179aea0/src/common/types.ts#L152">common/types.ts:152</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="icon" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>icon</span><a href="#icon" 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">icon</span><span class="tsd-signature-symbol">:</span> <a href="../types/Icon.html" class="tsd-signature-type tsd-kind-type-alias">Icon</a></div><div class="tsd-comment tsd-typography"><p>The icon or logo associated with the coin.</p>
10
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AlphaFiTech/alphafi-sdk/blob/76847ddad3232249c6cec1773f96f36e3179aea0/src/common/types.ts#L145">common/types.ts:145</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <a href="../types/CoinName.html" class="tsd-signature-type tsd-kind-type-alias">CoinName</a></div><div class="tsd-comment tsd-typography"><p>The name of the coin (e.g., SUI, ALPHA, WUSDC, USDT).</p>
11
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AlphaFiTech/alphafi-sdk/blob/76847ddad3232249c6cec1773f96f36e3179aea0/src/common/types.ts#L135">common/types.ts:135</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../types/CoinType.html" class="tsd-signature-type tsd-kind-type-alias">CoinType</a></div><div class="tsd-comment tsd-typography"><p>The type of the coin object on the Sui blockchain.</p>
12
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AlphaFiTech/alphafi-sdk/blob/76847ddad3232249c6cec1773f96f36e3179aea0/src/common/types.ts#L140">common/types.ts:140</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="#expo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>expo</span></a><a href="#icon" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>icon</span></a><a href="#name" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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.59</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>