npm - @alphafi/alphafi-sdk - Versions diffs - 0.0.49 → 0.0.50 - Mend

@alphafi/alphafi-sdk 0.0.49 → 0.0.50

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 (252) hide show

package/dist/cjs/adminFunctions.d.ts +2 -1
package/dist/cjs/adminFunctions.d.ts.map +1 -1
package/dist/cjs/adminFunctions.js +47 -0
package/dist/cjs/adminFunctions.js.map +1 -1
package/dist/cjs/common/maps.d.ts +1 -0
package/dist/cjs/common/maps.d.ts.map +1 -1
package/dist/cjs/common/maps.js.map +1 -1
package/dist/cjs/common/types.d.ts +17 -3
package/dist/cjs/common/types.d.ts.map +1 -1
package/dist/cjs/common/types.js.map +1 -1
package/dist/cjs/index.d.ts +2 -1
package/dist/cjs/index.d.ts.map +1 -1
package/dist/cjs/index.js +3 -2
package/dist/cjs/index.js.map +1 -1
package/dist/cjs/sui-sdk/client.d.ts +8 -0
package/dist/cjs/sui-sdk/client.d.ts.map +1 -1
package/dist/cjs/sui-sdk/client.js +12 -0
package/dist/cjs/sui-sdk/client.js.map +1 -1
package/dist/cjs/sui-sdk/functions/getPositionRange.d.ts +10 -0
package/dist/cjs/sui-sdk/functions/getPositionRange.d.ts.map +1 -0
package/dist/cjs/sui-sdk/functions/getPositionRange.js +86 -0
package/dist/cjs/sui-sdk/functions/getPositionRange.js.map +1 -0
package/dist/cjs/sui-sdk/functions/getReceipts.d.ts +4 -12
package/dist/cjs/sui-sdk/functions/getReceipts.d.ts.map +1 -1
package/dist/cjs/sui-sdk/functions/getReceipts.js +0 -81
package/dist/cjs/sui-sdk/functions/getReceipts.js.map +1 -1
package/dist/cjs/transactions/zapDeposit.d.ts.map +1 -1
package/dist/cjs/transactions/zapDeposit.js +58 -29
package/dist/cjs/transactions/zapDeposit.js.map +1 -1
package/dist/esm/adminFunctions.d.ts +2 -1
package/dist/esm/adminFunctions.d.ts.map +1 -1
package/dist/esm/adminFunctions.js +48 -2
package/dist/esm/adminFunctions.js.map +1 -1
package/dist/esm/common/maps.d.ts +1 -0
package/dist/esm/common/maps.d.ts.map +1 -1
package/dist/esm/common/maps.js.map +1 -1
package/dist/esm/common/types.d.ts +17 -3
package/dist/esm/common/types.d.ts.map +1 -1
package/dist/esm/common/types.js.map +1 -1
package/dist/esm/index.d.ts +2 -1
package/dist/esm/index.d.ts.map +1 -1
package/dist/esm/index.js +2 -1
package/dist/esm/index.js.map +1 -1
package/dist/esm/sui-sdk/client.d.ts +8 -0
package/dist/esm/sui-sdk/client.d.ts.map +1 -1
package/dist/esm/sui-sdk/client.js +10 -0
package/dist/esm/sui-sdk/client.js.map +1 -1
package/dist/esm/sui-sdk/functions/getPositionRange.d.ts +10 -0
package/dist/esm/sui-sdk/functions/getPositionRange.d.ts.map +1 -0
package/dist/esm/sui-sdk/functions/getPositionRange.js +82 -0
package/dist/esm/sui-sdk/functions/getPositionRange.js.map +1 -0
package/dist/esm/sui-sdk/functions/getReceipts.d.ts +4 -12
package/dist/esm/sui-sdk/functions/getReceipts.d.ts.map +1 -1
package/dist/esm/sui-sdk/functions/getReceipts.js +2 -81
package/dist/esm/sui-sdk/functions/getReceipts.js.map +1 -1
package/dist/esm/transactions/zapDeposit.d.ts.map +1 -1
package/dist/esm/transactions/zapDeposit.js +59 -30
package/dist/esm/transactions/zapDeposit.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 -0
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 -306
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/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/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/getCetusSqrtPriceMap.html +1 -249
package/docs/functions/getCoinAmountsFromLiquidity.html +1 -273
package/docs/functions/getConf.html +1 -11763
package/docs/functions/getCurrentTick.html +1 -247
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/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/getPoolExchangeRateMap.html +1 -249
package/docs/functions/getPoolsWeightDistribution.html +1 -0
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 -254
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/getTickToPrice.html +1 -254
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 -0
package/docs/functions/setSuiClient.html +7 -255
package/docs/functions/setSuiNodeUrl.html +5 -249
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 +6 -0
package/docs/interfaces/PoolWeightDistribution.html +4 -0
package/docs/interfaces/RebalanceHistoryType.html +9 -652
package/docs/modules.html +186 -1315
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 -0
package/docs/types/AutoCompoundingEventNode.html +1 -225
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 -290
package/docs/types/CoinType.html +1 -291
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 -289
package/docs/types/DoubleAssetTokenHoldings.html +1 -232
package/docs/types/DoubleAssetVaultBalance.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 -0
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 -326
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 -247
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 -217
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/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 -304
package/docs/variables/singleAssetPoolCoinMap.html +1 -229
package/docs/variables/stableCoins.html +1 -207
package/package.json +2 -3

