1686 lines
311 KiB
HTML
1686 lines
311 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Core | @tornado/sdk</title><meta name="description" content="Documentation for @tornado/sdk"/><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 defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
||
<div class="tsd-toolbar-contents container">
|
||
<div class="table-cell" id="tsd-search" data-base="..">
|
||
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
||
<div class="field">
|
||
<div id="tsd-toolbar-links"></div></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">@tornado/sdk</a></div>
|
||
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
||
<div class="container container-main">
|
||
<div class="col-content">
|
||
<div class="tsd-page-title">
|
||
<ul class="tsd-breadcrumb">
|
||
<li><a href="../modules.html">@tornado/sdk</a></li>
|
||
<li><a href="Core.html">Core</a></li></ul>
|
||
<h1>Class Core</h1></div>
|
||
<section class="tsd-panel tsd-hierarchy">
|
||
<h4>Hierarchy</h4>
|
||
<ul class="tsd-hierarchy">
|
||
<li><a href="Network.Synchronizer.html" class="tsd-signature-type tsd-kind-class">Synchronizer</a>
|
||
<ul class="tsd-hierarchy">
|
||
<li><span class="target">Core</span></li></ul></li></ul></section><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:49</li></ul></aside>
|
||
<section class="tsd-panel-group tsd-index-group">
|
||
<section class="tsd-panel tsd-index-panel">
|
||
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
||
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
|
||
<div class="tsd-accordion-details">
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Constructors</h3>
|
||
<div class="tsd-index-list"><a href="Core.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-512-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-512-text"></path></svg><span>constructor</span></a>
|
||
</div></section>
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Properties</h3>
|
||
<div class="tsd-index-list"><a href="Core.html#_backupDepositData" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>_backup<wbr/>Deposit<wbr/>Data</span></a>
|
||
<a href="Core.html#_calcWithdrawalFee" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_calc<wbr/>Withdrawal<wbr/>Fee</span></a>
|
||
<a href="Core.html#_chain" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_chain?</span></a>
|
||
<a href="Core.html#_checkProvider" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_check<wbr/>Provider</span></a>
|
||
<a href="Core.html#_findLeavesAndIndices" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_find<wbr/>Leaves<wbr/>And<wbr/>Indices</span></a>
|
||
<a href="Core.html#_instanceEventToFilter" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_instance<wbr/>Event<wbr/>To<wbr/>Filter</span></a>
|
||
<a href="Core.html#_mutex" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_mutex</span></a>
|
||
<a href="Core.html#_resolveInstance" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_resolve<wbr/>Instance</span></a>
|
||
<a href="Core.html#_resolveInstanceEvent" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_resolve<wbr/>Instance<wbr/>Event</span></a>
|
||
<a href="Core.html#caches" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>caches</span></a>
|
||
<a href="Core.html#captureRejectionSymbol" 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-1024-path"></use><use href="#icon-1024-text"></use></svg><span>capture<wbr/>Rejection<wbr/>Symbol</span></a>
|
||
<a href="Core.html#captureRejections" 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-1024-path"></use><use href="#icon-1024-text"></use></svg><span>capture<wbr/>Rejections</span></a>
|
||
<a href="Core.html#defaultMaxListeners" 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-1024-path"></use><use href="#icon-1024-text"></use></svg><span>default<wbr/>Max<wbr/>Listeners</span></a>
|
||
<a href="Core.html#errorMonitor" 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-1024-path"></use><use href="#icon-1024-text"></use></svg><span>error<wbr/>Monitor</span></a>
|
||
</div></section>
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Accessors</h3>
|
||
<div class="tsd-index-list"><a href="Core.html#chain" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-262144-path"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)" id="icon-262144-text"></path></svg><span>chain</span></a>
|
||
</div></section>
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Methods</h3>
|
||
<div class="tsd-index-list"><a href="Core.html#_populateSyncOptions" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>_populate<wbr/>Sync<wbr/>Options</span></a>
|
||
<a href="Core.html#addListener" 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>add<wbr/>Listener</span></a>
|
||
<a href="Core.html#backupInvoice" 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>backup<wbr/>Invoice</span></a>
|
||
<a href="Core.html#backupInvoices" 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>backup<wbr/>Invoices</span></a>
|
||
<a href="Core.html#backupNote" 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>backup<wbr/>Note</span></a>
|
||
<a href="Core.html#backupNotes" 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>backup<wbr/>Notes</span></a>
|
||
<a href="Core.html#clearListener" 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/>Listener</span></a>
|
||
<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#createDepositProof" 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/>Deposit<wbr/>Proof</span></a>
|
||
<a href="Core.html#createDepositProofs" 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/>Deposit<wbr/>Proofs</span></a>
|
||
<a href="Core.html#createDepositTransaction" 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/>Deposit<wbr/>Transaction</span></a>
|
||
<a href="Core.html#createDepositTransactions" 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/>Deposit<wbr/>Transactions</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#exportCacheZip" 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>export<wbr/>Cache<wbr/>Zip</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>
|
||
<a href="Core.html#getInstances" 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/>Instances</span></a>
|
||
<a href="Core.html#getMaxListeners" 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>get<wbr/>Max<wbr/>Listeners</span></a>
|
||
<a href="Core.html#getProxy" 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/>Proxy</span></a>
|
||
<a href="Core.html#listenForDeposits" 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>listen<wbr/>For<wbr/>Deposits</span></a>
|
||
<a href="Core.html#listenForEvents" 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>listen<wbr/>For<wbr/>Events</span></a>
|
||
<a href="Core.html#listenForInstanceEvents" 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>listen<wbr/>For<wbr/>Instance<wbr/>Events</span></a>
|
||
<a href="Core.html#listenForWithdrawals" 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>listen<wbr/>For<wbr/>Withdrawals</span></a>
|
||
<a href="Core.html#listenerCount" 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>listener<wbr/>Count</span></a>
|
||
<a href="Core.html#listeners" 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>listeners</span></a>
|
||
<a href="Core.html#loadCache" 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>load<wbr/>Cache</span></a>
|
||
<a href="Core.html#loadDepositCache" 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>load<wbr/>Deposit<wbr/>Cache</span></a>
|
||
<a href="Core.html#loadInstance" 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>load<wbr/>Instance</span></a>
|
||
<a href="Core.html#loadNotes" 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>load<wbr/>Notes</span></a>
|
||
<a href="Core.html#loadWithdrawalCache" 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>load<wbr/>Withdrawal<wbr/>Cache</span></a>
|
||
<a href="Core.html#off" 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>off</span></a>
|
||
<a href="Core.html#on" 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>on</span></a>
|
||
<a href="Core.html#once" 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>once</span></a>
|
||
<a href="Core.html#parseNote" 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>parse<wbr/>Note</span></a>
|
||
<a href="Core.html#parseNotes" 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>parse<wbr/>Notes</span></a>
|
||
<a href="Core.html#prependListener" 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>prepend<wbr/>Listener</span></a>
|
||
<a href="Core.html#prependOnceListener" 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>prepend<wbr/>Once<wbr/>Listener</span></a>
|
||
<a href="Core.html#rawListeners" 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>raw<wbr/>Listeners</span></a>
|
||
<a href="Core.html#removeAllListeners" 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>remove<wbr/>All<wbr/>Listeners</span></a>
|
||
<a href="Core.html#removeListener" 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>remove<wbr/>Listener</span></a>
|
||
<a href="Core.html#setMaxListeners" 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>set<wbr/>Max<wbr/>Listeners</span></a>
|
||
<a href="Core.html#sync" 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>sync</span></a>
|
||
<a href="Core.html#syncDeposits" 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>sync<wbr/>Deposits</span></a>
|
||
<a href="Core.html#syncWithdrawals" 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>sync<wbr/>Withdrawals</span></a>
|
||
<a href="Core.html#getEventListeners" 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>get<wbr/>Event<wbr/>Listeners</span></a>
|
||
<a href="Core.html#listenerCount-2" 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>listener<wbr/>Count</span></a>
|
||
<a href="Core.html#on-2" 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>on</span></a>
|
||
<a href="Core.html#once-2" 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>once</span></a>
|
||
<a href="Core.html#setMaxListeners-2" 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>set<wbr/>Max<wbr/>Listeners</span></a>
|
||
</div></section></div></details></section></section>
|
||
<section class="tsd-panel-group tsd-member-group">
|
||
<h2>Constructors</h2>
|
||
<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
|
||
<ul class="tsd-signatures">
|
||
<li class="tsd-signature tsd-anchor-link" id="constructor.new_Core"><span class="tsd-kind-constructor-signature">new <wbr/>Core</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a><a href="#constructor.new_Core" 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">
|
||
<h4 class="tsd-returns-title">Returns <a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a></h4><aside class="tsd-sources">
|
||
<p>Overrides <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#constructor">constructor</a></p>
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:54</li></ul></aside></li></ul></section></section>
|
||
<section class="tsd-panel-group tsd-member-group">
|
||
<h2>Properties</h2>
|
||
<section class="tsd-panel tsd-member tsd-is-private"><a id="_backupDepositData" class="tsd-anchor"></a>
|
||
<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/dist/index.d.ts:110</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">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:73</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-private"><a id="_chain" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>_chain</span><a href="#_chain" 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">_chain</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/dist/index.d.ts:51</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-private"><a id="_checkProvider" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_check<wbr/>Provider</span><a href="#_checkProvider" 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">_check<wbr/>Provider</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/dist/index.d.ts:55</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-private"><a id="_findLeavesAndIndices" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_find<wbr/>Leaves<wbr/>And<wbr/>Indices</span><a href="#_findLeavesAndIndices" 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">_find<wbr/>Leaves<wbr/>And<wbr/>Indices</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h3>Param</h3><p>The name of the instance as created in <code>_sync</code> function.</p>
|
||
|
||
<h3>Param</h3><p>The commitments for which the leaf index values are to be noted down extra.</p>
|
||
|
||
<h3>Returns</h3><p>The result of concatenating the array of leaf indices found by matching them with the provided commitment values, followed by the array of all leaf indices, including all of the formerly mentioned values given that they are valid. Values which have not been matched, meaning probably invalid values, will be <code>0</code>.</p>
|
||
</div><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:79</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-private"><a id="_instanceEventToFilter" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_instance<wbr/>Event<wbr/>To<wbr/>Filter</span><a href="#_instanceEventToFilter" 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">_instance<wbr/>Event<wbr/>To<wbr/>Filter</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/dist/index.d.ts:88</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-private"><a id="_mutex" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_mutex</span><a href="#_mutex" 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">_mutex</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/dist/index.d.ts:50</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-private"><a id="_resolveInstance" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_resolve<wbr/>Instance</span><a href="#_resolveInstance" 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">_resolve<wbr/>Instance</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/dist/index.d.ts:90</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-private"><a id="_resolveInstanceEvent" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>_resolve<wbr/>Instance<wbr/>Event</span><a href="#_resolveInstanceEvent" 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">_resolve<wbr/>Instance<wbr/>Event</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/dist/index.d.ts:89</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member"><a id="caches" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>caches</span><a href="#caches" 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">caches</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../modules/Data.html" class="tsd-signature-type tsd-kind-namespace">Data</a><span class="tsd-signature-symbol">.</span><a href="../modules/Data.Cache.html" class="tsd-signature-type tsd-kind-namespace">Cache</a><span class="tsd-signature-symbol">.</span><a href="Data.Cache.Base.html" class="tsd-signature-type tsd-kind-class">Base</a><span class="tsd-signature-symbol"><</span><a href="../modules/Data.html" class="tsd-signature-type tsd-kind-namespace">Data</a><span class="tsd-signature-symbol">.</span><a href="../modules/Data.Docs.html" class="tsd-signature-type tsd-kind-namespace">Docs</a><span class="tsd-signature-symbol">.</span><a href="Data.Docs.Base.html" class="tsd-signature-type tsd-kind-class">Base</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:52</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>capture<wbr/>Rejection<wbr/>Symbol</span><a href="#captureRejectionSymbol" 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">capture<wbr/>Rejection<wbr/>Symbol</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="Network.Synchronizer.html#captureRejectionSymbol" class="tsd-signature-type tsd-kind-property">captureRejectionSymbol</a></div><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#captureRejectionSymbol">captureRejectionSymbol</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:328</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureRejections" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Rejections</span><a href="#captureRejections" 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">capture<wbr/>Rejections</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||
<div class="tsd-comment tsd-typography"><p>Sets or gets the default captureRejection value for all emitters.</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#captureRejections">captureRejections</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:333</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="defaultMaxListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>default<wbr/>Max<wbr/>Listeners</span><a href="#defaultMaxListeners" 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">default<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#defaultMaxListeners">defaultMaxListeners</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:334</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="errorMonitor" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>error<wbr/>Monitor</span><a href="#errorMonitor" 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">error<wbr/>Monitor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="Network.Synchronizer.html#errorMonitor" class="tsd-signature-type tsd-kind-property">errorMonitor</a></div>
|
||
<div class="tsd-comment tsd-typography"><p>This symbol shall be used to install a listener for only monitoring <code>'error'</code>
|
||
events. Listeners installed using this symbol are called before the regular
|
||
<code>'error'</code> listeners are called.</p>
|
||
<p>Installing a listener using this symbol does not change the behavior once an
|
||
<code>'error'</code> event is emitted, therefore the process will still crash if no
|
||
regular <code>'error'</code> listener is installed.</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#errorMonitor">errorMonitor</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:327</li></ul></aside></section></section>
|
||
<section class="tsd-panel-group tsd-member-group">
|
||
<h2>Accessors</h2>
|
||
<section class="tsd-panel tsd-member"><a id="chain" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>chain</span><a href="#chain" 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" id="chain.chain-1"><span class="tsd-signature-symbol">get</span> chain<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Network.Chain.html" class="tsd-signature-type tsd-kind-class">Chain</a></li>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <a href="Network.Chain.html" class="tsd-signature-type tsd-kind-class">Chain</a></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:53</li></ul></aside></li></ul></section></section>
|
||
<section class="tsd-panel-group tsd-member-group">
|
||
<h2>Methods</h2>
|
||
<section class="tsd-panel tsd-member tsd-is-protected"><a id="_populateSyncOptions" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_populate<wbr/>Sync<wbr/>Options</span><a href="#_populateSyncOptions" 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-protected">
|
||
<li class="tsd-signature tsd-anchor-link" id="_populateSyncOptions._populateSyncOptions-1"><span class="tsd-kind-call-signature">_populate<wbr/>Sync<wbr/>Options</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-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">></span><a href="#_populateSyncOptions._populateSyncOptions-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">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"><</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">></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/dist/index.d.ts:118</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">
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-1"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a><a href="#addListener.addListener-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-comment tsd-typography"><p>Alias for <code>emitter.on(eventName, listener)</code>.</p>
|
||
|
||
<h3>Since</h3><p>v0.1.26</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#addListener">addListener</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:354</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="backupInvoice" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>backup<wbr/>Invoice</span><a href="#backupInvoice" 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="backupInvoice.backupInvoice-1"><span class="tsd-kind-call-signature">backup<wbr/>Invoice</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span>, <span class="tsd-kind-parameter">transaction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#backupInvoice.backupInvoice-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><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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:107</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">
|
||
<li class="tsd-signature tsd-anchor-link" id="backupInvoices.backupInvoices-1"><span class="tsd-kind-call-signature">backup<wbr/>Invoices</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span>, <span class="tsd-kind-parameter">transactions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#backupInvoices.backupInvoices-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><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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:109</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">
|
||
<li class="tsd-signature tsd-anchor-link" id="backupNote.backupNote-1"><span class="tsd-kind-call-signature">backup<wbr/>Note</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span>, <span class="tsd-kind-parameter">transaction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#backupNote.backupNote-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><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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:106</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">
|
||
<li class="tsd-signature tsd-anchor-link" id="backupNotes.backupNotes-1"><span class="tsd-kind-call-signature">backup<wbr/>Notes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span>, <span class="tsd-kind-parameter">transactions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#backupNotes.backupNotes-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><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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:108</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">
|
||
<li class="tsd-signature tsd-anchor-link" id="clearListener.clearListener-1"><span class="tsd-kind-call-signature">clear<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span>, <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">listenerIndex</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#clearListener.clearListener-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">string</span><span class="tsd-signature-symbol"> | </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">event</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Function</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">listenerIndex</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:83</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="clearListenerByIndex" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>clear<wbr/>Listener<wbr/>By<wbr/>Index</span><a href="#clearListenerByIndex" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="clearListenerByIndex.clearListenerByIndex-1"><span class="tsd-kind-call-signature">clear<wbr/>Listener<wbr/>By<wbr/>Index</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contract</span>, <span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listenerIndex</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#clearListenerByIndex.clearListenerByIndex-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">contract</span>: <span class="tsd-signature-type ">BaseContract</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type ">EventFilter</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">listenerIndex</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#clearListenerByIndex">clearListenerByIndex</a></p>
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:64</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="clearListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>clear<wbr/>Listeners</span><a href="#clearListeners" 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="clearListeners.clearListeners-1"><span class="tsd-kind-call-signature">clear<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#clearListeners.clearListeners-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">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">TornadoInstance</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:84</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="connect" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>connect</span><a href="#connect" 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="connect.connect-1"><span class="tsd-kind-call-signature">connect</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">provider</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#connect.connect-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">provider</span>: <span class="tsd-signature-type ">Provider</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:56</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="createDepositProof" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>create<wbr/>Deposit<wbr/>Proof</span><a href="#createDepositProof" 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="createDepositProof.createDepositProof-1"><span class="tsd-kind-call-signature">create<wbr/>Deposit<wbr/>Proof</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span>, <span class="tsd-kind-parameter">relayerProperties</span>, <span class="tsd-kind-parameter">recipientAddress</span>, <span class="tsd-kind-parameter">depositInfo</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><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#createDepositProof.createDepositProof-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><span class="tsd-kind-parameter">relayerProperties</span>: <span class="tsd-signature-type ">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Data.RelayerProperties.html" class="tsd-signature-type tsd-kind-interface">RelayerProperties</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"address"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"serviceFeePercent"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"prices"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"serviceFeePercent"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"prices"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Data.RelayerProperties.html" class="tsd-signature-type tsd-kind-interface">RelayerProperties</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"address"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"serviceFeePercent"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"prices"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"serviceFeePercent"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"prices"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">recipientAddress</span>: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">depositInfo</span>: <a href="../modules/Crypto.html" class="tsd-signature-type tsd-kind-namespace">Crypto</a><span class="tsd-signature-symbol">.</span><a href="../modules/Crypto.OutputOf.html" class="tsd-signature-type tsd-kind-namespace">OutputOf</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Crypto.OutputOf.CreateDeposit.html" class="tsd-signature-type tsd-kind-interface">CreateDeposit</a></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Options.Core.BuildDepositProof.html" class="tsd-signature-type tsd-kind-interface">BuildDepositProof</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:63</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="createDepositProofs" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>create<wbr/>Deposit<wbr/>Proofs</span><a href="#createDepositProofs" 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="createDepositProofs.createDepositProofs-1"><span class="tsd-kind-call-signature">create<wbr/>Deposit<wbr/>Proofs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span>, <span class="tsd-kind-parameter">relayerProperties</span>, <span class="tsd-kind-parameter">recipientAddresses</span>, <span class="tsd-kind-parameter">depositInfo</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><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#createDepositProofs.createDepositProofs-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-comment tsd-typography"></div>
|
||
<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>
|
||
<div class="tsd-comment tsd-typography"><p>This is the Tornado Instance which will be withdrawn from.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">relayerProperties</span>: <span class="tsd-signature-type ">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Data.RelayerProperties.html" class="tsd-signature-type tsd-kind-interface">RelayerProperties</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"address"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"serviceFeePercent"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"prices"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"serviceFeePercent"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"prices"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type ">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Data.RelayerProperties.html" class="tsd-signature-type tsd-kind-interface">RelayerProperties</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"address"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"serviceFeePercent"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"prices"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"serviceFeePercent"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"prices"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The properties of the relayer that is going to be used for the withdrawals. If the service fee is 0, it is assumed that there is no relayer, but that a manual wallet withdraw is being made. These properties are included in the ZK proof.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">recipientAddresses</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The recipient addresses which should receive the withdrawals, in order.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">depositInfo</span>: <a href="../modules/Crypto.html" class="tsd-signature-type tsd-kind-namespace">Crypto</a><span class="tsd-signature-symbol">.</span><a href="../modules/Crypto.OutputOf.html" class="tsd-signature-type tsd-kind-namespace">OutputOf</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Crypto.OutputOf.CreateDeposit.html" class="tsd-signature-type tsd-kind-interface">CreateDeposit</a><span class="tsd-signature-symbol">[]</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>These represent the public and private values, reconstructed from the deposit note, generated during the building of deposit transactions, used for building the proof of knowledge statement for withdrawal, for each withdrawal (in this context).</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Options.Core.BuildDepositProof.html" class="tsd-signature-type tsd-kind-interface">BuildDepositProof</a></h5>
|
||
<div class="tsd-comment tsd-typography"><p>Numerous options which most importantly allow a user to specify whether he is buying ETH, whether to check proof data validity and finally to modulate the gas prices which will be used to calculate the gas fees paid to the relayer.</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The proofs for which the user should then decide whether to use a relayer (recommended, but decide carefully which one) or use his own wallet (if needed).</p>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:72</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="createDepositTransaction" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>create<wbr/>Deposit<wbr/>Transaction</span><a href="#createDepositTransaction" 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="createDepositTransaction.createDepositTransaction-1"><span class="tsd-kind-call-signature">create<wbr/>Deposit<wbr/>Transaction</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="#createDepositTransaction.createDepositTransaction-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-comment tsd-typography"><p>This is the main function to build a single Tornado Cash Classic deposit. An address need not be supplied because the returned note proves a deposit.</p>
|
||
</div>
|
||
<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>
|
||
<div class="tsd-comment tsd-typography"><p>The TornadoInstance for which to build transactions.</p>
|
||
</div></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>
|
||
<div class="tsd-comment tsd-typography"><p>Whether or not to populate the transactions (only in the sense of encoding transaction data), and whether to backup notes and invoices. Defaults: <code>depositsPerInstance = [1], doNotPopulate = false, backup { notes = true, invoices = false }</code> Deposits per instance are hardcoded to 1, since we're doing a single transaction.</p>
|
||
</div></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><p>A promise which resolves to the created transaction.</p>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:97</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="createDepositTransactions" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>create<wbr/>Deposit<wbr/>Transactions</span><a href="#createDepositTransactions" 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="createDepositTransactions.createDepositTransactions-1"><span class="tsd-kind-call-signature">create<wbr/>Deposit<wbr/>Transactions</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="#createDepositTransactions.createDepositTransactions-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-comment tsd-typography"><p>This is the main function which is used to build Tornado Cash Classic deposit transactions. An address need not be supplied because the returned note proves a deposit.</p>
|
||
|
||
<h3>Todo</h3><p>TODO: Maybe this should be sync and deposit backups should be async somewhere else</p>
|
||
</div>
|
||
<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>
|
||
<div class="tsd-comment tsd-typography"><p>The TornadoInstance instances for which to build transactions.</p>
|
||
</div></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>
|
||
<div class="tsd-comment tsd-typography"><p>The number of deposits per instance, whether or not to populate the transactions (only in the sense of encoding transaction data), and whether to backup notes and invoices. Defaults: <code>depositsPerInstance = [1]*instance_num, doNotPopulate = false, backup { notes = true, invoices = false }</code></p>
|
||
</div></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><p>A promise which resolves to the created transactions.</p>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:105</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">
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-1"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-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-comment tsd-typography"><p>Synchronously calls each of the listeners registered for the event named<code>eventName</code>, in the order they were registered, passing the supplied arguments
|
||
to each.</p>
|
||
<p>Returns <code>true</code> if the event had listeners, <code>false</code> otherwise.</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1"> = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEmitter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-7">// First listener</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-5">firstListener</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'Helloooo! first listener'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-7">// Second listener</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-5">secondListener</span><span class="hl-1">(</span><span class="hl-0">arg1</span><span class="hl-1">, </span><span class="hl-0">arg2</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">`event with parameters </span><span class="hl-3">${</span><span class="hl-0">arg1</span><span class="hl-3">}</span><span class="hl-6">, </span><span class="hl-3">${</span><span class="hl-0">arg2</span><span class="hl-3">}</span><span class="hl-6"> in second listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-7">// Third listener</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-5">thirdListener</span><span class="hl-1">(...</span><span class="hl-0">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">parameters</span><span class="hl-1"> = </span><span class="hl-0">args</span><span class="hl-1">.</span><span class="hl-5">join</span><span class="hl-1">(</span><span class="hl-6">', '</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">`event with parameters </span><span class="hl-3">${</span><span class="hl-0">parameters</span><span class="hl-3">}</span><span class="hl-6"> in third listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">listeners</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">));</span><br/><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-2">1</span><span class="hl-1">, </span><span class="hl-2">2</span><span class="hl-1">, </span><span class="hl-2">3</span><span class="hl-1">, </span><span class="hl-2">4</span><span class="hl-1">, </span><span class="hl-2">5</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// [</span><br/><span class="hl-7">// [Function: firstListener],</span><br/><span class="hl-7">// [Function: secondListener],</span><br/><span class="hl-7">// [Function: thirdListener]</span><br/><span class="hl-7">// ]</span><br/><span class="hl-7">// Helloooo! first listener</span><br/><span class="hl-7">// event with parameters 1, 2 in second listener</span><br/><span class="hl-7">// event with parameters 1, 2, 3, 4, 5 in third listener</span>
|
||
</code><button>Copy</button></pre>
|
||
|
||
<h3>Since</h3><p>v0.1.26</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#emit">emit</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:610</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eventNames" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>event<wbr/>Names</span><a href="#eventNames" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="eventNames.eventNames-1"><span class="tsd-kind-call-signature">event<wbr/>Names</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><a href="#eventNames.eventNames-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-comment tsd-typography"><p>Returns an array listing the events for which the emitter has registered
|
||
listeners. The values in the array are strings or <code>Symbol</code>s.</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><span class="hl-1"> = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEE</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {});</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'bar'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">sym</span><span class="hl-1"> = </span><span class="hl-5">Symbol</span><span class="hl-1">(</span><span class="hl-6">'symbol'</span><span class="hl-1">);</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-0">sym</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {});</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">eventNames</span><span class="hl-1">());</span><br/><span class="hl-7">// Prints: [ 'foo', 'bar', Symbol(symbol) ]</span>
|
||
</code><button>Copy</button></pre>
|
||
|
||
<h3>Since</h3><p>v6.0.0</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#eventNames">eventNames</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:673</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="exportCacheZip" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>export<wbr/>Cache<wbr/>Zip</span><a href="#exportCacheZip" 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="exportCacheZip.exportCacheZip-1"><span class="tsd-kind-call-signature">export<wbr/>Cache<wbr/>Zip</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cacheName</span>, <span class="tsd-kind-parameter">outDirPath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">close</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#exportCacheZip.exportCacheZip-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">cacheName</span>: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">outDirPath</span>: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">close</span>: <span class="tsd-signature-type">boolean</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:111</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="getInstance" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Instance</span><a href="#getInstance" 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="getInstance.getInstance-1"><span class="tsd-kind-call-signature">get<wbr/>Instance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">token</span>, <span class="tsd-kind-parameter">denomination</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">TornadoInstance</span><a href="#getInstance.getInstance-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">token</span>: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<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/dist/index.d.ts:61</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="getInstances" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Instances</span><a href="#getInstances" 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="getInstances.getInstances-1"><span class="tsd-kind-call-signature">get<wbr/>Instances</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">keys</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">TornadoInstance</span><span class="tsd-signature-symbol">[]</span><a href="#getInstances.getInstances-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">keys</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">denomination</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">token</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">TornadoInstance</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:57</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getMaxListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Max<wbr/>Listeners</span><a href="#getMaxListeners" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="getMaxListeners.getMaxListeners-1"><span class="tsd-kind-call-signature">get<wbr/>Max<wbr/>Listeners</span><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><a href="#getMaxListeners.getMaxListeners-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-comment tsd-typography"><p>Returns the current max listener value for the <code>EventEmitter</code> which is either
|
||
set by <code>emitter.setMaxListeners(n)</code> or defaults to <a href="Core.html#defaultMaxListeners" class="tsd-kind-property">defaultMaxListeners</a>.</p>
|
||
|
||
<h3>Since</h3><p>v1.0.0</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#getMaxListeners">getMaxListeners</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:526</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="getProxy" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Proxy</span><a href="#getProxy" 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="getProxy.getProxy-1"><span class="tsd-kind-call-signature">get<wbr/>Proxy</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">TornadoProxy</span><a href="#getProxy.getProxy-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">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">TornadoProxy</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:62</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="listenForDeposits" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>listen<wbr/>For<wbr/>Deposits</span><a href="#listenForDeposits" 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="listenForDeposits.listenForDeposits-1"><span class="tsd-kind-call-signature">listen<wbr/>For<wbr/>Deposits</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#listenForDeposits.listenForDeposits-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">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">TornadoInstance</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:85</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="listenForEvents" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>listen<wbr/>For<wbr/>Events</span><a href="#listenForEvents" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="listenForEvents.listenForEvents-1"><span class="tsd-kind-call-signature">listen<wbr/>For<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">contract</span>, <span class="tsd-kind-parameter">filter</span>, <span class="tsd-kind-parameter">cache</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#listenForEvents.listenForEvents-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">name</span>: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">contract</span>: <span class="tsd-signature-type ">BaseContract</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">filter</span>: <span class="tsd-signature-type ">EventFilter</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">cache</span>: <a href="Data.Cache.Syncable.html" class="tsd-signature-type tsd-kind-class">Syncable</a><span class="tsd-signature-symbol"><</span><a href="../modules/Data.html" class="tsd-signature-type tsd-kind-namespace">Data</a><span class="tsd-signature-symbol">.</span><a href="../modules/Data.Docs.html" class="tsd-signature-type tsd-kind-namespace">Docs</a><span class="tsd-signature-symbol">.</span><a href="Data.Docs.Base.html" class="tsd-signature-type tsd-kind-class">Base</a><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#listenForEvents">listenForEvents</a></p>
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:63</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="listenForInstanceEvents" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>listen<wbr/>For<wbr/>Instance<wbr/>Events</span><a href="#listenForInstanceEvents" 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="listenForInstanceEvents.listenForInstanceEvents-1"><span class="tsd-kind-call-signature">listen<wbr/>For<wbr/>Instance<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span>, <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#listenForInstanceEvents.listenForInstanceEvents-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">string</span><span class="tsd-signature-symbol"> | </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">event</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Function</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:87</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="listenForWithdrawals" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>listen<wbr/>For<wbr/>Withdrawals</span><a href="#listenForWithdrawals" 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="listenForWithdrawals.listenForWithdrawals-1"><span class="tsd-kind-call-signature">listen<wbr/>For<wbr/>Withdrawals</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#listenForWithdrawals.listenForWithdrawals-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">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">TornadoInstance</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:86</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>listener<wbr/>Count</span><a href="#listenerCount" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="listenerCount.listenerCount-1"><span class="tsd-kind-call-signature">listener<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><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><a href="#listenerCount.listenerCount-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-comment tsd-typography"><p>Returns the number of listeners listening to the event named <code>eventName</code>.</p>
|
||
<p>If <code>listener</code> is provided, it will return how many times the listener
|
||
is found in the list of the listeners of the event.</p>
|
||
|
||
<h3>Since</h3><p>v3.2.0</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The name of the event being listened for</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-type ">Function</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The event handler function</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#listenerCount">listenerCount</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:620</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>listeners</span><a href="#listeners" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="listeners.listeners-1"><span class="tsd-kind-call-signature">listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span><a href="#listeners.listeners-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-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">util</span><span class="hl-1">.</span><span class="hl-5">inspect</span><span class="hl-1">(</span><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">listeners</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">)));</span><br/><span class="hl-7">// Prints: [ [Function] ]</span>
|
||
</code><button>Copy</button></pre>
|
||
|
||
<h3>Since</h3><p>v0.1.26</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#listeners">listeners</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:539</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="loadCache" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>load<wbr/>Cache</span><a href="#loadCache" 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="loadCache.loadCache-1"><span class="tsd-kind-call-signature">load<wbr/>Cache</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">D</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">C</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</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><span class="tsd-signature-type tsd-kind-type-parameter">C</span><a href="#loadCache.loadCache-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">
|
||
<section class="tsd-panel">
|
||
<h4>Type Parameters</h4>
|
||
<ul class="tsd-type-parameter-list">
|
||
<li>
|
||
<h4><span class="tsd-kind-type-parameter">D</span><span class="tsd-signature-symbol"> extends </span><a href="../modules/Data.html" class="tsd-signature-type tsd-kind-namespace">Data</a><span class="tsd-signature-symbol">.</span><a href="../modules/Data.Docs.html" class="tsd-signature-type tsd-kind-namespace">Docs</a><span class="tsd-signature-symbol">.</span><a href="Data.Docs.Base.html" class="tsd-signature-type tsd-kind-class">Base</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">D</span><span class="tsd-signature-symbol">></span></h4></li>
|
||
<li>
|
||
<h4><span class="tsd-kind-type-parameter">C</span><span class="tsd-signature-symbol"> extends </span><a href="../modules/Data.html" class="tsd-signature-type tsd-kind-namespace">Data</a><span class="tsd-signature-symbol">.</span><a href="../modules/Data.Cache.html" class="tsd-signature-type tsd-kind-namespace">Cache</a><span class="tsd-signature-symbol">.</span><a href="Data.Cache.Base.html" class="tsd-signature-type tsd-kind-class">Base</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">D</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">C</span><span class="tsd-signature-symbol">></span> = <a href="../modules/Data.html" class="tsd-signature-type tsd-kind-namespace">Data</a><span class="tsd-signature-symbol">.</span><a href="../modules/Data.Cache.html" class="tsd-signature-type tsd-kind-namespace">Cache</a><span class="tsd-signature-symbol">.</span><a href="Data.Cache.Base.html" class="tsd-signature-type tsd-kind-class">Base</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">D</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<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/dist/index.d.ts:114</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">
|
||
<li class="tsd-signature tsd-anchor-link" id="loadDepositCache.loadDepositCache-1"><span class="tsd-kind-call-signature">load<wbr/>Deposit<wbr/>Cache</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</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="DepositCache.html" class="tsd-signature-type tsd-kind-class">DepositCache</a><a href="#loadDepositCache.loadDepositCache-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">name</span>: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<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/dist/index.d.ts:112</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">
|
||
<li class="tsd-signature tsd-anchor-link" id="loadInstance.loadInstance-1"><span class="tsd-kind-call-signature">load<wbr/>Instance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chainId</span>, <span class="tsd-kind-parameter">token</span>, <span class="tsd-kind-parameter">denomination</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">TornadoInstance</span><a href="#loadInstance.loadInstance-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">chainId</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<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/dist/index.d.ts:115</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">
|
||
<li class="tsd-signature tsd-anchor-link" id="loadNotes.loadNotes-1"><span class="tsd-kind-call-signature">load<wbr/>Notes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">indexes</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">keys</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/Crypto.html" class="tsd-signature-type tsd-kind-namespace">Crypto</a><span class="tsd-signature-symbol">.</span><a href="../modules/Crypto.OutputOf.html" class="tsd-signature-type tsd-kind-namespace">OutputOf</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Crypto.OutputOf.CreateDeposit.html" class="tsd-signature-type tsd-kind-interface">CreateDeposit</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#loadNotes.loadNotes-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><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">indexes</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">keys</span>: <span class="tsd-signature-type ">Partial</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Data.Keys.InstanceLookup.html" class="tsd-signature-type tsd-kind-interface">InstanceLookup</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"><</span><a href="../modules/Crypto.html" class="tsd-signature-type tsd-kind-namespace">Crypto</a><span class="tsd-signature-symbol">.</span><a href="../modules/Crypto.OutputOf.html" class="tsd-signature-type tsd-kind-namespace">OutputOf</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Crypto.OutputOf.CreateDeposit.html" class="tsd-signature-type tsd-kind-interface">CreateDeposit</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:80</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="loadWithdrawalCache" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>load<wbr/>Withdrawal<wbr/>Cache</span><a href="#loadWithdrawalCache" 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="loadWithdrawalCache.loadWithdrawalCache-1"><span class="tsd-kind-call-signature">load<wbr/>Withdrawal<wbr/>Cache</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</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="WithdrawalCache.html" class="tsd-signature-type tsd-kind-class">WithdrawalCache</a><a href="#loadWithdrawalCache.loadWithdrawalCache-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">name</span>: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<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/dist/index.d.ts:113</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">
|
||
<li class="tsd-signature tsd-anchor-link" id="off.off-1"><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a><a href="#off.off-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-comment tsd-typography"><p>Alias for <code>emitter.removeListener()</code>.</p>
|
||
|
||
<h3>Since</h3><p>v10.0.0</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#off">off</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:499</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="on" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>on</span><a href="#on" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a><a href="#on.on-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-comment tsd-typography"><p>Adds the <code>listener</code> function to the end of the listeners array for the
|
||
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
||
already been added. Multiple calls passing the same combination of <code>eventName</code>and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
||
times.</p>
|
||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||
</code><button>Copy</button></pre>
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
<p>By default, event listeners are invoked in the order they are added. The<code>emitter.prependListener()</code> method can be used as an alternative to add the
|
||
event listener to the beginning of the listeners array.</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEE</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'a'</span><span class="hl-1">));</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">prependListener</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'b'</span><span class="hl-1">));</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// b</span><br/><span class="hl-7">// a</span>
|
||
</code><button>Copy</button></pre>
|
||
|
||
<h3>Since</h3><p>v0.1.101</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#on">on</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:385</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="once" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>once</span><a href="#once" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-1"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a><a href="#once.once-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-comment tsd-typography"><p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code>. The
|
||
next time <code>eventName</code> is triggered, this listener is removed and then invoked.</p>
|
||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||
</code><button>Copy</button></pre>
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
<p>By default, event listeners are invoked in the order they are added. The<code>emitter.prependOnceListener()</code> method can be used as an alternative to add the
|
||
event listener to the beginning of the listeners array.</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEE</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'a'</span><span class="hl-1">));</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">prependOnceListener</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'b'</span><span class="hl-1">));</span><br/><span class="hl-0">myEE</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// b</span><br/><span class="hl-7">// a</span>
|
||
</code><button>Copy</button></pre>
|
||
|
||
<h3>Since</h3><p>v0.3.0</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#once">once</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:414</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="parseNote" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>parse<wbr/>Note</span><a href="#parseNote" 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="parseNote.parseNote-1"><span class="tsd-kind-call-signature">parse<wbr/>Note</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">note</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/Crypto.html" class="tsd-signature-type tsd-kind-namespace">Crypto</a><span class="tsd-signature-symbol">.</span><a href="../modules/Crypto.OutputOf.html" class="tsd-signature-type tsd-kind-namespace">OutputOf</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Crypto.OutputOf.CreateDeposit.html" class="tsd-signature-type tsd-kind-interface">CreateDeposit</a><a href="#parseNote.parseNote-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">note</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="../modules/Crypto.html" class="tsd-signature-type tsd-kind-namespace">Crypto</a><span class="tsd-signature-symbol">.</span><a href="../modules/Crypto.OutputOf.html" class="tsd-signature-type tsd-kind-namespace">OutputOf</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Crypto.OutputOf.CreateDeposit.html" class="tsd-signature-type tsd-kind-interface">CreateDeposit</a></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:82</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="parseNotes" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>parse<wbr/>Notes</span><a href="#parseNotes" 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="parseNotes.parseNotes-1"><span class="tsd-kind-call-signature">parse<wbr/>Notes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">notes</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/Crypto.html" class="tsd-signature-type tsd-kind-namespace">Crypto</a><span class="tsd-signature-symbol">.</span><a href="../modules/Crypto.OutputOf.html" class="tsd-signature-type tsd-kind-namespace">OutputOf</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Crypto.OutputOf.CreateDeposit.html" class="tsd-signature-type tsd-kind-interface">CreateDeposit</a><span class="tsd-signature-symbol">[]</span><a href="#parseNotes.parseNotes-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">notes</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="../modules/Crypto.html" class="tsd-signature-type tsd-kind-namespace">Crypto</a><span class="tsd-signature-symbol">.</span><a href="../modules/Crypto.OutputOf.html" class="tsd-signature-type tsd-kind-namespace">OutputOf</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/Crypto.OutputOf.CreateDeposit.html" class="tsd-signature-type tsd-kind-interface">CreateDeposit</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:81</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prependListener" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>prepend<wbr/>Listener</span><a href="#prependListener" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-1"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a><a href="#prependListener.prependListener-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-comment tsd-typography"><p>Adds the <code>listener</code> function to the <em>beginning</em> of the listeners array for the
|
||
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
||
already been added. Multiple calls passing the same combination of <code>eventName</code>and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
||
times.</p>
|
||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">prependListener</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||
</code><button>Copy</button></pre>
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
|
||
<h3>Since</h3><p>v6.0.0</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#prependListener">prependListener</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:638</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prependOnceListener" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>prepend<wbr/>Once<wbr/>Listener</span><a href="#prependOnceListener" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-1"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a><a href="#prependOnceListener.prependOnceListener-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-comment tsd-typography"><p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code> to the <em>beginning</em> of the listeners array. The next time <code>eventName</code> is triggered, this
|
||
listener is removed, and then invoked.</p>
|
||
<pre><code class="language-js"><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">prependOnceListener</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'Ah, we have our first user!'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
||
</code><button>Copy</button></pre>
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
|
||
<h3>Since</h3><p>v6.0.0</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The name of the event.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The callback function</p>
|
||
</div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#prependOnceListener">prependOnceListener</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:654</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="rawListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>raw<wbr/>Listeners</span><a href="#rawListeners" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="rawListeners.rawListeners-1"><span class="tsd-kind-call-signature">raw<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span><a href="#rawListeners.rawListeners-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-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>,
|
||
including any wrappers (such as those created by <code>.once()</code>).</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">emitter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-6">'log'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'log once'</span><span class="hl-1">));</span><br/><br/><span class="hl-7">// Returns a new Array with a function `onceWrapper` which has a property</span><br/><span class="hl-7">// `listener` which contains the original listener bound above</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">listeners</span><span class="hl-1"> = </span><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-5">rawListeners</span><span class="hl-1">(</span><span class="hl-6">'log'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">logFnWrapper</span><span class="hl-1"> = </span><span class="hl-0">listeners</span><span class="hl-1">[</span><span class="hl-2">0</span><span class="hl-1">];</span><br/><br/><span class="hl-7">// Logs "log once" to the console and does not unbind the `once` event</span><br/><span class="hl-0">logFnWrapper</span><span class="hl-1">.</span><span class="hl-5">listener</span><span class="hl-1">();</span><br/><br/><span class="hl-7">// Logs "log once" to the console and removes the listener</span><br/><span class="hl-5">logFnWrapper</span><span class="hl-1">();</span><br/><br/><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'log'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'log persistently'</span><span class="hl-1">));</span><br/><span class="hl-7">// Will return a new Array with a single function bound by `.on()` above</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">newListeners</span><span class="hl-1"> = </span><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-5">rawListeners</span><span class="hl-1">(</span><span class="hl-6">'log'</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// Logs "log persistently" twice</span><br/><span class="hl-0">newListeners</span><span class="hl-1">[</span><span class="hl-2">0</span><span class="hl-1">]();</span><br/><span class="hl-0">emitter</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'log'</span><span class="hl-1">);</span>
|
||
</code><button>Copy</button></pre>
|
||
|
||
<h3>Since</h3><p>v9.4.0</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#rawListeners">rawListeners</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:569</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeAllListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removeAllListeners" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="removeAllListeners.removeAllListeners-1"><span class="tsd-kind-call-signature">remove<wbr/>All<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a><a href="#removeAllListeners.removeAllListeners-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-comment tsd-typography"><p>Removes all listeners, or those of the specified <code>eventName</code>.</p>
|
||
<p>It is bad practice to remove listeners added elsewhere in the code,
|
||
particularly when the <code>EventEmitter</code> instance was created by some other
|
||
component or module (e.g. sockets or file streams).</p>
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
|
||
<h3>Since</h3><p>v0.1.26</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#removeAllListeners">removeAllListeners</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:510</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeListener" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>remove<wbr/>Listener</span><a href="#removeListener" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-1"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a><a href="#removeListener.removeListener-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-comment tsd-typography"><p>Removes the specified <code>listener</code> from the listener array for the event named<code>eventName</code>.</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-5">callback</span><span class="hl-1"> = (</span><span class="hl-0">stream</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'someone connected!'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, </span><span class="hl-0">callback</span><span class="hl-1">);</span><br/><span class="hl-7">// ...</span><br/><span class="hl-0">server</span><span class="hl-1">.</span><span class="hl-5">removeListener</span><span class="hl-1">(</span><span class="hl-6">'connection'</span><span class="hl-1">, </span><span class="hl-0">callback</span><span class="hl-1">);</span>
|
||
</code><button>Copy</button></pre>
|
||
<p><code>removeListener()</code> will remove, at most, one instance of a listener from the
|
||
listener array. If any single listener has been added multiple times to the
|
||
listener array for the specified <code>eventName</code>, then <code>removeListener()</code> must be
|
||
called multiple times to remove each instance.</p>
|
||
<p>Once an event is emitted, all listeners attached to it at the
|
||
time of emitting are called in order. This implies that any<code>removeListener()</code> or <code>removeAllListeners()</code> calls <em>after</em> emitting and <em>before</em> the last listener finishes execution
|
||
will not remove them from<code>emit()</code> in progress. Subsequent events behave as expected.</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEmitter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">MyEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-5">callbackA</span><span class="hl-1"> = () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'A'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">removeListener</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-0">callbackB</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-5">callbackB</span><span class="hl-1"> = () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'B'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-0">callbackA</span><span class="hl-1">);</span><br/><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, </span><span class="hl-0">callbackB</span><span class="hl-1">);</span><br/><br/><span class="hl-7">// callbackA removes listener callbackB but it will still be called.</span><br/><span class="hl-7">// Internal listener array at time of emit [callbackA, callbackB]</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// A</span><br/><span class="hl-7">// B</span><br/><br/><span class="hl-7">// callbackB is now removed.</span><br/><span class="hl-7">// Internal listener array [callbackA]</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">);</span><br/><span class="hl-7">// Prints:</span><br/><span class="hl-7">// A</span>
|
||
</code><button>Copy</button></pre>
|
||
<p>Because listeners are managed using an internal array, calling this will
|
||
change the position indices of any listener registered <em>after</em> the listener
|
||
being removed. This will not impact the order in which listeners are called,
|
||
but it means that any copies of the listener array as returned by
|
||
the <code>emitter.listeners()</code> method will need to be recreated.</p>
|
||
<p>When a single function has been added as a handler multiple times for a single
|
||
event (as in the example below), <code>removeListener()</code> will remove the most
|
||
recently added instance. In the example the <code>once('ping')</code>listener is removed:</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-5">pong</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'pong'</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'ping'</span><span class="hl-1">, </span><span class="hl-0">pong</span><span class="hl-1">);</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-6">'ping'</span><span class="hl-1">, </span><span class="hl-0">pong</span><span class="hl-1">);</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">removeListener</span><span class="hl-1">(</span><span class="hl-6">'ping'</span><span class="hl-1">, </span><span class="hl-0">pong</span><span class="hl-1">);</span><br/><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'ping'</span><span class="hl-1">);</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'ping'</span><span class="hl-1">);</span>
|
||
</code><button>Copy</button></pre>
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
|
||
<h3>Since</h3><p>v0.1.26</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#removeListener">removeListener</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:494</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setMaxListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>set<wbr/>Max<wbr/>Listeners</span><a href="#setMaxListeners" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="setMaxListeners.setMaxListeners-1"><span class="tsd-kind-call-signature">set<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">n</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a><a href="#setMaxListeners.setMaxListeners-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-comment tsd-typography"><p>By default <code>EventEmitter</code>s will print a warning if more than <code>10</code> listeners are
|
||
added for a particular event. This is a useful default that helps finding
|
||
memory leaks. The <code>emitter.setMaxListeners()</code> method allows the limit to be
|
||
modified for this specific <code>EventEmitter</code> instance. The value can be set to<code>Infinity</code> (or <code>0</code>) to indicate an unlimited number of listeners.</p>
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
|
||
<h3>Since</h3><p>v0.3.5</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">n</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="Core.html" class="tsd-signature-type tsd-kind-class">Core</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#setMaxListeners">setMaxListeners</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:520</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="sync" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>sync</span><a href="#sync" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="sync.sync-1"><span class="tsd-kind-call-signature">sync</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">filter</span>, <span class="tsd-kind-parameter">contract</span>, <span class="tsd-kind-parameter">cache</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><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#sync.sync-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">eventName</span>: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">filter</span>: <span class="tsd-signature-type ">EventFilter</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">contract</span>: <span class="tsd-signature-type ">BaseContract</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">cache</span>: <a href="Data.Cache.Syncable.html" class="tsd-signature-type tsd-kind-class">Syncable</a><span class="tsd-signature-symbol"><</span><a href="../modules/Data.html" class="tsd-signature-type tsd-kind-namespace">Data</a><span class="tsd-signature-symbol">.</span><a href="../modules/Data.Docs.html" class="tsd-signature-type tsd-kind-namespace">Docs</a><span class="tsd-signature-symbol">.</span><a href="Data.Docs.Base.html" class="tsd-signature-type tsd-kind-class">Base</a><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/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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#sync">sync</a></p>
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-chain/dist/index.d.ts:62</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="syncDeposits" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>sync<wbr/>Deposits</span><a href="#syncDeposits" 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="syncDeposits.syncDeposits-1"><span class="tsd-kind-call-signature">sync<wbr/>Deposits</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><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#syncDeposits.syncDeposits-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>: <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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:116</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">
|
||
<li class="tsd-signature tsd-anchor-link" id="syncWithdrawals.syncWithdrawals-1"><span class="tsd-kind-call-signature">sync<wbr/>Withdrawals</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><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#syncWithdrawals.syncWithdrawals-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>: <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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in @tornado/sdk-core/dist/index.d.ts:117</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">
|
||
<li class="tsd-signature tsd-anchor-link" id="getEventListeners.getEventListeners-1"><span class="tsd-kind-call-signature">get<wbr/>Event<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span><a href="#getEventListeners.getEventListeners-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-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
||
<p>For <code>EventEmitter</code>s this behaves exactly the same as calling <code>.listeners</code> on
|
||
the emitter.</p>
|
||
<p>For <code>EventTarget</code>s this is the only way to get the event listeners for the
|
||
event target. This is useful for debugging and diagnostic purposes.</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">getEventListeners</span><span class="hl-1">, </span><span class="hl-4">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-5">listener</span><span class="hl-1"> = () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'Events are fun'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-0">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-5">getEventListeners</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'foo'</span><span class="hl-1">); </span><span class="hl-7">// [listener]</span><br/><span class="hl-1">}</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">et</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventTarget</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-5">listener</span><span class="hl-1"> = () </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'Events are fun'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">et</span><span class="hl-1">.</span><span class="hl-5">addEventListener</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-0">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-5">getEventListeners</span><span class="hl-1">(</span><span class="hl-0">et</span><span class="hl-1">, </span><span class="hl-6">'foo'</span><span class="hl-1">); </span><span class="hl-7">// [listener]</span><br/><span class="hl-1">}</span>
|
||
</code><button>Copy</button></pre>
|
||
|
||
<h3>Since</h3><p>v15.2.0, v14.17.0</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type ">_DOMEventTarget</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">EventEmitter</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#getEventListeners">getEventListeners</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:299</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listenerCount-2" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>listener<wbr/>Count</span><a href="#listenerCount-2" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="listenerCount-2.listenerCount-3"><span class="tsd-kind-call-signature">listener<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#listenerCount-2.listenerCount-3" 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-comment tsd-typography"><p>A class method that returns the number of listeners for the given <code>eventName</code>registered on the given <code>emitter</code>.</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">EventEmitter</span><span class="hl-1">, </span><span class="hl-4">listenerCount</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">myEmitter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {});</span><br/><span class="hl-0">myEmitter</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-6">'event'</span><span class="hl-1">, () </span><span class="hl-3">=></span><span class="hl-1"> {});</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-5">listenerCount</span><span class="hl-1">(</span><span class="hl-0">myEmitter</span><span class="hl-1">, </span><span class="hl-6">'event'</span><span class="hl-1">));</span><br/><span class="hl-7">// Prints: 2</span>
|
||
</code><button>Copy</button></pre>
|
||
|
||
<h3>Since</h3><p>v0.9.12</p>
|
||
|
||
<h3>Deprecated</h3><p>Since v3.2.0 - Use <code>listenerCount</code> instead.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type ">EventEmitter</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The emitter to query</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The event name</p>
|
||
</div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#listenerCount-2">listenerCount</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:271</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="on-2" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>on</span><a href="#on-2" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="on-2.on-3"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</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><span class="tsd-signature-type ">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#on-2.on-3" 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-comment tsd-typography"><pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">on</span><span class="hl-1">, </span><span class="hl-4">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-1">(</span><span class="hl-3">async</span><span class="hl-1"> () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-7">// Emit later on</span><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-5">nextTick</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-6">'bar'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-2">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-8">for</span><span class="hl-1"> </span><span class="hl-8">await</span><span class="hl-1"> (</span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">event</span><span class="hl-1"> </span><span class="hl-3">of</span><span class="hl-1"> </span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'foo'</span><span class="hl-1">)) {</span><br/><span class="hl-1"> </span><span class="hl-7">// The execution of this inner block is synchronous and it</span><br/><span class="hl-1"> </span><span class="hl-7">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-1"> </span><span class="hl-7">// if concurrent execution is required.</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">); </span><span class="hl-7">// prints ['bar'] [42]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-7">// Unreachable here</span><br/><span class="hl-1">})();</span>
|
||
</code><button>Copy</button></pre>
|
||
<p>Returns an <code>AsyncIterator</code> that iterates <code>eventName</code> events. It will throw
|
||
if the <code>EventEmitter</code> emits <code>'error'</code>. It removes all listeners when
|
||
exiting the loop. The <code>value</code> returned by each iteration is an array
|
||
composed of the emitted event arguments.</p>
|
||
<p>An <code>AbortSignal</code> can be used to cancel waiting on events:</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">on</span><span class="hl-1">, </span><span class="hl-4">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ac</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">AbortController</span><span class="hl-1">();</span><br/><br/><span class="hl-1">(</span><span class="hl-3">async</span><span class="hl-1"> () </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-7">// Emit later on</span><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-5">nextTick</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-6">'bar'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-2">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-8">for</span><span class="hl-1"> </span><span class="hl-8">await</span><span class="hl-1"> (</span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">event</span><span class="hl-1"> </span><span class="hl-3">of</span><span class="hl-1"> </span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'foo'</span><span class="hl-1">, { </span><span class="hl-0">signal:</span><span class="hl-1"> </span><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-0">signal</span><span class="hl-1"> })) {</span><br/><span class="hl-1"> </span><span class="hl-7">// The execution of this inner block is synchronous and it</span><br/><span class="hl-1"> </span><span class="hl-7">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-1"> </span><span class="hl-7">// if concurrent execution is required.</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">event</span><span class="hl-1">); </span><span class="hl-7">// prints ['bar'] [42]</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-7">// Unreachable here</span><br/><span class="hl-1">})();</span><br/><br/><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-5">nextTick</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-5">abort</span><span class="hl-1">());</span>
|
||
</code><button>Copy</button></pre>
|
||
|
||
<h3>Since</h3><p>v13.6.0, v12.16.0</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type ">EventEmitter</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The name of the event being listened for</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">StaticEventEmitterOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><p>that iterates <code>eventName</code> events emitted by the <code>emitter</code></p>
|
||
<aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#on-2">on</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:254</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="once-2" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>once</span><a href="#once-2" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="once-2.once-3"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</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><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#once-2.once-3" 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-comment tsd-typography"><p>Creates a <code>Promise</code> that is fulfilled when the <code>EventEmitter</code> emits the given
|
||
event or that is rejected if the <code>EventEmitter</code> emits <code>'error'</code> while waiting.
|
||
The <code>Promise</code> will resolve with an array of all the arguments emitted to the
|
||
given event.</p>
|
||
<p>This method is intentionally generic and works with the web platform <a href="https://dom.spec.whatwg.org/#interface-eventtarget">EventTarget</a> interface, which has no special<code>'error'</code> event
|
||
semantics and does not listen to the <code>'error'</code> event.</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">once</span><span class="hl-1">, </span><span class="hl-4">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-3">async</span><span class="hl-1"> </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-5">run</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-5">nextTick</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'myevent'</span><span class="hl-1">, </span><span class="hl-2">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> [</span><span class="hl-4">value</span><span class="hl-1">] = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'myevent'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">value</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">err</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">(</span><span class="hl-6">'kaboom'</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-0">process</span><span class="hl-1">.</span><span class="hl-5">nextTick</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'error'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-8">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'myevent'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-8">catch</span><span class="hl-1"> (</span><span class="hl-0">err</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'error happened'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">run</span><span class="hl-1">();</span>
|
||
</code><button>Copy</button></pre>
|
||
<p>The special handling of the <code>'error'</code> event is only used when <code>events.once()</code>is used to wait for another event. If <code>events.once()</code> is used to wait for the
|
||
'<code>error'</code> event itself, then it is treated as any other kind of event without
|
||
special handling:</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">EventEmitter</span><span class="hl-1">, </span><span class="hl-4">once</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'error'</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-5">then</span><span class="hl-1">(([</span><span class="hl-0">err</span><span class="hl-1">]) </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'ok'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">.</span><span class="hl-0">message</span><span class="hl-1">))</span><br/><span class="hl-1"> .</span><span class="hl-5">catch</span><span class="hl-1">((</span><span class="hl-0">err</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'error'</span><span class="hl-1">, </span><span class="hl-0">err</span><span class="hl-1">.</span><span class="hl-0">message</span><span class="hl-1">));</span><br/><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'error'</span><span class="hl-1">, </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">(</span><span class="hl-6">'boom'</span><span class="hl-1">));</span><br/><br/><span class="hl-7">// Prints: ok boom</span>
|
||
</code><button>Copy</button></pre>
|
||
<p>An <code>AbortSignal</code> can be used to cancel waiting for the event:</p>
|
||
<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">EventEmitter</span><span class="hl-1">, </span><span class="hl-4">once</span><span class="hl-1"> } = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ee</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">ac</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">AbortController</span><span class="hl-1">();</span><br/><br/><span class="hl-3">async</span><span class="hl-1"> </span><span class="hl-3">function</span><span class="hl-1"> </span><span class="hl-5">foo</span><span class="hl-1">(</span><span class="hl-0">emitter</span><span class="hl-1">, </span><span class="hl-0">event</span><span class="hl-1">, </span><span class="hl-0">signal</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-8">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-5">once</span><span class="hl-1">(</span><span class="hl-0">emitter</span><span class="hl-1">, </span><span class="hl-0">event</span><span class="hl-1">, { </span><span class="hl-0">signal</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-6">'event emitted!'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-8">catch</span><span class="hl-1"> (</span><span class="hl-0">error</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-8">if</span><span class="hl-1"> (</span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">name</span><span class="hl-1"> === </span><span class="hl-6">'AbortError'</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">error</span><span class="hl-1">(</span><span class="hl-6">'Waiting for the event was canceled!'</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-8">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">error</span><span class="hl-1">(</span><span class="hl-6">'There was an error'</span><span class="hl-1">, </span><span class="hl-0">error</span><span class="hl-1">.</span><span class="hl-0">message</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">foo</span><span class="hl-1">(</span><span class="hl-0">ee</span><span class="hl-1">, </span><span class="hl-6">'foo'</span><span class="hl-1">, </span><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-0">signal</span><span class="hl-1">);</span><br/><span class="hl-0">ac</span><span class="hl-1">.</span><span class="hl-5">abort</span><span class="hl-1">(); </span><span class="hl-7">// Abort waiting for the event</span><br/><span class="hl-0">ee</span><span class="hl-1">.</span><span class="hl-5">emit</span><span class="hl-1">(</span><span class="hl-6">'foo'</span><span class="hl-1">); </span><span class="hl-7">// Prints: Waiting for the event was canceled!</span>
|
||
</code><button>Copy</button></pre>
|
||
|
||
<h3>Since</h3><p>v11.13.0, v10.16.0</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type ">_NodeEventTarget</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</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 ">StaticEventEmitterOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#once-2">once</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:194</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once-2.once-4"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</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><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#once-2.once-4" 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">emitter</span>: <span class="tsd-signature-type ">_DOMEventTarget</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</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 ">StaticEventEmitterOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#once-2">once</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:195</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setMaxListeners-2" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>set<wbr/>Max<wbr/>Listeners</span><a href="#setMaxListeners-2" 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">
|
||
<li class="tsd-signature tsd-anchor-link" id="setMaxListeners-2.setMaxListeners-3"><span class="tsd-kind-call-signature">set<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">n</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">eventTargets</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setMaxListeners-2.setMaxListeners-3" 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-comment tsd-typography"><pre><code class="language-js"><span class="hl-3">const</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">setMaxListeners</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">EventEmitter</span><br/><span class="hl-1">} = </span><span class="hl-5">require</span><span class="hl-1">(</span><span class="hl-6">'events'</span><span class="hl-1">);</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">target</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventTarget</span><span class="hl-1">();</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">emitter</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-5">setMaxListeners</span><span class="hl-1">(</span><span class="hl-2">5</span><span class="hl-1">, </span><span class="hl-0">target</span><span class="hl-1">, </span><span class="hl-0">emitter</span><span class="hl-1">);</span>
|
||
</code><button>Copy</button></pre>
|
||
|
||
<h3>Since</h3><p>v15.4.0</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">n</span>: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>A non-negative number. The maximum number of listeners per <code>EventTarget</code> event.</p>
|
||
</div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">eventTargets</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">_DOMEventTarget</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">EventEmitter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from <a href="Network.Synchronizer.html">Synchronizer</a>.<a href="Network.Synchronizer.html#setMaxListeners-2">setMaxListeners</a></p>
|
||
<ul>
|
||
<li>Defined in .yarn/cache/@types-node-npm-18.16.2-81a2b61beb-7ad66d23b3.zip/node_modules/@types/node/events.d.ts:317</li></ul></aside></li></ul></section></section></div>
|
||
<div class="col-sidebar">
|
||
<div class="page-menu">
|
||
<div class="tsd-navigation settings">
|
||
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
||
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>Settings</h3></summary>
|
||
<div class="tsd-accordion-details">
|
||
<div class="tsd-filter-visibility">
|
||
<h4 class="uppercase">Member Visibility</h4><form>
|
||
<ul id="tsd-filter-options">
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
||
<div class="tsd-theme-toggle">
|
||
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
||
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
||
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>On This Page</h3></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul>
|
||
<li><a href="#constructor" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg><span>constructor</span></a></li>
|
||
<li><a href="#_backupDepositData" class="tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_backup<wbr/>Deposit<wbr/>Data</span></a></li>
|
||
<li><a href="#_calcWithdrawalFee" class="tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_calc<wbr/>Withdrawal<wbr/>Fee</span></a></li>
|
||
<li><a href="#_chain" class="tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_chain</span></a></li>
|
||
<li><a href="#_checkProvider" class="tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_check<wbr/>Provider</span></a></li>
|
||
<li><a href="#_findLeavesAndIndices" class="tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_find<wbr/>Leaves<wbr/>And<wbr/>Indices</span></a></li>
|
||
<li><a href="#_instanceEventToFilter" class="tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_instance<wbr/>Event<wbr/>To<wbr/>Filter</span></a></li>
|
||
<li><a href="#_mutex" class="tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_mutex</span></a></li>
|
||
<li><a href="#_resolveInstance" class="tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_resolve<wbr/>Instance</span></a></li>
|
||
<li><a href="#_resolveInstanceEvent" class="tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>_resolve<wbr/>Instance<wbr/>Event</span></a></li>
|
||
<li><a href="#caches" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>caches</span></a></li>
|
||
<li><a href="#captureRejectionSymbol" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>capture<wbr/>Rejection<wbr/>Symbol</span></a></li>
|
||
<li><a href="#captureRejections" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>capture<wbr/>Rejections</span></a></li>
|
||
<li><a href="#defaultMaxListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>default<wbr/>Max<wbr/>Listeners</span></a></li>
|
||
<li><a href="#errorMonitor" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>error<wbr/>Monitor</span></a></li>
|
||
<li><a href="#chain" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>chain</span></a></li>
|
||
<li><a href="#_populateSyncOptions" class="tsd-is-protected"><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>_populate<wbr/>Sync<wbr/>Options</span></a></li>
|
||
<li><a href="#addListener" 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>add<wbr/>Listener</span></a></li>
|
||
<li><a href="#backupInvoice" 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>backup<wbr/>Invoice</span></a></li>
|
||
<li><a href="#backupInvoices" 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>backup<wbr/>Invoices</span></a></li>
|
||
<li><a href="#backupNote" 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>backup<wbr/>Note</span></a></li>
|
||
<li><a href="#backupNotes" 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>backup<wbr/>Notes</span></a></li>
|
||
<li><a href="#clearListener" 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/>Listener</span></a></li>
|
||
<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="#createDepositProof" 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/>Deposit<wbr/>Proof</span></a></li>
|
||
<li><a href="#createDepositProofs" 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/>Deposit<wbr/>Proofs</span></a></li>
|
||
<li><a href="#createDepositTransaction" 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/>Deposit<wbr/>Transaction</span></a></li>
|
||
<li><a href="#createDepositTransactions" 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/>Deposit<wbr/>Transactions</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="#exportCacheZip" 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>export<wbr/>Cache<wbr/>Zip</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>
|
||
<li><a href="#getInstances" 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/>Instances</span></a></li>
|
||
<li><a href="#getMaxListeners" 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>get<wbr/>Max<wbr/>Listeners</span></a></li>
|
||
<li><a href="#getProxy" 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/>Proxy</span></a></li>
|
||
<li><a href="#listenForDeposits" 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>listen<wbr/>For<wbr/>Deposits</span></a></li>
|
||
<li><a href="#listenForEvents" 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>listen<wbr/>For<wbr/>Events</span></a></li>
|
||
<li><a href="#listenForInstanceEvents" 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>listen<wbr/>For<wbr/>Instance<wbr/>Events</span></a></li>
|
||
<li><a href="#listenForWithdrawals" 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>listen<wbr/>For<wbr/>Withdrawals</span></a></li>
|
||
<li><a href="#listenerCount" 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>listener<wbr/>Count</span></a></li>
|
||
<li><a href="#listeners" 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>listeners</span></a></li>
|
||
<li><a href="#loadCache" 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>load<wbr/>Cache</span></a></li>
|
||
<li><a href="#loadDepositCache" 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>load<wbr/>Deposit<wbr/>Cache</span></a></li>
|
||
<li><a href="#loadInstance" 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>load<wbr/>Instance</span></a></li>
|
||
<li><a href="#loadNotes" 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>load<wbr/>Notes</span></a></li>
|
||
<li><a href="#loadWithdrawalCache" 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>load<wbr/>Withdrawal<wbr/>Cache</span></a></li>
|
||
<li><a href="#off" 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>off</span></a></li>
|
||
<li><a href="#on" 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>on</span></a></li>
|
||
<li><a href="#once" 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>once</span></a></li>
|
||
<li><a href="#parseNote" 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>parse<wbr/>Note</span></a></li>
|
||
<li><a href="#parseNotes" 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>parse<wbr/>Notes</span></a></li>
|
||
<li><a href="#prependListener" 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>prepend<wbr/>Listener</span></a></li>
|
||
<li><a href="#prependOnceListener" 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>prepend<wbr/>Once<wbr/>Listener</span></a></li>
|
||
<li><a href="#rawListeners" 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>raw<wbr/>Listeners</span></a></li>
|
||
<li><a href="#removeAllListeners" 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>remove<wbr/>All<wbr/>Listeners</span></a></li>
|
||
<li><a href="#removeListener" 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>remove<wbr/>Listener</span></a></li>
|
||
<li><a href="#setMaxListeners" 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>set<wbr/>Max<wbr/>Listeners</span></a></li>
|
||
<li><a href="#sync" 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>sync</span></a></li>
|
||
<li><a href="#syncDeposits" 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>sync<wbr/>Deposits</span></a></li>
|
||
<li><a href="#syncWithdrawals" 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>sync<wbr/>Withdrawals</span></a></li>
|
||
<li><a href="#getEventListeners" 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>get<wbr/>Event<wbr/>Listeners</span></a></li>
|
||
<li><a href="#listenerCount-2" 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>listener<wbr/>Count</span></a></li>
|
||
<li><a href="#on-2" 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>on</span></a></li>
|
||
<li><a href="#once-2" 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>once</span></a></li>
|
||
<li><a href="#setMaxListeners-2" 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>set<wbr/>Max<wbr/>Listeners</span></a></li></ul></div></details></div>
|
||
<div class="site-menu">
|
||
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4-path"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)" id="icon-4-text"></path></svg><span>@tornado/sdk</span></a>
|
||
<ul class="tsd-small-nested-navigation">
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Crypto"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Crypto.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Crypto</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Crypto.InputFor"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Crypto.InputFor.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Input<wbr/>For</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../interfaces/Crypto.InputFor.BuildMerkleTree.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Build<wbr/>Merkle<wbr/>Tree</span></a></li>
|
||
<li><a href="../interfaces/Crypto.InputFor.CreateDeposit.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Create<wbr/>Deposit</span></a></li>
|
||
<li><a href="../interfaces/Crypto.InputFor.DepositProof.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Deposit<wbr/>Proof</span></a></li>
|
||
<li><a href="../interfaces/Crypto.InputFor.PedersenHash.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Pedersen<wbr/>Hash</span></a></li>
|
||
<li><a href="../types/Crypto.InputFor.Groth16.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg><span>Groth16</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Crypto.OutputOf"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Crypto.OutputOf.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Output<wbr/>Of</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../interfaces/Crypto.OutputOf.CreateDeposit.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Create<wbr/>Deposit</span></a></li>
|
||
<li><a href="../interfaces/Crypto.OutputOf.Groth16Proof.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Groth16<wbr/>Proof</span></a></li>
|
||
<li><a href="../interfaces/Crypto.OutputOf.MerkleProof.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Merkle<wbr/>Proof</span></a></li>
|
||
<li><a href="../types/Crypto.OutputOf.PedersenHash.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Pedersen<wbr/>Hash</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Crypto.Primitives"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Crypto.Primitives.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Primitives</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../functions/Crypto.Primitives.buildMerkleTree.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg><span>build<wbr/>Merkle<wbr/>Tree</span></a></li>
|
||
<li><a href="../functions/Crypto.Primitives.calcDepositProofs.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>calc<wbr/>Deposit<wbr/>Proofs</span></a></li>
|
||
<li><a href="../functions/Crypto.Primitives.calcPedersenHash.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>calc<wbr/>Pedersen<wbr/>Hash</span></a></li>
|
||
<li><a href="../functions/Crypto.Primitives.createDeposit.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>create<wbr/>Deposit</span></a></li>
|
||
<li><a href="../functions/Crypto.Primitives.createNote.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>create<wbr/>Note</span></a></li>
|
||
<li><a href="../functions/Crypto.Primitives.parseNote.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>parse<wbr/>Note</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Crypto.Setup"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Crypto.Setup.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Setup</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../functions/Crypto.Setup.getDefaultHash.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Default<wbr/>Hash</span></a></li>
|
||
<li><a href="../functions/Crypto.Setup.getGroth16.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Groth16</span></a></li>
|
||
<li><a href="../functions/Crypto.Setup.getProvingKey.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Proving<wbr/>Key</span></a></li>
|
||
<li><a href="../functions/Crypto.Setup.getTornadoCircuit.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Tornado<wbr/>Circuit</span></a></li>
|
||
<li><a href="../functions/Crypto.Setup.getZeroElement.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Zero<wbr/>Element</span></a></li>
|
||
<li><a href="../functions/Crypto.Setup.terminateGroth16.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>terminate<wbr/>Groth16</span></a></li></ul></div></details></li>
|
||
<li><a href="../types/Crypto.DepositInfo.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Deposit<wbr/>Info</span></a></li>
|
||
<li><a href="../types/Crypto.DepositProof.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Deposit<wbr/>Proof</span></a></li>
|
||
<li><a href="../types/Crypto.MerkleProof.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Merkle<wbr/>Proof</span></a></li>
|
||
<li><a href="../types/Crypto.bigInt.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>big<wbr/>Int</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Data"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Data.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Data</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Data.Cache"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Data.Cache.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Cache</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="Data.Cache.Base.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Base</span></a></li>
|
||
<li><a href="Data.Cache.Syncable.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Syncable</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Data.Constants"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Data.Constants.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Constants</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../variables/Data.Constants.MERKLE_TREE_HEIGHT.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg><span>MERKLE_<wbr/>TREE_<wbr/>HEIGHT</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Data.Docs"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Data.Docs.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Docs</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="Data.Docs.Base.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Base</span></a></li>
|
||
<li><a href="Data.Docs.Deposit.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Deposit</span></a></li>
|
||
<li><a href="Data.Docs.Invoice.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Invoice</span></a></li>
|
||
<li><a href="Data.Docs.Note.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Note</span></a></li>
|
||
<li><a href="Data.Docs.Relayer.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Relayer</span></a></li>
|
||
<li><a href="Data.Docs.Withdrawal.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Withdrawal</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Data.Files"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Data.Files.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Files</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../types/Data.Files.PathGetter.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Path<wbr/>Getter</span></a></li>
|
||
<li><a href="../functions/Data.Files.cacheDirExists.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>cache<wbr/>Dir<wbr/>Exists</span></a></li>
|
||
<li><a href="../functions/Data.Files.getCachePath.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Cache<wbr/>Path</span></a></li>
|
||
<li><a href="../functions/Data.Files.getModulesPath.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Modules<wbr/>Path</span></a></li>
|
||
<li><a href="../functions/Data.Files.getResourcePath.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Resource<wbr/>Path</span></a></li>
|
||
<li><a href="../functions/Data.Files.gunzipSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>gunzip<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Files.gzipSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>gzip<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Files.loadRaw.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>load<wbr/>Raw</span></a></li>
|
||
<li><a href="../functions/Data.Files.loadRawSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>load<wbr/>Raw<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Files.makeCacheDir.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>make<wbr/>Cache<wbr/>Dir</span></a></li>
|
||
<li><a href="../functions/Data.Files.parentPath.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>parent<wbr/>Path</span></a></li>
|
||
<li><a href="../functions/Data.Files.stripExtensions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>strip<wbr/>Extensions</span></a></li>
|
||
<li><a href="../functions/Data.Files.wipeCache.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>wipe<wbr/>Cache</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Data.Json"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Data.Json.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Json</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../functions/Data.Json.getError.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Error</span></a></li>
|
||
<li><a href="../functions/Data.Json.getValue.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Value</span></a></li>
|
||
<li><a href="../functions/Data.Json.load.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>load</span></a></li>
|
||
<li><a href="../functions/Data.Json.loadMap.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>load<wbr/>Map</span></a></li>
|
||
<li><a href="../functions/Data.Json.loadSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>load<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Json.throwError.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>throw<wbr/>Error</span></a></li>
|
||
<li><a href="../functions/Data.Json.toMap.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>to<wbr/>Map</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Data.Keys"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Data.Keys.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Keys</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../interfaces/Data.Keys.InstanceLookup.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Instance<wbr/>Lookup</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Data.Offchain"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Data.Offchain.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Offchain</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../functions/Data.Offchain.getClassicSubgraphURL.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Classic<wbr/>SubgraphURL</span></a></li>
|
||
<li><a href="../functions/Data.Offchain.getClassicSubgraphURLSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Classic<wbr/>SubgraphURLSync</span></a></li>
|
||
<li><a href="../functions/Data.Offchain.getUncensoredRpcURL.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Uncensored<wbr/>RpcURL</span></a></li>
|
||
<li><a href="../functions/Data.Offchain.getUncensoredRpcURLSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Uncensored<wbr/>RpcURLSync</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Data.Onchain"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Data.Onchain.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Onchain</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../functions/Data.Onchain.getClassicInstanceData.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Classic<wbr/>Instance<wbr/>Data</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getClassicInstanceDataSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Classic<wbr/>Instance<wbr/>Data<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getInstanceAddress.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Instance<wbr/>Address</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getInstanceAddressSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Instance<wbr/>Address<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getInstanceAddresses.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Instance<wbr/>Addresses</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getInstanceAddressesSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Instance<wbr/>Addresses<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getInstanceDeployBlockNum.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Instance<wbr/>Deploy<wbr/>Block<wbr/>Num</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getInstanceDeployBlockNumSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Instance<wbr/>Deploy<wbr/>Block<wbr/>Num<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getInstanceDeployBlockNums.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Instance<wbr/>Deploy<wbr/>Block<wbr/>Nums</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getInstanceDeployBlockNumsSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Instance<wbr/>Deploy<wbr/>Block<wbr/>Nums<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getInstanceLookupKeys.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Instance<wbr/>Lookup<wbr/>Keys</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getInstanceLookupKeysSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Instance<wbr/>Lookup<wbr/>Keys<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getMulticall3Address.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Multicall3<wbr/>Address</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getMulticall3AddressSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Multicall3<wbr/>Address<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getMulticallAddress.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Multicall<wbr/>Address</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getMulticallAddressSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Multicall<wbr/>Address<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getNetworkSymbol.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Network<wbr/>Symbol</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getNetworkSymbolSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Network<wbr/>Symbol<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getPathstringBasedContent.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Pathstring<wbr/>Based<wbr/>Content</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getPathstringBasedContentSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Pathstring<wbr/>Based<wbr/>Content<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getProxyAddress.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Proxy<wbr/>Address</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getProxyAddressSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Proxy<wbr/>Address<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getTokenAddress.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Token<wbr/>Address</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getTokenAddressSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Token<wbr/>Address<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getTokenData.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Token<wbr/>Data</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getTokenDataSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Token<wbr/>Data<wbr/>Sync</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getTokenDecimals.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Token<wbr/>Decimals</span></a></li>
|
||
<li><a href="../functions/Data.Onchain.getTokenDecimalsSync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Token<wbr/>Decimals<wbr/>Sync</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Data.Options"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Data.Options.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Options</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../interfaces/Data.Options.Cache.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Cache</span></a></li></ul></div></details></li>
|
||
<li><a href="../interfaces/Data.ClassicInstance.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Classic<wbr/>Instance</span></a></li>
|
||
<li><a href="../interfaces/Data.RelayerProperties.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Relayer<wbr/>Properties</span></a></li>
|
||
<li><a href="../interfaces/Data.TokenData.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Token<wbr/>Data</span></a></li>
|
||
<li><a href="../interfaces/Data.TornadoInstance.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Tornado<wbr/>Instance</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Network"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Network.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Network</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Network.Contracts"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Network.Contracts.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Contracts</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../functions/Network.Contracts.getInstance.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Instance</span></a></li>
|
||
<li><a href="../functions/Network.Contracts.getProxy.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Proxy</span></a></li>
|
||
<li><a href="../functions/Network.Contracts.getToken.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Token</span></a></li>
|
||
<li><a href="../functions/Network.Contracts.getTornToken.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Torn<wbr/>Token</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Network.Options"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Network.Options.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Options</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../interfaces/Network.Options.Sync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Sync</span></a></li></ul></div></details></li>
|
||
<li><a href="Network.Chain.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Chain</span></a></li>
|
||
<li><a href="Network.Synchronizer.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Synchronizer</span></a></li>
|
||
<li><a href="../types/Network.TornadoContracts.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Tornado<wbr/>Contracts</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Options"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Options.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Options</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Options.Core"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Options.Core.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Core</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../interfaces/Options.Core.BuildDepositProof.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Build<wbr/>Deposit<wbr/>Proof</span></a></li>
|
||
<li><a href="../interfaces/Options.Core.Deposit.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Deposit</span></a></li>
|
||
<li><a href="../types/Options.Core.Invoice.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Invoice</span></a></li></ul></div></details></li>
|
||
<li><a href="../types/Options.Sync.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Sync</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Transactions"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Transactions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Transactions</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../interfaces/Transactions.Deposit.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Deposit</span></a></li>
|
||
<li><a href="../types/Transactions.Invoice.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Invoice</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Utils"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Utils.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Utils</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Utils.AsyncUtils"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Utils.AsyncUtils.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Async<wbr/>Utils</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="Utils.AsyncUtils.PromisePooler.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Promise<wbr/>Pooler</span></a></li>
|
||
<li><a href="Utils.AsyncUtils.SimpleMutex.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Simple<wbr/>Mutex</span></a></li>
|
||
<li><a href="../types/Utils.AsyncUtils.Callback.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Callback</span></a></li>
|
||
<li><a href="../types/Utils.AsyncUtils.ErrorHandler.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Error<wbr/>Handler</span></a></li>
|
||
<li><a href="../functions/Utils.AsyncUtils.timeout.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>timeout</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Utils.ErrorUtils"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Utils.ErrorUtils.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Error<wbr/>Utils</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../functions/Utils.ErrorUtils.ensureError.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>ensure<wbr/>Error</span></a></li>
|
||
<li><a href="../functions/Utils.ErrorUtils.getError.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Error</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Utils.HexUtils"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Utils.HexUtils.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Hex<wbr/>Utils</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../functions/Utils.HexUtils.bigIntToHex.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>big<wbr/>Int<wbr/>To<wbr/>Hex</span></a></li>
|
||
<li><a href="../functions/Utils.HexUtils.bufferToHex.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>buffer<wbr/>To<wbr/>Hex</span></a></li>
|
||
<li><a href="../functions/Utils.HexUtils.numberToHex.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>number<wbr/>To<wbr/>Hex</span></a></li>
|
||
<li><a href="../functions/Utils.HexUtils.prepareAddress.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>prepare<wbr/>Address</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Utils.NumberUtils"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Utils.NumberUtils.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Number<wbr/>Utils</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../functions/Utils.NumberUtils.getRandomFromRange.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>get<wbr/>Random<wbr/>From<wbr/>Range</span></a></li>
|
||
<li><a href="../functions/Utils.NumberUtils.randomBigInteger.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>random<wbr/>Big<wbr/>Integer</span></a></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Utils.ObjectUtils"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Utils.ObjectUtils.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Object<wbr/>Utils</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../functions/Utils.ObjectUtils.exists.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>exists</span></a></li>
|
||
<li><a href="../functions/Utils.ObjectUtils.populate.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>populate</span></a></li>
|
||
<li><a href="../functions/Utils.ObjectUtils.swap.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>swap</span></a></li></ul></div></details></li></ul></div></details></li>
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Web"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Web.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Web</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li>
|
||
<details class="tsd-index-accordion" data-key="Web.Options"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/Web.Options.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>Options</span></a></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul class="tsd-nested-navigation">
|
||
<li><a href="../interfaces/Web.Options.Relayer.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Relayer</span></a></li></ul></div></details></li>
|
||
<li><a href="Web.Relayer.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Relayer</span></a></li>
|
||
<li><a href="Web.TorProvider.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Tor<wbr/>Provider</span></a></li>
|
||
<li><a href="../interfaces/Web.ObfuscationOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Obfuscation<wbr/>Options</span></a></li>
|
||
<li><a href="../interfaces/Web.WithdrawalRequestResult.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Withdrawal<wbr/>Request<wbr/>Result</span></a></li>
|
||
<li><a href="../types/Web.RelayerOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Relayer<wbr/>Options</span></a></li>
|
||
<li><a href="../variables/Web.RegularHttpClient.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Regular<wbr/>Http<wbr/>Client</span></a></li>
|
||
<li><a href="../variables/Web.TorHttpClient.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Tor<wbr/>Http<wbr/>Client</span></a></li></ul></div></details></li>
|
||
<li><a href="Core.html" class="current"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Core</span></a></li>
|
||
<li><a href="DepositCache.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Deposit<wbr/>Cache</span></a></li>
|
||
<li><a href="WithdrawalCache.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Withdrawal<wbr/>Cache</span></a></li></ul></nav></div></div></div>
|
||
<div class="tsd-generator">
|
||
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
||
<div class="overlay"></div></body></html> |