Updated dist files.

Create security policy.

.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,140 @@
+name: Node.js CI
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+
+  test-node:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      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 }}
+
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install node-hid requirements
+        run: sudo apt-get install libusb-1.0-0 libusb-1.0-0-dev libudev-dev
+
+      - name: Install dependencies (and link per package)
+        run: npm ci
+
+      - name: Build CommonJS and ESM (from TypeScript)
+        run: npm run build-all
+
+      - name: Run tests
+        run: npm run test-node
+
+
+  test-browser:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        module: [ 'esm', 'umd' ]
+
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install node-hid requirements
+        run: sudo apt-get install libusb-1.0-0 libusb-1.0-0-dev libudev-dev
+
+      - name: Install dependencies (and link per package)
+        run: npm ci
+
+      - name: Build CommonJS and ESM (from TypeScript)
+        run: npm run build-all
+
+      - name: Run tests
+        run: npm run test-browser-${{ matrix.module }}
+
+  test-react-native:
+
+    runs-on: macos-latest
+
+    # Temporary for testing CI
+    continue-on-error: true
+
+    strategy:
+      fail-fast: false
+
+    steps:
+      - name: Use Node.js 12.x
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install dependencies (and link per package)
+        run: npm ci
+
+      - name: Build CommonJS and ESM (from TypeScript)
+        run: npm run build-all
+
+      - name: Run tests
+        run: npm run test-react
+
+
+  coverage:
+
+    name: Coverage
+
+    runs-on: ubuntu-latest
+
+    continue-on-error: true
+
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install node-hid requirements
+        run: sudo apt-get install libusb-1.0-0 libusb-1.0-0-dev libudev-dev
+
+      - name: Install dependencies (and link per package)
+        run: npm ci
+
+      - name: Build CommonJS and ESM (from TypeScript)
+        run: npm run build-all
+
+      - name: Run tests
+        run: npm run test-coverage
+
+      - name: Upload coverage summary
+        uses: actions/upload-artifact@v2
+        with:
+          name: coverage-summary
+          path: ./output/summary.txt
+
+      - name: Tar files
+        run: tar -cvf ./output/coverage.tar ./output/lcov-report/
+
+      - name: Upload coverage
+        uses: actions/upload-artifact@v2
+        with:
+          name: coverage-complete
+          path: ./output/coverage.tar

.gitignore

@@ -1,4 +1,6 @@
 node_modules/
