Release - 1.2.9

[ryanio]

Description

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

Release notes

In addition to dependency updates, small bug fixes for the ABI Coder change in 1.2.8, and many documentation improvements, this release extends the transaction event API for more granular tracking of transaction submissions.

These additions were proposed by client engineer @benjamincburns in #3438 and should:

• make it easier to ensure that transactions are submitted in order (see web3+HttpProvider reusing nonce when doing parallel contract deploy using Promise.all #1846)
• make transaction timing in performance benchmarking tools more precise
• make it easier to monitor the transaction submission process for debugging purposes

The new / changed Promievents are:

Event	Description	Handler args
sending	Fired immediately before transmitting the transaction request, after all intermediate requests such as eth_chainId, eth_estimateGas, or eth_gasPrice have completed.	transactionPayload
sent	Fired immediately after the request body has been written to the client, but before the transaction hash is received	transactionPayload
confirmation	Behaves as it does today, but includes the block hash for the most recently mined block in the event handler arguments	confNumber, receipt, latestBlockHash

Also of note...

As reported in #3432 by @dmihal, Web3 has long had some interaction issues with provider middle-ware like web3-provider-engine that uses http and provides an event emitter interface. The library has assumed that these packages support subscription endpoints when they don't. This bug should be fixed by PR #3517.

Changelog

Added

• Add sending and sent events for tx submissions (Add events to transaction submission in support of performance testing #3438)
• Add latestBlockHash arg to confirmation event handler payload (Add events to transaction submission in support of performance testing #3438)
• Make socket providers' max listeners threshold configurable (Make maxListenersExceeded warning configurable #3469)
• Documentation about testing & ci resources for Web3.js development (Add CI and testing documentation #3528)
• More detailed documentation about how to use method.encodeABI (More about encodeABI #3549)
• Integration tests for transactionPollingTimeout (transactionPollingTimeout might not work as documented #3513)

Changed

• Websocket package from @web3-js/websocket@1.0.29 to websocket@1.0.31 (Update websocket fork (node-gyp err output on Windows / Node 12) #3371)
• Upgrade @web3-js/scrypt-shim@0.1.0 to scrypt-js@3.0.1
• sendSignedTransaction revert handling synthesizes tx without network call (Improve sendSignedTransaction revert reason fetching #3457)
• Make docs grammar more idiomatic, normalize punctuation (Docs: small typos and grammar fixes #3543)

Fixed

• Size property de-referencing crash when calling web3.eth.clearSubscriptions (Cannot read property 'size' of undefined #3527)
• Abi param encoding for tuple arrays ("coder.coders undefined" (Cannot read property 'forEach' of undefined) #3538)
• account.hashMessage with non-ASCII characters (account.hashMessage is incorrect with non-ASCII characters #3523)
• Subscription support check in method confirmations loop (Checking if a provider supports subscriptions by checking for "on" property often breaks #3432)
• TS bindings for handleRevert added (Add ts bindings for handleRevert #3545)
• Docs: spelling of pre-defined block number (Fix spelling of pre-defined block number #3539)
• Docs: missing defaultBlock param option in method.call description (Document defaultBlock in methods.myMethod.call #3558)

Compare View

v1.2.8 -> v1.2.9-rc.0

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-all and tested the resulting files from dist folder in a browser.
• I have updated the CHANGELOG.md file in the root folder.
• I have tested my code on the live network.

[coveralls]

Coverage remained the same at 89.855% when pulling 0e7ee33 on release/1.2.9 into f52bf55 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	✅
gnosis/dex-react	TS React app ~200 tests + webpack build + jest	✅
synthetix	~1000 units	✅

---

Live test from CI at http://sudden-playground.surge.sh/

edit from ryan: we have changed from surge to netlify in #3575

[cgewecke]

LGTM!