.github/FUNDING.yml

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

.github/ISSUE_TEMPLATE/bug-report-legacy.yml

@@ -0,0 +1,81 @@
+name: "Bug Report v5 (legacy)"
+description: "Open an issue for a bug in Ethers v5 (legacy)"
+title: "Add Bug Title Here"
+labels: [ "investigate", "v5" ]
+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**, specifically for the legacy v5 branch.
+
+        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: 5.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.org), 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)
+        - Altcoin - Please specify (e.g. Polygon)
+        - 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/bug-report.yml

@@ -0,0 +1,81 @@
+name: "Bug Report v6 (latest)"
+description: "Open an issue for a bug in Ethers v6 (latest)"
+title: "Add Bug Title Here"
+labels: [ "investigate", "v6" ]
+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: 6.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.org), 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)
+        - Altcoin - Please specify (e.g. Polygon)
+        - 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.org) 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/workflows/generate-docs.yml

@@ -0,0 +1,48 @@
+name: Generate Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "src.ts/**"
+      - "docs.wrm/**"
+
+jobs:
+  docs:
+    name: Generate Documentation
+
+    runs-on: ubuntu-latest
+
+    environment: ethers-tests
+    env:
+      FAUCET_PRIVATEKEY: ${{ secrets.FAUCET_PRIVATEKEY }}
+
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 20.x
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: "0"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Install Flatworm
+        run: npm install --no-save 'https://github.com/ricmoo/flatworm.git#tsdocs'
+
+      - name: Build Documentation
+        run: node node_modules/flatworm/lib/cli-test ./docs.wrm/config.mjs
+
+      - name: Upload documentation to to docs.ethers.org
+        uses: ethers-io/sync-s3-action@main
+        with:
+          aws_access_key_id: ${{ secrets.DOCS_AWS_ACCESS_KEY_ID }}
+          aws_secret_access_key: ${{ secrets.DOCS_AWS_SECRET_ACCESS_KEY}}
+          aws_s3_bucket: ethers.org
+          source_folder: 'output/docs/'
+          destination_prefix: 'docs/'
+          aws_cloudfront_id: ${{ secrets.DOCS_AWS_CLOUDFRONT_ID }}

.github/workflows/test-browser.yml

@@ -0,0 +1,46 @@
+name: Browser Tests
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "src.ts/**"
+      - "lib.esm/**"
+      - "lib.commonjs/**"
+      - "misc/test-browser/**"
+
+jobs:
+  test-browser:
+    name: Run Browser Tests
+
+    runs-on: ubuntu-latest
+
+    environment: ethers-tests
+
+    strategy:
+      fail-fast: false
+
+    steps:
+      - name: Install Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 20.x
+
+      - name: Install and run Geth
+        uses: ethers-io/run-geth-action@main
+
+      - name: Insall Chrome
+        run: wget -q 'https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb' && sudo dpkg --install google-chrome-stable_current_amd64.deb
+
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build browser bundles (from TypeScript)
+        run: npm run build-dist
+        
+      - name: Run tests
+        run: npm run test-browser

.github/workflows/test-ci.yml

