37 lines
22 KiB
HTML
37 lines
22 KiB
HTML
<html><head><title>Flatworm Docs</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 depth-4"><a href="/api/providers/other/#urljsonrpcprovider">UrlJsonRpcProvider</a></div><div class="hide link depth-4"><a href="/api/providers/other/#web3provider">Web3Provider</a></div><div class="hide link depth-3"><a href="/api/providers/types/">Types</a></div><div class="hide link depth-4"><a href="/api/providers/types/#network">Network</a></div><div class="hide link depth-4"><a href="/api/providers/types/#block">Block</a></div><div class="hide link depth-4"><a href="/api/providers/types/#events-and-logs">Events and Logs</a></div><div class="hide link depth-4"><a href="/api/providers/types/#transactions">Transactions</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/address/">Addresses</a></div><div class="hide link depth-4"><a href="/api/utils/address/#address-formats">Address Formats</a></div><div class="hide link depth-4"><a href="/api/utils/address/#functions">Functions</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/#formats">Formats</a></div><div class="hide link depth-4"><a href="/api/utils/abi/#fragment">Fragment</a></div><div class="hide link depth-4"><a href="/api/utils/abi/#constructorfragment">ConstructorFragment</a></div><div class="hide link depth-4"><a href="/api/utils/abi/#eventfragment">EventFragment</a></div><div class="hide link depth-4"><a href="/api/utils/abi/#functionfragment">FunctionFragment</a></div><div class="hide link depth-4"><a href="/api/utils/abi/#paramtype">ParamType</a></div><div class="hide link depth-3"><a href="/api/utils/bignumber/">BigNumber</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#creating-instances">Creating Instances</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#methods">Methods</a></div><div class="hide link depth-4"><a href="/api/utils/bignumber/#notes">Notes</a></div><div class="hide link depth-3"><a href="/api/utils/bytes/">Byte Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#inspection">Inspection</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#converting-between-arrays-and-hexstrings">Converting between Arrays and Hexstrings</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#array-manipulation">Array Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#hexstring-manipulation">Hexstring Manipulation</a></div><div class="hide link depth-4"><a href="/api/utils/bytes/#signature-conversion">Signature Conversion</a></div><div class="hide link depth-3"><a href="/api/utils/constants/">Constants</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#bytes">Bytes</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#strings">Strings</a></div><div class="hide link depth-4"><a href="/api/utils/constants/#bignumber">BigNumber</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-4"><a href="/api/utils/display-logic/#units">Units</a></div><div class="hide link depth-4"><a href="/api/utils/display-logic/#functions">Functions</a></div><div class="hide link depth-3"><a href="/api/utils/fixednumber/">FixedNumber</a></div><div class="hide link depth-4"><a href="/api/utils/fixednumber/#fixedformat">FixedFormat</a></div><div class="hide link depth-4"><a href="/api/utils/fixednumber/#creating-instances">Creating Instances</a></div><div class="hide link depth-4"><a href="/api/utils/fixednumber/#properties">Properties</a></div><div class="hide link depth-4"><a href="/api/utils/fixednumber/#methods">Methods</a></div><div class="hide link depth-3"><a href="/api/utils/hashing/">Hashing Algorithms</a></div><div class="hide link depth-4"><a href="/api/utils/hashing/#cryptographic-hashing">Cryptographic Hashing</a></div><div class="hide link depth-4"><a href="/api/utils/hashing/#common-hashing-helpers">Common Hashing Helpers</a></div><div class="hide link depth-4"><a href="/api/utils/hashing/#solidity-hashing-algorithms">Solidity Hashing Algorithms</a></div><div class="hide link depth-3"><a href="/api/utils/strings/">Strings</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#bytes32string">Bytes32String</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#utf-8-strings">UTF-8 Strings</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#unicodenormalizationform">UnicodeNormalizationForm</a></div><div class="hide link depth-4"><a href="/api/utils/strings/#custom-utf-8-error-handling">Custom UTF-8 Error Handling</a></div><div class="hide link depth-3"><a href="/api/utils/transactions/">Transactions</a></div><div class="hide link depth-4"><a href="/api/utils/transactions/#types">Types</a></div><div class="hide link depth-4"><a href="/api/utils/transactions/#functions">Functions</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/hardware/">Hardware Wallets</a></div><div class="hide link depth-4"><a href="/api/other/hardware/#ledgersigner">LedgerSigner</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-3"><a href="/cli/ethers/#help">Help</a></div><div class="hide link depth-3"><a href="/cli/ethers/#examples">Examples</a></div><div class="hide link depth-2"><a href="/cli/asm/">Assembler</a></div><div class="hide link depth-3"><a href="/cli/asm/#help">Help</a></div><div class="hide link depth-3"><a href="/cli/asm/#examples">Examples</a></div><div class="hide link depth-2"><a href="/cli/ens/">ENS</a></div><div class="hide link depth-3"><a href="/cli/ens/#help">Help</a></div><div class="hide link depth-3"><a href="/cli/ens/#examples">Examples</a></div><div class="hide link depth-2"><a href="/cli/typescript/">TypeScript</a></div><div class="hide link depth-3"><a href="/cli/typescript/#help">Help</a></div><div class="hide link depth-3"><a href="/cli/typescript/#examples">Examples</a></div><div class="hide link depth-2"><a href="/cli/plugin/">Making Your Own</a></div><div class="hide link depth-3"><a href="/cli/plugin/#cli">CLI</a></div><div class="hide link depth-3"><a href="/cli/plugin/#plugin">Plugin</a></div><div class="hide link depth-3"><a href="/cli/plugin/#argparser">ArgParser</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/#from-web3">From Web3</a></div><div class="hide link depth-2"><a href="/migration/#from-ethers-v4">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="hide link depth-2"><a href="/contributing/#building">Building</a></div><div class="base myself ancestor ancestor show link depth-1"><a href="/documentation/">Flatworm Docs</a></div><div class="child link depth-2"><a href="/documentation/#fragments">Fragments</a></div><div class="child link depth-2"><a href="/documentation/#markdown">Markdown</a></div><div class="child link depth-2"><a href="/documentation/#configuration">Configuration</a></div><div class="child link depth-2"><a href="/documentation/#extended-directive-functions">Extended Directive Functions</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">Flatworm Docs</span></div>
|
|
<a name="flatworm-docs"></a><h1 class="show-anchors"><div>Flatworm Docs<div class="anchors"><a class="self" href="#flatworm-docs"></a></div></div></h1>
|
|
<p>The <i>Flatworm Docs</i> rendering script is designed to be <b>very</b> simple, but provide enough formatting necessary for documenting JavaScript libraries.</p><p>A lot of its inspiration came from <a href="https:<i>github.com/readthedocs/sphinx_rtd_theme">Read the Docs</a> and the <a href="https:</i>www.sphinx-doc.org/">Sphinx</a> project.</p>
|
|
<a name="flatworm-fragments"></a><a name="fragments"></a><h2 class="show-anchors"><div>Fragments<div class="anchors"><a class="self" href="#flatworm-fragments"></a></div></div></h2>
|
|
<p>Flatworm Docs are made up of fragments. A fragment is either a lone body of <a href="/documentation/#flatworm-markdown">markdown</a> text, or a <a href="/documentation/#flatworm-directive">directive</a> for specialized formatting, which may itself have body.</p>
|
|
<a name="directive-format"></a><h3 class="show-anchors"><div>Directive Format<div class="anchors"><a class="self" href="#directive-format"></a></div></div></h3>
|
|
|
|
<div class="code">_DIRECTIVE: VALUE @<LINK> @META<PARAMETER><br>BODY<br><br>DIRECTIVE: The directive name<br>VALUE: Optional; the value to pass to the directive<br>LINK: Optional; a name for internal linking<br>META: Optional; extended directive functionality<br>PARAMETER: Optional; value to pass to extended directive functions<br>BODY: Optional; the directive body (certain directives only)</div>
|
|
|
|
<a name="flatworm-directive"></a><a name="flatworm-directives"></a><h3 class="show-anchors"><div>Flatworm Directives<div class="anchors"><a class="self" href="#flatworm-directive"></a></div></div></h3>
|
|
|
|
<div class="definition show-anchors"><div class="term"><b>_section:</b> <i>TITLE</i></div><div class="body"><p>A <i>section</i> has its <b>TITLE</b> in an H1 font. Sections are linked to in <i>Table of Contents</i> and have a dividing line drawn above them. If an option is specified, it is avaialble as a name for intern linking. There should only be one <code class="inline">_section:</code> per page.</p></div></div>
|
|
<div class="definition show-anchors"><div class="term"><b>_subsection:</b> <i>TITLE</i></div><div class="body"><p>A <i>subsection</i> has its <b>TITLE</b> in an H2 font. Subsections are linked to in <i>Table of Contents</i> and have a dividing line drawn above them. If an option is specified, it is avaialble as a name for internal linking.</p></div></div>
|
|
<div class="definition show-anchors"><div class="term"><b>_heading:</b> <i>TITLE</i></div><div class="body"><p>A <i>heading</i> has its <b>TITLE</b> in an H3 font. If an option is specified, it is available as a name for internal linking.</p></div></div>
|
|
<div class="definition show-anchors"><div class="term"><b>_definition:</b> <i>TERM</i></div><div class="body"><p>A <i>definition</i> has its <b>TERM</b> bolded and the markdown body is indented.</p></div></div>
|
|
<div class="definition show-anchors"><div class="term"><b>_property:</b> <i>SIGNATURE</i></div><div class="body"><p>A <i>property</i> has its JavaScript <b>SIGNATURE</b> formatted and the markdown body is indented.</p></div></div>
|
|
<div class="definition show-anchors"><div class="term"><b>_note:</b> <i>TITLE</i></div><div class="body"><p>A <i>note</i> is placed in a blue bordered-box to draw attention to it.</p></div></div>
|
|
<div class="definition show-anchors"><div class="term"><b>_warning:</b> <i>TITLE</i></div><div class="body"><p>A <i>warning</i> is placed in an orange bordered-box to draw attention to it.</p></div></div>
|
|
<div class="definition show-anchors"><div class="term"><b>_code:</b> <i>FILENAME</i></div><div class="body"><p>A <i>code</i> reads the <b>FILENAME</b> and depending on the extension adjusts it.</p><p>For JavaScript files, the file is executed, with <code class="inline">//!</code> replaced with the result of the last statement and <code class="inline">//!error</code> is replaced with the throw error. If the error state does not agree, rendering fails.</p></div></div>
|
|
<div class="definition show-anchors"><div class="term"><b>_toc:</b></div><div class="body"><p>A <i>toc</i> injects a Table of Contents, loading each line of the body as a filename and recursively loads the <i>toc</i> if present, otherwise all the <i>sections</i> and <i>subsections</i>.</p></div></div>
|
|
<div class="definition show-anchors"><div class="term"><b>_null:</b></div><div class="body"><p>A <i>null</i> is used to terminated a directive. For example, after a <i>definition</i>, the bodies are indented, so a <i>null</i> can be used to reset the indentation.</p></div></div>
|
|
<a name="examples"></a><h3 class="show-anchors"><div>Examples<div class="anchors"><a class="self" href="#examples"></a></div></div></h3>
|
|
|
|
<div class="code">_section: Hello World @<link-to-this-section><br><br>_subsection: Some Example @<link-to-this-subsection><br><br>_heading: Large Bold Text @<link-to-this-heading><br><br>_definition: Flatworm<br>A phylum of relatively **simple** bilaterian, unsegmented,<br>soft-bodied invertebrates.<br><br>_property: String.fromCharCode(code) => string<br>Returns a string created from //code//, a sequence of<br>UTF-16 code units.<br><br>_code: filename.js<br><br>_toc:<br> some-file<br> some-directory<br><br>_definition and reset the indentation.<br><br>_note: Title<br>This is placed in a blue box.<br><br>_warning: Title<br>This is placed in an orange box.<br><br>_null:<br>This breaks out of a directive. For example, to end a</div>
|
|
|
|
<a name="flatworm-markdown"></a><a name="markdown"></a><h2 class="show-anchors"><div>Markdown<div class="anchors"><a class="self" href="#flatworm-markdown"></a></div></div></h2>
|
|
<p>The markdown is simple and does not have the flexibility of other dialects, but allows for <b>bold</b>, <i>italic</i>, <u>underlined</u>, <code class="inline">monospaced</code>, <sup>super-scripted</sup> text, supporting <a href="/documentation/#flatworm-markdown">links</a> and lists.</p>
|
|
<div class="code">**bold text**<br><br>//italic text//<br><br>__underlined text__<br><br>``monospace code``<br><br>^^superscript text^^<br><br>- This is a list<br>- With bullet points<br>- With a total of three items<br><br>This is separated by -- an en-dash.<br><br>This is separated by --- an em-dash.<br><br>This is a [Link to Ethereum](https://ethereum.org) and this<br>is an [Internal Link](some-link).<br><br>This is a self-titled link [[https://ethereumorg]] and this<br>[[some-link]] will use the title from its directives value.</div>
|
|
|
|
<a name="flatworm-config"></a><a name="configuration"></a><h2 class="show-anchors"><div>Configuration<div class="anchors"><a class="self" href="#flatworm-config"></a></div></div></h2>
|
|
<p>Configuration is optional (but highly recommended) and may be either a simple JSON file (config.json) or a JS file (config.js) placed in the top of the source folder.</p><p>TODO: example JSON and example JS</p>
|
|
<a name="flatworm-extended-directive-functions"></a><a name="extended-directive-functions"></a><h2 class="show-anchors"><div>Extended Directive Functions<div class="anchors"><a class="self" href="#flatworm-extended-directive-functions"></a></div></div></h2>
|
|
|
|
<a name="@inherit\<markdown>"></a><h3 class="show-anchors"><div>@INHERIT<markdown><div class="anchors"><a class="self" href="#@inherit\<markdown>"></a></div></div></h3>
|
|
<p>Adds an inherits description to a directive. The <i>markdown</i> may contain links.</p><p>This extended directive function is available for:</p><ul><li>_section</li><li>_subsetion</li><li>_heading</li></ul>
|
|
<a name="@src\<text>"></a><h3 class="show-anchors"><div>@SRC<text><div class="anchors"><a class="self" href="#@src\<text>"></a></div></div></h3>
|
|
<p>Calls the configuration <code class="inline">getSourceUrl(text, VALUE)</code> to get a URL which will be linked to by a link next to the <i>directive</i>.</p><p>This extended directive function requires an advanced <code class="inline">config.js</code> <a href="/documentation/#flatworm-config">Configuration</a> file since it requires a JavaScript function.</p><p>This extended directive function is available for:</p><ul><li>_section</li><li>_subsetion</li><li>_heading</li><li>_property</li></ul><div class="footer"><div class="nav previous"><a href="/contributing/"><span class="arrow">←</span>Contributing and Hacking</a></div> <div class="nav next"><a href="/license/">License and Copyright<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 Attribution 4.0 International License</a>.</div></div><script src="/script.js" type="text/javascript"></script></body></html><!-- ContentHash:c6caac3bd3d87b9a5b92fa42ce06235474c93daebdd1835257aaf53f7a9c0a71 --> |