package/docs/functions/setSuiClient.html CHANGED Viewed

@@ -1,255 +1,7 @@
-<!doctype html>
-<html class="default" lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <meta http-equiv="x-ua-compatible" content="IE=edge" />
-    <title>setSuiClient | @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="setSuiClient.html">setSuiClient</a></li>
-          </ul>
-          <h1>Function setSuiClient</h1>
-        </div>
-        <section class="tsd-panel">
-          <ul class="tsd-signatures">
-            <li class="tsd-signature tsd-anchor-link">
-              <a id="setSuiClient" class="tsd-anchor"></a
-              ><span class="tsd-kind-call-signature"
-                >set<wbr />Sui<wbr />Client</span
-              ><span class="tsd-signature-symbol">(</span
-              ><span class="tsd-kind-parameter">rpcNodeUrl</span
-              ><span class="tsd-signature-symbol">)</span
-              ><span class="tsd-signature-symbol">: </span
-              ><span class="tsd-signature-type">void</span
-              ><a
-                href="#setSuiClient"
-                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-comment tsd-typography">
-                <p>
-                  Set a new SuiClient instance with the specified RPC node URL.
-                  This function directly creates a new instance of the
-                  SuiClient, overriding the existing instance and using the
-                  provided URL for future requests.
-                </p>
-                <p>
-                  If the RPC node URL is different from the currently stored
-                  URL, a new instance of SuiClient will be created and assigned,
-                  allowing the client to communicate with a new Sui node.
-                </p>
-              </div>
-              <div class="tsd-parameters">
-                <h4 class="tsd-parameters-title">Parameters</h4>
-                <ul class="tsd-parameter-list">
-                  <li>
-                    <span
-                      ><span class="tsd-kind-parameter">rpcNodeUrl</span>:
-                      <span class="tsd-signature-type">string</span></span
-                    >
-                    <div class="tsd-comment tsd-typography">
-                      <p>The new RPC URL to be used for the SuiClient.</p>
-                    </div>
-                    <div class="tsd-comment tsd-typography"></div>
-                  </li>
-                </ul>
-              </div>
-              <h4 class="tsd-returns-title">
-                Returns <span class="tsd-signature-type">void</span>
-              </h4>
-              <div class="tsd-comment tsd-typography"></div>
-              <aside class="tsd-sources">
-                <ul>
-                  <li>
-                    Defined in
-                    <a
-                      href="https://github.com/AlphaFiTech/alphafi-sdk/blob/ad45856aec52bc553dbb631704dbf058dd03f3af/src/sui-sdk/client.ts#L62"
-                      >sui-sdk/client.ts:62</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.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>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>setSuiClient | @alphafi/alphafi-sdk - v0.0.50</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.50</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="setSuiClient.html">setSuiClient</a></li></ul><h1>Function setSuiClient</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setSuiClient" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Sui<wbr/>Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">rpcNodeUrl</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setSuiClient" 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-comment tsd-typography"><p>Set a new SuiClient instance with the specified RPC node URL.
+This function directly creates a new instance of the SuiClient, overriding the existing instance
+and using the provided URL for future requests.</p>
+<p>If the RPC node URL is different from the currently stored URL, a new instance of SuiClient will
+be created and assigned, allowing the client to communicate with a new Sui node.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">rpcNodeUrl</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The new RPC URL to be used for the SuiClient.</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AlphaFiTech/alphafi-sdk/blob/0b94f54ad0b7fff20d6bb5358e8a8f3bf9289397/src/sui-sdk/client.ts#L62">sui-sdk/client.ts:62</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.50</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/setSuiNodeUrl.html CHANGED Viewed

