Fixed documentation for web3.eth.accounts.signTransaction (#5121)

* Fixed documentation for web3.eth.accounts.signTransaction Fixed documentation for maxPriorityFeePerGas and maxFeePerGas in web3.eth.accounts.signTransaction * Added entry to CHANGELOG.md
web3 · Jun 28, 2022 · 8f05f19 · 8f05f19
1 parent 5b10473
commit 8f05f19
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -565,5 +565,8 @@ Released with 1.0.0-beta.37 code base.
 
 ## [1.7.5]
 
+### Added
+- Documentation details about `maxFeePerGas` and `maxPriorityFeePerGas` (#5121)
+
 ### Fixed
 -  Fix typos in web3-eth-accounts.rst & TESTING.md (#5047)
diff --git a/docs/web3-eth-accounts.rst b/docs/web3-eth-accounts.rst
@@ -156,6 +156,8 @@ Parameters
     - ``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.
     - ``gasPrice`` - ``String``: (optional) The gas price set by this transaction, if empty, it will use :ref:`web3.eth.getGasPrice() <eth-gasprice>`
+    - ``maxFeePerGas`` - ``Number|String|BN``: (optional, defaulted to ``(2 * block.baseFeePerGas) + maxPriorityFeePerGas``) The maximum fee per gas that the transaction is willing to pay in total. If ``gasPrice`` is also set, ``maxFeePerGas`` will be set equal to it, regardless of this value.
+    - ``maxPriorityFeePerGas`` - ``Number|String|BN`` (optional, defaulted to ``2.5 Gwei``) The maximum fee per gas to give miners to incentivize them to include the transaction (Priority fee). If ``gasPrice`` is also set, ``maxPriorityFeePerGas`` will be set equal to it, regardless of this value.
     - ``gas`` - ``String``: The gas provided by the transaction.
     - ``chain`` - ``String``: (optional) Defaults to ``mainnet``.
     - ``hardfork`` - ``String``: (optional) Defaults to ``berlin``.