npm - @alphafi/alphafi-sdk - Versions diffs - 0.0.57 → 0.0.59 - Mend

@alphafi/alphafi-sdk 0.0.57 → 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 (228) hide show

package/dist/cjs/common/constants.d.ts +31 -0
package/dist/cjs/common/constants.d.ts.map +1 -1
package/dist/cjs/common/constants.js +38 -5
package/dist/cjs/common/constants.js.map +1 -1
package/dist/cjs/getAprs.d.ts +2 -0
package/dist/cjs/getAprs.d.ts.map +1 -1
package/dist/cjs/getAprs.js +251 -1
package/dist/cjs/getAprs.js.map +1 -1
package/dist/cjs/transactions/bluefin.d.ts.map +1 -1
package/dist/cjs/transactions/bluefin.js +84 -28
package/dist/cjs/transactions/bluefin.js.map +1 -1
package/dist/esm/common/constants.d.ts +31 -0
package/dist/esm/common/constants.d.ts.map +1 -1
package/dist/esm/common/constants.js +38 -5
package/dist/esm/common/constants.js.map +1 -1
package/dist/esm/getAprs.d.ts +2 -0
package/dist/esm/getAprs.d.ts.map +1 -1
package/dist/esm/getAprs.js +249 -2
package/dist/esm/getAprs.js.map +1 -1
package/dist/esm/transactions/bluefin.d.ts.map +1 -1
package/dist/esm/transactions/bluefin.js +84 -28
package/dist/esm/transactions/bluefin.js.map +1 -1
package/docs/assets/highlight.css +51 -74
package/docs/assets/icons.js +17 -20
package/docs/assets/main.js +5 -2163
package/docs/assets/navigation.js +1 -2
package/docs/assets/search.js +1 -2
package/docs/assets/style.css +850 -846
package/docs/functions/alphaLpBreakdown.html +1 -253
package/docs/functions/cetusLpBreakdown.html +1 -253
package/docs/functions/claimBlueRewardTxb.html +1 -258
package/docs/functions/claimRewardTxb.html +1 -243
package/docs/functions/coinAmountToXTokensDoubleAsset.html +1 -267
package/docs/functions/coinAmountToXTokensSingleAsset.html +1 -260
package/docs/functions/coinsInPool.html +1 -438
package/docs/functions/collectRewards.html +1 -242
package/docs/functions/deposit.html +1 -246
package/docs/functions/depositDoubleAssetTxb.html +1 -270
package/docs/functions/depositSingleAssetTxb.html +1 -263
package/docs/functions/fetchAfterTransactionEvents.html +1 -328
package/docs/functions/fetchAutoCompoundingEvents.html +1 -257
package/docs/functions/fetchAutoCompoundingEventsGql.html +1 -251
package/docs/functions/fetchCetusPools.html +1 -231
package/docs/functions/fetchChainIdentifier.html +1 -233
package/docs/functions/fetchCheckRatioEvents.html +1 -249
package/docs/functions/fetchLiquidityChangeEvents.html +1 -257
package/docs/functions/fetchMultiCategoryEvents.html +1 -348
package/docs/functions/fetchMultiReceipts.html +1 -261
package/docs/functions/fetchNftHolders.html +1 -233
package/docs/functions/fetchPools.html +1 -230
package/docs/functions/fetchPortfolioData.html +1 -243
package/docs/functions/fetchProtocolData.html +1 -231
package/docs/functions/fetchTVL.html +1 -253
package/docs/functions/fetchUserVaultBalances.html +1 -245
package/docs/functions/fetchUserVaults.html +1 -243
package/docs/functions/fetchUserWalletData.html +1 -243
package/docs/functions/fetchVoloExchangeRate.html +1 -251
package/docs/functions/fetchWithdrawV2Events.html +1 -255
package/docs/functions/getAirdropShare.html +1 -243
package/docs/functions/getAllDoubleAssetVaults.html +1 -235
package/docs/functions/getAllSingleAssetVaults.html +1 -235
package/docs/functions/getAllVaultBalances.html +1 -265
package/docs/functions/getAllVaults.html +1 -233
package/docs/functions/getAlphaUnlocks.html +1 -245
package/docs/functions/getAlphaVaultBalance.html +1 -255
package/docs/functions/getAmounts.html +1 -272
package/docs/functions/getApr.html +1 -243
package/docs/functions/getAprs.html +1 -255
package/docs/functions/getApy.html +1 -243
package/docs/functions/getApys.html +1 -255
package/docs/functions/getCetusInvestorTicksMap.html +1 -284
package/docs/functions/getCetusPool.html +1 -270
package/docs/functions/getCetusSqrtPriceMap.html +1 -249
package/docs/functions/getCoinAmountsFromLiquidity.html +1 -273
package/docs/functions/getConf.html +1 -13163
package/docs/functions/getCurrentTick.html +1 -247
package/docs/functions/getDistributor.html +1 -252
package/docs/functions/getDoubleAssetVaultBalance.html +1 -268
package/docs/functions/getDoubleAssetVaults.html +1 -253
package/docs/functions/getHoldersFromTransactions.html +1 -299
package/docs/functions/getInvestor.html +1 -259
package/docs/functions/getInvestorPoolMap.html +1 -241
package/docs/functions/getLastAutoCompoundTime.html +1 -249
package/docs/functions/getLatestPrices.html +1 -253
package/docs/functions/getLiquidity.html +1 -260
package/docs/functions/getMultiCetusPool.html +1 -231
package/docs/functions/getMultiInvestor.html +1 -231
package/docs/functions/getMultiLatestPrices.html +1 -233
package/docs/functions/getMultiParentPool.html +1 -231
package/docs/functions/getMultiPool.html +1 -231
package/docs/functions/getMultiReceipts.html +1 -243
package/docs/functions/getParentPool.html +1 -266
package/docs/functions/getPool.html +1 -262
package/docs/functions/getPoolExchangeRate.html +1 -254
package/docs/functions/getPoolExchangeRateMap.html +1 -249
package/docs/functions/getPoolsWeightDistribution.html +1 -266
package/docs/functions/getPositionRange.html +1 -283
package/docs/functions/getPositionRanges.html +1 -289
package/docs/functions/getPositionTicks.html +1 -249
package/docs/functions/getPriceToTick.html +1 -264
package/docs/functions/getRebalanceHistories.html +1 -269
package/docs/functions/getRebalanceHistory.html +1 -255
package/docs/functions/getReceipts.html +1 -268
package/docs/functions/getSingleAssetVaultBalance.html +1 -268
package/docs/functions/getSingleAssetVaults.html +1 -253
package/docs/functions/getSuiClient.html +3 -247
package/docs/functions/getSuiNodeUrl.html +3 -232
package/docs/functions/getTVLs-1.html +1 -243
package/docs/functions/getTickSpacing.html +1 -247
package/docs/functions/getTickToPrice.html +1 -248
package/docs/functions/getTvls.html +1 -259
package/docs/functions/getUserTokensFromTransactions.html +1 -269
package/docs/functions/getUserTokensInUsdFromTransactions.html +1 -263
package/docs/functions/getVaultBalance.html +1 -277
package/docs/functions/getVaultBalanceForActiveUsers.html +1 -261
package/docs/functions/getVaults.html +1 -250
package/docs/functions/getXTokenVaultBalanceForActiveUsers.html +1 -261
package/docs/functions/getZapAmounts.html +1 -323
package/docs/functions/lastAutocompoundTime.html +1 -249
package/docs/functions/liquidityToTokens.html +1 -253
package/docs/functions/multiLiquidityToTokens.html +1 -271
package/docs/functions/multiTokensToUsd.html +1 -262
package/docs/functions/multiXTokensToLiquidity.html +1 -257
package/docs/functions/parseUserWalletData.html +1 -243
package/docs/functions/pendingBlueRewardAmount.html +1 -256
package/docs/functions/setCustomSuiClient.html +5 -251
package/docs/functions/setSuiClient.html +7 -255
package/docs/functions/setSuiNodeUrl.html +5 -249
package/docs/functions/setWeights.html +1 -270
package/docs/functions/withdraw.html +1 -249
package/docs/functions/withdrawAlphaTxb.html +1 -257
package/docs/functions/withdrawTxb.html +1 -260
package/docs/functions/zapDepositTxb.html +1 -300
package/docs/index.html +41 -587
package/docs/interfaces/Coin.html +12 -474
package/docs/interfaces/CoinPair.html +3 -358
package/docs/interfaces/NaviVoloData.html +3 -514
package/docs/interfaces/PoolData.html +8 -579
package/docs/interfaces/PoolWeightDistribution.html +4 -414
package/docs/interfaces/RebalanceHistoryType.html +9 -652
package/docs/modules.html +198 -1430
package/docs/types/AfterTransactionEventNode.html +1 -305
package/docs/types/Allocator.html +1 -321
package/docs/types/AlphaFiDoubleAssetVault.html +1 -258
package/docs/types/AlphaFiMultiVaultBalance.html +1 -219
package/docs/types/AlphaFiSingleAssetVault.html +1 -244
package/docs/types/AlphaFiVault.html +1 -214
package/docs/types/AlphaFiVaultBalance.html +1 -220
package/docs/types/AlphaPoolType.html +1 -383
package/docs/types/AlphaReceipt.html +1 -220
package/docs/types/AlphaReceiptFields.html +1 -421
package/docs/types/AlphaVaultBalance.html +1 -245
package/docs/types/AutoBalancePoolNames.html +1 -226
package/docs/types/AutoCompoundingEventNode.html +1 -230
package/docs/types/BluefinInvestor.html +1 -209
package/docs/types/BluefinPoolType.html +1 -440
package/docs/types/BucketInvestor.html +1 -249
package/docs/types/CetusInvestor.html +1 -240
package/docs/types/CetusPoolType.html +1 -433
package/docs/types/CetusSwapOptions.html +1 -209
package/docs/types/CoinAmounts.html +1 -216
package/docs/types/CoinName.html +1 -293
package/docs/types/CoinType.html +1 -294
package/docs/types/CommonInvestorFields.html +1 -276
package/docs/types/CreatePoolOptions.html +1 -246
package/docs/types/Distributor.html +1 -341
package/docs/types/DoubleAssetMultiVaultBalance.html +1 -236
package/docs/types/DoubleAssetPoolNames.html +1 -297
package/docs/types/DoubleAssetTokenHoldings.html +1 -232
package/docs/types/DoubleAssetVaultBalance.html +1 -229
package/docs/types/EventCategory.html +1 -209
package/docs/types/EventNode.html +1 -229
package/docs/types/GetHoldersParams.html +1 -221
package/docs/types/GetTokenHoldingsParams.html +1 -227
package/docs/types/GetUserTokensFromTransactionsParams.html +1 -233
package/docs/types/GetUserTokensInUsdFromTransactionsParams.html +1 -244
package/docs/types/GetVaultBalanceForActiveUsersParams.html +1 -231
package/docs/types/GetVaultBalanceParams.html +1 -217
package/docs/types/HoldingsObj.html +1 -223
package/docs/types/Icon.html +1 -266
package/docs/types/Investor.html +1 -245
package/docs/types/LiquidityChangeEventNode.html +1 -220
package/docs/types/LiquidityToTokensParams.html +1 -255
package/docs/types/LiquidityToUsdParams.html +1 -267
package/docs/types/LoopingDebt.html +1 -258
package/docs/types/LoopingPoolNames.html +1 -216
package/docs/types/LpBreakdownType.html +1 -238
package/docs/types/MemberPoolDataType.html +1 -276
package/docs/types/MemberType.html +1 -269
package/docs/types/MultiGetVaultBalancesParams.html +1 -229
package/docs/types/NaviInvestor.html +1 -235
package/docs/types/OtherReceiptFields.html +1 -373
package/docs/types/PoolName.html +1 -214
package/docs/types/PoolReceipt.html +1 -253
package/docs/types/PoolType.html +1 -388
package/docs/types/Receipt.html +1 -475
package/docs/types/ReceiptGQL.html +1 -374
package/docs/types/SingleAssetMultiVaultBalance.html +1 -232
package/docs/types/SingleAssetPoolNames.html +1 -244
package/docs/types/SingleAssetTokenHoldings.html +1 -228
package/docs/types/SingleAssetVaultBalance.html +1 -223
package/docs/types/SingleGetVaultBalancesParams.html +1 -224
package/docs/types/StrategyType.html +1 -221
package/docs/types/SuiNetwork.html +1 -213
package/docs/types/SwapOptions.html +1 -248
package/docs/types/TickSpacing.html +1 -212
package/docs/types/TotalWeightType.html +1 -246
package/docs/types/TransactionBlockType.html +1 -358
package/docs/types/UserPoolLiquidity.html +1 -221
package/docs/types/UserPoolTokenHoldings.html +1 -217
package/docs/types/UserUsdHoldings.html +1 -223
package/docs/types/VaultBalance.html +1 -216
package/docs/types/WithdrawV2EventNode.html +1 -208
package/docs/variables/bluefinPoolMap.html +1 -214
package/docs/variables/cetusPoolMap.html +1 -214
package/docs/variables/coinsList.html +1 -220
package/docs/variables/defunctPoolsSet.html +1 -209
package/docs/variables/doubleAssetPoolCoinMap.html +1 -237
package/docs/variables/eventCategories.html +1 -210
package/docs/variables/ignoredWalletsForDailyRevenue.html +1 -218
package/docs/variables/loopingAccountAddresses.html +1 -219
package/docs/variables/loopingPoolCoinMap.html +1 -233
package/docs/variables/naviAssetMap.html +1 -215
package/docs/variables/poolIdPoolNameMap.html +1 -218
package/docs/variables/poolInfo.html +1 -319
package/docs/variables/singleAssetPoolCoinMap.html +1 -229
package/docs/variables/stableCoins.html +1 -207
package/package.json +1 -1

