68 lines
176 KiB
HTML
68 lines
176 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MangoAccount | @blockworks-foundation/mango-v4</title><meta name="description" content="Documentation for @blockworks-foundation/mango-v4"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@blockworks-foundation/mango-v4</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">@blockworks-foundation/mango-v4</a></li><li><a href="MangoAccount.html">MangoAccount</a></li></ul><h1>Class MangoAccount</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">MangoAccount</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="MangoAccount.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#accountNum" class="tsd-kind-icon">account<wbr/>Num</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#beingLiquidated" class="tsd-kind-icon">being<wbr/>Liquidated</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#buybackFeesAccruedCurrent" class="tsd-kind-icon">buyback<wbr/>Fees<wbr/>Accrued<wbr/>Current</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#buybackFeesAccruedPrevious" class="tsd-kind-icon">buyback<wbr/>Fees<wbr/>Accrued<wbr/>Previous</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#buybackFeesExpiryTimestamp" class="tsd-kind-icon">buyback<wbr/>Fees<wbr/>Expiry<wbr/>Timestamp</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#delegate" class="tsd-kind-icon">delegate</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#frozenUntil" class="tsd-kind-icon">frozen<wbr/>Until</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#group" class="tsd-kind-icon">group</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#headerVersion" class="tsd-kind-icon">header<wbr/>Version</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#healthRegionBeginInitHealth" class="tsd-kind-icon">health<wbr/>Region<wbr/>Begin<wbr/>Init<wbr/>Health</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#inHealthRegion" class="tsd-kind-icon">in<wbr/>Health<wbr/>Region</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#netDeposits" class="tsd-kind-icon">net<wbr/>Deposits</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#owner" class="tsd-kind-icon">owner</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#perpOpenOrders" class="tsd-kind-icon">perp<wbr/>Open<wbr/>Orders</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#perpSpotTransfers" class="tsd-kind-icon">perp<wbr/>Spot<wbr/>Transfers</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#perps" class="tsd-kind-icon">perps</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#publicKey" class="tsd-kind-icon">public<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#serum3" class="tsd-kind-icon">serum3</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#serum3OosMapByMarketIndex" class="tsd-kind-icon">serum3<wbr/>Oos<wbr/>Map<wbr/>By<wbr/>Market<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#tokens" class="tsd-kind-icon">tokens</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getAssetsValue" class="tsd-kind-icon">get<wbr/>Assets<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getBuybackFeesAccrued" class="tsd-kind-icon">get<wbr/>Buyback<wbr/>Fees<wbr/>Accrued</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getBuybackFeesAccruedUi" class="tsd-kind-icon">get<wbr/>Buyback<wbr/>Fees<wbr/>Accrued<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getCollateralValue" class="tsd-kind-icon">get<wbr/>Collateral<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getCumulativeInterest" class="tsd-kind-icon">get<wbr/>Cumulative<wbr/>Interest</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getEffectiveTokenBalance" class="tsd-kind-icon">get<wbr/>Effective<wbr/>Token<wbr/>Balance</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getEquity" class="tsd-kind-icon">get<wbr/>Equity</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getHealth" class="tsd-kind-icon">get<wbr/>Health</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getHealthRatio" class="tsd-kind-icon">get<wbr/>Health<wbr/>Ratio</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getHealthRatioUi" class="tsd-kind-icon">get<wbr/>Health<wbr/>Ratio<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getLiabsValue" class="tsd-kind-icon">get<wbr/>Liabs<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxBaseForPerpAskUi" class="tsd-kind-icon">get<wbr/>Max<wbr/>Base<wbr/>For<wbr/>Perp<wbr/>Ask<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxBaseForSerum3AskUi" class="tsd-kind-icon">get<wbr/>Max<wbr/>Base<wbr/>For<wbr/>Serum3<wbr/>Ask<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxFeesBuyback" class="tsd-kind-icon">get<wbr/>Max<wbr/>Fees<wbr/>Buyback</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxFeesBuybackUi" class="tsd-kind-icon">get<wbr/>Max<wbr/>Fees<wbr/>Buyback<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxQuoteForPerpBidUi" class="tsd-kind-icon">get<wbr/>Max<wbr/>Quote<wbr/>For<wbr/>Perp<wbr/>Bid<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxQuoteForSerum3BidUi" class="tsd-kind-icon">get<wbr/>Max<wbr/>Quote<wbr/>For<wbr/>Serum3<wbr/>Bid<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxSourceUiForTokenSwap" class="tsd-kind-icon">get<wbr/>Max<wbr/>Source<wbr/>Ui<wbr/>For<wbr/>Token<wbr/>Swap</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxWithdrawWithBorrowForToken" class="tsd-kind-icon">get<wbr/>Max<wbr/>Withdraw<wbr/>With<wbr/>Borrow<wbr/>For<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxWithdrawWithBorrowForTokenUi" class="tsd-kind-icon">get<wbr/>Max<wbr/>Withdraw<wbr/>With<wbr/>Borrow<wbr/>For<wbr/>Token<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getPerpPosition" class="tsd-kind-icon">get<wbr/>Perp<wbr/>Position</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getPerpPositionUi" class="tsd-kind-icon">get<wbr/>Perp<wbr/>Position<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getPerpSettleHealth" class="tsd-kind-icon">get<wbr/>Perp<wbr/>Settle<wbr/>Health</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getPnl" class="tsd-kind-icon">get<wbr/>Pnl</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getSerum3Account" class="tsd-kind-icon">get<wbr/>Serum3<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getSerum3OoAccount" class="tsd-kind-icon">get<wbr/>Serum3<wbr/>Oo<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getToken" class="tsd-kind-icon">get<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getTokenBalance" class="tsd-kind-icon">get<wbr/>Token<wbr/>Balance</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getTokenBalanceUi" class="tsd-kind-icon">get<wbr/>Token<wbr/>Balance<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getTokenBorrows" class="tsd-kind-icon">get<wbr/>Token<wbr/>Borrows</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getTokenBorrowsUi" class="tsd-kind-icon">get<wbr/>Token<wbr/>Borrows<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getTokenDeposits" class="tsd-kind-icon">get<wbr/>Token<wbr/>Deposits</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getTokenDepositsUi" class="tsd-kind-icon">get<wbr/>Token<wbr/>Deposits<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#isDelegate" class="tsd-kind-icon">is<wbr/>Delegate</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#isOperational" class="tsd-kind-icon">is<wbr/>Operational</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#loadPerpOpenOrdersForMarket" class="tsd-kind-icon">load<wbr/>Perp<wbr/>Open<wbr/>Orders<wbr/>For<wbr/>Market</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#loadSerum3OpenOrdersAccounts" class="tsd-kind-icon">load<wbr/>Serum3<wbr/>Open<wbr/>Orders<wbr/>Accounts</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#loadSerum3OpenOrdersForMarket" class="tsd-kind-icon">load<wbr/>Serum3<wbr/>Open<wbr/>Orders<wbr/>For<wbr/>Market</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#perpActive" class="tsd-kind-icon">perp<wbr/>Active</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#perpOrderExistsForMarket" class="tsd-kind-icon">perp<wbr/>Order<wbr/>Exists<wbr/>For<wbr/>Market</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#perpOrdersActive" class="tsd-kind-icon">perp<wbr/>Orders<wbr/>Active</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#perpPositionExistsForMarket" class="tsd-kind-icon">perp<wbr/>Position<wbr/>Exists<wbr/>For<wbr/>Market</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#reload" class="tsd-kind-icon">reload</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#reloadSerum3OpenOrders" class="tsd-kind-icon">reload<wbr/>Serum3<wbr/>Open<wbr/>Orders</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#reloadWithSlot" class="tsd-kind-icon">reload<wbr/>With<wbr/>Slot</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#serum3Active" class="tsd-kind-icon">serum3<wbr/>Active</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#serum3CancelAllOrdersForAllMarkets" class="tsd-kind-icon">serum3<wbr/>Cancel<wbr/>All<wbr/>Orders<wbr/>For<wbr/>All<wbr/>Markets</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#serum3SettleFundsForAllMarkets" class="tsd-kind-icon">serum3<wbr/>Settle<wbr/>Funds<wbr/>For<wbr/>All<wbr/>Markets</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#simHealthRatioWithPerpAskUiChanges" class="tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Perp<wbr/>Ask<wbr/>Ui<wbr/>Changes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#simHealthRatioWithPerpBidUiChanges" class="tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Perp<wbr/>Bid<wbr/>Ui<wbr/>Changes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#simHealthRatioWithSerum3AskUiChanges" class="tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Serum3<wbr/>Ask<wbr/>Ui<wbr/>Changes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#simHealthRatioWithSerum3BidUiChanges" class="tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Serum3<wbr/>Bid<wbr/>Ui<wbr/>Changes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#simHealthRatioWithTokenPositionUiChanges" class="tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Token<wbr/>Position<wbr/>Ui<wbr/>Changes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#tokensActive" class="tsd-kind-icon">tokens<wbr/>Active</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="MangoAccount.html#from" class="tsd-kind-icon">from</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Mango<wbr/>Account<span class="tsd-signature-symbol">(</span>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span>, group<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span>, owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span>, delegate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span>, accountNum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, beingLiquidated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, inHealthRegion<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, netDeposits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, perpSpotTransfers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, healthRegionBeginInitHealth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, frozenUntil<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, buybackFeesAccruedCurrent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, buybackFeesAccruedPrevious<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, buybackFeesExpiryTimestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, headerVersion<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, tokens<span class="tsd-signature-symbol">: </span><a href="TokenPositionDto.html" class="tsd-signature-type" data-tsd-kind="Class">TokenPositionDto</a><span class="tsd-signature-symbol">[]</span>, serum3<span class="tsd-signature-symbol">: </span><a href="Serum3PositionDto.html" class="tsd-signature-type" data-tsd-kind="Class">Serum3PositionDto</a><span class="tsd-signature-symbol">[]</span>, perps<span class="tsd-signature-symbol">: </span><a href="PerpPositionDto.html" class="tsd-signature-type" data-tsd-kind="Class">PerpPositionDto</a><span class="tsd-signature-symbol">[]</span>, perpOpenOrders<span class="tsd-signature-symbol">: </span><a href="PerpOoDto.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOoDto</a><span class="tsd-signature-symbol">[]</span>, serum3OosMapByMarketIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">OpenOrders</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MangoAccount.html" class="tsd-signature-type" data-tsd-kind="Class">MangoAccount</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L70">accounts/mangoAccount.ts:70</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>publicKey: <span class="tsd-signature-type">PublicKey</span></h5></li><li><h5>group: <span class="tsd-signature-type">PublicKey</span></h5></li><li><h5>owner: <span class="tsd-signature-type">PublicKey</span></h5></li><li><h5>name: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>delegate: <span class="tsd-signature-type">PublicKey</span></h5></li><li><h5>accountNum: <span class="tsd-signature-type">number</span></h5></li><li><h5>beingLiquidated: <span class="tsd-signature-type">boolean</span></h5></li><li><h5>inHealthRegion: <span class="tsd-signature-type">boolean</span></h5></li><li><h5>netDeposits: <span class="tsd-signature-type">BN</span></h5></li><li><h5>perpSpotTransfers: <span class="tsd-signature-type">BN</span></h5></li><li><h5>healthRegionBeginInitHealth: <span class="tsd-signature-type">BN</span></h5></li><li><h5>frozenUntil: <span class="tsd-signature-type">BN</span></h5></li><li><h5>buybackFeesAccruedCurrent: <span class="tsd-signature-type">BN</span></h5></li><li><h5>buybackFeesAccruedPrevious: <span class="tsd-signature-type">BN</span></h5></li><li><h5>buybackFeesExpiryTimestamp: <span class="tsd-signature-type">BN</span></h5></li><li><h5>headerVersion: <span class="tsd-signature-type">number</span></h5></li><li><h5>tokens: <a href="TokenPositionDto.html" class="tsd-signature-type" data-tsd-kind="Class">TokenPositionDto</a><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>serum3: <a href="Serum3PositionDto.html" class="tsd-signature-type" data-tsd-kind="Class">Serum3PositionDto</a><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>perps: <a href="PerpPositionDto.html" class="tsd-signature-type" data-tsd-kind="Class">PerpPositionDto</a><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>perpOpenOrders: <a href="PerpOoDto.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOoDto</a><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>serum3OosMapByMarketIndex: <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">OpenOrders</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="MangoAccount.html" class="tsd-signature-type" data-tsd-kind="Class">MangoAccount</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="accountNum" class="tsd-anchor"></a><h3 class="tsd-anchor-link">account<wbr/>Num<a href="#accountNum" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">account<wbr/>Num<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="beingLiquidated" class="tsd-anchor"></a><h3 class="tsd-anchor-link">being<wbr/>Liquidated<a href="#beingLiquidated" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">being<wbr/>Liquidated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="buybackFeesAccruedCurrent" class="tsd-anchor"></a><h3 class="tsd-anchor-link">buyback<wbr/>Fees<wbr/>Accrued<wbr/>Current<a href="#buybackFeesAccruedCurrent" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">buyback<wbr/>Fees<wbr/>Accrued<wbr/>Current<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BN</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="buybackFeesAccruedPrevious" class="tsd-anchor"></a><h3 class="tsd-anchor-link">buyback<wbr/>Fees<wbr/>Accrued<wbr/>Previous<a href="#buybackFeesAccruedPrevious" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">buyback<wbr/>Fees<wbr/>Accrued<wbr/>Previous<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BN</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="buybackFeesExpiryTimestamp" class="tsd-anchor"></a><h3 class="tsd-anchor-link">buyback<wbr/>Fees<wbr/>Expiry<wbr/>Timestamp<a href="#buybackFeesExpiryTimestamp" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">buyback<wbr/>Fees<wbr/>Expiry<wbr/>Timestamp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BN</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="delegate" class="tsd-anchor"></a><h3 class="tsd-anchor-link">delegate<a href="#delegate" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">delegate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PublicKey</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="frozenUntil" class="tsd-anchor"></a><h3 class="tsd-anchor-link">frozen<wbr/>Until<a href="#frozenUntil" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">frozen<wbr/>Until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BN</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="group" class="tsd-anchor"></a><h3 class="tsd-anchor-link">group<a href="#group" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">group<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PublicKey</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="headerVersion" class="tsd-anchor"></a><h3 class="tsd-anchor-link">header<wbr/>Version<a href="#headerVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">header<wbr/>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="healthRegionBeginInitHealth" class="tsd-anchor"></a><h3 class="tsd-anchor-link">health<wbr/>Region<wbr/>Begin<wbr/>Init<wbr/>Health<a href="#healthRegionBeginInitHealth" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">health<wbr/>Region<wbr/>Begin<wbr/>Init<wbr/>Health<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BN</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="inHealthRegion" class="tsd-anchor"></a><h3 class="tsd-anchor-link">in<wbr/>Health<wbr/>Region<a href="#inHealthRegion" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">in<wbr/>Health<wbr/>Region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link">name<a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L15">accounts/mangoAccount.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="netDeposits" class="tsd-anchor"></a><h3 class="tsd-anchor-link">net<wbr/>Deposits<a href="#netDeposits" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">net<wbr/>Deposits<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BN</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="owner" class="tsd-anchor"></a><h3 class="tsd-anchor-link">owner<a href="#owner" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">owner<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PublicKey</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="perpOpenOrders" class="tsd-anchor"></a><h3 class="tsd-anchor-link">perp<wbr/>Open<wbr/>Orders<a href="#perpOpenOrders" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">perp<wbr/>Open<wbr/>Orders<span class="tsd-signature-symbol">:</span> <a href="PerpOo.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOo</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L19">accounts/mangoAccount.ts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="perpSpotTransfers" class="tsd-anchor"></a><h3 class="tsd-anchor-link">perp<wbr/>Spot<wbr/>Transfers<a href="#perpSpotTransfers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">perp<wbr/>Spot<wbr/>Transfers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BN</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="perps" class="tsd-anchor"></a><h3 class="tsd-anchor-link">perps<a href="#perps" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">perps<span class="tsd-signature-symbol">:</span> <a href="PerpPosition.html" class="tsd-signature-type" data-tsd-kind="Class">PerpPosition</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L18">accounts/mangoAccount.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="publicKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link">public<wbr/>Key<a href="#publicKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">public<wbr/>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PublicKey</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="serum3" class="tsd-anchor"></a><h3 class="tsd-anchor-link">serum3<a href="#serum3" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">serum3<span class="tsd-signature-symbol">:</span> <a href="Serum3Orders.html" class="tsd-signature-type" data-tsd-kind="Class">Serum3Orders</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L17">accounts/mangoAccount.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="serum3OosMapByMarketIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link">serum3<wbr/>Oos<wbr/>Map<wbr/>By<wbr/>Market<wbr/>Index<a href="#serum3OosMapByMarketIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">serum3<wbr/>Oos<wbr/>Map<wbr/>By<wbr/>Market<wbr/>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">OpenOrders</span><span class="tsd-signature-symbol">></span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="tokens" class="tsd-anchor"></a><h3 class="tsd-anchor-link">tokens<a href="#tokens" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">tokens<span class="tsd-signature-symbol">:</span> <a href="TokenPosition.html" class="tsd-signature-type" data-tsd-kind="Class">TokenPosition</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L16">accounts/mangoAccount.ts:16</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAssetsValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Assets<wbr/>Value<a href="#getAssetsValue" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Assets<wbr/>Value<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, healthType<span class="tsd-signature-symbol">?: </span><a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L401">accounts/mangoAccount.ts:401</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sum of all positive assets.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> healthType: <a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></h4><div><p>assets, in native quote</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getBuybackFeesAccrued" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Buyback<wbr/>Fees<wbr/>Accrued<a href="#getBuybackFeesAccrued" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Buyback<wbr/>Fees<wbr/>Accrued<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L989">accounts/mangoAccount.ts:989</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BN</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getBuybackFeesAccruedUi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Buyback<wbr/>Fees<wbr/>Accrued<wbr/>Ui<a href="#getBuybackFeesAccruedUi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Buyback<wbr/>Fees<wbr/>Accrued<wbr/>Ui<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L993">accounts/mangoAccount.ts:993</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getCollateralValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Collateral<wbr/>Value<a href="#getCollateralValue" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Collateral<wbr/>Value<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L393">accounts/mangoAccount.ts:393</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The amount of native quote you could withdraw against your existing assets.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></h4><div><p>collateral value, in native quote</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getCumulativeInterest" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Cumulative<wbr/>Interest<a href="#getCumulativeInterest" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Cumulative<wbr/>Interest<span class="tsd-signature-symbol">(</span>bank<span class="tsd-signature-symbol">: </span><a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L433">accounts/mangoAccount.ts:433</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>bank: <a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>token cumulative interest, in native token units. Sum of deposit and borrow interest.
|
|
Caveat: This will only return cumulative interest since the tokenPosition was last opened.
|
|
If the tokenPosition was closed and reopened multiple times it is necessary to add this result to
|
|
cumulative interest at each of the prior tokenPosition closings (from mango API) to get the all time
|
|
cumulative interest.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getEffectiveTokenBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Effective<wbr/>Token<wbr/>Balance<a href="#getEffectiveTokenBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Effective<wbr/>Token<wbr/>Balance<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, bank<span class="tsd-signature-symbol">: </span><a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L240">accounts/mangoAccount.ts:240</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>bank: <a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getEquity" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Equity<a href="#getEquity" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Equity<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L350">accounts/mangoAccount.ts:350</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sum of all the assets i.e. token deposits, borrows, total assets in spot open orders, and perps positions.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></h4><div><p>equity, in native quote</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getHealth" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Health<a href="#getHealth" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Health<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, healthType<span class="tsd-signature-symbol">: </span><a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L315">accounts/mangoAccount.ts:315</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Health, see health.rs or <a href="https://docs.mango.markets/mango-markets/health-overview">https://docs.mango.markets/mango-markets/health-overview</a></p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>healthType: <a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></h4><div><p>raw health number, in native quote</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getHealthRatio" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Health<wbr/>Ratio<a href="#getHealthRatio" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Health<wbr/>Ratio<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, healthType<span class="tsd-signature-symbol">: </span><a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L331">accounts/mangoAccount.ts:331</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Health ratio, which is computed so <code>100 * (assets-liabs)/liabs</code>
|
|
Note: health ratio is technically ∞ if liabs are 0</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>healthType: <a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></h4><div><p>health ratio, in percentage form</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getHealthRatioUi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Health<wbr/>Ratio<wbr/>Ui<a href="#getHealthRatioUi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Health<wbr/>Ratio<wbr/>Ui<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, healthType<span class="tsd-signature-symbol">: </span><a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L341">accounts/mangoAccount.ts:341</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Health ratio</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>healthType: <a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>health ratio, in percentage form, capped to 100</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getLiabsValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Liabs<wbr/>Value<a href="#getLiabsValue" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Liabs<wbr/>Value<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, healthType<span class="tsd-signature-symbol">?: </span><a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L410">accounts/mangoAccount.ts:410</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sum of all negative assets.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> healthType: <a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></h4><div><p>liabs, in native quote</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getMaxBaseForPerpAskUi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Max<wbr/>Base<wbr/>For<wbr/>Perp<wbr/>Ask<wbr/>Ui<a href="#getMaxBaseForPerpAskUi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Max<wbr/>Base<wbr/>For<wbr/>Perp<wbr/>Ask<wbr/>Ui<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, perpMarketIndex<span class="tsd-signature-symbol">: </span><a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L913">accounts/mangoAccount.ts:913</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>TODO: also think about limit orders</p>
|
|
</div><div><p>The max ui base you can place a market/ioc ask on the market,
|
|
price is the ui price at which you think the order would materialiase.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>perpMarketIndex: <a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>max ui base ask</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getMaxBaseForSerum3AskUi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Max<wbr/>Base<wbr/>For<wbr/>Serum3<wbr/>Ask<wbr/>Ui<a href="#getMaxBaseForSerum3AskUi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Max<wbr/>Base<wbr/>For<wbr/>Serum3<wbr/>Ask<wbr/>Ui<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, externalMarketPk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L729">accounts/mangoAccount.ts:729</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>TODO REWORK, know to break in binary search, also make work for limit orders</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>externalMarketPk: <span class="tsd-signature-type">PublicKey</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>maximum ui base which can be traded at oracle price for quote token given current health</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getMaxFeesBuyback" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Max<wbr/>Fees<wbr/>Buyback<a href="#getMaxFeesBuyback" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Max<wbr/>Fees<wbr/>Buyback<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L997">accounts/mangoAccount.ts:997</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BN</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getMaxFeesBuybackUi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Max<wbr/>Fees<wbr/>Buyback<wbr/>Ui<a href="#getMaxFeesBuybackUi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Max<wbr/>Fees<wbr/>Buyback<wbr/>Ui<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L1011">accounts/mangoAccount.ts:1011</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getMaxQuoteForPerpBidUi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Max<wbr/>Quote<wbr/>For<wbr/>Perp<wbr/>Bid<wbr/>Ui<a href="#getMaxQuoteForPerpBidUi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Max<wbr/>Quote<wbr/>For<wbr/>Perp<wbr/>Bid<wbr/>Ui<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, perpMarketIndex<span class="tsd-signature-symbol">: </span><a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L886">accounts/mangoAccount.ts:886</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>TODO: also think about limit orders</p>
|
|
</div><div><p>The max ui quote you can place a market/ioc bid on the market,
|
|
price is the ui price at which you think the order would materialiase.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>perpMarketIndex: <a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>maximum ui quote which can be traded at oracle price for quote token given current health</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getMaxQuoteForSerum3BidUi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Max<wbr/>Quote<wbr/>For<wbr/>Serum3<wbr/>Bid<wbr/>Ui<a href="#getMaxQuoteForSerum3BidUi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Max<wbr/>Quote<wbr/>For<wbr/>Serum3<wbr/>Bid<wbr/>Ui<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, externalMarketPk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L687">accounts/mangoAccount.ts:687</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>TODO REWORK, know to break in binary search, also make work for limit orders</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>externalMarketPk: <span class="tsd-signature-type">PublicKey</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>maximum ui quote which can be traded at oracle price for base token given current health</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getMaxSourceUiForTokenSwap" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Max<wbr/>Source<wbr/>Ui<wbr/>For<wbr/>Token<wbr/>Swap<a href="#getMaxSourceUiForTokenSwap" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Max<wbr/>Source<wbr/>Ui<wbr/>For<wbr/>Token<wbr/>Swap<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, sourceMintPk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span>, targetMintPk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span>, slippageAndFeesFactor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L553">accounts/mangoAccount.ts:553</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The max amount of given source ui token you can swap to a target token.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>sourceMintPk: <span class="tsd-signature-type">PublicKey</span></h5></li><li><h5>targetMintPk: <span class="tsd-signature-type">PublicKey</span></h5></li><li><h5>slippageAndFeesFactor: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>max amount of given source ui token you can swap to a target token, in ui token</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getMaxWithdrawWithBorrowForToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Max<wbr/>Withdraw<wbr/>With<wbr/>Borrow<wbr/>For<wbr/>Token<a href="#getMaxWithdrawWithBorrowForToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Max<wbr/>Withdraw<wbr/>With<wbr/>Borrow<wbr/>For<wbr/>Token<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, mintPk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L470">accounts/mangoAccount.ts:470</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The amount of given native token you can withdraw including borrows, considering all existing assets as collateral.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>mintPk: <span class="tsd-signature-type">PublicKey</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></h4><div><p>amount of given native token you can borrow, considering all existing assets as collateral, in native token</p>
|
|
<p>TODO: take into account net_borrow_limit and min_vault_to_deposits_ratio</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getMaxWithdrawWithBorrowForTokenUi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Max<wbr/>Withdraw<wbr/>With<wbr/>Borrow<wbr/>For<wbr/>Token<wbr/>Ui<a href="#getMaxWithdrawWithBorrowForTokenUi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Max<wbr/>Withdraw<wbr/>With<wbr/>Borrow<wbr/>For<wbr/>Token<wbr/>Ui<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, mintPk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L538">accounts/mangoAccount.ts:538</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>mintPk: <span class="tsd-signature-type">PublicKey</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPerpPosition" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Perp<wbr/>Position<a href="#getPerpPosition" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Perp<wbr/>Position<span class="tsd-signature-symbol">(</span>perpMarketIndex<span class="tsd-signature-symbol">: </span><a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="PerpPosition.html" class="tsd-signature-type" data-tsd-kind="Class">PerpPosition</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L192">accounts/mangoAccount.ts:192</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>perpMarketIndex: <a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="PerpPosition.html" class="tsd-signature-type" data-tsd-kind="Class">PerpPosition</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPerpPositionUi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Perp<wbr/>Position<wbr/>Ui<a href="#getPerpPositionUi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Perp<wbr/>Position<wbr/>Ui<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, perpMarketIndex<span class="tsd-signature-symbol">: </span><a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a>, useEventQueue<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L198">accounts/mangoAccount.ts:198</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>perpMarketIndex: <a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> useEventQueue: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPerpSettleHealth" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Perp<wbr/>Settle<wbr/>Health<a href="#getPerpSettleHealth" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Perp<wbr/>Settle<wbr/>Health<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L320">accounts/mangoAccount.ts:320</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPnl" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Pnl<a href="#getPnl" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Pnl<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L420">accounts/mangoAccount.ts:420</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></h4><div><p>Overall PNL, in native quote
|
|
PNL is defined here as spot value + serum3 open orders value + perp value - net deposits value (evaluated at native quote price at the time of the deposit/withdraw)
|
|
spot value + serum3 open orders value + perp value is returned by getEquity (open orders values are added to spot token values implicitly)</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getSerum3Account" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Serum3<wbr/>Account<a href="#getSerum3Account" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Serum3<wbr/>Account<span class="tsd-signature-symbol">(</span>marketIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MarketIndex</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="Serum3Orders.html" class="tsd-signature-type" data-tsd-kind="Class">Serum3Orders</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L188">accounts/mangoAccount.ts:188</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>marketIndex: <span class="tsd-signature-type">MarketIndex</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="Serum3Orders.html" class="tsd-signature-type" data-tsd-kind="Class">Serum3Orders</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getSerum3OoAccount" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Serum3<wbr/>Oo<wbr/>Account<a href="#getSerum3OoAccount" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Serum3<wbr/>Oo<wbr/>Account<span class="tsd-signature-symbol">(</span>marketIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MarketIndex</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">OpenOrders</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L211">accounts/mangoAccount.ts:211</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>marketIndex: <span class="tsd-signature-type">MarketIndex</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">OpenOrders</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Token<a href="#getToken" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Token<span class="tsd-signature-symbol">(</span>tokenIndex<span class="tsd-signature-symbol">: </span><a href="../index.html#TokenIndex" class="tsd-signature-type" data-tsd-kind="Type alias">TokenIndex</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="TokenPosition.html" class="tsd-signature-type" data-tsd-kind="Class">TokenPosition</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L184">accounts/mangoAccount.ts:184</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>tokenIndex: <a href="../index.html#TokenIndex" class="tsd-signature-type" data-tsd-kind="Type alias">TokenIndex</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="TokenPosition.html" class="tsd-signature-type" data-tsd-kind="Class">TokenPosition</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTokenBalance" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Token<wbr/>Balance<a href="#getTokenBalance" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Token<wbr/>Balance<span class="tsd-signature-symbol">(</span>bank<span class="tsd-signature-symbol">: </span><a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L234">accounts/mangoAccount.ts:234</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>bank: <a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></h4><div><p>native balance for a token, is signed</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTokenBalanceUi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Token<wbr/>Balance<wbr/>Ui<a href="#getTokenBalanceUi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Token<wbr/>Balance<wbr/>Ui<span class="tsd-signature-symbol">(</span>bank<span class="tsd-signature-symbol">: </span><a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L285">accounts/mangoAccount.ts:285</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>bank: <a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>UI balance for a token, is signed</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTokenBorrows" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Token<wbr/>Borrows<a href="#getTokenBorrows" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Token<wbr/>Borrows<span class="tsd-signature-symbol">(</span>bank<span class="tsd-signature-symbol">: </span><a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L275">accounts/mangoAccount.ts:275</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>bank: <a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></h4><div><p>native borrows for a token, 0 if position has deposits</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTokenBorrowsUi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Token<wbr/>Borrows<wbr/>Ui<a href="#getTokenBorrowsUi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Token<wbr/>Borrows<wbr/>Ui<span class="tsd-signature-symbol">(</span>bank<span class="tsd-signature-symbol">: </span><a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L305">accounts/mangoAccount.ts:305</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>bank: <a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>UI borrows for a token, 0 or less</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTokenDeposits" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Token<wbr/>Deposits<a href="#getTokenDeposits" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Token<wbr/>Deposits<span class="tsd-signature-symbol">(</span>bank<span class="tsd-signature-symbol">: </span><a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L265">accounts/mangoAccount.ts:265</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>bank: <a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="I80F48.html" class="tsd-signature-type" data-tsd-kind="Class">I80F48</a></h4><div><p>native deposits for a token, 0 if position has borrows</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getTokenDepositsUi" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Token<wbr/>Deposits<wbr/>Ui<a href="#getTokenDepositsUi" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Token<wbr/>Deposits<wbr/>Ui<span class="tsd-signature-symbol">(</span>bank<span class="tsd-signature-symbol">: </span><a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L295">accounts/mangoAccount.ts:295</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>bank: <a href="Bank.html" class="tsd-signature-type" data-tsd-kind="Class">Bank</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>UI deposits for a token, 0 or more</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isDelegate" class="tsd-anchor"></a><h3 class="tsd-anchor-link">is<wbr/>Delegate<a href="#isDelegate" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Delegate<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L144">accounts/mangoAccount.ts:144</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isOperational" class="tsd-anchor"></a><h3 class="tsd-anchor-link">is<wbr/>Operational<a href="#isOperational" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Operational<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L150">accounts/mangoAccount.ts:150</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="loadPerpOpenOrdersForMarket" class="tsd-anchor"></a><h3 class="tsd-anchor-link">load<wbr/>Perp<wbr/>Open<wbr/>Orders<wbr/>For<wbr/>Market<a href="#loadPerpOpenOrdersForMarket" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">load<wbr/>Perp<wbr/>Open<wbr/>Orders<wbr/>For<wbr/>Market<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a>, group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, perpMarketIndex<span class="tsd-signature-symbol">: </span><a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a>, forceReload<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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"><</span><a href="PerpOrder.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOrder</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L972">accounts/mangoAccount.ts:972</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a></h5></li><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>perpMarketIndex: <a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> forceReload: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="PerpOrder.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOrder</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="loadSerum3OpenOrdersAccounts" class="tsd-anchor"></a><h3 class="tsd-anchor-link">load<wbr/>Serum3<wbr/>Open<wbr/>Orders<wbr/>Accounts<a href="#loadSerum3OpenOrdersAccounts" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">load<wbr/>Serum3<wbr/>Open<wbr/>Orders<wbr/>Accounts<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OpenOrders</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L619">accounts/mangoAccount.ts:619</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OpenOrders</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="loadSerum3OpenOrdersForMarket" class="tsd-anchor"></a><h3 class="tsd-anchor-link">load<wbr/>Serum3<wbr/>Open<wbr/>Orders<wbr/>For<wbr/>Market<a href="#loadSerum3OpenOrdersForMarket" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">load<wbr/>Serum3<wbr/>Open<wbr/>Orders<wbr/>For<wbr/>Market<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a>, group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, externalMarketPk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</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"><</span><span class="tsd-signature-type">Order</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L641">accounts/mangoAccount.ts:641</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a></h5></li><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>externalMarketPk: <span class="tsd-signature-type">PublicKey</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Order</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="perpActive" class="tsd-anchor"></a><h3 class="tsd-anchor-link">perp<wbr/>Active<a href="#perpActive" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">perp<wbr/>Active<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PerpPosition.html" class="tsd-signature-type" data-tsd-kind="Class">PerpPosition</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L174">accounts/mangoAccount.ts:174</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="PerpPosition.html" class="tsd-signature-type" data-tsd-kind="Class">PerpPosition</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="perpOrderExistsForMarket" class="tsd-anchor"></a><h3 class="tsd-anchor-link">perp<wbr/>Order<wbr/>Exists<wbr/>For<wbr/>Market<a href="#perpOrderExistsForMarket" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">perp<wbr/>Order<wbr/>Exists<wbr/>For<wbr/>Market<span class="tsd-signature-symbol">(</span>perpMarket<span class="tsd-signature-symbol">: </span><a href="PerpMarket.html" class="tsd-signature-type" data-tsd-kind="Class">PerpMarket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L168">accounts/mangoAccount.ts:168</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>perpMarket: <a href="PerpMarket.html" class="tsd-signature-type" data-tsd-kind="Class">PerpMarket</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="perpOrdersActive" class="tsd-anchor"></a><h3 class="tsd-anchor-link">perp<wbr/>Orders<wbr/>Active<a href="#perpOrdersActive" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">perp<wbr/>Orders<wbr/>Active<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PerpOo.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOo</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L178">accounts/mangoAccount.ts:178</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="PerpOo.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOo</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="perpPositionExistsForMarket" class="tsd-anchor"></a><h3 class="tsd-anchor-link">perp<wbr/>Position<wbr/>Exists<wbr/>For<wbr/>Market<a href="#perpPositionExistsForMarket" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">perp<wbr/>Position<wbr/>Exists<wbr/>For<wbr/>Market<span class="tsd-signature-symbol">(</span>perpMarket<span class="tsd-signature-symbol">: </span><a href="PerpMarket.html" class="tsd-signature-type" data-tsd-kind="Class">PerpMarket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L162">accounts/mangoAccount.ts:162</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>perpMarket: <a href="PerpMarket.html" class="tsd-signature-type" data-tsd-kind="Class">PerpMarket</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="reload" class="tsd-anchor"></a><h3 class="tsd-anchor-link">reload<a href="#reload" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">reload<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="MangoAccount.html" class="tsd-signature-type" data-tsd-kind="Class">MangoAccount</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L100">accounts/mangoAccount.ts:100</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="MangoAccount.html" class="tsd-signature-type" data-tsd-kind="Class">MangoAccount</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="reloadSerum3OpenOrders" class="tsd-anchor"></a><h3 class="tsd-anchor-link">reload<wbr/>Serum3<wbr/>Open<wbr/>Orders<a href="#reloadSerum3OpenOrders" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">reload<wbr/>Serum3<wbr/>Open<wbr/>Orders<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="MangoAccount.html" class="tsd-signature-type" data-tsd-kind="Class">MangoAccount</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L116">accounts/mangoAccount.ts:116</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="MangoAccount.html" class="tsd-signature-type" data-tsd-kind="Class">MangoAccount</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="reloadWithSlot" class="tsd-anchor"></a><h3 class="tsd-anchor-link">reload<wbr/>With<wbr/>Slot<a href="#reloadWithSlot" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">reload<wbr/>With<wbr/>Slot<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><a href="MangoAccount.html" class="tsd-signature-type" data-tsd-kind="Class">MangoAccount</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L107">accounts/mangoAccount.ts:107</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>slot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><a href="MangoAccount.html" class="tsd-signature-type" data-tsd-kind="Class">MangoAccount</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="serum3Active" class="tsd-anchor"></a><h3 class="tsd-anchor-link">serum3<wbr/>Active<a href="#serum3Active" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">serum3<wbr/>Active<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Serum3Orders.html" class="tsd-signature-type" data-tsd-kind="Class">Serum3Orders</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L158">accounts/mangoAccount.ts:158</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="Serum3Orders.html" class="tsd-signature-type" data-tsd-kind="Class">Serum3Orders</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="serum3CancelAllOrdersForAllMarkets" class="tsd-anchor"></a><h3 class="tsd-anchor-link">serum3<wbr/>Cancel<wbr/>All<wbr/>Orders<wbr/>For<wbr/>All<wbr/>Markets<a href="#serum3CancelAllOrdersForAllMarkets" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">serum3<wbr/>Cancel<wbr/>All<wbr/>Orders<wbr/>For<wbr/>All<wbr/>Markets<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a>, group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L860">accounts/mangoAccount.ts:860</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a></h5></li><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="serum3SettleFundsForAllMarkets" class="tsd-anchor"></a><h3 class="tsd-anchor-link">serum3<wbr/>Settle<wbr/>Funds<wbr/>For<wbr/>All<wbr/>Markets<a href="#serum3SettleFundsForAllMarkets" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">serum3<wbr/>Settle<wbr/>Funds<wbr/>For<wbr/>All<wbr/>Markets<span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a>, group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L842">accounts/mangoAccount.ts:842</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="MangoClient.html" class="tsd-signature-type" data-tsd-kind="Class">MangoClient</a></h5></li><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="simHealthRatioWithPerpAskUiChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Perp<wbr/>Ask<wbr/>Ui<wbr/>Changes<a href="#simHealthRatioWithPerpAskUiChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Perp<wbr/>Ask<wbr/>Ui<wbr/>Changes<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, perpMarketIndex<span class="tsd-signature-symbol">: </span><a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a>, size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L950">accounts/mangoAccount.ts:950</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>perpMarketIndex: <a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a></h5></li><li><h5>size: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="simHealthRatioWithPerpBidUiChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Perp<wbr/>Bid<wbr/>Ui<wbr/>Changes<a href="#simHealthRatioWithPerpBidUiChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Perp<wbr/>Bid<wbr/>Ui<wbr/>Changes<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, perpMarketIndex<span class="tsd-signature-symbol">: </span><a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a>, size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L928">accounts/mangoAccount.ts:928</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>perpMarketIndex: <a href="../index.html#PerpMarketIndex" class="tsd-signature-type" data-tsd-kind="Type alias">PerpMarketIndex</a></h5></li><li><h5>size: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="simHealthRatioWithSerum3AskUiChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Serum3<wbr/>Ask<wbr/>Ui<wbr/>Changes<a href="#simHealthRatioWithSerum3AskUiChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Serum3<wbr/>Ask<wbr/>Ui<wbr/>Changes<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, uiBaseAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, externalMarketPk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span>, healthType<span class="tsd-signature-symbol">?: </span><a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L811">accounts/mangoAccount.ts:811</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>uiBaseAmount: <span class="tsd-signature-type">number</span></h5></li><li><h5>externalMarketPk: <span class="tsd-signature-type">PublicKey</span></h5></li><li><h5>healthType: <a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a><span class="tsd-signature-symbol"> = HealthType.init</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>health ratio after an ask with uiBaseAmount is placed</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="simHealthRatioWithSerum3BidUiChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Serum3<wbr/>Bid<wbr/>Ui<wbr/>Changes<a href="#simHealthRatioWithSerum3BidUiChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Serum3<wbr/>Bid<wbr/>Ui<wbr/>Changes<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, uiQuoteAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, externalMarketPk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span>, healthType<span class="tsd-signature-symbol">?: </span><a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L773">accounts/mangoAccount.ts:773</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>uiQuoteAmount: <span class="tsd-signature-type">number</span></h5></li><li><h5>externalMarketPk: <span class="tsd-signature-type">PublicKey</span></h5></li><li><h5>healthType: <a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a><span class="tsd-signature-symbol"> = HealthType.init</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>health ratio after a bid with uiQuoteAmount is placed</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="simHealthRatioWithTokenPositionUiChanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Token<wbr/>Position<wbr/>Ui<wbr/>Changes<a href="#simHealthRatioWithTokenPositionUiChanges" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Token<wbr/>Position<wbr/>Ui<wbr/>Changes<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, uiTokenChanges<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>mintPk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>uiTokenAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span>, healthType<span class="tsd-signature-symbol">?: </span><a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L592">accounts/mangoAccount.ts:592</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Simulates new health ratio after applying tokenChanges to the token positions.
|
|
Note: token changes are expected in ui amounts</p>
|
|
</div><div><p>e.g. useful to simulate health after a potential swap.
|
|
Note: health ratio is technically ∞ if liabs are 0</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>uiTokenChanges: <span class="tsd-signature-symbol">{ </span>mintPk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>uiTokenAmount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>healthType: <a href="HealthType.html" class="tsd-signature-type" data-tsd-kind="Class">HealthType</a><span class="tsd-signature-symbol"> = HealthType.init</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div><p>health ratio, in percentage form</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link">to<wbr/>String<a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">to<wbr/>String<span class="tsd-signature-symbol">(</span>group<span class="tsd-signature-symbol">?: </span><a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a>, onlyTokens<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L1015">accounts/mangoAccount.ts:1015</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> group: <a href="Group.html" class="tsd-signature-type" data-tsd-kind="Class">Group</a></h5></li><li><h5>onlyTokens: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="tokensActive" class="tsd-anchor"></a><h3 class="tsd-anchor-link">tokens<wbr/>Active<a href="#tokensActive" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">tokens<wbr/>Active<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TokenPosition.html" class="tsd-signature-type" data-tsd-kind="Class">TokenPosition</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L154">accounts/mangoAccount.ts:154</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="TokenPosition.html" class="tsd-signature-type" data-tsd-kind="Class">TokenPosition</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> from<a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">(</span>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span>, obj<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>accountNum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>beingLiquidated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>buybackFeesAccruedCurrent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>buybackFeesAccruedPrevious<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>buybackFeesExpiryTimestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>delegate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>frozenUntil<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>group<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>headerVersion<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>healthRegionBeginInitHealth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>inHealthRegion<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>netDeposits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>perpOpenOrders<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>perpSpotTransfers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>perps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>serum3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>tokens<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MangoAccount.html" class="tsd-signature-type" data-tsd-kind="Class">MangoAccount</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/blockworks-foundation/mango-v4/blob/08dfb0d/ts/client/src/accounts/mangoAccount.ts#L21">accounts/mangoAccount.ts:21</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>publicKey: <span class="tsd-signature-type">PublicKey</span></h5></li><li><h5>obj: <span class="tsd-signature-symbol">{ </span>accountNum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>beingLiquidated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>buybackFeesAccruedCurrent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>buybackFeesAccruedPrevious<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>buybackFeesExpiryTimestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>delegate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>frozenUntil<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>group<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>headerVersion<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>healthRegionBeginInitHealth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>inHealthRegion<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>netDeposits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">; </span>perpOpenOrders<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>perpSpotTransfers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span><span class="tsd-signature-symbol">; </span>perps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>serum3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span>tokens<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>account<wbr/>Num<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>being<wbr/>Liquidated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>buyback<wbr/>Fees<wbr/>Accrued<wbr/>Current<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>buyback<wbr/>Fees<wbr/>Accrued<wbr/>Previous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>buyback<wbr/>Fees<wbr/>Expiry<wbr/>Timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>delegate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>frozen<wbr/>Until<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>group<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>header<wbr/>Version<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>health<wbr/>Region<wbr/>Begin<wbr/>Init<wbr/>Health<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>in<wbr/>Health<wbr/>Region<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>net<wbr/>Deposits<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span></h5></li><li class="tsd-parameter"><h5>perp<wbr/>Open<wbr/>Orders<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></h5></li><li class="tsd-parameter"><h5>perp<wbr/>Spot<wbr/>Transfers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span></h5></li><li class="tsd-parameter"><h5>perps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></h5></li><li class="tsd-parameter"><h5>serum3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></h5></li><li class="tsd-parameter"><h5>tokens<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="MangoAccount.html" class="tsd-signature-type" data-tsd-kind="Class">MangoAccount</a></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="MangoAccount.html" class="tsd-kind-icon">Mango<wbr/>Account</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="MangoAccount.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#accountNum" class="tsd-kind-icon">account<wbr/>Num</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#beingLiquidated" class="tsd-kind-icon">being<wbr/>Liquidated</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#buybackFeesAccruedCurrent" class="tsd-kind-icon">buyback<wbr/>Fees<wbr/>Accrued<wbr/>Current</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#buybackFeesAccruedPrevious" class="tsd-kind-icon">buyback<wbr/>Fees<wbr/>Accrued<wbr/>Previous</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#buybackFeesExpiryTimestamp" class="tsd-kind-icon">buyback<wbr/>Fees<wbr/>Expiry<wbr/>Timestamp</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#delegate" class="tsd-kind-icon">delegate</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#frozenUntil" class="tsd-kind-icon">frozen<wbr/>Until</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#group" class="tsd-kind-icon">group</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#headerVersion" class="tsd-kind-icon">header<wbr/>Version</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#healthRegionBeginInitHealth" class="tsd-kind-icon">health<wbr/>Region<wbr/>Begin<wbr/>Init<wbr/>Health</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#inHealthRegion" class="tsd-kind-icon">in<wbr/>Health<wbr/>Region</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#netDeposits" class="tsd-kind-icon">net<wbr/>Deposits</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#owner" class="tsd-kind-icon">owner</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#perpOpenOrders" class="tsd-kind-icon">perp<wbr/>Open<wbr/>Orders</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#perpSpotTransfers" class="tsd-kind-icon">perp<wbr/>Spot<wbr/>Transfers</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#perps" class="tsd-kind-icon">perps</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#publicKey" class="tsd-kind-icon">public<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#serum3" class="tsd-kind-icon">serum3</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#serum3OosMapByMarketIndex" class="tsd-kind-icon">serum3<wbr/>Oos<wbr/>Map<wbr/>By<wbr/>Market<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="MangoAccount.html#tokens" class="tsd-kind-icon">tokens</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getAssetsValue" class="tsd-kind-icon">get<wbr/>Assets<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getBuybackFeesAccrued" class="tsd-kind-icon">get<wbr/>Buyback<wbr/>Fees<wbr/>Accrued</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getBuybackFeesAccruedUi" class="tsd-kind-icon">get<wbr/>Buyback<wbr/>Fees<wbr/>Accrued<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getCollateralValue" class="tsd-kind-icon">get<wbr/>Collateral<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getCumulativeInterest" class="tsd-kind-icon">get<wbr/>Cumulative<wbr/>Interest</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getEffectiveTokenBalance" class="tsd-kind-icon">get<wbr/>Effective<wbr/>Token<wbr/>Balance</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getEquity" class="tsd-kind-icon">get<wbr/>Equity</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getHealth" class="tsd-kind-icon">get<wbr/>Health</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getHealthRatio" class="tsd-kind-icon">get<wbr/>Health<wbr/>Ratio</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getHealthRatioUi" class="tsd-kind-icon">get<wbr/>Health<wbr/>Ratio<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getLiabsValue" class="tsd-kind-icon">get<wbr/>Liabs<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxBaseForPerpAskUi" class="tsd-kind-icon">get<wbr/>Max<wbr/>Base<wbr/>For<wbr/>Perp<wbr/>Ask<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxBaseForSerum3AskUi" class="tsd-kind-icon">get<wbr/>Max<wbr/>Base<wbr/>For<wbr/>Serum3<wbr/>Ask<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxFeesBuyback" class="tsd-kind-icon">get<wbr/>Max<wbr/>Fees<wbr/>Buyback</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxFeesBuybackUi" class="tsd-kind-icon">get<wbr/>Max<wbr/>Fees<wbr/>Buyback<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxQuoteForPerpBidUi" class="tsd-kind-icon">get<wbr/>Max<wbr/>Quote<wbr/>For<wbr/>Perp<wbr/>Bid<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxQuoteForSerum3BidUi" class="tsd-kind-icon">get<wbr/>Max<wbr/>Quote<wbr/>For<wbr/>Serum3<wbr/>Bid<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxSourceUiForTokenSwap" class="tsd-kind-icon">get<wbr/>Max<wbr/>Source<wbr/>Ui<wbr/>For<wbr/>Token<wbr/>Swap</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxWithdrawWithBorrowForToken" class="tsd-kind-icon">get<wbr/>Max<wbr/>Withdraw<wbr/>With<wbr/>Borrow<wbr/>For<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getMaxWithdrawWithBorrowForTokenUi" class="tsd-kind-icon">get<wbr/>Max<wbr/>Withdraw<wbr/>With<wbr/>Borrow<wbr/>For<wbr/>Token<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getPerpPosition" class="tsd-kind-icon">get<wbr/>Perp<wbr/>Position</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getPerpPositionUi" class="tsd-kind-icon">get<wbr/>Perp<wbr/>Position<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getPerpSettleHealth" class="tsd-kind-icon">get<wbr/>Perp<wbr/>Settle<wbr/>Health</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getPnl" class="tsd-kind-icon">get<wbr/>Pnl</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getSerum3Account" class="tsd-kind-icon">get<wbr/>Serum3<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getSerum3OoAccount" class="tsd-kind-icon">get<wbr/>Serum3<wbr/>Oo<wbr/>Account</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getToken" class="tsd-kind-icon">get<wbr/>Token</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getTokenBalance" class="tsd-kind-icon">get<wbr/>Token<wbr/>Balance</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getTokenBalanceUi" class="tsd-kind-icon">get<wbr/>Token<wbr/>Balance<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getTokenBorrows" class="tsd-kind-icon">get<wbr/>Token<wbr/>Borrows</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getTokenBorrowsUi" class="tsd-kind-icon">get<wbr/>Token<wbr/>Borrows<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getTokenDeposits" class="tsd-kind-icon">get<wbr/>Token<wbr/>Deposits</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#getTokenDepositsUi" class="tsd-kind-icon">get<wbr/>Token<wbr/>Deposits<wbr/>Ui</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#isDelegate" class="tsd-kind-icon">is<wbr/>Delegate</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#isOperational" class="tsd-kind-icon">is<wbr/>Operational</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#loadPerpOpenOrdersForMarket" class="tsd-kind-icon">load<wbr/>Perp<wbr/>Open<wbr/>Orders<wbr/>For<wbr/>Market</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#loadSerum3OpenOrdersAccounts" class="tsd-kind-icon">load<wbr/>Serum3<wbr/>Open<wbr/>Orders<wbr/>Accounts</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#loadSerum3OpenOrdersForMarket" class="tsd-kind-icon">load<wbr/>Serum3<wbr/>Open<wbr/>Orders<wbr/>For<wbr/>Market</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#perpActive" class="tsd-kind-icon">perp<wbr/>Active</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#perpOrderExistsForMarket" class="tsd-kind-icon">perp<wbr/>Order<wbr/>Exists<wbr/>For<wbr/>Market</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#perpOrdersActive" class="tsd-kind-icon">perp<wbr/>Orders<wbr/>Active</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#perpPositionExistsForMarket" class="tsd-kind-icon">perp<wbr/>Position<wbr/>Exists<wbr/>For<wbr/>Market</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#reload" class="tsd-kind-icon">reload</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#reloadSerum3OpenOrders" class="tsd-kind-icon">reload<wbr/>Serum3<wbr/>Open<wbr/>Orders</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#reloadWithSlot" class="tsd-kind-icon">reload<wbr/>With<wbr/>Slot</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#serum3Active" class="tsd-kind-icon">serum3<wbr/>Active</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#serum3CancelAllOrdersForAllMarkets" class="tsd-kind-icon">serum3<wbr/>Cancel<wbr/>All<wbr/>Orders<wbr/>For<wbr/>All<wbr/>Markets</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#serum3SettleFundsForAllMarkets" class="tsd-kind-icon">serum3<wbr/>Settle<wbr/>Funds<wbr/>For<wbr/>All<wbr/>Markets</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#simHealthRatioWithPerpAskUiChanges" class="tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Perp<wbr/>Ask<wbr/>Ui<wbr/>Changes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#simHealthRatioWithPerpBidUiChanges" class="tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Perp<wbr/>Bid<wbr/>Ui<wbr/>Changes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#simHealthRatioWithSerum3AskUiChanges" class="tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Serum3<wbr/>Ask<wbr/>Ui<wbr/>Changes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#simHealthRatioWithSerum3BidUiChanges" class="tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Serum3<wbr/>Bid<wbr/>Ui<wbr/>Changes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#simHealthRatioWithTokenPositionUiChanges" class="tsd-kind-icon">sim<wbr/>Health<wbr/>Ratio<wbr/>With<wbr/>Token<wbr/>Position<wbr/>Ui<wbr/>Changes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#toString" class="tsd-kind-icon">to<wbr/>String</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="MangoAccount.html#tokensActive" class="tsd-kind-icon">tokens<wbr/>Active</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="MangoAccount.html#from" class="tsd-kind-icon">from</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |