Release - 1.2.10

[ryanio]

This PR introduces web3.js version 1.2.10 beginning with 1.2.10-rc.0.

Please see the release notes for more.

Changelog

Added

• Add support for EIP-1193 provider request method (Use provider.request() when available #3625)

Changed

• Upgrade minified bundle build process (from gulp to webpack) (Upgrade build process from gulp to webpack #3618)
• CI improvements: add dependency caching, netlify browser test preview (Add Netlify to rtd #3598, Remove invisible  char from web3-utils files #3602)
• Remove references to genesis block in 1.x documentation (updating docs: genesis is not a valid block identifier any longer #3594)
• Disallow setting toBlock when subscribing to contract events (Undesired behaviour and unexpected error when toBlock is passed to myContract.events.<eventName> or myContract.events.allEvents #3207)

Fixed

• Extend _txInputFormatter with hex prefix check (Extend _txInputFormatter with hex prefix check #3317)
• Extract revert reason string for geth >= 1.9.15 (Revert reason missing when using geth 1.9.14 #3520)
• Fix Incorrect param encoding of BN object in arrayed inputs (Incorrect encoding of BigNumber for uint256[] #3592)
• Remove mis-encoded whitespace characters from web3-utils files (utf8 confuses browserify #3601)
• Fix incompatibilities with webpack Buffer polyfill for wallet.encrypt/decrypt (Decrypting a keystore fails on 1.2.9 (browser / React )  #3580)
• Fix misformatted fromBlock value when re-subscribing to events over WS (format fromBlock param on resubscription #3596)
• Support Function type log parameter decoding (getPastEvents() causes an error if an event has a function as argument #2826)
• Add undefined callback check to websocket provider response queue (Add undefined callback check to websocket provider response queue #3574)
• Fix WS clientConfig type (Fix WS clientConfig types and clarify docs #3563)

Compare View

v1.2.9 -> v1.2.10

Type of change

• Release

Checklist:

• I have selected the correct base branch.
• I have performed a self-review of my own code.
• I have commented my code, particularly in hard-to-understand areas.
• I have made corresponding changes to the documentation.
• My changes generate no new warnings.
• Any dependent changes have been merged and published in downstream modules.
• I ran npm run dtslint with success and extended the tests and types if necessary.
• I ran npm run test:unit with success.
• I ran npm run test:cov and my test cases cover all the lines and branches of the added code.
• I ran npm run build and tested dist/web3.min.js in a browser.
• I have tested my code on the live network.
• I have checked the Deploy Preview and it looks correct.
• I have updated the CHANGELOG.md file in the root folder.

[coveralls]

Coverage remained the same at 90.254% when pulling 6c2357b on release/1.2.10 into 6862c59 on 1.x.

[cgewecke]

As part of the RC process, am doing some test installations in other projects and running their tests to see if everything.

• installs properly
• builds
• tests pass

(This list will be actively edited)

Project	Desc	Status
oz-test-helpers	Test utils. Subset of their suite is web3 contracts	✅
synthetix	~1000 units	✅

[cgewecke]

Incidental to this release... while running the Synthetix tests, believe I found another difference between old and new Ethers.

Beginning with Web3 1.2.8, ABI decoded array return values are immutable.

// Solidity
function getAddresses() returns (address[] addrs){
  ...
}

// JS
const immutableArray = await instance.methods.getAddresses().call();

Applying native .sort directly on the return value now throws an error like:

TypeError: Cannot assign to read only property '1' of object '[object Array]'
      at Array.sort (native)
      at Context.it.only (test/contracts/BinaryOptionMarketManager.js:859:60)
      at process._tickCallback (internal/process/next_tick.js:68:7)

...because it tries to sort in place.

A work-around is to copy the array: e.g.

const sorted = [...immutableArray].sort()`.

[cgewecke]

Looks good!