ethers.js/docs/getting-started/index.html

17 lines
19 KiB
HTML
Raw Normal View History

2020-02-18 01:56:50 +03:00
<html><head><title>Getting Started</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 myself ancestor ancestor show link depth-1"><a href="/getting-started/">Getting Started</a></div><div class="child link depth-2"><a href="/getting-started/#installing">Installing</a></div><div class="child 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 show link depth-1"><a href="/api/">Application Programming Interface</a></div><div class="hide 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="hide 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="hide link depth-2"><a href="/api/providers/">Providers</a></div><div class="hide 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="hide 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="hide 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/#alchemyprovider">AlchemyProvider</a></div><div class="hide link depth-4"><a href="/api/providers/api-providers/#cloudfrontprovider">CloudfrontProvider</a></div><div class="hide 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">IpcProvide
2019-12-14 06:05:10 +03:00
<a name="getting-started"></a><h1 class="show-anchors"><div>Getting Started<div class="anchors"><a class="self" href="#getting-started"></a></div></div></h1>
2019-12-14 06:05:10 +03:00
<a name="installing"></a><h2 class="show-anchors"><div>Installing<div class="anchors"><a class="self" href="#installing"></a></div></div></h2>
<p>The various Classes and Functions are available to be imported manually from sub-packages under the <a href="https://www.npmjs.com/search?q=%40ethersproject%2F">@ethersproject</a> but for most projects, the umbrella package is the easiest way to get started.</p>
<div class="code">/home/ricmoo&gt;&nbsp;npm&nbsp;install&nbsp;--save&nbsp;ethers@next</div>
2019-12-14 06:05:10 +03:00
<a name="importing"></a><h2 class="show-anchors"><div>Importing<div class="anchors"><a class="self" href="#importing"></a></div></div></h2>
2019-12-14 06:05:10 +03:00
<a name="node.js"></a><h3 class="show-anchors"><div>Node.js<div class="anchors"><a class="self" href="#node.js"></a></div></div></h3>
<div class="code"><span class="comment">// CommonJS</span><br>const { ethers } = require("ethers");<br><br><span class="comment">// ES6 or TypeScript </span><br>const { ethers } = require("ethers");<br></div>
2019-12-14 06:05:10 +03:00
<a name="web-browser"></a><h3 class="show-anchors"><div>Web Browser<div class="anchors"><a class="self" href="#web-browser"></a></div></div></h3>
<p>It is generally better practice (for security reasons) to copy the <a href="https://cdn.ethers.io/lib/ethers-5.0.esm.min.js">ethers library</a> to your own webserver and serve it yourself.</p><p>For quick demos or prototyping though, it can be loaded in your Web Applications from our CDN.</p>
<div class="code">&lt;script&nbsp;src="https://cdn.ethers.io/lib/ethers-5.0.esm.min.js"<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;type="application/javascipt"&gt;&lt;/script&gt;</div>
2020-02-18 01:56:50 +03:00
<div class="footer"><div class="nav previous"><a href="/"><span class="arrow">&larr;</span>Documentation</a></div> <div class="nav next"><a href="/concepts/">Concepts<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:4c7fb0c897ace511d7fdb0b2bc1bbbef5248fd69dc926b289c8f351a2a71a3cc -->