ethers.js/docs/hacking/index.html

13 lines
19 KiB
HTML
Raw Normal View History

2020-02-18 01:56:50 +03:00
<html><head><title>Hacking</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 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">IpcProvider</a></div><div class="hide link de
2019-12-14 06:05:10 +03:00
<a name="hacking"></a><h1 class="show-anchors"><div>Hacking<div class="anchors"><a class="self" href="#hacking"></a></div></div></h1>
<p>Things to keep in mind:</p>
<a name="supported-platforms"></a><h3 class="show-anchors"><div>Supported Platforms<div class="anchors"><a class="self" href="#supported-platforms"></a></div></div></h3>
<p>...</p>
<a name="dependencies"></a><h3 class="show-anchors"><div>Dependencies<div class="anchors"><a class="self" href="#dependencies"></a></div></div></h3>
<p>Adding a dependency is non-trivial and will require fairly convincing arguments.</p><p>Further, <b>ALL</b> dependencies for ethers, <b>must</b> be MIT licensed or public domain (CC0).</p><p>All contributions to ethers are then included under the MIT license.</p>
<a name="printable-ascii-(7-bit)-characters"></a><h3 class="show-anchors"><div>Printable ASCII (7-bit) Characters<div class="anchors"><a class="self" href="#printable-ascii-(7-bit)-characters"></a></div></div></h3>
<p>All source and documentation files should ONLY use the printable ASCII set.</p><p>This is for several reasons, bu...</p><ul><li>Transmission over certain HTTP servers and proxies can mangle UTF-8 data</li><li>Certain editors on some platforms, or in certain terminals cannot handle UTF-8 characters elegantly</li><li>The ability to enter non-ASCII characters on some platforms require special keyboards, input devices or input methods to be installed, which either not be supported, or may require administrative priviledges.</li></ul>
<a name="license"></a><h3 class="show-anchors"><div>License<div class="anchors"><a class="self" href="#license"></a></div></div></h3>
<p>MIT...</p>
<a name="other-considerations"></a><h3 class="show-anchors"><div>Other Considerations<div class="anchors"><a class="self" href="#other-considerations"></a></div></div></h3>
2020-02-18 01:56:50 +03:00
<p>A common argument to Pull Requests is that they are simple, backwards compatible and</p><p>It is important to remember that a small change is something that we are required to support in perpetuity.</p><p>For example, adding support for an obscure platform, such as adding a dot-file to the root of the package, now carries the implication that we will continue keeping that dot-file up-to-date as new versions of that platform are released.</p><div class="footer"> <div class="nav next"><a href="/getting-started/">Getting Started<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:2d878369503ff00b8bf2df3c438f0166077d4b62ae8547dc535bb364295611e3 -->