Web3Eth TODOs

package.json

@@ -45,7 +45,7 @@
 	},
 	"devDependencies": {
 		"@types/node": "*",
-		"eslint": "^8.3.0",
+		"eslint": "^7.32.0",
 		"husky": "^7.0.4",
 		"jest": "^27.3.1",
 		"lerna": "^4.0.0",

packages/web3-common/package.json

@@ -31,7 +31,7 @@
 		"@types/jest": "^27.0.3",
 		"@typescript-eslint/eslint-plugin": "^5.4.0",
 		"@typescript-eslint/parser": "^5.4.0",
-		"eslint": "^8.3.0",
+		"eslint": "^7.32.0",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-config-web3-base": "0.1.0",
 		"eslint-plugin-import": "^2.25.3",

packages/web3-common/src/eth_execution_api.ts

@@ -1,5 +1,6 @@
 import {
 	Address,
+	BlockNumberOrTag,
 	HexString,
 	HexString256Bytes,
 	HexString8Bytes,
@@ -8,6 +9,8 @@ import {
 	HexStringSingleByte,
 	Uint,
 	Uint256,
+	Topic,
+	Filter,
 } from 'web3-utils';
 
 // The types are generated manually by referring to following doc
@@ -20,9 +23,8 @@ export interface AccessListEntry {
 export type AccessList = AccessListEntry[];
 export type TransactionHash = HexString;
 export type Uncles = HexString32Bytes[];
-export type BlockTag = 'earliest' | 'latest' | 'pending';
-export type BlockNumberOrTag = Uint | BlockTag;
 
+// TODO Should probably support EIP-2930 and EIP-1559
 export interface TransactionCall {
 	readonly from?: Address;
 	readonly to: Address;
@@ -118,14 +120,11 @@ export interface Block {
 	readonly totalDifficulty: Uint;
 	readonly baseFeePerGas?: Uint;
 	readonly size: Uint;
-	readonly transactions: TransactionHash[] | TransactionSigned[];
+	readonly transactions: TransactionHash[] | TransactionInfo[];
 	readonly uncles: Uncles;
 	readonly hash: HexString32Bytes | null;
 }
 
-// https://github.com/ethereum/execution-apis/blob/main/src/schemas/filter.json#L59
-export type Topic = HexString256Bytes;
-
 // https://github.com/ethereum/execution-apis/blob/main/src/schemas/receipt.json#L2
 export interface Log {
 	readonly removed?: boolean;
@@ -142,7 +141,7 @@ export interface Log {
 // https://github.com/ethereum/execution-apis/blob/main/src/schemas/receipt.json#L44
 export interface ReceiptInfo {
 	readonly transactionHash: HexString32Bytes;
-	readonly transactionIndex: HexString32Bytes;
+	readonly transactionIndex: Uint;
 	readonly blockHash: HexString32Bytes;
 	readonly blockNumber: Uint;
 	readonly from: Address;
@@ -168,14 +167,6 @@ export interface FeeHistoryResult {
 	readonly reward: number[][];
 }
 
-// https://github.com/ethereum/execution-apis/blob/main/src/schemas/filter.json#L28
-export interface Filter {
-	readonly fromBlock?: BlockNumberOrTag;
-	readonly toBlock?: BlockNumberOrTag;
-	readonly address?: Address | Address[];
-	readonly topics?: (Topic | Topic[] | null)[];
-}
-
 // https://github.com/ethereum/execution-apis/blob/main/src/schemas/filter.json#L2
 export type FilterResults = HexString32Bytes[] | Log[];
 

packages/web3-common/src/formatters.ts

@@ -11,6 +11,7 @@ import {
 	toNumber,
 	toUtf8,
 	utf8ToHex,
+	isBlockTag,
 } from 'web3-utils';
 import { FormatterError } from './errors';
 import {
@@ -28,7 +29,6 @@ import {
 	Mutable,
 	LogsInput,
 	LogsOutput,
-	PredefinedBlockNumbers,
 } from './types';
 
 /**
@@ -50,14 +50,6 @@ export const outputProofFormatter = (proof: Proof): Proof => ({
  */
 export const outputBigIntegerFormatter = (number: Numbers) => toNumber(number);
 
-/**
- * Returns true if the given blockNumber is 'latest', 'pending', or 'earliest.
- */
-export const isPredefinedBlockNumber = (blockNumber: string) =>
-	PredefinedBlockNumbers.LATEST === blockNumber ||
-	PredefinedBlockNumbers.PENDING === blockNumber ||
-	PredefinedBlockNumbers.EARLIEST === blockNumber;
-
 /**
  * Returns the given block number as hex string or the predefined block number 'latest', 'pending', 'earliest', 'genesis'
  */
@@ -66,15 +58,14 @@ export const inputBlockNumberFormatter = (blockNumber: Numbers | undefined) => {
 		return undefined;
 	}
 
-	if (typeof blockNumber === 'string' && isPredefinedBlockNumber(blockNumber)) {
+	if (typeof blockNumber === 'string' && isBlockTag(blockNumber)) {
 		return blockNumber;
 	}
 
 	if (blockNumber === 'genesis') {
 		return '0x0';
 	}
 
-	// eslint-disable-next-line no-nested-ternary
 	if (typeof blockNumber === 'string' && isHexStrict(blockNumber)) {
 		return blockNumber.toLowerCase();
 	}

packages/web3-common/src/types.ts

@@ -212,12 +212,6 @@ export interface SyncOutput {
 	readonly pulledStates?: bigint | number;
 }
 
-export enum PredefinedBlockNumbers {
-	LATEST = 'latest',
-	PENDING = 'pending',
-	EARLIEST = 'earliest',
-}
-
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type Web3APISpec = Record<string, (...params: any) => any>;
 export type Web3APIMethod<T extends Web3APISpec> = string & keyof T;

packages/web3-common/test/unit/formatters.test.ts

@@ -1,12 +1,10 @@
 import * as utils from 'web3-utils';
 
-import { PredefinedBlockNumbers } from '../../src/types';
 import {
 	inputAddressFormatter,
 	inputBlockNumberFormatter,
 	inputDefaultBlockNumberFormatter,
 	inputPostFormatter,
-	isPredefinedBlockNumber,
 	outputBigIntegerFormatter,
 	outputBlockFormatter,
 	outputLogFormatter,
@@ -71,36 +69,17 @@ describe('formatters', () => {
 		});
 	});
 
-	describe('isPredefinedBlockNumber', () => {
-		it('should return true for "latest"', () => {
-			expect(isPredefinedBlockNumber('latest')).toBeTruthy();
-		});
-
-		it('should return true for "pending"', () => {
-			expect(isPredefinedBlockNumber('pending')).toBeTruthy();
-		});
-
-		it('should return true for "earliest"', () => {
-			expect(isPredefinedBlockNumber('earliest')).toBeTruthy();
-		});
-
-		it('should return false for "unknown"', () => {
-			expect(isPredefinedBlockNumber('unknown')).toBeFalsy();
-		});
-	});
-
 	describe('inputBlockNumberFormatter', () => {
 		it('should return undefined if block number not given', () => {
 			expect(inputBlockNumberFormatter(undefined)).toBeUndefined();
 		});
 
-		it.each([
-			PredefinedBlockNumbers.EARLIEST,
-			PredefinedBlockNumbers.LATEST,
-			PredefinedBlockNumbers.PENDING,
-		])('should return "%s" values for "%s" block numbers', blockNumber => {
-			expect(inputBlockNumberFormatter(blockNumber)).toEqual(blockNumber);
-		});
+		it.each([utils.BlockTags.EARLIEST, utils.BlockTags.LATEST, utils.BlockTags.PENDING])(
+			'should return "%s" values for "%s" block numbers',
+			blockNumber => {
+				expect(inputBlockNumberFormatter(blockNumber)).toEqual(blockNumber);
+			},
+		);
 
 		it('should return valid genesis block number', () => {
 			expect(inputBlockNumberFormatter('genesis')).toBe('0x0');

packages/web3-core/package.json

@@ -34,7 +34,7 @@
 		"@types/jest-when": "^2.7.3",
 		"@typescript-eslint/eslint-plugin": "^5.4.0",
 		"@typescript-eslint/parser": "^5.4.0",
-		"eslint": "^8.3.0",
+		"eslint": "^7.32.0",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-config-web3-base": "0.1.0",
 		"eslint-plugin-import": "^2.25.3",

packages/web3-core/src/types.ts

@@ -6,6 +6,7 @@ import {
 	JsonRpcResult,
 	Web3BaseProvider,
 } from 'web3-common';
+import { HexString, ValidTypes } from 'web3-utils';
 
 export type LegacyRequestProvider = {
 	request: <R = JsonRpcResult, P = unknown>(
@@ -37,3 +38,18 @@ export type Web3BaseProviderConstructor = new <API extends Web3APISpec>(
 	url: string,
 	net?: Socket,
 ) => Web3BaseProvider<API>;
+
+export interface ConfigOptions {
+	handleRevert: boolean;
+	defaultAccount: HexString | null;
+	defaultBlock: HexString;
+	transactionBlockTimeout: number;
+	transactionConfirmationBlocks: number;
+	transactionPollingTimeout: number;
+	blockHeaderTimeout: number;
+	maxListenersWarningThreshold: number;
+	defaultChain: string | null;
+	defaultHardfork: string | null;
+	defaultCommon: Record<string, unknown> | null;
+	defaultReturnType: ValidTypes;
+}

packages/web3-core/src/web3_config.ts

@@ -1,19 +1,7 @@
-import { HexString } from 'web3-utils';
+import { ValidTypes } from 'web3-utils';
 import { Web3EventEmitter } from 'web3-common';
 
-interface ConfigOptions {
-	handleRevert: boolean;
-	defaultAccount: HexString | null;
-	defaultBlock: HexString;
-	transactionBlockTimeout: number;
-	transactionConfirmationBlocks: number;
-	transactionPollingTimeout: number;
-	blockHeaderTimeout: number;
-	maxListenersWarningThreshold: number;
-	defaultChain: string | null;
-	defaultHardfork: string | null;
-	defaultCommon: Record<string, unknown> | null;
-}
+import { ConfigOptions } from './types';
 
 type ConfigEvent<T, P extends keyof T = keyof T> = P extends unknown
 	? { name: P; oldValue: T[P]; newValue: T[P] }
@@ -39,6 +27,7 @@ export abstract class Web3Config
 		defaultChain: null,
 		defaultHardfork: null,
 		defaultCommon: null,
+		defaultReturnType: ValidTypes.HexString,
 	};
 
 	public getConfig() {
@@ -193,4 +182,18 @@ export abstract class Web3Config
 
 		this._config.defaultCommon = val;
 	}
+
+	public get defaultReturnType() {
+		return this._config.defaultReturnType;
+	}
+
+	public set defaultReturnType(val) {
+		this.emit(Web3ConfigEvent.CONFIG_CHANGE, {
+			name: 'defaultReturnType',
+			oldValue: this._config.defaultReturnType,
+			newValue: val,
+		});
+
+		this._config.defaultReturnType = val;
+	}
 }

packages/web3-core/src/web3_context.ts

@@ -1,5 +1,5 @@
 import { Web3APISpec } from 'web3-common';
-import { SupportedProviders } from './types';
+import { ConfigOptions, SupportedProviders } from './types';
 import { Web3Config } from './web3_config';
 import { Web3RequestManager } from './web3_request_manager';
 
@@ -10,9 +10,20 @@ export class Web3Context<API extends Web3APISpec> extends Web3Config {
 
 	public readonly requestManager: Web3RequestManager<API>;
 
-	public constructor(provider: SupportedProviders<API> | string) {
+	public constructor(
+		provider: SupportedProviders<API> | string,
+		options?: Partial<ConfigOptions>,
+	) {
 		super();
 		this.requestManager = new Web3RequestManager<API>(provider);
+
+		if (options !== undefined)
+			for (const key of Object.keys(options)) {
+				// TODO
+				// @ts-expect-error Not sure how to type this
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+				this[key] = options[key];
+			}
 	}
 
 	public get currentProvider(): SupportedProviders<API> | string {

packages/web3-core/test/unit/web3_config.test.ts

@@ -1,3 +1,4 @@
+import { ValidTypes } from 'web3-utils';
 import { Web3Config, Web3ConfigEvent } from '../../src/web3_config';
 
 class MyConfigObject extends Web3Config {}
@@ -9,6 +10,7 @@ const defaultConfig = {
 	defaultChain: null,
 	defaultCommon: null,
 	defaultHardfork: null,
+	defaultReturnType: ValidTypes.HexString,
 	handleRevert: false,
 	maxListenersWarningThreshold: 100,
 	transactionBlockTimeout: 50,

packages/web3-eth-abi/src/types.ts

@@ -39,7 +39,7 @@ export interface JsonAbiFunctionFragment extends JsonAbiBaseFragment {
 	outputs?: Array<JsonAbiParameter>;
 
 	// legacy properties
-	constant?: boolean;	// stateMutability == 'pure' or stateMutability == 'view'
+	constant?: boolean; // stateMutability == 'pure' or stateMutability == 'view'
 	payable?: boolean; // stateMutability == 'payable'
 }
 

packages/web3-eth-accounts/package.json

@@ -28,7 +28,7 @@
 		"@types/jest": "^27.0.3",
 		"@typescript-eslint/eslint-plugin": "^5.4.0",
 		"@typescript-eslint/parser": "^5.4.0",
-		"eslint": "^8.3.0",
+		"eslint": "^7.32.0",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-config-web3-base": "0.1.0",
 		"eslint-plugin-import": "^2.25.3",

packages/web3-eth-contract/package.json

@@ -34,7 +34,7 @@
 		"@types/jest": "^27.0.3",
 		"@typescript-eslint/eslint-plugin": "^5.4.0",
 		"@typescript-eslint/parser": "^5.4.0",
-		"eslint": "^8.3.0",
+		"eslint": "^7.32.0",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-config-web3-base": "0.1.0",
 		"eslint-plugin-import": "^2.25.3",

packages/web3-eth/package.json

@@ -28,7 +28,7 @@
 		"@types/jest": "^27.0.3",
 		"@typescript-eslint/eslint-plugin": "^5.4.0",
 		"@typescript-eslint/parser": "^5.4.0",
-		"eslint": "^8.3.0",
+		"eslint": "^7.32.0",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-config-web3-base": "0.1.0",
 		"eslint-plugin-import": "^2.25.3",
@@ -37,5 +37,10 @@
 		"prettier": "^2.4.1",
 		"ts-jest": "^27.0.7",
 		"typescript": "^4.5.2"
+	},
+	"dependencies": {
+		"web3-common": "1.0.0-alpha.0",
+		"web3-core": "4.0.0-alpha.0",
+		"web3-utils": "4.0.0-alpha.0"
 	}
 }