@@ -0,0 +1,109 @@
+name: CI Tests
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "src.ts/**"
+      - "lib.esm/**"
+      - "lib.commonjs/**"
+
+jobs:
+
+  test-node:
+    #if: ${{ false }}  # disable for now
+
+    name: Run Node.js Tests
+
+    runs-on: ubuntu-latest
+
+    environment: ethers-tests
+    env:
+      FAUCET_PRIVATEKEY: ${{ secrets.FAUCET_PRIVATEKEY }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [ 18.x, 20.x ]
+        test-type: [ esm, commonjs ]
+
+    steps:
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install and run Geth
+        uses: ethers-io/run-geth-action@main
+
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build ESM and CommonJS (from TypeScript)
+        run: npm run build-all
+
+      - name: Run tests (${{ matrix.test-type }})
+        run: npm run test-${{ matrix.test-type }}
+
+
+  coverage:
+    #if: ${{ false }}  # disable for now
+
+    name: Generate Coverage Report
+
+    runs-on: ubuntu-latest
+
+    environment: ethers-tests
+    env:
+      FAUCET_PRIVATEKEY: ${{ secrets.FAUCET_PRIVATEKEY }}
+
+    continue-on-error: true
+
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 20.x
+
+      - name: Install and run Geth
+        uses: ethers-io/run-geth-action@main
+        
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build ESM (from TypeScript)
+        run: npm run build
+
+      - name: Run coverage tests
+        run: npm run test-coverage
+
+      - name: Store coverage summary artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: coverage-summary
+          path: ./output/summary.txt
+
+      - name: Tar coverage files
+        run: tar -cvf ./output/coverage.tar ./output/lcov-report/
+
+      - name: Store full coverage artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: coverage-complete
+          path: ./output/coverage.tar
+
+      - name: Upload coverage to build.ethers.org
+        uses: ethers-io/sync-s3-action@main
+        with:
+          aws_access_key_id: ${{ secrets.BUILD_AWS_ACCESS_KEY_ID }}
+          aws_secret_access_key: ${{ secrets.BUILD_AWS_SECRET_ACCESS_KEY}}
+          aws_s3_bucket: ethers.org
+          source_folder: 'output/'
+          destination_prefix: 'build/output/'
+          aws_cloudfront_id: ${{ secrets.BUILD_AWS_CLOUDFRONT_ID }}

.github/workflows/test-env.yml

@@ -0,0 +1,86 @@
+name: Environment Tests
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+
+  test-tsc-env:
+    name: Test TypeScript Environments
+
+    runs-on: ubuntu-latest
+
+    env:
+      npm_config_registry: http://localhost:8043
+
+    strategy:
+      fail-fast: false
+      matrix:
+        tsModuleResolution: [ "node", "node16", "nodenext" ]
+        tsModule: [ "commonjs", "es2020" ]
+
+    steps:
+      - name: Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 20.x
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          path: "faux_modules/ethers"
+
+      - name: Copy tests to working directory
+        run: cp -r faux_modules/ethers/testcases/test-env/test-tsc/* .
+
+      - name: Prepare setup moduleResolution=${{ matrix.tsModuleResolution }} module=${{ matrix.tsModule }}
+        run: node prepare.cjs ${{ matrix.tsModuleResolution }} ${{ matrix.tsModule }}
+
+      - name: Dump Config
+        run: cat package.json tsconfig.json
+
+      - name: Install and run Faux Registry
+        uses: ethers-io/hijack-npm-action@main
+
+      - name: Install packages
+        run: npm install
+
+      - name: Dump Faux Logs
+        run: cat .fauxNpm.log
+
+      - name: Run tests
+        run: npm test
+
+  test-angular:
+    name: Test Angular Environment
+
+    runs-on: ubuntu-latest
+
+    env:
+      npm_config_registry: http://localhost:8043
+
+    steps:
+      - name: Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 20.x
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          path: "faux_modules/ethers"
+
+      - name: Copy tests to working directory
+        run: cp -r faux_modules/ethers/testcases/test-env/angular/* .
+
+      - name: Install and run Faux Registry
+        uses: ethers-io/hijack-npm-action@main
+
+      - name: Install packages
+        run: npm install
+
+      - name: Build project
+        run: npm run build
+

.gitignore

@@ -1,20 +1,7 @@
-node_modules/
-obsolete/
-.DS_Store
-.tmp/
-dist/types/shims/
-shims/*.d.ts
+node_modules/**
+output/**
+
+**/*.save
 **/*.swp
-*~
-
-# Weird intermediate files tsc generates for references
-**/src.ts/*.js
-
-# Weird file Browserify sometimes leaves lying around.
-**/*.tmp-browserify-*
-
-lerna-debug.log
-
-packages/*/tsconfig.tsbuildinfo
-
-packages/testcases/input/nameprep/**
+**/*.tgz
+dist/*.gz

.npmignore

@@ -0,0 +1,31 @@
+
+# Ignore TypeScript config and caches
+tsconfig.*.json
+tsconfig.tsbuildinfo
+rollup.config.js
+output/**
+docs.wrm/**
+.github/**
+
+# Ignore admin scripts and files
+src.ts/_admin/**
+lib.commonjs/_admin/**
+lib.esm/_admin/**
+types/_admin/**
+reporter.cjs
+package-commonjs.json
+.github/workflows/test-ci.yml
+
+# Ignore test cases
+src.ts/_tests/**
+lib.commonjs/_tests/**
+lib.esm/_tests/**
+types/_tests/**
+testcases/**
+
+# Ignore random junk
+.DS_Store
+node_modules/**
+misc/**
+**/*.tgz
+dist/*.gz

.npmrc

@@ -0,0 +1 @@
+@tornado:registry=https://git.tornado.ws/api/packages/tornado-packages/npm/

CHANGELOG.md

@@ -1,174 +1,339 @@
-Changelog
-=========
+Change Log
+==========
 
-This change log is managed by `scripts/cmds/update-versions` but may be manually updated.
+This change log is maintained by `src.ts/_admin/update-changelog.ts` but may also be manually updated.
 
-ethers/v5.0.0-beta.156 (2019-09-06 17:56)
------------------------------------------
+ethers/v6.12.0 (2024-04-17 01:09)
+---------------------------------
 
-  - 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))
+  - Added Linea Sepolia network and Infura endpoint ([#4655](https://github.com/ethers-io/ethers.js/issues/4655); [b4aaab8](https://github.com/ethers-io/ethers.js/commit/b4aaab8d39fe47f8a1a296fa442f0856f84faf03)).
+  - Do not send unsubscribe messages to destroyed Providers ([#4678](https://github.com/ethers-io/ethers.js/issues/4678); [c45935e](https://github.com/ethers-io/ethers.js/commit/c45935e29ca0dd1ecdf1277fa1107246041be580)).
+  - Get definitive network from InfuraProvider when using InfuraWebSocketProvider ([38e32d8](https://github.com/ethers-io/ethers.js/commit/38e32d82145eb289e5179f9b6b11f4a9225a7022)).
+  - Better error messages for transaction field mismatch ([#4659](https://github.com/ethers-io/ethers.js/issues/4659); [9230aa0](https://github.com/ethers-io/ethers.js/commit/9230aa0b9a88b5241915a8d6afa8a522d35abd5d)).
+  - Added prevRandao to block ([#3372](https://github.com/ethers-io/ethers.js/issues/3372); [ec6a754](https://github.com/ethers-io/ethers.js/commit/ec6a754f0c8647dae59c73b2589225cb200d83dd)).
+  - Added Polygon Amoy testnet ([#4645](https://github.com/ethers-io/ethers.js/issues/4645); [1717abb](https://github.com/ethers-io/ethers.js/commit/1717abbf29a14a6f6b106e479fe9a5b1f8768dc4)).
+  - Added Chainstack provider ([#2741](https://github.com/ethers-io/ethers.js/issues/2741); [014004d](https://github.com/ethers-io/ethers.js/commit/014004d9402d7fd8c15553792cfb7a8a84ed327a)).
+  - Added deep convertion to Result for toObject and toArray ([#4681](https://github.com/ethers-io/ethers.js/issues/4681); [03bfe2a](https://github.com/ethers-io/ethers.js/commit/03bfe2a4f7b29b15cd90127974b7fc1d8b03edf9)).
+  - Added EIP-4844 broadcast support ([92bad88](https://github.com/ethers-io/ethers.js/commit/92bad88261a5d8a538535a7d5528162fe5010527)).
+  - Fix ignored throttle parameters ([#4663](https://github.com/ethers-io/ethers.js/issues/4663); [12772e9](https://github.com/ethers-io/ethers.js/commit/12772e9498b70f8538838f30e16f3792ea90e173)).
 
-ethers/v5.0.0-beta.155 (2019-08-22 17:11)
------------------------------------------
+ethers/v6.11.1 (2024-02-14 13:13)
+---------------------------------
 
-  - 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))
+  - Throw an error when attempting to derive from a master path from a non-master node ([#4551](https://github.com/ethers-io/ethers.js/issues/4551); [556fdd9](https://github.com/ethers-io/ethers.js/commit/556fdd91d9b6bf7db4041bb099e66b2080e1a985)).
+  - Allow ENS wildcards with labels up to 255 bytes wide; discussed with ENS and deemed safe ([#4543](https://github.com/ethers-io/ethers.js/issues/4543); [7f14bde](https://github.com/ethers-io/ethers.js/commit/7f14bdebf1aef6760462a1c2437c31f002b984fe)).
+  - Enforce string is passed to toUtf8Bytes ([#4583](https://github.com/ethers-io/ethers.js/issues/4583); [f45bb87](https://github.com/ethers-io/ethers.js/commit/f45bb87aefaf2c6c3a4991f6e30a81c227ae83c0)).
+  - Fix transaction.index not being populated on some backends ([#4591](https://github.com/ethers-io/ethers.js/issues/4591); [7f0e140](https://github.com/ethers-io/ethers.js/commit/7f0e140d5e3925a42e8bb2ac9eb1ba3fbd939864)).
 
-ethers/v5.0.0-beta.154 (2019-08-21 01:51)
------------------------------------------
+ethers/v6.11.0 (2024-02-08 20:26)
+---------------------------------
 
-  - 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))
+  - Allow transaction encoding for inferred type transactions ([f02211d](https://github.com/ethers-io/ethers.js/commit/f02211d055567b51373b5faa2c3dc6efe0523618)).
+  - Added EIP-4788, receipts root and state root fields to Block ([#4570](https://github.com/ethers-io/ethers.js/issues/4570); [c5f126f](https://github.com/ethers-io/ethers.js/commit/c5f126faf7d826b6a99df0ee578ff3d0ef409381)).
+  - Added EIP-4844 fields to Provider classes and formatter ([#4570](https://github.com/ethers-io/ethers.js/issues/4570); [7b4f2c1](https://github.com/ethers-io/ethers.js/commit/7b4f2c1a74db411829b5e8ef758bfa2ee21e5890)).
+  - Assert BrowserProvider receives an EIP-1193 provider to fail early when passing undefined ethereum object ([b69f43b](https://github.com/ethers-io/ethers.js/commit/b69f43bc6f35da881ca7a0c8ccc5fda92edd076d)).
+  - Add timeout to ContractTransactionResponse wait ([#4497](https://github.com/ethers-io/ethers.js/issues/4497); [095de51](https://github.com/ethers-io/ethers.js/commit/095de51e605a9b88576e5e34fd55a6e32befa4eb)).
+  - Allow override keyword in human-readable ABI and improve error messages ([#4514](https://github.com/ethers-io/ethers.js/issues/4514), [#4548](https://github.com/ethers-io/ethers.js/issues/4548); [be5ec2d](https://github.com/ethers-io/ethers.js/commit/be5ec2d327a503b2e5fc0f37c47eee9e828f8e23)).
+  - Expand Contract sub-class to accept BaseContract super-class constructor arguments ([#4538](https://github.com/ethers-io/ethers.js/issues/4538); [98496bc](https://github.com/ethers-io/ethers.js/commit/98496bc48ec23ce0d9c21d3c6c87e5b1b796a610)).
+  - Allow network for default provider to be null to select mainnet ([#4501](https://github.com/ethers-io/ethers.js/issues/4501); [b6bf7ab](https://github.com/ethers-io/ethers.js/commit/b6bf7aba62fb38839cd01858432b801cc5c28a11)).
+  - Allow long dnsEncode names with optional length parameter ([#4543](https://github.com/ethers-io/ethers.js/issues/4543); [a136348](https://github.com/ethers-io/ethers.js/commit/a1363483a56b0dee342595c8f44ed8fcce7ecca9)).
+  - Fix parseLog signature when receiving read-only array for topics ([#4029](https://github.com/ethers-io/ethers.js/issues/4029), [#4459](https://github.com/ethers-io/ethers.js/issues/4459); [20cd8a2](https://github.com/ethers-io/ethers.js/commit/20cd8a23eaf8e8a14e2b51f7f64da4cb3e32fccb)).
+  - Use Secure endpoints for BNB on Etherscan ([#4525](https://github.com/ethers-io/ethers.js/issues/4525); [1f6e188](https://github.com/ethers-io/ethers.js/commit/1f6e1882515195bd67f0bce9fe347ec05107324b)).
+  - Added holesky network and related end-points for supporting providers ([c6e6c43](https://github.com/ethers-io/ethers.js/commit/c6e6c432574a0b7e55c300ab3e470aafdace28b3)).
+  - Added EIP-4844 BLOb transactions ([#4554](https://github.com/ethers-io/ethers.js/issues/4554); [9c1e82e](https://github.com/ethers-io/ethers.js/commit/9c1e82e1230526ebcd62902890c4f24b1f7f7d79)).
+  - Normalize EIP-712 types before computing the payload ([#4541](https://github.com/ethers-io/ethers.js/issues/4541); [56c1361](https://github.com/ethers-io/ethers.js/commit/56c1361ee83db8b68859caf0850c95ff70e7e306)).
+  - Updated thrid-part provider URLs for QuickNode ([2b4891d](https://github.com/ethers-io/ethers.js/commit/2b4891d86e72e849079cb1dc98b18e158b0c0620)).
+  - Fixed normalization and abstracted EIP-712 Array parsing ([#4541](https://github.com/ethers-io/ethers.js/issues/4541); [8f99601](https://github.com/ethers-io/ethers.js/commit/8f99601df1f26a8ba4d6d9dea5e033e7f688107e)).
+  - Updated third-party provider network URLs ([#4542](https://github.com/ethers-io/ethers.js/issues/4542); [84ca14f](https://github.com/ethers-io/ethers.js/commit/84ca14f1ffc5afbdd7f4c26a9b734ec5951eee3c)).
+  - Added additional sepolia testnets ([4efef76](https://github.com/ethers-io/ethers.js/commit/4efef76e8cab0acaf1b2ba231a0148f9381bb1ee)).
+  - Fix EIP-712 type aliases for uint and int ([#4541](https://github.com/ethers-io/ethers.js/issues/4541); [43fb9c2](https://github.com/ethers-io/ethers.js/commit/43fb9c233696aeaa80b1c2b0e5fafce90e0ad508)).
+  - Fixed typo in Error string ([#4539](https://github.com/ethers-io/ethers.js/issues/4539); [7882905](https://github.com/ethers-io/ethers.js/commit/78829050853093bc5291ae78fc5a904044759aa0)).
+  - Better debugging output on fetch errors ([bee07a0](https://github.com/ethers-io/ethers.js/commit/bee07a0750b448a9d13c2d57014bcf27f43e2ed7)).
 
-ethers/v5.0.0-beta.153 (2019-08-06 19:15)
------------------------------------------
+ethers/v6.10.0 (2024-01-12 19:46)
+---------------------------------
 
-  - 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))
+  - Limit decoded result imflation ratio from ABI-encoded data ([#4537](https://github.com/ethers-io/ethers.js/issues/4537); [1b4debd](https://github.com/ethers-io/ethers.js/commit/1b4debd4a9e61d171bfc60590116facb8bdbd2da)).
 
-ethers/v5.0.0-beta.152 (2019-08-05 14:37)
------------------------------------------
+ethers/v6.9.2 (2024-01-02 19:12)
+--------------------------------
 
-  - 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))
+  - Fix Base58 padding for string representation of binary data ([#4527](https://github.com/ethers-io/ethers.js/issues/4527); [ccac24a](https://github.com/ethers-io/ethers.js/commit/ccac24a5b0a4d07a4b639c1c4d0a44703e32d418)).
 
-ethers/v5.0.0-beta.151 (2019-08-05 14:29)
------------------------------------------
+ethers/v6.9.1 (2023-12-19 04:53)
+--------------------------------
 
-  - Added package name prefix to all _version for Logger. ([692589d](https://github.com/ethers-io/ethers.js/commit/692589db54cbca10a2a453e9a1801a8612056559))
+  - Fix uncatchable issue when sending transactions over JSON-RPC and provide some retry-recovery for missing v ([#4513](https://github.com/ethers-io/ethers.js/issues/4513); [1802215](https://github.com/ethers-io/ethers.js/commit/180221574c5d2af9ad85404af4fab8752d3d5029)).
 
-ethers/v5.0.0-beta.150 (2019-08-03 01:07)
------------------------------------------
+ethers/v6.9.0 (2023-11-27 06:15)
+--------------------------------
 
-  - 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))
+  - Use provider-specified suggested priority fee when available, otherwise fallback onto existing logic of 1 gwei ([#4463](https://github.com/ethers-io/ethers.js/issues/4463); [f8f11c7](https://github.com/ethers-io/ethers.js/commit/f8f11c754aa2c9b541db73d3bde66a8ffa5146f0)).
+  - Add auto-detected static network support to providers and allow customizing socket provider options ([#4199](https://github.com/ethers-io/ethers.js/issues/4199), [#4418](https://github.com/ethers-io/ethers.js/issues/4418), [#4441](https://github.com/ethers-io/ethers.js/issues/4441); [4681b83](https://github.com/ethers-io/ethers.js/commit/4681b83d516ab2eb41ddb68b5021c97e14c6f2cf)).
+  - Added Base network to AlchemyProvider ([#4384](https://github.com/ethers-io/ethers.js/issues/4384); [9e74d14](https://github.com/ethers-io/ethers.js/commit/9e74d14432e6efebdff21b9a7d2e6143af55e143)).
+  - Fixed ParamType formatting causing bad tuple full and minimal ABI output ([#4329](https://github.com/ethers-io/ethers.js/issues/4329), [#4479](https://github.com/ethers-io/ethers.js/issues/4479); [2b67488](https://github.com/ethers-io/ethers.js/commit/2b6748815169abf2c99a647131875c13b8b6a787)).
+  - Adjust for provider config weight when kicking off a request in FallbackProvider ([#4298](https://github.com/ethers-io/ethers.js/issues/4298); [da34e35](https://github.com/ethers-io/ethers.js/commit/da34e3569e95357d9469209d926cb645f0750bfa)).
+  - More robust FallbackProvider broadcast ([#4186](https://github.com/ethers-io/ethers.js/issues/4186), [#4297](https://github.com/ethers-io/ethers.js/issues/4297), [#4442](https://github.com/ethers-io/ethers.js/issues/4442); [e2485b8](https://github.com/ethers-io/ethers.js/commit/e2485b8ef927d18c7a15d2d29b3b0feffec9991a)).
+  - Added safe and finalized provider events ([#3921](https://github.com/ethers-io/ethers.js/issues/3921); [a92766e](https://github.com/ethers-io/ethers.js/commit/a92766e56ad04185625037d84fc28adaac7fae8c)).
 
-ethers/v5.0.0-beta.149 (2019-08-03 00:45)
------------------------------------------
+ethers/v6.8.1 (2023-11-01 16:08)
+--------------------------------
 
-  - 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))
+  - Fixed typo in error description when converting values to arrays ([#4427](https://github.com/ethers-io/ethers.js/issues/4427), [#4446](https://github.com/ethers-io/ethers.js/issues/4446); [8fed2f8](https://github.com/ethers-io/ethers.js/commit/8fed2f84768ace4bf3e5742c931a74841da7c637)).
+  - Fix invalid token nonpayable being included in formatted constructor ([#4412](https://github.com/ethers-io/ethers.js/issues/4412); [2e0bd90](https://github.com/ethers-io/ethers.js/commit/2e0bd90744b8e76fcf03f75a66cb0061d50f7bd9)).
+  - Add ENS support for Sepolia ([#4422](https://github.com/ethers-io/ethers.js/issues/4422); [1da50ae](https://github.com/ethers-io/ethers.js/commit/1da50ae286da01e58a70bb8df8aa5cc5d260e33e)).
 
-ethers/v5.0.0-beta.148 (2019-07-27 18:56)
------------------------------------------
+ethers/v6.8.0 (2023-10-10 22:42)
+--------------------------------
 
-  - 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))
+  - Replicated former ENS normalize behaviour for empty strings and update namehash testcases ([125ff11](https://github.com/ethers-io/ethers.js/commit/125ff1189b9cefb8abfd7da9c104c75e382a50cc)).
+  - Initial shortMessage support for errors ([#4241](https://github.com/ethers-io/ethers.js/issues/4241); [d6a8c14](https://github.com/ethers-io/ethers.js/commit/d6a8c14d907cf8b90347444c0186b83a5db2e293)).
+  - Fixed resolving ENS addresses used as from parameters ([#3961](https://github.com/ethers-io/ethers.js/issues/3961); [2616f4c](https://github.com/ethers-io/ethers.js/commit/2616f4c30c82bd45449b73fa37ef269d60a07d80)).
+  - Merge: 9a4b7534 0c9c23b0     Merge branch 'v5.8-progress' ([cd5f0fe](https://github.com/ethers-io/ethers.js/commit/cd5f0fe03f2137fbc47e295f8db38a5151111e72)).
+  - Allow more loose input format for RLP encoder ([#4402](https://github.com/ethers-io/ethers.js/issues/4402); [9a4b753](https://github.com/ethers-io/ethers.js/commit/9a4b7534458fc79a0654b0eb57fc956bffa02a2f)).
+  - Update to latest noble crypto libraries ([#3975](https://github.com/ethers-io/ethers.js/issues/3975); [b27faa0](https://github.com/ethers-io/ethers.js/commit/b27faa02ac8f90e2e54b188e8139c59d98c469e3)).
+  - More robust configuration options for FetchRequest getUrl functions ([#4353](https://github.com/ethers-io/ethers.js/issues/4353); [9541f2f](https://github.com/ethers-io/ethers.js/commit/9541f2f70cd7f5c6f3caf93f5a3d5e34eae5281a)).
+  - Ignore blockTag when calling Etherscan if it is the default block tag ([dcea9b3](https://github.com/ethers-io/ethers.js/commit/dcea9b353619d85878ad2ba340ae17e5c285d558)).
 
-ethers/v5.0.0-beta.147 (2019-07-23 01:04)
------------------------------------------
+ethers/v6.7.1 (2023-08-15 03:08)
+--------------------------------
 
-  - 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))
+  - Prevent destroyed providers from emitting network detection errors ([7d41730](https://github.com/ethers-io/ethers.js/commit/7d4173049edc3b4ff2de1971c3ecca3b08588651)).
+  - Fix VSCode reported lint issues ([#4153](https://github.com/ethers-io/ethers.js/issues/4153), [#4156](https://github.com/ethers-io/ethers.js/issues/4156), [#4158](https://github.com/ethers-io/ethers.js/issues/4158), [#4159](https://github.com/ethers-io/ethers.js/issues/4159); [4eb84da](https://github.com/ethers-io/ethers.js/commit/4eb84da865a82a27c5113c38102b6b710096958e), [203dfc3](https://github.com/ethers-io/ethers.js/commit/203dfc33b9c8e72c9cdfe0a349ac763ef17a4484)).
+  - Add gasPrice to Polygon feeData for type 0 and type 1 legacy transactions ([#4315](https://github.com/ethers-io/ethers.js/issues/4315); [0df3ab9](https://github.com/ethers-io/ethers.js/commit/0df3ab93137039de1e1986bbfe9a5b32ceffa8a4)).
 
-ethers/v5.0.0-beta.146 (2019-07-20 21:06)
------------------------------------------
+ethers/v6.7.0 (2023-08-02 23:52)
+--------------------------------
 
-  - 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))
+  - Fixed receipt wait not throwing on reverted transactions ([25fef4f](https://github.com/ethers-io/ethers.js/commit/25fef4f8d756f5bbf5a2a05e38233248a8eb43ac)).
+  - Added custom priority fee to Optimism chain (via telegram) ([ff80b04](https://github.com/ethers-io/ethers.js/commit/ff80b04f31da21496e72d3687cecd1c01efaecc5)).
+  - Add context to Logs that fail decoding due to ABI issues to help debugging ([f3c46f2](https://github.com/ethers-io/ethers.js/commit/f3c46f22994d194ff78b3b176407b2ecb7af1c77)).
+  - Added new exports for FallbackProviderOptions and FetchUrlFeeDataNetworkPlugin ([#2828](https://github.com/ethers-io/ethers.js/issues/2828), [#4160](https://github.com/ethers-io/ethers.js/issues/4160); [b1dbbb0](https://github.com/ethers-io/ethers.js/commit/b1dbbb0de3f10a3d9e12d6a84ad5c52bea25c7f6)).
+  - Allow overriding pollingInterval in JsonRpcProvider constructor (via discord) ([f42f258](https://github.com/ethers-io/ethers.js/commit/f42f258beb305a06e563ad16522f095a72da32eb)).
+  - Fixed FallbackProvider priority sorting ([#4150](https://github.com/ethers-io/ethers.js/issues/4150); [78538eb](https://github.com/ethers-io/ethers.js/commit/78538eb100addd135d29e60c9fa4fed3946278fa)).
+  - Added linea network to InfuraProvider and Network ([#4184](https://github.com/ethers-io/ethers.js/issues/4184), [#4190](https://github.com/ethers-io/ethers.js/issues/4190); [d3e5e2c](https://github.com/ethers-io/ethers.js/commit/d3e5e2c45b28c377f306091acfc024e30c49ef20)).
+  - Added whitelist support to getDefaultProvider ([82bb936](https://github.com/ethers-io/ethers.js/commit/82bb936542e29c6441ac8dc2d3ebbdd4edb708ee)).
+  - Add Polygon RPC endpoints to the default provider ([#3689](https://github.com/ethers-io/ethers.js/issues/3689); [23704a9](https://github.com/ethers-io/ethers.js/commit/23704a9c44d5857817e138fb19d44ce2103ca005)).
+  - Added customizable quorum to FallbackProvider ([#4160](https://github.com/ethers-io/ethers.js/issues/4160); [8f0a509](https://github.com/ethers-io/ethers.js/commit/8f0a50921a12a866addcf5b0fabc576bfc287689)).
+  - Added basic Gas Station support via a NetworkPlugin ([#2828](https://github.com/ethers-io/ethers.js/issues/2828); [229145d](https://github.com/ethers-io/ethers.js/commit/229145ddf566a962517588eaeed155734c7d4598)).
+  - Add BNB URLs to EtherscanProvider networks ([ec39abe](https://github.com/ethers-io/ethers.js/commit/ec39abe067259fad4ea8607a6c5aece61890eb41)).
+  - Added tests for JSON format ([#4248](https://github.com/ethers-io/ethers.js/issues/4248); [ba36079](https://github.com/ethers-io/ethers.js/commit/ba36079a285706694532ce726568c4c447acad47)).
+  - Use empty string for unnamed parameters in JSON output instead of undefined ([#4248](https://github.com/ethers-io/ethers.js/issues/4248); [8c2652c](https://github.com/ethers-io/ethers.js/commit/8c2652c8cb4d054207d89688d30930869d9d3f8b)).
+  - Return undefined for Contract properties that do not exist instead of throwing an error ([#4266](https://github.com/ethers-io/ethers.js/issues/4266); [5bf7b34](https://github.com/ethers-io/ethers.js/commit/5bf7b3494ed62952fc387b4368a0bdc86dfe163e)).
 
-ethers/v5.0.0-beta.145 (2019-07-20 20:12)
------------------------------------------
+ethers/v6.6.7 (2023-07-28 14:50)
+--------------------------------
 
-  - 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))
+  - Prevent malformed logs from preventing other logs being decoded ([#4275](https://github.com/ethers-io/ethers.js/issues/4275); [0dca645](https://github.com/ethers-io/ethers.js/commit/0dca645632d73488bf6ad460e0d779361a537bbe)).
+  - Allow visibility on human-readable constructors ([#4278](https://github.com/ethers-io/ethers.js/issues/4278); [3a52201](https://github.com/ethers-io/ethers.js/commit/3a52201fe2ba68a00105cca2c0901da5ffa18d6b)).
 
-ethers/v5.0.0-beta.144 (2019-07-09 17:28)
------------------------------------------
+ethers/v6.6.6 (2023-07-28 01:14)
+--------------------------------
 
-  - 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))
+  - Better error message when passing invalid overrides object into a contract deployment ([#4182](https://github.com/ethers-io/ethers.js/issues/4182); [aa2ea3d](https://github.com/ethers-io/ethers.js/commit/aa2ea3d5296956fd0d40b83888e1ca053bb250ee)).
 
-ethers/v5.0.0-beta.143 (2019-07-02 16:12)
------------------------------------------
+ethers/v6.6.5 (2023-07-24 00:04)
+--------------------------------
 
-  - 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))
+  - Reflect symbols in the Contract Proxy to target ([#4084](https://github.com/ethers-io/ethers.js/issues/4048); [ac2f5e5](https://github.com/ethers-io/ethers.js/commit/ac2f5e563b8ec0e91a931470eb6ea58b0c01fb3d)).
+  - Allow arrays of address for indexed filter topics ([#4259](https://github.com/ethers-io/ethers.js/issues/4259); [93af87c](https://github.com/ethers-io/ethers.js/commit/93af87c447eeb77090e29bd940612603b3f74026)).
+  - Fixed filter encoding for bytesX ([#4244](https://github.com/ethers-io/ethers.js/issues/4244); [fa3a883](https://github.com/ethers-io/ethers.js/commit/fa3a883ff7c88611ce766f58bdd4b8ac90814470)).
+  - Fix JSON formatting for tuple arrays ([#4237](https://github.com/ethers-io/ethers.js/issues/4237); [a8bc49b](https://github.com/ethers-io/ethers.js/commit/a8bc49bdcf07a51b35f38cf209db27e116cc1a59)).
+  - Better error messages when parsing fragment strings ([#4246](https://github.com/ethers-io/ethers.js/issues/4246); [e36b6c3](https://github.com/ethers-io/ethers.js/commit/e36b6c35b7bc777c9adbe0055b32b31a13185240)).
+  - Include the missing fragment key and args when no matching Contract method or event is present ([#3809](https://github.com/ethers-io/ethers.js/issues/3809); [450a176](https://github.com/ethers-io/ethers.js/commit/450a176ee25f88a2ddb9ff23b153ef70bf1dc546)).
+  - Prevent a single malformed event from preventing other Contract logs; reported on Discord ([b1375f4](https://github.com/ethers-io/ethers.js/commit/b1375f4e4463b856855ebc684b45945455ac082e)).
 
-ethers/v5.0.0-beta.142 (2019-06-28 16:13)
------------------------------------------
+ethers/v6.6.4 (2023-07-16 00:35)
+--------------------------------
 
-  - 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))
+  - More robust support for Signatures with less standard parameter values ([#3835](https://github.com/ethers-io/ethers.js/issues/3835), [#4228](https://github.com/ethers-io/ethers.js/issues/4228); [a7e4048](https://github.com/ethers-io/ethers.js/commit/a7e4048fe3b75a743cec8c8ef2a5fad4bdc8b14c)).
+  - Fixed CCIP-read in the EnsResolver ([#4221](https://github.com/ethers-io/ethers.js/issues/4221); [57f1e1c](https://github.com/ethers-io/ethers.js/commit/57f1e1c47148921148e35c10c83539531942923e)).
+  - Skip checking confirmation count if confirms is 0 ([#4229](https://github.com/ethers-io/ethers.js/issues/4229), [#4242](https://github.com/ethers-io/ethers.js/issues/4242); [492919d](https://github.com/ethers-io/ethers.js/commit/492919d14f646c630f29e1596e5564df1e51f309)).
+  - Fixed waiting for confirmations in deployment transactions ([#4212](https://github.com/ethers-io/ethers.js/issues/4212), [#4230](https://github.com/ethers-io/ethers.js/issues/4230); [43c253a](https://github.com/ethers-io/ethers.js/commit/43c253a402f52a08353c424f6c4e236836cfaf36)).
 
-ethers/v5.0.0-beta.141 (2019-06-24 21:25)
------------------------------------------
+ethers/v6.6.3 (2023-07-11 20:55)
+--------------------------------
 
-  - 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))
+  - Throw more desscriptive error for unconfigured ENS name contract targets ([#4213](https://github.com/ethers-io/ethers.js/issues/4213); [80f62ef](https://github.com/ethers-io/ethers.js/commit/80f62efc41c3a29e690af40a1976928b7f886a0e)).
+  - Fixed contract once not running stop callback ([7d061b7](https://github.com/ethers-io/ethers.js/commit/7d061b786f72cbfc461bf80d139d10aeff533a6e)).
 
-ethers/v5.0.0-beta.140 (2019-06-12 01:25)
------------------------------------------
+ethers/v6.6.2 (2023-06-27 23:30)
+--------------------------------
 
-  - 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))
+  - Wider error detection for call exceptions on certain backends ([#4154](https://github.com/ethers-io/ethers.js/issues/4154), [#4155](https://github.com/ethers-io/ethers.js/issues/4155); [9197f9f](https://github.com/ethers-io/ethers.js/commit/9197f9f938b5f3b5f97c043f2dab06854656c932)).
+  - Added wider error deetection for JSON-RPC unsupported operation ([#4162](https://github.com/ethers-io/ethers.js/issues/4162); [1dc8986](https://github.com/ethers-io/ethers.js/commit/1dc8986a33be9dce536b24189326cbfaabf1342e)).
+  - Fixed formatUnits and parseUnits for values over 128 bits ([#4037](https://github.com/ethers-io/ethers.js/issues/4037), [#4133](https://github.com/ethers-io/ethers.js/issues/4133); [3d141b4](https://github.com/ethers-io/ethers.js/commit/3d141b44b528f52b3c9205125b64ce342f91643c)).
 
-ethers/v5.0.0-beta.139 (2019-06-11 17:55)
------------------------------------------
+ethers/v6.6.1 (2023-06-23 00:35)
+--------------------------------
 
-  - 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))
+  - Fixed CCIP read in contract calls ([#4043](https://github.com/ethers-io/ethers.js/issues/4043); [d51e3fb](https://github.com/ethers-io/ethers.js/commit/d51e3fbff43c31d88353ac71151626312d22c0b9), [857aa8c](https://github.com/ethers-io/ethers.js/commit/857aa8ccc30f25eda8e83dcac3e0ad2c1a5ce2b3)).
 
-ethers/v5.0.0-beta.138 (2019-06-04 16:05)
------------------------------------------
+ethers/v6.6.0 (2023-06-13 21:42)
+--------------------------------
 
-  - 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))
+  - Add exports for AbstractProviderOptions and for MulticoinProviderPlugin ([203a759](https://github.com/ethers-io/ethers.js/commit/203a759efc65bf6901d3e574a601525ea3936238)).
+  - Add option to adjust perform cache timeout in AbstractProvider ([de0f518](https://github.com/ethers-io/ethers.js/commit/de0f5189f695c181a5fa09100af96a691a338e2b)).
+  - Add full support for MultiCoin plugins and automatic detection for EVM-compatible coin types ([#3888](https://github.com/ethers-io/ethers.js/issues/3888), [#4081](https://github.com/ethers-io/ethers.js/issues/4081); [84375be](https://github.com/ethers-io/ethers.js/commit/84375be92d32a2939cf4a2f713e4c554b5b54a32)).
+  - Allow Interface instances where InterfaceAbi are allowed ([#4142](https://github.com/ethers-io/ethers.js/issues/4142); [2318005](https://github.com/ethers-io/ethers.js/commit/2318005dfd996c8a7c51603d0264ceabe9bb6141)).
+  - Allow Numeric type for decimals in FixedNumber ([#4141](https://github.com/ethers-io/ethers.js/issues/4141); [9055ef6](https://github.com/ethers-io/ethers.js/commit/9055ef6c69291f1a44ea23a2e7b5aaf3140a5577)).
 
-ethers/v5.0.0-beta.137 (2019-06-01 14:06)
------------------------------------------
+ethers/v6.5.1 (2023-06-07 20:19)
+--------------------------------
 
-  - 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))
+  - Fix lost promise fulfillment when a batch has an error response ([#4126](https://github.com/ethers-io/ethers.js/issues/4126); [8dd21f0](https://github.com/ethers-io/ethers.js/commit/8dd21f03334ffd3cdb7ac532376d51fd4130c7ab)).
 
-ethers/v5.0.0-beta.136
-----------------------
+ethers/v6.5.0 (2023-06-06 22:41)
+--------------------------------
 
-  - 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))
+  - Fix CJS browser bundling ([#4033](https://github.com/ethers-io/ethers.js/issues/4033); [38ee319](https://github.com/ethers-io/ethers.js/commit/38ee3195b0192d8180899fd61308e03fa3a0eb32)).
+  - Fixed type guard for non-Typed instances ([#4087](https://github.com/ethers-io/ethers.js/issues/4087); [20c3d1b](https://github.com/ethers-io/ethers.js/commit/20c3d1b109743e33ab60a75d69bf7ede73b15ce2)).
+  - Add confirmations to TransactionResponse ([#4094](https://github.com/ethers-io/ethers.js/issues/4094); [bb8685b](https://github.com/ethers-io/ethers.js/commit/bb8685b112ce1c689c740d4dbcb358c16fb9b22d)).
+  - Fix stray promises when a node returns invalid results ([#4118](https://github.com/ethers-io/ethers.js/issues/4118); [3c1bad2](https://github.com/ethers-io/ethers.js/commit/3c1bad2fb7ad4a6ff90ff11f3e382fd18e41c800)).
+  - Added support to detect and stop providers spinning on intitial network detection ([#4015](https://github.com/ethers-io/ethers.js/issues/4015); [f37a52d](https://github.com/ethers-io/ethers.js/commit/f37a52da28ac130b7f4de52901618320994ea87a)).
 
-ethers/v5.0.0-beta.135
-----------------------
+ethers/v6.4.2 (2023-06-05 22:41)
+--------------------------------
 
-  - 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))
+  - Bump ens-normalize version ([#4071](https://github.com/ethers-io/ethers.js/issues/4071), [#4077](https://github.com/ethers-io/ethers.js/issues/4077), [#4080](https://github.com/ethers-io/ethers.js/issues/4080), [#4102](https://github.com/ethers-io/ethers.js/issues/4102); [c135784](https://github.com/ethers-io/ethers.js/commit/c1357847dcdec93d72f28d890f9271d0289ccefd)).
+  - Fix for networks with polling with non-consistent block and filter events ([#4119](https://github.com/ethers-io/ethers.js/issues/4119); [9b0e992](https://github.com/ethers-io/ethers.js/commit/9b0e9920c09577296ec0e2abb3acc3f3299d96c7)).
 
+ethers/v6.4.1 (2023-06-01 17:52)
+--------------------------------
+
+  - Fixed AbstractProvider lookupAddress bug ([#4086](https://github.com/ethers-io/ethers.js/issues/4086); [15ed2f5](https://github.com/ethers-io/ethers.js/commit/15ed2f5b32084527961332481c9442a313036a01)).
+  - Fix FixedNumber comparison bug ([#4112](https://github.com/ethers-io/ethers.js/issues/4112); [d8e9586](https://github.com/ethers-io/ethers.js/commit/d8e9586044e888e424b5ead0f6e01f88140dba8a)).
+
+ethers/v6.4.0 (2023-05-18 17:28)
+--------------------------------
+
+  - Coerce value into BigInt when checking for value ([83d7f43](https://github.com/ethers-io/ethers.js/commit/83d7f43b9ca4b9868a3952510e56b41ea8610baa)).
+  - Better errors when junk passed as Contract target ([#3947](https://github.com/ethers-io/ethers.js/issues/3947), [#4053](https://github.com/ethers-io/ethers.js/issues/4053); [219b16d](https://github.com/ethers-io/ethers.js/commit/219b16dc284b0c6a532c8c49e824d8234f94222b)).
+  - More robust message checking in socket providers ([#4051](https://github.com/ethers-io/ethers.js/issues/4051); [f58990b](https://github.com/ethers-io/ethers.js/commit/f58990b80cfd83579014339315e58663c0aa6ae3)).
+  - More robust defaultProvider start-up when a backend fails on bootstrap ([#3979](https://github.com/ethers-io/ethers.js/issues/3979); [984f6fa](https://github.com/ethers-io/ethers.js/commit/984f6fa155fca08ebec2353c75ee0a0b974e8568)).
+  - Fix Result.map when Array contains zero elements ([#4036](https://github.com/ethers-io/ethers.js/issues/4036), [#4048](https://github.com/ethers-io/ethers.js/issues/4048); [2e5935b](https://github.com/ethers-io/ethers.js/commit/2e5935b91cff462165a054b33c8b8413f51e3f39)).
+  - Fixed error handling for contracts with receive and non-payable fallback ([6db7458](https://github.com/ethers-io/ethers.js/commit/6db7458cf0a09e8e8a2abb712239972ab81dc9df)).
+  - Remove superfluous logging in defaultProvider ([f87f6ef](https://github.com/ethers-io/ethers.js/commit/f87f6ef9a01ca399664f9fe106b0a677dba0c8e8)).
+  - Removed superfluous logging ([1bc8b55](https://github.com/ethers-io/ethers.js/commit/1bc8b55d502a95c4ae58352bdcfce9e5f9ea72d3)).
+  - Fix receipt gas price when effectiveGasPrice is 0 on testnets ([#4014](https://github.com/ethers-io/ethers.js/issues/4014); [2b0fe61](https://github.com/ethers-io/ethers.js/commit/2b0fe611335432aee334d777a64d8c7827881618)).
+  - Added error event to provider ([#3970](https://github.com/ethers-io/ethers.js/issues/3970), [#3982](https://github.com/ethers-io/ethers.js/issues/3982); [af0291c](https://github.com/ethers-io/ethers.js/commit/af0291c01639674658f5049343da88a84da763a1)).
+  - Removed superfluous parameters for internal transaction functions ([e848978](https://github.com/ethers-io/ethers.js/commit/e8489787585c2e69a23f6cdec6901f22b096aebe)).
+  - More aggresive tree-shaking ([076edad](https://github.com/ethers-io/ethers.js/commit/076edad81ef62474f48f2b4c8af0edc6e4fd64f2)).
+  - More flexible static network checking ([#3834](https://github.com/ethers-io/ethers.js/issues/3834); [7c0465c](https://github.com/ethers-io/ethers.js/commit/7c0465c5fb834eba18d4e5535072685bdc1029f0)).
+  - Support transitive dependants that use non-node16 moduleResolution ([#3920](https://github.com/ethers-io/ethers.js/issues/3920); [df685b1](https://github.com/ethers-io/ethers.js/commit/df685b1bd9ad346ee7863beb6c3ca3f4e94932a2)).
+  - Populate any missing log.removed with false ([#3959](https://github.com/ethers-io/ethers.js/issues/3959); [4e478e6](https://github.com/ethers-io/ethers.js/commit/4e478e625d5648f2172631eef5fda5776ee776b0)).
+
+ethers/v6.3.0 (2023-04-06 04:35)
+--------------------------------
+
+  - Added support for legacy ABI JSON fragments ([#3932](https://github.com/ethers-io/ethers.js/issues/3932); [8c5973e](https://github.com/ethers-io/ethers.js/commit/8c5973e3a9b8d4d4ed80bdf209d8a0b6cc6b8d6d)).
+  - Add _in_ operator support for contract and contract.filters ([#3901](https://github.com/ethers-io/ethers.js/issues/3901); [c58ab3a](https://github.com/ethers-io/ethers.js/commit/c58ab3a97687e15a3ffe30b038089c5f4b570bb9)).
+  - Fixed TypedData unsigned value range ([#3873](https://github.com/ethers-io/ethers.js/issues/3873); [a851b24](https://github.com/ethers-io/ethers.js/commit/a851b24d0af009ecf277766d2a5f81f9b3e7f9f8)).
+  - Added missing export for getIndexedAccountPath ([#3875](https://github.com/ethers-io/ethers.js/issues/3875); [356ff2b](https://github.com/ethers-io/ethers.js/commit/356ff2becb4f4d3622b281d3825770af5caf71ca)).
+  - Fixed TypedData payloads for JSON-restricted chainId field ([#3836](https://github.com/ethers-io/ethers.js/issues/3836); [50b74b8](https://github.com/ethers-io/ethers.js/commit/50b74b8806ef2064f2764b09f89c7ac75fda3a3c)).
+
+ethers/v6.2.3 (2023-03-27 21:22)
+--------------------------------
+
+  - Fixed events when emitted in WebSocketProvider ([#3767](https://github.com/ethers-io/ethers.js/issues/3767), [#3922](https://github.com/ethers-io/ethers.js/issues/3922); [ffaafc0](https://github.com/ethers-io/ethers.js/commit/ffaafc0ce1cf40d1d76d8d814c9c445057bf6989)).
+
+ethers/v6.2.2 (2023-03-24 00:49)
+--------------------------------
+
+  - Fixed FetchRequest when using credentials ([#3897](https://github.com/ethers-io/ethers.js/issues/3897); [88e8124](https://github.com/ethers-io/ethers.js/commit/88e8124c37d377628f9b8abdf140fc07ad06259f)).
+
+ethers/v6.2.1 (2023-03-23 17:33)
+--------------------------------
+
+  - Stall block polling bootstrap when the network is down ([#3924](https://github.com/ethers-io/ethers.js/issues/3924); [603d474](https://github.com/ethers-io/ethers.js/commit/603d47496e2b667c15b72f315261d6e299381848)).
+
+ethers/v6.2.0 (2023-03-20 15:53)
+--------------------------------
+
+  - Added extra details in the error info field for RPC errors ([30ffa78](https://github.com/ethers-io/ethers.js/commit/30ffa78d1441fa033677fa09237fc135a314f373)).
+  - Remove Ankr as a deafult for now as the provided API key is failing ([6e01e54](https://github.com/ethers-io/ethers.js/commit/6e01e5448f4a3e2d30288d4c8447db295c3a2e7a)).
+  - Fixed deferred filters after unsafe-eval changes ([#3749](https://github.com/ethers-io/ethers.js/issues/3749), [#3763](https://github.com/ethers-io/ethers.js/issues/3763); [2e3802a](https://github.com/ethers-io/ethers.js/commit/2e3802a83b8ad2f5a6269d79fbd1c83c9f2d1047)).
+  - Remove use of Function sub-class to address unsafe-eval issues ([#3749](https://github.com/ethers-io/ethers.js/issues/3749), [#3763](https://github.com/ethers-io/ethers.js/issues/3763); [7d3af51](https://github.com/ethers-io/ethers.js/commit/7d3af512c75b4c24027ec2daef1e9f4c1064194a)).
+  - Added verifyTypedData utility (reported on Farcaster) ([f06a445](https://github.com/ethers-io/ethers.js/commit/f06a445247f3b294f9fc805cc8fe0752accb8edc)).
+  - Removed stray logging in IpcProvider ([#3908](https://github.com/ethers-io/ethers.js/issues/3908), [#3909](https://github.com/ethers-io/ethers.js/issues/3909); [e11d4c1](https://github.com/ethers-io/ethers.js/commit/e11d4c1c20cc5b6fd5803cf9636c4f5bc082dab7)).
+  - Fixed legacy serialization for implicit chainId transactions ([#3898](https://github.com/ethers-io/ethers.js/issues/3898), [#3899](https://github.com/ethers-io/ethers.js/issues/3899); [fcf6c8f](https://github.com/ethers-io/ethers.js/commit/fcf6c8fcee95ec412aaafba8ec84d5049b077a4e)).
+  - Fix Webpack issue (reported on discord) ([3ad4273](https://github.com/ethers-io/ethers.js/commit/3ad4273b8b714bff344ccbfb1eb71ed8a8b7cfa4)).
+  - Fix some bundlers which cannot handle recursive pkg.exports ([#3848](https://github.com/ethers-io/ethers.js/issues/3848); [6315e78](https://github.com/ethers-io/ethers.js/commit/6315e78ea32147653b72ca06f6800f3e2df6ffbf)).
+  - Fixed typo in signature.s error ([#3891](https://github.com/ethers-io/ethers.js/issues/3891); [47ef3eb](https://github.com/ethers-io/ethers.js/commit/47ef3ebde37bfa0c015c258c3d8a6800d751e147)).
+  - Fixed stray unreachable code ([#3890](https://github.com/ethers-io/ethers.js/issues/3890); [c220fe2](https://github.com/ethers-io/ethers.js/commit/c220fe2ea747ccc80cd3c4020e0278e3daf3c4fc)).
+  - Move all wrapping to proper _wrap functions ([#3818](https://github.com/ethers-io/ethers.js/issues/3818); [02a0aad](https://github.com/ethers-io/ethers.js/commit/02a0aad61212c35e8d2723a8ae589989b97dae3e)).
+
+ethers/v6.1.0 (2023-03-07 02:10)
+--------------------------------
+
+  - Fixed ethers imported in web workers ([#3856](https://github.com/ethers-io/ethers.js/issues/3856); [5f2678f](https://github.com/ethers-io/ethers.js/commit/5f2678fb059d643638b9cc1dc59cbfc61ce7a7b8)).
+  - Added Sepolia support ([#3863](https://github.com/ethers-io/ethers.js/issues/3863); [abeaa74](https://github.com/ethers-io/ethers.js/commit/abeaa74da04fbe25e837a2ffa7d1e9c1257a5da5)).
+  - Added missing exports ([#3734](https://github.com/ethers-io/ethers.js/issues/3734); [06aa303](https://github.com/ethers-io/ethers.js/commit/06aa30363f88144db672376d39012d7fe3f86c33)).
+  - Allow null values for TypedData domain ([#3623](https://github.com/ethers-io/ethers.js/issues/3623); [a32af3a](https://github.com/ethers-io/ethers.js/commit/a32af3adc104c4b07a45097a4a3725a4ce9e0be6)).
+  - Added listAccounts to JsonRpcProvider ([#3778](https://github.com/ethers-io/ethers.js/issues/3778); [287d94f](https://github.com/ethers-io/ethers.js/commit/287d94fc454d03f1b3086ea98745131cdf40129a)).
+  - Allow BigInt for blockTag ([#3780](https://github.com/ethers-io/ethers.js/issues/3780); [fe1f04c](https://github.com/ethers-io/ethers.js/commit/fe1f04c6e5fb4254a100f492d7dcbdc3cf19a446)).
+  - Fixed typo in error messages ([#3822](https://github.com/ethers-io/ethers.js/issues/3822), [#3824](https://github.com/ethers-io/ethers.js/issues/3824); [f1a810d](https://github.com/ethers-io/ethers.js/commit/f1a810dcb56df54b1e1567f2a59c73500619472f)).
+  - Re-adding definition files to require exports ([#3703](https://github.com/ethers-io/ethers.js/issues/3703); [76fab92](https://github.com/ethers-io/ethers.js/commit/76fab923da33e71e6bb751bb0b5e3ba3faa27ab2)).
+
+ethers/v6.0.8 (2023-02-23 06:30)
+--------------------------------
+
+  - Fix matic-mumbai network and include aliases to legacy names ([#3811](https://github.com/ethers-io/ethers.js/issues/3811); [20bbd12](https://github.com/ethers-io/ethers.js/commit/20bbd1281911d31b360f6f5032251c9257943541)).
+  - Fixed getSigner bug ([#3821](https://github.com/ethers-io/ethers.js/issues/3821); [388edf6](https://github.com/ethers-io/ethers.js/commit/388edf6abc168f89f1ca609e9e5b025dc9205add)).
+
+ethers/v6.0.7 (2023-02-23 01:41)
+--------------------------------
+
+  - Fixed getContentHash ([#3819](https://github.com/ethers-io/ethers.js/issues/3819); [b993f7c](https://github.com/ethers-io/ethers.js/commit/b993f7c3b6c0e135c460c8b8dc5943215628231a)).
+
+ethers/v6.0.6 (2023-02-22 21:53)
+--------------------------------
+
+  - Added chain parameters for Arbitrum and Optimism ([#3811](https://github.com/ethers-io/ethers.js/issues/3811); [77a7323](https://github.com/ethers-io/ethers.js/commit/77a7323119923e596f4def4f1bc90beae5447320)).
+  - Fix NonceManager race condition ([#3812](https://github.com/ethers-io/ethers.js/issues/3812), [#3813](https://github.com/ethers-io/ethers.js/issues/3813); [5a3c10a](https://github.com/ethers-io/ethers.js/commit/5a3c10a29c047609a50828adb620d88aa8cf0014)).
+  - Add UMD output to dist builds ([#3814](https://github.com/ethers-io/ethers.js/issues/3814); [f9eed4c](https://github.com/ethers-io/ethers.js/commit/f9eed4cdb190b06dd4ddaa2382c1de42e8e98de6)).
+
+ethers/v6.0.5 (2023-02-18 22:36)
+--------------------------------
+
+  - Fixed Result to behave correctly like an array using slice and toArray ([#3787](https://github.com/ethers-io/ethers.js/issues/3787); [399356b](https://github.com/ethers-io/ethers.js/commit/399356b91227db04e496628af60c4b8e38207760)).
+  - Replaced substring from 0 index with startsWith ([#3691](https://github.com/ethers-io/ethers.js/issues/3691); [4512e97](https://github.com/ethers-io/ethers.js/commit/4512e97f9b55607ce388aa6eb63a37fc196a5d9d)).
+  - Fixed inverted assert in duplicate name detection for ABI encoding ([#3792](https://github.com/ethers-io/ethers.js/issues/3792); [762c2f3](https://github.com/ethers-io/ethers.js/commit/762c2f34eac848c5464389f11d1697dcd8ebcbb5)).
+  - Fixed missing property during transaction copy ([#3793](https://github.com/ethers-io/ethers.js/issues/3793); [48bbef7](https://github.com/ethers-io/ethers.js/commit/48bbef7ade69bcfe86542f752f15049cc62f4141)).
+  - Add support for Wallet private keys without 0x prefix ([#3768](https://github.com/ethers-io/ethers.js/issues/3768); [4665fb4](https://github.com/ethers-io/ethers.js/commit/4665fb4c6886c8b344dee316ba9f4fde57ce7557)).
+  - Fixed quicknode property for defaultProvider ([#3741](https://github.com/ethers-io/ethers.js/issues/3741); [a8afb72](https://github.com/ethers-io/ethers.js/commit/a8afb72fbbceb6a5024c1edb85badb72099787ea)).
+  - Fixed exports field order ([#3703](https://github.com/ethers-io/ethers.js/issues/3703), [#3755](https://github.com/ethers-io/ethers.js/issues/3755); [085a905](https://github.com/ethers-io/ethers.js/commit/085a9054f349afb816ca1a123737293ec9bd2532)).
+
+ethers/v6.0.4 (2023-02-16 08:55)
+--------------------------------
+
+  - Fixed custom error decoding ([#3785](https://github.com/ethers-io/ethers.js/issues/3785); [4d9b29d](https://github.com/ethers-io/ethers.js/commit/4d9b29de751e2387c143e474bb96d271da892ea6)).
+  - Removed stray debug logging ([e1e0929](https://github.com/ethers-io/ethers.js/commit/e1e09293483a9d07fd8e8f96552aa958b5ec45ed)).
+  - Fixed lookupAddress when bad resolver is present ([#3782](https://github.com/ethers-io/ethers.js/issues/3782); [92def9c](https://github.com/ethers-io/ethers.js/commit/92def9c1489bb35ad13fe58a1cd107ee3a05a112)).
+  - Fixed FallbackProvider median calculation ([#3746](https://github.com/ethers-io/ethers.js/issues/3746); [83957dc](https://github.com/ethers-io/ethers.js/commit/83957dc283043b9af8f6e89920faac3e09ca69fc)).
+  - Move the xnf normalize variant to pkg.browser instead of import ([#3724](https://github.com/ethers-io/ethers.js/issues/3724); [179e6ca](https://github.com/ethers-io/ethers.js/commit/179e6ca520392177c7dea5e477b29930952ed637)).
+
+ethers/v6.0.3 (2023-02-12 22:45)
+--------------------------------
+
+  - Allow null type in transaction receipt for legacy type 0 networks ([#3459](https://github.com/ethers-io/ethers.js/issues/3459); [6372a46](https://github.com/ethers-io/ethers.js/commit/6372a46b1b273db3e4c1189daebb4b888bd588bc)).
+  - Fixed events when slicing immutable Result ([#3765](https://github.com/ethers-io/ethers.js/issues/3765); [2ba4a17](https://github.com/ethers-io/ethers.js/commit/2ba4a172555b7e17ac01fedfc944549defab61bc)).
+  - More robust support on networks which throw when filters are not supported ([#3767](https://github.com/ethers-io/ethers.js/issues/3767); [37bf4fb](https://github.com/ethers-io/ethers.js/commit/37bf4fb55563d7ff66edee15c7515c8a0d6a2266)).
+  - Fixed ignored polling override for JsonRpcApiProvider ([400d576](https://github.com/ethers-io/ethers.js/commit/400d57621b3e9a33679a528b5072449699f0a068)).
+
+ethers/v6.0.2 (2023-02-04 08:50)
+--------------------------------
+
+  - Fixed crossed assert in Fetch ([#3733](https://github.com/ethers-io/ethers.js/issues/3733); [6c338c1](https://github.com/ethers-io/ethers.js/commit/6c338c1c5b4013db9754c9d1a33dcbf54330e5c7)).
+
+ethers/v6.0.1 (2023-02-04 04:06)
+--------------------------------
+
+  - Fix Subscriber model when removed within emit callback ([d0ed918](https://github.com/ethers-io/ethers.js/commit/d0ed91840c9f51c7ce9061ebb1d36727dbdd51a4)).
+  - Fixed human-readable parser when identifier begins with valid type prefix ([#3728](https://github.com/ethers-io/ethers.js/issues/3728); [522fd16](https://github.com/ethers-io/ethers.js/commit/522fd16f68aabc53e4dc8745d4128e0d61260ed5)).
+  - Update to latest secp256k1 library ([#3719](https://github.com/ethers-io/ethers.js/issues/3719); [803e8f9](https://github.com/ethers-io/ethers.js/commit/803e8f9821950b83efa876d64b1cfb35f6bccc38)).
+
+ethers/v6.0.0 (2023-02-02 22:48)
+--------------------------------
+
+  - Initial release ([90afd9b](https://github.com/ethers-io/ethers.js/commit/90afd9bd81ed1408421a0247fa0845a74c9eb319)).

FUNDING.json

@@ -0,0 +1,7 @@
+{
+  "drips": {
+    "ethereum": {
+      "ownedBy": "0x89EdE5cBE53473A64d6C8DF14176a0d658dAAeDC"
+    }
+  }
+}

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Richard Moore
+Copyright (c) 2016-2023 Richard Moore
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,81 +1,136 @@
 The Ethers Project
 ==================
 
-**EXPERIMENTAL!!!**
+[![npm (tag)](https://img.shields.io/npm/v/ethers)](https://www.npmjs.com/package/ethers)
+[![CI Tests](https://github.com/ethers-io/ethers.js/actions/workflows/test-ci.yml/badge.svg?branch=main)](https://github.com/ethers-io/ethers.js/actions/workflows/test-ci.yml)
+![npm bundle size (version)](https://img.shields.io/bundlephobia/minzip/ethers)
+![npm (downloads)](https://img.shields.io/npm/dm/ethers)
+[![GitPOAP Badge](https://public-api.gitpoap.io/v1/repo/ethers-io/ethers.js/badge)](https://www.gitpoap.io/gh/ethers-io/ethers.js)
+[![Twitter Follow](https://img.shields.io/twitter/follow/ricmoo?style=social)](https://twitter.com/ricmoo)
 
-This is just a development version to experiment with lerna.
+-----
+
+A complete, compact and simple library for Ethereum and ilk, written
+in [TypeScript](https://www.typescriptlang.org).
+
+**Features**
+
+- Keep your private keys in your client, **safe** and sound
+- Import and export **JSON wallets** (Geth, Parity and crowdsale)
+- Import and export BIP 39 **mnemonic phrases** (12 word backup phrases) and **HD Wallets** (English as well as Czech, French, Italian, Japanese, Korean, Simplified Chinese, Spanish, Traditional Chinese)
+- Meta-classes create JavaScript objects from any contract ABI, including **ABIv2** and **Human-Readable ABI**
+- Connect to Ethereum nodes over [JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC), [INFURA](https://infura.io), [Etherscan](https://etherscan.io), [Alchemy](https://alchemyapi.io), [Ankr](https://ankr.com) or [MetaMask](https://metamask.io)
+- **ENS names** are first-class citizens; they can be used anywhere an Ethereum addresses can be used
+- **Small** (~144kb compressed; 460kb uncompressed)
+- **Tree-shaking** focused; include only what you need during bundling
+- **Complete** functionality for all your Ethereum desires
+- Extensive [documentation](https://docs.ethers.org/v6/)
+- Large collection of **test cases** which are maintained and added to
+- Fully written in **TypeScript**, with strict types for security and safety
+- **MIT License** (including ALL dependencies); completely open source to do with as you please
+
+
+Keep Updated
+------------
+
+For advisories and important notices, follow [@ethersproject](https://twitter.com/ethersproject)
+on Twitter (low-traffic, non-marketing, important information only) as well as watch this GitHub project.
+
+For more general news, discussions, and feedback, follow or DM me,
+[@ricmoo](https://twitter.com/ricmoo) on Twitter or on the
+[Ethers Discord](https://discord.gg/qYtSscGYYc).
+
+
+For the latest changes, see the
+[CHANGELOG](https://github.com/ethers-io/ethers.js/blob/main/CHANGELOG.md).
+
+
+**Summaries**
+
+- [August 2023](https://blog.ricmoo.com/highlights-ethers-js-august-2023-fb68354c576c)
+- [September 2022](https://blog.ricmoo.com/highlights-ethers-js-september-2022-d7bda0fc37ed)
+- [June 2022](https://blog.ricmoo.com/highlights-ethers-js-june-2022-f5328932e35d)
+- [March 2022](https://blog.ricmoo.com/highlights-ethers-js-march-2022-f511fe1e88a1)
+- [December 2021](https://blog.ricmoo.com/highlights-ethers-js-december-2021-dc1adb779d1a)
+- [September 2021](https://blog.ricmoo.com/highlights-ethers-js-september-2021-1bf7cb47d348)
+- [May 2021](https://blog.ricmoo.com/highlights-ethers-js-may-2021-2826e858277d)
+- [March 2021](https://blog.ricmoo.com/highlights-ethers-js-march-2021-173d3a545b8d)
+- [December 2020](https://blog.ricmoo.com/highlights-ethers-js-december-2020-2e2db8bc800a)
 
-**Do NOT use**
 
 
 Installing
 ----------
 
-**node.js**
+**NodeJS**
 
 ```
-/home/ricmoo/some_project> npm install --save ethers@next
+/home/ricmoo/some_project> npm install ethers
 ```
 
-**browser**
+**Browser (ESM)**
+
+The bundled library is available in the `./dist/` folder in this repo.
 
 ```
-<script src="https://cdn.ethers.io/lib/ethers-5.0.min.js" type="text/javasctipt">
+<script type="module">
+    import { ethers } from "./dist/ethers.min.js";
 </script>
 ```
 
 
-Ancillary Packages
+Documentation
+-------------
+
+Browse the [documentation](https://docs.ethers.org) online:
+
+- [Getting Started](https://docs.ethers.org/v6/getting-started/)
+- [Full API Documentation](https://docs.ethers.org/v6/api/)
+- [Various Ethereum Articles](https://blog.ricmoo.com/)
+
+
+
+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.org/v5/api-keys/) in
+the documentation.
+
+A special thanks to these services for providing community resources:
+
+- [Ankr](https://www.ankr.com/)
+- [QuickNode](https://www.quicknode.com/)
+- [Etherscan](https://etherscan.io/)
+- [INFURA](https://infura.io/)
+- [Alchemy](https://dashboard.alchemyapi.io/signup?referral=55a35117-028e-4b7c-9e47-e275ad0acc6d)
+
+
+Extension 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
-everyone else with packages they do not need.
+The `ethers` package only includes the most common and most core
+functionality to interact with Ethereum. There are many other
+packages designed to further enhance the functionality and experience.
 
-We will keep a list of useful pacakges here.
-
-- `@ethersproject/experimental`
-- `@ethersproject/cli`
-- `@ethersproject/ens`
-- `@ethersproject/ledger`
-- `@ethersproject/trezor`
-
-
-Hacking
--------
-
-This project uses a combination of Lerna and the ./admin scripts to manage
-itself as a package of packages.
-
-The umbrella package can be found in `packages/ethers`, and all packages in general
-can be found in the `packages/` folder.
-
-If you add new dependencies to any package (incuding internal dependencies), you will
-need to re-create the internal links and re-build teh dependency graph::
-
-```
-/home/ethers> npm run bootstrap
-```
-
-To run a continuous build (with incremental TypeScript compilation):
-
-```
-/home/ethers> npm run auto-build
-```
-
-Finally, once you have made all your changes, you will need to bump the version
-of packages that changed their NPM tarballs, as well as update the _version.*
-and distribution builds (which is what we host on the CDN for browser-based
-apps). To do this, run:
-
-
-```
-/home/ethers> npm run update-versions
-```
-
-Which will also list all packages that have changed along with the specifc files.
+- [MulticallProvider](https://github.com/ethers-io/ext-provider-multicall) - A Provider which bundles multiple call requests into a single `call` to reduce latency and backend request capacity
+- [MulticoinPlugin](https://github.com/ethers-io/ext-provider-plugin-multicoin) - A Provider plugin to expand the support of ENS coin types
+- [GanaceProvider](https://github.com/ethers-io/ext-provider-ganache) - A Provider for in-memory node instances, for fast debugging, testing and simulating blockchain operations
+- [Optimism Utilities](https://github.com/ethers-io/ext-utils-optimism) - A collection of Optimism utilities
+- [LedgerSigner](https://github.com/ethers-io/ext-signer-ledger) - A Signer to interact directly with Ledger Hardware Wallets
 
 
 License

SECURITY.md

@@ -0,0 +1,34 @@
+# 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   |
+| ------- | ------------------------------------------ | ----------------- |
+| 6.0.x   | :white_check_mark:                         | 2023-02-02        |
+| 5.0.x   | :white_check_mark: (security updates)      | 2020-06-12        |
+| 4.0.x   | :x:                                        | 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,114 +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");
-                error.stderr = stderr.toString();
-                error.stdout = stdout.toString();
-                error.statusCode = code;
-                reject(error);
-            } else {
-                resolve(stdout.toString());
-            }
-        });
-    });
-}
-
-function setupConfig(outDir, moduleType, targetType) {
-    function update(value) {
-        let comps = value.split("/");
-        if (comps.length >= 3 && comps[0] === "." && comps[1].match(/^lib(\.esm)?$/)) {
-            return outDir + comps.slice(2).join("/");
-        }
-        return value;
-    }
-
-    // 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);
-
-    dirnames.forEach((dirname) => {
-        let info = loadPackage(dirname);
-
-        if (info._ethers_nobuild) { return; }
-
-        if (info.browser) {
-            if (typeof(info.browser) === "string") {
-                info.browser = update(info.browser);
-            } else {
-                for (let key in info.browser) {
-                    info.browser[key] = update(info.browser[key]);
-                }
-            }
-        }
-        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_ethers" ], true);
-}
-
-module.exports = {
-    run: run,
-    runDist: runDist,
-    runBuild: runBuild,
-    setupBuild: setupBuild
-};

admin/changelog.js

@@ -1,113 +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";
-}
-
-module.exports = {
-    generate: generate,
-    ChangelogPath: ChangelogPath,
-}
-
-

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,92 +0,0 @@
-"use strict";
-
-const config = require("../config");
-
-const { getOrdered, loadPackage } = require("../depgraph");
-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;
-
-    // @TODO: Fail if there are any untracked files or unchecked in files
-
-    // Load the token from the encrypted store
-    try {
-        token = await config.get("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";
-        } 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.>");
-    }
-
-})();

admin/cmds/reset-build.js

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

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,20 +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";
-
-import * as ethers from "./ethers";
-
-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,87 +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 getConfigFilename() {
-    return resolve(os.homedir(), ".ethers-dist");
-}
-
-function getScrypt(message, password, salt) {
-    let progressBar = prompt.getProgressBar(message);
-    return new Promise((resolve, reject) => {
-        scrypt(Buffer.from(password), Buffer.from(salt), (1 << 17), 8, 1, 64, (error, progress, key) => {
-            if (error) { return reject(error); }
-            progressBar(progress);
-            if (key) { resolve(key); }
-        });
-    });
-}
-
-async function loadConfig(dkey) {
-    let config = { };
-
-    let filename = getConfigFilename();
-    if (fs.existsSync(filename)) {
-        let data = JSON.parse(fs.readFileSync(filename));
-        let ciphertext = Buffer.from(data.ciphertext, "base64");
-        let iv = Buffer.from(data.iv, "base64");
-        let aes = new AES.ModeOfOperation.ctr(dkey.slice(0, 32), new AES.Counter(iv));
-        let plaintext = aes.decrypt(ciphertext);
-        let hmac = computeHmac("sha512", dkey.slice(32, 64), plaintext);
-        if (hmac !== data.hmac) {
-            throw new Error("wrong password");
-        }
-        config = JSON.parse(Buffer.from(plaintext).toString());
-    }
-
-    return config;
-}
-
-async function getConfig(key) {
-    let password = await prompt.getPassword(colorify("Password (seesion-store): ", "bold"));
-    let dkey = await getScrypt(colorify("Decrypting", "bold"), password, key);
-
-    let config = await loadConfig(dkey);
-    return config[key];
-}
-
-async function setConfig(key, value) {
-    let password = await prompt.getPassword(colorify("Password (seesion-store): ", "bold"));
-    let dkey = await getScrypt("Encrypting", password, key);
-
-    let config = await loadConfig(dkey);
-    config[key] = value;
-    config._junk = Buffer.from(randomBytes(16 + parseInt(Math.random() * 48))).toString("base64")
-
-    let plaintext = Buffer.from(JSON.stringify(config));
-
-    let iv = Buffer.from(randomBytes(16));
-    let hmac = computeHmac("sha512", dkey.slice(32, 64), plaintext);
-
-    let aes = new AES.ModeOfOperation.ctr(dkey.slice(0, 32), new AES.Counter(iv));
-    let ciphertext = Buffer.from(aes.encrypt(plaintext));
-
-    let data = {
-        ciphertext: ciphertext.toString("base64"),
-        iv: iv.toString("base64"),
-        hmac: hmac
-    };
-
-    fs.writeFileSync(getConfigFilename(), JSON.stringify(data, null, 2));
-}
-
-module.exports = {
-    get: getConfig,
-    set: setConfig
-}

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/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,89 +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 savePackage(dirname, info) {
-    return saveJson(resolve(ROOT, dirname, "package.json"), 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/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) + " " + [
-        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
-}

dist/README.md

@@ -0,0 +1,22 @@
+Distribution Folder
+===================
+
+The contents of this folder are for using `import` in ESM
+browser-base projects.
+
+The `ethers.js` (and `ethers.min.js`) files only include the
+English wordlist to conserve space.
+
+For additional Wordlist support, the `wordlist-extra.js` (and
+`wordlist-extra.min.js`) should be imported too.
+
+
+Notes
+-----
+
+The contents are generated via the `npm build dist` target using
+`rollup` and the `/rollup.config.js` configuration.
+
+Do not modify the files in this folder. They are deleted on `build-clean`.
+
+To modify this `README.md`, see the `/output/post-build/dist`.

docs.wrm/README.md

@@ -1,16 +1,5 @@
-Documentation
-=============
+Documentation Source
+====================
 
-These docs are built using [Flatworm Docs](https://github.com/ricmoo/flatworm).
-
-The output is placed in [docs](../docs) and generates both HTML and Markdown
-files.
-
-
-Building
---------
-
-```
-/home/ricmoo/ethers.js> npm run build-docs 
-```
+This folder contains all the Flatworm source for the documentation.
 

docs.wrm/api/contract.wrm

@@ -1,8 +0,0 @@
-_title: Contracts
-
-_null: Contract @<contract>
-_section: Contracts
-
-Explain what contracts are...
-
-_subsection: Buckets

docs.wrm/api/index.wrm

@@ -1,11 +0,0 @@
-_title: Application Programming Interface
-
-_section: Application Programming Interface (API)
-
-Here...
-
-_toc:
-    contract
-    signer
-    providers
-    utils

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

@@ -1,54 +0,0 @@
-_title: API Providers
-
-_section: API Providers
-
-There are many services which offer a web API for accessing
-the Ethereum Blockchain. These Providers allow connecting
-to them, which simplifies development, since you do not need
-to run your own instance or cluster of Ethereum nodes.
-
-However, this reliance on third-party services can reduce
-resiliance, security and increase the amount of required trust.
-To mitigate these issues, it is recommended you use a
-[Default Provider](get-default-provider).
-
-
-_subsection: EtherscanProvider
-
-The **EtherscanProvider** is backed by a combination of the various
-[Etherscan APIs](https://etherscan.io/apis).
-
-_property: provider.getHistory(address) => Array<History>
-
-
-_subsection: InfuraProvider
-
-The **InfuraProvider** is backed by the popular [INFURA](https://infura.io)
-Ethereum service.
-
-It supports Mainnet (homestead) and all common testnets (Ropsten, Rinkeby,
-G&ouml;rli and Kovan).
-
-
-_subsection: NodesmithProvider
-
-The **NodesmithProvider** is backed by [Nodesmith](https://nodesmith.io).
-
-It supports Mainnet (homestead) and all common testnets (Ropsten, Rinkeby,
-G&ouml;rli and Kovan), as well as the Ethereum-like network [Aion](https://aion.network).
-
-
-_subsection: AlchemyProvider
-
-The **AlchemtProvider** is backed by [Alchemy](https://alchemyapi.io).
-
-It supports Mainnet (homestead) and all common testnets (Ropsten, Rinkeby,
-G&ouml;rli and Kovan).
-
-
-_subsection: CloudfrontProvider
-
-The CloudfrontProvider is backed by the
-[Cloudflare Ethereum Gateway](https://developers.cloudflare.com/distributed-web/ethereum-gateway/).
-
-It only supports Mainnet (homestead).

docs.wrm/api/providers/example-account.js

@@ -1,29 +0,0 @@
-// <hide>
-
-const { ethers } = require("./packages/ethers");
-const provider = ethers.getDefaultProvider()
-
-function _inspect(result) {
-    if (ethers.BigNumber.isBigNumber(result)) {
-        return `{ BigNumber: ${ JSON.stringify(result.toString()) } }`;
-    }
-    return JSON.stringify(result);
-}
-
-// </hide>
-
-// 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");
-//!

docs.wrm/api/providers/example-ens.js

@@ -1,15 +0,0 @@
-// <hide>
-
-const { ethers } = require("./packages/ethers");
-const provider = ethers.getDefaultProvider()
-
-// </hide>
-
-// Reverse lookup of an ENS by address...
-provider.lookupAddress("0x6fC21092DA55B392b045eD78F4732bff3C580e2c");
-//!
-
-// Lookup an address of an ENS name...
-provider.resolveName("ricmoo.firefly.eth");
-//!
-

docs.wrm/api/providers/index.wrm

@@ -1,46 +0,0 @@
-_title: Providers
-
-_section: Providers
-
-A **Provider** is an abstraction of a connection to the
-Ethereum network, providing a concise, consistent interface
-to standard Ethereum node functionality.
-
-The ethers.js library provides several options which should
-cover the vast majority of use-cases, but also includes the
-necessary functions and classes for sub-classing if a more
-custom configuration is necessary.
-
-Most users should be able to simply use the [[get-default-provider]].
-
-
-_subsection: Default Provider @<get-default-provider>
-
-The default provider is the safest, easiest way to begin
-developing on //Ethereum//, and it is also robust enough
-for use in production.
-
-It creates a [[provider-fallback]] connected to as many backend
-services as possible. When a request is made, it is sent to
-multiple backends simulatenously. As responses from each backend
-are returned, they are checked that they agree. Once a quorum
-has been reached (i.e. enough of the backends agree), the response
-is provided to your application.
-
-This ensures that if a backend has become out-of-sync, or if it
-has been compromised that its responses are dropped in favor of
-responses that match the majority.
-
-_property: ethers.getDefaultProvider([ network ]) => [[provider]]
-Returns a new Provider, backed by multiple services, connected
-to //network//. Is no //network// is provided, **homestead**
-(i.e. mainnet) is used.
-
-_subsection: Provider Documentation
-
-_toc:
-    provider
-    jsonrpc-provider
-    api-providers
-    other
-    types

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

@@ -1,22 +0,0 @@
-_title: JSON-RPC Provider
-
-_section: JSON-RPC Provider
-
-Explain here...
-
-_subsection: JsonRpcProvider  @<jsonrpc-provider>
-
-TODO...
-
-_property: provider.getSigner([ addressOrIndex ]) => [[jsonrpc-signer]]
-Returns a [[jsonrpc-signer]] which is managed by this Ethereum node, at
-//addressOrIndex//. If no //addressOrIndex// is provided, the first
-account (account #0) is used.
-
-_property: provider.getUncheckSigner([ addressOrIndex ]) => [[jsonrpc-uncheckedsigner]]
-
-_subsection: JsonRpcSigner @<jsonrpc-signer>
-TODO... Explain
-
-_subsection: JsonRpcUncheckedSigner @<jsonrpc-uncheckedsigner>
-TODO... Explain

docs.wrm/api/providers/other.wrm

@@ -1,27 +0,0 @@
-_title: Other Providers
-
-_section: Other Providers
-
-Others...
-
-_subsection: FallbackProvider @<provider-fallback>
-
-Explain...
-
-_heading: Properties
-
-_property: provider.providers => Array<[[provider]]>
-The list of Providers this is connected to.
-
-_property: provider.quorum => number
-The quorum the backend responses must agree upon before a result will be
-resolved. By default this is //half the sum of the weights//.
-
-_property: provider.weights => Array<number>
-The weight each of the Providers adds to a results acceptance.
-
-
-_subsection: IpcProvider @<provider-ipc>
-
-Explain...
-

docs.wrm/api/providers/provider.wrm

@@ -1,141 +0,0 @@
-_title: Abstract Provider
-
-
-_section: Provider @<provider>
-
-Explain what a provider is...
-
-
-_subsection: Accounts Methods
-
-_property: provider.getBalance(address [ , blockTag = "latest" ]) => Promise<[[bignumber]]>
-Returns the balance of //address// as of the //blockTag// block height.
-
-_property: provider.getCode(address [ , blockTag = "latest" ]) => Promise<[[hexstring]]>
-Returns the contract code of //address// as of the //blockTag// block height. If there is
-no contract currently deployed, the result is ``0x``.
-
-_property: provider.getStorageAt(address, position [ , blockTag = "latest" ]) => Promise<[[hexstring]]>
-Returns the ``Bytes32`` value of the //position// at //address//, as of the //blockTag//.
-
-_property: provider.getTransactionCount(address [ , blockTag = "latest" ]) => Promise<number>
-Returns the number of transactions //address// has ever **sent**, as of //blockTag//.
-This value is required to be the nonce for the next transaction from //address//
-sent to the network.
-
-_heading: Examples
-
-_code: example-account.js
-
-
-_subsection: Blocks Methods
-
-_property: provider.getBlock(block) => Promise<[[provider-block]]>
-Get the //block// from the network, where the ``result.transactions`` is a list
-of transaction hashes.
-
-_property: provider.getBlockWithTransactions(block) => Promise<[[provider-blocktxs]]>
-Get the //block// from the network, where the ``result.transactions`` is
-an Array of [[provider-transactionresponse]] objects.
-
-
-_subsection: Ethereum Naming Service (ENS) Methods
-
-TODO: Explain ENS here...
-
-_property: provider.lookupAddress(address) => Promise<string>
-Performs a reverse lookup of the //address// in ENS using the
-//Reverse Registrar//.  If the name does not exist, or the
-forward lookup does not match, ``null`` is returned.
-
-_property: provider.resovleName(name) => Promise<string>
-Looks up the address of //name//. If the name is not owned, or
-does not have a //Resolver// configured, or the //Resolver// does
-not have an address configured, ``null`` is returned.
-
-_heading: Examples
-
-_code: example-ens.js
-
-_subsection: Logs Methods
-
-_property: provider.getLogs(filter) => Promise<Array<[[provider-log]]>>
-Returns the Array of [[provider-log]] matching the //filter//.
-
-Keep in mind that many backends will discard old events, and that requests
-which are too broad may get dropped as they require too many resources to
-execute the query.
-
-
-_subsection: Network Status Methods
-
-_property: provider.getNetwork() => Promise<[[provider-network]]>
-Returns the [[provider-network]] this Provider is connected to.
-
-_property: provider.getBlockNumber() => Promise<number>
-Returns the block number (or height) of the most recently mined block.
-
-_property: provider.getGasPrice() => Promise<[[bignumber]]>
-Returns a //best guess// of the [[gas-price]] to use in a transaction.
-
-
-_subsection: Transactions Methods
-
-_property: provider.call(transaction [ , blockTag = "latest" ]) => Promise<[[hexstring]]>
-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.
-
-_property: provider.estimateGas(transaction) => Promise<[[bignumber]]>
-Returns an estimate of the amount of gas that would be required to submit //transaction//
-to the network.
-
-An estimate may not be accurate since there could be another transaction
-on the network that was not accounted for, but after being mined affected
-relevant state.
-
-_property: provider.sendTransaction(transaction) => Promise<[[provider-transactionresponse]]>
-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).
-
-_property: provider.waitForTransaction(transactionHash) => Promise<[[provider-transactionreceipt]]>
-Returns a Promise which will not resolve until //transactionHash// is mined.
-
-
-_subsection: Event Emitter Methods
-
-Explain events here...
-
-_property: provider.on(eventName, listener) => this
-Add a //listener// to be triggered for each //eventName//.
-
-_property: provider.once(eventName, listener) => this
-Add a //listener// to be triggered for only the next //eventName//,
-at which time it be removed.
-
-_property: provider.emit(eventName, ...args) => boolean
-Notify all listeners of //eventName//, passing //args// to each listener. This
-is generally only used internally.
-
-_property: provider.off(eventName [ , listener ]) => this
-Remove a //listener// for //eventName//. If no //listener// is provided,
-all listeners for //eventName// are removed.
-
-_property: provider.removeAllListeners([ eventName ]) => this
-Remove all the listeners for //eventName//. If no //eventName// is provided,
-**all** events are removed.
-
-_property: provider.listenerCount([ eventName ]) => number
-Returns the number of listeners for //eventName//. If no //eventName// is
-provided, the total number of listeners is returned.
-
-_property: provider.listeners(eventName) => Array<Listener>
-Returns the list of Listeners for //eventName//.
-
-
-_subsection: Inspection Methods
-
-_property: Provider.isProvider(object) => boolean
-Returns true if and only if //object// is a Provider.
-

docs.wrm/api/providers/types.wrm

@@ -1,75 +0,0 @@
-_title: Types
-
-_section: Types
-
-_heading: BlockTag @<provider-blocktag>
-A **BlockTag** specifies a specific location in the Blockchain.
-
-- **``"latest"``** -- The most recently mined block
-- **``"earliest"``** -- Block #0
-- **``"pending"``** -- The block currently being prepared for mining; not all
-  operations support this BlockTag
-- **//number//** -- The block at this height
-- **//a negative number//** -- The block this many blocks ago
-
-_heading: Network @<provider-network>
-A **Network** represents an Etherem network.
-
-- **name** -- The human-readable name of the network
-- **chainId** -- The Chain ID of the network
-- **ensAddress** -- The address at which the ENS registry is deployed
-
-
-_subsection: Blocks
-
-_heading: Block @<provider-block>
-TODO
-
-_heading: BlockWithTransactions @<provider-blocktxs>
-TODO
-
-
-_subsection: Events and Logs
-
-_heading: EventFilter
-TODO
-
-_heading: EventType
-TODO
-
-_heading: Filter
-TODO
-
-_heading: FilterByBlockHash
-TODO
-
-_heading: Log @<provider-log>
-A network...
-
-
-_subsection: Transactions
-
-_heading: TransactionRequest @<provider-transactionrequest>
-
-A transaction request describes a transaction that is to
-be sent to the network or otherwise processed.
-
-It contains the fields:
-- **to** --- target address
-- **from** --- target address
-- **nonce** --- target address
-- **gasLimit** --- target address
-- **gasPrice** --- target address
-- **data** --- target address
-- **value** --- target address
-- **chainId** --- target address
-
-All fields are optional and may be a promise which resolves
-to the required type.
-
-_heading: TransactionResponse @<provider-transactionresponse>
-
-A **TransactionResponse** ..
-
-_heading: TransactionReceipt @<provider-transactionreceipt>
-TODO

docs.wrm/api/signer.wrm

@@ -1,33 +0,0 @@
-_title: Signer
-
-_section: Signers
-
-Tra la la...
-
-_subsection: Signer @<signer>
-
-_property: signer.connect(provider) => [[signer]]
-TODO
-
-_heading: Blockchain Methods
-
-_property: signer.getBalance([ blockTag = "latest" ]) => Promise<[[bignumber]]>
-TODO
-
-_property: signer.getTransactionCount([ blockTag = "latest" ]) => Promise<number>
-TODO
-
-
-_subsection: Wallet inherits Signer
-
-The Wallet class inherits [[signer]] and can sign transactions and messages
-using a private key as a standard Externally Owned Account (EOA).
-
-_heading: Creating an Instance
-
-_property: new ethers.Wallet(privateKey [ , provider ])
-TODO
-
-_property: Wallet.fromEncryptedJson(json, password)
-TODO
-

docs.wrm/api/utils/address.wrm

@@ -1,21 +0,0 @@
-_title: Addresses
-
-_section: Addresses
-
-Explain addresses,formats and checksumming here.
-
-Also see: [Constants.AddressZero](constants)
-
-_heading: Functions
-
-_property: utils.getAddress(address) => string
-TODO
-
-_property: utils.isAddress(address) => boolean
-TODO
-
-_property: utils.getIcapAddress(address) => string
-TODO
-
-_property: utils.getContractAddress(transaction) => string
-TODO

docs.wrm/api/utils/bignumber-create.js

@@ -1,50 +0,0 @@
-// <hide>
-const { BigNumber } = require("./packages/ethers");
-const { constants } = require("./packages/ethers");
-
-function _inspect(result) {
-    if (BigNumber.isBigNumber(result)) {
-        return `{ BigNumber: ${ JSON.stringify(result.toString()) } }`;
-    }
-    return result;
-}
-// </hide>
-
-// From a decimal string...
-BigNumber.from("42")
-//!
-
-// From a hexstring...
-BigNumber.from("0x2a")
-//!
-
-// From a negative hexstring...
-BigNumber.from("-0x2a")
-//!
-
-// From an Array (or Uint8Array)...
-BigNumber.from([ 42 ])
-//!
-
-// From an existing BigNumber...
-let one1 = constants.One;
-let one2 = BigNumber.from(one1)
-
-one2
-//!
-
-// ...which returns the same instance
-one1 === one2
-//!
-
-// From a (safe) number...
-BigNumber.from(42)
-//!
-
-// From a ES2015 BigInt... (only on platforms with BigInt support)
-BigNumber.from(42n)
-//!
-
-// Numbers outside the safe range fail:
-BigNumber.from(Number.MAX_SAFE_INTEGER);
-//! error

docs.wrm/api/utils/bignumber-examples.js

@@ -1,16 +0,0 @@
-// <hide>
-const { BigNumber } = require("./packages/ethers");
-
-function _inspect(result) {
-    if (BigNumber.isBigNumber(result)) {
-        return `{ BigNumber: ${ JSON.stringify(result.toString()) } }`;
-    }
-    return result;
-}
-// </hide>
-
-let a = BigNumber.from(42);
-let b = BigNumber.from("91");
-
-  a.mul(b);
-  //!

docs.wrm/api/utils/bignumber-ieee754.js

@@ -1,2 +0,0 @@
-(Number.MAX_SAFE_INTEGER + 2 - 2) == (Number.MAX_SAFE_INTEGER)
-//!

docs.wrm/api/utils/bignumber-import.source

@@ -1,18 +0,0 @@
-/////
-// CommonJS:
-
-// From the Umbrella ethers package...
-const { BigNumber } = require("ethers");
-
-// From the bignumber pacakge...
-const { BigNumber } = require("@ethersproject/bignumber");
-
-
-/////
-// ES6 and TypeScript:
-
-// From the Umbrella ethers package...
-import { BigNumber } from "ethers";
-
-// From the bignumber pacakge...
-import { BigNumber } from "@ethersproject/bignumber";

docs.wrm/api/utils/bignumber.wrm

@@ -1,175 +0,0 @@
-_title: Big Number
-
-
-_section: BigNumber @<bignumber>
-
-Explain about BigNumber here...
-
-_heading: Importing
-
-_code: bignumber-import.source
-
-_subsection: Types
-
-_heading: BigNumberish @<bignumberish>
-
-Many functions and methods in this library take in values which
-can be non-ambiguously and safely converted to a BigNumber. These
-values can be sepcified as:
-
-_definition: **//string//**
-A [hexstring](hexstring) or a decimal string, either of which may
-be negative.
-
-_definition: **//BytesLike//**
-A [BytesLike](byteslike) Object, such as an Array or Uint8Array.
-
-_definition: **//BigNumber//**
-An existing BigNumber instance.
-
-_definition: **//number//**
-A number that is within the safe range for JavaScript numbers.
-
-_definition: **//BigInt//**
-A JavaScript [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt)
-object, on environments that support BigInt.
-
-
-_subsection: Creating Instances
-
-The constructor of BigNumber cannot be called directly. Instead, Use the static ``BigNumber.from``.
-
-_property: BigNumber.from(aBigNumberish) => [[bignumber]]
-Returns an instance of a **BigNumber** for //aBigNumberish//.
-
-_heading: Examples:
-
-_code: bignumber-create.js
-
-
-_subsection: Methods
-
-The BigNumber class is immutable, so no operations can change the value
-it represents.
-
-
-_heading: Math Operations
-
-_property: bignumber.add(otherValue) => [[bignumber]]
-Returns a BigNumber with the value of //bignumber// **+** //otherValue//.
-
-_property: bignumber.sub(otherValue) => [[bignumber]]
-Returns a BigNumber with the value of //bignumber// **&ndash;** //otherValue//.
-
-_property: bignumber.mul(otherValue) => [[bignumber]]
-Returns a BigNumber with the value of //bignumber// **&times;** //otherValue//.
-
-_property: bignumber.div(divisor) => [[bignumber]]
-Returns a BigNumber with the value of //bignumber// **&#247;** //divisor//.
-
-_property: bignumber.mod(divisor) => [[bignumber]]
-Returns a BigNumber with the value of the **remainder** of //bignumber// &#247; //divisor//.
-
-_property: bignumber.pow(exponent) => [[bignumber]]
-Returns a BigNumber with the value of //bignumber// to the power of //exponent//.
-
-_property: bignumber.abs() => [[bignumber]]
-Returns a BigNumber with the absolute value of //bignumber//.
-
-_property: bignumber.maskn(bitcount) => [[bignumber]]
-Returns a BigNumber with the value of //bignumber// with bits beyond
-the //bitcount// least significant bits set to zero.
-
-
-_heading: Two's Compliment
-
-[Two's Complicment](https://en.wikipedia.org/wiki/Two%27s_complement)
-is an elegant method used to encode and decode fixed-width signed values
-while efficiently preserving mathematic operations.
-Most users will not need to interact with these.
-
-_property: bignumber.fromTwos(bitwidth) => [[bignumber]]
-Returns a BigNumber with the value of //bignumber// converted from twos-compliment with //bitwidth//.
-
-_property: bignumber.toTwos(bitwidth) => [[bignumber]]
-Returns a BigNumber with the value of //bignumber// converted to twos-compliment with //bitwidth//.
-
-
-_heading: Comparison and Equivalence
-
-_property: bignumber.eq(otherValue) => boolean
-Returns true if and only if the value of //bignumber// is equal to //otherValue//.
-
-_property: bignumber.lt(otherValue) => boolean
-Returns true if and only if the value of //bignumber// **<** //otherValue//.
-
-_property: bignumber.lte(otherValue) => boolean
-Returns true if and only if the value of //bignumber// **&le;** //otherValue//.
-
-_property: bignumber.gt(otherValue) => boolean
-Returns true if and only if the value of //bignumber// **>** //otherValue//.
-
-_property: bignumber.gte(otherValue) => boolean
-Returns true if and only if the value of //bignumber// **&ge;** //otherValue//.
-
-_property: bignumber.isZero() => boolean
-Returns true if and only if the value of //bignumber// is zero.
-
-
-_heading: Conversion
-
-_property: bignumber.toNumber() => number
-Returns the value of //bignumber// as a JavaScript value.
-
-This will **throw an error**
-if the value is greater than or equal to //Number.MAX_SAFE_INTEGER// or less than or
-equal to //Number.MIN_SAFE_INTEGER//.
-
-_property: bignumber.toString() => string
-Returns the value of //bignumber// as a base-10 string.
-
-_property: bignumber.toHexString() => string
-Returns the value of //bignumber// as a base-16, `0x`-prefixed [hexstring](hexstring).
-
-
-_heading: Inspection
-
-_property: BigNumnber.isBigNumber(object) => boolean
-Returns true if and only if the //object// is a BigNumber object.
-
-
-_heading: Examples
-
-_code: bignumber-examples.js
-
-_subsection: Notes
-
-A few short notes on numbers...
-
-_heading: Why can't I just use numbers?
-
-The first problem many encounter when dealing with Ethereum is
-the concept of numbers. Most common currencies are broken down
-with very little granularity. For example, there are only 100
-cents in a single dollar. However, there are 10^^18^^ **wei** in a
-single **ether**.
-
-JavaScript uses [IEEE 754 double-precision binary floating point](https://en.wikipedia.org/wiki/Double-precision_floating-point_format)
-numbers to represent numeric values. As a result, there are //holes//
-in the integer set after 9,007,199,254,740,991; which is
-problematic for //Ethereum// because that is only around 0.009
-ether (in wei), which means any value over that will begin to
-experience rounding errors.
-
-To demonstrate how this may be an issue in your code, consider:
-
-_code: bignumber-ieee754.js
-
-To remedy this, all numbers (which can be large) are stored
-and manipulated as [Big Numbers](bignumber).
-
-The functions [parseEther( etherString )](http://linkto) and
-[formatEther( wei )](http://linkto) can be used to convert
-between string representations, which are displayed to or entered
-by the user and Big Number representations which can have
-mathematical operations handled safely.

docs.wrm/api/utils/bytes-conversion.js

@@ -1,37 +0,0 @@
-// <hide>
-
-const { ethers } = require("./packages/ethers");
-const { arrayify, hexlify, hexValue } = ethers.utils;
-
-function _inspect(result) {
-    if (result && typeof(result.length) === "number" && typeof(result) !== "string") {
-        return "[ " + Array.prototype.map.call(result, (i) => _inspect(i)).join(", ") + " ]";
-    }
-    return result;
-}
-
-// </hide>
-
-// Convert a hexstring to a Uint8Array
-arrayify("0x1234")
-//!
-
-// Convert an Array to a hexstring
-hexlify([1, 2, 3, 4])
-//!
-
-// Convert an Object to a hexstring
-hexlify({ length: 2, "0": 1, "1": 2 })
-//!
-
-// Convert an Array to a hexstring
-hexlify([ 1 ])
-//!
-
-// Convert a number to a stripped hex value
-hexValue(1)
-//!
-
-// Convert an Array to a stripped hex value
-hexValue([ 1, 2 ])
-//!

docs.wrm/api/utils/bytes.wrm

@@ -1,121 +0,0 @@
-_title: Byte Manipulation
-
-_section: Byte Manipulation
-
-Tra la la...
-
-_subsection: Types
-
-_heading: Bytes @<bytes>
-
-A Bytes object is any object which is an
-[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) or
-[TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) with
-each value in the valid byte range (i.e. between 0 and 255 inclusive),
-or is an Object with a ``length`` property where each indexed property
-is in the valid byte range.
-
-_heading: BytesLike @<byteslike>
-
-A **BytesLike** can be either a [[bytes]] or a [[hexstring]].
-
-_heading: Hexstring @<hexstring>
-
-A **hexstring** is a string which has a ``0x`` prefix followed by 
-
-_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](https://link_here) of the **(r, s)** and **v**
-- **recoveryParam** --- The normalized (i.e. 0 or 1) value of **v**
-
-_heading: SignatureLike @<signaturelike>
-
-A **SignatureLike** is similar to a [[signature]], except redundant properties
-may be omitted.
-
-For example, if *_vs* is specified, **(r, s)** and **v** can be omitted. Likewise,
-if **recoverParam** is provided, **v** can be omitted (as it can be computed).
-
-
-_subsection: Inspection
-
-_property: utils.isBytes(object) => boolean
-Returns true if and only if //object// is a valid [[bytes]].
-
-_property: utils.isBytesLike(object) => boolean
-Returns true if and only if //object// is a [[bytes]] or an Array or TypedArray
-where each value is a valid byte (i.e. between 0 and 255 inclusive).
-
-_property: utils.isHexString(object, [ length ] ) => boolean
-Returns true if and only if //object// is a valid hex string;
-if //length// is specified the length (in bytes) is also verified.
-
-
-_subsection: Converting between Arrays and Hexstrings
-
-_property: utils.arrayify(hexstringOrArrayish [ , options ]) => Uint8Array
-Converts //hexstringOrArrayish// to a Uint8Array. If a [[hexstring]]
-is passed in, the length must be even.
-
-_property: utils.hexlify(hexstringOrArrayish) => string
-Converts //hexstringOrArrayish// to a [[hexstring]]. The result
-will always be zero-padded to even length.
-
-_property: utils.hexValue(aBigNumberish) => string
-Converts //aBigNumberish// to a [[hexstring]], with no unecessary leading
-zeros. The result of this function can be of odd-length.
-
-_heading: Examples
-
-_code: bytes-conversion.js
-
-
-_subsection: Array Manipulation
-
-_property: utils.concat(arrayOfBytesLike) => Uint8Array
-Concatenates all the [[byteslike]] in //arrayOfBytesLike//
-into a single Uint8Array.
-
-_property: utils.stripZeros(aBytesLike) => Uint8Array
-Concatenates all the [[byteslike]] in //arrayOfBytesLike//
-
-_property: utils.zeroPad(aBytesLike, length) => Uint8Array
-Concatenates all the [[byteslike]] in //arrayOfBytesLike//
-
-
-_subsection: Hexstring Manipulation
-
-_property: utils.hexConcat(arrayOfBytesLike) => string
-Concatenates all the [[byteslike]] in //arrayOfBytesLike//
-into a single [[hexstring]]
-
-_property: utils.hexDataLength(aBytesLike) => number
-Returns the length (in bytes) of //aBytesLike//.
-
-This will **throw and error** if //aBytesLike// is a [[hexstring]]
-but is of odd-length.
-
-_property: utils.hexDataSlice(aBytesLike, offset [ , endOffset ] ) => string
-Returns the length (in bytes) of //aBytesLike//.
-
-_property: utils.hexStripZeros(aBytesLike) => string
-@TODO
-
-_property: utils.hexZeroPad(aBytesLike, length) => string
-@TODO
-
-
-_subsection: Signature Conversion
-
-_property: utils.joinSignature(aSignatureLike) => string
-Return the flat-format of a [[signaturelike]], which is
-65 bytes (130 nibbles) long, concatenating the **r**, **s** and **v**
-of a Signature.
-
-_property: utils.splitSignature(aSignatureLikeOrBytesLike) => Signature
-Return the full expanded-format of a [[signaturelike]] or
-a flat-format [[hexstring]]. Any missing properties will be
-computed.
-

docs.wrm/api/utils/constants-import.js

@@ -1,3 +0,0 @@
-
-//const { constants } = require("ethers");
-// const { constants } = require("@ethersproject/constants");

docs.wrm/api/utils/constants.wrm

@@ -1,49 +0,0 @@
-_title: Constants
-
-_section: Constants @<constants>
-
-The **ethers.contants** Object contains commonly used values.
-
-_heading: Importing
-
-_code: constants-import.js
-
-
-_subsection: Bytes
-
-_property: constants.AddressZero
-The Address Zero, which is 20 bytes (40 nibbles) of zero.
-
-_property: constants.HashZero
-The Hash Zero, which is 32 bytes (64 nibbles) of zero.
-
-
-_subsection: Strings
-
-_property: constants.EtherSymbol
-The Ether symbol, **&Xi;**.
-
-
-_subsection: BigNumber
-
-_property: constants.NegativeOne
-The BigNumber value representing ``"-1"``.
-
-_property: constants.Zero
-The BigNumber value representing ``"0"``.
-
-_property: constants.One
-The BigNumber value representing ``"1"``.
-
-_property: constants.Two
-The BigNumber value representing ``"2"``.
-
-_property: constants.WeiPerEther
-The BigNumber value representing ``"1000000000000000000"``, which is the
-number of Wei per Ether.
-
-_property: constants.MaxUint256
-The BigNumber value representing the maximum ``uint256`` value.
-
-
-

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

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

docs.wrm/api/utils/fixednumber.wrm

@@ -1,80 +0,0 @@
-_title: Fixed Number
-
-_section: FixedNumber @<fixednumber>
-
-
-_subsection: Types
-
-
-_heading: FixedFormat @<fixedformat>
-TODO
-
-_definition: **//"fixed"//**
-A shorthand for ``fixed128x80``.
-
-_subsection: Creating Instances
-
-The FixedNumber constructor cannot be called directly. There are several
-static methods for creating a FixedNumber.
-
-_property: BigNumber.from(value [ , format = "fixed" ] ) => [[fixednumber]]
-Returns an instance of a **FixedNumber** for //value// as a //format//.
-
-_property: BigNumber.fromBytes(aBytesLike [ , format = "fixed" ] ) => [[fixednumber]]
-Returns an instance of a **FixedNumber** for //value// as a //format//.
-
-_property: BigNumber.fromString(value [ , format = "fixed" ] ) => [[fixednumber]]
-Returns an instance of a **FixedNumber** for //value// as a //format//. The //value// must
-not contain more decimals than the //format// permits.
-
-_property: BigNumber.fromValue(value [ , decimals = 0 [ , format = "fixed" ] ] ) => [[fixednumber]]
-Returns an instance of a **FixedNumber** for //value// with //decimals// as a //format//.
-
-
-_subsection: Properties
-
-_property: fixednumber.format
-The [FixedFormat](fixedformat) of //fixednumber//.
-
-
-_subsection: Methods
-
-_heading: Math Operations
-
-_property: fixednumber.addUnsafe(otherValue) => [[fixednumber]]
-Returns a new FixedNumber with the value of //fixedvalue// **+** //otherValue//.
-
-_property: fixednumber.subUnsafe(otherValue) => [[fixednumber]]
-Returns a new FixedNumber with the value of //fixedvalue// **&ndash;** //otherValue//.
-
-_property: fixednumber.mulUnsafe(otherValue) => [[fixednumber]]
-Returns a new FixedNumber with the value of //fixedvalue// **&times;** //otherValue//.
-
-_property: fixednumber.divUnsafe(otherValue) => [[fixednumber]]
-Returns a new FixedNumber with the value of //fixedvalue// **&#247;** //otherValue//.
-
-_property: fixednumber.round([ decimals = 0 ]) => [[fixednumber]]
-Returns a new FixedNumber with the value of //fixedvalue// rounded to //decimals//.
-
-
-_heading: Conversion
-
-_property: fixednumber.toFormat(format) => [[fixednumber]]
-Returns a new FixedNumber with the value of //fixedvalue// with //format//.
-
-_property: fixednumber.toHexString() => string
-Returns a [Hexstring](hexstring) representation of //fixednumber//.
-
-_property: fixednumber.toString() => string
-Returns a string representation of //fixednumber//.
-
-_property: fixednumber.toUnsafeFloat() => float
-Returns a floating-point JavaScript number value of //fixednumber//.
-Due to rounding in JavaScript numbers, the value is only approximate.
-
-
-_heading: Inspection
-
-_property: BigNumber.isFixedNumber(value) => boolean
-Returns true if and only if //value// is a **FixedNumber**.
-

docs.wrm/api/utils/hashing.wrm

@@ -1,71 +0,0 @@
-_title: Hashing
-
-_section: Hashing Algorithms
-
-Explain what hash functions are?
-
-
-_subsection: Cryptographic Hashing
-
-The [Cryptographic Hash Functions](https://en.wikipedia.org/wiki/Cryptographic_hash_function)
-are a specific family of hash functions.
-
-_property: utils.keccak256(aBytesLike) => string
-Returns the [KECCAK256](https://en.wikipedia.org/wiki/SHA-3) digest //aBytesLike//.
-
-_property: utils.ripemd160(aBytesLike) => string
-Returns the [RIPEMD-160](https://en.m.wikipedia.org/wiki/RIPEMD) digest of //aBytesLike//.
-
-_property: utils.sha256(aBytesLike) => string
-Returns the [SHA2-256](https://en.wikipedia.org/wiki/SHA-2) digest of //aBytesLike//.
-
-_property: utils.sha512(aBytesLike) => string
-Returns the [SHA2-512](https://en.wikipedia.org/wiki/SHA-2) digest of //aBytesLike//.
-
-_property: utils.computeHmac(algorithm, key, data) => string
-Returns the [HMAC](https://en.wikipedia.org/wiki/HMAC) of //data// with //key//
-using the [Algorithm](supported-algorithm) //algorithm//.
-
-
-_heading: HMAC Supported Algorithms @<supported-algorithm>
-
-_property: utils.SupportedAlgorithms.sha256
-Use the [SHA2-256](https://en.wikipedia.org/wiki/SHA-2) hash algorithm.
-
-_property: utils.SupportedAlgorithms.sha512
-Use the [SHA2-512](https://en.wikipedia.org/wiki/SHA-2) hash algorithm.
-
-
-_subsection: Common Hashing Helpers
-
-_property: utils.hashMessage(message) => string
-Computes the Ethereum message digest of //message//. Ethereum messages are
-converted to UTF-8 bytes and prefixed with ``\x19Ethereum Signed Message:``
-and the length of //message//.
-
-_property: utils.id(text) => string
-The Ethereum Identity function computs the keccak256 hash of the //text// bytes.
-
-_property: utils.namehash(name) => string
-Returns the [ENS Namehash](https://docs.ens.domains/contract-api-reference/name-processing#hashing-names) of //name//.
-
-
-_subsection: Solidity Hashing Algorithms
-
-When using the Solidity ``abi.packEncoded(...)`` function, a non-standard
-//tightly packed// version of encoding is used. These functions implement
-the tightly packing algorithm.
-
-_property: utils.solidityPack(arrayOfTypes, arrayOfValues) => string
-Returns the non-standard encoded //arrayOfValues// packed according to
-their respecive type in //arrayOfTypes//.
-
-_property: utils.solidityKeccak256(arrayOfTypes, arrayOfValues) => string
-Returns the KECCAK256 of the non-standard encoded //arrayOfValues// packed
-according to their respective type in //arrayOfTypes//.
-
-_property: utils.soliditySha256(arrayOfTypes, arrayOfValues) => string
-Returns the SHA2-256 of the non-standard encoded //arrayOfValues// packed
-according to their respective type in //arrayOfTypes//.
-
-

docs.wrm/api/utils/index.wrm

@@ -1,16 +0,0 @@
-_title: Utilities
-
-_section: Utilities
-
-These utilities are used extensively within the library, but
-are also quite useful for application developers.
-
-_toc:
-    address
-    bignumber
-    bytes
-    constants
-    display-logic
-    fixednumber
-    hashing
-    strings

docs.wrm/api/utils/strings.wrm

@@ -1,92 +0,0 @@
-_title: Strings
-
-_section: Strings
-
-Tra la la
-
-
-_subsection: Bytes32String @<bytes32-string>
-
-A string in Solidity is length prefixed with its 256-bit (32 byte)
-length, which means that even short strings require 2 words (64 bytes)
-of storage.
-
-In many cases, we deal with short strings, so instead of prefixing
-the string with its length, we can null-terminate it and fit it in a
-single word (32 bytes). Since we need only a single byte for the
-null termination, we can store strings up to 31 bytes long in a
-word.
-
-_definition: **Note:**
-Strings that are 31 __//bytes//__ long may contain fewer than 31 __//characters//__,
-since UTF-8 requires multiple bytes to encode international characters.
-
-_property: utils.parseBytes32String(aBytesLike) => string
-Returns the decoded string represented by the ``Bytes32`` encoded data.
-
-_property: utils.formatBytes32String(text) => string
-Returns a ``bytes32`` string representation of //text//. If the
-length of //text// exceeds 31 bytes, it will throw an error.
-
-
-_subsection: UTF-8 Strings @<utf8-string>
-
-_property: utils.toUtf8Bytes(text [ , form = current ] ) => Uint8Array
-Returns the UTF-8 bytes of //text//, optionally normalizing it using the
-[[unicode-normalization-form]] //form//.
-
-_property: utils.toUtf8CodePoints(aBytesLike [ , form = current ] ) => Array<number>
-Returns the Array of codepoints of //aBytesLike//, optionally normalizing it using the
-[[unicode-normalization-form]] //form//.
-
-**Note:** This function correctly splits each user-perceived character into
-its codepoint, accounting for surrogate pairs. This should not be confused with
-``string.split("")``, which destroys surrogate pairs, spliting between each UTF-16
-codeunit instead.
-
-_property: utils.toUtf8String(aBytesLike [ , ignoreErrors = false ] ) => string
-Returns the string represented by the UTF-8 bytes of //aBytesLike//. This will
-throw an error for invalid surrogates, overlong sequences or other UTF-8 issues,
-unless //ignoreErrors// is specified.
-
-
-_heading: UnicodeNormalizationForm @<unicode-normalization-form>
-
-There are several [commonly used forms](https://en.wikipedia.org/wiki/Unicode_equivalence)
-when normalizing UTF-8 data, which allow strings to be compared or hashed in a stable
-way.
-
-_property: utils.UnicodeNormalizationForm.current
-Maintain the current normalization form.
-
-_property: utils.UnicodeNormalizationForm.NFC
-The Composed Normalization Form. This form uses single codepoints
-which represent the fully composed character.
-
-For example, the **&eacute;** is a single codepoint, ``0x00e9``.
-
-_property: utils.UnicodeNormalizationForm.NFD
-The Decomposed Normalization Form. This form uses multiple codepoints
-(when necessary) to compose a character.
-
-For example, the **&eacute;**
-is made up of two codepoints, ``"0x0065"`` (which is the letter ``"e"``)
-and ``"0x0301"`` which is a special diacritic UTF-8 codepoint which
-indicates the previous character should have an acute accent.
-
-_property: utils.UnicodeNormalizationForm.NFKC
-The Composed Normalization Form with Canonical Equivalence. The Canonical
-representation folds characters which have the same syntactic representation
-but different semantic meaning.
-
-For example, the Roman Numeral **I**, which has a UTF-8
-codepoint ``"0x2160"``, is folded into the capital letter I, ``"0x0049"``.
-
-_property: utils.UnicodeNormalizationForm.NFKD
-The Decomposed Normalization Form with Canonical Equivalence.
-See NFKC for more an example.
-
-_definition: **Note:**
-Only certain specified characters are folded in Canonical Equivalence, and thus
-it should not be considered a method to acheive //any// level of security from
-[homoglyph attacks](https://en.wikipedia.org/wiki/IDN_homograph_attack).

docs.wrm/basics/abi.wrm

@@ -0,0 +1,97 @@
+_section: Application Binary Interfaces  @<docs-abi>
+
+When interacting with any application, whether it is on Ethereum,
+over the internet or within a compiled application on a computer
+all information is stored and sent as binary data which is just a
+sequence of bytes.
+
+So every application must agree on how to encode and decode their
+information as a sequence of bytes.
+
+An **Application Binary Interface** (ABI) provides a way to describe
+the encoding and decoding process, in a generic way so that a variety
+of types and structures of types can be defined.
+
+For example, a string is often encoded as a UTF-8 sequence of bytes,
+which uses specific bits within sub-sequences to indicate emoji and
+other special characters. Every implementation of UTF-8 must understand
+and operate under the same rules so that strings work universally. In
+this way, UTF-8 standard is itself an ABI.
+
+When interacting with Ethereum, a contract received a sequence of bytes
+as input (provided by sending a transaction or through a call) and
+returns a result as a sequence of bytes. So, each Contract has its own
+ABI that helps specify how to encode the input and how to decode the output.
+
+It is up to the contract developer to make this ABI available. Many
+Contracts implement a standard (such as ERC-20), in which case the
+ABI for that standard can be used. Many developers choose to verify their
+source code on Etherscan, in which case Etherscan computes the ABI and
+provides it through their website (which can be fetched using the ``getContract``
+method). Otherwise, beyond reverse engineering the Contract there is
+not a meaningful way to extract the contract ABI.
+
+_subsection: Call Data Representation
+
+When calling a Contract on Ethereum, the input data must be encoded
+according to the ABI.
+
+The first 4 bytes of the data are the **method selector**, which is
+the keccak256 hash of the normalized method signature.
+
+Then the method parameters are encoded and concatenated to the selector.
+
+All encoded data is made up of components padded to 32 bytes, so the length
+of input data will always be congruent to ``4 mod 32``.
+
+The result of a successful call will be encoded values, whose components
+are padded to 32 bytes each as well, so the length of a result will always
+be congruent to ``0 mod 32``, on success.
+
+The result of a reverted call will contain the **error selector** as the
+first 4 bytes, which is the keccak256 of the normalized error signature,
+followed by the encoded values, whose components are padded to 32 bytes
+each, so the length of a revert will be congruent to ``4 mod 32``.
+
+The one exception to all this is that ``revert(false)`` will return a
+result or ``0x``.
+
+
+_subsection: Event Data Representation
+
+When an Event is emitted from a contract, there are two places data is
+logged in a Log: the **topics** and the **data**.
+
+An additonal fee is paid for each **topic**, but this affords a topic
+to be indexed in a bloom filter within the block, which allows efficient
+filtering.
+
+The **topic hash** is always the first topic in a Log, which is the
+keccak256 of the normalized event signature. This allows a specific
+event to be efficiently filtered, finding the matching events in a block.
+
+Each additional **indexed** parameter (i.e. parameters marked with
+``indexed`` in the signautre) are placed in the topics as well, but may be
+filtered to find matching values.
+
+All non-indexed parameters are encoded and placed in the **data**. This
+is cheaper and more compact, but does not allow filtering on these values.
+
+For example, the event ``Transfer(address indexed from, address indexed to, uint value)``
+would require 3 topics, which are the topic hash, the ``from`` address
+and the ``to`` address and the data would contain 32 bytes, which is
+the padded big-endian representation of ``value``. This allows for
+efficient filtering by the event (i.e. ``Transfer``) as well as the ``from``
+address and ``to`` address.
+
+
+_subsection: Deployment
+
+When deploying a transaction, the data provided is treated as **initcode**,
+which executes the data as normal EVM bytecode, which returns a sequence
+of bytes, but instead of that sequence of bytes being treated as data that
+result is instead the bytecode to install as the bytecode of the contract.
+
+The bytecode produced by Solidity is designed to have all constructor
+parameters encoded normally and concatenated to the bytecode and provided
+as the ``data`` to a transaction with no ``to`` address.

docs.wrm/basics/index.wrm

@@ -0,0 +1,8 @@
+_section: Ethereum Basics @<docs-basics> @priority<99>
+
+This section aims to cover some of the basics for those interested
+in a deeper understanding of the inner-workings of Ethereum.
+
+_subsection: Topics
+
+- [Application Binary Interface](docs-abi)

docs.wrm/concepts/events.wrm

@@ -1,5 +0,0 @@
-_title: Events
-
-_section: Events
-
-Explain how topics and such work

docs.wrm/concepts/gas.wrm

@@ -1,13 +0,0 @@
-_title: Gas
-
-_section: Gas
-
-_subsection: Gas Price @<gas-price>
-
-The gas price is used somewhat like a bid, indicating an amount
-you are willing to pay (per unit of execution) to have your transaction
-processed.
-
-_subsection: Gas Limit @<gas-limit>
-
-

docs.wrm/concepts/index.wrm

@@ -1,10 +0,0 @@
-_title: Concepts
-
-_section: Concepts
-
-This is a very breif overview of some aspects of //Ethereum//
-which developers can make use of or should be aware of.
-
-_toc:
-    events
-    gas

docs.wrm/config.json

@@ -1,9 +0,0 @@
-{
-  "title": "ethers",
-  "subtitle": "v5.0-beta",
-  "logo": "logo.svg",
-  "link": "https://docs-beta.ethers.io",
-  "markdown": {
-      "banner": "-----\n\nDocumentation: [html](https://docs-beta.ethers.io/)\n\n-----\n\n"
-  }
-}

docs.wrm/config.mjs

@@ -0,0 +1,86 @@
+import { inspect } from "util";
+
+import * as ethers from "../lib.esm/index.js";
+import { version } from "../lib.esm/_version.js";
+
+import { getModifiedTime } from "../lib.esm/_admin/utils/git.js";
+
+const title = "ethers";
+
+const subtitle = (function(version) {
+    const dash = version.indexOf("-");
+    if (dash === -1) { return version; }
+    return version.substring(dash + 1);
+})(version);
+
+const extraLinks = function() {
+    return [
+      `link-cdnjs [ethers.min.js](https:/\/cdnjs.cloudflare.com/ajax/libs/ethers/${ version }/ethers.min.js)`,
+      `link-cdnjs-wordlists [wordlists-extra.min.js](https:/\/cdnjs.cloudflare.com/ajax/libs/ethers/${ version }/wordlists-extra.min.js)`,
+    ];
+}
+
+export default {
+  title, subtitle,
+
+  // Where all the basic documentation is
+  docRoot: ".",
+
+  // Where all the code is for the jsdocs API crawler
+  codeRoot: "../src.ts/index.ts",
+
+  // Place all files in the /v6/ folder
+  prefix: "v6",
+
+  // Prepare the context for running the examples
+  contextify: function(context) {
+    Object.assign(context, ethers);
+    context.provider = new ethers.InfuraProvider();
+    context.Uint8Array = Uint8Array;
+
+    ethers.InfuraProvider.prototype[inspect.custom] = function(depth, options, inspect) {
+      if (depth > 0) { return `InfuraProvider { ... }`; }
+      // Does this cause infinite recursion??
+      return this;
+    };
+
+    ethers.Interface.prototype[inspect.custom] = function(depth, options, inspect) {
+      if (depth > 0) { return `Interface { ... }`; }
+      // Does this cause infinite recursion??
+      return this;
+    };
+
+    ethers.Fragment.prototype[inspect.custom] = function(depth, options, inspect) {
+      if (depth > 0) { return `${ this.constructor.name } { ... }`; }
+      // Does this cause infinite recursion??
+      return this;
+    };
+  },
+
+  // The base URL to use for the <src> links
+  srcBaseUrl: "https:/\/github.com/ethers-io/ethers.js/blob/main/src.ts/{FILENAME}#L{LINENO}",
+
+  // Used at the bottom of each page to indicate the last-modified-time.
+  // This uses the most recent time in the repo that the file was
+  // updated.
+  getTimestamp: function(path) {
+      return getModifiedTime(path);
+  },
+
+  // All the links to pull in
+  links: [
+    "./links/javascript.txt",
+    "./links/npm.txt",
+    "./links/projects.txt",
+    "./links/ricmoo.txt",
+    "./links/specs.txt",
+    "./links/wiki.txt",
+    extraLinks
+  ],
+
+  // Extra files to copy over to the /static folder
+  staticFiles: [
+    "logo.svg",
+    "social.jpg"
+  ]
+};

docs.wrm/contributing.wrm

@@ -1,35 +1,123 @@
-_title: Contributing and Hacking
+_section: Contributions and Hacking @<about-contrib> @priority<-90>
 
-_section: Contributing and Hacking
+Pull requests are welcome, but please keep the following in mind:
 
-The ethers.js library is something that I've written out of necessity,
-and has grown somewhat organically over time.
-
-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:
-
-- Backwards-compatibility-breaking changes will not be accepted; they may be
-  considered for the next major version
-- Security is important; adding dependencies require fairly convincing
-  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
+- Backwards-compatibility-breaking changes will not be accepted;
+  they may be considered for the next major version
+- Security is important; adding dependencies require fairly
+  convincing 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 (the ``build-clean`` target includes these stats)
+- Keep the PR simple, readable and confined to the relevant
+  files; see below for which files to change
 - 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
+- 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
+- Everyone is working hard; **be kind and respectful**
 
-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.
-**:)**
+It is always //highly recommended// that you open a [[link-discussion]]
+**before** beginning a PR.
 
 
-_subsection: Building
+_subsection: Documentation  @<about-contrib-docs>
 
-use npm run auto-build
+The documentation is an area which can always benefit from extra
+eyes, extra knowledge and extra examples.
 
-use npm run update-version
+Contributing to the documentation is welcome, but when making
+changes to documentation, please ensure that all changes are
+made **only** to:
+
+- Updating ``/docs.wrm/*\*.wrm``
+- Adding links: ``/docs.wrm/links/*.txt``
+- Updating API jsdocs: ``/*\* ... */`` comment blocks within ``/src.ts/``
+
+Generally changes to ``/docs.wrm/config.wrm`` should not be
+made, and if you feel it is necessary, please consider opening
+a [[link-discussion]] first.
+
+Similarly, when adding a new sections, a [[link-discussion]] is
+preferred.
+
+All changes should be in the Flatworm Markdown Dialect.
+
+_heading: Building the Documentation
+
+Currently, the documentation is built using an experimental v2 of the
+Flatworm documentation system, a system originally specifically made
+to maintain the Ethers documentation.
+
+The new ``tsdocs`` branch has the ability to parse ``jsdocs`` from
+from TypeScript source files to create an API reference.
+
+_code: Building with the v2 Flatworm @lang<shell>
+
+  # Clone the repo
+  /home/ricmoo> git clone https://github.com/ricmoo/flatworm.git
+  /home/ricmoo> cd flatworm
+
+  # Check out the tsdocs branch
+  /home/ricmoo/flatworm> git checkout tsdocs
+
+  # Install the necessary dependencies
+  /home/ricmoo/flatworm> npm install
+
+  # Ready to build the docs; output to a folder ./output/
+  /home/ricmoo/flatworm> node lib/cli-test PATH_TO_WRM_ROOT
+
+Eventually the code for the v2 branch will be cleaned up, and it
+will be much easier to include as a ``devDependency`` for Ethers.
+
+In the meantime, expect new changes to be made frequently to the
+``tsdocs`` branch, so for stability you may wish to checkout a
+specific hash.
+
+
+_subsection: Fixing Bugs  @<about-contrib-bugs>
+
+In general the **only** files you should ever include in a PR are:
+
+- TypeScript source: ``/src.ts/*\*.ts``
+
+Do not include a ``package.json`` with the updated ``tarballHash``
+or ``version``, and do not include any generated files in your PR.
+
+A bug fix **must not** modify anything requiring a minor version
+bump (see [[about-contrib-feature]]), such as changing a method
+signature or altering the exports.
+
+
+_subsection: Adding Features  @<about-contrib-feature>
+
+Contributing new features usually require a deeper understanding
+of the internal interactions with Ethers and its components, and
+generally requires a minor version bump.
+
+When making any of the following changes, you must first open a
+[[link-discussion]] as the minor version will need to be bumped.
+
+- any signature change (such as adding a parameter, changing a
+  parameter type, changing the return type)
+- adding any new export; such as a class, function or constants
+- adding any method to any class
+- changing any ``exports`` property within the ``package.json``
+
+Changes of this sort should not be made without serious consideration
+and discussion.
+
+
+_subsection: Building  @<building>
+
+_code: @lang<shell>
+  /home/ricmoo> git clone @TODO
+  /home/ricmoo> cd ethers
+  /home/ricmoo/ethers> npm install
+  /home/ricmoo/ethers> npm run auto-build
+
+_null:
+
+
+_subsection: Previewing Documentation
 

docs.wrm/cookbook/ens.wrm

@@ -0,0 +1,66 @@
+_section: Cookbook: ENS Recipes  @<cookbook-ens>
+
+Here is a collection of short, but useful examples of working with
+ENS entries.
+
+
+_subsection: Get all Text records  @<cookbook-ens-allText>
+
+Here is a short recipe to get all the text records set for an ENS
+name.
+
+It first queries all ``TextChanged`` events on the resovler, and
+uses a MulticallProvider to batch all the ``eth_call`` queries
+for each key into a single ``eth_call``. As such, you will need
+to install:
+
+``/home/ricmoo> npm install @ethers-ext/provider-multicall``
+
+
+_code: Fetching all ENS text records.  @lang<script>
+
+import { ethers } from "ethers";
+import { MulticallProvider } from "@ethers-ext/provider-multicall";
+
+async function getTextRecords(_provider, name) {
+  // Prepare a multicall-based provider to batch all the call operations
+  const provider = new MulticallProvider(_provider);
+
+  // Get the resolver for the given name
+  const resolver = await provider.getResolver(name);
+
+  // A contract instance; used filter and parse logs
+  const contract = new ethers.Contract(resolver.address, [
+    "event TextChanged(bytes32 indexed node, string indexed _key, string key)"
+  ], provider);
+
+  // A filter for the given name
+  const filter = contract.filters.TextChanged(ethers.namehash(name));
+
+  // Get the matching logs
+  const logs = await contract.queryFilter(filter);
+
+  // Filter the *unique* keys
+  const keys = [ ...(new Set(logs.map((log) => log.args.key))) ];
+
+  // Get the values for the keys; failures are discarded
+  const values = await Promise.all(keys.map((key) => {
+      try {
+          return resolver.getText(key);
+      } catch (error) { }
+      return null;
+  }));
+
+  // Return a Map of the key/value pairs
+  return keys.reduce((accum, key, index) => {
+      const value = values[index];
+      if (value != null) { accum.set(key, value); }
+      return accum;
+  }, new Map());
+}
+
+// Example usage
+(async function() {
+  const provider = new ethers.InfuraProvider();
+  console.log(await getTextRecords(provider, "ricmoo.eth"));
+})();

docs.wrm/cookbook/index.wrm

@@ -1,7 +1,7 @@
-_title: Cookbook
-
-_section: Cookbook
-
-Cooking...
+_section: Cookbook @<cookbook>
 
+A growing collection of code snippets for common problems and use cases
+when developing dapps and other blockchain tools.
 
+- [Signing Messages and Data](cookbook-signing)
+- [React Native Performance](cookbook-react-native)

docs.wrm/cookbook/react-native.wrm

@@ -0,0 +1,36 @@
+_section: React Native  @<cookbook-react-native>
+
+When using React Native, many of the built-in cryptographic primitives
+can be replaced by native, substantially faster implementations.
+
+This should be available in its own package in the future, but for now
+this is highly recommended, and requires installing the
+[[link-npm-react-native-quick-crypto]] package.
+
+
+_code:
+
+import { ethers } from "ethers";
+
+import crypto from "react-native-quick-crypto";
+
+ethers.randomBytes.register((length) => {
+  return new Uint8Array(crypto.randomBytes(length));
+});
+
+ethers.computeHmac.register((algo, key, data) => {
+    return crypto.createHmac(algo, key).update(data).digest();
+});
+
+ethers.pbkdf2.register((passwd, salt, iter, keylen, algo) => {
+  return crypto.pbkdf2Sync(passwd, salt, iter, keylen, algo);
+});
+
+ethers.sha256.register((data) => {
+  return crypto.createHash('sha256').update(data).digest();
+});
+
+ethers.sha512.register((data) => {
+  return crypto.createHash('sha512').update(data).digest();
+});
+

docs.wrm/cookbook/signing.wrm

@@ -0,0 +1,273 @@
+_section: Signing  @<cookbook-signing>
+
+Signing content and providing the content and signature to a
+Contract allows on-chain validation that a signer has access
+to the private key of a specific address.
+
+The ecrecover algorithm allows the public key to be determined
+given some message digest and the signature generated by the
+private key for that digest. From the public key, the address
+can then be computed.
+
+How a digest is derived depends on the type of data being
+signed and a variety of encoding formats are employed. Each
+format is designed to ensure that they do not collide, so for
+example, a user **cannot** be tricked into signing a message
+which is actually a valid transaction.
+
+For this reason, most APIs in Ethereum do not permit signing a
+raw digest, and instead require a separate API for each format
+type and require the related data be specified, protecting the
+user from accidentally authorizing an action they didn't intend.
+
+_subsection: Messages  @<cookbook-signing-messages>
+
+A signed message can be any data, but it is generally recommended
+to use human-readable text, as this is easier for a user to
+verify visually.
+
+This technique could be used, for example, to sign into a service
+by using the text ``"I am signing into ethers.org on 2023-06-04 12:57pm"``.
+The user can then see the message in MetaMask or on a Ledger
+Hardware Wallet and accept that they wish to sign the message which
+the site can then authenticate them with. By providing a timestamp
+the site can ensure that an older signed message cannot be used again
+in the future.
+
+The format that is signed uses [[link-eip-191]] with the
+**personal sign** version code (``0x45``, or ``"E"``).
+
+For those interested in the choice of this prefix, signed messages
+began as a Bitcoin feature, which used ``"\\x18Bitcoin Signed Message:\\n"``,
+which was a Bitcoin var-int length-prefixed string (as ``0x18`` is 24,
+the length of ``"Bitcoin Signed Message:\\n"``.). When Ethereum adopted
+the similar feature, the relevant string was ``"\\x19Ethereum Signed Message:\\n"``.
+
+In one of the most brilliant instances of technical retcon-ing,
+since 0x19 is invalid as the first byte of a transaction (in [[link-rlp]] it
+indicates a single byte of value 25), the initial byte ``\\x19`` has
+now been adopted as a prefix for //some sort of signed data//,
+where the second byte determines how to interpret that data. If the
+second byte is 69 (the letter ``"E"``, as in
+``"Ethereum Signed Message:\\n"``), then the format is a
+the above prefixed message format.
+
+So, all existing messages, tools and instances using the signed
+message format were already EIP-191 compliant, long before the
+standard existed or was even conceived and allowed for an extensible
+format for future formats (of which there now a few).
+
+Anyways, the necessary JavaScript and Solidity are provided below.
+
+_code: JavaScript  @lang<javascript>
+
+// The contract below is deployed to Sepolia at this address
+contractAddress = "0xf554DA5e35b2e40C09DDB481545A395da1736513";
+contract = new Contract(contractAddress, [
+  "function recoverStringFromCompact(string message, (bytes32 r, bytes32 yParityAndS) sig) pure returns (address)",
+  "function recoverStringFromExpanded(string message, (uint8 v, bytes32 r, bytes32 s) sig) pure returns (address)",
+  "function recoverStringFromVRS(string message, uint8 v, bytes32 r, bytes32 s) pure returns (address)",
+  "function recoverStringFromRaw(string message, bytes sig) pure returns (address)",
+  "function recoverHashFromCompact(bytes32 hash, (bytes32 r, bytes32 yParityAndS) sig) pure returns (address)"
+], new ethers.InfuraProvider("sepolia"));
+
+// The Signer; it does not need to be connected to a Provider to sign
+signer = new Wallet(id("foobar"));
+signer.address
+//_result:
+
+// Our message
+message = "Hello World";
+
+// The raw signature; 65 bytes
+rawSig = await signer.signMessage(message);
+//_result:
+
+// Converting it to a Signature object provides more
+// flexibility, such as using it as a struct
+sig = Signature.from(rawSig);
+//_result:
+
+
+// If the signature matches the EIP-2098 format, a Signature
+// can be passed as the struct value directly, since the
+// parser will pull out the matching struct keys from sig.
+await contract.recoverStringFromCompact(message, sig);
+//_result:
+
+// Likewise, if the struct keys match an expanded signature
+// struct, it can also be passed as the struct value directly.
+await contract.recoverStringFromExpanded(message, sig);
+//_result:
+
+// If using an older API which requires the v, r and s be passed
+// separately, those members are present on the Signature.
+await contract.recoverStringFromVRS(message, sig.v, sig.r, sig.s);
+//_result:
+
+// Or if using an API that expects a raw signature.
+await contract.recoverStringFromRaw(message, rawSig);
+//_result:
+
+// Note: The above recovered addresses matches the signer address
+
+_null:
+
+The Solidity Contract has been deployed and verified on
+the Sepolia testnet at the address
+[0xf554DA5e35b2e40C09DDB481545A395da1736513](link-sol-recovermessage).
+
+It provides a variety of examples using various Signature
+encodings and formats, to recover the address for an [[link-eip-191]]
+signed message.
+
+_code: Solidity @lang<solidity>
+
+// SPDX-License-Identifier: MIT
+
+// For more info, see: https://docs.ethers.org
+
+
+pragma solidity ^0.8.21;
+
+// Returns the decimal string representation of value
+function itoa(uint value) pure returns (string memory) {
+
+  // Count the length of the decimal string representation
+  uint length = 1;
+  uint v = value;
+  while ((v /= 10) != 0) { length++; }
+
+  // Allocated enough bytes
+  bytes memory result = new bytes(length);
+
+  // Place each ASCII string character in the string,
+  // right to left
+  while (true) {
+    length--;
+
+    // The ASCII value of the modulo 10 value
+    result[length] = bytes1(uint8(0x30 + (value % 10)));
+
+    value /= 10;
+
+    if (length == 0) { break; }
+  }
+
+  return string(result);
+}
+
+contract RecoverMessage {
+
+  // This is the EIP-2098 compact representation, which reduces gas costs
+  struct SignatureCompact {
+    bytes32 r;
+    bytes32 yParityAndS;
+  }
+
+  // This is an expaned Signature representation
+  struct SignatureExpanded {
+      uint8 v;
+      bytes32 r;
+      bytes32 s;
+  }
+
+  // Helper function
+  function _ecrecover(string memory message, uint8 v, bytes32 r, bytes32 s) internal pure returns (address) {
+    // Compute the EIP-191 prefixed message
+    bytes memory prefixedMessage = abi.encodePacked(
+      "\x19Ethereum Signed Message:\n",
+      itoa(bytes(message).length),
+      message
+    );
+
+    // Compute the message digest
+    bytes32 digest = keccak256(prefixedMessage);
+
+    // Use the native ecrecover provided by the EVM
+    return ecrecover(digest, v, r, s);
+  }
+
+  // Recover the address from an EIP-2098 compact Signature, which packs the bit for
+  // v into an unused bit within s, which saves gas overall, costing a little extra
+  // in computation, but saves far more in calldata length.
+  //
+  // This Signature format is 64 bytes in length.
+  function recoverStringFromCompact(string calldata message, SignatureCompact calldata sig) public pure returns (address) {
+
+      // Decompose the EIP-2098 signature (the struct is 64 bytes in length)
+      uint8 v = 27 + uint8(uint256(sig.yParityAndS) >> 255);
+      bytes32 s = bytes32((uint256(sig.yParityAndS) << 1) >> 1);
+
+      return _ecrecover(message, v, sig.r, s);
+  }
+
+  // Recover the address from the expanded Signature struct.
+  //
+  // This Signature format is 96 bytes in length.
+  function recoverStringFromExpanded(string calldata message, SignatureExpanded calldata sig) public pure returns (address) {
+
+      // The v, r and s are included directly within the struct, which is 96 bytes in length
+      return _ecrecover(message, sig.v, sig.r, sig.s);
+  }
+
+  // Recover the address from a v, r and s passed directly into the method.
+  //
+  // This Signature format is 96 bytes in length.
+  function recoverStringFromVRS(string calldata message, uint8 v, bytes32 r, bytes32 s) public pure returns (address) {
+
+      // The v, r and s are included directly within the struct, which is 96 bytes in length
+      return _ecrecover(message, v, r, s);
+  }
+
+  // Recover the address from a raw signature. The signature is 65 bytes, which when
+  // ABI encoded is 160 bytes long (a pointer, a length and the padded 3 words of data).
+  //
+  // When using raw signatures, some tools return the v as 0 or 1. In this case you must
+  // add 27 to that value as v must be either 27 or 28.
+  //
+  // This Signature format is 65 bytes of data, but when ABI encoded is 160 bytes in length; 
+  // a pointer (32 bytes), a length (32 bytes) and the padded 3 words of data (96 bytes).
+  function recoverStringFromRaw(string calldata message, bytes calldata sig) public pure returns (address) {
+
+    // Sanity check before using assembly
+    require(sig.length == 65, "invalid signature");
+
+    // Decompose the raw signature into r, s and v (note the order)
+    uint8 v;
+    bytes32 r;
+    bytes32 s;
+    assembly {
+      r := calldataload(sig.offset)
+      s := calldataload(add(sig.offset, 0x20))
+      v := calldataload(add(sig.offset, 0x21))
+    }
+
+    return _ecrecover(message, v, r, s);
+  }
+
+  // This is provided as a quick example for those that only need to recover a signature
+  // for a signed hash (highly discouraged; but common), which means we can hardcode the
+  // length in the prefix. This means we can drop the itoa and _ecrecover functions above.
+  function recoverHashFromCompact(bytes32 hash, SignatureCompact calldata sig) public pure returns (address) {
+    bytes memory prefixedMessage = abi.encodePacked(
+      // Notice the length of the message is hard-coded to 32
+      // here -----------------------v
+      "\x19Ethereum Signed Message:\n32",
+      hash
+    );
+
+    bytes32 digest = keccak256(prefixedMessage);
+
+    // Decompose the EIP-2098 signature
+    uint8 v = 27 + uint8(uint256(sig.yParityAndS) >> 255);
+    bytes32 s = bytes32((uint256(sig.yParityAndS) << 1) >> 1);
+
+    return ecrecover(digest, v, sig.r, s);
+  }
+}
+
+
+_subsection: EIP-712 Typed Data  @<cookbook-signing-eip712>
+
+//Coming soon...//

docs.wrm/documentation/examples.txt

@@ -1,23 +0,0 @@
-_section: Hello World @<link-to-this-section>
-
-_subsection: Some Example @<link-to-this-subsection>
-
-_heading: Large Bold Text @<link-to-this-heading>
-
-_definition: Flatworm
-A phylum of relatively **simple** bilaterian, unsegmented,
-soft-bodied invertebrates.
-
-_property: String.fromCharCode(code) => string
-Returns a string created from //code//, a sequence of
-UTF-16 code units.
-
-_code: filename.js
-
-_toc:
-    some-file
-    some-directory
-
-_null:
-This breaks out of a directive. For example, to end a
-_definition and reset the indentation.

docs.wrm/documentation/fragment.txt

@@ -1,7 +0,0 @@
-_DIRECTIVE: VALUE @<LINK>
-BODY
-
-DIRECTIVE: The directive name
-VALUE:     Optional; the value to pass to the directive
-LINK:      Optional; a name for internal linking
-BODY:      Optional; the directive body (certain directives only)

docs.wrm/documentation/index.wrm

@@ -1,85 +0,0 @@
-_title: Flatworm Docs
-
-_section: Flatworm Docs
-
-The //Flatworm Docs// rendering script is designed to be **very**
-simple, but provide enough formatting necessary for documenting
-JavaScript libraries.
-
-A lot of its inspiration came from [Read the Docs](https://github.com/readthedocs/sphinx_rtd_theme) and
-the [Sphinx](https://www.sphinx-doc.org/) project.
-
-
-_subsection: Fragments
-
-Flatworm Docs are made up of fragments. A fragment is either a lone
-body of [markdown](flatworm-markdown) text, or a
-[directive](flatworm-directive) for specialized formatting, which may
-itself have body.
-
-
-_heading: Directive Format
-
-_code: fragment.txt
-
-
-_heading: Flatworm Directives @<flatworm-directive>
-
-_definition: **_section:** //TITLE//
-A //section// has its **TITLE** in an H1 font. Sections are linked
-to in //Table of Contents// and have a dividing line drawn above
-them. If an option is specified, it is avaialble as a name for
-intern linking. There should only be one ``_section:`` per page.
-
-_definition: **_subsection:** //TITLE//
-A //subsection// has its **TITLE** in an H2 font. Subsections are linked
-to in //Table of Contents// and have a dividing line drawn above
-them. If an option is specified, it is avaialble as a name for
-internal linking.
-
-_definition: **_heading:** //TITLE//
-A //heading// has its **TITLE** in an H3 font. If an option is specified,
-it is available as a name for internal linking.
-
-_definition: **_definition:** //TERM//
-A //definition// has its **TERM** bolded and the markdown body is
-indented.
-
-_definition: **_property:** //SIGNATURE//
-A //property// has its JavaScript **SIGNATURE** formatted and the
-markdown body is indented.
-
-_definition: **_code:** //FILENAME//
-A //code// reads the **FILENAME** and depending on the extension
-adjusts it.
-
-For JavaScript files, the file is executed, with ``\/\/!`` replaced
-with the result of the last statement and ``\/\/!error`` is replaced
-with the throw error. If the error state does not agree, rendering
-fails.
-
-_definition: **_toc:**
-A //toc// injects a Table of Contents, loading each line of the
-body as a filename and recursively loads the //toc// if present,
-otherwise all the //sections// and //subsections//.
-
-_definition: **_null:**
-A //null// is used to terminated a directive. For example, after
-a //definition//, the bodies are indented, so a //null// can be
-used to reset the indentation.
-
-
-_heading: Examples
-
-_code: examples.txt
-
-
-_subsection: Markdown @<flatworm-markdown>
-
-The markdown is simple and does not have the flexibility of
-other dialects, but allows for **bold**, //italic//,
-__underlined__, ``monospaced``, ^^super-scripted^^ text,
-supporting [links](flatworm-markdown) and lists.
-
-_code: markdown.txt
-

docs.wrm/documentation/markdown.txt

@@ -1,23 +0,0 @@
-**bold text**
-
-//italic text//
-
-__underlined text__
-
-``monospace code``
-
-^^superscript text^^
-
-- This is a list
-- With bullet points
-- With a total of three items
-
-This is separated by -- an en-dash.
-
-This is separated by --- an em-dash.
-
-This is a [Link to Ethereum](https://ethereum.org) and this
-is an [Internal Link](some-link).
-
-This is a self-titled link [[https://ethereumorg]] and this
-[[some-link]] will use the title from its directives value.

docs.wrm/getting-started.wrm

@@ -1,32 +1,505 @@
-_title: Getting Started
+_section: Getting Started @<getting-started> @priority<100>
 
-_section: Getting Started
+This is a very short introduction to Ethers, but covers many of the
+most common operations that developers require and provides a
+starting point for those newer to Ethereum.
 
 
-_subsection: Installing
+_heading: Getting Ethers
 
-The various Classes and Functions are available to be imported
-manually from sub-packages under the
-[@ethersproject](https://www.npmjs.com/search?q=%40ethersproject%2F)
-but for most projects, the umbrella package is the easiest way to
-get started.
+If using NPM, you must first install Ethers.
 
-_code: installing.txt
+_code: installing via NPM @lang<shell>
+  # Install ethers
+  /home/ricmoo/test-ethers> npm install ethers
+
+_null:
+
+Everything in Ethers is exported from its root as well as on the ``ethers``
+object. There are also ``exports`` in the ``package.json`` to facilitate
+more fine-grained importing.
+
+Generally this documentation will presume all exports from ethers
+have been imported in the code examples, but you may import the
+necessary objects in any way you wish.
+
+_code: importing in Node.js  @lang<script>
+  // Import everything
+  import { ethers } from "ethers";
+
+  // Import just a few select items
+  import { BrowserProvider, parseUnits } from "ethers";
+
+  // Import from a specific export
+  import { HDNodeWallet } from "ethers/wallet";
+
+_code: importing ESM in a browser  @lang<script>
+  <script type="module">
+    import { ethers } from "https://cdnjs.cloudflare.com/ajax/libs/ethers/6.7.0/ethers.min.js";
+    // Your code here...
+  </script>
 
 
-_subsection: Importing
+_subsection: Some Common Terminology  @<starting-glossary>
 
-_heading: Node.js
+To begin, it is useful to have a basic understanding of the types of
+objects available and what they are responsible for, at a high level.
 
-_code: importing-node.source
+_heading: Provider
 
-_heading: Web Browser
+A [[Provider]] is a read-only connection to the blockchain, which allows
+querying the blockchain state, such as account, block or transaction details,
+querying event logs or evaluating read-only code using call.
 
-It is generally better practice (for security reasons) to copy the
-[ethers library](https://cdn.ethers.io/lib/ethers-5.0.min.js) to
-your own webserver and serve it yourself.
+If you are coming from Web3.js, you are used to a **Provider** offering
+both read and write access. In Ethers, all write operations are further
+abstracted into another Object, the **Signer**.
 
-For quick demos or prototyping though, it can be loaded in your
-Web Applications from our CDN.
+_heading: Signer
+
+A [[Signer]] wraps all operations that interact with an account. An
+account generally has a private key located //somewhere//, which can be
+used to sign a variety of types of payloads.
+
+The private key may be located in memory (using a [[Wallet]]) or
+protected via some IPC layer, such as MetaMask which proxies interaction
+from a website to a browser plug-in, which keeps the private key out of
+the reach of the website and only permits interaction after requesting
+permission from the user and receiving authorization.
+
+_heading: Transaction
+
+To make any state changes to the blockchain, a transaction is required,
+which requires a fee to be paid, where the fee covers the associated costs
+with executing the transaction (such as reading the disk and performing
+maths) and storing the updated information.
+
+If a transaction reverts, a fee must still be paid, since the validator
+still had to expend resources to try running the transaction to determine
+that it reverted and the details of its failure are still be recorded.
+
+Transactions include sending ether from one user to another, deploying
+a **Contract** or executing a state-changing operation against a
+**Contract**.
+
+_heading: Contract
+
+A [[Contract]] is a program that has been deployed to the blockchain,
+which includes some code and has allocated storage which it can read
+from and write to.
+
+It may be read from when it is connected to a [[Provider]] or
+state-changing operations can be called when connected to a [[Signer]].
+
+_heading: Receipt
+
+Once a **Transaction** has been submitted to the blockchain, it is placed
+in the memory pool (mempool) until a validator decides to include it.
+
+A transaction's changes are only made once it has been included in the
+blockchain, at which time a receipt is available, which includes details
+about the transaction, such as which block it was included in, the actual
+fee paid, gas used, all the events that it emitted and whether it was
+successful or reverted.
+
+
+_subsection: Connecting to Ethereum  @<starting-connecting>
+
+This very first thing needed to begin interacting with the blockchain is
+connecting to it using a [[Provider]].
+
+_heading: MetaMask (and other injected providers)
+
+The quickest and easiest way to experiment and begin developing
+on Ethereum is to use [[link-metamask]], which is a browser
+extension that injects objects into the ``window``, providing:
+
+- read-only access to the Ethereum network (a [[Provider]])
+- authenticated write access backed by a private key (a [[Signer]])
+
+When requesting access to the authenticated methods, such as
+sending a transaction or even requesting the private key address,
+MetaMask will show a pop-up to the user asking for permission.
+
+_code:  @lang<script>
+  let signer = null;
+
+  let provider;
+  if (window.ethereum == null) {
+
+      // If MetaMask is not installed, we use the default provider,
+      // which is backed by a variety of third-party services (such
+      // as INFURA). They do not have private keys installed,
+      // so they only have read-only access
+      console.log("MetaMask not installed; using read-only defaults")
+      provider = ethers.getDefaultProvider()
+
+  } else {
+
+      // Connect to the MetaMask EIP-1193 object. This is a standard
+      // protocol that allows Ethers access to make all read-only
+      // requests through MetaMask.
+      provider = new ethers.BrowserProvider(window.ethereum)
+
+      // It also provides an opportunity to request access to write
+      // operations, which will be performed by the private key
+      // that MetaMask manages for the user.
+      signer = await provider.getSigner();
+  }
+
+
+_heading: Custom RPC Backend
+
+If you are running your own Ethereum node (e.g. [[link-geth]])
+or using a custom third-party service (e.g. [[link-infura]]),
+you can use the [[JsonRpcProvider]] directly, which communicates
+using the [[link-jsonrpc]] protocol.
+
+When using your own Ethereum node or a developer-base blockchain,
+such as Hardhat or Ganache, you can get access to the accounts with
+[[JsonRpcProvider-getSigner]].
+
+_code: connecting to a JSON-RPC URL  @lang<script>
+
+  // If no %%url%% is provided, it connects to the default
+  // http://localhost:8545, which most nodes use.
+  provider = new ethers.JsonRpcProvider(url)
+
+  // Get write access as an account by getting the signer
+  signer = await provider.getSigner()
+
+
+_subsection: User Interaction  @<starting-display>
+
+All units in Ethereum tend to be integer values, since dealing with
+decimals and floating points can lead to imprecise and non-obvious
+results when performing mathematic operations.
+
+As a result, the internal units used (e.g. wei) which are suited for
+machine-readable purposes and maths are often very large and not
+easily human-readable.
+
+For example, imagine dealing with dollars and cents; you would show
+values like ``"$2.56"``. In the blockchain world, we would keep all
+values as cents, so that would be ``256`` cents, internally.
+
+So, when accepting data that a user types, it must be converted from
+its decimal string representation (e.g. ``"2.56"``) to its lowest-unit
+integer representation (e.g. ``256``). And when displaying a value to
+a user the opposite operation is necessary.
+
+In Ethereum, //one ether// is equal to ``10 *\* 18`` wei and //one gwei//
+is equal to ``10 *\* 9`` wei, so the values get very large very quickly,
+so some convenience functions are provided to help convert between
+representations.
+
+_code:  @lang<javascript>
+  // Convert user-provided strings in ether to wei for a value
+  eth = parseEther("1.0")
+  //_result:
+
+  // Convert user-provided strings in gwei to wei for max base fee
+  feePerGas = parseUnits("4.5", "gwei")
+  //_result:
+
+  // Convert a value in wei to a string in ether to display in a UI
+  formatEther(eth)
+  //_result:
+
+  // Convert a value in wei to a string in gwei to display in a UI
+  formatUnits(feePerGas, "gwei")
+  //_result:
+
+
+_subsection: Interacting with the Blockchain  @<starting-blockchain>
+
+_heading: Querying State
+
+Once you have a [[Provider]], you have a read-only connection to
+the data on the blockchain. This can be used to query the current
+account state, fetch historic logs, look up contract code and so on.
+
+_code:  @lang<javascript>
+  //_hide: provider = new InfuraProvider();
+
+  // Look up the current block number (i.e. height)
+  await provider.getBlockNumber()
+  //_result:
+
+  // Get the current balance of an account (by address or ENS name)
+  balance = await provider.getBalance("ethers.eth")
+  //_result:
+
+  // Since the balance is in wei, you may wish to display it
+  // in ether instead.
+  formatEther(balance)
+  //_result:
+
+  // Get the next nonce required to send a transaction
+  await provider.getTransactionCount("ethers.eth")
+  //_result:
+
+_heading: Sending Transactions
+
+To write to the blockchain you require access to a private key
+which controls some account. In most cases, those private keys
+are not accessible directly to your code, and instead you make
+requests via a [[Signer]], which dispatches the request to a
+service (such as [[link-metamask]]) which provides strictly
+gated access and requires feedback to the user to approve or
+reject operations.
+
+_code:  @lang<script>
+
+  //_hide: provider = new JsonRpcProvider("http:/\/localhost:8545")
+  //_hide: provider.resolveName = () => "0x643aA0A61eADCC9Cc202D1915D942d35D005400C";
+  //_hide: signer = new Wallet(id("test"), provider);
+
+  // When sending a transaction, the value is in wei, so parseEther
+  // converts ether to wei.
+  tx = await signer.sendTransaction({
+    to: "ethers.eth",
+    value: parseEther("1.0")
+  });
+  //_result:
+
+  // Often you may wish to wait until the transaction is mined
+  receipt = await tx.wait();
+  //_result:
+
+
+_subsection: Contracts  @<starting-contracts>
+
+A **Contract** is a meta-class, which means that its definition
+its derived at run-time, based on the ABI it is passed, which then
+determined what methods and properties are available on it.
+
+_heading: Application Binary Interface (ABI)
+
+Since all operations that occur on the blockchain must be encoded
+as binary data, we need a concise way to define how to convert
+between common objects (like strings and numbers) and its binary
+representation, as well as encode the ways to call and interpret
+the Contract.
+
+For any method, event or error you wish to use, you must include a
+[[Fragment]] to inform Ethers how it should encode the request and
+decode the result.
+
+Any methods or events that are not needed can be safely excluded.
+
+There are several common formats available to describe an ABI. The
+Solidity compiler usually dumps a JSON representation but when typing
+an ABI by hand it is often easier (and more readable) to use the
+human-readable ABI, which is just the Solidity signature.
+
+_code: simplified ERC-20 ABI @lang<script>
+  abi = [
+    "function decimals() view returns (string)",
+    "function symbol() view returns (string)",
+    "function balanceOf(address addr) view returns (uint)"
+  ]
+
+  // Create a contract
+  contract = new Contract("dai.tokens.ethers.eth", abi, provider)
+
+_heading: Read-only methods (i.e. ``view`` and ``pure``)
+
+A read-only method is one which cannot change the state of the
+blockchain, but often provide a simple interface to get important
+data about a Contract.
+
+_code: reading the DAI ERC-20 contract @lang<javascript>
+  // The contract ABI (fragments we care about)
+  abi = [
+    "function decimals() view returns (uint8)",
+    "function symbol() view returns (string)",
+    "function balanceOf(address a) view returns (uint)"
+  ]
+
+  // Create a contract; connected to a Provider, so it may
+  // only access read-only methods (like view and pure)
+  contract = new Contract("dai.tokens.ethers.eth", abi, provider)
+
+  // The symbol name for the token
+  sym = await contract.symbol()
+  //_result:
+
+  // The number of decimals the token uses
+  decimals = await contract.decimals()
+  //_result:
+
+  // Read the token balance for an account
+  balance = await contract.balanceOf("ethers.eth")
+  //_result:
+
+  // Format the balance for humans, such as in a UI
+  formatUnits(balance, decimals)
+  //_result:
+
+_heading: State-changing Methods
+
+_code: change state on an ERC-20 contract  @lang<script>
+
+  abi = [
+    "function transfer(address to, uint amount)"
+  ]
+
+  // Connected to a Signer; can make state changing transactions,
+  // which will cost the account ether
+  contract = new Contract("dai.tokens.ethers.eth", abi, signer)
+
+  // Send 1 DAI
+  amount = parseUnits("1.0", 18);
+
+  // Send the transaction
+  tx = await contract.transfer("ethers.eth", amount)
+  //_result: @TODO
+
+  // Currently the transaction has been sent to the mempool,
+  // but has not yet been included. So, we...
+
+  // ...wait for the transaction to be included.
+  await tx.wait()
+  //_result: @TODO
+
+_code: forcing a call (simulation) of a state-changing method @lang<javascript>
+
+  abi = [
+    "function transfer(address to, uint amount) returns (bool)"
+  ]
+
+  // Connected to a Provider since we only require read access
+  contract = new Contract("dai.tokens.ethers.eth", abi, provider)
+
+  amount = parseUnits("1.0", 18)
+
+  // There are many limitations to using a static call, but can
+  // often be useful to preflight a transaction.
+  await contract.transfer.staticCall("ethers.eth", amount)
+  //_result:
+
+  // We can also simulate the transaction as another account
+  other = new VoidSigner("0x643aA0A61eADCC9Cc202D1915D942d35D005400C")
+  contractAsOther = contract.connect(other.connect(provider))
+  await contractAsOther.transfer.staticCall("ethers.eth", amount)
+  //_result:
+
+_heading: Listening to Events
+
+When adding event listeners for a named event, the event parameters
+are destructed for the listener.
+
+There is always one additional parameter passed to a listener, which
+is an [[EventPayload]], which includes more information about the event
+including the filter and a method to remove that listener.
+
+_code: listen for ERC-20 events  @lang<script>
+  abi = [
+    "event Transfer(address indexed from, address indexed to, uint amount)"
+  ]
+
+  // Create a contract; connected to a Provider, so it may
+  // only access read-only methods (like view and pure)
+  contract = new Contract("dai.tokens.ethers.eth", abi, provider)
+
+  // Begin listening for any Transfer event
+  contract.on("Transfer", (from, to, _amount, event) => {
+    const amount = formatEther(_amount, 18)
+    console.log(`${ from } => ${ to }: ${ amount }`);
+
+    // The `event.log` has the entire EventLog
+
+    // Optionally, stop listening
+    event.removeListener();
+  });
+
+  // Same as above
+  contract.on(contract.filters.Transfer, (from, to, amount, event) => {
+    // See above
+  })
+
+  // Listen for any Transfer to "ethers.eth"
+  filter = contract.filters.Transfer("ethers.eth")
+  contract.on(filter, (from, to, amount, event) => {
+    // `to` will always be equal to the address of "ethers.eth"
+  });
+
+  // Listen for any event, whether it is present in the ABI
+  // or not. Since unknown events can be picked up, the
+  // parameters are not destructed.
+  contract.on("*", (event) => {
+    // The `event.log` has the entire EventLog
+  });
+
+
+
+_heading: Query Historic Events
+
+When querying within a large range of blocks, some backends may
+be prohibitively slow, may return an error or may truncate the
+results without any indication. This is at the discretion of each
+backend.
+
+_code: query historic ERC-20 events  @lang<javascript>
+  abi = [
+    "event Transfer(address indexed from, address indexed to, uint amount)"
+  ]
+
+  // Create a contract; connected to a Provider, so it may
+  // only access read-only methods (like view and pure)
+  contract = new Contract("dai.tokens.ethers.eth", abi, provider)
+
+  // Query the last 100 blocks for any transfer
+  filter = contract.filters.Transfer
+  events = await contract.queryFilter(filter, -100)
+
+  // The events are a normal Array
+  events.length
+  //_result:
+
+  // The first matching event
+  events[0]
+  //_result:
+
+  // Query all time for any transfer to ethers.eth
+  filter = contract.filters.Transfer("ethers.eth")
+  events = await contract.queryFilter(filter)
+
+  // The first matching event
+  events[0]
+  //_result:
+
+
+_subsection: Signing Messages  @<starting-signing>
+
+A private key can do a lot more than just sign a transaction to authorize
+it. It can also be used to sign other forms of data, which are then able
+to be validated for other purposes.
+
+For example, signing **a message** can be used to prove ownership of an
+account which a website could use to authenticate a user and log them in.
+
+_code:  @lang<javascript>
+
+  // Our signer; Signing messages does not require a Provider
+  signer = new Wallet(id("test"))
+  //_result:
+
+  message = "sign into ethers.org?"
+
+  // Signing the message
+  sig = await signer.signMessage(message);
+  //_result:
+
+  // Validating a message; notice the address matches the signer
+  verifyMessage(message, sig)
+  //_result:
+
+_null:
+
+Many other more advanced protocols built on top of signed messages are
+used to allow a private key to authorize other users to transfer their
+tokens, allowing the transaction fees of the transfer to be paid by
+someone else.
 
-_code: importing-browser.txt

docs.wrm/importing-browser.txt

@@ -1,2 +0,0 @@
-<script src="https://cdn.ethers.io/lib/ethers-5.0.min.js"
-        type="application/javascipt"></script>

docs.wrm/importing-node.source

@@ -1,5 +0,0 @@
-// CommonJS
-const { ethers } = require("ethers");
-
-// ES6 or TypeScript 
-const { ethers } = require("ethers");

docs.wrm/index.wrm

@@ -1,59 +1,28 @@
-_title: Documentation
+_section: Documentation  @<about-home> @nav<Documentation>
 
-_section: What is ethers?
+The ethers.js library aims to be a complete and compact library
+for interacting with the Ethereum Blockchain and its ecosystem.
 
-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](https://ethers.io/) and
-has since expanded into a much more general-purpose library.
-
-_subsection: Features
-
-- Keep your private keys in your client, **safe** and sound
-- Import and export **JSON wallets** (Geth, Parity and crowdsale)
-- Import and export BIP 39 **mnemonic phrases** (12 word backup
-  phrases) and HD Wallets (English, Italian, Japanese, Korean,
-  Simplified Chinese, Traditional Chinese; more coming soon)
-- Meta-classes create JavaScript objects from any contract ABI,
-  including **ABIv2** and **Human-Readable ABI**
-- Connect to Ethereum nodes over
-  [JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC),
-  [INFURA](https://infura.io/),
-  [Etherscan](https://etherscan.io/),
-  [Nodesmith](https://nodesmith.io),
-  [Alchemy](https://alchemyapi.io),
-  or [MetaMask](https://metamask.io/).
-- **ENS names** are first-class citizens; they can be used
-  anywhere an Ethereum addresses can be used
-- **Tiny** (~88kb compressed; 284kb uncompressed)
-- **Complete** functionality for all your Ethereum needs
-- Extensive [documentation](https://docs.ethers.io/)
-- 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
+It is often used to create decentralized applications (dapps),
+wallets (such as [[link-metamask]] and [[link-tally]]) and
+other tools and simple scripts that require reading and writing
+to the blockchain.
 
 
-_subsection: Developer Documentation
+_subsection: About this documentation?
 
-_toc:
+These docs are still under construction, and are being expanded
+every day.
 
-    getting-started
-    concepts
-    api
-    cookbook
-    migration
-    testing
-    contributing
-    documentation
-    license
-    
+Developers new to Ethers should be sure to read through the
+[[getting-started]] section.
 
-_subsection: Legacy Documentation
+And the [[about-api]] is available for drilling down into more details
+about the entire Application Programming Interface.
 
-This section will be kept up to date, linking to documentation of
-older versions of the library.
 
-- [version 4.0](https://docs.ethers.io/ethers.js)
-- [version 3.0](https://docs.ethers.io/ethers.js/v3.0/html/)
+_subsection: Older Documentation
+
+- [v5 documentation](link-docs-v5)
+- [v4 documentation](link-docs-v4)
+- [v3 documentation](link-docs-v3)

docs.wrm/installing.txt

@@ -1 +0,0 @@
-/home/ricmoo> npm install --save ethers@next

docs.wrm/license.wrm

@@ -1,16 +1,11 @@
-_title: License and Copyright
+_section: License and Copyright  @priority<-100>
 
+The ethers library (including all dependencies) are available under the
+[[link-mit]], which permits a wide variety of uses.
 
-_section: License and Copyright
+_subsection: MIT License
 
-The ethers library (including all dependencies) are available
-under the [MIT License](https://en.m.wikipedia.org/wiki/MIT_License),
-which permits a wide variety of uses.
-
-
-_heading: MIT License
-
-//Copyright &copy; 2019 [Richard Moore](mailto:me@ricmoo.com).//
+Copyright &copy; [Richard Moore](link-mail).
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,14 +14,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

docs.wrm/links/javascript.txt

@@ -0,0 +1,8 @@
+link-js-array [link-js-array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
+link-js-bigint [link-js-bigint](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt)
+link-js-date [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)
+link-js-fetch [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
+link-js-normalize [String.normalize](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize)
+link-js-maxsafe [link-js-maxsafe](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER#Description)
+link-js-proxy [link-js-proxy](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy)
+link-js-typedarray [link-js-typedarray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray)

docs.wrm/links/npm.txt

@@ -0,0 +1,5 @@
+link-npm-ethers [link-ethers-npm](https://www.npmjs.com/search?q=%40ethersproject%2F)
+link-npm-events [EventEmitter](https://nodejs.org/dist/latest-v13.x/docs/api/events.html#events_class_eventemitter)
+link-npm-query-bignumber [link-npm-query-bignumber](https://www.npmjs.com/search?q=bignumber)
+link-npm-react-native-get-random-values [React Native get-random-values](https://www.npmjs.com/package/react-native-get-random-values)
+link-npm-react-native-quick-crypto [Quick Crypto](https://www.npmjs.com/package/react-native-quick-crypto)

docs.wrm/links/projects.txt

@@ -0,0 +1,50 @@
+link-alchemy [Alchemy](https://alchemy.com/?a=ethers)
+link-ankr [Ankr](https://www.ankr.com)
+link-chainstack [Chainstack](https://chainstack.com)
+link-cloudflare [Cloudflare](https://developers.cloudflare.com/distributed-web/ethereum-gateway/)
+link-ens [ENS](https://ens.domains/)
+link-ethereum [Ethereum](https://ethereumorg)
+link-etherscan [Etherscan](https://etherscan.io)
+link-expo [Expo](https://expo.io)
+link-etherscan-api [Etherscan API](https://etherscan.io/apis)
+link-flatworm [Flatworm](https://github.com/ricmoo/flatworm)
+link-geth [Geth](https://geth.ethereum.org)
+link-infura [INFURA](https://infura.io)
+link-javascriptcore [JavaScriptCore](https://developer.apple.com/documentation/javascriptcore?language=objc)
+link-ledger [Ledger](https://www.ledger.com)
+link-metamask [MetaMask](https://metamask.io/)
+link-node [Node.js](https://nodejs.org/)
+link-otto [Otto](https://github.com/robertkrimen/otto)
+link-parity [Parity](https://www.parity.io)
+link-pocket [Pocket Network](https://pokt.network)
+link-quicknode [QuickNode](https://www.quicknode.com/ethers)
+link-react-native [React Native](https://reactnative.dev)
+link-semver [semver](https://semver.org)
+link-solidity [Solidity](https://solidity.readthedocs.io/)
+link-tally [Tally](https://tallyho.org)
+
+# Project-specific
+link-alchemy-signup [Alchemy Signup](https://dashboard.alchemyapi.io/signup?referral=55a35117-028e-4b7c-9e47-e275ad0acc6d)
+link-ankr-public [link-ankr-public](https://www.ankr.com/protocol/public/)
+link-ankr-signup [link-ankr-premium](https://www.ankr.com/protocol/plan/)
+link-etherscan-signup [Etherscan Signup](https://etherscan.io/apis)
+link-etherscan-ratelimit [link-etherscan-ratelimit](https://info.etherscan.com/api-return-errors/)
+link-infura-signup [INFURA Signup](https://infura.io/register)
+link-geth-debug [link-geth-debug](https://github.com/ethereum/go-ethereum/wiki/Management-APIs#debug)
+link-geth-rpc [link-geth-rpc](https://github.com/ethereum/go-ethereum/wiki/Management-APIs)
+link-infura-secret [link-infura-secret](https://infura.io/docs/gettingStarted/authentication)
+link-parity-trace [link-parity-trace](https://openethereum.github.io/wiki/JSONRPC-trace-module)
+link-parity-rpc [link-parity-rpc](https://openethereum.github.io/wiki/JSONRPC)
+link-pocket-signup [link-pocket-signup](https://pokt.network/pocket-gateway-ethereum-mainnet/)
+link-web3js [link-web3](https://github.com/ethereum/web3.js)
+link-web3-http [link-web3-http](https://github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-http)
+link-web3-ipc [link-web3-ipc](https://github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-ipc)
+link-web3-send [link-web3-send](https://github.com/ethereum/web3.js/blob/1.x/packages/web3-providers-http/types/index.d.ts#L57)
+link-web3-ws [link-web3-ws](https://github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-ws)
+
+link-solidity-errors [link-solidity-errors](https://docs.soliditylang.org/en/v0.8.4/abi-spec.html#errors)
+link-solidity-events [link-solidity-events](https://docs.soliditylang.org/en/v0.8.4/abi-spec.html#events)
+
+link-other-ethereum-dev-docs [link-other-ethereum-dev-docs](https://ethereum.org/en/developers/docs/)
+
+link-sol-recovermessage [RecoverMessage.sol](https://sepolia.etherscan.io/address/0xf554da5e35b2e40c09ddb481545a395da1736513#code)

docs.wrm/links/ricmoo.txt

@@ -0,0 +1,21 @@
+link-mail [me@ricmoo](mailto:me@ricmoo.com)
+link-website [ethers.org](https://ethers.org)
+
+# Ethers links
+link-ci [Ethers CI](https://github.com/ethers-io/ethers.js/actions/runs/158006903)
+link-discussion [Ethers Discussion](https://github.com/ethers-io/ethers.js/discussions)
+link-issue [Open Ethers Issue](https://github.com/ethers-io/ethers.js/issues/new/choose)
+link-issues [Ethers Issues](https://github.com/ethers-io/ethers.js/issues)
+link-docs-v3 [V3 Documentation](https://docs.ethers.org/v3/)
+link-docs-v4 [V4 Documentation](https://docs.ethers.org/v4/)
+link-docs-v5 [V5 Documentation](https://docs.ethers.org/v5/)
+
+# Social profiles
+link-repo [GitHub Repo](https://github.com/ethers-io/ethers.js)
+link-mastodon [@ethers on Mastodon](http://mochi.social/@ethers)
+link-twitter [@ethersproject on Twitter](https://twitter.com/ethersproject)
+
+# Blog
+link-ricmoo-humanreadableabi [Human-Readable Contract ABIs](https://blog.ricmoo.com/human-readable-contract-abis-in-ethers-js-141902f4d917)
+link-ricmoo-wisps [Wisps: The Magical World of Create2](https://blog.ricmoo.com/wisps-the-magical-world-of-create2-5c2177027604);
+

docs.wrm/links/specs.txt

@@ -0,0 +1,54 @@
+# BIPs
+link-bip-39 [BIP-39](https://en.bitcoin.it/wiki/BIP_0039)
+link-bip-32 [BIP-32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)
+link-bip-44 [BIP-44](https://en.bitcoin.it/wiki/BIP_0044)
+
+# BIP 39 lists
+link-bip39-wordlists [BIP-39 Wordlists](https://github.com/bitcoin/bips/blob/master/bip-0039/bip-0039-wordlists.md)
+link-bip39-cz [Czech wordlist](https://github.com/bitcoin/bips/blob/master/bip-0039/czech.txt)
+link-bip39-es [Spanish wordlist](https://github.com/bitcoin/bips/blob/master/bip-0039/spanish.txt)
+link-bip39-en [English wordlist](https://github.com/bitcoin/bips/blob/master/bip-0039/english.txt)
+link-bip39-fr [French wordlist](https://github.com/bitcoin/bips/blob/master/bip-0039/french.txt)
+link-bip39-it [Italian wordlist](https://github.com/bitcoin/bips/blob/master/bip-0039/italian.txt)
+link-bip39-ja [Japanese wordlist](https://github.com/bitcoin/bips/blob/master/bip-0039/japanese.txt)
+link-bip39-ko [Korean wordlist](https://github.com/bitcoin/bips/blob/master/bip-0039/korean.txt)
+link-bip39-pt [Portuguese wordlist](https://github.com/bitcoin/bips/blob/master/bip-0039/portuguese.txt)
+link-bip39-zh_tw [Tradional Chinese wordlist](https://github.com/bitcoin/bips/blob/master/bip-0039/chinese_traditional.txt)
+link-bip39-zh_cn [Simplified Chinese wordlist](https://github.com/bitcoin/bips/blob/master/bip-0039/chinese_simplified.txt)
+
+# EIPs; see https://eips.ethereum.org/all
+link-eip-155 [EIP-155](https://eips.ethereum.org/EIPS/eip-155)
+link-eip-191 [EIP-191](https://eips.ethereum.org/EIPS/eip-191)
+link-eip-609 [EIP-609](https://eips.ethereum.org/EIPS/eip-609)
+link-eip-634 [EIP-634](https://eips.ethereum.org/EIPS/eip-634)
+link-eip-712 [EIP-712](https://eips.ethereum.org/EIPS/eip-712)
+link-eip-1014 [EIP-1014](https://eips.ethereum.org/EIPS/eip-1014)
+link-eip-1193 [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193)
+link-eip-1559 [EIP-1559](https://eips.ethereum.org/EIPS/eip-1559)
+link-eip-1577 [EIP-1577](https://eips.ethereum.org/EIPS/eip-1577)
+link-eip-2070 [EIP-2930](https://eips.ethereum.org/EIPS/eip-2070)
+link-eip-2098 [EIP-2098](https://eips.ethereum.org/EIPS/eip-2098)
+link-eip-2304 [EIP-2304](https://eips.ethereum.org/EIPS/eip-2304)
+link-eip-2718 [EIP-2718](https://eips.ethereum.org/EIPS/eip-2718)
+link-eip-2930 [EIP-2930](https://eips.ethereum.org/EIPS/eip-2930)
+link-eip-4788 [EIP-4844](https://eips.ethereum.org/EIPS/eip-4788)
+link-eip-4844 [EIP-4844](https://eips.ethereum.org/EIPS/eip-4844)
+
+# Open Standards
+link-base58 [Base58](https://en.bitcoinwiki.org/wiki/Base58)
+link-cors [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
+link-crowdsale [Crowdsale Wallet](https://github.com/ethereum/pyethsaletool)
+link-icap [ICAP Address](https://github.com/ethereum/wiki/wiki/Inter-exchange-Client-Address-Protocol-%28ICAP%29)
+link-jsonrpc [link-jsonrpc](https://github.com/ethereum/wiki/wiki/JSON-RPC)
+link-mit [MIT License](https://en.m.wikipedia.org/wiki/MIT_License)
+link-namehash [namehash](https://docs.ens.domains/contract-api-reference/name-processing#hashing-names)
+link-rlp [Recursive-Length Prefix](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/)
+link-pbkdf2 [PBKDF2](https://en.wikipedia.org/wiki/PBKDF2)
+link-solc-abi [ABI Specification](https://docs.soliditylang.org/en/v0.8.19/abi-spec.html#formal-specification-of-the-encoding)
+link-solc-jsonabi [ABI JSON Specification](https://docs.soliditylang.org/en/v0.8.19/abi-spec.html#json)
+link-solc-errors [Solidity Custom Errors](https://docs.soliditylang.org/en/v0.8.4/abi-spec.html#errors)
+link-solc-events [Solidity Events](https://docs.soliditylang.org/en/v0.8.4/abi-spec.html#events)
+link-solc-output [solc standard output](https://solidity.readthedocs.io/en/v0.6.0/using-the-compiler.html#output-description)
+link-solc-packed [Non-Standard Packed Mode](https://docs.soliditylang.org/en/v0.8.14/abi-spec.html#non-standard-packed-mode)
+link-uuid [UUID](https://www.ietf.org/rfc/rfc4122.txt)
+