2023-05-13 03:15:07 -07:00
<!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 c
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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" > <
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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.
2023-02-11 06:48:57 -08:00
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 >
2023-05-13 03:15:07 -07:00
< / 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" >
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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" >
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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" >
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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" >
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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" >
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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" >
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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" >
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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" >
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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" >
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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" >
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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 t
2023-02-11 06:48:57 -08:00
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 >
2023-05-13 03:15:07 -07:00
< / 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" > < /pa
< / 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-
< / 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" >
2023-02-11 06:48:57 -08:00
< 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 >
2023-05-13 03:15:07 -07:00
< / 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
