1 line
34 KiB
HTML
1 line
34 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PerpOrder | @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="PerpOrder.html">PerpOrder</a></li></ul><h1>Class PerpOrder</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">PerpOrder</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="PerpOrder.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="PerpOrder.html#expiryTimestamp" class="tsd-kind-icon">expiry<wbr/>Timestamp</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#feeTier" class="tsd-kind-icon">fee<wbr/>Tier</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#isExpired" class="tsd-kind-icon">is<wbr/>Expired</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#isOraclePegged" class="tsd-kind-icon">is<wbr/>Oracle<wbr/>Pegged</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#openOrdersSlot" class="tsd-kind-icon">open<wbr/>Orders<wbr/>Slot</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#oraclePeggedProperties" class="tsd-kind-icon">oracle<wbr/>Pegged<wbr/>Properties</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#orderId" class="tsd-kind-icon">order<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#orderType" class="tsd-kind-icon">order<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#owner" class="tsd-kind-icon">owner</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#perpMarketIndex" class="tsd-kind-icon">perp<wbr/>Market<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#priceLots" class="tsd-kind-icon">price<wbr/>Lots</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#seqNum" class="tsd-kind-icon">seq<wbr/>Num</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#side" class="tsd-kind-icon">side</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#sizeLots" class="tsd-kind-icon">size<wbr/>Lots</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#timestamp" class="tsd-kind-icon">timestamp</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#uiPrice" class="tsd-kind-icon">ui<wbr/>Price</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#uiSize" class="tsd-kind-icon">ui<wbr/>Size</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="PerpOrder.html#price" class="tsd-kind-icon">price</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="PerpOrder.html#size" class="tsd-kind-icon">size</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 tsd-is-static"><a href="PerpOrder.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/>Perp<wbr/>Order<span class="tsd-signature-symbol">(</span>seqNum<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, orderId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, owner<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PublicKey</span>, openOrdersSlot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, feeTier<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">0</span>, uiPrice<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, priceLots<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, uiSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, sizeLots<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, side<span class="tsd-signature-symbol">: </span><a href="PerpOrderSide.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOrderSide</a>, timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, expiryTimestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BN</span>, perpMarketIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, isExpired<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, isOraclePegged<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, orderType<span class="tsd-signature-symbol">: </span><a href="PerpOrderType.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOrderType</a>, oraclePeggedProperties<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">OraclePeggedProperties</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PerpOrder.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOrder</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/perp.ts#L937">accounts/perp.ts:937</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>seqNum: <span class="tsd-signature-type">BN</span></h5></li><li><h5>orderId: <span class="tsd-signature-type">BN</span></h5></li><li><h5>owner: <span class="tsd-signature-type">PublicKey</span></h5></li><li><h5>openOrdersSlot: <span class="tsd-signature-type">number</span></h5></li><li><h5>feeTier: <span class="tsd-signature-type">0</span></h5></li><li><h5>uiPrice: <span class="tsd-signature-type">number</span></h5></li><li><h5>priceLots: <span class="tsd-signature-type">BN</span></h5></li><li><h5>uiSize: <span class="tsd-signature-type">number</span></h5></li><li><h5>sizeLots: <span class="tsd-signature-type">BN</span></h5></li><li><h5>side: <a href="PerpOrderSide.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOrderSide</a></h5></li><li><h5>timestamp: <span class="tsd-signature-type">BN</span></h5></li><li><h5>expiryTimestamp: <span class="tsd-signature-type">BN</span></h5></li><li><h5>perpMarketIndex: <span class="tsd-signature-type">number</span></h5></li><li><h5>isExpired: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li><li><h5>isOraclePegged: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li><li><h5>orderType: <a href="PerpOrderType.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOrderType</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> oraclePeggedProperties: <span class="tsd-signature-type">OraclePeggedProperties</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="PerpOrder.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOrder</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="expiryTimestamp" class="tsd-anchor"></a><h3 class="tsd-anchor-link">expiry<wbr/>Timestamp<a href="#expiryTimestamp" 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">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="feeTier" class="tsd-anchor"></a><h3 class="tsd-anchor-link">fee<wbr/>Tier<a href="#feeTier" 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">fee<wbr/>Tier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="isExpired" class="tsd-anchor"></a><h3 class="tsd-anchor-link">is<wbr/>Expired<a href="#isExpired" 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">is<wbr/>Expired<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="isOraclePegged" class="tsd-anchor"></a><h3 class="tsd-anchor-link">is<wbr/>Oracle<wbr/>Pegged<a href="#isOraclePegged" 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">is<wbr/>Oracle<wbr/>Pegged<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="openOrdersSlot" class="tsd-anchor"></a><h3 class="tsd-anchor-link">open<wbr/>Orders<wbr/>Slot<a href="#openOrdersSlot" 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">open<wbr/>Orders<wbr/>Slot<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="oraclePeggedProperties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> oracle<wbr/>Pegged<wbr/>Properties<a href="#oraclePeggedProperties" 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">oracle<wbr/>Pegged<wbr/>Properties<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">OraclePeggedProperties</span></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="orderId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">order<wbr/>Id<a href="#orderId" 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">order<wbr/>Id<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="orderType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">order<wbr/>Type<a href="#orderType" 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">order<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="PerpOrderType.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOrderType</a></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="perpMarketIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link">perp<wbr/>Market<wbr/>Index<a href="#perpMarketIndex" 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/>Market<wbr/>Index<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="priceLots" class="tsd-anchor"></a><h3 class="tsd-anchor-link">price<wbr/>Lots<a href="#priceLots" 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">price<wbr/>Lots<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="seqNum" class="tsd-anchor"></a><h3 class="tsd-anchor-link">seq<wbr/>Num<a href="#seqNum" 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">seq<wbr/>Num<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="side" class="tsd-anchor"></a><h3 class="tsd-anchor-link">side<a href="#side" 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">side<span class="tsd-signature-symbol">:</span> <a href="PerpOrderSide.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOrderSide</a></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="sizeLots" class="tsd-anchor"></a><h3 class="tsd-anchor-link">size<wbr/>Lots<a href="#sizeLots" 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">size<wbr/>Lots<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="timestamp" class="tsd-anchor"></a><h3 class="tsd-anchor-link">timestamp<a href="#timestamp" 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">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="uiPrice" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ui<wbr/>Price<a href="#uiPrice" 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">ui<wbr/>Price<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="uiSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ui<wbr/>Size<a href="#uiSize" 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">ui<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="price" class="tsd-anchor"></a><h3 class="tsd-anchor-link">price<a href="#price" 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-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> price<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/perp.ts#L957">accounts/perp.ts:957</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-get-signature tsd-parent-kind-class"><a id="size" class="tsd-anchor"></a><h3 class="tsd-anchor-link">size<a href="#size" 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-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> size<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/perp.ts#L961">accounts/perp.ts:961</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></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 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>perpMarket<span class="tsd-signature-symbol">: </span><a href="PerpMarket.html" class="tsd-signature-type" data-tsd-kind="Class">PerpMarket</a>, leafNode<span class="tsd-signature-symbol">: </span><a href="LeafNode.html" class="tsd-signature-type" data-tsd-kind="Class">LeafNode</a>, type<span class="tsd-signature-symbol">: </span><a href="BookSideType.html" class="tsd-signature-type" data-tsd-kind="Class">BookSideType</a>, isExpired<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, isOraclePegged<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><a href="PerpOrder.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOrder</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/perp.ts#L881">accounts/perp.ts:881</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><li><h5>leafNode: <a href="LeafNode.html" class="tsd-signature-type" data-tsd-kind="Class">LeafNode</a></h5></li><li><h5>type: <a href="BookSideType.html" class="tsd-signature-type" data-tsd-kind="Class">BookSideType</a></h5></li><li><h5>isExpired: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li><li><h5>isOraclePegged: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="PerpOrder.html" class="tsd-signature-type" data-tsd-kind="Class">PerpOrder</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="PerpOrder.html" class="tsd-kind-icon">Perp<wbr/>Order</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="PerpOrder.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#expiryTimestamp" class="tsd-kind-icon">expiry<wbr/>Timestamp</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#feeTier" class="tsd-kind-icon">fee<wbr/>Tier</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#isExpired" class="tsd-kind-icon">is<wbr/>Expired</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#isOraclePegged" class="tsd-kind-icon">is<wbr/>Oracle<wbr/>Pegged</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#openOrdersSlot" class="tsd-kind-icon">open<wbr/>Orders<wbr/>Slot</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#oraclePeggedProperties" class="tsd-kind-icon">oracle<wbr/>Pegged<wbr/>Properties</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#orderId" class="tsd-kind-icon">order<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#orderType" class="tsd-kind-icon">order<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#owner" class="tsd-kind-icon">owner</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#perpMarketIndex" class="tsd-kind-icon">perp<wbr/>Market<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#priceLots" class="tsd-kind-icon">price<wbr/>Lots</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#seqNum" class="tsd-kind-icon">seq<wbr/>Num</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#side" class="tsd-kind-icon">side</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#sizeLots" class="tsd-kind-icon">size<wbr/>Lots</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#timestamp" class="tsd-kind-icon">timestamp</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#uiPrice" class="tsd-kind-icon">ui<wbr/>Price</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="PerpOrder.html#uiSize" class="tsd-kind-icon">ui<wbr/>Size</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="PerpOrder.html#price" class="tsd-kind-icon">price</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="PerpOrder.html#size" class="tsd-kind-icon">size</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="PerpOrder.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> |