From a78ca7eb8d841f8dbbdda13ef8b128a8817d10a4 Mon Sep 17 00:00:00 2001 From: Richard Moore Date: Tue, 7 Jul 2020 23:20:32 -0400 Subject: [PATCH] Updated docs. --- docs.wrm/api/index.wrm | 4 +- docs.wrm/config.js | 7 + docs.wrm/migration/ethers-v4.wrm | 115 ++++++++- docs.wrm/migration/web3.wrm | 62 +++-- docs.wrm/testing/index.wrm | 384 ++++++++++++++++++++++++++++++- 5 files changed, 541 insertions(+), 31 deletions(-) diff --git a/docs.wrm/api/index.wrm b/docs.wrm/api/index.wrm index 038529c81..6e14e1467 100644 --- a/docs.wrm/api/index.wrm +++ b/docs.wrm/api/index.wrm @@ -4,9 +4,9 @@ An Application Programming Interface (API) is the formal specification of the library. _toc: - contract - signer providers + signer + contract utils other experimental diff --git a/docs.wrm/config.js b/docs.wrm/config.js index 4aac6713c..5177d2eb3 100644 --- a/docs.wrm/config.js +++ b/docs.wrm/config.js @@ -181,6 +181,7 @@ module.exports = { "link-infura": { name: "INFURA", url: "https:/\/infura.io" }, "link-ledger": "https:/\/www.ledger.com", "link-metamask": { name: "Metamask", url: "https:/\/metamask.io/" }, + "link-otto": "https:/\/github.com/robertkrimen/otto", "link-parity": { name: "Parity", url: "https:/\/www.parity.io" }, "link-rtd": "https:/\/github.com/readthedocs/sphinx_rtd_theme", "link-semver": { name: "semver", url: "https:/\/semver.org" }, @@ -197,6 +198,11 @@ module.exports = { "link-legacy-docs3": "https:/\/docs.ethers.io/v3/", "link-legacy-docs4": "https:/\/docs.ethers.io/v4/", + "link-github-ci": "https:/\/github.com/ethers-io/ethers.js/actions/runs/158006903", + "link-github-issues": "https:/\/github.com/ethers-io/ethers.js/issues", + + "link-issue-407": "https:/\/github.com/ethers-io/ethers.js/issues/407", + "link-infura-secret": "https:/\/infura.io/docs/gettingStarted/authentication", "link-web3": "https:/\/github.com/ethereum/web3.js", @@ -237,6 +243,7 @@ module.exports = { "link-js-bigint": "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt", "link-js-normalize": { name: "String.normalize", url: "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize" }, "link-js-maxsafe": "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER#Description", + "link-js-proxy": "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy", "link-js-typedarray": "https:/\/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray", "link-ricmoo-humanreadableabi": "https:/\/blog.ricmoo.com/human-readable-contract-abis-in-ethers-js-141902f4d917", diff --git a/docs.wrm/migration/ethers-v4.wrm b/docs.wrm/migration/ethers-v4.wrm index eb6a52914..e06e07805 100644 --- a/docs.wrm/migration/ethers-v4.wrm +++ b/docs.wrm/migration/ethers-v4.wrm @@ -1,5 +1,16 @@ _section: Migration: From Ethers v4 @ +This document only covers the features present in v4 which have changed +in some important way in v5. + +It does not cover all the new additional featuers that have been added and +mainly aims to help those updating their older scripts and applications to +retain functional parity. + +If you encounter any missing changes, please let me know and I'll update this +guide. + + _subsection: BigNumber _heading: Namespace @@ -18,6 +29,7 @@ ethers.BigNumberish _heading: Creating Instances + The ``bigNumberify`` method was always preferred over the constructor since it could short-circuit an object instantiation for [[BigNumber] objects (since they are immutable). This has been moved to a static @@ -37,9 +49,99 @@ ethers.BigNumber.from(someValue) _subsection: Contracts -_code: @lang