54 lines
8.3 KiB
HTML
54 lines
8.3 KiB
HTML
<!DOCTYPE html>
|
|
<html class="paged">
|
|
<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="base show link depth-1"><a href="/concepts/">Ethereum Basics</a></div><div class="hide link depth-2"><a href="/concepts/events/">Events</a></div><div class="hide link depth-2"><a href="/concepts/gas/">Gas</a></div><div class="hide link depth-2"><a href="/concepts/security/">Security</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/">Contract Interaction</a></div><div class="hide link depth-3"><a href="/api/contract/contract/">Contract</a></div><div class="hide link depth-3"><a href="/api/contract/contract-factory/">ContractFactory</a></div><div class="hide link depth-3"><a href="/api/contract/example/">Example: ERC-20 Contract</a></div><div class="hide link depth-2"><a href="/api/signer/">Signers</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-3"><a href="/api/providers/jsonrpc-provider/">JsonRpcProvider</a></div><div class="hide link depth-3"><a href="/api/providers/api-providers/">API Providers</a></div><div class="hide link depth-3"><a href="/api/providers/other/">Other Providers</a></div><div class="hide link depth-3"><a href="/api/providers/types/">Types</a></div><div class="hide link depth-2"><a href="/api/utils/">Utilities</a></div><div class="hide link depth-3"><a href="/api/utils/abi/">Application Binary Interface</a></div><div class="hide link depth-4"><a href="/api/utils/abi/interface/">Interface</a></div><div class="hide link depth-4"><a href="/api/utils/abi/fragments/">Fragments</a></div><div class="hide link depth-3"><a href="/api/utils/address/">Addresses</a></div><div class="hide link depth-3"><a href="/api/utils/bignumber/">BigNumber</a></div><div class="hide link depth-3"><a href="/api/utils/bytes/">Byte Manipulation</a></div><div class="hide link depth-3"><a href="/api/utils/constants/">Constants</a></div><div class="hide link depth-3"><a href="/api/utils/display-logic/">Display Logic and Input</a></div><div class="hide link depth-3"><a href="/api/utils/encoding/">Encoding Utilities</a></div><div class="hide link depth-3"><a href="/api/utils/fixednumber/">FixedNumber</a></div><div class="hide link depth-3"><a href="/api/utils/hashing/">Hashing Algorithms</a></div><div class="hide link depth-3"><a href="/api/utils/hdnode/">HD Wallet</a></div><div class="hide link depth-3"><a href="/api/utils/logger/">Logging</a></div><div class="hide link depth-3"><a href="/api/utils/properties/">Property Utilities</a></div><div class="hide link depth-3"><a href="/api/utils/signing-key/">Signing Key</a></div><div class="hide link depth-3"><a href="/api/utils/strings/">Strings</a></div><div class="hide link depth-3"><a href="/api/utils/transactions/">Transactions</a></div><div class="hide link depth-3"><a href="/api/utils/web/">Web Utilities</a></div><div class="hide link depth-3"><a href="/api/utils/wordlists/">Wordlists</a></div><div class="hide link depth-2"><a href="/api/other/">Other Libraries</a></div><div class="hide link depth-3"><a href="/api/other/assembly/">Assembly</a></div><div class="hide link depth-4"><a href="/api/other/assembly/dialect/">Ethers ASM Dialect</a></div><div class="hide link depth-4"><a href="/api/other/assembly/api/">Utilities</a></div><div class="hide link depth-4"><a href="/api/other/assembly/ast/">Abstract Syntax Tree</a></div><div class="hide link depth-3"><a href="/api/other/hardware/">Hardware Wallets</a></div><div class="hide link depth-2"><a href="/api/experimental/">Experimental</a></div><div class="base show link depth-1"><a href="/cli/">Command Line Interfaces</a></div><div class="hide link depth-2"><a href="/cli/ethers/">Sandbox Utility</a></div><div class="hide link depth-2"><a href="/cli/asm/">Assembler</a></div><div class="hide link depth-2"><a href="/cli/ens/">Ethereum Naming Service</a></div><div class="hide link depth-2"><a href="/cli/typescript/">TypeScript</a></div><div class="hide link depth-2"><a href="/cli/plugin/">Making Your Own</a></div><div class="base show link depth-1"><a href="/cookbook/">Cookbook</a></div><div class="base show link depth-1"><a href="/migration/">Migration Guide</a></div><div class="hide link depth-2"><a href="/migration/web3/">Migration: From Web3.js</a></div><div class="hide link depth-2"><a href="/migration/ethers-v4/">Migration: From Ethers v4</a></div><div class="base show link depth-1"><a href="/testing/">Testing</a></div><div class="base show link depth-1"><a href="/contributing/">Contributing and Hacking</a></div><div class="base show link depth-1"><a href="/documentation/">Flatworm Docs</a></div><div class="base show link depth-1"><a href="/license/">License and Copyright</a></div>
|
|
</div></div>
|
|
</div>
|
|
<div class="content">
|
|
<div class="breadcrumbs"><a href="/">Documentation</a> » <span class="current">Hacking</span></div>
|
|
|
|
<a name="hacking"></a><h1 class="show-anchors"><div>Hacking<div class="anchors"><a class="self" href="/hacking/#hacking"></a></div></div></h1><p>Things to keep in mind:</p>
|
|
|
|
<a name="hacking--supported-platforms"></a><h3 class="show-anchors"><div>Supported Platforms<div class="anchors"><a class="self" href="/hacking/#hacking--supported-platforms"></a></div></div></h3><p>...</p>
|
|
|
|
<a name="hacking--dependencies"></a><h3 class="show-anchors"><div>Dependencies<div class="anchors"><a class="self" href="/hacking/#hacking--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="hacking--printable-ascii-7-bit-characters"></a><h3 class="show-anchors"><div>Printable ASCII (7-bit) Characters<div class="anchors"><a class="self" href="/hacking/#hacking--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>
|
|
|
|
<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></p>
|
|
|
|
<a name="hacking--license"></a><h3 class="show-anchors"><div>License<div class="anchors"><a class="self" href="/hacking/#hacking--license"></a></div></div></h3><p>MIT...</p>
|
|
|
|
<a name="hacking--other-considerations"></a><h3 class="show-anchors"><div>Other Considerations<div class="anchors"><a class="self" href="/hacking/#hacking--other-considerations"></a></div></div></h3><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 previous"><!--PREV_LINK--></div>
|
|
<div class="nav next"><!--NEXT_LINK--></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, 9:6pm.</div>
|
|
</div>
|
|
<script src="/static/script.js" type="text/javascript"></script>
|
|
</body>
|
|
</html>
|