Abstracted JSON-RPC parameter generation for others to use.

Ethers v5 beta

.circleci/config.yml

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

CHANGELOG.md

@@ -3,6 +3,165 @@ Changelog
 
 This change log is managed by `scripts/cmds/update-versions` but may be manually updated.
 
+ethers/v5.0.0-beta.176 (2020-03-12 19:10)
+-----------------------------------------
+
+  - Checking in initial Eip1193Bridge (experimental). ([2c78f0b](https://github.com/ethers-io/ethers.js/commit/2c78f0bf265a0f7c9f4cfc1bc79ecd4629b59c49))
+  - Added initial WebSocketProvider. ([#141](https://github.com/ethers-io/ethers.js/issues/141); [117a5dd](https://github.com/ethers-io/ethers.js/commit/117a5dd7ffa783c4335c0b87621437447cd499d0))
+  - Renamed properties based on community recommendations; estimate to estimateGas and addressPromise to resovledAddress. ([fe3b3fa](https://github.com/ethers-io/ethers.js/commit/fe3b3fa1aded67827fec1131931d95d8153d8f32))
+  - Better error reporting and fixed look-ahead for data labels. ([e52312e](https://github.com/ethers-io/ethers.js/commit/e52312e783b8d0fdd7e9992716cbe2e179751b38))
+
+ethers/v5.0.0-beta.175 (2020-02-27 19:53)
+-----------------------------------------
+
+  - Fix address-less filter listening in Provider. ([#741](https://github.com/ethers-io/ethers.js/issues/741); [64dccb2](https://github.com/ethers-io/ethers.js/commit/64dccb275c68ebb40328350d4ab5be0f29b8a02e))
+  - Added sync version of wallet decryption. ([0ad94cd](https://github.com/ethers-io/ethers.js/commit/0ad94cdf8137259bedb38c0dc949b61570bcdac0), [6809c37](https://github.com/ethers-io/ethers.js/commit/6809c370c027aea148466c00d3ce09c6d0ee6ddc))
+
+ethers/v5.0.0-beta.175 (2020-02-27 19:38)
+-----------------------------------------
+
+  - Fix address-less filter listening in Provider. ([#741](https://github.com/ethers-io/ethers.js/issues/741); [64dccb2](https://github.com/ethers-io/ethers.js/commit/64dccb275c68ebb40328350d4ab5be0f29b8a02e))
+  - Added sync version of wallet decryption. ([0ad94cd](https://github.com/ethers-io/ethers.js/commit/0ad94cdf8137259bedb38c0dc949b61570bcdac0))
+
+ethers/v5.0.0-beta.174 (2020-02-25 14:57)
+-----------------------------------------
+
+  - Reduced default Provider quorum for testnets. ([1cfab31](https://github.com/ethers-io/ethers.js/commit/1cfab3173c3d0519beffc054efe73f70b7d28501))
+  - Added JSON-RPC debugging on error responses. ([ad27600](https://github.com/ethers-io/ethers.js/commit/ad27600c699827858e7343adff2d4fa622248e42))
+  - Fixed setLogLevel to affect global logging. ([ac51a88](https://github.com/ethers-io/ethers.js/commit/ac51a88c2913d7055e050c91d7d96bb42abf6656))
+  - Renamed interface getTopic to getEventTopic. ([f61f34b](https://github.com/ethers-io/ethers.js/commit/f61f34bfb295bafee3b7ee426efa696aaa9bbafe))
+  - Fix log parsing when no matching topic hash is found. ([#733](https://github.com/ethers-io/ethers.js/issues/733); [a5d2ec5](https://github.com/ethers-io/ethers.js/commit/a5d2ec534f75b21eebe69a789a3c43c33014a825), [4b8e198](https://github.com/ethers-io/ethers.js/commit/4b8e198bf209fcf0aea55018d8940355ea4345de), [89ac9f4](https://github.com/ethers-io/ethers.js/commit/89ac9f4f298ac340c4429e8ebdacd29962eba7f4))
+
+ethers/v5.0.0-beta.173 (2020-02-12 17:09)
+-----------------------------------------
+
+  - Added experimental EipWrappedProvider. ([944600d](https://github.com/ethers-io/ethers.js/commit/944600d779564c500ab98d3265286a0717642614))
+  - Updated signature for JsonRpcProvider.send to match EIP-1193. ([b962b59](https://github.com/ethers-io/ethers.js/commit/b962b59ab72e67bc4566a361964e42cf1b791025))
+  - Added binary literal support to ASM grammar. ([375bd15](https://github.com/ethers-io/ethers.js/commit/375bd15594a3179432e8452d819d91ea72b4bdd8))
+  - Added explicit pop placeholders to ASM dialect. ([a6b696d](https://github.com/ethers-io/ethers.js/commit/a6b696d8bd03c4027b52fe23745f066d158f1420))
+  - Added position independent code option for asm. ([89615c5](https://github.com/ethers-io/ethers.js/commit/89615c59d385a58fa79b6bbd8eae53c30e45fe96))
+  - Added ASM semantic checking and the Pop placeholder. ([a33bf0e](https://github.com/ethers-io/ethers.js/commit/a33bf0e37f4f969cc03b85ebf0dbadcf3e9b068a))
+  - Better type safety for defineReadOnly. ([e7adc84](https://github.com/ethers-io/ethers.js/commit/e7adc84a972968f39a983efb6f21b6ceaacd6cc5))
+  - Fixed CLI sandbox quiting after prompt entry. ([ff9bc2a](https://github.com/ethers-io/ethers.js/commit/ff9bc2a282e617125bbca76702dec85149661390))
+
+ethers/v5.0.0-beta.172 (2020-02-04 00:59)
+-----------------------------------------
+
+  - Synced GitHub issue cache. ([13dbf1f](https://github.com/ethers-io/ethers.js/commit/13dbf1f965eab344d2a304f7612d19ea96391261))
+  - Better typing for Timers. ([5622f70](https://github.com/ethers-io/ethers.js/commit/5622f703d962993442623ef1450a595825c4efa8))
+  - Safer transaction serialization, matching signature.v with chainId. ([#708](https://github.com/ethers-io/ethers.js/issues/708); [edb7c5d](https://github.com/ethers-io/ethers.js/commit/edb7c5da91ce271688561364d867998b0f0675e3))
+  - Fixed Opcode typo and added check to prevent future typos. ([15bb840](https://github.com/ethers-io/ethers.js/commit/15bb8409077f96b22e8bd60c426cddd015454e6b))
+  - Renamed AST nodes for teh assembler. ([f02c7db](https://github.com/ethers-io/ethers.js/commit/f02c7db4109d1785b4528757aa50f24948e896ae))
+  - Added timeout to waitForTransaction. ([#477](https://github.com/ethers-io/ethers.js/issues/477); [bacc440](https://github.com/ethers-io/ethers.js/commit/bacc4403979fa423890e269e7a5c7d11c6891a9f))
+  - Added CLI for asm package. ([aafa42a](https://github.com/ethers-io/ethers.js/commit/aafa42a32b2a5c7481a409ad048dfc06112c6599))
+  - Prevent Signer.checkTransaction from creating conflicting from properties. ([1decb13](https://github.com/ethers-io/ethers.js/commit/1decb1379902b60a15925b9b1de39633393db825))
+  - Include asm in generated TypeScript dependencies. ([ba29618](https://github.com/ethers-io/ethers.js/commit/ba296188960fb345dfdab12f2bb3ed3dc5eab51a))
+  - Clean up some asm checks and dead code. ([fa317eb](https://github.com/ethers-io/ethers.js/commit/fa317ebc032f8a5f9fb2dd10e23496252ae744e1))
+  - More contained Opcode API. ([da8153c](https://github.com/ethers-io/ethers.js/commit/da8153c87753b79e5e4cd34d484b8e0e717426d9))
+  - Added initial codedrop for the asm package. ([0296594](https://github.com/ethers-io/ethers.js/commit/0296594aba8d1e90e9ef7a18d2324f6cac815953))
+
+ethers/v5.0.0-beta.171 (2020-02-01 05:05)
+-----------------------------------------
+
+  - Added CLI for asm package. ([aafa42a](https://github.com/ethers-io/ethers.js/commit/aafa42a32b2a5c7481a409ad048dfc06112c6599))
+  - Added more flatworm documentation. ([1c85fe9](https://github.com/ethers-io/ethers.js/commit/1c85fe95b2b536828e83087676becba85c9a90bb))
+  - Prevent Signer.checkTransaction from creating conflicting from properties. ([1decb13](https://github.com/ethers-io/ethers.js/commit/1decb1379902b60a15925b9b1de39633393db825))
+  - Include asm in generated TypeScript dependencies. ([ba29618](https://github.com/ethers-io/ethers.js/commit/ba296188960fb345dfdab12f2bb3ed3dc5eab51a))
+  - Clean up some asm checks and dead code. ([fa317eb](https://github.com/ethers-io/ethers.js/commit/fa317ebc032f8a5f9fb2dd10e23496252ae744e1))
+  - More contained Opcode API. ([da8153c](https://github.com/ethers-io/ethers.js/commit/da8153c87753b79e5e4cd34d484b8e0e717426d9))
+  - Added initial codedrop for the asm package. ([0296594](https://github.com/ethers-io/ethers.js/commit/0296594aba8d1e90e9ef7a18d2324f6cac815953))
+
+ethers/v5.0.0-beta.171 (2020-01-29 21:41)
+-----------------------------------------
+
+  - Better solc support in CLI; it will search the local pacakge for an existing solc version. ([7428776](https://github.com/ethers-io/ethers.js/commit/7428776f75222d5c07282bc29c3dd8ed99f5d2cc))
+  - Update ENS registry address and lower default quorum for testnets. ([edb49da](https://github.com/ethers-io/ethers.js/commit/edb49da15518f25b3d60813ebb84f54171e308f3))
+  - Exposed isBytes and isBytesLike in ethers.utils. ([99329b0](https://github.com/ethers-io/ethers.js/commit/99329b013ce7f3af301d40c41f7eb35bff288910))
+
+ethers/v5.0.0-beta.170 (2020-01-21 20:37)
+-----------------------------------------
+
+  - Better, easier and more provider testing. ([e0d1d38](https://github.com/ethers-io/ethers.js/commit/e0d1d3866d2559f39627254873a0a1d4c0fcaf3d))
+  - Fixed out-of-bounds difficulty in getBlock, which can affect PoA networks. ([#711](https://github.com/ethers-io/ethers.js/issues/711); [251882c](https://github.com/ethers-io/ethers.js/commit/251882ced4379931ec82ba28a4db10bc7dbf3580))
+
+ethers/v5.0.0-beta.169 (2020-01-20 19:42)
+-----------------------------------------
+
+  - Fixed imports after refactor. ([adf5622](https://github.com/ethers-io/ethers.js/commit/adf56229c6cc83003d319ea9a004677e2555d478))
+  - Refactor some enum names and add UTF-8 error support to the umbrella package. ([931da2f](https://github.com/ethers-io/ethers.js/commit/931da2f77446fc9266cf07f0d7d78d4376625005))
+  - Allow arbitrary apiKey for UrlJsonRpcProvider. ([5878b54](https://github.com/ethers-io/ethers.js/commit/5878b54d6eded1329a6dc3b4023f876a87f72b6e))
+  - Added more general error handling (e.g. error, ignore, replace) for calling toUtf8String. ([a055edb](https://github.com/ethers-io/ethers.js/commit/a055edb5855b96fdf179403458c1694b96fd906c))
+
+ethers/v5.0.0-beta.168 (2020-01-18 21:46)
+-----------------------------------------
+
+  - Much more resiliant FallbackProvider which can ignore properties that are only approximate and supports per-provider priorities. ([#635](https://github.com/ethers-io/ethers.js/issues/635), [#588](https://github.com/ethers-io/ethers.js/issues/588); [f4bcf24](https://github.com/ethers-io/ethers.js/commit/f4bcf24a257a17ec9beb98f3d0b3682de543534c))
+  - Fixed some typing for receipts and logs. ([#497](https://github.com/ethers-io/ethers.js/issues/497); [ea102ef](https://github.com/ethers-io/ethers.js/commit/ea102ef7c4fa5df7b9389fbc8a2947bbbd4c471e))
+  - Abstracting mnemonic phrases. ([#685](https://github.com/ethers-io/ethers.js/issues/685); [92a383f](https://github.com/ethers-io/ethers.js/commit/92a383ff0dad4587e44953efca3c6ab795a1b1bd))
+  - Sync GitHub issues. ([75e1a37](https://github.com/ethers-io/ethers.js/commit/75e1a37bb5935d5d538ffcfce5b0073e1334d457))
+  - Fixed 304 status for fetchJson. ([c66d81e](https://github.com/ethers-io/ethers.js/commit/c66d81e96f7c9b0808f181085ffe1c92f6219d46))
+
+ethers/v5.0.0-beta.167 (2020-01-11 04:16)
+-----------------------------------------
+
+  - Fixed testcases for provider changes. ([90ed07c](https://github.com/ethers-io/ethers.js/commit/90ed07c74e7230ea0f02288b140d497d8b9779e0))
+  - Add support for legacy flat signatures with recid instead of normalized v. ([245cd0e](https://github.com/ethers-io/ethers.js/commit/245cd0e48e07eef35f5bf45ee7fe5ed5ef31338a))
+  - Fix TransactionResponse to have chainId instead of legacy networkId. ([#700](https://github.com/ethers-io/ethers.js/issues/700); [72b3bc9](https://github.com/ethers-io/ethers.js/commit/72b3bc9909074893038c768f3da1564ed96a6a20))
+  - Fixed splitSignature computing wrong v for BytesLike. ([#700](https://github.com/ethers-io/ethers.js/issues/700); [4151c0e](https://github.com/ethers-io/ethers.js/commit/4151c0eacd22287e2369a8656ffa00359db6f84b))
+  - Added dist files for hardware-wallets. ([c846649](https://github.com/ethers-io/ethers.js/commit/c84664953d2f50ee0d704a8aa18fe6c08668dabb))
+  - Browser support (with dist files) for Ledger. ([6f7fbf3](https://github.com/ethers-io/ethers.js/commit/6f7fbf3858c82417933a5e5595a919c0ec0487c7))
+
+ethers/v5.0.0-beta.166 (2020-01-10 03:09)
+-----------------------------------------
+
+  - Relaxed joinSignature API to allow SignauteLike. ([602e6a8](https://github.com/ethers-io/ethers.js/commit/602e6a8973480299843a0158f75451a2c6aac749))
+  - Initial code drop of new hardware wallet package. ([2e8f5ca](https://github.com/ethers-io/ethers.js/commit/2e8f5ca7ed498261079da75713b18f3370dfd236))
+  - Added more docs. ([381a72d](https://github.com/ethers-io/ethers.js/commit/381a72ddaa7fb59ef2ded84d228296d693df05c3))
+
+ethers/v5.0.0-beta.165 (2020-01-09 03:31)
+-----------------------------------------
+
+  - Fixed require resolution for CLI scripts. ([c04f9a7](https://github.com/ethers-io/ethers.js/commit/c04f9a7fff727bb04a4aa3a0fa05fd5cd8e795a6))
+  - Added new URLs for default ETC (and ETC testnets) providers. ([#351](https://github.com/ethers-io/ethers.js/issues/351); [3c184ac](https://github.com/ethers-io/ethers.js/commit/3c184ace21aafbb27f4d44cce1bb738af899d59f))
+
+ethers/v5.0.0-beta.164 (2020-01-07 19:57)
+-----------------------------------------
+
+  - Use better Description typing. ([2d5492c](https://github.com/ethers-io/ethers.js/commit/2d5492cd2ee722c818c249244af7b5bea05d67b0))
+  - Better property access on ABI decoded results. ([#698](https://github.com/ethers-io/ethers.js/issues/698); [13f50ab](https://github.com/ethers-io/ethers.js/commit/13f50abd847f7ddcc7e54c102da54e2d23b86fae))
+  - Better typing support for Description. ([d0f4642](https://github.com/ethers-io/ethers.js/commit/d0f4642f6d2c9f5119f1910a0082894c60e81191))
+  - Fixed resolveName when name is an address with an invalid checksum. ([#694](https://github.com/ethers-io/ethers.js/issues/694); [1e72fc7](https://github.com/ethers-io/ethers.js/commit/1e72fc7d6f7c3be4410dbdcfbab9a0463ceb52bd))
+
+ethers/v5.0.0-beta.163 (2020-01-06 18:57)
+-----------------------------------------
+
+  - Added function to generate CREATE2 addresses. ([#697](https://github.com/ethers-io/ethers.js/issues/697); [eb26a6d](https://github.com/ethers-io/ethers.js/commit/eb26a6d95022a241c44f859e7b2f29646afb4914))
+  - Force constructor name to be null (instead of undefined). ([a648f2b](https://github.com/ethers-io/ethers.js/commit/a648f2bd1e5e52a3662896f04fe7025884866972))
+  - Added documentation uploading script. ([e593aba](https://github.com/ethers-io/ethers.js/commit/e593aba2946c98820b0c2edf9c5dab6cb30c7402))
+  - Added Czech wordlist to default wordlists export. ([#691](https://github.com/ethers-io/ethers.js/issues/691); [5724fa5](https://github.com/ethers-io/ethers.js/commit/5724fa5d9c6fe73f14ec8bdea1f7226a222537ef))
+  - Added Czech BIP-39 wordlist. ([#691](https://github.com/ethers-io/ethers.js/issues/691); [f54f06b](https://github.com/ethers-io/ethers.js/commit/f54f06b5c8092997fd3c9055d69a3e0796ce44f3))
+  - Updated README. ([e809ead](https://github.com/ethers-io/ethers.js/commit/e809eadf8d608cd8c8a78c08a2e3547dd09156cf))
+  - Updating docs. ([184c459](https://github.com/ethers-io/ethers.js/commit/184c459fab0d089a8a879584b72e5eb3560b33ce))
+  - Merge branch 'yuetloo-ethers-v5-beta' into ethers-v5-beta ([06cafe3](https://github.com/ethers-io/ethers.js/commit/06cafe3437ef129b47f5f9c02f4759f2c4854d3c))
+  - Add circleci and parity test files ([fdf0980](https://github.com/ethers-io/ethers.js/commit/fdf0980663ffead0faf3e9b7b233b22ca1574e21))
+  - Fixed typo in package test dist scripts. ([9c78c7f](https://github.com/ethers-io/ethers.js/commit/9c78c7fee69d07733048d898d58205ae7f5c82d7))
+
+ethers/v5.0.0-beta.162 (2019-11-25 0:02)
+----------------------------------------
+
+  - Update elliptic package to protect from Minerva timing attack. ([#666](https://github.com/ethers-io/ethers.js/issues/666); [cf036e1](https://github.com/ethers-io/ethers.js/commit/cf036e1ffad3340fcf1c7559d0032493ccc08e6e))
+  - Browser and node testing works again. ([4470477](https://github.com/ethers-io/ethers.js/commit/4470477d7fd3031f2f3a1fbd9c538468c33c7350))
+
+ethers/v5.0.0-beta.161 (2019-11-23 21:43)
+-----------------------------------------
+
+  - Updated dist files (sorted package.json to reduce package version change chatter). ([f308ba3](https://github.com/ethers-io/ethers.js/commit/f308ba3540ed0d282d099456d0369873ad9596b0))
+  - Stubs for adding throttle support. ([2f0e679](https://github.com/ethers-io/ethers.js/commit/2f0e679f0bc81bf901cf60a79e50f9715cddec5a))
+  - Refactor wordlists. ([abab9f6](https://github.com/ethers-io/ethers.js/commit/abab9f6aa27d1870d1053e7caa951408b86c454d))
+  - Browser testcases work again. ([c11c2e2](https://github.com/ethers-io/ethers.js/commit/c11c2e2e3376a6764f07ed443245823f2792b8cc))
+  - Added dist files for non-English wordlists. ([3d75c52](https://github.com/ethers-io/ethers.js/commit/3d75c52dac668af5eeede3e7764dadd3055a0707))
+  - Sync GitHub issue cache. ([29f0e9d](https://github.com/ethers-io/ethers.js/commit/29f0e9dd627a7b4b7f772300497f27718c9ecc7b))
+
 ethers/v5.0.0-beta.160 (2019-11-20 18:36)
 -----------------------------------------
 

README.md

@@ -1,11 +1,17 @@
 The Ethers Project
 ==================
 
-**EXPERIMENTAL!!!**
+**EXPERIMENTAL**
 
-This is just a development version to experiment with lerna.
+This branch is the next release of ethers.js, which should
+be promoted to the official release shortly.
 
-**Do NOT use**
+I would recommend it for most new projects and personally use
+it for my own projects.
+
+The [new documentation](https://docs-beta.ethers.io) is still a
+bit sparse, but is coming along as well and will be complete
+before the promotion to master.
 
 
 Installing
@@ -17,10 +23,18 @@ Installing
 /home/ricmoo/some_project> npm install --save ethers@next
 ```
 
-**browser**
+**browser (UMD)**
 
 ```
-<script src="https://cdn.ethers.io/lib/ethers-5.0.min.js" type="text/javasctipt">
+<script src="https://cdn.ethers.io/lib/ethers-5.0.umd.min.js" type="text/javasctipt">
+</script>
+```
+
+**browser (ESM)**
+
+```
+<script type="module">
+    import { ethers } from "https://cdn.ethers.io/lib/ethers-5.0.umd.min.js";
 </script>
 ```
 

admin/build.js

@@ -36,7 +36,7 @@ function run(progname, args, ignoreErrorStream) {
                 console.log("ERROR");
                 console.log(stderr.toString());
 
-                let error = new Error("stderr not empty");
+                let error = new Error(`stderr not empty: ${ progname } ${ JSON.stringify(args) }`);
                 error.stderr = stderr.toString();
                 error.stdout = stdout.toString();
                 error.statusCode = code;
@@ -105,7 +105,7 @@ function runBuild(buildModule) {
 }
 
 function runDist() {
-    return run("npm", [ "run", "_dist_ethers" ], true);
+    return run("npm", [ "run", "_dist" ], true);
 }
 
 module.exports = {

admin/changelog.js

@@ -105,9 +105,41 @@ async function generate() {
     return formatted.join("\n") + "\n";
 }
 
+function getChanges() {
+    const changes = [ ];
+
+    let lastLine = null;
+    fs.readFileSync(ChangelogPath).toString().split("\n").forEach((line) => {
+        line = line.trim();
+        if (line === "") { return; }
+
+        if (line.substring(0, 5) === "-----") {
+            changes.push({ title: lastLine, lines: [ ] });
+        } else if (line.substring(0, 1) === "-" && changes.length) {
+            changes[changes.length - 1].lines.push(line);
+        }
+        lastLine = line;
+    });
+
+    return changes;
+}
+
+function latestChange() {
+    const recent = getChanges()[0];
+
+    const match = recent.title.match(/ethers\/([^\(]*)\(([^\)]*)\)/);
+
+    return {
+        title: recent.title,
+        version: match[1].trim(),
+        data: match[2].trim(),
+        content: recent.lines.join("\n")
+    };
+}
+
 module.exports = {
     generate: generate,
+    latestChange: latestChange,
     ChangelogPath: ChangelogPath,
 }
 
-

admin/cmds/publish.js

@@ -2,13 +2,16 @@
 
 const config = require("../config");
 
+const { latestChange } = require("../changelog");
 const { getOrdered, loadPackage } = require("../depgraph");
+const { createRelease } = require("../github");
 const { getPackageVersion, publish } = require("../npm");
 const { log } = require("../log");
 
 const USER_AGENT = "ethers-dist@0.0.0";
 const TAG = "next";
 
+
 let dirnames = getOrdered();
 
 // Only publish specific packages
@@ -32,6 +35,8 @@ if (process.argv.length > 2) {
 (async function() {
     let token = null;
 
+    let includeEthers = false;
+
     // @TODO: Fail if there are any untracked files or unchecked in files
 
     // Load the token from the encrypted store
@@ -68,6 +73,7 @@ if (process.argv.length > 2) {
 
         if (dirname === "ethers") {
             options.tag = "next";
+            includeEthers = true;
         } else {
             options.tag = "latest";
         }
@@ -89,4 +95,20 @@ if (process.argv.length > 2) {
         log("  <green:Done.>");
     }
 
+    // Publish the GitHub release (currently beta)
+    const beta = true;
+    if (includeEthers) {
+
+        // The password above already succeeded
+        const username = await config.get("github-user");
+        const password = await config.get("github-release");
+
+        // Get the latest change from the changelog
+        const change = latestChange();
+
+        // Publish the release
+        const link = await createRelease(username, password, change.version, change.title, change.content, beta);
+        log(`<bold:Published Release:> ${ link }...`);
+    }
+
 })();

admin/cmds/update-exports.js

@@ -12,9 +12,13 @@ const output = `"use strict";
 
 import * as ethers from "./ethers";
 
-if ((<any>global)._ethers == null) {
-    (<any>global)._ethers = ethers;
-}
+try {
+    const anyGlobal = (window as any);
+
+    if (anyGlobal._ethers == null) {
+        anyGlobal._ethers = ethers;
+    }
+} catch (error) { }
 
 export { ethers };
 

admin/cmds/upload-docs.js

@@ -0,0 +1,172 @@
+"use strict";
+
+const crypto = require('crypto');
+const fs = require('fs');
+const path = require('path');
+
+const AWS = require('aws-sdk');
+
+const config = require("../config");
+
+
+const Bucket = "docs-beta.ethers.io";
+
+
+function _getKeys(s3, result, nextToken, callback) {
+    const params = {
+        Bucket: Bucket,
+        MaxKeys: 1000,
+        ContinuationToken: nextToken,
+    };
+    s3.listObjectsV2(params, function(error, data) {
+        if (error) {
+            console.log(error);
+            callback(error);
+            return;
+        }
+        data.Contents.forEach(function(item) {
+            result[item.Key] = item.ETag.replace(/"/g,'');
+        });
+        callback(null, data.IsTruncated ? data.NextContinuationToken: null);
+    });
+}
+
+function getKeys(s3) {
+    const result = {};
+    return new Promise(function(resolve, reject) {
+        function handleBlock(error, nextToken) {
+            if (error) {
+                reject(error);
+            } else if (nextToken) {
+                nextBlock(nextToken);
+            } else {
+                resolve(result);
+            }
+        }
+        function nextBlock(nextToken) {
+            _getKeys(s3, result, nextToken, handleBlock);
+        }
+        nextBlock(undefined);
+    });
+}
+
+function getMime(filename) {
+    const comps = filename.split('.');
+    const ext = comps[comps.length - 1];
+    switch (ext.toLowerCase()) {
+        case 'css':      return 'text/css';
+        case 'doctree':  return 'application/x-doctree';
+        case 'eot':      return 'application/vnd.ms-fontobject';
+        case 'gif':      return 'image/gif';
+        case 'html':     return 'text/html';
+        case 'js':       return 'application/javascript';
+        case 'jpg':      return 'image/jpeg';
+        case 'jpeg':     return 'image/jpeg';
+        case 'md':       return 'text/markdown';
+        case 'pickle':   return 'application/x-pickle';
+        case 'png':      return 'image/png';
+        case 'svg':      return 'image/svg+xml';
+        case 'ttf':      return 'application/x-font-ttf';
+        case 'txt':      return 'text/plain';
+        case 'woff':     return 'application/font-woff';
+    }
+    console.log('NO MIME', filename);
+    return undefined;
+}
+
+function putObject(s3, name, content) {
+    return new Promise(function(resolve, reject) {
+        s3.putObject({
+            ACL: 'public-read',
+            Body: content,
+            Bucket: Bucket,
+            ContentType: getMime(name),
+            Key: name
+        }, function(error, data) {
+            if (error) {
+                reject(error);
+            } else {
+                console.log('Uplodaed:', name)
+                resolve({
+                    name: name,
+                    hash: data.ETag.replace(/"/g, '')
+                });
+            }
+        });
+    });
+}
+
+function hash(filename) {
+    const hasher = crypto.createHash('md5');
+    hasher.update(fs.readFileSync(filename));
+    return hasher.digest().toString('hex');
+}
+
+function _getFiles(result, root) {
+    fs.readdirSync(root).forEach(function(filename) {
+
+        // We don't need to upload junk
+        if (filename === '.DS_Store') { return; }
+
+        const fullFilename = path.join(root, filename)
+        const stat = fs.statSync(fullFilename);
+        if (stat.isDirectory()) {
+            _getFiles(result, fullFilename);
+        } else {
+            result[fullFilename] = hash(fullFilename);
+        }
+    });
+}
+
+function getFiles(dirs) {
+    const result = { } //"index.html": hash("index.html") };
+    dirs.forEach(function(dir) {
+        _getFiles(result, dir);
+    })
+    return result;
+}
+
+(async function() {
+    const awsAccessId = await config.get("aws-upload-docs-accesskey");
+    const awsSecretKey = await config.get("aws-upload-docs-secretkey");
+
+    const s3 = new AWS.S3({
+        apiVersion: '2006-03-01',
+        accessKeyId: awsAccessId,
+        secretAccessKey: awsSecretKey
+    });
+
+    const added = [], removed = [], changed = [], upload = [];
+
+    const local = await getFiles([ "docs" ]);
+    const remote = await getKeys(s3);
+
+    Object.keys(local).forEach((filename) => {
+        if (!remote[filename]) {
+            added.push(filename);
+            upload.push(filename);
+        } else if (remote[filename] != local[filename]) {
+            changed.push(filename);
+            upload.push(filename);
+        }
+    });
+
+    Object.keys(remote).forEach((filename) => {
+        if (!local[filename]) {
+            removed.push(filename);
+        } else if (!local[filename] && remote[filename] != local[filename]) {
+            changed.push(filename);
+            upload.push(filename);
+        }
+    });
+
+    console.log('Added:    ', added.length);
+    console.log('Removed:  ', removed.length);
+    console.log('Changed:  ', changed.length);
+
+    for (let i = 0; i < upload.length; i++) {
+        const filename = upload[i];
+        console.log("Uploading:", filename);
+        await putObject(s3, filename, fs.readFileSync(filename));
+    }
+})();

admin/config.js

@@ -57,6 +57,11 @@ Config.prototype.load = async function() {
     }
 };
 
+Config.prototype.keys = async function() {
+    await this.load();
+    return Object.keys(this.values);
+}
+
 Config.prototype.save = function() {
     this.values._junk = Buffer.from(randomBytes(16 + parseInt(Math.random() * 48))).toString("base64")
 
@@ -102,6 +107,9 @@ module.exports = {
     set: function(key, value) {
         config.set(key, value);
     },
+    keys: function() {
+        return config.keys();
+    },
     lock: function() {
         config.lock();
     }

admin/github.js

@@ -128,7 +128,35 @@ function syncIssues(user, password) {
     return _getIssues(user, password);
 }
 
+async function createRelease(user, password, tagName, title, body, prerelease, commit) {
+    const payload = {
+        tag_name: tagName,
+        target_commitish: (commit || "master"),
+        name: title,
+        body: body,
+        //draft: true,
+        draft: false,
+        prerelease: !!prerelease
+    };
+
+    const headers = {
+        "User-Agent": "ethers-io",
+    };
+
+    const result = await fetchJson({
+        url: "https://api.github.com/repos/ethers-io/ethers.js/releases",
+        user: user,
+        password: password,
+        headers: headers
+    }, JSON.stringify(payload));
+
+
+    return result.html_url;
+}
+
 module.exports = {
     getIssues,
     syncIssues,
+    createRelease,
 }
+

admin/test-parity/parity-dev.json

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

admin/test-parity/parity-dev.pwds

@@ -0,0 +1 @@
+

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

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

admin/utils.js

@@ -25,7 +25,7 @@ function getDate(date) {
 
 function getDateTime(date) {
     return getDate(date) + " " + [
-        date.getHours(),
+        zpad(date.getHours()) ,
         zpad(date.getMinutes() + 1)
     ].join(":");
 }

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

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

docs.wrm/api/contract/example.wrm

@@ -0,0 +1,150 @@
+_section: Example: ERC-20 Contract
+
+_subsection: Connecting to a Contract
+
+_code: token.txt
+
+
+_heading: ERC20Contract @INHERIT<[[contract]]>
+
+_property: new ethers.Contract(address, abi, providerOrSigner)
+See the above code example for creating an Instance which will
+(in addition to the Contact methods and properties) automatically
+add the additional properties defined in //abi// to a **Contract**
+connected to //address// using the //providerOrSigner//.
+
+
+_subsection: Properties ^^//(inheritted from [[contract]])//^^
+
+_property: erc20.address => string<[[address]]>
+This is the address (or ENS name) the contract was constructed with.
+
+_property: erc20.addressPromise => string<[[address]]>
+This is a promise that will resolve to the address the **Contract**
+object is attached to. If an [[address]] was provided to the constructor,
+it will be equal to this; if an ENS name was provided, this will be the
+resolved address.
+
+_property: erc20.deployTransaction => [[provider-transactionresponse]]
+If the **Contract** object is the result of a ContractFactory deployment,
+this is the transaction which was used to deploy the contract.
+
+_property: erc20.interface => [[abi-interface]]
+This is the ABI as an [[abi-interface]].
+
+_property: erc20.provider => [[provider]]
+If a provider was provided to the constructor, this is that provider. If
+a signer was provided that had a [[provider]], this is that provider.
+
+_property: erc20.signer => [[signer]]
+If a signer was provided to the constructor, this is that signer.
+
+
+_subsection: Methods ^^//(inheritted from [[contract]])//^^
+
+_property: erc20.attach(addressOrName) => [[contract]]
+Returns a new instance of the **Contract** attached to a new
+address. This is useful if there are multiple similar or identical
+copies of a Contract on the network and you wish to interact with
+each of them.
+
+_property: erc20.connect(providerOrSigner) => [[contract]]
+Returns a new instance of the Contract, but connected to
+//providerOrSigner//.
+
+By passing in a [[provider]], this will return a downgraded
+**Contract** which only has read-only access (i.e. constant calls).
+
+By passing in a [[signer]]. the will return a **Contract** which
+will act on behalf of that signer.
+
+_property: erc20.deployed() => Promise<Contract>
+
+_property: Contract.isIndexed(value) => boolean
+
+
+_subsection: Events ^^//(inheritted from Contract)//^^ @<erc20-events>
+
+_property: erc20.queryFilter(event [ , fromBlockOrBlockHash [ , toBlock ]) => Promise<Array<Event>> @<erc20-queryfilter>
+Return Events that match the //event//.
+
+_property: erc20.listenerCount([ event ]) => number
+Return the number of listeners that are subscribed to //event//. If
+no event is provided, returns the total count of all events.
+
+_property: erc20.listeners(event) => Array<Listener>
+Return a list of listeners that are subscribed to //event//.
+
+_property: erc20.off(event, listener) => this
+Unsubscribe //listener// to //event//.
+
+_property: erc20.on(event, listener) => this
+Subscribe to //event// calling //listener// when the event occurs.
+
+_property: erc20.once(event, listener) => this
+Subscribe once to //event// calling //listener// when the event
+occurs.
+
+_property: erc20.removeAllListeners([ event ]) => this
+Unsubscribe all listeners for //event//. If no event is provided,
+all events are unsubscribed.
+
+
+_subsection: Meta-Class Methods ^^//(added at Runtime)//^^
+
+Since the Contract is a Meta-Class, the methods available here depend
+on the ABI which was passed into the **Contract**.
+
+_property: erc20.decimals([ overrides ]) => Promise<number>
+Returns the number of decimal places used by this ERC-20 token. This can be
+used with [parseUnits](utils-parseunits) when taking input from the user or
+[formatUnits](utils-formatunits] when displaying the token amounts in the UI.
+
+_property: erc20.getBalance(owner [, overrides ]) => Promise<[[bignumber]]>
+Returns the balance of //owner// for this ERC-20 token.
+
+_property: erc20.symbol([ overrides ]) => Promise<string>
+Returns the symbol of the token.
+
+_property: erc20_rw.transfer(target, amount [, overrides ]) => Promise<[[provider-transactionresponse]]>
+Transfers //amount// tokens to //target// from the current signer.
+The return value (a boolean) is inaccessible during a write operation
+using a transaction. Other techniques (such as events) are required
+if this value is required. On-chain contracts calling the ``transfer``
+function have access to this result, which is why it is possible.
+
+_property: erc20.callStatic.transfer(target, amount [, overrides ]) => Promise<boolean>
+Performs a dry-run of transferring //amount// tokens to //target// from
+the current signer, without actually signing or sending a transaction.
+
+This can be used to preflight check that a transaction will be successful.
+
+_property: erc20.estimate.transfer(target, amount [, overrides ]) => Promise<[[bignumber]]>
+Returns an estimate for how many units of gas would be required
+to transfer //amount// tokens to //target//.
+
+_property: erc20.populateTransaction.transfer(target, amount [, overrides ]) => Promise<[UnsignedTx](types-unsignedtransaction)>
+Returns an [[types-unsignedtransaction]] which could be signed and submitted
+to the network to transaction //amount// tokens to //target//.
+
+
+_note: Note on Estimating and Static Calling
+
+When you perform a static call, the current state is taken into account as
+best as Ethereum can determine. There are many cases where this can provide
+false positives and false negatives. The eventually consistent model of the
+blockchain also means there are certain consistency modes that cannot be
+known until an actual transaction is attempted.
+
+
+_subsection: Meta-Class Filters ^^//(added at Runtime)//^^
+
+Since the Contract is a Meta-Class, the methods available here depend
+on the ABI which was passed into the **Contract**.
+
+_property: erc20.filters.Transafer([ fromAddress [ , toAddress ] ]) => Filter
+Returns a new Filter which can be used to [query](erc20-queryfilter) or
+to [subscribe/unsubscribe to events](erc20-events).
+
+If //fromAddress// is null or not provided, then any from address matches.
+If //toAddress// is null or not provided, then any to address matches.

docs.wrm/api/contract/index.wrm

@@ -0,0 +1,8 @@
+_section: Contract Interaction @<contracts>
+
+Explain what contracts are...
+
+
+_toc:
+    contract
+    example

docs.wrm/api/contract/token.txt

@@ -0,0 +1,35 @@
+// A Human-Readable ABI; any supported ABI format could be used
+const abi = [
+    // Read-Only Functions
+    "function balanceOf(address owner) view returns (uint256)",
+    "function decimals() view returns (uint8)",
+    "function symbol() view returns (string)",
+
+    // Authenticated Functions
+    "function transfer(address to, uint amount) returns (boolean)",
+
+    // Events
+    "event Transfer(address indexed from, address indexed to, uint amount)"
+];
+
+// This can be an address or an ENS name
+const address = "demotoken.ethers.eth";
+
+// An example Provider (connceted to testnet)
+const provider = ethers.getDefaultProvider("ropsten");
+
+// An example Signer
+const signer = ethers.Wallet.createRandom(provider);
+
+// Read-Only; By connecting to a Provider, allows:
+// - Any constant function
+// - Querying Filters
+// - Populating Unsigned Transactions for non-constant methods
+// - Estimating Gas for non-constant (as an anonymous sender)
+// - Static Calling non-constant methods (as anonymous sender)
+const erc20 = new ethers.Contract(address, abi, provider);
+
+// Read-Write; By connecting to a Signer, allows:
+// - Everything from Read-Only (except as Signer, not anonymous)
+// - Sending transactions for non-constant functions
+const erc20_rw = new ethers.Contract(address, abi, signer)

docs.wrm/api/index.wrm

@@ -1,6 +1,4 @@
-_title: Application Programming Interface
-
-_section: Application Programming Interface (API)
+_section: Application Programming Interface @NAV<API>
 
 Here...
 
@@ -9,3 +7,4 @@ _toc:
     signer
     providers
     utils
+    other

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

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

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

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

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

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

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

@@ -0,0 +1,6 @@
+_section: Assembly
+
+_toc:
+    dialect
+    api
+    ast

docs.wrm/api/other/hardware/index.wrm

@@ -0,0 +1,15 @@
+_section: Hardware Wallets
+
+_subsection: LedgerSigner @<hw-ledger> @INHERIT<[[signer]]> @SRC<hardware-wallets:class.LedgerSigner>
+
+The [Ledger Hardware Wallets](link-ledger) are a fairly
+popular brand.
+
+TODO: importing
+
+_heading: API
+
+_property: new LedgerSigner([provider [, type [ , path ] ] ]) => [[hw-ledger]]
+Connects to a Ledger Hardware Wallet. The //type// if left unspecified is
+determined by the environment; in node the default is "hid" and in the browser
+"u2f" is the default. The default Ethereum path is used if //path// is left unspecified.

docs.wrm/api/other/index.wrm

@@ -0,0 +1,9 @@
+_section: Other Libraries
+
+Now that ethers is more modular, it is possible to have additional
+ancillary packages, which are not part of the core but optionally
+add functionality only needed in certain situations.
+
+_toc:
+    assembly
+    hardware

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

@@ -1,5 +1,3 @@
-_title: API Providers
-
 _section: API Providers
 
 There are many services which offer a web API for accessing
@@ -13,42 +11,55 @@ To mitigate these issues, it is recommended you use a
 [Default Provider](get-default-provider).
 
 
-_subsection: EtherscanProvider
+_subsection: EtherscanProvider @INHERIT<[[provider]]>
 
 The **EtherscanProvider** is backed by a combination of the various
-[Etherscan APIs](https://etherscan.io/apis).
+[Etherscan APIs](link-etherscan-api).
 
 _property: provider.getHistory(address) => Array<History>
 
+@TODO... Explain
 
-_subsection: InfuraProvider
+_definition: **Supported Networks**
 
-The **InfuraProvider** is backed by the popular [INFURA](https://infura.io)
+- Homestead (Mainnet)
+- Ropsten (proof-of-work testnet)
+- Rinkeby (proof-of-authority testnet)
+- G&ouml;rli (clique testnet)
+- Kovan (proof-of-authority testnet)
+
+
+_subsection: InfuraProvider @INHERIT<[[provider-urljsonrpc]]>
+
+The **InfuraProvider** is backed by the popular [INFURA](link-infura)
 Ethereum service.
 
-It supports Mainnet (homestead) and all common testnets (Ropsten, Rinkeby,
-G&ouml;rli and Kovan).
+_definition: **Supported Networks**
+
+- Homestead (Mainnet)
+- Ropsten (proof-of-work testnet)
+- Rinkeby (proof-of-authority testnet)
+- G&ouml;rli (clique testnet)
+- Kovan (proof-of-authority testnet)
 
 
-_subsection: NodesmithProvider
+_subsection: AlchemyProvider @INHERIT<[[provider-urljsonrpc]]>
 
-The **NodesmithProvider** is backed by [Nodesmith](https://nodesmith.io).
+The **AlchemtProvider** is backed by [Alchemy](link-alchemy).
 
-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).
+_definition: **Supported Networks**
+
+- Homestead (Mainnet)
+- Ropsten (proof-of-work testnet)
+- Rinkeby (proof-of-authority testnet)
+- G&ouml;rli (clique testnet)
+- Kovan (proof-of-authority testnet)
 
 
-_subsection: AlchemyProvider
+_subsection: CloudfrontProvider @INHERIT<[[provider-urljsonrpc]]>
 
-The **AlchemtProvider** is backed by [Alchemy](https://alchemyapi.io).
+The CloudfrontProvider is backed by the [Cloudflare Ethereum Gateway](link-cloudflare).
 
-It supports Mainnet (homestead) and all common testnets (Ropsten, Rinkeby,
-G&ouml;rli and Kovan).
+_definition: **Supported Networks**
 
-
-_subsection: CloudfrontProvider
-
-The CloudfrontProvider is backed by the
-[Cloudflare Ethereum Gateway](https://developers.cloudflare.com/distributed-web/ethereum-gateway/).
-
-It only supports Mainnet (homestead).
+- Homestead (Mainnet)

docs.wrm/api/providers/index.wrm

@@ -1,5 +1,3 @@
-_title: Providers
-
 _section: Providers
 
 A **Provider** is an abstraction of a connection to the

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

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

docs.wrm/api/providers/other.wrm

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

docs.wrm/api/providers/provider.wrm

@@ -1,6 +1,3 @@
-_title: Abstract Provider
-
-
 _section: Provider @<provider>
 
 Explain what a provider is...
@@ -8,17 +5,17 @@ Explain what a provider is...
 
 _subsection: Accounts Methods
 
-_property: provider.getBalance(address [ , blockTag = "latest" ]) => Promise<[[bignumber]]>
+_property: provider.getBalance(address [ , blockTag = "latest" ]) => Promise<[[bignumber]]>  @<provider-getbalance> @SRC<providers/base-provider>
 Returns the balance of //address// as of the //blockTag// block height.
 
-_property: provider.getCode(address [ , blockTag = "latest" ]) => Promise<[[hexstring]]>
+_property: provider.getCode(address [ , blockTag = "latest" ]) => Promise<string<[[datahexstring]]>>  @<providers-getcode> @SRC<providers/base-provider>
 Returns the contract code of //address// as of the //blockTag// block height. If there is
 no contract currently deployed, the result is ``0x``.
 
-_property: provider.getStorageAt(address, position [ , blockTag = "latest" ]) => Promise<[[hexstring]]>
-Returns the ``Bytes32`` value of the //position// at //address//, as of the //blockTag//.
+_property: provider.getStorageAt(addr, pos [ , blockTag = "latest" ]) => Promise<string<[[datahexstring]]>>  @<providers-getstorageat> @SRC<providers/base-provider>
+Returns the ``Bytes32`` value of the position //pos// at address //addr//, as of the //blockTag//.
 
-_property: provider.getTransactionCount(address [ , blockTag = "latest" ]) => Promise<number>
+_property: provider.getTransactionCount(address [ , blockTag = "latest" ]) => Promise<number>  @<providers-gettransactioncount> @SRC<providers/base-provider>
 Returns the number of transactions //address// has ever **sent**, as of //blockTag//.
 This value is required to be the nonce for the next transaction from //address//
 sent to the network.
@@ -30,11 +27,11 @@ _code: example-account.js
 
 _subsection: Blocks Methods
 
-_property: provider.getBlock(block) => Promise<[[provider-block]]>
+_property: provider.getBlock(block) => Promise<[[provider-block]]>  @<providers-getblock> @SRC<providers/base-provider>
 Get the //block// from the network, where the ``result.transactions`` is a list
 of transaction hashes.
 
-_property: provider.getBlockWithTransactions(block) => Promise<[[provider-blocktxs]]>
+_property: provider.getBlockWithTransactions(block) => Promise<[[provider-blocktxs]]>  @<providers-getblockwithtransactions> @SRC<providers/base-provider>
 Get the //block// from the network, where the ``result.transactions`` is
 an Array of [[provider-transactionresponse]] objects.
 
@@ -43,12 +40,12 @@ _subsection: Ethereum Naming Service (ENS) Methods
 
 TODO: Explain ENS here...
 
-_property: provider.lookupAddress(address) => Promise<string>
+_property: provider.lookupAddress(address) => Promise<string>  @<providers-lookupaddress> @SRC<providers/base-provider>
 Performs a reverse lookup of the //address// in ENS using the
 //Reverse Registrar//.  If the name does not exist, or the
 forward lookup does not match, ``null`` is returned.
 
-_property: provider.resovleName(name) => Promise<string>
+_property: provider.resolveName(name) => Promise<string<[Address](address)>>  @<providers-resolvename> @SRC<providers/base-provider>
 Looks up the address of //name//. If the name is not owned, or
 does not have a //Resolver// configured, or the //Resolver// does
 not have an address configured, ``null`` is returned.
@@ -59,7 +56,7 @@ _code: example-ens.js
 
 _subsection: Logs Methods
 
-_property: provider.getLogs(filter) => Promise<Array<[[provider-log]]>>
+_property: provider.getLogs(filter) => Promise<Array<[[provider-log]]>>  @<providers-getlogs> @SRC<providers/base-provider>
 Returns the Array of [[provider-log]] matching the //filter//.
 
 Keep in mind that many backends will discard old events, and that requests
@@ -69,24 +66,24 @@ execute the query.
 
 _subsection: Network Status Methods
 
-_property: provider.getNetwork() => Promise<[[provider-network]]>
+_property: provider.getNetwork() => Promise<[[provider-network]]>  @<providers-getnetwork> @SRC<providers/base-provider:method.BaseProvider.getNetwork>
 Returns the [[provider-network]] this Provider is connected to.
 
-_property: provider.getBlockNumber() => Promise<number>
+_property: provider.getBlockNumber() => Promise<number>  @<providers-getblocknumber> @SRC<providers/base-provider>
 Returns the block number (or height) of the most recently mined block.
 
-_property: provider.getGasPrice() => Promise<[[bignumber]]>
+_property: provider.getGasPrice() => Promise<[[bignumber]]>  @<providers-getgasprice> @SRC<providers/base-provider>
 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 
+_property: provider.call(transaction [ , blockTag = "latest" ]) => Promise<string<[[hexstring]]>>  @<providers-call> @SRC<providers/base-provider>
+Returns the result of executing the //transaction//, using //call//. A call
 does not require any ether, but cannot change any state. This is useful
 for calling gettings on Contracts.
 
-_property: provider.estimateGas(transaction) => Promise<[[bignumber]]>
+_property: provider.estimateGas(transaction) => Promise<[[bignumber]]>  @<providers-estimategas> @SRC<providers/base-provider>
 Returns an estimate of the amount of gas that would be required to submit //transaction//
 to the network.
 
@@ -94,12 +91,12 @@ 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]]>
+_property: provider.sendTransaction(transaction) => Promise<[[provider-transactionresponse]]>  @<providers-sendtransaction> @SRC<providers/base-provider>
 Submits //transaction// to the network to be mined. The //transaction// **must** be signed,
 and be valid (i.e. the nonce is correct and the account has sufficient balance to pay
 for the transaction).
 
-_property: provider.waitForTransaction(transactionHash) => Promise<[[provider-transactionreceipt]]>
+_property: provider.waitForTransaction(transactionHash) => Promise<[[provider-receipt]]>  @<providers-waitfortransaction> @SRC<providers/base-provider>
 Returns a Promise which will not resolve until //transactionHash// is mined.
 
 
@@ -107,35 +104,35 @@ _subsection: Event Emitter Methods
 
 Explain events here...
 
-_property: provider.on(eventName, listener) => this
+_property: provider.on(eventName, listener) => this  @<providers-on> @SRC<providers/base-provider>
 Add a //listener// to be triggered for each //eventName//.
 
-_property: provider.once(eventName, listener) => this
+_property: provider.once(eventName, listener) => this  @<providers-once> @SRC<providers/base-provider>
 Add a //listener// to be triggered for only the next //eventName//,
 at which time it be removed.
 
-_property: provider.emit(eventName, ...args) => boolean
+_property: provider.emit(eventName, ...args) => boolean  @<providers-emit> @SRC<providers/base-provider>
 Notify all listeners of //eventName//, passing //args// to each listener. This
 is generally only used internally.
 
-_property: provider.off(eventName [ , listener ]) => this
+_property: provider.off(eventName [ , listener ]) => this  @<providers-off> @SRC<providers/base-provider>
 Remove a //listener// for //eventName//. If no //listener// is provided,
 all listeners for //eventName// are removed.
 
-_property: provider.removeAllListeners([ eventName ]) => this
+_property: provider.removeAllListeners([ eventName ]) => this  @<providers-removealllisteners> @SRC<providers/base-provider>
 Remove all the listeners for //eventName//. If no //eventName// is provided,
 **all** events are removed.
 
-_property: provider.listenerCount([ eventName ]) => number
+_property: provider.listenerCount([ eventName ]) => number  @<providers-listenercount> @SRC<providers/base-provider>
 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>
+_property: provider.listeners(eventName) => Array<Listener>  @<providers-listeners> @SRC<providers/base-provider>
 Returns the list of Listeners for //eventName//.
 
 
 _subsection: Inspection Methods
 
-_property: Provider.isProvider(object) => boolean
+_property: Provider.isProvider(object) => boolean  @<providers-isprovider> @SRC<abstract-provider>
 Returns true if and only if //object// is a Provider.
 

docs.wrm/api/providers/types.wrm

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

docs.wrm/api/signer.wrm

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

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

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

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

@@ -0,0 +1,5 @@
+_section: Application Binary Interface @NAV<ABI>
+
+_toc:
+  interface
+  fragments

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

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

docs.wrm/api/utils/address.wrm

@@ -1,21 +1,66 @@
-_title: Addresses
-
-_section: Addresses
+_section: Addresses @<addresses>
 
 Explain addresses,formats and checksumming here.
 
-Also see: [Constants.AddressZero](constants)
+Also see: [constants.AddressZero](constants)
 
-_heading: Functions
+_subsection: Address Formats  @<address-formats>
 
-_property: utils.getAddress(address) => string
-TODO
 
-_property: utils.isAddress(address) => boolean
-TODO
+_heading: Address  @<address>
 
-_property: utils.getIcapAddress(address) => string
-TODO
+An **Address** is a [[datahexstring]] of 20 bytes (40 nibbles), with optional
+mixed case.
 
-_property: utils.getContractAddress(transaction) => string
-TODO
+If the case is mixed, it is a **Checksum Address**, which uses a specific pattern
+of uppercase and lowercase letters within a given address to reduce the risk
+of errors introduced from typing an address or cut and paste issues.
+
+All functions that return an Address will return a Checksum Address.
+
+
+_heading: ICAP Address  @<address-icap>
+
+The **ICAP Address Format** was an early attempt to introduce a checksum
+into Ethereum addresses using the popular banking industry's
+[IBAN](link-wiki-iban)
+format with the country code specified as **XE**.
+
+Due to the way IBAN encodes address, only addresses that fit into 30 base-36
+characters are actually compatible, so the format was adapted to support 31
+base-36 characters which is large enough for a full Ethereum address, however
+the preferred method was to select a private key whose address has a ``0`` as
+the first byte, which allows the address to be formatted as a fully compatibly
+standard IBAN address with 30 base-36 characters.
+
+In general this format is no longer widely supported anymore, however any function that
+accepts an address can receive an ICAP address, and it will be converted internally.
+
+To convert an address into the ICAP format, see [getIcapAddress](utils-getIcapAddress).
+
+
+_subsection: Functions
+
+_property: ethers.utils.getAddress(address) => string<[[address]]>  @<utils-getAddress> @SRC<address>
+Returns //address// as a Checksum Address.
+
+If //address// is an invalid 40-nibble [[hexstring]] or if it contains mixed case and
+the checksum is invalid, an InvalidArgument Error is throw.
+
+The value of //address// may be any supported address format.
+
+
+_property: ethers.utils.isAddress(address) => boolean  @<utils-isAddress> @SRC<address>
+Returns true if //address// is valid (in any supported format).
+
+_property: ethers.utils.getIcapAddress(address) => string<[IcapAddress](address-icap)>  @<utils-getIcapAddress> @SRC<address>
+Returns //address// as an [ICAP address](link-icap).
+Supports the same restrictions as [utils.getAddress](utils-getAddress).
+
+_property: ethers.utils.getContractAddress(transaction) => string<[[address]]>  @<utils-getcontractaddress> @SRC<address>
+Returns the contract address that would result if //transaction// was
+used to deploy a contract.
+
+_property: ethers.utils.getCreate2Address(from, salt, initCodeHash) => string<[[address]]> @<utils-getCreate2Address> @SRC<address>
+Returns the contract address that would result from the given
+[CREATE2](link-eip-1014) call.

docs.wrm/api/utils/bignumber.wrm

@@ -1,9 +1,15 @@
-_title: Big Number
-
-
 _section: BigNumber @<bignumber>
 
-Explain about BigNumber here...
+Many operations in Ethereum operation on numbers which are
+[outside the range of safe values](notes-safenumbers) to use
+in JavaScript.
+
+A **BigNumber** is an object which safely allows mathematic operations
+on numbers of any magnitude.
+
+Most operations which need to return a value will return a **BigNumber**
+and parameters which accept values will generally accept them.
+
 
 _heading: Importing
 
@@ -25,13 +31,13 @@ _definition: **//BytesLike//**
 A [BytesLike](byteslike) Object, such as an Array or Uint8Array.
 
 _definition: **//BigNumber//**
-An existing BigNumber instance.
+An existing [[bignumber]] instance.
 
 _definition: **//number//**
-A number that is within the safe range for JavaScript numbers.
+A number that is within the [safe range](link-js-maxsafe) for JavaScript numbers.
 
 _definition: **//BigInt//**
-A JavaScript [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt)
+A JavaScript [BigInt](link-js-bigint)
 object, on environments that support BigInt.
 
 
@@ -39,10 +45,10 @@ _subsection: Creating Instances
 
 The constructor of BigNumber cannot be called directly. Instead, Use the static ``BigNumber.from``.
 
-_property: BigNumber.from(aBigNumberish) => [[bignumber]]
+_property: ethers.BigNumber.from(aBigNumberish) => [[bignumber]]
 Returns an instance of a **BigNumber** for //aBigNumberish//.
 
-_heading: Examples:
+_heading: Examples:  @<>
 
 _code: bignumber-create.js
 
@@ -55,86 +61,86 @@ it represents.
 
 _heading: Math Operations
 
-_property: bignumber.add(otherValue) => [[bignumber]]
+_property: bignumber.add(otherValue) => [[bignumber]]  @SRC<bignumber>
 Returns a BigNumber with the value of //bignumber// **+** //otherValue//.
 
-_property: bignumber.sub(otherValue) => [[bignumber]]
+_property: bignumber.sub(otherValue) => [[bignumber]]  @SRC<bignumber>
 Returns a BigNumber with the value of //bignumber// **&ndash;** //otherValue//.
 
-_property: bignumber.mul(otherValue) => [[bignumber]]
+_property: bignumber.mul(otherValue) => [[bignumber]]  @SRC<bignumber>
 Returns a BigNumber with the value of //bignumber// **&times;** //otherValue//.
 
-_property: bignumber.div(divisor) => [[bignumber]]
+_property: bignumber.div(divisor) => [[bignumber]]  @SRC<bignumber>
 Returns a BigNumber with the value of //bignumber// **&#247;** //divisor//.
 
-_property: bignumber.mod(divisor) => [[bignumber]]
+_property: bignumber.mod(divisor) => [[bignumber]]  @SRC<bignumber>
 Returns a BigNumber with the value of the **remainder** of //bignumber// &#247; //divisor//.
 
-_property: bignumber.pow(exponent) => [[bignumber]]
+_property: bignumber.pow(exponent) => [[bignumber]]  @SRC<bignumber>
 Returns a BigNumber with the value of //bignumber// to the power of //exponent//.
 
-_property: bignumber.abs() => [[bignumber]]
+_property: bignumber.abs() => [[bignumber]]  @SRC<bignumber>
 Returns a BigNumber with the absolute value of //bignumber//.
 
-_property: bignumber.maskn(bitcount) => [[bignumber]]
+_property: bignumber.maskn(bitcount) => [[bignumber]]  @SRC<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)
+[Two's Complicment](link-wiki-twoscomplement)
 is an elegant method used to encode and decode fixed-width signed values
 while efficiently preserving mathematic operations.
 Most users will not need to interact with these.
 
-_property: bignumber.fromTwos(bitwidth) => [[bignumber]]
+_property: bignumber.fromTwos(bitwidth) => [[bignumber]]  @SRC<bignumber>
 Returns a BigNumber with the value of //bignumber// converted from twos-compliment with //bitwidth//.
 
-_property: bignumber.toTwos(bitwidth) => [[bignumber]]
+_property: bignumber.toTwos(bitwidth) => [[bignumber]]  @SRC<bignumber>
 Returns a BigNumber with the value of //bignumber// converted to twos-compliment with //bitwidth//.
 
 
 _heading: Comparison and Equivalence
 
-_property: bignumber.eq(otherValue) => boolean
+_property: bignumber.eq(otherValue) => boolean  @SRC<bignumber>
 Returns true if and only if the value of //bignumber// is equal to //otherValue//.
 
-_property: bignumber.lt(otherValue) => boolean
+_property: bignumber.lt(otherValue) => boolean  @SRC<bignumber>
 Returns true if and only if the value of //bignumber// **<** //otherValue//.
 
-_property: bignumber.lte(otherValue) => boolean
+_property: bignumber.lte(otherValue) => boolean  @SRC<bignumber>
 Returns true if and only if the value of //bignumber// **&le;** //otherValue//.
 
-_property: bignumber.gt(otherValue) => boolean
+_property: bignumber.gt(otherValue) => boolean  @SRC<bignumber>
 Returns true if and only if the value of //bignumber// **>** //otherValue//.
 
-_property: bignumber.gte(otherValue) => boolean
+_property: bignumber.gte(otherValue) => boolean  @SRC<bignumber>
 Returns true if and only if the value of //bignumber// **&ge;** //otherValue//.
 
-_property: bignumber.isZero() => boolean
+_property: bignumber.isZero() => boolean  @SRC<bignumber>
 Returns true if and only if the value of //bignumber// is zero.
 
 
 _heading: Conversion
 
-_property: bignumber.toNumber() => number
+_property: bignumber.toNumber() => number  @SRC<bignumber>
 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
+_property: bignumber.toString() => string  @SRC<bignumber:BigNumber.toString>
 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).
+_property: bignumber.toHexString() => string<[[datahexstring]]>  @SRC<bignumber:BigNumber.toHexString>
+Returns the value of //bignumber// as a base-16, ``0x``-prefixed [[datahexstring]].
 
 
 _heading: Inspection
 
-_property: BigNumnber.isBigNumber(object) => boolean
+_property: ethers.BigNumnber.isBigNumber(object) => boolean  @SRC<bignumber>
 Returns true if and only if the //object// is a BigNumber object.
 
 
@@ -142,11 +148,13 @@ _heading: Examples
 
 _code: bignumber-examples.js
 
+
 _subsection: Notes
 
-A few short notes on numbers...
+This section is a for a couple of questions that come up frequently.
 
-_heading: Why can't I just use numbers?
+
+_heading: Why can't I just use numbers? @<notes-safenumbers>
 
 The first problem many encounter when dealing with Ethereum is
 the concept of numbers. Most common currencies are broken down
@@ -154,7 +162,7 @@ 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)
+JavaScript uses [IEEE 754 double-precision binary floating point](link-wiki-ieee754)
 numbers to represent numeric values. As a result, there are //holes//
 in the integer set after 9,007,199,254,740,991; which is
 problematic for //Ethereum// because that is only around 0.009
@@ -173,3 +181,61 @@ The functions [parseEther( etherString )](http://linkto) and
 between string representations, which are displayed to or entered
 by the user and Big Number representations which can have
 mathematical operations handled safely.
+
+
+_heading: Why not BigNumber.js, BN.js, BigDecimal, etc?
+
+Everyone has their own favourite Big Number library, and once someone
+has choosen one, it becomes part of their identity, like their editor,
+vi vs emacs. There are over 100 Big Number libraries on [npm](link-npm-query-bignumber).
+
+One of the biggest differences between the Ethers [[bignumber]] object and
+other libraries is that it is immutable, which is very important when
+dealing with the asynchronous nature of the blockchain.
+
+Capturing the value is not safe in async functions, so immutability
+protects us from easy to make mistakes, which is not possible on the
+low-level library's objects which supports myriad in-place operations.
+
+Second, the Ethers [[bignumber]] provides all the functionality required
+internally and should generally be sufficient for most developers while
+not exposing some of the more advanced and rare functionality. So it will
+be eaiser to swap out the underlying library without impacting consumers.
+
+For example, if [[link-npm-bnjs]] was exposed, someone may use the
+greatest-common-denominator functions, which would then be functionality
+the replacing library should also provide to ensure anyone depending on
+that functionality is not broken.
+
+
+_heading: Why BN.js??
+
+The reason why [[link-npm-bnjs]] is used internally as the big
+number is because that is the library used by [[link-npm-elliptic]].
+
+Therefore it **must** be included regardless, so we leverage that
+library rather than adding another Big Number library, which would
+mean two different libraries offering the same functionality.
+
+This has saved about 85kb (80% of this library size) of library size
+over other libraries which include separate Big Number libraries for
+various purposes.
+
+
+_heading: Why not allow us to set a global Big Number library?
+
+Another comment that comes up frequently is tha desire to specify a
+global user-defined Big Number library, which all functions would
+return.
+
+This becomes problematic since your code may live along side other
+libraries or code that use Ethers. In fact, even Ethers uses a lot
+of the public functions internally.
+
+If you, for example, used a library that used ``a.plus(b)`` instead
+of ``a.add(b)``, this would break Ethers when it tries to compute
+fees internally, and other libraries likely have similar logic.
+
+But, the [[bignumber]] prototype is exposed, so you can always add a
+``toMyCustomBigNumber()`` method to all [[bignumber]]'s globally
+which is safe.

docs.wrm/api/utils/bytes.wrm

@@ -1,5 +1,3 @@
-_title: Byte Manipulation
-
 _section: Byte Manipulation
 
 Tra la la...
@@ -8,64 +6,76 @@ _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
+A **Bytes** is any object which is an
+[Array](link-js-array) or [TypedArray](link-js-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]].
+A **BytesLike** can be either a [[bytes]] or a [[datahexstring]].
+
+_heading: DataHexstring @<datahexstring>
+
+A **DataHexstring** is identical to a [[hexstring]] except that it has
+an even number of nibbles, and therefore is a valid representation of
+binary data as a string.
 
 _heading: Hexstring @<hexstring>
 
-A **hexstring** is a string which has a ``0x`` prefix followed by 
+A **Hexstring** is a string which has a ``0x`` prefix followed by any
+number of nibbles (i.e. case-insensitive hexidecumal characters, ``0-9`` and ``a-f``).
 
 _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**
+- **_vs** --- The [compact representation](link-eip-2098) of the **s** and **v**
 - **recoveryParam** --- The normalized (i.e. 0 or 1) value of **v**
 
+_heading: Flat-Format Signature @<signature-flat>
+
+A **Flat-Format Signature** is a common Signature format where
+the r, s and v are concanenated into a 65 byte (130 nibble)
+[[datahexstring]].
+
+
 _heading: SignatureLike @<signaturelike>
 
 A **SignatureLike** is similar to a [[signature]], except redundant properties
-may be omitted.
+may be omitted or it may be a [[signature-flat]].
 
-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).
+For example, if **_vs** is specified, **s** and **v** may be omitted. Likewise,
+if **recoveryParam** is provided, **v** may be omitted (as in these cases the
+missing values can be computed).
 
 
 _subsection: Inspection
 
-_property: utils.isBytes(object) => boolean
+_property: ethers.utils.isBytes(object) => boolean  @<utils-isbytes> @SRC<bytes>
 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: ethers.utils.isBytesLike(object) => boolean  @<utils-isbyteslike> @SRC<bytes>
+Returns true if and only if //object// is a [[bytes]] or [[datahexstring]].
 
-_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.
+_property: ethers.utils.isHexString(object, [ length ] ) => boolean  @<utils-ishexstring> @SRC<bytes>
+Returns true if and only if //object// is a valid hex string.
+If //length// is specified and //object// is not a valid [[datahexstring]] of
+//length// bytes, an InvalidArgument error is thrown.
 
 
 _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: ethers.utils.arrayify(datahexstringOrArrayish [ , options ]) => Uint8Array  @<utils-arrayify> @SRC<bytes>
+Converts //datahexstringOrArrayish// to a Uint8Array.
 
-_property: utils.hexlify(hexstringOrArrayish) => string
-Converts //hexstringOrArrayish// to a [[hexstring]]. The result
-will always be zero-padded to even length.
+_property: ethers.utils.hexlify(hexstringOrArrayish) => string<[[datahexstring]]>  @<utils-hexlify> @SRC<bytes>
+Converts //hexstringOrArrayish// to a [[datahexstring]].
 
-_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.
+_property: ethers.utils.hexValue(aBigNumberish) => string<[[hexstring]]>  @<utils-hexvalue> @SRC<bytes>
+Converts //aBigNumberish// to a [[hexstring]], with no __unnecessary__ leading
+zeros.
 
 _heading: Examples
 
@@ -74,48 +84,58 @@ _code: bytes-conversion.js
 
 _subsection: Array Manipulation
 
-_property: utils.concat(arrayOfBytesLike) => Uint8Array
-Concatenates all the [[byteslike]] in //arrayOfBytesLike//
-into a single Uint8Array.
+_property: ethers.utils.concat(arrayOfBytesLike) => Uint8Array  @<utils-concat> @SRC<bytes>
+Concatenates all the [[byteslike]] in //arrayOfBytesLike// into a single Uint8Array.
 
-_property: utils.stripZeros(aBytesLike) => Uint8Array
-Concatenates all the [[byteslike]] in //arrayOfBytesLike//
+_property: ethers.utils.stripZeros(aBytesLike) => Uint8Array  @<utils-stripzeros> @SRC<bytes>
+Returns a Uint8Array with all leading ``0`` bytes of //aBtyesLike// removed.
 
-_property: utils.zeroPad(aBytesLike, length) => Uint8Array
-Concatenates all the [[byteslike]] in //arrayOfBytesLike//
+_property: ethers.utils.zeroPad(aBytesLike, length) => Uint8Array  @<utils-zeropad> @SRC<bytes>
+Retutns a Uint8Array of the data in //aBytesLike// with ``0`` bytes prepended to
+//length// bytes long.
+
+If //aBytesLike// is already longer than //length// bytes long, an InvalidArgument
+error will be thrown.
 
 
 _subsection: Hexstring Manipulation
 
-_property: utils.hexConcat(arrayOfBytesLike) => string
-Concatenates all the [[byteslike]] in //arrayOfBytesLike//
-into a single [[hexstring]]
+_property: ethers.utils.hexConcat(arrayOfBytesLike) => string<[[datahexstring]]>  @<utils-hexconcat> @SRC<bytes>
+Concatenates all the [[byteslike]] in //arrayOfBytesLike// into a single [[datahexstring]]
 
-_property: utils.hexDataLength(aBytesLike) => number
+_property: ethers.utils.hexDataLength(aBytesLike) => string<[[datahexstring]]>  @<utils-hexdatalength> @SRC<bytes>
 Returns the length (in bytes) of //aBytesLike//.
 
-This will **throw and error** if //aBytesLike// is a [[hexstring]]
-but is of odd-length.
+_property: ethers.utils.hexDataSlice(aBytesLike, offset [ , endOffset ] ) => string<[[datahexstring]]>  @<utils-hexdataslice> @SRC<bytes>
+Returns a [[datahexstring]] representation of a slice of //aBytesLike//, from
+//offset// (in bytes) to //endOffset// (in bytes). If //endOffset// is
+omitted, the length of //aBytesLike// is used.
 
-_property: utils.hexDataSlice(aBytesLike, offset [ , endOffset ] ) => string
-Returns the length (in bytes) of //aBytesLike//.
+_property: ethers.utils.hexStripZeros(aBytesLike) => string<[[hexstring]]>  @<utils-hexstripzeros> @SRC<bytes>
+Returns a [[hexstring]] representation of //aBytesLike// with all
+leading zeros removed.
 
-_property: utils.hexStripZeros(aBytesLike) => string
-@TODO
+_property: ethers.utils.hexZeroPad(aBytesLike, length) => string<[[datahexstring]]>  @<utils-hexzeropad> @SRC<bytes>
+Returns a [[datahexstring]] representation of //aBytesLike// padded to //length// bytes.
 
-_property: utils.hexZeroPad(aBytesLike, length) => string
-@TODO
+If //aBytesLike// is already longer than //length// bytes long, an InvalidArgument
+error will be thrown.
 
 
 _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: ethers.utils.joinSignature(aSignatureLike) => string<[FlatSignature](signature-flat)>  @<utils-joinsignature> @SRC<bytes>
+Return the flat-format of //aSignaturelike//, which is 65 bytes (130 nibbles)
+long, concatenating the **r**, **s** and (normalized) **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.
+_property: ethers.utils.splitSignature(aSignatureLikeOrBytesLike) => [[signature]]  @<utils-splitsignature> @SRC<bytes>
+Return the full expanded-format of //aSignaturelike// or a flat-format [[datahexstring]].
+Any missing properties will be computed.
 
+_subsection: Random Bytes
+
+_property: ethers.utils.randomBytes(length) => Uint8Array  @<utils-randombytes> @SRC<random/index>
+Return a new Uint8Array of //length// random bytes.
+
+_property: ethers.utils.shuffled(array) => Array<any>  @<utils.shuffled> @SRC<random>
+Return a copy of //array// shuffled using [[link-wiki-shuffle]].

docs.wrm/api/utils/constants.wrm

@@ -1,5 +1,3 @@
-_title: Constants
-
 _section: Constants @<constants>
 
 The **ethers.contants** Object contains commonly used values.
@@ -11,38 +9,38 @@ _code: constants-import.js
 
 _subsection: Bytes
 
-_property: constants.AddressZero
+_property: ethers.constants.AddressZero => string<[Address](address)>  @<constants-addresszero> @SRC<constants>
 The Address Zero, which is 20 bytes (40 nibbles) of zero.
 
-_property: constants.HashZero
+_property: ethers.constants.HashZero => string<[[datahexstring]]<32>>  @<constants-hashzero> @SRC<constants>
 The Hash Zero, which is 32 bytes (64 nibbles) of zero.
 
 
 _subsection: Strings
 
-_property: constants.EtherSymbol
+_property: ethers.constants.EtherSymbol => string  @<constants-ethersymbol> @SRC<constants>
 The Ether symbol, **&Xi;**.
 
 
 _subsection: BigNumber
 
-_property: constants.NegativeOne
+_property: ethers.constants.NegativeOne => [[bignumber]]  @<constants-negativeone> @SRC<constants>
 The BigNumber value representing ``"-1"``.
 
-_property: constants.Zero
+_property: ethers.constants.Zero => [[bignumber]]  @<constants-zero> @SRC<constants>
 The BigNumber value representing ``"0"``.
 
-_property: constants.One
+_property: ethers.constants.One => [[bignumber]]  @<constants-one> @SRC<constants>
 The BigNumber value representing ``"1"``.
 
-_property: constants.Two
+_property: ethers.constants.Two => [[bignumber]]  @<constants-two> @SRC<constants>
 The BigNumber value representing ``"2"``.
 
-_property: constants.WeiPerEther
+_property: ethers.constants.WeiPerEther => [[bignumber]]  @<constants-weiperether> @SRC<constants>
 The BigNumber value representing ``"1000000000000000000"``, which is the
 number of Wei per Ether.
 
-_property: constants.MaxUint256
+_property: ethers.constants.MaxUint256 => [[bignumber]]  @<constants-maxuint256> @SRC<constants>
 The BigNumber value representing the maximum ``uint256`` value.
 
 

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

@@ -1,5 +1,3 @@
-_title: Display Logic and Input
-
 _section: Display Logic and Input
 
 When creating an Application, it is useful to convert between
@@ -46,23 +44,23 @@ _subsection: Functions
 
 _heading: Formatting
 
-_property: utils.commify(value) => string
+_property: ethers.utils.commify(value) => string  @<utils-commify> @SRC<units>
 Returns a string with value grouped by 3 digits, separated by ``,``.
 
 
 _heading: Conversion @<unit-conversion>
 
-_property: utils.formatUnits(value [ , unit = "ether" ] ) => string
+_property: ethers.utils.formatUnits(value [ , unit = "ether" ] ) => string  @<utils-formatunits> @SRC<units>
 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
+_property: ethers.utils.formatEther(value) => string  @<utils-formatether> @SRC<units>
 The equivalent to calling ``formatUnits(value, "ether")``.
 
-_property: utils.parseUnits(value [ , unit = "ether" ] ) => [BigNumber](bignumber)
+_property: ethers.utils.parseUnits(value [ , unit = "ether" ] ) => [BigNumber](bignumber)  @<utils-parseunits> @SRC<units>
 Returns a [BigNumber](bignumber) representation of //value//, parsed with
 //unit// digits (if it is a number) or from the unit specified (if
 a string).
 
-_property: utils.parseEther(value) => [BigNumber](bignumber)
+_property: ethers.utils.parseEther(value) => [BigNumber](bignumber)  @<utils-parseether> @SRC<units>
 The equivalent to calling ``parseUnits(value, "ether")``.

docs.wrm/api/utils/encoding.wrm

@@ -0,0 +1,49 @@
+_section: Encoding Utilities @<encoding>
+
+_subsection: Base58 @<bse58> @SRC<basex:Base58>
+
+_property: ethers.utils.base58.decode(textData) => Uin8Array
+Return a typed Uint8Array representation of //textData// decoded using
+base-58 encoding.
+
+_property: ethers.utils.base58.encode(aBytesLike) => string
+Return //aBytesLike// encoded as a string using the base-58 encoding.
+
+
+_subsection: Base64 @<base64>
+
+_property: ethers.utils.base64.decode(textData) => Uin8Array  @SRC<base64>
+Return a typed Uint8Array representation of //textData// decoded using
+base-64 encoding.
+
+_property: ethers.utils.base64.encode(aBytesLike) => string  @SRC<base64>
+Return //aBytesLike// encoded as a string using the base-64 encoding.
+
+
+_subsection: Recursive-Length Prefix @<rlp>
+
+The [[link-rlp]] encoding is used throughout Ethereum to serialize nested
+structures of Arrays and data.
+
+_property: ethers.utils.RLP.encode(dataObject) => string<[[datahexstring]]>  @<rlp-encode> @SRC<rlp>
+Encode a structured Data Object into its RLP-encoded representation.
+
+Each Data component may be an valid [[byteslike]].
+
+_property: ethers.utils.RLP.decode(aBytesLike) => [DataObject](rlp-dataobject)  @<rlp-decode> @SRC<rlp>
+Decode an RLP-encoded //aBytesLike// into its structured Data Object.
+
+All Data components will be returned as a [[datahexstring]].
+
+_heading: Data Object @<rlp-dataobject>
+
+A **Data Object** is a recursive structure which is used to serialize many
+internal structures in Ethereum. Each **Data Object** can either be:
+
+- Binary Data
+- An Array of **Data Objects** (i.e. this recursively includes Nesting)
+
+_definition: **Examples**
+
+- ``"0x1234"``
+- ``[ "0x1234", [ "0xdead", "0xbeef" ], [ ] ]``

docs.wrm/api/utils/fixednumber.wrm

@@ -1,33 +1,25 @@
-_title: Fixed Number
-
 _section: FixedNumber @<fixednumber>
 
-
-_subsection: Types
-
-
-_heading: FixedFormat @<fixedformat>
-TODO
-
-_definition: **//"fixed"//**
-A shorthand for ``fixed128x80``.
+A **FixedNumber** is a fixed-width (in bits) number with an internal
+base-10 divisor, which allows it to represent a decimal fractional
+component.
 
 _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]]
+_property: FixedNumber.from(value [ , format = "fixed" ] ) => [[fixednumber]]  @SRC<bignumber:FixedNumber.from>
 Returns an instance of a **FixedNumber** for //value// as a //format//.
 
-_property: BigNumber.fromBytes(aBytesLike [ , format = "fixed" ] ) => [[fixednumber]]
+_property: FixedNumber.fromBytes(aBytesLike [ , format = "fixed" ] ) => [[fixednumber]]  @SRC<bignumber>
 Returns an instance of a **FixedNumber** for //value// as a //format//.
 
-_property: BigNumber.fromString(value [ , format = "fixed" ] ) => [[fixednumber]]
+_property: FixedNumber.fromString(value [ , format = "fixed" ] ) => [[fixednumber]]  @SRC<bignumber:FixedNumber.fromString>
 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]]
+_property: FixedNumber.fromValue(value [ , decimals = 0 [ , format = "fixed" ] ] ) => [[fixednumber]]  @SRC<bignumber:FixedNumber.fromValue>
 Returns an instance of a **FixedNumber** for //value// with //decimals// as a //format//.
 
 
@@ -41,40 +33,94 @@ _subsection: Methods
 
 _heading: Math Operations
 
-_property: fixednumber.addUnsafe(otherValue) => [[fixednumber]]
+_property: fixednumber.addUnsafe(otherValue) => [[fixednumber]]  @SRC<bignumber/fixednumber>
 Returns a new FixedNumber with the value of //fixedvalue// **+** //otherValue//.
 
-_property: fixednumber.subUnsafe(otherValue) => [[fixednumber]]
+_property: fixednumber.subUnsafe(otherValue) => [[fixednumber]]  @SRC<bignumber/fixednumber>
 Returns a new FixedNumber with the value of //fixedvalue// **&ndash;** //otherValue//.
 
-_property: fixednumber.mulUnsafe(otherValue) => [[fixednumber]]
+_property: fixednumber.mulUnsafe(otherValue) => [[fixednumber]]  @SRC<bignumber/fixednumber>
 Returns a new FixedNumber with the value of //fixedvalue// **&times;** //otherValue//.
 
-_property: fixednumber.divUnsafe(otherValue) => [[fixednumber]]
+_property: fixednumber.divUnsafe(otherValue) => [[fixednumber]]  @SRC<bignumber/fixednumber>
 Returns a new FixedNumber with the value of //fixedvalue// **&#247;** //otherValue//.
 
-_property: fixednumber.round([ decimals = 0 ]) => [[fixednumber]]
+_property: fixednumber.round([ decimals = 0 ]) => [[fixednumber]]  @SRC<bignumber/fixednumber>
 Returns a new FixedNumber with the value of //fixedvalue// rounded to //decimals//.
 
 
 _heading: Conversion
 
-_property: fixednumber.toFormat(format) => [[fixednumber]]
+_property: fixednumber.toFormat(format) => [[fixednumber]]  @SRC<bignumber/fixednumber>
 Returns a new FixedNumber with the value of //fixedvalue// with //format//.
 
-_property: fixednumber.toHexString() => string
+_property: fixednumber.toHexString() => string  @SRC<bignumber/fixednumber>
 Returns a [Hexstring](hexstring) representation of //fixednumber//.
 
-_property: fixednumber.toString() => string
+_property: fixednumber.toString() => string  @SRC<bignumber/fixednumber>
 Returns a string representation of //fixednumber//.
 
-_property: fixednumber.toUnsafeFloat() => float
+_property: fixednumber.toUnsafeFloat() => float  @SRC<bignumber/fixednumber>
 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
+_property: FixedNumber.isFixedNumber(value) => boolean  @SRC<bignumber/fixednumber>
 Returns true if and only if //value// is a **FixedNumber**.
 
+
+_subsection: FixedFormat @<fixedformat>
+
+A **FixedFormat** is a simple object which represents a decimal
+(base-10) Fixed-Point data representation. Usually using this
+class directly is uneccessary, as passing in a [[fixedformatstring]]
+directly into the [[fixednumber]] will automatically create this.
+
+_heading: Format Strings  @<fixedformatstring>
+
+A format string is composed of three components, including signed-ness,
+bit-width and number of decimals.
+
+A signed format string begins with ``fixed``, which an unsigned format
+string begins with ``ufixed``, followed by the width (in bits) and the
+number of decimals.
+
+The width must be conguent to 0 mod 8 (i.e. ``(width % 8) == 0``) and no
+larger than 256 bits and the number of decimals must be no larger than 80.
+
+For example:
+
+- **fixed128x18** is signed, 128 bits wide and has 18 decimals; this is useful for most purposes
+- **fixed32x0** is signed, 32 bits wide and has 0 decimals; this would be the same as a ``int32_t` in C
+- **ufixed32x0** is unsigned, 32 bits wide and has 0 decimals; this would be the same as a ``uint32_t` in C
+- **fixed** is shorthand for ``fixed128x18`
+- **ufixed** is shorthand for ``ufixed128x18`
+
+_heading: Creating Instances
+
+_property: FixedFormat.from(value = "fixed128x18") => [[fixedformat]]  @<fixednumber-from> @SRC<bignumber/fixednumber:FixedFormat.from>
+
+Returns a new instance of a **FixedFormat** defined by //value//. Any valid [[fixedformatstring]]
+may be passed in as well as any object which has any of ``signed``, ``width`` and ``decimals``
+defined, including a [[fixedformat]] object.
+
+_heading: Properties
+
+_property: fixedFormat.signed => boolean
+The signed-ness of //fixedFormat//, true if negative values are supported.
+
+_property: fixedFormat.width => number
+The width (in bits) of //fixedFormat//.
+
+_property: fixedFormat.decimals => number
+The number of decimal points of //fixedFormat//.
+
+_property: fixedFormat.name => string
+The name of the //fixedFormat//, which can be used to recreate the format
+and is the string that the Solidity language uses to represent this format.
+
+_definition: **//"fixed"//**
+A shorthand for ``fixed128x80``.
+

docs.wrm/api/utils/hashing.wrm

@@ -1,5 +1,3 @@
-_title: Hashing
-
 _section: Hashing Algorithms
 
 Explain what hash functions are?
@@ -7,47 +5,47 @@ Explain what hash functions are?
 
 _subsection: Cryptographic Hashing
 
-The [Cryptographic Hash Functions](https://en.wikipedia.org/wiki/Cryptographic_hash_function)
+The [Cryptographic Hash Functions](link-wiki-cryptographichash)
 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: ethers.utils.keccak256(aBytesLike) => string<[[datahexstring]]<32>>  @<utils-keccak256> @SRC<keccak256>
+Returns the [KECCAK256](link-wiki-sha3) digest //aBytesLike//.
 
-_property: utils.ripemd160(aBytesLike) => string
-Returns the [RIPEMD-160](https://en.m.wikipedia.org/wiki/RIPEMD) digest of //aBytesLike//.
+_property: ethers.utils.ripemd160(aBytesLike) => string<[[datahexstring]]<20>>  @<utils-ripemd160> @SRC<sha2>
+Returns the [RIPEMD-160](link-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: ethers.utils.sha256(aBytesLike) => string<[[datahexstring]]<32>>  @<utils-sha256> @SRC<sha2:function.sha256>
+Returns the [SHA2-256](link-wiki-sha2) digest of //aBytesLike//.
 
-_property: utils.sha512(aBytesLike) => string
-Returns the [SHA2-512](https://en.wikipedia.org/wiki/SHA-2) digest of //aBytesLike//.
+_property: ethers.utils.sha512(aBytesLike) => string<[[datahexstring]]<64>>  @<utils-sha512> @SRC<sha2:function.sha512>
+Returns the [SHA2-512](link-wiki-sha2) digest of //aBytesLike//.
 
-_property: utils.computeHmac(algorithm, key, data) => string
-Returns the [HMAC](https://en.wikipedia.org/wiki/HMAC) of //data// with //key//
+_property: ethers.utils.computeHmac(algorithm, key, data) => string<[[datahexstring]]>  @<utils-computehmac> @SRC<sha2>
+Returns the [HMAC](link-wiki-hmac) of //data// with //key//
 using the [Algorithm](supported-algorithm) //algorithm//.
 
 
-_heading: HMAC Supported Algorithms @<supported-algorithm>
+_heading: HMAC Supported Algorithms @<supported-algorithm> @SRC<sha2:enum.SupportedAlgorithm>
 
-_property: utils.SupportedAlgorithms.sha256
-Use the [SHA2-256](https://en.wikipedia.org/wiki/SHA-2) hash algorithm.
+_property: ethers.utils.SupportedAlgorithm.sha256 => string
+Use the [SHA2-256](link-wiki-sha2) hash algorithm.
 
-_property: utils.SupportedAlgorithms.sha512
-Use the [SHA2-512](https://en.wikipedia.org/wiki/SHA-2) hash algorithm.
+_property: ethers.utils.SupportedAlgorithm.sha512 => string
+Use the [SHA2-512](link-wiki-sha2) 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:``
+_property: ethers.utils.hashMessage(message) => string<[[datahexstring]]<32>>  @<utils-hashmessage> @SRC<hash>
+Computes the [[link-eip-191]] personal message digest of //message//. Personal messages are
+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: ethers.utils.id(text) => string<[[datahexstring]]<32>>  @<utils-id> @SRC<hash>
+The Ethereum Identity function computs the [KECCAK256](link-wiki-sha3) hash of the //text// bytes.
 
-_property: utils.namehash(name) => string
-Returns the [ENS Namehash](https://docs.ens.domains/contract-api-reference/name-processing#hashing-names) of //name//.
+_property: ethers.utils.namehash(name) => string<[[datahexstring]]<32>>  @<utils-namehash> @SRC<hash>
+Returns the [ENS Namehash](link-namehash) of //name//.
 
 
 _subsection: Solidity Hashing Algorithms
@@ -56,16 +54,16 @@ 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
+_property: ethers.utils.solidityPack(arrayOfTypes, arrayOfValues) => string<[[datahexstring]]>  @<utils-soliditypack> @SRC<solidity:pack>
 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
+_property: ethers.utils.solidityKeccak256(arrayOfTypes, arrayOfValues) => string<[[datahexstring]]<32>>  @<utils-soliditykeccak256> @SRC<solidity:keccak256>
+Returns the [KECCAK256](link-wiki-sha3) 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
+_property: ethers.utils.soliditySha256(arrayOfTypes, arrayOfValues) => string<[[datahexstring]]<32>>  @<utils-soliditysha256> @SRC<solidity:sha256>
+Returns the [SHA2-256](link-wiki-sha2) of the non-standard encoded //arrayOfValues// packed
 according to their respective type in //arrayOfTypes//.
 
 

docs.wrm/api/utils/hdnode.wrm

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

docs.wrm/api/utils/index.wrm

@@ -1,16 +1,23 @@
-_title: Utilities
-
 _section: Utilities
 
 These utilities are used extensively within the library, but
 are also quite useful for application developers.
 
 _toc:
+    abi
     address
     bignumber
     bytes
     constants
     display-logic
+    encoding
     fixednumber
     hashing
+    hdnode
+    logger
+    properties
+    signing-key
     strings
+    transactions
+    web
+    wordlists

docs.wrm/api/utils/logger.wrm

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

docs.wrm/api/utils/properties.wrm

@@ -0,0 +1,9 @@
+_section: Property Utilities
+
+_property: ethers.utils.checkPropertoes() => void
+
+_property: ethers.utils.deepCopy(anObject) => any
+_property: ethers.utils.defineReadOnly(anObject, name, value) => void
+_property: ethers.utils.getStatic(aConstructor, key) => any
+_property: ethers.utils.resolveProperties(anObject) => Promise<any> @<utils-resolveproperties> @SRC<properties>
+_property: ethers.utils.shallowCopy(anObject) => any

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

@@ -0,0 +1,47 @@
+_section: Signing Key @<utils-signingkey>
+
+_property: new ethers.utils.SigningKey(privateKey)
+Create a new SigningKey for //privateKey//.
+
+_property: signingKey.privateKey => string<[[datahexstring]]<32>>
+The private key for this Signing Key.
+
+_property: signingKey.publicKey => string<[[datahexstring]]<65>>
+The uncompressed public key for this Signing Key. It will always be
+65 bytes (130 nibbles) and begine with ``0x04``.
+
+_property: signingKey.compressedPublicKey => string<[[datahexstring]]<33>>
+The compressed public key for this Signing Key. It will always be
+33 bytes (66 nibbles) and begine with either ``0x02`` or ``0x03``.
+
+_property: signingKey.signDisgest(digest) => [[signature]]
+Sign the //digest// and return the signature.
+
+_property: signingKey.computeSharedSecret(otherKey) => string<[[datahexstring]]<32>>
+Compute the ECDH shared secret with //otherKey//. The //otherKey// may be
+either a public key or a private key, but generally will be a public key from
+another party.
+
+It is best practice that each party computes the hash of this before using it
+as a symmetric key.
+
+_property: SigningKey.isSigningKey(anObject) => boolean
+Returns true if //anObject// is a SigningKey.
+
+
+_subsection: Other Functions
+
+_property: ethers.utils.verifyMessage(message, signature) => string<[[address]]>  @<utils-verifymessage> @SRC<wallet>
+Returns the address that signed //message// producing //signature//. The
+signature may have a non-canonical v (i.e. does not need to be 27 or 28),
+in which case it will be normalized to compute the `recoveryParam` which
+will then be used to compute the address; this allows systems which use
+the v to encode additional data (such as [EIP-155](link-eip-155))
+to be used since the v parameter is still completely non-ambiguous.
+
+_property: ethers.utils.recocverPublicKey(digest, signature) => string<[[datahexstring]]<65>> @<utils-recoverpublickey>
+
+_property: ethers.utils.computePublicKey(key [, compressed = false ]) => string<[[datahexstring]]> @<utils-computepublickey>
+Computes the public key of //key//, optionally compressing it. The //key//
+can be any form of public key (compressed or uncompressed) or a private
+key.

docs.wrm/api/utils/strings.wrm

@@ -1,5 +1,3 @@
-_title: Strings
-
 _section: Strings
 
 Tra la la
@@ -17,55 +15,57 @@ 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:**
+_note: 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
+_property: ethers.utils.parseBytes32String(aBytesLike) => string  @<utils-parsebytes32> @SRC<strings>
 Returns the decoded string represented by the ``Bytes32`` encoded data.
 
-_property: utils.formatBytes32String(text) => string
+_property: ethers.utils.formatBytes32String(text) => string<[[datahexstring]]<32>>  @<utils-formatbytes32> @SRC<strings>
 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
+_property: ethers.utils.toUtf8Bytes(text [ , form = current ] ) => Uint8Array  @<utils-toutf8bytes> @SRC<strings>
 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
+_property: ethers.utils.toUtf8CodePoints(text [ , form = current ] ) => Array<number>  @<utils-toutf8codepoints> @SRC<strings>
+Returns the Array of codepoints of //text//, optionally normalized using the
 [[unicode-normalization-form]] //form//.
 
-**Note:** This function correctly splits each user-perceived character into
+_note: Note
+This function correctly splits each **user-perceived character** into
 its codepoint, accounting for surrogate pairs. This should not be confused with
 ``string.split("")``, which destroys surrogate pairs, spliting between each UTF-16
 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.
+_property: ethers.utils.toUtf8String(aBytesLike [ , onError = error ] ) => string  @<utils-toutf8string> @SRC<strings>
+Returns the string represented by the UTF-8 bytes of //aBytesLike//.
 
+The //onError// is a [Custom UTF-8 Error function](utf8error) and if not specified
+it defaults to the [error](utf8error-error) function, which throws an error
+on **any** UTF-8 error.
 
-_heading: UnicodeNormalizationForm @<unicode-normalization-form>
+_subsection: UnicodeNormalizationForm @<unicode-normalization-form> @SRC<strings/utf8:enum.UnicodeNormalizationForm>
 
-There are several [commonly used forms](https://en.wikipedia.org/wiki/Unicode_equivalence)
+There are several [commonly used forms](link-wiki-unicode-equivalence)
 when normalizing UTF-8 data, which allow strings to be compared or hashed in a stable
 way.
 
-_property: utils.UnicodeNormalizationForm.current
+_property: ethers.utils.UnicodeNormalizationForm.current
 Maintain the current normalization form.
 
-_property: utils.UnicodeNormalizationForm.NFC
+_property: ethers.utils.UnicodeNormalizationForm.NFC
 The Composed Normalization Form. This form uses single codepoints
 which represent the fully composed character.
 
 For example, the **&eacute;** is a single codepoint, ``0x00e9``.
 
-_property: utils.UnicodeNormalizationForm.NFD
+_property: ethers.utils.UnicodeNormalizationForm.NFD
 The Decomposed Normalization Form. This form uses multiple codepoints
 (when necessary) to compose a character.
 
@@ -74,7 +74,7 @@ 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
+_property: ethers.utils.UnicodeNormalizationForm.NFKC
 The Composed Normalization Form with Canonical Equivalence. The Canonical
 representation folds characters which have the same syntactic representation
 but different semantic meaning.
@@ -82,11 +82,101 @@ 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
+_property: ethers.utils.UnicodeNormalizationForm.NFKD
 The Decomposed Normalization Form with Canonical Equivalence.
 See NFKC for more an example.
 
-_definition: **Note:**
+_note: Note
 Only certain specified characters are folded in Canonical Equivalence, and thus
-it should not be considered a method to acheive //any// level of security from
-[homoglyph attacks](https://en.wikipedia.org/wiki/IDN_homograph_attack).
+it should **not** be considered a method to acheive //any// level of security from
+[homoglyph attacks](link-wiki-homoglyph).
+
+_subsection: Custom UTF-8 Error Handling @<utf8error>
+
+When converting a string to its codepoints, there is the possibility
+of invalid byte sequences. Since certain situations may need specific
+ways to handle UTF-8 errors, a custom error handling function can be used,
+which has the signature:
+
+_property: errorFunction(reason, offset, bytes, output [ , badCodepoint ]) => number
+The //reason// is one of the [UTF-8 Error Reasons](utf8error-reasons), //offset// is the index
+into //bytes// where the error was first encountered, output is the list
+of codepoints already processed (and may be modified) and in certain Error
+Reasons, the //badCodepoint// indicates the currently computed codepoint,
+but which would be rejected because its value is invalid.
+
+This function should return the number of bytes to skip past keeping in
+mind the value at //offset// will already be consumed.
+
+_heading: UTF-8 Error Reasons @<utf8error-reasons> @SRC<strings/utf8:Utf8ErrorReason>
+
+_property: ethers.utils.Utf8ErrorReason.BAD_PREFIX
+A byte was encountered which is invalid to begin a UTF-8 byte
+sequence with.
+
+_property: ethers.utils.Utf8ErrorReason.MISSING_CONTINUE
+A UTF-8 sequence was begun, but did not have enough continuation
+bytes for the sequence. For this error the //ofset// is the index
+at which a continuation byte was expected.
+
+_property: ethers.utils.Utf8ErrorReason.OUT_OF_RANGE
+The computed codepoint is outside the range for valid UTF-8
+codepoints (i.e. the codepoint is greater than 0x10ffff).
+This reason will pass the computed //badCountpoint// into
+the custom error function.
+
+_property: ethers.utils.Utf8ErrorReason.OVERLONG
+Due to the way UTF-8 allows variable length byte sequences
+to be used, it is possible to have multiple representations
+of the same character, which means
+[overlong sequences](link-wiki-utf8-overlong)
+allow for a non-distinguished string to be formed, which can
+impact security as multiple strings that are otherwise
+equal can have different hashes.
+
+Generally, overlong sequences are an attempt to circumvent
+some part of security, but in rare cases may be produced by
+lazy libraries or used to encode the null terminating
+character in a way that is safe to include in a ``char*``.
+
+This reason will pass the computed //badCountpoint// into the
+custom error function, which is actually a valid codepoint, just
+one that was arrived at through unsafe methods.
+
+_property: ethers.utils.Utf8ErrorReason.OVERRUN
+The string does not have enough characters remaining for the
+length of this sequence.
+
+_property: ethers.utils.Utf8ErrorReason.UNEXPECTED_CONTINUE
+This error is similar to BAD_PREFIX, since a continuation byte
+cannot begin a valid sequence, but many may wish to process this
+differently. However, most developers would want to trap this
+and perform the same operation as a BAD_PREFIX.
+
+_property: ethers.utils.Utf8ErrorReason.UTF16_SURROGATE
+The computed codepoint represents a value reserved for
+UTF-16 surrogate pairs.
+This reason will pass the computed surrogate half
+//badCountpoint// into the custom error function.
+
+
+
+_heading: Provided UTF-8 Error Handling Functions
+
+There are already several functions available for the  most common
+situations.
+
+_property: ethers.utils.Utf8ErrorFuncs.error @<utf8error-error> @SRC<strings/utf8:errorFunc>
+The will throw an error on **any** error with a UTF-8 sequence, including
+invalid prefix bytes, overlong sequences, UTF-16 surrogate pairs.
+
+_property: ethers.utils.Utf8ErrorFuncs.ignore @<utf8error-ignore> @SRC<strings/utf8:ignoreFunc>
+This will drop all invalid sequences (by consuming invalid prefix bytes and
+any following continuation bytes) from the final string as well as permit
+overlong sequences to be converted to their equivalent string.
+
+_property: ethers.utils.Utf8ErrorFuncs.replace @<utf8error-replace> @SRC<strings/utf8:replaceFunc>
+This will replace all invalid sequences (by consuming invalid prefix bytes and
+any following continuation bytes) with the
+[UTF-8 Replacement Character](link-wiki-utf8-replacement),
+(i.e. U+FFFD).

docs.wrm/api/utils/transactions.wrm

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

docs.wrm/api/utils/web.wrm

@@ -0,0 +1,64 @@
+_section: Web Utilities
+
+
+_property: ethers.utils.fetchJson(urlOrConnectionInfo [, json [ , processFunc ] ]) => Promise<any> @<web-fetchjson>
+Fetch and parse the JSON content from //urlOrConnectionInfo//, with the
+optiona body //json// and optionally processing the result with //processFun//
+before returning it.
+
+_property: ethers.utils.poll(pollFunc [, options ]) => Promise<any> @<web-poll>
+Repeatedly call pollFunc using the [[web-polloptions]] until it returns a
+value other than undefined.
+
+
+_heading: Connection Info @<web-connectioninfo>
+
+_property: connection.url => string
+The URL to connect to.
+
+_property: connection.user => string
+The username to use for [[link-wiki-basicauth]].
+The default is null (i.e. do not use basic authentication)
+
+_property: connection.password => string
+The password to use for [[link-wiki-basicauth]].
+The default is null (i.e. do not use basic authentication)
+
+_property: connection.allowInsecureAuthentication => boolean
+Allow [[link-wiki-basicauth]] over non-secure HTTP. The default is false.
+
+_property: connection.timeout => number
+How long to wait before rejecting with a //timeout// error.
+
+_property: connection.headers => { [ key: string]: string }
+Additional headers to include in the connection.
+
+
+_heading: Poll Options @<web-polloptions>
+
+_property: options.timeout => number
+The amount of time allowed to ellapse before triggering a timeout
+error.
+
+_property: options.floor => number
+The minimum time limit to allow for [[link-wiki-backoff]].
+
+The default is 0s.
+
+_property: options.ceiling => number
+The maximum time limit to allow for [[link-wiki-backoff]].
+
+The default is 10s.
+
+_property: options.interval => number
+The interval used during [[link-wiki-backoff]] calculation.
+
+The default is 250ms.
+
+_property: options.retryLimit => number
+The number of times to retry in the event of an error or //undefined// is
+returned.
+
+_property: options.onceBlock => [[provider]]
+If this is specified, the polling will wait on new blocks from
+//provider// before attempting the //pollFunc// again.

docs.wrm/api/utils/wordlists.wrm

@@ -0,0 +1,58 @@
+_section: Wordlists @<wordlists>
+
+_subsection: Wordlist @<wordlist>
+
+_property: wordlist.locale => string
+The locale for this wordlist.
+
+_property: wordlist.getWord(index) => string
+Returns the word at //index//.
+
+_property: wordlist.getWordIndex(word) => number
+Returns the index of //word// within the wordlist.
+
+_property: wordlist.split(mnemonic) => Array<string>
+Returns the mnemonic split into each individual word, according to a
+locale's valid whitespace character set.
+
+_property: wordlist.join(words) => string
+Returns the mnemonic by joining //words// together using the
+whitespace that is standard for the locale.
+
+_property: Wordlist.check(wordlists) => string<[[datahexstring]]<32>>
+Checks that all words map both directions correctly and return the
+hash of the lists. Sub-classes should use this to validate the wordlist
+is correct against the official wordlist hash.
+
+_property: Wordlist.register(wordlist [ , name ]) => void
+Register a wordlist with the list of wordlists, optionally overriding
+the registered //name//.
+
+_subsection: Languages @<wordlist-languages>
+
+_property: ethers.wordlists.cz => Wordlist
+The Czech [[wordlist]].
+
+_property: ethers.wordlists.en => Wordlist
+The English [[wordlist]].
+
+_property: ethers.wordlists.es => Wordlist
+The Spanish [[wordlist]].
+
+_property: ethers.wordlists.fr => Wordlist
+The French [[wordlist]].
+
+_property: ethers.wordlists.it => Wordlist
+The Italian [[wordlist]].
+
+_property: ethers.wordlists.ja => Wordlist
+The Japanese [[wordlist]].
+
+_property: ethers.wordlists.ko => Wordlist
+The Korean [[wordlist]].
+
+_property: ethers.wordlists.zh_cn => Wordlist
+The Simplified Chinese [[wordlist]].
+
+_property: ethers.wordlists.zh_tw => Wordlist
+The Traditional Chinese [[wordlist]].

docs.wrm/cli/asm-examples-assemble.txt

@@ -0,0 +1,11 @@
+/home/ethers> ethers-asm SimpleStore.asm
+0x602a6000556044601160003960446000f334601e5760003560e01c80632096525514602457806355241077146030575b60006000fd5b60005460005260206000f35b6024361415601e5760043560005560006000f3
+
+# Piping in ASM source code
+/home/ethers> cat SimpleStore.asm | ethers-asm
+# Same as above
+
+# Setting a define which the ASM file checks and adds a checksum
+/home/ethers> ethers-asm --define checksum SimpleStore.asm
+0x602a6000556065601160003960656000f334601e5760003560e01c80632096525514602457806355241077146030575b60006000fd5b60005460005260206000f35b6024361415601e5760043560005560006000f37f10358310d664c9aeb4bf4ce7a10a6a03176bd23194c8ccbd3160a6dac90774d6
+

docs.wrm/cli/asm-examples-disassemble.txt

@@ -0,0 +1,57 @@
+/home/ethers> ethers-asm --disassemble SimpleStore.bin
+0000 : 0x2a                                                               ; #1 
+0002 : 0x00                                                               ; #1 
+0004 : SSTORE
+0005 : 0x44                                                               ; #1 
+0007 : 0x11                                                               ; #1 
+0009 : 0x00                                                               ; #1 
+000b : CODECOPY
+000c : 0x44                                                               ; #1 
+000e : 0x00                                                               ; #1 
+0010 : RETURN
+0011 : CALLVALUE
+0012 : 0x1e                                                               ; #1 
+0014 : JUMPI
+0015 : 0x00                                                               ; #1 
+0017 : CALLDATALOAD
+0018 : 0xe0                                                               ; #1 
+001a : SHR
+001b : DUP1
+001c : 0x20965255                                                         ; #4 
+0021 : EQ
+0022 : 0x24                                                               ; #1 
+0024 : JUMPI
+0025 : DUP1
+0026 : 0x55241077                                                         ; #4 
+002b : EQ
+002c : 0x30                                                               ; #1 
+002e : JUMPI
+002f*: JUMPDEST
+0030 : 0x00                                                               ; #1 
+0032 : 0x00                                                               ; #1 
+0034 : REVERT
+0035*: JUMPDEST
+0036 : 0x00                                                               ; #1 
+0038 : SLOAD
+0039 : 0x00                                                               ; #1 
+003b : MSTORE
+003c : 0x20                                                               ; #1 
+003e : 0x00                                                               ; #1 
+0040 : RETURN
+0041*: JUMPDEST
+0042 : 0x24                                                               ; #1 
+0044 : CALLDATASIZE
+0045 : EQ
+0046 : ISZERO
+0047 : 0x1e                                                               ; #1 
+0049 : JUMPI
+004a : 0x04                                                               ; #1 
+004c : CALLDATALOAD
+004d : 0x00                                                               ; #1 
+004f : SSTORE
+0050 : 0x00                                                               ; #1 
+0052 : 0x00                                                               ; #1 
+0054 : RETURN
+
+/home/ethers> cat SimpleStore.bin | ethers-asm --disassemble 
+# Same as above

docs.wrm/cli/asm-help.txt

@@ -0,0 +1,14 @@
+Usage:
+   ethers-asm [ FILENAME ] [ OPTIONS ]
+
+OPTIONS
+  --define KEY=VALUE          provide assembler defines
+  --disassemble               Disassemble input bytecode
+  --ignore-warnings           Ignore warnings
+  --pic                       generate position independent code
+  --target LABEL              output LABEL bytecode (default: _)
+
+OTHER OPTIONS
+  --debug                     Show stack traces for errors
+  --help                      Show this usage and exit
+  --version                   Show this version and exit

docs.wrm/cli/asm-simplestore-asm.txt

@@ -0,0 +1,48 @@
+; SimpleStore (uint)
+
+; Set the inital value of 42
+sstore(0, 42)
+
+; Init code to deploy myContract
+codecopy(0, $myContract, #myContract)
+return(0, #myContract)
+
+@myContract {
+    ; Non-payable
+    jumpi($error, callvalue)
+
+    ; Get the Sighash
+    shr({{= 256 - 32 }}, calldataload(0))
+
+    ; getValue()
+    dup1
+    {{= sighash("getValue()") }}
+    jumpi($getValue, eq)
+
+    ; setValue(uint)
+    dup1
+    {{= sighash("setValue(uint)") }}
+    jumpi($setValue, eq)
+
+    ; No matching signature
+    @error:
+        revert(0, 0)
+
+    @getValue:
+        mstore(0, sload(0))
+        return (0, 32)
+
+    @setValue:
+        ; Make sure we have exactly a uint
+        jumpi($error, iszero(eq(calldatasize, 36)))
+
+        ; Store the value
+        sstore(0, calldataload(4))
+        return (0, 0)
+
+    ; There is no *need* for the PUSH32, it just makes
+    ; decompiled code look nicer
+    @checksum[
+        {{= (defines.checksum ? concat([ Opcode.from("PUSH32"), id(myContract.source) ]): "0x") }}
+    ]
+}

docs.wrm/cli/asm-simplestore-bin.txt

@@ -0,0 +1,3 @@
+0x602a6000556044601160003960446000f334601e5760003560e01c8063209652
+0x5514602457806355241077146030575b60006000fd5b60005460005260206000
+0xf35b6024361415601e5760043560005560006000f3

docs.wrm/cli/asm.wrm

@@ -0,0 +1,81 @@
+_section: Assembler @<cli-asm>
+
+The assembler Command-Line utility allows you to assemble the
+[Ethers ASM Dialect](asm-dialect) into deployable EVM bytecode
+and disassemle EVM bytecode into human-readable mnemonics.
+
+
+_subsection: Help
+
+_code: asm-help.txt
+
+
+_subsection: Example Input Files
+
+_definition: **SimpleStore.asm**
+
+_code: asm-simplestore-asm.txt
+
+_definition: **SimpleStore.bin**
+
+_code: asm-simplestore-bin.txt
+
+_note: Note: Bytecode File Syntax
+A bin file may be made up of multiple blocks of bytecode, each may
+optionally begin with a ``0x`` prefix, all of which **must** be of
+even length (since bytes are required, with 2 nibbles per byte)
+
+All whitespace is ignored.
+
+_subsection: Assembler Examples
+
+The assembler converts an [Ethers ASM Dialect](asm-dialect) into
+bytecode by running multiple passes of an assemble stage, each pass
+more closely approximating the final result.
+
+This allows small portions of the bytecode to be massaged and tweaked
+until the bytecode stablizes. This allows for more compact jump
+destinations and for code to be include more advanced meta-programming
+techniques.
+
+_code: asm-examples-assemble.txt
+
+_heading: Options
+
+_definition: **-\-define KEY=VALUE** //or// **-\-define FLAG**
+This allows key/value pairs (where the value is a string) and
+flags (which the value is ``true``) to be passed along to the
+assembler, which can be accessed in
+[Scripting Blocks](asm-dialect-scripting), such as ``{{= defined.someKey }}``.
+
+_definition: **-\-ignore-warnings**
+By default any warning will be treated like an error. This enabled
+by-passing warnings.
+
+_definition: **-\-pic**
+When a program is assembled, the labels are usually given as an
+absolute byte position, which can be jumped to for loops and
+control flow. This means that a program must be installed at a specific
+location.
+
+Byt specifying the **Position Independent Code** flag, code
+will be generated in a way such that all offsets are relative, allowing
+the program to be moved without any impact to its logic.
+
+This does incur an additional gsas cost of 8 gas per offset access though.
+
+_definition: **-\-target LABEL**
+All programs have a root scope named ``_`` which is by default
+assembled. This option allows another labelled target (either a
+[[asm-dialect-scope]] or a [[asm-dialect-datasegment]] to be
+assembled instead. The entire program is still assembled per usual,
+so this only impacts which part of the program is output.
+
+_subsection: Disassembler Examples
+
+A disassembled program shows offsets and mnemonics for the given
+bytecode. This format may change in the future to be more
+human-readable.
+
+_code: asm-examples-disassemble.txt
+

docs.wrm/cli/ens-help.txt

@@ -0,0 +1,69 @@
+Usage:
+   ethers-ens COMMAND [ ARGS ] [ OPTIONS ]
+
+COMMANDS
+   lookup [ NAME | ADDRESS [ ... ] ]
+                              Lookup a name or address
+   commit NAME                Submit a pre-commitment
+      [ --duration DAYS ]        Register duration (default: 365 days)
+      [ --salt SALT ]            SALT to blind the commit with
+      [ --secret SECRET ]        Use id(SECRET) as the salt
+      [ --owner OWNER ]          The target owner (default: current account)
+   reveal NAME                Reveal a previous pre-commitment
+      [ --duration DAYS ]        Register duration (default: 365 days)
+      [ --salt SALT ]            SALT to blind the commit with
+      [ --secret SECRET ]        Use id(SECRET) as the salt
+      [ --owner OWNER ]          The target owner (default: current account)
+   set-controller NAME        Set the controller (default: current account)
+      [ --address ADDRESS ]      Specify another address
+   set-subnode NAME           Set a subnode owner (default: current account)
+      [ --address ADDRESS ]      Specify another address
+   set-resolver NAME          Set the resolver (default: resolver.eth)
+      [ --address ADDRESS ]      Specify another address
+   set-addr NAME              Set the addr record (default: current account)
+      [ --address ADDRESS ]      Specify another address
+   set-text NAME KEY VALUE    Set a text record
+   set-email NAME EMAIL       Set the email text record
+   set-website NAME URL       Set the website text record
+   set-content NAME HASH      Set the IPFS Content Hash
+   migrate-registrar NAME     Migrate from the Legacy to the Permanent Registrar
+   transfer NAME NEW_OWNER    Transfer registrant ownership
+   reclaim NAME               Reset the controller by the registrant
+      [ --address ADDRESS ]      Specify another address
+
+ACCOUNT OPTIONS
+  --account FILENAME          Load from a file (JSON, RAW or mnemonic)
+  --account RAW_KEY           Use a private key (insecure *)
+  --account 'MNEMONIC'        Use a mnemonic (insecure *)
+  --account -                 Use secure entry for a raw key or mnemonic
+  --account-void ADDRESS      Use an address as a void signer
+  --account-void ENS_NAME     Add the resolved address as a void signer
+  --account-rpc ADDRESS       Add the address from a JSON-RPC provider
+  --account-rpc INDEX         Add the index from a JSON-RPC provider
+  --mnemonic-password         Prompt for a password for mnemonics
+  --xxx-mnemonic-password     Prompt for a (experimental) hard password
+
+PROVIDER OPTIONS (default: all + homestead)
+  --alchemy                   Include Alchemy
+  --etherscan                 Include Etherscan
+  --infura                    Include INFURA
+  --nodesmith                 Include nodesmith
+  --rpc URL                   Include a custom JSON-RPC
+  --offline                   Dump signed transactions (no send)
+  --network NETWORK           Network to connect to (default: homestead)
+
+TRANSACTION OPTIONS (default: query network)
+  --gasPrice GWEI             Default gas price for transactions(in wei)
+  --gasLimit GAS              Default gas limit for transactions
+  --nonce NONCE               Initial nonce for the first transaction
+  --yes                       Always accept Siging and Sending
+
+OTHER OPTIONS
+  --wait                      Wait until transactions are mined
+  --debug                     Show stack traces for errors
+  --help                      Show this usage and exit
+  --version                   Show this version and exit
+
+(*) By including mnemonics or private keys on the command line they are
+    possibly readable by other users on your system and may get stored in
+    your bash history file. This is NOT recommended.

docs.wrm/cli/ens.wrm

@@ -0,0 +1,11 @@
+_section: Ethereum Naming Service @NAV<ENS>
+
+_subsection: Help
+
+_code: ens-help.txt
+
+_subsection: Examples
+
+TODO examples
+
+

docs.wrm/cli/ethers-help.txt

@@ -0,0 +1,65 @@
+Usage:
+   ethers [ COMMAND ] [ ARGS ] [ OPTIONS ]
+
+COMMANDS (default: sandbox)
+   sandbox                    Run a REPL VM environment with ethers
+   init FILENAME              Create a new JSON wallet
+      [ --force ]                Overwrite any existing files
+   fund TARGET                Fund TARGET with testnet ether
+   info [ TARGET ... ]        Dump info for accounts, addresses and ENS names
+   send TARGET ETHER          Send ETHER ether to TARGET form accounts[0]
+      [ --allow-zero ]           Allow sending to the address zero
+      [ --data DATA ]            Include data in the transaction
+   sweep TARGET               Send all ether from accounts[0] to TARGET
+   sign-message MESSAGE       Sign a MESSAGE with accounts[0]
+      [ --hex ]                  The message content is hex encoded
+   eval CODE                  Run CODE in a VM with ethers
+   run FILENAME               Run FILENAME in a VM with ethers
+   wait HASH                  Wait for a transaction HASH to be mined
+   wrap-ether VALUE           Deposit VALUE into Wrapped Ether (WETH)
+   unwrap-ether VALUE         Withdraw VALUE from Wrapped Ether (WETH)
+   send-token TOKEN ADDRESS VALUE
+                              Send VALUE tokens (at TOKEN) to ADDRESS
+   compile FILENAME           Compiles a Solidity contract
+      [ --no-optimize ]          Do not optimize the compiled output
+      [ --warnings ]             Error on any warning
+   deploy FILENAME            Compile and deploy a Solidity contract
+      [ --no-optimize ]          Do not optimize the compiled output
+      [ --contract NAME ]        Specify the contract to deploy
+
+ACCOUNT OPTIONS
+  --account FILENAME          Load from a file (JSON, RAW or mnemonic)
+  --account RAW_KEY           Use a private key (insecure *)
+  --account 'MNEMONIC'        Use a mnemonic (insecure *)
+  --account -                 Use secure entry for a raw key or mnemonic
+  --account-void ADDRESS      Use an address as a void signer
+  --account-void ENS_NAME     Add the resolved address as a void signer
+  --account-rpc ADDRESS       Add the address from a JSON-RPC provider
+  --account-rpc INDEX         Add the index from a JSON-RPC provider
+  --mnemonic-password         Prompt for a password for mnemonics
+  --xxx-mnemonic-password     Prompt for a (experimental) hard password
+
+PROVIDER OPTIONS (default: all + homestead)
+  --alchemy                   Include Alchemy
+  --etherscan                 Include Etherscan
+  --infura                    Include INFURA
+  --nodesmith                 Include nodesmith
+  --rpc URL                   Include a custom JSON-RPC
+  --offline                   Dump signed transactions (no send)
+  --network NETWORK           Network to connect to (default: homestead)
+
+TRANSACTION OPTIONS (default: query network)
+  --gasPrice GWEI             Default gas price for transactions(in wei)
+  --gasLimit GAS              Default gas limit for transactions
+  --nonce NONCE               Initial nonce for the first transaction
+  --yes                       Always accept Siging and Sending
+
+OTHER OPTIONS
+  --wait                      Wait until transactions are mined
+  --debug                     Show stack traces for errors
+  --help                      Show this usage and exit
+  --version                   Show this version and exit
+
+(*) By including mnemonics or private keys on the command line they are
+    possibly readable by other users on your system and may get stored in
+    your bash history file. This is NOT recommended.

docs.wrm/cli/ethers-init.txt

@@ -0,0 +1,14 @@
+/home/ethers> ethers init wallet.json
+Creating a new JSON Wallet - wallet.json
+Keep this password and file SAFE!! If lost or forgotten
+it CANNOT be recovered, by ANYone, EVER.
+Choose a password: ******
+Confirm password: ******
+Encrypting... 100%
+New account address: 0x485bcC23ae2E5038ec7ec9b8DCB2A6A6291cC003
+Saved:               wallet.json
+
+
+# If you are planning to try out the Ropsten testnet...
+/home/ethers> ethers --network ropsten fund 0x485bcC23ae2E5038ec7ec9b8DCB2A6A6291cC003
+Transaction Hash: 0x8dc55b8f8dc8076acded97f9e3ed7d6162460c0221e2769806006b6d7d1156e0

docs.wrm/cli/ethers-mnemonic-hard.txt

@@ -0,0 +1,8 @@
+/home/ricmoo> ethers --account mnemonic.txt --xxx-mnemonic-password
+Password (mnemonic; experimental - hard): ******
+Decrypting... 100%
+network: homestead (chainId: 1)
+homestead> accounts[0].getAddress()
+<Promise id=0 resolved>
+'0x56FC8792cC17971C19bEC4Ced978beEA44711EeD'
+homestead> 

docs.wrm/cli/ethers-mnemonic.txt

@@ -0,0 +1,7 @@
+/home/ricmoo> ethers --account public-mnemonic.txt --mnemonic-password
+Password (mnemonic): ******
+network: homestead (chainId: 1)
+homestead> accounts[0].getAddress()
+<Promise id=0 resolved>
+'0x6d3F723EC1B73141AA4aC248c3ab34A5a1DAD776'
+homestead> 

docs.wrm/cli/ethers-script.txt

@@ -0,0 +1,19 @@
+# Get the formatted balance of an account
+/home/ethers> ethers --network ropsten --account wallet.json eval 'accounts[0].getBalance().then(b => formatEther(b))'
+3.141592653589793238
+
+# Get the current block number
+/home/ethers> ethers --network rinkeby eval "provider.getBlockNumber()"
+5761009
+
+# Convert a Solidity signature to JSON
+/home/ethers> ethers eval 'utils.Fragment.from("function balanceOf(address owner) view returns (uint)").format("json")' 
+{"type":"function","name":"balanceOf","constant":true,"stateMutability":"view","payble":false,"inputs":[{"type":"address","name":"owner"}],"ouputs":[{"type":"uint256"}]}
+
+# Compute a topic hash
+/home/ricmoo> ethers eval 'id("Transfer(address,address,uint256")'
+0xd99659a21de82e379975ce8df556f939a4ccb95e92144f38bb0dd35730ffcdd5
+
+# Create a random mnemonic
+/home/ricmoo> ethers eval 'Wallet.createRandom().mnemonic'
+useful pond inch knock ritual matrix giggle attend dilemma convince coach amazing

docs.wrm/cli/ethers-send.txt

@@ -0,0 +1,44 @@
+# Sending ether
+/home/ricmoo> ethers --account wallet.json send ricmoo.firefly.eth 0.123
+Password (wallet.json): ******
+Decrypting... 100%
+Transaction:
+  To:         0x8ba1f109551bD432803012645Ac136ddd64DBA72
+  From:       0xaB7C8803962c0f2F5BBBe3FA8bf41cd82AA1923C
+  Value:      0.123 ether
+  Nonce:      96
+  Data:       0x
+  Gas Limit:  21000
+  Gas Price:  1.2 gwei
+  Chain ID:   1
+  Network:    homestead
+Send Transaction? (y/N/a) y
+Response:
+  Hash:  0xc4adf8b379033d7ab679d199aa35e6ceee9a802ca5ab0656af067e911c4a589a
+
+
+# Sending a token (SAI)
+# NOTE: the contract address could be used instead but
+#       popular token contract addresses are also managed
+#       by ethers
+/home/ricmoo> ethers --account wallet.json send-token sai.tokens.ethers.eth ricmoo.firefly.eth 1.0
+Sending Tokens:
+  To:              0x8ba1f109551bD432803012645Ac136ddd64DBA72
+  Token Contract:  0x89d24A6b4CcB1B6fAA2625fE562bDD9a23260359
+  Value:           1.0
+Password (wallet.json): ******
+Decrypting... 100%
+Transaction:
+  To:         0x89d24A6b4CcB1B6fAA2625fE562bDD9a23260359
+  From:       0xaB7C8803962c0f2F5BBBe3FA8bf41cd82AA1923C
+  Value:      0.0 ether
+  Nonce:      95
+  Data:       0xa9059cbb0000000000000000000000008ba1f109551bd432803012645ac136ddd64dba720000000000000000000000000000000000000000000000000de0b6b3a7640000
+  Gas Limit:  37538
+  Gas Price:  1.0 gwei
+  Chain ID:   1
+  Network:    homestead
+Send Transaction? (y/N/a) y
+Response:
+  Hash:  0xd609ecb7e3b5e8d36fd781dffceede3975ece6774b6322ea56cf1e4d0a17e3a1
+

docs.wrm/cli/ethers-sign.txt

@@ -0,0 +1,14 @@
+/home/ethers> ethers --account wallet.json sign-message 'Hello World'
+Password (wallet.json): ******
+Decrypting... 100%
+Message:
+  Message:        "Hello World"
+  Message (hex):  0x48656c6c6f20576f726c64
+Sign Message? (y/N/a) y
+Signature
+  Flat:   0xca3f0b32a22a5ab97ca8be7e4a36b1e81d565c6822465d769f4faa4aa24539fb122ee5649c8a37c9f5fc8446593674159e3a7b039997cd6ee697a24b787b1a161b
+  r:      0xca3f0b32a22a5ab97ca8be7e4a36b1e81d565c6822465d769f4faa4aa24539fb
+  s:      0x122ee5649c8a37c9f5fc8446593674159e3a7b039997cd6ee697a24b787b1a16
+  vs:     0x122ee5649c8a37c9f5fc8446593674159e3a7b039997cd6ee697a24b787b1a16
+  v:      27
+  recid:  0

docs.wrm/cli/ethers.wrm

@@ -0,0 +1,57 @@
+_section: Sandbox Utility
+
+The sandbox utility provides a simple way to use the most common
+ethers utilities required during learning, debuging and managing
+interactions with the Ethereum network.
+
+If no command is given, it will enter a REPL interface with many
+of the ethers utilities already exposed.
+
+_subsection: Help
+
+_code: ethers-help.txt
+
+_subsection: Examples
+
+_heading: Creating Wallets  @<cliex-init>
+
+_code: ethers-init.txt
+
+_heading: Sending Ether and Tokens  @<cliex-send>
+
+_code: ethers-send.txt
+
+_heading: Signing Messages  @<cliex-signing>
+
+_code: ethers-sign.txt
+
+_heading: Scripting  @<cliex-scripting>
+
+The ``eval`` command can be used to execute simple one-line scripts from
+the command line to be passed into other commands or stored in script
+environment variables.
+
+_code: ethers-script.txt
+
+_heading: Using Mnemonics (with a password)  @<cliex-mnemonicpassword>
+
+All mnemonic phrases have a password, but the default is to use the empty
+string (i.e. ``""``) as the password. If you have a password on your
+mnemonic, the ``-\-mnemonic-password`` will prompt for the password to
+use to decrypt the account.
+
+_code: ethers-mnemonic.txt
+
+_heading: Using Mnemonics (with experimental memory-hard passwords)  @<cliex-mnemonicpassword-xxx>
+
+The ``-\-xxx-mnemonic-password`` is similar to the ``-\-mnemonic-password`` options,
+which uses a password to decrypt the account for a mnemonic, however it passes
+the password through the [scrypt](link-wiki-scrypt)
+//password-based key derivation function// first, which is intentionally slow and makes
+a brute-force attack far more difficult.
+
+_code: ethers-mnemonic-hard.txt
+
+_warning: Note
+This is still an experimental feature (hence the ``xxx``).
+

docs.wrm/cli/index.wrm

@@ -0,0 +1,8 @@
+_section: Command Line Interfaces
+
+_toc:
+    ethers
+    asm
+    ens
+    typescript
+    plugin

docs.wrm/cli/plugin.txt

@@ -0,0 +1,10 @@
+/home/ethers> ethers --account wallet.json --yes send ricmoo.eth 1.0
+#  An Option ----------^                     ^   ^
+#    - name =  "account"                     |   |
+#    - value = "wallet.json"                 |   |
+#  A Flag -----------------------------------+   |
+#    - name  = "yes"                             |
+#    - value = true                              |
+#  Arguments ------------------------------------+
+#    - count = 3
+#    - [ "send", "ricmoo.eth", "1.0" ]

docs.wrm/cli/plugin.wrm

@@ -0,0 +1,146 @@
+_section: Making Your Own @<cli-diy>
+
+The //cli// library is meant to make it easy to create command
+line utilities of your own.
+
+_subsection: CLI @<cli-cli> @SRC<cli:class.CLI>
+
+A **CLI** handles parsing all the command-line flags, options and arguments
+and instantiates a [[cli-plugin]] to process the command.
+
+A **CLI** may support multiple [[cli-plugin]]'s in which case the first
+argument is used to determine which to run (or if no arguments, the default
+plugin will be selected) or may be designed to be standalone, in which case
+exactly one [[cli-plugin]] will be used and no command argument is allowed.
+
+
+_property: addPlugin(command, pluginClass) => void  @<cli-addplugin> @SRC<cli/cli>
+Add a //plugin// class for the //command//. After all options and flags
+have been consumed, the first argument will be consumed and the
+associated plugin class will be instantiated and run.
+
+_property: setPlugin(pluginClass) => void  @<cli-setplugin> @SRC<cli/cli>
+Set a dedicated [[cli-plugin]] class which will handle all input. This
+may not be used in conjuction with addPlugin and will not automatically
+accept a command from the arguments.
+
+_property: showUsage([ message = "" [ , status = 0 ] ]) => never  @<cli-showusage> @SRC<cli/cli>
+Shows the usage help screen for the CLI and terminates.
+
+_property: run(args) => Promise<void>  @<cli-run> @SRC<cli/cli:CLI.run>
+Usually the value of //args// passed in will be ``process.argv.slice(2)``.
+
+
+_subsection: Plugin  @<cli-plugin> @SRC<cli:class.Plugin>
+
+Each **Plugin** manages each command of a CLI and is executed in phases.
+
+If the usage (i.e. help) of a CLI is requested, the static methods ``getHelp``
+and ``getOptionHelp`` are used to geneate the help screen.
+
+Otherwise, a plugin is instantiated and the ``prepareOptions`` is called. Each
+plugin **must** call ``super.prepareOptions``, otherwise the basic options are
+not yet processed. During this time a Plugin should consume all the flags and
+options it understands, since any left over flags or options will cause the
+CLI to bail and issue an //unknown option// error. This should throw if a value
+for a given option is invalid or some combination of options and flags is not
+allowed.
+
+Once the prepareOptions is complete (the returned promise is resolved), the ``prepareArguments``
+is called. This should validate the number of arguments is expected and throw
+and error if there are too many or too few arguments or if any arguments do not
+make sense.
+
+Once the prepareArguments is complete (the returned promise is resolved), the ``run``
+is called.
+
+_property: plugin.network => [[provider-network]]
+The network this plugin is running for.
+
+_property: plugin.provider => [[provider]]
+The provider for this plugin is running for.
+
+_property: plugin.accounts => Array<[[signer]]>
+The accounts passed into the plugin using ``--account``,
+``--account-rpc`` and ``--account-void`` which this plugin can use.
+
+_property: plugin.gasLimit => [[bignumber]]
+The gas limit this plugin should use. This is null if unspecified.
+
+_property: plugin.gasPrice => [[bignumber]]
+The gas price this plugin should use. This is null if unspecified.
+
+_property: plugin.nonce => number
+The initial nonce for the account this plugin should use.
+
+
+_heading: Methods
+
+_property: plugin.prepareOptions(argParser [ , verifyOnly = false ]) => Promise<void>  @<plugin-prepareoptions> @SRC<cli/cli:Plugin.prepareOptions>
+
+_property: plugin.prepareArgs(args) =>  Promise<void>  @<plugin-prepareargs> @SRC<cli/cli>
+
+_property: plugin.run() => Promise<void>  @<plugin-run> @SRC<cli/cli:Plugin.run>
+
+_property: plugin.getAddress(addressOrName [ , message = "", [ allowZero = false ] ]) => Promise<string>  @<plugin-getaddress> @SRC<cli/cli:Plugin.getAddress>
+A plugin should use this method to resolve an address. If the resovled address is
+the zero address and //allowZero// is not true, an error is raised.
+
+_property: plugin.dump(header, info) => void  @<plugin-dump> @SRC<cli/cli:Plugin.dump>
+Dumps the contents of //info// to the console with a //header// in a nicely
+formatted style. In the future, plugins may support a JSON output format
+which will automatically work with this method.
+
+_property: plugin.throwUsageError([ message = "" ]) => never  @<plugin-throwusageerror> @SRC<cli/cli>
+Stops exectuion of the plugin and shows the help screen of the plugin with
+the optional //message//.
+
+_property: plugin.throwError(message) => never  @<plugin-throwerror> @SRC<cli/cli>
+Stops execution of the plugin and shows //message//.
+
+_heading: Static Methods
+
+_property: Plugin.getHelp => Help  @<plugin-gethelp> @SRC<cli/cli>
+Each subclass should implement this static method which is used to
+generate the help screen.
+
+_property: Plugin.getOptionHelp => Array<Help>  @<plugin-getoptionshelp> @SRC<cli/cli>
+Each subclass should implement this static method if it supports
+additional options which is used to generate the help screen.
+
+
+_subsection: ArgParser @<cli-argparser> @SRC<cli:class.ArgParser>
+
+The **ArgParser** is used to parse a command line into flags, options
+and arguments.
+
+_code: plugin.txt
+
+Flags are simple binary options (such as the ``--yes``), which are true if present
+otherwise false.
+
+Options require a single parameter follow them on the command line
+(such as ``--account wallet.json``, which nhas the name ``account`` and the value
+``wallet.json``)
+
+Arguments are all other values on the command line, and are not accessed through
+the **ArgParser** directly.
+
+When a CLI is run, an **ArgParser** is used to validate the command line by using
+prepareOptions, which consumes all flags and options leaving only the arguments
+behind, which are then passed into prepareArgs.
+
+_property: argParser.consumeFlag(name) => boolean  @<argparser-consumeflag> @SRC<cli/cli>
+Remove the flag //name// and return true if it is present.
+
+_property: argParser.consumeMultiOptions(names) => Array<{ name: string, value: string}>  @<argparser-consumemultioptions> @SRC<cli/cli>
+Remove all options which match any name in the Array of //names//
+with their values returning the list (in order) of values.
+
+_property: argParser.consumeOption(name) => string  @<argparser-consumeoption> @SRC<cli/cli>
+Remove the option with its value for //name// and return the value. This
+will throw a UsageError if the option is included multiple times.
+
+_property: argParser.consumeOptions(name) => Array<string>  @<argparser-consumeoptions> @SRC<cli/cli>
+Remove all options with their values for //name// and return the list
+(in order) of values.

docs.wrm/cli/typescript-help.txt

@@ -0,0 +1,19 @@
+Usage:
+   ethers-ts FILENAME [ ... ] [ OPTIONS ]
+
+OPTIONS
+  --output FILENAME           Write the output to FILENAME (default: stdout)
+  --force                     Overwrite files if they already exist
+  --no-optimize               Do not run the solc optimizer
+  --no-bytecode               Do not include bytecode and Factory methods
+
+OTHER OPTIONS
+  --debug                     Show stack traces for errors
+  --help                      Show this usage and exit
+  --version                   Show this version and exit
+
+(*) By including mnemonics or private keys on the command line they are
+    possibly readable by other users on your system and may get stored in
+    your bash history file. This is NOT recommended.
+
+

docs.wrm/cli/typescript.wrm

@@ -0,0 +1,9 @@
+_section: TypeScript
+
+_subsection: Help
+
+_code: typescript-help.txt
+
+_subsection: Examples
+
+TODO

docs.wrm/concepts/events.wrm

@@ -1,5 +1,7 @@
-_title: Events
-
 _section: Events
 
 Explain how topics and such work
+
+_subsection: Solidity Topics
+
+How to compute the topic...

docs.wrm/concepts/gas.wrm

@@ -1,6 +1,6 @@
-_title: Gas
+_section: Gas @<gas>
 
-_section: Gas
+Explain attack vectors
 
 _subsection: Gas Price @<gas-price>
 
@@ -10,4 +10,3 @@ processed.
 
 _subsection: Gas Limit @<gas-limit>
 
-

docs.wrm/concepts/index.wrm

@@ -1,9 +1,8 @@
-_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.
+and blockchains which developers can make use of or should
+be aware of.
 
 _toc:
     events

docs.wrm/config.js

@@ -0,0 +1,209 @@
+"use strict";
+
+const { resolve } = require("path");
+const fs = require("fs");
+
+const ts = require("typescript");
+
+function getDefinitions(source) {
+    const sourceFile = ts.createSourceFile("filename.ts", source);
+
+    const defs = [ ];
+
+    function add(type, name, pos) {
+        const lineNo = sourceFile.getLineAndCharacterOfPosition(pos).line + 1;
+        name = type + "." + name
+        defs.push({ type, name, lineNo });
+    }
+
+    let lastClass = null, lastEnum = null;
+    function visit(node, depth) {
+        if (ts.isConstructorDeclaration(node)) {
+            add("constructor", lastClass, node.body.pos);
+        } else if (ts.isFunctionDeclaration(node)) {
+            add("function", node.name.text, node.name.end);
+        } else if (ts.isConstructorDeclaration(node)) {
+            add("constructor", lastClass, node.pos);
+        } else if (ts.isClassDeclaration(node)) {
+            lastClass = node.name.escapedText;
+            add("class", lastClass, node.name.end);
+        } else if (ts.isMethodDeclaration(node)) {
+            if (lastClass == null) { throw new Error("missing class"); }
+            if (ts.hasStaticModifier(node)) {
+                add("staticmethod", (lastClass + "." + node.name.text), node.name.end);
+            } else {
+                add("method", (lastClass + "." + node.name.text), node.name.end);
+            }
+        } else if (ts.isEnumDeclaration(node)) {
+            lastEnum = node.name.escapedText;
+            add("enum", lastEnum, node.name.end);
+        } else if (ts.isEnumMember(node)) {
+            add("enum", (lastEnum + "." + node.name.escapedText), node.name.end);
+        } else if (ts.isVariableDeclaration(node)) {
+            if (depth === 3) {
+                add("var", node.name.escapedText, node.name.end);
+            }
+        }
+        ts.forEachChild(node, (node) => { return visit(node, depth + 1); });
+    }
+
+    visit(sourceFile, 0);
+
+    return defs;
+}
+
+const getSourceUrl = (function(path, include, exclude) {
+    console.log("Scanning TypeScript Sources...");
+    const Link = "https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages$FILENAME#L$LINE";
+    const Root = resolve(__dirname, path);
+
+    const readdir = function(path) {
+        if (path.match(exclude)) { return [ ]; }
+
+        const stat = fs.statSync(path);
+        if (stat.isDirectory()) {
+            return fs.readdirSync(path).reduce((result, filename) => {
+                readdir(resolve(path, filename)).forEach((file) => {
+                    result.push(file);
+                });
+                return result;
+            }, [ ]);
+        }
+
+        if (path.match(include)) {
+            const source = fs.readFileSync(path).toString();
+            return [ { filename: path.substring(Root.length), defs: getDefinitions(source) } ]
+        }
+
+        return [ ];
+    }
+
+    const defs = readdir(Root);
+
+    return function getSourceUrl(key) {
+        const comps = key.split(":");
+        if (comps.length !== 2) { throw new Error("unsupported key"); }
+
+        const pathCheck = new RegExp("(^|[^a-zA-Z0-9_])" + comps[0].split("/").join("/(.*/)*") + "($|[^a-zA-Z0-9_])");
+
+        let match = comps[1];
+        if (match.indexOf("(" /* fix: )*/)) {
+            match = new RegExp("(^|\\.)" + match.split("(" /* fix: ) */)[0] + "$");
+        } else if (match[0] === "=") {
+            match = new RegExp("^" + match.substring(1) + "$");
+        } else {
+            match = new RegExp("(^|\\.)" + match + "$");
+        }
+
+        const result = [ ];
+        defs.forEach((def) => {
+            if (!def.filename.match(pathCheck)) { return; }
+            def.defs.forEach((d) => {
+                if (!d.name.match(match)) { return; }
+                result.push({ filename: def.filename, lineNo: d.lineNo, name: d.name });
+            });
+        });
+        if (result.length > 1) {
+            throw new Error(`Ambiguous TypeScript link: ${ key } in [ ${ result.map((r) => JSON.stringify(r.filename + ":" + r.lineNo + "@" + r.name)).join(", ") }]`);
+        } else if (result.length === 0) {
+            throw new Error(`No matching TypeScript link: ${ key }`);
+        }
+
+        return Link
+            .replace("$LINE", String(result[0].lineNo))
+            .replace("$FILENAME", result[0].filename);
+    }
+})("../packages/", new RegExp("packages/.*/src.ts/.*\.ts$"), new RegExp("/node_modules/|src.ts/.*browser.*"));
+
+module.exports = {
+  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"
+  },
+
+  getSourceUrl: getSourceUrl,
+
+  externalLinks: {
+      "link-alchemy": "https:/\/alchemyapi.io",
+      "link-cloudflare": "https:/\/developers.cloudflare.com/distributed-web/ethereum-gateway/",
+      "link-ethereum": "https:/\/ethereumorg",
+      "link-etherscan": "https:/\/etherscan.io",
+      "link-etherscan-api": "https:/\/etherscan.io/apis",
+      "link-flatworm": "https:/\/github.com/ricmoo/flatworm",
+      "link-geth": "https:/\/geth.ethereum.org",
+      "link-infura": "https:/\/infura.io",
+      "link-ledger": "https:/\/www.ledger.com",
+      "link-metamask": "https:/\/metamask.io/",
+      "link-parity": "https:/\/www.parity.io",
+      "link-rtd": "https:/\/github.com/readthedocs/sphinx_rtd_theme",
+      "link-solidity": { name: "Solidity" , url: "https:/\/solidity.readthedocs.io/en/v0.6.2/" },
+      "link-sphinx": "https:/\/www.sphinx-doc.org/",
+
+      "link-legacy-docs3": "https:/\/docs.ethers.io/ethers.js/v3.0/html/",
+      "link-legacy-docs4": "https:/\/docs.ethers.io/ethers.js",
+
+      "link-web3": "https:/\/github.com/ethereum/web3.js",
+      "link-web3-http": "https:/\/github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-http",
+      "link-web3-ipc": "https:/\/github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-ipc",
+      "link-web3-ws": "https:/\/github.com/ethereum/web3.js/tree/1.x/packages/web3-providers-ws",
+
+      "link-solc-output": "https:/\/solidity.readthedocs.io/en/v0.6.0/using-the-compiler.html#output-description",
+
+      "link-icap": "https:/\/github.com/ethereum/wiki/wiki/Inter-exchange-Client-Address-Protocol-%28ICAP%29",
+      "link-jsonrpc": "https:/\/github.com/ethereum/wiki/wiki/JSON-RPC",
+      "link-mit": "https:/\/en.m.wikipedia.org/wiki/MIT_License",
+      "link-namehash": "https:/\/docs.ens.domains/contract-api-reference/name-processing#hashing-names",
+      "link-rlp": { name: "Recursive Length Prefix", url: "https:/\/github.com/ethereum/wiki/wiki/RLP" },
+
+      "link-ethersio": "https:/\/ethers.io/",
+      "link-ethers-docs": "https:/\/docs.ethers.io/",
+      "link-ethers-js": "https:/\/cdn.ethers.io/lib/ethers-5.0.esm.min.js",
+      "link-ethers-npm": "https:/\/www.npmjs.com/search?q=%40ethersproject%2F",
+      "link-ethers-asm-grammar": "https:/\/github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages/asm/grammar.jison",
+
+      "link-eip-155": { name: "EIP-155", url: "https:/\/eips.ethereum.org/EIPS/eip-155" },
+      "link-eip-191": { name: "EIP-191", url: "https:/\/eips.ethereum.org/EIPS/eip-191" },
+      "link-eip-609": "https:/\/eips.ethereum.org/EIPS/eip-609",
+      "link-eip-1014": "https:/\/eips.ethereum.org/EIPS/eip-1014",
+      "link-eip-2098": "https:/\/eips.ethereum.org/EIPS/eip-2098",
+      "link-bip-39": "https://en.bitcoin.it/wiki/BIP_0039",
+      "link-bip-32": "https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki",
+
+      "link-npm-elliptic": { name: "elliptic", url: "https:/\/www.npmjs.com/package/elliptic" },
+      "link-npm-bnjs": { name: "BN.js", url: "https:/\/www.npmjs.com/package/bn.js" },
+      "link-npm-query-bignumber": "https:/\/www.npmjs.com/search?q=bignumber",
+
+      "link-js-array": "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array",
+      "link-js-bigint": "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt",
+      "link-js-normalize": { name: "String.normalize", url: "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize" },
+      "link-js-maxsafe": "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER#Description",
+      "link-js-typedarray": "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray",
+
+      "link-ricmoo-humanreadableabi": "https:/\/blog.ricmoo.com/human-readable-contract-abis-in-ethers-js-141902f4d917",
+
+      "link-wiki-basicauth": { name: "Basic Authentication", url: "https:/\/en.wikipedia.org/wiki/Basic_access_authentication" },
+      "link-wiki-backoff": { name: "Exponential Backoff", url: "https:/\/en.wikipedia.org/wiki/Exponential_backoff" },
+      "link-wiki-bloomfilter": { name: "Bloom Filter", url: "https:/\/en.wikipedia.org/wiki/Bloom_filter" },
+      "link-wiki-cryptographichash": "https:/\/en.wikipedia.org/wiki/Cryptographic_hash_function",
+      "link-wiki-homoglyph": "https:/\/en.wikipedia.org/wiki/IDN_homograph_attack",
+      "link-wiki-hmac": "https:/\/en.wikipedia.org/wiki/HMAC",
+      "link-wiki-iban": "https:/\/en.wikipedia.org/wiki/International_Bank_Account_Number",
+      "link-wiki-ieee754": "https:/\/en.wikipedia.org/wiki/Double-precision_floating-point_format",
+      "link-wiki-ripemd": "https:/\/en.m.wikipedia.org/wiki/RIPEMD",
+      "link-wiki-sha2": "https:/\/en.wikipedia.org/wiki/SHA-2",
+      "link-wiki-twoscomplement": "https:/\/en.wikipedia.org/wiki/Two%27s_complement",
+      "link-wiki-unicode-equivalence": "https:/\/en.wikipedia.org/wiki/Unicode_equivalence",
+      "link-wiki-utf8-overlong": "https:/\/en.wikipedia.org/wiki/UTF-8#Overlong_encodings",
+      "link-wiki-utf8-replacement": "https:/\/en.wikipedia.org/wiki/Specials_%28Unicode_block%29#Replacement_character",
+      "link-wiki-scrypt": "https:/\/en.wikipedia.org/wiki/Scrypt",
+      "link-wiki-sha3": "https:/\/en.wikipedia.org/wiki/SHA-3",
+      "link-wiki-shuffle": { name: "Fisher-Yates Shuffle", url: "https:/\/en.wikipedia.org/wiki/Fisher-Yates_shuffle" },
+      "link-wiki-overflow": { name: "overflow", url: "https:/\/en.wikipedia.org/wiki/Integer_overflow" },
+      "link-wiki-underflow": { name: "arithmetic underflow", url: "https:/\/en.wikipedia.org/wiki/Arithmetic_underflow" },
+  }
+};

docs.wrm/config.json

@@ -5,5 +5,11 @@
   "link": "https://docs-beta.ethers.io",
   "markdown": {
       "banner": "-----\n\nDocumentation: [html](https://docs-beta.ethers.io/)\n\n-----\n\n"
+  },
+  "source": {
+      "path": "../packages/",
+      "include": "packages/.*/src.ts/",
+      "exclude": "/node_modules/|src.ts/.*browser.*",
+      "link": "https://github.com/ethers-io/ethers.js/blob/ethers-v5-beta/packages$FILENAME#L$LINE"
   }
 }

docs.wrm/contributing.wrm

@@ -1,5 +1,3 @@
-_title: Contributing and Hacking
-
 _section: Contributing and Hacking
 
 The ethers.js library is something that I've written out of necessity,

docs.wrm/cookbook/index.wrm

@@ -1,5 +1,3 @@
-_title: Cookbook
-
 _section: Cookbook
 
 Cooking...

docs.wrm/documentation/examples.txt

@@ -18,6 +18,13 @@ _toc:
     some-file
     some-directory
 
+_definition and reset the indentation.
+
+_note: Title
+This is placed in a blue box.
+
+_warning: Title
+This is placed in an orange box.
+
 _null:
 This breaks out of a directive. For example, to end a
-_definition and reset the indentation.

docs.wrm/documentation/fragment.txt

@@ -1,7 +1,9 @@
-_DIRECTIVE: VALUE @<LINK>
+_DIRECTIVE: VALUE @<LINK> @META<PARAMETER>
 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)
+DIRECTIVE:  The directive name
+VALUE:      Optional; the value to pass to the directive
+LINK:       Optional; a name for internal linking
+META:       Optional; extended directive functionality
+PARAMETER:  Optional; value to pass to extended directive functions
+BODY:       Optional; the directive body (certain directives only)

docs.wrm/documentation/index.wrm

@@ -1,16 +1,14 @@
-_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.
+A lot of its inspiration came from [Read the Docs](link-rtd) and
+the [Sphinx](link-sphinx) project.
 
 
-_subsection: Fragments
+_subsection: Fragments @<flatworm-fragments>
 
 Flatworm Docs are made up of fragments. A fragment is either a lone
 body of [markdown](flatworm-markdown) text, or a
@@ -49,6 +47,12 @@ _definition: **_property:** //SIGNATURE//
 A //property// has its JavaScript **SIGNATURE** formatted and the
 markdown body is indented.
 
+_definition: **_note:** //TITLE//
+A //note// is placed in a blue bordered-box to draw attention to it.
+
+_definition: **_warning:** //TITLE//
+A //warning// is placed in an orange bordered-box to draw attention to it.
+
 _definition: **_code:** //FILENAME//
 A //code// reads the **FILENAME** and depending on the extension
 adjusts it.
@@ -69,11 +73,10 @@ a //definition//, the bodies are indented, so a //null// can be
 used to reset the indentation.
 
 
-_heading: Examples
+_heading: Examples @<>
 
 _code: examples.txt
 
-
 _subsection: Markdown @<flatworm-markdown>
 
 The markdown is simple and does not have the flexibility of
@@ -83,3 +86,49 @@ supporting [links](flatworm-markdown) and lists.
 
 _code: markdown.txt
 
+
+_subsection: Configuration @<flatworm-config>
+
+Configuration is optional (but highly recommended) and may be either
+a simple JSON file (config.json) or a JS file (config.js) placed in
+the top  of the source folder.
+
+TODO:  example JSON and example JS
+
+
+_subsection: Extended Directive Functions @<flatworm-extended-directive-functions>
+
+_heading: @INHERIT\<markdown>
+
+Adds an inherits description to a directive. The //markdown// may contain links.
+
+This extended directive function is available for:
+
+- _section
+- _subsetion
+- _heading
+
+
+_heading: @NAV\<text>
+
+Sets the name in the breadcrumbs when not the current node.
+
+This extended directive function is available for:
+
+- _section
+
+
+_heading: @SRC\<text>
+
+Calls the configuration ``getSourceUrl(text, VALUE)`` to get a URL which
+will be linked to by a link next to the //directive//.
+
+This extended directive function requires an advanced ``config.js`` [[flatworm-config]]
+file since it requires a JavaScript function.
+
+This extended directive function is available for:
+
+- _section
+- _subsetion
+- _heading
+- _property

docs.wrm/getting-started.wrm

@@ -1,13 +1,10 @@
-_title: Getting Started
-
 _section: Getting Started
 
 
 _subsection: Installing
 
 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)
+manually from sub-packages under the [@ethersproject](link-ethers-npm)
 but for most projects, the umbrella package is the easiest way to
 get started.
 
@@ -23,8 +20,8 @@ _code: importing-node.source
 _heading: Web Browser
 
 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.
+[ethers library](link-ethers-js) to your own webserver and serve it
+yourself.
 
 For quick demos or prototyping though, it can be loaded in your
 Web Applications from our CDN.

docs.wrm/hacking.wrm

@@ -0,0 +1,56 @@
+_section: Hacking
+
+Things to keep in mind:
+
+
+_heading: Supported Platforms
+
+...
+
+_heading: Dependencies
+
+Adding a dependency is non-trivial and will require fairly convincing
+arguments.
+
+Further, **ALL** dependencies for ethers, **must** be MIT licensed or
+public domain (CC0).
+
+All contributions to ethers are then included under the MIT license.
+
+
+_heading: Printable ASCII (7-bit) Characters
+
+All source and documentation files should ONLY use the printable ASCII
+set.
+
+This is for several reasons, bu...
+
+- Transmission over certain HTTP servers and proxies can mangle
+  UTF-8 data
+- Certain editors on some platforms, or in certain terminals cannot
+  handle UTF-8 characters elegantly
+- The ability to enter non-ASCII characters on some platforms require
+  special keyboards, input devices or input methods to be installed,
+  which either not be supported, or may require administrative
+  priviledges.
+
+
+_heading: License
+
+MIT...
+
+
+_heading: Other Considerations
+
+A common argument to Pull Requests is that they are simple, backwards compatible
+and 
+
+It is important to remember that a small change is something that
+we are required to support in perpetuity.
+
+For example, adding support for an obscure platform, such as adding a dot-file
+to the root of the package, now carries the implication that we will continue
+keeping that dot-file up-to-date as new versions of that platform are released.
+
+
+

docs.wrm/importing-browser.txt

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

docs.wrm/index.wrm

@@ -1,10 +1,10 @@
-_title: Documentation
+_section: Documentation
 
-_section: What is ethers?
+_subsection: What is Ethers?
 
 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
+originally designed for use with [ethers.io](link-ethersio) and
 has since expanded into a much more general-purpose library.
 
 _subsection: Features
@@ -17,17 +17,14 @@ _subsection: Features
 - 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/).
+  [JSON-RPC](link-jsonrpc), [INFURA](link-infura),
+  [Etherscan](link-etherscan), [Alchemy](link-alchemy),
+  [Cloudflare](link-cloudflare) or [MetaMask](link-metamask).
 - **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/)
+- Extensive [documentation](link-ethers-docs)
 - Large collection of **test cases** which are maintained and added to
 - Fully **TypeScript** ready, with definition files and full
   TypeScript source
@@ -42,6 +39,7 @@ _toc:
     getting-started
     concepts
     api
+    cli
     cookbook
     migration
     testing
@@ -55,5 +53,5 @@ _subsection: Legacy Documentation
 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/)
+- [version 4.0](link-legacy-docs4)
+- [version 3.0](link-legacy-docs3)

docs.wrm/license.wrm

@@ -1,11 +1,8 @@
-_title: License and Copyright
-
-
-_section: License and Copyright
+_section: License and Copyright  @<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.
+under the [MIT License](link-mit), which permits a wide variety
+of uses.
 
 
 _heading: MIT License

docs.wrm/migration/ethers-v4/bignumber-creating.txt

@@ -0,0 +1,8 @@
+// v4
+new ethers.utils.BigNumber(someValue)
+ethers.utils.bigNumberify(someValue);
+
+// v5
+// - Constructor is private
+// - Removed `bigNumberify`
+ethers.BigNumber.from(someValue)

docs.wrm/migration/ethers-v4/bignumber-namespace.txt

@@ -0,0 +1,7 @@
+// v4
+ethers.utils.BigNumber
+ethers.utils.BigNumberish
+
+// v5
+ethers.BigNumber
+ethers.BigNumberish

docs.wrm/migration/ethers-v4/contracts.txt

@@ -0,0 +1 @@
+TODO

docs.wrm/migration/ethers-v4/errors.txt

@@ -0,0 +1,29 @@
+// v4
+ethers.errors.UNKNOWN_ERROR
+ethers.errors.*
+
+errors.setCensorship(censorship, permanent)
+errors.setLogLevel(logLevel)
+
+errors.checkArgumentCount(count, expectedCount, suffix)
+errors.checkNew(self, kind)
+errors.checkNormalize()
+errors.throwError(message, code, params)
+errors.warn(...)
+errors.info(...)
+
+// v5
+ethers.utils.Logger.errors.UNKNOWN_ERROR
+ethers.utils.Logger.errors.*
+
+Logger.setCensorship(censorship, permanent)
+Logger.setLogLevel(logLevel)
+
+const logger = new ethers.utils.Logger(version);
+logger.checkArgumentCount(count, expectedCount, suffix)
+logger.checkNew(self, kind)
+logger.checkNormalize()
+logger.throwError(message, code, params)
+logger.warn(...)
+logger.info(...)
+

docs.wrm/migration/ethers-v4/index.wrm

@@ -0,0 +1,62 @@
+_section: Migration: From Ethers v4  @<migration-v4>
+
+_subsection: BigNumber
+
+_heading: Namespace
+Since [[bignumber]] is used quite frequently, it has been moved to
+the top level of the umbrella package.
+_code: bignumber-namespace.txt
+
+_heading: Creating Instances
+The ``bigNumberify`` method was always preferred over the constructor
+since it could short-circuit an object instantiation for [[bignumber]
+objects (since they are immutable). This has been moved to a static
+``from`` class method.
+_code: bignumber-creating.txt
+
+
+_subsection: Contracts
+_code: contracts.txt
+
+_subsection: Errors
+
+_heading: Namespace
+All errors now belong to the [[logger]] class and the related functions
+have been moved to [[logger]] instances, which can include a per-package
+version string.
+
+Global error fucntions have been moved [[logger]] class methods.
+_code: errors.txt
+
+
+_subsection: Interface
+The [[abi-interface]] object has undergone the most dramatic changes.
+
+It is no longer a meta-class and now has methods that simplify handling
+contract interface operations without the need for object inspection and
+special edge cases.
+
+_heading: Functions
+_code: interface-functions.txt
+
+_heading: Events
+_code: interface-events.txt
+
+_heading: Inspection
+Interrogating properties about a function or event can now (mostly) be
+done directly on the [[abi-fragment]] object.
+_code: interface-inspection.txt
+
+
+_subsection: Utilities
+
+_heading: Renaming
+_code: utils.txt
+
+
+_subsection: Wallet
+
+_heading: Mnemonic Phrases
+The **mnemonic** phrase and related properties have been merged into
+a single ``mnemonic`` object, which also now includes the ``locale``.
+_code: wallet.txt

docs.wrm/migration/ethers-v4/interface-events.txt

@@ -0,0 +1,7 @@
+// v4 (example: Transfer(address indexed, address indexed, uint256)
+interface.events.Transfer.encodeTopics(values)
+interface.events.Transfer.decode(data, topics)
+
+// v5
+interface.encodeFilterTopics("Transfer", values)
+interface.encodeEventLog("Transfer", data, topics)

docs.wrm/migration/ethers-v4/interface-functions.txt

@@ -0,0 +1,14 @@
+// v4 (example: "transfer(address to, uint amount)")
+interface.functions.transfer.encode(to, amount)
+interface.functions.transfer.decode(callData)
+
+// v5
+interface.encodeData("transfer", [ to, amount ])
+interface.decodeResult("transfer", data)
+
+// Or you can use any compatible signature or Fragment objects.
+// Notice that signature normalization is performed for you,
+// e.g. "uint" and "uint256" will be automatically converted
+interface.encodeData("transfer(address,uint)", [ to, amount ])
+interface.decodeResult("transfer(address to, uint256 amount)", data)
+

docs.wrm/migration/ethers-v4/interface-inspection.txt

@@ -0,0 +1,48 @@
+// v4
+interface.functions.transfer.name
+interface.functions.transfer.inputs
+interface.functions.transfer.outputs
+interface.functions.transfer.payable
+interface.functions.transfer.gas
+
+// v5
+const functionFragment = interface.getFunction("transfer")
+functionFragment.name
+functionFragment.inputs
+functionFragment.outputs
+functionFragment.payable
+functionFragment.gas
+
+
+// v4; type is "call" or "transaction"
+interface.functions.transfer.type
+
+// v5; constant is true (i.e. "call") or false (i.e. "transaction")
+functionFragment.constant
+
+
+// v4
+interface.events.Transfer.anonymous
+interface.events.Transfer.inputs
+interface.events.Transfer.name
+
+// v5
+const eventFragment = interface.getEvent("Transfer");
+eventFragment.anonymous
+eventFragment.inputs
+eventFragment.name
+
+
+// v4
+const functionSig = interface.functions.transfer.signature
+const sighash = interface.functions.transfer.sighash
+
+const eventSig = interface.events.Transfer.signature
+const topic = interface.events.Transfer.topic
+
+// v5
+const functionSig = functionFragment.format()
+const sighash = interface.getSighash(functionFragment)
+
+const eventSig = eventFragment.format()
+const topic = interface.getTopic(eventFragment)

docs.wrm/migration/ethers-v4/utils.txt

@@ -0,0 +1 @@
+TODO

docs.wrm/migration/ethers-v4/wallet.txt

@@ -0,0 +1,9 @@
+// v4
+wallet.mnemonic
+wallet.path
+
+// v5
+// - Mnemonic phrase and path are a Mnemonic object
+// - Note: wallet.mnemonic is null if there is no mnemonic
+wallet.mnemonic.phrase
+wallet.mnemonic.path

docs.wrm/migration/index.wrm

@@ -1,13 +1,8 @@
-_title: Migration Guide
+_section: Migration Guide @<migration>
 
-_section: Migration Guide
+Here are some migration guides when upgrading from older versions
+of Ethers or other libraries.
 
-Migratimg...
-
-_subsection: From Web3
-
-test
-
-_subsection: From ethers v4
-
-test
+_toc:
+    web3
+    ethers-v4