+packages/*/node_modules
+.package_node_modules/
 obsolete/
 .DS_Store
 .tmp/
@@ -18,3 +20,7 @@ lerna-debug.log
 packages/*/tsconfig.tsbuildinfo
 
 packages/testcases/input/nameprep/**
+
+.nyc_output/**
+
+output/**

CHANGELOG.md

@@ -1,496 +1,159 @@
 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-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)
------------------------------------------
-
-  - Add sub-error to gas estimate error for Ganache users. ([#829](https://github.com/ethers-io/ethers.js/issues/829); [647fbd8](https://github.com/ethers-io/ethers.js/commit/647fbd8cbfa0f94f72db6faadd528e61c49b1dd6))
-  - Moved ABI check for unique names to coding time and only if ambiguous. ([#816](https://github.com/ethers-io/ethers.js/issues/816); [fa87417](https://github.com/ethers-io/ethers.js/commit/fa87417e9416d99a37d9a2668a1e54feb7e342fc))
-  - Added missing Interface exports to umbrella utils. ([82a9326](https://github.com/ethers-io/ethers.js/commit/82a93263fae330ae39a7212e74d973fa9f820f64))
-  - Fixed FallbackProvider ESM super-this out-of-order issue. ([#822](https://github.com/ethers-io/ethers.js/issues/822); [fde102b](https://github.com/ethers-io/ethers.js/commit/fde102b7eda304403dcc677cd6d3b48339cd3a81))
-  - Fixed node hanging on unnecessary timeout when fetchJson fails. ([fdf2253](https://github.com/ethers-io/ethers.js/commit/fdf2253218cf379043acc32dea8c95c284a82cec))
-
-ethers/v5.0.0-beta.186 (2020-05-08 15:27)
------------------------------------------
-
-  - Fix JsonRpcProvider out-of-order super call. ([#822](https://github.com/ethers-io/ethers.js/issues/822); [963197d](https://github.com/ethers-io/ethers.js/commit/963197d70c96e5970b431173c2cc782cb496674c))
-
-ethers/v5.0.0-beta.185 (2020-05-04 22:54)
------------------------------------------
-
-  - More robust FallbackProvider on clean exits. ([8eeda23](https://github.com/ethers-io/ethers.js/commit/8eeda23e989fcb0126bd20b17c67f62466d19259))
-  - Safer test suite reporter timer. ([657a039](https://github.com/ethers-io/ethers.js/commit/657a0394f56b51a13c691477c2b0dcf74678fd7c))
-  - Added goerli to AlchemyProvider tests. ([ab7c781](https://github.com/ethers-io/ethers.js/commit/ab7c78118ab80990a3e3368749599a1cf6e9d4ae))
-  - Added more robust poll event to Provider. ([dc48bfb](https://github.com/ethers-io/ethers.js/commit/dc48bfb7adb9334848c93173ba2c634f22a9a72f))
-  - Added goerli to AlchemyProvider. ([86670eb](https://github.com/ethers-io/ethers.js/commit/86670eb80e96fc4ba4e3664c9389f8130bbfea73))
-  - Removed Cloudflare from test suite; it is down again. ([17dc022](https://github.com/ethers-io/ethers.js/commit/17dc022603afdfe4147638ab4b2704bcef09533f))
-  - Prevent forceOutput in test reporter from crashing. ([cafd344](https://github.com/ethers-io/ethers.js/commit/cafd34460b194d78092021f1d7e0307130340b68))
-  - Stall FallbackProvider backends from requests if not in-sync. ([fa6904f](https://github.com/ethers-io/ethers.js/commit/fa6904fef35e7ab888221f3a0613bfe7e6df3594))
-  - Allow providers to detect their network after instantiation. ([#814](https://github.com/ethers-io/ethers.js/issues/814); [99ae946](https://github.com/ethers-io/ethers.js/commit/99ae946476a317a9d89e5d8f57cf37f8680bfa2b))
-  - Better messaging on low-level network errors. ([#814](https://github.com/ethers-io/ethers.js/issues/814); [0e3a66c](https://github.com/ethers-io/ethers.js/commit/0e3a66c82959a08f3f4e4ffbca3ae3792ff2548f))
-  - Manage FallbackProvider stalling without unref. ([#815](https://github.com/ethers-io/ethers.js/issues/815); [7b1a7c7](https://github.com/ethers-io/ethers.js/commit/7b1a7c7f31a3631e12c2a341b562983360e670e9))
-  - Only error on duplicate signatures in Contract ABI. ([#499](https://github.com/ethers-io/ethers.js/issues/499); [098d7ef](https://github.com/ethers-io/ethers.js/commit/098d7efb21bd648c2660342297d2419904a10925))
-  - Added getWebSocketProvider static method to InfuraProvider. ([a6c1174](https://github.com/ethers-io/ethers.js/commit/a6c1174dffe6dca1a3a64d1d472cec6e12372117))
-  - Fix WebSocketProvider responses when message result is null. ([#813](https://github.com/ethers-io/ethers.js/issues/813); [472e5b0](https://github.com/ethers-io/ethers.js/commit/472e5b07eab180baa12185c8f00e5079ce4c671f))
-  - Allow modifiers on Human-Readable ABI for tuples and arrays. ([83fba3d](https://github.com/ethers-io/ethers.js/commit/83fba3de25b524cc48975b1952f4319d63874205))
-  - Added initial renew support to ENS CLI. ([54dfb75](https://github.com/ethers-io/ethers.js/commit/54dfb757c4c88e4bcada1890c4016fadfb25581a))
-  - Allow contract filters to include OR-ed values. ([#437](https://github.com/ethers-io/ethers.js/issues/437); [28800d7](https://github.com/ethers-io/ethers.js/commit/28800d7681f3bab08f6d30a22f0813e04feee18a))
-
-ethers/v5.0.0-beta.184 (2020-04-28 04:58)
------------------------------------------
-
-  - Removed old EIP-1193 experimental provider; it can now be supported by Web3Provider as EIP-1193 is now backwards compatible. ([84c68ac](https://github.com/ethers-io/ethers.js/commit/84c68ac5c17b10897ade966d6c8fac1f1f66a4af))
-  - Fixed getLogs filter deserialization. ([#805](https://github.com/ethers-io/ethers.js/issues/805); [393c0c7](https://github.com/ethers-io/ethers.js/commit/393c0c74a91175adca2e25026dcdb9e6445afd8f))
-  - Added EIP-1193 support to Web3Provider. ([56af441](https://github.com/ethers-io/ethers.js/commit/56af4413b1dd1787db68985e0b612b63d86fdf7c))
-  - Minor typing-detected fixes. ([d1f3a42](https://github.com/ethers-io/ethers.js/commit/d1f3a42c119d5588eab667ec7bb6e71042cfb656))
-  - Added initial support for recoverable coding erros. ([#800](https://github.com/ethers-io/ethers.js/issues/800); [bda6623](https://github.com/ethers-io/ethers.js/commit/bda66230916e58e25a522e8430ce4de25091eb6b))
-  - More draconian Typing. ([14e6811](https://github.com/ethers-io/ethers.js/commit/14e6811bf7d7c38a3b5714dededcc883c185d814))
-  - Omit HID libraries for hardware-wallets package on unsupported environments. ([#798](https://github.com/ethers-io/ethers.js/issues/798); [2e24920](https://github.com/ethers-io/ethers.js/commit/2e24920d028d42908d0764ad4ca0b56b55f852d1), [5aefb43](https://github.com/ethers-io/ethers.js/commit/5aefb4303d2fdda62e7e5ddb644919f613d6016a))
-  - Make default constructor non-payable. ([#684](https://github.com/ethers-io/ethers.js/issues/684); [017ea0d](https://github.com/ethers-io/ethers.js/commit/017ea0d6bd22833e9d399ae6b818443786f17884))
-
-ethers/v5.0.0-beta.183 (2020-04-23 23:28)
------------------------------------------
-
-  - Fixed inconsistent log format in WebSocketProvider. ([#795](https://github.com/ethers-io/ethers.js/issues/795); [8e7751f](https://github.com/ethers-io/ethers.js/commit/8e7751f7dfb41e58f81c7918cf36c152c3209ae2))
-  - Added WebSocketProvider support for ENS names in filters. ([6707754](https://github.com/ethers-io/ethers.js/commit/6707754580490c5a801d6205af0841794d20b3c9))
-  - Fixed provider filtering by ENS name. ([aeeb75f](https://github.com/ethers-io/ethers.js/commit/aeeb75f74c3be11b9b3b2925fd73349070542e54))
-  - Fixed ContractFactory.deploy ignoring overrides. ([#796](https://github.com/ethers-io/ethers.js/issues/796); [8bb2a0f](https://github.com/ethers-io/ethers.js/commit/8bb2a0fd08f6f128a80444e3fd90c29e4cd7edfb))
-  - Fix median calculation for large block number deltas across FallbackProvider backends. ([fca5ccb](https://github.com/ethers-io/ethers.js/commit/fca5ccbc2052569e700a96dbb1de1c9cef7c966f))
-  - Work-around for Cloudflare not offering eth_blockNumber. ([8cf4b3c](https://github.com/ethers-io/ethers.js/commit/8cf4b3cf4598f4f3643d5ebe9c366466d398cb83))
-  - Added string spell-checking to library and fixed discovered typos. ([71d03c6](https://github.com/ethers-io/ethers.js/commit/71d03c6e3cab1aacb3e4e74d3966fbaa7db2ee06))
-  - Fixed getUrl for node 8. ([560adea](https://github.com/ethers-io/ethers.js/commit/560adeabb06a2ab483bcad162f02ccef41ebc245))
-  - Dependency security updates. ([da3b0bf](https://github.com/ethers-io/ethers.js/commit/da3b0bf0786fe8a95c68485d130ca59c597ffe4d))
-  - Fixes for dist builds without injected XMLHttpRequest. ([#789](https://github.com/ethers-io/ethers.js/issues/789), [#506](https://github.com/ethers-io/ethers.js/issues/506); [9ae6b70](https://github.com/ethers-io/ethers.js/commit/9ae6b70efb9f3d3251820403597085cfa30ace05))
-
-ethers/v5.0.0-beta.182 (2020-04-16 21:53)
------------------------------------------
-
-  - Added support for Contract event parsing error recovery. ([cc72f76](https://github.com/ethers-io/ethers.js/commit/cc72f76695572d235d7f5a5ad4dc1838a5fe884a))
-  - Fix provider log filters with zero topics. ([#785](https://github.com/ethers-io/ethers.js/issues/785); [4ef0e4f](https://github.com/ethers-io/ethers.js/commit/4ef0e4f7653226bf8cca86e065ad614e7288af96))
-
-ethers/v5.0.0-beta.181 (2020-04-15 18:23)
------------------------------------------
-
-  - Temporarily remove CloudflareProvider tests; it is down and breaking the tests. ([797abb7](https://github.com/ethers-io/ethers.js/commit/797abb726711499d96bf1c12c61e3bb1a7b4925d))
-  - Better error reporting for Fragments. ([7dcefcb](https://github.com/ethers-io/ethers.js/commit/7dcefcbf71ef337103639bbe3f4ad2625565651a))
-  - Fixed Contract filter unsubscribing. ([2eb3823](https://github.com/ethers-io/ethers.js/commit/2eb3823de4ba111cc0c746a0715fe6dd3d1b16da), [39c78f3](https://github.com/ethers-io/ethers.js/commit/39c78f37ceff9b8ec08329903dcba7bd53bd8661))
-  - Fixed WebSocketProvider filter events. ([#784](https://github.com/ethers-io/ethers.js/issues/784); [69f7077](https://github.com/ethers-io/ethers.js/commit/69f707762ed5939c5f52bf6dce5c5513aaf6fa1d))
-  - Added bitwise operations to BigNumber. ([#781](https://github.com/ethers-io/ethers.js/issues/781); [7498c18](https://github.com/ethers-io/ethers.js/commit/7498c18235c7566b2f652cddba991f55e0943da8), [284771e](https://github.com/ethers-io/ethers.js/commit/284771ea39b6f4ee9cdf75ce5feea9e6aa9a65c5))
-
-ethers/v5.0.0-beta.180 (2020-04-03 22:10)
------------------------------------------
-
-  - Correctly return the Provider in NonceManager. ([6caf7c2](https://github.com/ethers-io/ethers.js/commit/6caf7c292cd5f03741cd6b30053c3325c4f30a81))
-  - Fail earlier when resolving an ENS name that is not a string. ([2882546](https://github.com/ethers-io/ethers.js/commit/28825463517f8821392464ec2283ee59c431d928))
-  - Fixed mutabilityState calculation for function fragments. ([#762](https://github.com/ethers-io/ethers.js/issues/762); [6526de0](https://github.com/ethers-io/ethers.js/commit/6526de016fda5403474dad61ee59acc62ee25ebc), [d7c8b35](https://github.com/ethers-io/ethers.js/commit/d7c8b355a049b36068b0525a357c6278639a8d58))
-  - Force Log properties to be non-optional. ([#415](https://github.com/ethers-io/ethers.js/issues/415); [da412f6](https://github.com/ethers-io/ethers.js/commit/da412f660723d1c411484e74970ce4eb166374c2), [8ad26f0](https://github.com/ethers-io/ethers.js/commit/8ad26f0ff42614a6c40e735cb6fffd36874da1a0))
-  - Fixed Signer call not forwarding blockTag. ([#768](https://github.com/ethers-io/ethers.js/issues/768); [053a2d7](https://github.com/ethers-io/ethers.js/commit/053a2d7fcdb4ca4c9bfd0bee0f42e0187d3db477))
-
-ethers/v5.0.0-beta.179 (2020-03-31 23:40)
------------------------------------------
-
-  - Fixed ENS CLI lookup for Website. ([0f144c6](https://github.com/ethers-io/ethers.js/commit/0f144c6cc03082026080782356b940af3389b34e))
-  - Fixed getEtherPrice for EtherscanProvider. ([#776](https://github.com/ethers-io/ethers.js/issues/776); [6c71b51](https://github.com/ethers-io/ethers.js/commit/6c71b515126d8ef3cea5a1aec814c4cab56cc1a5))
-  - Fixed ENS CLI tool set-websites and added set-name. ([70cffb6](https://github.com/ethers-io/ethers.js/commit/70cffb6a5166a79a54e02b03b6a7ec0085407e07))
-
-ethers/v5.0.0-beta.178 (2020-03-30 22:14)
------------------------------------------
-
-  - Fixed Event args keyword access. ([2692e78](https://github.com/ethers-io/ethers.js/commit/2692e783b40ce16207fa1a8e8513ebb5455fd2d0), [092ce9b](https://github.com/ethers-io/ethers.js/commit/092ce9bcc2abf92c40550c4a990a8e2c889cc250))
-  - Updating TypeScript library and fixing some audit issues. ([bd32ee0](https://github.com/ethers-io/ethers.js/commit/bd32ee0af5b25a435e5896773d8bfd482d3adcaf))
-
-ethers/v5.0.0-beta.177 (2020-03-21 12:46)
------------------------------------------
-
-  - Abstracted JSON-RPC parameter generation for others to use. ([030f65e](https://github.com/ethers-io/ethers.js/commit/030f65e66ce059d69d8d77973d5c3190745eaac2))
-  - Updated RLP package to use Logger instead of bare errors. ([390497f](https://github.com/ethers-io/ethers.js/commit/390497f38964a052837f6c0e7c96efe74c668517))
-  - Fixed log level filtering for Logger. ([#379](https://github.com/ethers-io/ethers.js/issues/379); [72c8992](https://github.com/ethers-io/ethers.js/commit/72c89922a4e1b77295414c8e0717a7373f2397b8))
-  - Throw errors when trying to RLP encode integers. ([9ea16e5](https://github.com/ethers-io/ethers.js/commit/9ea16e5172928962792ba4c0273e23db373409e0))
-  - Added delays to provider tests to prevent throttling causing failed tests. ([3e44aac](https://github.com/ethers-io/ethers.js/commit/3e44aac8f199ec09babb20c4af2ee668e0ab05a1))
-
-ethers/v5.0.0-beta.176 (2020-03-12 19:10)
------------------------------------------
-
-  - Checking in initial Eip1193Bridge (experimental). ([2c78f0b](https://github.com/ethers-io/ethers.js/commit/2c78f0bf265a0f7c9f4cfc1bc79ecd4629b59c49))
-  - Added initial WebSocketProvider. ([#141](https://github.com/ethers-io/ethers.js/issues/141); [117a5dd](https://github.com/ethers-io/ethers.js/commit/117a5dd7ffa783c4335c0b87621437447cd499d0))
-  - Renamed properties based on community recommendations; estimate to estimateGas and addressPromise to resovledAddress. ([fe3b3fa](https://github.com/ethers-io/ethers.js/commit/fe3b3fa1aded67827fec1131931d95d8153d8f32))
-  - Better error reporting and fixed look-ahead for data labels. ([e52312e](https://github.com/ethers-io/ethers.js/commit/e52312e783b8d0fdd7e9992716cbe2e179751b38))
-
-ethers/v5.0.0-beta.175 (2020-02-27 19:53)
------------------------------------------
-
-  - Fix address-less filter listening in Provider. ([#741](https://github.com/ethers-io/ethers.js/issues/741); [64dccb2](https://github.com/ethers-io/ethers.js/commit/64dccb275c68ebb40328350d4ab5be0f29b8a02e))
-  - Added sync version of wallet decryption. ([0ad94cd](https://github.com/ethers-io/ethers.js/commit/0ad94cdf8137259bedb38c0dc949b61570bcdac0), [6809c37](https://github.com/ethers-io/ethers.js/commit/6809c370c027aea148466c00d3ce09c6d0ee6ddc))
-
-ethers/v5.0.0-beta.175 (2020-02-27 19:38)
------------------------------------------
-
-  - Fix address-less filter listening in Provider. ([#741](https://github.com/ethers-io/ethers.js/issues/741); [64dccb2](https://github.com/ethers-io/ethers.js/commit/64dccb275c68ebb40328350d4ab5be0f29b8a02e))
-  - Added sync version of wallet decryption. ([0ad94cd](https://github.com/ethers-io/ethers.js/commit/0ad94cdf8137259bedb38c0dc949b61570bcdac0))
-
-ethers/v5.0.0-beta.174 (2020-02-25 14:57)
------------------------------------------
-
-  - Reduced default Provider quorum for testnets. ([1cfab31](https://github.com/ethers-io/ethers.js/commit/1cfab3173c3d0519beffc054efe73f70b7d28501))
-  - Added JSON-RPC debugging on error responses. ([ad27600](https://github.com/ethers-io/ethers.js/commit/ad27600c699827858e7343adff2d4fa622248e42))
-  - Fixed setLogLevel to affect global logging. ([ac51a88](https://github.com/ethers-io/ethers.js/commit/ac51a88c2913d7055e050c91d7d96bb42abf6656))
-  - Renamed interface getTopic to getEventTopic. ([f61f34b](https://github.com/ethers-io/ethers.js/commit/f61f34bfb295bafee3b7ee426efa696aaa9bbafe))
-  - Fix log parsing when no matching topic hash is found. ([#733](https://github.com/ethers-io/ethers.js/issues/733); [a5d2ec5](https://github.com/ethers-io/ethers.js/commit/a5d2ec534f75b21eebe69a789a3c43c33014a825), [4b8e198](https://github.com/ethers-io/ethers.js/commit/4b8e198bf209fcf0aea55018d8940355ea4345de), [89ac9f4](https://github.com/ethers-io/ethers.js/commit/89ac9f4f298ac340c4429e8ebdacd29962eba7f4))
-
-ethers/v5.0.0-beta.173 (2020-02-12 17:09)
------------------------------------------
-
-  - Added experimental EipWrappedProvider. ([944600d](https://github.com/ethers-io/ethers.js/commit/944600d779564c500ab98d3265286a0717642614))
-  - Updated signature for JsonRpcProvider.send to match EIP-1193. ([b962b59](https://github.com/ethers-io/ethers.js/commit/b962b59ab72e67bc4566a361964e42cf1b791025))
-  - Added binary literal support to ASM grammar. ([375bd15](https://github.com/ethers-io/ethers.js/commit/375bd15594a3179432e8452d819d91ea72b4bdd8))
-  - Added explicit pop placeholders to ASM dialect. ([a6b696d](https://github.com/ethers-io/ethers.js/commit/a6b696d8bd03c4027b52fe23745f066d158f1420))
-  - Added position independent code option for asm. ([89615c5](https://github.com/ethers-io/ethers.js/commit/89615c59d385a58fa79b6bbd8eae53c30e45fe96))
-  - Added ASM semantic checking and the Pop placeholder. ([a33bf0e](https://github.com/ethers-io/ethers.js/commit/a33bf0e37f4f969cc03b85ebf0dbadcf3e9b068a))
-  - Better type safety for defineReadOnly. ([e7adc84](https://github.com/ethers-io/ethers.js/commit/e7adc84a972968f39a983efb6f21b6ceaacd6cc5))
-  - Fixed CLI sandbox quiting after prompt entry. ([ff9bc2a](https://github.com/ethers-io/ethers.js/commit/ff9bc2a282e617125bbca76702dec85149661390))
-
-ethers/v5.0.0-beta.172 (2020-02-04 00:59)
------------------------------------------
-
-  - Synced GitHub issue cache. ([13dbf1f](https://github.com/ethers-io/ethers.js/commit/13dbf1f965eab344d2a304f7612d19ea96391261))
-  - Better typing for Timers. ([5622f70](https://github.com/ethers-io/ethers.js/commit/5622f703d962993442623ef1450a595825c4efa8))
-  - Safer transaction serialization, matching signature.v with chainId. ([#708](https://github.com/ethers-io/ethers.js/issues/708); [edb7c5d](https://github.com/ethers-io/ethers.js/commit/edb7c5da91ce271688561364d867998b0f0675e3))
-  - Fixed Opcode typo and added check to prevent future typos. ([15bb840](https://github.com/ethers-io/ethers.js/commit/15bb8409077f96b22e8bd60c426cddd015454e6b))
-  - Renamed AST nodes for teh assembler. ([f02c7db](https://github.com/ethers-io/ethers.js/commit/f02c7db4109d1785b4528757aa50f24948e896ae))
-  - Added timeout to waitForTransaction. ([#477](https://github.com/ethers-io/ethers.js/issues/477); [bacc440](https://github.com/ethers-io/ethers.js/commit/bacc4403979fa423890e269e7a5c7d11c6891a9f))
-  - Added CLI for asm package. ([aafa42a](https://github.com/ethers-io/ethers.js/commit/aafa42a32b2a5c7481a409ad048dfc06112c6599))
-  - Prevent Signer.checkTransaction from creating conflicting from properties. ([1decb13](https://github.com/ethers-io/ethers.js/commit/1decb1379902b60a15925b9b1de39633393db825))
-  - Include asm in generated TypeScript dependencies. ([ba29618](https://github.com/ethers-io/ethers.js/commit/ba296188960fb345dfdab12f2bb3ed3dc5eab51a))
-  - Clean up some asm checks and dead code. ([fa317eb](https://github.com/ethers-io/ethers.js/commit/fa317ebc032f8a5f9fb2dd10e23496252ae744e1))
-  - More contained Opcode API. ([da8153c](https://github.com/ethers-io/ethers.js/commit/da8153c87753b79e5e4cd34d484b8e0e717426d9))
-  - Added initial codedrop for the asm package. ([0296594](https://github.com/ethers-io/ethers.js/commit/0296594aba8d1e90e9ef7a18d2324f6cac815953))
-
-ethers/v5.0.0-beta.171 (2020-02-01 05:05)
------------------------------------------
-
-  - Added CLI for asm package. ([aafa42a](https://github.com/ethers-io/ethers.js/commit/aafa42a32b2a5c7481a409ad048dfc06112c6599))
-  - Added more flatworm documentation. ([1c85fe9](https://github.com/ethers-io/ethers.js/commit/1c85fe95b2b536828e83087676becba85c9a90bb))
-  - Prevent Signer.checkTransaction from creating conflicting from properties. ([1decb13](https://github.com/ethers-io/ethers.js/commit/1decb1379902b60a15925b9b1de39633393db825))
-  - Include asm in generated TypeScript dependencies. ([ba29618](https://github.com/ethers-io/ethers.js/commit/ba296188960fb345dfdab12f2bb3ed3dc5eab51a))
-  - Clean up some asm checks and dead code. ([fa317eb](https://github.com/ethers-io/ethers.js/commit/fa317ebc032f8a5f9fb2dd10e23496252ae744e1))
-  - More contained Opcode API. ([da8153c](https://github.com/ethers-io/ethers.js/commit/da8153c87753b79e5e4cd34d484b8e0e717426d9))
-  - Added initial codedrop for the asm package. ([0296594](https://github.com/ethers-io/ethers.js/commit/0296594aba8d1e90e9ef7a18d2324f6cac815953))
-
-ethers/v5.0.0-beta.171 (2020-01-29 21:41)
------------------------------------------
-
-  - Better solc support in CLI; it will search the local pacakge for an existing solc version. ([7428776](https://github.com/ethers-io/ethers.js/commit/7428776f75222d5c07282bc29c3dd8ed99f5d2cc))
-  - Update ENS registry address and lower default quorum for testnets. ([edb49da](https://github.com/ethers-io/ethers.js/commit/edb49da15518f25b3d60813ebb84f54171e308f3))
-  - Exposed isBytes and isBytesLike in ethers.utils. ([99329b0](https://github.com/ethers-io/ethers.js/commit/99329b013ce7f3af301d40c41f7eb35bff288910))
-
-ethers/v5.0.0-beta.170 (2020-01-21 20:37)
------------------------------------------
-
-  - Better, easier and more provider testing. ([e0d1d38](https://github.com/ethers-io/ethers.js/commit/e0d1d3866d2559f39627254873a0a1d4c0fcaf3d))
-  - Fixed out-of-bounds difficulty in getBlock, which can affect PoA networks. ([#711](https://github.com/ethers-io/ethers.js/issues/711); [251882c](https://github.com/ethers-io/ethers.js/commit/251882ced4379931ec82ba28a4db10bc7dbf3580))
-
-ethers/v5.0.0-beta.169 (2020-01-20 19:42)
------------------------------------------
-
-  - Fixed imports after refactor. ([adf5622](https://github.com/ethers-io/ethers.js/commit/adf56229c6cc83003d319ea9a004677e2555d478))
-  - Refactor some enum names and add UTF-8 error support to the umbrella package. ([931da2f](https://github.com/ethers-io/ethers.js/commit/931da2f77446fc9266cf07f0d7d78d4376625005))
-  - Allow arbitrary apiKey for UrlJsonRpcProvider. ([5878b54](https://github.com/ethers-io/ethers.js/commit/5878b54d6eded1329a6dc3b4023f876a87f72b6e))
-  - Added more general error handling (e.g. error, ignore, replace) for calling toUtf8String. ([a055edb](https://github.com/ethers-io/ethers.js/commit/a055edb5855b96fdf179403458c1694b96fd906c))
-
-ethers/v5.0.0-beta.168 (2020-01-18 21:46)
------------------------------------------
-
-  - Much more resiliant FallbackProvider which can ignore properties that are only approximate and supports per-provider priorities. ([#635](https://github.com/ethers-io/ethers.js/issues/635), [#588](https://github.com/ethers-io/ethers.js/issues/588); [f4bcf24](https://github.com/ethers-io/ethers.js/commit/f4bcf24a257a17ec9beb98f3d0b3682de543534c))
-  - Fixed some typing for receipts and logs. ([#497](https://github.com/ethers-io/ethers.js/issues/497); [ea102ef](https://github.com/ethers-io/ethers.js/commit/ea102ef7c4fa5df7b9389fbc8a2947bbbd4c471e))
-  - Abstracting mnemonic phrases. ([#685](https://github.com/ethers-io/ethers.js/issues/685); [92a383f](https://github.com/ethers-io/ethers.js/commit/92a383ff0dad4587e44953efca3c6ab795a1b1bd))
-  - Sync GitHub issues. ([75e1a37](https://github.com/ethers-io/ethers.js/commit/75e1a37bb5935d5d538ffcfce5b0073e1334d457))
-  - Fixed 304 status for fetchJson. ([c66d81e](https://github.com/ethers-io/ethers.js/commit/c66d81e96f7c9b0808f181085ffe1c92f6219d46))
-
-ethers/v5.0.0-beta.167 (2020-01-11 04:16)
------------------------------------------
-
-  - Fixed testcases for provider changes. ([90ed07c](https://github.com/ethers-io/ethers.js/commit/90ed07c74e7230ea0f02288b140d497d8b9779e0))
-  - Add support for legacy flat signatures with recid instead of normalized v. ([245cd0e](https://github.com/ethers-io/ethers.js/commit/245cd0e48e07eef35f5bf45ee7fe5ed5ef31338a))
-  - Fix TransactionResponse to have chainId instead of legacy networkId. ([#700](https://github.com/ethers-io/ethers.js/issues/700); [72b3bc9](https://github.com/ethers-io/ethers.js/commit/72b3bc9909074893038c768f3da1564ed96a6a20))
-  - Fixed splitSignature computing wrong v for BytesLike. ([#700](https://github.com/ethers-io/ethers.js/issues/700); [4151c0e](https://github.com/ethers-io/ethers.js/commit/4151c0eacd22287e2369a8656ffa00359db6f84b))
-  - Added dist files for hardware-wallets. ([c846649](https://github.com/ethers-io/ethers.js/commit/c84664953d2f50ee0d704a8aa18fe6c08668dabb))
-  - Browser support (with dist files) for Ledger. ([6f7fbf3](https://github.com/ethers-io/ethers.js/commit/6f7fbf3858c82417933a5e5595a919c0ec0487c7))
-
-ethers/v5.0.0-beta.166 (2020-01-10 03:09)
------------------------------------------
-
-  - Relaxed joinSignature API to allow SignauteLike. ([602e6a8](https://github.com/ethers-io/ethers.js/commit/602e6a8973480299843a0158f75451a2c6aac749))
-  - Initial code drop of new hardware wallet package. ([2e8f5ca](https://github.com/ethers-io/ethers.js/commit/2e8f5ca7ed498261079da75713b18f3370dfd236))
-  - Added more docs. ([381a72d](https://github.com/ethers-io/ethers.js/commit/381a72ddaa7fb59ef2ded84d228296d693df05c3))
-
-ethers/v5.0.0-beta.165 (2020-01-09 03:31)
------------------------------------------
-
-  - Fixed require resolution for CLI scripts. ([c04f9a7](https://github.com/ethers-io/ethers.js/commit/c04f9a7fff727bb04a4aa3a0fa05fd5cd8e795a6))
-  - Added new URLs for default ETC (and ETC testnets) providers. ([#351](https://github.com/ethers-io/ethers.js/issues/351); [3c184ac](https://github.com/ethers-io/ethers.js/commit/3c184ace21aafbb27f4d44cce1bb738af899d59f))
-
-ethers/v5.0.0-beta.164 (2020-01-07 19:57)
------------------------------------------
-
-  - Use better Description typing. ([2d5492c](https://github.com/ethers-io/ethers.js/commit/2d5492cd2ee722c818c249244af7b5bea05d67b0))
-  - Better property access on ABI decoded results. ([#698](https://github.com/ethers-io/ethers.js/issues/698); [13f50ab](https://github.com/ethers-io/ethers.js/commit/13f50abd847f7ddcc7e54c102da54e2d23b86fae))
-  - Better typing support for Description. ([d0f4642](https://github.com/ethers-io/ethers.js/commit/d0f4642f6d2c9f5119f1910a0082894c60e81191))
-  - Fixed resolveName when name is an address with an invalid checksum. ([#694](https://github.com/ethers-io/ethers.js/issues/694); [1e72fc7](https://github.com/ethers-io/ethers.js/commit/1e72fc7d6f7c3be4410dbdcfbab9a0463ceb52bd))
-
-ethers/v5.0.0-beta.163 (2020-01-06 18:57)
------------------------------------------
-
-  - Added function to generate CREATE2 addresses. ([#697](https://github.com/ethers-io/ethers.js/issues/697); [eb26a6d](https://github.com/ethers-io/ethers.js/commit/eb26a6d95022a241c44f859e7b2f29646afb4914))
-  - Force constructor name to be null (instead of undefined). ([a648f2b](https://github.com/ethers-io/ethers.js/commit/a648f2bd1e5e52a3662896f04fe7025884866972))
-  - Added documentation uploading script. ([e593aba](https://github.com/ethers-io/ethers.js/commit/e593aba2946c98820b0c2edf9c5dab6cb30c7402))
-  - Added Czech wordlist to default wordlists export. ([#691](https://github.com/ethers-io/ethers.js/issues/691); [5724fa5](https://github.com/ethers-io/ethers.js/commit/5724fa5d9c6fe73f14ec8bdea1f7226a222537ef))
-  - Added Czech BIP-39 wordlist. ([#691](https://github.com/ethers-io/ethers.js/issues/691); [f54f06b](https://github.com/ethers-io/ethers.js/commit/f54f06b5c8092997fd3c9055d69a3e0796ce44f3))
-  - Updated README. ([e809ead](https://github.com/ethers-io/ethers.js/commit/e809eadf8d608cd8c8a78c08a2e3547dd09156cf))
-  - Updating docs. ([184c459](https://github.com/ethers-io/ethers.js/commit/184c459fab0d089a8a879584b72e5eb3560b33ce))
-  - Merge branch 'yuetloo-ethers-v5-beta' into ethers-v5-beta ([06cafe3](https://github.com/ethers-io/ethers.js/commit/06cafe3437ef129b47f5f9c02f4759f2c4854d3c))
-  - 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 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))
-
-ethers/v5.0.0-beta.161 (2019-11-23 21:43)
------------------------------------------
-
-  - Updated dist files (sorted package.json to reduce package version change chatter). ([f308ba3](https://github.com/ethers-io/ethers.js/commit/f308ba3540ed0d282d099456d0369873ad9596b0))
-  - Stubs for adding throttle support. ([2f0e679](https://github.com/ethers-io/ethers.js/commit/2f0e679f0bc81bf901cf60a79e50f9715cddec5a))
-  - Refactor wordlists. ([abab9f6](https://github.com/ethers-io/ethers.js/commit/abab9f6aa27d1870d1053e7caa951408b86c454d))
-  - Browser testcases work again. ([c11c2e2](https://github.com/ethers-io/ethers.js/commit/c11c2e2e3376a6764f07ed443245823f2792b8cc))
-  - Added dist files for non-English wordlists. ([3d75c52](https://github.com/ethers-io/ethers.js/commit/3d75c52dac668af5eeede3e7764dadd3055a0707))
-  - Sync GitHub issue cache. ([29f0e9d](https://github.com/ethers-io/ethers.js/commit/29f0e9dd627a7b4b7f772300497f27718c9ecc7b))
-
-ethers/v5.0.0-beta.160 (2019-11-20 18:36)
------------------------------------------
-
-  - Updated API in testcases. ([3ab3733](https://github.com/ethers-io/ethers.js/commit/3ab373334c75800f2b20b6639ed8eb1b11e453ef))
-  - Fixed scrypt import in ESM build. ([b72ef27](https://github.com/ethers-io/ethers.js/commit/b72ef27b2a8f9941fb9d79122ec449fed9d2464d))
-  - Fixed null apiKey problem for InfuraProvider. ([e518151](https://github.com/ethers-io/ethers.js/commit/e51815150912d10e2734707986b10b37c87d6d12))
-  - Added support for sighash-style tuple parsing. ([19aaade](https://github.com/ethers-io/ethers.js/commit/19aaade9c62510012cfd50ae487ebd1705a28678))
-  - Fixed solc imports for cli. ([c35ddaf](https://github.com/ethers-io/ethers.js/commit/c35ddaf646efa25e738fee604585a0a7af45b206))
-  - Added nonce manager to experimental index. ([8316406](https://github.com/ethers-io/ethers.js/commit/8316406977ea26ca2044d16f7b3bb6ba21ef5b43))
-  - Removing NodesmithProvider from default provider as it is being discontinued. ([01ca350](https://github.com/ethers-io/ethers.js/commit/01ca35036ca11a47f60890e5cae62e46a00f3da8))
-  - Moved bare ABI named functions and events from Interface into Contracts to simplify other consumers of Interface. ([da8ca2e](https://github.com/ethers-io/ethers.js/commit/da8ca2e8bc982fc3ea0343bb3c593a485ca1fef0))
-  - Added support for complex API keys including support for INFURA project secrets. ([#464](https://github.com/ethers-io/ethers.js/issues/464), [#651](https://github.com/ethers-io/ethers.js/issues/651), [#652](https://github.com/ethers-io/ethers.js/issues/652); [1ec5804](https://github.com/ethers-io/ethers.js/commit/1ec5804bd460f6948d4813469fdc7bf739baa6a6))
-  - Migrated to scrypt-js v3. ([75895fa](https://github.com/ethers-io/ethers.js/commit/75895fa1491e7542c755a102f4e4c190685fd2b6))
-  - Moved getDefaultProvider to providers package. ([51e4ef2](https://github.com/ethers-io/ethers.js/commit/51e4ef2b45b83a8d82923600a2fac544d70b0807))
-  - Migrating providers to modern syntax and scoping. ([#634](https://github.com/ethers-io/ethers.js/issues/634); [e1509a6](https://github.com/ethers-io/ethers.js/commit/e1509a6326dd2cb8bf7ed64b82dd3947b768a314))
-  - Migrating to modern syntax and scoping. ([#634](https://github.com/ethers-io/ethers.js/issues/634); [394c36c](https://github.com/ethers-io/ethers.js/commit/394c36cad43f229a94c72d21f94d1c7982a887a1))
-  - Added provider property to Web3Provider. ([#641](https://github.com/ethers-io/ethers.js/issues/641); [1d4f90a](https://github.com/ethers-io/ethers.js/commit/1d4f90a958da6364117353850d62535c9702abd2))
-  - Updated GitHub issue cache. ([494381a](https://github.com/ethers-io/ethers.js/commit/494381a6284cc8ed90bd8002d42a6b6d94dc1200))
-  - Force deploy receipt to address to be null. ([#573](https://github.com/ethers-io/ethers.js/issues/573); [d9d438a](https://github.com/ethers-io/ethers.js/commit/d9d438a119bb11f8516fc9cf02c534ab3816fcb3))
-  - Updated experimental NonceManager. ([3d514c8](https://github.com/ethers-io/ethers.js/commit/3d514c8dbb94e1c4ce5754463e683dd9dbe7c0aa))
-  - Fixed typo in error message. ([28339a9](https://github.com/ethers-io/ethers.js/commit/28339a9c8585392086da159a46df4afb8958915c))
-  - Added GitHub issue caching. ([fea867a](https://github.com/ethers-io/ethers.js/commit/fea867a206f007a17718396e486883a5e718aa29))
-
-ethers/v5.0.0-beta.159 (2019-10-17 01:08)
------------------------------------------
-
-  - Removing TypeScript build files from npm to fix excessive package diffs.
-  - Fixed getBlock for blockhashes with a leading 0. ([#629](https://github.com/ethers-io/ethers.js/issues/629); [12cfc59](https://github.com/ethers-io/ethers.js/commit/12cfc599656d7e3a6d3d9aa4e468592865a711cc))
-
-ethers/v5.0.0-beta.158 (2019-09-28 01:56)
------------------------------------------
-
-  - Added less-common, but useful, coding functions to Interface. ([778eb3b](https://github.com/ethers-io/ethers.js/commit/778eb3b425b5ab5b23d28e75be92feccd0fc56bc))
-  - Add response handling and 304 support to fetchJson. ([3d25882](https://github.com/ethers-io/ethers.js/commit/3d25882d6bf689740506b9c569f6e0d30da6f6a5))
-  - Allow numeric values in a transaction to be odd-lengthed hexstrings. ([#614](https://github.com/ethers-io/ethers.js/issues/614); [a12030a](https://github.com/ethers-io/ethers.js/commit/a12030ad29aa13c02aa75d9e0860f4986a0043b4))
-  - Simpler crypt for admin tools. ([828c8cf](https://github.com/ethers-io/ethers.js/commit/828c8cfd419ac4f8d11d978c2e2ff83eba5ae909))
-
-ethers/v5.0.0-beta.157 (2019-09-08 02:43)
------------------------------------------
-
-  - Fixed getContractAddress for odd-length hex values. ([#572](https://github.com/ethers-io/ethers.js/issues/572); [751793e](https://github.com/ethers-io/ethers.js/commit/751793ea25183d54d7fc4c610a789608f91c062e))
-  - Fixed typo in error message. ([#592](https://github.com/ethers-io/ethers.js/issues/592); [6f4291f](https://github.com/ethers-io/ethers.js/commit/6f4291f65f0ea20c65fef7fd7b09b4d5bf5f0dcd))
-  - Fixed typo in error message. ([#580](https://github.com/ethers-io/ethers.js/issues/580); [9c63b4a](https://github.com/ethers-io/ethers.js/commit/9c63b4a7535f423a802bb1c17c325ce968987349))
-  - Fixed typo in error message. ([#574](https://github.com/ethers-io/ethers.js/issues/574); [22a2673](https://github.com/ethers-io/ethers.js/commit/22a26736cc332fe6e896c9d2707cc99ceee2fb10))
-
-ethers/v5.0.0-beta.156 (2019-09-06 17:56)
------------------------------------------
-
-  - Removed export star to fix UMD dist file. ([4c17c4d](https://github.com/ethers-io/ethers.js/commit/4c17c4db0455e1b89fd597c4c929cdc36aa3d90d))
-  - Updated TypeScript version. ([e8028d0](https://github.com/ethers-io/ethers.js/commit/e8028d0e73368257b76b394bb8e2bf63f8aecd71))
-  - Fixed test suites and reporter. ([1e0ed4e](https://github.com/ethers-io/ethers.js/commit/1e0ed4e99a22a27fe5057336f8cb320809768f3e))
-  - Added lock-versions admin tool. ([2187604](https://github.com/ethers-io/ethers.js/commit/21876049137644af2b3afa31120ee95d032843a8))
-  - Updated packages with version lock and moved types. ([85b4db7](https://github.com/ethers-io/ethers.js/commit/85b4db7d6db37b853f11a90cf4648c34404edcf9))
-  - Fixed typo in error message. ([#592](https://github.com/ethers-io/ethers.js/issues/592); [019c1fc](https://github.com/ethers-io/ethers.js/commit/019c1fc7089b3da2d7bd41c933b6c6bc35c8dade))
-  - Fixed build process to re-target browser field to ES version. ([3a91e91](https://github.com/ethers-io/ethers.js/commit/3a91e91df56c1ef6cf096c0322f74fd5060891e0))
-  - Major overhaul in compilation to enable ES6 module generation. ([73a0077](https://github.com/ethers-io/ethers.js/commit/73a0077fd38c6ae79f33a9d4d3cc128a904b4a6c))
-  - Updated some of the flatworm docs. ([81fd942](https://github.com/ethers-io/ethers.js/commit/81fd9428cab4be7eee7ddeb564bf91f282cae475))
-  - Fixed package descriptions. ([#561](https://github.com/ethers-io/ethers.js/issues/561); [ebfca98](https://github.com/ethers-io/ethers.js/commit/ebfca98dc276d6f6ca6961632635e8203bb17645))
-
-ethers/v5.0.0-beta.155 (2019-08-22 17:11)
------------------------------------------
-
-  - Added Wrapped Ether and Token transfers to CLI. ([c031a13](https://github.com/ethers-io/ethers.js/commit/c031a1336815923bae85d9982dba0985a79cfaed))
-  - Fixed sendTransaction and use median gas price in FallbackProvider. ([07e1599](https://github.com/ethers-io/ethers.js/commit/07e15993ba181cfbff987778d158dbde6bb84de2))
-  - Port optional Secret Storage wallet address to v5. ([#582](https://github.com/ethers-io/ethers.js/issues/582); [a12d60d](https://github.com/ethers-io/ethers.js/commit/a12d60d722dfcf998a2e06eba5e46390d7d442e5))
-  - Updated flatworm docs output. ([8745a81](https://github.com/ethers-io/ethers.js/commit/8745a81b11b710036ddb546308c13958be1affb9))
-  - Added initial flatworm documentation stubs. ([0333a76](https://github.com/ethers-io/ethers.js/commit/0333a76f4ff382b5b59b24c672b702721e7a386a))
-
-ethers/v5.0.0-beta.154 (2019-08-21 01:51)
------------------------------------------
-
-  - Use safe transfer for ENS in CLI. ([b7494d8](https://github.com/ethers-io/ethers.js/commit/b7494d8618001797a4e856f3d1886273897e6ba4))
-  - Fixed quorum-matching logic for FallbackProvider. ([b304ec1](https://github.com/ethers-io/ethers.js/commit/b304ec1f008ec5301c0dbd1a493d790fe3528512))
-  - Added CloudflareProvider. ([#587](https://github.com/ethers-io/ethers.js/issues/587); [621313d](https://github.com/ethers-io/ethers.js/commit/621313d2a697bc6e1dd25eb5b08d67e832a28d05))
-  - Added receipt to CALL_EXCEPTION errors. ([724c32e](https://github.com/ethers-io/ethers.js/commit/724c32e8c08b55404594f263e52babb0550a15b8))
-
-ethers/v5.0.0-beta.153 (2019-08-06 19:15)
------------------------------------------
-
-  - Updated gas estimate failure messaging to include that the tx may simple be causing a revert. ([edb26b1](https://github.com/ethers-io/ethers.js/commit/edb26b16354afd707e5d03e174c4cc809b951c4f))
-  - Additional sanity checks in ethers-ens. ([de4b2a4](https://github.com/ethers-io/ethers.js/commit/de4b2a449ca3a49807c8bedb3e21e8e8d71e63fc))
-  - Fix bug in --wait for CLI. ([9977c9f](https://github.com/ethers-io/ethers.js/commit/9977c9f66a7007dcc1963128c88c584b6b6c064b))
-  - Added content-hash support to ENS CLI. ([7dfef46](https://github.com/ethers-io/ethers.js/commit/7dfef463f83a9190d1b89cf81e0fb692da3dd813))
-
-ethers/v5.0.0-beta.152 (2019-08-05 14:37)
------------------------------------------
-
-  - Using CLI --wait instead of custom Plugin flag for ethers-ens. ([19ee2b5](https://github.com/ethers-io/ethers.js/commit/19ee2b516005b2c35b846f19457ec9bbfa0c283b))
-  - Added --wait as a general flag to CLI. ([7640292](https://github.com/ethers-io/ethers.js/commit/7640292ac8b7b9e6de3ad6699d23e2debf26cc1b))
-  - Added migrate-registrar and transfer to ENS CLI. ([31e8e1b](https://github.com/ethers-io/ethers.js/commit/31e8e1b0520bc8be390fbf7e2b473c36a8649eb3))
-  - Include data in the CLI transaction dump. ([53bd96a](https://github.com/ethers-io/ethers.js/commit/53bd96a9f675233906033290f1e0c71ca4e9d389))
-  - Better errors on gas estimation failure. ([0e6b810](https://github.com/ethers-io/ethers.js/commit/0e6b810def390309240508a99b2cf0736848dedd))
-
-ethers/v5.0.0-beta.151 (2019-08-05 14:29)
------------------------------------------
-
-  - Added package name prefix to all _version for Logger. ([692589d](https://github.com/ethers-io/ethers.js/commit/692589db54cbca10a2a453e9a1801a8612056559))
-
-ethers/v5.0.0-beta.150 (2019-08-03 01:07)
------------------------------------------
-
-  - Fixed old references to errors package. ([1cabce7](https://github.com/ethers-io/ethers.js/commit/1cabce7e1c23b15cc2b630c0b403dd72d815a5ba))
-  - Added generation scripts for Table A.1 for stringprep. ([#42](https://github.com/ethers-io/ethers.js/issues/42); [b21681a](https://github.com/ethers-io/ethers.js/commit/b21681a7f4292b0e77315caad3a59fe814e9292b))
-
-ethers/v5.0.0-beta.149 (2019-08-03 00:45)
------------------------------------------
-
-  - Fixed some case-folding and added Table A.1 for IDNA. ([#42](https://github.com/ethers-io/ethers.js/issues/42); [f955dca](https://github.com/ethers-io/ethers.js/commit/f955dca417a6f86690cf33a81b08baa99e1b1a5c))
-  - Removed references to legacy errors pacakge and updated umbrella pacakge. ([c09de16](https://github.com/ethers-io/ethers.js/commit/c09de163473c361cac11ddef9ec852f4cbb7d8e3))
-  - Updated admin module to use new fetchJson. ([226c100](https://github.com/ethers-io/ethers.js/commit/226c100c72c3fcb0c0e3b62be5f579fd9cc4c904))
-  - Updated dist files. ([8354c3f](https://github.com/ethers-io/ethers.js/commit/8354c3f9fe5487f21acaaeccd4450d9a5d495bc1))
-  - Full case-folding for IDNA in namehash. ([0af95f4](https://github.com/ethers-io/ethers.js/commit/0af95f4a655106e67c2ba8f445af88c9e9e24339))
-  - Deprecating errors for logger. ([0b224e8](https://github.com/ethers-io/ethers.js/commit/0b224e8fb5811cd06727063c909ca1e1e5cde57e))
-  - More consistent debug events for Providers. ([e8f28b5](https://github.com/ethers-io/ethers.js/commit/e8f28b55d7dd62e29f03628232ffe7c75dc811b5))
+This change log is managed by `admin/cmds/update-versions` but may be manually updated.
 
-ethers/v5.0.0-beta.148 (2019-07-27 18:56)
------------------------------------------
+ethers/v5.0.18 (2020-10-19 01:26)
+---------------------------------
 
-  - Initial drop of new ENS CLI tool. ([c3c65b2](https://github.com/ethers-io/ethers.js/commit/c3c65b2fa19e117d6433c2e0b3d20decfe506c74))
-  - Added TypeScript tool support for functions with multiple outputs. ([6de4a5d](https://github.com/ethers-io/ethers.js/commit/6de4a5d8a9d114c4c33c58f8a304b60e7370eeff))
-  - Added CLI support for stand-alone (no sub-command) tools. ([b67b121](https://github.com/ethers-io/ethers.js/commit/b67b12123996f1aaf7cbe3c8648fd85a22d6674e))
-  - Make utils.resolveProperties preserve object parameter order. ([74dbc28](https://github.com/ethers-io/ethers.js/commit/74dbc281ede042c5eeaa7b45150b215dea860a88))
-  - Added initial IDNA support for full UTF-8 support in namehash. ([#42](https://github.com/ethers-io/ethers.js/issues/42); [28eb38e](https://github.com/ethers-io/ethers.js/commit/28eb38ee703288aaad9f730b2d93fe3aeea7ada6))
+  - Fix signTypedData call for JsonRpcSigner. ([#687](https://github.com/ethers-io/ethers.js/issues/687); [15a90af](https://github.com/ethers-io/ethers.js/commit/15a90af5be75806e26f589f0a3f3687c0fb1c672))
+  - Added EIP-712 test cases. ([#687](https://github.com/ethers-io/ethers.js/issues/687); [1589353](https://github.com/ethers-io/ethers.js/commit/15893537c3d9c92fe8748a3e9617d133d1d5d6a7))
+  - Initial Signer support for EIP-712 signed typed data. ([#687](https://github.com/ethers-io/ethers.js/issues/687); [be4e216](https://github.com/ethers-io/ethers.js/commit/be4e2164e64dfa0697561763e8079120a485a566))
+  - Split hash library files up. ([3e676f2](https://github.com/ethers-io/ethers.js/commit/3e676f21b00931ed966f4561e4f28792a1f8f154))
+  - Added EIP-712 multi-dimensional array support. ([#687](https://github.com/ethers-io/ethers.js/issues/687); [5a4dd5a](https://github.com/ethers-io/ethers.js/commit/5a4dd5a70377d3e86823d279d6ff466d03767644))
+  - Consolidated TypedDataEncoder methods. ([#687](https://github.com/ethers-io/ethers.js/issues/687); [345a830](https://github.com/ethers-io/ethers.js/commit/345a830dc4bc869d5f3edfdc27465797e7663055))
+  - Initial EIP-712 utilities. ([#687](https://github.com/ethers-io/ethers.js/issues/687); [cfa6dec](https://github.com/ethers-io/ethers.js/commit/cfa6dec29314fe485df283974612d40550bc4179))
+  - Added initial PocketProvider. ([#1052](https://github.com/ethers-io/ethers.js/issues/1052); [a62d20d](https://github.com/ethers-io/ethers.js/commit/a62d20d86f2d545b9a7bcda5418993790b7db91c))
+
+ethers/v5.0.17 (2020-10-07 20:08)
+---------------------------------
+
+  - Better error message for parseUnits of non-strings. ([#981](https://github.com/ethers-io/ethers.js/issues/981); [5abc2f3](https://github.com/ethers-io/ethers.js/commit/5abc2f36e20eef79a935961f3dd8133b5528d9e5))
+  - Add gzip support to AlchemyProivder and InfuraProvider fetching. ([#1085](https://github.com/ethers-io/ethers.js/issues/1085); [38a068b](https://github.com/ethers-io/ethers.js/commit/38a068bcea3f251c8f3a349a90fcb077a39d23ad))
+  - Add gzip support to getUrl in node. ([#1085](https://github.com/ethers-io/ethers.js/issues/1085); [65772a8](https://github.com/ethers-io/ethers.js/commit/65772a8e1a55d663bdb67e3a2b160fecc9f986ef))
+  - Added CommunityResourcable to mark Providers as highly throttled. ([a022093](https://github.com/ethers-io/ethers.js/commit/a022093ce03f55db7ba2cac36e365d1af39ac45b))
+  - Added debug event info to WebSocketProvider. ([#1018](https://github.com/ethers-io/ethers.js/issues/1018); [8e682cc](https://github.com/ethers-io/ethers.js/commit/8e682cc8481c6051a6f8115b29d78f4996120ccd))
 
-ethers/v5.0.0-beta.147 (2019-07-23 01:04)
------------------------------------------
+ethers/v5.0.16 (2020-10-05 15:44)
+---------------------------------
 
-  - Use the CLI solc instead of solc directly for ABI testcase generation. ([99c7b1c](https://github.com/ethers-io/ethers.js/commit/99c7b1ca94382490b9757fd51375a7ad4259b831))
-  - Added experimental UTF-8 functions for escaping non-ascii strings. ([b132e32](https://github.com/ethers-io/ethers.js/commit/b132e32172c9d63e59209628dadd5796dd6291c8))
-  - Bump Solidity version in CLI to 0.5.10. ([6005248](https://github.com/ethers-io/ethers.js/commit/600524842e1a4b857e8428a45c0c7d1baa0624ee))
+  - ABI encoding performance additions. ([#1012](https://github.com/ethers-io/ethers.js/issues/1012); [f3e5b0d](https://github.com/ethers-io/ethers.js/commit/f3e5b0ded1b227a377fd4799507653c95c76e353))
+  - Export hexConcat in utils. ([#1079](https://github.com/ethers-io/ethers.js/issues/1079); [3d051e4](https://github.com/ethers-io/ethers.js/commit/3d051e454db978f58c7b38ff4484096c3eb85b94))
+  - Cache chain ID for WebSocketProvider. ([#1054](https://github.com/ethers-io/ethers.js/issues/1054); [40264ff](https://github.com/ethers-io/ethers.js/commit/40264ff9006156ba8441e6101e5a7149a5cf03f6))
 
-ethers/v5.0.0-beta.146 (2019-07-20 21:06)
------------------------------------------
+ethers/v5.0.15 (2020-09-26 03:22)
+---------------------------------
+
+  - Add more accurate intrinsic gas cost to ABI calls with specified gas property. ([#1058](https://github.com/ethers-io/ethers.js/issues/1058); [f0a5869](https://github.com/ethers-io/ethers.js/commit/f0a5869c53475e55a5f47d8651f609fff45dc9a7))
+  - Better errors for unconfigured ENS names. ([#1066](https://github.com/ethers-io/ethers.js/issues/1066); [5cd1668](https://github.com/ethers-io/ethers.js/commit/5cd1668e0d29099c5b7ce1fdc1d0e8a41af1a249))
+  - Updated CLI solc to versin 0.7.1. ([4306b35](https://github.com/ethers-io/ethers.js/commit/4306b3563a171baa9d7bf4872475a13c3434f834))
+
+ethers/v5.0.14 (2020-09-16 02:39)
+---------------------------------
+
+  - More robust blockchain error detection ([#1047](https://github.com/ethers-io/ethers.js/issues/1047); [49f7157](https://github.com/ethers-io/ethers.js/commit/49f71574f4799d685a5ae8fd24fe1134f752d70a))
+  - Forward blockchain errors from Signer during gas estimation. ([#1047](https://github.com/ethers-io/ethers.js/issues/1047); [9ee685d](https://github.com/ethers-io/ethers.js/commit/9ee685df46753c46cbbde12d05d6ea04f2b5ea3f))
+  - Improve fetch errors with looser mime-type detection. ([#1047](https://github.com/ethers-io/ethers.js/issues/1047); [263bfe5](https://github.com/ethers-io/ethers.js/commit/263bfe5ce632790e0399d06a0ab660a501997998))
+
+ethers/v5.0.13 (2020-09-11 02:10)
+---------------------------------
+
+  - Force content-length in web fetching. ([be92339](https://github.com/ethers-io/ethers.js/commit/be923396962ea76bf0fb566dcf8801e58ccf0e7e))
+  - Better error forwarding from FallbackProvider. ([#1021](https://github.com/ethers-io/ethers.js/issues/1021); [bc3eeec](https://github.com/ethers-io/ethers.js/commit/bc3eeeca39adb734f24019d0e942eff2eac6ad4d))
+  - Add clamping functions to FixedNumber. ([#1037](https://github.com/ethers-io/ethers.js/issues/1037); [042b74e](https://github.com/ethers-io/ethers.js/commit/042b74e6ee648d4fa37bf674194273d8f4483bfb))
 
-  - Keep extra filter topics when using Frgment filters in Contracts. ([efaafb2](https://github.com/ethers-io/ethers.js/commit/efaafb203feaf703de803df7e346652372e9fb75))
-  - Updated package.json description for Contract package. ([#561](https://github.com/ethers-io/ethers.js/issues/561); [d88ee45](https://github.com/ethers-io/ethers.js/commit/d88ee45937b3484b68f72e3f72ad6c29556c984b))
+ethers/v5.0.12 (2020-09-07 19:54)
+---------------------------------
 
-ethers/v5.0.0-beta.145 (2019-07-20 20:12)
------------------------------------------
+  - Allow events to use compact bytes ABI coded data for Solidity 0.4 external events. ([#891](https://github.com/ethers-io/ethers.js/issues/891), [#992](https://github.com/ethers-io/ethers.js/issues/992); [4e394fc](https://github.com/ethers-io/ethers.js/commit/4e394fc68019445ae4b4e201e41f95d6793dbe92))
+
+ethers/v5.0.11 (2020-09-05 23:51)
+---------------------------------
+
+  - Synced unorm in shims to most recent version. ([bdccf7b](https://github.com/ethers-io/ethers.js/commit/bdccf7b8d352ba400317266a0a37e6e290633e3c))
+  - Fixed LedgerSigner sendTransaction. ([#936](https://github.com/ethers-io/ethers.js/issues/936); [cadb28d](https://github.com/ethers-io/ethers.js/commit/cadb28d6b364e68e43a06f7a9b8a31797afbd920))
+  - Added BrainWallet to experimental exports. ([72385c2](https://github.com/ethers-io/ethers.js/commit/72385c228783a3158511b3cddc5cb4f9ce1dddae))
+  - More readable server errors. ([201e5ce](https://github.com/ethers-io/ethers.js/commit/201e5ced9c38da2de1dd7518ffbf24284d477e80))
+
+ethers/v5.0.10 (2020-09-05 01:21)
+---------------------------------
+
+  - Added retry logic to provider tests. ([0558bba](https://github.com/ethers-io/ethers.js/commit/0558bba8eb1b783ef50bb37bcf4c9bae1f86f1e1), [35b64b9](https://github.com/ethers-io/ethers.js/commit/35b64b9a65e2c09ecb63b0eca712b45a3092c204), [681f2a5](https://github.com/ethers-io/ethers.js/commit/681f2a50b26d7954795dba5aec55bede4740e494))
+  - Fixed link in docs. ([#1028](https://github.com/ethers-io/ethers.js/issues/1028); [2359a98](https://github.com/ethers-io/ethers.js/commit/2359a98641d99b26cf88ec892e3601a8a2c81c9c))
+  - Added memory-like support and new opcodes to asm. ([6fd3bb6](https://github.com/ethers-io/ethers.js/commit/6fd3bb62d10eab1563dc4ddbd88732b4f484ec7a))
+  - Added basic ENS resolver functions for contenthash, text and multi-coin addresses. ([#1003](https://github.com/ethers-io/ethers.js/issues/1003); [83db8a6](https://github.com/ethers-io/ethers.js/commit/83db8a6bd1364458dcfeea544de707df41890b4e))
+  - Added support for changing Reporter logging function. ([d01d0c8](https://github.com/ethers-io/ethers.js/commit/d01d0c8448df40de52253f9e92889ab7e75c6a97))
+  - Initial React Native test harness. ([#993](https://github.com/ethers-io/ethers.js/issues/993); [57eb5b7](https://github.com/ethers-io/ethers.js/commit/57eb5b777e2c67f1f8d74e41d3413e9f0564528d), [d3b473e](https://github.com/ethers-io/ethers.js/commit/d3b473e7c738fdfc65b6f1c8f80bcdacf9827d8a))
+  - Updating shims for constrained environments. ([#944](https://github.com/ethers-io/ethers.js/issues/944), [#993](https://github.com/ethers-io/ethers.js/issues/993); [8abdbbb](https://github.com/ethers-io/ethers.js/commit/8abdbbbf633f96fde2346c4ae70e538895fd7829), [240aac5](https://github.com/ethers-io/ethers.js/commit/240aac568303deff14cbb2366b94c8c89cacefc1))
+
+ethers/v5.0.9 (2020-08-25 01:45)
+--------------------------------
+
+  - Updated docs for all packages on npm pages. ([#1013](https://github.com/ethers-io/ethers.js/issues/1013); [cb8f4a3](https://github.com/ethers-io/ethers.js/commit/cb8f4a3a4e378a749c6bbbddf46d8d79d35722cc))
+  - Added JSON support to BigNumber. ([#1010](https://github.com/ethers-io/ethers.js/issues/1010); [8facc1a](https://github.com/ethers-io/ethers.js/commit/8facc1a5305b1f699aa3afc5a0a692abe7927652))
+  - Updated packages for security audit. ([5b5904e](https://github.com/ethers-io/ethers.js/commit/5b5904ea9977ecf8c079a57593b627553f0126a0))
+  - Fix emitted error for ABI code array count mismatch. ([#1004](https://github.com/ethers-io/ethers.js/issues/1004); [b0c082d](https://github.com/ethers-io/ethers.js/commit/b0c082d728dc66b0f2a5ec315da44d6295716284))
+
+ethers/v5.0.8 (2020-08-04 20:55)
+--------------------------------
+
+  - Abstract fetchJson for data. ([e2d6f28](https://github.com/ethers-io/ethers.js/commit/e2d6f281d5a2bd749bc72549a4e55f2c752a7bd8), [2c49a52](https://github.com/ethers-io/ethers.js/commit/2c49a52a41a30ae844376561de95f0c851d19f73), [e1bbb06](https://github.com/ethers-io/ethers.js/commit/e1bbb064a10d0b4bf5563e0a79396665d83935a1))
+
+ethers/v5.0.7 (2020-07-20 02:22)
+--------------------------------
+
+  - Fix Logger setLogLevel with enum case mismatch. ([#947](https://github.com/ethers-io/ethers.js/issues/947); [5443363](https://github.com/ethers-io/ethers.js/commit/5443363de43e92de712e72d55165c3f4d7f652e9), [af10705](https://github.com/ethers-io/ethers.js/commit/af10705632bc1f8203ea50ea7ed3120b01c67122))
+  - Removed UUID dependency from json-wallets. ([#966](https://github.com/ethers-io/ethers.js/issues/966); [e3f7426](https://github.com/ethers-io/ethers.js/commit/e3f7426af4d6d7e43db322700d768216b06433e0))
+  - Removed unnecessary dependency from BigNumber. ([#951](https://github.com/ethers-io/ethers.js/issues/951); [78b350b](https://github.com/ethers-io/ethers.js/commit/78b350bbc5ea73561bf47038743b9e51049496f7))
+
+ethers/v5.0.6 (2020-07-16 05:54)
+--------------------------------
+
+  - Removed unnecessary dependency from BigNumber. ([#951](https://github.com/ethers-io/ethers.js/issues/951); [78b350b](https://github.com/ethers-io/ethers.js/commit/78b350bbc5ea73561bf47038743b9e51049496f7))
+  - Longer Etherscan throttle slot interval. ([9f20258](https://github.com/ethers-io/ethers.js/commit/9f20258d5d39cd901d2078275323071eb0f3505b))
+  - Fixed ENS overrides for the default provider. ([#959](https://github.com/ethers-io/ethers.js/issues/959); [63dd3d4](https://github.com/ethers-io/ethers.js/commit/63dd3d4682b564445948988243fa9139c598587b))
+  - Added Retry-After support and adjustable slot interval to fetchJson. ([7d43545](https://github.com/ethers-io/ethers.js/commit/7d435453039f009b339d835ddee47e35a843711b))
+  - Added initial throttling support. ([#139](https://github.com/ethers-io/ethers.js/issues/139), [#904](https://github.com/ethers-io/ethers.js/issues/904), [#926](https://github.com/ethers-io/ethers.js/issues/926); [88c7eae](https://github.com/ethers-io/ethers.js/commit/88c7eaed061ae9a6798733a97e4e87011d36b8e7))
+  - Use status code 1000 on WebSocket hangup for compatibility. ([588f64c](https://github.com/ethers-io/ethers.js/commit/588f64c760ee49bfb5109bfbaafb4beafe41c52a))
+  - Updated WebSocketProvider to use web-style event listener API. ([57fd6f0](https://github.com/ethers-io/ethers.js/commit/57fd6f06047a1a2a3a46fe8b23ff585293a40062))
+  - Normalize formatUnits to simplified decimals. ([79b1da1](https://github.com/ethers-io/ethers.js/commit/79b1da130be50df80c7e5aeb221edc5669fc211e))
+  - Prevent zero-padding on Solidity type lengths. ([e128bfc](https://github.com/ethers-io/ethers.js/commit/e128bfcd10e006c920532151598700ca33a2127e))
+  - Set sensible defaults for INFURA and AlchemyAPI getWebSocketProvider methods. ([e3d3e60](https://github.com/ethers-io/ethers.js/commit/e3d3e604f299edbafe7d0721c0a3eff5f67c83f4))
+  - Added logger assert methods. ([619a888](https://github.com/ethers-io/ethers.js/commit/619a8888ebe08de9956f60c16703fb3543aeacc4))
+  - Added initial code coverage testing. ([0c1d55b](https://github.com/ethers-io/ethers.js/commit/0c1d55b6dc9c725c86e849d13b911c8bace9821d))
+  - Added destroy to WebSocketProvider. ([d0a79c6](https://github.com/ethers-io/ethers.js/commit/d0a79c6a1362e12f6f102e4af99adfef930092db))
+  - Updated packages (security updates). ([c660176](https://github.com/ethers-io/ethers.js/commit/c6601769ada64832b1ce392680a30cb145c3cab9))
 
-  - Export provider.Formatter. ([#562](https://github.com/ethers-io/ethers.js/issues/562); [083fd76](https://github.com/ethers-io/ethers.js/commit/083fd76a3a638ec16d5f9bf652101e5a150c7347))
-  - Update CLI to use new Fragment.format style. ([9a41199](https://github.com/ethers-io/ethers.js/commit/9a4119910b07d1ad61bafafb38ac18a9dae1d9ed))
-  - Added FormatTypes to utils. ([a05027c](https://github.com/ethers-io/ethers.js/commit/a05027c744102bbe1be5e13dd89b9c1e64b3b526))
-  - Added experimental memory-hard password scheme for password-protected mnemonics to the CLI. ([5877418](https://github.com/ethers-io/ethers.js/commit/5877418de94256a69fdf2ad466ba579309b9dee8))
-  - Added more flexible output options to fragment.format (JSON and minimal) and better JSON object parsing. ([e9558c8](https://github.com/ethers-io/ethers.js/commit/e9558c8d4fe6df889f4d7ba6ac6448aa543ef99d))
+ethers/v5.0.5 (2020-07-07 23:18)
+--------------------------------
 
-ethers/v5.0.0-beta.144 (2019-07-09 17:28)
------------------------------------------
+  - Fixed splitSignature when recoveryParam is encoded directly. ([#893](https://github.com/ethers-io/ethers.js/issues/893), [#933](https://github.com/ethers-io/ethers.js/issues/933); [bf65ddb](https://github.com/ethers-io/ethers.js/commit/bf65ddbff0036f6eb8e99c145f30edff157687f5))
+  - Fixed BigNumber string validation. ([#935](https://github.com/ethers-io/ethers.js/issues/935); [7e56f3d](https://github.com/ethers-io/ethers.js/commit/7e56f3d392e52815c5c859772b99660e0fc38ef5))
 
-  - Make mnemonic phrases case agnostic. ([#557](https://github.com/ethers-io/ethers.js/issues/557); [e4423b7](https://github.com/ethers-io/ethers.js/commit/e4423b7a277e7e1be1c02d345d4ab1eab484c9b8))
+ethers/v5.0.4 (2020-07-04 23:46)
+--------------------------------
 
-ethers/v5.0.0-beta.143 (2019-07-02 16:12)
------------------------------------------
+  - Prevent negative exponents in BigNumber. ([#925](https://github.com/ethers-io/ethers.js/issues/925); [84e253f](https://github.com/ethers-io/ethers.js/commit/84e253f3f9674b52fa2a17b097644e91e6474021))
+  - Fixed StaticJsonRpcProvider when auto-detecting network. ([#901](https://github.com/ethers-io/ethers.js/issues/901); [0fd9aa5](https://github.com/ethers-io/ethers.js/commit/0fd9aa5cb6f4a3f9c1bea9b4eeee389700db01fa))
+  - Added WebSocket static method to Alchemy provider and updated Alchemy URLs. ([4838874](https://github.com/ethers-io/ethers.js/commit/48388741272df8569315637f21df7c6519f79e2e))
 
-  - Adding more support for offline signing in the CLI. ([9cc269c](https://github.com/ethers-io/ethers.js/commit/9cc269ceb5d33b2d88542d4bc6771279f729e733))
-  - Allow providers to prepare their Network object. ([6484908](https://github.com/ethers-io/ethers.js/commit/6484908cb25dd35e5d98b2672dca72ed3f30cbe1))
-  - Export BIP-44 default path in ethers.utils. ([04bdf45](https://github.com/ethers-io/ethers.js/commit/04bdf456eb07aa72872265e0ee01e3231d2b6cf1))
+ethers/v5.0.3 (2020-06-29 00:50)
+--------------------------------
 
-ethers/v5.0.0-beta.142 (2019-06-28 16:13)
------------------------------------------
+  - Fixed typo in error string. ([7fe702d](https://github.com/ethers-io/ethers.js/commit/7fe702d59b0b81d2812e407b99a1e98e0e18ba03))
+  - Updated elliptic package to address possible malleability issue; which should not affect Ethereum. ([9e14345](https://github.com/ethers-io/ethers.js/commit/9e1434503e2a0280e9918c4eadb4d972b062b3b0))
+  - Fixed FixedNumber unguarded constructor and added isZero. ([#898](https://github.com/ethers-io/ethers.js/issues/898); [08c74e9](https://github.com/ethers-io/ethers.js/commit/08c74e9a132f37ab8cc3fb5dab3bd1fd708ee702))
+  - Added StaticJsonRpcProvider for reducing calls to chainId in certain cases. ([#901](https://github.com/ethers-io/ethers.js/issues/901); [c53864d](https://github.com/ethers-io/ethers.js/commit/c53864de0af55dd8ec8ca5681e78da380d85250a))
+  - Allow getDefaultProvider to accept a URL as a network. ([8c1ff4c](https://github.com/ethers-io/ethers.js/commit/8c1ff4c862b8cecb04c98d71910870e0b73867a0))
+  - Make network an optional parameter to WebSocketProvider. ([987b535](https://github.com/ethers-io/ethers.js/commit/987b5354cc18ed41620c43910ac163f358d91b5d))
+  - Removed deprecated errors package. ([f9e9347](https://github.com/ethers-io/ethers.js/commit/f9e9347e69133354c3d65c1f47475ddac8a793cf))
+  - Updated badges in docs. ([d00362e](https://github.com/ethers-io/ethers.js/commit/d00362eb706cfbf9911611e8d934260061cfbbd2))
+  - Create security policy. Create security policy. ([88e6849](https://github.com/ethers-io/ethers.js/commit/88e68495b67d9268ee66362b08c9b691d03ab58a))
 
-  - Do not require a Signer for contract.populateTransaction. ([0e78386](https://github.com/ethers-io/ethers.js/commit/0e78386a08d3d3a0a98c8d03cd665b8992ab3ea2))
-  - Bumping version of solc to 0.5.9. ([e2da447](https://github.com/ethers-io/ethers.js/commit/e2da447c7bc05937966bc4909c47291e4819d2a9))
+ethers/v5.0.2 (2020-06-13 21:36)
+--------------------------------
 
-ethers/v5.0.0-beta.141 (2019-06-24 21:25)
------------------------------------------
+  - Allow provider.ready to stall until the network is available. ([#882](https://github.com/ethers-io/ethers.js/issues/882); [bbb4f40](https://github.com/ethers-io/ethers.js/commit/bbb4f407b34782c36ff93fa528e3b9f793987d4a))
+  - Reduce dependencies to squash security issues. ([738d349](https://github.com/ethers-io/ethers.js/commit/738d34969d7c2184242b92f78228ba6a8aed1f3a))
+  - Updated admin scripts for publishing prod releases. ([e0e0dbe](https://github.com/ethers-io/ethers.js/commit/e0e0dbef1830572c465670b826a7aa2b403ad2e8))
 
-  - Fix non-ES6 import in keccak256. ([5eb393d](https://github.com/ethers-io/ethers.js/commit/5eb393d828328b34567566d3c0d622b4aef1e202))
-  - Refactored wordlist exports to export Wordlist directly. ([746d255](https://github.com/ethers-io/ethers.js/commit/746d255b741844b615583b2de3ffd07631b4e872))
+ethers/v5.0.1 (2020-06-12 23:09)
+--------------------------------
+
+  - Fixed embedded package version strings. ([5a69e9c](https://github.com/ethers-io/ethers.js/commit/5a69e9caa882aa5f1b44c4453d67cde43254eafe))
 
-ethers/v5.0.0-beta.140 (2019-06-12 01:25)
------------------------------------------
-
-  - Move from node-fetch to cross-fetch; better browser fallback implementation. ([826ffbc](https://github.com/ethers-io/ethers.js/commit/826ffbc7c4ed1c301f30e6f264eedeaf3c243ca8))
-  - Added getStatic with support for inheritance of static methods. ([5e4535e](https://github.com/ethers-io/ethers.js/commit/5e4535e939fdb9d9d23bd14b3e2590873d3eb508))
-  - Fixed node-fetch for Safari (todo: push this fix upstream to node-fetch). ([7164e51](https://github.com/ethers-io/ethers.js/commit/7164e51131215ae3201b49f8c7f5ade8cbd8a420))
-  - Migrated XMLHttpRequest to fetch API. ([#506](https://github.com/ethers-io/ethers.js/issues/506); [62201c5](https://github.com/ethers-io/ethers.js/commit/62201c5eebc52e9723dbbb2cc64823155ce1e0f9))
-
-ethers/v5.0.0-beta.139 (2019-06-11 17:55)
------------------------------------------
-
-  - Removed freeze option from deepCopy; all properties are read-only and only objects may have new properties added. ([1bc792d](https://github.com/ethers-io/ethers.js/commit/1bc792d9dcc6a06a1be4fc5e5b9a538a3f6b7ada))
-  - Moved away from isNamedInstance which breaks after Browserify name mangling. ([257d67c](https://github.com/ethers-io/ethers.js/commit/257d67c9625fa237bcfb3d651c49aa3b79175cae))
-  - Expose poll function in utils. ([#512](https://github.com/ethers-io/ethers.js/issues/512); [e6f6383](https://github.com/ethers-io/ethers.js/commit/e6f6383346818fa67423f1f20450e011242eb554))
-  - Make TransactionResponse hash required. ([#537](https://github.com/ethers-io/ethers.js/issues/537); [095c1fe](https://github.com/ethers-io/ethers.js/commit/095c1fe579068a3204ea0d1bc1893f293f61e719))
-
-ethers/v5.0.0-beta.138 (2019-06-04 16:05)
------------------------------------------
-
-  - Fixed INFURA project ID checking. ([#534](https://github.com/ethers-io/ethers.js/issues/534); [5bf763f](https://github.com/ethers-io/ethers.js/commit/5bf763fe2307e8570ab5e91e30c43e2e5731fc39))
-
-ethers/v5.0.0-beta.137 (2019-06-01 14:06)
------------------------------------------
-
-  - Fixed invalid arrayify value in browser for SHA2-HMAC. ([#530](https://github.com/ethers-io/ethers.js/issues/530); [c4a494b](https://github.com/ethers-io/ethers.js/commit/c4a494b528f2e5f706c159d916d8ff0ffd96a211))
-  - Fix event and function fragment formatting. ([a2d4b29](https://github.com/ethers-io/ethers.js/commit/a2d4b2907184d9480a72fe6f67652489074af86e))
-  - Fixed default JsonRpcSigner. ([#532](https://github.com/ethers-io/ethers.js/issues/532); [5ba6a61](https://github.com/ethers-io/ethers.js/commit/5ba6a616a6f969b1f28f8c6367c21488f497a7ae))
-  - Added changelog management to update-versions. ([4a3f719](https://github.com/ethers-io/ethers.js/commit/4a3f7190dc04275030d313289e1ba6a2b31407ec))
-
-ethers/v5.0.0-beta.136
-----------------------
-
-  - Added queryFilter to Contracts. ([#463](https://github.com/ethers-io/ethers.js/issues/463); [eea53bb](https://github.com/ethers-io/ethers.js/commit/eea53bb1be29ad2bd1b229a13c85b12be264b019))
-  - Allow storage class in Human-Readable ABI. ([#476](https://github.com/ethers-io/ethers.js/issues/476); [cf39adb](https://github.com/ethers-io/ethers.js/commit/cf39adb09020ca0393e028b330bfd07fb4869236))
-  - Track per-provider JSON-RPC ID in JsonRpcProvider. ([#337](https://github.com/ethers-io/ethers.js/issues/337), [#489](https://github.com/ethers-io/ethers.js/issues/489); [044554b](https://github.com/ethers-io/ethers.js/commit/044554b58525d1677646a74119f86ea867a06d1e))
-  - Fixed typo in error message. ([#470](https://github.com/ethers-io/ethers.js/issues/470); [47d92ae](https://github.com/ethers-io/ethers.js/commit/47d92aeff02cacfb26793850c7faef7cb21ce4cf))
-
-ethers/v5.0.0-beta.135
-----------------------
-
-  - Better error message for unconfigured ENS names. ([#504](https://github.com/ethers-io/ethers.js/issues/504); [3cbc4b4](https://github.com/ethers-io/ethers.js/commit/3cbc4b462262ba61fa7d99a7a12e7bbf8049afb1))
-  - Fixed contract events. ([#404](https://github.com/ethers-io/ethers.js/issues/404); [8cdda37](https://github.com/ethers-io/ethers.js/commit/8cdda37095df28f828ccd2ac5437ccb6541b16cc))
-  - Updated license for BaseX to include original authors; was only included in the source. ([03c9725](https://github.com/ethers-io/ethers.js/commit/03c97259c46de10dbe6ce62921de2f32ffff0522))
+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))

CHANGELOG.v5-beta.md

@@ -0,0 +1,523 @@
+Changelog
+=========
+
+This change log is managed by `scripts/cmds/update-versions` but may be manually updated.
+
+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)
+-----------------------------------------
+
+  - Add sub-error to gas estimate error for Ganache users. ([#829](https://github.com/ethers-io/ethers.js/issues/829); [647fbd8](https://github.com/ethers-io/ethers.js/commit/647fbd8cbfa0f94f72db6faadd528e61c49b1dd6))
+  - Moved ABI check for unique names to coding time and only if ambiguous. ([#816](https://github.com/ethers-io/ethers.js/issues/816); [fa87417](https://github.com/ethers-io/ethers.js/commit/fa87417e9416d99a37d9a2668a1e54feb7e342fc))
+  - Added missing Interface exports to umbrella utils. ([82a9326](https://github.com/ethers-io/ethers.js/commit/82a93263fae330ae39a7212e74d973fa9f820f64))
+  - Fixed FallbackProvider ESM super-this out-of-order issue. ([#822](https://github.com/ethers-io/ethers.js/issues/822); [fde102b](https://github.com/ethers-io/ethers.js/commit/fde102b7eda304403dcc677cd6d3b48339cd3a81))
+  - Fixed node hanging on unnecessary timeout when fetchJson fails. ([fdf2253](https://github.com/ethers-io/ethers.js/commit/fdf2253218cf379043acc32dea8c95c284a82cec))
+
+ethers/v5.0.0-beta.186 (2020-05-08 15:27)
+-----------------------------------------
+
+  - Fix JsonRpcProvider out-of-order super call. ([#822](https://github.com/ethers-io/ethers.js/issues/822); [963197d](https://github.com/ethers-io/ethers.js/commit/963197d70c96e5970b431173c2cc782cb496674c))
+
+ethers/v5.0.0-beta.185 (2020-05-04 22:54)
+-----------------------------------------
+
+  - More robust FallbackProvider on clean exits. ([8eeda23](https://github.com/ethers-io/ethers.js/commit/8eeda23e989fcb0126bd20b17c67f62466d19259))
+  - Safer test suite reporter timer. ([657a039](https://github.com/ethers-io/ethers.js/commit/657a0394f56b51a13c691477c2b0dcf74678fd7c))
+  - Added goerli to AlchemyProvider tests. ([ab7c781](https://github.com/ethers-io/ethers.js/commit/ab7c78118ab80990a3e3368749599a1cf6e9d4ae))
+  - Added more robust poll event to Provider. ([dc48bfb](https://github.com/ethers-io/ethers.js/commit/dc48bfb7adb9334848c93173ba2c634f22a9a72f))
+  - Added goerli to AlchemyProvider. ([86670eb](https://github.com/ethers-io/ethers.js/commit/86670eb80e96fc4ba4e3664c9389f8130bbfea73))
+  - Removed Cloudflare from test suite; it is down again. ([17dc022](https://github.com/ethers-io/ethers.js/commit/17dc022603afdfe4147638ab4b2704bcef09533f))
+  - Prevent forceOutput in test reporter from crashing. ([cafd344](https://github.com/ethers-io/ethers.js/commit/cafd34460b194d78092021f1d7e0307130340b68))
+  - Stall FallbackProvider backends from requests if not in-sync. ([fa6904f](https://github.com/ethers-io/ethers.js/commit/fa6904fef35e7ab888221f3a0613bfe7e6df3594))
+  - Allow providers to detect their network after instantiation. ([#814](https://github.com/ethers-io/ethers.js/issues/814); [99ae946](https://github.com/ethers-io/ethers.js/commit/99ae946476a317a9d89e5d8f57cf37f8680bfa2b))
+  - Better messaging on low-level network errors. ([#814](https://github.com/ethers-io/ethers.js/issues/814); [0e3a66c](https://github.com/ethers-io/ethers.js/commit/0e3a66c82959a08f3f4e4ffbca3ae3792ff2548f))
+  - Manage FallbackProvider stalling without unref. ([#815](https://github.com/ethers-io/ethers.js/issues/815); [7b1a7c7](https://github.com/ethers-io/ethers.js/commit/7b1a7c7f31a3631e12c2a341b562983360e670e9))
+  - Only error on duplicate signatures in Contract ABI. ([#499](https://github.com/ethers-io/ethers.js/issues/499); [098d7ef](https://github.com/ethers-io/ethers.js/commit/098d7efb21bd648c2660342297d2419904a10925))
+  - Added getWebSocketProvider static method to InfuraProvider. ([a6c1174](https://github.com/ethers-io/ethers.js/commit/a6c1174dffe6dca1a3a64d1d472cec6e12372117))
+  - Fix WebSocketProvider responses when message result is null. ([#813](https://github.com/ethers-io/ethers.js/issues/813); [472e5b0](https://github.com/ethers-io/ethers.js/commit/472e5b07eab180baa12185c8f00e5079ce4c671f))
+  - Allow modifiers on Human-Readable ABI for tuples and arrays. ([83fba3d](https://github.com/ethers-io/ethers.js/commit/83fba3de25b524cc48975b1952f4319d63874205))
+  - Added initial renew support to ENS CLI. ([54dfb75](https://github.com/ethers-io/ethers.js/commit/54dfb757c4c88e4bcada1890c4016fadfb25581a))
+  - Allow contract filters to include OR-ed values. ([#437](https://github.com/ethers-io/ethers.js/issues/437); [28800d7](https://github.com/ethers-io/ethers.js/commit/28800d7681f3bab08f6d30a22f0813e04feee18a))
+
+ethers/v5.0.0-beta.184 (2020-04-28 04:58)
+-----------------------------------------
+
+  - Removed old EIP-1193 experimental provider; it can now be supported by Web3Provider as EIP-1193 is now backwards compatible. ([84c68ac](https://github.com/ethers-io/ethers.js/commit/84c68ac5c17b10897ade966d6c8fac1f1f66a4af))
+  - Fixed getLogs filter deserialization. ([#805](https://github.com/ethers-io/ethers.js/issues/805); [393c0c7](https://github.com/ethers-io/ethers.js/commit/393c0c74a91175adca2e25026dcdb9e6445afd8f))
+  - Added EIP-1193 support to Web3Provider. ([56af441](https://github.com/ethers-io/ethers.js/commit/56af4413b1dd1787db68985e0b612b63d86fdf7c))
+  - Minor typing-detected fixes. ([d1f3a42](https://github.com/ethers-io/ethers.js/commit/d1f3a42c119d5588eab667ec7bb6e71042cfb656))
+  - Added initial support for recoverable coding erros. ([#800](https://github.com/ethers-io/ethers.js/issues/800); [bda6623](https://github.com/ethers-io/ethers.js/commit/bda66230916e58e25a522e8430ce4de25091eb6b))
+  - More draconian Typing. ([14e6811](https://github.com/ethers-io/ethers.js/commit/14e6811bf7d7c38a3b5714dededcc883c185d814))
+  - Omit HID libraries for hardware-wallets package on unsupported environments. ([#798](https://github.com/ethers-io/ethers.js/issues/798); [2e24920](https://github.com/ethers-io/ethers.js/commit/2e24920d028d42908d0764ad4ca0b56b55f852d1), [5aefb43](https://github.com/ethers-io/ethers.js/commit/5aefb4303d2fdda62e7e5ddb644919f613d6016a))
+  - Make default constructor non-payable. ([#684](https://github.com/ethers-io/ethers.js/issues/684); [017ea0d](https://github.com/ethers-io/ethers.js/commit/017ea0d6bd22833e9d399ae6b818443786f17884))
+
+ethers/v5.0.0-beta.183 (2020-04-23 23:28)
+-----------------------------------------
+
+  - Fixed inconsistent log format in WebSocketProvider. ([#795](https://github.com/ethers-io/ethers.js/issues/795); [8e7751f](https://github.com/ethers-io/ethers.js/commit/8e7751f7dfb41e58f81c7918cf36c152c3209ae2))
+  - Added WebSocketProvider support for ENS names in filters. ([6707754](https://github.com/ethers-io/ethers.js/commit/6707754580490c5a801d6205af0841794d20b3c9))
+  - Fixed provider filtering by ENS name. ([aeeb75f](https://github.com/ethers-io/ethers.js/commit/aeeb75f74c3be11b9b3b2925fd73349070542e54))
+  - Fixed ContractFactory.deploy ignoring overrides. ([#796](https://github.com/ethers-io/ethers.js/issues/796); [8bb2a0f](https://github.com/ethers-io/ethers.js/commit/8bb2a0fd08f6f128a80444e3fd90c29e4cd7edfb))
+  - Fix median calculation for large block number deltas across FallbackProvider backends. ([fca5ccb](https://github.com/ethers-io/ethers.js/commit/fca5ccbc2052569e700a96dbb1de1c9cef7c966f))
+  - Work-around for Cloudflare not offering eth_blockNumber. ([8cf4b3c](https://github.com/ethers-io/ethers.js/commit/8cf4b3cf4598f4f3643d5ebe9c366466d398cb83))
+  - Added string spell-checking to library and fixed discovered typos. ([71d03c6](https://github.com/ethers-io/ethers.js/commit/71d03c6e3cab1aacb3e4e74d3966fbaa7db2ee06))
+  - Fixed getUrl for node 8. ([560adea](https://github.com/ethers-io/ethers.js/commit/560adeabb06a2ab483bcad162f02ccef41ebc245))
+  - Dependency security updates. ([da3b0bf](https://github.com/ethers-io/ethers.js/commit/da3b0bf0786fe8a95c68485d130ca59c597ffe4d))
+  - Fixes for dist builds without injected XMLHttpRequest. ([#789](https://github.com/ethers-io/ethers.js/issues/789), [#506](https://github.com/ethers-io/ethers.js/issues/506); [9ae6b70](https://github.com/ethers-io/ethers.js/commit/9ae6b70efb9f3d3251820403597085cfa30ace05))
+
+ethers/v5.0.0-beta.182 (2020-04-16 21:53)
+-----------------------------------------
+
+  - Added support for Contract event parsing error recovery. ([cc72f76](https://github.com/ethers-io/ethers.js/commit/cc72f76695572d235d7f5a5ad4dc1838a5fe884a))
+  - Fix provider log filters with zero topics. ([#785](https://github.com/ethers-io/ethers.js/issues/785); [4ef0e4f](https://github.com/ethers-io/ethers.js/commit/4ef0e4f7653226bf8cca86e065ad614e7288af96))
+
+ethers/v5.0.0-beta.181 (2020-04-15 18:23)
+-----------------------------------------
+
+  - Temporarily remove CloudflareProvider tests; it is down and breaking the tests. ([797abb7](https://github.com/ethers-io/ethers.js/commit/797abb726711499d96bf1c12c61e3bb1a7b4925d))
+  - Better error reporting for Fragments. ([7dcefcb](https://github.com/ethers-io/ethers.js/commit/7dcefcbf71ef337103639bbe3f4ad2625565651a))
+  - Fixed Contract filter unsubscribing. ([2eb3823](https://github.com/ethers-io/ethers.js/commit/2eb3823de4ba111cc0c746a0715fe6dd3d1b16da), [39c78f3](https://github.com/ethers-io/ethers.js/commit/39c78f37ceff9b8ec08329903dcba7bd53bd8661))
+  - Fixed WebSocketProvider filter events. ([#784](https://github.com/ethers-io/ethers.js/issues/784); [69f7077](https://github.com/ethers-io/ethers.js/commit/69f707762ed5939c5f52bf6dce5c5513aaf6fa1d))
+  - Added bitwise operations to BigNumber. ([#781](https://github.com/ethers-io/ethers.js/issues/781); [7498c18](https://github.com/ethers-io/ethers.js/commit/7498c18235c7566b2f652cddba991f55e0943da8), [284771e](https://github.com/ethers-io/ethers.js/commit/284771ea39b6f4ee9cdf75ce5feea9e6aa9a65c5))
+
+ethers/v5.0.0-beta.180 (2020-04-03 22:10)
+-----------------------------------------
+
+  - Correctly return the Provider in NonceManager. ([6caf7c2](https://github.com/ethers-io/ethers.js/commit/6caf7c292cd5f03741cd6b30053c3325c4f30a81))
+  - Fail earlier when resolving an ENS name that is not a string. ([2882546](https://github.com/ethers-io/ethers.js/commit/28825463517f8821392464ec2283ee59c431d928))
+  - Fixed mutabilityState calculation for function fragments. ([#762](https://github.com/ethers-io/ethers.js/issues/762); [6526de0](https://github.com/ethers-io/ethers.js/commit/6526de016fda5403474dad61ee59acc62ee25ebc), [d7c8b35](https://github.com/ethers-io/ethers.js/commit/d7c8b355a049b36068b0525a357c6278639a8d58))
+  - Force Log properties to be non-optional. ([#415](https://github.com/ethers-io/ethers.js/issues/415); [da412f6](https://github.com/ethers-io/ethers.js/commit/da412f660723d1c411484e74970ce4eb166374c2), [8ad26f0](https://github.com/ethers-io/ethers.js/commit/8ad26f0ff42614a6c40e735cb6fffd36874da1a0))
+  - Fixed Signer call not forwarding blockTag. ([#768](https://github.com/ethers-io/ethers.js/issues/768); [053a2d7](https://github.com/ethers-io/ethers.js/commit/053a2d7fcdb4ca4c9bfd0bee0f42e0187d3db477))
+
+ethers/v5.0.0-beta.179 (2020-03-31 23:40)
+-----------------------------------------
+
+  - Fixed ENS CLI lookup for Website. ([0f144c6](https://github.com/ethers-io/ethers.js/commit/0f144c6cc03082026080782356b940af3389b34e))
+  - Fixed getEtherPrice for EtherscanProvider. ([#776](https://github.com/ethers-io/ethers.js/issues/776); [6c71b51](https://github.com/ethers-io/ethers.js/commit/6c71b515126d8ef3cea5a1aec814c4cab56cc1a5))
+  - Fixed ENS CLI tool set-websites and added set-name. ([70cffb6](https://github.com/ethers-io/ethers.js/commit/70cffb6a5166a79a54e02b03b6a7ec0085407e07))
+
+ethers/v5.0.0-beta.178 (2020-03-30 22:14)
+-----------------------------------------
+
+  - Fixed Event args keyword access. ([2692e78](https://github.com/ethers-io/ethers.js/commit/2692e783b40ce16207fa1a8e8513ebb5455fd2d0), [092ce9b](https://github.com/ethers-io/ethers.js/commit/092ce9bcc2abf92c40550c4a990a8e2c889cc250))
+  - Updating TypeScript library and fixing some audit issues. ([bd32ee0](https://github.com/ethers-io/ethers.js/commit/bd32ee0af5b25a435e5896773d8bfd482d3adcaf))
+
+ethers/v5.0.0-beta.177 (2020-03-21 12:46)
+-----------------------------------------
+
+  - Abstracted JSON-RPC parameter generation for others to use. ([030f65e](https://github.com/ethers-io/ethers.js/commit/030f65e66ce059d69d8d77973d5c3190745eaac2))
+  - Updated RLP package to use Logger instead of bare errors. ([390497f](https://github.com/ethers-io/ethers.js/commit/390497f38964a052837f6c0e7c96efe74c668517))
+  - Fixed log level filtering for Logger. ([#379](https://github.com/ethers-io/ethers.js/issues/379); [72c8992](https://github.com/ethers-io/ethers.js/commit/72c89922a4e1b77295414c8e0717a7373f2397b8))
+  - Throw errors when trying to RLP encode integers. ([9ea16e5](https://github.com/ethers-io/ethers.js/commit/9ea16e5172928962792ba4c0273e23db373409e0))
+  - Added delays to provider tests to prevent throttling causing failed tests. ([3e44aac](https://github.com/ethers-io/ethers.js/commit/3e44aac8f199ec09babb20c4af2ee668e0ab05a1))
+
+ethers/v5.0.0-beta.176 (2020-03-12 19:10)
+-----------------------------------------
+
+  - Checking in initial Eip1193Bridge (experimental). ([2c78f0b](https://github.com/ethers-io/ethers.js/commit/2c78f0bf265a0f7c9f4cfc1bc79ecd4629b59c49))
+  - Added initial WebSocketProvider. ([#141](https://github.com/ethers-io/ethers.js/issues/141); [117a5dd](https://github.com/ethers-io/ethers.js/commit/117a5dd7ffa783c4335c0b87621437447cd499d0))
+  - Renamed properties based on community recommendations; estimate to estimateGas and addressPromise to resovledAddress. ([fe3b3fa](https://github.com/ethers-io/ethers.js/commit/fe3b3fa1aded67827fec1131931d95d8153d8f32))
+  - Better error reporting and fixed look-ahead for data labels. ([e52312e](https://github.com/ethers-io/ethers.js/commit/e52312e783b8d0fdd7e9992716cbe2e179751b38))
+
+ethers/v5.0.0-beta.175 (2020-02-27 19:53)
+-----------------------------------------
+
+  - Fix address-less filter listening in Provider. ([#741](https://github.com/ethers-io/ethers.js/issues/741); [64dccb2](https://github.com/ethers-io/ethers.js/commit/64dccb275c68ebb40328350d4ab5be0f29b8a02e))
+  - Added sync version of wallet decryption. ([0ad94cd](https://github.com/ethers-io/ethers.js/commit/0ad94cdf8137259bedb38c0dc949b61570bcdac0), [6809c37](https://github.com/ethers-io/ethers.js/commit/6809c370c027aea148466c00d3ce09c6d0ee6ddc))
+
+ethers/v5.0.0-beta.175 (2020-02-27 19:38)
+-----------------------------------------
+
+  - Fix address-less filter listening in Provider. ([#741](https://github.com/ethers-io/ethers.js/issues/741); [64dccb2](https://github.com/ethers-io/ethers.js/commit/64dccb275c68ebb40328350d4ab5be0f29b8a02e))
+  - Added sync version of wallet decryption. ([0ad94cd](https://github.com/ethers-io/ethers.js/commit/0ad94cdf8137259bedb38c0dc949b61570bcdac0))
+
+ethers/v5.0.0-beta.174 (2020-02-25 14:57)
+-----------------------------------------
+
+  - Reduced default Provider quorum for testnets. ([1cfab31](https://github.com/ethers-io/ethers.js/commit/1cfab3173c3d0519beffc054efe73f70b7d28501))
+  - Added JSON-RPC debugging on error responses. ([ad27600](https://github.com/ethers-io/ethers.js/commit/ad27600c699827858e7343adff2d4fa622248e42))
+  - Fixed setLogLevel to affect global logging. ([ac51a88](https://github.com/ethers-io/ethers.js/commit/ac51a88c2913d7055e050c91d7d96bb42abf6656))
+  - Renamed interface getTopic to getEventTopic. ([f61f34b](https://github.com/ethers-io/ethers.js/commit/f61f34bfb295bafee3b7ee426efa696aaa9bbafe))
+  - Fix log parsing when no matching topic hash is found. ([#733](https://github.com/ethers-io/ethers.js/issues/733); [a5d2ec5](https://github.com/ethers-io/ethers.js/commit/a5d2ec534f75b21eebe69a789a3c43c33014a825), [4b8e198](https://github.com/ethers-io/ethers.js/commit/4b8e198bf209fcf0aea55018d8940355ea4345de), [89ac9f4](https://github.com/ethers-io/ethers.js/commit/89ac9f4f298ac340c4429e8ebdacd29962eba7f4))
+
+ethers/v5.0.0-beta.173 (2020-02-12 17:09)
+-----------------------------------------
+
+  - Added experimental EipWrappedProvider. ([944600d](https://github.com/ethers-io/ethers.js/commit/944600d779564c500ab98d3265286a0717642614))
+  - Updated signature for JsonRpcProvider.send to match EIP-1193. ([b962b59](https://github.com/ethers-io/ethers.js/commit/b962b59ab72e67bc4566a361964e42cf1b791025))
+  - Added binary literal support to ASM grammar. ([375bd15](https://github.com/ethers-io/ethers.js/commit/375bd15594a3179432e8452d819d91ea72b4bdd8))
+  - Added explicit pop placeholders to ASM dialect. ([a6b696d](https://github.com/ethers-io/ethers.js/commit/a6b696d8bd03c4027b52fe23745f066d158f1420))
+  - Added position independent code option for asm. ([89615c5](https://github.com/ethers-io/ethers.js/commit/89615c59d385a58fa79b6bbd8eae53c30e45fe96))
+  - Added ASM semantic checking and the Pop placeholder. ([a33bf0e](https://github.com/ethers-io/ethers.js/commit/a33bf0e37f4f969cc03b85ebf0dbadcf3e9b068a))
+  - Better type safety for defineReadOnly. ([e7adc84](https://github.com/ethers-io/ethers.js/commit/e7adc84a972968f39a983efb6f21b6ceaacd6cc5))
+  - Fixed CLI sandbox quiting after prompt entry. ([ff9bc2a](https://github.com/ethers-io/ethers.js/commit/ff9bc2a282e617125bbca76702dec85149661390))
+
+ethers/v5.0.0-beta.172 (2020-02-04 00:59)
+-----------------------------------------
+
+  - Synced GitHub issue cache. ([13dbf1f](https://github.com/ethers-io/ethers.js/commit/13dbf1f965eab344d2a304f7612d19ea96391261))
+  - Better typing for Timers. ([5622f70](https://github.com/ethers-io/ethers.js/commit/5622f703d962993442623ef1450a595825c4efa8))
+  - Safer transaction serialization, matching signature.v with chainId. ([#708](https://github.com/ethers-io/ethers.js/issues/708); [edb7c5d](https://github.com/ethers-io/ethers.js/commit/edb7c5da91ce271688561364d867998b0f0675e3))
+  - Fixed Opcode typo and added check to prevent future typos. ([15bb840](https://github.com/ethers-io/ethers.js/commit/15bb8409077f96b22e8bd60c426cddd015454e6b))
+  - Renamed AST nodes for teh assembler. ([f02c7db](https://github.com/ethers-io/ethers.js/commit/f02c7db4109d1785b4528757aa50f24948e896ae))
+  - Added timeout to waitForTransaction. ([#477](https://github.com/ethers-io/ethers.js/issues/477); [bacc440](https://github.com/ethers-io/ethers.js/commit/bacc4403979fa423890e269e7a5c7d11c6891a9f))
+  - Added CLI for asm package. ([aafa42a](https://github.com/ethers-io/ethers.js/commit/aafa42a32b2a5c7481a409ad048dfc06112c6599))
+  - Prevent Signer.checkTransaction from creating conflicting from properties. ([1decb13](https://github.com/ethers-io/ethers.js/commit/1decb1379902b60a15925b9b1de39633393db825))
+  - Include asm in generated TypeScript dependencies. ([ba29618](https://github.com/ethers-io/ethers.js/commit/ba296188960fb345dfdab12f2bb3ed3dc5eab51a))
+  - Clean up some asm checks and dead code. ([fa317eb](https://github.com/ethers-io/ethers.js/commit/fa317ebc032f8a5f9fb2dd10e23496252ae744e1))
+  - More contained Opcode API. ([da8153c](https://github.com/ethers-io/ethers.js/commit/da8153c87753b79e5e4cd34d484b8e0e717426d9))
+  - Added initial codedrop for the asm package. ([0296594](https://github.com/ethers-io/ethers.js/commit/0296594aba8d1e90e9ef7a18d2324f6cac815953))
+
+ethers/v5.0.0-beta.171 (2020-02-01 05:05)
+-----------------------------------------
+
+  - Added CLI for asm package. ([aafa42a](https://github.com/ethers-io/ethers.js/commit/aafa42a32b2a5c7481a409ad048dfc06112c6599))
+  - Added more flatworm documentation. ([1c85fe9](https://github.com/ethers-io/ethers.js/commit/1c85fe95b2b536828e83087676becba85c9a90bb))
+  - Prevent Signer.checkTransaction from creating conflicting from properties. ([1decb13](https://github.com/ethers-io/ethers.js/commit/1decb1379902b60a15925b9b1de39633393db825))
+  - Include asm in generated TypeScript dependencies. ([ba29618](https://github.com/ethers-io/ethers.js/commit/ba296188960fb345dfdab12f2bb3ed3dc5eab51a))
+  - Clean up some asm checks and dead code. ([fa317eb](https://github.com/ethers-io/ethers.js/commit/fa317ebc032f8a5f9fb2dd10e23496252ae744e1))
+  - More contained Opcode API. ([da8153c](https://github.com/ethers-io/ethers.js/commit/da8153c87753b79e5e4cd34d484b8e0e717426d9))
+  - Added initial codedrop for the asm package. ([0296594](https://github.com/ethers-io/ethers.js/commit/0296594aba8d1e90e9ef7a18d2324f6cac815953))
+
+ethers/v5.0.0-beta.171 (2020-01-29 21:41)
+-----------------------------------------
+
+  - Better solc support in CLI; it will search the local pacakge for an existing solc version. ([7428776](https://github.com/ethers-io/ethers.js/commit/7428776f75222d5c07282bc29c3dd8ed99f5d2cc))
+  - Update ENS registry address and lower default quorum for testnets. ([edb49da](https://github.com/ethers-io/ethers.js/commit/edb49da15518f25b3d60813ebb84f54171e308f3))
+  - Exposed isBytes and isBytesLike in ethers.utils. ([99329b0](https://github.com/ethers-io/ethers.js/commit/99329b013ce7f3af301d40c41f7eb35bff288910))
+
+ethers/v5.0.0-beta.170 (2020-01-21 20:37)
+-----------------------------------------
+
+  - Better, easier and more provider testing. ([e0d1d38](https://github.com/ethers-io/ethers.js/commit/e0d1d3866d2559f39627254873a0a1d4c0fcaf3d))
+  - Fixed out-of-bounds difficulty in getBlock, which can affect PoA networks. ([#711](https://github.com/ethers-io/ethers.js/issues/711); [251882c](https://github.com/ethers-io/ethers.js/commit/251882ced4379931ec82ba28a4db10bc7dbf3580))
+
+ethers/v5.0.0-beta.169 (2020-01-20 19:42)
+-----------------------------------------
+
+  - Fixed imports after refactor. ([adf5622](https://github.com/ethers-io/ethers.js/commit/adf56229c6cc83003d319ea9a004677e2555d478))
+  - Refactor some enum names and add UTF-8 error support to the umbrella package. ([931da2f](https://github.com/ethers-io/ethers.js/commit/931da2f77446fc9266cf07f0d7d78d4376625005))
+  - Allow arbitrary apiKey for UrlJsonRpcProvider. ([5878b54](https://github.com/ethers-io/ethers.js/commit/5878b54d6eded1329a6dc3b4023f876a87f72b6e))
+  - Added more general error handling (e.g. error, ignore, replace) for calling toUtf8String. ([a055edb](https://github.com/ethers-io/ethers.js/commit/a055edb5855b96fdf179403458c1694b96fd906c))
+
+ethers/v5.0.0-beta.168 (2020-01-18 21:46)
+-----------------------------------------
+
+  - Much more resiliant FallbackProvider which can ignore properties that are only approximate and supports per-provider priorities. ([#635](https://github.com/ethers-io/ethers.js/issues/635), [#588](https://github.com/ethers-io/ethers.js/issues/588); [f4bcf24](https://github.com/ethers-io/ethers.js/commit/f4bcf24a257a17ec9beb98f3d0b3682de543534c))
+  - Fixed some typing for receipts and logs. ([#497](https://github.com/ethers-io/ethers.js/issues/497); [ea102ef](https://github.com/ethers-io/ethers.js/commit/ea102ef7c4fa5df7b9389fbc8a2947bbbd4c471e))
+  - Abstracting mnemonic phrases. ([#685](https://github.com/ethers-io/ethers.js/issues/685); [92a383f](https://github.com/ethers-io/ethers.js/commit/92a383ff0dad4587e44953efca3c6ab795a1b1bd))
+  - Sync GitHub issues. ([75e1a37](https://github.com/ethers-io/ethers.js/commit/75e1a37bb5935d5d538ffcfce5b0073e1334d457))
+  - Fixed 304 status for fetchJson. ([c66d81e](https://github.com/ethers-io/ethers.js/commit/c66d81e96f7c9b0808f181085ffe1c92f6219d46))
+
+ethers/v5.0.0-beta.167 (2020-01-11 04:16)
+-----------------------------------------
+
+  - Fixed testcases for provider changes. ([90ed07c](https://github.com/ethers-io/ethers.js/commit/90ed07c74e7230ea0f02288b140d497d8b9779e0))
+  - Add support for legacy flat signatures with recid instead of normalized v. ([245cd0e](https://github.com/ethers-io/ethers.js/commit/245cd0e48e07eef35f5bf45ee7fe5ed5ef31338a))
+  - Fix TransactionResponse to have chainId instead of legacy networkId. ([#700](https://github.com/ethers-io/ethers.js/issues/700); [72b3bc9](https://github.com/ethers-io/ethers.js/commit/72b3bc9909074893038c768f3da1564ed96a6a20))
+  - Fixed splitSignature computing wrong v for BytesLike. ([#700](https://github.com/ethers-io/ethers.js/issues/700); [4151c0e](https://github.com/ethers-io/ethers.js/commit/4151c0eacd22287e2369a8656ffa00359db6f84b))
+  - Added dist files for hardware-wallets. ([c846649](https://github.com/ethers-io/ethers.js/commit/c84664953d2f50ee0d704a8aa18fe6c08668dabb))
+  - Browser support (with dist files) for Ledger. ([6f7fbf3](https://github.com/ethers-io/ethers.js/commit/6f7fbf3858c82417933a5e5595a919c0ec0487c7))
+
+ethers/v5.0.0-beta.166 (2020-01-10 03:09)
+-----------------------------------------
+
+  - Relaxed joinSignature API to allow SignauteLike. ([602e6a8](https://github.com/ethers-io/ethers.js/commit/602e6a8973480299843a0158f75451a2c6aac749))
+  - Initial code drop of new hardware wallet package. ([2e8f5ca](https://github.com/ethers-io/ethers.js/commit/2e8f5ca7ed498261079da75713b18f3370dfd236))
+  - Added more docs. ([381a72d](https://github.com/ethers-io/ethers.js/commit/381a72ddaa7fb59ef2ded84d228296d693df05c3))
+
+ethers/v5.0.0-beta.165 (2020-01-09 03:31)
+-----------------------------------------
+
+  - Fixed require resolution for CLI scripts. ([c04f9a7](https://github.com/ethers-io/ethers.js/commit/c04f9a7fff727bb04a4aa3a0fa05fd5cd8e795a6))
+  - Added new URLs for default ETC (and ETC testnets) providers. ([#351](https://github.com/ethers-io/ethers.js/issues/351); [3c184ac](https://github.com/ethers-io/ethers.js/commit/3c184ace21aafbb27f4d44cce1bb738af899d59f))
+
+ethers/v5.0.0-beta.164 (2020-01-07 19:57)
+-----------------------------------------
+
+  - Use better Description typing. ([2d5492c](https://github.com/ethers-io/ethers.js/commit/2d5492cd2ee722c818c249244af7b5bea05d67b0))
+  - Better property access on ABI decoded results. ([#698](https://github.com/ethers-io/ethers.js/issues/698); [13f50ab](https://github.com/ethers-io/ethers.js/commit/13f50abd847f7ddcc7e54c102da54e2d23b86fae))
+  - Better typing support for Description. ([d0f4642](https://github.com/ethers-io/ethers.js/commit/d0f4642f6d2c9f5119f1910a0082894c60e81191))
+  - Fixed resolveName when name is an address with an invalid checksum. ([#694](https://github.com/ethers-io/ethers.js/issues/694); [1e72fc7](https://github.com/ethers-io/ethers.js/commit/1e72fc7d6f7c3be4410dbdcfbab9a0463ceb52bd))
+
+ethers/v5.0.0-beta.163 (2020-01-06 18:57)
+-----------------------------------------
+
+  - Added function to generate CREATE2 addresses. ([#697](https://github.com/ethers-io/ethers.js/issues/697); [eb26a6d](https://github.com/ethers-io/ethers.js/commit/eb26a6d95022a241c44f859e7b2f29646afb4914))
+  - Force constructor name to be null (instead of undefined). ([a648f2b](https://github.com/ethers-io/ethers.js/commit/a648f2bd1e5e52a3662896f04fe7025884866972))
+  - Added documentation uploading script. ([e593aba](https://github.com/ethers-io/ethers.js/commit/e593aba2946c98820b0c2edf9c5dab6cb30c7402))
+  - Added Czech wordlist to default wordlists export. ([#691](https://github.com/ethers-io/ethers.js/issues/691); [5724fa5](https://github.com/ethers-io/ethers.js/commit/5724fa5d9c6fe73f14ec8bdea1f7226a222537ef))
+  - Added Czech BIP-39 wordlist. ([#691](https://github.com/ethers-io/ethers.js/issues/691); [f54f06b](https://github.com/ethers-io/ethers.js/commit/f54f06b5c8092997fd3c9055d69a3e0796ce44f3))
+  - Updated README. ([e809ead](https://github.com/ethers-io/ethers.js/commit/e809eadf8d608cd8c8a78c08a2e3547dd09156cf))
+  - Updating docs. ([184c459](https://github.com/ethers-io/ethers.js/commit/184c459fab0d089a8a879584b72e5eb3560b33ce))
+  - Merge branch 'yuetloo-ethers-v5-beta' into ethers-v5-beta ([06cafe3](https://github.com/ethers-io/ethers.js/commit/06cafe3437ef129b47f5f9c02f4759f2c4854d3c))
+  - 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 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))
+
+ethers/v5.0.0-beta.161 (2019-11-23 21:43)
+-----------------------------------------
+
+  - Updated dist files (sorted package.json to reduce package version change chatter). ([f308ba3](https://github.com/ethers-io/ethers.js/commit/f308ba3540ed0d282d099456d0369873ad9596b0))
+  - Stubs for adding throttle support. ([2f0e679](https://github.com/ethers-io/ethers.js/commit/2f0e679f0bc81bf901cf60a79e50f9715cddec5a))
+  - Refactor wordlists. ([abab9f6](https://github.com/ethers-io/ethers.js/commit/abab9f6aa27d1870d1053e7caa951408b86c454d))
+  - Browser testcases work again. ([c11c2e2](https://github.com/ethers-io/ethers.js/commit/c11c2e2e3376a6764f07ed443245823f2792b8cc))
+  - Added dist files for non-English wordlists. ([3d75c52](https://github.com/ethers-io/ethers.js/commit/3d75c52dac668af5eeede3e7764dadd3055a0707))
+  - Sync GitHub issue cache. ([29f0e9d](https://github.com/ethers-io/ethers.js/commit/29f0e9dd627a7b4b7f772300497f27718c9ecc7b))
+
+ethers/v5.0.0-beta.160 (2019-11-20 18:36)
+-----------------------------------------
+
+  - Updated API in testcases. ([3ab3733](https://github.com/ethers-io/ethers.js/commit/3ab373334c75800f2b20b6639ed8eb1b11e453ef))
+  - Fixed scrypt import in ESM build. ([b72ef27](https://github.com/ethers-io/ethers.js/commit/b72ef27b2a8f9941fb9d79122ec449fed9d2464d))
+  - Fixed null apiKey problem for InfuraProvider. ([e518151](https://github.com/ethers-io/ethers.js/commit/e51815150912d10e2734707986b10b37c87d6d12))
+  - Added support for sighash-style tuple parsing. ([19aaade](https://github.com/ethers-io/ethers.js/commit/19aaade9c62510012cfd50ae487ebd1705a28678))
+  - Fixed solc imports for cli. ([c35ddaf](https://github.com/ethers-io/ethers.js/commit/c35ddaf646efa25e738fee604585a0a7af45b206))
+  - Added nonce manager to experimental index. ([8316406](https://github.com/ethers-io/ethers.js/commit/8316406977ea26ca2044d16f7b3bb6ba21ef5b43))
+  - Removing NodesmithProvider from default provider as it is being discontinued. ([01ca350](https://github.com/ethers-io/ethers.js/commit/01ca35036ca11a47f60890e5cae62e46a00f3da8))
+  - Moved bare ABI named functions and events from Interface into Contracts to simplify other consumers of Interface. ([da8ca2e](https://github.com/ethers-io/ethers.js/commit/da8ca2e8bc982fc3ea0343bb3c593a485ca1fef0))
+  - Added support for complex API keys including support for INFURA project secrets. ([#464](https://github.com/ethers-io/ethers.js/issues/464), [#651](https://github.com/ethers-io/ethers.js/issues/651), [#652](https://github.com/ethers-io/ethers.js/issues/652); [1ec5804](https://github.com/ethers-io/ethers.js/commit/1ec5804bd460f6948d4813469fdc7bf739baa6a6))
+  - Migrated to scrypt-js v3. ([75895fa](https://github.com/ethers-io/ethers.js/commit/75895fa1491e7542c755a102f4e4c190685fd2b6))
+  - Moved getDefaultProvider to providers package. ([51e4ef2](https://github.com/ethers-io/ethers.js/commit/51e4ef2b45b83a8d82923600a2fac544d70b0807))
+  - Migrating providers to modern syntax and scoping. ([#634](https://github.com/ethers-io/ethers.js/issues/634); [e1509a6](https://github.com/ethers-io/ethers.js/commit/e1509a6326dd2cb8bf7ed64b82dd3947b768a314))
+  - Migrating to modern syntax and scoping. ([#634](https://github.com/ethers-io/ethers.js/issues/634); [394c36c](https://github.com/ethers-io/ethers.js/commit/394c36cad43f229a94c72d21f94d1c7982a887a1))
+  - Added provider property to Web3Provider. ([#641](https://github.com/ethers-io/ethers.js/issues/641); [1d4f90a](https://github.com/ethers-io/ethers.js/commit/1d4f90a958da6364117353850d62535c9702abd2))
+  - Updated GitHub issue cache. ([494381a](https://github.com/ethers-io/ethers.js/commit/494381a6284cc8ed90bd8002d42a6b6d94dc1200))
+  - Force deploy receipt to address to be null. ([#573](https://github.com/ethers-io/ethers.js/issues/573); [d9d438a](https://github.com/ethers-io/ethers.js/commit/d9d438a119bb11f8516fc9cf02c534ab3816fcb3))
+  - Updated experimental NonceManager. ([3d514c8](https://github.com/ethers-io/ethers.js/commit/3d514c8dbb94e1c4ce5754463e683dd9dbe7c0aa))
+  - Fixed typo in error message. ([28339a9](https://github.com/ethers-io/ethers.js/commit/28339a9c8585392086da159a46df4afb8958915c))
+  - Added GitHub issue caching. ([fea867a](https://github.com/ethers-io/ethers.js/commit/fea867a206f007a17718396e486883a5e718aa29))
+
+ethers/v5.0.0-beta.159 (2019-10-17 01:08)
+-----------------------------------------
+
+  - Removing TypeScript build files from npm to fix excessive package diffs.
+  - Fixed getBlock for blockhashes with a leading 0. ([#629](https://github.com/ethers-io/ethers.js/issues/629); [12cfc59](https://github.com/ethers-io/ethers.js/commit/12cfc599656d7e3a6d3d9aa4e468592865a711cc))
+
+ethers/v5.0.0-beta.158 (2019-09-28 01:56)
+-----------------------------------------
+
+  - Added less-common, but useful, coding functions to Interface. ([778eb3b](https://github.com/ethers-io/ethers.js/commit/778eb3b425b5ab5b23d28e75be92feccd0fc56bc))
+  - Add response handling and 304 support to fetchJson. ([3d25882](https://github.com/ethers-io/ethers.js/commit/3d25882d6bf689740506b9c569f6e0d30da6f6a5))
+  - Allow numeric values in a transaction to be odd-lengthed hexstrings. ([#614](https://github.com/ethers-io/ethers.js/issues/614); [a12030a](https://github.com/ethers-io/ethers.js/commit/a12030ad29aa13c02aa75d9e0860f4986a0043b4))
+  - Simpler crypt for admin tools. ([828c8cf](https://github.com/ethers-io/ethers.js/commit/828c8cfd419ac4f8d11d978c2e2ff83eba5ae909))
+
+ethers/v5.0.0-beta.157 (2019-09-08 02:43)
+-----------------------------------------
+
+  - Fixed getContractAddress for odd-length hex values. ([#572](https://github.com/ethers-io/ethers.js/issues/572); [751793e](https://github.com/ethers-io/ethers.js/commit/751793ea25183d54d7fc4c610a789608f91c062e))
+  - Fixed typo in error message. ([#592](https://github.com/ethers-io/ethers.js/issues/592); [6f4291f](https://github.com/ethers-io/ethers.js/commit/6f4291f65f0ea20c65fef7fd7b09b4d5bf5f0dcd))
+  - Fixed typo in error message. ([#580](https://github.com/ethers-io/ethers.js/issues/580); [9c63b4a](https://github.com/ethers-io/ethers.js/commit/9c63b4a7535f423a802bb1c17c325ce968987349))
+  - Fixed typo in error message. ([#574](https://github.com/ethers-io/ethers.js/issues/574); [22a2673](https://github.com/ethers-io/ethers.js/commit/22a26736cc332fe6e896c9d2707cc99ceee2fb10))
+
+ethers/v5.0.0-beta.156 (2019-09-06 17:56)
+-----------------------------------------
+
+  - Removed export star to fix UMD dist file. ([4c17c4d](https://github.com/ethers-io/ethers.js/commit/4c17c4db0455e1b89fd597c4c929cdc36aa3d90d))
+  - Updated TypeScript version. ([e8028d0](https://github.com/ethers-io/ethers.js/commit/e8028d0e73368257b76b394bb8e2bf63f8aecd71))
+  - Fixed test suites and reporter. ([1e0ed4e](https://github.com/ethers-io/ethers.js/commit/1e0ed4e99a22a27fe5057336f8cb320809768f3e))
+  - Added lock-versions admin tool. ([2187604](https://github.com/ethers-io/ethers.js/commit/21876049137644af2b3afa31120ee95d032843a8))
+  - Updated packages with version lock and moved types. ([85b4db7](https://github.com/ethers-io/ethers.js/commit/85b4db7d6db37b853f11a90cf4648c34404edcf9))
+  - Fixed typo in error message. ([#592](https://github.com/ethers-io/ethers.js/issues/592); [019c1fc](https://github.com/ethers-io/ethers.js/commit/019c1fc7089b3da2d7bd41c933b6c6bc35c8dade))
+  - Fixed build process to re-target browser field to ES version. ([3a91e91](https://github.com/ethers-io/ethers.js/commit/3a91e91df56c1ef6cf096c0322f74fd5060891e0))
+  - Major overhaul in compilation to enable ES6 module generation. ([73a0077](https://github.com/ethers-io/ethers.js/commit/73a0077fd38c6ae79f33a9d4d3cc128a904b4a6c))
+  - Updated some of the flatworm docs. ([81fd942](https://github.com/ethers-io/ethers.js/commit/81fd9428cab4be7eee7ddeb564bf91f282cae475))
+  - Fixed package descriptions. ([#561](https://github.com/ethers-io/ethers.js/issues/561); [ebfca98](https://github.com/ethers-io/ethers.js/commit/ebfca98dc276d6f6ca6961632635e8203bb17645))
+
+ethers/v5.0.0-beta.155 (2019-08-22 17:11)
+-----------------------------------------
+
+  - Added Wrapped Ether and Token transfers to CLI. ([c031a13](https://github.com/ethers-io/ethers.js/commit/c031a1336815923bae85d9982dba0985a79cfaed))
+  - Fixed sendTransaction and use median gas price in FallbackProvider. ([07e1599](https://github.com/ethers-io/ethers.js/commit/07e15993ba181cfbff987778d158dbde6bb84de2))
+  - Port optional Secret Storage wallet address to v5. ([#582](https://github.com/ethers-io/ethers.js/issues/582); [a12d60d](https://github.com/ethers-io/ethers.js/commit/a12d60d722dfcf998a2e06eba5e46390d7d442e5))
+  - Updated flatworm docs output. ([8745a81](https://github.com/ethers-io/ethers.js/commit/8745a81b11b710036ddb546308c13958be1affb9))
+  - Added initial flatworm documentation stubs. ([0333a76](https://github.com/ethers-io/ethers.js/commit/0333a76f4ff382b5b59b24c672b702721e7a386a))
+
+ethers/v5.0.0-beta.154 (2019-08-21 01:51)
+-----------------------------------------
+
+  - Use safe transfer for ENS in CLI. ([b7494d8](https://github.com/ethers-io/ethers.js/commit/b7494d8618001797a4e856f3d1886273897e6ba4))
+  - Fixed quorum-matching logic for FallbackProvider. ([b304ec1](https://github.com/ethers-io/ethers.js/commit/b304ec1f008ec5301c0dbd1a493d790fe3528512))
+  - Added CloudflareProvider. ([#587](https://github.com/ethers-io/ethers.js/issues/587); [621313d](https://github.com/ethers-io/ethers.js/commit/621313d2a697bc6e1dd25eb5b08d67e832a28d05))
+  - Added receipt to CALL_EXCEPTION errors. ([724c32e](https://github.com/ethers-io/ethers.js/commit/724c32e8c08b55404594f263e52babb0550a15b8))
+
+ethers/v5.0.0-beta.153 (2019-08-06 19:15)
+-----------------------------------------
+
+  - Updated gas estimate failure messaging to include that the tx may simple be causing a revert. ([edb26b1](https://github.com/ethers-io/ethers.js/commit/edb26b16354afd707e5d03e174c4cc809b951c4f))
+  - Additional sanity checks in ethers-ens. ([de4b2a4](https://github.com/ethers-io/ethers.js/commit/de4b2a449ca3a49807c8bedb3e21e8e8d71e63fc))
+  - Fix bug in --wait for CLI. ([9977c9f](https://github.com/ethers-io/ethers.js/commit/9977c9f66a7007dcc1963128c88c584b6b6c064b))
+  - Added content-hash support to ENS CLI. ([7dfef46](https://github.com/ethers-io/ethers.js/commit/7dfef463f83a9190d1b89cf81e0fb692da3dd813))
+
+ethers/v5.0.0-beta.152 (2019-08-05 14:37)
+-----------------------------------------
+
+  - Using CLI --wait instead of custom Plugin flag for ethers-ens. ([19ee2b5](https://github.com/ethers-io/ethers.js/commit/19ee2b516005b2c35b846f19457ec9bbfa0c283b))
+  - Added --wait as a general flag to CLI. ([7640292](https://github.com/ethers-io/ethers.js/commit/7640292ac8b7b9e6de3ad6699d23e2debf26cc1b))
+  - Added migrate-registrar and transfer to ENS CLI. ([31e8e1b](https://github.com/ethers-io/ethers.js/commit/31e8e1b0520bc8be390fbf7e2b473c36a8649eb3))
+  - Include data in the CLI transaction dump. ([53bd96a](https://github.com/ethers-io/ethers.js/commit/53bd96a9f675233906033290f1e0c71ca4e9d389))
+  - Better errors on gas estimation failure. ([0e6b810](https://github.com/ethers-io/ethers.js/commit/0e6b810def390309240508a99b2cf0736848dedd))
+
+ethers/v5.0.0-beta.151 (2019-08-05 14:29)
+-----------------------------------------
+
+  - Added package name prefix to all _version for Logger. ([692589d](https://github.com/ethers-io/ethers.js/commit/692589db54cbca10a2a453e9a1801a8612056559))
+
+ethers/v5.0.0-beta.150 (2019-08-03 01:07)
+-----------------------------------------
+
+  - Fixed old references to errors package. ([1cabce7](https://github.com/ethers-io/ethers.js/commit/1cabce7e1c23b15cc2b630c0b403dd72d815a5ba))
+  - Added generation scripts for Table A.1 for stringprep. ([#42](https://github.com/ethers-io/ethers.js/issues/42); [b21681a](https://github.com/ethers-io/ethers.js/commit/b21681a7f4292b0e77315caad3a59fe814e9292b))
+
+ethers/v5.0.0-beta.149 (2019-08-03 00:45)
+-----------------------------------------
+
+  - Fixed some case-folding and added Table A.1 for IDNA. ([#42](https://github.com/ethers-io/ethers.js/issues/42); [f955dca](https://github.com/ethers-io/ethers.js/commit/f955dca417a6f86690cf33a81b08baa99e1b1a5c))
+  - Removed references to legacy errors pacakge and updated umbrella pacakge. ([c09de16](https://github.com/ethers-io/ethers.js/commit/c09de163473c361cac11ddef9ec852f4cbb7d8e3))
+  - Updated admin module to use new fetchJson. ([226c100](https://github.com/ethers-io/ethers.js/commit/226c100c72c3fcb0c0e3b62be5f579fd9cc4c904))
+  - Updated dist files. ([8354c3f](https://github.com/ethers-io/ethers.js/commit/8354c3f9fe5487f21acaaeccd4450d9a5d495bc1))
+  - Full case-folding for IDNA in namehash. ([0af95f4](https://github.com/ethers-io/ethers.js/commit/0af95f4a655106e67c2ba8f445af88c9e9e24339))
+  - Deprecating errors for logger. ([0b224e8](https://github.com/ethers-io/ethers.js/commit/0b224e8fb5811cd06727063c909ca1e1e5cde57e))
+  - More consistent debug events for Providers. ([e8f28b5](https://github.com/ethers-io/ethers.js/commit/e8f28b55d7dd62e29f03628232ffe7c75dc811b5))
+
+ethers/v5.0.0-beta.148 (2019-07-27 18:56)
+-----------------------------------------
+
+  - Initial drop of new ENS CLI tool. ([c3c65b2](https://github.com/ethers-io/ethers.js/commit/c3c65b2fa19e117d6433c2e0b3d20decfe506c74))
+  - Added TypeScript tool support for functions with multiple outputs. ([6de4a5d](https://github.com/ethers-io/ethers.js/commit/6de4a5d8a9d114c4c33c58f8a304b60e7370eeff))
+  - Added CLI support for stand-alone (no sub-command) tools. ([b67b121](https://github.com/ethers-io/ethers.js/commit/b67b12123996f1aaf7cbe3c8648fd85a22d6674e))
+  - Make utils.resolveProperties preserve object parameter order. ([74dbc28](https://github.com/ethers-io/ethers.js/commit/74dbc281ede042c5eeaa7b45150b215dea860a88))
+  - Added initial IDNA support for full UTF-8 support in namehash. ([#42](https://github.com/ethers-io/ethers.js/issues/42); [28eb38e](https://github.com/ethers-io/ethers.js/commit/28eb38ee703288aaad9f730b2d93fe3aeea7ada6))
+
+ethers/v5.0.0-beta.147 (2019-07-23 01:04)
+-----------------------------------------
+
+  - Use the CLI solc instead of solc directly for ABI testcase generation. ([99c7b1c](https://github.com/ethers-io/ethers.js/commit/99c7b1ca94382490b9757fd51375a7ad4259b831))
+  - Added experimental UTF-8 functions for escaping non-ascii strings. ([b132e32](https://github.com/ethers-io/ethers.js/commit/b132e32172c9d63e59209628dadd5796dd6291c8))
+  - Bump Solidity version in CLI to 0.5.10. ([6005248](https://github.com/ethers-io/ethers.js/commit/600524842e1a4b857e8428a45c0c7d1baa0624ee))
+
+ethers/v5.0.0-beta.146 (2019-07-20 21:06)
+-----------------------------------------
+
+  - Keep extra filter topics when using Frgment filters in Contracts. ([efaafb2](https://github.com/ethers-io/ethers.js/commit/efaafb203feaf703de803df7e346652372e9fb75))
+  - Updated package.json description for Contract package. ([#561](https://github.com/ethers-io/ethers.js/issues/561); [d88ee45](https://github.com/ethers-io/ethers.js/commit/d88ee45937b3484b68f72e3f72ad6c29556c984b))
+
+ethers/v5.0.0-beta.145 (2019-07-20 20:12)
+-----------------------------------------
+
+  - Export provider.Formatter. ([#562](https://github.com/ethers-io/ethers.js/issues/562); [083fd76](https://github.com/ethers-io/ethers.js/commit/083fd76a3a638ec16d5f9bf652101e5a150c7347))
+  - Update CLI to use new Fragment.format style. ([9a41199](https://github.com/ethers-io/ethers.js/commit/9a4119910b07d1ad61bafafb38ac18a9dae1d9ed))
+  - Added FormatTypes to utils. ([a05027c](https://github.com/ethers-io/ethers.js/commit/a05027c744102bbe1be5e13dd89b9c1e64b3b526))
+  - Added experimental memory-hard password scheme for password-protected mnemonics to the CLI. ([5877418](https://github.com/ethers-io/ethers.js/commit/5877418de94256a69fdf2ad466ba579309b9dee8))
+  - Added more flexible output options to fragment.format (JSON and minimal) and better JSON object parsing. ([e9558c8](https://github.com/ethers-io/ethers.js/commit/e9558c8d4fe6df889f4d7ba6ac6448aa543ef99d))
+
+ethers/v5.0.0-beta.144 (2019-07-09 17:28)
+-----------------------------------------
+
+  - Make mnemonic phrases case agnostic. ([#557](https://github.com/ethers-io/ethers.js/issues/557); [e4423b7](https://github.com/ethers-io/ethers.js/commit/e4423b7a277e7e1be1c02d345d4ab1eab484c9b8))
+
+ethers/v5.0.0-beta.143 (2019-07-02 16:12)
+-----------------------------------------
+
+  - Adding more support for offline signing in the CLI. ([9cc269c](https://github.com/ethers-io/ethers.js/commit/9cc269ceb5d33b2d88542d4bc6771279f729e733))
+  - Allow providers to prepare their Network object. ([6484908](https://github.com/ethers-io/ethers.js/commit/6484908cb25dd35e5d98b2672dca72ed3f30cbe1))
+  - Export BIP-44 default path in ethers.utils. ([04bdf45](https://github.com/ethers-io/ethers.js/commit/04bdf456eb07aa72872265e0ee01e3231d2b6cf1))
+
+ethers/v5.0.0-beta.142 (2019-06-28 16:13)
+-----------------------------------------
+
+  - Do not require a Signer for contract.populateTransaction. ([0e78386](https://github.com/ethers-io/ethers.js/commit/0e78386a08d3d3a0a98c8d03cd665b8992ab3ea2))
+  - Bumping version of solc to 0.5.9. ([e2da447](https://github.com/ethers-io/ethers.js/commit/e2da447c7bc05937966bc4909c47291e4819d2a9))
+
+ethers/v5.0.0-beta.141 (2019-06-24 21:25)
+-----------------------------------------
+
+  - Fix non-ES6 import in keccak256. ([5eb393d](https://github.com/ethers-io/ethers.js/commit/5eb393d828328b34567566d3c0d622b4aef1e202))
+  - Refactored wordlist exports to export Wordlist directly. ([746d255](https://github.com/ethers-io/ethers.js/commit/746d255b741844b615583b2de3ffd07631b4e872))
+
+ethers/v5.0.0-beta.140 (2019-06-12 01:25)
+-----------------------------------------
+
+  - Move from node-fetch to cross-fetch; better browser fallback implementation. ([826ffbc](https://github.com/ethers-io/ethers.js/commit/826ffbc7c4ed1c301f30e6f264eedeaf3c243ca8))
+  - Added getStatic with support for inheritance of static methods. ([5e4535e](https://github.com/ethers-io/ethers.js/commit/5e4535e939fdb9d9d23bd14b3e2590873d3eb508))
+  - Fixed node-fetch for Safari (todo: push this fix upstream to node-fetch). ([7164e51](https://github.com/ethers-io/ethers.js/commit/7164e51131215ae3201b49f8c7f5ade8cbd8a420))
+  - Migrated XMLHttpRequest to fetch API. ([#506](https://github.com/ethers-io/ethers.js/issues/506); [62201c5](https://github.com/ethers-io/ethers.js/commit/62201c5eebc52e9723dbbb2cc64823155ce1e0f9))
+
+ethers/v5.0.0-beta.139 (2019-06-11 17:55)
+-----------------------------------------
+
+  - Removed freeze option from deepCopy; all properties are read-only and only objects may have new properties added. ([1bc792d](https://github.com/ethers-io/ethers.js/commit/1bc792d9dcc6a06a1be4fc5e5b9a538a3f6b7ada))
+  - Moved away from isNamedInstance which breaks after Browserify name mangling. ([257d67c](https://github.com/ethers-io/ethers.js/commit/257d67c9625fa237bcfb3d651c49aa3b79175cae))
+  - Expose poll function in utils. ([#512](https://github.com/ethers-io/ethers.js/issues/512); [e6f6383](https://github.com/ethers-io/ethers.js/commit/e6f6383346818fa67423f1f20450e011242eb554))
+  - Make TransactionResponse hash required. ([#537](https://github.com/ethers-io/ethers.js/issues/537); [095c1fe](https://github.com/ethers-io/ethers.js/commit/095c1fe579068a3204ea0d1bc1893f293f61e719))
+
+ethers/v5.0.0-beta.138 (2019-06-04 16:05)
+-----------------------------------------
+
+  - Fixed INFURA project ID checking. ([#534](https://github.com/ethers-io/ethers.js/issues/534); [5bf763f](https://github.com/ethers-io/ethers.js/commit/5bf763fe2307e8570ab5e91e30c43e2e5731fc39))
+
+ethers/v5.0.0-beta.137 (2019-06-01 14:06)
+-----------------------------------------
+
+  - Fixed invalid arrayify value in browser for SHA2-HMAC. ([#530](https://github.com/ethers-io/ethers.js/issues/530); [c4a494b](https://github.com/ethers-io/ethers.js/commit/c4a494b528f2e5f706c159d916d8ff0ffd96a211))
+  - Fix event and function fragment formatting. ([a2d4b29](https://github.com/ethers-io/ethers.js/commit/a2d4b2907184d9480a72fe6f67652489074af86e))
+  - Fixed default JsonRpcSigner. ([#532](https://github.com/ethers-io/ethers.js/issues/532); [5ba6a61](https://github.com/ethers-io/ethers.js/commit/5ba6a616a6f969b1f28f8c6367c21488f497a7ae))
+  - Added changelog management to update-versions. ([4a3f719](https://github.com/ethers-io/ethers.js/commit/4a3f7190dc04275030d313289e1ba6a2b31407ec))
+
+ethers/v5.0.0-beta.136
+----------------------
+
+  - Added queryFilter to Contracts. ([#463](https://github.com/ethers-io/ethers.js/issues/463); [eea53bb](https://github.com/ethers-io/ethers.js/commit/eea53bb1be29ad2bd1b229a13c85b12be264b019))
+  - Allow storage class in Human-Readable ABI. ([#476](https://github.com/ethers-io/ethers.js/issues/476); [cf39adb](https://github.com/ethers-io/ethers.js/commit/cf39adb09020ca0393e028b330bfd07fb4869236))
+  - Track per-provider JSON-RPC ID in JsonRpcProvider. ([#337](https://github.com/ethers-io/ethers.js/issues/337), [#489](https://github.com/ethers-io/ethers.js/issues/489); [044554b](https://github.com/ethers-io/ethers.js/commit/044554b58525d1677646a74119f86ea867a06d1e))
+  - Fixed typo in error message. ([#470](https://github.com/ethers-io/ethers.js/issues/470); [47d92ae](https://github.com/ethers-io/ethers.js/commit/47d92aeff02cacfb26793850c7faef7cb21ce4cf))
+
+ethers/v5.0.0-beta.135
+----------------------
+
+  - Better error message for unconfigured ENS names. ([#504](https://github.com/ethers-io/ethers.js/issues/504); [3cbc4b4](https://github.com/ethers-io/ethers.js/commit/3cbc4b462262ba61fa7d99a7a12e7bbf8049afb1))
+  - Fixed contract events. ([#404](https://github.com/ethers-io/ethers.js/issues/404); [8cdda37](https://github.com/ethers-io/ethers.js/commit/8cdda37095df28f828ccd2ac5437ccb6541b16cc))
+  - Updated license for BaseX to include original authors; was only included in the source. ([03c9725](https://github.com/ethers-io/ethers.js/commit/03c97259c46de10dbe6ce62921de2f32ffff0522))
+

README.md

@@ -1,17 +1,35 @@
 The Ethers Project
 ==================
 
-**EXPERIMENTAL**
+[![npm (tag)](https://img.shields.io/npm/v/ethers)](https://www.npmjs.com/package/ethers)
+[![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/v5/)
+- 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-marketing, 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
@@ -20,13 +38,13 @@ Installing
 **node.js**
 
 ```
-/home/ricmoo/some_project> npm install --save ethers@next
+/home/ricmoo/some_project> npm install --save ethers
 ```
 
 **browser (UMD)**
 
 ```
-<script src="https://cdn.ethers.io/lib/ethers-5.0.umd.min.js" type="text/javasctipt">
+<script src="https://cdn.ethers.io/lib/ethers-5.0.umd.min.js" type="text/javascript">
 </script>
 ```
 
@@ -39,57 +57,32 @@ Installing
 ```
 
 
+Documentation
+-------------
+
+Browse the [documentation](https://docs.ethers.io/v5/) online:
+
+- [Getting Started](https://docs.ethers.io/v5/getting-started/)
+- [Full API Documentation](https://docs.ethers.io/v5/api/)
+- [Various Ethereum Articles](https://blog.ricmoo.com/)
+
+Or browse the entire documentation as a [single page](https://docs.ethers.io/v5/single-page/) to make searching easier.
+
+
 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
+ancillary packages, which can be included by those who need them, while not bloating
 everyone else with packages they do not need.
 
-We will keep a list of useful pacakges here.
+We will keep a list of useful packages 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

SECURITY.md

@@ -0,0 +1,33 @@
+# Security Policy
+
+## Supported Versions
+
+Maintaining multiple versions of the library is quite time consuming, so
+the majority of the effort is focused on the latest major release.
+
+If you do require a version outside of this chart updated with patch fix,
+please [contact me](mailto:github@ricmoo.com).
+
+| Version | Supported                                  | Initial Release   |
+| ------- | ------------------------------------------ | ----------------- |
+| 5.0.x   | :white_check_mark:                         | 2020-06-12        |
+| 4.0.x   | :white_check_mark: (security patches only) | 2018-10-01        |
+| 3.0.x   | :x:                                        | 2018-03-05        |
+| 2.2.x   | :x:                                        | 2018-01-11        |
+| 2.1.x   | :x:                                        | 2017-05-22        |
+| 2.0.x   | :x:                                        | 2017-04-05        |
+| 1.0.x   | :x:                                        | 2016-08-23        |
+| 0.0.x   | :x:                                        | 2016-07-14        |
+
+
+## Reporting a Vulnerability
+
+If you identify a security vulnerability with this library (or any dependency),
+please do not hesitate to contact [github@ricmoo.com](mailto:github@ricmoo.com)
+immediately.
+
+I try to respond within the same day and will address any concern as quickly
+as possible (including code fixes and publishing to NPM).
+
+Any vulnerability will also be published to this file, along with credits,
+pertinent information and links to fixes.

admin/cmds/lock-versions.js

@@ -23,15 +23,23 @@ const { log } = require("../log");
             const deps = info[key];
             if (!deps) { return; }
             Object.keys(deps).forEach((name) => {
-                if (versions[name] == null) { return; }
-                const value = ">=" + versions[name];
-                if (value !== deps[name])
-                if (!deps[name]) { return; }
+                // Not a package in this monorepoa
+                const version = versions[name];
+                if (version == null) { return; }
+
+                const value = ((version.indexOf("beta") !== -1) ? ">=": "^") + version;
+
+                // No change
+                if (value === deps[name]) { return; }
+
+                // Show a header for the first change
                 if (!shown) {
                     log(`<bold:Locking ${ info.name }:>`);
                     shown = true;
                 }
-                log(`    <green:${ name }>: ${ deps[name] } => <bold:${ value.substring(2) }>`);
+
+                // Show the locked version
+                log(`    <green:${ name }>: ${ deps[name] } => <bold:${ value.replace(">", "&gt;") }>`);
                 deps[name] = value;
             });
         });

admin/cmds/publish.js

@@ -1,5 +1,10 @@
 "use strict";
 
+const { basename, resolve } = require("path");
+const fs = require("fs");
+
+const AWS = require('aws-sdk');
+
 const config = require("../config");
 
 const { ChangelogPath, latestChange } = require("../changelog");
@@ -10,7 +15,7 @@ const { getPackageVersion, publish } = require("../npm");
 const { log } = require("../log");
 
 const USER_AGENT = "ethers-dist@0.0.0";
-const TAG = "next";
+const TAG = "latest";
 
 
 let dirnames = getOrdered();
@@ -33,6 +38,45 @@ if (process.argv.length > 2) {
     dirnames = dirnames.filter((dirname) => (filter.indexOf(dirname) >= 0));
 }
 
+
+function putObject(s3, info) {
+    return new Promise(function(resolve, reject) {
+        s3.putObject(info, function(error, data) {
+            if (error) {
+                reject(error);
+            } else {
+                resolve({
+                    name: info.Key,
+                    hash: data.ETag.replace(/"/g, '')
+                });
+            }
+        });
+    });
+}
+
+function invalidate(cloudfront, distributionId) {
+    return new Promise((resolve, reject) => {
+        cloudfront.createInvalidation({
+            DistributionId: distributionId,
+            InvalidationBatch: {
+                CallerReference: `${ USER_AGENT }-${ parseInt(((new Date()).getTime()) / 1000) }`,
+                Paths: {
+                    Quantity: "1",
+                    Items: [
+                        "/\*"
+                    ]
+                }
+            }
+        }, function(error, data) {
+            if (error) {
+                console.log(error);
+                return;
+            }
+            resolve(data.Invalidation.Id);
+        });
+    });
+}
+
 (async function() {
     let token = null;
 
@@ -75,10 +119,7 @@ if (process.argv.length > 2) {
         let dirname = dirnames[i];
 
         if (dirname === "ethers") {
-            options.tag = "next";
             includeEthers = true;
-        } else {
-            options.tag = "latest";
         }
 
         let info = loadPackage(dirname);
@@ -98,20 +139,72 @@ if (process.argv.length > 2) {
         log("  <green:Done.>");
     }
 
-    // Publish the GitHub release (currently beta)
-    const beta = true;
+    // Publish the GitHub release
+    const beta = false;
     if (includeEthers) {
 
-        // The password above already succeeded
-        const username = await config.get("github-user");
-        const password = await config.get("github-release");
-
         // Get the latest change from the changelog
         const change = latestChange();
 
-        // Publish the release
-        const link = await createRelease(username, password, change.version, change.title, change.content, beta, gitCommit);
-        log(`<bold:Published Release:> ${ link }`);
+        // Publish the release to GitHub
+        {
+            // The password above already succeeded
+            const username = await config.get("github-user");
+            const password = await config.get("github-release");
+
+
+            // Publish the release
+            const link = await createRelease(username, password, change.version, change.title, change.content, beta, gitCommit);
+            log(`<bold:Published Release:> ${ link }`);
+        }
+
+        // Upload the scripts to the CDN and refresh the edge caches
+        {
+            const awsAccessId = await config.get("aws-upload-scripts-accesskey");
+            const awsSecretKey = await config.get("aws-upload-scripts-secretkey");
+            const bucketName = await config.get("aws-upload-scripts-bucket");
+            const originRoot = await config.get("aws-upload-scripts-root");
+            const distributionId = await config.get("aws-upload-scripts-distribution-id");
+
+            const s3 = new AWS.S3({
+                apiVersion: '2006-03-01',
+                accessKeyId: awsAccessId,
+                secretAccessKey: awsSecretKey
+            });
+
+            // Upload the libs to ethers-v5.0 and ethers-5.0.x
+            const fileInfos = [
+                { filename: "packages/ethers/dist/ethers.esm.min.js", key: `ethers-${ change.version.substring(1) }.esm.min.js` },
+                { filename: "packages/ethers/dist/ethers.umd.min.js", key: `ethers-${ change.version.substring(1) }.umd.min.js` },
+                { filename: "packages/ethers/dist/ethers.esm.min.js", key: `ethers-5.0.esm.min.js` },
+                { filename: "packages/ethers/dist/ethers.umd.min.js", key: `ethers-5.0.umd.min.js` },
+            ];
+
+            for (let i = 0; i < fileInfos.length; i++) {
+                const fileInfo = fileInfos[i];
+                const status = await putObject(s3, {
+                    ACL: 'public-read',
+                    Body: fs.readFileSync(resolve(__dirname, "../../", fileInfo.filename)),
+                    Bucket: bucketName,
+                    ContentType: "application/javascript; charset=utf-8",
+                    Key: (originRoot + fileInfo.key)
+                });
+
+                log(`<bold:Uploaded :> https://cdn.ethers.io/lib/${ fileInfo.key }`);
+            }
+
+            // Flush the edge caches
+            {
+                const cloudfront = new AWS.CloudFront({
+                    //apiVersion: '2006-03-01',
+                    accessKeyId: awsAccessId,
+                    secretAccessKey: awsSecretKey
+                });
+
+                const invalidationId = await invalidate(cloudfront, distributionId);
+                log(`<bold:Invalidated Cache :> ${ invalidationId }`);
+            }
+        }
     }
 
 })();

admin/cmds/reset-build.js

@@ -1,5 +0,0 @@
-"use strict";
-
-const { setupBuild } = require("../build");
-
-setupBuild(false);

admin/cmds/serve-docs.js

@@ -0,0 +1,100 @@
+const fs = require("fs");
+const http = require("http");
+const path = require("path");
+
+function getMime(filename) {
+    const comps = filename.split('.');
+    const ext = comps[comps.length - 1];
+    switch (ext.toLowerCase()) {
+        case 'css':      return 'text/css';
+        case 'doctree':  return 'application/x-doctree';
+        case 'eot':      return 'application/vnd.ms-fontobject';
+        case 'gif':      return 'image/gif';
+        case 'html':     return 'text/html';
+        case 'js':       return 'application/javascript';
+        case 'jpg':      return 'image/jpeg';
+        case 'jpeg':     return 'image/jpeg';
+        case 'md':       return 'text/markdown';
+        case 'pickle':   return 'application/x-pickle';
+        case 'png':      return 'image/png';
+        case 'svg':      return 'image/svg+xml';
+        case 'ttf':      return 'application/x-font-ttf';
+        case 'txt':      return 'text/plain';
+        case 'woff':     return 'application/font-woff';
+    }
+    console.log('NO MIME', filename);
+    return undefined;
+}
+
+function start(root, options) {
+    if (root == null) { throw new Error("root required"); }
+    if (options == null) { options = { }; }
+    if (options.port == null) { options.port = 8000; }
+    root = path.resolve(root);
+
+    const server = http.createServer((req, resp) => {
+
+        // Follow redirects in options
+        if (options.redirects && options.redirects[req.url]) {
+            resp.writeHead(301, { Location: options.redirects[req.url] });
+            resp.end();
+            return;
+        }
+
+        let filename = path.resolve(root, "." + req.url);
+
+        // Make sure we aren't crawling out of our sandbox
+        if (req.url[0] !== "/" || filename.substring(0, filename.length) !== filename) {
+            resp.writeHead(403);
+            resp.end();
+            return;
+        }
+
+        try {
+            const stat = fs.statSync(filename);
+            if (stat.isDirectory()) {
+
+                // Redirect bare directory to its path (i.e. "/foo" => "/foo/")
+                if (req.url[req.url.length - 1] !== "/") {
+                    resp.writeHead(301, { Location: req.url + "/" });
+                    resp.end();
+                    return;
+                }
+
+                filename += "/index.html";
+            }
+
+            const content = fs.readFileSync(filename);
+
+            resp.writeHead(200, {
+                "Content-Length": content.length,
+                "Content-Type": getMime(filename)
+            });
+            resp.end(content);
+            return;
+
+        } catch (error) {
+            if (error.code === "ENOENT") {
+                resp.writeHead(404, { });
+                resp.end();
+                return;
+            }
+
+            resp.writeHead(500, { });
+            resp.end();
+            return;
+        }
+    });
+
+    server.listen(options.port, () => {
+        console.log(`Server running on: http://localhost:${ options.port }`);
+    });
+
+    return server;
+}
+
+start(path.resolve(__dirname, "../../docs"), {
+    redirects: {
+        "/": "/v5/"
+    }
+});

admin/cmds/set-option.js

@@ -1,37 +0,0 @@
-const { setupBuild } = require("../build");
-const { loadPackage, savePackage } = require("../local");
-
-const arg = process.argv[2];
-
-(async function() {
-    process.argv.slice(2).forEach((arg) => {
-        console.log("Setting Option:", arg);
-        switch(arg) {
-            case "esm":
-                setupBuild(true);
-                break;
-
-            case "cjs":
-                setupBuild(false);
-                break;
-
-            // This will remove the browser field entirely, so make sure
-            // to set esm of cjs first as they will restore the browser
-            // field
-            case "browser-lang-all": {
-                const info = loadPackage("wordlists");
-                delete info.browser;
-                savePackage("wordlists", info);
-                break;
-            }
-
-            default:
-                console.log("Unknown option:", arg);
-                return 1;
-      }
-    });
-    return 0;
-
-})().then((result) => {
-    process.exit(result);
-});

admin/cmds/update-depgraph.js

@@ -1,16 +0,0 @@
-"use stricT";
-
-const depgraph = require("../depgraph");
-const { log } = require("../log");
-const { loadJson, resolve, saveJson } = require("../utils");
-
-(async function() {
-    log(`<bold:Updating dependency-graph build order (tsconfig.project.json)...>`);
-    let ordered = depgraph.getOrdered(true);
-
-    let path = resolve("tsconfig.project.json")
-
-    let projectConfig = loadJson(path);
-    projectConfig.references = ordered.map((name) => ({ path: ("./packages/" + name) }));
-    saveJson(path, projectConfig);
-})();

admin/cmds/update-exports.js

@@ -1,30 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const { resolve } = require("path");
-
-const sourceEthers = fs.readFileSync(resolve(__dirname, "../../packages/ethers/src.ts/ethers.ts")).toString();
-const targets = sourceEthers.match(/export\s*{\s*((.|\s)*)}/)[1].trim();
-
-const output = `"use strict";
-
-// To modify this file, you must update ./admin/cmds/update-exports.js
-
-import * as ethers from "./ethers";
-
-try {
-    const anyGlobal = (window as any);
-
-    if (anyGlobal._ethers == null) {
-        anyGlobal._ethers = ethers;
-    }
-} catch (error) { }
-
-export { ethers };
-
-export {
-    ${ targets }
-} from "./ethers";
-`;
-
-fs.writeFileSync(resolve(__dirname, "../../packages/ethers/src.ts/index.ts"), output);

admin/cmds/update-versions.js

@@ -60,7 +60,7 @@ if (process.argv.length > 2) {
 
         // Bump the version if necessary
         if (info.version === npmInfo.version) {
-            let newVersion = semver.inc(info.version, "prerelease", "beta");
+            let newVersion = semver.inc(info.version, "patch");
 
             // Write out the _version.ts
             if (!info._ethers_nobuild) {

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));

admin/index.js

@@ -54,7 +54,7 @@ async function runDiff(dirnames) {
 
         // Bump the version if necessary
         if (info.version === npmInfo.version) {
-            info.version = semver.inc(info.version, "prerelease", "beta");
+            info.version = semver.inc(info.version, "patch");
         }
 
         console.log(colorify("<bold:Package>: ") + info.name);
@@ -176,7 +176,7 @@ async function runUpdate(dirnames) {
 
         // Bump the version if necessary
         if (info.version === npmInfo.version) {
-            let newVersion = semver.inc(info.version, "prerelease", "beta");
+            let newVersion = semver.inc(info.version, "patch");
 
             // Write out the _version.ts
             if (!info._ethers_skipPrepare) {

admin/npm.js

@@ -2,7 +2,7 @@
 
 const resolve = require("path").resolve;
 
-const npm = require("libnpm");
+const npmpub = require("libnpmpublish");
 const semver = require("semver");
 
 const local = require("./local");
@@ -60,7 +60,7 @@ async function getTarballHash(name, version) {
 
 async function _publish(info, tarball, options) {
     try {
-        let result = await npm.publish(info, tarball, options);
+        let result = await npmpub.publish(info, tarball, options);
         return result;
     } catch (error) {
 

docs.wrm/api-keys.wrm

@@ -0,0 +1,103 @@
+_section: Provider API Keys @<api-keys>
+
+//( **TL; DR** &ndash; sign up for your own API keys with the links below to improve your application performance )//
+
+When using a [[Provider]] backed by an API service (such as [[link-alchemy]],
+[[link-etherscan]] or [[link-infura]]), the service requires an API key,
+which allows each service to track individual projects and their usage and
+permissions.
+
+The ethers library offers default API keys for each service, so that each
+[[Provider]] works out-of-the-box.
+
+These API keys are a provided as a community resource by the backend services
+for low-traffic projects and for early prototyping.
+
+Since these API keys are shared by all users (that have not acquired their
+own API key), they are aggressively throttled which means retries occur more
+frequently and the responses are slower.
+
+It is **highly recommended** that you sign up for a free API key from each service for their
+free tier, which (depending on the service) includes many advantages:
+
+- a much **higher request rate** and concurrent request limit
+- **faster** responses with fewer retries and timeouts
+- useful **metric tracking** for performance tuning and to analyze your customer behaviour
+- more **advanced APIs**, such as archive data or advanced log queries
+
+_subsection: Etherscan @<api-keys--etherscan>
+
+Etherscan is an Ethereum block explorer, which is possibly the most useful
+developer tool for building and debugging Ethereum applications.
+
+They offer an extensive collection of API endpoints which provide all the
+operations required to interact with the Ethereum Blockchain.
+
+[Sign up for a free API key on Etherscan](link-etherscan-signup)
+
+**Benefits:**
+
+- higher rate limit (since you are not using the [shared rate limit](link-etherscan-ratelimit))
+- customer usage metrics
+
+_subsection: INFURA @<api-keys--infura>
+
+The INFURA service has been around for quite some time and is very robust
+and reliable and highly recommend.
+
+They offer a standard JSON-RPC interface and a WebSocket interface, which makes
+interaction with standard tools versatile, simple and straight forward.
+
+[Sign up for a free Project ID on INFURA](link-infura-signup)
+
+**Benefits:**
+
+- higher rate limit
+- customer usage metrics
+- access to archive data (requires paid upgrade)
+
+_subsection: Alchemy @<api-keys--alchemy>
+
+The Alchemy service has been around a few years and is also very robust
+and reliable.
+
+They offer a standard JSON-RPC interface and a WebSocket interface, as well
+as a collection of advanced APIs for interacting with tokens and to assist
+with debugging.
+
+[Sign up for a free API key on Alchemy](link-alchemy-signup)
+
+**Benefits:**
+
+- higher rate limit
+- customer usage metrics
+- access to advanced token balance and metadata APIs
+- access to advanced debugging trace and revert reason APIs
+
+
+_subsection: Creating a Default Provider @<api-keys--getDefaultProvider>
+
+The [default provider](providers-getDefaultProvider) connects to multiple
+backends and verifies their results internally, making it simple to have
+a high level of trust in third-party services.
+
+A second optional parameter allows API keys to be specified to each
+Provider created internally and any API key omitted will fallback onto
+using the default API key for that service.
+
+It is **highly recommended** that you provide an API for each service, to
+maximize your applications performance.
+
+_code: Passing API Keys into getDefaultProvider @lang<script>
+
+// Use the mainnet
+const network = "homestead";
+
+// Specify your own API keys
+// Each is optional, and if you omit it the default
+// API key for that service will be used.
+const provider = ethers.getDefaultProvider(network, {
+    etherscan: YOUR_ETHERSCAN_API_KEY,
+    infura: YOUR_INFURA_PROJECT_ID,
+    alchemy: YOUR_ALCHEMY_API_KEY
+});

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

@@ -1,13 +1,14 @@
 _section: ContractFactory @<ContractFactory> @SRC<contracts:class.ContractFactory>
 
+@TODO: Fill this in, including @SRC links
 
 _subsection: Creating Instances  @<ContractFactory--creating>
 
-_property: new ethers.ContractFactory(interface, bydecode [ , signer ]) @SRC<contracts:constructor.ContractFactory>
+_property: new ethers.ContractFactory(interface, bytecode [ , signer ]) @SRC<contracts:constructor.ContractFactory>
 
 _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
+Return an instance of a [[Contract]] attached to //address//. This is the
+same as using the [Contract constructor](Contract--creating) with
 //address// and this the the //interface// and //signerOrProvider// passed
 in when creating the ContractFactory.
 
@@ -33,13 +34,13 @@ _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
-deployed once the transction is mined.
+Uses the signer to deploy the Contract with //args// passed into the constructor and
+returns a Contract which is attached to  the address where this contract **will** be
+deployed once the transaction is mined.
 
-The transction can be found at ``contract.deployTransaction``, and no interactions
+The transaction can be found at ``contract.deployTransaction``, and no interactions
 should be made until the transaction is mined.
 
 _code: Deploying a Contract
@@ -72,6 +73,6 @@ contract.deployTransaction
 contract.deployTransaction.wait()
 //!
 
-// Now the contract is safe to ineract with
+// Now the contract is safe to interact with
 contract.value()
 //!

docs.wrm/api/contract/contract.wrm

@@ -2,28 +2,28 @@ _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//.
 
 By passing in a [[Provider]], this will return a downgraded
 **Contract** which only has read-only access (i.e. constant calls).
 
-By passing in a [[Signer]]. the will return a **Contract** which
+By passing in a [[Signer]]. this 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,21 +100,37 @@ 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
 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
+For numbers, if the **type** is in the JavaScript safe range (i.e. less
 than 53 bits, such as an ``int24`` or ``uint48``) a normal JavaScript
 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,9 +148,9 @@ 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
+There are several options to analyze properties and results of a
 write method without actually executing it.
 
 _property: contract.estimateGas.METHOD_NAME(...args [ , overrides ]) => Promise<[[BigNumber]]>  @<contract-estimateGas>
@@ -146,17 +162,17 @@ Returns an [[UnsignedTransaction]] which represents the transaction
 that would need to be signed and submitted to the network to execute
 //METHOD_NAME// with //args// and //overrides//.
 
-_property: contract.staticCall.METHOD_NAME(...args [ , overrides ]) => Promise<any>  @<contract-staticCall>
+_property: contract.callStatic.METHOD_NAME(...args [ , overrides ]) => Promise<any>  @<contract-callStatic>
 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
+This does not actually change 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/contract/example.wrm

@@ -91,7 +91,7 @@ Returns a new instance of the Contract, but connected to
 By passing in a [[Provider]], this will return a downgraded
 **Contract** which only has read-only access (i.e. constant calls).
 
-By passing in a [[Signer]]. the will return a **Contract** which
+By passing in a [[Signer]]. this will return a **Contract** which
 will act on behalf of that signer.
 
 _property: erc20.deployed() => Promise<Contract>
@@ -178,7 +178,7 @@ _subsection: Meta-Class Filters @NOTE<(added at Runtime)>
 Since the Contract is a Meta-Class, the methods available here depend
 on the ABI which was passed into the **Contract**.
 
-_property: erc20.filters.Transafer([ fromAddress [ , toAddress ] ]) => Filter
+_property: erc20.filters.Transfer([ fromAddress [ , toAddress ] ]) => Filter
 Returns a new Filter which can be used to [query](erc20-queryfilter) or
 to [subscribe/unsubscribe to events](erc20-events).
 

docs.wrm/api/contract/index.wrm

@@ -2,10 +2,10 @@ _section: Contract Interaction @<contracts>
 
 A **Contract** object is an abstraction of a contract (EVM bytecode)
 deployed on the Ethereum network. It allows for a simple way to
-serialize calls and transaxtions to an on-chain contract and
+serialize calls and transactions to an on-chain contract and
 deserialize their results and emitted logs.
 
-A **ContractFactory** is an abstraction a contract's //bytecode//
+A **ContractFactory** is an abstraction of a contract's //bytecode//
 and facilitates deploying a contract.
 
 _toc:

docs.wrm/api/experimental.wrm

@@ -17,7 +17,7 @@ Generates a brain wallet, with a slightly improved experience, in which
 the generated wallet has a mnemonic.
 
 _property: BrainWallet.generateLegacy(username, password [ , progressCallback ]) => [[experimental-brainwallet]]
-Generate a brain wallet which is compatibile with the ethers v3 and earlier.
+Generate a brain wallet which is compatible with the ethers v3 and earlier.
 
 
 _subsection: EIP1193Bridge @<experimental-eip1193bridge> @INHERIT<[[link-npm-events]]>

docs.wrm/api/index.wrm

@@ -1,12 +1,12 @@
-_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.
 
 _toc:
-    contract
-    signer
     providers
+    signer
+    contract
     utils
     other
     experimental

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

@@ -26,7 +26,7 @@ Create a formatted output of an array of [[asm-operation]].
 
 _heading: Bytecode @<asm-bytecode> @INHERIT<Array\<[[asm-operation]]\>>
 
-Each arary index represents an operation, collapsing multi-byte operations
+Each array index represents an operation, collapsing multi-byte operations
 (i.e. ``PUSH``) into a single operation.
 
 _property: bytecode.getOperation(offset) => [[asm-operation]]
@@ -52,7 +52,7 @@ If the opcode is a ``PUSH``, this is the value of that push
 _subsection: Opcode @<asm-opcode> @SRC<asm/opcodes:class.Opcode>
 
 _property: asm.Opcode.from(valueOrMnemonic) => [[asm-opcode]]
-Create a new instnace of an Opcode for a given numeric value
+Create a new instance of an Opcode for a given numeric value
 (e.g. 0x60 is PUSH1) or mnemonic string (e.g. "PUSH1").
 
 _heading: Properties

docs.wrm/api/other/assembly/ast.wrm

@@ -49,7 +49,7 @@ string of a decimal number.
 
 _property: literalNode.verbatim => boolean
 This is true in a [[asm-datanode]] context, since in that case the
-value should be taken verbatim and no ``PUSH`` operation shoud be
+value should be taken verbatim and no ``PUSH`` operation should be
 added, otherwise false.
 
 
@@ -96,7 +96,7 @@ any output assembly, using the ``{{! code here }}`` syntax.
 
 _property: literalNode.verbatim => boolean
 This is true in a [[asm-datanode]] context, since in that case the
-value should be taken verbatim and no ``PUSH`` operation shoud be
+value should be taken verbatim and no ``PUSH`` operation should be
 added, otherwise false.
 
 _property: evaluationNode.script => string

docs.wrm/api/other/assembly/dialect.wrm

@@ -1,9 +1,9 @@
 _section: Ethers ASM Dialect @<asm-dialect>
 
-This provides a quick, high-level overcview of the **Ethers ASM Dialect**
+This provides a quick, high-level overview of the **Ethers ASM Dialect**
 for EVM, which is defined by the [Ethers ASM Dialect Grammar](link-ethers-asm-grammar)
 
-Once a program is compiled by a higher level langauge into ASM (assembly),
+Once a program is compiled by a higher level language 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
@@ -34,7 +34,7 @@ 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
+@TODO: Examples
 
 
 _subsection: Literals @<asm-dialect-literal>
@@ -45,7 +45,7 @@ operation.
 A **Literal** can be provided using a [[DataHexString]] or a decimal
 byte value.
 
-@TODO: exmples
+@TODO: examples
 
 
 _subsection: Comments @<asm-dialect-comment>
@@ -64,7 +64,7 @@ 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
+returns some other bytecode as a result, this result is the bytecode
 to be installed.
 
 Therefore it is important that embedded code uses jumps relative to itself,
@@ -84,7 +84,7 @@ _subsection: Data Segment @<asm-dialect-datasegment>
 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
+An empty **Data Segment** can also be used when a labelled location is
 required, but without the ``JUMPDEST`` which a [[asm-dialect-label]] adds.
 
 @TODO: Example
@@ -111,5 +111,5 @@ _subsection: Stack Placeholders @<asm-dialect-placeholder>
 @TODO: exampl
 
 
-_subsection: Evaluation and Excution @<asm-dialect-scripting>
+_subsection: Evaluation and Execution @<asm-dialect-scripting>
 

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,12 +77,12 @@ _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.
 
-_property: new ethers.providers.InfuraProvider([ network = "homestead", [ apiKey ] ])
+_property: new ethers.providers.InfuraProvider([ network = "homestead", [ apiKey ] ]) @SRC<providers>
 Create a new **InfuraProvider** connected to //network// with
 the optional //apiKey//.
 
@@ -96,6 +96,12 @@ specify a [Project Secret](link-infura-secret) which can be used
 on non-public sources (like on a server) to further secure your
 API access and quotas.
 
+_property: InfuraProvider.getWebSocketProvider([ network [ , apiKey ] ]) => [[WebSocketProvider]] @<InfuraProvider-getWebSocketProvider> @SRC<providers:InfuraProvider.getWebSocketProvider>
+Create a new [[WebSocketProvider]] using the INFURA web-socket endpoint
+to connect to //network// with the optional //apiKey//.
+
+The //network// and //apiKey// are specified the same as [the constructor](InfuraProvider).
+
 _note: Note: Default API keys
 If no //apiKey// is provided, a shared API key will be used,
 which may result in reduced performance and throttled requests.
@@ -136,8 +142,14 @@ provider = new InfuraProvider("homestead", {
     projectSecret: projectSecret
 });
 
+// Connect to the INFURA WebSocket endpoints with a WebSocketProvider
+provider = InfuraProvider.getWebSocketProvider()
+// <hide>
+provider.destroy();
+// </hide>
 
-_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).
 
@@ -182,8 +194,14 @@ provider = new AlchemyProvider("ropsten");
 provider = new AlchemyProvider(null, apiKey);
 provider = new AlchemyProvider("homestead", apiKey);
 
+// Connect to the Alchemy WebSocket endpoints with a WebSocketProvider
+provider = AlchemyProvider.getWebSocketProvider()
+// <hide>
+provider.destroy();
+// </hide>
 
-_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
@@ -9,7 +9,7 @@ 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 [[providers-getDefaultProvider]].
+Most users should use the [[providers-getDefaultProvider]].
 
 
 _subsection: Default Provider @<providers-getDefaultProvider>
@@ -34,6 +34,9 @@ Returns a new Provider, backed by multiple services, connected
 to //network//. Is no //network// is provided, **homestead**
 (i.e. mainnet) is used.
 
+The //network// may also be a URL to connect to, such as ``http:/\/localhost:8545``
+or ``wss:/\/example.com``.
+
 The //options// is an object, with the following properties:
 
 _table: Option Properties
@@ -41,32 +44,55 @@ _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
 
 It is highly recommended for production services that to acquire
 and specify an API Key for each sercice.
 
-The deafult API Keys used by ethers are shared across all users,
+The default API Keys used by ethers are shared across all users,
 so services may throttle all services that are using the default
 API Keys during periods of load without realizing it.
 
 Many services also have monitoring and usage metrics, which are
-only available if an API Key is specifie. This allows tracking
+only available if an API Key is specified. This allows tracking
 how many requests are being sent and which methods are being
 used the most.
 
-Some services also provide additional paid features, whichare only
+Some services also provide additional paid features, which are only
 available when specifying an API Key.
 
+_subsection: Networks
+
+There are several official common Ethereum networks as well as custom
+networks and other compatible projects.
+
+Any API that accept a [[providers-Networkish]] can be passed a common name (such as
+``"mainnet"`` or ``"ropsten"``) to use that network definition or may specify
+custom parameters.
+
+_heading: Custom ENS Contract
+
+One common reason to specify custom properties for a [[providers-Network]] is to override
+the address of the root ENS registry, either on a common network to intercept
+the [ENS Methods](Provider--ens-methods) or to specify the ENS registry on a
+dev network (on most dev networks you must deploy the ENS contracts manually).
+
+_code: Example: Override the ENS registry @lang<script>
+
+const network = {
+    name: "dev",
+    chianId: 1337,
+    ensAddress: customEnsAddress
+};
 
 _subsection: Provider Documentation
 

docs.wrm/api/providers/jsonrpc-provider.wrm

@@ -1,6 +1,6 @@
 _section: JsonRpcProvider  @<JsonRpcProvider> @INHERIT<[[Provider]]> @SRC<providers:class.JsonRpcProvider>
 
-The [JSON-RPC API](link-jsonrpc) is a very popular method for interacting
+The [JSON-RPC API](link-jsonrpc) is a popular method for interacting
 with Ethereum and is available in all major Ethereum node implementations
 (e.g. [[link-geth]] and [[link-parity]]) as well as many
 third-party web services (e.g. [[link-infura]])
@@ -14,7 +14,7 @@ querying the node.
 _note: Note: Connecting to a Local Node
 Each node implementation is slightly different and may require specific
 command-line flags, configuration or settings in their UI to enable
-JSON-RPC, unlock accounrs or expose specific APIs. Please consult
+JSON-RPC, unlock accounts or expose specific APIs. Please consult
 their documentation.
 
 _property: jsonRpcProvider.getSigner([ addressOrIndex ]) => [[JsonRpcSigner]]  @<JsonRpcProvider-getSigner> @SRC<providers/json-rpc-provider>
@@ -42,12 +42,12 @@ _property: signer.provider => [[JsonRpcProvider]]
 The provider this signer was established from.
 
 _property: signer.connectUnchecked() => [[UncheckedJsonRpcSigner]]  @<JsonRpcSigner-connectUnchecked> @SRC<providers>
-Returns a new Signer object which does not perform addtional checks when
+Returns a new Signer object which does not perform additional checks when
 sending a transaction. See [getUncheckedSigner](JsonRpcProvider-getUncheckedSigner) for more details.
 
 _property: signer.sendUncheckedTransaction(transaction) => Promise<string<[[DataHexString]]\<32>\>>  @<JsonRpcSigner-sendUncheckedTransaction> @SRC<providers>
 Sends the //transaction// and returns a Promise which resolves to the
-opacque transaction hash.
+opaque transaction hash.
 
 _property: signer.unlock(password) => Promise<boolean>  @<JsonRpcSigner-unlock> @SRC<providers>
 Request the node unlock the account (if locked) using //password//.
@@ -60,7 +60,7 @@ 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
+To remedy this, the [[JsonRpcSigner]] immediately queries the provider for
 the details using the returned transaction hash to populate the [[providers-TransactionResponse]]
 object.
 
@@ -85,7 +85,7 @@ The [jsonRpcProvider.send](JsonRpcProvider-send) method can be used to access th
 - [All JSON-RPC methods](link-json-rpc) (including the less common methods) which most
   Ethereum Nodes support.
 - [Parity's Trace Module](link-parity-trace) can be used to trace and debug EVM
-  execcution of a transaction (requires custom configuration)
+  execution of a transaction (requires custom configuration)
 - [Geth's Debug Module](link-geth-debug) can be used to debug transactions and
   internal cache state, etc.
 - [Additional Geth Methods](link-geth-rpc)

docs.wrm/api/providers/other.wrm

@@ -11,7 +11,7 @@ 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
+chosen (higher priority 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.
 
@@ -41,7 +41,7 @@ The provider for this configuration.
 
 _property: 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
+priorities. If multiple providers share the same prioirty, they are chosen
 at random.
 
 _property: fallbackProviderConfig.stallTimeout => number
@@ -93,18 +93,71 @@ The URL to use for the JsonRpcProvider instance.
 
 
 
-_subsection: Web3Provider @<Web3Provider> @INHERIT<[[JsonRpcProvider]]>
+_subsection: Web3Provider @<Web3Provider> @INHERIT<[[JsonRpcProvider]]> @SRC<providers:class.Web3Provider>
 
 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
+application to ethers by wrapping an existing Web3-compatible (such as a
+[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
+
+
+_subsection: WebSocketProvider @<WebSocketProvider> @INHERIT<[[JsonRpcProvider]]> @SRC<providers:class.WebSocketProvider>
+
+The **WebSocketProvider** connects to a JSON-RPC WebSocket-compatible backend
+which allows for a persistent connection, multiplexing requests and pub-sub
+events for a more immediate event dispatching.
+
+The WebSocket API is newer, and if running your own infrastructure, note that
+WebSockets are much more intensive on your server resourses, as they must manage
+and maintain the state for each client. For this reason, many services may also
+charge additional fees for using their WebSocket endpoints.
+
+_property: new ethers.provider.WebSocketProvider([ url [ , network ] ])
+Returns a new [[WebSocketProvider]] connected to //url// as the //network//.
+
+If //url// is unspecified, the default ``"ws:/\/localhost:8546"`` will be used.
+If //network// is unspecified, it will be queried from the network.

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 attached 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,10 +279,10 @@ 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")
+        utils.id("Transfer(address,address,uint256)")
     ]
 }
 provider.on(filter, (log, event) => {
@@ -259,8 +292,8 @@ 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 = [
-    utils.id("Transfer(address,address,uint256"),
+topicSets = [
+    utils.id("Transfer(address,address,uint256)"),
     null,
     [
         myAddress,
@@ -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/providers/types.wrm

@@ -19,8 +19,17 @@ And **EventType** can be any of the following.
 - **//[[providers-EventFilter]]//** -- TODO...
 
 
