69 lines
14 KiB
HTML
69 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html class="paged">
|
|
<head>
|
|
<title>Web Utilities</title>
|
|
<link rel="stylesheet" type="text/css" href="/v5/static/style.css">
|
|
</head>
|
|
<body>
|
|
<div class="sidebar">
|
|
<div class="header">
|
|
<div class="logo"><a href="/v5/"><div class="image"></div><div class="name">ethers</div><div class="version">v5.0-beta</div></a></div>
|
|
</div>
|
|
<div class="toc"><div>
|
|
<div class="link title"><a href="/v5/">Documentation</a></div><div class="base show link depth-1"><a href="/v5/getting-started/">Getting Started</a></div><div class="base show link depth-1"><a href="/v5/concepts/">Ethereum Basics</a></div><div class="hide link depth-2"><a href="/v5/concepts/events/">Events</a></div><div class="hide link depth-2"><a href="/v5/concepts/gas/">Gas</a></div><div class="hide link depth-2"><a href="/v5/concepts/security/">Security</a></div><div class="base ancestor show link depth-1"><a href="/v5/api/">Application Programming Interface</a></div><div class="show link depth-2"><a href="/v5/api/contract/">Contract Interaction</a></div><div class="hide link depth-3"><a href="/v5/api/contract/contract/">Contract</a></div><div class="hide link depth-3"><a href="/v5/api/contract/contract-factory/">ContractFactory</a></div><div class="hide link depth-3"><a href="/v5/api/contract/example/">Example: ERC-20 Contract</a></div><div class="show link depth-2"><a href="/v5/api/signer/">Signers</a></div><div class="show link depth-2"><a href="/v5/api/providers/">Providers</a></div><div class="hide link depth-3"><a href="/v5/api/providers/provider/">Provider</a></div><div class="hide link depth-3"><a href="/v5/api/providers/jsonrpc-provider/">JsonRpcProvider</a></div><div class="hide link depth-3"><a href="/v5/api/providers/api-providers/">API Providers</a></div><div class="hide link depth-3"><a href="/v5/api/providers/other/">Other Providers</a></div><div class="hide link depth-3"><a href="/v5/api/providers/types/">Types</a></div><div class="ancestor show link depth-2"><a href="/v5/api/utils/">Utilities</a></div><div class="show link depth-3"><a href="/v5/api/utils/abi/">Application Binary Interface</a></div><div class="hide link depth-4"><a href="/v5/api/utils/abi/interface/">Interface</a></div><div class="hide link depth-4"><a href="/v5/api/utils/abi/fragments/">Fragments</a></div><div class="show link depth-3"><a href="/v5/api/utils/address/">Addresses</a></div><div class="show link depth-3"><a href="/v5/api/utils/bignumber/">BigNumber</a></div><div class="show link depth-3"><a href="/v5/api/utils/bytes/">Byte Manipulation</a></div><div class="show link depth-3"><a href="/v5/api/utils/constants/">Constants</a></div><div class="show link depth-3"><a href="/v5/api/utils/display-logic/">Display Logic and Input</a></div><div class="show link depth-3"><a href="/v5/api/utils/encoding/">Encoding Utilities</a></div><div class="show link depth-3"><a href="/v5/api/utils/fixednumber/">FixedNumber</a></div><div class="show link depth-3"><a href="/v5/api/utils/hashing/">Hashing Algorithms</a></div><div class="show link depth-3"><a href="/v5/api/utils/hdnode/">HD Wallet</a></div><div class="show link depth-3"><a href="/v5/api/utils/logger/">Logging</a></div><div class="show link depth-3"><a href="/v5/api/utils/properties/">Property Utilities</a></div><div class="show link depth-3"><a href="/v5/api/utils/signing-key/">Signing Key</a></div><div class="show link depth-3"><a href="/v5/api/utils/strings/">Strings</a></div><div class="show link depth-3"><a href="/v5/api/utils/transactions/">Transactions</a></div><div class="myself ancestor ancestor show link depth-3"><a href="/v5/api/utils/web/">Web Utilities</a></div><div class="show link depth-3"><a href="/v5/api/utils/wordlists/">Wordlists</a></div><div class="show link depth-2"><a href="/v5/api/other/">Other Libraries</a></div><div class="hide link depth-3"><a href="/v5/api/other/assembly/">Assembly</a></div><div class="hide link depth-4"><a href="/v5/api/other/assembly/dialect/">Ethers ASM Dialect</a></div><div class="hide link depth-4"><a href="/v5/api/other/assembly/api/">Utilities</a></div><div class="hide link depth-4"><a href="/v5/api/other/assembly/ast/">Abstract Syntax Tree</a></div><div class="hide link depth-3"><a href="/v5/api/other/hardware/">Hardware Wallets</a></div><div class="show link depth-2"><a href="/v5/api/experimental/">Experimental</a></div><div class="base show link depth-1"><a href="/v5/cli/">Command Line Interfaces</a></div><div class="hide link depth-2"><a href="/v5/cli/ethers/">Sandbox Utility</a></div><div class="hide link depth-2"><a href="/v5/cli/asm/">Assembler</a></div><div class="hide link depth-2"><a href="/v5/cli/ens/">Ethereum Naming Service</a></div><div class="hide link depth-2"><a href="/v5/cli/typescript/">TypeScript</a></div><div class="hide link depth-2"><a href="/v5/cli/plugin/">Making Your Own</a></div><div class="base show link depth-1"><a href="/v5/cookbook/">Cookbook</a></div><div class="base show link depth-1"><a href="/v5/migration/">Migration Guide</a></div><div class="hide link depth-2"><a href="/v5/migration/web3/">Migration: From Web3.js</a></div><div class="hide link depth-2"><a href="/v5/migration/ethers-v4/">Migration: From Ethers v4</a></div><div class="base show link depth-1"><a href="/v5/testing/">Testing</a></div><div class="base show link depth-1"><a href="/v5/contributing/">Contributing and Hacking</a></div><div class="base show link depth-1"><a href="/v5/documentation/">Flatworm Docs</a></div><div class="base show link depth-1"><a href="/v5/license/">License and Copyright</a></div>
|
|
</div></div>
|
|
</div>
|
|
<div class="content">
|
|
<div class="breadcrumbs"><a href="/v5/">Documentation</a> » <a href="/v5/api/">API</a> » <a href="/v5/api/utils/">Utilities</a> » <span class="current">Web Utilities</span></div>
|
|
|
|
<a name="web"></a><a name="web"></a><h1 class="show-anchors"><div>Web Utilities<div class="anchors"><a class="self" href="/v5/api/utils/web/#web"></a></div></div></h1>
|
|
<a name="utils-fetchJson"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">fetchJson</span><span class="symbol">(</span> <span class="param">urlOrConnectionInfo</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">json</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">processFunc</span> <span class="symbol">]</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< any ></span><div class="anchors"><a class="self" href="/v5/api/utils/web/#utils-fetchJson"></a></div></div><div class="body"><p>Fetch and parse the JSON content from <i>urlOrConnectionInfo</i>, with the optiona body <i>json</i> and optionally processing the result with <i>processFun</i> before returning it.</p>
|
|
|
|
</div></div><a name="utils-poll"></a><div class="property show-anchors"><div class="signature"><span class="path">ethers</span><span class="symbol">.</span><span class="path">utils</span><span class="symbol">.</span><span class="method">poll</span><span class="symbol">(</span> <span class="param">pollFunc</span> <span class="symbol">[</span> <span class="symbol">,</span> <span class="param">options</span> <span class="symbol">]</span> <span class="symbol">)</span> <span class="arrow">⇒</span> <span class="returns">Promise< any ></span><div class="anchors"><a class="self" href="/v5/api/utils/web/#utils-poll"></a></div></div><div class="body"><p>Repeatedly call pollFunc using the <a href="/v5/api/utils/web/#PollOptions">PollOptions</a> until it returns a value other than undefined.</p>
|
|
|
|
</div></div><a name="ConnectionInfo"></a><a name="web--ConnectionInfo"></a><h3 class="show-anchors"><div>ConnectionInfo<div class="anchors"><a class="self" href="/v5/api/utils/web/#ConnectionInfo"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">connection</span><span class="symbol">.</span><span class="method">url</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The URL to connect to.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">connection</span><span class="symbol">.</span><span class="method">user</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The username to use for <a href="https://en.wikipedia.org/wiki/Basic_access_authentication">Basic Authentication</a>. The default is null (i.e. do not use basic authentication)</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">connection</span><span class="symbol">.</span><span class="method">password</span> <span class="arrow">⇒</span> <span class="returns">string</span><div class="anchors"></div></div><div class="body"><p>The password to use for <a href="https://en.wikipedia.org/wiki/Basic_access_authentication">Basic Authentication</a>. The default is null (i.e. do not use basic authentication)</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">connection</span><span class="symbol">.</span><span class="method">allowInsecureAuthentication</span> <span class="arrow">⇒</span> <span class="returns">boolean</span><div class="anchors"></div></div><div class="body"><p>Allow <a href="https://en.wikipedia.org/wiki/Basic_access_authentication">Basic Authentication</a> over non-secure HTTP. The default is false.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">connection</span><span class="symbol">.</span><span class="method">timeout</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>How long to wait before rejecting with a <i>timeout</i> error.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">connection</span><span class="symbol">.</span><span class="method">headers</span> <span class="arrow">⇒</span> <span class="returns">{[key:string]:string}</span><div class="anchors"></div></div><div class="body"><p>Additional headers to include in the connection.</p>
|
|
|
|
</div></div><a name="PollOptions"></a><a name="web--PollOptions"></a><h3 class="show-anchors"><div>PollOptions<div class="anchors"><a class="self" href="/v5/api/utils/web/#PollOptions"></a></div></div></h3>
|
|
<div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">timeout</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The amount of time allowed to ellapse before triggering a timeout error.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">floor</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The minimum time limit to allow for <a href="https://en.wikipedia.org/wiki/Exponential_backoff">Exponential Backoff</a>.</p>
|
|
|
|
<p>The default is 0s.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">ceiling</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The maximum time limit to allow for <a href="https://en.wikipedia.org/wiki/Exponential_backoff">Exponential Backoff</a>.</p>
|
|
|
|
<p>The default is 10s.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">interval</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The interval used during <a href="https://en.wikipedia.org/wiki/Exponential_backoff">Exponential Backoff</a> calculation.</p>
|
|
|
|
<p>The default is 250ms.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">retryLimit</span> <span class="arrow">⇒</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The number of times to retry in the event of an error or <i>undefined</i> is returned.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">onceBlock</span> <span class="arrow">⇒</span> <span class="returns"><a href="/v5/api/providers/provider/">Provider</a></span><div class="anchors"></div></div><div class="body"><p>If this is specified, the polling will wait on new blocks from <i>provider</i> before attempting the <i>pollFunc</i> again.</p>
|
|
|
|
</div></div><div class="property show-anchors"><div class="signature"><span class="path">options</span><span class="symbol">.</span><span class="method">oncePoll</span> <span class="arrow">⇒</span> <span class="returns"><a href="/v5/api/providers/provider/">Provider</a></span><div class="anchors"></div></div><div class="body"><p>If this is specified, the polling will occur on each poll cycle of <i>provider</i> before attempting the <i>pollFunc</i> again.</p>
|
|
|
|
</div></div>
|
|
|
|
<div class="footer">
|
|
<div class="nav previous"><a href="/v5/api/utils/transactions/"><span class="arrow">←</span>Transactions</a></div>
|
|
<div class="nav next"><a href="/v5/api/utils/wordlists/">Wordlists<span class="arrow">→</span></a></div>
|
|
</div>
|
|
<div class="copyright">The content of this site is licensed under the <a href="https://choosealicense.com/licenses/cc-by-4.0/">Creative Commons License</a>. Generated on June 10, 2020, 12:47am.</div>
|
|
</div>
|
|
<script src="/v5/static/script.js" type="text/javascript"></script>
|
|
</body>
|
|
</html>
|