admin: updated dist files

Create security policy.

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: [ 'https://gitcoin.co/grants/13/ethersjs-complete-simple-and-tiny-2', 'https://www.buymeacoffee.com/ricmoo' ]

.github/ISSUE_TEMPLATE/beta-issue.yml

@@ -0,0 +1,74 @@
+name: Beta (v6) Bug
+description: Open an issue for a bug in the v6 beta
+title: "Title Here"
+labels: ["v6-beta"]
+assignees:
+  - ricmoo
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This form is **only** for issues in the **v6 beta**, which you
+        can access using either the `v6-beta` tag in the repository or
+        install using `ethers@beta` with `npm`.
+
+        The v6 branch will be very lively, undergoing a lot of changes,
+        including backwards compatible changes between beta versions.
+
+        Before opening an issue, please make sure you have
+        **fully updated to the latest version** by removing the
+        `node_modules/` and `package-lock.json` and then running a
+        fresh `npm install`. Otherwise you may end up with incompatible
+        versions which may conflict with each other.
+
+        Thanks for trying out the v6 beta! Cheers!
+  - type: input
+    id: version
+    attributes:
+      label: Ethers Version
+      description: What version of ethers are you using? Before opening an issue, please make sure you are using the latest beta.
+      placeholder: x.y.z
+    validations:
+      required: true
+  - type: textarea
+    id: about-the-bug
+    attributes:
+      label: Describe the Problem
+      description: Please describe what you expected to happen vs what did happen?
+      placeholder: What happened?
+    validations:
+      required: true
+  - type: textarea
+    id: code-snippet
+    attributes:
+      label: Code Snippet
+      description: If possible, please include a **short and concise** code snippets that can reproduce this issue. Ideally code that can be pasted into the [Ethers Playground](https://playground.ethers.org).
+      placeholder: e.g. provider.getBlockNumber()
+      render: shell
+  - type: textarea
+    id: errors
+    attributes:
+      label: Errors
+      description: If there is an error, please include the **entire error** (redacting any sensitive information).
+      placeholder: "e.g. Error: invalid name (code='INVALID_ARGUMENT, ...)"
+      render: shell
+  - type: dropdown
+    id: environment
+    attributes:
+      label: Environment
+      description: What environment, platforms or frameworks are you using? Select all that apply.
+      multiple: true
+      options:
+        - node.js
+        - Browser (Chrome, Safari, etc)
+        - React Native/Expo/JavaScriptCore
+        - Hardhat
+        - Geth
+        - Parity
+        - Ganache
+        - Other (please specify)
+  - type: input
+    id: other-envrionment
+    attributes:
+      label: Environment (Other)
+      placeholder: anything else?

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,81 @@
+name: Bug Report
+description: Open an issue for a bug in Ethers
+title: "Bug Report Title"
+labels: ["investigate"]
+assignees:
+  - ricmoo
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **READ THIS FIRST** and follow all instructions, please. `:)`
+
+        Thank you for taking the time to report an issue. This form is for reporting **bugs within ethers**.
+
+        If you are **new to ethers** or *uncertain* whether this is a bug in ethers, a bug in another framework or a bug in your own code, please [start a discussion](https://github.com/ethers-io/ethers.js/discussions) first.
+  - type: input
+    id: version
+    attributes:
+      label: Ethers Version
+      description: What version of ethers are you using? Before opening an issue, please make sure you are up to date.
+      placeholder: x.y.z
+    validations:
+      required: true
+  - type: input
+    id: search-terms
+    attributes:
+      label: Search Terms
+      description: Have you searched for answers [in the documentation](https://docs.ethers.io), through [the issues](https://github.com/ethers-io/ethers.js/issues) and [on the discusions](https://github.com/ethers-io/ethers.js/discussions)? Please include the search terms you have tried. This helps us add more keywords where needed.
+      placeholder: e.g. abi, network, utf8
+  - type: textarea
+    id: about-the-bug
+    attributes:
+      label: Describe the Problem
+      description: Please describe what you expected to happen vs what did happen?
+      placeholder: What happened?
+    validations:
+      required: true    
+  - type: textarea
+    id: code-snippet
+    attributes:
+      label: Code Snippet
+      description: If possible, please include a **short and concise** code snippets that can reproduce this issue. Ideally code that can be pasted into the [Ethers Playground](https://playground.ethers.org).
+      placeholder: e.g. provider.getBlockNumber()
+      render: shell
+  - type: textarea
+    id: contract-abi
+    attributes:
+      label: Contract ABI
+      description: If this involves a contract, please include any **concise and relevant** ABI fragments.
+      placeholder: e.g. [ 'function balanceOf(address owner) view returns (uint)' ]
+      render: shell
+  - type: textarea
+    id: errors
+    attributes:
+      label: Errors
+      description: If there is an error, please include the **entire error** (redacting any sensitive information).
+      placeholder: "e.g. Error: invalid name (code='INVALID_ARGUMENT, ...)"
+      render: shell
+  - type: dropdown
+    id: environment
+    attributes:
+      label: Environment
+      description: What environment, platforms or frameworks are you using? Select all that apply.
+      multiple: true
+      options:
+        - Ethereum (mainnet, ropsten, rinkeby, goerli, etc.)
+        - Altcoin (Matic, BNB, etc.)
+        - node.js (v12 or newer)
+        - node.js (older than v12)
+        - Browser (Chrome, Safari, etc)
+        - React Native/Expo/JavaScriptCore
+        - Hardhat
+        - Geth
+        - Parity
+        - Ganache
+        - Other (please specify)
+  - type: input
+    id: other-envrionment
+    attributes:
+      label: Environment (Other)
+      placeholder: anything else?

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,23 @@
+name: Documentation
+description: Documentation update, change or suggestion
+title: "Documentation Title"
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please include anything about the [documentation](https://docs.ethers.io) you would like to see improved.
+
+          - Missing information or details?
+          - Spelling or Grammar mistakes?
+          - Wrong Information?
+          - Dead or wrong links?
+          - Something needs code examples?
+          - General feedback or anything else?        
+  - type: textarea
+    id: suggestion
+    attributes:
+      label: Suggestion
+      placeholder: e.g. please add an example for ropsten
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,26 @@
+name: Feature Request
+description: Suggest a new feature or addition to Ethers
+title: "Feature Request Title"
+labels: [ "enhancement" ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        The best place to start a new feature request is by starting an [Idea discussion](https://github.com/ethers-io/ethers.js/discussions), to mull over the feature, discuss current options and think through the impact on the overall library.
+
+        Keep in mind that features increase the library size, and may require additional dependencies. Ethers strives to remain lean and the number of dependencies low, so many features may make more sense as ancillary packages.
+  - type: textarea
+    id: about-the-feature
+    attributes:
+      label: Describe the Feature
+      description: Please describe the feature, the problem it is solving, your solution and alternatives you've considered.
+      placeholder: e.g. I want Ethers to be more/less magical.
+    validations:
+      required: true
+  - type: textarea
+    id: code-example
+    attributes:
+      label: Code Example
+      description: Optionally, provide an example of how the feature would be used in code.
+      placeholder: e.g. provider.doMagic()
+      render: shell

.github/ISSUE_TEMPLATE/other.yml

@@ -0,0 +1,27 @@
+name: Other
+description: Open a general issue
+title: Other Issue Title
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **READ THIS FIRST**
+
+        This form should almost **NEVER** be used. Consider closely why your issue does not fit into one of the [other categories](https://github.com/ethers-io/ethers.js/issues/new/choose).
+        
+        You almost certainly wish to use [the discussions](https://github.com/ethers-io/ethers.js/discussions) instead, to ask a question or seek further guidance.
+  - type: textarea
+    id: about
+    attributes:
+      label: Describe your Issue
+      description: Please include as much relevant context as possible, be concise and clearly explain what you are looking for.
+      placeholder: e.g. What is the answer to life, the universe and everything?
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: This is an exception issue
+      description: This form is **only** for *exceptional issues*, which do not match any [other categoeries](https://github.com/ethers-io/ethers.js/issues/new/choose).
+      options:
+        - label: I understand this form is for exceptional issues and believe my issue qualifies.
+          required: true

.github/workflows/nodejs.yml

@@ -3,32 +3,49 @@ name: Node.js CI
 on:
   push:
     branches:
-      - ethers-v5-beta
+      - master
 
 jobs:
+
   test-node:
 
-    runs-on: ubuntu-latest
+#    runs-on: ubuntu-latest
+    runs-on: macos-latest
 
     strategy:
+      fail-fast: false
       matrix:
-        node-version: [8.x, 10.x, 12.x, 13.x]
+        node-version: [ 12.x, 14.x, 16.x ]
 
     steps:
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
-      - uses: actions/checkout@v2
-      - run: npm ci
-      - run: npm run bootstrap
-      - run: npm run test-node
+
+      - 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
+#    runs-on: ubuntu-latest
+    runs-on: macos-latest
 
     strategy:
+      fail-fast: false
       matrix:
         module: [ 'esm', 'umd' ]
 
@@ -36,8 +53,91 @@ jobs:
       - uses: actions/setup-node@v1
         with:
           node-version: 12.x
-      - uses: actions/checkout@v2
-      - run: npm ci
-      - run: npm run bootstrap
-      - run: npm run test-browser-${{ matrix.module }}
 
+      - 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
+    runs-on: macos-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,7 @@
 node_modules/
+packages/*/node_modules
+packages/*/lib._esm
+.package_node_modules/
 obsolete/
 .DS_Store
 .tmp/
@@ -18,3 +21,9 @@ lerna-debug.log
 packages/*/tsconfig.tsbuildinfo
 
 packages/testcases/input/nameprep/**
+
+.nyc_output/**
+
+output/**
+
+misc/testing/**

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,7 +1,7 @@
 The Ethers Project
 ==================
 
-[![npm (tag)](https://img.shields.io/npm/v/ethers/next)](https://www.npmjs.com/package/ethers/v/next)
+[![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)
 
 A complete Ethereum wallet implementation and utilities in JavaScript (and TypeScript).
@@ -17,7 +17,7 @@ A complete Ethereum wallet implementation and utilities in JavaScript (and TypeS
 - **Tiny** (~104kb compressed; 322kb uncompressed)
 - **Modular** packages; include only what you need
 - **Complete** functionality for all your Ethereum desires
-- Extensive [documentation](https://docs.ethers.io/ethers.js/html/)
+- 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
@@ -26,10 +26,12 @@ A complete Ethereum wallet implementation and utilities in JavaScript (and TypeS
 Keep Updated
 ------------
 
-For the latest news and advisories, please follow the [@ethersproject](https://twitter.com/ethersproject)
-on Twitter (low-traffic, non-marketting, important information only) as well as watch this GitHub project.
+For the latest 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).
+For the latest changes, see the
+[CHANGELOG](https://github.com/ethers-io/ethers.js/blob/master/CHANGELOG.md).
 
 
 Installing
@@ -38,13 +40,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.6.umd.min.js" type="text/javascript">
 </script>
 ```
 
@@ -52,7 +54,7 @@ Installing
 
 ```
 <script type="module">
-    import { ethers } from "https://cdn.ethers.io/lib/ethers-5.0.umd.min.js";
+    import { ethers } from "https://cdn.ethers.io/lib/ethers-5.6.esm.min.js";
 </script>
 ```
 
@@ -60,13 +62,40 @@ Installing
 Documentation
 -------------
 
-Browse the documentation online:
+Browse the [documentation](https://docs.ethers.io/v5/) online:
 
-- [Getting Started](https://docs.ethers.io/)
-- [Full API Documentation](https://docs.ethers.io/)
+- [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 browser the entire documentations as a [single page](https://docs.ethers.io/single-page/).
+
+Providers
+---------
+
+Ethers works closely with an ever-growing list of third-party providers
+to ensure getting started is quick and easy, by providing default keys
+to each service.
+
+These built-in keys mean you can use `ethers.getDefaultProvider()` and
+start developing right away.
+
+However, the API keys provided to ethers are also shared and are
+intentionally throttled to encourage developers to eventually get
+their own keys, which unlock many other features, such as faster
+responses, more capacity, analytics and other features like archival
+data.
+
+When you are ready to sign up and start using for your own keys, please
+check out the [Provider API Keys](https://docs.ethers.io/v5/api-keys/) in
+the documentation.
+
+A special thanks to these services for providing community resources:
+
+- [Ankr](https://www.ankr.com/)
+- [Etherscan](https://etherscan.io/)
+- [INFURA](https://infura.io/)
+- [Alchemy](https://dashboard.alchemyapi.io/signup?referral=55a35117-028e-4b7c-9e47-e275ad0acc6d)
+- [Pocket](https://pokt.network/pocket-gateway-ethereum-mainnet/)
 
 
 Ancillary Packages
@@ -75,14 +104,14 @@ Ancillary Packages
 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` ([documentation](https://docs.ethers.io))
-- `@ethersproject/cli` ([documentation](https://docs.ethers.io))
-- `@ethersproject/hardware-wallets` ([documentation](https://docs.ethers.io))
+- `@ethersproject/experimental` ([documentation](https://docs.ethers.io/v5/api/experimental/))
+- `@ethersproject/cli` ([documentation](https://docs.ethers.io/v5/cli/))
+- `@ethersproject/hardware-wallets` ([documentation](https://docs.ethers.io/v5/api/other/hardware/))
 
 
 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/README.md

@@ -1,59 +0,0 @@
-Admin Tool
-==========
-
-This tool is meant for admin tasks related to ethers.js.
-
-
-Workflow
---------
-
-After a new series of changes have been made and tested:
-
-1. Run `npm run update-versions` to update and build all packages
-2. Make any human-necessary changes to the automatically updated `CHANGELOG.md`
-3. Run `git add .`
-4. Run `git commit -S -m "Updated dist files."`
-5. Run `git push`
-6. Wait for TravisCI to complete running test cases
-7. Run `npm run publish-all` to publish changed packages to NPM and tag GitHub
-
-
-Update Dependency Graph: admin/cmds/update-depgraph
----------------------------------------------------
-
-This is run as part of `npm run bootstrap` before running lerna bootstrap.
-It recomputes the dependency graph and writes out the ordered
-**tsconfig.project.json**
-
-
-Update Versions: admin/cmds/update-versions
--------------------------------------------
-
-Run using the `npm run update-versions`, which also cleans, bootstraps  and
-rebuilds the project before running the script.
-
-For each package that has changed from the version in NPM (the published
-tarballs are compared):
-
-- Update the `version` in the **package.json**
-- Update the `src.ts/_version.ts` (matches the **package.json**)
-- Updates the `tarballHash` in the **package.json**
-- Compiles the TypeScript (which updates the `_version.js` and `_version.d.js`)
-- Lists all changed files (highlighting src.ts files)
-
-Then:
-
-- Generate the distribution files
-- Update the `CHANGELOG.md`
-
-
-Publish: admin/cmds/publish
----------------------------
-
-Run using `npm run publish-all`. This requires a password for the secure
-local config and the OTP for NPM.
-
-- Publish (in dependency order) changed files to NPM
-- The `gitHead` is updated in **only** the NPM **package.json**
-- @TODO: Cut a release on GitHub including the relevant CHANGELOG entry
-

admin/build.js

@@ -1,111 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const resolve = require("path").resolve;
-const spawn = require("child_process").spawn;
-
-const { dirnames } = require("./local");
-const { loadPackage, savePackage } = require("./local");
-const { loadJson, saveJson } = require("./utils");
-
-function run(progname, args, ignoreErrorStream) {
-    return new Promise((resolve, reject) => {
-        const proc = spawn(progname, args);
-
-        let stdout = Buffer.from([]);
-        let stderr = Buffer.from([]);
-
-        proc.stdout.on("data", (data) => {
-            stdout = Buffer.concat([ stdout, data ]);
-        });
-
-        proc.stderr.on("data", (data) => {
-            stderr = Buffer.concat([ stdout, data ]);
-        });
-
-        proc.on("error", (error) => {
-            console.log("ERROR");
-            console.log(stderr.toString());
-            error.stderr = stderr.toString();
-            error.stdout = stdout.toString();
-            reject(error);
-        });
-
-        proc.on("close", (code) => {
-            if ((stderr.length && !ignoreErrorStream) || code !== 0) {
-                console.log("ERROR");
-                console.log(stderr.toString());
-
-                let error = new Error(`stderr not empty: ${ progname } ${ JSON.stringify(args) }`);
-                error.stderr = stderr.toString();
-                error.stdout = stdout.toString();
-                error.statusCode = code;
-                reject(error);
-            } else {
-                resolve(stdout.toString());
-            }
-        });
-    });
-}
-
-function setupConfig(outDir, moduleType, targetType) {
-
-    // Configure the tsconfit.package.json...
-    const path = resolve(__dirname, "../tsconfig.package.json");
-    const content = loadJson(path);
-    content.compilerOptions.module = moduleType;
-    content.compilerOptions.target = targetType;
-    saveJson(path, content);
-
-    // Configure the browser field for every pacakge, copying the
-    // browser.umd filed for UMD and browser.esm for ESM
-    dirnames.forEach((dirname) => {
-        let info = loadPackage(dirname);
-
-        if (info._ethers_nobuild) { return; }
-
-        if (targetType === "es2015") {
-            if (info["browser.esm"]) {
-                info.browser = info["browser.esm"];
-            }
-        } else if (targetType === "es5") {
-            if (info["browser.umd"]) {
-                info.browser = info["browser.umd"];
-            }
-        } else {
-            throw new Error("unsupported target");
-        }
-        savePackage(dirname, info);
-
-        let path = resolve(__dirname, "../packages", dirname, "tsconfig.json");
-        let content = loadJson(path);
-        content.compilerOptions.outDir = outDir;
-        saveJson(path, content);
-    });
-}
-
-function setupBuild(buildModule) {
-    if (buildModule) {
-        setupConfig("./lib.esm/", "es2015", "es2015");
-    } else {
-        setupConfig("./lib/", "commonjs", "es5");
-    }
-}
-
-function runBuild(buildModule) {
-    setupBuild(buildModule);
-
-    // Compile
-    return run("npx", [ "tsc", "--build", resolve(__dirname, "../tsconfig.project.json"), "--force" ]);
-}
-
-function runDist() {
-    return run("npm", [ "run", "_dist" ], true);
-}
-
-module.exports = {
-    run: run,
-    runDist: runDist,
-    runBuild: runBuild,
-    setupBuild: setupBuild
-};

admin/changelog.js

@@ -1,145 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const resolve = require("path").resolve;
-
-const git = require("./git");
-const local = require("./local");
-const npm = require("./npm");
-const utils = require("./utils");
-
-const ChangelogPath = resolve(__dirname, "../CHANGELOG.md");
-
-async function generate() {
-
-    // Get each section of the Changelog
-    let existing = fs.readFileSync(ChangelogPath).toString().split("\n");
-    let sections = [ ];
-    let lastLine = existing[0];
-    existing.slice(1).forEach((line) => {
-        if (line.substring(0, 5) === "=====" || line.substring(0, 5) === "-----") {
-            sections.push({
-                title: lastLine,
-                underline: line.substring(0, 1),
-                body: [ ]
-            });
-            lastLine = null;
-            return;
-        } else if (lastLine) {
-            sections[sections.length - 1].body.push(lastLine);
-        }
-        lastLine = line;
-    });
-    sections[sections.length - 1].body.push(lastLine);
-
-    let lastVersion = await npm.getPackageVersion("ethers");
-
-    let logs = await git.run([ "log", (lastVersion.gitHead + "..") ]);
-
-    let changes = [ ];
-    logs.split("\n").forEach((line) => {
-        if (line.toLowerCase().substring(0, 6) === "commit") {
-            changes.push({
-                commit: line.substring(6).trim(),
-                body: [ ]
-            });
-        } else if (line.toLowerCase().substring(0, 5) === "date:") {
-            changes[changes.length - 1].date = utils.getDateTime(new Date(line.substring(5).trim()));
-        } else if (line.substring(0, 1) === " ") {
-            line = line.trim();
-            if (line === "") { return; }
-            changes[changes.length - 1].body += line + " ";
-        }
-    });
-
-    // @TODO:
-    // ethers/version ([date](tag))
-    let newSection = {
-        title: `ethers/v${ local.loadPackage("ethers").version } (${utils.getDateTime(new Date())})`,
-        underline: "-",
-        body: [ ]
-    }
-
-    // Delete duplicate sections for the same version (ran update multiple times)
-    while (sections[1].title === newSection.title) {
-        sections.splice(1, 1);
-    }
-
-    changes.forEach((change) => {
-        let body = change.body.trim();
-        let link = body.match(/(\((.*#.*)\))/)
-        let commit = `[${ change.commit.substring(0, 7) }](https://github.com/ethers-io/ethers.js/commit/${ change.commit })`;
-        if (link) {
-            body = body.replace(/ *(\(.*#.*)\) */, "");
-            link = link[2].replace(/#([0-9]+)/g, (all, issue) => {
-                return `[#${ issue }](https://github.com/ethers-io/ethers.js/issues/${ issue })`;
-            }) + "; " + commit;
-        } else {
-            link = commit;
-        }
-        newSection.body.push(`  - ${ body } (${ link })`);
-    });
-
-    sections.splice(1, 0, newSection);
-
-
-    let formatted = [ ];
-    sections.forEach((section) => {
-        formatted.push(section.title);
-        formatted.push(utils.repeat(section.underline, section.title.length));
-        formatted.push("");
-        section.body.forEach((line) => {
-            line = line.trim();
-            if (line === "") { return; }
-            if (line.substring(0, 1) === "-") {
-                line = "- " + line.substring(1).trim();
-            }
-            if (section.underline === "-") {
-                line = "  " + line;
-            }
-            formatted.push(line);
-        });
-        formatted.push("");
-    });
-
-    return formatted.join("\n") + "\n";
-}
-
-function getChanges() {
-    const changes = [ ];
-
-    let lastLine = null;
-    fs.readFileSync(ChangelogPath).toString().split("\n").forEach((line) => {
-        line = line.trim();
-        if (line === "") { return; }
-
-        if (line.substring(0, 5) === "-----") {
-            changes.push({ title: lastLine, lines: [ ] });
-        } else if (line.substring(0, 1) === "-" && changes.length) {
-            changes[changes.length - 1].lines.push(line);
-        }
-        lastLine = line;
-    });
-
-    return changes;
-}
-
-function latestChange() {
-    const recent = getChanges()[0];
-
-    const match = recent.title.match(/ethers\/([^\(]*)\(([^\)]*)\)/);
-
-    return {
-        title: recent.title,
-        version: match[1].trim(),
-        data: match[2].trim(),
-        content: recent.lines.join("\n")
-    };
-}
-
-module.exports = {
-    generate: generate,
-    latestChange: latestChange,
-    ChangelogPath: ChangelogPath,
-}
-

admin/cmds/grep-github.js

@@ -1,142 +0,0 @@
-"use strict";
-
-const { colorify } = require("../log");
-const { getIssues } = require("../github");
-const { repeat } = require("../utils");
-
-const Options = {
-    "body": 1,
-    "end": 1,
-    "issue": 1,
-    "start": 1,
-    "title": 1,
-    "user": 1,
-};
-
-const Flags = {
-    "open": 1,
-    "match-case": 1,
-};
-
-(async function() {
-    const options = { };
-    for (let i = 2; i < process.argv.length; i++) {
-        const option = process.argv[i];
-        if (option.substring(0, 2) === "--") {
-            const comps = option.substring(2).split(/=/);
-            if (Flags[comps[0]]) {
-                if (comps[1] != null) { throw new Error("Invalid flag: " + option); }
-                options[comps[0]] = true;
-            } else if (Options[comps[0]]) {
-                if (comps[1] == null) {
-                    options[comps[0]] = process.argv[++i];
-                    if (options[comps[0]] == null) {
-                        throw new Error("Missing option value: " + option);
-                    }
-                } else {
-                    options[comps[0]] = comps[1];
-                }
-            } else {
-                throw new Error("Unexpected option: " + option);
-            }
-        } else {
-            throw new Error("Unexpected argument: " + option);
-        }
-    }
-
-    if (options["title"]) { options.title = new RegExp(options.title, (options["match-case"] ? "": "i")); }
-    if (options["body"]) { options.body = new RegExp(options.title, (options["match-case"] ? "": "i")); }
-    if (options["start"]) {
-        if (options["start"].match(/^[0-9]{4}-[0-9]{2}-[0-9{2}]$/)) {
-            throw new Error("Expected YYYY-MM-DD");
-        }
-    }
-    if (options["end"]) {
-        if (options["end"].match(/^[0-9]{4}-[0-9]{2}-[0-9{2}]$/)) {
-            throw new Error("Expected YYYY-MM-DD");
-        }
-    }
-
-    const count = { issues: 0, comments: 0, code: 0, responses: 0 };
-
-    const issues = await getIssues();
-    issues.forEach((issue) => {
-        const info = issue.issue;
-        const comments = issue.comments;
-
-        if (options.issue && parseInt(options.issue) != info.number) { return; }
-        if (options.open && info.state !== "open") { return; }
-        if (options.title && !info.title.match(options.title)) { return; }
-        if (options.body) {
-            const body = info.body + "\n" + comments.map((c) => (c.body)).join("\n");
-            if (!body.match(options.body)) {
-                return;
-            }
-        }
-        if (options.user) {
-            const users = comments.map((c) => (c.user.login));
-            users.push(info.user.login);
-            if (users.indexOf(options.user) === -1) {
-                return;
-            }
-        }
-
-        const dates = comments.map((c) => (c.created_at.split("T")[0]));
-        dates.push(info.created_at.split("T")[0]);
-
-        if (options.start) {
-            if (dates.filter((d) => (d >= options.start)).length === 0) { return; }
-        }
-        if (options.end) {
-            if (dates.filter((d) => (d <= options.start)).length === 0) { return; }
-        }
-
-        count.issues++;
-
-        console.log(colorify(repeat("=", 70), "bold"))
-        console.log(colorify("Issue:", "bold"), info.title, ` (#${ info.number })`);
-        console.log(colorify("User:","bold"), colorify(info.user.login, "blue"));
-        console.log(colorify("State:", "bold"), info.state);
-        if (info.created_at === info.updated_at) {
-            console.log(colorify("Created:", "bold"), info.created_at);
-        } else {
-            console.log(colorify("Created:", "bold"), info.created_at, ` (updated: ${ info.updated_at })`);
-        }
-        info.body.trim().split("\n").forEach((line) => {
-            console.log("  " + line);
-        });
-
-        if (comments.length) {
-            comments.forEach((info) => {
-                if (options.start && info.created_at < options.start) { return ; }
-                if (options.end && info.created_at > options.end) { return; }
-                count.comments++;
-                if (options.user && info.user.login !== options.user) { return; }
-                count.responses++;
-                if (info.body.indexOf("`") >= 0) { count.code++; }
-                console.log(colorify(repeat("-", 70), "bold"));
-                console.log(colorify("User:", "bold"), colorify(info.user.login, "green"));
-                if (info.created_at === info.updated_at) {
-                    console.log(colorify("Created:", "bold"), info.created_at);
-                } else {
-                    console.log(colorify("Created:", "bold"), info.created_at, ` (updated: ${ info.updated_at })`);
-                }
-                info.body.trim().split("\n").forEach((line) => {
-                    console.log("  " + line);
-                });
-            });
-        }
-    });
-
-    console.log(colorify(repeat("=", 70), "bold"))
-
-    // @TODO: Add stats on new/closed issues
-    //if (options.user) {
-    //    console.log(`${ count.responses } responses (${ count.code } w/ code) on ${ count.comments } comments across ${ count.issues } issues.`);
-    //} else {
-        console.log(`${ count.comments } comment${ (count.comments !== 1) ? "s": "" } across ${ count.issues } issue${ (count.issues !== 1) ? "s": ""}.`);
-    //}
-
-})().catch((error) => {
-    console.log("Error: " + error.message);
-});

admin/cmds/lock-versions.js

@@ -1,41 +0,0 @@
-"use strict";
-
-const { getOrdered, loadPackage } = require("../depgraph");
-const { savePackage } = require("../local");
-const { log } = require("../log");
-
-(async function() {
-    let versions = { };
-
-    const dirnames = getOrdered();
-
-    dirnames.forEach((dirname) => {
-        let info = loadPackage(dirname);
-        if (info.name.split("/")[0] === "@ethersproject" || info.name === "ethers") {
-            versions[info.name] = info.version;
-        }
-    });
-
-    dirnames.forEach((dirname) => {
-        const info = loadPackage(dirname);
-        let shown = false;
-        ["dependencies", "devDependencies"].forEach((key) => {
-            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; }
-                if (!shown) {
-                    log(`<bold:Locking ${ info.name }:>`);
-                    shown = true;
-                }
-                log(`    <green:${ name }>: ${ deps[name] } => <bold:${ value.substring(2) }>`);
-                deps[name] = value;
-            });
-        });
-        savePackage(dirname, info);
-    });
-
-})();

admin/cmds/publish.js

@@ -1,117 +0,0 @@
-"use strict";
-
-const config = require("../config");
-
-const { ChangelogPath, latestChange } = require("../changelog");
-const { getOrdered, loadPackage } = require("../depgraph");
-const { getGitTag } = require("../git");
-const { createRelease } = require("../github");
-const { getPackageVersion, publish } = require("../npm");
-const { log } = require("../log");
-
-const USER_AGENT = "ethers-dist@0.0.0";
-const TAG = "next";
-
-
-let dirnames = getOrdered();
-
-// Only publish specific packages
-if (process.argv.length > 2) {
-    let filter = process.argv.slice(2);
-
-    // Verify all named packages exist
-    filter.forEach((dirname) => {
-        try {
-            loadPackage(dirname);
-        } catch (error) {
-            console.log("Package not found: " + dirname);
-            process.exit(1);
-        }
-    });
-
-    // Filter out pacakges we don't care about
-    dirnames = dirnames.filter((dirname) => (filter.indexOf(dirname) >= 0));
-}
-
-(async function() {
-    let token = null;
-
-    const gitCommit = await getGitTag(ChangelogPath);
-
-    let includeEthers = false;
-
-    // @TODO: Fail if there are any untracked files or unchecked in files
-
-    // Load the token from the encrypted store
-    try {
-        token = await config.get("npm-token");
-    } catch (error) {
-        switch (error.message) {
-            case "wrong password":
-                log("<bold:Wrong password>");
-                break;
-            case "cancelled":
-                break;
-            default:
-                console.log(error);
-        }
-
-        log("<red:Aborting.>");
-
-        return;
-    }
-
-    token = token.trim().split("=");
-
-    let options = {
-        npmVersion: USER_AGENT,
-        tag: TAG
-    };
-
-    // Set the authentication token
-    options[token[0]] = token[1];
-
-    for (let i = 0; i < dirnames.length; i++) {
-        let dirname = dirnames[i];
-
-        if (dirname === "ethers") {
-            options.tag = "next";
-            includeEthers = true;
-        } else {
-            options.tag = "latest";
-        }
-
-        let info = loadPackage(dirname);
-        let npmInfo = await getPackageVersion(info.name);
-        if (!npmInfo) { npmInfo = { version: "NEW" }; }
-
-        if (info.tarballHash === npmInfo.tarballHash) { continue; }
-
-        log(`<bold:Publishing:> ${info.name}...`);
-        log(`  <blue:Version:> ${npmInfo.version} <bold:=\\>> ${info.version}`);
-
-        let success = await publish(dirname, options);
-        if (!success) {
-            log("  <red:FAILED! Aborting.>");
-            return;
-        }
-        log("  <green:Done.>");
-    }
-
-    // Publish the GitHub release (currently beta)
-    const beta = true;
-    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 }`);
-    }
-
-})();

admin/cmds/reset-build.js

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

admin/cmds/set-config.js

@@ -1,16 +0,0 @@
-"use strict";
-
-const { prompt } = require("../../packages/cli");
-const config = require("../config");
-
-if (process.argv.length !== 3) {
-    console.log("Usage: set-config KEY");
-    process.exit(1);
-}
-
-const key = process.argv[2];
-
-(async function() {
-    const value = await prompt.getPassword("Value: ");
-    await config.set(key, value);
-})();

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

@@ -1,146 +0,0 @@
-"use strict";
-
-// Expected this to be run after
-//   - npm run clean
-//   - npm run bootstrap
-//   - npm run build
-
-const fs = require("fs");
-
-const semver = require("semver");
-
-const { runBuild, runDist } = require("../build");
-const { ChangelogPath, generate } = require("../changelog");
-const { getOrdered, loadPackage } = require("../depgraph");
-const { getDiff, getStatus, getGitTag } = require("../git");
-const { updatePackage } = require("../local");
-const { getPackageVersion } = require("../npm");
-const { resolve } = require("../utils");
-const { colorify, log } = require("../log");
-
-const { prompt } = require("../../packages/cli");
-
-let dirnames = getOrdered();
-
-// Only publish specific packages
-if (process.argv.length > 2) {
-    let filter = process.argv.slice(2);
-
-    // Verify all named packages exist
-    filter.forEach((dirname) => {
-        try {
-            loadPackage(dirname);
-        } catch (error) {
-            console.log("Package not found: " + dirname);
-            process.exit(1);
-        }
-    });
-
-    // Filter out pacakges we don't care about
-    dirnames = dirnames.filter((dirname) => (filter.indexOf(dirname) >= 0));
-}
-
-(async function() {
-    let progress = prompt.getProgressBar(colorify("Updating versions", "bold"));
-
-    for (let i = 0; i < dirnames.length; i++) {
-        progress(i / dirnames.length);
-
-        let dirname = dirnames[i];
-        let path = resolve("packages", dirname);
-
-        // Get local package.json (update the tarballHash)
-        let info = await updatePackage(dirname);
-
-        // Get the remote package.json (or sub in a placeholder for new pacakges)
-        let npmInfo = await getPackageVersion(info.name);
-        if (!npmInfo) { npmInfo = { version: "NEW" }; }
-
-        if (info.tarballHash === npmInfo.tarballHash) { continue; }
-
-        // Bump the version if necessary
-        if (info.version === npmInfo.version) {
-            let newVersion = semver.inc(info.version, "prerelease", "beta");
-
-            // Write out the _version.ts
-            if (!info._ethers_nobuild) {
-                let code = "export const version = " + JSON.stringify(dirname + "/" + newVersion) + ";\n";
-                fs.writeFileSync(resolve(path, "src.ts/_version.ts"), code);
-            }
-
-            // Update the package.json (we do this after _version, so if we fail,
-            // this remains old; which is what triggers the version bump)
-            info = await updatePackage(dirname, { version: newVersion });
-        }
-    }
-    progress(1);
-
-    try {
-        log("<bold:Building TypeScript source (es6)...>");
-        await runBuild(true);
-        log("<bold:Building TypeScript source (commonjs)...>");
-        await runBuild(false);
-        log("<bold:Building distribution files...>");
-        let content = await runDist();
-        console.log(content);
-    } catch (error) {
-        console.log(error);
-        log("<red:Aborting.>");
-        return;
-    }
-
-    // Update the tarball hash now that _version and package.json may have changed.
-    progress = prompt.getProgressBar(colorify("Updating tarballHash", "bold"));
-    for (let i = 0; i < dirnames.length; i++) {
-        progress(i / dirnames.length);
-        await updatePackage(dirnames[i]);
-    }
-    progress(1);
-
-    // Show the changed files (compared to npm)
-    for (let i = 0; i < dirnames.length; i++) {
-        let dirname = dirnames[i];
-
-        // Get local package.json
-        let info = await loadPackage(dirname);
-        let path = resolve("packages/", dirname);
-
-        // Get the remote package.json (or sub in a placeholder for new pacakges)
-        let npmInfo = await getPackageVersion(info.name);
-        if (!npmInfo) { npmInfo = { version: "NEW" }; }
-
-        // No change
-        if (info.tarballHash === npmInfo.tarballHash) { continue; }
-
-        let gitHead = await getGitTag(path);
-
-        log(`<bold:Package>: ${info.name}`);
-        log(`    <green:Tarball Changed:>   (bumping version)`);
-        log(`        ${npmInfo.version}  =>  ${info.version}`)
-        log(`    <blue:Changed:>`);
-        let filenames = await getDiff(path, npmInfo.gitHead, true);
-        filenames.forEach((filename) => {
-            let short = filename.split("/").slice(1).join("/");
-            if (short.indexOf("/src.ts/") >= 0 || short.indexOf("/dist/") >= 0) {
-                log(`        <bold:${short}>`);
-            } else {
-                log(`        ${short}`);
-            }
-        });
-        log("");
-    }
-
-    let existing = fs.readFileSync(ChangelogPath).toString();
-    let changelog = await generate();
-    if (existing !== changelog) {
-        let changelogStatus = await getStatus(ChangelogPath);
-        if (changelogStatus !== "unmodified") {
-            log("<bold:WARNING:> There are local changes to the CHANGELOG (they will be discarded)");
-            console.log(existing);
-        }
-        log("<bold:Updating CHANGELOG>...");
-        fs.writeFileSync(ChangelogPath, changelog);
-    }
-
-
-})();

admin/config.js

@@ -1,120 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const os = require("os");
-const resolve = require("path").resolve;
-
-const AES = require("aes-js");
-const scrypt = require("scrypt-js");
-
-const { prompt } = require("../packages/cli");
-const randomBytes = require("../packages/random").randomBytes;
-const computeHmac = require("../packages/sha2").computeHmac;
-
-const colorify = require("./log").colorify;
-
-function getScrypt(message, password, salt) {
-    let progressBar = prompt.getProgressBar(message);
-    return scrypt.scrypt(Buffer.from(password), Buffer.from(salt), (1 << 17), 8, 1, 64, progressBar);
-}
-
-function Config(filename) {
-    this.salt = null;
-    this.dkey = null;
-    this.values = { };
-    this.canary = "";
-    this.filename = filename;
-}
-
-Config.prototype.load = async function() {
-    if (this.dkey) { return; }
-
-    let data = null;
-    if (fs.existsSync(this.filename)) {
-        data = JSON.parse(fs.readFileSync(this.filename));
-    } else {
-        data = {
-            salt: Buffer.from(randomBytes(32)).toString("hex")
-        };
-    }
-
-    this.canary = data.canary || "";
-
-    this.salt = data.salt;
-
-    const password = await prompt.getPassword(colorify("Password (config-store): ", "bold"));
-
-    this.dkey = await getScrypt(colorify("Unlocking config", "bold"), password, this.salt);
-
-    if (data.ciphertext) {
-        const ciphertext = Buffer.from(data.ciphertext, "base64");
-        const iv = Buffer.from(data.iv, "base64");
-        const aes = new AES.ModeOfOperation.ctr(this.dkey.slice(0, 32), new AES.Counter(iv));
-        const plaintext = aes.decrypt(ciphertext);
-        const hmac = computeHmac("sha512", this.dkey.slice(32, 64), plaintext);
-        if (hmac !== data.hmac) {
-            throw new Error("wrong password");
-        }
-
-        this.values = JSON.parse(Buffer.from(plaintext).toString());
-    }
-};
-
-Config.prototype.keys = async function() {
-    await this.load();
-    return Object.keys(this.values);
-}
-
-Config.prototype.save = function() {
-    this.values._junk = Buffer.from(randomBytes(16 + parseInt(Math.random() * 48))).toString("base64")
-
-    const plaintext = Buffer.from(JSON.stringify(this.values));
-
-    const iv = Buffer.from(randomBytes(16));
-    const hmac = computeHmac("sha512", this.dkey.slice(32, 64), plaintext);
-
-    const aes = new AES.ModeOfOperation.ctr(this.dkey.slice(0, 32), new AES.Counter(iv));
-    const ciphertext = Buffer.from(aes.encrypt(plaintext));
-
-    const data = {
-        ciphertext: ciphertext.toString("base64"),
-        iv: iv.toString("base64"),
-        salt: this.salt,
-        hmac: hmac,
-        canary: this.canary
-    };
-
-    fs.writeFileSync(this.filename, JSON.stringify(data, null, 2));
-}
-
-Config.prototype.get = async function(key) {
-    await this.load();
-    return this.values[key];
-};
-
-Config.prototype.set = async function(key, value) {
-    await this.load();
-    this.values[key] = value;
-    this.save();
-};
-
-Config.prototype.lock = function() {
-    this.salt = this.dkey = null;
-}
-
-const config = new Config(resolve(os.homedir(), ".ethers-dist"));
-
-module.exports = {
-    get: function(key) {
-        return config.get(key);
-    },
-    set: function(key, value) {
-        config.set(key, value);
-    },
-    keys: function() {
-        return config.keys();
-    },
-    lock: function() {
-        config.lock();
-    }
-}

admin/depgraph.js

@@ -1,94 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-
-const { loadJson, resolve } = require("./utils");
-
-const ROOT = resolve("packages");
-
-const dirnames = fs.readdirSync(ROOT);
-
-function loadPackage(dirname) {
-    return loadJson(resolve("packages", dirname, "package.json"));
-}
-
-function getOrdered(skipNobuild) {
-    let packages = { };
-    let filenames = { };
-
-    let addDeps = (name, depends) => {
-        Object.keys(depends).forEach((dep) => {
-            // Not a package we manage
-            if (packages[dep] == null) { return; }
-            deps[name][dep] = true;
-        });
-    }
-
-    for (let i = 0; i < dirnames.length; i++) {
-        let dirname = dirnames[i];
-        let info = loadPackage(dirname);
-        if (skipNobuild && info._ethers_nobuild) { continue; }
-        packages[info.name] = info;
-        filenames[info.name] = dirname;
-    }
-
-    // Maps names to list of dependencies; { [ name:string]: Array<name: string> }
-    let deps = { };
-    let depGraph = { };
-
-    Object.keys(packages).forEach((name) => {
-        let info = packages[name];
-        deps[info.name] = { };
-        addDeps(info.name, info.dependencies || { });
-        addDeps(info.name, info.devDependencies || { });
-        deps[info.name] = Object.keys(deps[info.name]);
-        deps[info.name].sort();
-    });
-
-    let ordered = [ ];
-    let remaining = Object.keys(deps);
-
-    let isSatisfied = (name) => {
-        for (let i = 0; i < deps[name].length; i++) {
-            if (ordered.indexOf(deps[name][i]) === -1) { return false; }
-        }
-        return true;
-    }
-
-    while (remaining.length) {
-        let bail = true;
-        for (let i = 0; i < remaining.length; i++) {
-            if (!isSatisfied(remaining[i])) { continue; }
-            bail = false;
-            ordered.push(remaining[i]);
-            remaining.splice(i, 1);
-            break;
-        }
-
-        if (bail) {
-            throw new Error("Nothing processed; circular dependencies...");
-        }
-    }
-
-    return ordered.map((name) => filenames[name]);
-}
-
-function sort(dirnames) {
-    let ordered = getOrdered();
-    dirnames.sort((a, b) => {
-        let ai = ordered.indexOf(local.loadPackage(a).name);
-        let bi = ordered.indexOf(local.loadPackage(b).name);
-        if (ai === -1 || bi === -1) {
-            throw new Error("unknown dirname - " + [a, b].join(", "));
-        }
-        return ai - bi;
-    });
-}
-
-module.exports = {
-    dirnames: dirnames,
-    getOrdered: getOrdered,
-    loadPackage: loadPackage,
-    ROOT: ROOT,
-    sort: sort
-}

admin/git.js

@@ -1,186 +0,0 @@
-"use strict";
-
-const resolve = require("path").resolve;
-const spawn = require("child_process").spawn;
-
-const semver = require("semver");
-
-const { run } = require("./build");
-const { loadPackage } = require("./local");
-
-function git(args) {
-    return run("git", args);
-}
-
-function getStatus(filename) {
-    return git([ "status", "-s", resolve(__dirname, "..", filename) ]).then((result) => {
-        result = result.trim();
-        if (result === "") { return "unmodified"; }
-        switch (result.substring(0, 2)) {
-            case 'M ': return "modified";
-            case 'A ': return "added";
-            case 'D ': return "deleted";
-            case 'R ': return "renamed";
-            case 'C ': return "copied";
-            case 'U ': return "updated";
-            case '??': return "untracked";
-        }
-        console.log(result);
-        return "unknown";
-    });
-}
-
-async function getChanges(latest) {
-    let diff = await git(["diff", "--name-only", latest ]);
-
-    // Map dirname => { dist: [ ], src: [ ] }
-    let changes = { "_": { filename: "_", dist: [], src: [] } };
-
-    diff.split("\n").forEach((line) => {
-        // e.g. packages/constants/index.d.ts
-        let comps = line.trim().split("/");
-
-        // Track non-packages as dist
-        if (comps.length < 2 || comps[0] !== "packages") {
-            let filename = comps.join("/").trim();
-            if (filename === "") { return; }
-            changes._.dist.push(filename);
-            return;
-        }
-
-        let name = loadPackage(comps[1]).name;
-
-        let change = changes[name];
-        if (!change) {
-            change = { filename: comps[1], dist: [ ], src: [ ] }
-            changes[name] = change;
-        }
-
-        // Split changes into source changes (src.ts/) or dist changes (output of TypeScript)
-        if (comps[2] === "src.ts") {
-            change.src.push(comps.join("/"));
-        } else {
-            change.dist.push(comps.join("/"));
-        }
-    });
-
-    return changes;
-}
-
-function getLatestTag() {
-    let seq = Promise.resolve();
-
-    // @TODO: Pull
-    if (false) {
-        seq = seq.then(() => {
-            console.log("Pulling remote changes...");
-            return git([ "pull" ]);
-        });
-    }
-
-    seq = seq.then(() => {
-        return git([ "tag" ]).then((tags) => {
-            tags = tags.split("\n").filter(tag => (tag.match(/^v[0-9]+\.[0-9]+\.[0-9]+\-/)));
-            tags.sort(semver.compare)
-            return tags.pop();
-        });
-    });
-
-    return seq;
-}
-
-function findChanges(latest) {
-    let seq = Promise.resolve();
-
-    seq = seq.then(() => {
-        return git(["diff", "--name-only", latest, "HEAD" ]).then((result) => {
-            let filenames = { };
-            result.split("\n").forEach((line) => {
-                // e.g. packages/constants/index.d.ts
-                let comps = line.trim().split("/");
-                if (comps.length < 2) { return; }
-                filenames[comps[1]] = true;
-            });
-            return Object.keys(filenames);
-        });
-    });
-
-    seq = seq.then((filenames) => {
-        return filenames.map((filename) => {
-            let name = packages[filename].name;
-            return {
-                filename: filename,
-                name: name,
-                localVersion: getLocalVersion(name),
-            }
-        });
-    });
-
-    seq = seq.then((packages) => {
-        let seq = Promise.resolve();
-        packages.forEach((p) => {
-            seq = seq.then(() => {
-                return getNpmVersion(p.name).then((version) => {
-                    p.npmVersion = version;
-               });
-            });
-        });
-        return seq.then(() => packages);
-    });
-    return seq;
-}
-
-async function getGitTag(filename) {
-    let result = await git([ "log", "-n", "1", "--", filename ]);
-    result = result.trim();
-    if (!result) { return null; }
-    result = result.match(/^commit\s+([0-9a-f]{40})\n/i);
-    if (!result) { return null; }
-    return result[1];
-}
-
-async function getDiff(filename, tag, nameOnly) {
-    if (tag == null) { tag = "HEAD"; }
-    let cmd = [ "diff", "--name-only", tag, "--", filename ]
-    if (!nameOnly) { cmd.splice(1, 1); }
-    try {
-       let result = await git(cmd);
-       result = result.trim();
-       if (result === "") { return [ ]; }
-       return result.split("\n");
-    } catch (error) {
-        // This tag does not exist, so compare against beginning of time
-        // This happens when there is a new history (like an orphan branch)
-        if (error.stderr.trim().match(/^fatal: bad object/)) {
-            console.log("Could not find history; showing all");
-            let cmd = [ "rev-list", "--max-parents=0", "HEAD" ];
-            let tag = await git(cmd);
-            return getDiff(filename, tag.trim(), nameOnly);
-        }
-
-        throw error;
-    }
-}
-
-async function getUntracked(filename) {
-    let cmd = [ "ls-files", "-o", "--exclude-standard"];
-    if (filename) {
-        cmd.push("--");
-        cmd.push(filename);
-    }
-    let result = await git(cmd);
-    result = result.trim();
-    if (result === "") { return [ ]; }
-    return result.split("\n");
-}
-
-module.exports = {
-    findChanges: findChanges,
-    getChanges: getChanges,
-    getDiff: getDiff,
-    getGitTag: getGitTag,
-    getLatestTag: getLatestTag,
-    getStatus: getStatus,
-    getUntracked: getUntracked,
-    run: git,
-}

admin/github.js

@@ -1,162 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const { resolve } = require("path");
-const zlib = require("zlib");
-
-const { id } = require("../packages/hash");
-const { fetchJson } = require("../packages/web");
-
-const CacheDir = resolve(__dirname, "../github-cache/");
-
-function addResponse(result, response) {
-    return { result, response };
-}
-
-function loadFile(filename) {
-    return JSON.parse(zlib.gunzipSync(fs.readFileSync(filename)).toString());
-    //return JSON.parse(fs.readFileSync(filename).toString());
-}
-
-// @TODO: atomic
-function saveFile(filename, content) {
-    fs.writeFileSync(filename, zlib.gzipSync(JSON.stringify(content)));
-    //fs.writeFileSync(filename, JSON.stringify(content));
-}
-
-function mockFetchJson(url, body, headers) {
-    return {
-        result: null,
-        response: {
-            statusCode: 304
-        }
-    }
-}
-
-async function _fetchGitHub(user, password, fetchJson, url) {
-    const result = [ ];
-    while (true) {
-
-        const filename = resolve(CacheDir, id(url).substring(2, 14));
-
-        const headers = {
-            "User-Agent": "ethers-io",
-        };
-
-        let items = null;
-        let link = null;
-        try {
-            const data = loadFile(filename);
-            headers["if-none-match"] = data.etag;
-            items = data.items;
-            link = data.link;
-        } catch (error) {
-            if (error.code !== "ENOENT") { throw error; }
-        }
-
-        const fetch = await fetchJson({
-            url: url,
-            user: user,
-            password: password,
-            headers: headers
-        }, null, addResponse);
-
-        // Cached response is good; use it!
-        if (fetch.response.statusCode !== 304) {
-            items = fetch.result;
-            if (fetch.response.headers) {
-                link = (fetch.response.headers.link || null);
-            }
-            if (fetch.response.headers.etag){
-                saveFile(filename, {
-                    timestamp: (new Date()).getTime(),
-                    url: url,
-                    link: link,
-                    etag: fetch.response.headers.etag,
-                    items: items,
-                    version: 1
-                });
-            }
-        }
-
-        items.forEach((item) => { result.push(item)});
-
-        url = null;
-        (link || "").split(",").forEach((item) => {
-            if (item.indexOf('rel="next"') >= 0) {
-                const match = item.match(/<([^>]*)>/);
-                if (match) { url = match[1]; }
-            }
-        });
-
-        if (!url) { break; }
-    }
-    return result;
-}
-
-async function fetchGitHub(user, password, url, cacheOnly) {
-    if (cacheOnly) {
-        return await _fetchGitHub("none", "none", mockFetchJson, url);
-    }
-
-    const results = await _fetchGitHub(user, password, fetchJson, url);
-    return results;
-}
-
-
-async function _getIssues(user, password) {
-    const cacheOnly = (user == null);
-
-    let issues = await fetchGitHub(user, password, "https:/\/api.github.com/repos/ethers-io/ethers.js/issues?state=all&per_page=100", cacheOnly)
-    if (!cacheOnly) { console.log(`Found ${ issues.length } issues`); }
-    const result = [ ];
-    for (let i = 0; i < issues.length; i++) {
-        const issue = issues[i];
-        let comments = await fetchGitHub(user, password, issue.comments_url, cacheOnly);
-        result.push({ issue, comments});
-        if (!cacheOnly) { console.log(`  Issue ${ issue.number }: ${ comments.length } comments`); }
-    }
-    result.sort((a, b) => (a.issue.number - b.issue.number));
-    return result;
-}
-
-function getIssues() {
-    return _getIssues();
-}
-
-function syncIssues(user, password) {
-    return _getIssues(user, password);
-}
-
-async function createRelease(user, password, tagName, title, body, prerelease, commit) {
-    const payload = {
-        tag_name: tagName,
-        target_commitish: (commit || "master"),
-        name: title,
-        body: body,
-        //draft: true,
-        draft: false,
-        prerelease: !!prerelease
-    };
-
-    const headers = {
-        "User-Agent": "ethers-io",
-    };
-
-    const result = await fetchJson({
-        url: "https://api.github.com/repos/ethers-io/ethers.js/releases",
-        user: user,
-        password: password,
-        headers: headers
-    }, JSON.stringify(payload));
-
-
-    return result.html_url;
-}
-
-module.exports = {
-    getIssues,
-    syncIssues,
-    createRelease,
-}
-

admin/index.js

@@ -1,401 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const resolve = require("path").resolve;
-
-const diff = require("diff");
-const semver = require("semver");
-
-const { prompt } = require("../packages/cli");
-
-const build = require("./build");
-const changelog = require("./changelog");
-const depgraph = require("./depgraph");
-const { colorify, colorifyStatus, log } = require("./log");
-const config = require("./config")
-const git = require("./git");
-const local = require("./local");
-const npm = require("./npm");
-const utils = require("./utils");
-
-/*
-async function runChanged(dirnames, callback) {
-            try {
-                await callback(dirname, info, npmInfo);
-            } catch (error) {
-                console.log(error);
-                console.log(colorify("Aborting! " + error.message));
-                return;
-            }
-        }
-    }
-}
-*/
-/*
-        if (diff) {
-        } else {
-*/
-
-async function runDiff(dirnames) {
-    // Default to all packages
-    if (dirnames == null || dirnames.length === 0) { dirnames = local.dirnames; }
-
-    for (let i = 0; i < dirnames.length; i++) {
-        let dirname = dirnames[i];
-
-        // Get local (update the tarballHash) and remote package.json
-        let info = await local.loadPackage(dirname);
-        let npmInfo = await npm.getPackageVersion(info.name);
-        if (!npmInfo) { npmInfo = { gitHead: "HEAD", version: "NEW" }; }
-
-        let delta = await git.getDiff(resolve(__dirname, "../packages", dirname), npmInfo.gitHead);
-
-        if (delta.length === 0) { continue; }
-
-        // Bump the version if necessary
-        if (info.version === npmInfo.version) {
-            info.version = semver.inc(info.version, "prerelease", "beta");
-        }
-
-        console.log(colorify("<bold:Package>: ") + info.name);
-        console.log(colorify("    <green:Git Head Changed:>   (run update to bump version)"));
-        console.log("        " + npmInfo.gitHead)
-        console.log("        " + npmInfo.version + colorify("  =>  ", "bold") + info.version)
-
-        console.log(colorify("    Diff", "bold"));
-        delta.forEach((line) => {
-            let color = "blue";
-            switch (line.substring(0, 1)) {
-                case '+':
-                    color = "green";
-                    break;
-                case '-':
-                    color = "red";
-                    break;
-                case ' ':
-                    color = "normal";
-                    break;
-            }
-            console.log("        " + colorify(line, color));
-        });
-
-        console.log("");
-    }
-
-    console.log("");
-}
-
-async function updateChangelog() {
-    let filename = resolve(local.ROOT, "../CHANGELOG.md");
-
-    let lastVersion = await git.getLatestTag();
-    let newVersion = "v" + local.getVersion("ethers");
-
-    let current = fs.readFileSync(filename).toString();
-    let log = await changelog.generate();
-    if (log === current) { return; }
-
-    let changes = diff.createTwoFilesPatch("CHANGELOG-old.md", "CHANGELOG.md", current, log, lastVersion, newVersion);
-    console.log(changes);
-
-    try {
-        let response = await prompt.getChoice(colorify("Accept changes?", "bold"), "yn", "n");
-        if (response === "n") { throw new Error("Not changing."); }
-    } catch (error) {
-        console.log("Abort: " + error.message);
-        return;
-    }
-
-    fs.writeFileSync(filename, log);
-}
-
-// Updates the dependency-graph (tsconfig.project.json) so the build order is correct
-async function runUpdateDepgraph() {
-    log(`<bold:Updating dependency-graph build order (tsconfig.project.json)...>`);
-    let ordered = depgraph.getOrdered();
-
-    let path = resolve(local.ROOT, "../tsconfig.project.json")
-
-    let projectConfig = local.loadJson(path);
-    projectConfig.references = ordered.map((name) => ({ path: ("./packages/" + name) }));
-    local.saveJson(path, projectConfig);
-}
-
-async function runUpdate(dirnames) {
-
-    // Check for untracked files...
-    let untracked = [ ];
-    if (dirnames == null || dirnames.length === 0) {
-        dirnames = local.dirnames;
-        let filenames = await git.getUntracked(resolve(__dirname, ".."));
-        for (let i = 0; i < filenames.length; i++) {
-            untracked.push(filenames[i]);
-        }
-    } else {
-        for (let i = 0; i < dirnames.length; i++) {
-            let filenames = await git.getUntracked(resolve(local.ROOT, dirnames[i]));
-            for (let j = 0; j < filenames.length; j++) {
-                untracked.push(filenames[j]);
-            }
-        }
-    }
-
-    // Untracked files! Abort.
-    if (untracked.length) {
-        log("<bold:Untracked Files:>");
-        untracked.forEach((filename) => {
-            console.log("  " + filename);
-        });
-        log("<red:Aborting.>");
-        return;
-    }
-
-    log(`<bold:Run TypeScript build...>`);
-    await build.runBuild()
-
-    log("");
-
-    // @TODO: Root
-
-    // Update all the package.json and _version.ts
-    let progress = prompt.getProgressBar(colorify("Updating versions", "bold"));
-    for (let i = 0; i < dirnames.length; i++) {
-        progress(i / dirnames.length);
-
-        let dirname = dirnames[i];
-        let path = resolve(__dirname, "../packages/", dirname);
-
-        // Get local package.json (update the tarballHash)
-        let info = await local.updatePackage(dirname);
-
-        // Get the remote package.json (or sub in a placeholder for new pacakges)
-        let npmInfo = await npm.getPackageVersion(info.name);
-        if (!npmInfo) { npmInfo = { version: "NEW" }; }
-
-        if (info.tarballHash === npmInfo.tarballHash) { continue; }
-
-        // Bump the version if necessary
-        if (info.version === npmInfo.version) {
-            let newVersion = semver.inc(info.version, "prerelease", "beta");
-
-            // Write out the _version.ts
-            if (!info._ethers_skipPrepare) {
-                let code = "export const version = " + JSON.stringify(newVersion) + ";\n";
-                fs.writeFileSync(resolve(path, "src.ts/_version.ts"), code);
-            }
-
-            // Update the package.json (we do this after _version, so if we fail,
-            // this remains old; which is what triggers the version bump)
-            info = await local.updatePackage(dirname, { version: newVersion });
-        }
-    }
-    progress(1);
-
-    // Build the TypeScript sources
-    log("<bold:Runing TypeScript build...>");
-    try {
-        await build.runTsc();
-    } catch (error) {
-        console.log(error);
-        log("<red:Aborting.>");
-        return;
-    }
-
-    // Run the dist
-    // @TODO:
-
-    // Update the tarball hash now that _version and package.json may have changed.
-    progress = prompt.getProgressBar(colorify("Updating tarballHash", "bold"));
-    for (let i = 0; i < dirnames.length; i++) {
-        progress(i / dirnames.length);
-        await local.updatePackage(dirnames[i]);
-    }
-    progress(1);
-
-    // Show the changed files (compared to npm)
-    for (let i = 0; i < dirnames.length; i++) {
-        let dirname = dirnames[i];
-
-        // Get local package.json
-        let info = await local.loadPackage(dirname);
-        let path = resolve(__dirname, "../packages/", dirname);
-
-        // Get the remote package.json (or sub in a placeholder for new pacakges)
-        let npmInfo = await npm.getPackageVersion(info.name);
-        if (!npmInfo) { npmInfo = { version: "NEW" }; }
-
-        // No change
-        if (info.tarballHash === npmInfo.tarballHash) { continue; }
-
-        let gitHead = await git.getGitTag(path);
-
-        log(`<bold:Package>: ${info.name}`);
-        log(`    <green:Tarball Changed:>   (bumping version)`);
-        log(`        ${npmInfo.version}  =>  ${info.version}`)
-        log(`    <blue:Changed:>`);
-        let filenames = await git.getDiff(resolve(__dirname, "../packages", dirname), npmInfo.gitHead, true);
-        filenames.forEach((filename) => {
-            let short = filename.split("/").slice(1).join("/");
-            if (short.indexOf("/src.ts/") >= 0) {
-                log(`        <bold:${short}>`);
-            } else {
-                log(`        ${short}`);
-            }
-        });
-        log("");
-    }
-
-    // @TODO: Changelog
-    await updateChangelog();
-}
-
-async function runAdd(type, names) {
-    let latest = await git.getLatestTag();
-    console.log("");
-    console.log(colorify("<bold:Latest Published>: ") + latest);
-    console.log("");
-
-    let changes = await git.getChanges("HEAD");
-
-    if (!names || names.length === 0) {
-        names = Object.keys(changes);
-    }
-
-    let filenames = [ ];
-    for (let i = 0; i < names.length; i++) {
-        let name = names[i];
-        let change = changes[name] || changes[(packages[name] || {}).name];
-        if (!change) { return; }
-        change[type].forEach((filename) => {
-            filenames.push(filename);
-        });
-    }
-
-    if (filenames.length === 0) {
-        console.log(colorify("<bold:Nothing to add.>"));
-        console.log("");
-        return;
-    }
-
-    for (let i = 0; i < filenames.length; i++) {
-        let filename = filenames[i];
-        let status = await git.getStatus(filename);
-        console.log("    " + colorifyStatus(status) + ": " + utils.repeat(" ", 10 - status.length) + filename);
-    }
-
-    console.log("");
-
-    try {
-        let response = await prompt.getChoice(colorify("Add these files?", "bold"), "yn", "n");
-        if (response === "n") { throw new Error("Not adding."); }
-    } catch (error) {
-        console.log("Abort: " + error.message);
-        return;
-    }
-
-    let params = filenames.map((f) => f); //resolve(ROOT, f));
-    params.unshift("--");
-    params.unshift("add");
-
-    console.log("git " + params.join(" "));
-
-    try {
-        await git.run(params);
-    } catch (error) {
-        console.log("Error: (status: " + error.code + ")");
-        console.log("  " + error.stderr);
-        return;
-    }
-
-    console.log("Added.");
-}
-
-function runDist() {
-    // Run npm dist
-    // Generate changelog
-    // run status to update all the package
-    // add dist files?
-}
-
-async function runPublish(dirnames) {
-
-    // @TODO: Make sure there are no staged files
-
-    // @TODO: Make sure the repo has been pushed
-
-    // @TODO: Run the publish in the correct order
-
-    // Get the authentication token from our encrypted store
-    let token = await config.get("token");
-    token = token.trim().split("=");
-
-    let options = {
-        npmVersion: "ethers-dist@0.0.0",
-        tag: "next"
-    };
-
-    // Set the authentication token
-    options[token[0]] = token[1];
-
-    if (dirnames == null || dirnames.length === 0) { dirnames = local.dirnames; }
-    depgraph.sort(dirnames);
-
-    await runChanged(dirnames, async (dirname, info, npmInfo) => {
-        console.log(colorify("<bold:Publishing:> ") + info.name + "...")
-        console.log(colorify("  Version: ", "blue") + npmInfo.version + colorify("  =>  ", "bold") + info.version);
-
-        let success = await npm.publish(dirname, options);
-        if (!success) {
-            console.log(colorify("  <red:FAILED! Aborting.>"));
-            throw new Error("");
-        }
-        console.log(colorify("  <green:Done.>"));
-    });
-}
-
-async function runTest() {
-    let r = await git([ "tag", "--porcelain", "-a", "-m", "Title of Release\n\nHello\n-----\n\nTesting 4 **bold** #1\nHello World", "test6", "HEAD" ]);
-    console.log(r);
-    try {
-    r = await git([ "push", "--tags" ])
-    } catch(e) { console.log(e); }
-    console.log(r);
-}
-
-(function() {
-    let args = process.argv.slice(2);
-    switch (args[0]) {
-
-        // Compare published to current stage
-        case "diff":
-            return runDiff(args.slice(1));
-
-        // Add unchecked-in source files
-        case "add-source":
-            return runAdd("src", args.slice(1));
-
-        // Update all package.json. the changelog and dist files
-        case "update":
-            return runUpdate(args.slice(1));
-
-        // Update dependency graph (./tsconfig-project.json)
-        case "update-depgraph":
-            return runUpdateDepgraph();
-
-        // Add unchecked-in dist files
-        case "add-dist":
-            return runAdd("dist", args.slice(1));
-
-
-        // Add unchecked-in source files
-        case "changelog":
-            return updateChangelog();
-
-        // Add unchecked-in source files
-        case "publish":
-            return runPublish(args.slice(1));
-
-        case "test":
-            return runTest();
-    }
-})();

admin/local.js

@@ -1,101 +0,0 @@
-"use strict";
-
-const packlist = require("npm-packlist");
-const tar = require("tar");
-
-const keccak256 = (function() {
-    try {
-        return require("../packages/keccak256").keccak256;
-    } catch (error) {
-        console.log("Cannot load Keccak256 (maybe not built yet? Not really a problem for most things)");
-        return null;
-    }
-})();
-
-const { dirnames, loadPackage, ROOT } = require("./depgraph");
-const { resolve, saveJson } = require("./utils");
-
-function sorted(obj) {
-    if (Array.isArray(obj)) { return obj.map(sorted); }
-    if (obj == null || typeof(obj) !== "object") { return obj; }
-
-    const keys = Object.keys(obj);
-    keys.sort();
-
-    const result = { };
-    keys.forEach((key) => { result[key] = sorted(obj[key]); });
-    return result;
-}
-
-function savePackage(dirname, info) {
-    return saveJson(resolve(ROOT, dirname, "package.json"), sorted(info));
-}
-
-async function createTarball(dirname) {
-    let base = resolve(ROOT, dirname);
-
-    // From NPM publish, create the packed version
-    let files = await packlist({ path: base });
-    files = files.map((f) => ("./" + f));
-
-    let options = {
-        cwd: base,
-        prefix: 'package/',
-        portable: true,
-        sync: true,
-        // Provide a specific date in the 1980s for the benefit of zip,
-        // which is confounded by files dated at the Unix epoch 0.
-        mtime: new Date('1985-10-26T08:15:00.000Z'),
-        gzip: true
-    };
-
-    // Take the hash of the package sans
-    return tar.create(options, files).read();
-}
-
-async function updatePackage(dirname, values) {
-    let info = loadPackage(dirname);
-
-    if (values) {
-        for (let key in values) {
-            info[key] = values[key];
-        }
-    }
-    /*
-    ["dependencies", "devDependencies"].forEach((key) => {
-        let deps = info[key] || [];
-        for (let name in deps) {
-            if (name.substring(0, "@ethersproject".length) === "@ethersproject" || name === "ethers") {
-                deps[name] = ">5.0.0-beta.0";
-            }
-        }
-    });
-    */
-
-    //if (dirname !== "ethers") {
-    //    delete info.publishConfig.tag;
-    //}
-
-    // Create a normalized version sans tarballHash to compute the tarballHash
-    delete info.tarballHash;
-    savePackage(dirname, info);
-
-    // Compute the tarballHash
-    let tarball = await createTarball(dirname);
-    info.tarballHash = keccak256(tarball);
-
-    // Save the updated package.json to disk
-    savePackage(dirname, info);
-
-    return info;
-}
-
-module.exports = {
-    ROOT: ROOT,
-    createTarball: createTarball,
-    dirnames: dirnames,
-    getVersion: function(dirname) { return ((loadPackage(dirname) || {}).version || null); },
-    loadPackage: loadPackage,
-    savePackage: savePackage,
-    updatePackage: updatePackage,
-}

admin/log.js

@@ -1,53 +0,0 @@
-"use strict";
-
-function getColor(color) {
-    if (!color || color === "normal") { return "\x1b[0m"; }
-    return "\x1b[1m" + ({
-        blue: "\x1b[34m",
-        cyan: "\x1b[36m",
-        green: "\x1b[32m",
-        magenta: "\x1b[35m",
-        red:   "\x1b[31m",
-        yellow: "\x1b[33m",
-        bold: ""
-    })[color];
-}
-
-// See: https://stackoverflow.com/questions/9781218/how-to-change-node-jss-console-font-color
-let disableColor = !(process.stdout.isTTY);
-function colorify(message, color) {
-    if (color) {
-        if (disableColor) { return message; }
-        return getColor(color) + message + getColor();
-    }
-
-    return message.replace(/<([^:]*):((?:[^<>\\]|\\.)*)>/g, (all, color, message) => {
-        message = message.replace("\\>", ">");
-        if (disableColor) { return message; }
-        return getColor(color) + message + getColor();
-    });
-}
-
-function colorifyStatus(status) {
-    switch (status) {
-        case "modified":   return colorify("<blue:" + status + ">");
-        case "added":      return colorify("<green:" + status + ">");
-        case "deleted":    return colorify("<red:" + status + ">");
-        case "unmodified": return colorify("<magenta:" + status + ">");
-    }
-    return status;
-}
-
-function log(message, color) {
-    if (color) {
-        console.log(colorify(message, color));
-    } else {
-        console.log(colorify(message));
-    }
-}
-
-module.exports = {
-    colorify: colorify,
-    colorifyStatus: colorifyStatus,
-    log: log
-}

admin/npm.js

@@ -1,104 +0,0 @@
-"use strict";
-
-const resolve = require("path").resolve;
-
-const npm = require("libnpm");
-const semver = require("semver");
-
-const local = require("./local");
-
-const keccak256 = require("../packages/keccak256").keccak256;
-const fetchJson = require("../packages/web").fetchJson;
-const { prompt } = require("../packages/cli");
-
-const colorify = require("./log").colorify;
-const git = require("./git");
-
-
-let cache = { };
-
-async function getPackage(name) {
-    if (cache[name]) { return cache[name]; }
-
-    return fetchJson("http:/" + "/registry.npmjs.org/" + name).then((result) => {
-        cache[name] = result;
-        return result;
-    }, (error) => {
-        if (error.status === 404) {
-            return null;
-        }
-        throw error;
-    });
-}
-
-async function getVersion(name) {
-    return getPackage(name).then((result) => {
-        if (!result) { return null; }
-        let versions = Object.keys(result.versions);
-        versions.sort(semver.compare)
-        return versions.pop();
-    });
-}
-
-async function getPackageVersion(name, version) {
-    let info = await getPackage(name)
-    if (!info) { return null; }
-
-    if (version == null) {
-        let versions = Object.keys(info.versions);
-        versions.sort(semver.compare);
-        version = versions.pop();
-    }
-
-    return info.versions[version] || null;
-}
-
-async function getTarballHash(name, version) {
-    let info = await getPackageVersion(name, version);
-    return (info || {}).tarballHash;
-}
-
-async function _publish(info, tarball, options) {
-    try {
-        let result = await npm.publish(info, tarball, options);
-        return result;
-    } catch (error) {
-
-        // We need an OTP
-        if (error.code === "EOTP") {
-            try {
-                let otp = await prompt.getMessage(colorify("Enter OTP: ", "bold"));
-                options.otp = otp.replace(" ", "");
-            } catch (error) {
-
-                // CTRL-C
-                if (error.message === "cancelled") {
-                    return false;
-                }
-
-                // Something unexpected...
-                throw error;
-            }
-
-            // Retry with the new OTP
-            return _publish(info, tarball, options);
-        }
-        throw error;
-    }
-}
-
-async function publish(dirname, options) {
-    let info = local.loadPackage(dirname);
-    info.gitHead = await git.getGitTag(resolve(__dirname, "../packages/", dirname));
-    if (info.gitHead == null) { throw new Error("no git tag found - " + dirname); }
-    let tarball = await local.createTarball(dirname);
-    return _publish(info, tarball, options);
-}
-
-module.exports = {
-    getPackage: getPackage,
-    getPackageVersion: getPackageVersion,
-    getTarballHash: getTarballHash,
-    getVersion: getVersion,
-    publish: publish,
-};

admin/test-parity/parity-dev.json

@@ -1,50 +0,0 @@
-{
-    "name": "DevelopmentChain",
-    "engine": {
-        "instantSeal": null
-    },
-    "params": {
-        "gasLimitBoundDivisor": "0x0400",
-        "accountStartNonce": "0x0",
-        "maximumExtraDataSize": "0x20",
-        "minGasLimit": "0x1388",
-        "networkID" : "0x11",
-        "registrar" : "0x0000000000000000000000000000000000001337",
-        "maxCodeSize": 24576,
-        "maxCodeSizeTransition": "0x0",
-        "eip98Transition": "0x7fffffffffffff",
-        "eip140Transition": "0x0",
-        "eip145Transition": "0x0",
-        "eip150Transition": "0x0",
-        "eip155Transition": "0x0",
-        "eip160Transition": "0x0",
-        "eip161abcTransition": "0x0",
-        "eip161dTransition": "0x0",
-        "eip211Transition": "0x0",
-        "eip214Transition": "0x0",
-        "eip658Transition": "0x0",
-        "wasmActivationTransition": "0x0"
-    },
-    "genesis": {
-        "seal": {
-            "generic": "0x0"
-        },
-        "difficulty": "0x20000",
-        "author": "0x0000000000000000000000000000000000000000",
-        "timestamp": "0x00",
-        "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
-        "extraData": "0x",
-        "gasLimit": "0x7A1200"
-    },
-    "accounts": {
-        "0000000000000000000000000000000000000001": { "balance": "1", "builtin": { "name": "ecrecover", "pricing": { "linear": { "base": 3000, "word": 0 } } } },
-        "0000000000000000000000000000000000000002": { "balance": "1", "builtin": { "name": "sha256", "pricing": { "linear": { "base": 60, "word": 12 } } } },
-        "0000000000000000000000000000000000000003": { "balance": "1", "builtin": { "name": "ripemd160", "pricing": { "linear": { "base": 600, "word": 120 } } } },
-        "0000000000000000000000000000000000000004": { "balance": "1", "builtin": { "name": "identity", "pricing": { "linear": { "base": 15, "word": 3 } } } },
-        "0000000000000000000000000000000000000005": { "balance": "1", "builtin": { "name": "modexp", "activate_at": 0, "pricing": { "modexp": { "divisor": 20 } } } },
-        "0000000000000000000000000000000000000006": { "balance": "1", "builtin": { "name": "alt_bn128_add", "activate_at": 0, "pricing": { "linear": { "base": 500, "word": 0 } } } },
-        "0000000000000000000000000000000000000007": { "balance": "1", "builtin": { "name": "alt_bn128_mul", "activate_at": 0, "pricing": { "linear": { "base": 40000, "word": 0 } } } },
-        "0000000000000000000000000000000000000008": { "balance": "1", "builtin": { "name": "alt_bn128_pairing", "activate_at": 0, "pricing": { "alt_bn128_pairing": { "base": 100000, "pair": 80000 } } } },
-        "0x7454a8f5a7c7555d79b172c89d20e1f4e4cc226c": { "balance": "1606938044258990275541962092341162602522202993782792835301376" }
-    }
-}

admin/test-parity/parity-keys/UTC--2019-06-25T00-14-25Z--24d70b97-fff9-d322-e760-4b8cc2e21751

@@ -1 +0,0 @@
-{"id":"24d70b97-fff9-d322-e760-4b8cc2e21751","version":3,"crypto":{"cipher":"aes-128-ctr","cipherparams":{"iv":"45d392cd16dbbd5c0f5b2d145c112da9"},"ciphertext":"b001ccd09fc5431dc055975b58ee61f86e85529245506c04182c902716e750e5","kdf":"pbkdf2","kdfparams":{"c":10240,"dklen":32,"prf":"hmac-sha256","salt":"028594da27a0e864105f33b912e5dc6ce7c75ecd13c81bfc158fe963d30c93bb"},"mac":"374bf2e9144b74b889708abc19e9ebc164f90bc27e83fd9f01da4571a9f81a70"},"address":"7454a8f5a7c7555d79b172c89d20e1f4e4cc226c","name":"","meta":"{}"}

admin/utils.js

@@ -1,64 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const _resolve = require("path").resolve;
-
-function repeat(chr, length) {
-    let result = chr;
-    while (result.length < length) { result += chr; }
-    return result;
-}
-
-function zpad(value) {
-    value = String(value);
-    while (value.length < 2) { value = "0" + value; }
-    return value;
-}
-
-function getDate(date) {
-    return [
-        date.getFullYear(),
-        zpad(date.getMonth() + 1),
-        zpad(date.getDate())
-    ].join("-");
-}
-
-function getDateTime(date) {
-    return getDate(date) + " " + [
-        zpad(date.getHours()) ,
-        zpad(date.getMinutes() + 1)
-    ].join(":");
-}
-
-function today() {
-    return getDate(new Date());
-}
-
-function loadJson(filename) {
-    return JSON.parse(fs.readFileSync(filename).toString());
-}
-
-// @TODO: atomic write
-function saveJson(filename, json) {
-    fs.writeFileSync(filename, JSON.stringify(json, null, 2) + "\n");
-}
-
-function resolve(...args) {
-    args = args.slice();
-    args.unshift("..");
-    args.unshift(__dirname);
-    return _resolve.apply(null, args);
-}
-
-module.exports = {
-    resolve: resolve,
-
-    loadJson: loadJson,
-    saveJson: saveJson,
-
-    repeat: repeat,
-
-    today: today,
-    getDate: getDate,
-    getDateTime: getDateTime
-}

docs.wrm/api-keys.wrm

@@ -0,0 +1,167 @@
+_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 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 @NOTE<(see the [[EtherscanProvider]])> @<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
+
+_definition: **Networks:**
+``homestead``, ``ropsten``, ``rinkeby``, ``goerli`` and ``kovan``.
+
+
+_subsection: INFURA @NOTE<(see the [[InfuraProvider]])> @<api-keys--infura>
+
+The INFURA service has been around for quite some time and is very robust
+and reliable and highly recommended.
+
+They offer a standard JSON-RPC interface and a WebSocket interface, which makes
+interaction with standard tools versatile, simple and straightforward.
+
+[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)
+
+_definition: **Networks:**
+``homestead``, ``ropsten``, ``rinkeby``, ``goerli``, ``kovan``, ``matic``,
+``maticmum``, ``optimism``, ``optimism-kovan``, ``arbitrum`` and
+``arbitrum-rinkeby``.
+
+
+_subsection: Alchemy @NOTE<(see the [[AlchemyProvider]])> @<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
+
+_definition: **Networks:**
+``homestead``, ``ropsten``, ``rinkeby``, ``goerli``, ``kovan``, ``matic``,
+``maticmum``, ``optimism``, ``optimism-kovan``, ``arbitrum`` and
+``arbitrum-rinkeby``.
+
+
+_subsection: Pocket Gateway @NOTE<(see the [[PocketProvider]])> @<api-keys--pocket-gateway>
+
+They offer a standard JSON-RPC interface using either a load-balanced
+network or non-load-balanced fleet.
+
+[Sign up for a free API key on Pocket](link-pocket-signup)
+
+**Benefits:**
+
+- customer usage metrics
+- decentralized Access to Blockchain Infrastructure
+- Stake as opposed to paying a monthly fee
+- Highly redundant global set of nodes incentivized by cryptoeconomic incentives
+
+_definition: **Networks:**
+``homestead``
+
+
+_subsection: Ankr @NOTE<(see the [[AnkrProvider]])> @<api-keys--ankr>
+
+They offer a standard JSON-RPC interface and have fairly high capacity without
+the need for an API key early on in the development cycle.
+
+[See their free tier features on Ankr](link-ankr-public)
+
+**Benefits:**
+
+- higher rate limit
+- customer usage metrics
+- access to archive data (requires paid upgrade)
+
+_definition: **Networks:**
+``homestead``, ``matic`` and ``arbitrum``
+
+
+_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.
+
+If the API key ``"-"`` is used, the corresponding Provider will be omitted.
+
+_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,
+    // Or if using a project secret:
+    // infura: {
+    //   projectId: YOUR_INFURA_PROJECT_ID,
+    //   projectSecret: YOUR_INFURA_PROJECT_SECRET,
+    // },
+    alchemy: YOUR_ALCHEMY_API_KEY,
+    pocket: YOUR_POCKET_APPLICATION_KEY
+    // Or if using an application secret key:
+    // pocket: {
+    //   applicationId: ,
+    //   applicationSecretKey:
+    // },
+    ankr: YOUR_ANKR_API_KEY
+});

docs.wrm/api/contract/MyToken.sol

@@ -0,0 +1,34 @@
+// Do not use this; it is only for an example in the docs
+
+contract MyToken {
+    event Transfer(address indexed from, address indexed to, uint amount);
+
+    mapping (address => uint256) _balances;
+
+    constructor(uint256 totalSupply) {
+        emit Transfer(address(0), msg.sender, totalSupply);
+        _balances[msg.sender] = totalSupply;
+    }
+
+    // Read-Only Functions
+    function balanceOf(address owner) public view returns (uint256) {
+        return _balances[owner];
+    }
+
+    function decimals() public pure returns (uint8) {
+        return 18;
+    }
+
+    function symbol() public pure returns (string memory) {
+        return "MyToken";
+    }
+
+    // Authenticated Functions
+    function transfer(address to, uint amount) public returns (bool) {
+        require(_balances[msg.sender] >= amount, "insufficient token balance");
+        _balances[msg.sender] -= amount;
+        _balances[to] += amount;
+        emit Transfer(msg.sender, to, amount);
+        return true;
+    }
+}

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

@@ -1,78 +1,119 @@
 _section: ContractFactory @<ContractFactory> @SRC<contracts:class.ContractFactory>
 
-@TODO: Fill this in, including @SRC links
+To deploy a [[Contract]], additional information is needed
+that is not available on a Contract object itself.
+
+Mainly, the bytecode (more specifically the initcode) of a contract is required.
+
+The **Contract Factory** sends a special type of transaction, an initcode
+transaction (i.e. the ``to`` field is null, and the ``data`` field is the
+initcode) where the initcode will be evaluated and the result becomes the
+new code to be deployed as a new contract.
 
 _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>
+
+Creates a new instance of a **ContractFactory** for the contract described
+by the //interface// and //bytecode// initcode.
 
 _property: ContractFactory.fromSolidity(compilerOutput [ , signer ]) => [[ContractFactory]]
 
-_property: contractFactory.connect(signer) => [[Contract]] @<ContractFactory-connect>
+Consumes the output of the Solidity compiler, extracting the ABI
+and bytecode from it, allowing for the various formats the solc
+compiler has emitted over its life.
 
+_property: contractFactory.connect(signer) => [[ContractFactory]] @<ContractFactory-connect>
+
+Returns a **new instance** of the ContractFactory with the same //interface//
+and //bytecode//, but with a different //signer//.
 
 _subsection: Properties  @<ContractFactory--properties>
 
 _property: contractFactory.interface => [[Interface]]
 
+The [[Contract]] interface.
+
 _property: contractFactory.bytecode => string<[[DataHexString]]>
 
+The bytecode (i.e. initcode) that this **ContractFactory** will
+use to deploy the Contract.
+
 _property: contractFactory.signer => [[Signer]]
 
+The [[Signer]] (if any) this ContractFactory will use to deploy instances
+of the Contract to the Blockchain.
+
 
 _subsection: Methods  @<ContractFactory--methods>
 
 _property: contractFactory.attach(address) => [[Contract]] @<ContractFactory-attach>
 
-Return an instance of a [[Contract]] attched to //address//. This is the
+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
+//address// and this the //interface// and //signerOrProvider// passed
 in when creating the ContractFactory.
 
-_property: contractFactory.getDeployTransaction(...args) => [[UnsignedTransaction]]
+_property: contractFactory.getDeployTransaction(...args [ , overrides ]) => [[UnsignedTransaction]]
 
 Returns the unsigned transaction which would deploy this Contract with //args// passed
 to the Contract's constructor.
 
-_property: contractFactory.deploy(...args) => Promise<[[Contract]]> @<ContractFactory-deploy>
+If the optional //overrides// is specified, they can be used to
+override the endowment ``value``, transaction ``nonce``, ``gasLimit`` or
+``gasPrice``.
 
-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.
+_property: contractFactory.deploy(...args [ , overrides ]) => Promise<[[Contract]]> @<ContractFactory-deploy>
 
-The transction can be found at ``contract.deployTransaction``, and no interactions
+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 transaction can be found at ``contract.deployTransaction``, and no interactions
 should be made until the transaction is mined.
 
-_code: Deploying a Contract
+If the optional //overrides// is specified, they can be used to
+override the endowment ``value``, transaction ``nonce``, ``gasLimit`` or
+``gasPrice``.
 
-// <hide>
-const signer = ethers.LocalSigner();
-const ContractFactory = ethers.ContractFactory;
-// </hide>
+_code: Deploying a Contract @lang<javascript>
+
+//_hide: const signer = localSigner;
+//_hide: const ContractFactory = ethers.ContractFactory;
+//_hide: const bytecode = "608060405234801561001057600080fd5b5060405161012e38038061012e8339818101604052604081101561003357600080fd5b81019080805190602001909291908051906020019092919050505081600160006101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff1602179055508060008190555050506088806100a66000396000f3fe6080604052348015600f57600080fd5b506004361060285760003560e01c80633fa4f24514602d575b600080fd5b60336049565b6040518082815260200191505060405180910390f35b6000805490509056fea2646970667358221220926465385af0e8706644e1ff3db7161af699dc063beaadd55405f2ccd6478d7564736f6c63430007040033";
 
 // If your contract constructor requires parameters, the ABI
 // must include the constructor
 const abi = [
-  "constructor(address owner, uint256 initialValue)"
+  "constructor(address owner, uint256 initialValue)",
+  "function value() view returns (uint)"
 ];
 
-const factory = new ContractFactory(abi, bytecode, signer)
+// The factory we use for deploying contracts
+factory = new ContractFactory(abi, bytecode, signer)
 
-const contract = await factory.deploy("ricmoo.eth", 42);
+// Deploy an instance of the contract
+contract = await factory.deploy("ricmoo.eth", 42);
 
 // The address is available immediately, but the contract
 // is NOT deployed yet
+//_result:
 contract.address
-//!
+//_log:
 
 // The transaction that the signer sent to deploy
+//_result:
 contract.deployTransaction
-//!
+//_log:
 
-// Wait until the transaction is mined
-contract.deployTransaction.wait()
-//!
+// Wait until the transaction is mined (i.e. contract is deployed)
+//  - returns the receipt
+//  - throws on failure (the reciept is on the error)
+//_result:
+await contract.deployTransaction.wait()
+//_log:
 
-// Now the contract is safe to ineract with
-contract.value()
-//!
+// Now the contract is safe to interact with
+//_result:
+await contract.value()
+//_log:

docs.wrm/api/contract/contract.wrm

@@ -1,25 +1,29 @@
 _section: Contract @<Contract> @SRC<contracts:class.Contract>
 
-Explain contract here...
+A **Contract** is an abstraction of code that has been deployed
+to the blockchain.
+
+A Contract may be sent transactions, which will trigger its code
+to be run with the input of the transaction data.
 
 _subsection: Creating Instances @<Contract--creating>
 
-_property: new ethers.Contract(address, abi, signerOrProvider) @src<contracts:constructor.Contract>
+_property: new ethers.Contract(address, abi, signerOrProvider) @src<contracts:class.Contract>
 
-_property: contract.attach(addressOrName) => [[Contract]]  @<Contract-attach> @SRC<contracts:Contract.attach>
+_property: contract.attach(addressOrName) => [[Contract]]  @<Contract-attach> @SRC<contracts:BaseContract.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:BaseContract.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.
 
 
@@ -61,11 +65,11 @@ _subsection: Events @<Contract--events>
 _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:BaseContract.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:BaseContract.listeners>
 Return a list of listeners that are subscribed to //event//.
 
 _property: contract.off(event, listener) => this  @<Contract-off> @SRC<contracts>
@@ -78,7 +82,7 @@ _property: contract.once(event, listener) => this  @<Contract-once> @SRC<contrac
 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:BaseContract.removeAllListeners>
 Unsubscribe all listeners for //event//. If no event is provided,
 all events are unsubscribed.
 
@@ -94,25 +98,55 @@ at run-time during the **Contract** constructor.
 
 _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
-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..
+A constant method (denoted by ``pure`` or ``view`` in Solidity)
+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..
 
 _property: contract.METHOD_NAME(...args [, overrides ]) => Promise<any>  @<Contract-functionsCall>
-The type of the result depends on the ABI.
+The type of the result depends on the ABI. If the method returns a single
+value, it will be returned directly, otherwise a [[Result]] object will
+be returned with each parameter available positionally and if the parameter
+is named, it will also be available by its name.
 
 For values that have a simple meaning in JavaScript, the types are fairly
-straight forward; strings and booleans are returned as JavaScript strings
+straightforward; 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.
 
+If the call reverts (or runs out of gas), a [CALL_EXCEPTION](errors--call-exception)
+will be thrown which will include:
+
+- ``error.address`` - the contract address
+- ``error.args`` - the arguments passed into the method
+- ``error.transaction`` - the transaction
+
+The //overrides// object for a read-only method may include any of:
+
+- ``overrides.from`` - the ``msg.sender`` (or ``CALLER``) to use during the
+  execution of the code
+- ``overrides.value`` - the ``msg.value`` (or ``CALLVALUE``) to use during the
+  execution of the code
+- ``overrides.gasPrice`` - the price to pay per gas (theoretically); since there
+  is no transaction, there is not going to be any fee charged, but the EVM still
+  requires a value to report to ``tx.gasprice`` (or ``GASPRICE``);
+  //most developers will not require this//
+- ``overrides.gasLimit`` - the amount of gas (theoretically) to allow a node
+  to use during the execution of the code; since there is no transaction, there
+  is not going to be any fee charged, but the EVM still processes gas metering
+  so calls like ``gasleft`` (or ``GAS``) report meaningful values
+- ``overrides.blockTag`` - a block tag to simulate the execution at, which
+  can be used for hypothetical historic analysis; note that many backends
+  do not support this, or may require paid plans to access as the node database
+  storage and processing requirements are much higher
+
 _property: contract.functions.METHOD_NAME(...args [, overrides ]) => Promise<[[Result]]>
 
 The result will always be a [[Result]], even if there is only a single
@@ -130,6 +164,8 @@ allowing an alternate UTF-8 error strategy to be used.
 
 Most developers should not require this.
 
+The //overrides// are identical to the read-only operations above.
+
 _heading: Write Methods (non-constant) @<Contract--write>
 
 A non-constant method requires a transaction to be signed and requires
@@ -147,31 +183,65 @@ Returns a [[providers-TransactionResponse]] for the transaction after
 it is sent to the network. This requires the **Contract** has a
 signer.
 
+The //overrides// object for write methods may include any of:
+
+- ``overrides.gasPrice`` - the price to pay per gas
+- ``overrides.gasLimit`` - the limit on the amount of gas to allow the transaction
+  to consume; any unused gas is returned at the gasPrice
+- ``overrides.value`` - the amount of ether (in wei) to forward with the call
+- ``overrides.nonce`` - the nonce to use for the [[Signer]]
+
+If the ``wait()`` method on the returned [[providers-TransactionResponse]]
+is called, there will be additional properties on the receipt:
+
+- ``receipt.events`` - an array of the logs, with additional properties
+  (if the ABI included a description for the events)
+- ``receipt.events[n].args`` - the parsed arguments
+- ``receipt.events[n].decode`` - a method that can be used to parse the
+  log topics and data (this was used to compute ``args``)
+- ``receipt.events[n].event`` - the name of the event
+- ``receipt.events[n].eventSignature`` - the full signature of the event
+- ``receipt.removeListener()`` - a method to remove the listener that trigger
+  this event
+- ``receipt.getBlock()`` - a method to return the [Block](providers-Block) this event occurred in
+- ``receipt.getTransaction()`` - a method to return the
+  [Transaction](providers-TransactionResponse) this event occurred in
+- ``receipt.getTransactionReceipt()`` - a method to return the
+  [Transaction Receipt](providers-TransactionReceipt) this event occurred in
+
 
 _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>
 Returns the estimate units of gas that would be required to
 execute the //METHOD_NAME// with //args// and //overrides//.
 
+The //overrides// are identical to the overrides above for read-only
+or write methods, depending on the type of call of //METHOD_NAME//.
+
 _property: contract.populateTransaction.METHOD_NAME(...args [ , overrides ]) => Promise<[UnsignedTx](UnsignedTransaction)>  @<contract-populateTransaction>
 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>
+The //overrides// are identical to the overrides above for read-only
+or write methods, depending on the type of call of //METHOD_NAME//.
+
+_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).
 
+The //overrides// are identical to the read-only operations above.
+
 _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

docs.wrm/api/contract/example.wrm

@@ -1,10 +1,75 @@
 _section: Example: ERC-20 Contract
 
+The concept of Meta-Classes is somewhat confusing, so we will go
+over a short example.
+
+A meta-class is a class which is defined at run-time. A Contract
+is specified by an //Application Binary Interface// (ABI), which describes
+the methods and events it has. This description is passed the the
+[[Contract]] object at run-time, and it creates a new Class, adding
+all the methods defined in the ABI at run-time.
+
+_subsection: Deploying a Contract
+
+Most often, any contract you will need to interact with will already
+be deployed to the blockchain, but for this example will will first
+deploy the contract.
+
+_property: new ethers.ContractFactory(abi, bytecode, signer)
+Create a new [[ContractFactory]] which can deploy a contract to the
+blockchain.
+
+_code: @lang<javascript>
+
+//_hide: const signer = localSigner;
+//_hide: const parseUnits = utils.parseUnits;
+
+const bytecode = "0x608060405234801561001057600080fd5b506040516103bc3803806103bc83398101604081905261002f9161007c565b60405181815233906000907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9060200160405180910390a333600090815260208190526040902055610094565b60006020828403121561008d578081fd5b5051919050565b610319806100a36000396000f3fe608060405234801561001057600080fd5b506004361061004c5760003560e01c8063313ce5671461005157806370a082311461006557806395d89b411461009c578063a9059cbb146100c5575b600080fd5b604051601281526020015b60405180910390f35b61008e610073366004610201565b6001600160a01b031660009081526020819052604090205490565b60405190815260200161005c565b604080518082018252600781526626bcaa37b5b2b760c91b6020820152905161005c919061024b565b6100d86100d3366004610222565b6100e8565b604051901515815260200161005c565b3360009081526020819052604081205482111561014b5760405162461bcd60e51b815260206004820152601a60248201527f696e73756666696369656e7420746f6b656e2062616c616e6365000000000000604482015260640160405180910390fd5b336000908152602081905260408120805484929061016a9084906102b6565b90915550506001600160a01b0383166000908152602081905260408120805484929061019790849061029e565b90915550506040518281526001600160a01b0384169033907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9060200160405180910390a350600192915050565b80356001600160a01b03811681146101fc57600080fd5b919050565b600060208284031215610212578081fd5b61021b826101e5565b9392505050565b60008060408385031215610234578081fd5b61023d836101e5565b946020939093013593505050565b6000602080835283518082850152825b818110156102775785810183015185820160400152820161025b565b818111156102885783604083870101525b50601f01601f1916929092016040019392505050565b600082198211156102b1576102b16102cd565b500190565b6000828210156102c8576102c86102cd565b500390565b634e487b7160e01b600052601160045260246000fdfea2646970667358221220d80384ce584e101c5b92e4ee9b7871262285070dbcd2d71f99601f0f4fcecd2364736f6c63430008040033";
+
+// A Human-Readable ABI; we only need to specify relevant fragments,
+// in the case of deployment this means the constructor
+const abi = [
+    "constructor(uint totalSupply)"
+];
+
+const factory = new ethers.ContractFactory(abi, bytecode, signer)
+
+// Deploy, setting total supply to 100 tokens (assigned to the deployer)
+const contract = await factory.deploy(parseUnits("100"));
+
+// The contract is not currentl live on the network yet, however
+// its address is ready for us
+//_result:
+contract.address
+//_log:
+//_hide: _page.address = contract.address;
+
+// Wait until the contract has been deployed before interacting
+// with it; returns the receipt for the deployemnt transaction
+//_result:
+await contract.deployTransaction.wait();
+//_log:
+
+
 _subsection: Connecting to a Contract
 
-_code: A simple ERC-20 contract @lang<javascript>
+_heading: ERC20Contract @INHERIT<[[Contract]]>
 
-// A Human-Readable ABI; any supported ABI format could be used
+_property: new ethers.Contract(address, abi, providerOrSigner)
+Creating a new instance of a Contract connects to an existing
+contract by specifying its //address// on the blockchain,
+its //abi// (used to populate the class' methods) a //providerOrSigner//.
+
+If a [[Provider]] is given, the contract has only read-only access, while
+a [[Signer]] offers access to state manipulating methods.
+
+_code: @lang<javascript>
+
+//_hide: const provider = localProvider;
+//_hide: const signer = localSigner;
+
+// A Human-Readable ABI; for interacting with the contract, we
+// must include any fragment we wish to use
 const abi = [
     // Read-Only Functions
     "function balanceOf(address owner) view returns (uint256)",
@@ -12,20 +77,15 @@ const abi = [
     "function symbol() view returns (string)",
 
     // Authenticated Functions
-    "function transfer(address to, uint amount) returns (boolean)",
+    "function transfer(address to, uint amount) returns (bool)",
 
     // Events
     "event Transfer(address indexed from, address indexed to, uint amount)"
 ];
 
 // This can be an address or an ENS name
-const address = "dai.tokens.ethers.eth";
-
-// An example Provider
-const provider = ethers.getDefaultProvider();
-
-// An example Signer
-const signer = ethers.Wallet.createRandom().connect(provider);
+//_hide: const address = _page.address;
+//_verbatim: `const address = ${ JSON.stringify(address) };`
 
 // Read-Only; By connecting to a Provider, allows:
 // - Any constant function
@@ -34,20 +94,13 @@ const signer = ethers.Wallet.createRandom().connect(provider);
 // - 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);
+//_hide: _page.erc20 = erc20;
 
 // 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)
-
-
-_heading: ERC20Contract @INHERIT<[[Contract]]>
-
-_property: 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//.
+const erc20_rw = new ethers.Contract(address, abi, signer);
+//_hide: _page.erc20_rw = erc20_rw;
 
 
 _subsection: Properties @NOTE<(inheritted from [[Contract]])>
@@ -91,7 +144,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>
@@ -101,6 +154,8 @@ _property: Contract.isIndexed(value) => boolean
 
 _subsection: Events @NOTE<(inheritted from [[Contract]])> @<erc20-events>
 
+See [Meta-Class Filters](erc20-meta-events) for examples using events.
+
 _property: erc20.queryFilter(event [ , fromBlockOrBlockHash [ , toBlock ]) => Promise<Array<Event>> @<erc20-queryfilter>
 Return Events that match the //event//.
 
@@ -126,7 +181,7 @@ Unsubscribe all listeners for //event//. If no event is provided,
 all events are unsubscribed.
 
 
-_subsection: Meta-Class Methods @NOTE<(added at Runtime)>
+_subsection: Meta-Class Methods @NOTE<(added at Runtime)> @<erc20-meta-methods>
 
 Since the Contract is a Meta-Class, the methods available here depend
 on the ABI which was passed into the **Contract**.
@@ -136,12 +191,35 @@ Returns the number of decimal places used by this ERC-20 token. This can be
 used with [parseUnits](utils-parseUnits) when taking input from the user or
 [formatUnits](utils-formatunits] when displaying the token amounts in the UI.
 
-_property: erc20.getBalance(owner [, overrides ]) => Promise<[[BigNumber]]>
+_code: @lang<javascript>
+
+//_hide: const erc20 = _page.erc20;
+//_result:
+await erc20.decimals();
+//_log:
+
+_property: erc20.balanceOf(owner [, overrides ]) => Promise<[[BigNumber]]>
 Returns the balance of //owner// for this ERC-20 token.
 
+_code: @lang<javascript>
+
+//_hide: const signer = localSigner;
+//_hide: const erc20 = _page.erc20;
+
+//_result:
+await erc20.balanceOf(signer.getAddress())
+//_log:
+
 _property: erc20.symbol([ overrides ]) => Promise<string>
 Returns the symbol of the token.
 
+_code: @lang<javascript>
+
+//_hide: const erc20 = _page.erc20;
+//_result:
+await erc20.symbol();
+//_log:
+
 _property: erc20_rw.transfer(target, amount [, overrides ]) => Promise<[[providers-TransactionResponse]]>
 Transfers //amount// tokens to //target// from the current signer.
 The return value (a boolean) is inaccessible during a write operation
@@ -149,20 +227,86 @@ 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.
 
+_code: @lang<javascript>
+
+//_hide: const signer = localSigner;
+//_hide: const erc20_rw = _page.erc20_rw;
+//_hide: const parseUnits = utils.parseUnits;
+//_hide: const formatUnits = utils.formatUnits;
+
+// Before...
+//_result:
+formatUnits(await erc20_rw.balanceOf(signer.getAddress()));
+//_log:
+
+// Transfer 1.23 tokens to the ENS name "ricmoo.eth"
+//_result:
+tx = await erc20_rw.transfer("ricmoo.eth", parseUnits("1.23"));
+//_log:
+
+// Wait for the transaction to be mined...
+//_result:
+await tx.wait();
+//_log:
+
+// After!
+//_result:
+formatUnits(await erc20_rw.balanceOf(signer.getAddress()));
+//_log:
+
+//_result:
+formatUnits(await erc20_rw.balanceOf("ricmoo.eth"));
+//_log:
+
 _property: 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.
 
+_code: @lang<javascript>
+
+//_hide: const erc20_rw = _page.erc20_rw;
+//_hide: const randomWallet = ethers.Wallet.createRandom().connect(erc20_rw.provider);
+//_hide: const parseUnits = utils.parseUnits;
+
+// The signer has enough tokens to send, so true is returned
+//_result:
+await erc20_rw.callStatic.transfer("ricmoo.eth", parseUnits("1.23"));
+//_log:
+
+// A random address does not have enough tokens to
+// send, in which case the contract throws an error
+erc20_random = erc20_rw.connect(randomWallet);
+//_throws:
+await erc20_random.callStatic.transfer("ricmoo.eth", parseUnits("1.23"));
+//_log:
+
 _property: erc20.estimateGas.transfer(target, amount [, overrides ]) => Promise<[[BigNumber]]>
 Returns an estimate for how many units of gas would be required
 to transfer //amount// tokens to //target//.
 
+_code: @lang<javascript>
+
+//_hide: const erc20_rw = _page.erc20_rw;
+//_hide: const parseUnits = utils.parseUnits;
+
+//_result:
+await erc20_rw.estimateGas.transfer("ricmoo.eth", parseUnits("1.23"));
+//_log:
+
 _property: erc20.populateTransaction.transfer(target, amount [, overrides ]) => Promise<[UnsignedTx](UnsignedTransaction)>
 Returns an [[UnsignedTransaction]] which could be signed and submitted
 to the network to transaction //amount// tokens to //target//.
 
+_code: @lang<javascript>
+
+//_hide: const erc20_rw = _page.erc20_rw;
+//_hide: const parseUnits = utils.parseUnits;
+
+//_result:
+await erc20_rw.populateTransaction.transfer("ricmoo.eth", parseUnits("1.23"));
+//_log:
 
 _note: Note on Estimating and Static Calling
 
@@ -173,14 +317,86 @@ blockchain also means there are certain consistency modes that cannot be
 known until an actual transaction is attempted.
 
 
-_subsection: Meta-Class Filters @NOTE<(added at Runtime)>
+_subsection: Meta-Class Filters @NOTE<(added at Runtime)> @<erc20-meta-events>
 
 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).
 
 If //fromAddress// is null or not provided, then any from address matches.
 If //toAddress// is null or not provided, then any to address matches.
+
+_code: query filter *from* events @lang<javascript>
+
+//_hide: const signer = localSigner;
+//_hide: const erc20 = _page.erc20;
+
+//_result:
+filterFrom = erc20.filters.Transfer(signer.address);
+//_log:
+
+// Search for transfers *from* me in the last 10 blocks
+//_result:
+logsFrom = await erc20.queryFilter(filterFrom, -10, "latest");
+//_log:
+
+// Note that the args providees the details of the event, each
+// parameters is available positionally, and since our ABI
+// included parameter names also by name
+//_result:
+logsFrom[0].args
+//_log:
+
+//_hide: _page.filterFrom = filterFrom;
+
+
+_code: query filter with *to* events @lang<javascript>
+
+//_hide: const signer = localSigner;
+//_hide: const erc20 = _page.erc20;
+
+//_result:
+filterTo = erc20.filters.Transfer(null, signer.address);
+//_log:
+
+// Search for transfers *to* me in the last 10 blocks
+// Note: the contract transferred totalSupply tokens to us
+//       when it was deployed in its constructor
+//_result:
+logsTo = await erc20.queryFilter(filterTo, -10, "latest");
+//_log:
+
+// Note that the args providees the details of the event, each
+// parameters is available positionally, and since our ABI
+// included parameter names also by name
+//_result:
+logsTo[0].args
+//_log:
+
+//_hide: _page.filterTo = filterTo;
+
+_code: listen for events @lang<javascript>
+
+//_hide: const erc20 = _page.erc20;
+//_hide: const filterFrom = _page.filterFrom;
+//_hide: const filterTo = _page.filterTo;
+
+// Listen to incoming events from signer:
+erc20.on(filterFrom, (from, to, amount, event) => {
+  // The `from` will always be the signer address
+});
+
+// Listen to incoming events to signer:
+erc20.on(filterTo, (from, to, amount, event) => {
+  // The `to` will always be the signer address
+});
+
+// Listen to all Transfer events:
+erc20.on("Transfer", (from, to, amount, event) => {
+  // ...
+});
+
+//_hide: erc20.removeAllListeners();

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

@@ -5,6 +5,10 @@ to be included in the base library. The API should not be considered
 stable and does not follow [[link-semver]] versioning, so applications
 requiring it should specify the //exact version// needed.
 
+These features are not available in the core ethers package, so to use them
+you must install the ``@ethersproject/experimental`` package and import them
+from that.
+
 _subsection: BrainWallet @<experimental-brainwallet> @INHERIT<[[Wallet]]>
 
 Ethers removed support for BrainWallets in v4, since they are unsafe and
@@ -17,7 +21,15 @@ 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.
+
+_code: Importing @lang<script>
+
+// Node
+const { BrainWallet } = require("@ethersproject/experimental");
+
+// ESM/TypeScript
+import { BrainWallet } from "@ethersproject/experimental";
 
 
 _subsection: EIP1193Bridge @<experimental-eip1193bridge> @INHERIT<[[link-npm-events]]>
@@ -26,6 +38,14 @@ The **EIP1193Bridge** allows a normal Ethers [[Signer]] and [[Provider]] to be
 exposed in as a standard [EIP-1193 Provider](link-eip-1193), which may be useful
 when interacting with other libraries.
 
+_code: Importing @lang<script>
+
+// Node
+const { Eip1193Bridge } = require("@ethersproject/experimental");
+
+// ESM/TypeScript
+import { Eip1193Bridge } from "@ethersproject/experimental";
+
 
 _subsection: NonceManager @<experimental-noncemanager> @INHERIT<[[Signer]]>
 
@@ -55,11 +75,19 @@ The provider associated with the signer.
 _property: nonceManager.setTransactionCount(count) => void
 Set the current transaction count (nonce) for the signer.
 
-This may be useful it interacting with the signer outside of using
+This may be useful in interacting with the signer outside of using
 this class.
 
-_property: nonceManager.increaseTransactionCount( [ count = 1 ]) => void
+_property: nonceManager.incrementTransactionCount( [ count = 1 ]) => void
 Bump the current transaction count (nonce) by //count//.
 
-This may be useful it interacting with the signer outside of using
+This may be useful in interacting with the signer outside of using
 this class.
+
+_code: Importing @lang<script>
+
+// Node
+const { NonceManager } = require("@ethersproject/experimental");
+
+// ESM/TypeScript
+import { NonceManager } from "@ethersproject/experimental";

docs.wrm/api/index.wrm

@@ -4,9 +4,9 @@ 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.
 
 
@@ -57,7 +57,7 @@ _heading: PopNode @<asm-popnode> @INHERIT<[[asm-valuenode]]> @SRC<asm:class.PopN
 
 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
+explicit place-holder (e.g. ``$1``), which indicates the expected stack position
 to consume.
 
 _property: literalNode.index => number
@@ -72,7 +72,7 @@ A **LinkNode** represents a link to another [[asm-node]]'s data,
 for example ``$foo`` or ``#bar``.
 
 _property: linkNode.label => string
-Te name of the target node.
+The name of the target node.
 
 _property: linkNode.type => "offset" | "length"
 Whether this node is for an offset or a length value of the
@@ -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
@@ -115,7 +115,7 @@ The code to execute. Any result is ignored.
 _heading: LabelledNode @<asm-labellednode> @INHERIT<[[asm-node]]> @SRC<asm:class.LabelledNode>
 
 A **LabelledNode** is used for any Node that has a name, and can therefore
-be targetted by a [[asm-linknode]].
+be targeted by a [[asm-linknode]].
 
 _property: labelledNode.name => string
 The name of this node.

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,
@@ -76,7 +76,7 @@ A scope may access the offset of any child [[asm-dialect-datasegment]] or
 child [[asm-dialect-scope]] (with respect to itself) and may access the length
 of any [[asm-dialect-datasegment]] or [[asm-dialect-scope]] anywhere in the program.
 
-Every program in the **Ethers ASM Dialect** has a top-leve scope named ``_``.
+Every program in the **Ethers ASM Dialect** has a top-level scope named ``_``.
 
 
 _subsection: Data Segment @<asm-dialect-datasegment>
@@ -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/providers/api-providers.wrm

@@ -6,12 +6,12 @@ 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.
+resilience, security and increase the amount of required trust.
 To mitigate these issues, it is recommended you use a
 [Default Provider](providers-getDefaultProvider).
 
 
-_subsection: EtherscanProvider @<EtherscanProvider> @inherit<[[Provider]]> @src<providers:class.EtherscanProvider>
+_subsection: EtherscanProvider @<EtherscanProvider> @inherit<[[BaseProvider]]> @src<providers:class.EtherscanProvider>
 
 The **EtherscanProvider** is backed by a combination of the various
 [Etherscan APIs](link-etherscan-api).
@@ -20,7 +20,7 @@ _property: new ethers.providers.EtherscanProvider([ network = "homestead", [ api
 Create a new **EtherscanProvider** connected to //network// with the
 optional //apiKey//.
 
-The //network// may be specified as **string** for a common
+The //network// may be specified as a **string** for a common
 network name, a **number** for a common chain ID or a
 [Network Object]provider-(network).
 
@@ -39,18 +39,16 @@ It is highly recommended for production, you register with
 
 _definition: **Supported Networks**
 
-- Homestead (Mainnet)
-- Ropsten (proof-of-work testnet)
-- Rinkeby (proof-of-authority testnet)
-- G&ouml;rli (clique testnet)
-- Kovan (proof-of-authority testnet)
+- ``homestead`` - Homestead (Mainnet)
+- ``ropsten`` - Ropsten (proof-of-work testnet)
+- ``rinkeby`` - Rinkeby (proof-of-authority testnet)
+- ``goerli`` - G&ouml;rli (clique testnet)
+- ``kovan`` - Kovan (proof-of-authority testnet)
 
 _code: Etherscan Examples @lang<javascript>
 
-// <hide>
-const EtherscanProvider = ethers.providers.EtherscanProvider;
-const apiKey = "...";
-// </hide>
+//_hide: const EtherscanProvider = ethers.providers.EtherscanProvider;
+//_hide: const apiKey = "...";
 
 // Connect to mainnet (homestead)
 provider = new EtherscanProvider();
@@ -59,12 +57,9 @@ provider = new EtherscanProvider();
 provider = new EtherscanProvider("rinkeby");
 provider = new EtherscanProvider(4);
 
-const network = ethers.providers.getNetwork("rinkeby");
-// <hide>
-delete network._defaultProvider;
-network
-// </hide>
-//!
+network = ethers.providers.getNetwork("rinkeby");
+//_hide: delete network._defaultProvider;
+//_log: network
 
 provider = new EtherscanProvider(network);
 
@@ -82,11 +77,11 @@ _subsection: InfuraProvider @<InfuraProvider> @INHERIT<[[UrlJsonRpcProvider]]> @
 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//.
 
-The //network// may be specified as **string** for a common
+The //network// may be specified as a **string** for a common
 network name, a **number** for a common chain ID or a
 [Network Object]provider-(network).
 
@@ -96,6 +91,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.
@@ -105,19 +106,23 @@ It is highly recommended for production, you register with
 
 _definition: **Supported Networks**
 
-- Homestead (Mainnet)
-- Ropsten (proof-of-work testnet)
-- Rinkeby (proof-of-authority testnet)
-- G&ouml;rli (clique testnet)
-- Kovan (proof-of-authority testnet)
+- ``homestead`` - Homestead (Mainnet)
+- ``ropsten`` - Ropsten (proof-of-work testnet)
+- ``rinkeby`` - Rinkeby (proof-of-authority testnet)
+- ``goerli`` - G&ouml;rli (clique testnet)
+- ``kovan`` - Kovan (proof-of-authority testnet)
+- ``matic`` - Polygon
+- ``maticmum`` - Polygon Mumbai Testnet
+- ``optimism`` - Optimism (L2; optimistic roll-up)
+- ``optimism-kovan`` - Optimism Testnet (L2; optimistic roll-up testnet)
+- ``arbitrum`` - Arbitrum (L2; optimistic roll-up)
+- ``arbitrum-rinkeby`` - Arbitrum Testnet (L2; optimistic roll-up testnet)
 
 _code: INFURA Examples @lang<javascript>
 
-// <hide>
-const InfuraProvider = ethers.providers.InfuraProvider;
-const projectId = "...";
-const projectSecret = "...";
-// </hide>
+//_hide: const InfuraProvider = ethers.providers.InfuraProvider;
+//_hide: const projectId = "...";
+//_hide: const projectSecret = "...";
 
 // Connect to mainnet (homestead)
 provider = new InfuraProvider();
@@ -136,6 +141,10 @@ provider = new InfuraProvider("homestead", {
     projectSecret: projectSecret
 });
 
+// Connect to the INFURA WebSocket endpoints with a WebSocketProvider
+provider = InfuraProvider.getWebSocketProvider()
+//_hide: await provider.destroy();
+
 
 _subsection: AlchemyProvider @<AlchemyProvider> @inherit<[[UrlJsonRpcProvider]]> @src<providers:class.AlchemyProvider>
 
@@ -145,7 +154,7 @@ _property: new ethers.providers.AlchemyProvider([ network = "homestead", [ apiKe
 Create a new **AlchemyProvider** connected to //network// with
 the optional //apiKey//.
 
-The //network// may be specified as **string** for a common
+The //network// may be specified as a **string** for a common
 network name, a **number** for a common chain ID or a
 [Network Object](providers-Network).
 
@@ -158,18 +167,22 @@ It is highly recommended for production, you register with
 
 _definition: **Supported Networks**
 
-- Homestead (Mainnet)
-- Ropsten (proof-of-work testnet)
-- Rinkeby (proof-of-authority testnet)
-- G&ouml;rli (clique testnet)
-- Kovan (proof-of-authority testnet)
+- ``homestead`` - Homestead (Mainnet)
+- ``ropsten`` - Ropsten (proof-of-work testnet)
+- ``rinkeby`` - Rinkeby (proof-of-authority testnet)
+- ``goerli`` - G&ouml;rli (clique testnet)
+- ``kovan`` - Kovan (proof-of-authority testnet)
+- ``matic`` - Polygon
+- ``maticmum`` - Polygon Mumbai Testnet
+- ``optimism`` - Optimism (L2; optimistic roll-up)
+- ``optimism-kovan`` - Optimism Testnet (L2; optimistic roll-up testnet)
+- ``arbitrum`` - Arbitrum (L2; optimistic roll-up)
+- ``arbitrum-rinkeby`` - Arbitrum Testnet (L2; optimistic roll-up testnet)
 
 _code: Alchemy Examples @lang<javascript>
 
-// <hide>
-const AlchemyProvider = ethers.providers.AlchemyProvider;
-const apiKey = "...";
-// </hide>
+//_hide: const AlchemyProvider = ethers.providers.AlchemyProvider;
+//_hide: const apiKey = "...";
 
 // Connect to mainnet (homestead)
 provider = new AlchemyProvider();
@@ -182,6 +195,10 @@ 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();
+
 
 _subsection: CloudflareProvider @<CloudflareProvider> @inherit<[[UrlJsonRpcProvider]]> @src<providers:class.CloudflareProvider>
 
@@ -192,13 +209,106 @@ Create a new **CloudflareProvider** connected to mainnet (i.e. "homestead").
 
 _definition: **Supported Networks**
 
-- Homestead (Mainnet)
+- ``homestead`` - Homestead (Mainnet)
 
 _code: Cloudflare Examples @lang<javascript>
 
-// <hide>
-const CloudflareProvider = ethers.providers.CloudflareProvider;
-// </hide>
+//_hide: const CloudflareProvider = ethers.providers.CloudflareProvider;
 
 // Connect to mainnet (homestead)
 provider = new CloudflareProvider();
+
+
+_subsection: PocketProvider @<PocketProvider> @inherit<[[UrlJsonRpcProvider]]> @src<providers:class.PocketProvider>
+
+The **PocketProvider** is backed by [Pocket](link-pocket).
+
+_property: new ethers.providers.PocketProvider([ network = "homestead", [ apiKey ] ])
+Create a new **PocketProvider** connected to //network// with
+the optional //apiKey//.
+
+The //network// may be specified as a **string** for a common
+network name, a **number** for a common chain ID or a
+[Network Object](providers-Network).
+
+_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.
+
+It is highly recommended for production, you register with
+[Pocket](link-pocket) for your own API key.
+
+_definition: **Supported Networks**
+
+- ``homestead`` - Homestead (Mainnet)
+- ``ropsten`` - Ropsten (proof-of-work testnet)
+- ``rinkeby`` - Rinkeby (proof-of-authority testnet)
+- ``goerli`` - G&ouml;rli (clique testnet)
+
+_code: Pocket Examples @lang<javascript>
+
+//_hide: const PocketProvider = ethers.providers.PocketProvider;
+//_hide: const applicationId = "...";
+//_hide: const applicationSecretKey = "...";
+//_hide: const loadBalancer = true;
+
+// Connect to mainnet (homestead)
+provider = new PocketProvider();
+
+// Connect to the ropsten testnet
+// (see EtherscanProvider above for other network examples)
+provider = new PocketProvider("ropsten");
+
+// Connect to mainnet with an Application ID (these are equivalent)
+provider = new PocketProvider(null, applicationId);
+provider = new PocketProvider("homestead", applicationId);
+
+// Connect to mainnet with an application ID, application secret
+// and specify whether to use the load balances
+provider = new PocketProvider("homestead", {
+    applicationId: applicationId,
+    applicationSecretKey: applicationSecretKey,
+    loadBalancer: loadBalancer     // true or false
+});
+
+
+_subsection: AnkrProvider @<AnkrProvider> @inherit<[[UrlJsonRpcProvider]]> @src<providers:class.AnkrProvider>
+
+The **AnkrProvider** is backed by [Ankr](link-ankr).
+
+_property: new ethers.providers.AnkrProvider([ network = "homestead", [ apiKey ] ])
+Create a new **AnkrProvider** connected to //network// with
+the optional //apiKey//.
+
+The //network// may be specified as a **string** for a common
+network name, a **number** for a common chain ID or a
+[Network Object](providers-Network).
+
+_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.
+
+It is highly recommended for production, you register with
+[Ankr](link-ankr) for your own API key.
+
+_definition: **Supported Networks**
+
+- ``homestead`` - Homestead (Mainnet)
+- ``matic`` - Polygon
+- ``arbitrum`` - Arbitrum (L2; optimistic roll-up)
+
+_code: Ankr Examples @lang<javascript>
+
+//_hide: const AnkrProvider = ethers.providers.AnkrProvider;
+//_hide: const apiKey = "...";
+
+// Connect to mainnet (homestead)
+provider = new AnkrProvider();
+
+// Connect to polygont
+// (see EtherscanProvider above for other network examples)
+provider = new AnkrProvider("matic");
+
+// Connect to mainnet with an API Key (these are equivalent)
+provider = new AnkrProvider(null, apiKey);
+provider = new AnkrProvider("homestead", apiKey);

docs.wrm/api/providers/index.wrm

@@ -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>
@@ -20,7 +20,7 @@ for use in production.
 
 It creates a [[FallbackProvider]] 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
+multiple backends simultaneously. 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.
@@ -31,42 +31,95 @@ responses that match the majority.
 
 _property: ethers.getDefaultProvider([ network, [ options ] ]) => [[Provider]]
 Returns a new Provider, backed by multiple services, connected
-to //network//. Is no //network// is provided, **homestead**
+to //network//. If 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
 
 $Alchemy:     [[link-alchemy]] API Token
 $Etherscan:   [[link-etherscan]] API Token
-$Infura:      [[link-infura]] Project ID or ProjectID and Project Secret
+$Infura:      [[link-infura]] Project ID or ``{ projectId, projectSecret }``
+$Pocket:      [[link-pocket]] Application ID or ``{ applicationId, applicationSecretKey }``
 $Quorum:      The number of backends that must agree
               //(default: 2 for mainnet, 1 for testnets)//
-    
+
 |    **Property**    |  **Description**  |
 |    //alchemy//     | $Alchemy          |
 |   //etherscan//    | $Etherscan        |
 |    //infura//      | $Infura           |
+|    //pocket//      | $Pocket           |
 |    //quorum//      | $Quorum           |
 
 _note: Note: API Keys
 
-It is highly recommended for production services that to acquire
-and specify an API Key for each sercice.
+It is highly recommended for production services to acquire
+and specify an API Key for each service.
 
-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"``) or chain ID to use that
+network definition or may specify custom parameters.
+
+_property: ethers.providers.getNetwork(aNetworkish) => [[providers-Network]]
+
+Returns the full [[providers-Network]] for the given standard
+//aNetworkish// [[providers-Networkish]].
+
+This is useful for functions and classes which wish to accept [[providers-Networkish]]
+as an input parameter.
+
+_code: @lang<javascript>
+
+//_hide: const getNetwork = ethers.providers.getNetwork;
+
+// By Chain Name
+//_result:
+getNetwork("homestead");
+//_hide: delete _._defaultProvider;
+//_log:
+
+// By Chain ID
+//_result:
+getNetwork(1);
+//_hide: delete _._defaultProvider;
+//_log:
+
+_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",
+    chainId: 1337,
+    ensAddress: customEnsAddress
+};
+
 
 _subsection: Provider Documentation
 

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

@@ -1,22 +1,27 @@
-_section: JsonRpcProvider  @<JsonRpcProvider> @INHERIT<[[Provider]]> @SRC<providers:class.JsonRpcProvider>
+_section: JsonRpcProvider  @<JsonRpcProvider> @INHERIT<[[BaseProvider]]> @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]])
 
-_property: new ethers.providers.JsonRpcProvider([ url [ , aNetworkish ] ])  @SRC<providers:constructor.JsonRpcProvider>
-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.
+_property: new ethers.providers.JsonRpcProvider([ urlOrConnectionInfo [ , networkish ] ])  @SRC<providers:constructor.JsonRpcProvider>
+Connect to a JSON-RPC HTTP API using the URL or [[ConnectionInfo]] //urlOrConnectionInfo//
+connected to the //networkish// network.
+
+If //urlOrConnectionInfo// 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 using ``eth_chaindId`` and falling back on ``eth_networkId``.
 
 _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.connection => [[ConnectionInfo]]
+The fully formed [[ConnectionInfo]] the Provider is connected to.
+
 _property: jsonRpcProvider.getSigner([ addressOrIndex ]) => [[JsonRpcSigner]]  @<JsonRpcProvider-getSigner> @SRC<providers/json-rpc-provider>
 Returns a [[JsonRpcSigner]] which is managed by this Ethereum node, at
 //addressOrIndex//. If no //addressOrIndex// is provided, the first
@@ -24,7 +29,7 @@ account (account #0) is used.
 
 _property: jsonRpcProvider.getUncheckedSigner([ addressOrIndex ]) => [[UncheckedJsonRpcSigner]]  @<JsonRpcProvider-getUncheckedSigner> @SRC<providers/json-rpc-provider>
 
-_property: jsonRpcProvider.listAccounts() => Array<string>  @<JsonRpcProvider-listAccounts> @SRC<providers/json-rpc-provider>
+_property: jsonRpcProvider.listAccounts() => Promise<Array<string>>  @<JsonRpcProvider-listAccounts> @SRC<providers/json-rpc-provider>
 Returns a list of all account addresses managed by this provider.
 
 _property: jsonRpcProvider.send(method, params) => Promise<any>  @<JsonRpcProvider-send> @SRC<providers/json-rpc-provider>
@@ -42,12 +47,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 +65,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.
 
@@ -73,6 +78,25 @@ object, with most of the properties set to null, but allows access to the
 transaction hash quickly, if that is all that is required.
 
 
+_subsection: StaticJsonRpcProvider @<StaticJsonRpcProvider> @INHERIT<[[JsonRpcProvider]]> @SRC<providers:class.StaticJsonRpcProvider>
+
+An ethers Provider will execute frequent ``getNetwork`` calls to ensure
+the network calls and network being communicated with are consistent.
+
+In the case of a client like MetaMask, this is desired as the network
+may be changed by the user at any time, in such cases the cost of
+checking the chainId is local and therefore cheap.
+
+However, there are also many times where it is known the network cannot
+change, such as when connecting to an INFURA endpoint, in which case,
+the **StaticJsonRpcProvider** can be used which will indefinitely cache
+the chain ID, which can reduce network traffic and reduce round-trip
+queries for the chain ID.
+
+This [[Provider]] should **only** be used when it is known the network
+cannot change.
+
+
 _subsection: Node-Specific Methods @<JsonRpcProvider--other>
 
 Many methods are less common or specific to certain Ethereum Node implementations
@@ -85,7 +109,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

@@ -1,8 +1,6 @@
 _section: Other Providers
 
-Others...
-
-_subsection: FallbackProvider  @<FallbackProvider> @INHERIT<[[Provider]]> @SRC<providers/fallback-provider:class.FallbackProvider>
+_subsection: FallbackProvider  @<FallbackProvider> @INHERIT<[[BaseProvider]]> @SRC<providers/fallback-provider:class.FallbackProvider>
 
 The **FallbackProvider** is the most advanced [[Provider]] available in
 ethers.
@@ -11,7 +9,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 (lower-value 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.
 
@@ -40,9 +38,9 @@ _property: fallbackProviderConfig.provider => [[Provider]]
 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
-at random.
+The priority used for the provider. Lower-value priorities are favoured over
+higher-value priorities. If multiple providers share the same priority, they
+are chosen at random.
 
 _property: fallbackProviderConfig.stallTimeout => number
 The timeout (in ms) after which another [[Provider]] will be attempted. This
@@ -70,6 +68,18 @@ _property: ipcProvider.path => string
 The path this [[Provider]] is connected to.
 
 
+_subsection: JsonRpcBatchProvider  @<JsonRpcBatchProvider> @INHERIT<[[JsonRpcProvider]]> @SRC<providers:class.JsonRpcBatchProvider>
+
+The **JsonRpcBatchProvider** operated identically to any other Provider,
+except the calls are implicly batched during an event-loop and sent using
+the JSON-RPC batch protocol to the backend.
+
+This results in fewer connections and fewer requests, which may result
+in lower costs or faster responses, depending on your use case.
+
+Keep in mind some backends may not support batched requests.
+
+
 _subsection: UrlJsonRpcProvider @<UrlJsonRpcProvider> @INHERIT<[[JsonRpcProvider]]> @SRC<providers:class.UrlJsonRpcProvider>
 
 This class is intended to be sub-classed and not used directly. It
@@ -93,15 +103,15 @@ 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
+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.
 
-This may also be used to wrap a standard [EIP-1193 Provider](link-eip-1193].
+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
@@ -144,3 +154,20 @@ 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 resources, 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.providers.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

@@ -1,42 +1,61 @@
 _section: Provider @<Provider>
 
-Explain what a provider is...
+A **Provider** in ethers is a read-only abstraction to
+access the blockchain data.
 
+_note: Coming from Web3.js?
+If you are coming from Web3.js, this is one of the biggest
+differences you will encounter using ethers.
+
+The ethers library creates a strong division between the
+operation a **Provider** can perform and those of a [[Signer]],
+which Web3.js lumps together.
+
+This separation of concerns and a stricted subset of Provider
+operations allows for a larger variety of backends, a more
+consistent API and ensures other libraries to operate without
+being able to rely on any underlying assumption.
 
 _subsection: Accounts Methods  @<Provider--account-methods>
 
 _property: provider.getBalance(address [ , blockTag = latest ]) => Promise<[[BigNumber]]>  @<Provider-getBalance> @SRC<providers/base-provider>
 Returns the balance of //address// as of the //blockTag// block height.
 
+_code: @lang<javascript>
+
+//_result:
+await provider.getBalance("ricmoo.eth");
+//_log:
+
 _property: provider.getCode(address [ , blockTag = latest ]) => Promise<string<[[DataHexString]]>>  @<Provider-getCode> @SRC<providers/base-provider>
 Returns the contract code of //address// as of the //blockTag// block height. If there is
 no contract currently deployed, the result is ``0x``.
 
+_code: @lang<javascript>
+
+//_result:
+await provider.getCode("registrar.firefly.eth");
+//_log:
+
 _property: provider.getStorageAt(addr, pos [ , blockTag = latest ]) => Promise<string<[[DataHexString]]>>  @<Provider-getStorageAt> @SRC<providers/base-provider>
 Returns the ``Bytes32`` value of the position //pos// at address //addr//, as of the //blockTag//.
 
+_code: @lang<javascript>
+
+//_result:
+await provider.getStorageAt("registrar.firefly.eth", 0)
+//_log:
+
 _property: provider.getTransactionCount(address [ , blockTag = latest ]) => Promise<number>  @<Provider-getTransactionCount> @SRC<providers/base-provider>
 Returns the number of transactions //address// has ever **sent**, as of //blockTag//.
 This value is required to be the nonce for the next transaction from //address//
 sent to the network.
 
-_code: Account Examples @lang<javascript>
+_code: @lang<javascript>
 
-// Get the balance for an account...
-provider.getBalance("ricmoo.firefly.eth");
-//!
-
-// Get the code for a contract...
-provider.getCode("registrar.firefly.eth");
-//!
-
-// Get the storage value at position 0...
-provider.getStorageAt("registrar.firefly.eth", 0)
-//!
-
-// Get transaction count of an account...
-provider.getTransactionCount("ricmoo.firefly.eth");
-//!
+//_result:
+await provider.getTransactionCount("ricmoo.eth");
+//_log:
 
 
 _subsection: Blocks Methods  @<Provider--block-methods>
@@ -45,22 +64,26 @@ _property: provider.getBlock(block) => Promise<[[providers-Block]]>  @<Provider-
 Get the //block// from the network, where the ``result.transactions`` is a list
 of transaction hashes.
 
+_code: @lang<javascript>
+
+//_result:
+await provider.getBlock(100004)
+//_log:
+
 _property: provider.getBlockWithTransactions(block) => Promise<[[providers-BlockWithTransactions]]>  @<Provider-getBlockWithTransactions> @SRC<providers/base-provider>
 Get the //block// from the network, where the ``result.transactions`` is
 an Array of [[providers-TransactionResponse]] objects.
 
-_code: Block Examples @lang<javascript>
+_code: @lang<javascript>
 
-provider.getBlock(100004)
-//!
-
-provider.getBlockWithTransactions(100004)
-//!
+//_result:
+await provider.getBlockWithTransactions(100004)
+//_log:
 
 _subsection: Ethereum Naming Service (ENS) Methods @<Provider--ens-methods>
 
 The [Ethereum Naming Service](link-ens) (ENS) allows a short and
-easy-to-remember ENS Name to be atached to any set of keys
+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
@@ -73,26 +96,118 @@ reading and debugging much simpler.
 The provider offers some basic operations to help resolve and
 work with ENS names.
 
+_property: provider.getAvatar(name) => Promise<string>
+Returns the URL for the avatar associated to the ENS name, or null
+if no avatar was configured.
+
+_property: provider.getResolver(name) => Promise<[[EnsResolver]]>
+Returns an EnsResolver instance which can be used to further inquire
+about specific entries for an ENS name.
+
+_code: @lang<javascript>
+
+//_hide: provider = ethers.getDefaultProvider();
+
+// See below (Resolver) for examples of using this object
+const resolver = await provider.getResolver("ricmoo.eth");
+
+//_hide: _page.resolver = resolver;
+
 _property: provider.lookupAddress(address) => Promise<string>  @<Provider-lookupAddress> @SRC<providers/base-provider>
 Performs a reverse lookup of the //address// in ENS using the
 //Reverse Registrar//.  If the name does not exist, or the
 forward lookup does not match, ``null`` is returned.
 
+An ENS name requries additional configuration to setup a reverse
+record, they are not automatically set up.
+
+_code: @lang<javascript>
+
+//_result:
+await provider.lookupAddress("0x5555763613a12D8F3e73be831DFf8598089d3dCa");
+//_log:
+
 _property: provider.resolveName(name) => Promise<string<[Address](address)>>  @<Provider-ResolveName> @SRC<providers/base-provider>
 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.
 
-_code: ENS Examples @lang<javascript>
+_code: @lang<javascript>
 
-// Reverse lookup of an ENS by address...
-provider.lookupAddress("0x6fC21092DA55B392b045eD78F4732bff3C580e2c");
-//!
+//_result:
+await provider.resolveName("ricmoo.eth");
+//_log:
 
-// Lookup an address of an ENS name...
-provider.resolveName("ricmoo.firefly.eth");
-//!
 
+_subsection: EnsResolver @<EnsResolver> 
+
+_property: resolver.name => string
+The name of this resolver.
+
+_property: resolver.address => string<[[address]]>
+The address of the Resolver.
+
+_property: resolver.getAddress([ cointType = 60 ]) => Promise<string>
+Returns a Promise which resolves to the [[link-eip-2304]] multicoin address
+stored for the //coinType//. By default an Ethereum [[address]]
+(``coinType = 60``) will be returned.
+
+_code: @lang<javascript>
+
+//_hide: const resolver = _page.resolver;
+
+// By default, looks up the Ethereum address
+// (this will match provider.resolveName)
+//_result:
+await resolver.getAddress();
+//_log:
+
+// Specify the coinType for other coin addresses (0 = Bitcoin)
+//_result:
+await resolver.getAddress(0);
+//_log:
+
+_property: resolver.getAvatar() => Promise<AvatarInfo>
+Returns an object the provides the URL of the avatar and the
+linkage representing each stage in the avatar resolution.
+
+If there is no avatar found (or the owner of any NFT does not
+match the name owner), null is returned.
+
+The AvatarInfo has the properties:
+
+- ``info.linkage`` - An array of info on each step resolving the avatar
+- ``info.url`` - The URL of the avatar
+
+_property: resolver.getContentHash() => Promise<string>
+Returns a Promise which resolves to any stored [[link-eip-1577]] content hash.
+
+_code: @lang<javascript>
+
+//_hide: const resolver = _page.resolver;
+
+//_result:
+await resolver.getContentHash();
+//_log:
+
+_property: resolver.getText(key) => Promise<string>
+Returns a Promise which resolves to any stored [[link-eip-634]] text entry for //key//.
+
+_code: @lang<javascript>
+
+//_hide: const resolver = _page.resolver;
+
+//_result:
+await resolver.getText("email");
+//_log:
+
+//_result:
+await resolver.getText("url");
+//_log:
+
+//_result:
+await resolver.getText("com.twitter");
+//_log:
 
 _subsection: Logs Methods  @<Provider--log-methods>
 
@@ -109,36 +224,65 @@ _subsection: Network Status Methods  @<Provider--network-methods>
 _property: provider.getNetwork() => Promise<[[providers-Network]]>  @<Provider-getNetwork> @SRC<providers/base-provider:method.BaseProvider.getNetwork>
 Returns the [[providers-Network]] this Provider is connected to.
 
+_code: @lang<javascript>
+
+//_result:
+await provider.getNetwork()
+//_hide: _ = utils.shallowCopy(_);
+//_hide: delete _._defaultProvider;
+//_log:
+
 _property: provider.getBlockNumber() => Promise<number>  @<Provider-getBlockNumber> @SRC<providers/base-provider>
 Returns the block number (or height) of the most recently mined block.
 
+_code: @lang<javascript>
+
+//_result:
+await provider.getBlockNumber()
+//_log:
+
 _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>
+_code: @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)...
+// The gas price (in wei)...
 gasPrice = await provider.getGasPrice()
-//! async gasPrice
+//_log: gasPrice
 
 // ...often this gas price is easier to understand or
-// display to the user in gwei (giga-wei, or 1e9 wei)
+// display to the user in gwei
+//_result:
 utils.formatUnits(gasPrice, "gwei")
-//!
+//_log:
+
+_property: provider.getFeeData() => Promise<[[providers-FeeData]]>  @<Provider-getFeeData> @SRC<abstract-provider>
+Returns the current recommended [[providers-FeeData]] to use in a transaction.
+
+For an EIP-1559 transaction, the ``maxFeePerGas`` and ``maxPriorityFeePerGas``
+should be used.
+
+For legacy transactions and networks which do not support EIP-1559, the ``gasPrice``
+should be used.
+
+_code: @lang<javascript>
+
+// The gas price (in wei)...
+feeData = await provider.getFeeData()
+//_log: feeData
+
+// ...often these values are easier to understand or
+// display to the user in gwei
+//_result:
+utils.formatUnits(feeData.maxFeePerGas, "gwei")
+//_log:
+
+_property: provider.ready => Promise<[[providers-Network]]> @<Provider-ready> @src<providers/base-provider>
+Returns a Promise which will stall until the network has heen established,
+ignoring errors due to the target node not being active yet.
+
+This can be used for testing or attaching scripts to wait until the node is
+up and running smoothly.
 
 
 _subsection: Transactions Methods  @<Provider--transaction-methods>
@@ -146,7 +290,19 @@ _subsection: Transactions Methods  @<Provider--transaction-methods>
 _property: provider.call(transaction [ , blockTag = latest ]) => Promise<string<[[DataHexString]]>>  @<Provider-call> @SRC<providers/base-provider>
 Returns the result of executing the //transaction//, using //call//. A call
 does not require any ether, but cannot change any state. This is useful
-for calling gettings on Contracts.
+for calling getters on Contracts.
+
+_code: @lang<javascript>
+
+//_result:
+await provider.call({
+  // ENS public resovler address
+  to: "0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41",
+
+  // `function addr(namehash("ricmoo.eth")) view returns (address)`
+  data: "0x3b3b57debf074faa138b72c65adbdcfb329847e4f2c04bde7f7dd7fcad5a52d2f395a558"
+});
+//_log:
 
 _property: provider.estimateGas(transaction) => Promise<[[BigNumber]]>  @<Provider-estimateGas> @SRC<providers/base-provider>
 Returns an estimate of the amount of gas that would be required to submit //transaction//
@@ -156,44 +312,116 @@ An estimate may not be accurate since there could be another transaction
 on the network that was not accounted for, but after being mined affected
 relevant state.
 
+_code: @lang<javascript>
+
+//_hide: const parseEther = ethers.utils.parseEther;
+
+//_result:
+await provider.estimateGas({
+  // Wrapped ETH address
+  to: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+
+  // `function deposit() payable`
+  data: "0xd0e30db0",
+
+  // 1 ether
+  value: parseEther("1.0")
+});
+//_log:
+
+_property: provider.getTransaction(hash) => Promise<[[providers-TransactionResponse]]> @<Provider-getTransaction> @src<providers/base-provider>
+Returns the transaction with //hash// or null if the transaction is unknown.
+
+If a transaction has not been mined, this method will search the transaction
+pool. Various backends may have more restrictive transaction pool access (e.g.
+if the gas price is too low or the transaction was only recently sent and not
+yet indexed) in which case this method may also return null.
+
+_code: @lang<javascript>
+
+//_result:
+await provider.getTransaction("0x5b73e239c55d790e3c9c3bbb84092652db01bb8dbf49ccc9e4a318470419d9a0");
+//_log:
+
+_property: provider.getTransactionReceipt(hash) => Promise<[[providers-TransactionReceipt]]> @<Provider-getTransactionReceipt> @src<providers/base-provider>
+Returns the transaction receipt for //hash// or null if the transaction
+has not been mined.
+
+To stall until the transaction has been mined, consider the ``waitForTransaction``
+method below.
+
+_code: @lang<javascript>
+
+//_result:
+await provider.getTransactionReceipt("0x5b73e239c55d790e3c9c3bbb84092652db01bb8dbf49ccc9e4a318470419d9a0");
+//_log:
+
 _property: provider.sendTransaction(transaction) => Promise<[[providers-TransactionResponse]]>  @<Provider-sendTransaction> @SRC<providers/base-provider>
 Submits //transaction// to the network to be mined. The //transaction// **must** be signed,
 and be valid (i.e. the nonce is correct and the account has sufficient balance to pay
 for the transaction).
 
+_code: @lang<javascript>
+
+//_hide: const provider = localProvider;
+//_hide: const wallet = new ethers.Wallet(ethers.utils.id("HelloWorld"), provider);
+//_hide: const fundTx = await localSigner.sendTransaction({
+//_hide:   to: wallet.address,
+//_hide:   value: ethers.utils.parseEther("2.0")
+//_hide: });
+//_hide: await fundTx.wait();
+//_hide: const tx = await localSigner.populateTransaction({ to: "ricmoo.eth", value: ethers.utils.parseEther("3.14159") });
+//_hide: const signedTx = await localSigner.signTransaction(tx);
+
+//_verbatim: `const signedTx = ${ JSON.stringify(signedTx) };`
+//_result:
+await provider.sendTransaction(signedTx);
+//_log:
+
 _property: provider.waitForTransaction(hash [ , confirms = 1 [ , timeout ] ]) => Promise<[TxReceipt](providers-TransactionReceipt)>  @<Provider-waitForTransaction> @SRC<providers/base-provider>
 Returns a Promise which will not resolve until //transactionHash// is mined.
 
+If //confirms// is 0, this method is non-blocking and if the
+transaction has not been mined returns null. Otherwise,
+this method will block until the transaction has //confirms//
+blocks mined on top of the block in which is was mined.
 
 _subsection: Event Emitter Methods @<Provider--event-methods>
 
-Explain events here...
+The EventEmitter API allows applications to use an
+[[link-wiki-observer-pattern]] to register callbacks for when
+various events occur.
+
+This closely follows the Event Emitter provided by other JavaScript
+libraries with the exception that event names support some more
+[complex objects](Provider--events), not only strings. The objects
+are normalized internally.
 
 _property: provider.on(eventName, listener) => this  @<Provider-on> @SRC<providers/base-provider>
-Add a //listener// to be triggered for each //eventName//.
+Add a //listener// to be triggered for each //eventName// [event](Provider--events).
 
 _property: provider.once(eventName, listener) => this  @<Provider-once> @SRC<providers/base-provider>
-Add a //listener// to be triggered for only the next //eventName//,
-at which time it be removed.
+Add a //listener// to be triggered for only the next
+//eventName// [event](Provider--events), at which time it will be removed.
 
 _property: provider.emit(eventName, ...args) => boolean  @<Provider-emit> @SRC<providers/base-provider>
-Notify all listeners of //eventName//, passing //args// to each listener. This
-is generally only used internally.
+Notify all listeners of the //eventName// [event](Provider--events),
+passing //args// to each listener. This is generally only used internally.
 
 _property: provider.off(eventName [ , listener ]) => this  @<Provider-off> @SRC<providers/base-provider>
-Remove a //listener// for //eventName//. If no //listener// is provided,
-all listeners for //eventName// are removed.
+Remove a //listener// for the //eventName// [event](Provider--events).
+If no //listener// is provided, all listeners for //eventName// are removed.
 
 _property: provider.removeAllListeners([ eventName ]) => this  @<Provider-removeAllListeners> @SRC<providers/base-provider>
-Remove all the listeners for //eventName//. If no //eventName// is provided,
-**all** events are removed.
+Remove all the listeners for the //eventName// [events](Provider--events).
+If no //eventName// is provided, **all** events are removed.
 
 _property: provider.listenerCount([ eventName ]) => number  @<Provider-listenerCount> @SRC<providers/base-provider>
-Returns the number of listeners for //eventName//. If no //eventName// is
-provided, the total number of listeners is returned.
+Returns the number of listeners for the //eventName// [events](Provider--events).
+If no //eventName// is provided, the total number of listeners is returned.
 
 _property: provider.listeners(eventName) => Array<Listener>  @<Provider-listeners> @SRC<providers/base-provider>
-Returns the list of Listeners for //eventName//.
+Returns the list of Listeners for the //eventName// [events](Provider--events).
 
 
 _heading: Events  @<Provider--events>
@@ -207,7 +435,7 @@ properties ``address`` (the source contract) and ``topics`` (a topic-set to matc
 
 If ``address`` is unspecified, the filter matches any contract address.
 
-See events for more information on how to specify topic-sets.
+See [EventFilters](providers-EventFilter) for more information on filtering events.
 
 _definition: **Topic-Set Filter**
 
@@ -216,6 +444,8 @@ The value of a **Topic-Set Filter** is a array of Topic-Sets.
 This event is identical to a //Log Filter// with the address omitted (i.e. from
 any contract).
 
+See [EventFilters](providers-EventFilter) for more information on filtering events.
+
 _definition: **Transaction Filter**
 
 The value of a **Transaction Filter** is any transaction hash.
@@ -260,11 +490,10 @@ $Debug:    each Provider may use this to emit useful debugging information
 
 _code: Events Example @lang<javascript>
 
-// <hide>
-const txHash = utils.id("dummy-data");
-const myAddress = ethers.constants.HashZero;
-const myOtherAddress = ethers.constants.HashZero;
-// </hide>
+//_hide: const txHash = utils.id("dummy-data");
+//_hide: const myAddress = ethers.constants.HashZero;
+//_hide: const myOtherAddress = ethers.constants.HashZero;
+//_hide: const hexZeroPad = ethers.utils.hexZeroPad;
 
 provider.on("block", (blockNumber) => {
     // Emitted on every block change
@@ -282,7 +511,7 @@ provider.once(txHash, (transaction) => {
 filter = {
     address: "dai.tokens.ethers.eth",
     topics: [
-        utils.id("Transfer(address,address,uint256")
+        utils.id("Transfer(address,address,uint256)")
     ]
 }
 provider.on(filter, (log, event) => {
@@ -293,11 +522,11 @@ 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)
 topicSets = [
-    utils.id("Transfer(address,address,uint256"),
+    utils.id("Transfer(address,address,uint256)"),
     null,
     [
-        myAddress,
-        myOtherAddress
+        hexZeroPad(myAddress, 32),
+        hexZeroPad(myOtherAddress, 32)
     ]
 ]
 provider.on(topicSets, (log, event) => {
@@ -314,13 +543,24 @@ provider.on("error", (tx) => {
     // Emitted when any error occurs
 });
 
-// <hide>
-// Make sure our documentation builds without waiting forever
-provider.removeAllListeners()
-// </hide>
+//_hide: provider.removeAllListeners() /* Make sure the docs build without waiting forever */
 
 _subsection: Inspection Methods  @<Provider--inspection-methods>
 
 _property: Provider.isProvider(object) => boolean  @<Provider-isProvider> @SRC<abstract-provider>
 Returns true if and only if //object// is a Provider.
 
+
+_subsection: BaseProvider @<BaseProvider> @INHERIT<[[Provider]]> @SRC<providers:class.BaseProvider>
+
+Most Providers available in ethers are sub-classes of BaseProvider, which
+simplifies sub-classes, as it handles much of the event operations, such as
+polling and formatting.
+
+_property: provider.polling => boolean
+Indicates if the Provider is currently polling. If there are no events to
+poll for or polling has been explicitly disabled, this will be false.
+
+_property: provider.pollingInterval => number
+The frequency at which the provider polls.
+

docs.wrm/api/providers/types.wrm

@@ -1,26 +1,27 @@
 _section: Types
 
 _subsection: BlockTag @<providers-BlockTag>
-A **BlockTag** specifies a specific location in the Blockchain.
+A **BlockTag** specifies a specific block location in the Blockchain.
 
-- **``"latest"``** -- The most recently mined block
-- **``"earliest"``** -- Block #0
-- **``"pending"``** -- The block currently being prepared for mining; not all
+- **``"latest"``** - The most recently mined block
+- **``"earliest"``** - Block #0
+- **``"pending"``** - The block currently being prepared for mining; not all
   operations and backends support this BlockTag
-- **//number//** -- The block at this height
-- **//a negative number//** -- The block this many blocks ago
+- **//number//** - The block at this height
+- **//a negative number//** - The block this many blocks ago
+- **//hex string//** - The block at this height (as a hexidecimal value)
 
-_heading: EventType @<providers-EventType>
-
-And **EventType** can be any of the following.
-
-- **//string//** -- TODO...
-- **//Array<string<[[DataHexString]]<32>> | Array<string<[[DataHexString]]<32>>>>//** -- TODO...
-- **//[[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
@@ -33,6 +34,23 @@ _property: network.ensAddress => string<[[address]]>
 The address at which the ENS registry is deployed on this network.
 
 
+_subsection: FeeData @<providers-FeeData>
+
+A **FeeData** object encapsulates the necessary fee data required
+to send a transaction, based on the best available recommendations.
+
+_property: feeData.gasPrice => [[BigNumber]]
+The gasPrice to use for legacy transactions or networks which do not
+support EIP-1559.
+
+_property: feeData.maxFeePerGas => [[BigNumber]]
+The ``maxFeePerGas`` to use for a transaction. This is based on the
+most recent block's ``baseFee``.
+
+_property: feeData.maxPriorityFeePerGas => [[BigNumber]]
+The ``maxPriorityFeePerGas`` to use for a transaction. This accounts
+for the uncle risk and for the majority of current MEV risk.
+
 _subsection: Block @<providers-Block>
 
 _property: block.hash => string<[[DataHexString]]<32>>
@@ -50,19 +68,19 @@ The timestamp of this block.
 _property: block.nonce => string<[[DataHexString]]>
 The nonce used as part of the proof-of-work to mine this block.
 
-This property is generally of little interest developers.
+This property is generally of little interest to developers.
 
 _property: block.difficulty => number
 The difficulty target required to be met by the miner of the block.
 
-This property is generally of little interest developers.
+This property is generally of little interest to developers.
 
 _property: block.gasLimit => [[BigNumber]]
 The maximum amount of gas that this block was permitted to use. This
 is a value that can be voted up or voted down by miners and is used
 to automatically adjust the bandwidth requirements of the network.
 
-This property is generally of little interest developers.
+This property is generally of little interest to developers.
 
 _property: block.gasUsed => [[BigNumber]]
 The total amount of gas used by all transactions in this block.
@@ -74,7 +92,7 @@ miner that mined this block would like the subsidy reward to go to.
 _property: block.extraData => string
 This is extra data a miner may choose to include when mining a block.
 
-This property is generally of little interest developers.
+This property is generally of little interest to developers.
 
 _heading: Block (with transaction hashes)
 
@@ -102,10 +120,15 @@ _heading: EventFilter @<providers-EventFilter>
 _property: filter.address => string<[[address]]>
 The address to filter by, or ``null`` to match any address.
 
-_property: filter.topics => Array<string<[[DataHexString]]<32>> | Array<string<[[DataHexString]]<32>>>>
-The topics to filter by, or ``null`` to match any topics. Each entry represents an
-**AND** condition that must match, or may be ``null`` to match anything. If a given
-entry is an Array, then that entry is treated as an **OR** for any value in the entry.
+_property: filter.topics => Array<string<[Data](DataHexString)<32>> | Array<string<[Data](DataHexString)<32>>>>
+The topics to filter by or ``null`` to match any topics.
+
+Each entry represents an **AND** condition that must match, or may
+be ``null`` to match anything. If a given entry is an Array, then
+that entry is treated as an **OR** for any value in the entry.
+
+See [Filters](events--filters) for more details and examples
+on specifying complex filters.
 
 _heading: Filter @<providers-Filter> @INHERIT<[[providers-EventFilter]]>
 
@@ -177,18 +200,47 @@ _property: transactionRequest.nonce => number | Promise<number>
 The nonce for this transaction. This should be set to the number of
 transactions ever sent **from** this address.
 
-_property: transactionRequest.gasLimit => [[BigNumber]] | Promise<[[BigNumber]]>
-The maximum amount of gas this transaction is permitted to use.
-
-_property: transactionRequest.gasPrice => [[BigNumber]] | Promise<[[BigNumber]]>
-The price (in wei) per unit of gas this transaction will pay.
-
 _property: transactionRequest.data => [[DataHexString]] | Promise<[[DataHexString]]>
 The transaction data.
 
 _property: transactionRequest.value => [[BigNumber]] | Promise<[[BigNumber]]>
 The amount (in wei) this transaction is sending.
 
+_property: transactionRequest.gasLimit => [[BigNumber]] | Promise<[[BigNumber]]>
+The maximum amount of gas this transaction is permitted to use.
+
+If left unspecified, ethers will use ``estimateGas`` to determine the value
+to use. For transactions with unpredicatable gas estimates, this may be required
+to specify explicitly.
+
+_property: transactionRequest.gasPrice => [[BigNumber]] | Promise<[[BigNumber]]>
+The price (in wei) per unit of gas this transaction will pay.
+
+This may not be specified for transactions with ``type`` set to ``1`` or ``2``, or
+if ``maxFeePerGas`` or ``maxPriorityFeePerGas`` is given.
+
+_property: transactionRequest.maxFeePerGas => [[BigNumber]] | Promise<[[BigNumber]]>
+The maximum price (in wei) per unit of gas this transaction will pay for the
+combined [[link-eip-1559]] block's base fee and this transaction's priority fee.
+
+Most developers should leave this unspecified and use the default value that
+ethers determines from the network.
+
+This may not be specified for transactions with ``type`` set to ``0`` or if ``gasPrice``
+is specified..
+
+_property: transactionRequest.maxPriorityFeePerGas => [[BigNumber]] | Promise<[[BigNumber]]>
+The price (in wei) per unit of gas this transaction will allow in addition to
+the [[link-eip-1559]] block's base fee to bribe miners into giving this transaction
+priority. This is **included in** the ``maxFeePerGas``, so this will **not affect**
+the total maximum cost set with ``maxFeePerGas``.
+
+Most developers should leave this unspecified and use the default value that
+ethers determines from the network.
+
+This may not be specified for transactions with ``type`` set to ``0`` or if ``gasPrice``
+is specified.
+
 _property: transactionRequest.chainId => number | Promise<number>
 The chain ID this transaction is authorized on, as specified by
 [EIP-155](link-eip-155).
@@ -196,7 +248,19 @@ The chain ID this transaction is authorized on, as specified by
 If the chain ID is 0 will disable EIP-155 and the transaction will be valid
 on any network. This can be **dangerous** and care should be taken, since it
 allows transactions to be replayed on networks that were possibly not
-intended.
+intended. Intentionally-replayable transactions are also disabled by default
+on recent versions of Geth and require configuration to enable.
+
+_property: transactionRequest.type => null | number
+
+The [[link-eip-2718]] type of this transaction envelope, or ``null``
+for to use the network default. To force using a lagacy transaction
+without an envelope, use type ``0``.
+
+_property: transactionRequest.accessList => [[providers-AccessListish]]
+
+The [[providers-AccessList]] to include; only available for [[link-eip-2930]]
+and [[link-eip-1559]] transactions.
 
 _heading: TransactionResponse @<providers-TransactionResponse> @INHERIT<[[Transaction]]>
 
@@ -220,16 +284,50 @@ The number of blocks that have been mined (including the initial block) since th
 transaction was mined.
 
 _property: transaction.raw => string<[[DataHexString]]>
-The serialized transaction.
+The serialized transaction. This may be null as some backends do not
+rpopulate it. If this is required, it can be computed from a **TransactionResponse**
+object using [this cookbook recipe](cookbook--compute-raw-transaction).
 
-_property: transaction.wait([ confirmations = 1 ]) => Promise<[[providers-TransactionReceipt]]>
-Wait for //confirmations//. If 0, and the transaction has not been mined,
-``null`` is returned.
+_property: transaction.wait([ confirms = 1 ]) => Promise<[[providers-TransactionReceipt]]>
+Resolves to the [[providers-TransactionReceipt]] once the transaction
+has been included in the chain for //confirms// blocks. If //confirms//
+is 0, and the transaction has not been mined, ``null`` is returned.
+
+If the transaction execution failed (i.e. the receipt status is ``0``),
+a [CALL_EXCEPTION](errors--call-exception) error will be rejected with
+the following properties:
+
+- ``error.transaction`` - the original transaction
+- ``error.transactionHash`` - the hash of the transaction
+- ``error.receipt`` - the actual receipt, with the status of ``0``
+
+If the transaction is replaced by another transaction, a
+[TRANSACTION_REPLACED](errors--transaction-replaced) error will be rejected
+with the following properties:
+
+- ``error.hash`` - the hash of the original transaction which was replaced
+- ``error.reason`` - a string reason; one of ``"repriced"``, ``"cancelled"`` or ``"replaced"``
+- ``error.cancelled`` - a boolean; a ``"repriced"`` transaction is not considered cancelled, but ``"cancelled"`` and ``"replaced"`` are
+- ``error.replacement`` - the replacement transaction (a [[providers-TransactionResponse]])
+- ``error.receipt`` - the receipt of the replacement transaction (a [[providers-TransactionReceipt]])
+
+Transactions are replaced when the user uses an option in their client to
+send a new transaction from the same account with the original ``nonce``.
+This is usually to speed up a transaction or to cancel one, by bribing
+miners with additional fees to prefer the new transaction over the original one.
+
+_property: transactionRequest.type => number
+The [[link-eip-2718]] type of this transaction. If the transaction
+is a legacy transaction without an envelope, it will have the type ``0``.
+
+_property: transactionRequest.accessList => [[providers-AccessList]]
+The [[providers-AccessList]] included, or null for transaction types which
+do not support access lists.
 
 _heading: TransactionReceipt @<providers-TransactionReceipt>
 
 _property: receipt.to => string<[[address]]>
-The address this transaction is to. This is ``null`` if the the
+The address this transaction is to. This is ``null`` if the
 transaction was an **init transaction**, used to deploy a contract.
 
 _property: receipt.from => string<[[address]]>
@@ -248,6 +346,10 @@ _property: receipt.transactionIndex => number
 The index of this transaction in the list of transactions included in
 the block this transaction was mined in.
 
+_property: receipt.type => number
+The [[link-eip-2718]] type of this transaction. If the transaction
+is a legacy transaction without an envelope, it will have the type ``0``.
+
 _property: receipt.root => string
 The intermediate state root of a receipt.
 
@@ -262,9 +364,19 @@ must be considered.
 _property: receipt.gasUsed => [[BigNumber]]
 The amount of gas actually used by this transaction.
 
+_property: receipt.effectiveGasPrice => [[BigNumber]]
+The effective gas price the transaction was charged at.
+
+Prior to EIP-1559 or on chains that do not support it, this value will
+simply be equal to the transaction ``gasPrice``.
+
+On EIP-1559 chains, this is equal to the block ``baseFee`` for the block
+that the transaction was included in, plus the transaction
+``maxPriorityFeePerGas`` clamped to the transaction ``maxFeePerGas``.
+
 _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>>
@@ -286,7 +398,7 @@ including the actual block it was mined in.
 
 _property: receipt.cumulativeGasUsed => [[BigNumber]]
 For the block this transaction was included in, this is the sum of the
-gas used used by each transaction in the ordered list of transactions
+gas used by each transaction in the ordered list of transactions
 up to (and including) this transaction.
 
 This is generally of little interest to developers.
@@ -299,3 +411,102 @@ _property: receipt.status => boolean
 The status of a transaction is 1 is successful or 0 if it was
 reverted. Only transactions included in blocks [post-Byzantium Hard Fork](link-eip-609)
 have this property.
+
+_subsection: Access Lists
+
+An Access List is optional an includes a list of addresses and storage
+slots for that address which should be //warmed// or pre-fetched for
+use within the execution of this transaction. A //warmed// value has an
+additional upfront cost to access, but is discounted throughout the code
+execution for reading and writing.
+
+_heading: AccessListish @<providers-AccessListish>
+
+A looser description of an [[providers-AccessList]], which will be
+converted internally using [accessListify](utils-accessListify).
+
+
+It may be any of:
+
+- any [[providers-AccessList]]
+- an Array of 2-element Arrays, where the first element is the address
+  and second array is an array of storage keys
+- an object, whose keys represent the addresses and each value is an
+  array of storage keys
+
+When using the object form (the last option), the addresses and storage
+slots will be sorted. If an explicit order for the access list is
+required, one of the other forms must be used. Most developers
+**do not** require explicit order.
+
+_code: equivalent to the AccessList example below @lang<javascript>
+
+// Option 1:
+// AccessList
+// see below
+
+// Option 2:
+// Array< [ Address, Array<Bytes32> ] >
+//_hide: ;
+accessList = [
+  [
+    "0x0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
+    [
+      "0x0000000000000000000000000000000000000000000000000000000000000004",
+      "0x0bcad17ecf260d6506c6b97768bdc2acfb6694445d27ffd3f9c1cfbee4a9bd6d"
+    ]
+  ],
+  [
+    "0x5FfC014343cd971B7eb70732021E26C35B744cc4",
+    [
+        "0x0000000000000000000000000000000000000000000000000000000000000001"
+    ]
+  ]
+];
+
+// Option 3:
+// Record<Address, Array<Bytes32>>
+accessList = {
+  "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e": [
+    "0x0000000000000000000000000000000000000000000000000000000000000004",
+    "0x0bcad17ecf260d6506c6b97768bdc2acfb6694445d27ffd3f9c1cfbee4a9bd6d"
+  ],
+  "0x5FfC014343cd971B7eb70732021E26C35B744cc4": [
+    "0x0000000000000000000000000000000000000000000000000000000000000001"
+  ]
+};
+
+
+_heading: AccessList @<providers-AccessList>
+
+An [[link-eip-2930]] transaction allows an optional **AccessList**
+which causes a transaction to //warm// (i.e. pre-cache) another
+addresses state and the specified storage keys.
+
+This incurs an increased intrinsic cost for the transaction, but provides
+discounts for storage and state access throughout the execution of the
+transaction.
+
+_code: example access list
+
+// Array of objects with the form:
+// {
+//   address: Address,
+//   storageKey: Array< DataHexString< 32 > >
+// }
+
+accessList = [
+  {
+    address: "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
+    storageKeys: [
+        "0x0000000000000000000000000000000000000000000000000000000000000004",
+        "0x0bcad17ecf260d6506c6b97768bdc2acfb6694445d27ffd3f9c1cfbee4a9bd6d"
+    ]
+  },
+  {
+    address: "0x5FfC014343cd971B7eb70732021E26C35B744cc4",
+    storageKeys: [
+        "0x0000000000000000000000000000000000000000000000000000000000000001"
+    ]
+  }
+];

docs.wrm/api/signer.wrm

@@ -6,7 +6,7 @@ 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.
+The available operations depend 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).
@@ -20,9 +20,9 @@ The most common Signers you will encounter are:
 
 _subsection: Signer @<Signer> @SRC<abstract-signer:class.Signer>
 
-The **Signer** class is abstract and cannot be directly instaniated.
+The **Signer** class is abstract and cannot be directly instantiated.
 
-Instead use one of the concreate sub-classes, such as the [[Wallet]],
+Instead use one of the concrete sub-classes, such as the [[Wallet]],
 [[VoidSigner]] or [[JsonRpcSigner]].
 
 _property: signer.connect(provider) => [[Signer]]  @<Signer-connect>
@@ -39,7 +39,7 @@ asynchronous source, such as  hardware wallets.
 Sub-classes **must** implement this.
 
 _property: Signer.isSigner(object) => boolean  @<Signer-isSigner> @SRC<abstract-signer>
-Returns true if an only if //object// is a **Signer**.
+Returns true if and only if //object// is a **Signer**.
 
 _heading: Blockchain Methods @<Signer--blockchain-methods>
 
@@ -47,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.
@@ -74,6 +74,12 @@ _property: signer.signMessage(message) => Promise<string<[RawSignature](signatur
 This returns a Promise which resolves to the [[signature-raw]]
 of //message//.
 
+A signed message is prefixd with ``"\\x19Ethereum Signed Message:\\n"`` and
+the length of the message, using the [hashMessage](utils-hashMessage)
+method, so that it is [EIP-191](link-eip-191) compliant. If recovering
+the address in Solidity, this prefix will be required to create a matching
+hash.
+
 Sub-classes **must** implement this, however they may throw if signing a
 message is not supported, such as in a Contract-based Wallet or
 Meta-Transaction-based Wallet.
@@ -112,6 +118,61 @@ 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]].
 
+_property: signer._signTypedData(domain, types, value) => Promise<string<[RawSignature](signature-raw)>>  @<Signer-signTypedData>
+
+Signs the typed data //value// with //types// data structure for //domain// using
+the [[link-eip-712]] specification.
+
+_warning: Experimental feature (this method name will change)
+
+This is still an experimental feature. If using it, please specify the **exact**
+version of ethers you are using (e.g. spcify ``"5.0.18"``, **not** ``"^5.0.18"``) as
+the method name will be renamed from ``_signTypedData`` to ``signTypedData`` once
+it has been used in the field a bit.
+
+_code: Typed Data Example @lang<javascript>
+
+//_hide: signer = new Wallet("0x1234567890123456789012345678901234567890123456789012345678901234");
+
+// All properties on a domain are optional
+const domain = {
+    name: 'Ether Mail',
+    version: '1',
+    chainId: 1,
+    verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC'
+};
+
+// The named list of all type definitions
+const types = {
+    Person: [
+        { name: 'name', type: 'string' },
+        { name: 'wallet', type: 'address' }
+    ],
+    Mail: [
+        { name: 'from', type: 'Person' },
+        { name: 'to', type: 'Person' },
+        { name: 'contents', type: 'string' }
+    ]
+};
+
+// The data to sign
+const value = {
+    from: {
+        name: 'Cow',
+        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826'
+    },
+    to: {
+        name: 'Bob',
+        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB'
+    },
+    contents: 'Hello, Bob!'
+};
+
+//_result:
+signature = await signer._signTypedData(domain, types, value);
+//_log:
+
+
 _heading: Sub-Classes @<Signer--subclassing>
 
 It is very important that all important properties of a **Signer** are
@@ -121,23 +182,23 @@ 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** extend Sigenr and **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
+This is generally not required to be overridden, but may be needed to provide
 custom behaviour in sub-classes.
 
 This should return a **copy** of the //transactionRequest//, with any properties
 needed by ``call``, ``estimateGas`` and ``populateTransaction`` (which is used
 by sendTransaction). It should also throw an error if any unknown key is specified.
 
-The default implementation checks only valid [[providers-TransactionRequest]] properties
+The default implementation checks only if valid [[providers-TransactionRequest]] properties
 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
+This is generally not required to be overridden, but may be needed to provide
 custom behaviour in sub-classes.
 
 This should return a **copy** of //transactionRequest//, follow the same procedure
@@ -167,7 +228,7 @@ 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.
+Create an instance by decrypting 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
@@ -193,11 +254,11 @@ _property: wallet.address => string<[[address]]>
 The address for the account this Wallet represents.
 
 _property: wallet.provider => [[Provider]]
-The provider this wallet is connected to, which will ge used for any [[Signer--blockchain-methods]]
+The provider this wallet is connected to, which will be used for any [[Signer--blockchain-methods]]
 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.
 
@@ -224,35 +285,43 @@ walletMnemonic = Wallet.fromMnemonic(mnemonic)
 // ...or from a private key
 walletPrivateKey = new Wallet(walletMnemonic.privateKey)
 
+//_result:
 walletMnemonic.address === walletPrivateKey.address
-//!
+//_log:
 
 // The address as a Promise per the Signer API
-walletMnemonic.getAddress()
-//!
+//_result:
+await walletMnemonic.getAddress()
+//_log:
 
 // A Wallet address is also available synchronously
+//_result:
 walletMnemonic.address
-//!
+//_log:
 
 // The internal cryptographic components
+//_result:
 walletMnemonic.privateKey
-//!
+//_log:
+//_result:
 walletMnemonic.publicKey
-//!
+//_log:
 
 // The wallet mnemonic
+//_result:
 walletMnemonic.mnemonic
-//!
+//_log:
 
 // Note: A wallet created with a private key does not
 //       have a mnemonic (the derivation prevents it)
+//_result:
 walletPrivateKey.mnemonic
-//!
+//_log:
 
 // Signing a message
-walletMnemonic.signMessage("Hello World")
-//!
+//_result:
+await walletMnemonic.signMessage("Hello World")
+//_log:
 
 tx = {
   to: "0x8ba1f109551bD432803012645Ac136ddd64DBA72",
@@ -260,24 +329,29 @@ tx = {
 }
 
 // Signing a transaction
-walletMnemonic.signTransaction(tx)
-//!
+//_result:
+await walletMnemonic.signTransaction(tx)
+//_log:
 
 // The connect method returns a new instance of the
 // Wallet connected to a provider
+//_result:
 wallet = walletMnemonic.connect(provider)
+//_null:
 
 // Querying the network
-wallet.getBalance();
-//!
-wallet.getTransactionCount();
-//!
+//_result:
+await wallet.getBalance();
+//_log:
+//_result:
+await wallet.getTransactionCount();
+//_log:
 
 // Sending ether
-wallet.sendTransaction(tx)
-// <hide>
-//! error
-// </hide>
+//_hide: wallet = localSigner; /* prevent insufficient funds error from blowing up the docs */
+//_result:
+await wallet.sendTransaction(tx)
+//_log:
 
 
 
@@ -310,12 +384,10 @@ abi = [
 ]
 contract = new ethers.Contract("dai.tokens.ethers.eth", abi, signer)
 
-// <hide>
-//!
-// </hide>
 // Get the number of tokens for this account
+//_result:
 tokens = await contract.balanceOf(signer.getAddress())
-//! async tokens
+//_log:
 
 //
 // Pre-flight (check for revert) on DAI from the signer
@@ -327,12 +399,14 @@ tokens = await contract.balanceOf(signer.getAddress())
 //
 
 // This will pass since the token balance is available
-contract.callStatic.transfer("donations.ethers.eth", tokens)
-//!
+//_result:
+await contract.callStatic.transfer("donations.ethers.eth", tokens)
+//_log:
 
 // This will fail since it is greater than the token balance
-contract.callStatic.transfer("donations.ethers.eth", tokens.add(1))
-//! error
+//_throws:
+await contract.callStatic.transfer("donations.ethers.eth", tokens.add(1))
+//_log:
 
 
 _subsection: ExternallyOwnedAccount  @<ExternallyOwnedAccount>
@@ -352,5 +426,5 @@ The privateKey of this EOA
 _property: eoa.mnemonic => [[Mnemonic]]
 
 //Optional//. The account HD mnemonic, if it has one and can be
-determined. Some sources do not encode the mnemonic, such as an
+determined. Some sources do not encode the mnemonic, such as
 HD extended keys.

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

@@ -12,7 +12,7 @@ _subsection: Creating Instance @<AbiCoder--creating>
 
 For the most part, there should never be a need to manually create
 an instance of an [[AbiCoder]], since one is created with the
-default coersion function when the library is loaded which can
+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
@@ -39,10 +39,81 @@ _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
+Encode the array //values// according to the array of //types//, each of which may be a
 string or a [[ParamType]].
 
+_code: @lang<javascript>
+
+//_hide: const abiCoder = utils.defaultAbiCoder;
+
+// Encoding simple types
+//_result:
+abiCoder.encode([ "uint", "string" ], [ 1234, "Hello World" ]);
+//_log:
+//_hide: _page.example1 = _;
+
+// Encoding with arrays types
+//_result:
+abiCoder.encode([ "uint[]", "string" ], [ [ 1234, 5678 ] , "Hello World" ]);
+//_log:
+//_hide: _page.example2 = _;
+
+// Encoding complex structs (using positional properties)
+//_result:
+abiCoder.encode(
+  [ "uint", "tuple(uint256, string)" ],
+  [
+    1234,
+    [ 5678, "Hello World" ]
+  ]
+);
+//_log:
+//_hide: _page.example3 = _;
+
+// Encoding complex structs (using keyword properties)
+//_result:
+abiCoder.encode(
+  [ "uint a", "tuple(uint256 b, string c) d" ],
+  [
+    1234,
+    { b: 5678, c: "Hello World" }
+  ]
+);
+//_log:
+
 _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]].
+
+_code: @lang<javascript>
+
+//_hide: const abiCoder = utils.defaultAbiCoder;
+
+// Decoding simple types
+//_hide: data = _page.example1;
+//_verbatim: `data = ${ JSON.stringify(data) };`
+//_result:
+abiCoder.decode([ "uint", "string" ], data);
+//_log:
+
+// Decoding with arrays types
+//_hide: data = _page.example2;
+//_verbatim: `data = ${ JSON.stringify(data) };`
+//_result:
+abiCoder.decode([ "uint[]", "string" ], data);
+//_log:
+
+// Decoding complex structs; unnamed parameters allows ONLY
+// positional access to values
+//_hide: data = _page.example3;
+//_verbatim: `data = ${ JSON.stringify(data) };`
+//_result:
+abiCoder.decode([ "uint", "tuple(uint256, string)" ], data);
+//_log:
+
+// Decoding complex structs; named parameters allows positional
+// or keyword access to values
+//_result:
+abiCoder.decode([ "uint a", "tuple(uint256 b, string c) d" ], data);
+//_log:

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

@@ -1,11 +1,289 @@
 _section: ABI Formats @<abi-formats>
 
-@TODO: Expand this section
+There are several formats available to specify an ABI for
+a Smart Contract, which specifies to the under-lying library
+what methods, events and errors exist so that encoding and
+decoding the data from and to the network can be handled by
+the library.
+
+The supports ABI types are:
+
+- [Human-Readable ABI](abi-formats--human-readable-abi)
+- [Solidity JSON ABI](abi-formats--solidity)
+- [Solidity Object ABI](abi-formats--object)
 
 _subsection: Human-Readable ABI @<abi-formats--human-readable-abi>
 
-See [Human-Readable Abi](link-ricmoo-humanreadableabi).
+The **Human-Readable ABI** was [introduced early by ethers](link-ricmoo-humanreadableabi),
+which allows for a Solidity signatures to be used to describe each
+method, event and error.
+
+It is important to note that a Solidity signature **fully describes**
+all the properties the ABI requires:
+
+- name
+- type (constructor, event, function)
+- inputs (types, nested structures and optionally names)
+- outputs (types nested structures and optionally names)
+- state mutability (for constructors and methods)
+- payability (for constructors and methods)
+- whether inputs are indexed (for events)
+
+This allows for a simple format which is both machine-readable (since
+the parser is a machine) and human-readable (at least **developer-readable**),
+as well as simple for humans to type and inline into code, which improves
+code readability. The Human-Readable ABI is also considerably smaller, which
+helps reduce code size.
+
+A Human-Readable ABI is simple an array of strings, where each string is
+the Solidity signature.
+
+Signatures may be minimally specified (i.e. names of inputs and outputs
+may be omitted) or fully specified (i.e. with all property names) and
+whitespace is ignored.
+
+Several modifiers available in Solidity are dropped internally, as they
+are not required for the ABI and used old by Solidity's semantic checking
+system, such as input parameter data location like ``"calldata"``
+and ``"memory"``. As such, they can be safely dropped in the ABI as well.
+
+_code: Human-Readable ABI Example @lang<javascript>
+
+const humanReadableAbi = [
+
+  // Simple types
+  "constructor(string symbol, string name)",
+  "function transferFrom(address from, address to, uint value)",
+  "function balanceOf(address owner) view returns (uint balance)",
+  "event Transfer(address indexed from, address indexed to, address value)",
+  "error InsufficientBalance(account owner, uint balance)",
+
+  // Some examples with the struct type, we use the tuple keyword:
+  // (note: the tuple keyword is optional, simply using additional
+  //        parentheses accomplishes the same thing)
+  // struct Person {
+  //   string name;
+  //   uint16 age;
+  // }
+  "function addPerson(tuple(string name, uint16 age) person)",
+  "function addPeople(tuple(string name, uint16 age)[] person)",
+  "function getPerson(uint id) view returns (tuple(string name, uint16 age))",
+
+  "event PersonAdded(uint indexed id, tuple(string name, uint16 age) person)"
+];
+
+//_hide: _page.humanReadableAbi = humanReadableAbi;
+
 
 _subsection: Solidity JSON ABI @<abi-formats--solidity>
 
-See [Solidity compiler](link-solc-output).
+The **Solidity JSON ABI** is a standard format that many tools export,
+including the Solidity compiler. For the full specification, see
+the [Solidity compiler documentation](link-solc-output).
+
+Various versions include slightly different keys and values. For example,
+early compilers included only a boolean ``"constant"`` to indicate mutability,
+while newer versions include a string ``"mutabilityState"``, which encompasses
+several older properties.
+
+When creating an instance of a [Fragment](Fragment) using a JSON ABI, it will
+automatically infer all legacy properties for new-age ABIs and for legacy
+ABIs will infer the new-age properties. All properties will be populated, so
+it will match the equivalent created using a Human-Readable ABI fragment.
+
+_code: The same ABI as JSON ABI @lang<javascript>
+
+const jsonAbi = `[
+  {
+    "type": "constructor",
+    "payable": false,
+    "inputs": [
+      { "type": "string", "name": "symbol" },
+      { "type": "string", "name": "name" }
+    ]
+  },
+  {
+    "type": "function",
+    "name": "transferFrom",
+    "constant": false,
+    "payable": false,
+    "inputs": [
+      { "type": "address", "name": "from" },
+      { "type": "address", "name": "to" },
+      { "type": "uint256", "name": "value" }
+    ],
+    "outputs": [ ]
+  },
+  {
+    "type": "function",
+    "name": "balanceOf",
+    "constant":true,
+    "stateMutability": "view",
+    "payable":false, "inputs": [
+      { "type": "address", "name": "owner"}
+    ],
+    "outputs": [
+      { "type": "uint256"}
+    ]
+  },
+  {
+    "type": "event",
+    "anonymous": false,
+    "name": "Transfer",
+    "inputs": [
+      { "type": "address", "name": "from", "indexed":true},
+      { "type": "address", "name": "to", "indexed":true},
+      { "type": "address", "name": "value"}
+    ]
+  },
+  {
+    "type": "error",
+    "name": "InsufficientBalance",
+    "inputs": [
+      { "type": "account", "name": "owner"},
+      { "type": "uint256", "name": "balance"}
+    ]
+  },
+  {
+    "type": "function",
+    "name": "addPerson",
+    "constant": false,
+    "payable": false,
+    "inputs": [
+      {
+        "type": "tuple",
+        "name": "person",
+        "components": [
+          { "type": "string", "name": "name" },
+          { "type": "uint16", "name": "age" }
+        ]
+      }
+    ],
+    "outputs": []
+  },
+  {
+    "type": "function",
+    "name": "addPeople",
+    "constant": false,
+    "payable": false,
+    "inputs": [
+      {
+        "type": "tuple[]",
+        "name": "person",
+        "components": [
+          { "type": "string", "name": "name" },
+          { "type": "uint16", "name": "age" }
+        ]
+      }
+    ],
+    "outputs": []
+  },
+  {
+    "type": "function",
+    "name": "getPerson",
+    "constant": true,
+    "stateMutability": "view",
+    "payable": false,
+    "inputs": [
+      { "type": "uint256", "name": "id" }
+    ],
+    "outputs": [
+      {
+        "type": "tuple",
+        "components": [
+          { "type": "string", "name": "name" },
+          { "type": "uint16", "name": "age" }
+        ]
+      }
+    ]
+  },
+  {
+    "type": "event",
+    "anonymous": false,
+    "name": "PersonAdded",
+    "inputs": [
+      { "type": "uint256", "name": "id", "indexed": true },
+      {
+        "type": "tuple",
+        "name": "person",
+        "components": [
+          { "type": "string", "name": "name", "indexed": false },
+          { "type": "uint16", "name": "age", "indexed": false }
+        ]
+      }
+    ]
+  }
+]`;
+
+//_hide: _page.jsonAbi = jsonAbi;
+
+_subsection: Solidity Object ABI @<abi-formats--object>
+
+The output from parsing (using JSON.parse) a Solidity JSON ABI
+is also fully compatible with the [[Interface]] class and each
+method, event and error from that object are compatible with
+the [[Fragment]] class.
+
+Some developers may prefer this as it allows access to the ABI
+properties as normal JavaScript objects, and closely matches the
+JSON ABI that those familiar with the Solidity ABI will recognize.
+
+_subsection: Converting Between Formats
+
+The [[Fragment]] object makes it simple to reformat a single
+method, event or error, however most developers will be interested
+in converting an entire ABI.
+
+For production code it is recommended to inline the Human-Readable
+ABI as it makes it easy to see at a glance which methods, events
+and errors are available. It is also highly recommend to strip out
+unused parts of the ABI (such as admin methods) to further reduce
+code size.
+
+_code: Converting to Full Human-Readable ABI @lang<javascript>
+
+//_hide: const Interface = ethers.utils.Interface;
+//_hide: const FormatTypes = ethers.utils.FormatTypes;
+//_hide: jsonAbi = _page.jsonAbi;
+
+// Using the "full" format will ensure the Result objects
+// have named properties, which improves code readability
+const iface = new Interface(jsonAbi);
+//_result:
+iface.format(FormatTypes.full);
+//_log:
+
+_code: Converting to Minimal Human-Readable ABI @lang<javascript>
+
+//_hide: const Interface = ethers.utils.Interface;
+//_hide: const FormatTypes = ethers.utils.FormatTypes;
+//_hide: jsonAbi = _page.jsonAbi;
+
+// Using the "minimal" format will save a small amount of
+// space, but is generally not worth it as named properties
+// on Results will not be available
+const iface = new Interface(jsonAbi);
+//_result:
+iface.format(FormatTypes.minimal);
+//_log:
+
+_code: Converting to JSON ABI @lang<javascript>
+
+//_hide: const Interface = ethers.utils.Interface;
+//_hide: const FormatTypes = ethers.utils.FormatTypes;
+//_hide: humanReadableAbi = _page.humanReadableAbi;
+
+// Sometimes you may need to export a Human-Readable ABI to
+// JSON for tools that do not have Human-Readable support
+
+// For compactness, the JSON is kept with minimal white-space
+const iface = new Interface(humanReadableAbi);
+//_result:
+jsonAbi = iface.format(FormatTypes.json);
+//_log:
+
+// However it is easy to use JSON.parse and JSON.stringify
+// with formatting parameters to assist with readability
+//_result:
+JSON.stringify(JSON.parse(jsonAbi), null, 2);
+//_log:

docs.wrm/api/utils/abi/fragments.wrm

@@ -5,60 +5,83 @@ Explain an ABI.
 _subsection: Formats
 
 _heading: JSON String ABI (Solidity Output JSON)
-
 The **JSON ABI Format** is the format that is
 [output from the Solidity compiler](link-solc-output).
 
 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
+_heading: Humanb-Readable ABI @<human-readable-abi>
+The Human-Readable ABI was introduced by ethers in [this article](link-ricmoo-humanreadableabi)
+and has since gained wider adoption.
 
-The Human-Readable ABI was 
+The ABI is described by using an array of strings, where each string is the
+Solidity signature of the **constructor**, **function**, **event** or **error**.
 
-[article](link-ricmoo-humanreadableabi)
+When parsing a fragment, all inferred properties will be injected (e.g. a //payable//
+method will have its ``constant`` proeprty set to false).
+
+Tuples can be specified by using the ``tuple(...)`` syntax or with bare (additional)
+parenthesis, ``(...)``.
+
+_code: Example Human-Readable ABI
+
+const ABI = [
+  // Constructor
+  "constructor(address ens)",
+
+  // Constant functions (pure or view)
+  "function balanceOf(address owner) view returns (uint)",
+
+  // State-mutating functions (payable or non-payable)
+  "function mint(uint amount) payable",
+  "function transfer(address to, uint amount) returns (bool)",
+
+  // Events
+  "event Transfer(address indexed from, address indexed to, uint amount)",
+
+  // Errors
+  "error InsufficientFunds(address from, uint balance)",
+]
 
 
 _heading: Output Formats @<fragments--output-formats> @SRC<abi/fragments:FormatTypes>
-
 Each [[Fragment]] and [[ParamType]] may be output using its ``format``
 method.
 
-_property: ethers.utils.FragmentTypes.full => string
-
+_property: ethers.utils.FormatTypes.full => string
 This is a full human-readable string, including all parameter names, any
 optional modifiers (e.g. ``indexed``, ``public``, etc) and white-space
-to aid in human readabiliy.
-
-_property: ethers.utils.FragmentTypes.minimal => string
+to aid in human readability.
 
+_property: ethers.utils.FormatTypes.minimal => string
 This is similar to ``full``, except with no unnecessary whitespace or parameter
 names. This is useful for storing a minimal string which can still fully
 reconstruct the original Fragment using [Fragment&thinsp;.&thinsp;from](Fragment-from).
 
-_property: ethers.utils.FragmentTypes.json => string
-
+_property: ethers.utils.FormatTypes.json => string
 This returns a JavaScript Object which is safe to call ``JSON.stringify``
 on to create a JSON string.
 
-_property: ethers.utils.FragmentTypes.sighash => string
-
+_property: ethers.utils.FormatTypes.sighash => string
 This is a minimal output format, which is used by Solidity when computing a
 signature hash or an event topic hash.
 
 _warning: Note
-
 The ``sighash`` format is **insufficient** to re-create the original [[Fragment]],
 since it discards modifiers such as indexed, anonymous, stateMutability, etc.
 
+It is only useful for computing the selector for a Fragment, and cannot
+be used to format an Interface.
+
 
 _subsection: Fragment @<Fragment> @SRC<abi/fragments:class.Fragment>
-
 An ABI is a collection of **Fragments**, where each fragment specifies:
 
+- An [Error](ErrorFragment)
 - An [Event](EventFragment)
 - A [Function](FunctionFragment)
 - A [Constructor](ConstructorFragment)
@@ -66,12 +89,10 @@ An ABI is a collection of **Fragments**, where each fragment specifies:
 _heading: Properties
 
 _property: fragment.name => string
-
 This is the name of the Event or Function. This will be null for
 a [[ConstructorFragment]].
 
 _property: fragment.type => string
-
 This is a string which indicates the type of the [[Fragment]]. This
 will be one of:
 
@@ -80,19 +101,20 @@ will be one of:
 - ``function``
 
 _property: fragment.inputs => Array<[[ParamType]]>
-
-This is an array of of each [[ParamType]] for the input parameters to
+This is an array of each [[ParamType]] for the input parameters to
 the Constructor, Event of Function.
 
 _heading: Methods
 
-_property: ethers.utils.Fragment.from(objectOrString) => [[Fragment]] @<Fragment-from> @SRC<abi/fragments:Fragment.from>
+_property: fragment.format([ format = sighash]) => string @<Fragment-format> @SRC<abi/fragments:Fragment.format>
+Creates a string representation of the Fragment using the available
+[output formats](fragments--output-formats).
 
-Returns a 
+_property: ethers.utils.Fragment.from(objectOrString) => [[Fragment]] @<Fragment-from> @SRC<abi/fragments:Fragment.from>
+Creates a new **Fragment** sub-class from any compatible //objectOrString//.
 
 _property: ethers.utils.Fragment.isFragment(object) => boolean @<Fragment-isFragment> @SRC<abi/fragments:Fragment.isFragment>
-
-Tra lal al
+Returns true if //object// is a **Fragment**.
 
 
 _subsection: ConstructorFragment @<ConstructorFragment> @INHERIT<[[Fragment]]> @SRC<abi/fragments:class.ConstructorFragment>
@@ -100,17 +122,14 @@ _subsection: ConstructorFragment @<ConstructorFragment> @INHERIT<[[Fragment]]> @
 _heading: Properties
 
 _property: fragment.gas => [[BigNumber]]
-
 This is the gas limit that should be used during deployment. It may be
 null.
 
 _property: fragment.payable => boolean
-
 This is whether the constructor may receive ether during deployment as
 an endowment (i.e. msg.value != 0).
 
 _property: fragment.stateMutability => string
-
 This is the state mutability of the constructor. It can be any of:
 
 - ``nonpayable``
@@ -119,12 +138,21 @@ This is the state mutability of the constructor. It can be any of:
 _heading: Methods
 
 _property: ethers.utils.ConstructorFragment.from(objectOrString) => [[ConstructorFragment]] @<ConstructorFragment-from> @SRC<abi/fragments:ConstructorFragment.from>
-
-Tra la la...
+Creates a new **ConstructorFragment** from any compatible //objectOrString//.
 
 _property: ethers.utils.ConstructorFragment.isConstructorFragment(object) => boolean @<ConstructorFragment-isConstructorFragment> @SRC<abi/fragments:ConstructorFragment.isConstructorFragment>
+Returns true if //object// is a **ConstructorFragment**.
 
-Tra lal al
+
+_subsection: ErrorFragment @<ErrorFragment> @INHERIT<[[Fragment]]> @SRC<abi/fragments:class.ErrorFragment>
+
+_heading: Methods
+
+_property: ethers.utils.ErrorFragment.from(objectOrString) => [[ErrorFragment]] @<ErrorFragment-from> @SRC<abi/fragments:ErrorFragment.from>
+Creates a new **ErrorFragment** from any compatible //objectOrString//.
+
+_property: ethers.utils.ErrorFragment.isErrorFragment(object) => boolean @<ErrorFragment-isErrorFragment> @SRC<abi/fragments:ErrorFragment.isErrorFragment>
+Returns true if //object// is an **ErrorFragment**.
 
 
 _subsection: EventFragment @<EventFragment> @INHERIT<[[Fragment]]> @SRC<abi/fragments:class.EventFragment>
@@ -132,19 +160,16 @@ _subsection: EventFragment @<EventFragment> @INHERIT<[[Fragment]]> @SRC<abi/frag
 _heading: Properties
 
 _property: fragment.anonymous => boolean
-
 This is whether the event is anonymous. An anonymous Event does not inject its
 topic hash as topic0 when creating a log.
 
 _heading: Methods
 
 _property: ethers.utils.EventFragment.from(objectOrString) => [[EventFragment]] @<EventFragment-from> @SRC<abi/fragments:EventFragment.from>
-
-Tra la la...
+Creates a new **EventFragment** from any compatible //objectOrString//.
 
 _property: ethers.utils.EventFragment.isEventFragment(object) => boolean @<EventFragment-isEventFragment> @SRC<abi/fragments:EventFragment.isEventFragment>
-
-Tra lal al
+Returns true if //object// is an **EventFragment**.
 
 
 _subsection: FunctionFragment @<FunctionFragment> @INHERIT<[[ConstructorFragment]]> @SRC<abi/fragments:class.FunctionFragment>
@@ -152,12 +177,10 @@ _subsection: FunctionFragment @<FunctionFragment> @INHERIT<[[ConstructorFragment
 _heading: Properties
 
 _property: fragment.constant => boolean
-
 This is whether the function is constant (i.e. does not change state). This
 is true if the state mutability is ``pure`` or ``view``.
 
 _property: fragment.stateMutability => string
-
 This is the state mutability of the constructor. It can be any of:
 
 - ``nonpayable``
@@ -166,22 +189,18 @@ This is the state mutability of the constructor. It can be any of:
 - ``view``
 
 _property: fragment.outputs => Array<[[ParamType]]>
-
 A list of the Function output parameters.
 
-_heading: Method
+_heading: Methods
 
 _property: ethers.utils.FunctionFragment.from(objectOrString) => [[FunctionFragment]] @<FunctionFragment-from> @SRC<abi/fragments:ConstructorFragment.from>
-
-Tra la la...
+Creates a new **FunctionFragment** from any compatible //objectOrString//.
 
 _property: ethers.utils.FunctionFragment.isFunctionFragment(object) => boolean @<FunctionFragment-isFunctionFragment> @SRC<abi/fragments:FunctionFragment.isFunctionFragment>
-
-Tra lal al
+Returns true if //object// is a **FunctionFragment**.
 
 
 _subsection: ParamType @<ParamType> @SRC<abi/fragments:class.ParamType>
-
 The following examples will represent the Solidity parameter:
 
 ``string foobar``
@@ -189,53 +208,42 @@ The following examples will represent the Solidity parameter:
 _heading: Properties
 
 _property: paramType.name => string @<ParamType-name>
-
 The local parameter name. This may be null for unnamed parameters. For example,
 the parameter definition ``string foobar`` would be ``foobar``.
 
 _property: paramType.type => string @<ParamType-type>
-
 The full type of the parameter, including tuple and array symbols. This may be null
 for unnamed parameters. For the above example, this would be ``foobar``.
 
 _property: paramType.baseType => string @<ParamType-baseType>
-
 The base type of the parameter. For primitive types (e.g. ``address``, ``uint256``, etc)
 this is equal to [type](ParamType-type). For arrays, it will be the string ``array`` and for
 a tuple, it will be the string ``tuple``.
 
 _property: paramType.indexed => boolean @<ParamType-indexed>
-
 Whether the parameter has been marked as indexed. This **only** applies
 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.
+The type of children of the array. This is null for any parameter
+which is not an array.
 
 _property: paramType.arrayLength => number @<ParamType-arrayLength>
-
 The length of the array, or ``-1`` for dynamic-length arrays. This is
-null for parameters which is not arrays.
+null for parameters which are not arrays.
 
 _property: paramType.components => Array<[[ParamType]]> @<ParamType-components>
-
 The components of a tuple. This is null for non-tuple parameters.
 
 
 _heading: Methods
 
-Tra la la...
-
 _property: paramType.format([ outputType = sighash ])
-
-Tra la la...
+Creates a string representation of the Fragment using the available
+[output formats](fragments--output-formats).
 
 _property: ethers.utils.ParamType.from(objectOrString) => [[ParamType]] @<ParamType-from> @SRC<abi/fragments:ParamType.from>
-
-Tra la la...
+Creates a new **ParamType** from any compatible //objectOrString//.
 
 _property: ethers.utils.ParamType.isParamType(object) => boolean @<ParamType-isParamType> @SRC<abi/fragments:ParamType.isParamType>
-
-Tra la la...
+Returns true if //object// is a **ParamType**.

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
@@ -26,11 +26,47 @@ 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.
 
+_code: Creating an Interface instance @lang<javascript>
+
+//_hide: const Interface = ethers.utils.Interface;
+
+// This interface is used for the below examples
+
+const iface = new Interface([
+  // Constructor
+  "constructor(string symbol, string name)",
+
+  // State mutating method
+  "function transferFrom(address from, address to, uint amount)",
+
+  // State mutating method, which is payable
+  "function mint(uint amount) payable",
+
+  // Constant method (i.e. "view" or "pure")
+  "function balanceOf(address owner) view returns (uint)",
+
+  // An Event
+  "event Transfer(address indexed from, address indexed to, uint256 amount)",
+
+  // A Custom Solidity Error
+  "error AccountLocked(address owner, uint256 balance)",
+
+  // Examples with structured types
+  "function addUser(tuple(string name, address addr) user) returns (uint id)",
+  "function addUsers(tuple(string name, address addr)[] user) returns (uint[] id)",
+  "function getUser(uint id) view returns (tuple(string name, address addr) user)"
+]);
+
+//_hide: _page.iface = iface;
+
 _subsection: Properties @<Interface--properties>
 
 _property: interface.fragments => Array<[[Fragment]]>
 All the [Fragments](Fragment) in the interface.
 
+_property: interface.errors => Array<[[ErrorFragment]]>
+All the [Error Fragments](ErrorFragment) in the interface.
+
 _property: interface.events => Array<[[EventFragment]]>
 All the [Event Fragments](EventFragment) in the interface.
 
@@ -48,24 +84,133 @@ Return the formatted **Interface**. If the format type is ``json`` a
 single string is returned, otherwise an Array of the human-readable
 strings is returned.
 
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+
+const FormatTypes = ethers.utils.FormatTypes;
+
+//_result:
+iface.format(FormatTypes.json)
+//_log:
+
+//_result:
+iface.format(FormatTypes.full)
+//_log:
+
+//_result:
+iface.format(FormatTypes.minimal)
+//_log:
 
 _subsection: Fragment Access @<Interface--fragments>
 
 _property: interface.getFunction(fragment) => [[FunctionFragment]]  @SRC<abi/interface>
 Returns the [[FunctionFragment]] for //fragment// (see [[Interface--specifying-fragments]]).
 
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+
+// By method signature, which is normalized so whitespace
+// and superfluous attributes are ignored
+iface.getFunction("transferFrom(address, address, uint256)");
+
+// By name; this ONLY works if the method is non-ambiguous
+iface.getFunction("transferFrom");
+
+// By method selector
+iface.getFunction("0x23b872dd");
+
+// Throws if the method does not exist
+//_throws:
+iface.getFunction("doesNotExist()");
+//_log:
+
+_property: interface.getError(fragment) => [[ErrorFragment]] @SRC<abi/interface>
+Returns the [[ErrorFragment]] for //fragment// (see [[Interface--specifying-fragments]]).
+
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+
+// By error signature, which is normalized so whitespace
+// and superfluous attributes are ignored
+iface.getError("AccountLocked(address, uint256)");
+
+// By name; this ONLY works if the error is non-ambiguous
+iface.getError("AccountLocked");
+
+// By error selector
+iface.getError("0xf7c3865a");
+
+// Throws if the error does not exist
+//_throws:
+iface.getError("DoesNotExist()");
+//_log:
+
 _property: interface.getEvent(fragment) => [[EventFragment]] @SRC<abi/interface>
 Returns the [[EventFragment]] for //fragment// (see [[Interface--specifying-fragments]]).
 
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+
+// By event signature, which is normalized so whitespace
+// and superfluous attributes are ignored
+iface.getEvent("Transfer(address, address, uint256)");
+
+// By name; this ONLY works if the event is non-ambiguous
+iface.getEvent("Transfer");
+
+// By event topic hash
+iface.getEvent("0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef");
+
+// Throws if the event does not exist
+//_throws:
+iface.getEvent("DoesNotExist()");
+//_log:
 
 _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]]).
 
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+
+//_result:
+iface.getSighash("balanceOf");
+//_log:
+
+//_result:
+iface.getSighash("balanceOf(address)");
+//_log:
+
+const fragment = iface.getFunction("balanceOf")
+//_result:
+iface.getSighash(fragment);
+//_log:
+
 _property: interface.getEventTopic(fragment) => string<[[DataHexString]]<32>> @SRC<abi/interface:method.Interface.getEventTopic>
 Return the topic hash for //fragment// (see [[Interface--specifying-fragments]]).
 
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+
+//_result:
+iface.getEventTopic("Transfer");
+//_log:
+
+//_result:
+iface.getEventTopic("Transfer(address, address, uint)");
+//_log:
+
+const fragment = iface.getEvent("Transfer")
+//_result:
+iface.getEventTopic(fragment);
+//_log:
 
 _subsection: Encoding Data @<Interface--encoding>
 
@@ -74,25 +219,145 @@ Return the encoded deployment data, which can be concatenated to the
 deployment bytecode of a contract to pass //values// into the contract
 constructor.
 
-_property: interface.encodeFilterTopics(fragment [ , values ]) => Array<topic | Array<topic>> @SRC<abi/interface>
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+//_hide: const parseEther = ethers.utils.parseEther;
+
+// The data that should be appended to the bytecode to pass
+// parameters to the constructor during deployment
+//_result:
+iface.encodeDeploy([ "SYM", "Some Name" ])
+//_log:
+
+_property: interface.encodeErrorResult(fragment [ , values ]) => string<[[DataHexString]]> @SRC<abi/interface>
+Returns the encoded error result, which would normally be the response from
+a reverted call for //fragment// (see [[Interface--specifying-fragments]]) for
+the given //values//.
+
+Most developers will not need this method, but may be useful for authors of
+a mock blockchain.
+
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+//_hide: const parseEther = ethers.utils.parseEther;
+
+// Encoding result data (like is returned by eth_call during a revert)
+//_result:
+iface.encodeErrorResult("AccountLocked", [
+  "0x8ba1f109551bD432803012645Ac136ddd64DBA72",
+  parseEther("1.0")
+]);
+//_log:
+
+_property: interface.encodeFilterTopics(fragment, values) => Array<topic | Array<topic>> @SRC<abi/interface>
 Returns the encoded topic filter, which can be passed to getLogs for //fragment//
 (see [[Interface--specifying-fragments]]) for the given //values//.
 
 Each //topic// is a 32 byte (64 nibble) [[DataHexString]].
 
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+//_hide: const parseEther = ethers.utils.parseEther;
+
+// Filter that matches all Transfer events
+//_result:
+iface.encodeFilterTopics("Transfer", [])
+//_log:
+
+// Filter that matches the sender
+//_result:
+iface.encodeFilterTopics("Transfer", [
+  "0x8ba1f109551bD432803012645Ac136ddd64DBA72"
+])
+//_log:
+
+// Filter that matches the receiver
+//_result:
+iface.encodeFilterTopics("Transfer", [
+  null,
+  "0x8ba1f109551bD432803012645Ac136ddd64DBA72"
+])
+//_log:
+
 _property: interface.encodeFunctionData(fragment [ , values ]) => string<[[DataHexString]]> @SRC<abi/interface>
 Returns the encoded data, which can be used as the data for a transaction for
 //fragment// (see [[Interface--specifying-fragments]]) for the given //values//.
 
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+//_hide: const parseEther = ethers.utils.parseEther;
+
+// Encoding data for the tx.data of a call or transaction
+//_result:
+iface.encodeFunctionData("transferFrom", [
+  "0x8ba1f109551bD432803012645Ac136ddd64DBA72",
+  "0xaB7C8803962c0f2F5BBBe3FA8bf41cd82AA1923C",
+  parseEther("1.0")
+])
+//_log:
+
+// Encoding structured data (using positional Array)
+user = [
+   "Richard Moore",
+   "0x8ba1f109551bD432803012645Ac136ddd64DBA72"
+];
+//_result:
+iface.encodeFunctionData("addUser", [ user ]);
+//_log:
+
+// Encoding structured data, using objects. Only available
+// if paramters are named.
+user = {
+   name: "Richard Moore",
+   addr: "0x8ba1f109551bD432803012645Ac136ddd64DBA72"
+};
+//_result:
+iface.encodeFunctionData("addUser", [ user ]);
+//_log:
+
 _property: interface.encodeFunctionResult(fragment [ , values ]) => string<[[DataHexString]]> @SRC<abi/interface>
 Returns the encoded result, which would normally be the response from a call for
 //fragment// (see [[Interface--specifying-fragments]]) for the given //values//.
 
 Most developers will not need this method, but may be useful for authors of a mock blockchain.
 
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+//_hide: const parseEther = ethers.utils.parseEther;
+
+// Encoding result data (like is returned by eth_call)
+//_result:
+iface.encodeFunctionResult("balanceOf", [
+  "0x8ba1f109551bD432803012645Ac136ddd64DBA72"
+])
+//_log:
+
 
 _subsection: Decoding Data @<Interface--decoding>
 
+_property: interface.decodeErrorResult(fragment, data) => [[Result]] @SRC<abi/interface>
+Returns the decoded values from the result of a call during a revert for
+//fragment// (see [[Interface--specifying-fragments]]) for the given //data//.
+
+Most developers won't need this, as the ``decodeFunctionResult`` will automatically
+decode errors if the //data// represents a revert.
+
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+
+// Decoding result data (e.g. from an eth_call)
+errorData = "0xf7c3865a0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba720000000000000000000000000000000000000000000000000de0b6b3a7640000";
+
+//_result:
+iface.decodeErrorResult("AccountLocked", errorData)
+//_log:
+
 _property: interface.decodeEventLog(fragment, data [ , topics ]) => [[Result]] @SRC<abi/interface>
 Returns the decoded event values from an event log for
 //fragment// (see [[Interface--specifying-fragments]]) for the given //data//
@@ -100,6 +365,26 @@ with the optional //topics//.
 
 If //topics// is not specified, placeholders will be inserted into the result.
 
+Most develoeprs will find the [parsing methods](Interface--parsing) more
+convenient for decoding event data, as they will automatically detect the
+matching event.
+
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+
+// Decoding log data and topics (the entries in a receipt)
+const data = "0x0000000000000000000000000000000000000000000000000de0b6b3a7640000";
+const topics = [
+  "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
+  "0x0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72",
+  "0x000000000000000000000000ab7c8803962c0f2f5bbbe3fa8bf41cd82aa1923c"
+];
+
+//_result:
+iface.decodeEventLog("Transfer", data, topics);
+//_log:
+
 _property: interface.decodeFunctionData(fragment, data) => [[Result]] @SRC<abi/interface>
 Returns the decoded values from transaction data for
 //fragment// (see [[Interface--specifying-fragments]]) for the given //data//.
@@ -107,25 +392,119 @@ Returns the decoded values from transaction data for
 Most developers will not need this method, but may be useful for debugging
 or inspecting transactions.
 
+Most develoeprs will also find the [parsing methods](Interface--parsing) more
+convenient for decoding transation data, as they will automatically detect the
+matching function.
+
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+
+// Decoding function data (the value of tx.data)
+const txData = "0x23b872dd0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72000000000000000000000000ab7c8803962c0f2f5bbbe3fa8bf41cd82aa1923c0000000000000000000000000000000000000000000000000de0b6b3a7640000";
+//_result:
+iface.decodeFunctionData("transferFrom", txData);
+//_log:
+
 _property: interface.decodeFunctionResult(fragment, data) => [[Result]] @SRC<abi/interface>
 Returns the decoded values from the result of a call for
 //fragment// (see [[Interface--specifying-fragments]]) for the given //data//.
 
 
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+
+// Decoding result data (e.g. from an eth_call)
+resultData = "0x0000000000000000000000000000000000000000000000000de0b6b3a7640000";
+//_result:
+iface.decodeFunctionResult("balanceOf", resultData)
+//_log:
+
+// Decoding result data which was caused by a revert
+// Throws a CALL_EXCEPTION, with extra details
+errorData = "0xf7c3865a0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba720000000000000000000000000000000000000000000000000de0b6b3a7640000";
+//_throws:
+iface.decodeFunctionResult("balanceOf", errorData)
+//_log:
+
+// Decoding structured data returns a Result object, which
+// will include all values positionally and if the ABI
+// included names, values will additionally be available
+// by their name.
+resultData = "0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000400000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72000000000000000000000000000000000000000000000000000000000000000d52696368617264204d6f6f726500000000000000000000000000000000000000";
+//_result:
+result = iface.decodeFunctionResult("getUser", resultData);
+//_log:
+
+// Access positionally:
+// The 0th output parameter, the 0th proerty of the structure
+//_result:
+result[0][0];
+//_log:
+
+// Access by name: (only avilable because parameters were named)
+//_result:
+result.user.name
+//_log:
+
 _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
 the components as a fully specified description.
 
+_property: interface.parseError(data) => [[ErrorDescription]] @SRC<abi/interface>
+Search for the error that matches the error selector in //data// and parse out
+the details.
+
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+
+const data = "0xf7c3865a0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba720000000000000000000000000000000000000000000000000de0b6b3a7640000";
+
+//_result:
+iface.parseError(data);
+//_hide: _.errorFragment = createClass("ErrorFragment");
+//_log:
+
 _property: interface.parseLog(log) => [[LogDescription]] @SRC<abi/interface>
 Search the event that matches the //log// topic hash and parse the values
 the log represents.
 
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+
+const data = "0x0000000000000000000000000000000000000000000000000de0b6b3a7640000";
+const topics = [
+  "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
+  "0x0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72",
+  "0x000000000000000000000000ab7c8803962c0f2f5bbbe3fa8bf41cd82aa1923c"
+];
+
+//_result:
+iface.parseLog({ data, topics });
+//_hide: _.eventFragment = createClass("EventFragment");
+//_log:
+
 _property: interface.parseTransaction(transaction) => [[TransactionDescription]] @SRC<abi/interface>
 Search for the function that matches the //transaction// data sighash
 and parse the transaction properties.
 
+_code: @lang<javascript>
+
+//_hide: const iface = _page.iface;
+//_hide: const parseEther = ethers.utils.parseEther;
+
+const data = "0x23b872dd0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba72000000000000000000000000ab7c8803962c0f2f5bbbe3fa8bf41cd82aa1923c0000000000000000000000000000000000000000000000000de0b6b3a7640000";
+const value = parseEther("1.0");
+
+//_result:
+iface.parseTransaction({ data, value });
+//_hide: _.functionFragment = createClass("FunctionFragment");
+//_log:
 
 _subsection: Types @<Interface--types>
 
@@ -142,6 +521,24 @@ any named value for this key is renamed to ``_length``. If there is a
 name collision, only the first is available by its key.
 
 
+_heading: ErrorDescription @<ErrorDescription>
+
+_property: errorDescription.args => [[Result]]
+The values of the input parameters of the error.
+
+_property: errorDescription.errorFragment => [[ErrorFragment]]
+The [[ErrorFragment]] which matches the selector in the data.
+
+_property: errorDescription.name => string
+The error name. (e.g. ``AccountLocked``)
+
+_property: errorDescription.signature => string
+The error signature. (e.g. ``AccountLocked(address,uint256)``)
+
+_property: errorDescription.sighash => string
+The selector of the error.
+
+
 _heading: LogDescription @<LogDescription>
 
 _property: logDescription.args => [[Result]]

docs.wrm/api/utils/address.wrm

@@ -18,7 +18,6 @@ of errors introduced from typing an address or cut and paste issues.
 
 All functions that return an Address will return a Checksum Address.
 
-
 _heading: ICAP Address  @<address-icap>
 
 The **ICAP Address Format** was an early attempt to introduce a checksum
@@ -45,17 +44,76 @@ _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 [INVALID_ARGUMENT](errors--invalid-argument) Error is thrown.
 
 The value of //address// may be any supported address format.
 
+_code: @lang<javascript>
+
+//_hide: const getAddress = ethers.utils.getAddress;
+
+// Injects the checksum (via upper-casing specific letters)
+//_result:
+getAddress("0x8ba1f109551bd432803012645ac136ddd64dba72");
+//_log:
+
+// Converts and injects the checksum
+//_result:
+getAddress("XE65GB6LDNXYOFTX0NSV3FUWKOWIXAMJK36");
+//_log:
+
+// Throws if a checksummed address is provided, but a
+// letter is the wrong case
+// ------------v (should be lower-case)
+//_throws:
+getAddress("0x8Ba1f109551bD432803012645Ac136ddd64DBA72")
+//_log:
+
+// Throws if the ICAP/IBAN checksum fails
+//_throws:
+getIcapAddress("XE65GB6LDNXYOFTX0NSV3FUWKOWIXAMJK37");
+//_log:
+
+// Throws if the address is invalid, in general
+//_throws:
+getIcapAddress("I like turtles!");
+//_log:
+
+
 _property: ethers.utils.getIcapAddress(address) => string<[IcapAddress](address-icap)>  @<utils-getIcapAddress> @SRC<address>
 Returns //address// as an [ICAP address](link-icap).
-Supports the same restrictions as [utils.getAddress](utils-getAddress).
+Supports the same restrictions as [getAddress](utils-getAddress).
+
+_code: @lang<javascript>
+
+//_hide: const getIcapAddress = ethers.utils.getIcapAddress;
+
+//_result:
+getIcapAddress("0x8ba1f109551bd432803012645ac136ddd64dba72");
+//_log:
+
+//_result:
+getIcapAddress("XE65GB6LDNXYOFTX0NSV3FUWKOWIXAMJK36");
+//_log:
 
 _property: ethers.utils.isAddress(address) => boolean  @<utils-isAddress> @SRC<address>
 Returns true if //address// is valid (in any supported format).
 
+_code: @lang<javascript>
+
+//_hide: const isAddress = ethers.utils.isAddress;
+
+//_result:
+isAddress("0x8ba1f109551bd432803012645ac136ddd64dba72");
+//_log:
+
+//_result:
+isAddress("XE65GB6LDNXYOFTX0NSV3FUWKOWIXAMJK36");
+//_log:
+
+//_result:
+isAddress("I like turtles.");
+//_log:
 
 _subsection: Derivation @<utils--address-derivation>
 
@@ -64,10 +122,49 @@ Returns the address for //publicOrPrivateKey//. A public key may be
 compressed or uncompressed, and a private key will be converted
 automatically to a public key for the derivation.
 
+_code: @lang<javascript>
+
+//_hide: const computeAddress = ethers.utils.computeAddress;
+
+// Private Key
+//_result:
+computeAddress("0xb976778317b23a1385ec2d483eda6904d9319135b89f1d8eee9f6d2593e2665d");
+//_log:
+
+// Public Key (compressed)
+//_result:
+computeAddress("0x0376698beebe8ee5c74d8cc50ab84ac301ee8f10af6f28d0ffd6adf4d6d3b9b762");
+//_log:
+
+// Public Key (uncompressed)
+//_result:
+computeAddress("0x0476698beebe8ee5c74d8cc50ab84ac301ee8f10af6f28d0ffd6adf4d6d3b9b762d46ca56d3dad2ce13213a6f42278dabbb53259f2d92681ea6a0b98197a719be3");
+//_log:
+
 _property: ethers.utils.recoverAddress(digest, signature) => string<[[address]]>  @<utils-recoverAddress> @SRC<transactions>
 Use [[link-wiki-ecrecover]] to determine the address that signed //digest// to
 which generated //signature//.
 
+_code: @lang<javascript>
+
+//_hide: const recoverAddress = ethers.utils.recoverAddress;
+
+const digest = "0x7c5ea36004851c764c44143b1dcb59679b11c9a68e5f41497f6cf3d480715331";
+
+// Using an expanded Signature
+//_result:
+recoverAddress(digest, {
+  r: "0x528459e4aec8934dc2ee94c4f3265cf6ce00d47cf42bb106afda3642c72e25eb",
+  s: "0x42544137118256121502784e5a6425e6183ca964421ecd577db6c66ba9bccdcf",
+  v: 27
+});
+//_log:
+
+// Using a flat Signature
+const signature = "0x528459e4aec8934dc2ee94c4f3265cf6ce00d47cf42bb106afda3642c72e25eb42544137118256121502784e5a6425e6183ca964421ecd577db6c66ba9bccdcf1b";
+//_result:
+recoverAddress(digest, signature);
+//_log:
 
 _subsection: Contracts Addresses @<utils--contract-addresses>
 
@@ -75,9 +172,33 @@ _property: ethers.utils.getContractAddress(transaction) => string<[[address]]>
 Returns the contract address that would result if //transaction// was
 used to deploy a contract.
 
+_code: @lang<javascript>
+
+//_hide: const getContractAddress = ethers.utils.getContractAddress;
+
+const from = "0x8ba1f109551bD432803012645Ac136ddd64DBA72";
+const nonce = 5;
+
+//_result:
+getContractAddress({ from, nonce });
+//_log:
+
 _property: ethers.utils.getCreate2Address(from, salt, initCodeHash) => string<[[address]]> @<utils-getCreate2Address> @SRC<address>
 Returns the contract address that would result from the given
 [CREATE2](link-eip-1014) call.
 
+_code: @lang<javascript>
+
+//_hide: const getCreate2Address = ethers.utils.getCreate2Address;
+//_hide: const keccak256 = ethers.utils.keccak256;
+
+const from = "0x8ba1f109551bD432803012645Ac136ddd64DBA72";
+const salt = "0x7c5ea36004851c764c44143b1dcb59679b11c9a68e5f41497f6cf3d480715331";
+const initCode = "0x6394198df16000526103ff60206004601c335afa6040516060f3";
+const initCodeHash = keccak256(initCode);
+
+//_result:
+getCreate2Address(from, salt, initCodeHash);
+//_log:
 
 

docs.wrm/api/utils/bignumber.wrm

@@ -1,10 +1,10 @@
 _section: BigNumber @<BigNumber>
 
-Many operations in Ethereum operation on numbers which are
+Many operations in Ethereum operate on numbers which are
 [outside the range of safe values](BigNumber--notes-safenumbers) to use
 in JavaScript.
 
-A **BigNumber** is an object which safely allows mathematic operations
+A **BigNumber** is an object which safely allows mathematical operations
 on numbers of any magnitude.
 
 Most operations which need to return a value will return a **BigNumber**
@@ -17,7 +17,7 @@ _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
@@ -49,43 +49,52 @@ _heading: Examples:  @<>
 _code: @lang<javascript>
 
 // From a decimal string...
+//_result:
 BigNumber.from("42")
-//!
+//_log:
 
 // From a HexString...
+//_result:
 BigNumber.from("0x2a")
-//!
+//_log:
 
 // From a negative HexString...
+//_result:
 BigNumber.from("-0x2a")
-//!
+//_log:
 
 // From an Array (or Uint8Array)...
+//_result:
 BigNumber.from([ 42 ])
-//!
+//_log:
 
 // From an existing BigNumber...
 let one1 = constants.One;
 let one2 = BigNumber.from(one1)
 
+//_result:
 one2
-//!
+//_log:
 
 // ...which returns the same instance
+//_result:
 one1 === one2
-//!
+//_log:
 
 // From a (safe) number...
+//_result:
 BigNumber.from(42)
-//!
+//_log:
 
 // From a ES2015 BigInt... (only on platforms with BigInt support)
+//_result:
 BigNumber.from(42n)
-//!
+//_log:
 
 // Numbers outside the safe range fail:
+//_throws:
 BigNumber.from(Number.MAX_SAFE_INTEGER);
-//! error
+//_log:
 
 
 _subsection: Methods @<BigNumber--methods>
@@ -122,18 +131,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.
+while efficiently preserving mathematical 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
@@ -153,12 +162,16 @@ 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.
 
 
 _heading: Conversion
 
+_property: BigNumber.toBigInt() => bigint  @SRC<bignumber>
+Returns the value of //BigNumber// as a [JavaScript BigInt](link-js-bigint) value,
+on platforms which support them.
+
 _property: BigNumber.toNumber() => number  @SRC<bignumber>
 Returns the value of //BigNumber// as a JavaScript value.
 
@@ -175,7 +188,7 @@ Returns the value of //BigNumber// as a base-16, ``0x``-prefixed [[DataHexString
 
 _heading: Inspection
 
-_property: ethers.BigNumnber.isBigNumber(object) => boolean  @SRC<bignumber>
+_property: ethers.BigNumber.isBigNumber(object) => boolean  @SRC<bignumber>
 Returns true if and only if the //object// is a BigNumber object.
 
 
@@ -186,8 +199,9 @@ _code: @lang<javascript>
 let a = BigNumber.from(42);
 let b = BigNumber.from("91");
 
+//_result:
 a.mul(b);
-//!
+//_log:
 
 
 _subsection: Notes @<BigNumber--notes>
@@ -214,8 +228,9 @@ To demonstrate how this may be an issue in your code, consider:
 
 _code: @lang<javascript>
 
+//_result:
 (Number.MAX_SAFE_INTEGER + 2 - 2) == (Number.MAX_SAFE_INTEGER)
-//!
+//_log:
 
 _null:
 
@@ -232,7 +247,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
@@ -246,7 +261,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
@@ -270,7 +285,7 @@ various purposes.
 
 _heading: Allow us to set a global Big Number library?
 
-Another comment that comes up frequently is tha desire to specify a
+Another comment that comes up frequently is the desire to specify a
 global user-defined Big Number library, which all functions would
 return.
 

docs.wrm/api/utils/bytes.wrm

@@ -1,6 +1,13 @@
 _section: Byte Manipulation
 
-Tra la la...
+While there are many high-level APIs for interacting with
+Ethereum, such as [Contracts](Contract) and [Providers](Provider),
+a lot of the low level access requires byte manipulation
+operations.
+
+Many of these operations are used internally, but can also be
+used to help normalize binary data representations from the
+output of various functions and methods.
 
 _subsection: Types
 
@@ -25,19 +32,21 @@ 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>
 
 - **r** and **s** --- The x co-ordinate of **r** and the **s** value of the signature
 - **v** --- The parity of the y co-ordinate of **r**
-- **_vs** --- The [compact representation](link-eip-2098) of the **s** and **v**
+- **yParityAndS** --- The [compact representation](link-eip-2098) of the **s** and **v**
+- **_vs** --- Deprecated property; renamed to yParityAndS
 - **recoveryParam** --- The normalized (i.e. 0 or 1) value of **v**
+- **compact** - The full siggnature using [compact representation](link-eip-2098)
 
 _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>
@@ -79,28 +88,34 @@ zeros.
 _code: Examples @lang<javascript>
 
 // Convert a hexstring to a Uint8Array
+//_result:
 arrayify("0x1234")
-//!
+//_log:
 
 // Convert an Array to a hexstring
+//_result:
 hexlify([1, 2, 3, 4])
-//!
+//_log:
 
 // Convert an Object to a hexstring
+//_result:
 hexlify({ length: 2, "0": 1, "1": 2 })
-//!
+//_log:
 
 // Convert an Array to a hexstring
+//_result:
 hexlify([ 1 ])
-//!
+//_log:
 
 // Convert a number to a stripped hex value
+//_result:
 hexValue(1)
-//!
+//_log:
 
 // Convert an Array to a stripped hex value
+//_result:
 hexValue([ 1, 2 ])
-//!
+//_log:
 
 
 _subsection: Array Manipulation
@@ -112,7 +127,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
@@ -155,7 +170,7 @@ Any missing properties will be computed.
 
 _subsection: Random Bytes
 
-_property: ethers.utils.randomBytes(length) => Uint8Array  @<utils-randomBytes> @SRC<random/index>
+_property: ethers.utils.randomBytes(length) => Uint8Array  @<utils-randomBytes> @SRC<random/random>
 Return a new Uint8Array of //length// random bytes.
 
 _property: ethers.utils.shuffled(array) => Array<any>  @<utils-shuffled> @SRC<random>
@@ -163,15 +178,18 @@ Return a copy of //array// shuffled using [[link-wiki-shuffle]].
 
 _code: Examples @lang<javascript>
 
+//_result:
 utils.randomBytes(8)
-//!
+//_log:
 
 const data = [ 1, 2, 3, 4, 5, 6, 7 ];
 
 // Returns a new Array
+//_result:
 utils.shuffled(data);
-//!
+//_log:
 
 // The Original is unscathed...
+//_result:
 data
-//!
+//_log:

docs.wrm/api/utils/constants.wrm

@@ -1,6 +1,6 @@
 _section: Constants @<constants>
 
-The **ethers.contants** Object contains commonly used values.
+The **ethers.constants** Object contains commonly used values.
 
 
 _subsection: Bytes

docs.wrm/api/utils/display-logic.wrm

@@ -1,4 +1,4 @@
-_section: Display Logic and Input
+_section: Display Logic and Input @<display-logic>
 
 When creating an Application, it is useful to convert between
 user-friendly strings (usually displaying **ether**) and the
@@ -17,11 +17,11 @@ The [formatUnits](unit-conversion) will format a [BigNumberish](BigNumberish)
 into a string, which is useful when displaying a balance.
 
 
-_subsection: Units
+_subsection: Units @<display-logic--units>
 
 _heading: Decimal Count
 
-A **Unit** can be specified as an number, which indicates the
+A **Unit** can be specified as a number, which indicates the
 number of decimal places that should be used.
 
 **Examples:**
@@ -29,7 +29,7 @@ number of decimal places that should be used.
 - 1 ether in wei, has **18** decimal places (i.e. 1 ether represents 10^^18^^ wei)
 - 1 bitcoin in Satoshi, has **8** decimal places (i.e. 1 bitcoin represents 10^^8^^ satoshi)
 
-_heading: Named Units
+_heading: Named Units @<display-logic--named-units>
 
 There are also several common **Named Units**, in which case their name (as
 a string) may be used.
@@ -46,13 +46,20 @@ _table: @STYLE<compact>
 |  //ether//   |     18         |
 
 
-_subsection: Functions
+_subsection: Functions @<display-logic--functions>
 
-_heading: Formatting
+_heading: Formatting @<display-logic--formatting>
 
 _property: ethers.utils.commify(value) => string  @<utils-commify> @SRC<units>
 Returns a string with value grouped by 3 digits, separated by ``,``.
 
+_code: @lang<javascript>
+
+//_hide: const commify = ethers.utils.commify;
+
+//_result:
+commify("-1000.3000");
+//_log:
 
 _heading: Conversion @<unit-conversion>
 
@@ -60,13 +67,88 @@ _property: ethers.utils.formatUnits(value [ , unit = "ether" ] ) => string  @<ut
 Returns a string representation of //value// formatted with //unit//
 digits (if it is a number) or to the unit specified (if a string).
 
+_code: @lang<javascript>
+
+//_hide: const formatUnits = ethers.utils.formatUnits;
+//_hide: const BigNumber = ethers.BigNumber;
+
+const oneGwei = BigNumber.from("1000000000");
+const oneEther = BigNumber.from("1000000000000000000");
+
+//_result:
+formatUnits(oneGwei, 0);
+//_log:
+
+//_result:
+formatUnits(oneGwei, "gwei");
+//_log:
+
+//_result:
+formatUnits(oneGwei, 9);
+//_log:
+
+//_result:
+formatUnits(oneEther);
+//_log:
+
+//_result:
+formatUnits(oneEther, 18);
+//_log:
+
 _property: ethers.utils.formatEther(value) => string  @<utils-formatEther> @SRC<units>
 The equivalent to calling ``formatUnits(value, "ether")``.
 
+_code: @lang<javascript>
+
+//_hide: const formatEther = ethers.utils.formatEther;
+//_hide: const BigNumber = ethers.BigNumber;
+
+const value = BigNumber.from("1000000000000000000");
+
+//_result:
+formatEther(value);
+//_log:
+
 _property: ethers.utils.parseUnits(value [ , unit = "ether" ] ) => [BigNumber](BigNumber)  @<utils-parseUnits> @SRC<units>
 Returns a [BigNumber](BigNumber) representation of //value//, parsed with
 //unit// digits (if it is a number) or from the unit specified (if
 a string).
 
+_code: @lang<javascript>
+
+//_hide: const parseUnits = ethers.utils.parseUnits;
+
+//_result:
+parseUnits("1.0");
+//_log:
+
+//_result:
+parseUnits("1.0", "ether");
+//_log:
+
+//_result:
+parseUnits("1.0", 18);
+//_log:
+
+//_result:
+parseUnits("121.0", "gwei");
+//_log:
+
+//_result:
+parseUnits("121.0", 9);
+//_log:
+
 _property: ethers.utils.parseEther(value) => [BigNumber](BigNumber)  @<utils-parseEther> @SRC<units>
 The equivalent to calling ``parseUnits(value, "ether")``.
+
+_code: @lang<javascript>
+
+//_hide: const parseEther = ethers.utils.parseEther;
+
+//_result:
+parseEther("1.0");
+//_log:
+
+//_result:
+parseEther("-0.5");
+//_log:

docs.wrm/api/utils/encoding.wrm

@@ -2,23 +2,63 @@ _section: Encoding Utilities @<encoding>
 
 _subsection: Base58 @<Bse58> @SRC<basex:Base58>
 
-_property: ethers.utils.base58.decode(textData) => Uin8Array
+_property: ethers.utils.base58.decode(textData) => Uint8Array
 Return a typed Uint8Array representation of //textData// decoded using
 base-58 encoding.
 
+_code: @lang<javascript>
+
+//_hide: const base58 = ethers.utils.base58;
+
+//_result:
+base58.decode("TzMhH");
+//_log:
+
 _property: ethers.utils.base58.encode(aBytesLike) => string
 Return //aBytesLike// encoded as a string using the base-58 encoding.
 
+_code: @lang<javascript>
+
+//_hide: const base58 = ethers.utils.base58;
+
+//_result:
+base58.encode("0x12345678");
+//_log:
+
+//_result:
+base58.encode([ 0x12, 0x34, 0x56, 0x78 ]);
+//_log:
+
 
 _subsection: Base64 @<Base64>
 
-_property: ethers.utils.base64.decode(textData) => Uin8Array  @SRC<base64>
+_property: ethers.utils.base64.decode(textData) => Uint8Array  @SRC<base64>
 Return a typed Uint8Array representation of //textData// decoded using
 base-64 encoding.
 
+_code: @lang<javascript>
+
+//_hide: const base64 = ethers.utils.base64;
+
+//_result:
+base64.decode("EjQ=");
+//_log:
+
 _property: ethers.utils.base64.encode(aBytesLike) => string  @SRC<base64>
 Return //aBytesLike// encoded as a string using the base-64 encoding.
 
+_code: @lang<javascript>
+
+//_hide: const base64 = ethers.utils.base64;
+
+//_result:
+base64.encode("0x1234");
+//_log:
+
+//_result:
+base64.encode([ 0x12, 0x34 ]);
+//_log:
+
 
 _subsection: Recursive-Length Prefix @<rlp--methods>
 
@@ -26,15 +66,53 @@ The [[link-rlp]] encoding is used throughout Ethereum to serialize nested
 structures of Arrays and data.
 
 _property: ethers.utils.RLP.encode(dataObject) => string<[[DataHexString]]>  @<utils-rlpEncode> @SRC<rlp>
-Encode a structured Data Object into its RLP-encoded representation.
+Encode a structured [Data Object](rlp--dataobject) into its RLP-encoded representation.
 
-Each Data component may be an valid [[BytesLike]].
+_code: @lang<javascript>
+
+//_hide: const RLP = ethers.utils.RLP;
+
+//_result:
+RLP.encode("0x12345678");
+//_log:
+
+//_result:
+RLP.encode([ "0x12345678" ]);
+//_log:
+
+//_result:
+RLP.encode([ new Uint8Array([ 0x12, 0x34, 0x56, 0x78 ]) ]);
+//_log:
+
+//_result:
+RLP.encode([ [ "0x42", [ "0x43" ] ], "0x12345678", [ ] ]);
+//_log:
+
+//_result:
+RLP.encode([ ]);
+//_log:
 
 _property: ethers.utils.RLP.decode(aBytesLike) => [DataObject](rlp--dataobject)  @<utils.rlpDecode> @SRC<rlp>
-Decode an RLP-encoded //aBytesLike// into its structured Data Object.
+Decode an RLP-encoded //aBytesLike// into its structured [Data Object](rlp--dataobject).
 
 All Data components will be returned as a [[DataHexString]].
 
+_code: @lang<javascript>
+
+//_hide: const RLP = ethers.utils.RLP;
+
+//_result:
+RLP.decode("0x8412345678");
+//_log:
+
+//_result:
+RLP.decode("0xcac342c1438412345678c0");
+//_log:
+
+//_result:
+RLP.decode("0xc0");
+//_log:
+
 _heading: Data Object @<rlp--dataobject>
 
 A **Data Object** is a recursive structure which is used to serialize many

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>
@@ -75,7 +81,7 @@ _subsection: FixedFormat @<FixedFormat>
 
 A **FixedFormat** is a simple object which represents a decimal
 (base-10) Fixed-Point data representation. Usually using this
-class directly is uneccessary, as passing in a [[FixedFormat--strings]]
+class directly is unnecessary, as passing in a [[FixedFormat--strings]]
 directly into the [[FixedNumber]] will automatically create this.
 
 _heading: Format Strings  @<FixedFormat--strings>
@@ -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,6 +1,8 @@
 _section: Hashing Algorithms @<hashing-algorithms>
 
-Explain what hash functions are?
+There are many hashing algorithms used throughout the blockchain
+space as well as some more complex usages which require utilities
+to facilitate these common operations.
 
 
 _subsection: Cryptographic Hash Functions @<cryptographic-hash-functions>
@@ -9,7 +11,7 @@ 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//.
@@ -25,14 +27,17 @@ Returns the [SHA2-512](link-wiki-sha2) digest of //aBytesLike//.
 
 _code: KECCAK256 @lang<javascript>
 
+//_result:
 utils.keccak256([ 0x12, 0x34 ])
-//!
+//_log:
 
+//_result:
 utils.keccak256("0x")
-//!
+//_log:
 
+//_result:
 utils.keccak256("0x1234")
-//!
+//_log:
 
 // The value MUST be data, such as:
 //  - an Array of numbers
@@ -40,16 +45,19 @@ utils.keccak256("0x1234")
 //  - a Uint8Array
 
 // Do NOT use UTF-8 strings that are not a DataHexstring
+//_throws:
 utils.keccak256("hello world")
-//! error
+//_log:
 
 // If needed, convert strings to bytes first:
+//_result:
 utils.keccak256(utils.toUtf8Bytes("hello world"))
-//!
+//_log:
 
 // Or equivalently use the identity function:
+//_result:
 utils.id("hello world")
-//!
+//_log:
 
 // Keep in mind that the string "0x1234" represents TWO
 // bytes (i.e. [ 0x12, 0x34 ]. If you wish to compute the
@@ -59,48 +67,56 @@ utils.id("hello world")
 // Consider the following examples:
 
 // Hash of TWO (2) bytes:
+//_result:
 utils.keccak256("0x1234")
-//!
+//_log:
 
 // Hash of TWO (2) bytes: (same result)
+//_result:
 utils.keccak256([ 0x12, 0x34 ])
-//!
+//_log:
 
-const bytes = utils.toUtf8Bytes("0x1234");
-// <hide>
-bytes
-// </hide>
-//!
+//_result:
+bytes = utils.toUtf8Bytes("0x1234")
+//_log:
 
 // Hash of SIX (6) characters (different than above)
+//_result:
 utils.keccak256(bytes)
-//!
+//_log:
 
 // Hash of SIX (6) characters (same result)
+//_result:
 utils.id("0x1234")
-//!
+//_log:
 
 _code: RIPEMD160  @lang<javascript>
 
+//_result:
 utils.ripemd160("0x")
-//!
+//_log:
 
+//_result:
 utils.ripemd160("0x1234")
-//!
+//_log:
 
 _code: SHA-2  @lang<javascript>
 
+//_result:
 utils.sha256("0x")
-//!
+//_log:
 
+//_result:
 utils.sha256("0x1234")
-//!
+//_log:
 
+//_result:
 utils.sha512("0x")
-//!
+//_log:
 
+//_result:
 utils.sha512("0x1234")
-//!
+//_log:
 
 
 _subsection: HMAC @<utils--hmac>
@@ -119,10 +135,11 @@ Use the [SHA2-512](link-wiki-sha2) hash algorithm.
 
 _code: HMAC  @lang<javascript>
 
-const key = "0x0102";
-const data = "0x1234";
+const key = "0x0102"
+const data = "0x1234"
+//_result:
 utils.computeHmac("sha256", key, data)
-//!
+//_log:
 
 
 _subsection: Hashing Helpers @<utils--hashing-helpers>
@@ -132,27 +149,179 @@ Computes the [[link-eip-191]] personal message digest of //message//. Personal m
 converted to UTF-8 bytes and prefixed with ``\\x19Ethereum Signed Message:``
 and the length of //message//.
 
+_code: Hashing Messages  @lang<javascript>
+
+// Hashing a string message
+//_result:
+utils.hashMessage("Hello World")
+//_log:
+
+// Hashing binary data (also "Hello World", but as bytes)
+//_result:
+utils.hashMessage( [ 72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100 ])
+//_log:
+
+// NOTE: It is important to understand how strings and binary
+//       data is handled differently. A string is ALWAYS processed
+//       as the bytes of the string, so a hexstring MUST be
+//       converted to an ArrayLike object first.
+
+// Hashing a hex string is the same as hashing a STRING
+// Note: this is the hash of the 4 characters [ '0', 'x', '4', '2' ]
+//_result:
+utils.hashMessage("0x42")
+//_log:
+
+// Hashing the binary data
+// Note: this is the hash of the 1 byte [ 0x42 ]
+//_result:
+utils.hashMessage([ 0x42 ])
+//_log:
+
+// Hashing the binary data
+// Note: similarly, this is the hash of the 1 byte [ 0x42 ]
+//_result:
+utils.hashMessage(utils.arrayify("0x42"))
+//_log:
+
+
 _property: ethers.utils.namehash(name) => string<[[DataHexString]]<32>>  @<utils-namehash> @SRC<hash>
 Returns the [ENS Namehash](link-namehash) of //name//.
 
-_code: Hashing Messages  @lang<javascript>
-
-// @TODO: include examples of hashMessage; it can be complex. :)
-
-
 _code: Namehash  @lang<javascript>
 
+//_result:
 utils.namehash("")
-//!
+//_log:
 
+//_result:
 utils.namehash("eth")
-//!
+//_log:
 
+//_result:
 utils.namehash("ricmoo.firefly.eth")
-//!
+//_log:
 
+//_result:
 utils.namehash("ricmoo.xyz")
-//!
+//_log:
+
+_heading: Typed Data Encoder @<TypedDataEncoder> @SRC<hash:class.TypedDataEncoder>
+
+The **TypedDataEncoder** is used to compute the various encoded data required
+for [[link-eip-712]] signed data.
+
+Signed data requires a domain, list of structures and their members and the data
+itself.
+
+The **domain** is an object with values for any of the standard domain
+properties.
+
+The **types** is an object with each property being the name of a structure, mapping
+to an array of field descriptions. It should **not** include the ``EIP712Domain``
+property unless it is required as a child structure of another.
+
+_note: Experimental Feature (this exported class name will change)
+This is still an experimental feature. If using it, please specify the **exact**
+version of ethers you are using (e.g. spcify ``"5.0.18"``, **not** ``"^5.0.18"``) as
+the exported class name will be renamed from ``_TypedDataEncoder`` to ``TypedDataEncoder`` once
+it has been used in the field a bit.
+
+_property: ethers.utils._TypedDataEncoder.from(types) => [TypedDataEncoder] @<TypedDataEncoder-from> @SRC<hash:TypedDataEncoder.from>
+
+Creates a new **TypedDataEncoder** for //types//. This object is a fairly
+low-level object that most developers should not require using instances
+directly.
+
+Most developers will find the static class methods below the most useful.
+
+_property: TypedDataEncoder.encode(domain, types, values) => string @<TypedDataEncoder-encode> @SRC<hash:staticmethod.TypedDataEncoder.encode>
+
+Encodes the Returns the hashed [[link-eip-712]] domain.
+
+_property: TypedDataEncoder.getPayload(domain, types, value) => any @<TypedDataEncoder-getPayload> @SRC<hash:TypedDataEncoder.getPayload>
+
+Returns the standard payload used by various JSON-RPC ``eth_signTypedData*``
+calls.
+
+All domain values and entries in value are normalized and the types are
+verified.
+
+_property: TypedDataEncoder.getPrimaryType(types) => string @<TypedDataEncoder-getPrimaryType> @SRC<hash:TypedDataEncoder.getPrimaryType>
+
+Constructs a directed acyclic graph of the types and returns the
+root type, which can be used as the **primaryType** for [[link-eip-712]]
+payloads.
+
+_property: TypedDataEncoder.hash(domain, types, values) => string<[[DataHexString]]<32>> @<TypedDataEncoder-hash> @SRC<hash:staticmethod.TypedDataEncoder.hash>
+
+Returns the computed [[link-eip-712]] hash.
+
+_property: TypedDataEncoder.hashDomain(domain) => string<[[DataHexString]]<32>> @<TypedDataEncoder-hashDomain> @SRC<hash:TypedDataEncoder.hashDomain>
+
+Returns the hashed [[link-eip-712]] domain.
+
+_property: TypedDataEncoder.resolveNames(domain, types, value, resolveName) => Promise<any> @<TypedDataEncoder-resolveNames> @SRC<hash:TypedDataEncoder.resolveNames>
+
+Returns a copy of value, where any leaf value with a type of ``address`` will have
+been recursively replacedwith the value of calling //resolveName// with that value.
+
+_code: Typed Data Example @lang<javascript>
+
+//_hide: TypedDataEncoder = ethers.utils._TypedDataEncoder
+
+domain = {
+    name: 'Ether Mail',
+    version: '1',
+    chainId: 1,
+    verifyingContract: '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC'
+};
+
+// The named list of all type definitions
+types = {
+    Person: [
+        { name: 'name', type: 'string' },
+        { name: 'wallet', type: 'address' }
+    ],
+    Mail: [
+        { name: 'from', type: 'Person' },
+        { name: 'to', type: 'Person' },
+        { name: 'contents', type: 'string' }
+    ]
+};
+
+// The data to sign
+value = {
+    from: {
+        name: 'Cow',
+        wallet: '0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826'
+    },
+    to: {
+        name: 'Bob',
+        wallet: '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB'
+    },
+    contents: 'Hello, Bob!'
+};
+
+//_result:
+TypedDataEncoder.encode(domain, types, value)
+//_log:
+
+//_result:
+TypedDataEncoder.getPayload(domain, types, value)
+//_log:
+
+//_result:
+TypedDataEncoder.getPrimaryType(types)
+//_log:
+
+//_result:
+TypedDataEncoder.hash(domain, types, value)
+//_log:
+
+//_result:
+TypedDataEncoder.hashDomain(domain)
+//_log:
 
 
 _subsection: Solidity Hashing Algorithms @<utils--solidity-hashing>
@@ -163,7 +332,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
@@ -175,15 +344,40 @@ according to their respective type in //types//.
 
 _code: Solidity Hashing  @lang<javascript>
 
+//_result:
 utils.solidityPack([ "int16", "uint48" ], [ -1, 12 ])
-//!
+//_log:
 
+//_result:
 utils.solidityPack([ "string", "uint8" ], [ "Hello", 3 ])
-//!
+//_log:
 
+//_result:
 utils.solidityKeccak256([ "int16", "uint48" ], [ -1, 12 ])
-//!
+//_log:
 
+//_result:
 utils.soliditySha256([ "int16", "uint48" ], [ -1, 12 ])
-//!
+//_log:
 
+// As a short example of the non-distinguished nature of
+// Solidity tight-packing (which is why it is inappropriate
+// for many things from a security point of view), consider
+// the following examples are all equal, despite representing
+// very different values and layouts.
+
+//_result:
+utils.solidityPack([ "string", "string" ], [ "hello", "world01" ])
+//_log:
+
+//_result:
+utils.solidityPack([ "string", "string" ], [ "helloworld", "01" ])
+//_log:
+
+//_result:
+utils.solidityPack([ "string", "string", "uint16" ], [ "hell", "oworld", 0x3031 ])
+//_log:
+
+//_result:
+utils.solidityPack([ "uint96" ], [ "32309054545061485574011236401" ])
+//_log:

docs.wrm/api/utils/hdnode.wrm

@@ -1,6 +1,16 @@
 _section: HD Wallet @<hdnodes>
 
-TODO: Explain [BIP32](link-bip-32) [BIP-39](link-bip-39) and whatnot here...
+The Hierarchal Desterministic (HD) Wallet was a standard
+created for Bitcoin, but lends itself well to a wide variety of
+Blockchains which rely on secp256k1 private keys.
+
+For a more detailed technical understanding:
+
+- [BIP-32](link-bip-32) - the hierarchal deterministic description
+- [BIP-39](link-bip-39) - the method used to derive the BIP-32 seed
+  from human-readable sequences of words (i.e. a mnemonic)
+- [BIP-44](link-bip-44) - a standard defined to make BIP-32 easy
+  to adapt to any future compatible blockchain
 
 _subsection: Types
 
@@ -101,7 +111,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

@@ -48,39 +48,38 @@ Throw an Error with //message// and an optional //code// and
 additional //params// set.
 
 _property: logger.throwArgumentError(message, name, value) => never @SRC<logger>
-Throw an [INVALID_ARGUMENT](errors-InvalidArgument) Error with //name// and //value//.
-
+Throw an [INVALID_ARGUMENT](errors--invalid-argument) Error with //name// and //value//.
 
 _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
-as ``checkNew``. This is useful for ensuring abstract classes are not
-being instantiated.
+_property: logger.checkAbstract(target, kind) => void @<Logger-checkAbstract> @SRC<logger>
+If //target// is //kind//, throws a [UNSUPPORTED_OPERATION](errors--unsupported-operation) error
+otherwise performs the same operations as [checkNew](Logger-checkNew).
 
-_property: logger.checkArgumentCount(count, expectedCound [ , message) => void @SRC<logger>
-If //count// is not equal to //expectedCount//, throws a [MISSING_ARGUMENT](errors-MissingArgument)
-or [UNEXPECTED_ARGUMENT](errors-UnexpectedArgument) error.
+This is useful for ensuring abstract classes are not being instantiated.
 
-_property: logger.checkNew(target, kind) => void @SRC<logger>
+_property: logger.checkArgumentCount(count, expectedCount [ , message) => void @<Logger-checkArgumentCount> @SRC<logger>
+If //count// is not equal to //expectedCount//, throws a [MISSING_ARGUMENT](errors--missing-argument)
+or [UNEXPECTED_ARGUMENT](errors--unexpected-argument) error.
+
+_property: logger.checkNew(target, kind) => void @<Logger-checkNew> @SRC<logger>
 If //target// is not a valid ``this`` or ``target`` value, throw a
-[MISSING_NEW](errors-MissingNew) error. This is useful to ensure
+[MISSING_NEW](errors--missing-new) error. This is useful to ensure
 callers of a Class are using ``new``.
 
-_property: logger.checkNormalize(message) => void @SRC<logger>
+_property: logger.checkNormalize(message) => void @<Logger-checkNoralize> @SRC<logger>
 Check that the environment has a correctly functioning [[link-js-normalize]]. If not, a
-[UNSUPPORTED_OPERATION](errors-UnsupportedOperation) error is thrown.
+[UNSUPPORTED_OPERATION](errors--unsupported-operation) error is thrown.
 
-_property: logger.checkSafeUint53(value [, message ]) => void @SRC<logger>
+_property: logger.checkSafeUint53(value [, message ]) => void @<Logger-checkSafeUint53> @SRC<logger>
 If //value// is not safe as a [JavaScript number](link-wiki-ieee754), throws a
-[NUMERIC_FAULT](errors-NumericFault) error.
-
+[NUMERIC_FAULT](errors--numeric-fault) error.
 
 _heading: Censorship @<Logger--censorship>
 
-_property: Logger.setCensorship(censor [ , permanent = false ]) => void @SRC<logger>
+_property: Logger.setCensorship(censor [ , permanent = false ]) => void @<Logger-setCensorship> @SRC<logger>
 Set error censorship, optionally preventing errors from being uncensored.
 
 In production applications, this prevents any error from leaking information
@@ -88,7 +87,7 @@ by masking the message and values of errors.
 
 This can impact debugging, making it substantially more difficult.
 
-_property: Logger.setLogLevel(logLevel) => void @SRC<logger>
+_property: Logger.setLogLevel(logLevel) => void @<Logger-setLogLevel> @SRC<logger>
 Set the log level, to suppress logging output below a [particular log level](Logger-levels).
 
 
@@ -98,76 +97,113 @@ Every error in Ethers has a ``code`` value, which is a string that will
 match one of the following error codes.
 
 
-_heading: Generic Error Codes
+_heading: Generic Error Codes @<errors-generic>
 
-_property: Logger.errors.NOT_IMPLEMENTED
-The operation is not implemented.
+_property: Logger.errors.NOT_IMPLEMENTED @<errors--not-implemented>
+The operation is not implemented. This may occur when calling a method
+on a sub-class that has not fully implemented its abstract superclass.
 
-_property: Logger.errors.SERVER_ERROR
+_property: Logger.errors.SERVER_ERROR @<errors--server-error>
 There was an error communicating with a server.
 
-_property: Logger.errors.TIMEOUT @<errors-Timeout>
+This may occur for a number of reasons, for example:
+
+- a [CORS](link-cors) issue; this is quite often the problem and also the
+  hardest to diagnose and fix, so it is very beneficial to familiarize
+  yourself with CORS; some backends allow you configure your CORS, such as
+  the geth command-line or conifguration files or the INFURA and Alchemy
+  dashboards by specifing allowed Origins, methods, etc.
+- an SSL issue; for example, if you are trying to connect to a local node via
+  HTTP but are serving the content from a secure HTTPS website
+- a link issue; a firewall is preventing the traffic from reaching the server
+- a server issue; the server is down, or is returning 500 error codes
+- a backend DDoS mitigation proxy; for example, Etherscan operates behind a
+  Cloudflare proxy, which will block traffic if the request is sent via
+  specific User Agents or the client fingerprint is detected as a bot in some
+  cases
+
+_property: Logger.errors.TIMEOUT @<errors--timeout>
 A timeout occurred.
 
-_property: Logger.errors.UNKNOWN_ERROR @<errors-UnknownError>
+_property: Logger.errors.UNKNOWN_ERROR @<errors--unknown-error>
 A generic unknown error.
 
-_property: Logger.errors.UNSUPPORTED_OPERATION @<errors-UnsupportedOperation>
+_property: Logger.errors.UNSUPPORTED_OPERATION @<errors--unsupported-operation>
 The operation is not supported.
 
+This can happen for a variety reasons, for example:
 
-_heading: Safety Error Codes
+- Some backends do not support certain operations; such as passing a blockTag
+  to an [[EtherscanProvider]] for [call](Provider-call)
+- A [[Contract]] object connected to [[Provider]] (instead of a [[Signer]]) cannot
+  [sign](Signer-signTransaction) or [send](Signer-sendTransaction) transactions
+- a [[Contract]] connected to a [[Signer]] without a [[Provider]] is write-only
+  and cannot estimate gas or execute static calls
 
-_property: Logger.errors.BUFFER_OVERRUN
+
+_heading: Safety Error Codes @<errors-safety>
+
+_property: Logger.errors.BUFFER_OVERRUN @<errors--buffer-overrun>
 The amount of data needed is more than the amount of data required,
 which would cause the data buffer to read past its end.
 
-_property: Logger.errors.NUMERIC_FAULT @<errors-NumericFault>
+This can occur if a contract erroneously returns invalid ABI-encoded
+data or RLP data is malformed.
+
+_property: Logger.errors.NUMERIC_FAULT @<errors--numeric-fault>
 There was an invalid operation done on numeric values.
 
 Common cases of this occur when there is [[link-wiki-overflow]],
 [[link-wiki-underflow]] in fixed numeric types or division by zero.
 
 
-_heading: Usage Error Codes
+_heading: Usage Error Codes @<errors-usage>
 
-_property: Logger.errors.INVALID_ARGUMENT @<errors-InvalidArgument>
+_property: Logger.errors.INVALID_ARGUMENT @<errors--invalid-argument>
 The type or value of an argument is invalid. This will generally also
 include the ``name`` and ``value`` of the argument. Any function which
 accepts sensitive data (such as a private key) will include the string
-``[\[REDACTED]\]`` instead of the value passed in.
+``"[\[REDACTED]\]"`` instead of the value passed in.
 
-_property: Logger.errors.MISSING_ARGUMENT @<errors-MissingArgument>
+_property: Logger.errors.MISSING_ARGUMENT @<errors--missing-argument>
 An expected parameter was not specified.
 
-_property: Logger.errors.MISSING_NEW @<errors-MissingNew>
-An object is a Class, but is now being called with ``new``.
+_property: Logger.errors.MISSING_NEW @<errors--missing-new>
+An object is a Class, but is not being called with ``new``.
 
-_property: Logger.errors.UNEXPECTED_ARGUMENT @<errors-UnexpectedArgument>
+_property: Logger.errors.UNEXPECTED_ARGUMENT @<errors--unexpected-argument>
 Too many parameters we passed into a function.
 
 
-_heading: Ethereum Error Codes
+_heading: Ethereum Error Codes @<errors-ethereum>
 
-_property: Logger.errors.CALL_EXCEPTION
+_property: Logger.errors.CALL_EXCEPTION @<errors--call-exception>
 An attempt to call a blockchain contract (getter) resulted in a
-revert or other error.
+revert or other error, such as insufficient gas (out-of-gas) or an
+invalid opcode. This can also occur during gas estimation or if
+waiting for a [[providers-TransactionReceipt]] which failed during execution.
 
-_property: Logger.errors.INSUFFICIENT_FUNDS
+Consult the contract to determine the cause, such as a failed condition
+in a ``require`` statement. The ``reason`` property may provide more
+context for the cause of this error.
+
+_property: Logger.errors.INSUFFICIENT_FUNDS @<errors--insufficient-funds>
 The account is attempting to make a transaction which costs more than is
 available.
 
 A sending account must have enough ether to pay for the value, the gas limit
 (at the gas price) as well as the intrinsic cost of data. The intrinsic cost
-of data is 4 gas for each zero byte and 68 gas for each non-zero byte.
+of data is 4 gas for each zero byte and 68 gas for each non-zero byte, as well
+as 35000 gas if a transaction contains no ``to`` property and is therefore
+expected to create a new account.
 
-_property: Logger.errors.NETWORK_ERROR
+_property: Logger.errors.NETWORK_ERROR @<errors--network>
 An Ethereum network validation error, such as an invalid chain ID.
 
-_property: Logger.errors.NONCE_EXPIRED
+_property: Logger.errors.NONCE_EXPIRED @<errors--nonce-expired>
 The nonce being specified has already been used in a mined transaction.
 
-_property: Logger.errors.REPLACEMENT_UNDERPRICED
+_property: Logger.errors.REPLACEMENT_UNDERPRICED @<errors--replacement-underpriced>
 When replacing a transaction, by using a nonce which has already been sent to
 the network, but which has not been mined yet the new transaction must specify
 a higher gas price.
@@ -175,9 +211,28 @@ a higher gas price.
 This error occurs when the gas price is insufficient to //bribe// the transaction
 pool to prefer the new transaction over the old one. Generally, the new gas price
 should be about 50% + 1 wei more, so if a gas price of 10 gwei was used, the
-replacement should be 15.000000001 gwei.
+replacement should be 15.000000001 gwei. This is not enforced by the protocol, as
+it deals with unmined transactions, and can be configured by each node, however
+to ensure a transaction is propagated to a miner it is best practice to follow
+the defaults most nodes have enabled.
 
-_property: Logger.errors.UNPREDICTABLE_GAS_LIMIT
+_property: Logger.errors.TRANSACTION_REPLACED @<errors--transaction-replaced>
+When a transaction has been replaced by the user, by broadcasting a new transaction
+with the same nonce as an existing in-flight (unmined) transaction in the mempool,
+this error will occur while waiting if the transaction being waited for has become
+invalidated by that other transaction.
+
+This can happen for several reasons, but most commonly because the user has increased
+the gas price (which changes the transaction hash) to "speed up" a transaction or if
+a user has "cancelled" the transaction in their client. In either case this is
+usually accomplished by bribing the miners with a higher gas priced transaction.
+
+This error will have the additional properties, ``cancelled``, ``hash``, ``reason``,
+``receipt`` and ``replacement``.
+
+See the [[providers-TransactionResponse]] for the ``wait`` method for more details.
+
+_property: Logger.errors.UNPREDICTABLE_GAS_LIMIT @<errors--unpredicatable-gas-limit>
 When estimating the required amount of gas for a transaction, a node is queried for
 its best guess.
 
@@ -196,7 +251,7 @@ _property: Logger.levels.DEBUG
 Log all output, including debugging information.
 
 _property: Logger.levels.INFO
-Only log output for infomational, warnings and errors.
+Only log output for informational, warnings and errors.
 
 _property: Logger.levels.WARNING
 Only log output for warnings and errors.

docs.wrm/api/utils/properties.wrm

@@ -1,9 +1,40 @@
 _section: Property Utilities
 
-_property: ethers.utils.checkProperties() => void
+This is a collection of utility functions used for handling
+properties in a platform-safe way.
+
+The next major version of ethers will no longer be compatible
+with ES3, so many of these will be removed in favor of the
+built-in options available in ES2015 and above.
+
+_property: ethers.utils.checkProperties(object, check) => void
+
+Checks that //object// only contains properties included
+in //check//, and throws [INVALID_ARGUMENT](errors--invalid-argument) if not.
 
 _property: ethers.utils.deepCopy(anObject) => any
+
+Creates a recursive copy of //anObject//. Frozen (i.e. and other known
+immutable) objects are copied by reference.
+
 _property: ethers.utils.defineReadOnly(anObject, name, value) => void
+
+Uses the ``Object.defineProperty`` method to set a read-only property
+on an object.
+
 _property: ethers.utils.getStatic(aConstructor, key) => any
+
+Recursively check for a static method //key// on an inheritance chain
+from //aConstructor// to all ancestors.
+
+This is used to mimic behaviour in other languages where ``this`` in
+a static method will also search ancestors.
+
 _property: ethers.utils.resolveProperties(anObject) => Promise<any> @<utils-resolveproperties> @SRC<properties>
+
+Retruns a Promise which resolves all child values on //anObject//.
+
 _property: ethers.utils.shallowCopy(anObject) => any
+
+Returns a shallow copy of //anObject//. This is the same as
+using ``Object.assign({ }, anObject)``.

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.
@@ -39,7 +39,13 @@ will then be used to compute the address; this allows systems which use
 the v to encode additional data (such as [EIP-155](link-eip-155))
 to be used since the v parameter is still completely non-ambiguous.
 
+_property: ethers.utils.verifyTypedData(domain, types, value, signature) => string<[[address]]>  @<utils-verifyTypedData> @SRC<wallet>
+Returns the address that signed the [[link-eip-712]] //value// for the //domain//
+and //types// to produce the signature.
+
 _property: ethers.utils.recoverPublicKey(digest, signature) => string<[[DataHexString]]<65>> @<utils-recoverPublicKey>
+Returns the uncompressed public key (i.e. the first byte will be ``0x04``)
+of the private key that was used to sign //digest// which gave the //signature//.
 
 _property: ethers.utils.computePublicKey(key [, compressed = false ]) => string<[[DataHexString]]> @<utils-computePublicKey>
 Computes the public key of //key//, optionally compressing it. The //key//

docs.wrm/api/utils/strings.wrm

@@ -1,7 +1,11 @@
 _section: Strings  @<strings>
 
-Tra la la
+A **String** is a representation of a human-readable input of output,
+which are often taken for granted.
 
+When dealing with blockchains, properly handling human-readable and
+human-provided data is important to prevent loss of funds, assets,
+incorrect permissions, etc.
 
 _subsection: Bytes32String @<Bytes32String>
 
@@ -40,7 +44,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 +92,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

@@ -7,7 +7,7 @@ An unsigned transaction represents a transaction that has not been
 signed and its values are flexible as long as they are not ambiguous.
 
 _property: unsignedTransaction.to => string<[Address](address)>
-The addres this transaction is to.
+The address this transaction is to.
 
 _property: unsignedTransaction.nonce => number
 The nonce of this transaction.
@@ -18,6 +18,12 @@ The gas limit for this transaction.
 _property: unsignedTransaction.gasPrice => [[BigNumberish]]
 The gas price for this transaction.
 
+_property: unsignedTransaction.maxFeePerGas => [[BigNumberish]]
+The maximum fee per unit of gas for this transaction.
+
+_property: unsignedTransaction.maxPriorityFeePerGas => [[BigNumberish]]
+The maximum priority fee per unit of gas for this transaction.
+
 _property: unsignedTransaction.data => [[BytesLike]]
 The data for this transaction.
 
@@ -38,7 +44,7 @@ The transaction hash, which can be used as an identifier for
 //transaction//. This is the keccak256 of the serialized RLP encoded
 representation of //transaction//.
 
-_property: unsignedTransaction.to => string<[Address](address)>
+_property: transaction.to => string<[Address](address)>
 The address //transaction// is to.
 
 _property: transaction.from => string<[Address](address)>
@@ -54,12 +60,24 @@ _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]]
+_property: transaction.gasPrice => null | [[BigNumber]]
 The price (in wei) per unit of gas for //transaction//.
 
+For [[link-eip-1559]] transactions, this will be null.
+
+_property: transaction.maxFeePerGas => [[BigNumber]]
+The maximum price (in wei) per unit of gas for //transaction//.
+
+For transactions that are not [[link-eip-1559]] transactions, this will be null.
+
+_property: transaction.maxPriorityFeePerGas => [[BigNumber]]
+The priority fee price (in wei) per unit of gas for //transaction//.
+
+For transactions that are not [[link-eip-1559]] transactions, this will be null.
+
 _property: transaction.data => [[BytesLike]]
 The data for //transaction//. In a contract this is the call data.
 
@@ -97,8 +115,17 @@ used to encode the chain ID into the serialized transaction.
 
 _subsection: Functions  @<transactions--functions>
 
+_property: ethers.utils.accessListify(anAcceslistish) => [[providers-AccessList]]  @<utils-accessListify> @SRC<transactions:accessListify>
+Normalizes the [[providers-AccessListish]] //anAccessListish// into
+an [[providers-AccessList]].
+
+This is useful for other utility functions which wish to remain
+flexible as to the input parameter for access lists, such as
+when creating a [[Signer]] which needs to manipulate a possibly
+typed transaction envelope.
+
 _property: ethers.utils.parseTransaction(aBytesLike) => [[Transaction]]  @<utils-parseTransaction> @SRC<transactions:parse>
-Parses the transaction properties from a serialized transactions.
+Parses the transaction properties from a serialized transaction.
 
 _property: ethers.utils.serializeTransaction(tx [ , signature ]) => string<[[DataHexString]]>  @<utils-serializeTransaction> @SRC<transactions:serialize>
 Computes the serialized //transaction//, optionally serialized with

docs.wrm/api/utils/web.wrm

@@ -3,7 +3,7 @@ _section: Web Utilities  @<web>
 
 _property: ethers.utils.fetchJson(urlOrConnectionInfo [, json [ , processFunc ] ]) => Promise<any> @<utils-fetchJson>
 Fetch and parse the JSON content from //urlOrConnectionInfo//, with the
-optiona body //json// and optionally processing the result with //processFun//
+optional body //json// and optionally processing the result with //processFun//
 before returning it.
 
 _property: ethers.utils.poll(pollFunc [, options ]) => Promise<any> @<utils-poll>
@@ -33,11 +33,17 @@ How long to wait before rejecting with a //timeout// error.
 _property: connection.headers => { [ key: string]: string }
 Additional headers to include in the connection.
 
+_property: connection.skipFetchSetup => boolean
+Normally a connection will specify the default values for a connection
+such as CORS-behavior and caching policy, to ensure compatibility across
+platforms. On some services, such as Cloudflare Workers, specifying any
+value (inclluding the default values) will cause failure. Setting this
+to true will prevent any values being passed to the underlying API.
 
 _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,8 +30,8 @@ the registered //name//.
 
 _subsection: Languages @<wordlists--languages>
 
-The [official wordlists](link-bip39-wordlists) availalbe in at
-`ethers.wordlists`. In the browser, only the english langauge is
+The [official wordlists](link-bip39-wordlists) available 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.
 

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
@@ -104,8 +104,8 @@ bytecode by running multiple passes of an assemble stage, each pass
 more closely approximating the final result.
 
 This allows small portions of the bytecode to be massaged and tweaked
-until the bytecode stablizes. This allows for more compact jump
-destinations and for code to be include more advanced meta-programming
+until the bytecode stabilizes. This allows for more compact jump
+destinations and for code to include more advanced meta-programming
 techniques.
 
 _code: @lang<shell>
@@ -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
@@ -47,8 +47,8 @@ for a given option is invalid or some combination of options and flags is not
 allowed.
 
 Once the prepareOptions is complete (the returned promise is resolved), the ``prepareArguments``
-is called. This should validate the number of arguments is expected and throw
-and error if there are too many or too few arguments or if any arguments do not
+is called. This should validate the number of arguments expected and throw
+an error if there are too many or too few arguments or if any arguments do not
 make sense.
 
 Once the prepareArguments is complete (the returned promise is resolved), the ``run``
@@ -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

@@ -20,7 +20,7 @@ refresh the page. This should cause all your UI components to
 reset to a known-safe state, including any banners and warnings
 to your users if they are on an unsupported network.
 
-This can be acomplished by using the following function:
+This can be accomplished by using the following function:
 
 _code: Automatically Refresh on Network Change @lang<script>
 

docs.wrm/concepts/events.wrm

@@ -1,34 +1,40 @@
-_section: Events
-
-Explain how topics and such work
-
-_subsection: Solidity Topics
-
-How to compute the topic...
+_section: Events @<events>
 
 _subsection: Logs and Filtering
 
-Example hog logs are used.
+Logs and filtering are used quite often in blockchain applications,
+since they allow for efficient queries of indexed data and provide
+lower-cost data storage when the data is not required to be
+accessed on-chain.
 
-Link to provider.getLogs and contract.on
+These can be used in conjunction with the [Provider Events API](Provider--event-methods)
+and with the [Contract Events API](Contract--events).
 
-_heading: Filters
+The Contract Events API also provides [higher-level methods](Contract--filters)
+to compute and query this data, which should be preferred over the lower-level filter.
 
-Filter are used as a way to query ... efficient, explain bloom filters lightly
+_heading: Filters @<events--filters>
 
-A filter may have up to 4 topic-sets, where each topic-set refers
-to a condition that must match the log topic in that position (i.e. each
-condition is ``AND``-ed together).
+When a Contract creates a log, it can include up to 4 pieces of
+data to be indexed by. The indexed data is hashed and included in
+a [[link-wiki-bloomfilter]], which is a data structure that allows
+for efficient filtering.
 
-If a topic-set is ``null``, a log topic in that position is not filtered
+So, a filter may correspondingly have up to 4 topic-sets, where each
+topic-set refers to a condition that must match the indexed log topic
+in that position (i.e. each condition is ``AND``-ed together).
+
+If a topic-set is ``null``, a log topic in that position is **not filtered**
 at all and **any value** matches.
 
-If a topic-set is a single topic, a log topic in that position must match
+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).
 
+This may sound complicated at first, but is more easily understood with
+some examples.
 
 _table: Example Log Matching @style<full>
 
@@ -51,13 +57,11 @@ $TopicABaCD: **[** (topic[0] = A) **OR** (topic[0] = B) **]** **AND**
 
 _code: ERC-20 Transfer Filter Examples @lang<javascript>
 
-// <hide>
-const tokenAddress = ethers.constants.AddressZero;
-const myAddress = ethers.constants.AddressZero;
-const myOtherAddress = ethers.constants.AddressZero;
-const id = ethers.utils.id;
-const hexZeroPad = ethers.utils.hexZeroPad;
-// </hide>
+//_hide: const tokenAddress = ethers.constants.AddressZero;
+//_hide: const myAddress = ethers.constants.AddressZero;
+//_hide: const myOtherAddress = ethers.constants.AddressZero;
+//_hide: const id = ethers.utils.id;
+//_hide: const hexZeroPad = ethers.utils.hexZeroPad;
 
 // Short example of manually creating filters for an ERC-20
 // Transfer event.
@@ -87,33 +91,33 @@ const hexZeroPad = ethers.utils.hexZeroPad;
 filter = {
     address: tokenAddress,
     topics: [
-        id("Transfer(address,address,uint256)"),
+        utils.id("Transfer(address,address,uint256)"),
         hexZeroPad(myAddress, 32)
     ]
-}
+};
 
 // List all token transfers  *to*  myAddress:
 filter = {
     address: tokenAddress,
     topics: [
-        id("Transfer(address,address,uint256)"),
+        utils.id("Transfer(address,address,uint256)"),
         null,
         hexZeroPad(myAddress, 32)
     ]
-}
+};
 
 // List all token transfers  *to*  myAddress or myOtherAddress:
 filter = {
     address: tokenAddress,
     topics: [
-        id("Transfer(address,address,uint256)"),
+        utils.id("Transfer(address,address,uint256)"),
         null,
         [
             hexZeroPad(myAddress, 32),
             hexZeroPad(myOtherAddress, 32),
         ]
     ]
-}
+};
 
 _null:
 
@@ -122,35 +126,87 @@ To simplify life, ..., explain here, the contract API
 
 _code: ERC-20 Contract Filter Examples @lang<javascript>
 
-// <hide>
-const tokenAddress = "0x6B175474E89094C44Da98b954EedeAC495271d0F"; // DAI
-const myAddress = "0x8ba1f109551bD432803012645Ac136ddd64DBA72";
-const otherAddress = "0xEA517D5a070e6705Cc5467858681Ed953d285Eb9";
-const provider = ethers.getDefaultProvider();
-const Contract = ethers.Contract;
-// </hide>
+//_hide: const tokenAddress = "0x6B175474E89094C44Da98b954EedeAC495271d0F"; /* DAI */
+//_hide: const myAddress = "0x8ba1f109551bD432803012645Ac136ddd64DBA72";
+//_hide: const otherAddress = "0xEA517D5a070e6705Cc5467858681Ed953d285Eb9";
+//_hide: const provider = ethers.getDefaultProvider();
+//_hide: const Contract = ethers.Contract;
 
-const abi = [
+abi = [
   "event Transfer(address indexed src, address indexed dst, uint val)"
 ];
 
-const contract = new Contract(tokenAddress, abi, provider);
+contract = new Contract(tokenAddress, abi, provider);
 
 // List all token transfers *from* myAddress
+//_result:
 contract.filters.Transfer(myAddress)
-//!
+//_log:
 
 // List all token transfers *to* myAddress:
+//_result:
 contract.filters.Transfer(null, myAddress)
-//!
+//_log:
 
 // List all token transfers *from* myAddress *to* otherAddress:
+//_result:
 contract.filters.Transfer(myAddress, otherAddress)
-//!
+//_log:
 
 // List all token transfers *to* myAddress OR otherAddress:
+//_result:
 contract.filters.Transfer(null, [ myAddress, otherAddress ])
-//!
+//_log:
+
+
+_subsection: Solidity Topics @<events-solidity>
+
+This is a quick (and non-comprehensive) overview of how events are computed
+in Solidity.
+
+This is likely out of the scope for most developers, but may be interesting
+to those who want to learn a bit more about the underlying technology.
+
+Solidity provides two types of events, anonymous and non-anonymous. The
+default is non-anonymous, and most developers will not need to worry about
+anonymous events.
+
+For non-anonymous events, up to 3 topics may be indexed (instead of 4), since
+the first topic is reserved to specify the event signature. This allows
+non-anonymous events to always be filtered by their event signature.
+
+This topic hash is always in the first slot of the indexed data, and is
+computed by normalizing the Event signature and taking the keccak256 hash
+of it.
+
+For anonymous events, up to 4 topics may be indexed, and there is no
+signature topic hash, so the events cannot be filtered by the event
+signature.
+
+Each additional indexed property is processed depending on whether its
+length is fixed or dynamic.
+
+For fixed length types (e.g. ``uint``, ``bytes5``), all of which are
+internally exactly 32 bytes (shorter types are padded with zeros;
+numeric values are padded on the left, data values padded on the right),
+these are included directly by their actual value, 32 bytes of data.
+
+For dynamic types (e.g. ``string``, ``uint256[]``) , the value is hashed
+using keccak256 and this hash is used.
+
+Because dynamic types are hashed, there are important consequences in
+parsing events that should be kept in mind. Mainly that the original
+value is lost in the event. So, it is possible to tell is a topic is
+equal to a given string, but if they do not match, there is no way
+to determine what the value was.
+
+If a developer requires that a string value is required to be both
+able to be filtered and also able to be read, the value must be included
+in the signature twice, once indexed and once non-indexed (e.g.
+``someEvent(string indexed searchBy, string clearText)``).
+
+For a more detailed description, please refer to the
+[Solidity Event Documentation](link-solidity-events).
 
 _heading: Other Things? TODO
 

docs.wrm/concepts/index.wrm

@@ -1,13 +1,14 @@
 _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 fairly sparse at the moment, but will be expanded
+This section is sparse at the moment, but will be expanded
 as time goes on.
 
 _toc:
     events
     gas
     security
+    best-practices

docs.wrm/concepts/security/index.wrm

@@ -1,5 +1,82 @@
 _section: Security @<security>
 
+While security should be a concern for all developers, in the
+blockchain space developers must be additionally conscious of
+many areas which can be exploited.
+
+Once a problem has an economic incentives to exploit it, there
+is a much larger risk and with blockchain apps it can become
+quite valuable to attack.
+
+In addition to many of the other security issues app developers
+may have to worry about, there are a few additional vectors
+that JavaScript developers should be aware of.
+
+_subsection: Side-Channel Attacks
+
+A [Side-Channel Attack](link-wiki-side-channel-attack) occurs
+when something orthogonal to the implementation of the algorithm
+used can be exploited to learn more about secure or private
+information.
+
+_heading: Released Data (Strings, Uint8Arrays, Buffers)
+
+In JavaScript, memory may not be securely allocated, or more
+importantly securely released.
+
+[Historically](https://github.com/nodejs/node/issues/4660),
+``new Buffer(16)`` would re-use old memory that had been
+released. This would mean that code running later, may have
+access to data that was discarded.
+
+As an example of the dangers, imagine if you had used a Buffer
+to store a private key, signed data and then returned from the
+function, allowing the Buffer to be de-allocated. A future
+function may be able to request a new Buffer, which would still
+have that left-over private key, which it could then use to
+steal the funds from that account.
+
+There are also many debugging tools and systems designed to
+assist developers inspect the memory contents of JavaScript
+programs. In these cases, any //private key// or //mnemonic//
+sitting in memory may be visible to other users on the system,
+or malicious scripts.
+
+_heading: Timing Attack
+
+Timing attacks allow a malicious user or script to determine
+private data through analysing how long an operation requires
+to execute.
+
+In JavaScript, //Garbage Collection// occurs periodically when the
+system determines it is required. Each JavaScript implementation
+is different, with a variety of strategies and and abilities.
+
+Most Garbage Collection requires "stopping the world", or pausing
+all code being executed while it runs. This adds a large delay
+to any code that was currently running.
+
+This can be exploited by attackers to "condition cause a delay".
+They will set up a scenario where the system is on the edge of
+needing to garbage collect, and call your code with two paths,
+a simple path and complex path. The simple path won't stir things
+up enough to cause a garbage collection, while the complex one
+will. By timing how long the code took to execute, they now know
+whether garbage collection occured and therefore whether the simple
+or complex path was taken.
+
+Advanced timing attacks are very difficult to mitigate in any
+garbage-collection-based language. Most libraries where this
+matters will hopefully mitigate this for you as much as possible,
+but it is still good to be aware of.
+
+_heading: General Concerns
+
+- [Cross-Site Scripting](link-wiki-xss)
+- [Cross-Site Request Forgery](link-wiki-csrf)
+- [Phishing](link-wiki-phishing)
+
+
 _subsection: Key Derivation Functions @<security--pbkdf>
 
 This is not specific to Ethereum, but is a useful technique
@@ -12,7 +89,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 +98,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,8 +127,8 @@ 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
-a progress bar makes a user feel like there time is not being //needlessly//
+is remaining. Additionally, using language like //"decrypting..."// in
+a progress bar makes a user feel like their time is not being //needlessly//
 wasted.
 
 _heading: Work-Arounds (not recommended)

docs.wrm/config.js

@@ -43,6 +43,8 @@ function getDefinitions(source) {
             if (depth === 3) {
                 add("var", node.name.escapedText, node.name.end);
             }
+        } else if (ts.isGetAccessorDeclaration(node)) {
+            add("getter", (lastClass + "." + node.name.text), node.name.end);
         }
         ts.forEachChild(node, (node) => { return visit(node, depth + 1); });
     }
@@ -54,7 +56,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) {
@@ -115,10 +117,14 @@ const getSourceUrl = (function(path, include, exclude) {
     }
 })("../packages/", new RegExp("packages/.*/src.ts/.*\.ts$"), new RegExp("/node_modules/|src.ts/.*browser.*"));
 
+let localSigner = null;
+
 function codeContextify(context) {
     const { inspect } = require("util");
     const ethers = context.require("./packages/ethers");
 
+    if (localSigner == null) { localSigner = ethers.Wallet.createRandom(); }
+
     context.ethers = ethers;
     context.BigNumber = ethers.BigNumber;
     context.constants = ethers.constants;
@@ -127,40 +133,88 @@ function codeContextify(context) {
     context.hexlify = ethers.utils.hexlify;
     context.hexValue = ethers.utils.hexValue;
     context.Wallet = ethers.Wallet;
-    context.provider = new ethers.providers.InfuraProvider();
+    context.provider = new ethers.providers.InfuraProvider("mainnet", "49a0efa3aaee4fd99797bfa94d8ce2f1");
+
+    // We use a local dev node for some signing examples, but want to
+    // resolve ENS names against mainnet; super hacky but makes the
+    // docs nicer (funded in _startup)
+    context.localProvider = new ethers.providers.JsonRpcProvider();
+    context.localSigner = localSigner.connect(context.localProvider);
+    context.localProvider.resolveName = context.provider.resolveName.bind(context.provider);
 
     context.BigNumber.prototype[inspect.custom] = function(depth, options) {
         return `{ BigNumber: ${JSON.stringify(this.toString()) } }`;
     }
 
+    context.createClass = function(name) {
+        let C = class{ }
+        Object.defineProperty(C, "name", { value: name })
+        return C;
+    }
+
 
     context._inspect = function(value, depth) {
+        if (toString.call(value) === '[object Error]') {
+            // Not an error from ethers...
+            if (ethers.utils.Logger.errors[value.code] == null) {
+                return `Error: ${ value.message }`;
+            }
+
+            // Trim the ethers errors down on their verbosity for the docs...
+            if (value.message) {
+                value.message = value.message.split(" (")[0];
+            }
+            value.stack = undefined;
+        }
+
         if (value && value.constructor && value.constructor.name === "Uint8Array") {
             return `Uint8Array [ ${ Array.prototype.join.call(value, ", ") } ]`;
         }
 
+        if (typeof(value) === "string" && value.indexOf("\n") >= 0) {
+           return "`" + value + "`";
+        }
+
         //return JSON.stringify(value);
         return inspect(value, {
             compact: false,
+            depth: null,
             breakLength: Infinity,
             sorted: true,
         });
     }
+
+    context._startup = async function() {
+        console.log("Startup");
+        const signer = context.localProvider.getSigner();
+        const tx = await signer.sendTransaction({
+            to: localSigner.address,
+            value: ethers.utils.parseEther("10.0")
+        });
+        await tx.wait();
+    }
+
+    context._shutdown = function() {
+        console.log("Shutdown");
+    }
 }
 
 
 module.exports = {
   title: "ethers",
-  subtitle: "v5.0-beta",
+  subtitle: "v5.4",
+  description: "Documentation for ethers, a complete, tiny and simple Ethereum library.",
   logo: "logo.svg",
 
+  socialImage: "social.jpg",
+
   prefix: "/v5",
 
-  link: "https:/\/docs-beta.ethers.io",
+  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,
@@ -170,23 +224,40 @@ module.exports = {
   codeRoot: "../",
 
   externalLinks: {
+      "link-mail": "mailto:me@ricmoo.com",
       "link-alchemy": { name: "Alchemy", url: "https:/\/alchemyapi.io" },
+      "link-ankr": { name: "Ankr", url: "https:/\/www.ankr.com" },
       "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": { 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-metamask": { name: "MetaMask", url: "https:/\/metamask.io/" },
+      "link-otto": "https:/\/github.com/robertkrimen/otto",
       "link-parity": { name: "Parity", url: "https:/\/www.parity.io" },
+      "link-pocket": { name: "Pocket Network", url: "https:/\/pokt.network" },
+      "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-solidity": { name: "Solidity" , url: "https:/\/solidity.readthedocs.io/" },
+      "link-solidity-errors": "https:/\/docs.soliditylang.org/en/v0.8.4/abi-spec.html#errors",
+      "link-solidity-events": "https:/\/docs.soliditylang.org/en/v0.8.4/abi-spec.html#events",
       "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-ankr-public": "https:/\/www.ankr.com/protocol/public/",
+      "link-ankr-premium": "https:/\/www.ankr.com/protocol/plan/",
+      "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-pocket-signup": "https:/\/pokt.network/pocket-gateway-ethereum-mainnet/",
+
       "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",
@@ -197,6 +268,11 @@ module.exports = {
       "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",
 
       "link-web3": "https:/\/github.com/ethereum/web3.js",
@@ -215,42 +291,60 @@ module.exports = {
 
       "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-js": "https:/\/cdn.ethers.io/lib/ethers-5.1.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": { name: "EIP-609", url: "https:/\/eips.ethereum.org/EIPS/eip-609" },
+      "link-eip-634": { name: "EIP-634", url: "https:/\/eips.ethereum.org/EIPS/eip-634" },
+      "link-eip-712": { name: "EIP-712", url: "https:/\/eips.ethereum.org/EIPS/eip-712" },
       "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-1559": { name: "EIP-1559", url: "https:/\/eips.ethereum.org/EIPS/eip-1559" },
+      "link-eip-1577": { name: "EIP-1577", url: "https:/\/eips.ethereum.org/EIPS/eip-1577" },
       "link-eip-2098": { name: "EIP-2098", url: "https:/\/eips.ethereum.org/EIPS/eip-2098" },
+      "link-eip-2304": { name: "EIP-2304", url: "https:/\/eips.ethereum.org/EIPS/eip-2304" },
+      "link-eip-2718": { name: "EIP-2718", url: "https:/\/eips.ethereum.org/EIPS/eip-2718" },
+      "link-eip-2930": { name: "EIP-2930", url: "https:/\/eips.ethereum.org/EIPS/eip-2930" },
       "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-bip-44": { name: "BIP-44", url: "https:/\/en.bitcoin.it/wiki/BIP_0044" },
 
       "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-get-random-values": { name: "React Native get-random-values", url: "https:/\/www.npmjs.com/package/react-native-get-random-values" },
 
       "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-cors": { name: "CORS", url: "https:/\/developer.mozilla.org/en-US/docs/Web/HTTP/CORS" },
+
       "link-ricmoo-humanreadableabi": "https:/\/blog.ricmoo.com/human-readable-contract-abis-in-ethers-js-141902f4d917",
 
+      "link-other-ethereum-dev-docs": "https:/\/ethereum.org/en/developers/docs/",
+
       "link-wiki-basicauth": { name: "Basic Authentication", url: "https:/\/en.wikipedia.org/wiki/Basic_access_authentication" },
       "link-wiki-backoff": { name: "Exponential Backoff", url: "https:/\/en.wikipedia.org/wiki/Exponential_backoff" },
       "link-wiki-bloomfilter": { name: "Bloom Filter", url: "https:/\/en.wikipedia.org/wiki/Bloom_filter" },
       "link-wiki-bruteforce": "https:/\/en.wikipedia.org/wiki/Brute-force_attack",
       "link-wiki-cryptographichash": "https:/\/en.wikipedia.org/wiki/Cryptographic_hash_function",
+      "link-wiki-csrf": "https:/\/en.wikipedia.org/wiki/Cross-site_request_forgery",
       "link-wiki-ecrecover": { name: "ECDSA Public Key Recovery", url: "https:/\/en.wikipedia.org/wiki/Elliptic_Curve_Digital_Signature_Algorithm#Public_key_recovery" },
       "link-wiki-homoglyph": "https:/\/en.wikipedia.org/wiki/IDN_homograph_attack",
       "link-wiki-hmac": "https:/\/en.wikipedia.org/wiki/HMAC",
       "link-wiki-iban": "https:/\/en.wikipedia.org/wiki/International_Bank_Account_Number",
       "link-wiki-ieee754": "https:/\/en.wikipedia.org/wiki/Double-precision_floating-point_format",
+      "link-wiki-observer-pattern": { name: "Observer Pattern", url: "https:/\/en.wikipedia.org/wiki/Observer_pattern" },
+      "link-wiki-phishing": "https:/\/en.wikipedia.org/wiki/Phishing",
       "link-wiki-ripemd": "https:/\/en.m.wikipedia.org/wiki/RIPEMD",
       "link-wiki-sha2": "https:/\/en.wikipedia.org/wiki/SHA-2",
       "link-wiki-twoscomplement": "https:/\/en.wikipedia.org/wiki/Two%27s_complement",
@@ -258,9 +352,11 @@ module.exports = {
       "link-wiki-utf8-overlong": "https:/\/en.wikipedia.org/wiki/UTF-8#Overlong_encodings",
       "link-wiki-utf8-replacement": "https:/\/en.wikipedia.org/wiki/Specials_%28Unicode_block%29#Replacement_character",
       "link-wiki-scrypt": "https:/\/en.wikipedia.org/wiki/Scrypt",
+      "link-wiki-side-channel-attack": "https:/\/en.wikipedia.org/wiki/Side-channel_attack",
       "link-wiki-sha3": "https:/\/en.wikipedia.org/wiki/SHA-3",
       "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" },
+      "link-wiki-xss": "https:/\/en.wikipedia.org/wiki/Cross-site_scripting",
   },
 };

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.
@@ -7,7 +7,7 @@ Many things are the way they are for good (at the time, at least) reasons,
 but I always welcome criticism, and am completely willing to have my mind
 changed on things.
 
-So, pull requests are always welcome, but please keep a few points in mind:
+Pull requests are always welcome, but please keep a few points in mind:
 
 - Backwards-compatibility-breaking changes will not be accepted; they may be
   considered for the next major version
@@ -15,60 +15,209 @@ So, pull requests are always welcome, but please keep a few points in mind:
   arguments as to why
 - The library aims to be lean, so keep an eye on the dist/ethers.min.js
   file size before and after your changes
+- Keep the PR simple and readable; only modify files in the ``docs.wrm/``
+  and ``packages/*/src.ts/`` folders, as this allows the changes to be easily
+  verified
 - Add test cases for both expected and unexpected input
 - Any new features need to be supported by me (future issues, documentation,
   testing, migration), so anything that is overly complicated or specific
   may not be accepted
 
 In general, **please start an issue //before// beginning a pull request**, so we can
-have a public discussion and figure out the best way to address to problem/feature.
+have a public discussion and figure out the best way to address the problem/feature.
 **:)**
 
 
-_subsection: Building
+_subsection: Building @<contributing--building>
 
-If you wish to modify the source code, there are a few steps involved in setting up
-your environment.
+The build process for ethers is unfortunatly not super trivial, but
+I have attempted to make it as straightforward as possible.
 
-_code: Preparing the Package @lang<shell>
+It is a mono-repo which attempts to be compatibile with a large
+number of environments, build tools and platforms, which is why
+there are a some weird things it must do.
+
+There are several custom scripts in the ``misc/admin`` folder
+to help manage the monorepo. Developers working on contributing
+to ethers should not generally need to worry about those, since
+they are wrapped up behind ``npm run SCRIPT`` operations.
+
+_code: Installing @lang<shell>
+
+# Clone the repository
+/home/ricmoo> git clone https://github.com/ethers-io/ethers.js.git
 
-# Clone the REPO
-/home/ricmoo> git clone git@github.com:ethers-io/ethers.js.git
 /home/ricmoo> cd ethers.js
 
-# Install the base dependencies
+# Install all dependencies:
+# - Hoists all sub-package dependencies in the package.json (preinstall)
+# - Installs all the (hoisted) dependencies and devDependencies (install)
+# - Build the rat-nests (in .package_node_modules) (postinstall)
+# - Create a dependency graph for the TypeScript (postinstall)
+# - Link the rat-nets into each project (postinstall)
 /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
+_heading: Making Changes @<contributing--updating>
 
+Once your environment is set up, you should be able to simply
+start the ``auto-build`` feature, and make changes to the
+TypeScript source.
 
 _code: Watching and Building @lang<shell>
 
 # Begin watching the files and re-building whenever they change
 /home/ricmoo/ethers.js> npm run auto-build
 
+# Or if you do not want to watch and just build
+/home/ricmoo/ethers.js> npm run build
 
-# Sometimes the issue only affects the ESM modules
-/home/ricmoo/ethers.js> npm run auto-build-esm
+_heading: Creating Browser-Ready Files
 
+To create files for use directly in a browser, the distribution
+files (located in ``packages/ethers/dist``) need to be built
+which requires several intermediate builds, scripts and for
+various rollup scripts to execute.
 
-# 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: Building Distribution Files @lang<shell>
 
+# If you need to rebuild all the libs (esm + cjs) and dist files
+# Note: this requires node 10 or newer
+/home/ricmoo/ethers.js> npm run build-all
+
+_heading: Testing
 
 _code: Testing @lang<shell>
 
-# Rebuilds all files and bundles testcases up for testing
+# Rebuilds all files (npm run build-all) 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
+/home/ricmoo/ethers.js> npm run test-node
 
+_heading: Distribution
+
+Most developers should not ever require this step, but for people
+forking ethers and creating alternates (for example if you have
+a non-EVM compatible chain but are trying to reuse this package).
+
+This script will rebuild the entire ethers project, compare it
+against npm, re-write package versions, update internal hashes,
+re-write various TypeScript files (to get around some ES+TS
+limitations for Tree Shaking and linking), re-write map files,
+bundle stripped versions of dependencies and basically just a
+whole bunch of stuff.
+
+If you use this and get stuck, [message me](link-mail).
 
 _code: Preparing the Distribution @lang<shell>
 
+# Prepare all the distribution files
+# - Remove all generated files (i.e. npm run clean)
+# - Re-install all dependencies, hoisting, etc. (npm install)
+# - Spell check all strings in every TypeScript files
+# - Build everything from scratch with this clean install
+# - Compare local with npm, bumping the version if changed
+# - Build everything again (with the updated versions)
+# - Update the CHANGELOG.md with the git history since the last change
 /home/ricmoo/ethers.js> npm run update-version
 
+_note: Do NOT check in dist files in a PR
+
+For Pull Requests, please ONLY commit files in the ``docs.wrm/`` and
+``packages/*/src.ts/`` folders. I will prepare the distribution builds
+myself and keeping the PR relevant makes it easier to verify the changes.
+
+_heading: Publishing
+
+Again, this should not be necessary for most developers. This step
+requires using the ``misc/admin/cmds/config-set`` script for a number
+of values, including private keys, NPM session keys, AWS access keys,
+GitHub API tokens, etc.
+
+The config file is encrypted with about 30 seconds of scrypt password-based
+key derivation function, so brute-forcing the file is quite expensive.
+
+The config file also contains a plain-text mnemonic. This is a money-pot.
+Place a tempting amount of ether or Bitcoin on this account and set up an
+e-mail alert for this account.
+
+If any attacker happens across your encrypted config, they will have instant
+access to the plain-text mnemonic, so they have the option to immediately
+steal the ether (i.e. the responsible-disclosure bond).
+
+If you ever see this ether taken, your encrypted file is compromised! Rotate
+all your AWS keys, NPM session keys, etc. immedately.
+
+@TODO: document all the keys that need to be set for each step
+
+_code: Preparing the Distribution @lang<shell>
+
+# Publish
+# - Update any changed packages to NPM
+# - Create a release on GitHub with the latest CHANGELOG.md description
+# - Upload the bundled files the the CDN
+# - Flush the CDN edge caches
+/home/ricmoo/ethers.js> npm run publish-all
+
+
+_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 consistency; 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,10 @@
 _section: Cookbook
 
-Cooking...
+A collection (that will grow over time) of common, simple
+snippets of code that are in general useful.
 
+_toc:
+
+  react-native
+  transactions
 

docs.wrm/cookbook/react-native.wrm

@@ -0,0 +1,60 @@
+_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 possibly guess, allowing funds to be stolen and assets
+manipulated.
+
+For this reason, it is **HIGHLY RECOMMENDED** to also install the
+[[link-npm-react-native-get-random-values]], which **must** be included
+before the shims. If it worked correctly you should not receive any
+warning in the console regarding missing secure random sources.
+
+_code: Importing with Secure Random Sources @lang<script>
+
+// Import the crypto getRandomValues shim (**BEFORE** the shims)
+import "react-native-get-random-values"
+
+// Import the the ethers shims (**BEFORE** ethers)
+import "@ethersproject/shims"
+
+// Import the ethers library
+import { ethers } from "ethers";

docs.wrm/cookbook/transactions.wrm

@@ -0,0 +1,24 @@
+_section: Transactions @<cookbook--transactions>
+
+_subsection: Compute the raw transaction @<cookbook--compute-raw-transaction>
+
+_code: @lang<javascript>
+
+function getRawTransaction(tx) {
+  function addKey(accum, key) {
+    if (tx[key]) { accum[key] = tx[key]; }
+    return accum;
+  }
+
+  // Extract the relevant parts of the transaction and signature
+  const txFields = "accessList chainId data gasPrice gasLimit maxFeePerGas maxPriorityFeePerGas nonce to type value".split(" ");
+  const sigFields = "v r s".split(" ");
+
+  // Seriailze the signed transaction
+  const raw = utils.serializeTransaction(txFields.reduce(addKey, { }), sigFields.reduce(addKey, { }));
+
+  // Double check things went well
+  if (utils.keccak256(raw) !== tx.hash) { throw new Error("serializing failed!"); }
+
+  return raw;
+}

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>
@@ -218,58 +219,64 @@ for displaying code samples.
 
 _heading: JavaScript Evaluation @<flatworm--code-eval>
 
-For JavaScript files, the file is executed with some simple substitution.
+For JavaScript files, the file is transpiled and executed in a VM,
+allowiung output (or exceptions) of blocks to be included in the
+fragment output.
 
-A bare ``\/\/!`` on a line is replaced with the result of the last
-statement. Building will fail if an error is thrown.
+The entire **code fragment** source is included in an async IIFE,
+whick means ``await`` is allowed, and several special comment
+directives are allowed.
 
-A bare ``\/\/!error`` is replaced with the throw error. Building will
-fail if an error is not thrown.
+A ``/\/_hide:`` will include any following code directly into the
+output, but will not include it in the generated output for the fragment.
 
-Also any code included between the lines **``\/\/ <hide>``** and
-**``\/\/ </hide>``** will be omitted from the output, which can be used
-to setup variables.
+A ``/\/_log:`` will include the value of any following expression in the
+output, prefixed with a ``/\/ ``. Renderers will mark output in different
+style if possible.
+
+A ``/\/_result:`` will begin a block, assigning the contents to ``_``. The
+block can be ended with a ``/\/_log:`` or ``/\/_null:``, if no value is given
+to log, then ``_`` is assumed. If an error occurs, generation fails.
+
+A ``/\/_throws:`` will begin a block, which is expected to throw assigning
+the error to ``_``. The block can be ended with a ``/\/_log:`` or ``/\/_null:``,
+if no value is given to log, then ``_`` is assumed. If an error do not occur,
+generation fails.
 
 _code: Code Evaluation Example @lang<text>
 
 \_code: Result of Code Example  @lang<javascript>
 
-// <hide>
-const url = require("url");
-// </hide>
+//_hide: const url = require("url");
 
+//_result:
 url.parse("https://www.ricmoo.com/").protocol
-//!
+//_log:
 
+//_throws:
 url.parse(45)
-//! error
+//_log:
 
 // You want to assign (doesn't emit eval) AND display the value
 const foo = 4 + 5;
-// <hide>
-foo
-// </hide>
-//!
+//_log: foo
 
 
 _code: Result of Code Example  @lang<javascript>
 
-// <hide>
-const url = require("url");
-// </hide>
+//_hide: const url = require("url");
 
+//_result:
 url.parse("https://www.ricmoo.com/").protocol
-//!
+//_log:
 
+//_throws:
 url.parse(45)
-//! error
+//_log:
 
 // You want to assign (doesn't emit eval) AND display the value
 const foo = 4 + 5;
-// <hide>
-foo
-// </hide>
-//!
+//_log: foo
 
 
 _heading: Languages
@@ -279,7 +286,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,8 +385,8 @@ _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
-name must being with a letter and must only contain letters and numbers.
+separately within a table directive using **variables**. A variable
+name must begin with a letter and must only contain letters and numbers.
 
 Variables are also useful when content is repeated throughout a table.
 

docs.wrm/getting-started.wrm

@@ -3,14 +3,14 @@ _section: Getting Started @<getting-started>
 
 _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)
 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 @<importing>
@@ -32,20 +32,22 @@ 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.2.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>
+<script src="https://cdn.ethers.io/lib/ethers-5.2.umd.min.js"
+        type="application/javascript"></script>
 
 
 _subsection: Common Terminology @<getting-started--glossary>
@@ -62,8 +64,8 @@ $Signer:    A Signer is a class which (usually) in some way directly or
             and transactions to authorize the network to charge your account
             ether to perform operations.
 $Contract:  A Contract is an abstraction which represents a connection to a
-            specific contract on the Ethereum Network, so that it can be
-            used like a normal JavaScipt object.
+            specific contract on the Ethereum Network, so that applications 
+            can use it like a normal JavaScript object.
 
 
 | **Provider**     | $Provider      |
@@ -71,52 +73,79 @@ $Contract:  A Contract is an abstraction which represents a connection to a
 | **Contract**     | $Contract      |
 
 
-_subsection: Connecting to Ethereum: Metamask @<getting-started--connecting>
+_subsection: Connecting to Ethereum: MetaMask @<getting-started--connecting>
 
 The quickest and easiest way to experiment and begin developing on
 Ethereum is to use [[link-metamask]], which is a browser extension
 that provides:
 
 - A connection to the Ethereum network (a [[Provider]])
-- Holds your private key and can sign thing (a [[Signer]])
+- Holds your private key and can sign things (a [[Signer]])
 
-_code: Connecting to Metamask @lang<script>
+_code: Connecting to MetaMask @lang<script>
 
 // A Web3Provider wraps a standard Web3 provider, which is
-// what Metamask injects as window.ethereum into each page
+// 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
+// MetaMask requires requesting permission to connect users accounts
+await provider.send("eth_requestAccounts", []);
+
+// 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 things (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 can be used to query the current state, fetch historic
+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()
-//!
+//_result:
+await provider.getBlockNumber()
+//_log:
 
-// Get the balance of an account (by address or ENS name)
+// Get the balance of an account (by address or ENS name, if supported by network)
+//_result:
 balance = await provider.getBalance("ethers.eth")
-//! async balance
+//_log:
 
-// Often you will need to format the output for the user
-// which prefer to see values in ether (instead of wei)
+// Often you need to format the output to something more user-friendly,
+// such as in ether (instead of wei)
+//_result:
 ethers.utils.formatEther(balance)
-//!
+//_log:
 
-// Or if a user enters a string in an input field, you may need
+// 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)
+//_result:
 ethers.utils.parseEther("1.0")
-//!
+//_log:
 
 
 _heading: Writing to the Blockchain @<getting-started--sending>
@@ -136,37 +165,36 @@ A Contract is an abstraction of program code which lives on the
 Ethereum blockchain.
 
 The [[Contract]] object makes it easier to use an on-chain
-Contract as a normal JavaScript object, with the method all
+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 ORM.
+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)
+decode the data, which is what the //Application Binary Interface// (ABI)
 provides.
 
-This class is a meta-class, which means its methods are constructed
-at runtime, when you pass in the ABI to the constructor it uses that
+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 a on-chain Contract may have many methods available, you can safely ignore
+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 may also be
-placed in the code easily using the Human-Readable ABI, which the following
-examples use.
+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>
 
-// We can use an ENS name for the contract address
+// 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 simple details about the token
+  // Some details about the token
   "function name() view returns (string)",
   "function symbol() view returns (string)",
 
@@ -183,38 +211,33 @@ const daiAbi = [
 // The Contract object
 const daiContract = new ethers.Contract(daiAddress, daiAbi, provider);
 
+//_hide: _page.daiAbi = daiAbi;
+//_hide: _page.daiContract = daiContract;
 
 _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>
+//_hide: const daiContract = _page.daiContract;
 
 // Get the ERC-20 token name
-daiContract.name()
-//!
+//_result:
+await daiContract.name()
+//_log:
 
-// Get the ERC-20 token synbol (for tickers and UIs)
-daiContract.symbol()
-//!
+// Get the ERC-20 token symbol (for tickers and UIs)
+//_result:
+await daiContract.symbol()
+//_log:
 
 // Get the balance of an address
 balance = await daiContract.balanceOf("ricmoo.firefly.eth")
-//! async balance
+//_log: balance
 
 // Format the DAI for displaying to the user
+//_result:
 ethers.utils.formatUnits(balance, 18)
-//!
+//_log:
 
 
 _heading: State Changing Methods @<getting-started--writing>
@@ -222,8 +245,8 @@ _heading: State Changing Methods @<getting-started--writing>
 _code: Sending DAI @lang<script>
 
 // The DAI Contract is currently connected to the Provider,
-// which is read-only. We need to connect to a Signer, so
-// that we can pay to send state-changing transactions.
+// 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
@@ -237,13 +260,8 @@ _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>
+//_hide: const daiContract = _page.daiContract;
+//_hide: const formatEther = ethers.utils.formatEther;
 
 // Receive an event when ANY transfer occurs
 daiContract.on("Transfer", (from, to, amount, event) => {
@@ -256,10 +274,7 @@ daiContract.on("Transfer", (from, to, amount, event) => {
 // A filter for when a specific address receives tokens
 myAddress = "0x8ba1f109551bD432803012645Ac136ddd64DBA72";
 filter = daiContract.filters.Transfer(null, myAddress)
-// <hide>
-filter
-// </hide>
-//!
+//_log: filter
 
 // Receive an event when that filter occurs
 daiContract.on(filter, (from, to, amount, event) => {
@@ -267,73 +282,55 @@ daiContract.on(filter, (from, to, amount, event) => {
     console.log(`I got ${ formatEther(amount) } from ${ from }.`);
 });
 
-// <hide>
-// Don't want to block the docs from compiling...
-daiContract.removeAllListeners();
-// </hide>
+//_hide: daiContract.removeAllListeners(); /* Don't want to block the docs from compiling... */
 
 
 _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>
+//_hide: const signer = new ethers.VoidSigner("0x8ba1f109551bD432803012645Ac136ddd64DBA72");
+//_hide: const daiContract = _page.daiContract;
 
 // 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>
-//!
+//_log: myAddress
 
 // Filter for all token transfers from me
-filterTo = daiContract.filters.Transfer(null, myAddress);
-// <hide>
-filterTo
-// </hide>
-//!
+filterFrom = daiContract.filters.Transfer(myAddress, null);
+//_log: filterFrom
 
-// List all transfers sent from me a specific block range
-daiContract.queryFilter(filterFrom, 9843470, 9843480)
-//!
+// Filter for all token transfers to me
+filterTo = daiContract.filters.Transfer(null, myAddress);
+//_log: filterTo
+
+// List all transfers sent from me in a specific block range
+//_result:
+await daiContract.queryFilter(filterFrom, 9843470, 9843480)
+//_log:
 
 //
 // The following have had the results omitted due to the
 // number of entries; but they provide some useful examples
 //
 
-// List all transfers I sent in the last 10,000 blocks
-daiContract.queryFilter(filterFrom, -10000)
+// List all transfers sent in the last 10,000 blocks
+await daiContract.queryFilter(filterFrom, -10000)
 
 // List all transfers ever sent to me
-daiContract.queryFilter(filterTo)
-
+await daiContract.queryFilter(filterTo)
 
 _subsection: Signing Messages @<getting-started--signing>
 
 _code: Signing Messages @lang<javascript>
 
-// <hide>
-const signer = ethers.Wallet.createRandom();
-//!
-// </hide>
+//_hide: const signer = ethers.Wallet.createRandom();
 
-// To sign a simple string, which can often be used for
-// logging into a service, such as CryptoKitties simply
+// 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
+//_log: signature
 
 //
 // A common case is also signing a hash, which is 32
@@ -341,13 +338,13 @@ signature = await signer.signMessage("Hello World");
 // data it MUST be an Array (or TypedArray)
 //
 
-// This string is 66 chacacters long
+// This string is 66 characters long
 message = "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef"
 
 // This array representation is 32 bytes long
 messageBytes = ethers.utils.arrayify(message);
-//!
+//_log: messageBytes
 
 // To sign a hash, you most often want to sign the bytes
 signature = await signer.signMessage(messageBytes)
-//! async signature
+//_log: signature

docs.wrm/index.wrm

@@ -5,7 +5,7 @@ _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 @<features>
 
@@ -38,12 +38,14 @@ _toc:
 
     getting-started
     concepts
+    api-keys
     api
     cli
     cookbook
     migration
     testing
     contributing
+    other-resources
     documentation
     license
 

docs.wrm/license.wrm

@@ -7,7 +7,7 @@ of uses.
 
 _heading: MIT License
 
-//Copyright © 2019 [Richard Moore](mailto:me@ricmoo.com).//
+//Copyright © 2019-2021 [Richard Moore](mailto:me@ricmoo.com).//
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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 to [[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 contract.
+
+_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/other-resources.wrm

@@ -0,0 +1,17 @@
+_section: Other Resources
+
+There is a lot of documentation on the internet to help you get started,
+learn more or cover advanced topics. Here are a few resources to check out.
+
+_subsection: Ethereum Overview
+
+- Official [Ethereum Developer Documentations](link-other-ethereum-dev-docs)
+- The [Solidity Documentation](link-solidity), the defactor language for smart
+  contracts as well as a resource for some of the core concepts of Ethereum
+
+_subsection: Tutorials
+
+I do not manage or maintain these tutorials, but have happened across them.
+If a link is dead or outdated, please [let me know](link-mail) and I'll update it.
+
+- [Alchemy - How to Mint an NFT](https://docs.alchemy.com/alchemy/tutorials/how-to-create-an-nft/how-to-mint-an-nft-with-ethers)

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 languages). 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
+across 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 straightforward 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.wrm/troubleshooting/building.wrm

@@ -0,0 +1,15 @@
+_section: Building @<troubleshooting-building>
+
+@TODO
+
+_subsection: Packages
+
+Sometimes packages get out of sync.
+
+_code:
+
+/home/ethers> rm package-lock.json node_modules/
+
+/home/ethers> rm yarn.lock
+
+/home/ethers> npm install

docs.wrm/troubleshooting/errors.wrm

@@ -0,0 +1,249 @@
+_section: Error Codes @<error-codes>
+
+All errors in ethers are created by the [[Logger]] class, which includes
+a number of additional properties and extra data, which can assist in
+debugging and when submitting issues.
+
+When submitting an issue, please include as much of any error as possible,
+but also make sure you understand the error and have tried suggested solutions
+both in this trouble-shooting document and any other issues you find when
+searching the GitHub issues.
+
+
+_subsection: CALL_EXCEPTION @<help-CALL_EXCEPTION>
+
+This error occurs when a call or transaction is used to interact with
+the blockchain reverts (via ``revert``, ``require``, et cetera).
+
+Due to the overall flexibility of Ethereum and Turing Completeness,
+there is a large variety of reasons this can occur and troubleshooting
+requires attention.
+
+
+_heading: Common Causes
+
+- The code does not exist on-chain. This may happen if you failed to wait
+  until the contract was deployed, the address is incorrect or if you
+  are connected to a different network than the contract has been deployed.
+  Check the code exists using ``provider.getCode(address)``.
+- The wrong code is being accessed, for example if an artifact file was
+  not correctly updated so an older instance of the contract is being called
+- The contract is failing during a ``require`` statement. For example, if
+  a contract method requires an //admin account// to be used, but the
+  contract is connected to another [[Signer]].
+- The wrong ABI is being used to interact with a contract.
+
+_heading: Debugging
+
+- Always double check the address and network you are connected to and use
+  ``provider.getCode(address)`` to verify the deployed code matches your
+  most recent version.
+- Try accessing other, simpler contract methods to verify the account is correct.
+
+
+_subsection: INSUFFICIENT_FUNDS @<help-INSUFFICIENT_FUNDS>
+
+This usually occurs when a transaction is attempted, but the sending account
+does not have enough ether to cover the cost of the transaction.
+
+A transaction has an intrinsic cost which must be met, which accounts for
+the value being sent, the base fee of the transaction, additional fees per byte
+of calldata and whether the transaction will create a new account (i.e. the ``to``
+is empty).
+
+This error can also happen if ``provider.estimateGas`` is used with a non-zero
+fee (i.e. ``gasPrice``, ``maxFeePerGas`` or ``maxPriorityFeePerGas``). If any
+fee properties are specified, the ``from`` account must have sufficient ether
+to execute the transaction.
+
+
+_subsection: MISSING_NEW @<help-MISSING_NEW>
+
+Classes in ethers must be instantiated with the ``new`` operator. This
+error indicates that a Class is attempting to be used as a function.
+
+_code: Examples @lang<javascript>
+
+//_hide: privateKey = "0x0123456789012345678901234567890123456789012345678901234567890123";
+//_hide: Wallet = ethers.Wallet;
+
+// Bad:
+//_throws:
+ethers.Wallet(privateKey)
+//_log:
+
+// Good:
+//_result:
+new ethers.Wallet(privateKey)
+//_log:
+
+
+_subsection: NONCE_EXPIRED @<help-NONCE_EXPIRED>
+
+This error occurs when a transaction is being sent with a ``nonce`` that
+is lower than next required ``nonce``.
+
+Each Ethereum transaction requires a ``nonce`` property equal to the index
+of that transaction for that account for all time. So, if an account has
+send four transactions over its lifetime, that means the nonces 0 though 3
+(inclusive) have been used. The next transaction must use a nonce of 4.
+Attempting to re-use a nonce less than 4 will result in this error.
+
+
+_subsection: NUMERIC_FAULT @<help-NUMERIC_FAULT>
+
+A [numeric fault](errors--numeric-fault) is a consequence of
+performing an illegal operation with numeric values, such as
+dividing by zero.
+
+The error will indicate the ``operation``, which further indicates
+the reason for the error.
+
+
+_heading: Overflow @<help-NUMERIC_FAULT-overflow>
+
+JavaScript uses [IEEE 754 double-precision binary floating point](link-wiki-ieee754)
+numbers to represent numeric values. As a result, there are //holes//
+in the integer set after 9,007,199,254,740,991; which is
+problematic for //Ethereum// because that is only around 0.009
+ether (in wei), which means any value over that will begin to
+experience rounding errors.
+
+As a result, any attempt to use a number which is outside the safe
+range, which would result in incorrect values, an error is thrown.
+
+In general, numbers should be kept as strings, [[BigNumber]] instances or
+using ES2020 bigints, which all can safely be used without loss of precission.
+
+_code: Examples @lang<javascript>
+
+// One ether is outside the safe range
+//_throws:
+BigNumber.from(1000000000000000000)
+//_log:
+
+// Providing the value as a string is safe
+//_result:
+BigNumber.from("1000000000000000000")
+//_log:
+
+// As is using a bigint (notice the `n` suffix)
+//_result:
+BigNumber.from(1000000000000000000n)
+//_log:
+
+// But most often, the `parseEther` function solves this
+//_result:
+utils.parseEther("1.0")
+//_log:
+
+
+_heading: Numeric Underflow @<help-NUMERIC_FAULT-underflow>
+
+Numeric underflow sbould not be confused with overflow.
+
+Numeric underflow occurs when the precission of a value cannot be
+safely represented in the current data type.
+
+**Common Causes**
+
+- Using values with fractional componets (e.g. ``BigNumber.from(1.2)``).
+  If you require fractions, you must use the [[FixedNumber]] class.
+- Parsing string values that have more decimals than the unit supports
+  (e.g. ``parseUints("1.33", 1)``).
+
+_code: Examples @lang<javascript>
+
+// BigNumbers cannot be created with a fractional component
+//_throws:
+BigNumber.from(1.2)
+//_log:
+
+// Parsing a value with more decimals than the type
+//_throws:
+utils.parseUnits("1.34", 1);
+//_log:
+
+
+_heading: Division by zero @<help-NUMERIC_FAULT-division-by-zero>
+
+This error occurs when dividing by zero or attempting to take the modulo zero.
+
+
+_heading: Unbound Result @<help-NUMERIC_FAULT-unbound-result>
+
+The ethers [[BigNumber]] does not support bitwise operators
+on negative numbers which can result in the need for an infinite
+number of set bits.
+
+Other implementations may use negative values to indicate this,
+but this is considered out of scope for ethers.
+
+
+_heading: Unsupported Operation @<help-NUMERIC_FAULT-unsupported>
+
+The ethers [[BigNumber]] does not support negative powers or bitwise
+shift operation using negative values.
+
+_code: Examples @lang<javascript>
+
+two = BigNumber.from(2);
+
+//_throws:
+two.pow(-2)
+//_log:
+
+// Cannot use negative values to alter shift direction
+//_throws:
+two.shr(-1)
+//_log:
+
+
+_subsection: REPLACEMENT_UNDERPRICED @<help-REPLACEMENT_UNDERPRICED>
+
+To prevent nodes from being overloaded with junk transactions, a transaction
+is only accepted into the memory pool if it has a reasonable chance of being
+actually mined, which means that the account has sufficient balance, the nonce
+is correct and the fee seems reasonable.
+
+Once a transaction is in the memory pool though, to prevent an account from
+flooding the network with many different transactions with the same nonce (each
+of which satisfies the above criteria), to replace an existing transaction
+an additional committment of a fee must be made by increasing the promised fee.
+
+When replacing a legacy non-EIP1559 transaction, the ``gasPrice`` must be
+increased. When replacing a modern, EIP-1559 transaction, the ``maxPriorityFeePerGas``
+should be increased.
+
+
+_subsection: TRANSACTION_REPLACED @<help-TRANSACTION_REPLACED>
+
+This error is thrown when waiting for a transaction which has been
+replaced by another, by the sender submitting a second transaction
+with the same nonce, while the transaction was pending in the
+transaction pool.
+
+You can learn more about this feature in the ``.wait`` method of
+[TransactionResponse](providers-TransactionResponse).
+
+
+_subsection: UNPREDICTABLE_GAS_LIMIT @<help-UNPREDICTABLE_GAS_LIMIT>
+
+During gas estimation it is possible that a transaction would actually
+fail (and hence has no reasonable estimate of gas requirements) or that
+the transaction is complex in a way that does not permit a node to
+estiamte the gas requirements, in which case this error is thrown.
+
+In almost all cases, this will unfortunately require you specify an
+explicit ``gasLimit`` for your transaction, which will disable ether's
+automatic population of the ``gasLimit`` field, which will cause this
+error to go away.
+
+To dial in an appropriate gas limit, try a value that is much higher
+than you expect, and then make a few transactions to discover reasonable
+values and then you can reduce this value down to that ballpark.
+
+Keep in mind this error can also occur if the transaction would
+legitimately fail, in which case the root cause must be addressed, such
+as ensuring the correct [[Signer]] is being used, the appropriate allowance
+for an ERC-20 token has been approved, etc.

docs.wrm/troubleshooting/help.wrm

@@ -0,0 +1,62 @@
+_section: Getting Help @<troubleshooting-issues>
+
+@TODO
+
+_subsection: Starting a discussion
+
+Before opening an issue
+
+
+_subsection: Opening an Issue
+
+Keep in mind that opening an issue should be a last resort, as it
+requires time and energy by the library developers to look at that
+could otherwise be spent on improving the library, documentation
+and tools.
+
+Before opening an issue, please make sure you have searched any
+public information, such as:
+
+- Documentation
+- GitHub Discussions
+- GitHub Issues (including closed issues)
+
+There are several types of issues tracked by ethers. Using the correct
+one helps you receive feedback quicker and helps us keep the right
+person 
+
+_heading: Feature Requests
+
+
+
+_heading: Bugs
+
+This type of issue is for anything you you believe to be a bug in ethers.
+
+Keep in mind that ethers is used extensively by thousands of people every
+day, so while chances are possible you found a bug, please make sure to
+do your due diligence to rule out user error.
+
+If you are new to ethers, or are doing a fairly common operation, it is
+quite likely what you are experiencing is a misunderstanding of how to
+use a function, method or class. You should consider opening a discussion first.
+
+
+Please make sure you include as much information as is useful:
+
+- Are you using a third-party library, like Hardhat or Truffle?
+- What platform are you on, a web browser, React Native, node, etc.?
+- What network are you on, such as Ethereum mainnet, Optimism, etc.?
+- What backend are you using, such as Geth, INFURA, Provider Engine, etc.?
+
+
+_heading: Docuementation
+
+If you have found a typo in the documentation, a feature which isn't
+documented (or documented well) or just find something described in
+the documentation confusing, please feel free to create an issue and
+we will try to improve it.
+
+_heading: Other
+
+This should never be used.