fixes defaultBlock property handling

CHANGELOG.md

@@ -109,3 +109,5 @@ Released with 1.0.0-beta.37 code base.
 - ``getPendingTransactions`` added to web3-eth package (#3239)
 
 ### Fixed
+
+- ``defaultBlock`` property handling fixed (#3247)

docs/web3-eth-contract.rst

@@ -140,10 +140,11 @@ Property
 
 The default block parameters can be one of the following:
 
-- ``Number``: A block number
+- ``Number|BN|BigNumber``: A block number
 - ``"genesis"`` - ``String``: The genesis block
 - ``"latest"`` - ``String``: The latest block (current head of the blockchain)
 - ``"pending"`` - ``String``: The currently mined block (including pending transactions)
+- ``"earliest"`` - ``String``: The genesis block
 
 Default is ``"latest"``
 

docs/web3-eth.rst

@@ -187,10 +187,11 @@ Property
 
 Default block parameters can be one of the following:
 
-- ``Number``: A block number
+- ``Number|BN|BigNumber``: A block number
 - ``"genesis"`` - ``String``: The genesis block
 - ``"latest"`` - ``String``: The latest block (current head of the blockchain)
 - ``"pending"`` - ``String``: The currently mined block (including pending transactions)
+- ``"earliest"`` - ``String``: The genesis block
 
 Default is ``"latest"``
 

packages/web3-core-helpers/src/formatters.js

@@ -95,27 +95,32 @@ var isPredefinedBlockNumber = function (blockNumber) {
  */
 var inputDefaultBlockNumberFormatter = function (blockNumber) {
     if (this && (blockNumber === undefined || blockNumber === null)) {
-        return this.defaultBlock;
-    }
-    if (blockNumber === 'genesis' || blockNumber === 'earliest') {
-        return '0x0';
+        return inputBlockNumberFormatter(this.defaultBlock);
     }
+
     return inputBlockNumberFormatter(blockNumber);
 };
 
 /**
  * Returns the given block number as hex string or the predefined block number 'latest', 'pending', 'earliest', 'genesis'
  *
- * @param {String|Number|undefined} blockNumber
+ * @param {String|Number|BN|BigNumber} blockNumber
  *
- * @returns {String|Number|BN|BigNumber}
+ * @returns {String}
  */
 var inputBlockNumberFormatter = function (blockNumber) {
     if (blockNumber === undefined) {
         return undefined;
-    } else if (isPredefinedBlockNumber(blockNumber)) {
+    }
+
+    if (isPredefinedBlockNumber(blockNumber)) {
         return blockNumber;
     }
+
+    if (blockNumber === 'genesis') {
+        return '0x0';
+    }
+
     return (utils.isHexStrict(blockNumber)) ? ((_.isString(blockNumber)) ? blockNumber.toLowerCase() : blockNumber) : utils.numberToHex(blockNumber);
 };
 

packages/web3-core/types/index.d.ts

@@ -408,7 +408,7 @@ export interface LogsOptions {
     topics?: Array<string | string[] | null>;
 }
 
-export type BlockNumber = string | number | BN | BigNumber | 'latest' | 'pending' | 'earliest';
+export type BlockNumber = string | number | BN | BigNumber | 'latest' | 'pending' | 'earliest' | 'genesis';
 
 export type provider =
     | HttpProvider

packages/web3-eth-contract/types/index.d.ts

@@ -31,7 +31,7 @@ export class Contract {
     private _address: string;
     private _jsonInterface: AbiItem[];
     defaultAccount: string | null;
-    defaultBlock: string | number;
+    defaultBlock: BlockNumber;
     defaultCommon: Common;
     defaultHardfork: hardfork;
     defaultChain: chain;

packages/web3-eth-contract/types/tests/contract-test.ts

@@ -25,7 +25,7 @@ const contract = new Contract([]);
 // $ExpectType string | null
 contract.defaultAccount;
 
-// $ExpectType string | number
+// $ExpectType BlockNumber
 contract.defaultBlock;
 
 // $ExpectType Common

packages/web3-eth/types/index.d.ts

@@ -80,7 +80,7 @@ export class Eth {
     readonly givenProvider: any;
     static readonly givenProvider: any;
     defaultAccount: string | null;
-    defaultBlock: string | number;
+    defaultBlock: BlockNumber;
     defaultCommon: Common;
     defaultHardfork: hardfork;
     defaultChain: chain;

packages/web3-eth/types/tests/eth.tests.ts

@@ -43,10 +43,16 @@ const eth_empty = new Eth();
 // $ExpectType Eth
 const eth = new Eth('http://localhost:8545');
 
+// $ExpectType provider
+eth.currentProvider;
+
+// $ExpectType any
+eth.givenProvider;
+
 // $ExpectType string | null
 eth.defaultAccount;
 
-// $ExpectType string | number
+// $ExpectType BlockNumber
 eth.defaultBlock;
 
 // $ExpectType Common
@@ -123,18 +129,6 @@ eth.subscribe(
     (error: Error, transactionHash: string) => {}
 );
 
-// $ExpectType provider
-eth.currentProvider;
-
-// $ExpectType any
-eth.givenProvider;
-
-// $ExpectType string | null
-eth.defaultAccount;
-
-// $ExpectType string | number
-eth.defaultBlock;
-
 // $ExpectType boolean
 eth.setProvider('https://localhost:2100');
 

test/formatters.inputDefaultBlockFormatter.js

@@ -6,7 +6,7 @@ var tests = [
     { value: 'genesis', expected: '0x0' },
     { value: 'latest', expected: 'latest' },
     { value: 'pending', expected: 'pending' },
-    { value: 'earliest', expected: '0x0' },
+    { value: 'earliest', expected: 'earliest' },
     { value: 1, expected: '0x1' },
     { value: '0x1', expected: '0x1' }
 ];