Merge branch '1.x' into al/4174-webpack

web3 · Sep 22, 2021 · 9422c1e · 9422c1e
2 parents 622698a + 40974e9
commit 9422c1e
Show file tree

Hide file tree

Showing 60 changed files with 41,890 additions and 18,812 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -432,13 +432,12 @@ Released with 1.0.0-beta.37 code base.
 - Remove transaction `type` defaulting for `eth.sendTransaction`, `eth.sendRawTransaction` (#4241)
 - `type: 0x0` was being added to legacy transaction when using `eth.signTransaction` (#4241)
 
-## [Unreleased]
-
 ## [1.5.3]
 
 ### Fixed
 
 - Unable to send legacy transaction if network supported EIP-1559 (#4277)
+- Fixed bug in sending transaction with providers not support "newBlockHeaders" event (#3891)
 
 ### Changed
 
@@ -448,4 +447,12 @@ Released with 1.0.0-beta.37 code base.
 - Dropped build tests in CI for Node v8 and v10, and added support for Node v14
 - Change default value for `maxPriorityFeePerGas` from `1 Gwei` to `2.5 Gwei` (#4284)
 - Fixed bug in signTransaction (#4295) 
-- Updated readme to include webpack 5 angular support instructions (#4174)
+- Updated readme to include Webpack 5 angular support instructions (#4174)
+- Introduced new configuration "blockHeaderTimeout" for waiting of block headers for transaction receipt (#3891)
+- Fixed bug in signTransaction (#4295)
+
+## [Unreleased]
+
+## [1.5.4]
+### Changed
+- Not considering `tx.chainId` if `tx.common.customChain.chainId` is provided for `web3.eth.accounts.signTransaction` function (#4293)
diff --git a/dist/web3.min.js b/dist/web3.min.js
diff --git a/dist/web3.min.js.map b/dist/web3.min.js.map
diff --git a/docs/web3-eth-accounts.rst b/docs/web3-eth-accounts.rst
@@ -151,7 +151,7 @@ Parameters
 
 1. ``tx`` - ``Object``: The transaction object as follows:
  - ``nonce`` - ``String``: (optional) The nonce to use when signing this transaction. Default will use :ref:`web3.eth.getTransactionCount() <eth-gettransactioncount>`.
- - ``chainId`` - ``String``: (optional) The chain id to use when signing this transaction. Default will use :ref:`web3.eth.net.getId() <net-getid>`.
+ - ``chainId`` - ``String``: (optional) The chain id to use when signing this transaction. Default will use :ref:`web3.eth.net.getId() <net-getid>`. Web3 will ignore this field if `common.customChain.chainId` is provided.
  - ``to`` - ``String``: (optional) The recevier of the transaction, can be empty when deploying a contract.
  - ``data`` - ``String``: (optional) The call data of the transaction, can be empty for simple value transfers.
  - ``value`` - ``String``: (optional) The value of the transaction in wei.

diff --git a/docs/web3-eth-contract.rst b/docs/web3-eth-contract.rst
@@ -317,6 +317,27 @@ Returns
 
 ------------------------------------------------------------------------------
 
+.. _eth-contract-blockHeaderTimeout:
+
+blockHeaderTimeout
+=====================
+
+.. code-block:: javascript
+
+ web3.eth.Contract.blockHeaderTimeout
+ contract.blockHeaderTimeout // on contract instance
+
+The ``blockHeaderTimeout`` is used over socket-based connections. This option defines the amount seconds it should wait for "newBlockHeaders" event before falling back to polling to fetch transaction receipt.
+
+
+-------
+Returns
+-------
+
+``number``: The current value of blockHeaderTimeout (default: 10 seconds)
+
+------------------------------------------------------------------------------
+
 .. _eth-contract-module-transactionconfirmationblocks:
 
 transactionConfirmationBlocks

diff --git a/docs/web3-eth.rst b/docs/web3-eth.rst
@@ -373,6 +373,40 @@ Example
  web3.eth.transactionBlockTimeout = 100;
 
 
+------------------------------------------------------------------------------
+
+.. _eth-contract-blockHeaderTimeout:
+
+blockHeaderTimeout
+=====================
+
+.. code-block:: javascript
+
+ web3.eth.Contract.blockHeaderTimeout
+ contract.blockHeaderTimeout // on contract instance
+
+The ``blockHeaderTimeout`` is used over socket-based connections. This option defines the amount seconds it should wait for "newBlockHeaders" event before falling back to polling to fetch transaction receipt.
+
+
+-------
+Returns
+-------
+
+``number``: The current value of blockHeaderTimeout (default: 10 seconds)
+
+-------
+Example
+-------
+
+.. code-block:: javascript
+
+ web3.eth.blockHeaderTimeout;
+ > 5
+
+ // set the transaction confirmations blocks
+ web3.eth.blockHeaderTimeout = 10;
+
+
 ------------------------------------------------------------------------------
 
 .. _web3-module-transactionconfirmationblocks:

diff --git a/lerna.json b/lerna.json
@@ -1,5 +1,5 @@
 {
- "version": "1.5.2",
+ "version": "1.5.3",
  "lerna": "2.0.0",
  "command": {
  "init": {