11 lines
20 KiB
HTML
11 lines
20 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@project-serum/serum-dev-tools</title><meta name="description" content="Documentation for @project-serum/serum-dev-tools"/><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">@project-serum/serum-dev-tools</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"><h1>@project-serum/serum-dev-tools </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><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>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/Coin.html" class="tsd-kind-icon">Coin</a></li><li class="tsd-kind-class"><a href="classes/Dex.html" class="tsd-kind-icon">Dex</a></li><li class="tsd-kind-class"><a href="classes/DexMarket.html" class="tsd-kind-icon">Dex<wbr/>Market</a></li><li class="tsd-kind-class"><a href="classes/FileKeypair.html" class="tsd-kind-icon">File<wbr/>Keypair</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/MarketAccounts.html" class="tsd-kind-icon">Market<wbr/>Accounts</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#CrankOpts" class="tsd-kind-icon">Crank<wbr/>Opts</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MarketMakerOpts" class="tsd-kind-icon">Market<wbr/>Maker<wbr/>Opts</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MarketParams" class="tsd-kind-icon">Market<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MessageType" class="tsd-kind-icon">Message<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#OrderType" class="tsd-kind-icon">Order<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SelfTradeBehaviour" class="tsd-kind-icon">Self<wbr/>Trade<wbr/>Behaviour</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TransactionWithSigners" class="tsd-kind-icon">Transaction<wbr/>With<wbr/>Signers</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="CrankOpts" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Crank<wbr/>Opts<a href="#CrankOpts" 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">Crank<wbr/>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>durationInSecs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>verbose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/serum-dev-tools/blob/247d1c0/ts/src/dex.ts#L50">dex.ts:50</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>param durationInSecs</dt><dd><p>The duration in seconds for which the market maker will run.</p>
|
|
</dd><dt>param verbose</dt><dd><p>The boolean flag determining whether to log about the actions taking place.</p>
|
|
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>duration<wbr/>In<wbr/>Secs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>verbose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MarketMakerOpts" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Market<wbr/>Maker<wbr/>Opts<a href="#MarketMakerOpts" 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">Market<wbr/>Maker<wbr/>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>baseGeckoSymbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>durationInSecs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>initialBidSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>orderCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>quoteGeckoSymbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>verbose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/serum-dev-tools/blob/247d1c0/ts/src/dex.ts#L36">dex.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>param durationInSecs</dt><dd><p>The duration in seconds for which the market maker will run.</p>
|
|
</dd><dt>param orderCount</dt><dd><p>The number of orders to place per side in each iteration.</p>
|
|
</dd><dt>param initialBidSize</dt><dd><p>The initial bid size for the market maker.</p>
|
|
</dd><dt>param baseGeckoSymbol</dt><dd><p>The symbol used by CoinGecko for the base coin.</p>
|
|
</dd><dt>param quoteGeckoSymbol</dt><dd><p>The symbol used by CoinGecko for the quote coin.</p>
|
|
</dd><dt>param verbose</dt><dd><p>The boolean flag determining whether to log about the actions taking place.</p>
|
|
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>base<wbr/>Gecko<wbr/>Symbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>duration<wbr/>In<wbr/>Secs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>initial<wbr/>Bid<wbr/>Size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>order<wbr/>Count<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>quote<wbr/>Gecko<wbr/>Symbol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>verbose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MarketParams" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Market<wbr/>Params<a href="#MarketParams" 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">Market<wbr/>Params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>lotSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tickSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/serum-dev-tools/blob/247d1c0/ts/src/dex.ts#L21">dex.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>param lotSize</dt><dd><p>This is the smallest representable amount of the base coin .</p>
|
|
</dd><dt>param tickSize</dt><dd><p>This is the smallest representable amount of the quote coin.</p>
|
|
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>lot<wbr/>Size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>tick<wbr/>Size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MessageType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Message<wbr/>Type<a href="#MessageType" 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">Message<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"start"</span><span class="tsd-signature-symbol">; </span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/serum-dev-tools/blob/247d1c0/ts/src/types.ts#L14">types.ts:14</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"start"</span></h5></li><li class="tsd-parameter"><h5>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><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> <span class="tsd-signature-type">"limit"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ioc"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"postOnly"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/serum-dev-tools/blob/247d1c0/ts/src/types.ts#L8">types.ts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SelfTradeBehaviour" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Self<wbr/>Trade<wbr/>Behaviour<a href="#SelfTradeBehaviour" 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">Self<wbr/>Trade<wbr/>Behaviour<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"decrementTake"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"cancelProvide"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"abortTransaction"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/serum-dev-tools/blob/247d1c0/ts/src/types.ts#L9">types.ts:9</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="TransactionWithSigners" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Transaction<wbr/>With<wbr/>Signers<a href="#TransactionWithSigners" 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">Transaction<wbr/>With<wbr/>Signers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>signers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/project-serum/serum-dev-tools/blob/247d1c0/ts/src/types.ts#L3">types.ts:3</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>signers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Signer</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5>transaction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Transaction</span></h5></li></ul></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class"><a href="classes/Coin.html" class="tsd-kind-icon">Coin</a></li><li class="tsd-kind-class"><a href="classes/Dex.html" class="tsd-kind-icon">Dex</a></li><li class="tsd-kind-class"><a href="classes/DexMarket.html" class="tsd-kind-icon">Dex<wbr/>Market</a></li><li class="tsd-kind-class"><a href="classes/FileKeypair.html" class="tsd-kind-icon">File<wbr/>Keypair</a></li><li class="tsd-kind-interface"><a href="interfaces/MarketAccounts.html" class="tsd-kind-icon">Market<wbr/>Accounts</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CrankOpts" class="tsd-kind-icon">Crank<wbr/>Opts</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MarketMakerOpts" class="tsd-kind-icon">Market<wbr/>Maker<wbr/>Opts</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MarketParams" class="tsd-kind-icon">Market<wbr/>Params</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MessageType" class="tsd-kind-icon">Message<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#OrderType" class="tsd-kind-icon">Order<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SelfTradeBehaviour" class="tsd-kind-icon">Self<wbr/>Trade<wbr/>Behaviour</a></li><li class="tsd-kind-type-alias"><a href="modules.html#TransactionWithSigners" class="tsd-kind-icon">Transaction<wbr/>With<wbr/>Signers</a></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></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></ul><ul class="tsd-legend"><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> |