package/docs/functions/withdrawTxb.html CHANGED Viewed

@@ -1,260 +1 @@
-<!doctype html>
-<html class="default" lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <meta http-equiv="x-ua-compatible" content="IE=edge" />
-    <title>withdrawTxb | @alphafi/alphafi-sdk - v0.0.56</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.56</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="withdrawTxb.html">withdrawTxb</a></li>
-          </ul>
-          <h1>Function withdrawTxb</h1>
-        </div>
-        <section class="tsd-panel">
-          <ul class="tsd-signatures">
-            <li class="tsd-signature tsd-anchor-link">
-              <a id="withdrawTxb" class="tsd-anchor"></a
-              ><span class="tsd-kind-call-signature">withdraw<wbr />Txb</span
-              ><span class="tsd-signature-symbol">(</span
-              ><span class="tsd-kind-parameter">xTokensAmount</span>,
-              <span class="tsd-kind-parameter">poolName</span>,
-              <span class="tsd-kind-parameter">address</span
-              ><span class="tsd-signature-symbol">)</span
-              ><span class="tsd-signature-symbol">: </span
-              ><span class="tsd-signature-type">Promise</span
-              ><span class="tsd-signature-symbol">&lt;</span
-              ><span class="tsd-signature-type">Transaction</span
-              ><span class="tsd-signature-symbol">&gt;</span
-              ><a
-                href="#withdrawTxb"
-                aria-label="Permalink"
-                class="tsd-anchor-icon"
-                ><svg viewBox="0 0 24 24">
-                  <use href="../assets/icons.svg#icon-anchor"></use></svg
-              ></a>
-            </li>
-            <li class="tsd-description">
-              <div class="tsd-parameters">
-                <h4 class="tsd-parameters-title">Parameters</h4>
-                <ul class="tsd-parameter-list">
-                  <li>
-                    <span
-                      ><span class="tsd-kind-parameter">xTokensAmount</span>:
-                      <span class="tsd-signature-type">string</span></span
-                    >
-                  </li>
-                  <li>
-                    <span
-                      ><span class="tsd-kind-parameter">poolName</span>:
-                      <a
-                        href="../types/PoolName.html"
-                        class="tsd-signature-type tsd-kind-type-alias"
-                        >PoolName</a
-                      ></span
-                    >
-                  </li>
-                  <li>
-                    <span
-                      ><span class="tsd-kind-parameter">address</span>:
-                      <span class="tsd-signature-type">string</span></span
-                    >
-                  </li>
-                </ul>
-              </div>
-              <h4 class="tsd-returns-title">
-                Returns <span class="tsd-signature-type">Promise</span
-                ><span class="tsd-signature-symbol">&lt;</span
-                ><span class="tsd-signature-type">Transaction</span
-                ><span class="tsd-signature-symbol">&gt;</span>
-              </h4>
-              <aside class="tsd-sources">
-                <ul>
-                  <li>
-                    Defined in
-                    <a
-                      href="https://github.com/AlphaFiTech/alphafi-sdk/blob/d5c5baf4d5ffcf340653cbe7a9a3424d44d5a976/src/transactions/withdraw.ts#L22"
-                      >transactions/withdraw.ts:22</a
-                    >
-                  </li>
-                </ul>
-              </aside>
-            </li>
-          </ul>
-        </section>
-      </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>
-        </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.56</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>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>withdrawTxb | @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="withdrawTxb.html">withdrawTxb</a></li></ul><h1>Function withdrawTxb</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withdrawTxb" class="tsd-anchor"></a><span class="tsd-kind-call-signature">withdraw<wbr/>Txb</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">xTokensAmount</span>, <span class="tsd-kind-parameter">poolName</span>, <span class="tsd-kind-parameter">address</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol">&gt;</span><a href="#withdrawTxb" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">xTokensAmount</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">poolName</span>: <a href="../types/PoolName.html" class="tsd-signature-type tsd-kind-type-alias">PoolName</a></span></li><li><span><span class="tsd-kind-parameter">address</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AlphaFiTech/alphafi-sdk/blob/76847ddad3232249c6cec1773f96f36e3179aea0/src/transactions/withdraw.ts#L22">transactions/withdraw.ts:22</a></li></ul></aside></li></ul></section></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></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>

