2017-04-05 01:48:34 +03:00
<!DOCTYPE html>
<!-- [if IE 8]><html class="no - js lt - ie9" lang="en" > <![endif] -->
<!-- [if gt IE 8]><! --> < html class = "no-js" lang = "en" > <!-- <![endif] -->
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2017-05-22 03:37:29 +03:00
< title > Getting Started — ethers.js 2.1.0 documentation< / title >
2017-04-05 01:48:34 +03:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/css/ethers.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/css/ethers.css" type = "text/css" / >
2017-05-22 03:37:29 +03:00
< link rel = "top" title = "ethers.js 2.1.0 documentation" href = "index.html" / >
2017-04-05 01:48:34 +03:00
< link rel = "next" title = "Application Programming Interface (API)" href = "api.html" / >
< link rel = "prev" title = "What is ethers.js" href = "index.html" / >
< script src = "_static/js/modernizr.min.js" > < / script >
< / head >
< body class = "wy-body-for-nav" role = "document" >
< div class = "wy-grid-for-nav" >
< nav data-toggle = "wy-nav-shift" class = "wy-nav-side" >
< div class = "wy-side-scroll" >
< div class = "wy-side-nav-search" >
< a href = "index.html" class = "icon icon-home" > ethers.js
< / a >
< div class = "version" >
2017-05-22 03:37:29 +03:00
2.1.0
2017-04-05 01:48:34 +03:00
< / div >
< div role = "search" >
< form id = "rtd-search-form" class = "wy-form" action = "search.html" method = "get" >
< input type = "text" name = "q" placeholder = "Search docs" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "wy-menu wy-menu-vertical" data-spy = "affix" role = "navigation" aria-label = "main navigation" >
< p class = "caption" > < span class = "caption-text" > Developer Documentation< / span > < / p >
< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > Getting Started< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "#installing-in-node-js" > Installing in Node.js< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#including-in-web-applications" > Including in Web Applications< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "api.html" > Application Programming Interface (API)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "api-advanced.html" > Low-Level API< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cookbook.html" > Cookbook< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "notes.html" > Notes< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "testing.html" > Testing< / a > < / li >
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" role = "navigation" aria-label = "top navigation" >
< i data-toggle = "wy-nav-top" class = "fa fa-bars" > < / i >
< a href = "index.html" > ethers.js< / a >
< / nav >
< div class = "wy-nav-content" >
< div class = "rst-content" >
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
< li > < a href = "index.html" > Docs< / a > » < / li >
< li > Getting Started< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/getting-started.txt" rel = "nofollow" > View page source< / a >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< div class = "section" id = "getting-started" >
< h1 > Getting Started< a class = "headerlink" href = "#getting-started" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > The ethers.js library is a compact and complete JavaScript library for Ethereum.< / p >
< hr class = "docutils" / >
< div class = "section" id = "installing-in-node-js" >
< h2 > Installing in Node.js< a class = "headerlink" href = "#installing-in-node-js" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > From your project directory:< / p >
< div class = "highlight-default" > < div class = "highlight" > < pre > < span > < / span > < span class = "o" > /< / span > < span class = "n" > Users< / span > < span class = "o" > /< / span > < span class = "n" > ricmoo< / span > < span class = "o" > /< / span > < span class = "n" > my< / span > < span class = "o" > -< / span > < span class = "n" > project< / span > < span class = "o" > > < / span > < span class = "n" > npm< / span > < span class = "n" > install< / span > < span class = "o" > --< / span > < span class = "n" > save< / span > < span class = "n" > ethers< / span >
< / pre > < / div >
< / div >
< p > And from the relevant application files:< / p >
< div class = "highlight-default" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > var< / span > < span class = "n" > ethers< / span > < span class = "o" > =< / span > < span class = "n" > require< / span > < span class = "p" > (< / span > < span class = "s1" > ' ethers' < / span > < span class = "p" > );< / span >
< / pre > < / div >
< / div >
< / div >
< hr class = "docutils" / >
< div class = "section" id = "including-in-web-applications" >
< h2 > Including in Web Applications< a class = "headerlink" href = "#including-in-web-applications" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > For security purposes, it is usually best to place a copy of < a class = "reference external" href = "https://cdn.ethers.io/scripts/ethers-v2.0.min.js" > this script< / a > on
the application’ s server, but for a quick prototype using the Ethers CDN (content
distribution network) should suffice:< / p >
< div class = "highlight-default" > < div class = "highlight" > < pre > < span > < / span > < !-- This exposes the library as a global variable: ethers -->
< script src=" https://cdn.ethers.io/scripts/ethers-v2.0.min.js" type=" text/javascript" >
< /script>
< / pre > < / div >
< / div >
< hr class = "docutils" / >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "api.html" class = "btn btn-neutral float-right" title = "Application Programming Interface (API)" accesskey = "n" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
< a href = "index.html" class = "btn btn-neutral" title = "What is ethers.js" accesskey = "p" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
< / div >
< hr / >
< div role = "contentinfo" >
< p >
© Copyright 2016, Richard Moore < me@ricmoo.com> .
< / p >
< / div >
Built with < a href = "http://sphinx-doc.org/" > Sphinx< / a > using a < a href = "https://github.com/snide/sphinx_rtd_theme" > theme< / a > provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
2017-05-22 03:37:29 +03:00
VERSION:'2.1.0',
2017-04-05 01:48:34 +03:00
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
< / script >
< script type = "text/javascript" src = "_static/jquery.js" > < / script >
< script type = "text/javascript" src = "_static/underscore.js" > < / script >
< script type = "text/javascript" src = "_static/doctools.js" > < / script >
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
< / script >
< / body >
< / html >
