65 lines
9.1 KiB
HTML
65 lines
9.1 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html class="paged">
|
||
|
|
<head>
|
||
|
|
<title>Contributing and Hacking</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="/">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 show link depth-1"><a href="/v5/api/">Application Programming Interface</a></div><div class="hide 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="hide link depth-2"><a href="/v5/api/signer/">Signers</a></div><div class="hide 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="hide link depth-2"><a href="/v5/api/utils/">Utilities</a></div><div class="hide 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="hide link depth-3"><a href="/v5/api/utils/address/">Addresses</a></div><div class="hide link depth-3"><a href="/v5/api/utils/bignumber/">BigNumber</a></div><div class="hide link depth-3"><a href="/v5/api/utils/bytes/">Byte Manipulation</a></div><div class="hide link depth-3"><a href="/v5/api/utils/constants/">Constants</a></div><div class="hide link depth-3"><a href="/v5/api/utils/display-logic/">Display Logic and Input</a></div><div class="hide link depth-3"><a href="/v5/api/utils/encoding/">Encoding Utilities</a></div><div class="hide link depth-3"><a href="/v5/api/utils/fixednumber/">FixedNumber</a></div><div class="hide link depth-3"><a href="/v5/api/utils/hashing/">Hashing Algorithms</a></div><div class="hide link depth-3"><a href="/v5/api/utils/hdnode/">HD Wallet</a></div><div class="hide link depth-3"><a href="/v5/api/utils/logger/">Logging</a></div><div class="hide link depth-3"><a href="/v5/api/utils/properties/">Property Utilities</a></div><div class="hide link depth-3"><a href="/v5/api/utils/signing-key/">Signing Key</a></div><div class="hide link depth-3"><a href="/v5/api/utils/strings/">Strings</a></div><div class="hide link depth-3"><a href="/v5/api/utils/transactions/">Transactions</a></div><div class="hide link depth-3"><a href="/v5/api/utils/web/">Web Utilities</a></div><div class="hide link depth-3"><a href="/v5/api/utils/wordlists/">Wordlists</a></div><div class="hide 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="hide 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/">Sand
|
||
|
|
</div></div>
|
||
|
|
</div>
|
||
|
|
<div class="content">
|
||
|
|
<div class="breadcrumbs"><a href="/v5/">Documentation</a> » <span class="current">Contributing and Hacking</span></div>
|
||
|
|
|
||
|
|
<a name="contributing-and-hacking"></a><h1 class="show-anchors"><div>Contributing and Hacking<div class="anchors"><a class="self" href="/v5/contributing/#contributing-and-hacking"></a></div></div></h1><p>The ethers.js library is something that I've written out of necessity, and has grown somewhat organically over time.</p>
|
||
|
|
|
||
|
|
<p>Many things are the way they are for good (at the time, at least) reasons, but I always welcome criticism, and am completely willing to have my mind changed on things.</p>
|
||
|
|
|
||
|
|
<p>So, pull requests are always welcome, but please keep a few points in mind:</p>
|
||
|
|
|
||
|
|
<p><ul><li>Backwards-compatibility-breaking changes will not be accepted; they may be considered for the next major version </li><li>Security is important; adding dependencies require fairly convincing arguments as to why </li><li>The library aims to be lean, so keep an eye on the dist/ethers.min.js file size before and after your changes </li><li>Add test cases for both expected and unexpected input </li><li>Any new features need to be supported by me (future issues, documentation, testing, migration), so anything that is overly complicated or specific may not be accepted </li></ul></p>
|
||
|
|
|
||
|
|
<p>In general, <b>please start an issue <i>before</i> beginning a pull request</b>, so we can have a public discussion and figure out the best way to address to problem/feature. <b>:)</b></p>
|
||
|
|
|
||
|
|
<a name="contributing-and-hacking--building"></a><h2 class="show-anchors"><div>Building<div class="anchors"><a class="self" href="/v5/contributing/#contributing-and-hacking--building"></a></div></div></h2><p>If you wish to modify the source code, there are a few steps involved in setting up your environment.</p>
|
||
|
|
|
||
|
|
<div class="code-title"><div>Preparing the Package</div></div><div class="code"># Clone the REPO
|
||
|
|
/home/ricmoo> git clone git@github.com:ethers-io/ethers.js.git
|
||
|
|
/home/ricmoo> cd ethers.js
|
||
|
|
|
||
|
|
# Install the base dependencies
|
||
|
|
/home/ricmoo/ethers.js> npm install
|
||
|
|
|
||
|
|
# Install each module's dependencies and link the libraries
|
||
|
|
# internally, so they reference each other
|
||
|
|
/home/ricmoo/ethers.js> npm run bootstrap</div><div class="code-title"><div>Watching and Building</div></div><div class="code"># Begin watching the files and re-building whenever they change
|
||
|
|
/home/ricmoo/ethers.js> npm run auto-build
|
||
|
|
|
||
|
|
|
||
|
|
# Sometimes the issue only affects the ESM modules
|
||
|
|
/home/ricmoo/ethers.js> npm run auto-build-esm
|
||
|
|
|
||
|
|
|
||
|
|
# Or if you only need to run a single build
|
||
|
|
/home/ricmoo/ethers.js> npm run _build-cjs
|
||
|
|
/home/ricmoo/ethers.js> npm run _build-esm</div><div class="code-title"><div>Testing</div></div><div class="code"># Rebuilds all files and bundles testcases up for testing
|
||
|
|
/home/ricmoo/ethers.js> npm test
|
||
|
|
|
||
|
|
# Often you don't need the full CI experience
|
||
|
|
/home/ricmoo/ethers.js> npm run _test-node</div><div class="code-title"><div>Preparing the Distribution</div></div><div class="code">/home/ricmoo/ethers.js> npm run update-version</div>
|
||
|
|
|
||
|
|
<div class="footer">
|
||
|
|
<div class="nav previous"><a href="/v5/testing/"><span class="arrow">←</span>Testing</a></div>
|
||
|
|
<div class="nav next"><a href="/v5/documentation/">Flatworm Docs<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 8, 2020, 10:6pm.</div>
|
||
|
|
</div>
|
||
|
|
<script src="/v5/static/script.js" type="text/javascript"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|