+_subsection: Networkish @<providers-Networkish>
+A **Networkish** may be any of the following:
+
+- a [[providers-Network]] object
+- the name of a common network as a string (e.g. ``"homestead"``)
+- the chain ID a network as a number; if the chain ID is that of a
+  common network, the ``name`` and ``ensAddress`` will be populated, otherwise,
+  the default name ``"unknown"`` and no ``ensAddress`` is used
+
 _subsection: Network @<providers-Network>
-A **Network** represents an Etherem network.
+A **Network** represents an Ethereum network.
 
 _property: network.name => string
 The human-readable name of the network, such as ``homestead``. If the network
@@ -264,7 +273,7 @@ The amount of gas actually used by this transaction.
 
 _property: receipt.logsBloom => string<[[DataHexString]]>
 A [bloom-filter](link-wiki-bloomfilter), which
-incldues all the addresses and topics included in any log in this
+includes all the addresses and topics included in any log in this
 transaction.
 
 _property: receipt.blockHash => string<[[DataHexString]]<32>>

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
@@ -30,7 +47,7 @@ _property: signer.getBalance([ blockTag = "latest" ]) => Promise<[[BigNumber]]>
 Returns the balance of this wallet at //blockTag//.
 
 _property: signer.getChainId() => Promise<number>  @<Signer-getChainId> @SRC<abstract-signer>