@@ -1,249 +1,5 @@
-<!doctype html>
-<html class="default" lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <meta http-equiv="x-ua-compatible" content="IE=edge" />
-    <title>setSuiNodeUrl | @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="setSuiNodeUrl.html">setSuiNodeUrl</a></li>
-          </ul>
-          <h1>Function setSuiNodeUrl</h1>
-        </div>
-        <section class="tsd-panel">
-          <ul class="tsd-signatures">
-            <li class="tsd-signature tsd-anchor-link">
-              <a id="setSuiNodeUrl" class="tsd-anchor"></a
-              ><span class="tsd-kind-call-signature"
-                >set<wbr />Sui<wbr />Node<wbr />Url</span
-              ><span class="tsd-signature-symbol">(</span
-              ><span class="tsd-kind-parameter">rpcNodeUrl</span
-              ><span class="tsd-signature-symbol">)</span
-              ><span class="tsd-signature-symbol">: </span
-              ><span class="tsd-signature-type">void</span
-              ><a
-                href="#setSuiNodeUrl"
-                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-comment tsd-typography">
-                <p>
-                  Set a new Sui node URL. This will invalidate the current
-                  SuiClient instance, ensuring that the next call to
-                  getSuiClient returns a new instance with the updated URL.
-                </p>
-              </div>
-              <div class="tsd-parameters">
-                <h4 class="tsd-parameters-title">Parameters</h4>
-                <ul class="tsd-parameter-list">
-                  <li>
-                    <span
-                      ><span class="tsd-kind-parameter">rpcNodeUrl</span>:
-                      <span class="tsd-signature-type">string</span></span
-                    >
-                    <div class="tsd-comment tsd-typography">
-                      <p>The new RPC URL for the Sui client.</p>
-                    </div>
-                    <div class="tsd-comment tsd-typography"></div>
-                  </li>
-                </ul>
-              </div>
-              <h4 class="tsd-returns-title">
-                Returns <span class="tsd-signature-type">void</span>
-              </h4>
-              <div class="tsd-comment tsd-typography"></div>
-              <aside class="tsd-sources">
-                <ul>
-                  <li>
-                    Defined in
-                    <a
-                      href="https://github.com/AlphaFiTech/alphafi-sdk/blob/ad45856aec52bc553dbb631704dbf058dd03f3af/src/sui-sdk/client.ts#L45"
-                      >sui-sdk/client.ts:45</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.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>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>setSuiNodeUrl | @alphafi/alphafi-sdk - v0.0.50</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.50</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="setSuiNodeUrl.html">setSuiNodeUrl</a></li></ul><h1>Function setSuiNodeUrl</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setSuiNodeUrl" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Sui<wbr/>Node<wbr/>Url</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">rpcNodeUrl</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setSuiNodeUrl" 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-comment tsd-typography"><p>Set a new Sui node URL.
+This will invalidate the current SuiClient instance, ensuring that
+the next call to getSuiClient returns a new instance with the updated URL.</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">rpcNodeUrl</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The new RPC URL for the Sui client.</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AlphaFiTech/alphafi-sdk/blob/0b94f54ad0b7fff20d6bb5358e8a8f3bf9289397/src/sui-sdk/client.ts#L45">sui-sdk/client.ts:45</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.50</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>