package/docs/functions/zapDepositTxb.html CHANGED Viewed

@@ -1,300 +1 @@
-<!doctype html>
-<html class="default" lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <meta http-equiv="x-ua-compatible" content="IE=edge" />
-    <title>zapDepositTxb | @alphafi/alphafi-sdk - v0.0.56</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.56</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="zapDepositTxb.html">zapDepositTxb</a></li>
-          </ul>
-          <h1>Function zapDepositTxb</h1>
-        </div>
-        <section class="tsd-panel">
-          <ul class="tsd-signatures">
-            <li class="tsd-signature tsd-anchor-link">
-              <a id="zapDepositTxb" class="tsd-anchor"></a
-              ><span class="tsd-kind-call-signature"
-                >zap<wbr />Deposit<wbr />Txb</span
-              ><span class="tsd-signature-symbol">(</span
-              ><span class="tsd-kind-parameter">inputCoinName</span>,
-              <span class="tsd-kind-parameter">inputCoinAmount</span>,
-              <span class="tsd-kind-parameter">poolName</span>,
-              <span class="tsd-kind-parameter">slippage</span>,
-              <span class="tsd-kind-parameter">options</span
-              ><span class="tsd-signature-symbol">)</span
-              ><span class="tsd-signature-symbol">: </span
-              ><span class="tsd-signature-type">Promise</span
-              ><span class="tsd-signature-symbol">&lt;</span
-              ><span class="tsd-signature-type">Transaction</span
-              ><span class="tsd-signature-symbol"> | </span
-              ><span class="tsd-signature-type">undefined</span
-              ><span class="tsd-signature-symbol">&gt;</span
-              ><a
-                href="#zapDepositTxb"
-                aria-label="Permalink"
-                class="tsd-anchor-icon"
-                ><svg viewBox="0 0 24 24">
-                  <use href="../assets/icons.svg#icon-anchor"></use></svg
-              ></a>
-            </li>
-            <li class="tsd-description">
-              <div class="tsd-parameters">
-                <h4 class="tsd-parameters-title">Parameters</h4>
-                <ul class="tsd-parameter-list">
-                  <li>
-                    <span
-                      ><span class="tsd-kind-parameter">inputCoinName</span>:
-                      <a
-                        href="../types/CoinName.html"
-                        class="tsd-signature-type tsd-kind-type-alias"
-                        >CoinName</a
-                      ></span
-                    >
-                  </li>
-                  <li>
-                    <span
-                      ><span class="tsd-kind-parameter">inputCoinAmount</span>:
-                      <span class="tsd-signature-type">number</span></span
-                    >
-                  </li>
-                  <li>
-                    <span
-                      ><span class="tsd-kind-parameter">poolName</span>:
-                      <a
-                        href="../types/PoolName.html"
-                        class="tsd-signature-type tsd-kind-type-alias"
-                        >PoolName</a
-                      ></span
-                    >
-                  </li>
-                  <li>
-                    <span
-                      ><span class="tsd-kind-parameter">slippage</span>:
-                      <span class="tsd-signature-type">number</span></span
-                    >
-                  </li>
-                  <li>
-                    <span
-                      ><span class="tsd-kind-parameter">options</span>:
-                      <span class="tsd-signature-symbol">{ </span><br /><span
-                        >    </span
-                      ><span class="tsd-kind-property">address</span
-                      ><span class="tsd-signature-symbol">: </span
-                      ><span class="tsd-signature-type">string</span
-                      ><span class="tsd-signature-symbol">; </span><br /><span
-                        class="tsd-signature-symbol"
-                        >}</span
-                      ></span
-                    >
-                    <ul class="tsd-parameters">
-                      <li class="tsd-parameter">
-                        <h5>
-                          <span class="tsd-kind-property">address</span
-                          ><span class="tsd-signature-symbol">: </span
-                          ><span class="tsd-signature-type">string</span>
-                        </h5>
-                      </li>
-                    </ul>
-                  </li>
-                </ul>
-              </div>
-              <h4 class="tsd-returns-title">
-                Returns <span class="tsd-signature-type">Promise</span
-                ><span class="tsd-signature-symbol">&lt;</span
-                ><span class="tsd-signature-type">Transaction</span
-                ><span class="tsd-signature-symbol"> | </span
-                ><span class="tsd-signature-type">undefined</span
-                ><span class="tsd-signature-symbol">&gt;</span>
-              </h4>
-              <aside class="tsd-sources">
-                <ul>
-                  <li>
-                    Defined in
-                    <a
-                      href="https://github.com/AlphaFiTech/alphafi-sdk/blob/d5c5baf4d5ffcf340653cbe7a9a3424d44d5a976/src/transactions/zapDeposit.ts#L25"
-                      >transactions/zapDeposit.ts:25</a
-                    >
-                  </li>
-                </ul>
-              </aside>
-            </li>
-          </ul>
-        </section>
-      </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>
-        </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.56</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>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>zapDepositTxb | @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="zapDepositTxb.html">zapDepositTxb</a></li></ul><h1>Function zapDepositTxb</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="zapDepositTxb" class="tsd-anchor"></a><span class="tsd-kind-call-signature">zap<wbr/>Deposit<wbr/>Txb</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">inputCoinName</span>, <span class="tsd-kind-parameter">inputCoinAmount</span>, <span class="tsd-kind-parameter">poolName</span>, <span class="tsd-kind-parameter">slippage</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#zapDepositTxb" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">inputCoinName</span>: <a href="../types/CoinName.html" class="tsd-signature-type tsd-kind-type-alias">CoinName</a></span></li><li><span><span class="tsd-kind-parameter">inputCoinAmount</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">poolName</span>: <a href="../types/PoolName.html" class="tsd-signature-type tsd-kind-type-alias">PoolName</a></span></li><li><span><span class="tsd-kind-parameter">slippage</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">address</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">address</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AlphaFiTech/alphafi-sdk/blob/76847ddad3232249c6cec1773f96f36e3179aea0/src/transactions/zapDeposit.ts#L25">transactions/zapDeposit.ts:25</a></li></ul></aside></li></ul></section></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></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>