-Returns ths chain ID this wallet is connected to.
+Returns the chain ID this wallet is connected to.
 
 _property: signer.getGasPrice() => Promise<[[BigNumber]]>  @<Signer-getGasPrice> @SRC<abstract-signer>
 Returns the current gas price.
@@ -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 Signer 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]]
@@ -170,20 +197,89 @@ The provider this wallet is connected to, which will ge used for any [[Signer--b
 methods. This can be null.
 
 _note: Note
-A **Wallet** instance is immuatable, so if you wish to change the Provider, you
+A **Wallet** instance is immutable, so if you wish to change the Provider, you
 may use the [connect](Signer-connect) method to create a new instance connected
 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 coercion 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/fragments.wrm

@@ -12,12 +12,12 @@ The **JSON ABI Format** is the format that is
 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
+The deserialized JSON string (which is a normal JavaScript Object) may
 also be passed into any function which accepts a JSON String ABI.
 
 _heading: Humanb-Readable ABI
 
-The Human-Readable ABI was 
+The Human-Readable ABI was @TODO
 
 [article](link-ricmoo-humanreadableabi)
 
@@ -212,7 +212,7 @@ to parameters which are part of an [[EventFragment]].
 _property: paramType.arrayChildren => [[ParamType]] @<ParamType-arrayChildren>
 
 The type of children of the array. This is null for for any parameter
-wjhich is not an array.
+which is not an array.
 
 _property: paramType.arrayLength => number @<ParamType-arrayLength>
 

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

@@ -4,7 +4,7 @@ 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 [[link-solidity]]
-language, which other languages have adopted to remain compatibile with
+language, which other languages have adopted to remain compatible with
 existing deployed contracts.
 
 The EVM itself does not understand what the ABI is. It is simply an agreed
@@ -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/address.wrm

@@ -45,7 +45,7 @@ _property: ethers.utils.getAddress(address) => string<[[address]]>  @<utils-getA
 Returns //address// as a Checksum Address.
 
 If //address// is an invalid 40-nibble [[HexString]] or if it contains mixed case and
-the checksum is invalid, an InvalidArgument Error is throw.
+the checksum is invalid, an InvalidArgument Error is thrown.
 
 The value of //address// may be any supported address format.
 

docs.wrm/api/utils/bignumber.wrm

@@ -11,33 +11,13 @@ 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>
 
 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:
+values can be specified as:
 
 _definition: **//string//**
 A [[HexString]] or a decimal string, either of which may
@@ -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.
@@ -142,18 +122,18 @@ Returns a BigNumber with the value of //BigNumber// with bits beyond
 the //bitcount// least significant bits set to zero.
 
 
-_heading: Two's Compliment
+_heading: Two's Complement
 
-[Two's Complicment](link-wiki-twoscomplement)
+[Two's Complement](link-wiki-twoscomplement)
 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.
 
 _property: BigNumber.fromTwos(bitwidth) => [[BigNumber]]  @SRC<bignumber>
-Returns a BigNumber with the value of //BigNumber// converted from twos-compliment with //bitwidth//.
+Returns a BigNumber with the value of //BigNumber// converted from twos-complement with //bitwidth//.
 
 _property: BigNumber.toTwos(bitwidth) => [[BigNumber]]  @SRC<bignumber>
-Returns a BigNumber with the value of //BigNumber// converted to twos-compliment with //bitwidth//.
+Returns a BigNumber with the value of //BigNumber// converted to twos-complement with //bitwidth//.
 
 
 _heading: Comparison and Equivalence
@@ -173,7 +153,7 @@ Returns true if and only if the value of //BigNumber// **>** //otherValue//.
 _property: BigNumber.gte(otherValue) => boolean  @SRC<bignumber>
 Returns true if and only if the value of //BigNumber// **&ge;** //otherValue//.
 
-_property: BigNumber.isZero() => boolean  @SRC<bignumber>
+_property: BigNumber.isZero() => boolean  @SRC<bignumber:BigNumber.isZero>
 Returns true if and only if the value of //BigNumber// is zero.
 
 
@@ -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.
 
@@ -252,7 +232,7 @@ mathematical operations handled safely.
 _heading: 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,
+has chosen one, it becomes part of their identity, like their editor,
 vi vs emacs. There are over 100 Big Number libraries on [npm](link-npm-query-bignumber).
 
 One of the biggest differences between the Ethers [[BigNumber]] object and
@@ -266,7 +246,7 @@ 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.
+be easier to swap out the underlying library without impacting consumers.
 
 For example, if [[link-npm-bnjs]] was exposed, someone may use the
 greatest-common-denominator functions, which would then be functionality

docs.wrm/api/utils/bytes.wrm

@@ -25,7 +25,7 @@ binary data as a string.
 _heading: HexString @<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``).
+number of nibbles (i.e. case-insensitive hexadecimal characters, ``0-9`` and ``a-f``).
 
 _heading: Signature @<Signature>
 
@@ -37,7 +37,7 @@ _heading: Signature @<Signature>
 _heading: Raw Signature @<signature-raw> @inherit<string\<[[DataHexString]]\<65\>\>>
 
 A **Raw Signature** is a common Signature format where the r, s and v are
-concanenated into a 65 byte (130 nibble) [[DataHexString]].
+concatenated into a 65 byte (130 nibble) [[DataHexString]].
 
 
 _heading: SignatureLike @<SignatureLike>
@@ -112,7 +112,7 @@ _property: ethers.utils.stripZeros(aBytesLike) => Uint8Array  @<utils-stripZeros
 Returns a Uint8Array with all leading ``0`` bytes of //aBtyesLike// removed.
 
 _property: ethers.utils.zeroPad(aBytesLike, length) => Uint8Array  @<utils-zeroPad> @SRC<bytes>
-Retutns a Uint8Array of the data in //aBytesLike// with ``0`` bytes prepended to
+Returns 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

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/fixednumber.wrm

@@ -49,6 +49,12 @@ _property: fixednumber.round([ decimals = 0 ]) => [[FixedNumber]]  @SRC<bignumbe
 Returns a new FixedNumber with the value of //fixedvalue// rounded to //decimals//.
 
 
+_heading: Comparison and Equivalence
+
+_property: FixedNumber.isZero() => boolean  @SRC<bignumber/fixednumber:FixedNumber.isZero>
+Returns true if and only if the value of //FixedNumber// is zero.
+
+
 _heading: Conversion
 
 _property: fixednumber.toFormat(format) => [[FixedNumber]]  @SRC<bignumber/fixednumber>
@@ -87,7 +93,7 @@ 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
+The width must be congruent 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:

docs.wrm/api/utils/hashing.wrm

@@ -1,15 +1,15 @@
-_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.
 
 _property: ethers.utils.id(text) => string<[[DataHexString]]<32>>  @<utils-id> @SRC<hash>
-The Ethereum Identity function computs the [KECCAK256](link-wiki-sha3) hash of the //text// bytes.
+The Ethereum Identity function computes the [KECCAK256](link-wiki-sha3) hash of the //text// bytes.
 
 _property:  ethers.utils.keccak256(aBytesLike) => string<[[DataHexString]]<32>>  @<utils-keccak256> @SRC<keccak256>
 Returns the [KECCAK256](link-wiki-sha3) digest //aBytesLike//.
@@ -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
@@ -163,7 +163,7 @@ the tightly packing algorithm.
 
 _property: ethers.utils.solidityPack(types, values) => string<[[DataHexString]]>  @<utils-solidityPack> @SRC<solidity:pack>
 Returns the non-standard encoded //values// packed according to
-their respecive type in //types//.
+their respective type in //types//.
 
 _property: ethers.utils.solidityKeccak256(types, values) => string<[[DataHexString]]<32>>  @<utils-solidityKeccak256> @SRC<solidity:keccak256>
 Returns the [KECCAK256](link-wiki-sha3) of the non-standard encoded //values// packed

docs.wrm/api/utils/hdnode.wrm

@@ -101,7 +101,7 @@ _heading: Methods  @<HDNode--methods>
 
 _property: hdNode.neuter() => [[HDNode]]  @<HDNode-neuter> @SRC<hdnode>
 Return a new instance of //hdNode// with its private key removed
-but all otehr properties preserved. This ensures that the key
+but all other 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.

docs.wrm/api/utils/logger.wrm

@@ -56,11 +56,11 @@ _heading: Usage Validation
 There can be used to ensure various properties and actions are safe.
 
 _property: logger.checkAbstract(target, kind) => void @SRC<logger>
-Checks that //target// is not //kind// and performs the same operatons
+Checks that //target// is not //kind// and performs the same operations
 as ``checkNew``. This is useful for ensuring abstract classes are not
 being instantiated.
 
-_property: logger.checkArgumentCount(count, expectedCound [ , message) => void @SRC<logger>
+_property: logger.checkArgumentCount(count, expectedCount [ , message) => void @SRC<logger>
 If //count// is not equal to //expectedCount//, throws a [MISSING_ARGUMENT](errors-MissingArgument)
 or [UNEXPECTED_ARGUMENT](errors-UnexpectedArgument) error.
 

docs.wrm/api/utils/signing-key.wrm

@@ -8,11 +8,11 @@ The private key for this Signing Key.
 
 _property: signingKey.publicKey => string<[[DataHexString]]<65>>
 The uncompressed public key for this Signing Key. It will always be
-65 bytes (130 nibbles) and begine with ``0x04``.
+65 bytes (130 nibbles) and begins with ``0x04``.
 
 _property: signingKey.compressedPublicKey => string<[[DataHexString]]<33>>
 The compressed public key for this Signing Key. It will always be
-33 bytes (66 nibbles) and begine with either ``0x02`` or ``0x03``.
+33 bytes (66 nibbles) and begins with either ``0x02`` or ``0x03``.
 
 _property: signingKey.signDigest(digest) => [[Signature]]
 Sign the //digest// and return the signature.

docs.wrm/api/utils/strings.wrm

@@ -40,7 +40,7 @@ Returns the Array of codepoints of //text//, optionally normalized using the
 _note: 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
+``string.split("")``, which destroys surrogate pairs, splitting between each UTF-16
 codeunit instead.
 
 _property: ethers.utils.toUtf8String(aBytesLike [ , onError = error ] ) => string  @<utils-toUtf8String> @SRC<strings>
@@ -88,7 +88,7 @@ See NFKC for more an example.
 
 _note: 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
+it should **not** be considered a method to achieve //any// level of security from
 [homoglyph attacks](link-wiki-homoglyph).
 
 

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
@@ -54,7 +54,7 @@ _property: transaction.gasLimit => [[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
+to complete execution, the effects of the transaction are reverted, but
 the gas is **fully consumed** and an out-of-gas error occurs.
 
 _property: transaction.gasPrice => [[BigNumber]]
@@ -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/web.wrm

@@ -37,7 +37,7 @@ Additional headers to include in the connection.
 _heading: PollOptions @<PollOptions>
 
 _property: options.timeout => number
-The amount of time allowed to ellapse before triggering a timeout
+The amount of time allowed to elapse before triggering a timeout
 error.
 
 _property: options.floor => number

docs.wrm/api/utils/wordlists.wrm

@@ -30,6 +30,11 @@ the registered //name//.
 
 _subsection: Languages @<wordlists--languages>
 
+The [official wordlists](link-bip39-wordlists) available in at
+`ethers.wordlists`. In the browser, only the english language 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/cli/asm.wrm

@@ -2,7 +2,7 @@ _section: Assembler @<cli-asm>
 
 The assembler Command-Line utility allows you to assemble the
 [Ethers ASM Dialect](asm-dialect) into deployable EVM bytecode
-and disassemle EVM bytecode into human-readable mnemonics.
+and disassemble EVM bytecode into human-readable mnemonics.
 
 
 _subsection: Help
@@ -31,7 +31,7 @@ _code: SimpleStore.asm  @lang<asm>
 
 ; SimpleStore (uint)
 
-; Set the inital value of 42
+; Set the initial value of 42
 sstore(0, 42)
 
 ; Init code to deploy myContract
@@ -144,7 +144,7 @@ Byt specifying the **Position Independent Code** flag, code
 will be generated in a way such that all offsets are relative, allowing
 the program to be moved without any impact to its logic.
 
-This does incur an additional gsas cost of 8 gas per offset access though.
+This does incur an additional gas cost of 8 gas per offset access though.
 
 _definition: **-\-target LABEL**
 All programs have a root scope named ``_`` which is by default

docs.wrm/cli/ens.wrm

@@ -62,7 +62,7 @@ TRANSACTION OPTIONS (default: query network)
   --gasPrice GWEI             Default gas price for transactions(in wei)
   --gasLimit GAS              Default gas limit for transactions
   --nonce NONCE               Initial nonce for the first transaction
-  --yes                       Always accept Siging and Sending
+  --yes                       Always accept Signing and Sending
 
 OTHER OPTIONS
   --wait                      Wait until transactions are mined

docs.wrm/cli/ethers.wrm

@@ -1,7 +1,7 @@
 _section: Sandbox Utility
 
 The sandbox utility provides a simple way to use the most common
-ethers utilities required during learning, debuging and managing
+ethers utilities required during learning, debugging and managing
 interactions with the Ethereum network.
 
 If no command is given, it will enter a REPL interface with many
@@ -64,7 +64,7 @@ TRANSACTION OPTIONS (default: query network)
   --gasPrice GWEI             Default gas price for transactions(in wei)
   --gasLimit GAS              Default gas limit for transactions
   --nonce NONCE               Initial nonce for the first transaction
-  --yes                       Always accept Siging and Sending
+  --yes                       Always accept Signing and Sending
 
 OTHER OPTIONS
   --wait                      Wait until transactions are mined

docs.wrm/cli/plugin.wrm

@@ -21,7 +21,7 @@ associated plugin class will be instantiated and run.
 
 _property: setPlugin(pluginClass) => void  @<cli-setplugin> @SRC<cli/cli>
 Set a dedicated [[cli-plugin]] class which will handle all input. This
-may not be used in conjuction with addPlugin and will not automatically
+may not be used in conjunction with addPlugin and will not automatically
 accept a command from the arguments.
 
 _property: showUsage([ message = "" [ , status = 0 ] ]) => never  @<cli-showusage> @SRC<cli/cli>
@@ -36,7 +36,7 @@ _subsection: Plugin  @<cli-plugin> @SRC<cli:class.Plugin>
 Each **Plugin** manages each command of a CLI and is executed in phases.
 
 If the usage (i.e. help) of a CLI is requested, the static methods ``getHelp``
-and ``getOptionHelp`` are used to geneate the help screen.
+and ``getOptionHelp`` are used to generate the help screen.
 
 Otherwise, a plugin is instantiated and the ``prepareOptions`` is called. Each
 plugin **must** call ``super.prepareOptions``, otherwise the basic options are
@@ -83,7 +83,7 @@ _property: plugin.prepareArgs(args) =>  Promise<void>  @<plugin-prepareargs> @SR
 _property: plugin.run() => Promise<void>  @<plugin-run> @SRC<cli/cli:Plugin.run>
 
 _property: plugin.getAddress(addressOrName [ , message = "", [ allowZero = false ] ]) => Promise<string>  @<plugin-getaddress> @SRC<cli/cli:Plugin.getAddress>
-A plugin should use this method to resolve an address. If the resovled address is
+A plugin should use this method to resolve an address. If the resolved address is
 the zero address and //allowZero// is not true, an error is raised.
 
 _property: plugin.dump(header, info) => void  @<plugin-dump> @SRC<cli/cli:Plugin.dump>
@@ -92,7 +92,7 @@ formatted style. In the future, plugins may support a JSON output format
 which will automatically work with this method.
 
 _property: plugin.throwUsageError([ message = "" ]) => never  @<plugin-throwusageerror> @SRC<cli/cli>
-Stops exectuion of the plugin and shows the help screen of the plugin with
+Stops execution of the plugin and shows the help screen of the plugin with
 the optional //message//.
 
 _property: plugin.throwError(message) => never  @<plugin-throwerror> @SRC<cli/cli>
@@ -133,7 +133,7 @@ Flags are simple binary options (such as the ``--yes``), which are true if prese
 otherwise false.
 
 Options require a single parameter follow them on the command line
-(such as ``--account wallet.json``, which nhas the name ``account`` and the value
+(such as ``--account wallet.json``, which has the name ``account`` and the value
 ``wallet.json``)
 
 Arguments are all other values on the command line, and are not accessed through

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 accomplished 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/events.wrm

@@ -27,7 +27,7 @@ If a topic-set is a single topic, a log topic in that position must match
 **that topic**.
 
 If a topic-set is an array of topics, a log topic in that position must
-match any **one** of topics (i.e. the topic in thie position are ``OR``-ed).
+match any **one** of the topics (i.e. the topic in this position are ``OR``-ed).
 
 
 _table: Example Log Matching @style<full>

docs.wrm/concepts/index.wrm

@@ -1,9 +1,12 @@
 _section: Ethereum Basics
 
-This is a very breif overview of some aspects of //Ethereum//
+This is a brief overview of some aspects of //Ethereum//
 and blockchains which developers can make use of or should
 be aware of.
 
+This section is 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.
@@ -12,7 +12,7 @@ much stronger security.
 
 The algorithm usually used for this process is [scrypt](link-wiki-scrypt),
 which is a memory and CPU intensive algorithm which computes
-a key (fixed-length psudo-random series of bytes) for a given
+a key (fixed-length pseudo-random series of bytes) for a given
 password.
 
 
@@ -21,7 +21,7 @@ _heading: Why does it take so long?
 The goal is to use as much CPU and memory as possible during
 this algorithm, so that a single computer can only compute a
 very small number of results for some fixed amount of time. To
-scale up an attack, the attacker requires additional compuers,
+scale up an attack, the attacker requires additional computers,
 increasing the cost to [brute-force attack](link-wiki-bruteforce)
 to guess the password.
 
@@ -50,7 +50,7 @@ progress callback which will be periodically called with a number between
 
 In general a progress bar makes the experience feel faster, as well as
 more comfortable since there is a clear indication how much (relative) time
-is remaining. Additionally, using language like //"decrpyting..."// in
+is remaining. Additionally, using language like //"decrypting..."// in
 a progress bar makes a user feel like there time is not being //needlessly//
 wasted.
 

docs.wrm/config.js

@@ -54,7 +54,7 @@ function getDefinitions(source) {
 
 const getSourceUrl = (function(path, include, exclude) {
     console.log("Scanning TypeScript Sources...");
-    const Link = "https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages$FILENAME#L$LINE";
+    const Link = "https://github.com/ethers-io/ethers.js/blob/master/packages$FILENAME#L$LINE";
     const Root = resolve(__dirname, path);
 
     const readdir = function(path) {
@@ -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,52 +135,32 @@ 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",
+  subtitle: "v5.0",
   logo: "logo.svg",
 
-  link: "https:/\/docs-beta.ethers.io",
+  prefix: "/v5",
+
+  link: "https:/\/docs.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;.",
 
   markdown: {
-      "banner": "-----\n\nDocumentation: [html](https://docs-beta.ethers.io/)\n\n-----\n\n"
+      "banner": "-----\n\nDocumentation: [html](https://docs.ethers.io/)\n\n-----\n\n"
   },
 
   codeContextify: codeContextify,
@@ -189,30 +170,46 @@ 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-expo": { name: "Expo", url: "https:/\/expo.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-javascriptcore": { name: "JavaScriptCore", url: "https:/\/developer.apple.com/documentation/javascriptcore?language=objc" },
       "link-ledger": "https:/\/www.ledger.com",
       "link-metamask": { name: "Metamask", url: "https:/\/metamask.io/" },
+      "link-otto": "https:/\/github.com/robertkrimen/otto",
       "link-parity": { name: "Parity", url: "https:/\/www.parity.io" },
+      "link-react-native": { name: "React Native", url: "https:/\/reactnative.dev" },
       "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-alchemy-signup": "https:/\/dashboard.alchemyapi.io/signup?referral=55a35117-028e-4b7c-9e47-e275ad0acc6d",
+      "link-etherscan-signup": "https:/\/etherscan.io/apis",
+      "link-etherscan-ratelimit": "https:/\/info.etherscan.com/api-return-errors/",
+      "link-infura-signup": "https:/\/infura.io/register",
 
       "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-github-ci": "https:/\/github.com/ethers-io/ethers.js/actions/runs/158006903",
+      "link-github-issues": "https:/\/github.com/ethers-io/ethers.js/issues",
+
+      "link-issue-407": "https:/\/github.com/ethers-io/ethers.js/issues/407",
 
       "link-infura-secret": "https:/\/infura.io/docs/gettingStarted/authentication",
 
@@ -222,37 +219,41 @@ 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/",
       "link-ethers-docs": "https:/\/docs.ethers.io/",
       "link-ethers-js": "https:/\/cdn.ethers.io/lib/ethers-5.0.esm.min.js",
       "link-ethers-npm": "https:/\/www.npmjs.com/search?q=%40ethersproject%2F",
-      "link-ethers-asm-grammar": "https:/\/github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/asm/grammar.jison",
+      "link-ethers-asm-grammar": "https:/\/github.com/ethers-io/ethers.js/blob/master/packages/asm/grammar.jison",
 
       "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-ethersproject-shims": { name: "Shims", url: "https:/\/www.npmjs.com/package/@ethersproject/shims" },
       "link-npm-events": { name: "EventEmitter", url: "https:/\/nodejs.org/dist/latest-v13.x/docs/api/events.html#events_class_eventemitter" },
       "link-npm-bnjs": { name: "BN.js", url: "https:/\/www.npmjs.com/package/bn.js" },
       "link-npm-query-bignumber": "https:/\/www.npmjs.com/search?q=bignumber",
+      "link-npm-react-native-crypto": { name: "React Native Crypto", url: "https:/\/www.npmjs.com/package/react-native-crypto" },
 
       "link-js-array": "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array",
       "link-js-bigint": "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt",
       "link-js-normalize": { name: "String.normalize", url: "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize" },
       "link-js-maxsafe": "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER#Description",
+      "link-js-proxy": "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy",
       "link-js-typedarray": "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray",
 
       "link-ricmoo-humanreadableabi": "https:/\/blog.ricmoo.com/human-readable-contract-abis-in-ethers-js-141902f4d917",
@@ -278,5 +279,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

@@ -1,4 +1,4 @@
-_section: Contributing and Hacking
+_section: Contributing and Hacking @<contributing>
 
 The ethers.js library is something that I've written out of necessity,
 and has grown somewhat organically over time.
@@ -25,9 +25,121 @@ have a public discussion and figure out the best way to address to problem/featu
 **:)**
 
 
-_subsection: Building
+_subsection: Building @<contributing--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
+Since the library uses a monorepo, you must install an initial required
+set of libraries, which can then be used to install the remaining libraries
+used within each package, as well as link all the packages within the repo
+with each other.
 
+_code: Preparing for builds @lang<shell>
+
+# Clone the repository
+/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
+
+
+_subsection: Making your changes @<contributing--updating>
+
+TODO: Add more information here.
+
+_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
+
+
+_subsection: Documentation @<contributing--documentation>
+
+The documents are generated using [Flatworm](flatworm) documentation
+generation tool, which was written for the purpose of writing the documentation
+for ethers.
+
+Style Guide (this section will have much more coming):
+
+- Try to keep lines no longer than //around// 80 characters
+- Avoid inline links in the source; use the ``externalLinks`` field in the config.js
+- Prefix external links with ``link-``
+- Changing an anchor name must be well justified, as it will break all existing links
+  to that section; flatworm will support symlinks in the future
+- In general, I aim for xonsistency; look to similar situations throughout the documentation
+
+
+_heading: Building
+
+To build the documentation, you should first follow the
+[above steps](contributing--building) to build the ethers library.
+
+Building the docs will generate several types of output:
+
+- A full set of HTML pages, linking across each other
+- A single one-page HTML page with all pages linking to local anchors
+- A full set of README.md pages organized to be browsable and linkable in GitHub
+- A metadata dump for tool ingestion (still needs more work)
+- (@TODO; only half done) The documentation as a LaTeX and generated PDF
+
+_code: Building the Documentations @lang<shell>
+
+/home/ricmoo/ethers.js> npm run build-docs
+
+
+_heading: Evaluation
+
+When building the documentation, all code samples are run through a JavaScript
+VM to ensure there are no typos in the example code, as well the exact output
+of results are injected into the output, so there is no need to keep the results
+and code in-sync.
+
+However, this can be a bit of a headache when making many small changes, so to
+build the documentation faster, you can skip the evaluation step, which will
+inject the code directly.
+
+_code: Build docs skipping evaluation @lang<shell>
+
+/home/ricmoo/ethers.js> npm run build-docs -- --skip-eval
+
+
+_heading: Previewing Changes
+
+To preview the changes locally, you can use any standard web server and run
+from the ``/docs/`` folder, or use the built-in web server.
+
+The same caveats as normal web development apply, such flushing browser
+caches after changing (and re-building) the docs.
+
+_code: Running a webserver @lang<shell>
+
+/home/ricmoo/ethers.js> npm run serve-docs

docs.wrm/cookbook/index.wrm

@@ -1,5 +1,9 @@
 _section: Cookbook
 
-Cooking...
+A collection (that will grow over time) of common, simple
+snippets of code that are in general useful.
 
+_toc:
+
+  react-native
 

docs.wrm/cookbook/react-native.wrm

@@ -0,0 +1,47 @@
+_section: React Native (and ilk) @<cookbook-reactnative>
+
+The [[link-react-native]] framework has become quite popular and
+has many popular forks, such as [[link-expo]].
+
+React Native is based on [[link-javascriptcore]] (part of WebKit) and
+does not use Node.js or the common Web and DOM APIs. As such,
+there are many operations missing that a normal web environment
+or Node.js instance would provide.
+
+For this reason, there is a [[link-npm-ethersproject-shims]] module
+provided to fill in the holes.
+
+
+_subsection: Installing @<cookbook-reactnative-shims>
+
+To use ethers in React Native, you must either provide shims for the needed
+missing functionality, or use the ethers.js shim.
+
+It is **HIGHLY RECOMMENDED** you check out the [security section](cookbook-reactnative-security>
+below for instructions on installing packages which can affect the security
+of your application.
+
+After installing packages, you may need to restart your packager and company.
+
+_code: Installing @lang<shell>
+
+/home/ricmoo/my-react-project> npm install @ethersproject/shims --save
+
+_code: Importing @lang<script>
+
+// Pull in the shims (BEFORE importing ethers)
+import "@ethersproject/shims"
+
+// Import the ethers library
+import { ethers } from "ethers";
+
+
+_subsection: Security @<cookbook-reactnative-security>
+
+The React Native environment does not contain a secure random source, which
+is used when computing random private keys. This could result in private
+keys that others could guess, allowing the funds to be stolen.
+
+For this reason, it is **HIGHLY RECOMMENDED** to get either the
+[[link-npm-react-native-crypto]] module working or some equivalent.
+

docs.wrm/documentation.wrm

@@ -1,4 +1,4 @@
-_section: Flatworm Docs
+_section: Flatworm Docs @<flatworm>
 
 The //Flatworm Docs// rendering engine is designed to be **very**
 simple, but provide enough formatting necessary for documenting
@@ -102,7 +102,7 @@ _definition: **_table:** //FOOTER//
 
 Creates a [Table](flatworm--table) structured according to the body.
 
-Each cell support and variables support markdown.
+Each cell contents supports markdown and variables supports markdown.
 
 **Extensions:** [@style](flatworm--ext-style)
 
@@ -173,7 +173,8 @@ This is placed in an orange box.
 
 
 \_null:
-This breaks out of a directive. For example, to end a
+This breaks out of a directive. For example, to end
+a ``_note:`` or ``_code:``.
 
 
 _subsection: Markdown @<flatworm-markdown>
@@ -279,7 +280,7 @@ The language can be specified using the [@lang extension](flatworm--ext-lang).
 _table:
 
 |  **Language**  |                             **Notes**                                    |
-|   javascript   | Syntax highlights and [evaluates](flatworm--code-eval) the JavaScipt     |
+|   javascript   | Syntax highlights and [evaluates](flatworm--code-eval) the JavaScript    |
 |   script       | Same as ``javascript``, but does not evaluate the results                |
 |   shell        | Shell scripts or command-line                                            |
 |   text         | Plain text with no syntax highlighting                                   |
@@ -378,7 +379,7 @@ _heading: Variables  @<flatworm--table-variable>
 
 Often the layout of a table is easier to express and maintain without
 uneven or changing content within it. So the content can be defined
-separately within a table directive using **variables**. A varaible
+separately within a table directive using **variables**. A variable
 name must being with a letter and must only contain letters and numbers.
 
 Variables are also useful when content is repeated throughout a table.

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
+Ethers' various Classes and Functions are available to import
 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
+/home/ricmoo> npm install --save ethers
 
 
-_subsection: Importing
+_subsection: Importing @<importing>
 
 _heading: Node.js
 
@@ -32,17 +32,343 @@ It is generally better practice (for security reasons) to copy the
 [ethers library](link-ethers-js) to your own webserver and serve it
 yourself.
 
-For quick demos or prototyping though, it can be loaded in your
+For quick demos or prototyping though, you can load it in your
 Web Applications from our CDN.
 
 
 _code: ES6 in the Browser @lang<html>
 
-<script src="https://cdn.ethers.io/lib/ethers-5.0.esm.min.js"
-        type="application/javascipt"></script>
+<script type="module">
+    import { ethers } from "https://cdn.ethers.io/lib/ethers-5.0.esm.min.js";
+    // Your code here...
+</script>
 
 
 _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>
+        type="application/javascript"></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 applications 
+            can use it like a normal JavaScript 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 things (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, you need the account signer...
+const signer = provider.getSigner()
+
+_subsection: Connecting to Ethereum: RPC @<getting-started--connecting-rpc>
+
+The [JSON-RPC API](link-jsonrpc) is another popular method for interacting
+with Ethereum and is available in all major Ethereum node implementations
+(e.g. [[link-geth]] and [[link-parity]]) as well as many
+third-party web services (e.g. [[link-infura]]). It typically provides:
+
+- A connection to the Ethereum network (a [[Provider]])
+- Holds your private key and can sign thing (a [[Signer]])
+
+_code: Connecting to an RPC client @lang<script>
+
+// If you don't specify a //url//, Ethers connects to the default 
+// (i.e. ``http:/\/localhost:8545``)
+const provider = new ethers.providers.JsonRpcProvider();
+
+// The provider 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 you can use 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, if supported by network)
+balance = await provider.getBalance("ethers.eth")
+//! async balance
+
+// Often you need to format the output to something more user-friendly,
+// such as in ether (instead of wei)
+ethers.utils.formatEther(balance)
+//!
+
+// 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 methods
+mapped to encoding and decoding data for you.
+
+If you are familiar with Databases, this is similar to an //Object Relational Mapper// (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, and when you pass in the ABI to the constructor it uses it
+to determine which methods to add.
+
+While an 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 you can use the
+Human-Readable ABI in code, which the following examples use.
+
+_code: Connecting to the DAI Contract @lang<javascript>
+
+// You can also 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 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 symbol (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. You need to connect to a Signer, so
+// that you 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 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 are used for
+// logging into a service, such as CryptoKitties,
+// 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 characters 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.
+has since expanded into a 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)
@@ -38,6 +38,7 @@ _toc:
 
     getting-started
     concepts
+    api-keys
     api
     cli
     cookbook
@@ -48,7 +49,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/migration/ethers-v4.wrm

@@ -1,5 +1,16 @@
 _section: Migration: From Ethers v4  @<migration-v4>
 
+This document only covers the features present in v4 which have changed
+in some important way in v5.
+
+It does not cover all the new additional features that have been added and
+mainly aims to help those updating their older scripts and applications to
+retain functional parity.
+
+If you encounter any missing changes, please let me know and I'll update this
+guide.
+
+
 _subsection: BigNumber
 
 _heading: Namespace
@@ -18,6 +29,7 @@ ethers.BigNumberish
 
 
 _heading: Creating Instances
+
 The ``bigNumberify`` method was always preferred over the constructor
 since it could short-circuit an object instantiation for [[BigNumber]
 objects (since they are immutable). This has been moved to a static
@@ -37,9 +49,99 @@ ethers.BigNumber.from(someValue)
 
 _subsection: Contracts
 
-_code: @lang<script>
+_heading: ENS Name Resolution
 
-// @TODO
+The name of the resolved address has changed. If the address passed into the
+constructor was an ENS name, the address will be resolved before any calls
+are made to the contract.
+
+The name of the property where the resolved address has changed from ``addressPromise``
+to ``resolvedAddress``.
+
+_code: Resolved ENS Names @lang<script>
+
+// v4
+contract.addressPromise
+
+// v5
+contract.resolvedAddress
+
+
+_heading: Gas Estimation
+
+The only difference in gas estimation is that the bucket has changed
+its name from ``estimate`` to ``estimateGas``.
+
+_code: Gas Estimation @lang<script>
+
+// v4
+contract.estimate.transfer(toAddress, amount)
+
+// v5
+contract.estimateGas.transfer(toAddress, amount)
+
+_heading: Functions
+
+In a contract in ethers, there is a ``functions`` bucket, which exposes
+all the methods of a contract.
+
+All these functions are available on the root contract itself as well
+and historically there was no difference between ``contact.foo`` and
+``contract.functions.foo``. The original reason for the ``functions`` bucket
+was to help when there were method names that collided with other buckets,
+which is rare.
+
+In v5, the ``functions`` bucket is now intended to help with frameworks and
+for the new error recovery API, so most users should use the methods on the
+root contract.
+
+The main difference will occur when a contract method only returns a single
+item. The root method will dereference this automatically while the ``functions``
+bucket will preserve it as an [[Result]].
+
+If a method returns multiple items, there is no difference.
+
+This helps when creating a framework, since the result will always be known to
+have the same number of components as the [[Fragment]] outputs, without having
+to handle the special case of a single return value.
+
+_code: Functions Bucket @lang<script>
+
+const abi = [
+
+  // Returns a single value
+  "function single() view returns (uint8)",
+
+  // Returns two values
+  "function double() view returns (uint8, uint8)",
+];
+
+// v4
+await contract.single()
+// 123
+await contract.functions.single()
+// 123
+
+
+// v5 (notice the change in the .function variant)
+await contract.single()
+// 123
+await contract.functions.single()
+// [ 123 ]
+
+
+// v4
+await contract.double()
+// [ 123, 5 ]
+await contract.functions.double()
+// [ 123, 5 ]
+
+
+// v5 (no difference from v4)
+await contract.double()
+// [ 123, 5 ]
+await contract.functions.double()
+// [ 123, 5 ]
 
 
 _subsection: Errors
@@ -49,7 +151,7 @@ All errors now belong to the [[Logger]] class and the related functions
 have been moved to [[Logger]] instances, which can include a per-package
 version string.
 
-Global error fucntions have been moved [[Logger]] class methods.
+Global error functions have been moved [[Logger]] class methods.
 
 _code: @lang<script>
 
@@ -84,6 +186,7 @@ logger.info(...)
 
 
 _subsection: Interface
+
 The [[Interface]] object has undergone the most dramatic changes.
 
 It is no longer a meta-class and now has methods that simplify handling
@@ -99,14 +202,14 @@ interface.functions.transfer.encode(to, amount)
 interface.functions.transfer.decode(callData)
 
 // v5
-interface.encodeData("transfer", [ to, amount ])
-interface.decodeResult("transfer", data)
+interface.encodeFunctionData("transfer", [ to, amount ])
+interface.decodeFunctionResult("transfer", data)
 
 // Or you can use any compatible signature or Fragment objects.
 // Notice that signature normalization is performed for you,
 // e.g. "uint" and "uint256" will be automatically converted
-interface.encodeData("transfer(address,uint)", [ to, amount ])
-interface.decodeResult("transfer(address to, uint256 amount)", data)
+interface.encodeFunctionData("transfer(address,uint)", [ to, amount ])
+interface.decodeFunctionResult("transfer(address to, uint256 amount)", data)
 
 
 _heading: Events
@@ -119,7 +222,7 @@ interface.events.Transfer.decode(data, topics)
 
 // v5
 interface.encodeFilterTopics("Transfer", values)
-interface.encodeEventLog("Transfer", data, topics)
+interface.decodeEventLog("Transfer", data, topics)
 
 
 _heading: Inspection
@@ -178,14 +281,6 @@ const eventSig = eventFragment.format()
 const topic = interface.getTopic(eventFragment)
 
 
-_subsection: Utilities
-
-_heading: Renaming
-
-_code: @lang<script>
-
-// @TODO
-
 _subsection: Wallet
 
 _heading: Mnemonic Phrases

docs.wrm/migration/web3.wrm

@@ -1,13 +1,198 @@
 _section: Migration: From Web3.js
 
-TODO
-
-_subsection: Contracts
+This migration guide focuses on migrating web3.js version 1.2.9 to ethers.js v5.
 
 _subsection: Providers
 
+In ethers, a provider provides an abstraction for a connection to the Ethereum Network. It can be used to issue read only queries and send signed state changing transactions to the Ethereum Network.
+
+_heading: Connecting to Ethereum
+
+_code: @lang<script>
+
+// web3
+var Web3 = require('web3');
+var web3 = new Web3('http://localhost:8545');
+
+// ethers
+var ethers = require('ethers');
+const url = "http://127.0.0.1:8545";
+const provider = new ethers.providers.JsonRpcProvider(url);
+
+
+_heading: Connecting to Ethereum: Metamask
+
+
+_code: @lang<script>
+
+// web3
+const web3 = new Web3(Web3.givenProvider);
+
+// ethers
+const provider = new ethers.providers.Web3Provider(window.ethereum);
+
+
+_subsection: Signers
+
+In ethers, a **signer** is an abstraction of an Ethereum Account. It can be used to sign messages and transactions and send signed transactions to the Ethereum Network.
+
+In web3, an account can be used to sign messages and transactions.
+
+
+_heading: Creating signer
+
+_code: @lang<script>
+
+// web3
+const account = web3.eth.accounts.create();
+
+// ethers (create random new account)
+const signer = ethers.Wallet.createRandom();
+
+// ethers (connect to JSON-RPC accounts)
+const signer = provider.getSigner();
+
+
+_heading: Signing a message
+
+_code: @lang<script>
+
+// web3 (using a private key)
+signature = web3.eth.accounts.sign('Some data', privateKey)
+
+// web3 (using a JSON-RPC account)
+// @TODO
+
+// ethers
+signature = await signer.signMessage('Some data')
+
+
+_subsection: Contracts
+
+A contract object is an abstraction of a smart contract on the Ethereum Network. It allows for easy interaction with the smart contact.
+
+_heading: Deploying a Contract
+
+_code: @lang<script>
+
+// web3
+const contract = new web3.eth.Contract(abi);
+contract.deploy({
+   data: bytecode,
+   arguments: ["my string"]
+})
+.send({
+   from: "0x12598d2Fd88B420ED571beFDA8dD112624B5E730",
+   gas: 150000,
+   gasPrice: "30000000000000"
+}), function(error, transactionHash){ ... })
+.then(function(newContract){
+    console.log('new contract', newContract.options.address) 
+});
+
+// ethers
+const signer = provider.getSigner();
+const factory = new ethers.ContractFactory(abi, bytecode, signer);
+const contract = await factory.deploy("hello world");
+console.log('contract address', contract.address);
+
+// wait for contract creation transaction to be mined
+await contract.deployTransaction.wait();
+
+
+_heading: Interacting with a Contract
+
+_code: @lang<script>
+
+// web3
+const contract = new web3.eth.Contract(abi, contractAddress);
+// read only query
+contract.methods.getValue().call();
+// state changing operation
+contract.methods.changeValue(42).send({from: ....})
+.on('receipt', function(){
+    ...
+});
+
+// ethers
+// pass a provider when initiating a contract for read only queries
+const contract = new ethers.Contract(contractAddress, abi, provider);
+const value = await contract.getValue();
+
+
+// pass a signer to create a contract instance for state changing operations
+const contract = new ethers.Contract(contractAddress, abi, signer);
+const tx = await contract.changeValue(33);
+
+// wait for the transaction to be mined
+const receipt = await tx.wait();
+
+
+_heading: Overloaded Functions
+
+Overloaded functions are functions that have the same name but different parameter
+types.
+
+In ethers, the syntax to call an overloaded contract function is different
+from the non-overloaded function. This section shows the differences between web3
+and ethers when calling overloaded functions.
+
+See [issue #407](link-issue-407) for more details.
+
+_code: @lang<script>
+
+// web3
+message = await contract.methods.getMessage('nice').call();
+
+
+// ethers
+const abi = [
+  "function getMessage(string) public view returns (string)",
+  "function getMessage() public view returns (string)"
+]
+const contract = new ethers.Contract(address, abi, signer);
+
+// for ambiguous functions (two functions with the same
+// name), the signature must also be specified
+message = await contract['getMessage(string)']('nice');
+
+
 _subsection: Numbers
 
+_heading: BigNumber
+
+Convert to BigNumber:
+
+_code: @lang<script>
+
+// web3
+web3.utils.toBN('123456');
+
+// ethers (from a number; must be within safe range)
+ethers.BigNumber.from(123456)
+
+// ethers (from base-10 string)
+ethers.BigNumber.from("123456")
+
+// ethers (from hex string)
+ethers.BigNumber.from("0x1e240")
+
+
 _subsection: Utilities
 
+_heading: Hash
+
+Computing Keccak256 hash of a UTF-8 string in web3 and ethers:
+
+_code: @lang<script>
+
+// web3
+web3.utils.sha3('hello world');
+web3.utils.keccak256('hello world');
+
+// ethers (hash of a string)
+ethers.utils.id('hello world')
+
+// ethers (hash of binary data)
+ethers.utils.keccak256('0x4242')
 

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.wrm/testing/index.wrm

@@ -1,3 +1,385 @@
 _section: Testing
 
-Here goes info about testing
+Testing is a critical part of any library which wishes to remain secure, safe
+and reliable.
+
+Ethers currently has **over 23k tests** among its test suites, which are all
+made available for other projects to use as simple exported GZIP-JSON files.
+
+The tests are run on every check-in and the results can been seen on the
+[GitHub CI Action](link-github-ci).
+
+We also strive to constantly add new test cases, especially when issues
+arise to ensure the issue is present prior to the fix, corrected after the
+fix and included to prevent future changes from causing a regression.
+
+A large number of the test cases were created procedurally by using
+known correct implementations from various sources (such as Geth) and
+written in different languages and verified with multiple libraries.
+
+For example, the ABI test suites were generated by procedurally generating
+a list of types, for each type choosing a random (valid) value, which then
+was converted into a Solidity source file, compiled using ``solc`` and
+deployed to a running Parity node and executed, with its outputs being
+captured. Similar to the how many of the hashing, event and selector test
+cases were created.
+
+
+_subsection: Supported Platforms @<testing-supported>
+
+While web technologies move quite fast, especially in the Web3 universe, we try
+to keep ethers as accessible as possible.
+
+Currently ethers should work on almost any ES3 or better environment and tests
+are run against:
+
+- node.js 8.x
+- node.js 10.x
+- node.js 12.x
+- node.js 13.x
+- Web Browsers (using UMD)
+- Web Browsers (using ES modules)
+
+If there is an environment you feel has been overlooked or have suggestions, please feel
+free to reach out by opening an [issue on Github](link-github-issues).
+
+We would like to add a test build for Expo and React as those developers often seem
+to encounter pain points when using ethers, so if you have experience or ideas on this,
+[bug us](link-github-issues).
+
+The next Major version (probably summer 2021) will likely drop support for node 8.x
+and will require ES2015 for [Proxy](link-js-proxy).
+
+Certain features in JavaScript are also avoided, such as look-behind tokens in regular
+expressions, since these have caused conflicts (at import time) with certain JavaScript
+environments such as [Otto](link-otto).
+
+Basically, the moral of the story is "be inclusive and don't drop people needlessly".
+
+
+_subsection: Test Suites @<testing-suites>
+
+The test suites are available as gzipped JSON files in the
+``@ethersproject/testcases``, which makes it easy to install and import
+(both GZIP and JSON are quite easy to consume from most langauges). Each
+test suite also has its schema available in this package.
+
+_table: Test Suites @style<full>
+
+$Account:            Private Keys and addresses in checksum and ICAP formats
+$ContractEvents:     Compiled Solidity, ABI interfaces, input types/values with the
+                     output types/values for emitted events; all tests were
+                     executed against real Ethereum nodes
+$ContractAbi:        Compiled Solidity, ABI interfaces, input types/values with the
+                     output types/values, encoded and decoded binary data and normalized
+                     values for function calls executed against real Ethereum nodes.
+$ContractAbi2:       Identical to ``contract-interface``, except with emphasis on
+                     the ABIv2 coder which supports nested dynami types and structured
+                     data
+$ContractSignatures: Contract signatures and matching selectors
+$Hashes:             Data and respective hashes against a variety of hash functions
+$HDNode:             HDNodes (BIP-32) with mnemonics, entropy, seed and computed nodes
+                     with pathes and addresses
+$Namehash:           ENS names along with computed [namehashes](link-namehash
+$Nameprep:           IDNA and Nameprep representations including official vectors
+$RLP:                Recursive-Length Prefix (RLP) data and encodings
+$SoliditiyHashes:    Hashes based on the Solidity non-standard packed form
+$Transactions:       Signed and unsigned transactions with their serialized formats
+                     including both with and without EIP-155 replay protection
+$Units:              Values converted between various units
+$Wallet:             Keystore JSON format wallets, passwords and decrypted values
+$Wordlist:           Fully decompressed BIP-39 official wordlists
+
+|   **Filename**                   |  **Test Cases**        <|
+| accounts.json.gz                 | $Account               <|
+| contract-events.json.gz          | $ContractEvents        <|
+| contract-interface.json.gz       | $ContractAbi           <|
+| contract-interface-abi2.json.gz  | $ContractAbi2          <|
+| contract-signatures.json.gz      | $ContractSignatures    <|
+| hashes.json.gz                   | $Hashes                <|
+| hdnode.json.gz                   | $HDNode                <|
+| namehash.json.gz                 | $Namehash              <|
+| nameprep.json.gz                 | $Nameprep              <|
+| rlp-coder.json.gz                | $RLP                   <|
+| solidity-hashes.json.gz          | $SoliditiyHashes       <|
+| transactions.json.gz             | $Transactions          <|
+| units.json.gz                    | $Units                 <|
+| wallets.json.gz                  | $Wallet                <|
+| wordlists.json.gz                | $Wordlist              <|
+
+
+_subsection: Test Suite API @<testing-api>
+
+There are also convenience functions for those developing directly in TypeScript.
+
+_property: testcases.loadTests(tag) => Array<TestCase>
+Load all the given testcases for the //tag//.
+
+A tag is the string in the above list of test case names not including
+any extension (e.g. ``"solidity-hashes"``)
+
+_property: testcases.TestCase.TEST_NAME
+Most testcases have its schema available as a TypeScript type to make testing
+each property easier.
+
+_heading: Deterministic Random Numbers (DRNG)
+
+When creating test cases, often we want want random data from the perspective
+we do not case what values are used, however we want the values to be consistent
+accross runs. Otherwise it becomes difficult to reproduce an issue.
+
+In each of the following the seed is used to control the random value returned. Be
+sure to tweak the seed properly, for example on each iteration change the value and
+in recursive functions, concatenate to the seed.
+
+_property: testcases.randomBytes(seed, lower [, upper ]) => Uint8Array
+Return at least //lower// random bytes, up to //upper// (exclusive) if specified,
+given //seed//. If //upper// is omitted, exactly ///lower// bytes are returned.
+
+_property: testcases.randomHexString(seed, lower [, upper ]) => string<[[DataHexString]]>
+Identical to randomBytes, except returns the value as a [[DataHexString]] instead of a
+Uint8Array.
+
+_property: testcases.randomNumber(seed, lower, upper) => number
+Returns a random number of at least //lower// and less than //upper//
+given //seed//.
+
+
+_subsection: Schemas @<testing-schemas>
+
+This section is still a work in progress, but will outline some of the more nuanced
+aspects of the test cases and their values.
+
+There will likely be an overhaul of the test cases in the next major version, to
+make code coverage testing more straight forward and to collapse some of the redundancy.
+
+For example, there is no longer a need to separate the ABI and ABIv2 test case and the
+accounts and transactions suites can be merged into one large collection.
+
+
+_heading: Accounts
+
+Basic account information using a private key and computing various address forms.
+
+Tests were verified against [EthereumJS](https:/\/github.com/ethereumjs) and custom
+scripts created to directly interact with Geth and cpp implementations.
+
+//See: ``accounts.json.gz``//
+
+_table: Properties
+
+|   **Property**      |   **Meaning**                             |
+|   name              |  The testcase name                        |
+|   privateKey        |  The private key                          |
+|   address           |  The address (lowercase)                  |
+|   checksumAddress   |  The address with checksum-adjusted case  |
+|   icapAddress       |  The ICAP address                         |
+
+_code: Example @lang<script>
+{
+  "name":            "random-1023",
+  "address":         "0x53bff74b9af2e3853f758a8d2bd61cd115d27782",
+  "privateKey":      "0x8ab0e165c2ea461b01cdd49aec882d179dccdbdb5c85c3f9c94c448aa65c5ace",
+  "checksumAddress": "0x53bFf74b9Af2E3853f758A8D2Bd61CD115d27782",
+  "icapAddress":     "XE709S6NUSJR6SXQERCMYENAYYOZ2Y91M6A"
+}
+
+
+_heading: Contract Interface
+
+Procedurally generated test cases to test ABI coding.
+
+_code: Example @lang<script>
+{
+  "name":             "random-1999",
+  "source":           "contract Test {\n    function test() constant returns (address, bool, bytes14[1]) {\n        address a = address(0x061C7F399Ee738c97C7b7cD840892B281bf772B5);\n        bool b = bool(true);\n        bytes14[1] memory c;\n        c[0] = bytes14(0x327621c4abe12d4f21804ed40455);\n        return (a, b, c);\n    }\n}\n",
+  "types":            "[\"address\",\"bool\",\"bytes14[1]\"]",
+  "interface":        "[{\"constant\":true,\"inputs\":[],\"name\":\"test\",\"outputs\":[{\"name\":\"\",\"type\":\"address\"},{\"name\":\"\",\"type\":\"bool\"},{\"name\":\"\",\"type\":\"bytes14[1]\"}],\"type\":\"function\"}]\n",
+  "bytecode":         "0x6060604052610175806100126000396000f360606040526000357c010000000000000000000000000000000000000000000000000000000090048063f8a8fd6d1461003957610037565b005b610046600480505061009d565b604051808473ffffffffffffffffffffffffffffffffffffffff1681526020018315158152602001826001602002808383829060006004602084601f0104600f02600301f150905001935050505060405180910390f35b600060006020604051908101604052806001905b60008152602001906001900390816100b157905050600060006020604051908101604052806001905b60008152602001906001900390816100da5790505073061c7f399ee738c97c7b7cd840892b281bf772b59250600191506d327621c4abe12d4f21804ed404557201000000000000000000000000000000000000028160006001811015610002579090602002019071ffffffffffffffffffffffffffffffffffff191690818152602001505082828295509550955061016d565b50505090919256",
+  "result":           "0x000000000000000000000000061c7f399ee738c97c7b7cd840892b281bf772b50000000000000000000000000000000000000000000000000000000000000001327621c4abe12d4f21804ed40455000000000000000000000000000000000000",
+  "values":           "[{\"type\":\"string\",\"value\":\"0x061C7F399Ee738c97C7b7cD840892B281bf772B5\"},{\"type\":\"boolean\",\"value\":true},[{\"type\":\"buffer\",\"value\":\"0x327621c4abe12d4f21804ed40455\"}]]",
+  "normalizedValues": "[{\"type\":\"string\",\"value\":\"0x061C7F399Ee738c97C7b7cD840892B281bf772B5\"},{\"type\":\"boolean\",\"value\":true},[{\"type\":\"buffer\",\"value\":\"0x327621c4abe12d4f21804ed40455\"}]]",
+  "runtimeBytecode":  "0x60606040526000357c010000000000000000000000000000000000000000000000000000000090048063f8a8fd6d1461003957610037565b005b610046600480505061009d565b604051808473ffffffffffffffffffffffffffffffffffffffff1681526020018315158152602001826001602002808383829060006004602084601f0104600f02600301f150905001935050505060405180910390f35b600060006020604051908101604052806001905b60008152602001906001900390816100b157905050600060006020604051908101604052806001905b60008152602001906001900390816100da5790505073061c7f399ee738c97c7b7cd840892b281bf772b59250600191506d327621c4abe12d4f21804ed404557201000000000000000000000000000000000000028160006001811015610002579090602002019071ffffffffffffffffffffffffffffffffffff191690818152602001505082828295509550955061016d565b50505090919256"
+}
+
+
+_heading: Contract Signatures
+
+Computed ABI signatures and the selector hash.
+
+_code: Example @lang<script>
+{
+  "name":      "random-1999",
+  "sigHash":   "0xf51e9244",
+  "abi":       "[{\"constant\":false,\"inputs\":[{\"name\":\"r0\",\"type\":\"string[2]\"},{\"name\":\"r1\",\"type\":\"uint128\"},{\"components\":[{\"name\":\"a\",\"type\":\"bytes\"},{\"name\":\"b\",\"type\":\"bytes\"},{\"name\":\"c\",\"type\":\"bytes\"}],\"name\":\"r2\",\"type\":\"tuple\"},{\"name\":\"r3\",\"type\":\"bytes\"}],\"name\":\"testSig\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"test\",\"outputs\":[{\"name\":\"r0\",\"type\":\"string[2]\"},{\"name\":\"r1\",\"type\":\"uint128\"},{\"components\":[{\"name\":\"a\",\"type\":\"bytes\"},{\"name\":\"b\",\"type\":\"bytes\"},{\"name\":\"c\",\"type\":\"bytes\"}],\"name\":\"r2\",\"type\":\"tuple\"},{\"name\":\"r3\",\"type\":\"bytes\"}],\"payable\":false,\"stateMutability\":\"pure\",\"type\":\"function\"}]",
+  "signature": "testSig(string[2],uint128,(bytes,bytes,bytes),bytes)"
+}
+
+_heading: Hashes
+
+_code: Examples @lang<script>
+{
+  "data":      "0x3718a88ceb214c1480c32a9d",
+  "keccak256": "0x82d7d2dc3d384ddb289f41917b8280675bb1283f4fe2b601ac7c8f0a2c2824fa",
+  "sha512":    "0xe93462bb1de62ba3e6a980c3cb0b61728d3f771cea9680b0fa947b6f8fb2198a2690a3a837495c753b57f936401258dfe333a819e85f958b7d786fb9ab2b066c",
+  "sha256":    "0xe761d897e667aa72141dd729264c393c4ddda5c62312bbd21b0f4d954eba1a8d"
+}
+
+
+_heading: Hierarchal Deterministic Node (BIP-32)
+
+Tests for [BIP-32](link-bip-32) HD Wallets.
+
+_code: Example @lang<script>
+{
+  "name":     "trezor-23",
+  "entropy":  "0xf585c11aec520db57dd353c69554b21a89b20fb0650966fa0a9d6f74fd989d8f",
+  "mnemonic": "void come effort suffer camp survey warrior heavy shoot primary clutch crush open amazing screen patrol group space point ten exist slush involve unfold",
+  "locale":   "en",
+  "password": "TREZOR",
+  "hdnodes": [
+    {
+      "path":       "m",
+      "address":    "0xfd8eb95169ce57eab52fb69bc6922e9b6454d9aa",
+      "privateKey": "0x679bf92c04cf16307053cbed33784f3c4266b362bf5f3d7ee13bed6f2719743c"
+    },
+    {
+      "address":    "0xada964e9f10c4fc9787f9e17f00c63fe188722b0",
+      "privateKey": "0xdcbcb48a2b11eef0aab93a8f88d83f60a3aaabb34f9ffdbe939b8f059b30f2b7",
+      "path":       "m/8'/8'/2/3/4"
+    },
+    {
+      "privateKey": "0x10fd3776145dbeccb3d6925e4fdc0d58b452fce40cb8760b12f8b4223fafdfa6",
+      "address":    "0xf3f6b1ef343d5f5f231a2287e801a46add43eb06",
+      "path":       "m/1'/3'"
+    },
+    {
+      "address":    "0xb7b0fdb6e0f79f0529e95400903321e8a601b411",
+      "privateKey": "0x093a8ff506c95a2b79d397aed59703f6212ff3084731c2f03089b069ae76e69d",
+      "path":       "m/8'/4'/7'"
+    },
+    {
+      "path":       "m/7'/5'/11",
+      "privateKey": "0x6bd79da4dfa7dd0abf566a011bdb7cba0d28bba9ca249ba25880d5dabf861b42",
+      "address":    "0x1b3ad5fa50ae32875748107f4b2160829cc10536"
+    },
+    {
+      "path":       "m/9'/6'/2'/7'/3'",
+      "address":    "0x42eb4bed59f3291d02387cf0fb23098c55d82611",
+      "privateKey": "0xfc173acba7bc8bb2c434965d9e99f5a221f81add421bae96a891d08d60be11dd"
+    }
+  ],
+  "seed": "0x01f5bced59dec48e362f2c45b5de68b9fd6c92c6634f44d6d40aab69056506f0e35524a518034ddc1192e1dacd32c1ed3eaa3c3b131c88ed8e7e54c49a5d0998"
+}
+
+
+_heading: ENS Namehash
+
+Test cases for the [ENS Namehash Algorithm](link-namehash).
+
+_code: Examples
+{
+  "expected": "0x33868cc5c3fd3a9cd3adbc1e868ea133d2218f60dc2660c3bc48d8b1f4961384",
+  "name":     "ViTalIk.WALlet.Eth",
+  "test":     "mixed case"
+}
+
+
+_heading: RLP Coder
+
+_code: Examples @lang<script>
+{
+  "name":    "arrayWithNullString3",
+  "encoded": "0xc3808080",
+  "decoded": [ "0x", "0x", "0x" ]
+}
+
+
+_heading: Solidity Hashes
+
+Tests for the non-standard packed form of the Solidity hash functions.
+
+These tests were created by procedurally generating random signatures and
+values that match those signatures, constructing the equivalent Soldity,
+compiling it and deploying it to a Parity node then evaluating the response.
+
+_code: Example @lang<script>
+{
+  "name":      "random-1999",
+  "keccak256": "0x7d98f1144a0cd689f720aa2f11f0a73bd52a2da1117175bc4bacd93c130966a1",
+  "ripemd160": "0x59384617f8a06efd57ab106c9e0c20c3e64137ac000000000000000000000000",
+  "sha256":    "0xf9aeea729ff39f8d372d8552bca81eb2a3c5d433dc8f98140040a03b7d81ac92",
+  "values": [
+    "0xcdffcb5242e6",
+    "0xc1e101b60ebe4688",
+    "0x5819f0ef5537796e43bdcd48309f717d6f7ccffa",
+    "0xec3f3f9f",
+    false,
+    true
+  ],
+  "types": [
+    "int184",
+    "int176",
+    "address",
+    "int64",
+    "bool",
+    "bool"
+  ]
+}
+
+
+_heading: Transactions
+
+Serialized signed and unsigned transactions with both EIP-155 enabled and
+disabled.
+
+_code: Examples @lang<script>
+{
+  "name":                        "random-998",
+  "privateKey":                  "0xd16c8076a15f7fb583f05dc12686fe526bc59d298f1eb7b9a237b458133d1dec",
+  "signedTransactionChainId5":   "0xf8708391d450848517cfba8736fcf36da03ee4949577303fd4e0acbe72c6c116acab5bf63f0b1e9c8365fdc7827dc82ea059891894eb180cb7c6c45a52f62d2103420d3ad0bc3ba518d0a25ed910842522a0155c0ea2aee2ea82e75843aab297420bad907d46809d046b13d692928f4d78aa",
+  "gasLimit":                    "0x36fcf36da03ee4",
+  "to":                          "0x9577303fd4e0acbe72c6c116acab5bf63f0b1e9c",
+  "data":                        "0x7dc8",
+  "accountAddress":              "0x6d4a6aff30ca5ca4b8422eea0ebcb669c7d79859",
+  "unsignedTransaction":         "0xed8391d450848517cfba8736fcf36da03ee4949577303fd4e0acbe72c6c116acab5bf63f0b1e9c8365fdc7827dc8",
+  "nonce":                       "0x91d450",
+  "gasPrice":                    "0x8517cfba",
+  "signedTransaction":           "0xf8708391d450848517cfba8736fcf36da03ee4949577303fd4e0acbe72c6c116acab5bf63f0b1e9c8365fdc7827dc81ba05030832331e6be48c95e1569a1ca9505c495486f72d6009b3a30fadfa05d9686a05cd3116b416d2362da1e9b0ca7fb1856c4e591cc22e63b395bd881ce2d3735e6",
+  "unsignedTransactionChainId5": "0xf08391d450848517cfba8736fcf36da03ee4949577303fd4e0acbe72c6c116acab5bf63f0b1e9c8365fdc7827dc8058080",
+  "value":                       "0x65fdc7"
+}
+
+
+_heading: Units
+
+Unit conversion.
+
+_code: Example @lang<script>
+{
+  "name":          "one-two-three-3",
+  "gwei_format":   "-1234567890123456.789012345",
+  "ether_format":  "-1234567.890123456789012345",
+  "gwei":          "-1234567890123456.789012345",
+  "ether":         "-1234567.890123456789012345",
+  "finney":        "-1234567890.123456789012345",
+  "wei":           "-1234567890123456789012345",
+  "finney_format": "-1234567890.123456789012345"
+}
+
+
+_heading: Wallets
+
+Tests for the JSON keystore format.
+
+_code: Example @lang<script>
+{
+  "mnemonic":   null,
+  "name":       "secretstorage_password",
+  "type":       "secret-storage",
+  "password":   "foo",
+  "privateKey": "0xf03e581353c794928373fb0893bc731aefc4c4e234e643f3a46998b03cd4d7c5",
+  "hasAddress": true,
+  "json":       "{\"address\":\"88a5c2d9919e46f883eb62f7b8dd9d0cc45bc290\",\"Crypto\":{\"cipher\":\"aes-128-ctr\",\"ciphertext\":\"10adcc8bcaf49474c6710460e0dc974331f71ee4c7baa7314b4a23d25fd6c406\",\"cipherparams\":{\"iv\":\"1dcdf13e49cea706994ed38804f6d171\"},\"kdf\":\"scrypt\",\"kdfparams\":{\"dklen\":32,\"n\":262144,\"p\":1,\"r\":8,\"salt\":\"bbfa53547e3e3bfcc9786a2cbef8504a5031d82734ecef02153e29daeed658fd\"},\"mac\":\"1cf53b5ae8d75f8c037b453e7c3c61b010225d916768a6b145adf5cf9cb3a703\"},\"id\":\"fb1280c0-d646-4e40-9550-7026b1be504a\",\"version\":3}\n",
+  "address":    "0x88a5c2d9919e46f883eb62f7b8dd9d0cc45bc290"
+}

docs/api-keys/index.html

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>API Keys - ethers</title>
+  </head>
+  <body>
+    Redirect to /v5/api-keys.
+  </body>
+</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