TornadoCash
/
sdk-monorepo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs to reflect 

Signed-off-by: T-Hax <>
This commit is contained in:
T-Hax 2023-05-08 22:08:25 +00:00
parent ae60920ab0
commit a00b91dc38
3 changed files with 16 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/assets/search.js
View File

File diff suppressed because one or more lines are too long

62
docs/api/classes/Core.html
View File

@ -65,8 +65,6 @@
<a href="Core.html#clearListenerByIndex" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>clear<wbr/>Listener<wbr/>By<wbr/>Index</span></a>
<a href="Core.html#clearListeners" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>clear<wbr/>Listeners</span></a>
<a href="Core.html#connect" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>connect</span></a>
<a href="Core.html#createInvoice" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>Invoice</span></a>
<a href="Core.html#createInvoices" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>Invoices</span></a>
<a href="Core.html#emit" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>emit</span></a>
<a href="Core.html#eventNames" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>event<wbr/>Names</span></a>
<a href="Core.html#getInstance" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Instance</span></a>
@ -121,7 +119,7 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_backup<wbr/>Deposit<wbr/>Data</span><a href="#_backupDepositData" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">_backup<wbr/>Deposit<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:111</li></ul></aside></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:109</li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_calcWithdrawalFee" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_calc<wbr/>Withdrawal<wbr/>Fee</span><a href="#_calcWithdrawalFee" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">_calc<wbr/>Withdrawal<wbr/>Fee</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources">
@ -222,7 +220,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">blockDelta</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">blockDivisor</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">cacheAdapter</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">concurrencyLimit</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">listenForEvents</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">msTimeout</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">persistentCache</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">startBlock</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">targetBlock</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<p>Overrides <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#_populateSyncOptions">_populateSyncOptions</a></p>
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:118</li></ul></aside></li></ul></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:116</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addListener" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Listener</span><a href="#addListener" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
@ -268,7 +266,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<h5><span class="tsd-kind-parameter">transaction</span>: <a href="../modules/Transactions.html" class="tsd-signature-type tsd-kind-namespace">Transactions</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Transactions.Deposit.html" class="tsd-signature-type tsd-kind-interface">Deposit</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:108</li></ul></aside></li></ul></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:106</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="backupInvoices" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>backup<wbr/>Invoices</span><a href="#backupInvoices" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures">
@ -283,7 +281,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<h5><span class="tsd-kind-parameter">transactions</span>: <a href="../modules/Transactions.html" class="tsd-signature-type tsd-kind-namespace">Transactions</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Transactions.Deposit.html" class="tsd-signature-type tsd-kind-interface">Deposit</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:110</li></ul></aside></li></ul></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:108</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="backupNote" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>backup<wbr/>Note</span><a href="#backupNote" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures">
@ -298,7 +296,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<h5><span class="tsd-kind-parameter">transaction</span>: <a href="../modules/Transactions.html" class="tsd-signature-type tsd-kind-namespace">Transactions</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Transactions.Deposit.html" class="tsd-signature-type tsd-kind-interface">Deposit</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:107</li></ul></aside></li></ul></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:105</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="backupNotes" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>backup<wbr/>Notes</span><a href="#backupNotes" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures">
@ -313,7 +311,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<h5><span class="tsd-kind-parameter">transactions</span>: <a href="../modules/Transactions.html" class="tsd-signature-type tsd-kind-namespace">Transactions</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Transactions.Deposit.html" class="tsd-signature-type tsd-kind-interface">Deposit</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:109</li></ul></aside></li></ul></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:107</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="buildDepositProof" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>build<wbr/>Deposit<wbr/>Proof</span><a href="#buildDepositProof" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures">
@ -389,7 +387,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<h4 class="tsd-returns-title">Returns <a href="../modules/Transactions.html" class="tsd-signature-type tsd-kind-namespace">Transactions</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Transactions.Deposit.html" class="tsd-signature-type tsd-kind-interface">Deposit</a></h4><p>A promise which resolves to the created transaction.</p>
<aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:98</li></ul></aside></li></ul></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:96</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="buildDepositTransactions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>build<wbr/>Deposit<wbr/>Transactions</span><a href="#buildDepositTransactions" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures">
@ -413,7 +411,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<h4 class="tsd-returns-title">Returns <a href="../modules/Transactions.html" class="tsd-signature-type tsd-kind-namespace">Transactions</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Transactions.Deposit.html" class="tsd-signature-type tsd-kind-interface">Deposit</a><span class="tsd-signature-symbol">[]</span></h4><p>A promise which resolves to the created transactions.</p>
<aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:106</li></ul></aside></li></ul></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:104</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="clearListener" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>clear<wbr/>Listener</span><a href="#clearListener" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures">
@ -475,36 +473,6 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:55</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="createInvoice" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>create<wbr/>Invoice</span><a href="#createInvoice" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="createInvoice.createInvoice-1"><span class="tsd-kind-call-signature">create<wbr/>Invoice</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/Transactions.html" class="tsd-signature-type tsd-kind-namespace">Transactions</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Transactions.Deposit.html" class="tsd-signature-type tsd-kind-interface">Deposit</a><a href="#createInvoice.createInvoice-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">instance</span>: <span class="tsd-signature-type ">TornadoInstance</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/Options.html" class="tsd-signature-type tsd-kind-namespace">Options</a><span class="tsd-signature-symbol">.</span><a href="../modules/Options.Core.html" class="tsd-signature-type tsd-kind-namespace">Core</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Options.Core.Deposit.html" class="tsd-signature-type tsd-kind-interface">Deposit</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;depositsPerInstance&quot;</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../modules/Transactions.html" class="tsd-signature-type tsd-kind-namespace">Transactions</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Transactions.Deposit.html" class="tsd-signature-type tsd-kind-interface">Deposit</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:90</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="createInvoices" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>create<wbr/>Invoices</span><a href="#createInvoices" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="createInvoices.createInvoices-1"><span class="tsd-kind-call-signature">create<wbr/>Invoices</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instances</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/Transactions.html" class="tsd-signature-type tsd-kind-namespace">Transactions</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Transactions.Deposit.html" class="tsd-signature-type tsd-kind-interface">Deposit</a><span class="tsd-signature-symbol">[]</span><a href="#createInvoices.createInvoices-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5><span class="tsd-kind-parameter">instances</span>: <span class="tsd-signature-type ">TornadoInstance</span><span class="tsd-signature-symbol">[]</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../modules/Options.html" class="tsd-signature-type tsd-kind-namespace">Options</a><span class="tsd-signature-symbol">.</span><a href="../modules/Options.Core.html" class="tsd-signature-type tsd-kind-namespace">Core</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Options.Core.Deposit.html" class="tsd-signature-type tsd-kind-interface">Deposit</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../modules/Transactions.html" class="tsd-signature-type tsd-kind-namespace">Transactions</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Transactions.Deposit.html" class="tsd-signature-type tsd-kind-interface">Deposit</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:91</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="emit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
@ -721,7 +689,7 @@ is found in the list of the listeners of the event.</p>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../modules/Network.html" class="tsd-signature-type tsd-kind-namespace">Network</a><span class="tsd-signature-symbol">.</span><a href="../modules/Network.Options.html" class="tsd-signature-type tsd-kind-namespace">Options</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Network.Options.Sync.html" class="tsd-signature-type tsd-kind-interface">Sync</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">C</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:114</li></ul></aside></li></ul></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:112</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="loadDepositCache" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>load<wbr/>Deposit<wbr/>Cache</span><a href="#loadDepositCache" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures">
@ -736,7 +704,7 @@ is found in the list of the listeners of the event.</p>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../modules/Network.html" class="tsd-signature-type tsd-kind-namespace">Network</a><span class="tsd-signature-symbol">.</span><a href="../modules/Network.Options.html" class="tsd-signature-type tsd-kind-namespace">Options</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Network.Options.Sync.html" class="tsd-signature-type tsd-kind-interface">Sync</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="DepositCache.html" class="tsd-signature-type tsd-kind-class">DepositCache</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:112</li></ul></aside></li></ul></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:110</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="loadInstance" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>load<wbr/>Instance</span><a href="#loadInstance" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures">
@ -753,7 +721,7 @@ is found in the list of the listeners of the event.</p>
<h5><span class="tsd-kind-parameter">denomination</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">TornadoInstance</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:115</li></ul></aside></li></ul></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:113</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="loadNotes" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>load<wbr/>Notes</span><a href="#loadNotes" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures">
@ -783,7 +751,7 @@ is found in the list of the listeners of the event.</p>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../modules/Network.html" class="tsd-signature-type tsd-kind-namespace">Network</a><span class="tsd-signature-symbol">.</span><a href="../modules/Network.Options.html" class="tsd-signature-type tsd-kind-namespace">Options</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Network.Options.Sync.html" class="tsd-signature-type tsd-kind-interface">Sync</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="WithdrawalCache.html" class="tsd-signature-type tsd-kind-class">WithdrawalCache</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:113</li></ul></aside></li></ul></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:111</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="off" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
@ -1163,7 +1131,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../modules/Network.html" class="tsd-signature-type tsd-kind-namespace">Network</a><span class="tsd-signature-symbol">.</span><a href="../modules/Network.Options.html" class="tsd-signature-type tsd-kind-namespace">Options</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Network.Options.Sync.html" class="tsd-signature-type tsd-kind-interface">Sync</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:116</li></ul></aside></li></ul></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:114</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="syncWithdrawals" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>sync<wbr/>Withdrawals</span><a href="#syncWithdrawals" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures">
@ -1178,7 +1146,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../modules/Network.html" class="tsd-signature-type tsd-kind-namespace">Network</a><span class="tsd-signature-symbol">.</span><a href="../modules/Network.Options.html" class="tsd-signature-type tsd-kind-namespace">Options</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Network.Options.Sync.html" class="tsd-signature-type tsd-kind-interface">Sync</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in @tornado/sdk-core/build/index.d.ts:117</li></ul></aside></li></ul></section>
<li>Defined in @tornado/sdk-core/build/index.d.ts:115</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getEventListeners" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Event<wbr/>Listeners</span><a href="#getEventListeners" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
@ -1389,8 +1357,6 @@ special handling:</p>
<li><a href="#clearListenerByIndex" class="tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>clear<wbr/>Listener<wbr/>By<wbr/>Index</span></a></li>
<li><a href="#clearListeners" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>clear<wbr/>Listeners</span></a></li>
<li><a href="#connect" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>connect</span></a></li>
<li><a href="#createInvoice" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>Invoice</span></a></li>
<li><a href="#createInvoices" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>Invoices</span></a></li>
<li><a href="#emit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>emit</span></a></li>
<li><a href="#eventNames" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>event<wbr/>Names</span></a></li>
<li><a href="#getInstance" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Instance</span></a></li>

2
docs/api/index.html
View File

@ -13,7 +13,7 @@
<div class="tsd-page-title">
<h2>@tornado/sdk</h2></div>
<div class="tsd-panel tsd-typography"><a id="md:tornado-cash-sdk" class="tsd-anchor"></a><h1><a href="#md:tornado-cash-sdk">Tornado Cash SDK</a></h1><p>SDK to integrate your protocol with Tornado Cash.</p>
<p><a href="./docs/ABOUT.md">Check out the docs here.</a></p>
<p><a href="./docs/ABOUT_LOCAL.md">Check out the local docs here, </a><a href="./docs/ABOUT_WIKI.md">or check out the web version (wiki) here.</a></p>
<p>Contributions are welcome, we are here for freedom after all!</p>
<p>See <a href="./HISTORY.md">HISTORY.md</a> for a development log.</p>
</div></div>