Merge conflict

spacesailor24 · spacesailor24 · commit 68222febfadd · 2021-07-23T14:36:56.000-10:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -405,8 +405,16 @@ Released with 1.0.0-beta.37 code base.
 ### Added
 
 - London transaction support (#4155)
+- RPC support `eth_feehistory` call
+
+### Changed
+ - Grammar fix (#4088) and updated Swarm (#4151)and Whisper doc links (#4170)
+ - Removed deprecation notice for HttpProvider (#4008)
+ - Nonce added to send options in documentation and types (#4052)
+ - Updated Solidity example to modern syntax (#4147)
+ - Changing web3 connection example from lets to const (#3967)
+ - Updated the documentation for the transaction object to include EIP-2718 and EIP-1559 options
 
 ## [Unreleased]
 
 ## [1.5.1]
-
diff --git a/docs/callbacks-promises-events.rst b/docs/callbacks-promises-events.rst
@@ -9,7 +9,7 @@ To help web3 integrate into all kinds of projects with different standards we pr
 Most web3.js objects allow a callback as the last parameter, as well as returning promises to chain functions.
 
 Ethereum as a blockchain has different levels of finality and therefore needs to return multiple "stages" of an action.
-To cope with requirement we return a "promiEvent" for functions like ``web3.eth.sendTransaction`` or contract methods.
+To cope with this requirement we return a "promiEvent" for functions like ``web3.eth.sendTransaction`` or contract methods.
 This "promiEvent" is a promise combined with an event emitter to allow acting on different stages of action on the blockchain, like a transaction.
 
 PromiEvents work like a normal promises with added ``on``, ``once`` and ``off`` functions.
diff --git a/docs/getting-started.rst b/docs/getting-started.rst
@@ -37,6 +37,6 @@ If this property is ``null`` you should connect to a remote/local node.
 
     // In Node.js use: const Web3 = require('web3');
 
-    let web3 = new Web3(Web3.givenProvider || "ws://localhost:8545");
+    const web3 = new Web3(Web3.givenProvider || "ws://localhost:8545");
 
 That's it! now you can use the ``web3`` object.
diff --git a/docs/glossary.rst b/docs/glossary.rst
@@ -51,47 +51,51 @@ Example
 
 .. code-block:: javascript
 
+    pragma solidity ^0.8.4;
     contract Test {
         uint a;
-        address d = 0x12345678901234567890123456789012;
+        address d = 0xdCad3a6d3569DF655070DEd06cb7A1b2Ccd1D3AF;
 
-        function Test(uint testInt)  { a = testInt;}
+        constructor(uint testInt)  { a = testInt;}
 
         event Event(uint indexed b, bytes32 c);
 
         event Event2(uint indexed b, bytes32 c);
 
-        function foo(uint b, bytes32 c) returns(address) {
-            Event(b, c);
+        function foo(uint b, bytes32 c) public returns(address) {
+            emit Event(b, c);
             return d;
         }
     }
 
+
     // would result in the JSON:
-    [{
-        "type":"constructor",
-        "payable":false,
-        "stateMutability":"nonpayable"
-        "inputs":[{"name":"testInt","type":"uint256"}],
-      },{
-        "type":"function",
-        "name":"foo",
-        "constant":false,
-        "payable":false,
-        "stateMutability":"nonpayable",
-        "inputs":[{"name":"b","type":"uint256"}, {"name":"c","type":"bytes32"}],
-        "outputs":[{"name":"","type":"address"}]
-      },{
-        "type":"event",
-        "name":"Event",
-        "inputs":[{"indexed":true,"name":"b","type":"uint256"}, {"indexed":false,"name":"c","type":"bytes32"}],
-        "anonymous":false
-      },{
-        "type":"event",
-        "name":"Event2",
-        "inputs":[{"indexed":true,"name":"b","type":"uint256"},{"indexed":false,"name":"c","type":"bytes32"}],
-        "anonymous":false
-    }]
+    [
+        {
+            "type": "constructor"
+            "stateMutability": "nonpayable",
+            "inputs": [{"internalType":"uint256","name":"testInt","type":"uint256"}],
+        },
+        {
+            "type": "event"
+            "name": "Event",
+            "inputs": [{"indexed":true,"internalType":"uint256","name":"b","type":"uint256"},{"indexed":false,"internalType":"bytes32","name":"c","type":"bytes32"}],
+            "anonymous": false,
+        },
+        {
+            "type": "event"
+            "name": "Event2",
+            "inputs": [{"indexed":true,"internalType":"uint256","name":"b","type":"uint256"},{"indexed":false,"internalType":"bytes32","name":"c","type":"bytes32"}],
+            "anonymous": false,
+        },
+        {
+            "type": "function"
+            "name": "foo",
+            "stateMutability": "nonpayable",
+            "inputs": [{"internalType":"uint256","name":"b","type":"uint256"},{"internalType":"bytes32","name":"c","type":"bytes32"}],
+            "outputs": [{"internalType":"address","name":"","type":"address"}],
+        }
+    ]
 
 
 ------------------------------------------------------------------------------
diff --git a/docs/include_package-core.rst b/docs/include_package-core.rst
@@ -84,7 +84,7 @@ Value
 
 ``Object`` with the following providers:
 
-    - ``Object`` - ``HttpProvider``: The HTTP provider is **deprecated**, as it won't work for subscriptions.
+    - ``Object`` - ``HttpProvider``: HTTP provider, does not support subscriptions.
     - ``Object`` - ``WebsocketProvider``: The Websocket provider is the standard for usage in legacy browsers.
     - ``Object`` - ``IpcProvider``: The IPC provider is used node.js dapps when running a local node. Gives the most secure connection.
 
diff --git a/docs/web3-bzz.rst b/docs/web3-bzz.rst
@@ -8,7 +8,7 @@ web3.bzz
 
 
 The ``web3-bzz`` package allows you to interact with swarm, the decentralized file store.
-For more see the `Swarm Docs <http://swarm-guide.readthedocs.io/en/latest/>`_.
+For more see the `Swarm Docs <https://docs.ethswarm.org/docs/>`_.
 
 
 .. code-block:: javascript
diff --git a/docs/web3-eth-contract.rst b/docs/web3-eth-contract.rst
@@ -837,6 +837,8 @@ Parameters
     * ``gasPrice`` - ``String`` (optional): The gas price in wei to use for this transaction.
     * ``gas`` - ``Number`` (optional): The maximum gas provided for this transaction (gas limit).
     * ``value`` - ``Number|String|BN|BigNumber``(optional): The value transferred for the transaction in wei.
+    * ``nonce`` - ``Number`` (optional): the nonce number of transaction
+
 2. ``callback`` - ``Function`` (optional): This callback will be fired first with the "transactionHash", or with an error object as the first argument.
 
 -------
diff --git a/docs/web3-eth.rst b/docs/web3-eth.rst
@@ -236,8 +236,10 @@ The default hardfork property can be one of the following:
 - ``"constantinople"`` - ``String``
 - ``"petersburg"`` - ``String``
 - ``"istanbul"`` - ``String``
+- ``"berlin"`` - ``String``
+- ``"london"`` - ``String``
 
-Default is ``"petersburg"``
+Default is ``"london"``
 
 
 -------
@@ -247,7 +249,7 @@ Example
 .. code-block:: javascript
 
     web3.eth.defaultHardfork;
-    > "petersburg"
+    > "london"
 
     // set the default block
     web3.eth.defaultHardfork = 'istanbul';
@@ -318,7 +320,7 @@ The default common property does contain the following ``Common`` object:
     - ``networkId`` - ``number``: Network ID of the custom chain
     - ``chainId`` - ``number``: Chain ID of the custom chain
 - ``baseChain`` - ``string``: (optional) ``mainnet``, ``goerli``, ``kovan``, ``rinkeby``, or ``ropsten``
-- ``hardfork`` - ``string``: (optional) ``chainstart``, ``homestead``, ``dao``, ``tangerineWhistle``, ``spuriousDragon``, ``byzantium``, ``constantinople``, ``petersburg``, or ``istanbul``
+- ``hardfork`` - ``string``: (optional) ``chainstart``, ``homestead``, ``dao``, ``tangerineWhistle``, ``spuriousDragon``, ``byzantium``, ``constantinople``, ``petersburg``, ``istanbul``, ``berlin``, or ``london``
 
 
 Default is ``undefined``.
@@ -714,6 +716,43 @@ Example
 
 ------------------------------------------------------------------------------
 
+.. _eth-feehistory:
+
+
+getFeeHistory
+=====================
+
+.. code-block:: javascript
+
+    web3.eth.getFeeHistory(blockCount, newestBlock, rewardPercentiles, [callback])
+
+Transaction fee history
+Returns base fee per gas and transaction effective priority fee per gas history for the requested block range if available. 
+The range between headBlock-4 and headBlock is guaranteed to be available while retrieving data from the pending block and older
+history are optional to support. For pre-EIP-1559 blocks the gas prices are returned as rewards and zeroes are returned for the base fee per gas.
+
+----------
+Parameters
+----------
+
+1. ``String|Number|BN|BigNumber`` - Number of blocks in the requested range. Between 1 and 1024 blocks can be requested in a single query. Less than requested may be returned if not all blocks are available.
+2. ``String|Number|BN|BigNumber`` - Highest number block of the requested range.
+3. ``Array of numbers`` - A monotonically increasing list of percentile values to sample from each block's effective priority fees per gas in ascending order, weighted by gas used. Example: `["0", "25", "50", "75", "100"]` or `["0", "0.5", "1", "1.5", "3", "80"]`
+4. ``Function`` - (optional) Optional callback, returns an error object as first parameter and the result as second.
+
+-------
+Returns
+-------
+
+``Promise`` returns ``Object`` - Fee history for the returned block range. The object:
+
+- ``Number`` oldestBlock  - Lowest number block of the returned range.
+- ``Array of strings`` baseFeePerGas  - An array of block base fees per gas. This includes the next block after the newest of the returned range, because this value can be derived from the newest block. Zeroes are returned for pre-EIP-1559 blocks.
+- ``Array of numbers`` gasUsedRatio  - An array of block gas used ratios. These are calculated as the ratio of gasUsed and gasLimit.
+- ``Array of string arrays`` reward  - An array of effective priority fee per gas data points from a single block. All zeroes are returned if the block is empty.
+
+------------------------------------------------------------------------------
+
 
 getAccounts
 =====================
@@ -1419,17 +1458,21 @@ Parameters
     - ``value`` - ``Number|String|BN|BigNumber``: (optional) The value transferred for the transaction in :ref:`wei <what-is-wei>`, also the endowment if it's a contract-creation transaction.
     - ``gas``  - ``Number``: (optional, default: To-Be-Determined) The amount of gas to use for the transaction (unused gas is refunded).
     - ``gasPrice`` - ``Number|String|BN|BigNumber``: (optional) The price of gas for this transaction in :ref:`wei <what-is-wei>`, defaults to :ref:`web3.eth.gasPrice <eth-gasprice>`.
+    - ``type`` - ``Number|String|BN|BigNumber``: (optional) A positive unsigned 8-bit number between 0 and 0x7f that represents the type of the transaction. 
+    - ``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
+    - ``maxPriorityFeePerGas`` - ``Number|String|BN`` (optional, defaulted to ``1 Gwei``) The maximum fee per gas to give miners to incentivize them to include the transaction (Priority fee)
+    - ``accessList`` - ``List of hexstrings`` (optional) a list of addresses and storage keys that the transaction plans to access
     - ``data`` - ``String``: (optional) Either a `ABI byte string <http://solidity.readthedocs.io/en/latest/abi-spec.html>`_ containing the data of the function call on a contract, or in the case of a contract-creation transaction the initialisation code.
     - ``nonce`` - ``Number``: (optional) Integer of the nonce. This allows to overwrite your own pending transactions that use the same nonce.
     - ``chain`` - ``String``: (optional) Defaults to ``mainnet``.
-    - ``hardfork`` - ``String``: (optional) Defaults to ``petersburg``.
+    - ``hardfork`` - ``String``: (optional) Defaults to ``london``.
     - ``common`` - ``Object``: (optional) The common object
         - ``customChain`` - ``Object``: The custom chain properties
             - ``name`` - ``string``: (optional) The name of the chain
             - ``networkId`` - ``number``: Network ID of the custom chain
             - ``chainId`` - ``number``: Chain ID of the custom chain
         - ``baseChain`` - ``string``: (optional) ``mainnet``, ``goerli``, ``kovan``, ``rinkeby``, or ``ropsten``
-        - ``hardfork`` - ``string``: (optional) ``chainstart``, ``homestead``, ``dao``, ``tangerineWhistle``, ``spuriousDragon``, ``byzantium``, ``constantinople``, ``petersburg``, or ``istanbul``
+        - ``hardfork`` - ``string``: (optional) ``chainstart``, ``homestead``, ``dao``, ``tangerineWhistle``, ``spuriousDragon``, ``byzantium``, ``constantinople``, ``petersburg``, ``istanbul``, ``berlin``, or ``london``
 
 2. ``callback`` - ``Function``: (optional) Optional callback, returns an error object as first parameter and the result as second.
 
diff --git a/docs/web3-shh.rst b/docs/web3-shh.rst
@@ -5,7 +5,7 @@ web3.shh
 ========
 
 
-The ``web3-shh`` package allows you to interact with the whisper protocol for broadcasting. For more see `Whisper Overview <https://github.com/ethereum/go-ethereum/wiki/Whisper>`_.
+The ``web3-shh`` package allows you to interact with the whisper protocol for broadcasting. For more see `Whisper Overview <https://eth.wiki/concepts/whisper/whisper-overview>`_.
 
 
 .. code-block:: javascript
diff --git a/packages/web3-eth-contract/types/index.d.ts b/packages/web3-eth-contract/types/index.d.ts
@@ -125,6 +125,7 @@ export interface SendOptions {
     gasPrice?: string;
     gas?: number;
     value?: number | string | BN;
+    nonce?: number;
 }
 
 export interface EstimateGasOptions {
diff --git a/packages/web3-eth/src/index.js b/packages/web3-eth/src/index.js
@@ -385,6 +385,12 @@ var Eth = function Eth() {
             params: 0,
             outputFormatter: formatter.outputBigNumberFormatter
         }),
+        new Method({
+            name: 'getFeeHistory',
+            call: 'eth_feeHistory',
+            params: 3,
+            inputFormatter: [utils.toNumber, utils.toHex, function(value) {return value}]
+        }),
         new Method({
             name: 'getAccounts',
             call: 'eth_accounts',
diff --git a/packages/web3-eth/types/index.d.ts b/packages/web3-eth/types/index.d.ts
@@ -149,6 +149,13 @@ export class Eth {
         callback?: (error: Error, gasPrice: string) => void
     ): Promise<string>;
 
+    getFeeHistory(
+        blockCount: number | BigNumber | BN | string,
+        lastBlock: number | BigNumber | BN | string,
+        rewardPercentiles: number[],
+        callback?: (error: Error, feeHistory: FeeHistoryResult) => void
+    ): Promise<FeeHistoryResult>;
+
     getAccounts(
         callback?: (error: Error, accounts: string[]) => void
     ): Promise<string[]>;
@@ -439,3 +446,10 @@ export interface StorageProof {
     value: string;
     proof: string[];
 }
+
+export interface FeeHistoryResult {
+    baseFeePerGas: string[];
+    gasUsedRatio: number[];
+    oldestBlock: number;
+    reward: string[][];
+}
diff --git a/packages/web3-eth/types/tests/eth.tests.ts b/packages/web3-eth/types/tests/eth.tests.ts
@@ -32,7 +32,8 @@ import {
     TransactionConfig,
     hardfork,
     Common,
-    chain
+    chain,
+    FeeHistoryResult
 } from 'web3-eth';
 import BN = require('bn.js');
 import BigNumber from 'bignumber.js';
@@ -178,6 +179,15 @@ eth.getGasPrice();
 // $ExpectType Promise<string>
 eth.getGasPrice((error: Error, gasPrice: string) => {});
 
+// $ExpectType Promise<FeeHistoryResult>
+eth.getFeeHistory(
+    4, "0xA30953", []
+);
+// $ExpectType Promise<FeeHistoryResult>
+eth.getFeeHistory(
+    4, "0xA30953", [],
+    (error: Error, feeHistory: FeeHistoryResult) => {});
+
 // $ExpectType Promise<string[]>
 eth.getAccounts();
 // $ExpectType Promise<string[]>
diff --git a/packages/web3-utils/src/index.js b/packages/web3-utils/src/index.js
@@ -436,5 +436,7 @@ module.exports = {
     isTopicInBloom: utils.isTopicInBloom,
     isInBloom: utils.isInBloom,
 
-    compareBlockNumbers: compareBlockNumbers
+    compareBlockNumbers: compareBlockNumbers,
+
+    toNumber: utils.toNumber
 };
diff --git a/packages/web3-utils/src/utils.js b/packages/web3-utils/src/utils.js
@@ -521,6 +521,17 @@ var sha3Raw = function(value) {
     return value;
 };
 
+/**
+ * Auto converts any given value into it's hex representation,
+ * then converts hex to number.
+ *
+ * @method toNumber
+ * @param {String|Number|BN} value
+ * @return {Number}
+ */
+var toNumber = function(value) {
+    return typeof value === 'number' ? value : hexToNumber(toHex(value));
+}
 
 module.exports = {
     BN: BN,
@@ -550,5 +561,6 @@ module.exports = {
     rightPad: rightPad,
     toTwosComplement: toTwosComplement,
     sha3: sha3,
-    sha3Raw: sha3Raw
+    sha3Raw: sha3Raw,
+    toNumber: toNumber
 };
diff --git a/packages/web3-utils/types/index.d.ts b/packages/web3-utils/types/index.d.ts
@@ -122,6 +122,7 @@ export function testAddress(bloom: string, address: string): boolean;
 export function testTopic(bloom: string, topic: string): boolean;
 export function getSignatureParameters(signature: string): {r: string; s: string; v: number};
 export function stripHexPrefix(str: string): string;
+export function toNumber(value: number | string | BN): number;
 
 // interfaces
 export interface Utils {
@@ -178,6 +179,7 @@ export interface Utils {
     testTopic(bloom: string, topic: string): boolean;
     getSignatureParameters(signature: string): {r: string; s: string; v: number};
     stripHexPrefix(str: string): string;
+    toNumber(value: number | string | BN): number;
 }
 
 export interface Units {
diff --git a/packages/web3-utils/types/tests/to-number-test.ts b/packages/web3-utils/types/tests/to-number-test.ts
diff --git a/test/eth.feeHistory.js b/test/eth.feeHistory.js
diff --git a/test/eth_methods.js b/test/eth_methods.js
diff --git a/test/utils.hexToNumber.js b/test/utils.hexToNumber.js
diff --git a/test/utils.toNumber.js b/test/utils.toNumber.js

Original file line number	Diff line number	Diff line change
`@@ -125,6 +125,7 @@ export interface SendOptions {`
`125`	`125`	`gasPrice?: string;`
`126`	`126`	`gas?: number;`
`127`	`127`	`value?: number \| string \| BN;`
	`128`	`+ nonce?: number;`
`128`	`129`	`}`
`129`	`130`
`130`	`131`	`export interface EstimateGasOptions {`