9 lines
14 KiB
HTML
9 lines
14 KiB
HTML
|
<html><head><title>Providers</title><link rel="stylesheet" type="text/css" href="/static/style.css"></head><body><div class="sidebar"><div class="header"><div class="logo"><a href="/"><div class="image"></div><div class="name">ethers.js</div><div class="version">v5.0</div></a></div></div><div class="toc"><div><div class="link title"><a href="/">Documentation</a></div><div class="base show link depth-1"><a href="/getting-started/">Getting Started</a></div><div class="hide link depth-2"><a href="/getting-started/#installing">Installing</a></div><div class="hide link depth-2"><a href="/getting-started/#importing">Importing</a></div><div class="base show link depth-1"><a href="/concepts/">Concepts</a></div><div class="hide link depth-2"><a href="/concepts/events/">Events</a></div><div class="hide link depth-2"><a href="/concepts/gas/">Gas</a></div><div class="hide link depth-3"><a href="/concepts/gas/#gas-price">Gas Price</a></div><div class="hide link depth-3"><a href="/concepts/gas/#gas-limit">Gas Limit</a></div><div class="base ancestor show link depth-1"><a href="/api/">Application Programming Interface</a></div><div class="show link depth-2"><a href="/api/contract/">Contracts</a></div><div class="hide link depth-3"><a href="/api/contract/#buckets">Buckets</a></div><div class="show link depth-2"><a href="/api/signer/">Signers</a></div><div class="hide link depth-3"><a href="/api/signer/#signer">Signer</a></div><div class="hide link depth-3"><a href="/api/signer/#wallet-inherits-signer">Wallet inherits Signer</a></div><div class="myself ancestor ancestor show link depth-2"><a href="/api/providers/">Providers</a></div><div class="child show link depth-3"><a href="/api/providers/provider/">Provider</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#accounts-methods">Accounts Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#blocks-methods">Blocks Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#ethereum-naming-service-(ens)-methods">Ethereum Naming Service (ENS) Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#logs-methods">Logs Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#network-status-methods">Network Status Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#transactions-methods">Transactions Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#event-emitter-methods">Event Emitter Methods</a></div><div class="hide link depth-4"><a href="/api/providers/provider/#inspection-methods">Inspection Methods</a></div><div class="child show link depth-3"><a href="/api/providers/jsonrpc-provider/">JSON-RPC Provider</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcprovider">JsonRpcProvider</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcsigner">JsonRpcSigner</a></div><div class="hide link depth-4"><a href="/api/providers/jsonrpc-provider/#jsonrpcuncheckedsigner">JsonRpcUncheckedSigner</a></div><div class="child show link depth-3"><a href="/api/providers/api-providers/">API Providers</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#etherscanprovider">EtherscanProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#infuraprovider">InfuraProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#nodesmithprovider">NodesmithProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#alchemyprovider">AlchemyProvider</a></div><div class="child show link depth-3"><a href="/api/providers/other/">Other Providers</a></div><div class="hide link depth-4"><a href="/api/providers/other/#fallbackprovider">FallbackProvider</a></div><div class="hide link depth-4"><a href="/api/providers/other/#ipcprovider">IpcProvider</a></div><div class="child show link depth-3"><a href="/api/providers/types/">Types</a></div><div class="hide link depth-4
|
||
|
|
<a name="providers"></a><h1>Providers</h1>
|
||
|
|
<p>A <b>Provider</b> is an abstraction of a connection to the Ethereum network, providing a concise, consistent interface to standard Ethereum node functionality.</p><p>The ethers.js library provides several options which should cover the vast majority of use-cases, but also includes the necessary functions and classes for sub-classing if a more custom configuration is necessary.</p><p>Most users should be able to simply use the <a href="/api/providers/#get-default-provider">Default Provider</a>.</p>
|
||
|
|
<a name="get-default-provider"></a><a name="default-provider"></a><h2>Default Provider</h2>
|
||
|
|
<p>The default provider is the safest, easiest way to begin developing on <i>Ethereum</i>, and it is also robust enough for use in production.</p><p>It creates a <a href="/api/providers/other/#provider-fallback">FallbackProvider</a> connected to as many backend services as possible. When a request is made, it is sent to multiple backends simulatenously. As responses from each backend are returned, they are checked that they agree. Once a quorum has been reached (i.e. enough of the backends agree), the response is provided to your application.</p><p>This ensures that if a backend has become out-of-sync, or if it has been compromised that its responses are dropped in favor of responses that match the majority.</p>
|
||
|
|
<div class="property"><div class="signature"><span class="path">ethers</span> . <span class="method">getDefaultProvider</span> ( [ <span class="param">network</span> ] ) <span class="arrow">⇒</span> <span class="returns"><a href="/api/providers/provider/">Provider</a></span></div><div class="body"><p>Returns a new Provider, backed by multiple services, connected to <i>network</i>. Is no <i>network</i> is provided, <b>homestead</b> (i.e. mainnet) is used.</p></div></div>
|
||
|
|
<a name="provider-documentation"></a><h2>Provider Documentation</h2>
|
||
|
|
|
||
|
|
<div class="toc"><div style="padding-left: 0px"><span class="bullet">•</span><a href="/api/providers/provider/">Provider</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/provider/#accounts-methods">Accounts Methods</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/provider/#blocks-methods">Blocks Methods</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/provider/#ethereum-naming-service-(ens)-methods">Ethereum Naming Service (ENS) Methods</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/provider/#logs-methods">Logs Methods</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/provider/#network-status-methods">Network Status Methods</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/provider/#transactions-methods">Transactions Methods</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/provider/#event-emitter-methods">Event Emitter Methods</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/provider/#inspection-methods">Inspection Methods</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/api/providers/jsonrpc-provider/">JSON-RPC Provider</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/jsonrpc-provider/#jsonrpcprovider">JsonRpcProvider</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/jsonrpc-provider/#jsonrpcsigner">JsonRpcSigner</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/jsonrpc-provider/#jsonrpcuncheckedsigner">JsonRpcUncheckedSigner</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/api/providers/api-providers/">API Providers</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/api-providers/#etherscanprovider">EtherscanProvider</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/api-providers/#infuraprovider">InfuraProvider</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/api-providers/#nodesmithprovider">NodesmithProvider</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/api-providers/#alchemyprovider">AlchemyProvider</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/api/providers/other/">Other Providers</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/other/#fallbackprovider">FallbackProvider</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/other/#ipcprovider">IpcProvider</a></div><div style="padding-left: 0px"><span class="bullet">•</span><a href="/api/providers/types/">Types</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/types/#blocks">Blocks</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/types/#events-and-logs">Events and Logs</a></div><div style="padding-left: 28px"><span class="bullet">•</span><a href="/api/providers/types/#transactions">Transactions</a></div></div><div class="footer"><div class="nav previous"><a href="/api/signer/"><span class="arrow">←</span>Signers</a></div> <div class="nav next"><a href="/api/providers/provider/">Provider<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 Attribution 4.0 International License</a>.</div></div><script src="/script.js" type="text/javascript"></script></body></html><!-- ContentHash:49
|