Change default return type for integer values to BigInt

packages/web3-common/src/formatter.ts

@@ -60,9 +60,9 @@ export type DataFormat = {
 	readonly bytes: FMT_BYTES;
 };
 
-export const DEFAULT_RETURN_FORMAT = { number: FMT_NUMBER.HEX, bytes: FMT_BYTES.HEX } as const;
+export const DEFAULT_RETURN_FORMAT = { number: FMT_NUMBER.BIGINT, bytes: FMT_BYTES.HEX } as const;
+export const ETH_DATA_FORMAT = { number: FMT_NUMBER.HEX, bytes: FMT_BYTES.HEX } as const;
 
-// Added `undefined` to cover optional type
 export type FormatType<T, F extends DataFormat> = number extends Extract<T, Numbers>
 	? NumberTypes[F['number']] | Exclude<T, Numbers>
 	: Buffer extends Extract<T, Bytes>

packages/web3-common/src/formatters.ts

@@ -359,14 +359,14 @@ export const outputLogFormatter = (log: Partial<LogsInput>): LogsOutput => {
 		modifiedLog.id = undefined;
 	}
 
-	if (log.blockNumber) {
+	if (log.blockNumber && isHexStrict(log.blockNumber)) {
 		modifiedLog.blockNumber = hexToNumber(log.blockNumber);
 	}
-	if (log.transactionIndex) {
+	if (log.transactionIndex && isHexStrict(log.transactionIndex)) {
 		modifiedLog.transactionIndex = hexToNumber(log.transactionIndex);
 	}
 
-	if (log.logIndex) {
+	if (log.logIndex && isHexStrict(log.logIndex)) {
 		modifiedLog.logIndex = hexToNumber(log.logIndex);
 	}
 

packages/web3-common/src/web3_base_provider.ts

@@ -54,7 +54,6 @@ export abstract class Web3BaseProvider<API extends Web3APISpec = EthExecutionAPI
 
 	/**
 	 * @deprecated Please use `.request` instead.
-	 *
 	 * @param payload - Request Payload
 	 * @param cb - Callback
 	 */
@@ -75,7 +74,6 @@ export abstract class Web3BaseProvider<API extends Web3APISpec = EthExecutionAPI
 
 	/**
 	 * @deprecated Please use `.request` instead.
-	 *
 	 * @param payload - Request Payload
 	 * @param cb - Callback
 	 */

packages/web3-eth-contract/src/contract.ts

@@ -616,7 +616,7 @@ export class Contract<Abi extends ContractAbi>
 
 		return sendTransaction(this, tx, DEFAULT_RETURN_FORMAT, {
 			transactionResolver: receipt => {
-				if (receipt.status === '0x0') {
+				if (receipt.status === BigInt(0)) {
 					throw new Web3ContractError(
 						'contract deployment error',
 						receipt as ReceiptInfo,

packages/web3-eth-contract/test/integration/contract_methods.test.ts

@@ -65,8 +65,15 @@ describe('contract', () => {
 					.send(sendOptions);
 
 				expect(receipt).toEqual(
-					expect.objectContaining({ status: '0x1', transactionHash: expect.any(String) }),
+					expect.objectContaining({
+						// status: BigInt(1),
+						transactionHash: expect.any(String),
+					}),
 				);
+
+				// To avoid issue with the `objectContaining` and `cypress` had to add
+				// these expectations explicitly on each attribute
+				expect(receipt.status).toEqual(BigInt(1));
 			});
 
 			it('should returns a receipt (EIP-1559, maxFeePerGas and maxPriorityFeePerGas specified)', async () => {
@@ -78,15 +85,36 @@ describe('contract', () => {
 				});
 
 				expect(receipt).toEqual(
-					expect.objectContaining({ status: '0x1', transactionHash: expect.any(String) }),
+					expect.objectContaining({
+						// status: BigInt(1),
+						transactionHash: expect.any(String),
+					}),
 				);
+
+				// To avoid issue with the `objectContaining` and `cypress` had to add
+				// these expectations explicitly on each attribute
+				expect(receipt.status).toEqual(BigInt(1));
 			});
 
 			// TODO: Get and match the revert error message
 			it('should returns errors on reverts', async () => {
-				return expect(contract.methods.reverts().send(sendOptions)).rejects.toEqual(
-					expect.objectContaining({ status: '0x0', transactionHash: expect.any(String) }),
-				);
+				try {
+					await contract.methods.reverts().send(sendOptions);
+				} catch (receipt: any) {
+					// eslint-disable-next-line jest/no-conditional-expect
+					expect(receipt).toEqual(
+						expect.objectContaining({
+							transactionHash: expect.any(String),
+						}),
+					);
+
+					// To avoid issue with the `objectContaining` and `cypress` had to add
+					// these expectations explicitly on each attribute
+					// eslint-disable-next-line jest/no-conditional-expect
+					expect(receipt.status).toEqual(BigInt(0));
+				}
+
+				expect.assertions(2);
 			});
 		});
 	});

packages/web3-eth-ens/src/ens.ts

@@ -24,7 +24,7 @@ import {
 import { Web3Context, SupportedProviders, Web3ContextObject } from 'web3-core';
 import { getId, Web3NetAPI } from 'web3-net';
 import { Address } from 'web3-utils';
-import { EthExecutionAPI, DEFAULT_RETURN_FORMAT } from 'web3-common';
+import { EthExecutionAPI, DEFAULT_RETURN_FORMAT, FormatType, FMT_NUMBER } from 'web3-common';
 import { NonPayableCallOptions, Contract } from 'web3-eth-contract';
 import { RESOLVER } from './abi/resolver';
 import { Registry } from './registry';
@@ -71,7 +71,10 @@ export class ENS extends Web3Context<EthExecutionAPI & Web3NetAPI> {
 		name: string,
 		address: Address,
 		txConfig: NonPayableCallOptions,
-	): Promise<ReceiptInfo | RevertInstructionError> {
+	): Promise<
+		| FormatType<ReceiptInfo, typeof DEFAULT_RETURN_FORMAT>
+		| FormatType<RevertInstructionError, typeof DEFAULT_RETURN_FORMAT>
+	> {
 		return this._registry.setResolver(name, address, txConfig);
 	}
 
@@ -289,7 +292,10 @@ export class ENS extends Web3Context<EthExecutionAPI & Web3NetAPI> {
 		if (this._detectedAddress) {
 			return this._detectedAddress;
 		}
-		const networkType = await getId(this, DEFAULT_RETURN_FORMAT); // get the network from provider
+		const networkType = await getId(this, {
+			...DEFAULT_RETURN_FORMAT,
+			number: FMT_NUMBER.HEX,
+		}); // get the network from provider
 		const addr = registryAddresses[networkType];
 
 		if (typeof addr === 'undefined') {

packages/web3-eth-personal/src/rpc_method_wrappers.ts

@@ -15,7 +15,7 @@ You should have received a copy of the GNU Lesser General Public License
 along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-import { DEFAULT_RETURN_FORMAT } from 'web3-common';
+import { ETH_DATA_FORMAT } from 'web3-common';
 import { formatTransaction, Transaction } from 'web3-eth';
 import { Address, HexString, isHexStrict, toChecksumAddress, utf8ToHex } from 'web3-utils';
 import { validator } from 'web3-validator';
@@ -78,7 +78,7 @@ export const sendTransaction = async (
 	tx: Transaction,
 	passphrase: string,
 ) => {
-	const formattedTx = formatTransaction(tx, DEFAULT_RETURN_FORMAT);
+	const formattedTx = formatTransaction(tx, ETH_DATA_FORMAT);
 
 	return rpcSendTransaction(requestManager, formattedTx, passphrase);
 };
@@ -88,7 +88,7 @@ export const signTransaction = async (
 	tx: Transaction,
 	passphrase: string,
 ) => {
-	const formattedTx = formatTransaction(tx, DEFAULT_RETURN_FORMAT);
+	const formattedTx = formatTransaction(tx, ETH_DATA_FORMAT);
 
 	return rpcSignTransaction(requestManager, formattedTx, passphrase);
 };

packages/web3-eth-personal/test/unit/eth_personal.test.ts

@@ -15,6 +15,7 @@ You should have received a copy of the GNU Lesser General Public License
 along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+import { ETH_DATA_FORMAT } from 'web3-common';
 import * as utils from 'web3-utils';
 import * as eth from 'web3-eth';
 import { validator } from 'web3-validator';
@@ -185,10 +186,7 @@ describe('Personal', () => {
 			await personal.sendTransaction(tx, 'password');
 
 			expect(eth.formatTransaction).toHaveBeenCalledTimes(1);
-			expect(eth.formatTransaction).toHaveBeenCalledWith(tx, {
-				bytes: 'BYTES_HEX',
-				number: 'NUMBER_HEX',
-			});
+			expect(eth.formatTransaction).toHaveBeenCalledWith(tx, ETH_DATA_FORMAT);
 		});
 	});
 
@@ -218,10 +216,7 @@ describe('Personal', () => {
 			await personal.signTransaction(tx, 'password');
 
 			expect(eth.formatTransaction).toHaveBeenCalledTimes(1);
-			expect(eth.formatTransaction).toHaveBeenCalledWith(tx, {
-				bytes: 'BYTES_HEX',
-				number: 'NUMBER_HEX',
-			});
+			expect(eth.formatTransaction).toHaveBeenCalledWith(tx, ETH_DATA_FORMAT);
 		});
 	});
 

packages/web3-eth/src/constants.ts

@@ -0,0 +1,19 @@
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+import { FMT_BYTES, FMT_NUMBER } from 'web3-common';
+
+export const NUMBER_DATA_FORMAT = { bytes: FMT_BYTES.HEX, number: FMT_NUMBER.NUMBER } as const;