🎨 Improve the nullish value usage around the codebase (#5095)

* 🎨 Update the usage of "null" around the codebase

* 🎨 Update value check to avoid prototype pollution

* 🚨 Fix all lint errors for null values

* 🚨 Add linting rules

* 🎨 Update json-rpc "null" validation

* 🎨 Update the legacy provider error type to accept "null"

* Apply suggestions from code review

Co-authored-by: Junaid <[email protected]>

* 🎨 Improve the tests to make sure transaction complete in each test case

Co-authored-by: Junaid <[email protected]>

Author: nazarhussain

packages/web3-common/src/deferred_promise.ts

@@ -71,7 +71,7 @@ export class DeferredPromise<T> implements Promise<T> {
 		return this._promise.catch(onrejected);
 	}
 
-	public async finally(onfinally?: (() => void) | null): Promise<T> {
+	public async finally(onfinally?: (() => void) | undefined): Promise<T> {
 		return this._promise.finally(onfinally);
 	}
 

packages/web3-common/src/eth_execution_api.ts

@@ -55,7 +55,7 @@ export interface TransactionCall {
 }
 
 export interface BaseTransaction {
-	readonly to?: Address | null;
+	readonly to?: Address;
 	readonly type: HexStringSingleByte;
 	readonly nonce: Uint;
 	readonly gas: Uint;
@@ -113,11 +113,11 @@ export type TransactionSigned =
 
 // https://github.com/ethereum/execution-apis/blob/main/src/schemas/transaction.json#L269
 export type TransactionInfo = TransactionSigned & {
-	readonly blockHash: HexString32Bytes | null;
-	readonly blockNumber: Uint | null;
+	readonly blockHash?: HexString32Bytes;
+	readonly blockNumber?: Uint;
 	readonly from: Address;
 	readonly hash: HexString32Bytes;
-	readonly transactionIndex: Uint | null;
+	readonly transactionIndex?: Uint;
 };
 
 // https://github.com/ethereum/execution-apis/blob/main/src/schemas/transaction.json#L24
@@ -131,34 +131,34 @@ export interface Block {
 	readonly stateRoot: HexString32Bytes;
 	readonly transactionsRoot: HexString32Bytes;
 	readonly receiptsRoot: HexString32Bytes;
-	readonly logsBloom: HexString256Bytes | null;
+	readonly logsBloom?: HexString256Bytes;
 	readonly difficulty?: Uint;
-	readonly number: Uint | null;
+	readonly number?: Uint;
 	readonly gasLimit: Uint;
 	readonly gasUsed: Uint;
 	readonly timestamp: Uint;
 	readonly extraData: HexStringBytes;
 	readonly mixHash: HexString32Bytes;
-	readonly nonce: Uint | null;
+	readonly nonce?: Uint;
 	readonly totalDifficulty: Uint;
 	readonly baseFeePerGas?: Uint;
 	readonly size: Uint;
 	readonly transactions: TransactionHash[] | TransactionInfo[];
 	readonly uncles: Uncles;
-	readonly hash: HexString32Bytes | null;
+	readonly hash?: HexString32Bytes;
 }
 
 // https://github.com/ethereum/execution-apis/blob/main/src/schemas/receipt.json#L2
 export interface Log {
 	readonly removed?: boolean;
-	readonly logIndex?: Uint | null;
-	readonly transactionIndex?: Uint | null;
-	readonly transactionHash?: HexString32Bytes | null;
-	readonly blockHash?: HexString32Bytes | null;
-	readonly blockNumber?: Uint | null;
+	readonly logIndex?: Uint;
+	readonly transactionIndex?: Uint;
+	readonly transactionHash?: HexString32Bytes;
+	readonly blockHash?: HexString32Bytes;
+	readonly blockNumber?: Uint;
 	readonly address?: Address;
 	readonly data?: HexStringBytes;
-	readonly topics?: null | Topic | Topic[];
+	readonly topics?: Topic | Topic[];
 }
 
 // https://github.com/ethereum/execution-apis/blob/main/src/schemas/receipt.json#L44
@@ -171,7 +171,7 @@ export interface ReceiptInfo {
 	readonly to: Address;
 	readonly cumulativeGasUsed: Uint;
 	readonly gasUsed: Uint;
-	readonly contractAddress: Address | null;
+	readonly contractAddress?: Address;
 	readonly logs: Log[];
 	readonly logsBloom: HexString256Bytes;
 	readonly root: HexString32Bytes;
@@ -224,16 +224,16 @@ export type EthExecutionAPI = {
 	eth_getUncleByBlockNumberAndIndex: (blockNumber: BlockNumberOrTag, uncleIndex: Uint) => Block;
 
 	// https://github.com/ethereum/execution-apis/blob/main/src/eth/transaction.json
-	eth_getTransactionByHash: (transactionHash: HexString32Bytes) => TransactionInfo | null;
+	eth_getTransactionByHash: (transactionHash: HexString32Bytes) => TransactionInfo | undefined;
 	eth_getTransactionByBlockHashAndIndex: (
 		blockHash: HexString32Bytes,
 		transactionIndex: Uint,
-	) => TransactionInfo | null;
+	) => TransactionInfo | undefined;
 	eth_getTransactionByBlockNumberAndIndex: (
 		blockNumber: BlockNumberOrTag,
 		transactionIndex: Uint,
-	) => TransactionInfo | null;
-	eth_getTransactionReceipt: (transactionHash: HexString32Bytes) => ReceiptInfo | null;
+	) => TransactionInfo | undefined;
+	eth_getTransactionReceipt: (transactionHash: HexString32Bytes) => ReceiptInfo | undefined;
 
 	// https://github.com/ethereum/execution-apis/blob/main/src/eth/client.json
 	eth_protocolVersion: () => string;

packages/web3-common/src/formatter.ts

@@ -25,7 +25,7 @@ import {
 	numberToHex,
 	toBigInt,
 } from 'web3-utils';
-import { isObject, JsonSchema, utils, ValidationSchemaInput } from 'web3-validator';
+import { isNullish, isObject, JsonSchema, utils, ValidationSchemaInput } from 'web3-validator';
 
 const { parseBaseType } = utils;
 
@@ -159,7 +159,7 @@ export const convert = (
 		const schemaProp = findSchemaByDataPath(schema, dataPath);
 
 		// If value is a scaler value
-		if (schemaProp === undefined) {
+		if (isNullish(schemaProp)) {
 			delete object[key];
 			dataPath.pop();
 
@@ -175,7 +175,7 @@ export const convert = (
 
 		// If value is an array
 		if (Array.isArray(value)) {
-			if (schemaProp?.items === undefined) {
+			if (isNullish(schemaProp?.items)) {
 				// Can not find schema for array item, delete that item
 				delete object[key];
 				dataPath.pop();
@@ -184,7 +184,7 @@ export const convert = (
 			}
 
 			// If schema for array items is a single type
-			if (isObject(schemaProp.items) && schemaProp.items.eth !== undefined) {
+			if (isObject(schemaProp.items) && !isNullish(schemaProp.items.eth)) {
 				for (let i = 0; i < value.length; i += 1) {
 					(object[key] as unknown[])[i] = convertScalarValue(
 						value[i],

packages/web3-common/src/formatters.ts

@@ -35,7 +35,7 @@ import {
 	toUtf8,
 	utf8ToHex,
 } from 'web3-utils';
-import { isBlockTag, isHex } from 'web3-validator';
+import { isBlockTag, isHex, isNullish } from 'web3-validator';
 import {
 	BlockInput,
 	BlockOutput,
@@ -55,11 +55,15 @@ import {
 
 /**
  * Will format the given storage key array values to hex strings.
+ *
+ * @param keys
  */
 export const inputStorageKeysFormatter = (keys: Array<string>) => keys.map(numberToHex);
 
 /**
  * Will format the given proof response from the node.
+ *
+ * @param proof
  */
 export const outputProofFormatter = (proof: Proof): Proof => ({
 	address: toChecksumAddress(proof.address),
@@ -69,14 +73,18 @@ export const outputProofFormatter = (proof: Proof): Proof => ({
 
 /**
  * Should the format output to a big number
+ *
+ * @param number
  */
 export const outputBigIntegerFormatter = (number: Numbers) => toNumber(number);
 
 /**
  * Returns the given block number as hex string or the predefined block number 'latest', 'pending', 'earliest', 'genesis'
+ *
+ * @param blockNumber
  */
 export const inputBlockNumberFormatter = (blockNumber: Numbers | undefined) => {
-	if (blockNumber === undefined) {
+	if (isNullish(blockNumber)) {
 		return undefined;
 	}
 
@@ -97,6 +105,9 @@ export const inputBlockNumberFormatter = (blockNumber: Numbers | undefined) => {
 
 /**
  * Returns the given block number as hex string or does return the defaultBlock property of the current module
+ *
+ * @param blockNumber
+ * @param defaultBlock
  */
 export const inputDefaultBlockNumberFormatter = (
 	blockNumber: Numbers | undefined,
@@ -127,6 +138,8 @@ export const inputAddressFormatter = (address: string): string | never => {
 
 /**
  * Formats the input of a transaction and converts all values to HEX
+ *
+ * @param options
  */
 export const txInputOptionsFormatter = (options: TransactionInput): Mutable<TransactionOutput> => {
 	const modifiedOptions = { ...options } as unknown as Mutable<TransactionOutput>;
@@ -165,7 +178,7 @@ export const txInputOptionsFormatter = (options: TransactionInput): Mutable<Tran
 	}
 
 	['gasPrice', 'gas', 'value', 'maxPriorityFeePerGas', 'maxFeePerGas', 'nonce', 'chainId']
-		.filter(key => modifiedOptions[key] !== undefined)
+		.filter(key => !isNullish(modifiedOptions[key]))
 		.forEach(key => {
 			modifiedOptions[key] = numberToHex(modifiedOptions[key] as Numbers);
 		});
@@ -175,6 +188,9 @@ export const txInputOptionsFormatter = (options: TransactionInput): Mutable<Tran
 
 /**
  * Formats the input of a transaction and converts all values to HEX
+ *
+ * @param options
+ * @param defaultAccount
  */
 export const inputCallFormatter = (options: TransactionInput, defaultAccount?: string) => {
 	const opts = txInputOptionsFormatter(options);
@@ -190,6 +206,9 @@ export const inputCallFormatter = (options: TransactionInput, defaultAccount?: s
 
 /**
  * Formats the input of a transaction and converts all values to HEX
+ *
+ * @param options
+ * @param defaultAccount
  */
 export const inputTransactionFormatter = (options: TransactionInput, defaultAccount?: string) => {
 	const opts = txInputOptionsFormatter(options);
@@ -210,15 +229,17 @@ export const inputTransactionFormatter = (options: TransactionInput, defaultAcco
 
 /**
  * Hex encodes the data passed to eth_sign and personal_sign
+ *
+ * @param data
  */
 export const inputSignFormatter = (data: string) => (isHexStrict(data) ? data : utf8ToHex(data));
 
 /**
  * Formats the output of a transaction to its proper values
  *
- * @method outputTransactionFormatter
- * @param {Object} tx
- * @returns {Object}
+ * @function outputTransactionFormatter
+ * @param {object} tx
+ * @returns {object}
  */
 export const outputTransactionFormatter = (tx: TransactionInput): TransactionOutput => {
 	const modifiedTx = { ...tx } as unknown as Mutable<TransactionOutput>;
@@ -266,26 +287,31 @@ export const outputTransactionFormatter = (tx: TransactionInput): TransactionOut
 	return modifiedTx;
 };
 
+// To align with specification we use the type "null" here
+// eslint-disable-next-line @typescript-eslint/ban-types
 export const inputTopicFormatter = (topic: Topic): Topic | null => {
-	if (topic === null || typeof topic === 'undefined') return null;
+	// Using "null" value intentionally for validation
+	// eslint-disable-next-line no-null/no-null
+	if (isNullish(topic)) return null;
 
 	const value = String(topic);
 
 	return isHex(value) ? value : fromUtf8(value);
 };
 
 export const inputLogFormatter = (filter: Filter) => {
-	const val: Mutable<Filter> =
-		filter === undefined ? {} : mergeDeep({}, filter as Record<string, unknown>);
+	const val: Mutable<Filter> = isNullish(filter)
+		? {}
+		: mergeDeep({}, filter as Record<string, unknown>);
 
 	// If options !== undefined, don't blow out existing data
-	if (val.fromBlock === undefined) {
+	if (isNullish(val.fromBlock)) {
 		val.fromBlock = BlockTags.LATEST;
 	}
 
 	val.fromBlock = inputBlockNumberFormatter(val.fromBlock);
 
-	if (val.toBlock !== undefined) {
+	if (!isNullish(val.toBlock)) {
 		val.toBlock = inputBlockNumberFormatter(val.toBlock);
 	}
 
@@ -309,9 +335,9 @@ export const inputLogFormatter = (filter: Filter) => {
 /**
  * Formats the output of a log
  *
- * @method outputLogFormatter
- * @param {Object} log object
- * @returns {Object} log
+ * @function outputLogFormatter
+ * @param {object} log object
+ * @returns {object} log
  */
 export const outputLogFormatter = (log: Partial<LogsInput>): LogsOutput => {
 	const modifiedLog = { ...log } as unknown as Mutable<LogsOutput>;
@@ -353,6 +379,8 @@ export const outputLogFormatter = (log: Partial<LogsInput>): LogsOutput => {
 
 /**
  * Formats the output of a transaction receipt to its proper values
+ *
+ * @param receipt
  */
 export const outputTransactionReceiptFormatter = (receipt: ReceiptInput): ReceiptOutput => {
 	if (typeof receipt !== 'object') {
@@ -393,9 +421,9 @@ export const outputTransactionReceiptFormatter = (receipt: ReceiptInput): Receip
 /**
  * Formats the output of a block to its proper values
  *
- * @method outputBlockFormatter
- * @param {Object} block
- * @returns {Object}
+ * @function outputBlockFormatter
+ * @param {object} block
+ * @returns {object}
  */
 export const outputBlockFormatter = (block: BlockInput): BlockOutput => {
 	const modifiedBlock = { ...block } as unknown as Mutable<BlockOutput>;
@@ -435,6 +463,8 @@ export const outputBlockFormatter = (block: BlockInput): BlockOutput => {
 
 /**
  * Formats the input of a whisper post and converts all values to HEX
+ *
+ * @param post
  */
 export const inputPostFormatter = (post: PostOutput): PostInput => {
 	const modifiedPost = { ...post } as unknown as Mutable<PostInput>;
@@ -467,9 +497,10 @@ export const inputPostFormatter = (post: PostOutput): PostInput => {
 /**
  * Formats the output of a received post message
  *
- * @method outputPostFormatter
- * @param {Object}
- * @returns {Object}
+ * @function outputPostFormatter
+ * @param post
+ * @param {object}
+ * @returns {object}
  */
 export const outputPostFormatter = (post: PostInput): PostOutput => {
 	const modifiedPost = { ...post } as unknown as Mutable<PostOutput>;