Updated dist files (remove from beta).

.circleci/config.yml

@@ -1,147 +0,0 @@
-version: 2.1
-
-executors:
-  machine_executor:
-    machine: true
-    working_directory: ~/repo
-
-commands:
-  build-and-test:
-    parameters:
-      node-version:
-        type: string
-        default: "10.16.3"
-      test-script:
-        type: string
-        default: "test-node"
-      upgrade-chrome:
-        type: string
-        default: ""
-
-    steps:
-      - checkout
-
-      - when:
-          condition: << parameters.upgrade-chrome >>
-          steps:
-            - run:
-                name: Upgrade chrome
-                command: |
-                  sudo apt-get purge chromium-browser
-                  sudo apt-get update
-                  sudo apt-get install -y dpkg libappindicator1 fonts-liberation libgbm1
-                  wget https://cdn.ethers.io/downloads/google-chrome-stable_current_amd64.deb
-                  sudo dpkg -i google-chrome*.deb
-                  google-chrome --version
-
-      - run:
-          name: Update C build environment
-          command: |
-            sudo add-apt-repository ppa:ubuntu-toolchain-r/test
-            sudo apt update
-            sudo apt install gcc-6 g++-6 libusb-1.0-0-dev libudev-dev
-            sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-6 60 --slave /usr/bin/g++ g++ /usr/bin/g++-6
-
-#      - run:
-#          name: Prepare to run parity
-#          command: |
-#            mkdir -p /tmp/parity/keys
-#            cp -r admin/test-parity/parity-keys /tmp/parity/keys/DevelopmentChain
-#            cp admin/test-parity/parity-dev.* /tmp/parity
-#            chmod -R 777 /tmp/parity
-#            ls -la /tmp/parity
-
-#      - run:
-#          name: Starting Parity
-#          command: |
-#           docker run -d \
-#            -p 8545:8545 \
-#            -p 8546:8546 \
-#            -p 30303:30303 \
-#            -p 30303:30303/udp \
-#            --name parity \
-#            -v /tmp/parity:/home/parity/.local/share/io.parity.ethereum parity/parity:v2.4.8-stable \
-#            --chain /home/parity/.local/share/io.parity.ethereum/parity-dev.json \
-#            --unlock=0x7454a8F5a7c7555d79B172C89D20E1f4e4CC226C \
-#            --password /home/parity/.local/share/io.parity.ethereum/parity-dev.pwds \
-#            --min-gas-price 1000000000 \
-#            --jsonrpc-interface all
-
-#      - run:
-#          name: Waiting for Parity to be ready
-#          command: |
-#            for i in `seq 1 20`;
-#            do
-#              nc -z localhost 8545 && echo Success && exit 0
-#              echo -n .
-#              sleep 2
-#            done
-#            docker ps -a
-#            docker logs parity 
-#            echo Failed waiting for Parity && exit 1
-
-      - run:
-          name: Run << parameters.test-script >> with node version << parameters.node-version >>
-          command: |
-           [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm
-           [ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"
-           nvm install << parameters.node-version >>
-           node -v
-           npm -v
-           gcc --version
-           npm ci
-           npm run bootstrap
-           npm run << parameters.test-script >>
-
-jobs:
-  node-v8:
-    description: "test with node version 8"
-    executor: machine_executor
-    steps:
-      - build-and-test:
-          node-version: "8.16.1"
-          test-script: "test-node"
-
-  node-v10:
-    description: "test with node version 10"
-    executor: machine_executor
-    steps:
-      - build-and-test:
-          node-version: "10.16.3"
-          test-script: "test-node"
-
-  node-v12:
-    description: "test with node version 12"
-    executor: machine_executor
-    steps:
-      - build-and-test:
-          node-version: "12.13.1"
-          test-script: "test-node"
-
-  browser-esm:
-    description: "test browser with es6 module"
-    executor: machine_executor
-    steps:
-      - build-and-test:
-          node-version: "12.13.1"
-          test-script: "test-browser-esm"
-          upgrade-chrome: "true"
-
-  browser-umd:
-    description: "test browser with es3 module"
-    executor: machine_executor
-    steps:
-      - build-and-test:
-          node-version: "12.13.1"
-          test-script: "test-browser-umd"
-
-
-workflows:
-  version: 2
-  all:
-    jobs:
-      - node-v8
-      - node-v10
-      - node-v12
-      - browser-esm
-      - browser-umd

.github/workflows/nodejs.yml

@@ -0,0 +1,43 @@
+name: Node.js CI
+
+on:
+  push:
+    branches:
+      - ethers-v5-beta
+
+jobs:
+  test-node:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [8.x, 10.x, 12.x, 13.x]
+
+    steps:
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - uses: actions/checkout@v2
+      - run: npm ci
+      - run: npm run bootstrap
+      - run: npm run test-node
+
+  test-browser:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        module: [ 'esm', 'umd' ]
+
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+      - uses: actions/checkout@v2
+      - run: npm ci
+      - run: npm run bootstrap
+      - run: npm run test-browser-${{ matrix.module }}
+

CHANGELOG.md

@@ -2,10 +2,50 @@ Changelog
 =========
 
 This change log is managed by `scripts/cmds/update-versions` but may be manually updated.
-During the v5-BETA, although attempts are made to minimize it, some of the APIs
-may change. It is generally recommended that you remove your `node_modules/`,
-`package-lock.json` (and similar files for yarn, etc.) and doing an `npm install`
-after upgrading to a newer version of the v5-BETA.
+
+ethers/v5.0.0 (2020-06-12 19:58)
+--------------------------------
+
+  - Preserve config canary string. ([7157816](https://github.com/ethers-io/ethers.js/commit/7157816fa53f660d750811b293e3b1d5a2f70bd4))
+  - Updated docs. ([9e4c7e6](https://github.com/ethers-io/ethers.js/commit/9e4c7e609d9eeb5f2a11d6a90bfa9d32ee696431))
+
+ethers/v5.0.0-beta.192 (2020-06-12 04:51)
+-----------------------------------------
+
+  - Support nonpayable Solidity modifier in ABI. ([adc8d3d](https://github.com/ethers-io/ethers.js/commit/adc8d3d9aec2f5ee8e207f8bc77d99052e473d16))
+  - More debug information in timeout and fetch errors. ([#678](https://github.com/ethers-io/ethers.js/issues/678); [693094e](https://github.com/ethers-io/ethers.js/commit/693094e97ce4f0dc0cd49b9cf6b1557bd7dc517d))
+  - Use URL parse instead of constructor for react compatibility. ([#874](https://github.com/ethers-io/ethers.js/issues/874); [5e7d28b](https://github.com/ethers-io/ethers.js/commit/5e7d28b19b18aa1bbb4b851f74f6d7865725be02))
+
+ethers/v5.0.0-beta.191 (2020-06-03 03:41)
+-----------------------------------------
+
+  - Allow undefined properties in transaction object and fix stray this. ([#860](https://github.com/ethers-io/ethers.js/issues/860); [98bb589](https://github.com/ethers-io/ethers.js/commit/98bb58964bec7dff0ccf481d474354ec1ca6f376), [d2406c4](https://github.com/ethers-io/ethers.js/commit/d2406c42a18c123205918eb46bf24de0ff97ee23))
+  - Allow JsonRpcSigner to override from if it matches Signer. ([#862](https://github.com/ethers-io/ethers.js/issues/862); [1a89c59](https://github.com/ethers-io/ethers.js/commit/1a89c591c26a7fcc2031d0df90137d8a096c5c01))
+  - Added initial support for spontaneous network changes. ([#495](https://github.com/ethers-io/ethers.js/issues/495), [#861](https://github.com/ethers-io/ethers.js/issues/861); [2bc7bb6](https://github.com/ethers-io/ethers.js/commit/2bc7bb6e61219a40cfe2acd95c115c2195c21223), [d2ca4fb](https://github.com/ethers-io/ethers.js/commit/d2ca4fb443b2653063ca5aa349b52ecd0ff79e2f))
+
+ethers/v5.0.0-beta.190 (2020-06-01 05:02)
+-----------------------------------------
+
+  - Re-enable tests removed to fix slow CI. ([cd7a0b3](https://github.com/ethers-io/ethers.js/commit/cd7a0b36cd77df5d5951a97cdb6b6be1c9387f51))
+  - Major Contract refactor for overrides. ([#819](https://github.com/ethers-io/ethers.js/issues/819), [#845](https://github.com/ethers-io/ethers.js/issues/845), [#847](https://github.com/ethers-io/ethers.js/issues/847), [#860](https://github.com/ethers-io/ethers.js/issues/860); [42dee67](https://github.com/ethers-io/ethers.js/commit/42dee67187adb04d0b88f420b24cb3e73301d609))
+  - Remove legacy Circle CI tasks. ([c445232](https://github.com/ethers-io/ethers.js/commit/c445232980007d3474bc036ff59fb37638f93820))
+  - Fixing GitHub actions. ([#853](https://github.com/ethers-io/ethers.js/issues/853); [6b8f0f3](https://github.com/ethers-io/ethers.js/commit/6b8f0f3cb38295cd5d693f9b71f629b591206f1e))
+
+ethers/v5.0.0-beta.189 (2020-05-29 21:25)
+-----------------------------------------
+
+  - Simplify typing for properties module. ([41e66ab](https://github.com/ethers-io/ethers.js/commit/41e66ab834e9835807481658a7956207edfef3d7))
+  - Refactor Contract away from monolithic runMethod. ([e5a1b4d](https://github.com/ethers-io/ethers.js/commit/e5a1b4d5cbbaa0a8ce64c72e13d0d12fa2b856e3))
+  - Correctly set last emitted block for WebSocketProvider. ([#856](https://github.com/ethers-io/ethers.js/issues/856); [1b0ad5a](https://github.com/ethers-io/ethers.js/commit/1b0ad5aa69327f80c7814069142965914673dc06))
+  - Fixed delayed network detection attempting to overwrite read-only value. ([#854](https://github.com/ethers-io/ethers.js/issues/854); [8efd8d2](https://github.com/ethers-io/ethers.js/commit/8efd8d203158ebdef040ec759c3b423312a86e7c))
+  - Better WebSocket compatibilities with Parity. ([#849](https://github.com/ethers-io/ethers.js/issues/849); [180a1af](https://github.com/ethers-io/ethers.js/commit/180a1aff3adc5b4af3a1349b52666ca5942c92a2))
+
+ethers/v5.0.0-beta.188 (2020-05-21 00:02)
+-----------------------------------------
+
+  - Make filter blockHash property name match EIP-234. ([b03c4ed](https://github.com/ethers-io/ethers.js/commit/b03c4edd31a1929b411d0559d17eee7e3d6b11c8), [ed29fac](https://github.com/ethers-io/ethers.js/commit/ed29fac376c1a0aa210bf75979bb2ab62d0cf46b))
+  - Fixed FallbackProvider sync-stalling for backends. ([#841](https://github.com/ethers-io/ethers.js/issues/841); [f963589](https://github.com/ethers-io/ethers.js/commit/f96358940043123aa7a8fe97a1af7af293ce9740))
+  - Add correct tag to release on publish. ([#828](https://github.com/ethers-io/ethers.js/issues/828); [8516076](https://github.com/ethers-io/ethers.js/commit/85160766cdcd031f226382901ebadee9d7f40200))
 
 ethers/v5.0.0-beta.187 (2020-05-12 23:29)
 -----------------------------------------
@@ -257,8 +297,8 @@ ethers/v5.0.0-beta.163 (2020-01-06 18:57)
   - Add circleci and parity test files ([fdf0980](https://github.com/ethers-io/ethers.js/commit/fdf0980663ffead0faf3e9b7b233b22ca1574e21))
   - Fixed typo in package test dist scripts. ([9c78c7f](https://github.com/ethers-io/ethers.js/commit/9c78c7fee69d07733048d898d58205ae7f5c82d7))
 
-ethers/v5.0.0-beta.162 (2019-11-25 0:02)
-----------------------------------------
+ethers/v5.0.0-beta.162 (2019-11-25 00:02)
+-----------------------------------------
 
   - Update elliptic package to protect from Minerva timing attack. ([#666](https://github.com/ethers-io/ethers.js/issues/666); [cf036e1](https://github.com/ethers-io/ethers.js/commit/cf036e1ffad3340fcf1c7559d0032493ccc08e6e))
   - Browser and node testing works again. ([4470477](https://github.com/ethers-io/ethers.js/commit/4470477d7fd3031f2f3a1fbd9c538468c33c7350))

README.md

@@ -1,17 +1,35 @@
 The Ethers Project
 ==================
 
-**EXPERIMENTAL**
+[![npm (tag)](https://img.shields.io/npm/v/ethers/next)](https://www.npmjs.com/package/ethers/v/next)
+[![Node.js CI](https://github.com/ethers-io/ethers.js/workflows/Node.js%20CI/badge.svg?branch=ethers-v5-beta)](https://github.com/ethers-io/ethers.js/actions?query=workflow%3A%22Node.js+CI%22)
 
-This branch is the next release of ethers.js, which should
-be promoted to the official release shortly.
+A complete Ethereum wallet implementation and utilities in JavaScript (and TypeScript).
 
-I would recommend it for most new projects and personally use
-it for my own projects.
+**Features:**
 
-The [new documentation](https://docs-beta.ethers.io) is still a
-bit sparse, but is coming along as well and will be complete
-before the promotion to master.
+- Keep your private keys in your client, **safe** and sound
+- Import and export **JSON wallets** (Geth, Parity and crowdsale)
+- Import and export BIP 39 **mnemonic phrases** (12 word backup phrases) and **HD Wallets** (English as well as Czech, French, Italian, Japanese, Korean, Simplified Chinese, Spanish, Traditional Chinese)
+- Meta-classes create JavaScript objects from any contract ABI, including **ABIv2** and **Human-Readable ABI**
+- Connect to Ethereum nodes over [JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC), [INFURA](https://infura.io), [Etherscan](https://etherscan.io), [Alchemy](https://alchemyapi.io) or [MetaMask](https://metamask.io)
+- **ENS names** are first-class citizens; they can be used anywhere an Ethereum addresses can be used
+- **Tiny** (~104kb compressed; 322kb uncompressed)
+- **Modular** packages; include only what you need
+- **Complete** functionality for all your Ethereum desires
+- Extensive [documentation](https://docs.ethers.io/ethers.js/html/)
+- Large collection of **test cases** which are maintained and added to
+- Fully **TypeScript** ready, with definition files and full TypeScript source
+- **MIT License** (including ALL dependencies); completely open source to do with as you please
+
+
+Keep Updated
+------------
+
+For the latest news and advisories, please follow the [@ethersproject](https://twitter.com/ethersproject)
+on Twitter (low-traffic, non-marketting, important information only) as well as watch this GitHub project.
+
+For the latest changes, see the [CHANGELOG](https://github.com/ethers-io/ethers.js/blob/master/CHANGELOG.md).
 
 
 Installing
@@ -39,10 +57,22 @@ Installing
 ```
 
 
+Documentation
+-------------
+
+Browse the documentation online:
+
+- [Getting Started](https://docs.ethers.io/)
+- [Full API Documentation](https://docs.ethers.io/)
+- [Various Ethereum Articles](https://blog.ricmoo.com/)
+
+Or browser the entire documentations as a [single page](https://docs.ethers.io/single-page/).
+
+
 Ancillary Packages
 ------------------
 
-These are a number of packages not included in the umbrella `ethers ` npm package, and
+These are a number of packages not included in the umbrella `ethers` npm package, and
 additional packages are always being added. Often these packages are for specific
 use-cases, so rather than adding them to the umbrella package, they are added as
 ancillary packaged, which can be included by those who need them, while not bloating
@@ -50,46 +80,9 @@ everyone else with packages they do not need.
 
 We will keep a list of useful pacakges here.
 
-- `@ethersproject/experimental`
-- `@ethersproject/cli`
-- `@ethersproject/ens`
-- `@ethersproject/ledger`
-- `@ethersproject/trezor`
-
-
-Hacking
--------
-
-This project uses a combination of Lerna and the ./admin scripts to manage
-itself as a package of packages.
-
-The umbrella package can be found in `packages/ethers`, and all packages in general
-can be found in the `packages/` folder.
-
-If you add new dependencies to any package (incuding internal dependencies), you will
-need to re-create the internal links and re-build teh dependency graph::
-
-```
-/home/ethers> npm run bootstrap
-```
-
-To run a continuous build (with incremental TypeScript compilation):
-
-```
-/home/ethers> npm run auto-build
-```
-
-Finally, once you have made all your changes, you will need to bump the version
-of packages that changed their NPM tarballs, as well as update the _version.*
-and distribution builds (which is what we host on the CDN for browser-based
-apps). To do this, run:
-
-
-```
-/home/ethers> npm run update-versions
-```
-
-Which will also list all packages that have changed along with the specifc files.
+- `@ethersproject/experimental` ([documentation](https://docs.ethers.io))
+- `@ethersproject/cli` ([documentation](https://docs.ethers.io))
+- `@ethersproject/hardware-wallets` ([documentation](https://docs.ethers.io))
 
 
 License

admin/cmds/publish.js

@@ -2,8 +2,9 @@
 
 const config = require("../config");
 
-const { latestChange } = require("../changelog");
+const { ChangelogPath, latestChange } = require("../changelog");
 const { getOrdered, loadPackage } = require("../depgraph");
+const { getGitTag } = require("../git");
 const { createRelease } = require("../github");
 const { getPackageVersion, publish } = require("../npm");
 const { log } = require("../log");
@@ -35,6 +36,8 @@ if (process.argv.length > 2) {
 (async function() {
     let token = null;
 
+    const gitCommit = await getGitTag(ChangelogPath);
+
     let includeEthers = false;
 
     // @TODO: Fail if there are any untracked files or unchecked in files
@@ -107,7 +110,7 @@ if (process.argv.length > 2) {
         const change = latestChange();
 
         // Publish the release
-        const link = await createRelease(username, password, change.version, change.title, change.content, beta);
+        const link = await createRelease(username, password, change.version, change.title, change.content, beta, gitCommit);
         log(`<bold:Published Release:> ${ link }`);
     }
 

admin/cmds/spell-check.js

@@ -10,7 +10,7 @@ const Words = fs.readFileSync("/usr/share/dict/words").toString().split("\n").re
 
 `
 // Words missing from the dictionary
-accessing addresses aligned autofill called cancelled censored
+accessing addresses aligned autofill called cancelled changed censored
 compiled computed configured consumed creating decoded decoding
 decrypt decrypted decrypting deployed deploying deprecated detected
 discontinued earliest email enabled encoded encoding encrypt
@@ -18,11 +18,11 @@ encrypted encrypting entries euro exceeded existing expected
 expired failed fetches formatted formatting funding generated
 has ignoring implemented implementer imported including instantiate
 keyword labelled larger lookup matches mined modified modifies multi
-named nested neutered numeric offline optimizer owned packed
+named needed nested neutered numeric offline optimizer overriding owned packed
 padded parsed parsing passed placeholder processing reached
 recommended recovered redacted remaining replaced required
-serializes shared signed signing stored supported tagging targetted
-transactions uninstall unsubscribe using verifies website
+serializes shared signed signing skipped stored supported tagging targetted
+transactions uninstall unstake unsubscribe using verifies website
 
 // Overly Specific Words
 BIP BIP39 BIP44 crypto eip hashes hmac icap
@@ -47,7 +47,7 @@ callback calldata checksum ciphertext cli codepoint config
 contenthash ctr ctrl debug dd dklen eexist encseed eof ethaddr
 ethseed ethers eval exec filename func gz hid http https hw iv
 info init ipc json kdf kdfparams labelhash lang lib mm multihash nfc
-nfkc nfd nfkd nodehash oob opcode pbkdf pc plugin pragma pre prf
+nfkc nfd nfkd nodehash nullish oob opcode pbkdf pc plugin pragma pre prf
 repl rpc sighash topichash solc stdin stdout subclasses subnode
 timeout todo txt ufixed utc utf util url uuid vm vs websocket
 wikipedia wx xe yyyy zlib

admin/cmds/upload-docs.js

@@ -3,13 +3,12 @@
 const crypto = require('crypto');
 const fs = require('fs');
 const path = require('path');
-
 const AWS = require('aws-sdk');
 
 const config = require("../config");
 
 
-const Bucket = "docs-beta.ethers.io";
+const Bucket = "docs.ethers.io";
 
 
 function _getKeys(s3, result, nextToken, callback) {
@@ -86,7 +85,7 @@ function putObject(s3, name, content) {
             if (error) {
                 reject(error);
             } else {
-                console.log('Uplodaed:', name)
+                console.log("  Done.")
                 resolve({
                     name: name,
                     hash: data.ETag.replace(/"/g, '')
@@ -118,12 +117,18 @@ function _getFiles(result, root) {
     });
 }
 
-function getFiles(dirs) {
-    const result = { } //"index.html": hash("index.html") };
-    dirs.forEach(function(dir) {
-        _getFiles(result, dir);
-    })
-    return result;
+function getFiles(basedir) {
+    // Make sure we have a trailing slash
+    if (!basedir.match(/\/$/)) { basedir += "/"; }
+
+    // Fetch all the file hashes
+    const hashes = { };
+    _getFiles(hashes, basedir);
+
+    return Object.keys(hashes).reduce((accum, key) => {
+        accum[key.substring(basedir.length)] = hashes[key];
+        return accum;
+    }, { });
 }
 
 (async function() {
@@ -138,7 +143,9 @@ function getFiles(dirs) {
 
     const added = [], removed = [], changed = [], upload = [];
 
-    const local = await getFiles([ "docs" ]);
+    const basedir = path.resolve(__dirname, "../../docs");
+
+    const local = await getFiles(basedir);
     const remote = await getKeys(s3);
 
     Object.keys(local).forEach((filename) => {
@@ -166,7 +173,8 @@ function getFiles(dirs) {
 
     for (let i = 0; i < upload.length; i++) {
         const filename = upload[i];
-        console.log("Uploading:", filename);
-        await putObject(s3, filename, fs.readFileSync(filename));
+        const content = fs.readFileSync(path.resolve(basedir, filename));
+        console.log(`Uploading: ${ filename } (${ content.length } bytes)`);
+        await putObject(s3, filename, content);
     }
 })();

admin/config.js

@@ -22,6 +22,7 @@ function Config(filename) {
     this.salt = null;
     this.dkey = null;
     this.values = { };
+    this.canary = "";
     this.filename = filename;
 }
 
@@ -37,6 +38,8 @@ Config.prototype.load = async function() {
         };
     }
 
+    this.canary = data.canary || "";
+
     this.salt = data.salt;
 
     const password = await prompt.getPassword(colorify("Password (config-store): ", "bold"));
@@ -77,7 +80,8 @@ Config.prototype.save = function() {
         ciphertext: ciphertext.toString("base64"),
         iv: iv.toString("base64"),
         salt: this.salt,
-        hmac: hmac
+        hmac: hmac,
+        canary: this.canary
     };
 
     fs.writeFileSync(this.filename, JSON.stringify(data, null, 2));

docs.wrm/api/contract/contract-factory.wrm

@@ -1,5 +1,6 @@
 _section: ContractFactory @<ContractFactory> @SRC<contracts:class.ContractFactory>
 
+@TODO: Fill this in, including @SRC links
 
 _subsection: Creating Instances  @<ContractFactory--creating>
 
@@ -7,7 +8,7 @@ _property: new ethers.ContractFactory(interface, bydecode [ , signer ]) @SRC<con
 
 _property: ContractFactory.fromSolidity(compilerOutput [ , signer ]) => [[ContractFactory]]
 
-_property: contractFactory.connect(signer) => [[Contract]]
+_property: contractFactory.connect(signer) => [[Contract]] @<ContractFactory-connect>
 
 
 _subsection: Properties  @<ContractFactory--properties>
@@ -21,10 +22,10 @@ _property: contractFactory.signer => [[Signer]]
 
 _subsection: Methods  @<ContractFactory--methods>
 
-_property: contractFactory.attach(address) => [[Contract]]
+_property: contractFactory.attach(address) => [[Contract]] @<ContractFactory-attach>
 
 Return an instance of a [[Contract]] attched to //address//. This is the
-same as using the [Contract constructor](contract--creating) with
+same as using the [Contract constructor](Contract--creating) with
 //address// and this the the //interface// and //signerOrProvider// passed
 in when creating the ContractFactory.
 
@@ -33,7 +34,7 @@ _property: contractFactory.getDeployTransaction(...args) => [[UnsignedTransactio
 Returns the unsigned transaction which would deploy this Contract with //args// passed
 to the Contract's constructor.
 
-_property: contractFactory.deploy(...args) => Promise<[[Contract]]>
+_property: contractFactory.deploy(...args) => Promise<[[Contract]]> @<ContractFactory-deploy>
 
 Uses the signer to deploy the Contract with //args// passed into tgee constructor and
 retruns a Contract which is attached to  the address where this contract **will** be

docs.wrm/api/contract/contract.wrm

@@ -2,17 +2,17 @@ _section: Contract @<Contract> @SRC<contracts:class.Contract>
 
 Explain contract here...
 
-_subsection: Creating Instances @<contract--creating>
+_subsection: Creating Instances @<Contract--creating>
 
 _property: new ethers.Contract(address, abi, signerOrProvider) @src<contracts:constructor.Contract>
 
-_property: contract.attach(addressOrName) => [[Contract]]  @<contract-attach> @SRC<contracts:Contract.attach>
+_property: contract.attach(addressOrName) => [[Contract]]  @<Contract-attach> @SRC<contracts:Contract.attach>
 Returns a new instance of the **Contract** attached to a new
 address. This is useful if there are multiple similar or identical
 copies of a Contract on the network and you wish to interact with
 each of them.
 
-_property: contract.connect(providerOrSigner) => [[Contract]]  @<contract-connect> @SRC<contracts:Contract.connect>
+_property: contract.connect(providerOrSigner) => [[Contract]]  @<Contract-connect> @SRC<contracts:Contract.connect>
 Returns a new instance of the Contract, but connected to
 //providerOrSigner//.
 
@@ -23,7 +23,7 @@ By passing in a [[Signer]]. the will return a **Contract** which
 will act on behalf of that signer.
 
 
-_subsection: Properties  @<contrct--properties>
+_subsection: Properties  @<Contract--properties>
 
 _property: contract.address => string<[[address]]>
 This is the address (or ENS name) the contract was constructed with.
@@ -49,41 +49,41 @@ _property: contract.signer => [[Signer]]
 If a signer was provided to the constructor, this is that signer.
 
 
-_subsection: Methods
+_subsection: Methods @<Contract--methods>
 
-_property: contract.deployed() => Promise<[[Contract]]>  @<contract-deployed> @SRC<contracts>
+_property: contract.deployed() => Promise<[[Contract]]>  @<Contract-deployed> @SRC<contracts>
 
-_property: Contract.isIndexed(value) => boolean  @<contract-isIndexed> @SRC<contracts>
+_property: Contract.isIndexed(value) => boolean  @<Contract-isIndexed> @SRC<contracts>
 
 
-_subsection: Events
+_subsection: Events @<Contract--events>
 
-_property: contract.queryFilter(event [ , fromBlockOrBlockHash [ , toBlock ]) => Promise<Array<Event>> @<contract-queryFilter> @SRC<contracts>
+_property: contract.queryFilter(event [ , fromBlockOrBlockHash [ , toBlock ]) => Promise<Array<Event>> @<Contract-queryFilter> @SRC<contracts>
 Return Events that match the //event//.
 
-_property: contract.listenerCount([ event ]) => number  @<contract-listenerCount> @SRC<contracts:Contract.listenerCount>
+_property: contract.listenerCount([ event ]) => number  @<Contract-listenerCount> @SRC<contracts:Contract.listenerCount>
 Return the number of listeners that are subscribed to //event//. If
 no event is provided, returns the total count of all events.
 
-_property: contract.listeners(event) => Array<Listener>  @<contract-listeners> @SRC<contracts:Contract.listeners>
+_property: contract.listeners(event) => Array<Listener>  @<Contract-listeners> @SRC<contracts:Contract.listeners>
 Return a list of listeners that are subscribed to //event//.
 
-_property: contract.off(event, listener) => this  @<contract-off> @SRC<contracts>
+_property: contract.off(event, listener) => this  @<Contract-off> @SRC<contracts>
 Unsubscribe //listener// to //event//.
 
-_property: contract.on(event, listener) => this  @<contract-on> @SRC<contracts>
+_property: contract.on(event, listener) => this  @<Contract-on> @SRC<contracts>
 Subscribe to //event// calling //listener// when the event occurs.
 
-_property: contract.once(event, listener) => this  @<contract-once> @SRC<contracts>
+_property: contract.once(event, listener) => this  @<Contract-once> @SRC<contracts>
 Subscribe once to //event// calling //listener// when the event
 occurs.
 
-_property: contract.removeAllListeners([ event ]) => this  @<contract-removeAllListeners> @SRC<contracts:Contract.removeAllListeners>
+_property: contract.removeAllListeners([ event ]) => this  @<Contract-removeAllListeners> @SRC<contracts:Contract.removeAllListeners>
 Unsubscribe all listeners for //event//. If no event is provided,
 all events are unsubscribed.
 
 
-_subsection: Meta-Class  @<contract--metaclass>
+_subsection: Meta-Class  @<Contract--metaclass>
 
 A Meta-Class is a Class which has any of its properties determined
 at run-time. The **Contract** object uses a Contract's ABI to
@@ -92,7 +92,7 @@ describe the generic ways to interact with the properties added
 at run-time during the **Contract** constructor.
 
 
-_heading: Read-Only Methods (constant)  @<contract--readonly>
+_heading: Read-Only Methods (constant)  @<Contract--readonly>
 
 A constant method is read-only and evaluates a small amount of EVM
 code against the current blockchain state and can be computed by
@@ -100,7 +100,7 @@ asking a single node, which can return a result. It is therefore
 free and does not require any ether, but **cannot make changes** to
 the blockchain state..
 
-_property: contract.METHOD_NAME(...args [ overrides ]) => Promise<any>  @<contract-functionsCall>
+_property: contract.METHOD_NAME(...args [, overrides ]) => Promise<any>  @<Contract-functionsCall>
 The type of the result depends on the ABI.
 
 For values that have a simple meaning in JavaScript, the types are fairly
@@ -113,8 +113,24 @@ number is used. Otherwise a [[BigNumber]] is returned.
 
 For bytes (both fixed length and dynamic), a [[DataHexString]] is returned.
 
+_property: contract.functions.METHOD_NAME(...args [, overrides ]) => Promise<[[Result]]>
 
-_heading: Write Methods (non-constant) @<contract--write>
+The result will always be a [[Result]], even if there is only a single
+return value type.
+
+This simplifies frameworks which wish to use the [[Contract]] object,
+since they do not need to inspect the return types to unwrap simplified
+functions.
+
+Another use for this method is for error recovery. For example, if a
+function result is an invalid UTF-8 string, the normal call using the
+above meta-class function will throw an exception. This allows using the
+Result access error to access the low-level bytes and reason for the error
+allowing an alternate UTF-8 error strategy to be used.
+
+Most developers should not require this.
+
+_heading: Write Methods (non-constant) @<Contract--write>
 
 A non-constant method requires a transaction to be signed and requires
 payment in the form of a fee to be paid to a miner. This transaction
@@ -132,7 +148,7 @@ it is sent to the network. This requires the **Contract** has a
 signer.
 
 
-_heading: Write Methods Analysis @<contract--check>
+_heading: Write Methods Analysis @<Contract--check>
 
 There are secveral options to analyze properties and results of a
 write method without actually executing it.
@@ -154,9 +170,9 @@ return the result.
 This does not actually chagne any state, but is free. This in some cases
 can be used to determine if a transaction will fail or succeed.
 
-This otherwise functions the same as a [Read-Only Method](contract--readonly).
+This otherwise functions the same as a [Read-Only Method](Contract--readonly).
 
-_heading: Event Filters @<contract-filters>
+_heading: Event Filters @<Contract--filters>
 An event filter is made up of topics, which are values logged in a
 [[link-wiki-bloomfilter]], allowing efficient searching for entries
 which match a filter.

docs.wrm/api/index.wrm

@@ -1,4 +1,4 @@
-_section: Application Programming Interface @NAV<API>
+_section: Application Programming Interface  @<api> @NAV<API>
 
 An Application Programming Interface (API) is the formal
 specification of the library.

docs.wrm/api/other/assembly/index.wrm

@@ -1,5 +1,7 @@
 _section: Assembly
 
+This module should still be considered fairly experimental.
+
 _toc:
     dialect
     api

docs.wrm/api/providers/api-providers.wrm

@@ -77,7 +77,7 @@ _property: provider.getHistory(address) => Array<History> @src<providers>
 @TODO... Explain
 
 
-_subsection: InfuraProvider @INHERIT<[[UrlJsonRpcProvider]]> @src<providers:class.InfuraProvider>
+_subsection: InfuraProvider @<InfuraProvider> @INHERIT<[[UrlJsonRpcProvider]]> @src<providers:class.InfuraProvider>
 
 The **InfuraProvider** is backed by the popular [INFURA](link-infura)
 Ethereum service.
@@ -137,7 +137,7 @@ provider = new InfuraProvider("homestead", {
 });
 
 
-_subsection: AlchemyProvider @inherit<[[UrlJsonRpcProvider]]> @src<providers:class.AlchemyProvider>
+_subsection: AlchemyProvider @<AlchemyProvider> @inherit<[[UrlJsonRpcProvider]]> @src<providers:class.AlchemyProvider>
 
 The **AlchemyProvider** is backed by [Alchemy](link-alchemy).
 
@@ -183,7 +183,7 @@ provider = new AlchemyProvider(null, apiKey);
 provider = new AlchemyProvider("homestead", apiKey);
 
 
-_subsection: CloudflareProvider @inherit<[[UrlJsonRpcProvider]]> @src<providers:class.CloudflareProvider>
+_subsection: CloudflareProvider @<CloudflareProvider> @inherit<[[UrlJsonRpcProvider]]> @src<providers:class.CloudflareProvider>
 
 The CloudflareProvider is backed by the [Cloudflare Ethereum Gateway](link-cloudflare).
 

docs.wrm/api/providers/index.wrm

@@ -1,4 +1,4 @@
-_section: Providers
+_section: Providers @<providers>
 
 A **Provider** is an abstraction of a connection to the
 Ethereum network, providing a concise, consistent interface
@@ -41,14 +41,14 @@ _table: Option Properties
 $Alchemy:     [[link-alchemy]] API Token
 $Etherscan:   [[link-etherscan]] API Token
 $Infura:      [[link-infura]] Project ID or ProjectID and Project Secret
-$Quroum:      The number of backends that must agree
+$Quorum:      The number of backends that must agree
               //(default: 2 for mainnet, 1 for testnets)//
     
-|  **Property**  |  **Description**  |
-|    alchemy     | $Alchemt          |
-|   etherscan    | $Etherscan        |
-|    infura      | $Infura           |
-|    quorum      | $Quorum           |
+|    **Property**    |  **Description**  |
+|    //alchemy//     | $Alchemy          |
+|   //etherscan//    | $Etherscan        |
+|    //infura//      | $Infura           |
+|    //quorum//      | $Quorum           |
 
 _note: Note: API Keys
 

docs.wrm/api/providers/other.wrm

@@ -97,14 +97,50 @@ _subsection: Web3Provider @<Web3Provider> @INHERIT<[[JsonRpcProvider]]>
 
 The Web3Provider is meant to ease moving from a [web3.js based](link-web3)
 application to ethers by wraping an existing Web3-compatible (such as a
-[Web3HttpProvider](link-web3-http)[Web3IpcProvider](link-web3-ipc) or
+[Web3HttpProvider](link-web3-http), [Web3IpcProvider](link-web3-ipc) or
 [Web3WsProvider](link-web3-ws)) and exposing it as an ethers.js [[Provider]]
 which can then be used with the rest of the library.
 
-_property: new ethers.providers.Web3Provider(web3Provider [, network ])
-Create a new **Web3Provider**, which wraps an [EIP-1193 Provider]() or
+This may also be used to wrap a standard [EIP-1193 Provider](link-eip-1193].
+
+_property: new ethers.providers.Web3Provider(externalProvider [, network ])
+Create a new **Web3Provider**, which wraps an [EIP-1193 Provider](link-eip-1193) or
 Web3Provider-compatible Provider.
 
 _property: web3Provider.provider => Web3CompatibleProvider
 The provider used to create this instance.
 
+_heading: ExternalProvider @<Web3Provider--ExternalProvider>
+
+An **ExternalProvider** can be either one for the above mentioned Web3
+Providers (or otherwise compatible) or an [[link-eip-1193]] provider.
+
+An ExternalProvider must offer one of the following signatures, and the
+first matching is used:
+
+_property: externalProvider.request(request) => Promise<any>
+
+This follows the [[link-eip-1193]] API signature.
+
+The //request// should be a standard JSON-RPC payload, which should at
+a minimum specify the ``method`` and ``params``.
+
+The result should be the actual result, which differs from the Web3.js
+response, which is a wrapped JSON-RPC response.
+
+_property: externalProvider.sendAsync(request, callback) => void
+
+This follows the [Web3.js Provider Signature](link-web3-send).
+
+The //request// should be a standard JSON-RPC payload, which should at
+a minimum specify the ``method`` and ``params``.
+
+The //callback// should use the error-first calling semantics, so
+``(error, result)`` where the result is a JSON-RPC wrapped result.
+
+_property: externalProvider.send(request, callback) => void
+
+This is identical to ``sendAsync``. Historically, this used a synchronous
+web request, but no current browsers support this, so its use this way
+was deprecated quite a long time ago
+

docs.wrm/api/providers/provider.wrm

@@ -20,13 +20,7 @@ Returns the number of transactions //address// has ever **sent**, as of //blockT
 This value is required to be the nonce for the next transaction from //address//
 sent to the network.
 
-_heading: Examples
-
-_code: @lang<javascript>
-
-// <hide>
-const provider = ethers.getDefaultProvider()
-// </hide>
+_code: Account Examples @lang<javascript>
 
 // Get the balance for an account...
 provider.getBalance("ricmoo.firefly.eth");
@@ -55,10 +49,29 @@ _property: provider.getBlockWithTransactions(block) => Promise<[[providers-Block
 Get the //block// from the network, where the ``result.transactions`` is
 an Array of [[providers-TransactionResponse]] objects.
 
+_code: Block Examples @lang<javascript>
 
-_subsection: Ethereum Naming Service (ENS) Methods
+provider.getBlock(100004)
+//!
 
-TODO: Explain ENS here...
+provider.getBlockWithTransactions(100004)
+//!
+
+_subsection: Ethereum Naming Service (ENS) Methods @<Provider--ens-methods>
+
+The [Ethereum Naming Service](link-ens) (ENS) allows a short and
+easy-to-remember ENS Name to be atached to any set of keys
+and values.
+
+One of the most common uses for this is to use a simple name to
+refer to an [Ethereum Address](address).
+
+In the ethers API, nearly anywhere that accepts an address, an
+ENS name may be used instead, which can simplify code and make
+reading and debugging much simpler.
+
+The provider offers some basic operations to help resolve and
+work with ENS names.
 
 _property: provider.lookupAddress(address) => Promise<string>  @<Provider-lookupAddress> @SRC<providers/base-provider>
 Performs a reverse lookup of the //address// in ENS using the
@@ -70,13 +83,7 @@ Looks up the address of //name//. If the name is not owned, or
 does not have a //Resolver// configured, or the //Resolver// does
 not have an address configured, ``null`` is returned.
 
-_heading: Examples
-
-_code: @lang<javascript>
-
-// <hide>
-const provider = ethers.getDefaultProvider()
-// </hide>
+_code: ENS Examples @lang<javascript>
 
 // Reverse lookup of an ENS by address...
 provider.lookupAddress("0x6fC21092DA55B392b045eD78F4732bff3C580e2c");
@@ -108,6 +115,31 @@ Returns the block number (or height) of the most recently mined block.
 _property: provider.getGasPrice() => Promise<[[BigNumber]]>  @<Provider-getGasPrice> @SRC<providers/base-provider>
 Returns a //best guess// of the [[gas-price]] to use in a transaction.
 
+_code: Network Status Examples @lang<javascript>
+
+// The network information
+provider.getNetwork()
+// <hide>
+//!
+network = utils.shallowCopy(_)
+delete network._defaultProvider
+network
+// </hide>
+//!
+
+// The current block number
+provider.getBlockNumber()
+//!
+
+// Get the current suggested gas price (in wei)...
+gasPrice = await provider.getGasPrice()
+//! async gasPrice
+
+// ...often this gas price is easier to understand or
+// display to the user in gwei (giga-wei, or 1e9 wei)
+utils.formatUnits(gasPrice, "gwei")
+//!
+
 
 _subsection: Transactions Methods  @<Provider--transaction-methods>
 
@@ -226,14 +258,15 @@ $Debug:    each Provider may use this to emit useful debugging information
 |    ``"debug"``      |   provider dependent             <| $Debug             <<<|
 
 
-_code: Events Example @lang<javasript>
+_code: Events Example @lang<javascript>
 
 // <hide>
-const provider = ethers.getDefaultProvider();
 const txHash = utils.id("dummy-data");
+const myAddress = ethers.constants.HashZero;
+const myOtherAddress = ethers.constants.HashZero;
 // </hide>
 
-provide.on("block", (blockNumber) => {
+provider.on("block", (blockNumber) => {
     // Emitted on every block change
 })
 
@@ -246,7 +279,7 @@ provider.once(txHash, (transaction) => {
 // This filter could also be generated with the Contract or
 // Interface API. If address is not specified, any address
 // matches and if topics is not specified, any log matches
-const filter = {
+filter = {
     address: "dai.tokens.ethers.eth",
     topics: [
         utils.id("Transfer(address,address,uint256")
@@ -259,7 +292,7 @@ provider.on(filter, (log, event) => {
 
 // Notice this is an array of topic-sets and is identical to
 // using a filter with no address (i.e. match any address)
-const topicSets = [
+topicSets = [
     utils.id("Transfer(address,address,uint256"),
     null,
     [
@@ -276,10 +309,15 @@ provider.on("pending", (tx) => {
     // Emitted when any new pending transaction is noticed
 });
 
+
 provider.on("error", (tx) => {
     // Emitted when any error occurs
 });
 
+// <hide>
+// Make sure our documentation builds without waiting forever
+provider.removeAllListeners()
+// </hide>
 
 _subsection: Inspection Methods  @<Provider--inspection-methods>
 

docs.wrm/api/signer.wrm

@@ -1,19 +1,36 @@
+
 _section: Signers @<signers>
 
-A Signer represents...
+A **Signer** in //ethers// is an abstraction of an Ethereum Account,
+which can be used to sign messages and transactions and send
+signed transactions to the Ethereum Network to execute state
+changing operations.
+
+The available operations depends largely on the sub-class used.
+
+For example, a Signer from MetaMask can send transactions and sign
+messages but cannot sign a transaction (without broadcasting it).
+
+The most common Signers you will encounter are:
+
+- [[Wallet]], which is a class which knows its private key and can
+  execute any operations with it
+- [[JsonRpcSigner]], which is connected to a [[JsonRpcProvider]] (or
+  sub-class) and is acquired using [getSigner](JsonRpcProvider-getSigner)
 
 _subsection: Signer @<Signer> @SRC<abstract-signer:class.Signer>
 
-The **Signer** class is abstract and cannot be directly instaniated. Instead
-use one of the concreate sub-classes, such as the [[Wallet]], [[VoidSigner]]
-or [[JsonRpcSigner]].
+The **Signer** class is abstract and cannot be directly instaniated.
+
+Instead use one of the concreate sub-classes, such as the [[Wallet]],
+[[VoidSigner]] or [[JsonRpcSigner]].
 
 _property: signer.connect(provider) => [[Signer]]  @<Signer-connect>
 
 Sub-classes **must** implement this, however they may simply throw an error
 if changing providers is not supported.
 
-_property: signer.getAddress() => Promise<string<[Address](address)>>  @<Signer-getaddress> @SRC<abstract-signer:Signer.connect>
+_property: signer.getAddress() => Promise<string<[[address]]>>  @<Signer-getaddress> @SRC<abstract-signer:Signer.connect>
 Returns a Promise that resolves to the account address.
 
 This is a Promise so that a **Signer** can be designed around an
@@ -47,18 +64,19 @@ _property: signer.estimateGas(transactionRequest) => Promise<[[BigNumber]]>  @<S
 Returns the result of estimating the cost to send the //transactionRequest//,
 with this account address being used as the ``from`` field.
 
-_property: signer.resolveName(ensName) => Promise<string<[Address](address)>> @<Signer-resolveName> @SRC<abstract-signer>
+_property: signer.resolveName(ensName) => Promise<string<[[address]]>> @<Signer-resolveName> @SRC<abstract-signer>
 Returns the address associated with the //ensName//.
 
 
-_heading: Signing
+_heading: Signing @<Signer--signing-methods>
 
 _property: signer.signMessage(message) => Promise<string<[RawSignature](signature-raw)>> @<Signer-signMessage>
 This returns a Promise which resolves to the [[signature-raw]]
 of //message//.
 
 Sub-classes **must** implement this, however they may throw if signing a
-message is not supported.
+message is not supported, such as in a Contract-based Wallet or
+Meta-Transaction-based Wallet.
 
 _note: Note
 
@@ -83,24 +101,27 @@ Returns a Promise which resolves to the signed transaction of the
 //transactionRequest//. This method does not populate any missing fields.
 
 Sub-classes **must** implement this, however they may throw if signing a
-transaction is not supported.
+transaction is not supported, which is common for security reasons in many
+clients.
 
 _property: signer.sendTransaction(transactionRequest) => Promise<[[providers-TransactionResponse]]> @<Signer-sendTransaction>
 This method populates the transactionRequest with missing fields, using
 [populateTransaction](Signer-populateTransaction) and returns a Promise which resolves to the transaction.
 
-Sub-classes **must** implement this, however they may throw if signing a
-transaction is not supported.
+Sub-classes **must** implement this, however they may throw if sending a
+transaction is not supported, such as the [[VoidSigner]] or if the
+Wallet is offline and not connected to a [[Provider]].
 
 _heading: Sub-Classes @<Signer--subclassing>
 
 It is very important that all important properties of a **Signer** are
 **immutable**. Since Ethereum is very asynchronous and deals with critical
 data (such as ether and other potentially valuable crypto assets), keeping
-properties such as the //provider// and //address// static helps prevent
-serious issues.
+properties such as the //provider// and //address// static throughout the
+life-cycle of the Signer helps prevent serious issues and many other classes
+and libraries make this assumption.
 
-A sub-class **must** call ``super()``.
+A sub-class **must** extend Sigenr and **must** call ``super()``.
 
 _property: signer.checkTransaction(transactionRequest) => [[providers-TransactionRequest]]  @<Signer-checkTransaction> @SRC<abstract-signer>
 This is generally not required to be overridden, but may needed to provide
@@ -111,8 +132,9 @@ needed by ``call``, ``estimateGas`` and ``populateTransaction`` (which is used
 by sendTransaction). It should also throw an error if any unknown key is specified.
 
 The default implementation checks only valid [[providers-TransactionRequest]] properties
-exist and adds ``from`` to the transaction if it does not exist, or verifies it is equal
-to the Signer's address if it does exist.
+exist and adds ``from`` to the transaction if it does not exist.
+
+If there is a ``from`` field it **must** be verified to be equal to the Signer's address.
 
 _property: signer.populateTransaction(transactionRequest) => Promise<[[providers-TransactionRequest]]> @<Signer-populateTransaction> @SRC<abstract-signer>
 This is generally not required to be overridden, but may needed to provide
@@ -127,6 +149,7 @@ The default implementation calls ``checkTransaction`` and resolves to if it is a
 ENS name, adds ``gasPrice``, ``nonce``, ``gasLimit`` and ``chainId`` based on the
 related operations on Signer.
 
+
 _subsection: Wallet  @<Wallet> @INHERIT<[[ExternallyOwnedAccount]] and [[Signer]]> @SRC<wallet:class.Wallet>
 
 The Wallet class inherits [[Signer]] and can sign transactions and messages
@@ -141,10 +164,14 @@ Returns a new Wallet with a random private key, generated from
 cryptographically secure entropy sources. If the current environment
 does not have a secure entropy source, an error is thrown.
 
+Wallets created using this method will have a mnemonic.
+
 _property: ethers.Wallet.fromEncryptedJson(json, password [ , progress ])  => Promise<[[Wallet]]> @<Wallet-fromEncryptedJson> @SRC<wallet>
-Create an instance from an encrypted JSON wallet. If //progress//
-is provided it will be called during decryption with a value between 0 and
-1 indicating the progress towards completion.
+Create an instance from an encrypted JSON wallet.
+
+If //progress// is provided it will be called during decryption
+with a value between 0 and 1 indicating the progress towards
+completion.
 
 _property: ethers.Wallet.fromEncryptedJsonSync(json, password)  => [[Wallet]] @<Wallet-fromEncryptedJsonSync> @SRC<wallet>
 Create an instance from an encrypted JSON wallet.
@@ -153,16 +180,16 @@ This operation will operate synchronously which will lock up the user
 interface, possibly for a non-trivial duration. Most applications should
 use the asynchronous ``fromEncryptedJson`` instead.
 
-_property: ethers.Wallet.fromMnemonic(mnemonic [ , path, [ wordlist ] ]) => [[Wallet]]
+_property: ethers.Wallet.fromMnemonic(mnemonic [ , path, [ wordlist ] ]) => [[Wallet]] @<Wallet.fromMnemonic>
 Create an instance from a mnemonic phrase.
 
-If path is not specified, the Ethereum default path is used (i.e. m/44'/60'/0'/0/0).
+If path is not specified, the Ethereum default path is used (i.e. ``m/44'/60'/0'/0/0``).
 
 If wordlist is not specified, the English Wordlist is used.
 
-_heading: Properties
+_heading: Properties @<Wallet--properties>
 
-_property: wallet.address => string<[Address](address)>
+_property: wallet.address => string<[[address]]>
 The address for the account this Wallet represents.
 
 _property: wallet.provider => [[Provider]]
@@ -177,13 +204,82 @@ to the desired provider.
 _property: wallet.publicKey => string<[[DataHexString]]<65>>
 The uncompressed public key for this Wallet represents.
 
-_heading: Methods
+_heading: Methods @<Wallet--methods>
 
-_property: wallet.encrypt(password, [ options = { }, [ progress ] ]) => Promise<string>
+_property: wallet.encrypt(password, [ options = { }, [ progress ] ]) => Promise<string> @<Wallet-encrypt>
 
 Encrypt the wallet using //password// returning a Promise which resolves
 to a JSON wallet.
 
+If //progress// is provided it will be called during decryption
+with a value between 0 and 1 indicating the progress towards
+completion.
+
+_code: Wallet Examples @lang<javascript>
+
+// Create a wallet instance from a mnemonic...
+mnemonic = "announce room limb pattern dry unit scale effort smooth jazz weasel alcohol"
+walletMnemonic = Wallet.fromMnemonic(mnemonic)
+
+// ...or from a private key
+walletPrivateKey = new Wallet(walletMnemonic.privateKey)
+
+walletMnemonic.address === walletPrivateKey.address
+//!
+
+// The address as a Promise per the Signer API
+walletMnemonic.getAddress()
+//!
+
+// A Wallet address is also available synchronously
+walletMnemonic.address
+//!
+
+// The internal cryptographic components
+walletMnemonic.privateKey
+//!
+walletMnemonic.publicKey
+//!
+
+// The wallet mnemonic
+walletMnemonic.mnemonic
+//!
+
+// Note: A wallet created with a private key does not
+//       have a mnemonic (the derivation prevents it)
+walletPrivateKey.mnemonic
+//!
+
+// Signing a message
+walletMnemonic.signMessage("Hello World")
+//!
+
+tx = {
+  to: "0x8ba1f109551bD432803012645Ac136ddd64DBA72",
+  value: utils.parseEther("1.0")
+}
+
+// Signing a transaction
+walletMnemonic.signTransaction(tx)
+//!
+
+// The connect method returns a new instance of the
+// Wallet connected to a provider
+wallet = walletMnemonic.connect(provider)
+
+// Querying the network
+wallet.getBalance();
+//!
+wallet.getTransactionCount();
+//!
+
+// Sending ether
+wallet.sendTransaction(tx)
+// <hide>
+//! error
+// </hide>
+
+
 
 _subsection: VoidSigner  @<VoidSigner> @INHERIT<[[Signer]]> @SRC<abstract-signer:class.VoidSigner>
 
@@ -196,12 +292,48 @@ will be carried.
 For example, the ``call`` operation will automatically have the
 provided address passed along during the execution.
 
-_property: new ethers.VoidSigner(address) => [[VoidSigner]]
+_property: new ethers.VoidSigner(address [ , provider ]) => [[VoidSigner]]
 Create a new instance of a **VoidSigner** for //address//.
 
-_property: voidSigner.address => string<[Address](address)>
+_property: voidSigner.address => string<[[address]]>
 The address of this **VoidSigner**.
 
+_code: VoidSigner Pre-flight Example @lang<javascript>
+
+address = "0x8ba1f109551bD432803012645Ac136ddd64DBA72"
+signer = new ethers.VoidSigner(address, provider)
+
+// The DAI token contract
+abi = [
+  "function balanceOf(address) view returns (uint)",
+  "function transfer(address, uint) returns (bool)"
+]
+contract = new ethers.Contract("dai.tokens.ethers.eth", abi, signer)
+
+// <hide>
+//!
+// </hide>
+// Get the number of tokens for this account
+tokens = await contract.balanceOf(signer.getAddress())
+//! async tokens
+
+//
+// Pre-flight (check for revert) on DAI from the signer
+//
+// Note: We do not have the private key at this point, this
+//       simply allows us to check what would happen if we
+//       did. This can be useful to check before prompting
+//       a request in the UI
+//
+
+// This will pass since the token balance is available
+contract.callStatic.transfer("donations.ethers.eth", tokens)
+//!
+
+// This will fail since it is greater than the token balance
+contract.callStatic.transfer("donations.ethers.eth", tokens.add(1))
+//! error
+
 
 _subsection: ExternallyOwnedAccount  @<ExternallyOwnedAccount>
 
@@ -209,7 +341,7 @@ This is an interface which contains a minimal set of properties
 required for Externally Owned Accounts which can have certain
 operations performed, such as encoding as a JSON wallet.
 
-_property: eoa.address => string<[Address](address)>
+_property: eoa.address => string<[[address]]>
 
 The [[address]] of this EOA.
 

docs.wrm/api/utils/abi/coder.wrm

@@ -0,0 +1,48 @@
+_section: AbiCoder @<AbiCoder> @SRC<abi:class.AbiCoder>
+
+The **AbiCoder** is a collection of Coders which can be used to
+encode and decode the binary data formats used to interoperate
+between the EVM and higher level libraries.
+
+Most developers will never need to use this class directly, since
+the [[Interface]] class greatly simplifies these operations.
+
+
+_subsection: Creating Instance @<AbiCoder--creating>
+
+For the most part, there should never be a need to manually create
+an instance of an [[AbiCoder]], since one is created with the
+default coersion function when the library is loaded which can
+be used universally.
+
+This is likely only needed by those with specific needs to override
+how values are coerced after they are decoded from their binary format.
+
+_property: new ethers.utils.AbiCoder([coerceFunc]) @SRC<abi:constructor.AbiCoder>
+
+Create a new AbiCoder instance, which will call the //coerceFunc// on every
+decode, where the result of the call will be used in the Result.
+
+The function signature is `(type, value)`, where the //type// is the string
+describing the type and the //value// is the processed value from the underlying
+Coder.
+
+If the callback throws, the Result will contain a property that when accessed will
+throw, allowing for higher level libraries to recover from data errors.
+
+_property: ethers.utils.defaultAbiCoder => [[AbiCoder]]
+
+An [[AbiCoder]] created when the library is imported which is used by
+the [[Interface]].
+
+_subsection: Coding Methods @<AbiCoder--methods>
+
+_property: abiCoder.encode(types, values) => string<[[DataHexString]]> @<AbiCoder-encode> @SRC<abi/abi-coder>
+
+Encode the array //values// according the array of //types//, each of which may be a
+string or a [[ParamType]].
+
+_property: abiCoder.decode(types, data) => [[Result]] @<AbiCoder-decode> @SRC<abi/abi-coder>
+
+Decode the //data// according to the array of //types//, each of which may be a
+string or [[ParamType]].

docs.wrm/api/utils/abi/formats.wrm

@@ -0,0 +1,11 @@
+_section: ABI Formats @<abi-formats>
+
+@TODO: Expand this section
+
+_subsection: Human-Readable ABI @<abi-formats--human-readable-abi>
+
+See [Human-Readable Abi](link-ricmoo-humanreadableabi).
+
+_subsection: Solidity JSON ABI @<abi-formats--solidity>
+
+See [Solidity compiler](link-solc-output).

docs.wrm/api/utils/abi/index.wrm

@@ -15,5 +15,7 @@ framework, tool developers or developers using advanced techniques
 may find these classes and utilities useful.
 
 _toc:
-  interface
+  coder
+  formats
   fragments
+  interface

docs.wrm/api/utils/abi/interface.wrm

@@ -12,7 +12,7 @@ upon set of formats to encode various types of data which each contract can
 expect so they can interoperate with each other.
 
 
-_subsection: Creating Instances
+_subsection: Creating Instances @<Interface--creating>
 
 _property: new ethers.utils.Interface(abi) @SRC<abi/interface:constructor.Interface>
 Create a new **Interface** from a JSON string or object representing
@@ -26,7 +26,7 @@ which is a format the Ethers created to simplify manually typing the ABI
 into the source and so that a Contract ABI can also be referenced easily
 within the same source file.
 
-_subsection: Properties
+_subsection: Properties @<Interface--properties>
 
 _property: interface.fragments => Array<[[Fragment]]>
 All the [Fragments](Fragment) in the interface.
@@ -41,7 +41,7 @@ _property: interface.deploy => [[ConstructorFragment]]
 The [Constructor Fragments](ConstructorFragment) for the interface.
 
 
-_subsection: Formatting
+_subsection: Formatting @<Interface--formatting>
 
 _property: interface.format( [ format ]) => string | Array<string> @SRC<abi/interface>
 Return the formatted **Interface**. If the format type is ``json`` a
@@ -49,7 +49,7 @@ single string is returned, otherwise an Array of the human-readable
 strings is returned.
 
 
-_subsection: Fragment Access
+_subsection: Fragment Access @<Interface--fragments>
 
 _property: interface.getFunction(fragment) => [[FunctionFragment]]  @SRC<abi/interface>
 Returns the [[FunctionFragment]] for //fragment// (see [[Interface--specifying-fragments]]).
@@ -58,7 +58,7 @@ _property: interface.getEvent(fragment) => [[EventFragment]] @SRC<abi/interface>
 Returns the [[EventFragment]] for //fragment// (see [[Interface--specifying-fragments]]).
 
 
-_subsection: Signature and Topic Hashes
+_subsection: Signature and Topic Hashes @<Interface--selectors>
 
 _property: interface.getSighash(fragment) => string<[[DataHexString]]<4>> @SRC<abi/interface:method.Interface.getSighash>
 Return the sighash (or Function Selector) for //fragment// (see [[Interface--specifying-fragments]]).
@@ -67,7 +67,7 @@ _property: interface.getEventTopic(fragment) => string<[[DataHexString]]<32>> @S
 Return the topic hash for //fragment// (see [[Interface--specifying-fragments]]).
 
 
-_subsection: Encoding Data
+_subsection: Encoding Data @<Interface--encoding>
 
 _property: interface.encodeDeploy([ values ]) => string<[[DataHexString]]> @SRC<abi/interface>
 Return the encoded deployment data, which can be concatenated to the
@@ -91,7 +91,7 @@ Returns the encoded result, which would normally be the response from a call for
 Most developers will not need this method, but may be useful for authors of a mock blockchain.
 
 
-_subsection: Decoding Data
+_subsection: Decoding Data @<Interface--decoding>
 
 _property: interface.decodeEventLog(fragment, data [ , topics ]) => [[Result]] @SRC<abi/interface>
 Returns the decoded event values from an event log for
@@ -112,7 +112,7 @@ Returns the decoded values from the result of a call for
 //fragment// (see [[Interface--specifying-fragments]]) for the given //data//.
 
 
-_subsection: Parsing
+_subsection: Parsing @<Interface--parsing>
 
 The functions are generally the most useful for most developers. They will
 automatically search the ABI for a matching Event or Function and decode
@@ -127,7 +127,7 @@ Search for the function that matches the //transaction// data sighash
 and parse the transaction properties.
 
 
-_subsection: Types
+_subsection: Types @<Interface--types>
 
 _heading: Result @<Result> @INHERIT<Array\<any\>>
 

docs.wrm/api/utils/bignumber.wrm

@@ -11,27 +11,7 @@ Most operations which need to return a value will return a **BigNumber**
 and parameters which accept values will generally accept them.
 
 
-_heading: Importing
-
-_code: CommonJS @lang<script>
-
-// From the Umbrella ethers package...
-const { BigNumber } = require("ethers");
-
-// From the BigNumber pacakge...
-const { BigNumber } = require("@ethersproject/BigNumber");
-
-
-_code: ES6 and TypeScript CommonJS @lang<script>
-
-// From the Umbrella ethers package...
-import { BigNumber } from "ethers";
-
-// From the BigNumber pacakge...
-import { BigNumber } from "@ethersproject/BigNumber";
-
-
-_subsection: Types
+_subsection: Types @<BigNumber--types>
 
 _heading: BigNumberish @<BigNumberish>
 
@@ -57,7 +37,7 @@ A JavaScript [BigInt](link-js-bigint)
 object, on environments that support BigInt.
 
 
-_subsection: Creating Instances
+_subsection: Creating Instances @<BigNumber--creating>
 
 The constructor of BigNumber cannot be called directly. Instead, Use the static ``BigNumber.from``.
 
@@ -108,7 +88,7 @@ BigNumber.from(Number.MAX_SAFE_INTEGER);
 //! error
 
 
-_subsection: Methods
+_subsection: Methods @<BigNumber--methods>
 
 The BigNumber class is immutable, so no operations can change the value
 it represents.
@@ -210,7 +190,7 @@ a.mul(b);
 //!
 
 
-_subsection: Notes
+_subsection: Notes @<BigNumber--notes>
 
 This section is a for a couple of questions that come up frequently.
 

docs.wrm/api/utils/constants.wrm

@@ -2,13 +2,6 @@ _section: Constants @<constants>
 
 The **ethers.contants** Object contains commonly used values.
 
-_heading: Importing
-
-_code: @lang<script>
-
-const { constants } = require("ethers");
-const { constants } = require("@ethersproject/constants");
-
 
 _subsection: Bytes
 

docs.wrm/api/utils/hashing.wrm

@@ -1,9 +1,9 @@
-_section: Hashing Algorithms
+_section: Hashing Algorithms @<hashing-algorithms>
 
 Explain what hash functions are?
 
 
-_subsection: Cryptographic Hash Functions
+_subsection: Cryptographic Hash Functions @<cryptographic-hash-functions>
 
 The [Cryptographic Hash Functions](link-wiki-cryptographichash)
 are a specific family of hash functions.
@@ -125,7 +125,7 @@ utils.computeHmac("sha256", key, data)
 //!
 
 
-_subsection: Hashing Helpers
+_subsection: Hashing Helpers @<utils--hashing-helpers>
 
 _property: ethers.utils.hashMessage(message) => string<[[DataHexString]]<32>>  @<utils-hashMessage> @SRC<hash>
 Computes the [[link-eip-191]] personal message digest of //message//. Personal messages are
@@ -137,7 +137,7 @@ Returns the [ENS Namehash](link-namehash) of //name//.
 
 _code: Hashing Messages  @lang<javascript>
 
-// @TODO: include exampels of hashMessage; it can be complex. :)
+// @TODO: include examples of hashMessage; it can be complex. :)
 
 
 _code: Namehash  @lang<javascript>
@@ -155,7 +155,7 @@ utils.namehash("ricmoo.xyz")
 //!
 
 
-_subsection: Solidity Hashing Algorithms
+_subsection: Solidity Hashing Algorithms @<utils--solidity-hashing>
 
 When using the Solidity ``abi.packEncoded(...)`` function, a non-standard
 //tightly packed// version of encoding is used. These functions implement

docs.wrm/api/utils/transactions.wrm

@@ -1,6 +1,6 @@
 _section: Transactions @<transactions>
 
-_subsection: Types
+_subsection: Types @<transactions--types>
 
 _heading: UnsignedTransaction @<UnsignedTransaction>
 An unsigned transaction represents a transaction that has not been
@@ -95,7 +95,7 @@ x-coordinate can have, and in [[link-eip-155]] is additionally
 used to encode the chain ID into the serialized transaction.
 
 
-_subsection: Functions
+_subsection: Functions  @<transactions--functions>
 
 _property: ethers.utils.parseTransaction(aBytesLike) => [[Transaction]]  @<utils-parseTransaction> @SRC<transactions:parse>
 Parses the transaction properties from a serialized transactions.

docs.wrm/api/utils/wordlists.wrm

@@ -30,6 +30,11 @@ the registered //name//.
 
 _subsection: Languages @<wordlists--languages>
 
+The [official wordlists](link-bip39-wordlists) availalbe in at
+`ethers.wordlists`. In the browser, only the english langauge is
+available by default; to include the others (which increases the
+size of the library), see the dist files in the `ethers` package.
+
 _property: ethers.wordlists.cz => Wordlist
 The Czech [[Wordlist]].
 

docs.wrm/concepts/best-practices.wrm

@@ -0,0 +1,39 @@
+_section: Best Practices @<best-practices>
+
+_subsection: Network Changes
+
+Handling a change in the network (e.g. Ropsten vs Mainnet) is
+incredibly complex and a slight failure can at best make your
+application seem confusing and at worst cause the loss of funds,
+leak private data or misrepresent what an action performed.
+
+Luckily, standard users should likely never change their networks
+unless tricked to do so or they make a mistake.
+
+This is a problem you mainly need to worry about for developers, and
+most developers should understand the vast array of issues surrounding
+a network change during application operation and will understand the
+page reloading (which is already the default behaviour in many clients).
+
+So, the best practice when a network change occurs is to simply
+refresh the page. This should cause all your UI components to
+reset to a known-safe state, including any banners and warnings
+to your users if they are on an unsupported network.
+
+This can be acomplished by using the following function:
+
+_code: Automatically Refresh on Network Change @lang<script>
+
+// Force page refreshes on network changes
+{
+    // The "any" network will allow spontaneous network changes
+    const provider = new ethers.providers.Web3Provider(window.ethereum, "any");
+    provider.on("network", (newNetwork, oldNetwork) => {
+        // When a Provider makes its initial connection, it emits a "network"
+        // event with a null oldNetwork along with the newNetwork. So, if the
+        // oldNetwork exists, it represents a changing network
+        if (oldNetwork) {
+            window.location.reload();
+        }
+    });
+}

docs.wrm/concepts/index.wrm

@@ -4,6 +4,9 @@ This is a very breif overview of some aspects of //Ethereum//
 and blockchains which developers can make use of or should
 be aware of.
 
+This section is fairly sparse at the moment, but will be expanded
+as time goes on.
+
 _toc:
     events
     gas

docs.wrm/concepts/security/index.wrm

@@ -1,6 +1,6 @@
-_section: Security
+_section: Security @<security>
 
-_subsection: Key Derivation Functions @<security-pbkdf>
+_subsection: Key Derivation Functions @<security--pbkdf>
 
 This is not specific to Ethereum, but is a useful technique
 to understand and has some implications on User Experience.

docs.wrm/config.js

@@ -127,6 +127,7 @@ function codeContextify(context) {
     context.hexlify = ethers.utils.hexlify;
     context.hexValue = ethers.utils.hexValue;
     context.Wallet = ethers.Wallet;
+    context.provider = new ethers.providers.InfuraProvider();
 
     context.BigNumber.prototype[inspect.custom] = function(depth, options) {
         return `{ BigNumber: ${JSON.stringify(this.toString()) } }`;
@@ -134,47 +135,27 @@ function codeContextify(context) {
 
 
     context._inspect = function(value, depth) {
-        /*
-        if (context.BigNumber.isBigNumber(value)) {
-            return `{ BigNumber: ${ JSON.stringify(value.toString()) } }`;
+        if (value && value.constructor && value.constructor.name === "Uint8Array") {
+            return `Uint8Array [ ${ Array.prototype.join.call(value, ", ") } ]`;
         }
 
-        if (value && typeof(value.length) === "number" && typeof(value) !== "string") {
-            return "[ " + Array.prototype.map.call(value, (i) => context._inspect(i, (depth || 0) + 1)).join(", ") + " ]";
-        }
-
-        if (typeof(value) === "object" && depth == null) {
-            const keys = Object.keys(value);
-            keys.sort();
-            value = keys.reduce((accum, key) => {
-                accum[key] = value[key];
-                return accum;
-            }, { });
-        */
-            /*
-            return [
-                "{",
-                keys.map((key) => {
-                    return `  ${key}: ${ context._inspect(value[key], 1) },`;
-                }).join("\n"),
-                "}"
-            ].join("\n");
-            */
-        //}
-
         //return JSON.stringify(value);
         return inspect(value, {
             compact: false,
+            breakLength: Infinity,
             sorted: true,
         });
     }
 }
 
+
 module.exports = {
   title: "ethers",
   subtitle: "v5.0-beta",
   logo: "logo.svg",
 
+  prefix: "/v5",
+
   link: "https:/\/docs-beta.ethers.io",
   copyright: "The content of this site is licensed under the [Creative Commons License](https:/\/choosealicense.com/licenses/cc-by-4.0/). Generated on &$now;.",
 
@@ -189,12 +170,13 @@ module.exports = {
   codeRoot: "../",
 
   externalLinks: {
-      "link-alchemy": "https:/\/alchemyapi.io",
-      "link-cloudflare": "https:/\/developers.cloudflare.com/distributed-web/ethereum-gateway/",
-      "link-ethereum": "https:/\/ethereumorg",
-      "link-etherscan": "https:/\/etherscan.io",
+      "link-alchemy": { name: "Alchemy", url: "https:/\/alchemyapi.io" },
+      "link-cloudflare": { name: "Cloudflare", url: "https:/\/developers.cloudflare.com/distributed-web/ethereum-gateway/" },
+      "link-ens": { name: "ENS", url: "https:/\/ens.domains/" },
+      "link-ethereum": { name: "Ethereum", url: "https:/\/ethereumorg" },
+      "link-etherscan": { name: "Etherscan", url: "https:/\/etherscan.io" },
       "link-etherscan-api": "https:/\/etherscan.io/apis",
-      "link-flatworm": "https:/\/github.com/ricmoo/flatworm",
+      "link-flatworm": { name: "Flatworm", url: "https:/\/github.com/ricmoo/flatworm" },
       "link-geth": { name: "Geth", url: "https:/\/geth.ethereum.org" },
       "link-infura": { name: "INFURA", url: "https:/\/infura.io" },
       "link-ledger": "https:/\/www.ledger.com",
@@ -203,16 +185,17 @@ module.exports = {
       "link-rtd": "https:/\/github.com/readthedocs/sphinx_rtd_theme",
       "link-semver": { name: "semver", url: "https:/\/semver.org" },
       "link-solidity": { name: "Solidity" , url: "https:/\/solidity.readthedocs.io/en/v0.6.2/" },
-      "link-sphinx": "https:/\/www.sphinx-doc.org/",
+      "link-sphinx": { name: "Sphinx", url: "https:/\/www.sphinx-doc.org/" },
 
       "link-json-rpc": "https:/\/github.com/ethereum/wiki/wiki/JSON-RPC",
+      "link-web3-send": "https:/\/github.com/ethereum/web3.js/blob/1.x/packages/web3-providers-http/types/index.d.ts#L57",
       "link-parity-trace": "https:/\/openethereum.github.io/wiki/JSONRPC-trace-module",
       "link-parity-rpc": "https:/\/openethereum.github.io/wiki/JSONRPC",
       "link-geth-debug": "https:/\/github.com/ethereum/go-ethereum/wiki/Management-APIs#debug",
       "link-geth-rpc": "https:/\/github.com/ethereum/go-ethereum/wiki/Management-APIs",
 
-      "link-legacy-docs3": "https:/\/docs.ethers.io/ethers.js/v3.0/html/",
-      "link-legacy-docs4": "https:/\/docs.ethers.io/ethers.js",
+      "link-legacy-docs3": "https:/\/docs.ethers.io/v3/",
+      "link-legacy-docs4": "https:/\/docs.ethers.io/v4/",
 
       "link-infura-secret": "https:/\/infura.io/docs/gettingStarted/authentication",
 
@@ -222,11 +205,12 @@ module.exports = {
       "link-web3-ws": "https:/\/github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-ws",
 
       "link-solc-output": "https:/\/solidity.readthedocs.io/en/v0.6.0/using-the-compiler.html#output-description",
+      "link-bip39-wordlists": "https:/\/github.com/bitcoin/bips/blob/master/bip-0039/bip-0039-wordlists.md",
 
       "link-icap": "https:/\/github.com/ethereum/wiki/wiki/Inter-exchange-Client-Address-Protocol-%28ICAP%29",
       "link-jsonrpc": "https:/\/github.com/ethereum/wiki/wiki/JSON-RPC",
-      "link-mit": "https:/\/en.m.wikipedia.org/wiki/MIT_License",
-      "link-namehash": "https:/\/docs.ens.domains/contract-api-reference/name-processing#hashing-names",
+      "link-mit": { name: "MIT License", url: "https:/\/en.m.wikipedia.org/wiki/MIT_License" },
+      "link-namehash": { name: "namehash", url: "https:/\/docs.ens.domains/contract-api-reference/name-processing#hashing-names" },
       "link-rlp": { name: "Recursive Length Prefix", url: "https:/\/github.com/ethereum/wiki/wiki/RLP" },
 
       "link-ethersio": "https:/\/ethers.io/",
@@ -237,12 +221,12 @@ module.exports = {
 
       "link-eip-155": { name: "EIP-155", url: "https:/\/eips.ethereum.org/EIPS/eip-155" },
       "link-eip-191": { name: "EIP-191", url: "https:/\/eips.ethereum.org/EIPS/eip-191" },
-      "link-eip-609": "https:/\/eips.ethereum.org/EIPS/eip-609",
-      "link-eip-1014": "https:/\/eips.ethereum.org/EIPS/eip-1014",
+      "link-eip-609": { name: "EIP-609", url: "https:/\/eips.ethereum.org/EIPS/eip-609" },
+      "link-eip-1014": { name: "EIP-1014", url: "https:/\/eips.ethereum.org/EIPS/eip-1014" },
       "link-eip-1193": { name: "EIP-1193", url: "https:/\/eips.ethereum.org/EIPS/eip-1193" },
-      "link-eip-2098": "https:/\/eips.ethereum.org/EIPS/eip-2098",
-      "link-bip-39": "https://en.bitcoin.it/wiki/BIP_0039",
-      "link-bip-32": "https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki",
+      "link-eip-2098": { name: "EIP-2098", url: "https:/\/eips.ethereum.org/EIPS/eip-2098" },
+      "link-bip-39": { name: "BIP-39", url: "https:/\/en.bitcoin.it/wiki/BIP_0039" },
+      "link-bip-32": { name: "BIP-32", url: "https:/\/github.com/bitcoin/bips/blob/master/bip-0032.mediawiki" },
 
       "link-npm-elliptic": { name: "elliptic", url: "https:/\/www.npmjs.com/package/elliptic" },
       "link-npm-events": { name: "EventEmitter", url: "https:/\/nodejs.org/dist/latest-v13.x/docs/api/events.html#events_class_eventemitter" },
@@ -278,5 +262,5 @@ module.exports = {
       "link-wiki-shuffle": { name: "Fisher-Yates Shuffle", url: "https:/\/en.wikipedia.org/wiki/Fisher-Yates_shuffle" },
       "link-wiki-overflow": { name: "overflow", url: "https:/\/en.wikipedia.org/wiki/Integer_overflow" },
       "link-wiki-underflow": { name: "arithmetic underflow", url: "https:/\/en.wikipedia.org/wiki/Arithmetic_underflow" },
-  }
+  },
 };

docs.wrm/contributing.wrm

@@ -27,7 +27,48 @@ have a public discussion and figure out the best way to address to problem/featu
 
 _subsection: Building
 
-use npm run auto-build
+If you wish to modify the source code, there are a few steps involved in setting up
+your environment.
 
-use npm run update-version
+_code: Preparing the Package @lang<shell>
+
+# 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
+
+
+_code: Watching and Building @lang<shell>
+
+# 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
+
+
+_code: Testing @lang<shell>
+
+# 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
+
+
+_code: Preparing the Distribution @lang<shell>
+
+/home/ricmoo/ethers.js> npm run update-version
 

docs.wrm/generate-redirects.js

@@ -0,0 +1,113 @@
+const fs = require("fs");
+const { resolve } = require("path");
+
+const Content = `
+<html>
+  <head>
+    <title>ethers.js - Legacy Documentation</title>
+    <style type="text/css">
+      html {
+        font-family: sans-serif;
+      }
+      h1 {
+        opacity: 0.8;
+      }
+      .content {
+        border: 2px solid #000;
+        border-radius: 7px;
+        box-shadow: 5px 5px 10px #aaa;
+        left: 50%;
+        padding: 20px;
+        position: absolute;
+        text-align: center;
+        transform: translate(-50%, 30px);
+        width: 700px;
+      }
+      .hr {
+        border-top: 1px solid black;
+        margin: 4px 10px 40px;
+      }
+      span.v5 {
+        font-size: 24px;
+        margin-bottom: 40px;
+      }
+      span.v4 {
+        opacity: 0.7;
+      }
+    </style>
+  </head>
+  <body>
+    <div class="content">
+      <h1>This link is out-of-date <i>and</i> has moved.</h1>
+      <div class="hr"></div>
+      <span class="v5">Click <a id="link-v5" href="%%DEFAULT%%">here</a> to visit the updated documentation</span>
+      <br />
+      <br />
+      <br />
+      <span class="v4">or continue to the historic <a id="link-v4" href="%%LEGACY%%">legacy documentation</a>.</span>
+    </div>
+    <script type="text/javascript">
+      var redirects = %%REDIRECTS%%;
+      var hash = location.hash;
+      if (hash && hash !== "#") {
+        hash = hash.substring(1);
+        var v4 = document.getElementById("link-v4");
+        v4.setAttribute("href", v4.getAttribute("href").split("#")[0] + "#" + hash);
+        var target = redirects[hash];
+        if (target) {
+          var v5 = document.getElementById("link-v5");
+          v5.setAttribute("href", target);
+        }
+      }
+    </script>
+  </body>
+</html>`
+
+const redirects = require("./redirects.json");
+const links = require("../docs/v5/metadata.json").links;
+
+const result = { };
+
+const prefix = "ethers.js/html/";
+Object.keys(redirects).forEach((uri) => {
+    if (uri.substring(0, prefix.length) !== prefix) { return; }
+
+    const comps = uri.substring(prefix.length).split("#");
+    const filename = comps[0];
+    const hash = comps[1] || "_";
+    const tag = redirects[uri];
+
+    let path = null;
+    if (tag.path) {
+        path = tag.path;
+    } else if (tag.tag) {
+        path = links[tag.tag] || null;
+    } else {
+        console.log("Missing tag:", uri);
+        return;
+    }
+
+    if (!path) {
+        console.log("Missing path:", uri);
+        return;
+    }
+
+    if (!result[filename]) { result[filename] = {
+        "_legacy": `/v4/${ filename }`
+    }; }
+    result[filename][hash] = path;
+});
+
+function generateOutput(filename) {
+    const page = result[filename];
+    return Content.replace("%%DEFAULT%%", page._ || "/v5/")
+                  .replace("%%LEGACY%%", page._legacy || "/v4/")
+                  .replace("%%REDIRECTS%%", JSON.stringify(page));
+}
+
+Object.keys(result).forEach((filename) => {
+    const output = generateOutput(filename);
+    const path = resolve(__dirname, "../docs/ethers.js/html", filename);
+    fs.writeFileSync(path, output);
+});
+

docs.wrm/getting-started.wrm

@@ -1,19 +1,19 @@
-_section: Getting Started
+_section: Getting Started @<getting-started>
 
 
-_subsection: Installing
+_subsection: Installing @<installing>
 
 The various Classes and Functions are available to be imported
 manually from sub-packages under the [@ethersproject](link-ethers-npm)
-but for most projects, the umbrella package is the easiest way to
-get started.
+organization but for most projects, the umbrella package is the
+easiest way to get started.
 
 _code: @lang<shell>
 
 /home/ricmoo> npm install --save ethers@next
 
 
-_subsection: Importing
+_subsection: Importing @<importing>
 
 _heading: Node.js
 
@@ -46,3 +46,308 @@ _code: ES3 (UMD) in the Browser @lang<html>
 
 <script src="https://cdn.ethers.io/lib/ethers-5.0.umd.min.js"
         type="application/javascipt"></script>
+
+
+_subsection: Common Terminology @<getting-started--glossary>
+
+This section needs work...
+
+_table: Common Terms
+
+$Provider:  A Provider (in ethers) is a class which provides an abstraction
+            for a connection to the Ethereum Network. It provides read-only
+            access to the Blockchain and its status.
+$Signer:    A Signer is a class which (usually) in some way directly or
+            indirectly has access to a private key, which can sign messages
+            and transactions to authorize the network to charge your account
+            ether to perform operations.
+$Contract:  A Contract is an abstraction which represents a connection to a
+            specific contract on the Ethereum Network, so that it can be
+            used like a normal JavaScipt object.
+
+
+| **Provider**     | $Provider      |
+| **Signer**       | $Signer        |
+| **Contract**     | $Contract      |
+
+
+_subsection: Connecting to Ethereum: Metamask @<getting-started--connecting>
+
+The quickest and easiest way to experiment and begin developing on
+Ethereum is to use [[link-metamask]], which is a browser extension
+that provides:
+
+- A connection to the Ethereum network (a [[Provider]])
+- Holds your private key and can sign thing (a [[Signer]])
+
+_code: Connecting to Metamask @lang<script>
+
+// A Web3Provider wraps a standard Web3 provider, which is
+// what Metamask injects as window.ethereum into each page
+const provider = new ethers.providers.Web3Provider(window.ethereum)
+
+// The Metamask plugin also allows signing transactions to
+// send ether and pay to change state within the blockchain.
+// For this, we need the account signer...
+const signer = provider.getSigner()
+
+
+_heading: Querying the Blockchain @<getting-started--querying>
+
+Once you have a [[Provider]], you have a read-only connection to the
+blockchain, which can be used to query the current state, fetch historic
+logs, look up deployed code and so on.
+
+_code: Basic Queries @lang<javascript>
+
+// Look up the current block number
+provider.getBlockNumber()
+//!
+
+// Get the balance of an account (by address or ENS name)
+balance = await provider.getBalance("ethers.eth")
+//! async balance
+
+// Often you will need to format the output for the user
+// which prefer to see values in ether (instead of wei)
+ethers.utils.formatEther(balance)
+//!
+
+// Or if a user enters a string in an input field, you may need
+// to convert it from ether (as a string) to wei (as a BigNumber)
+ethers.utils.parseEther("1.0")
+//!
+
+
+_heading: Writing to the Blockchain @<getting-started--sending>
+
+_code: Sending Ether @lang<script>
+
+// Send 1 ether to an ens name.
+const tx = signer.sendTransaction({
+    to: "ricmoo.firefly.eth",
+    value: ethers.utils.parseEther("1.0")
+});
+
+
+_subsection: Contracts @<getting-started--contracts>
+
+A Contract is an abstraction of program code which lives on the
+Ethereum blockchain.
+
+The [[Contract]] object makes it easier to use an on-chain
+Contract as a normal JavaScript object, with the method all
+mapped to encoding and decoding data for you.
+
+If you are familiar with Databases, this is similar to ORM.
+
+In order to communicate with the Contract on-chain, this class
+needs to know what methods are available and how to encode and
+decode the data, which is what the //Application Binary Interface// (API)
+provides.
+
+This class is a meta-class, which means its methods are constructed
+at runtime, when you pass in the ABI to the constructor it uses that
+to determine which methods to add.
+
+While a on-chain Contract may have many methods available, you can safely ignore
+any methods you don't need or use, providing a smaller subset of the ABI to
+the contract.
+
+An ABI often comes from the Solidity or Vyper compiler, but may also be
+placed in the code easily using the Human-Readable ABI, which the following
+examples use.
+
+_code: Connecting to the DAI Contract @lang<javascript>
+
+// We can use an ENS name for the contract address
+const daiAddress = "dai.tokens.ethers.eth";
+
+// The ERC-20 Contract ABI, which is a common contract interface
+// for tokens (this is the Human-Readable ABI format)
+const daiAbi = [
+  // Some simple details about the token
+  "function name() view returns (string)",
+  "function symbol() view returns (string)",
+
+  // Get the account balance
+  "function balanceOf(address) view returns (uint)",
+
+  // Send some of your tokens to someone else
+  "function transfer(address to, uint amount)",
+
+  // An event triggered whenever anyone transfers to someone else
+  "event Transfer(address indexed from, address indexed to, uint amount)"
+];
+
+// The Contract object
+const daiContract = new ethers.Contract(daiAddress, daiAbi, provider);
+
+
+_heading: Read-Only Methods @<getting-started--reading>
+
+_code: Querying the DAI Contract @lang<javascript>
+
+// <hide>
+const daiAbi = [
+  // Some simple details about the token
+  "function name() view returns (string)",
+  "function symbol() view returns (string)",
+
+  // Get the account balance
+  "function balanceOf(address) view returns (uint)",
+];
+const daiContract = new ethers.Contract("dai.tokens.ethers.eth", daiAbi, provider);
+// </hide>
+
+// Get the ERC-20 token name
+daiContract.name()
+//!
+
+// Get the ERC-20 token synbol (for tickers and UIs)
+daiContract.symbol()
+//!
+
+// Get the balance of an address
+balance = await daiContract.balanceOf("ricmoo.firefly.eth")
+//! async balance
+
+// Format the DAI for displaying to the user
+ethers.utils.formatUnits(balance, 18)
+//!
+
+
+_heading: State Changing Methods @<getting-started--writing>
+
+_code: Sending DAI @lang<script>
+
+// The DAI Contract is currently connected to the Provider,
+// which is read-only. We need to connect to a Signer, so
+// that we can pay to send state-changing transactions.
+const daiWithSigner = contract.connect(signer);
+
+// Each DAI has 18 decimal places
+const dai = ethers.utils.parseUnits("1.0", 18);
+
+// Send 1 DAI to "ricmoo.firefly.eth"
+tx = daiWithSigner.transfer("ricmoo.firefly.eth", dai);
+
+
+_heading: Listening to Events @<getting-started--events>
+
+_code: Listening to Events @lang<javascript>
+
+// <hide>
+const daiAbi = [
+  "event Transfer(address indexed, address indexed, uint256)"
+];
+const daiContract = new ethers.Contract("dai.tokens.ethers.eth", daiAbi, provider);
+const formatEther = ethers.utils.formatEther;
+// </hide>
+
+// Receive an event when ANY transfer occurs
+daiContract.on("Transfer", (from, to, amount, event) => {
+    console.log(`${ from } sent ${ formatEther(amount) } to ${ to}`);
+    // The event object contains the verbatim log data, the
+    // EventFragment and functions to fetch the block,
+    // transaction and receipt and event functions
+});
+
+// A filter for when a specific address receives tokens
+myAddress = "0x8ba1f109551bD432803012645Ac136ddd64DBA72";
+filter = daiContract.filters.Transfer(null, myAddress)
+// <hide>
+filter
+// </hide>
+//!
+
+// Receive an event when that filter occurs
+daiContract.on(filter, (from, to, amount, event) => {
+    // The to will always be "address"
+    console.log(`I got ${ formatEther(amount) } from ${ from }.`);
+});
+
+// <hide>
+// Don't want to block the docs from compiling...
+daiContract.removeAllListeners();
+// </hide>
+
+
+_heading: Query Historic Events @<getting-started--history>
+
+_code: Filtering Historic Events @lang<javascript>
+
+// <hide>
+const signer = new ethers.VoidSigner("0x8ba1f109551bD432803012645Ac136ddd64DBA72");
+const daiAbi = [
+  "event Transfer(address indexed, address indexed, uint256)"
+];
+const daiContract = new ethers.Contract("dai.tokens.ethers.eth", daiAbi, provider);
+//!
+// </hide>
+
+// Get the address of the Signer
+myAddress = await signer.getAddress()
+//! async myAddress
+
+// Filter for all token transfers to me
+filterFrom = daiContract.filters.Transfer(myAddress, null);
+// <hide>
+filterFrom
+// </hide>
+//!
+
+// Filter for all token transfers from me
+filterTo = daiContract.filters.Transfer(null, myAddress);
+// <hide>
+filterTo
+// </hide>
+//!
+
+// List all transfers sent from me a specific block range
+daiContract.queryFilter(filterFrom, 9843470, 9843480)
+//!
+
+//
+// The following have had the results omitted due to the
+// number of entries; but they provide some useful examples
+//
+
+// List all transfers I sent in the last 10,000 blocks
+daiContract.queryFilter(filterFrom, -10000)
+
+// List all transfers ever sent to me
+daiContract.queryFilter(filterTo)
+
+
+_subsection: Signing Messages @<getting-started--signing>
+
+_code: Signing Messages @lang<javascript>
+
+// <hide>
+const signer = ethers.Wallet.createRandom();
+//!
+// </hide>
+
+// To sign a simple string, which can often be used for
+// logging into a service, such as CryptoKitties simply
+// pass the string in.
+signature = await signer.signMessage("Hello World");
+//! async signature
+
+//
+// A common case is also signing a hash, which is 32
+// bytes. It is important to note, that to sign binary
+// data it MUST be an Array (or TypedArray)
+//
+
+// This string is 66 chacacters long
+message = "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef"
+
+// This array representation is 32 bytes long
+messageBytes = ethers.utils.arrayify(message);
+//!
+
+// To sign a hash, you most often want to sign the bytes
+signature = await signer.signMessage(messageBytes)
+//! async signature

docs.wrm/index.wrm

@@ -1,13 +1,13 @@
-_section: Documentation
+_section: Documentation @<documentation>
 
-_subsection: What is Ethers?
+_subsection: What is Ethers? @<preamble>
 
 The ethers.js library aims to be a complete and compact library for
 interacting with the Ethereum Blockchain and its ecosystem. It was
 originally designed for use with [ethers.io](link-ethersio) and
 has since expanded into a much more general-purpose library.
 
-_subsection: Features
+_subsection: Features @<features>
 
 - Keep your private keys in your client, **safe** and sound
 - Import and export **JSON wallets** (Geth, Parity and crowdsale)
@@ -48,7 +48,7 @@ _toc:
     license
 
 
-_subsection: Legacy Documentation
+_subsection: Legacy Documentation @<documentation--legacy>
 
 This section will be kept up to date, linking to documentation of
 older versions of the library.

docs.wrm/quick-start.wrm

@@ -1,175 +0,0 @@
-_section: Quick Start
-
-
-_subsection: Connecting to Ethereum: Metamask
-
-The quickest and easiest way to experiment and begin
-developing on Ethereum is to use [[link-metamask]],
-which is a browser extension that provider:
-
-- A connection to the Ethereum network
-- Holds your private key and can sign thing
-
-_code: Connecting to Metamask
-
-// A Web3Provider wraps a standard Web3 provider, which is
-// what Metamask injects into every page you visit as window.ethereum
-const provider = new ethers.providers.Web3Provider(window.ethereum)
-
-// The Metamask plugin also allows signing transactions to send ether
-// and pay to change state within the blockchain. For this, we need
-// the account signer...
-const signer = provider.getSigner()
-
-
-_heading: Querying the Blockchain
-
-Once you have a [[Provider]], you have a read-only connection to the
-blockchain, which can be used to query the current state, fetch historic
-logs, look up deployed code and so on.
-
-_code: Basic Queries
-
-// <hide>
-const provider = ethers.getDefaultProvider();
-// </hide>
-
-// Look up the current block number
-provider.getBlockNumber()
-
-// Get the balance of an account (by address or ENS name)
-provider.getBalance("ethers.eth")
-
-
-_heading: Writing to the Blockchain
-
-Every write costs ... etc
-
-_code: Sending Ether
-
-// Send 1 ether to an ens name.
-const tx = signer.sendTransaction({
-    to: "ricmoo.firefly.eth",
-    value: ethers.utils.parseEther("1.0")
-});
-
-
-_subsection: Contracts
-
-_heading: Connecting to a Contract
-
-To connect to an contract...
-
-Explain ABI
-
-Explain meta-class and the aBI
-
-_code: Connecting to a Contract
-
-// The ERC-20 Contract ABI, which is a common contract interface
-// for tokens.
-const abi = [
-    // Some simple details about the token
-    "function namd() view returns (string)",
-    "function symbol() view returns (string)",
-
-    // Get the account balance
-    "function balanceOf(address) view returns (uint)",
-
-    // Send some of your tokens to someone else
-    "function transfer(address to, uint amount")",
-
-    // An event triggered whenever anyone transfers to someone else
-    "event Transfer(address indexed from, address indexed to, uint amount)"
-];
-
-const contract = new ethers.Contract(address, abi, provider);
-
-const contract = new ethers.Contract(address, abi, provider);
-
-
-_heading: Read-Only Methods
-
-_code: Querying the DAI Contract
-
-// <hide>
-// </hide>
-
-const contract = new Contract("dai.tokens.ethers.eth", abi, provider);
-
-contract.name()
-//!
-
-contract.symbol()
-//!
-
-contract.balanceOf("ricmoo.firefly.eth")
-//!
-
-
-_heading: State Changing Methods
-
-_heading: Listening to Events
-
-_code: Listening to Events
-
-// <hide>
-const contract = ...
-// </hide>
-
-// Receive an event when ANY transfer occurs
-contract.on("Transfer", (from, to, amount, event) => {
-    console.log(`${ from } sent ${ formatEther(amount) } to ${ to}`);
-});
-
-// Receive an event when a specific address receives a token
-const filter = contract.filters.Transfer(null, address)
-contract.on(filter, (from, to, amount, event) => {
-    // The to will always be "address"
-    console.log(`I got ${ formatEther(amount) } from ${ from }.`);
-});
-
-
-_heading: Listing Historic Events
-
-_code: Historic Events by Name
-
-// List all transfers from anyone to anyone in the first XXX
-contract.queryFilter("Transfer", 0, XXX)
-//!
-
-
-_code: Filtering Historic Events
-
-// <hide>
-const contract = ...
-// </hide>
-
-const address = signer.getAddress()
-
-// Filter for all token transfers we've sent
-const filterFrom = contract.filter.Transfer(address, null);
-// <hide>
-filterFrom
-// </hide>
-//!
-
-// Filter for all token transfers we've received
-const filterTo = contract.filter.Transfer(null, address);
-// <hide>
-filterTo
-// </hide>
-//!
-
-// List all transfers we've sent between ...
-contract.queryFilter(filterFrom, 0, 100000)
-//!
-
-// List all transfers we've received in blockhash XXX
-contract.queryFilter(filterTo, XXX)
-//!
-
-
-_subsection: Signing Messages
-
-

docs.wrm/redirects.json

@@ -1,294 +1,302 @@
 {
   "ethers.js/html/api-advanced.html":
-    { "tag": "" },
+    { "path": "/v5/api/utils/" },
   "ethers.js/html/api-advanced.html#abi-coder":
-    { "tag": "" },
+    { "tag": "AbiCoder" },
   "ethers.js/html/api-advanced.html#api-interface":
-    { "tag": "interface" },
+    { "tag": "Interface" },
   "ethers.js/html/api-advanced.html#creating-an-instance":
-    { "tag": "" },
+    { "tag": "Interface--creating" },
   "ethers.js/html/api-advanced.html#creating-instances":
-    { "tag": "" },
+    { "tag": "AbiCoder--creating" },
   "ethers.js/html/api-advanced.html#cryptographic-operations":
-    { "tag": "" },
+    { "tag": "SigningKey" },
   "ethers.js/html/api-advanced.html#deriving-child-and-neutered-nodes":
-    { "tag": "hd-wallet--hdnode--methods" },
+    { "tag": "HDNode--methods" },
   "ethers.js/html/api-advanced.html#descriptions":
-    { "tag": "" },
+    { "tag": "Interface--parsing" },
   "ethers.js/html/api-advanced.html#hdnode":
-    { "tag": "hd-wallet" },
+    { "tag": "HDNode" },
   "ethers.js/html/api-advanced.html#interface":
-    { "tag": "abi-interface" },
+    { "tag": "Interface" },
   "ethers.js/html/api-advanced.html#low-level-api":
-    { "tag": "" },
+    { "path": "/v5/api/utils/" },
   "ethers.js/html/api-advanced.html#object-test-functions":
-    { "tag": "" },
+    { "tag": "Interface" },
   "ethers.js/html/api-advanced.html#parsing-objects":
-    { "tag": "" },
+    { "tag": "Interface--parsing" },
   "ethers.js/html/api-advanced.html#prototype":
-    { "tag": "" },
+    { "tag": "AbiCoder--methods" },
+  "ethers.js/html/api-advanced.html#id3":
+    { "tag": "Interface" },
+  "ethers.js/html/api-advanced.html#id5":
+    { "tag": "Provider" },
+  "ethers.js/html/api-advanced.html#id8":
+    { "tag": "SigningKey" },
   "ethers.js/html/api-advanced.html#provider-sub-classing":
-    { "tag": "" },
+    { "tag": "Provider" },
   "ethers.js/html/api-advanced.html#recursive-length-prefixed-encoding-rlp":
-    { "tag": "rlp" },
+    { "tag": "rlp--methods" },
   "ethers.js/html/api-advanced.html#signing-key":
-    { "tag": "utils-signingkey" },
+    { "tag": "SigningKey" },
   "ethers.js/html/api-advanced.html#static-methods":
-    { "tag": "" },
+    { "tag": "HDNode--methods" },
+  "ethers.js/html/api-advanced.html#id6":
+    { "tag": "rlp--methods" },
   "ethers.js/html/api-advanced.html#static-properties":
-    { "tag": "" },
+    { "tag": "AbiCoder--creating" },
   "ethers.js/html/api-contract.html":
-    { "tag": "contract" },
+    { "tag": "Contract" },
   "ethers.js/html/api-contract.html#api-contract":
-    { "tag": "contract" },
+    { "tag": "Contract" },
   "ethers.js/html/api-contract.html#application-binary-interface-abi":
-    { "tag": "" },
+    { "tag": "abi-formats" },
   "ethers.js/html/api-contract.html#bytes":
-    { "tag": "" },
+    { "tag": "Contract-functionsCall" },
   "ethers.js/html/api-contract.html#configuring-events":
-    { "tag": "" },
+    { "tag": "Contract--events" },
   "ethers.js/html/api-contract.html#connecting":
-    { "tag": "" },
+    { "tag": "ContractFactory-attach" },
   "ethers.js/html/api-contract.html#connecting-to-a-contract":
-    { "tag": "" },
+    { "tag": "Contract--creating" },
   "ethers.js/html/api-contract.html#connecting-to-existing-contracts":
-    { "tag": "" },
+    { "tag": "Contract--creating" },
   "ethers.js/html/api-contract.html#contract-abi":
-    { "tag": "" },
+    { "tag": "abi-formats" },
   "ethers.js/html/api-contract.html#contract-event-filters":
-    { "tag": "" },
+    { "tag": "Contract--filters" },
   "ethers.js/html/api-contract.html#contract-filter":
-    { "tag": "" },
+    { "tag": "Contract--filters" },
   "ethers.js/html/api-contract.html#contract-metaclass":
-    { "tag": "" },
+    { "tag": "Contract--metaclass" },
   "ethers.js/html/api-contract.html#contract-methods":
-    { "tag": "" },
+    { "tag": "Contract--methods" },
   "ethers.js/html/api-contract.html#contracts":
-    { "tag": "" },
+    { "tag": "Contract" },
   "ethers.js/html/api-contract.html#creating-a-contract-factory":
-    { "tag": "" },
+    { "tag": "ContractFactory--creating" },
   "ethers.js/html/api-contract.html#deploying-a-contract":
-    { "tag": "" },
+    { "tag": "ContractFactory-deploy"  },
   "ethers.js/html/api-contract.html#deployment":
-    { "tag": "" },
+    { "tag": "ContractFactory--methods" },
   "ethers.js/html/api-contract.html#event-emitter":
-    { "tag": "" },
+    { "tag": "Contract--events" },
   "ethers.js/html/api-contract.html#event-names":
-    { "tag": "" },
+    { "tag": "Contract--events" },
   "ethers.js/html/api-contract.html#event-object":
-    { "tag": "" },
+    { "tag": "Contract--events" },
   "ethers.js/html/api-contract.html#filtering-events":
-    { "tag": "" },
+    { "tag": "Contract--filters" },
   "ethers.js/html/api-contract.html#integers":
-    { "tag": "" },
+    { "tag": "Contract-functionsCall" },
   "ethers.js/html/api-contract.html#meta-class-properties":
-    { "tag": "" },
+    { "tag": "Contract--metaclass" },
   "ethers.js/html/api-contract.html#overrides":
-    { "tag": "" },
+    { "tag": "Contract--metaclass" },
   "ethers.js/html/api-contract.html#prototype":
-    { "tag": "" },
+    { "tag": "Contract--properties" },
   "ethers.js/html/api-contract.html#providers-vs-signers":
-    { "tag": "" },
+    { "tag": "Contract-connect" },
   "ethers.js/html/api-contract.html#strings":
-    { "tag": "" },
+    { "tag": "Bytes32String" },
   "ethers.js/html/api-contract.html#structs":
-    { "tag": "" },
+    { "tag": "Contract--metaclass" },
   "ethers.js/html/api-contract.html#types":
-    { "tag": "" },
+    { "tag": "Contract-functionsCall" },
   "ethers.js/html/api-contract.html#waiting-for-deployment":
-    { "tag": "" },
+    { "tag": "ContractFactory" },
   "ethers.js/html/api-providers.html":
     { "tag": "providers" },
   "ethers.js/html/api-providers.html#account":
-    { "tag": "provider--account-methods" },
+    { "tag": "Provider--account-methods" },
   "ethers.js/html/api-providers.html#api-provider":
-    { "tag": "providers" },
+    { "tag": "Provider" },
   "ethers.js/html/api-providers.html#block-responses":
-    { "tag": "provider--block-methods" },
+    { "tag": "Provider--block-methods" },
   "ethers.js/html/api-providers.html#block-tag":
-    { "tag": "provider-blocktag" },
+    { "tag": "providers-BlockTag" },
   "ethers.js/html/api-providers.html#blockchain-status":
-    { "tag": "provider--network-status-methods" },
+    { "tag": "Provider--network-methods" },
   "ethers.js/html/api-providers.html#blockresponse":
-    { "tag": "" },
+    { "tag": "providers-Block" },
   "ethers.js/html/api-providers.html#blocktag":
-    { "tag": "provider-blocktag" },
+    { "tag": "providers-BlockTag" },
   "ethers.js/html/api-providers.html#connecting-to-ethereum":
-    { "tag": "get-default-provider" },
+    { "tag": "providers-getDefaultProvider" },
   "ethers.js/html/api-providers.html#contract-execution":
-    { "tag": "" },
+    { "tag": "Provider--transaction-methods" },
   "ethers.js/html/api-providers.html#contract-state":
-    { "tag": "" },
+    { "tag": "Provider--account-methods" },
   "ethers.js/html/api-providers.html#ethereum-naming-service":
-    { "tag": "" },
+    { "tag": "Provider--ens-methods" },
   "ethers.js/html/api-providers.html#etherscan":
-    { "tag": "api-providers--etehrscanprovider" },
+    { "tag": "EtherscanProvider" },
   "ethers.js/html/api-providers.html#etherscanprovider-inherits-from-provider":
-    { "tag": "" },
+    { "tag": "EtherscanProvider" },
   "ethers.js/html/api-providers.html#event-types":
-    { "tag": "" },
+    { "tag": "Provider--events" },
   "ethers.js/html/api-providers.html#events":
-    { "tag": "" },
+    { "tag": "Provider--events" },
   "ethers.js/html/api-providers.html#fallbackprovider-inherits-from-provider":
-    { "tag": "" },
+    { "tag": "FallbackProvider" },
   "ethers.js/html/api-providers.html#filter":
-    { "tag": "" },
+    { "tag": "Provider--events" },
   "ethers.js/html/api-providers.html#filters":
-    { "tag": "" },
+    { "tag": "Provider--events" },
   "ethers.js/html/api-providers.html#infuraprovider-inherits-from-jsonrpcprovider":
-    { "tag": "" },
+    { "tag": "InfuraProvider" },
   "ethers.js/html/api-providers.html#ipcprovider-inherits-from-jsonrpcprovider":
-    { "tag": "" },
+    { "tag": "IpcProvider" },
   "ethers.js/html/api-providers.html#jsonrpcprovider":
-    { "tag": "" },
+    { "tag": "JsonRpcProvider" },
   "ethers.js/html/api-providers.html#jsonrpcprovider-inherits-from-provider":
-    { "tag": "" },
+    { "tag": "JsonRpcProvider" },
   "ethers.js/html/api-providers.html#jsonrpcsigner":
-    { "tag": "" },
+    { "tag": "JsonRpcSigner" },
   "ethers.js/html/api-providers.html#log":
-    { "tag": "" },
+    { "tag": "Provider--log-methods" },
   "ethers.js/html/api-providers.html#network":
-    { "tag": "" },
+    { "tag": "Provider--network-methods" },
   "ethers.js/html/api-providers.html#objects-and-types":
-    { "tag": "" },
+    { "path": "/v5/api/providers/types/" },
   "ethers.js/html/api-providers.html#properties":
-    { "tag": "" },
+    { "tag": "Provider" },
   "ethers.js/html/api-providers.html#provider":
-    { "tag": "" },
+    { "tag": "Provider" },
   "ethers.js/html/api-providers.html#provider-connect":
-    { "tag": "" },
+    { "tag": "providers-getDefaultProvider" },
   "ethers.js/html/api-providers.html#provider-etherscan-extra":
-    { "tag": "" },
+    { "tag": "EtherscanProvider" },
   "ethers.js/html/api-providers.html#provider-etherscan-properties":
-    { "tag": "" },
+    { "tag": "EtherscanProvider" },
   "ethers.js/html/api-providers.html#provider-fallback-properties":
-    { "tag": "" },
+    { "tag": "FallbackProvider" },
   "ethers.js/html/api-providers.html#provider-infura-properties":
-    { "tag": "" },
+    { "tag": "InfuraProvider" },
   "ethers.js/html/api-providers.html#provider-ipc-properties":
-    { "tag": "" },
+    { "tag": "IpcProvider" },
   "ethers.js/html/api-providers.html#provider-jsonrpc-extra":
-    { "tag": "" },
+    { "tag": "JsonRpcProvider" },
   "ethers.js/html/api-providers.html#provider-jsonrpc-properties":
-    { "tag": "" },
+    { "tag": "JsonRpcProvider" },
   "ethers.js/html/api-providers.html#provider-specific-extra-api-calls":
-    { "tag": "" },
+    { "path": "/api/providers/other/" },
   "ethers.js/html/api-providers.html#provider-web3-properties":
-    { "tag": "" },
+    { "tag": "Web3Provider" },
   "ethers.js/html/api-providers.html#providers":
-    { "tag": "" },
+    { "path": "/v5/api/providers/" },
   "ethers.js/html/api-providers.html#signer-jsonrpc":
-    { "tag": "" },
+    { "tag": "JsonRpcSigner" },
   "ethers.js/html/api-providers.html#transaction-receipt":
-    { "tag": "" },
+    { "tag": "providers-TransactionReceipt" },
   "ethers.js/html/api-providers.html#transaction-receipts":
-    { "tag": "" },
+    { "tag": "providers-TransactionReceipt" },
   "ethers.js/html/api-providers.html#transaction-request":
-    { "tag": "" },
+    { "tag": "providers-TransactionRequest" },
   "ethers.js/html/api-providers.html#transaction-requests":
-    { "tag": "" },
+    { "tag": "providers-TransactionRequest" },
   "ethers.js/html/api-providers.html#transaction-response":
-    { "tag": "" },
+    { "tag": "providers-TransactionResponse" },
   "ethers.js/html/api-providers.html#waitfortransaction":
-    { "tag": "" },
+    { "tag": "Provider-waitForTransaction" },
   "ethers.js/html/api-providers.html#waiting-for-transactions":
-    { "tag": "" },
+    { "tag": "Provider-waitForTransaction" },
   "ethers.js/html/api-providers.html#web3provider-inherits-from-jsonrpcprovider":
-    { "tag": "" },
+    { "tag": "Web3Provider" },
   "ethers.js/html/api-utils.html":
-    { "tag": "" },
+    { "path": "/v5/api/utils/" },
   "ethers.js/html/api-utils.html#addresses":
     { "tag": "addresses" },
   "ethers.js/html/api-utils.html#arrayish":
-    { "tag": "bytes" },
+    { "tag": "Bytes" },
   "ethers.js/html/api-utils.html#big-numbers":
-    { "tag": "bignumber" },
+    { "tag": "BigNumber" },
   "ethers.js/html/api-utils.html#bignumber":
-    { "tag": "bignumber" },
+    { "tag": "BigNumber" },
   "ethers.js/html/api-utils.html#bytes32-strings":
-    { "tag": "bytes32-string" },
+    { "tag": "Bytes32String" },
   "ethers.js/html/api-utils.html#bytes32string":
-    { "tag": "bytes32-string" },
+    { "tag": "Bytes32String" },
   "ethers.js/html/api-utils.html#constants":
     { "tag": "constants" },
   "ethers.js/html/api-utils.html#creating-instances":
-    { "tag": "" },
+    { "tag": "BigNumber--creating" },
   "ethers.js/html/api-utils.html#cryptographic-functions":
-    { "tag": "hashing-algorithms--cryptographic-hash-functions" },
+    { "tag": "cryptographic-hash-functions" },
   "ethers.js/html/api-utils.html#elliptic-curve":
-    { "tag": "" },
+    { "tag": "SigningKey" },
   "ethers.js/html/api-utils.html#ether-strings-and-wei":
-    { "tag": "" },
+    { "tag": "unit-conversion" },
   "ethers.js/html/api-utils.html#formatether":
-    { "tag": "utils-formatunits" },
+    { "tag": "utils-formatUnits" },
   "ethers.js/html/api-utils.html#hash-function-helpers":
-    { "tag": "" },
+    { "tag": "utils--hashing-helpers" },
   "ethers.js/html/api-utils.html#hash-functions":
-    { "tag": "hashing-algorithms--cryptographic-hash-functions" },
+    { "tag": "cryptographic-hash-functions" },
   "ethers.js/html/api-utils.html#hex-strings":
-    { "tag": "hexstring" },
+    { "tag": "HexString" },
   "ethers.js/html/api-utils.html#hexstring":
-    { "tag": "hexstring" },
+    { "tag": "HexString" },
   "ethers.js/html/api-utils.html#key-derivation":
-    { "tag": "" },
+    { "tag": "utils--hashing-helpers" },
   "ethers.js/html/api-utils.html#namehash":
     { "tag": "utils-namehash" },
   "ethers.js/html/api-utils.html#parseether":
-    { "tag": "utils-parseunits" },
+    { "tag": "utils-parseUnits" },
   "ethers.js/html/api-utils.html#random":
-    { "tag": "utils-randombytes" },
+    { "tag": "utils-randomBytes" },
   "ethers.js/html/api-utils.html#signature":
-    { "tag": "signature" },
+    { "tag": "Signature" },
   "ethers.js/html/api-utils.html#signatures":
-    { "tag": "signature" },
+    { "tag": "Signature" },
   "ethers.js/html/api-utils.html#solidity":
-    { "tag": "" },
+    { "tag": "utils--solidity-hashing" },
   "ethers.js/html/api-utils.html#transactions":
-    { "tag": "" },
+    { "tag": "transactions--functions" },
   "ethers.js/html/api-utils.html#utf-8-strings":
-    { "tag": "utf8-string" },
+    { "tag": "strings-utf8" },
   "ethers.js/html/api-utils.html#utf8-strings":
-    { "tag": "utf8-string" },
+    { "tag": "strings-utf8" },
   "ethers.js/html/api-utils.html#utilities":
-    { "tag": "" },
+    { "path": "/v5/api/utils/" },
   "ethers.js/html/api-utils.html#utils-getaddress":
     { "tag": "utils-getAddress" },
   "ethers.js/html/api-utils.html#web":
-    { "tag": "web-utilities" },
+    { "tag": "web" },
   "ethers.js/html/api-wallet.html":
-    { "tag": "wallet" },
+    { "tag": "Wallet" },
   "ethers.js/html/api-wallet.html#blockchain-operations":
-    { "tag": "signer-blockchain" },
+    { "tag": "Signer--blockchain-methods" },
   "ethers.js/html/api-wallet.html#creating-instances":
-    { "tag": "wallet" },
+    { "tag": "Wallet" },
   "ethers.js/html/api-wallet.html#encrypted-json-wallets":
-    { "tag": "" },
+    { "tag": "Wallet--methods" },
   "ethers.js/html/api-wallet.html#fromencryptedjson":
-    { "tag": "wallet-fromencryptedjson" },
+    { "tag": "Wallet-fromEncryptedJson" },
   "ethers.js/html/api-wallet.html#prototype":
-    { "tag": "signers--wallet--properties" },
+    { "tag": "Wallet--properties" },
   "ethers.js/html/api-wallet.html#sendtransaction":
-    { "tag": "signer-sendtransaction" },
+    { "tag": "Signer-sendTransaction" },
   "ethers.js/html/api-wallet.html#signer":
-    { "tag": "signer" },
+    { "tag": "Signer" },
   "ethers.js/html/api-wallet.html#signer-api":
-    { "tag": "signer" },
+    { "tag": "Signer" },
   "ethers.js/html/api-wallet.html#signing":
-    { "tag": "signers--signer--signing" },
+    { "tag": "Signer--signing-methods" },
   "ethers.js/html/api-wallet.html#wallet":
-    { "tag": "wallet" },
+    { "tag": "Wallet" },
   "ethers.js/html/api-wallet.html#wallet-connect":
-    { "tag": "" },
+    { "tag": "Signer-connect" },
   "ethers.js/html/api-wallet.html#wallets-and-signers":
-    { "tag": "" },
+    { "tag": "signers" },
   "ethers.js/html/api.html":
-    { "tag": "" },
+    { "tag": "api" },
   "ethers.js/html/api.html#api":
-    { "tag": "" },
+    { "tag": "api" },
   "ethers.js/html/api.html#application-programming-interface-api":
-    { "tag": "" },
+    { "tag": "api" },
   "ethers.js/html/cookbook-accounts.html":
-    { "tag": "" },
+    { "path": "/v5/cookbook/" },
   "ethers.js/html/cookbook-accounts.html#access-funds-in-a-mnemonic-phrase-wallet":
     { "tag": "" },
   "ethers.js/html/cookbook-accounts.html#accounts":
@@ -304,7 +312,7 @@
   "ethers.js/html/cookbook-accounts.html#sweep-an-account-into-another":
     { "tag": "" },
   "ethers.js/html/cookbook-contracts.html":
-    { "tag": "" },
+    { "path": "/v5/cookbook/" },
   "ethers.js/html/cookbook-contracts.html#contracts":
     { "tag": "" },
   "ethers.js/html/cookbook-contracts.html#economic-incentives-and-economic-value":
@@ -312,7 +320,7 @@
   "ethers.js/html/cookbook-contracts.html#return-a-value-from-a-state-changing-method":
     { "tag": "" },
   "ethers.js/html/cookbook-providers.html":
-    { "tag": "" },
+    { "path": "/v5/cookbook/" },
   "ethers.js/html/cookbook-providers.html#custom-provider":
     { "tag": "" },
   "ethers.js/html/cookbook-providers.html#metamask":
@@ -322,7 +330,7 @@
   "ethers.js/html/cookbook-providers.html#testrpc-ganache":
     { "tag": "" },
   "ethers.js/html/cookbook-react.html":
-    { "tag": "" },
+    { "path": "/v5/cookbook/" },
   "ethers.js/html/cookbook-react.html#other-notes":
     { "tag": "" },
   "ethers.js/html/cookbook-react.html#react-native":
@@ -332,7 +340,7 @@
   "ethers.js/html/cookbook-react.html#wordlists":
     { "tag": "" },
   "ethers.js/html/cookbook-signing.html":
-    { "tag": "" },
+    { "path": "/v5/cookbook/" },
   "ethers.js/html/cookbook-signing.html#signing-a-digest-hash":
     { "tag": "" },
   "ethers.js/html/cookbook-signing.html#signing-a-string-message":
@@ -340,7 +348,7 @@
   "ethers.js/html/cookbook-signing.html#signing-messages":
     { "tag": "" },
   "ethers.js/html/cookbook-testing.html":
-    { "tag": "" },
+    { "path": "/v5/cookbook/" },
   "ethers.js/html/cookbook-testing.html#contract-events":
     { "tag": "" },
   "ethers.js/html/cookbook-testing.html#testing":
@@ -348,29 +356,29 @@
   "ethers.js/html/cookbook-testing.html#using-multiple-accounts":
     { "tag": "" },
   "ethers.js/html/cookbook.html":
-    { "tag": "" },
+    { "path": "/v5/cookbook/" },
   "ethers.js/html/cookbook.html#cookbook":
     { "tag": "" },
   "ethers.js/html/getting-started.html":
-    { "tag": "" },
+    { "tag": "getting-started" },
   "ethers.js/html/getting-started.html#getting-started":
-    { "tag": "" },
+    { "tag": "getting-started" },
   "ethers.js/html/getting-started.html#importing":
-    { "tag": "" },
+    { "tag": "importing" },
   "ethers.js/html/getting-started.html#including-in-web-applications":
-    { "tag": "" },
+    { "tag": "importing" },
   "ethers.js/html/getting-started.html#installing-in-node-js":
-    { "tag": "" },
+    { "tag": "installing" },
   "ethers.js/html/index.html":
-    { "tag": "" },
+    { "path": "/v5/" },
   "ethers.js/html/index.html#features":
-    { "tag": "" },
+    { "tag": "features" },
   "ethers.js/html/index.html#legacy-documentation":
-    { "tag": "" },
+    { "tag": "documentation--legacy" },
   "ethers.js/html/index.html#what-is-ethers-js":
-    { "tag": "" },
+    { "tag": "preamble" },
   "ethers.js/html/migration.html":
-    { "tag": "" },
+    { "path": "/v5/migration/" },
   "ethers.js/html/migration.html#big-number":
     { "tag": "" },
   "ethers.js/html/migration.html#constants":
@@ -406,37 +414,37 @@
   "ethers.js/html/migration.html#waiting-for-transactions":
     { "tag": "" },
   "ethers.js/html/notes.html":
-    { "tag": "" },
+    { "path": "/v5/" },
   "ethers.js/html/notes.html#checksum-address":
-    { "tag": "" },
+    { "tag": "address-formats" },
   "ethers.js/html/notes.html#contributing":
-    { "tag": "" },
+    { "path": "/v5/contributing/" },
   "ethers.js/html/notes.html#icap-address":
-    { "tag": "" },
+    { "tag": "address-formats" },
   "ethers.js/html/notes.html#ieee754":
-    { "tag": "" },
+    { "tag": "BigNumber--notes-safenumbers" },
   "ethers.js/html/notes.html#memory-hard-brute-force-encrpyting":
-    { "tag": "" },
+    { "tag": "security--pbkdf" },
   "ethers.js/html/notes.html#notes":
-    { "tag": "" },
+    { "tag": "/v5/" },
   "ethers.js/html/notes.html#promise":
     { "tag": "" },
   "ethers.js/html/notes.html#promises":
     { "tag": "" },
   "ethers.js/html/notes.html#responsible-disclosure":
-    { "tag": "" },
+    { "path": "/v5/contributing/" },
   "ethers.js/html/notes.html#security":
-    { "tag": "" },
+    { "tag": "security" },
   "ethers.js/html/notes.html#supported-platforms":
     { "tag": "" },
   "ethers.js/html/notes.html#the-github-and-npm-package":
     { "tag": "" },
   "ethers.js/html/notes.html#why-can-t-i-just-use-numbers":
-    { "tag": "" },
+    { "tag": "BigNumber--notes-safenumbers" },
   "ethers.js/html/testing.html":
-    { "tag": "" },
+    { "path": "/v5/testing/" },
   "ethers.js/html/testing.html#testing":
-    { "tag": "" },
+    { "path": "/v5/testing/" },
   "ethers.js/v3.0/examples/splitter/index.html":
     { "redirect": "https://docs-legacy.ethers.io/v3/examples/splitter/index.html" },
   "ethers.js/v3.0/examples/tool/index.html":

docs/api/contract/README.md

@@ -1,30 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Contract Interaction
-====================
-
-
-Explain what contracts are...
-
-
-* [Contract](contract)
-  * [Properties](contract)
-  * [Methods](contract)
-  * [Events](contract)
-  * [Meta-Class](contract)
-* [Example: ERC-20 Contract](example)
-  * [Connecting to a Contract](example)
-  * [Properties ^^//(inheritted from [[contract]])//^^](example)
-  * [Methods ^^//(inheritted from [[contract]])//^^](example)
-  * [Events ^^//(inheritted from Contract)//^^](example)
-  * [Meta-Class Methods ^^//(added at Runtime)//^^](example)
-  * [Meta-Class Filters ^^//(added at Runtime)//^^](example)
-
-
-
------
-**Content Hash:** f1a5079be018a7b2e6ce8b86a5a191f7a1352b976434766ea16cec21d0ce3b80

docs/api/contract/contract/README.md

@@ -1,284 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Contract
-========
-
-
-
-Properties
-----------
-
-
-
-#### *contract* . **address** **=>** *string< [Address](../../utils/address) >*
-
-This is the address (or ENS name) the contract was constructed with.
-
-
-
-
-#### *contract* . **addressPromise** **=>** *string< [Address](../../utils/address) >*
-
-This is a promise that will resolve to the address the **Contract**
-object is attached to. If an [Address](../../utils/address) was provided to the constructor,
-it will be equal to this; if an ENS name was provided, this will be the
-resolved address.
-
-
-
-
-#### *contract* . **deployTransaction** **=>** *[TransactionResponse](../../providers/types)*
-
-If the **Contract** object is the result of a ContractFactory deployment,
-this is the transaction which was used to deploy the contract.
-
-
-
-
-#### *contract* . **interface** **=>** *[Interface](../../utils/abi/interface)*
-
-This is the ABI as an [Interface](../../utils/abi/interface).
-
-
-
-
-#### *contract* . **provider** **=>** *[Provider](../../providers/provider)*
-
-If a provider was provided to the constructor, this is that provider. If
-a signer was provided that had a [Provider](../../providers/provider), this is that provider.
-
-
-
-
-#### *contract* . **signer** **=>** *[Signer](../../signer)*
-
-If a signer was provided to the constructor, this is that signer.
-
-
-
-
-Methods
--------
-
-
-
-#### *contract* . **attach** ( addressOrName )  **=>** *[Contract](./)*
-
-Returns a new instance of the **Contract** attached to a new
-address. This is useful if there are multiple similar or identical
-copies of a Contract on the network and you wish to interact with
-each of them.
-
-
-
-
-#### *contract* . **connect** ( providerOrSigner )  **=>** *[Contract](./)*
-
-Returns a new instance of the Contract, but connected to
-*providerOrSigner*.
-
-By passing in a [Provider](../../providers/provider), this will return a downgraded
-**Contract** which only has read-only access (i.e. constant calls).
-
-By passing in a [Signer](../../signer). the will return a **Contract** which
-will act on behalf of that signer.
-
-
-
-
-#### *contract* . **deployed** (  )  **=>** *Promise< [Contract](./) >*
-
-
-
-
-
-
-#### *Contract* . **isIndexed** ( value )  **=>** *boolean*
-
-
-
-
-
-
-Events
-------
-
-
-
-#### *contract* . **queryFilter** ( event [  , fromBlockOrBlockHash [  , toBlock ]  )  **=>** *Promise< Array< Event > >*
-
-Return Events that match the *event*.
-
-
-
-
-#### *contract* . **listenerCount** (  [ event ]  )  **=>** *number*
-
-Return the number of listeners that are subscribed to *event*. If
-no event is provided, returns the total count of all events.
-
-
-
-
-#### *contract* . **listeners** ( event )  **=>** *Array< Listener >*
-
-Return a list of listeners that are subscribed to *event*.
-
-
-
-
-#### *contract* . **off** ( event , listener )  **=>** *this*
-
-Unsubscribe *listener* to *event*.
-
-
-
-
-#### *contract* . **on** ( event , listener )  **=>** *this*
-
-Subscribe to *event* calling *listener* when the event occurs.
-
-
-
-
-#### *contract* . **once** ( event , listener )  **=>** *this*
-
-Subscribe once to *event* calling *listener* when the event
-occurs.
-
-
-
-
-#### *contract* . **removeAllListeners** (  [ event ]  )  **=>** *this*
-
-Unsubscribe all listeners for *event*. If no event is provided,
-all events are unsubscribed.
-
-
-
-
-Meta-Class
-----------
-
-
-A Meta-Class is a Class which has any of its properties determined
-at run-time. The **Contract** object uses a Contract's ABI to
-determine what methods are available, so the following sections
-describe the generic ways to interact with the properties added
-at run-time during the **Contract** constructor.
-
-
-### Read-Only Methods (constant)
-
-
-A constant method is read-only and evaluates a small amount of EVM
-code against the current blockchain state and can be computed by
-asking a single node, which can return a result. It is therefore
-free and does not require any ether, but **cannot make changes** to
-the blockchain state..
-
-
-#### *contract* . **METHOD_NAME** ( ...args [ overrides ]  )  **=>** *Promise< any >*
-
-The type of the result depends on the ABI.
-
-For values that have a simple meaning in JavaScript, the types are fairly
-straight forward; strings and booleans are returned as JavaScript strings
-and booleans.
-
-For numbers, if the **type** is in the JavaSsript safe range (i.e. less
-than 53 bits, such as an `int24` or `uint48`) a normal JavaScript
-number is used. Otherwise a [BigNumber](../../utils/bignumber) is returned.
-
-For bytes (both fixed length and dynamic), a [DataHexstring](../../utils/bytes) is returned.
-
-
-
-
-### Write Methods (non-constant)
-
-
-A non-constant method requires a transaction to be signed and requires
-payment in the form of a fee to be paid to a miner. This transaction
-will be verified by every node on the entire network as well by the
-miner who will compute the new state of the blockchain after executing
-it against the current state.
-
-It cannot return a result. If a result is required, it should be logged
-using a Solidity event (or EVM log), which can then be queried from the
-transaction receipt.
-
-
-#### *contract* . **METHOD_NAME** ( ...args [  , overrides ]  )  **=>** *Promise< [TransactionResponse](../../providers/types) >*
-
-Returns a [TransactionResponse](../../providers/types) for the transaction after
-it is sent to the network. This requires the **Contract** has a
-signer.
-
-
-
-
-### Write Methods Analysis
-
-
-There are secveral options to analyze properties and results of a
-write method without actually executing it.
-
-
-#### *contract* . *estimate* . **METHOD_NAME** ( ...args [  , overrides ]  )  **=>** *Promise< [BigNumber](../../utils/bignumber) >*
-
-Returns the estimate units of gas that would be required to
-execute the *METHOD_NAME* with *args* and *overrides*.
-
-
-
-
-#### *contract* . *populateTransaction* . **METHOD_NAME** ( ...args [  , overrides ]  )  **=>** *Promise< [UnsignedTx](../../utils/transactions) >*
-
-Returns an [UnsignedTransaction](../../utils/transactions) which represents the transaction
-that would need to be signed and submitted to the network to execute
-*METHOD_NAME* with *args/ and *overrides//.
-
-
-
-
-#### *contract* . *staticCall* . **METHOD_NAME** ( ...args [  , overrides ]  )  **=>** *Promise< any >*
-
-Rather than executing the state-change of a transaction, it is possible
-to ask a node to *pretend* that a call is not state-changing and
-return the result.
-
-This does not actually chagne any state, but is free. This in some cases
-can be used to determine if a transaction will fail or succeed.
-
-This otherwise functions the same as a [Read-Only Method](./).
-
-
-
-
-### Event Filters
-
-
-An event filter is made up of topics, which are values logged in a
-[Bloom Filter](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/Bloom_filter), allowing efficient searching for entries
-which match a filter.
-
-
-#### *contract* . *filters* . **EVENT_NAME** ( ...args )  **=>** *Filter*
-
-Return a filter for *EVENT_NAME*, optionally filtering by additional
-constraints.
-
-Only `indexed` event parameters may be filtered. If a parameter is
-null (or not provided) then any value in that field matches.
-
-
-
-
-
------
-**Content Hash:** 8f1f64a28b2501d01dcf4b55c405c43096f3a9daca7169a96022000a315b2ef2

docs/api/contract/example/README.md

@@ -1,323 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Example: ERC-20 Contract
-========================
-
-
-
-Connecting to a Contract
-------------------------
-
-
-
-```
-// A Human-Readable ABI; any supported ABI format could be used
-const abi = [
-    // Read-Only Functions
-    "function balanceOf(address owner) view returns (uint256)",
-    "function decimals() view returns (uint8)",
-    "function symbol() view returns (string)",
-
-    // Authenticated Functions
-    "function transfer(address to, uint amount) returns (boolean)",
-
-    // Events
-    "event Transfer(address indexed from, address indexed to, uint amount)"
-];
-
-// This can be an address or an ENS name
-const address = "demotoken.ethers.eth";
-
-// An example Provider (connceted to testnet)
-const provider = ethers.getDefaultProvider("ropsten");
-
-// An example Signer
-const signer = ethers.Wallet.createRandom(provider);
-
-// Read-Only; By connecting to a Provider, allows:
-// - Any constant function
-// - Querying Filters
-// - Populating Unsigned Transactions for non-constant methods
-// - Estimating Gas for non-constant (as an anonymous sender)
-// - Static Calling non-constant methods (as anonymous sender)
-const erc20 = new ethers.Contract(address, abi, provider);
-
-// Read-Write; By connecting to a Signer, allows:
-// - Everything from Read-Only (except as Signer, not anonymous)
-// - Sending transactions for non-constant functions
-const erc20_rw = new ethers.Contract(address, abi, signer)
-```
-
-
-
-### ERC20Contract
-
-
-
-#### **new** *ethers* . **Contract** ( address , abi , providerOrSigner ) 
-
-See the above code example for creating an Instance which will
-(in addition to the Contact methods and properties) automatically
-add the additional properties defined in *abi* to a **Contract**
-connected to *address* using the *providerOrSigner*.
-
-
-
-
-Properties ^(*(inheritted from [Contract](../contract))*)
----------------------------------------------------------
-
-
-
-#### *erc20* . **address** **=>** *string< [Address](../../utils/address) >*
-
-This is the address (or ENS name) the contract was constructed with.
-
-
-
-
-#### *erc20* . **addressPromise** **=>** *string< [Address](../../utils/address) >*
-
-This is a promise that will resolve to the address the **Contract**
-object is attached to. If an [Address](../../utils/address) was provided to the constructor,
-it will be equal to this; if an ENS name was provided, this will be the
-resolved address.
-
-
-
-
-#### *erc20* . **deployTransaction** **=>** *[TransactionResponse](../../providers/types)*
-
-If the **Contract** object is the result of a ContractFactory deployment,
-this is the transaction which was used to deploy the contract.
-
-
-
-
-#### *erc20* . **interface** **=>** *[Interface](../../utils/abi/interface)*
-
-This is the ABI as an [Interface](../../utils/abi/interface).
-
-
-
-
-#### *erc20* . **provider** **=>** *[Provider](../../providers/provider)*
-
-If a provider was provided to the constructor, this is that provider. If
-a signer was provided that had a [Provider](../../providers/provider), this is that provider.
-
-
-
-
-#### *erc20* . **signer** **=>** *[Signer](../../signer)*
-
-If a signer was provided to the constructor, this is that signer.
-
-
-
-
-Methods ^(*(inheritted from [Contract](../contract))*)
-------------------------------------------------------
-
-
-
-#### *erc20* . **attach** ( addressOrName )  **=>** *[Contract](../contract)*
-
-Returns a new instance of the **Contract** attached to a new
-address. This is useful if there are multiple similar or identical
-copies of a Contract on the network and you wish to interact with
-each of them.
-
-
-
-
-#### *erc20* . **connect** ( providerOrSigner )  **=>** *[Contract](../contract)*
-
-Returns a new instance of the Contract, but connected to
-*providerOrSigner*.
-
-By passing in a [Provider](../../providers/provider), this will return a downgraded
-**Contract** which only has read-only access (i.e. constant calls).
-
-By passing in a [Signer](../../signer). the will return a **Contract** which
-will act on behalf of that signer.
-
-
-
-
-#### *erc20* . **deployed** (  )  **=>** *Promise< Contract >*
-
-
-
-
-
-
-#### *Contract* . **isIndexed** ( value )  **=>** *boolean*
-
-
-
-
-
-
-Events ^(*(inheritted from Contract)*)
---------------------------------------
-
-
-
-#### *erc20* . **queryFilter** ( event [  , fromBlockOrBlockHash [  , toBlock ]  )  **=>** *Promise< Array< Event > >*
-
-Return Events that match the *event*.
-
-
-
-
-#### *erc20* . **listenerCount** (  [ event ]  )  **=>** *number*
-
-Return the number of listeners that are subscribed to *event*. If
-no event is provided, returns the total count of all events.
-
-
-
-
-#### *erc20* . **listeners** ( event )  **=>** *Array< Listener >*
-
-Return a list of listeners that are subscribed to *event*.
-
-
-
-
-#### *erc20* . **off** ( event , listener )  **=>** *this*
-
-Unsubscribe *listener* to *event*.
-
-
-
-
-#### *erc20* . **on** ( event , listener )  **=>** *this*
-
-Subscribe to *event* calling *listener* when the event occurs.
-
-
-
-
-#### *erc20* . **once** ( event , listener )  **=>** *this*
-
-Subscribe once to *event* calling *listener* when the event
-occurs.
-
-
-
-
-#### *erc20* . **removeAllListeners** (  [ event ]  )  **=>** *this*
-
-Unsubscribe all listeners for *event*. If no event is provided,
-all events are unsubscribed.
-
-
-
-
-Meta-Class Methods ^(*(added at Runtime)*)
-------------------------------------------
-
-
-Since the Contract is a Meta-Class, the methods available here depend
-on the ABI which was passed into the **Contract**.
-
-
-#### *erc20* . **decimals** (  [ overrides ]  )  **=>** *Promise< number >*
-
-Returns the number of decimal places used by this ERC-20 token. This can be
-used with [parseUnits](../../utils/display-logic) when taking input from the user or
-[formatUnits](utils-formatunits] when displaying the token amounts in the UI.
-
-
-
-
-#### *erc20* . **getBalance** ( owner [  , overrides ]  )  **=>** *Promise< [BigNumber](../../utils/bignumber) >*
-
-Returns the balance of *owner* for this ERC-20 token.
-
-
-
-
-#### *erc20* . **symbol** (  [ overrides ]  )  **=>** *Promise< string >*
-
-Returns the symbol of the token.
-
-
-
-
-#### *erc20_rw* . **transfer** ( target , amount [  , overrides ]  )  **=>** *Promise< [TransactionResponse](../../providers/types) >*
-
-Transfers *amount* tokens to *target* from the current signer.
-The return value (a boolean) is inaccessible during a write operation
-using a transaction. Other techniques (such as events) are required
-if this value is required. On-chain contracts calling the `transfer`
-function have access to this result, which is why it is possible.
-
-
-
-
-#### *erc20* . *callStatic* . **transfer** ( target , amount [  , overrides ]  )  **=>** *Promise< boolean >*
-
-Performs a dry-run of transferring *amount* tokens to *target* from
-the current signer, without actually signing or sending a transaction.
-
-This can be used to preflight check that a transaction will be successful.
-
-
-
-
-#### *erc20* . *estimate* . **transfer** ( target , amount [  , overrides ]  )  **=>** *Promise< [BigNumber](../../utils/bignumber) >*
-
-Returns an estimate for how many units of gas would be required
-to transfer *amount* tokens to *target*.
-
-
-
-
-#### *erc20* . *populateTransaction* . **transfer** ( target , amount [  , overrides ]  )  **=>** *Promise< [UnsignedTx](../../utils/transactions) >*
-
-Returns an [UnsignedTransaction](../../utils/transactions) which could be signed and submitted
-to the network to transaction *amount* tokens to *target*.
-
-
-
-
-#### Note on Estimating and Static Calling
-
-When you perform a static call, the current state is taken into account as
-best as Ethereum can determine. There are many cases where this can provide
-false positives and false negatives. The eventually consistent model of the
-blockchain also means there are certain consistency modes that cannot be
-known until an actual transaction is attempted.
-
-
-
-
-Meta-Class Filters ^(*(added at Runtime)*)
-------------------------------------------
-
-
-Since the Contract is a Meta-Class, the methods available here depend
-on the ABI which was passed into the **Contract**.
-
-
-#### *erc20* . *filters* . **Transafer** (  [ fromAddress [  , toAddress ]  ]  )  **=>** *Filter*
-
-Returns a new Filter which can be used to [query](./) or
-to [subscribe/unsubscribe to events](./).
-
-If *fromAddress* is null or not provided, then any from address matches.
-If *toAddress* is null or not provided, then any to address matches.
-
-
-
-
-
------
-**Content Hash:** a3d2ad294a2b4b4500d3f80c7a1cdc76420fee234ad271d90f5c609b040e93fa

docs/api/other/assembly/api/README.md

@@ -1,184 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Utilities
-=========
-
-
-
-Assembler
----------
-
-
-The assembler utilities allow parsing and assembling an
-[Ethers ASM Dialect](../dialect) source file.
-
-
-#### *asm* . **parse** ( code )  **=>** *[Node](../ast)*
-
-Parse an ethers-format assembly file and return the [Abstract Syntax Tree](../ast).
-
-
-
-
-#### *asm* . **assemble** ( node )  **=>** *string< [DataHexstring](../../../utils/bytes) >*
-
-Performs assembly of the [Abstract Syntax Tree](../ast) *node* and return the
-resulting bytecode representation.
-
-
-
-
-Disassembler
-------------
-
-
-The **Disassembler** utilities make it easy to convert bytecode
-into an object which can easily be examined for program structure.
-
-
-#### *asm* . **disassemble** ( bytecode )  **=>** *[Bytecode](./)*
-
-Returns an array of Operations given *bytecode*.
-
-
-
-
-#### *asm* . **formatBytecode** ( operations )  **=>** *string*
-
-Create a formatted output of an array of [Operation](./).
-
-
-
-
-### Bytecode
-
-
-Each arary index represents an operation, collapsing multi-byte operations
-(i.e. `PUSH`) into a single operation.
-
-
-#### *bytecode* . **getOperation** ( offset )  **=>** *[Operation](./)*
-
-Get the operation at a given *offset* into the bytecode. This ensures that
-the byte at *offset* is an operation and not data contained within a `PUSH`,
-in which case null it returned.
-
-
-
-
-### Operation
-
-
-An **Operation** is a single command from a disassembled bytecode
-stream.
-
-
-#### *operation* . **opcode** **=>** *[Opcode](./)*
-
-The opcode for this Operation.
-
-
-
-
-#### *operation* . **offset** **=>** *number*
-
-The offset into the bytecode for this Operation.
-
-
-
-
-#### *operation* . **pushValue** **=>** *string< [DataHexstring](../../../utils/bytes) >*
-
-If the opcode is a `PUSH`, this is the value of that push
-
-
-
-
-Opcode
-------
-
-
-
-#### *asm* . *Opcode* . **from** ( valueOrMnemonic )  **=>** *[Opcode](./)*
-
-Create a new instnace of an Opcode for a given numeric value
-(e.g. 0x60 is PUSH1) or mnemonic string (e.g. "PUSH1").
-
-
-
-
-### Properties
-
-
-
-#### *opcode* . **value** **=>** *number*
-
-The value (bytecode as a number) of this opcode.
-
-
-
-
-#### *opcode* . **mnemonic** **=>** *string*
-
-The mnemonic string of this opcode.
-
-
-
-
-#### *opcode* . **delta** **=>** *number*
-
-The number of items this opcode will consume from the stack.
-
-
-
-
-#### *opcode* . **alpha** **=>** *number*
-
-The number of items this opcode will push onto the stack.
-
-
-
-
-#### *opcode* . **doc** **=>** *string*
-
-A short description of what this opcode does.
-
-
-
-
-#### *opcode* . **isMemory** (  )  **=>** *"read"|"write"|"full"*
-
-Returns true if the opcode accesses memory.
-
-
-
-
-#### *opcode* . **isStatic** (  )  **=>** *boolean*
-
-Returns true if the opcode cannot change state.
-
-
-
-
-#### *opcode* . **isJump** (  )  **=>** *boolean*
-
-Returns true if the opcode is a jumper operation.
-
-
-
-
-#### *opcode* . **isPush** (  )  **=>** *number*
-
-Returns 0 if the opcode is not a `PUSH*`, or the number
-of bytes this opcode will push if it is.
-
-
-
-
-
------
-**Content Hash:** d71fdeafad470effc353664c161dec6982a9c29b1015a5726fd2a3f576f8e377

docs/api/other/assembly/ast/README.md

@@ -1,251 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Abstract Syntax Tree
-====================
-
-
-Parsing a file using the [Ethers ASM Dialect](../dialect) will
-generate an Abstract Syntax Tree. The root node will always
-be a [ScopeNode](./) whose name is `_`.
-
-To parse a file into an Abstract Syntax tree, use the [parse](../api)
-function.
-
-
-Types
------
-
-
-
-### Location
-
-
-
-#### **offset** **=>** *number*
-
-The offset into the source code to the start of this node.
-
-
-
-
-#### **length** **=>** *number*
-
-The length of characters in the source code to the end of this node.
-
-
-
-
-#### **source** **=>** *string*
-
-The source code of this node.
-
-
-
-
-Nodes
------
-
-
-@TODO: Place a diagram here showing the hierarchy
-
-
-### Node
-
-
-
-#### *node* . **tag** **=>** *string*
-
-A unique tag for this node for the lifetime of the process.
-
-
-
-
-#### *node* . **location** **=>** *[Location](./)*
-
-The source code and location within the source code that this
-node represents.
-
-
-
-
-### ValueNode
-
-
-A **ValueNode** is a node which may manipulate the stack.
-
-
-### LiteralNode
-
-
-
-#### *literalNode* . **value** **=>** *string*
-
-The literal value of this node, which may be a [DataHexstring](../../../utils/bytes) or
-string of a decimal number.
-
-
-
-
-#### *literalNode* . **verbatim** **=>** *boolean*
-
-This is true in a [DataNode](./) context, since in that case the
-value should be taken verbatim and no `PUSH` operation shoud be
-added, otherwise false.
-
-
-
-
-### PopNode
-
-
-A **PopNode** is used to store a place-holder for an implicit pop from the
-stack. It represents the code for an implicit place-holder (i.e. `$$`) or an
-explicit place-holder (e.g. `$1`), which indicates the expect stack position
-to consume.
-
-
-#### *literalNode* . **index** **=>** *number*
-
-The index this **PopNode** is representing. For an implicit place-holder
-this is `0`.
-
-
-
-
-### LinkNode
-
-
-A **LinkNode** represents a link to another [Node](./)'s data,
-for example `$foo` or `#bar`.
-
-
-#### *linkNode* . **label** **=>** *string*
-
-Te name of the target node.
-
-
-
-
-#### *linkNode* . **type** **=>** *"offset"|"length"*
-
-Whether this node is for an offset or a length value of the
-target node.
-
-
-
-
-### OpcodeNode
-
-
-
-#### *opcodeNode* . **opcode** **=>** *[Opcode](../api)*
-
-The opcode for this Node.
-
-
-
-
-#### *opcodeNode* . **operands** **=>** *Array< [ValueNode](./) >*
-
-A list of all operands passed into this Node.
-
-
-
-
-### EvaluationNode
-
-
-An **EvaluationNode** is used to execute code and insert the results
-but does not generate
-any output assembly, using the `{{! code here }}` syntax.
-
-
-#### *literalNode* . **verbatim** **=>** *boolean*
-
-This is true in a [DataNode](./) context, since in that case the
-value should be taken verbatim and no `PUSH` operation shoud be
-added, otherwise false.
-
-
-
-
-#### *evaluationNode* . **script** **=>** *string*
-
-The code to evaluate and produce the result to use as a literal.
-
-
-
-
-### ExecutionNode
-
-
-An **ExecutionNode** is used to execute code but does not generate
-any output assembly, using the `{{! code here }}` syntax.
-
-
-#### *evaluationNode* . **script** **=>** *string*
-
-The code to execute. Any result is ignored.
-
-
-
-
-### LabelledNode
-
-
-A **LabelledNode** is used for any Node that has a name, and can therefore
-be targetted by a [LinkNode](./).
-
-
-#### *labelledNode* . **name** **=>** *string*
-
-The name of this node.
-
-
-
-
-### LabelNode
-
-
-A **LabelNode** is used as a place to `JUMP` to by referencing it
-name, using `@myLabel:`. A `JUMPDEST` is automatically inserted
-at the bytecode offset.
-
-
-### DataNode
-
-
-A **DataNode** allows for data to be inserted directly into the output
-assembly, using `@myData[ ... ]`. The data is padded if needed to ensure
-values that would otherwise be regarded as a `PUSH` value does not impact
-anything past the data.
-
-
-#### *dataNode* . **data** **=>** *Array< [ValueNode](./) >*
-
-The child nodes, which each represent a verbatim piece of data in insert.
-
-
-
-
-### ScopeNode
-
-
-A **ScopeNode** allows a new frame of reference that all [LinkNode](./)'s
-will use when resolving offset locations, using `@myScope{ ... }`.
-
-
-#### *scopeNode* . **statements** **=>** *Array< [Node](./) >*
-
-The list of child nodes for this scope.
-
-
-
-
-
------
-**Content Hash:** 27350094145eafe8e3b166698c29705f2edee81f6126de4e45d957a7c35a7109

docs/api/other/assembly/dialect/README.md

@@ -1,145 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Ethers ASM Dialect
-==================
-
-
-This provides a quick, high-level overcview of the **Ethers ASM Dialect**
-for EVM, which is defined by the [Ethers ASM Dialect Grammar](../../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/asm/grammar.jison)
-
-Once a program is compiled by a higher level langauge into ASM (assembly),
-or hand-coded directly in ASM, it needs to be assembled into bytecode.
-
-The assembly process performs a very small set of operations and is
-intentionally simple and closely related to the underlying EVM bytecode.
-
-Operations include embedding programs within programs (for example the
-deployment bootstrap has the runtime embedded in it) and computing the
-necessary offsets for jump operations.
-
-The [Command-Line Assembler](../../../../cli/asm) can be used to assemble an
-*Ethers ASM Dialect* file or to disassemble bytecode into its
-human-readable (ish) opcodes and literals.
-
-
-Opcodes
--------
-
-
-An **Opcode** may be provided in either a *functional* or
-*instructional* syntax. For Opcodes that require parameters,
-the *functional* syntax is recommended and the *instructional*
-syntax will raise a warning.
-
-@TODO: Examples
-
-
-Labels
-------
-
-
-A **Label** is a position in the program which can be jumped to. A
-`JUMPDEST` is automatically added to this point in the assembled
-output.
-
-@TODO: Exmaples
-
-
-Literals
---------
-
-
-A **Literal** puts data on the stack when executed using a `PUSH`
-operation.
-
-A **Literal** can be provided using a [DataHexstring](../../../utils/bytes) or a decimal
-byte value.
-
-@TODO: exmples
-
-
-Comments
---------
-
-
-To enter a comment in the **Ethers ASM Dialect**, any text following
-a semi-colon (i.e. `;`) is ignored by the assembler.
-
-
-Scopes
-------
-
-
-A common case in Ethereum is to have one program embedded in another.
-
-The most common use of this is embedding a Contract **runtime bytecode**
-within a **deployment bytecode**, which can be used as **init code**.
-
-When deploying a program to Ethereum, an **init transaction** is used. An
-*init transaction* has a null `to` address and contains bytecode in
-the `data`. This `data` bytecode is a program, that when executed
-returns some other bytecode as a result, this restul is the bytecode
-to be installed.
-
-Therefore it is important that embedded code uses jumps relative to itself,
-not the entire program it is embedded in, which also means that a jump
-can **only** target its own scope, no parent or child scopes. This is
-enforced by the assembler.
-
-A scope may access the offset of any child [Data Segment](./) or
-child [Scopes](./) (with respect to itself) and may access the length
-of any [Data Segment](./) or [Scopes](./) anywhere in the program.
-
-Every program in the **Ethers ASM Dialect** has a top-leve scope named `_`.
-
-
-Data Segment
-------------
-
-
-A **Data Segment** allows arbitrary data to be embedded into a program,
-which can be useful for lookup tables or deploy-time constants.
-
-An emtpty **Data Segment** can also be used when a labelled location is
-required, but without the `JUMPDEST` which a [Labels](./) adds.
-
-@TODO: Example
-
-
-Links
------
-
-
-A **Link** allows access to a [Scopes](./), [Data Segment](./) or [Labels](./).
-
-To access the byte offset of a labelled item, use `$foobar`.
-
-For a [Labels](./), the target must be directly reachable within this scope. For
-a [Data Segment](./) or a [Scopes](./), it can be inside the same scope or any
-child scope.
-
-For a [Data Segment](./) or a [Labels](./), there is an additional type of
-**Link**, which provides the length of the data or bytecode respectively. A
-**Length Link** is accessed by `#foobar` and is pushed on the stack as a
-literal.
-
-
-Stack Placeholders
-------------------
-
-
-@TODO: exampl
-
-
-Evaluation and Excution
------------------------
-
-
-
-
------
-**Content Hash:** b8f100efb0bd6c794cc6d4ae97c0243e10e6c2fe471cf16ba4e751ed43722bba

docs/api/other/hardware/README.md

@@ -1,37 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Hardware Wallets
-================
-
-
-
-LedgerSigner
-------------
-
-
-The [Ledger Hardware Wallets](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/www.ledger.com) are a fairly
-popular brand.
-
-TODO: importing
-
-
-### API
-
-
-
-#### **new** **LedgerSigner** (  [ provider [  , type [  , path ]  ]  ]  )  **=>** *[LedgerSigner](./)*
-
-Connects to a Ledger Hardware Wallet. The *type* if left unspecified is
-determined by the environment; in node the default is "hid" and in the browser
-"u2f" is the default. The default Ethereum path is used if *path* is left unspecified.
-
-
-
-
-
------
-**Content Hash:** 04412211499f34796f91e7112977e6f84607638be72dc600e488df07c4465805

docs/api/providers/README.md

@@ -1,89 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Providers
-=========
-
-
-A **Provider** is an abstraction of a connection to the
-Ethereum network, providing a concise, consistent interface
-to standard Ethereum node functionality.
-
-The ethers.js library provides several options which should
-cover the vast majority of use-cases, but also includes the
-necessary functions and classes for sub-classing if a more
-custom configuration is necessary.
-
-Most users should be able to simply use the [Default Provider](./).
-
-
-Default Provider
-----------------
-
-
-The default provider is the safest, easiest way to begin
-developing on *Ethereum*, and it is also robust enough
-for use in production.
-
-It creates a [FallbackProvider](other) connected to as many backend
-services as possible. When a request is made, it is sent to
-multiple backends simulatenously. As responses from each backend
-are returned, they are checked that they agree. Once a quorum
-has been reached (i.e. enough of the backends agree), the response
-is provided to your application.
-
-This ensures that if a backend has become out-of-sync, or if it
-has been compromised that its responses are dropped in favor of
-responses that match the majority.
-
-
-#### *ethers* . **getDefaultProvider** (  [ network ]  )  **=>** *[Provider](provider)*
-
-Returns a new Provider, backed by multiple services, connected
-to *network*. Is no *network* is provided, **homestead**
-(i.e. mainnet) is used.
-
-
-
-
-Provider Documentation
-----------------------
-
-
-
-* [Provider](provider)
-  * [Accounts Methods](provider)
-  * [Blocks Methods](provider)
-  * [Ethereum Naming Service (ENS) Methods](provider)
-  * [Logs Methods](provider)
-  * [Network Status Methods](provider)
-  * [Transactions Methods](provider)
-  * [Event Emitter Methods](provider)
-  * [Inspection Methods](provider)
-* [JsonRpcProvider](jsonrpc-provider)
-  * [JsonRpcSigner](jsonrpc-provider)
-  * [JsonRpcUncheckedSigner](jsonrpc-provider)
-* [API Providers](api-providers)
-  * [EtherscanProvider](api-providers)
-  * [InfuraProvider](api-providers)
-  * [AlchemyProvider](api-providers)
-  * [CloudfrontProvider](api-providers)
-* [Other Providers](other)
-  * [FallbackProvider](other)
-  * [IpcProvider](other)
-  * [UrlJsonRpcProvider](other)
-  * [Web3Provider](other)
-* [Types](types)
-  * [BlockTag](types)
-  * [Network](types)
-  * [Block](types)
-  * [Events and Logs](types)
-  * [Transactions](types)
-
-
-
------
-**Content Hash:** 29575fb7fa8a7a126446a463e402b3d444aaf8a36c9226d0644466e3ff899b07

docs/api/providers/api-providers/README.md

@@ -1,109 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-API Providers
-=============
-
-
-There are many services which offer a web API for accessing
-the Ethereum Blockchain. These Providers allow connecting
-to them, which simplifies development, since you do not need
-to run your own instance or cluster of Ethereum nodes.
-
-However, this reliance on third-party services can reduce
-resiliance, security and increase the amount of required trust.
-To mitigate these issues, it is recommended you use a
-[Default Provider](..).
-
-
-EtherscanProvider
------------------
-
-
-The **EtherscanProvider** is backed by a combination of the various
-[Etherscan APIs](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/etherscan.io/apis).
-
-
-#### *provider* . **getHistory** ( address )  **=>** *Array< History >*
-
-@TODO... Explain
-
-
-
-
-#### **Supported Networks**
-
-
-
-* Homestead (Mainnet)
-* Ropsten (proof-of-work testnet)
-* Rinkeby (proof-of-authority testnet)
-* G&ouml;rli (clique testnet)
-* Kovan (proof-of-authority testnet)
-
-
-
-
-InfuraProvider
---------------
-
-
-The **InfuraProvider** is backed by the popular [INFURA](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/infura.io)
-Ethereum service.
-
-
-#### **Supported Networks**
-
-
-
-* Homestead (Mainnet)
-* Ropsten (proof-of-work testnet)
-* Rinkeby (proof-of-authority testnet)
-* G&ouml;rli (clique testnet)
-* Kovan (proof-of-authority testnet)
-
-
-
-
-AlchemyProvider
----------------
-
-
-The **AlchemtProvider** is backed by [Alchemy](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/alchemyapi.io).
-
-
-#### **Supported Networks**
-
-
-
-* Homestead (Mainnet)
-* Ropsten (proof-of-work testnet)
-* Rinkeby (proof-of-authority testnet)
-* G&ouml;rli (clique testnet)
-* Kovan (proof-of-authority testnet)
-
-
-
-
-CloudfrontProvider
-------------------
-
-
-The CloudfrontProvider is backed by the [Cloudflare Ethereum Gateway](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/developers.cloudflare.com/distributed-web/ethereum-gateway).
-
-
-#### **Supported Networks**
-
-
-
-* Homestead (Mainnet)
-
-
-
-
-
------
-**Content Hash:** 79ad5dae92f00fc2ef2aceff6620ed9ae5f12d92d9e29ebc6be1c5752e65322f

docs/api/providers/jsonrpc-provider/README.md

@@ -1,133 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-JsonRpcProvider
-===============
-
-
-The [JSON-RPC API](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/github.com/ethereum/wiki/wiki/JSON-RPC) is a
-very popular method for interacting with Ethereum and is available in all
-major Ethereum node implementations (e.g. [Geth](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/geth.ethereum.org)
-and [Parity](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/www.parity.io)) as well as many third-party web
-services (e.g. [INFURA](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/infura.io))
-
-
-#### **new** *ethers* . *providers* . **JsonRpcProvider** (  [ url [  , aNetworkish ]  ]  ) 
-
-Connect to a JSON-RPC API located at *url* using the /aNetworkish// network.
-If *url* is not specified, the default (i.e. `http://localhost:8545`) is used
-and if no network is specified, it will be determined automatically by
-querying the node.
-
-
-
-
-#### Note: Connecting to a Local Node
-
-Each node implementation is slightly different and may require specific command-line
-flags or changes in their Settings UI to enable JSON-RPC, unlock accounrs
-or expose specific APIs. Please consult theit documentation.
-
-
-
-
-#### *jsonRpcProvider* . **getSigner** (  [ addressOrIndex ]  )  **=>** *[JsonRpcSigner](./)*
-
-Returns a [JsonRpcSigner](./) which is managed by this Ethereum node, at
-*addressOrIndex*. If no *addressOrIndex* is provided, the first
-account (account #0) is used.
-
-
-
-
-#### *jsonRpcProvider* . **getUncheckedSigner** (  [ addressOrIndex ]  )  **=>** *[JsonRpcUncheckedSigner](./)*
-
-
-
-
-
-
-#### *jsonRpcProvider* . **listAccounts** (  )  **=>** *Array< string >*
-
-Returns a list of all account addresses managed by this provider.
-
-
-
-
-#### *jsonRpcProvider* . **send** ( method , params )  **=>** *Promise< any >*
-
-Allows sending raw messages to the provider.
-
-This can be used for backend-specific calls, such as for debugging or
-specific account management.
-
-
-
-
-JsonRpcSigner
--------------
-
-
-A **JsonRpcSigner** is a simple Signer which is backed by a connected
-[JsonRpcProvider](./).
-
-
-#### *signer* . **provider** **=>** *[JsonRpcProvider](./)*
-
-The provider this signer was established from.
-
-
-
-
-#### *signer* . **connectUnchecked** (  )  **=>** *[JsonRpcUncheckedSigner](./)*
-
-Returns a new Signer object which does not perform addtional checks when
-sending a transaction. See [JsonRpcUncheckedSigner](./) for more details.
-
-
-
-
-#### *signer* . **sendUncheckedTransaction** ( transaction )  **=>** *Promise< string< [DataHexstring](../../utils/bytes)< 32 > > >*
-
-Sends the *transaction* and returns a Promise which resolves to the
-opacque transaction hash.
-
-
-
-
-#### *signer* . **unlock** ( password )  **=>** *Promise< boolean >*
-
-Request the node unlock the account (if locked) using *password*.
-
-
-
-
-JsonRpcUncheckedSigner
-----------------------
-
-
-The JSON-RPC API only provides a transaction hash as the response when a
-transaction is sent, but the ethers Provider requires populating all details
-of a transaction before returning it. For example, the gas price and gas limit
-may be adjusted by the node or the nonce automatically included, in which case
-the opaque transaction hash has discarded this.
-
-To remedy this, the [JsonRpcSigner](./) immeidately queries the provider for
-the details using the returned transaction hash to populate the [TransactionResponse](../types)
-object.
-
-Some backends do not respond immediately and instead defer releasing the
-details of a transaction it was responsible for signing until it is mined.
-
-The **UncheckedSigner** does not populate any additional information and will
-immediately return the result as a mock [TransactionResponse](../types)-like
-object, with most of the properties set to null, but allows access to the
-transaction hash quickly, if that is all that is required.
-
-
-
------
-**Content Hash:** d60a1c5ef2f317ae59bc4b22a1e9d079f1762f60f6321b5da1efbe07d8284284

docs/api/providers/other/README.md

@@ -1,187 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Other Providers
-===============
-
-
-Others...
-
-
-FallbackProvider
-----------------
-
-
-The **FallbackProvider** is the most advanced [Provider](../provider) available in
-ethers.
-
-It uses a quorum and connects to multiple [Providers](../provider) as backends,
-each configured with a *priority* and a *weight* .
-
-When a request is made, the request is dispatched to multiple backends, randomly
-choosen (higher prioirty backends are always selected first) and the results from
-each are compared against the others. Only once the quorum has been reached will that
-result be accepted and returned to the caller.
-
-By default the quorum requires 50% (rounded up) of the backends to agree. The *weight*
-can be used to give a backend Provider more influence.
-
-
-#### **new** *ethers* . *providers* . **FallbackProvider** ( providers [  , quorum ]  ) 
-
-Creates a new instance of a FallbackProvider connected to *providers*. If
-quorum is not specified, half of the total sum of the provider weights is
-used.
-
-The *providers* can be either an array of [Provider](../provider) or [FallbackProviderConfig](./).
-If a [Provider](../provider) is provided, the defaults are a priority of 1 and a weight of 1.
-
-
-
-
-#### *provider* . **providerConfigs** **=>** *Array< [FallbackProviderConfig](./) >*
-
-The list of Provider Configurations that describe the backends.
-
-
-
-
-#### *provider* . **quorum** **=>** *number*
-
-The quorum the backend responses must agree upon before a result will be
-resolved. By default this is *half the sum of the weights*.
-
-
-
-
-### FallbackProviderConfig
-
-
-
-#### *fallbackProviderConfig* . **provider** **=>** *[Provider](../provider)*
-
-The provider for this configuration.
-
-
-
-
-#### *fallbackProviderConfig* . **priority** **=>** *number*
-
-The priority used for the provider. Higher priorities are favoured over lower
-priorities. If multiple providers share the same prioirty, they are choosen
-at random.
-
-
-
-
-#### *fallbackProviderConfig* . **stallTimeout** **=>** *number*
-
-The timeout (in ms) after which another [Provider](../provider) will be attempted. This
-does not affect the current Provider; if it returns a result it is counted
-as part of the quorum.
-
-Lower values will result in more network traffic, but may reduce the response
-time of requests.
-
-
-
-
-#### *fallbackProviderConfig* . **weight** **=>** *number*
-
-The weight a response from this provider provides. This can be used if a given
-[Provider](../provider) is more trusted, for example.
-
-
-
-
-IpcProvider
------------
-
-
-The **IpcProvider** allows the JSON-RPC API to be used over a local
-filename on the file system, exposed by Geth, Parity and other nodes.
-
-This is only available in *node.js* (as it requires file system access,
-and may have additional complications due to file permissions. See any
-related notes on the documentation for the actual node implementation websites.
-
-
-#### *ipcProvider* . **path** **=>** *string*
-
-The path this [Provider](../provider) is connected to.
-
-
-
-
-UrlJsonRpcProvider
-------------------
-
-
-This class is intended to be sub-classed and not used directly. It
-simplifies creating a [Provider](../provider) where a normal [JsonRpcProvider](../jsonrpc-provider)
-would suffice, with a little extra effort needed to generate the JSON-RPC
-URL.
-
-
-#### **new** *ethers* . *providers* . **UrlJsonRpcProvider** (  [ network [  , apiKey ]  ]  ) 
-
-Sub-classes do not need to override this. Instead they should override the
-static method `getUrl` and optionally `getApiKey`.
-
-
-
-
-#### *urlJsonRpcProvider* . **apiKey** **=>** *any*
-
-The value of the apiKey that was returned from `InheritedClass.getApiKey`.
-
-
-
-
-#### *InheritingClass* . **getApiKey** ( apiKey )  **=>** *any*
-
-This function should examine the *apiKey* to ensure it is valid and
-return a (possible modified) value to use in `getUrl`.
-
-
-
-
-#### *InheritingClass* . **getUrl** ( network , apiKey )  **=>** *string*
-
-The URL to use for the JsonRpcProvider instance.
-
-
-
-
-Web3Provider
-------------
-
-
-The Web3Provider is meant to ease moving from a [web3.js based](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/github.com/ethereum/web3.js)
-application to ethers by wraping an existing Web3-compatible (such as a
-[Web3HttpProvider](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-http)[Web3IpcProvider](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-ipc) or
-[Web3WsProvider](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-ws)) and exposing it as an ethers.js [Provider](../provider)
-which can then be used with the rest of the library.
-
-
-#### **new** *ethers* . *providers* . **Web3Provider** ( web3Provider [  , network ]  ) 
-
-Create a new **Web3Provider**, which wraps an [EIP-1193 Provider]() or
-Web3Provider-compatible Provider.
-
-
-
-
-#### *web3Provider* . **provider** **=>** *Web3CompatibleProvider*
-
-The provider used to create this instance.
-
-
-
-
-
------
-**Content Hash:** e85f8ef6e4b1924ef63365dd6f761aa0ef5db23ebdd124686763d5061551a8bf

docs/api/providers/provider/README.md

@@ -1,275 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Provider
-========
-
-
-Explain what a provider is...
-
-
-Accounts Methods
-----------------
-
-
-
-#### *provider* . **getBalance** ( address [  , blockTag="latest" ]  )  **=>** *Promise< [BigNumber](../../utils/bignumber) >*
-
-Returns the balance of *address* as of the *blockTag* block height.
-
-
-
-
-#### *provider* . **getCode** ( address [  , blockTag="latest" ]  )  **=>** *Promise< string< [DataHexstring](../../utils/bytes) > >*
-
-Returns the contract code of *address* as of the *blockTag* block height. If there is
-no contract currently deployed, the result is `0x`.
-
-
-
-
-#### *provider* . **getStorageAt** ( addr , pos [  , blockTag="latest" ]  )  **=>** *Promise< string< [DataHexstring](../../utils/bytes) > >*
-
-Returns the `Bytes32` value of the position *pos* at address *addr*, as of the *blockTag*.
-
-
-
-
-#### *provider* . **getTransactionCount** ( address [  , blockTag="latest" ]  )  **=>** *Promise< number >*
-
-Returns the number of transactions *address* has ever **sent**, as of *blockTag*.
-This value is required to be the nonce for the next transaction from *address*
-sent to the network.
-
-
-
-
-### Examples
-
-
-
-```javascript
-Skipping JavaScript Evaluation.
-```
-
-
-
-Blocks Methods
---------------
-
-
-
-#### *provider* . **getBlock** ( block )  **=>** *Promise< [Block](../types) >*
-
-Get the *block* from the network, where the `result.transactions` is a list
-of transaction hashes.
-
-
-
-
-#### *provider* . **getBlockWithTransactions** ( block )  **=>** *Promise< [BlockWithTransactions](../types) >*
-
-Get the *block* from the network, where the `result.transactions` is
-an Array of [TransactionResponse](../types) objects.
-
-
-
-
-Ethereum Naming Service (ENS) Methods
--------------------------------------
-
-
-TODO: Explain ENS here...
-
-
-#### *provider* . **lookupAddress** ( address )  **=>** *Promise< string >*
-
-Performs a reverse lookup of the *address* in ENS using the
-*Reverse Registrar*.  If the name does not exist, or the
-forward lookup does not match, `null` is returned.
-
-
-
-
-#### *provider* . **resolveName** ( name )  **=>** *Promise< string< [Address](../../utils/address) > >*
-
-Looks up the address of *name*. If the name is not owned, or
-does not have a *Resolver* configured, or the *Resolver* does
-not have an address configured, `null` is returned.
-
-
-
-
-### Examples
-
-
-
-```javascript
-Skipping JavaScript Evaluation.
-```
-
-
-
-Logs Methods
-------------
-
-
-
-#### *provider* . **getLogs** ( filter )  **=>** *Promise< Array< [Log](../types) > >*
-
-Returns the Array of [Log](../types) matching the *filter*.
-
-Keep in mind that many backends will discard old events, and that requests
-which are too broad may get dropped as they require too many resources to
-execute the query.
-
-
-
-
-Network Status Methods
-----------------------
-
-
-
-#### *provider* . **getNetwork** (  )  **=>** *Promise< [Network](../types) >*
-
-Returns the [Network](../types) this Provider is connected to.
-
-
-
-
-#### *provider* . **getBlockNumber** (  )  **=>** *Promise< number >*
-
-Returns the block number (or height) of the most recently mined block.
-
-
-
-
-#### *provider* . **getGasPrice** (  )  **=>** *Promise< [BigNumber](../../utils/bignumber) >*
-
-Returns a *best guess* of the [Gas Price](../../../concepts/gas) to use in a transaction.
-
-
-
-
-Transactions Methods
---------------------
-
-
-
-#### *provider* . **call** ( transaction [  , blockTag="latest" ]  )  **=>** *Promise< string< [Hexstring](../../utils/bytes) > >*
-
-Returns the result of executing the *transaction*, using *call*. A call
-does not require any ether, but cannot change any state. This is useful
-for calling gettings on Contracts.
-
-
-
-
-#### *provider* . **estimateGas** ( transaction )  **=>** *Promise< [BigNumber](../../utils/bignumber) >*
-
-Returns an estimate of the amount of gas that would be required to submit *transaction*
-to the network.
-
-An estimate may not be accurate since there could be another transaction
-on the network that was not accounted for, but after being mined affected
-relevant state.
-
-
-
-
-#### *provider* . **sendTransaction** ( transaction )  **=>** *Promise< [TransactionResponse](../types) >*
-
-Submits *transaction* to the network to be mined. The *transaction* **must** be signed,
-and be valid (i.e. the nonce is correct and the account has sufficient balance to pay
-for the transaction).
-
-
-
-
-#### *provider* . **waitForTransaction** ( transactionHash )  **=>** *Promise< [TransactionReceipt](../types) >*
-
-Returns a Promise which will not resolve until *transactionHash* is mined.
-
-
-
-
-Event Emitter Methods
----------------------
-
-
-Explain events here...
-
-
-#### *provider* . **on** ( eventName , listener )  **=>** *this*
-
-Add a *listener* to be triggered for each *eventName*.
-
-
-
-
-#### *provider* . **once** ( eventName , listener )  **=>** *this*
-
-Add a *listener* to be triggered for only the next *eventName*,
-at which time it be removed.
-
-
-
-
-#### *provider* . **emit** ( eventName , ...args )  **=>** *boolean*
-
-Notify all listeners of *eventName*, passing *args* to each listener. This
-is generally only used internally.
-
-
-
-
-#### *provider* . **off** ( eventName [  , listener ]  )  **=>** *this*
-
-Remove a *listener* for *eventName*. If no *listener* is provided,
-all listeners for *eventName* are removed.
-
-
-
-
-#### *provider* . **removeAllListeners** (  [ eventName ]  )  **=>** *this*
-
-Remove all the listeners for *eventName*. If no *eventName* is provided,
-**all** events are removed.
-
-
-
-
-#### *provider* . **listenerCount** (  [ eventName ]  )  **=>** *number*
-
-Returns the number of listeners for *eventName*. If no *eventName* is
-provided, the total number of listeners is returned.
-
-
-
-
-#### *provider* . **listeners** ( eventName )  **=>** *Array< Listener >*
-
-Returns the list of Listeners for *eventName*.
-
-
-
-
-Inspection Methods
-------------------
-
-
-
-#### *Provider* . **isProvider** ( object )  **=>** *boolean*
-
-Returns true if and only if *object* is a Provider.
-
-
-
-
-
------
-**Content Hash:** 22872aec1236c5cf8fb457e93f36ca9bcd260acddc08c1ededc642931fd1625f

docs/api/providers/types/README.md

@@ -1,585 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Types
-=====
-
-
-
-BlockTag
---------
-
-
-A **BlockTag** specifies a specific location in the Blockchain.
-
-
-
-* **`"latest"`** -- The most recently mined block
-* **`"earliest"`** -- Block #0
-* **`"pending"`** -- The block currently being prepared for mining; not all operations and backends support this BlockTag
-* ***number*** -- The block at this height
-* ***a negative number*** -- The block this many blocks ago
-
-
-### EventType
-
-
-And **EventType** can be any of the following.
-
-
-
-* ***string*** -- TODO...
-* ***Array<string<[DataHexstring](../../utils/bytes)<32>> | Array<string<[DataHexstring](../../utils/bytes)<32>>>>*** -- TODO...
-* ***[EventFilter](./)*** -- TODO...
-
-
-Network
--------
-
-
-A **Network** represents an Etherem network.
-
-
-#### *network* . **name** **=>** *string*
-
-The human-readable name of the network, such as `homestead`. If the network
-name is unknown, this will be `"unknown"`.
-
-
-
-
-#### *network* . **chainId** **=>** *number*
-
-The Chain ID of the network.
-
-
-
-
-#### *network* . **ensAddress** **=>** *string< [Address](../../utils/address) >*
-
-The address at which the ENS registry is deployed on this network.
-
-
-
-
-Block
------
-
-
-
-#### *block* . **hash** **=>** *string< [DataHexstring](../../utils/bytes)< 32 > >*
-
-The hash of this block.
-
-
-
-
-#### *block* . **parentHash** **=>** *string< [DataHexstring](../../utils/bytes)< 32 > >*
-
-The hash of the previous block.
-
-
-
-
-#### *block* . **number** **=>** *number*
-
-The height (number) of this block.
-
-
-
-
-#### *block* . **timestamp** **=>** *number*
-
-The timestamp of this block.
-
-
-
-
-#### *block* . **nonce** **=>** *string< [DataHexstring](../../utils/bytes) >*
-
-The nonce used as part of the proof-of-work to mine this block.
-
-This property is generally of little interest developers.
-
-
-
-
-#### *block* . **difficulty** **=>** *number*
-
-The difficulty target required to be met by the miner of the block.
-
-This property is generally of little interest developers.
-
-
-
-
-#### *block* . **gasLimit** **=>** *[BigNumber](../../utils/bignumber)*
-
-The maximum amount of gas that this block was permitted to use. This
-is a value that can be voted up or voted down by miners and is used
-to automatically adjust the bandwidth requirements of the network.
-
-This property is generally of little interest developers.
-
-
-
-
-#### *block* . **gasUsed** **=>** *[BigNumber](../../utils/bignumber)*
-
-The total amount of gas used by all transactions in this block.
-
-
-
-
-#### *block* . **miner** **=>** *string*
-
-The coinbase address of this block, which indicates the address the
-miner that mined this block would like the subsidy reward to go to.
-
-
-
-
-#### *block* . **extraData** **=>** *string*
-
-This is extra data a miner may choose to include when mining a block.
-
-This property is generally of little interest developers.
-
-
-
-
-### Block (with transaction hashes)
-
-
-Often only the hashes of the transactions included in a block are needed,
-so by default a block only contains this information, as it is
-substantially less data.
-
-
-#### *block* . **transactions** **=>** *Array< string< [DataHexstring](../../utils/bytes)< 32 > > >*
-
-A list of the transactions hashes for each transaction this block
-includes.
-
-
-
-
-### BlockWithTransactions
-
-
-If all transactions for a block are needed, this object instead includes
-the full details on each transaction.
-
-
-#### *block* . **transactions** **=>** *Array< [TransactionResponse](./) >*
-
-A list of the transactions this block includes.
-
-
-
-
-Events and Logs
----------------
-
-
-
-### EventFilter
-
-
-
-#### *filter* . **address** **=>** *string< [Address](../../utils/address) >*
-
-The address to filter by, or `null` to match any address.
-
-
-
-
-#### *filter* . **topics** **=>** *Array< string< [DataHexstring](../../utils/bytes)< 32 > >|Array< string< [DataHexstring](../../utils/bytes)< 32 > > > >*
-
-The topics to filter by, or `null` to match any topics. Each entry represents an
-**AND** condition that must match, or may be `null` to match anything. If a given
-entry is an Array, then that entry is treated as an **OR** for any value in the entry.
-
-
-
-
-### Filter
-
-
-
-#### *filter* . **fromBlock** **=>** *[BlockTag](./)*
-
-The starting block (inclusive) to search for logs matching the filter criteria.
-
-
-
-
-#### *filter* . **toBlock** **=>** *[BlockTag](./)*
-
-The end block (inclusive) to search for logs matching the filter criteria.
-
-
-
-
-### FilterByBlockHash
-
-
-
-#### *filter* . **blockHash** **=>** *string< [DataHexstring](../../utils/bytes)< 32 > >*
-
-The specific block (by its block hash) to search for logs matching the filter criteria.
-
-
-
-
-### Log
-
-
-
-#### *log* . **blockNumber** **=>** *number*
-
-The block height (number) of the block including the transaction of this log.
-
-
-
-
-#### *log* . **blockHash** **=>** *string< [DataHexstring](../../utils/bytes)< 32 > >*
-
-The block hash of the block including the transaction of this log.
-
-
-
-
-#### *log* . **removed** **=>** *boolean*
-
-During a re-org, if a transaction is orphaned, this will be set to true
-to indicate the Log entry has been removed; it will likely be emitted
-again in the near future when another block is mined with the transaction
-that triggered this log, but keep in mind the values may change.
-
-
-
-
-#### *log* . **transactionLogIndex** **=>** *number*
-
-The index of this log in the transaction.
-
-
-
-
-#### *log* . **address** **=>** *string< [Address](../../utils/address) >*
-
-The address of the contract that generated this log.
-
-
-
-
-#### *log* . **data** **=>** *string< [DataHexstring](../../utils/bytes) >*
-
-The data included in this log.
-
-
-
-
-#### *log* . **topics** **=>** *Array< string< [DataHexstring](../../utils/bytes)< 32 > > >*
-
-The list of topics (indexed properties) for this log.
-
-
-
-
-#### *log* . **transactionHash** **=>** *string< [DataHexstring](../../utils/bytes)< 32 > >*
-
-The transaction hash of the transaction of this log.
-
-
-
-
-#### *log* . **transactionIndex** **=>** *number*
-
-The index of the transaction in the block of the transaction of this log.
-
-
-
-
-#### *log* . **logIndex** **=>** *number*
-
-The index of this log across all logs in the entire **block**.
-
-
-
-
-Transactions
-------------
-
-
-
-### TransactionRequest
-
-
-A transaction request describes a transaction that is to
-be sent to the network or otherwise processed.
-
-All fields are optional and may be a promise which resolves
-to the required type.
-
-
-#### *transactionRequest* . **to** **=>** *string|Promise< string >*
-
-The address (or ENS name) this transaction it to.
-
-
-
-
-#### *transactionRequest* . **from** **=>** *string< [Address](../../utils/address) >|Promise< string< [Address](../../utils/address) > >*
-
-The address this transaction is from.
-
-
-
-
-#### *transactionRequest* . **nonce** **=>** *number|Promise< number >*
-
-The nonce for this transaction. This should be set to the number of
-transactions ever sent **from** this address.
-
-
-
-
-#### *transactionRequest* . **gasLimit** **=>** *[BigNumber](../../utils/bignumber)|Promise< [BigNumber](../../utils/bignumber) >*
-
-The maximum amount of gas this transaction is permitted to use.
-
-
-
-
-#### *transactionRequest* . **gasPrice** **=>** *[BigNumber](../../utils/bignumber)|Promise< [BigNumber](../../utils/bignumber) >*
-
-The price (in wei) per unit of gas this transaction will pay.
-
-
-
-
-#### *transactionRequest* . **data** **=>** *[DataHexstring](../../utils/bytes)|Promise< [DataHexstring](../../utils/bytes) >*
-
-The transaction data.
-
-
-
-
-#### *transactionRequest* . **value** **=>** *[BigNumber](../../utils/bignumber)|Promise< [BigNumber](../../utils/bignumber) >*
-
-The amount (in wei) this transaction is sending.
-
-
-
-
-#### *transactionRequest* . **chainId** **=>** *number|Promise< number >*
-
-The chain ID this transaction is authorized on, as specified by
-[EIP-155](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/eips.ethereum.org/EIPS/eip-155).
-
-If the chain ID is 0 will disable EIP-155 and the transaction will be valid
-on any network. This can be **dangerous** and care should be taken, since it
-allows transactions to be replayed on networks that were possibly not
-intended.
-
-
-
-
-### TransactionResponse
-
-
-A **TransactionResponse** includes all properties of a [Transaction](../../utils/transactions) as well as several
-properties that are useful once it has been mined.
-
-
-#### *transaction* . **blockNumber** **=>** *number*
-
-The number ("height") of the block this transaction was mined in. If the block has not been mined,
-this is `null`.
-
-
-
-
-#### *transaction* . **blockHash** **=>** *string< [DataHexstring](../../utils/bytes)< 32 > >*
-
-The hash of the block this transaction was mined in. If the block has not been mined,
-this is `null`.
-
-
-
-
-#### *transaction* . **timestamp** **=>** *number*
-
-The timestamp of the block this transaction was mined in. If the block has not been mined,
-this is `null`.
-
-
-
-
-#### *transaction* . **confirmations** **=>** *number*
-
-The number of blocks that have been mined (including the initial block) since this
-transaction was mined.
-
-
-
-
-#### *transaction* . **raw** **=>** *string< [DataHexstring](../../utils/bytes) >*
-
-The serialized transaction.
-
-
-
-
-#### *transaction* . **wait** (  [ confirmations=1 ]  )  **=>** *Promise< [TransactionReceipt](./) >*
-
-Wait for *confirmations*. If 0, and the transaction has not been mined,
-`null` is returned.
-
-
-
-
-### TransactionReceipt
-
-
-
-#### *receipt* . **to** **=>** *string< [Address](../../utils/address) >*
-
-The address this transaction is to. This is `null` if the the
-transaction was an **init transaction**, used to deploy a contract.
-
-
-
-
-#### *receipt* . **from** **=>** *string< [Address](../../utils/address) >*
-
-The address this transaction is from.
-
-
-
-
-#### *receipt* . **contractAddress** **=>** *string< [Address](../../utils/address) >*
-
-If this transaction has a ``null` to address, it is an **init transaction**
-used to deploy a contract, in which case this is the address created by that
-contract.
-
-To compute a contract address, the [getContractAddress](../../utils/address)
-utility function can also be used with a [TransactionResponse](./)
-object, which requires the transaction nonce and the address of the sender.
-
-
-
-
-#### *receipt* . **transactionIndex** **=>** *number*
-
-The index of this transaction in the list of transactions included in
-the block this transaction was mined in.
-
-
-
-
-#### *receipt* . **root** **=>** *string*
-
-The intermediate state root of a receipt.
-
-Only transactions included in blocks **before** the [Byzantium Hard Fork](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/eips.ethereum.org/EIPS/eip-609)
-have this property, as it was replaced by the `status` property.
-
-The property is generally of little use to developers. At the time
-it could be used to verify a state transition with a fraud-proof
-only considering the single transaction; without it the full block
-must be considered.
-
-
-
-
-#### *receipt* . **gasUsed** **=>** *[BigNumber](../../utils/bignumber)*
-
-The amount of gas actually used by this transaction.
-
-
-
-
-#### *receipt* . **logsBloom** **=>** *string< [DataHexstring](../../utils/bytes) >*
-
-A [bloom-filter](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/Bloom_filter), which
-incldues all the addresses and topics included in any log in this
-transaction.
-
-
-
-
-#### *receipt* . **blockHash** **=>** *string< [DataHexstring](../../utils/bytes)< 32 > >*
-
-The block hash of the block that this transaction was included in.
-
-
-
-
-#### *receipt* . **transactionHash** **=>** *string< [DataHexstring](../../utils/bytes)< 32 > >*
-
-The transaction hash of this transaction.
-
-
-
-
-#### *receipt* . **logs** **=>** *Array< [Log](./) >*
-
-All the logs emitted by this transaction.
-
-
-
-
-#### *receipt* . **blockNumber** **=>** *number*
-
-The block height (number) of the block that this transaction was
-included in.
-
-
-
-
-#### *receipt* . **confirmations** **=>** *number*
-
-The number of blocks that have been mined since this transaction,
-including the actual block it was mined in.
-
-
-
-
-#### *receipt* . **cumulativeGasUsed** **=>** *[BigNumber](../../utils/bignumber)*
-
-For the block this transaction was included in, this is the sum of the
-gas used used by each transaction in the ordered list of transactions
-up to (and including) this transaction.
-
-This is generally of little interest to developers.
-
-
-
-
-#### *receipt* . **byzantium** **=>** *boolean*
-
-This is true if the block is in a [post-Byzantium Hard Fork](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/eips.ethereum.org/EIPS/eip-609)
-block.
-
-
-
-
-#### *receipt* . **status** **=>** *boolean*
-
-The status of a transaction is 1 is successful or 0 if it was
-reverted. Only transactions included in blocks [post-Byzantium Hard Fork](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/eips.ethereum.org/EIPS/eip-609)
-have this property.
-
-
-
-
-
------
-**Content Hash:** 911f42520657ebece6d9fe0456cae0540134758a7253057c42acffac94fb0895

docs/api/signer/README.md

@@ -1,362 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Signers
-=======
-
-
-A Signer represents...
-
-
-Signer
-------
-
-
-The **Signer** class is abstract and cannot be directly instaniated. Instead
-use one of the concreate sub-classes, such as the [Wallet](./), [VoidSigner](./)
-or [JsonRpcSigner](../providers/jsonrpc-provider).
-
-
-#### *signer* . **connect** ( provider )  **=>** *[Signer](./)*
-
-Sub-classes **must** implement this, however they may simply throw an error
-if changing providers is not supported.
-
-
-
-
-#### *signer* . **getAddress** (  )  **=>** *Promise< string< [Address](../utils/address) > >*
-
-Returns a Promise that resolves to the account address.
-
-This is a Promise so that a **Signer** can be designed around an
-asynchronous source, such as  hardware wallets.
-
-Sub-classes **must** implement this.
-
-
-
-
-#### *Signer* . **isSigner** ( object )  **=>** *boolean*
-
-Returns true if an only if *object* is a **Signer**.
-
-
-
-
-### Blockchain Methods
-
-
-
-#### *signer* . **getBalance** (  [ blockTag="latest" ]  )  **=>** *Promise< [BigNumber](../utils/bignumber) >*
-
-Returns the balance of this wallet at *blockTag*.
-
-
-
-
-#### *signer* . **getChainId** (  )  **=>** *Promise< number >*
-
-Returns ths chain ID this wallet is connected to.
-
-
-
-
-#### *signer* . **getGasPrice** (  )  **=>** *Promise< [BigNumber](../utils/bignumber) >*
-
-Returns the current gas price.
-
-
-
-
-#### *signer* . **getTransactionCount** (  [ blockTag="latest" ]  )  **=>** *Promise< number >*
-
-Returns the number of transactions this account has ever sent. This
-is the value required to be included in transactions as the `nonce`.
-
-
-
-
-#### *signer* . **call** ( transactionRequest )  **=>** *Promise< string< [DataHexstring](../utils/bytes) > >*
-
-Returns the result of calling using the *transactionRequest*, with this
-account address being used as the `from` field.
-
-
-
-
-#### *signer* . **estimateGas** ( transactionRequest )  **=>** *Promise< [BigNumber](../utils/bignumber) >*
-
-Returns the result of estimating the cost to send the *transactionRequest*,
-with this account address being used as the `from` field.
-
-
-
-
-#### *signer* . **resolveName** ( ensName )  **=>** *Promise< string< [Address](../utils/address) > >*
-
-Returns the address associated with the *ensName*.
-
-
-
-
-### Signing
-
-
-
-#### *signer* . **signMessage** ( message )  **=>** *Promise< string< [FlatSignature](../utils/bytes) > >*
-
-This returns a Promise which resolves to the [Flat-Format Signature](../utils/bytes)
-of *message*.
-
-Sub-classes **must** implement this, however they may throw if signing a
-message is not supported.
-
-
-
-
-#### Note
-
-If *message* is a string, it is **treated as a string** and
-converted to its representation in UTF8 bytes.
-
-**If and only if** a message is a [Bytes](../utils/bytes) will it be treated as
-binary data.
-
-For example, the string `"0x1234"` is 6 characters long (and in
-this case 6 bytes long). This is **not** equivalent to the array
-`[ 0x12, 0x34 ]`, which is 2 bytes long.
-
-A common case is to sign a hash. In this case, if the hash is a
-string, it **must** be converted to an array first, using the
-[arrayify](../utils/bytes) utility function.
-
-
-
-
-
-#### *signer* . **signTransaction** ( transactionRequest )  **=>** *Promise< string< [DataHexstring](../utils/bytes) > >*
-
-Returns a Promise which resolves to the signed transaction of the
-*transactionRequest*. This method does not populate any missing fields.
-
-Sub-classes **must** implement this, however they may throw if signing a
-transaction is not supported.
-
-
-
-
-#### *signer* . **sendTransaction** ( transactionRequest )  **=>** *Promise< [TransactionResponse](../providers/types) >*
-
-This method populates the transactionRequest with missing fields, using
-[populateTransaction](./) and returns a Promise which resolves to the transaction.
-
-Sub-classes **must** implement this, however they may throw if signing a
-transaction is not supported.
-
-
-
-
-### Sub-Classes
-
-
-It is very important that all important properties of a **Signer** are
-**immutable**. Since Ethereum is very asynchronous and deals with critical
-data (such as ether and other potentially valuable crypto assets), keeping
-properties such as the *provider* and *address* static helps prevent
-serious issues.
-
-A sub-class **must** call `super()`.
-
-
-#### *signer* . **checkTransaction** ( transactionRequest )  **=>** *[TransactionRequest](../providers/types)*
-
-This is generally not required to be overridden, but may needed to provide
-custom behaviour in sub-classes.
-
-This should return a **copy** of the *transactionRequest*, with any properties
-needed by `call`, `estimateGas` and `populateTransaction` (which is used
-by sendTransaction). It should also throw an error if any unknown key is specified.
-
-The default implementation checks only valid [TransactionRequest](../providers/types) properties
-exist and adds `from` to the transaction if it does not exist, or verifies it is equal
-to the Signer's address if it does exist.
-
-
-
-
-#### *signer* . **populateTransaction** ( transactionRequest )  **=>** *Promise< [TransactionRequest](../providers/types) >*
-
-This is generally not required to be overridden, but may needed to provide
-custom behaviour in sub-classes.
-
-This should return a **copy** of *transactionRequest*, follow the same procedure
-as `checkTransaction` and fill in any properties required for sending a transaction.
-The result should have all promises resolved; if needed the [resolveProperties](../utils/properties)
-utility function can be used for this.
-
-The default implementation calls `checkTransaction` and resolves to if it is an
-ENS name, adds `gasPrice`, `nonce`, `gasLimit` and `chainId` based on the
-related operations on Signer.
-
-
-
-
-Wallet
-------
-
-
-The Wallet class inherits [Signer](./) and can sign transactions and messages
-using a private key as a standard Externally Owned Account (EOA).
-
-
-#### **new** *ethers* . **Wallet** ( privateKey [  , provider ]  ) 
-
-Create a new Wallet instance for *privateKey* and optionally
-connected to the *provider*.
-
-
-
-
-#### *ethers* . *Wallet* . **createRandom** (  [ options={} ]  )  **=>** *[Wallet](./)*
-
-Returns a new Wallet with a random private key, generated from
-cryptographically secure entropy sources. If the current environment
-does not have a secure entropy source, an error is thrown.
-
-
-
-
-#### *ethers* . *Wallet* . **fromEncryptedJson** ( json , password [  , progress ]  )  **=>** *Promise< [Wallet](./) >*
-
-Create an instance from an encrypted JSON wallet. If *progress*
-is provided it will be called during decryption with a value between 0 and
-1 indicating the progress towards completion.
-
-
-
-
-#### *ethers* . *Wallet* . **fromMnemonic** ( mnemonic [  , path ,  [ wordlist ]  ]  )  **=>** *[Wallet](./)*
-
-Create an instance from a mnemonic phrase.
-
-If path is not specified, the Ethereum default path is used (i.e. m/44'/60'/0'/0/0).
-
-If wordlist is not specified, the English Wordlist is used.
-
-
-
-
-### Properties
-
-
-
-#### *wallet* . **address** **=>** *string< [Address](../utils/address) >*
-
-The address for the account this Wallet represents.
-
-
-
-
-#### *wallet* . **provider** **=>** *[Provider](../providers/provider)*
-
-The provider this wallet is connected to, which will ge used for any [Blockchain Methods](./)
-methods. This can be null.
-
-
-
-
-#### Note
-
-A **Wallet** instance is immuatable, so if you wish to change the Provider, you
-may use the [connect](./) method to create a new instance connected
-to the desired provider.
-
-
-
-
-#### *wallet* . **publicKey** **=>** *string< [DataHexstring](../utils/bytes)< 65 > >*
-
-The uncompressed public key for this Wallet represents.
-
-
-
-
-### Methods
-
-
-
-#### *wallet* . **encrypt** ( password ,  [ options={} ,  [ progress ]  ]  )  **=>** *Promise< string >*
-
-Encrypt the wallet using *password* returning a Promise which resolves
-to a JSON wallet.
-
-
-
-
-VoidSigner
-----------
-
-
-A **VoidSigner** is a simple Signer which cannot sign.
-
-It is useful as a read-only signer, when an API requires a
-Signer as a parameter, but it is known only read-only operations
-will be carried.
-
-For example, the `call` operation will automatically have the
-provided address passed along during the execution.
-
-
-#### **new** *ethers* . **VoidSigner** ( address )  **=>** *[VoidSigner](./)*
-
-Create a new instance of a **VoidSigner** for *address*.
-
-
-
-
-#### *voidSigner* . **address** **=>** *string< [Address](../utils/address) >*
-
-The address of this **VoidSigner**.
-
-
-
-
-ExternallyOwnedAccount
-----------------------
-
-
-This is an interface which contains a minimal set of properties
-required for Externally Owned Accounts which can have certain
-operations performed, such as encoding as a JSON wallet.
-
-
-#### *eoa* . **address** **=>** *string< [Address](../utils/address) >*
-
-The [Address](../utils/address) of this EOA.
-
-
-
-
-#### *eoa* . **privateKey** **=>** *string< [DataHexstring](../utils/bytes)< 32 > >*
-
-The privateKey of this EOA
-
-
-
-
-#### *eoa* . **mnemonic** **=>** *[Mnemonic](../utils/hdnode)*
-
-*Optional*. The account HD mnemonic, if it has one and can be
-determined. Some sources do not encode the mnemonic, such as an
-HD extended keys.
-
-
-
-
-
------
-**Content Hash:** 142e4d9da1f8b8a900a2e97de899649447054c6addb8cba0fb3342ff02d29fd8

docs/api/utils/abi/fragments/README.md

@@ -1,398 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Fragments
-=========
-
-
-Explain an ABI.
-
-
-Formats
--------
-
-
-
-### JSON String ABI (Solidity Output JSON)
-
-
-The **JSON ABI Format** is the format that is
-[output from the Solidity compiler](../../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/solidity.readthedocs.io/en/v0.6.0/using-the-compiler.html).
-
-A JSON serialized object is always a string, which represents an Array
-of Objects, where each Object has various properties describing the [Fragment](./) of the ABI.
-
-The deserialied JSON string (which is a normal JavaScript Object) may
-also be passed into any function which accepts a JSON String ABI.
-
-
-### Humanb-Readable ABI
-
-
-The Human-Readable ABI was
-
-[article](../../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/blog.ricmoo.com/human-readable-contract-abis-in-ethers-js-141902f4d917)
-
-
-### Output Formats
-
-
-Each [Fragment](./) and [ParamType](./) may be output using its `format`
-method.
-
-
-#### *ethers* . *utils* . *FragmentTypes* . **full** **=>** *string*
-
-This is a full human-readable string, including all parameter names, any
-optional modifiers (e.g. `indexed`, `public`, etc) and white-space
-to aid in human readabiliy.
-
-
-
-
-#### *ethers* . *utils* . *FragmentTypes* . **minimal** **=>** *string*
-
-This is similar to `full`, except with no unnecessary whitespace or parameter
-names. This is useful for storing a minimal string which can still fully
-reconstruct the original Fragment using [Fragment . from](./).
-
-
-
-
-#### *ethers* . *utils* . *FragmentTypes* . **json** **=>** *string*
-
-This returns a JavaScript Object which is safe to call `JSON.stringify`
-on to create a JSON string.
-
-
-
-
-#### *ethers* . *utils* . *FragmentTypes* . **sighash** **=>** *string*
-
-This is a minimal output format, which is used by Solidity when computing a
-signature hash or an event topic hash.
-
-
-
-
-#### Note
-
-The `sighash` format is **insufficient** to re-create the original [Fragment](./),
-since it discards modifiers such as indexed, anonymous, stateMutability, etc.
-
-
-
-
-Fragment
---------
-
-
-An ABI is a collection of **Fragments**, where each fragment specifies:
-
-
-
-* An [Event](./)
-* A [Function](./)
-* A [Constructor](./)
-
-
-### Properties
-
-
-
-#### *fragment* . **name** **=>** *string*
-
-This is the name of the Event or Function. This will be null for
-a [ConstructorFragment](./).
-
-
-
-
-#### *fragment* . **type** **=>** *string*
-
-This is a string which indicates the type of the [Fragment](./). This
-will be one of:
-
-
-
-* `constructor`
-* `event`
-* `function`
-
-
-
-
-#### *fragment* . **inputs** **=>** *Array< [ParamType](./) >*
-
-This is an array of of each [ParamType](./) for the input parameters to
-the Constructor, Event of Function.
-
-
-
-
-### Methods
-
-
-
-#### *ethers* . *utils* . *Fragment* . **from** ( objectOrString )  **=>** *[Fragment](./)*
-
-Returns a
-
-
-
-
-#### *ethers* . *utils* . *Fragment* . **isFragment** ( object )  **=>** *boolean*
-
-Tra lal al
-
-
-
-
-ConstructorFragment
--------------------
-
-
-
-### Properties
-
-
-
-#### *fragment* . **gas** **=>** *[BigNumber](../../bignumber)*
-
-This is the gas limit that should be used during deployment. It may be
-null.
-
-
-
-
-#### *fragment* . **payable** **=>** *boolean*
-
-This is whether the constructor may receive ether during deployment as
-an endowment (i.e. msg.value != 0).
-
-
-
-
-#### *fragment* . **stateMutability** **=>** *string*
-
-This is the state mutability of the constructor. It can be any of:
-
-
-
-* `nonpayable`
-* `payable`
-
-
-
-
-### Methods
-
-
-
-#### *ethers* . *utils* . *ConstructorFragment* . **from** ( objectOrString )  **=>** *[ConstructorFragment](./)*
-
-Tra la la...
-
-
-
-
-#### *ethers* . *utils* . *ConstructorFragment* . **isConstructorFragment** ( object )  **=>** *boolean*
-
-Tra lal al
-
-
-
-
-EventFragment
--------------
-
-
-
-### Properties
-
-
-
-#### *fragment* . **anonymous** **=>** *boolean*
-
-This is whether the event is anonymous. An anonymous Event does not inject its
-topic hash as topic0 when creating a log.
-
-
-
-
-### Methods
-
-
-
-#### *ethers* . *utils* . *EventFragment* . **from** ( objectOrString )  **=>** *[EventFragment](./)*
-
-Tra la la...
-
-
-
-
-#### *ethers* . *utils* . *EventFragment* . **isEventFragment** ( object )  **=>** *boolean*
-
-Tra lal al
-
-
-
-
-FunctionFragment
-----------------
-
-
-
-### Properties
-
-
-
-#### *fragment* . **constant** **=>** *boolean*
-
-This is whether the function is constant (i.e. does not change state). This
-is true if the state mutability is `pure` or `view`.
-
-
-
-
-#### *fragment* . **stateMutability** **=>** *string*
-
-This is the state mutability of the constructor. It can be any of:
-
-
-
-* `nonpayable`
-* `payable`
-* `pure`
-* `view`
-
-
-
-
-#### *fragment* . **outputs** **=>** *Array< [ParamType](./) >*
-
-A list of the Function output parameters.
-
-
-
-
-### Method
-
-
-
-#### *ethers* . *utils* . *FunctionFragment* . **from** ( objectOrString )  **=>** *[FunctionFragment](./)*
-
-Tra la la...
-
-
-
-
-#### *ethers* . *utils* . *FunctionFragment* . **isFunctionFragment** ( object )  **=>** *boolean*
-
-Tra lal al
-
-
-
-
-ParamType
----------
-
-
-The following examples will represent the Solidity parameter:
-
-`string foobar`
-
-
-### Properties
-
-
-
-#### *paramType* . **name** **=>** *string*
-
-The local parameter name. This may be null for unnamed parameters. For example,
-the parameter definition `string foobar` would be `foobar`.
-
-
-
-
-#### *paramType* . **type** **=>** *string*
-
-The full type of the parameter, including tuple and array symbols. This may be null
-for unnamed parameters. For the above example, this would be `foobar`.
-
-
-
-
-#### *paramType* . **basetype** **=>** *string*
-
-The base type of the parameter. For primitive types (e.g. `address`, `uint256`, etc)
-this is equal to [type](./). For arrays, it will be the string `array` and for
-a tuple, it will be the string `tuple`.
-
-
-
-
-#### *paramType* . **indexed** **=>** *boolean*
-
-Whether the parameter has been marked as indexed. This **only** applies
-to parameters which are part of an [EventFragment](./).
-
-
-
-
-#### *paramType* . **arrayChildren** **=>** *[ParamType](./)*
-
-The type of children of the array. This is null for for any parameter
-wjhich is not an array.
-
-
-
-
-#### *paramType* . **arrayLength** **=>** *number*
-
-The length of the array, or `-1` for dynamic-length arrays. This is
-null for parameters which is not arrays.
-
-
-
-
-#### *paramType* . **components** **=>** *Array< [ParamType](./) >*
-
-The components of a tuple. This is null for non-tuple parameters.
-
-
-
-
-### Methods
-
-
-Tra la la...
-
-
-#### *paramType* . **format** (  [ outputType=sighash ]  ) 
-
-Tra la la...
-
-
-
-
-#### *ethers* . *utils* . *ParamType* . **from** ( objectOrString )  **=>** *[ParamType](./)*
-
-Tra la la...
-
-
-
-
-#### *ethers* . *utils* . *ParamType* . **isParamType** ( object )  **=>** *boolean*
-
-Tra la la...
-
-
-
-
-
------
-**Content Hash:** b3b5bca0e0fe90226032a0727af0e449044a395b8bceb808b47a022024ee560b

docs/api/utils/abi/interface/README.md

@@ -1,353 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Interface
-=========
-
-
-The **Interface** Class abstracts the encoding and decoding required
-to interact with contracts on the Ethereum network.
-
-Many of the standards organically evolved along side the [Solidity](../../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/solidity.readthedocs.io/en/v0.6.2)
-language, which other languages have adopted to remain compatibile with
-existing deployed contracts.
-
-The EVM itself does not understand what the ABI is. It is simply an agreed
-upon set of formats to encode various types of data which each contract can
-expect so they can interoperate with each other.
-
-
-Creating Instances
-------------------
-
-
-
-#### **new** *ethers* . *utils* . **Interface** ( abi ) 
-
-Create a new **Interface** from a JSON string or object representing
-*abi*.
-
-The *abi* may be a JSON string or the parsed Object (using JSON.parse)
-which is emitted by the [Solidity compiler](../../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/solidity.readthedocs.io/en/v0.6.0/using-the-compiler.html) (or compatible languages).
-
-The *abi* may also be a [Human-Readable Abi](../../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/blog.ricmoo.com/human-readable-contract-abis-in-ethers-js-141902f4d917),
-which is a format the Ethers created to simplify manually typing the ABI
-into the source and so that a Contract ABI can also be referenced easily
-within the same source file.
-
-
-
-
-Properties
-----------
-
-
-
-#### *interface* . **fragments** **=>** *Array< [Fragment](../fragments) >*
-
-All the [Fragments](../fragments) in the interface.
-
-
-
-
-#### *interface* . **events** **=>** *Array< [EventFragment](../fragments) >*
-
-All the [Event Fragments](../fragments) in the interface.
-
-
-
-
-#### *interface* . **functions** **=>** *Array< [FunctionFragment](../fragments) >*
-
-All the [Function Fragments](../fragments) in the interface.
-
-
-
-
-#### *interface* . **deploy** **=>** *[ConstructorFragment](../fragments)*
-
-The [Constructor Fragments](../fragments) for the interface.
-
-
-
-
-Formatting
-----------
-
-
-
-#### *interface* . **format** (  [ format ]  )  **=>** *string|Array< string >*
-
-Return the formatted **Interface**. If the format type is `json` a
-single string is returned, otherwise an Array of the human-readable
-strings is returned.
-
-
-
-
-Fragment Access
----------------
-
-
-
-#### *interface* . **getFunction** ( fragment )  **=>** *[FunctionFragment](../fragments)*
-
-Returns the [FunctionFragment](../fragments) for *fragment* (see [Specifying Fragments](./)).
-
-
-
-
-#### *interface* . **getEvent** ( fragment )  **=>** *[EventFragment](../fragments)*
-
-Returns the [EventFragment](../fragments) for *fragment* (see [Specifying Fragments](./)).
-
-
-
-
-Signature and Topic Hashes
---------------------------
-
-
-
-#### *interface* . **getSighash** ( fragment )  **=>** *string< [DataHexstring](../../bytes)< 4 > >*
-
-Return the sighash (or Function Selector) for *fragment* (see [Specifying Fragments](./)).
-
-
-
-
-#### *interface* . **getEventTopic** ( fragment )  **=>** *string< [DataHexstring](../../bytes)< 32 > >*
-
-Return the topic hash for *fragment* (see [Specifying Fragments](./)).
-
-
-
-
-Encoding Data
--------------
-
-
-
-#### *interface* . **encodeDeploy** (  [ values ]  )  **=>** *string< [DataHexstring](../../bytes) >*
-
-Return the encoded deployment data, which can be concatenated to the
-deployment bytecode of a contract to pass *values* into the contract
-constructor.
-
-
-
-
-#### *interface* . **encodeFilterTopics** ( fragment [  , values ]  )  **=>** *Array< topic|Array< topic > >*
-
-Returns the encoded topic filter, which can be passed to getLogs for *fragment*
-(see [Specifying Fragments](./)) for the given *values*.
-
-Each *topic* is a 32 byte (64 nibble) [DataHexstring](../../bytes).
-
-
-
-
-#### *interface* . **encodeFunctionData** ( fragment [  , values ]  )  **=>** *string< [DataHexstring](../../bytes) >*
-
-Returns the encoded data, which can be used as the data for a transaction for
-*fragment* (see [Specifying Fragments](./)) for the given *values*.
-
-
-
-
-#### *interface* . **encodeFunctionResult** ( fragment [  , values ]  )  **=>** *string< [DataHexstring](../../bytes) >*
-
-Returns the encoded result, which would normally be the response from a call for
-*fragment* (see [Specifying Fragments](./)) for the given *values*.
-
-Most developers will not need this method, but may be useful for authors of a mock blockchain.
-
-
-
-
-Decoding Data
--------------
-
-
-
-#### *interface* . **decodeEventLog** ( fragment , data [  , topics ]  )  **=>** *[Result](./)*
-
-Returns the decoded event values from an event log for
-*fragment* (see [Specifying Fragments](./)) for the given *data*
-with the optional *topics*.
-
-If *topics* is not specified, placeholders will be inserted into the result.
-
-
-
-
-#### *interface* . **decodeFunctionData** ( fragment , data )  **=>** *[Result](./)*
-
-Returns the decoded values from transaction data for
-*fragment* (see [Specifying Fragments](./)) for the given *data*.
-
-Most developers will not need this method, but may be useful for debugging
-or inspecting transactions.
-
-
-
-
-#### *interface* . **decodeFunctionResult** ( fragment , data )  **=>** *[Result](./)*
-
-Returns the decoded values from the result of a call for
-*fragment* (see [Specifying Fragments](./)) for the given *data*.
-
-
-
-
-Parsing
--------
-
-
-The functions are generally the most useful for most developers. They will
-automatically search the ABI for a matching Event or Function and decode
-the components as a fully specified description.
-
-
-#### *interface* . **parseLog** ( log )  **=>** *[LogDescription](./)*
-
-Search the event that matches the *log* topic hash and parse the values
-the log represents.
-
-
-
-
-#### *interface* . **parseTransaction** ( transaction )  **=>** *[TransactionDescription](./)*
-
-Search for the function that matches the *transaction* data sighash
-and parse the transaction properties.
-
-
-
-
-Types
------
-
-
-
-### Result
-
-
-A **Result** is an array, so each value can be accessed as a positional
-argument.
-
-Additionally, if values are named, the identical object as its positional
-value can be accessed by its name.
-
-The name `length` is however reserved as it is part of the Array, so
-any named value for this key is renamed to `_length`. If there is a
-name collision, only the first is available by its key.
-
-
-### LogDescription
-
-
-
-#### *logDescription* . **args** **=>** *[Result](./)*
-
-The values of the input parameters of the event.
-
-
-
-
-#### *logDescription* . **eventFragment** **=>** *[EventFragment](../fragments)*
-
-The [EventFragment](../fragments) which matches the topic in the Log.
-
-
-
-
-#### *logDescription* . **name** **=>** *string*
-
-The event name. (e.g. `Transfer`)
-
-
-
-
-#### *logDescription* . **signature** **=>** *string*
-
-The event signature. (e.g. `Transfer(address,address,uint256)`)
-
-
-
-
-#### *logDescription* . **topic** **=>** *string*
-
-The topic hash.
-
-
-
-
-### TransactionDescription
-
-
-
-#### *transactionDescription* . **args** **=>** *[Result](./)*
-
-The decoded values from the transaction data which were passed
-as the input parameters.
-
-
-
-
-#### *transactionDescription* . **functionFragment** **=>** *[FunctionFragment](../fragments)*
-
-The [FunctionFragment](../fragments) which matches the sighash in the transaction data.
-
-
-
-
-#### *transactionDescription* . **name** **=>** *string*
-
-The name of the function. (e.g. `transfer`)
-
-
-
-
-#### *transactionDescription* . **sighash** **=>** *string*
-
-The sighash (or function selector) that matched the transaction data.
-
-
-
-
-#### *transactionDescription* . **signature** **=>** *string*
-
-The signature of the function. (e.g. `transfer(address,uint256)`)
-
-
-
-
-#### *transactionDescription* . **value** **=>** *[BigNumber](../../bignumber)*
-
-The value from the transaction.
-
-
-
-
-Specifying Fragments
---------------------
-
-
-When specifying a fragment to any of the functions in an **Interface**,
-any of the following may be used:
-
-
-
-* The name of the event or function, if it is unique and non-ambiguous within the ABI (e.g. `transfer`)
-* The signature of the event or function. The signature is normalized, so, for example, `uint` and `uint256` are equivalent (e.g. `transfer(address, uint)`)
-* The sighash or topichash of the function. The sighash is often referred to the function selector in Solidity (e.g. `0xa9059cbb`)
-* A [Fragment](../fragments)
-
-
-
------
-**Content Hash:** ed5159ed39b943e91bae3e17384c149e4b55f4d80650672a092c2781a3883934

docs/api/utils/address/README.md

@@ -1,105 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Addresses
-=========
-
-
-Explain addresses,formats and checksumming here.
-
-Also see: [constants.AddressZero](../constants)
-
-
-Address Formats
----------------
-
-
-
-### Address
-
-
-An **Address** is a [DataHexstring](../bytes) of 20 bytes (40 nibbles), with optional
-mixed case.
-
-If the case is mixed, it is a **Checksum Address**, which uses a specific pattern
-of uppercase and lowercase letters within a given address to reduce the risk
-of errors introduced from typing an address or cut and paste issues.
-
-All functions that return an Address will return a Checksum Address.
-
-
-### ICAP Address
-
-
-The **ICAP Address Format** was an early attempt to introduce a checksum
-into Ethereum addresses using the popular banking industry's
-[IBAN](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/International_Bank_Account_Number)
-format with the country code specified as **XE**.
-
-Due to the way IBAN encodes address, only addresses that fit into 30 base-36
-characters are actually compatible, so the format was adapted to support 31
-base-36 characters which is large enough for a full Ethereum address, however
-the preferred method was to select a private key whose address has a `0` as
-the first byte, which allows the address to be formatted as a fully compatibly
-standard IBAN address with 30 base-36 characters.
-
-In general this format is no longer widely supported anymore, however any function that
-accepts an address can receive an ICAP address, and it will be converted internally.
-
-To convert an address into the ICAP format, see [getIcapAddress](./).
-
-
-Functions
----------
-
-
-
-#### *ethers* . *utils* . **getAddress** ( address )  **=>** *string< [Address](./) >*
-
-Returns *address* as a Checksum Address.
-
-If *address* is an invalid 40-nibble [Hexstring](../bytes) or if it contains mixed case and
-the checksum is invalid, an InvalidArgument Error is throw.
-
-The value of *address* may be any supported address format.
-
-
-
-
-#### *ethers* . *utils* . **isAddress** ( address )  **=>** *boolean*
-
-Returns true if *address* is valid (in any supported format).
-
-
-
-
-#### *ethers* . *utils* . **getIcapAddress** ( address )  **=>** *string< [IcapAddress](./) >*
-
-Returns *address* as an [ICAP address](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/github.com/ethereum/wiki/wiki/Inter-exchange-Client-Address-Protocol-%28ICAP%29).
-Supports the same restrictions as [utils.getAddress](./).
-
-
-
-
-#### *ethers* . *utils* . **getContractAddress** ( transaction )  **=>** *string< [Address](./) >*
-
-Returns the contract address that would result if *transaction* was
-used to deploy a contract.
-
-
-
-
-#### *ethers* . *utils* . **getCreate2Address** ( from , salt , initCodeHash )  **=>** *string< [Address](./) >*
-
-Returns the contract address that would result from the given
-[CREATE2](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/eips.ethereum.org/EIPS/eip-1014) call.
-
-
-
-
-
------
-**Content Hash:** 94de1affabe23203e5796f6ad2bd7ccacfb9dd51e5ea7db004c10cd2aea8fded

docs/api/utils/bignumber/README.md

@@ -1,415 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-BigNumber
-=========
-
-
-Many operations in Ethereum operation on numbers which are
-[outside the range of safe values](./) to use
-in JavaScript.
-
-A **BigNumber** is an object which safely allows mathematic operations
-on numbers of any magnitude.
-
-Most operations which need to return a value will return a **BigNumber**
-and parameters which accept values will generally accept them.
-
-
-### Importing
-
-
-
-```
-/////
-// CommonJS:
-
-// From the Umbrella ethers package...
-const { BigNumber } = require("ethers");
-
-// From the bignumber pacakge...
-const { BigNumber } = require("@ethersproject/bignumber");
-
-
-/////
-// ES6 and TypeScript:
-
-// From the Umbrella ethers package...
-import { BigNumber } from "ethers";
-
-// From the bignumber pacakge...
-import { BigNumber } from "@ethersproject/bignumber";
-```
-
-
-
-Types
------
-
-
-
-### BigNumberish
-
-
-Many functions and methods in this library take in values which
-can be non-ambiguously and safely converted to a BigNumber. These
-values can be sepcified as:
-
-
-#### ***string***
-
-A [hexstring](../bytes) or a decimal string, either of which may
-be negative.
-
-
-
-
-#### ***BytesLike***
-
-A [BytesLike](../bytes) Object, such as an Array or Uint8Array.
-
-
-
-
-#### ***BigNumber***
-
-An existing [BigNumber](./) instance.
-
-
-
-
-#### ***number***
-
-A number that is within the [safe range](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER) for JavaScript numbers.
-
-
-
-
-#### ***BigInt***
-
-A JavaScript [BigInt](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt)
-object, on environments that support BigInt.
-
-
-
-
-Creating Instances
-------------------
-
-
-The constructor of BigNumber cannot be called directly. Instead, Use the static `BigNumber.from`.
-
-
-#### *ethers* . *BigNumber* . **from** ( aBigNumberish )  **=>** *[BigNumber](./)*
-
-Returns an instance of a **BigNumber** for *aBigNumberish*.
-
-
-
-
-### Examples:
-
-
-
-```javascript
-Skipping JavaScript Evaluation.
-```
-
-
-
-Methods
--------
-
-
-The BigNumber class is immutable, so no operations can change the value
-it represents.
-
-
-### Math Operations
-
-
-
-#### *bignumber* . **add** ( otherValue )  **=>** *[BigNumber](./)*
-
-Returns a BigNumber with the value of *bignumber* **+** *otherValue*.
-
-
-
-
-#### *bignumber* . **sub** ( otherValue )  **=>** *[BigNumber](./)*
-
-Returns a BigNumber with the value of *bignumber* **–** *otherValue*.
-
-
-
-
-#### *bignumber* . **mul** ( otherValue )  **=>** *[BigNumber](./)*
-
-Returns a BigNumber with the value of *bignumber* **×** *otherValue*.
-
-
-
-
-#### *bignumber* . **div** ( divisor )  **=>** *[BigNumber](./)*
-
-Returns a BigNumber with the value of *bignumber* **÷** *divisor*.
-
-
-
-
-#### *bignumber* . **mod** ( divisor )  **=>** *[BigNumber](./)*
-
-Returns a BigNumber with the value of the **remainder** of *bignumber* ÷ *divisor*.
-
-
-
-
-#### *bignumber* . **pow** ( exponent )  **=>** *[BigNumber](./)*
-
-Returns a BigNumber with the value of *bignumber* to the power of *exponent*.
-
-
-
-
-#### *bignumber* . **abs** (  )  **=>** *[BigNumber](./)*
-
-Returns a BigNumber with the absolute value of *bignumber*.
-
-
-
-
-#### *bignumber* . **maskn** ( bitcount )  **=>** *[BigNumber](./)*
-
-Returns a BigNumber with the value of *bignumber* with bits beyond
-the *bitcount* least significant bits set to zero.
-
-
-
-
-### Two's Compliment
-
-
-[Two's Complicment](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/Two%27s_complement)
-is an elegant method used to encode and decode fixed-width signed values
-while efficiently preserving mathematic operations.
-Most users will not need to interact with these.
-
-
-#### *bignumber* . **fromTwos** ( bitwidth )  **=>** *[BigNumber](./)*
-
-Returns a BigNumber with the value of *bignumber* converted from twos-compliment with *bitwidth*.
-
-
-
-
-#### *bignumber* . **toTwos** ( bitwidth )  **=>** *[BigNumber](./)*
-
-Returns a BigNumber with the value of *bignumber* converted to twos-compliment with *bitwidth*.
-
-
-
-
-### Comparison and Equivalence
-
-
-
-#### *bignumber* . **eq** ( otherValue )  **=>** *boolean*
-
-Returns true if and only if the value of *bignumber* is equal to *otherValue*.
-
-
-
-
-#### *bignumber* . **lt** ( otherValue )  **=>** *boolean*
-
-Returns true if and only if the value of *bignumber* **<** *otherValue*.
-
-
-
-
-#### *bignumber* . **lte** ( otherValue )  **=>** *boolean*
-
-Returns true if and only if the value of *bignumber* **&le;** *otherValue*.
-
-
-
-
-#### *bignumber* . **gt** ( otherValue )  **=>** *boolean*
-
-Returns true if and only if the value of *bignumber* **>** *otherValue*.
-
-
-
-
-#### *bignumber* . **gte** ( otherValue )  **=>** *boolean*
-
-Returns true if and only if the value of *bignumber* **&ge;** *otherValue*.
-
-
-
-
-#### *bignumber* . **isZero** (  )  **=>** *boolean*
-
-Returns true if and only if the value of *bignumber* is zero.
-
-
-
-
-### Conversion
-
-
-
-#### *bignumber* . **toNumber** (  )  **=>** *number*
-
-Returns the value of *bignumber* as a JavaScript value.
-
-This will **throw an error**
-if the value is greater than or equal to *Number.MAX_SAFE_INTEGER* or less than or
-equal to *Number.MIN_SAFE_INTEGER*.
-
-
-
-
-#### *bignumber* . **toString** (  )  **=>** *string*
-
-Returns the value of *bignumber* as a base-10 string.
-
-
-
-
-#### *bignumber* . **toHexString** (  )  **=>** *string< [DataHexstring](../bytes) >*
-
-Returns the value of *bignumber* as a base-16, `0x`-prefixed [DataHexstring](../bytes).
-
-
-
-
-### Inspection
-
-
-
-#### *ethers* . *BigNumnber* . **isBigNumber** ( object )  **=>** *boolean*
-
-Returns true if and only if the *object* is a BigNumber object.
-
-
-
-
-### Examples
-
-
-
-```javascript
-Skipping JavaScript Evaluation.
-```
-
-
-
-Notes
------
-
-
-This section is a for a couple of questions that come up frequently.
-
-
-### Why can't I just use numbers?
-
-
-The first problem many encounter when dealing with Ethereum is
-the concept of numbers. Most common currencies are broken down
-with very little granularity. For example, there are only 100
-cents in a single dollar. However, there are 10^18 **wei** in a
-single **ether**.
-
-JavaScript uses [IEEE 754 double-precision binary floating point](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/Double-precision_floating-point_format)
-numbers to represent numeric values. As a result, there are *holes*
-in the integer set after 9,007,199,254,740,991; which is
-problematic for *Ethereum* because that is only around 0.009
-ether (in wei), which means any value over that will begin to
-experience rounding errors.
-
-To demonstrate how this may be an issue in your code, consider:
-
-
-```javascript
-Skipping JavaScript Evaluation.
-```
-
-
-To remedy this, all numbers (which can be large) are stored
-and manipulated as [Big Numbers](./).
-
-The functions [parseEther( etherString )](http://linkto) and
-[formatEther( wei )](http://linkto) can be used to convert
-between string representations, which are displayed to or entered
-by the user and Big Number representations which can have
-mathematical operations handled safely.
-
-
-### Why not BigNumber.js, BN.js, BigDecimal, etc?
-
-
-Everyone has their own favourite Big Number library, and once someone
-has choosen one, it becomes part of their identity, like their editor,
-vi vs emacs. There are over 100 Big Number libraries on [npm](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/www.npmjs.com/search?q=bignumber).
-
-One of the biggest differences between the Ethers [BigNumber](./) object and
-other libraries is that it is immutable, which is very important when
-dealing with the asynchronous nature of the blockchain.
-
-Capturing the value is not safe in async functions, so immutability
-protects us from easy to make mistakes, which is not possible on the
-low-level library's objects which supports myriad in-place operations.
-
-Second, the Ethers [BigNumber](./) provides all the functionality required
-internally and should generally be sufficient for most developers while
-not exposing some of the more advanced and rare functionality. So it will
-be eaiser to swap out the underlying library without impacting consumers.
-
-For example, if [BN.js](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/www.npmjs.com/package/bn.js) was exposed, someone may use the
-greatest-common-denominator functions, which would then be functionality
-the replacing library should also provide to ensure anyone depending on
-that functionality is not broken.
-
-
-### Why BN.js??
-
-
-The reason why [BN.js](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/www.npmjs.com/package/bn.js) is used internally as the big
-number is because that is the library used by [elliptic](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/www.npmjs.com/package/elliptic).
-
-Therefore it **must** be included regardless, so we leverage that
-library rather than adding another Big Number library, which would
-mean two different libraries offering the same functionality.
-
-This has saved about 85kb (80% of this library size) of library size
-over other libraries which include separate Big Number libraries for
-various purposes.
-
-
-### Why not allow us to set a global Big Number library?
-
-
-Another comment that comes up frequently is tha desire to specify a
-global user-defined Big Number library, which all functions would
-return.
-
-This becomes problematic since your code may live along side other
-libraries or code that use Ethers. In fact, even Ethers uses a lot
-of the public functions internally.
-
-If you, for example, used a library that used `a.plus(b)` instead
-of `a.add(b)`, this would break Ethers when it tries to compute
-fees internally, and other libraries likely have similar logic.
-
-But, the [BigNumber](./) prototype is exposed, so you can always add a
-`toMyCustomBigNumber()` method to all [BigNumber](./)'s globally
-which is safe.
-
-
-
------
-**Content Hash:** 8f8f918b6d3350f7494845577cf2d350c6f0c556a963040cadbde6520395311d

docs/api/utils/bytes/README.md

@@ -1,263 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Byte Manipulation
-=================
-
-
-Tra la la...
-
-
-Types
------
-
-
-
-### Bytes
-
-
-A **Bytes** is any object which is an
-[Array](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) or [TypedArray](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) with
-each value in the valid byte range (i.e. between 0 and 255 inclusive),
-or is an Object with a `length` property where each indexed property
-is in the valid byte range.
-
-
-### BytesLike
-
-
-A **BytesLike** can be either a [Bytes](./) or a [DataHexstring](./).
-
-
-### DataHexstring
-
-
-A **DataHexstring** is identical to a [Hexstring](./) except that it has
-an even number of nibbles, and therefore is a valid representation of
-binary data as a string.
-
-
-### Hexstring
-
-
-A **Hexstring** is a string which has a `0x` prefix followed by any
-number of nibbles (i.e. case-insensitive hexidecumal characters, `0-9` and `a-f`).
-
-
-### Signature
-
-
-
-
-* **r** and **s** --- The x co-ordinate of **r** and the **s** value of the signature
-* **v** --- The parity of the y co-ordinate of **r**
-* **_vs** --- The [compact representation](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/eips.ethereum.org/EIPS/eip-2098) of the **s** and **v**
-* **recoveryParam** --- The normalized (i.e. 0 or 1) value of **v**
-
-
-### Flat-Format Signature
-
-
-A **Flat-Format Signature** is a common Signature format where
-the r, s and v are concanenated into a 65 byte (130 nibble)
-[DataHexstring](./).
-
-
-### SignatureLike
-
-
-A **SignatureLike** is similar to a [Signature](./), except redundant properties
-may be omitted or it may be a [Flat-Format Signature](./).
-
-For example, if **_vs** is specified, **s** and **v** may be omitted. Likewise,
-if **recoveryParam** is provided, **v** may be omitted (as in these cases the
-missing values can be computed).
-
-
-Inspection
-----------
-
-
-
-#### *ethers* . *utils* . **isBytes** ( object )  **=>** *boolean*
-
-Returns true if and only if *object* is a valid [Bytes](./).
-
-
-
-
-#### *ethers* . *utils* . **isBytesLike** ( object )  **=>** *boolean*
-
-Returns true if and only if *object* is a [Bytes](./) or [DataHexstring](./).
-
-
-
-
-#### *ethers* . *utils* . **isHexString** ( object ,  [ length ]  )  **=>** *boolean*
-
-Returns true if and only if *object* is a valid hex string.
-If *length* is specified and *object* is not a valid [DataHexstring](./) of
-*length* bytes, an InvalidArgument error is thrown.
-
-
-
-
-Converting between Arrays and Hexstrings
-----------------------------------------
-
-
-
-#### *ethers* . *utils* . **arrayify** ( datahexstringOrArrayish [  , options ]  )  **=>** *Uint8Array*
-
-Converts *datahexstringOrArrayish* to a Uint8Array.
-
-
-
-
-#### *ethers* . *utils* . **hexlify** ( hexstringOrArrayish )  **=>** *string< [DataHexstring](./) >*
-
-Converts *hexstringOrArrayish* to a [DataHexstring](./).
-
-
-
-
-#### *ethers* . *utils* . **hexValue** ( aBigNumberish )  **=>** *string< [Hexstring](./) >*
-
-Converts *aBigNumberish* to a [Hexstring](./), with no *unnecessary* leading
-zeros.
-
-
-
-
-### Examples
-
-
-
-```javascript
-Skipping JavaScript Evaluation.
-```
-
-
-
-Array Manipulation
-------------------
-
-
-
-#### *ethers* . *utils* . **concat** ( arrayOfBytesLike )  **=>** *Uint8Array*
-
-Concatenates all the [BytesLike](./) in *arrayOfBytesLike* into a single Uint8Array.
-
-
-
-
-#### *ethers* . *utils* . **stripZeros** ( aBytesLike )  **=>** *Uint8Array*
-
-Returns a Uint8Array with all leading `0` bytes of *aBtyesLike* removed.
-
-
-
-
-#### *ethers* . *utils* . **zeroPad** ( aBytesLike , length )  **=>** *Uint8Array*
-
-Retutns a Uint8Array of the data in *aBytesLike* with `0` bytes prepended to
-*length* bytes long.
-
-If *aBytesLike* is already longer than *length* bytes long, an InvalidArgument
-error will be thrown.
-
-
-
-
-Hexstring Manipulation
-----------------------
-
-
-
-#### *ethers* . *utils* . **hexConcat** ( arrayOfBytesLike )  **=>** *string< [DataHexstring](./) >*
-
-Concatenates all the [BytesLike](./) in *arrayOfBytesLike* into a single [DataHexstring](./)
-
-
-
-
-#### *ethers* . *utils* . **hexDataLength** ( aBytesLike )  **=>** *string< [DataHexstring](./) >*
-
-Returns the length (in bytes) of *aBytesLike*.
-
-
-
-
-#### *ethers* . *utils* . **hexDataSlice** ( aBytesLike , offset [  , endOffset ]  )  **=>** *string< [DataHexstring](./) >*
-
-Returns a [DataHexstring](./) representation of a slice of *aBytesLike*, from
-*offset* (in bytes) to *endOffset* (in bytes). If *endOffset* is
-omitted, the length of *aBytesLike* is used.
-
-
-
-
-#### *ethers* . *utils* . **hexStripZeros** ( aBytesLike )  **=>** *string< [Hexstring](./) >*
-
-Returns a [Hexstring](./) representation of *aBytesLike* with all
-leading zeros removed.
-
-
-
-
-#### *ethers* . *utils* . **hexZeroPad** ( aBytesLike , length )  **=>** *string< [DataHexstring](./) >*
-
-Returns a [DataHexstring](./) representation of *aBytesLike* padded to *length* bytes.
-
-If *aBytesLike* is already longer than *length* bytes long, an InvalidArgument
-error will be thrown.
-
-
-
-
-Signature Conversion
---------------------
-
-
-
-#### *ethers* . *utils* . **joinSignature** ( aSignatureLike )  **=>** *string< [FlatSignature](./) >*
-
-Return the flat-format of *aSignaturelike*, which is 65 bytes (130 nibbles)
-long, concatenating the **r**, **s** and (normalized) **v** of a Signature.
-
-
-
-
-#### *ethers* . *utils* . **splitSignature** ( aSignatureLikeOrBytesLike )  **=>** *[Signature](./)*
-
-Return the full expanded-format of *aSignaturelike* or a flat-format [DataHexstring](./).
-Any missing properties will be computed.
-
-
-
-
-Random Bytes
-------------
-
-
-
-#### *ethers* . *utils* . **randomBytes** ( length )  **=>** *Uint8Array*
-
-Return a new Uint8Array of *length* random bytes.
-
-
-
-
-#### *ethers* . *utils* . **shuffled** ( array )  **=>** *Array< any >*
-
-Return a copy of *array* shuffled using [Fisher-Yates Shuffle](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/Fisher-Yates_shuffle).
-
-
-
-
-
------
-**Content Hash:** 8736c2f7c64aa2a0ba9f987036158ef0cecc8110bbc30f88c7365f24809af3fc

docs/api/utils/constants/README.md

@@ -1,105 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Constants
-=========
-
-
-The **ethers.contants** Object contains commonly used values.
-
-
-### Importing
-
-
-
-```javascript
-Skipping JavaScript Evaluation.
-```
-
-
-
-Bytes
------
-
-
-
-#### *ethers* . *constants* . **AddressZero** **=>** *string< [Address](../address) >*
-
-The Address Zero, which is 20 bytes (40 nibbles) of zero.
-
-
-
-
-#### *ethers* . *constants* . **HashZero** **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-The Hash Zero, which is 32 bytes (64 nibbles) of zero.
-
-
-
-
-Strings
--------
-
-
-
-#### *ethers* . *constants* . **EtherSymbol** **=>** *string*
-
-The Ether symbol, **&Xi;**.
-
-
-
-
-BigNumber
----------
-
-
-
-#### *ethers* . *constants* . **NegativeOne** **=>** *[BigNumber](../bignumber)*
-
-The BigNumber value representing `"-1"`.
-
-
-
-
-#### *ethers* . *constants* . **Zero** **=>** *[BigNumber](../bignumber)*
-
-The BigNumber value representing `"0"`.
-
-
-
-
-#### *ethers* . *constants* . **One** **=>** *[BigNumber](../bignumber)*
-
-The BigNumber value representing `"1"`.
-
-
-
-
-#### *ethers* . *constants* . **Two** **=>** *[BigNumber](../bignumber)*
-
-The BigNumber value representing `"2"`.
-
-
-
-
-#### *ethers* . *constants* . **WeiPerEther** **=>** *[BigNumber](../bignumber)*
-
-The BigNumber value representing `"1000000000000000000"`, which is the
-number of Wei per Ether.
-
-
-
-
-#### *ethers* . *constants* . **MaxUint256** **=>** *[BigNumber](../bignumber)*
-
-The BigNumber value representing the maximum `uint256` value.
-
-
-
-
-
------
-**Content Hash:** 2c8c7edeece6a1d7d8c07e666c59ffeec57423a4b908bed03e62d47b6ae758fb

docs/api/utils/display-logic/README.md

@@ -1,112 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Display Logic and Input
-=======================
-
-
-When creating an Application, it is useful to convert between
-user-friendly strings (usually displaying **ether**) and the
-machine-readable values that contracts and maths depend on
-(usually in **wei**).
-
-For example, a Wallet may specify the balance in ether, and
-gas prices in gwei for the User Interface, but when sending
-a transaction, both must be specified in wei.
-
-The [parseUnits](./) will parse a string representing
-ether, such as `1.1` into a [BigNumber](../bignumber) in wei, and is
-useful when a user types in a value, such as sending 1.1 ether.
-
-The [formatUnits](./) will format a [BigNumberish](../bignumber)
-into a string, which is useful when displaying a balance.
-
-
-Units
------
-
-
-
-### Decimal Count
-
-
-The *unit* specified may be an integer, which indicates how
-many decimal place the unit has. For example, 1 ether has 18 decimal
-places for wei, and if this library were used with Bitcoin, 1 BTC
-has 8 decimal places for satoshis.
-
-
-### Named Units
-
-
-In addition to specifying *unit* as a number of decimals, there
-are several common units, which can be passed in as a string:
-
-
-
-* **wei** --- 0
-* **kwei** --- 3
-* **mwei** --- 6
-* **gwei** --- 9
-* **szabo** --- 12
-* **finney** --- 15
-* **ether** --- 18
-
-
-Functions
----------
-
-
-
-### Formatting
-
-
-
-#### *ethers* . *utils* . **commify** ( value )  **=>** *string*
-
-Returns a string with value grouped by 3 digits, separated by `,`.
-
-
-
-
-### Conversion
-
-
-
-#### *ethers* . *utils* . **formatUnits** ( value [  , unit="ether" ]  )  **=>** *string*
-
-Returns a string representation of *value* formatted with *unit*
-digits (if it is a number) or to the unit specified (if a string).
-
-
-
-
-#### *ethers* . *utils* . **formatEther** ( value )  **=>** *string*
-
-The equivalent to calling `formatUnits(value, "ether")`.
-
-
-
-
-#### *ethers* . *utils* . **parseUnits** ( value [  , unit="ether" ]  )  **=>** *[BigNumber](../bignumber)*
-
-Returns a [BigNumber](../bignumber) representation of *value*, parsed with
-*unit* digits (if it is a number) or from the unit specified (if
-a string).
-
-
-
-
-#### *ethers* . *utils* . **parseEther** ( value )  **=>** *[BigNumber](../bignumber)*
-
-The equivalent to calling `parseUnits(value, "ether")`.
-
-
-
-
-
------
-**Content Hash:** dc749d05e2f4c378032440c4cdc06b705479b15b2582dca2c838021861f86a03

docs/api/utils/encoding/README.md

@@ -1,102 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Encoding Utilities
-==================
-
-
-
-Base58
-------
-
-
-
-#### *ethers* . *utils* . *base58* . **decode** ( textData )  **=>** *Uin8Array*
-
-Return a typed Uint8Array representation of *textData* decoded using
-base-58 encoding.
-
-
-
-
-#### *ethers* . *utils* . *base58* . **encode** ( aBytesLike )  **=>** *string*
-
-Return *aBytesLike* encoded as a string using the base-58 encoding.
-
-
-
-
-Base64
-------
-
-
-
-#### *ethers* . *utils* . *base64* . **decode** ( textData )  **=>** *Uin8Array*
-
-Return a typed Uint8Array representation of *textData* decoded using
-base-64 encoding.
-
-
-
-
-#### *ethers* . *utils* . *base64* . **encode** ( aBytesLike )  **=>** *string*
-
-Return *aBytesLike* encoded as a string using the base-64 encoding.
-
-
-
-
-Recursive-Length Prefix
------------------------
-
-
-The [Recursive Length Prefix](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/github.com/ethereum/wiki/wiki/RLP) encoding is used throughout Ethereum to serialize nested
-structures of Arrays and data.
-
-
-#### *ethers* . *utils* . *RLP* . **encode** ( dataObject )  **=>** *string< [DataHexstring](../bytes) >*
-
-Encode a structured Data Object into its RLP-encoded representation.
-
-Each Data component may be an valid [BytesLike](../bytes).
-
-
-
-
-#### *ethers* . *utils* . *RLP* . **decode** ( aBytesLike )  **=>** *[DataObject](./)*
-
-Decode an RLP-encoded *aBytesLike* into its structured Data Object.
-
-All Data components will be returned as a [DataHexstring](../bytes).
-
-
-
-
-### Data Object
-
-
-A **Data Object** is a recursive structure which is used to serialize many
-internal structures in Ethereum. Each **Data Object** can either be:
-
-
-
-* Binary Data
-* An Array of **Data Objects** (i.e. this recursively includes Nesting)
-
-
-#### **Examples**
-
-
-
-* `"0x1234"`
-* `[ "0x1234", [ "0xdead", "0xbeef" ], [ ] ]`
-
-
-
-
-
------
-**Content Hash:** ebb4f7f25cb19e1ca1f2b2fa0a73140ec30365c55a2ff6b15c3637b5ef58ff06

docs/api/utils/fixednumber/README.md

@@ -1,242 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-FixedNumber
-===========
-
-
-A **FixedNumber** is a fixed-width (in bits) number with an internal
-base-10 divisor, which allows it to represent a decimal fractional
-component.
-
-
-Creating Instances
-------------------
-
-
-The FixedNumber constructor cannot be called directly. There are several
-static methods for creating a FixedNumber.
-
-
-#### *FixedNumber* . **from** ( value [  , format="fixed" ]  )  **=>** *[FixedNumber](./)*
-
-Returns an instance of a **FixedNumber** for *value* as a *format*.
-
-
-
-
-#### *FixedNumber* . **fromBytes** ( aBytesLike [  , format="fixed" ]  )  **=>** *[FixedNumber](./)*
-
-Returns an instance of a **FixedNumber** for *value* as a *format*.
-
-
-
-
-#### *FixedNumber* . **fromString** ( value [  , format="fixed" ]  )  **=>** *[FixedNumber](./)*
-
-Returns an instance of a **FixedNumber** for *value* as a *format*. The *value* must
-not contain more decimals than the *format* permits.
-
-
-
-
-#### *FixedNumber* . **fromValue** ( value [  , decimals=0 [  , format="fixed" ]  ]  )  **=>** *[FixedNumber](./)*
-
-Returns an instance of a **FixedNumber** for *value* with *decimals* as a *format*.
-
-
-
-
-Properties
-----------
-
-
-
-#### *fixednumber* . **format**
-
-The [FixedFormat](./) of *fixednumber*.
-
-
-
-
-Methods
--------
-
-
-
-### Math Operations
-
-
-
-#### *fixednumber* . **addUnsafe** ( otherValue )  **=>** *[FixedNumber](./)*
-
-Returns a new FixedNumber with the value of *fixedvalue* **+** *otherValue*.
-
-
-
-
-#### *fixednumber* . **subUnsafe** ( otherValue )  **=>** *[FixedNumber](./)*
-
-Returns a new FixedNumber with the value of *fixedvalue* **–** *otherValue*.
-
-
-
-
-#### *fixednumber* . **mulUnsafe** ( otherValue )  **=>** *[FixedNumber](./)*
-
-Returns a new FixedNumber with the value of *fixedvalue* **×** *otherValue*.
-
-
-
-
-#### *fixednumber* . **divUnsafe** ( otherValue )  **=>** *[FixedNumber](./)*
-
-Returns a new FixedNumber with the value of *fixedvalue* **÷** *otherValue*.
-
-
-
-
-#### *fixednumber* . **round** (  [ decimals=0 ]  )  **=>** *[FixedNumber](./)*
-
-Returns a new FixedNumber with the value of *fixedvalue* rounded to *decimals*.
-
-
-
-
-### Conversion
-
-
-
-#### *fixednumber* . **toFormat** ( format )  **=>** *[FixedNumber](./)*
-
-Returns a new FixedNumber with the value of *fixedvalue* with *format*.
-
-
-
-
-#### *fixednumber* . **toHexString** (  )  **=>** *string*
-
-Returns a [Hexstring](../bytes) representation of *fixednumber*.
-
-
-
-
-#### *fixednumber* . **toString** (  )  **=>** *string*
-
-Returns a string representation of *fixednumber*.
-
-
-
-
-#### *fixednumber* . **toUnsafeFloat** (  )  **=>** *float*
-
-Returns a floating-point JavaScript number value of *fixednumber*.
-Due to rounding in JavaScript numbers, the value is only approximate.
-
-
-
-
-### Inspection
-
-
-
-#### *FixedNumber* . **isFixedNumber** ( value )  **=>** *boolean*
-
-Returns true if and only if *value* is a **FixedNumber**.
-
-
-
-
-FixedFormat
------------
-
-
-A **FixedFormat** is a simple object which represents a decimal
-(base-10) Fixed-Point data representation. Usually using this
-class directly is uneccessary, as passing in a [Format Strings](./)
-directly into the [FixedNumber](./) will automatically create this.
-
-
-### Format Strings
-
-
-A format string is composed of three components, including signed-ness,
-bit-width and number of decimals.
-
-A signed format string begins with `fixed`, which an unsigned format
-string begins with `ufixed`, followed by the width (in bits) and the
-number of decimals.
-
-The width must be conguent to 0 mod 8 (i.e. `(width % 8) == 0`) and no
-larger than 256 bits and the number of decimals must be no larger than 80.
-
-For example:
-
-
-
-* **fixed128x18** is signed, 128 bits wide and has 18 decimals; this is useful for most purposes
-* **fixed32x0** is signed, 32 bits wide and has 0 decimals; this would be the same as a ``int32_t` in C
-* **ufixed32x0** is unsigned, 32 bits wide and has 0 decimals; this would be the same as a ``uint32_t` in C
-* **fixed** is shorthand for ``fixed128x18`
-* **ufixed** is shorthand for ``ufixed128x18`
-
-
-### Creating Instances
-
-
-
-#### *FixedFormat* . **from** ( value="fixed128x18" )  **=>** *[FixedFormat](./)*
-
-Returns a new instance of a **FixedFormat** defined by *value*. Any valid [Format Strings](./)
-may be passed in as well as any object which has any of `signed`, `width` and `decimals`
-defined, including a [FixedFormat](./) object.
-
-
-
-
-### Properties
-
-
-
-#### *fixedFormat* . **signed** **=>** *boolean*
-
-The signed-ness of *fixedFormat*, true if negative values are supported.
-
-
-
-
-#### *fixedFormat* . **width** **=>** *number*
-
-The width (in bits) of *fixedFormat*.
-
-
-
-
-#### *fixedFormat* . **decimals** **=>** *number*
-
-The number of decimal points of *fixedFormat*.
-
-
-
-
-#### *fixedFormat* . **name** **=>** *string*
-
-The name of the *fixedFormat*, which can be used to recreate the format
-and is the string that the Solidity language uses to represent this format.
-
-
-
-
-#### ***"fixed"***
-
-A shorthand for `fixed128x80`.
-
-
-
-
-
------
-**Content Hash:** 60fa7fc0a5e28ce6608684d52fe57c2758aa6c9482cd19f71cb5b91fd7d392b8

docs/api/utils/hashing/README.md

@@ -1,139 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Hashing Algorithms
-==================
-
-
-Explain what hash functions are?
-
-
-Cryptographic Hashing
----------------------
-
-
-The [Cryptographic Hash Functions](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/Cryptographic_hash_function)
-are a specific family of hash functions.
-
-
-#### *ethers* . *utils* . **keccak256** ( aBytesLike )  **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-Returns the [KECCAK256](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/SHA-3) digest *aBytesLike*.
-
-
-
-
-#### *ethers* . *utils* . **ripemd160** ( aBytesLike )  **=>** *string< [DataHexstring](../bytes)< 20 > >*
-
-Returns the [RIPEMD-160](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.m.wikipedia.org/wiki/RIPEMD) digest of *aBytesLike*.
-
-
-
-
-#### *ethers* . *utils* . **sha256** ( aBytesLike )  **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-Returns the [SHA2-256](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/SHA-2) digest of *aBytesLike*.
-
-
-
-
-#### *ethers* . *utils* . **sha512** ( aBytesLike )  **=>** *string< [DataHexstring](../bytes)< 64 > >*
-
-Returns the [SHA2-512](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/SHA-2) digest of *aBytesLike*.
-
-
-
-
-#### *ethers* . *utils* . **computeHmac** ( algorithm , key , data )  **=>** *string< [DataHexstring](../bytes) >*
-
-Returns the [HMAC](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/HMAC) of *data* with *key*
-using the [Algorithm](./) *algorithm*.
-
-
-
-
-### HMAC Supported Algorithms
-
-
-
-#### *ethers* . *utils* . *SupportedAlgorithm* . **sha256** **=>** *string*
-
-Use the [SHA2-256](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/SHA-2) hash algorithm.
-
-
-
-
-#### *ethers* . *utils* . *SupportedAlgorithm* . **sha512** **=>** *string*
-
-Use the [SHA2-512](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/SHA-2) hash algorithm.
-
-
-
-
-Common Hashing Helpers
-----------------------
-
-
-
-#### *ethers* . *utils* . **hashMessage** ( message )  **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-Computes the [EIP-191](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/eips.ethereum.org/EIPS/eip-191) personal message digest of *message*. Personal messages are
-converted to UTF-8 bytes and prefixed with `\x19Ethereum Signed Message:`
-and the length of *message*.
-
-
-
-
-#### *ethers* . *utils* . **id** ( text )  **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-The Ethereum Identity function computs the [KECCAK256](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/SHA-3) hash of the *text* bytes.
-
-
-
-
-#### *ethers* . *utils* . **namehash** ( name )  **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-Returns the [ENS Namehash](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/docs.ens.domains/contract-api-reference/name-processing) of *name*.
-
-
-
-
-Solidity Hashing Algorithms
----------------------------
-
-
-When using the Solidity `abi.packEncoded(...)` function, a non-standard
-*tightly packed* version of encoding is used. These functions implement
-the tightly packing algorithm.
-
-
-#### *ethers* . *utils* . **solidityPack** ( arrayOfTypes , arrayOfValues )  **=>** *string< [DataHexstring](../bytes) >*
-
-Returns the non-standard encoded *arrayOfValues* packed according to
-their respecive type in *arrayOfTypes*.
-
-
-
-
-#### *ethers* . *utils* . **solidityKeccak256** ( arrayOfTypes , arrayOfValues )  **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-Returns the [KECCAK256](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/SHA-3) of the non-standard encoded *arrayOfValues* packed
-according to their respective type in *arrayOfTypes*.
-
-
-
-
-#### *ethers* . *utils* . **soliditySha256** ( arrayOfTypes , arrayOfValues )  **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-Returns the [SHA2-256](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/SHA-2) of the non-standard encoded *arrayOfValues* packed
-according to their respective type in *arrayOfTypes*.
-
-
-
-
-
------
-**Content Hash:** 5c27393d66c46e7175edbe51257fb8cb69e8dc965d45ed7913b9599deec14e80

docs/api/utils/hdnode/README.md

@@ -1,243 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-HD Wallet
-=========
-
-
-TODO: Explain [BIP32](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) [BIP-39](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.bitcoin.it/wiki/BIP_0039) and whatnot here...
-
-
-Types
------
-
-
-
-### Constants
-
-
-
-#### *ethers* . *utils* . **defaultPath** **=>** *"m/44'/60'/0'/0/0"*
-
-The default path for Ethereum in an HD Wallet
-
-
-
-
-### Mnemonic
-
-
-
-#### *mnemonic* . **phrase** **=>** *string*
-
-The mnemonic phrase for this mnemonic. It is 12, 15, 18, 21 or 24 words long
-and separated by the whitespace specified by the `locale`.
-
-
-
-
-#### *mnemonic* . **path** **=>** *string*
-
-The HD path for this mnemonic.
-
-
-
-
-#### *mnemonic* . **locale** **=>** *string*
-
-The language of the wordlist this mnemonic is using.
-
-
-
-
-HDNode
-------
-
-
-
-### Creating Instances
-
-
-
-#### *ethers* . *HDNode* . **fromMnemonic** ( phrase [  , password [  , wordlist ]  ]  )  **=>** *[HDNode](./)*
-
-Return the [HDNode](./) for *phrase* with the optional *password*
-and *wordlist*.
-
-
-
-
-#### *ethers* . *HDNode* . **fromSeed** ( aBytesLike )  **=>** *[HDNode](./)*
-
-Return the [HDNode](./) for the seed *aBytesLike*.
-
-
-
-
-#### *ethers* . *HDNode* . **fromExtendedKey** ( extendedKey )  **=>** *[HDNode](./)*
-
-Return the [HDNode](./) for the *extendedKey*. If *extendedKey* was
-neutered, the **HDNode** will only be able to compute addresses and not
-private keys.
-
-
-
-
-### Properties
-
-
-
-#### *hdNode* . **privateKey** **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-The private key for this HDNode.
-
-
-
-
-#### *hdNode* . **publicKey** **=>** *string< [DataHexstring](../bytes)< 33 > >*
-
-The (compresses) public key for this HDNode.
-
-
-
-
-#### *hdNode* . **fingerprint** **=>** *string< [DataHexstring](../bytes)< 4 > >*
-
-The fingerprint is meant as an index to quickly match parent and
-children nodes together, however collisions may occur and software
-should verify matching nodes.
-
-Most developers will not need to use this.
-
-
-
-
-#### *hdNode* . **parentFingerprint** **=>** *string< [DataHexstring](../bytes)< 4 > >*
-
-The fingerprint of the parent node. See *fingerprint* for more
-details.
-
-Most developers will not need to use this.
-
-
-
-
-#### *hdNode* . **address** **=>** *string< [Address](../address) >*
-
-The address of this HDNode.
-
-
-
-
-#### *hdNode* . **mnemonic** **=>** *[Mnemonic](./)*
-
-The mnemonic of this HDNode, if known.
-
-
-
-
-#### *hdNode* . **path** **=>** *string*
-
-The path of this HDNode, if known. If the *mnemonic* is also known,
-this will match `mnemonic.path`.
-
-
-
-
-#### *hdNode* . **chainCode** **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-The chain code is used as a non-secret private key which is then used
-with EC-multiply to provide the ability to derive addresses without
-the private key of child non-hardened nodes.
-
-Most developers will not need to use this.
-
-
-
-
-#### *hdNode* . **index** **=>** *number*
-
-The index of this HDNode. This will match the last component of
-the *path*.
-
-Most developers will not need to use this.
-
-
-
-
-#### *hdNode* . **depth** **=>** *number*
-
-The depth of this HDNode. This will match the number of components
-(less one, the `m/`) of the *path*.
-
-Most developers will not need to use this.
-
-
-
-
-#### *hdNode* . **extendedKey** **=>** *string*
-
-A serialized string representation of this HDNode. Not all properties
-are included in the serialization, such as the mnemonic and path, so
-serializing and deserializing (using the `fromExtendedKey` class
-method) will result in reduced information.
-
-
-
-
-### Methods
-
-
-
-#### *hdNode* . **neuter** (  )  **=>** *[HDNode](./)*
-
-Return a new instance of *hdNode* with its private key removed
-but all otehr properties preserved. This ensures that the key
-can not leak the private key of itself or any derived children,
-but may still be used to compute the addresses of itself and
-any non-hardened children.
-
-
-
-
-#### *hdNode* . **derivePath** ( path )  **=>** *[HDNode](./)*
-
-Return a new [HDNode](./) which is the child of *hdNode* found
-by deriving *path*.
-
-
-
-
-Other Functions
----------------
-
-
-
-#### *ethers* . *utils* . **mnemonicToSeed** ( phrase [  , password ]  )  **=>** *string< [DataHexstring](../bytes)< 64 > >*
-
-Convert a mnemonic phrase to a seed, according to [BIP-39](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.bitcoin.it/wiki/BIP_0039).
-
-
-
-
-#### *ethers* . *utils* . **mnemonicToEntropy** ( phrase [  , wordlist ]  )  **=>** *string< [DataHexstring](../bytes) >*
-
-Convert a mnemonic phrase to its entropy, according to [BIP-39](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.bitcoin.it/wiki/BIP_0039).
-
-
-
-
-#### *ethers* . *utils* . **isValidMnemonic** ( phrase [  , wordlist ]  )  **=>** *boolean*
-
-Returns true if *phrase* is a valid mnemonic phrase, by
-testing the checksum.
-
-
-
-
-
------
-**Content Hash:** 042e28f2a611879151bc40783559c6310e23d466a310b508b22f264fa40d53e8

docs/api/utils/logger/README.md

@@ -1,383 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Logging
-=======
-
-
-These are just a few simple logging utilities provided to simplify
-and standardize the error facilities across the Ethers library.
-
-The [Logger](./) library has zero dependencies and is intentionally
-very light so it can be easily included in each library.
-
-The [Censorship](./) functionality relies on one instance
-of the Ethers library being included. In large bundled packages or when
-`npm link` is used, this may not be the case. If you require this
-functionality, ensure that your bundling is configured properly.
-
-
-Logger
-------
-
-
-
-#### **new** *ethers* . *utils* . **Logger** ( version ) 
-
-Create a new logger which will include *version* in all errors thrown.
-
-
-
-
-#### *Logger* . **globalLogger** (  )  **=>** *[Logger](./)*
-
-Returns the singleton global logger.
-
-
-
-
-### Logging Output
-
-
-
-#### *logger* . **debug** ( ...args )  **=>** *void*
-
-Log debugging information.
-
-
-
-
-#### *logger* . **info** ( ...args )  **=>** *void*
-
-Log generic information.
-
-
-
-
-#### *logger* . **warn** ( ...args )  **=>** *void*
-
-Log warnings.
-
-
-
-
-### Errors
-
-
-These functions honor the current [Censorship](./) and help create
-a standard error model for detecting and processing errors within Ethers.
-
-
-#### *logger* . **makeError** ( message [  , code=UNKNOWN_ERROR [  , params ]  ]  )  **=>** *Error*
-
-Create an Error object with *message* and an optional *code* and
-additional *params* set. This is useful when an error is needed to be
-rejected instead of thrown.
-
-
-
-
-#### *logger* . **throwError** ( message [  , code=UNKNOWN_ERROR [  , params ]  ]  )  **=>** *never*
-
-Throw an Error with *message* and an optional *code* and
-additional *params* set.
-
-
-
-
-#### *logger* . **throwArgumentError** ( message , name , value )  **=>** *never*
-
-Throw an [INVALID_ARGUMENT](./) Error with *name* and *value*.
-
-
-
-
-### Usage Validation
-
-
-There can be used to ensure various properties and actions are safe.
-
-
-#### *logger* . **checkAbstract** ( target , kind )  **=>** *void*
-
-Checks that *target* is not *kind* and performs the same operatons
-as `checkNew`. This is useful for ensuring abstract classes are not
-being instantiated.
-
-
-
-
-#### *logger* . **checkArgumentCount** ( count , expectedCound [  , message )  **=>** *void*
-
-If *count* is not equal to *expectedCount*, throws a [MISSING_ARGUMENT](./)
-or [UNEXPECTED_ARGUMENT](./) error.
-
-
-
-
-#### *logger* . **checkNew** ( target , kind )  **=>** *void*
-
-If *target* is not a valid `this` or `target` value, throw a
-[MISSING_NEW](./) error. This is useful to ensure
-callers of a Class are using `new`.
-
-
-
-
-#### *logger* . **checkNormalize** ( message )  **=>** *void*
-
-Check that the environment has a correctly functioning [String.normalize](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize). If not, a
-[UNSUPPORTED_OPERATION](./) error is thrown.
-
-
-
-
-#### *logger* . **checkSafeUint53** ( value [  , message ]  )  **=>** *void*
-
-If *value* is not safe as a [JavaScript number](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/Double-precision_floating-point_format), throws a
-[NUMERIC_FAULT](./) error.
-
-
-
-
-### Censorship
-
-
-
-#### *Logger* . **setCensorship** ( censor [  , permanent=false ]  )  **=>** *void*
-
-Set error censorship, optionally preventing errors from being uncensored.
-
-In production applications, this prevents any error from leaking information
-by masking the message and values of errors.
-
-This can impact debugging, making it substantially more difficult.
-
-
-
-
-#### *Logger* . **setLogLevel** ( logLevel )  **=>** *void*
-
-Set the log level, to suppress logging output below a [particular log level](./).
-
-
-
-
-Errors
-------
-
-
-Every error in Ethers has a `code` value, which is a string that will
-match one of the following error codes.
-
-
-### Generic Error Codes
-
-
-
-#### *Logger* . *errors* . **NOT_IMPLEMENTED**
-
-The operation is not implemented.
-
-
-
-
-#### *Logger* . *errors* . **SERVER_ERROR**
-
-There was an error communicating with a server.
-
-
-
-
-#### *Logger* . *errors* . **TIMEOUT**
-
-A timeout occurred.
-
-
-
-
-#### *Logger* . *errors* . **UNKNOWN_ERROR**
-
-A generic unknown error.
-
-
-
-
-#### *Logger* . *errors* . **UNSUPPORTED_OPERATION**
-
-The operation is not supported.
-
-
-
-
-### Safety Error Codes
-
-
-
-#### *Logger* . *errors* . **BUFFER_OVERRUN**
-
-The amount of data needed is more than the amount of data required,
-which would cause the data buffer to read past its end.
-
-
-
-
-#### *Logger* . *errors* . **NUMERIC_FAULT**
-
-There was an invalid operation done on numeric values.
-
-Common cases of this occur when there is [overflow](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/Integer_overflow),
-[arithmetic underflow](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/Arithmetic_underflow) in fixed numeric types or division by zero.
-
-
-
-
-### Usage Error Codes
-
-
-
-#### *Logger* . *errors* . **INVALID_ARGUMENT**
-
-The type or value of an argument is invalid. This will generally also
-include the `name` and `value` of the argument. Any function which
-accepts sensitive data (such as a private key) will include the string
-`[[REDACTED]]` instead of the value passed in.
-
-
-
-
-#### *Logger* . *errors* . **MISSING_ARGUMENT**
-
-An expected parameter was not specified.
-
-
-
-
-#### *Logger* . *errors* . **MISSING_NEW**
-
-An object is a Class, but is now being called with `new`.
-
-
-
-
-#### *Logger* . *errors* . **UNEXPECTED_ARGUMENT**
-
-Too many parameters we passed into a function.
-
-
-
-
-### Ethereum Error Codes
-
-
-
-#### *Logger* . *errors* . **CALL_EXCEPTION**
-
-An attempt to call a blockchain contract (getter) resulted in a
-revert or other error.
-
-
-
-
-#### *Logger* . *errors* . **INSUFFICIENT_FUNDS**
-
-The account is attempting to make a transaction which costs more than is
-available.
-
-A sending account must have enough ether to pay for the value, the gas limit
-(at the gas price) as well as the intrinsic cost of data. The intrinsic cost
-of data is 4 gas for each zero byte and 68 gas for each non-zero byte.
-
-
-
-
-#### *Logger* . *errors* . **NETWORK_ERROR**
-
-An Ethereum network validation error, such as an invalid chain ID.
-
-
-
-
-#### *Logger* . *errors* . **NONCE_EXPIRED**
-
-The nonce being specified has already been used in a mined transaction.
-
-
-
-
-#### *Logger* . *errors* . **REPLACEMENT_UNDERPRICED**
-
-When replacing a transaction, by using a nonce which has already been sent to
-the network, but which has not been mined yet the new transaction must specify
-a higher gas price.
-
-This error occurs when the gas price is insufficient to *bribe* the transaction
-pool to prefer the new transaction over the old one. Generally, the new gas price
-should be about 50% + 1 wei more, so if a gas price of 10 gwei was used, the
-replacement should be 15.000000001 gwei.
-
-
-
-
-#### *Logger* . *errors* . **UNPREDICTABLE_GAS_LIMIT**
-
-When estimating the required amount of gas for a transaction, a node is queried for
-its best guess.
-
-If a node is unable (or unwilling) to predict the cost, this error occurs.
-
-The best remedy for this situation is to specify a gas limit in the transaction
-manually.
-
-This error can also indicate that the transaction is expected to fail regardless,
-if for example an account with no tokens is attempting to send a token.
-
-
-
-
-Log Levels
-----------
-
-
-
-#### *Logger* . *levels* . **DEBUG**
-
-Log all output, including debugging information.
-
-
-
-
-#### *Logger* . *levels* . **INFO**
-
-Only log output for infomational, warnings and errors.
-
-
-
-
-#### *Logger* . *levels* . **WARNING**
-
-Only log output for warnings and errors.
-
-
-
-
-#### *Logger* . *levels* . **ERROR**
-
-Only log output for errors.
-
-
-
-
-#### *Logger* . *levels* . **OFF**
-
-Do not output any logs.
-
-
-
-
-
------
-**Content Hash:** 22f86858ee436554a50ae97e21e1866ac72fc3b0d0aec16ae331ab718c122c95

docs/api/utils/properties/README.md

@@ -1,56 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Property Utilities
-==================
-
-
-
-#### *ethers* . *utils* . **checkPropertoes** (  )  **=>** *void*
-
-
-
-
-
-
-#### *ethers* . *utils* . **deepCopy** ( anObject )  **=>** *any*
-
-
-
-
-
-
-#### *ethers* . *utils* . **defineReadOnly** ( anObject , name , value )  **=>** *void*
-
-
-
-
-
-
-#### *ethers* . *utils* . **getStatic** ( aConstructor , key )  **=>** *any*
-
-
-
-
-
-
-#### *ethers* . *utils* . **resolveProperties** ( anObject )  **=>** *Promise< any >*
-
-
-
-
-
-
-#### *ethers* . *utils* . **shallowCopy** ( anObject )  **=>** *any*
-
-
-
-
-
-
-
------
-**Content Hash:** 8e7a07176855d0fdb51c85a0d3ab0bdc2049989a4015d134914275ed11a57b65

docs/api/utils/signing-key/README.md

@@ -1,103 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Signing Key
-===========
-
-
-
-#### **new** *ethers* . *utils* . **SigningKey** ( privateKey ) 
-
-Create a new SigningKey for *privateKey*.
-
-
-
-
-#### *signingKey* . **privateKey** **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-The private key for this Signing Key.
-
-
-
-
-#### *signingKey* . **publicKey** **=>** *string< [DataHexstring](../bytes)< 65 > >*
-
-The uncompressed public key for this Signing Key. It will always be
-65 bytes (130 nibbles) and begine with `0x04`.
-
-
-
-
-#### *signingKey* . **compressedPublicKey** **=>** *string< [DataHexstring](../bytes)< 33 > >*
-
-The compressed public key for this Signing Key. It will always be
-33 bytes (66 nibbles) and begine with either `0x02` or `0x03`.
-
-
-
-
-#### *signingKey* . **signDisgest** ( digest )  **=>** *[Signature](../bytes)*
-
-Sign the *digest* and return the signature.
-
-
-
-
-#### *signingKey* . **computeSharedSecret** ( otherKey )  **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-Compute the ECDH shared secret with *otherKey*. The *otherKey* may be
-either a public key or a private key, but generally will be a public key from
-another party.
-
-It is best practice that each party computes the hash of this before using it
-as a symmetric key.
-
-
-
-
-#### *SigningKey* . **isSigningKey** ( anObject )  **=>** *boolean*
-
-Returns true if *anObject* is a SigningKey.
-
-
-
-
-Other Functions
----------------
-
-
-
-#### *ethers* . *utils* . **verifyMessage** ( message , signature )  **=>** *string< [Address](../address) >*
-
-Returns the address that signed *message* producing *signature*. The
-signature may have a non-canonical v (i.e. does not need to be 27 or 28),
-in which case it will be normalized to compute the `recoveryParam` which
-will then be used to compute the address; this allows systems which use
-the v to encode additional data (such as [EIP-155](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/eips.ethereum.org/EIPS/eip-155))
-to be used since the v parameter is still completely non-ambiguous.
-
-
-
-
-#### *ethers* . *utils* . **recocverPublicKey** ( digest , signature )  **=>** *string< [DataHexstring](../bytes)< 65 > >*
-
-
-
-
-
-
-#### *ethers* . *utils* . **computePublicKey** ( key [  , compressed=false ]  )  **=>** *string< [DataHexstring](../bytes) >*
-
-Computes the public key of *key*, optionally compressing it. The *key*
-can be any form of public key (compressed or uncompressed) or a private
-key.
-
-
-
-
-
------
-**Content Hash:** 285e65d57c4ba5901703c8a99e95632bd13aca7392d31734251d5d876e7df43e

docs/api/utils/strings/README.md

@@ -1,303 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Strings
-=======
-
-
-Tra la la
-
-
-Bytes32String
--------------
-
-
-A string in Solidity is length prefixed with its 256-bit (32 byte)
-length, which means that even short strings require 2 words (64 bytes)
-of storage.
-
-In many cases, we deal with short strings, so instead of prefixing
-the string with its length, we can null-terminate it and fit it in a
-single word (32 bytes). Since we need only a single byte for the
-null termination, we can store strings up to 31 bytes long in a
-word.
-
-
-#### Note
-
-Strings that are 31 **bytes** long may contain fewer than 31 **characters**,
-since UTF-8 requires multiple bytes to encode international characters.
-
-
-
-
-#### *ethers* . *utils* . **parseBytes32String** ( aBytesLike )  **=>** *string*
-
-Returns the decoded string represented by the `Bytes32` encoded data.
-
-
-
-
-#### *ethers* . *utils* . **formatBytes32String** ( text )  **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-Returns a `bytes32` string representation of *text*. If the
-length of *text* exceeds 31 bytes, it will throw an error.
-
-
-
-
-UTF-8 Strings
--------------
-
-
-
-#### *ethers* . *utils* . **toUtf8Bytes** ( text [  , form=current ]  )  **=>** *Uint8Array*
-
-Returns the UTF-8 bytes of *text*, optionally normalizing it using the
-[UnicodeNormalizationForm](./) *form*.
-
-
-
-
-#### *ethers* . *utils* . **toUtf8CodePoints** ( text [  , form=current ]  )  **=>** *Array< number >*
-
-Returns the Array of codepoints of *text*, optionally normalized using the
-[UnicodeNormalizationForm](./) *form*.
-
-
-
-
-#### Note
-
-This function correctly splits each **user-perceived character** into
-its codepoint, accounting for surrogate pairs. This should not be confused with
-`string.split("")`, which destroys surrogate pairs, spliting between each UTF-16
-codeunit instead.
-
-
-
-
-#### *ethers* . *utils* . **toUtf8String** ( aBytesLike [  , onError=error ]  )  **=>** *string*
-
-Returns the string represented by the UTF-8 bytes of *aBytesLike*.
-
-The *onError* is a [Custom UTF-8 Error function](./) and if not specified
-it defaults to the [error](./) function, which throws an error
-on **any** UTF-8 error.
-
-
-
-
-UnicodeNormalizationForm
-------------------------
-
-
-There are several [commonly used forms](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/Unicode_equivalence)
-when normalizing UTF-8 data, which allow strings to be compared or hashed in a stable
-way.
-
-
-#### *ethers* . *utils* . *UnicodeNormalizationForm* . **current**
-
-Maintain the current normalization form.
-
-
-
-
-#### *ethers* . *utils* . *UnicodeNormalizationForm* . **NFC**
-
-The Composed Normalization Form. This form uses single codepoints
-which represent the fully composed character.
-
-For example, the **&eacute;** is a single codepoint, `0x00e9`.
-
-
-
-
-#### *ethers* . *utils* . *UnicodeNormalizationForm* . **NFD**
-
-The Decomposed Normalization Form. This form uses multiple codepoints
-(when necessary) to compose a character.
-
-For example, the **&eacute;**
-is made up of two codepoints, `"0x0065"` (which is the letter `"e"`)
-and `"0x0301"` which is a special diacritic UTF-8 codepoint which
-indicates the previous character should have an acute accent.
-
-
-
-
-#### *ethers* . *utils* . *UnicodeNormalizationForm* . **NFKC**
-
-The Composed Normalization Form with Canonical Equivalence. The Canonical
-representation folds characters which have the same syntactic representation
-but different semantic meaning.
-
-For example, the Roman Numeral **I**, which has a UTF-8
-codepoint `"0x2160"`, is folded into the capital letter I, `"0x0049"`.
-
-
-
-
-#### *ethers* . *utils* . *UnicodeNormalizationForm* . **NFKD**
-
-The Decomposed Normalization Form with Canonical Equivalence.
-See NFKC for more an example.
-
-
-
-
-#### Note
-
-Only certain specified characters are folded in Canonical Equivalence, and thus
-it should **not** be considered a method to acheive *any* level of security from
-[homoglyph attacks](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/IDN_homograph_attack).
-
-
-
-
-Custom UTF-8 Error Handling
----------------------------
-
-
-When converting a string to its codepoints, there is the possibility
-of invalid byte sequences. Since certain situations may need specific
-ways to handle UTF-8 errors, a custom error handling function can be used,
-which has the signature:
-
-
-#### **errorFunction** ( reason , offset , bytes , output [  , badCodepoint ]  )  **=>** *number*
-
-The *reason* is one of the [UTF-8 Error Reasons](./), *offset* is the index
-into *bytes* where the error was first encountered, output is the list
-of codepoints already processed (and may be modified) and in certain Error
-Reasons, the *badCodepoint* indicates the currently computed codepoint,
-but which would be rejected because its value is invalid.
-
-This function should return the number of bytes to skip past keeping in
-mind the value at *offset* will already be consumed.
-
-
-
-
-### UTF-8 Error Reasons
-
-
-
-#### *ethers* . *utils* . *Utf8ErrorReason* . **BAD_PREFIX**
-
-A byte was encountered which is invalid to begin a UTF-8 byte
-sequence with.
-
-
-
-
-#### *ethers* . *utils* . *Utf8ErrorReason* . **MISSING_CONTINUE**
-
-A UTF-8 sequence was begun, but did not have enough continuation
-bytes for the sequence. For this error the *ofset* is the index
-at which a continuation byte was expected.
-
-
-
-
-#### *ethers* . *utils* . *Utf8ErrorReason* . **OUT_OF_RANGE**
-
-The computed codepoint is outside the range for valid UTF-8
-codepoints (i.e. the codepoint is greater than 0x10ffff).
-This reason will pass the computed *badCountpoint* into
-the custom error function.
-
-
-
-
-#### *ethers* . *utils* . *Utf8ErrorReason* . **OVERLONG**
-
-Due to the way UTF-8 allows variable length byte sequences
-to be used, it is possible to have multiple representations
-of the same character, which means
-[overlong sequences](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/UTF-8)
-allow for a non-distinguished string to be formed, which can
-impact security as multiple strings that are otherwise
-equal can have different hashes.
-
-Generally, overlong sequences are an attempt to circumvent
-some part of security, but in rare cases may be produced by
-lazy libraries or used to encode the null terminating
-character in a way that is safe to include in a `char*`.
-
-This reason will pass the computed *badCountpoint* into the
-custom error function, which is actually a valid codepoint, just
-one that was arrived at through unsafe methods.
-
-
-
-
-#### *ethers* . *utils* . *Utf8ErrorReason* . **OVERRUN**
-
-The string does not have enough characters remaining for the
-length of this sequence.
-
-
-
-
-#### *ethers* . *utils* . *Utf8ErrorReason* . **UNEXPECTED_CONTINUE**
-
-This error is similar to BAD_PREFIX, since a continuation byte
-cannot begin a valid sequence, but many may wish to process this
-differently. However, most developers would want to trap this
-and perform the same operation as a BAD_PREFIX.
-
-
-
-
-#### *ethers* . *utils* . *Utf8ErrorReason* . **UTF16_SURROGATE**
-
-The computed codepoint represents a value reserved for
-UTF-16 surrogate pairs.
-This reason will pass the computed surrogate half
-*badCountpoint* into the custom error function.
-
-
-
-
-### Provided UTF-8 Error Handling Functions
-
-
-There are already several functions available for the  most common
-situations.
-
-
-#### *ethers* . *utils* . *Utf8ErrorFuncs* . **error**
-
-The will throw an error on **any** error with a UTF-8 sequence, including
-invalid prefix bytes, overlong sequences, UTF-16 surrogate pairs.
-
-
-
-
-#### *ethers* . *utils* . *Utf8ErrorFuncs* . **ignore**
-
-This will drop all invalid sequences (by consuming invalid prefix bytes and
-any following continuation bytes) from the final string as well as permit
-overlong sequences to be converted to their equivalent string.
-
-
-
-
-#### *ethers* . *utils* . *Utf8ErrorFuncs* . **replace**
-
-This will replace all invalid sequences (by consuming invalid prefix bytes and
-any following continuation bytes) with the
-[UTF-8 Replacement Character](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/en.wikipedia.org/wiki/Specials_%28Unicode_block%29),
-(i.e. U+FFFD).
-
-
-
-
-
------
-**Content Hash:** 07249bd69db30a03c4095abd99904dd50f0d1b924138023085e78a43e0b5e4c4

docs/api/utils/transactions/README.md

@@ -1,241 +0,0 @@
------
-
-Documentation: [html](https://docs-beta.ethers.io/)
-
------
-
-Transactions
-============
-
-
-
-Types
------
-
-
-
-### UnsignedTransaction
-
-
-An unsigned transaction represents a transaction that has not been
-signed and its values are flexible as long as they are not ambiguous.
-
-
-#### *unsignedTransaction* . **to** **=>** *string< [Address](../address) >*
-
-The addres this transaction is to.
-
-
-
-
-#### *unsignedTransaction* . **nonce** **=>** *number*
-
-The nonce of this transaction.
-
-
-
-
-#### *unsignedTransaction* . **gasLimit** **=>** *[BigNumberish](../bignumber)*
-
-The gas limit for this transaction.
-
-
-
-
-#### *unsignedTransaction* . **gasPrice** **=>** *[BigNumberish](../bignumber)*
-
-The gas price for this transaction.
-
-
-
-
-#### *unsignedTransaction* . **data** **=>** *[BytesLike](../bytes)*
-
-The data for this transaction.
-
-
-
-
-#### *unsignedTransaction* . **value** **=>** *[BigNumberish](../bignumber)*
-
-The value (in wei) for this transaction.
-
-
-
-
-#### *unsignedTransaction* . **chainId** **=>** *number*
-
-The chain ID for this transaction. If the chain ID is 0 or null,
-then [EIP-155](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/eips.ethereum.org/EIPS/eip-155) is disabled and legacy signing is
-used, unless overridden in a signature.
-
-
-
-
-### Transaction
-
-
-A generic object to represent a transaction.
-
-
-#### *transaction* . **hash** **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-The transaction hash, which can be used as an identifier for
-*transaction*. This is the keccak256 of the serialized RLP encoded
-representation of *transaction*.
-
-
-
-
-#### *unsignedTransaction* . **to** **=>** *string< [Address](../address) >*
-
-The address *transaction* is to.
-
-
-
-
-#### *transaction* . **from** **=>** *string< [Address](../address) >*
-
-The address *transaction* is from.
-
-
-
-
-#### *transaction* . **nonce** **=>** *number*
-
-The nonce for *transaction*. Each transaction sent to the network
-from an account includes this, which ensures the order and
-non-replayability of a transaction. This must be equal to the current
-number of transactions ever sent to the network by the **from** address.
-
-
-
-
-#### *transaction* . **gasLimit** **=>** *[BigNumber](../bignumber)*
-
-The gas limit for *transaction*. An account must have enough ether to
-cover the gas (at the specified **gasPrice**). Any unused gas is
-refunded at the end of the transaction, and if there is insufficient gas
-to complete execution, the effects of the trasaction are reverted, but
-the gas is **fully consumed** and an out-of-gas error occurs.
-
-
-
-
-#### *transaction* . **gasPrice** **=>** *[BigNumber](../bignumber)*
-
-The price (in wei) per unit of gas for *transaction*.
-
-
-
-
-#### *transaction* . **data** **=>** *[BytesLike](../bytes)*
-
-The data for *transaction*. In a contract this is the call data.
-
-
-
-
-#### *transaction* . **value** **=>** *[BigNumber](../bignumber)*
-
-The value (in wei) for *transaction*.
-
-
-
-
-#### *transaction* . **chainId** **=>** *number*
-
-The chain ID for *transaction*. This is used as part of
-[EIP-155](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/eips.ethereum.org/EIPS/eip-155) to prevent replay attacks on different
-networks.
-
-For example, if a transaction was made on ropsten with an account
-also used on homestead, it would be possible for a transaction
-signed on ropsten to be executed on homestead, which is likely
-unintended.
-
-There are situations where replay may be desired, however these
-are very rare and it is almost always recommended to specify the
-chain ID.
-
-
-
-
-#### *transaction* . **r** **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-The r portion of the elliptic curve signatures for *transaction*.
-This is more accurately, the x coordinate of the point r (from
-which the y can be computed, along with v).
-
-
-
-
-#### *transaction* . **s** **=>** *string< [DataHexstring](../bytes)< 32 > >*
-
-The s portion of the elliptic curve signatures for *transaction*.
-
-
-
-
-#### *transaction* . **v** **=>** *number*
-
-The v portion of the elliptic curve signatures for *transaction*.
-This is used to refine which of the two possible points a given
-x-coordinate can have, and in [EIP-155](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/eips.ethereum.org/EIPS/eip-155) is additionally
-used to encode the chain ID into the serialized transaction.
-
-
-
-
-Functions
----------
-
-
-
-#### *ethers* . *utils* . **computeAddress** ( publicOrPrivateKey )  **=>** *string< [Address](../address) >*
-
-Compute the address of *publicOrPrivateKey*. If a public key is
-provided, it may be either compressed or uncompressed.
-
-
-
-
-#### *ethers* . *utils* . **parse** ( aBytesLike )  **=>** *[Transaction](./)*
-
-Parses the transaction properties from a serialized transactions.
-
-
-
-
-#### *ethers* . *utils* . **recoverAddress** ( digest , aSignatureLike )  **=>** *string< [Address](../address) >*
-
-Computes the address that signed *digest* to get *aSignatureLike* using the
-ecrecover algorithm.
-
-
-
-
-#### *ethers* . *utils* . **serialize** ( transaction [  , signature ]  )  **=>** *string< [DataHexstring](../bytes) >*
-
-Computes the serialized *transaction*, optionally serialized with
-the a *signature*. If *signature* is not present, the unsigned
-serialized transaction is returned, which can be used to compute the
-hash necessary to sign.
-
-This function uses [EIP-155](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/eips.ethereum.org/EIPS/eip-155) if a chainId is provided,
-otherwise legacy serialization is used. It is **highly** recommended
-to always specify a *chainId*.
-
-If *signature* includes a chain ID (explicitly or implicitly by using an
-[EIP-155](../../../Users/ricmoo/Development/ethers/ethers.js-v5/https:/eips.ethereum.org/EIPS/eip-155) `v` or `_vs`) it will be used to compute the
-chain ID.
-
-If there is a mismatch between the chain ID of *transaction* and *signature*
-an error is thrown.
-
-
-
-
-
------
-**Content Hash:** cda81a14250e9640ccedf9111dbb11772c4f513b10adac75aedf70271273a2c3