ethers.js/docs/api/providers/api-providers/index.html

16 lines
21 KiB
HTML
Raw Normal View History

2020-02-18 01:56:50 +03:00
<html><head><title>API 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</div><div class="version">v5.0-beta</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-3"><a href="/concepts/events/#solidity-topics">Solidity Topics</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">Wallet</a></div><div class="hide link depth-3"><a href="/api/signer/#voidsigner">VoidSigner</a></div><div class="hide link depth-3"><a href="/api/signer/#externallyownedaccount">ExternallyOwnedAccount</a></div><div class="ancestor show link depth-2"><a href="/api/providers/">Providers</a></div><div class="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="show link depth-3"><a href="/api/providers/jsonrpc-provider/">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="myself ancestor ancestor show link depth-3"><a href="/api/providers/api-providers/">API Providers</a></div><div class="child link depth-4"><a href="/api/providers/api-providers/#etherscanprovider">EtherscanProvider</a></div><div class="child link depth-4"><a href="/api/providers/api-providers/#infuraprovider">InfuraProvider</a></div><div class="child link depth-4"><a href="/api/providers/api-providers/#alchemyprovider">AlchemyProvider</a></div><div class="child link depth-4"><a href="/api/providers/api-providers/#cloudfrontprovider">CloudfrontProvider</a></div><div class="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/#ipcpr
2019-12-14 06:05:10 +03:00
<a name="api-providers"></a><h1 class="show-anchors"><div>API Providers<div class="anchors"><a class="self" href="#api-providers"></a></div></div></h1>
<p>There are many services which offer a web API for accessing the Ethereum Blockchain. These Providers allow connecting to them, which simplifies development, since you do not need to run your own instance or cluster of Ethereum nodes.</p><p>However, this reliance on third-party services can reduce resiliance, security and increase the amount of required trust. To mitigate these issues, it is recommended you use a <a href="/api/providers/#get-default-provider">Default Provider</a>.</p>
2020-02-02 08:53:22 +03:00
<a name="etherscanprovider"></a><h2 class="show-anchors"><div>EtherscanProvider<span class="inherits"> inherits <a href="/api/providers/provider/">Provider</a></span><div class="anchors"><a class="self" href="#etherscanprovider"></a></div></div></h2>
2019-12-14 06:05:10 +03:00
<p>The <b>EtherscanProvider</b> is backed by a combination of the various <a href="https://etherscan.io/apis">Etherscan APIs</a>.</p>
2020-02-02 08:53:22 +03:00
<div class="property show-anchors"><div class="signature"><span class="path">provider</span> . <span class="method">getHistory</span> ( <span class="param">address</span> ) <span class="arrow">&rArr;</span> <span class="returns">Array&lt;&thinsp;History&thinsp;&gt;</span><div class="anchors"></div></div><div class="body"><p>@TODO... Explain</p></div></div>
2020-02-18 01:56:50 +03:00
<div class="definition show-anchors"><div class="term"><b>Supported Networks</b></div><div class="body"><ul><li>Homestead (Mainnet)</li><li>Ropsten (proof-of-work testnet)</li><li>Rinkeby (proof-of-authority testnet)</li><li>G&ouml;rli (clique testnet)</li><li>Kovan (proof-of-authority testnet)</li></ul></div></div>
2020-02-02 08:53:22 +03:00
<a name="infuraprovider"></a><h2 class="show-anchors"><div>InfuraProvider<span class="inherits"> inherits <a href="/api/providers/other/#provider-urljsonrpc">UrlJsonRpcProvider</a></span><div class="anchors"><a class="self" href="#infuraprovider"></a></div></div></h2>
<p>The <b>InfuraProvider</b> is backed by the popular <a href="https://infura.io">INFURA</a> Ethereum service.</p>
2020-02-18 01:56:50 +03:00
<div class="definition show-anchors"><div class="term"><b>Supported Networks</b></div><div class="body"><ul><li>Homestead (Mainnet)</li><li>Ropsten (proof-of-work testnet)</li><li>Rinkeby (proof-of-authority testnet)</li><li>G&ouml;rli (clique testnet)</li><li>Kovan (proof-of-authority testnet)</li></ul></div></div>
2020-02-02 08:53:22 +03:00
<a name="alchemyprovider"></a><h2 class="show-anchors"><div>AlchemyProvider<span class="inherits"> inherits <a href="/api/providers/other/#provider-urljsonrpc">UrlJsonRpcProvider</a></span><div class="anchors"><a class="self" href="#alchemyprovider"></a></div></div></h2>
<p>The <b>AlchemtProvider</b> is backed by <a href="https://alchemyapi.io">Alchemy</a>.</p>
2020-02-18 01:56:50 +03:00
<div class="definition show-anchors"><div class="term"><b>Supported Networks</b></div><div class="body"><ul><li>Homestead (Mainnet)</li><li>Ropsten (proof-of-work testnet)</li><li>Rinkeby (proof-of-authority testnet)</li><li>G&ouml;rli (clique testnet)</li><li>Kovan (proof-of-authority testnet)</li></ul></div></div>
2020-02-02 08:53:22 +03:00
<a name="cloudfrontprovider"></a><h2 class="show-anchors"><div>CloudfrontProvider<span class="inherits"> inherits <a href="/api/providers/other/#provider-urljsonrpc">UrlJsonRpcProvider</a></span><div class="anchors"><a class="self" href="#cloudfrontprovider"></a></div></div></h2>
<p>The CloudfrontProvider is backed by the <a href="https://developers.cloudflare.com/distributed-web/ethereum-gateway/">Cloudflare Ethereum Gateway</a>.</p>
2020-02-18 01:56:50 +03:00
<div class="definition show-anchors"><div class="term"><b>Supported Networks</b></div><div class="body"><ul><li>Homestead (Mainnet)</li></ul></div></div><div class="footer"><div class="nav previous"><a href="/api/providers/jsonrpc-provider/"><span class="arrow">&larr;</span>JsonRpcProvider</a></div> <div class="nav next"><a href="/api/providers/other/">Other Providers<span class="arrow">&rarr;</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:00efe9c4dec775b5a199b28a3a191bfa7f6b90302d9390b650a8cb22a4b4b45b -->