allow getpastlogs to accept bn and numbers (#6219)

* allow getpastlogs to accept bn and numbers

* update rpc tests

* update numbertohex bigint conditional

* update conditional

* update conditional

* update changelog

* getpastLogs accept blockhash as a parameter

* add coverage and update changelogs

* update conditional

* address feedback

* update web3 eth methods

* update unit tests for getpastlogs

* update fixtures for getpastlogs

Author: Alex

CHANGELOG.md

@@ -1698,3 +1698,12 @@ If there are any bugs, improvements, optimizations or any new feature proposal f
 -   Dependencies updated
 
 ## [Unreleased]
+
+
+#### web3-utils
+
+-   BigInts pass validation within the method `numberToHex` (#6206)
+
+#### web3-rpc-methods
+
+-   Rpc method `getPastLogs` accept blockHash as a parameter https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs (#6181)

packages/web3-eth/src/rpc_method_wrappers.ts

@@ -49,7 +49,7 @@ import {
 	AccessListResult,
 } from 'web3-types';
 import { Web3Context, Web3PromiEvent } from 'web3-core';
-import { format, hexToBytes, bytesToUint8Array } from 'web3-utils';
+import { format, hexToBytes, bytesToUint8Array, numberToHex } from 'web3-utils';
 import { TransactionFactory } from 'web3-eth-accounts';
 import { isBlockTag, isBytes, isNullish, isString } from 'web3-validator';
 import {
@@ -988,7 +988,22 @@ export async function getLogs<ReturnFormat extends DataFormat>(
 	filter: Filter,
 	returnFormat: ReturnFormat,
 ) {
-	const response = await ethRpcMethods.getLogs(web3Context.requestManager, filter);
+	// format type bigint or number toBlock and fromBlock to hexstring.
+	let { toBlock, fromBlock } = filter;
+	if (!isNullish(toBlock)) {
+		if (typeof toBlock === 'number' || typeof toBlock === 'bigint') {
+			toBlock = numberToHex(toBlock);
+		}
+	}
+	if (!isNullish(fromBlock)) {
+		if (typeof fromBlock === 'number' || typeof fromBlock === 'bigint') {
+			fromBlock = numberToHex(fromBlock);
+		}
+	}
+
+	const formattedFilter = { ...filter, fromBlock, toBlock };
+
+	const response = await ethRpcMethods.getLogs(web3Context.requestManager, formattedFilter);
 
 	const result = response.map(res => {
 		if (typeof res === 'string') {

packages/web3-eth/test/fixtures/web3_eth_methods_with_parameters.ts

@@ -1769,6 +1769,15 @@ export const signValidData: [
 	],
 ];
 
+/**
+ * Array tests getPastLogs and formats valid fromBlock and toBlock
+ */
+export const getPastLogsValidFormatData: [Filter][] = [
+	[{ fromBlock: 0, toBlock: 100 }],
+	[{ fromBlock: BigInt(0), toBlock: BigInt(100) }],
+	[{ fromBlock: '0x0', toBlock: '0x10' }],
+	[{ blockHash: '0x19e54b41ac6ed5eb5045aab59967489bbab1852e742857b1987f62290a4b89af' }],
+];
 /**
  * Array consists of:
  * - array of inputs
@@ -1779,6 +1788,16 @@ export const getPastLogsValidData: [[Filter, DataFormat | undefined], [Filter, D
 		[{}, undefined],
 		[{}, DEFAULT_RETURN_FORMAT],
 	],
+	[
+		[
+			{ blockHash: '0x19e54b41ac6ed5eb5045aab59967489bbab1852e742857b1987f62290a4b89af' },
+			undefined,
+		],
+		[
+			{ blockHash: '0x19e54b41ac6ed5eb5045aab59967489bbab1852e742857b1987f62290a4b89af' },
+			DEFAULT_RETURN_FORMAT,
+		],
+	],
 	[
 		[
 			{

packages/web3-eth/test/integration/rpc.test.ts

@@ -345,17 +345,45 @@ describe('rpc', () => {
 				// eslint-disable-next-line  no-await-in-loop
 				resTx.push(await contractDeployed.methods?.firesStringEvent(l).send(sendOptions));
 			}
+
+			// test type hexstring
 			const res: Array<any> = await web3Eth.getPastLogs({
 				address: contractDeployed.options.address as string,
 				fromBlock: numberToHex(Math.min(...resTx.map(d => Number(d.blockNumber)))),
+				toBlock: numberToHex(1000),
 			});
 			const results = res.map(
 				r =>
 					decodeEventABI(eventAbi as AbiEventFragment & { signature: string }, r, [])
 						.returnValues[0],
 			);
+
+			// test type number
+			const res2: Array<any> = await web3Eth.getPastLogs({
+				address: contractDeployed.options.address as string,
+				fromBlock: Math.min(...resTx.map(d => Number(d.blockNumber))),
+				toBlock: 1000,
+			});
+			const results2 = res2.map(
+				r =>
+					decodeEventABI(eventAbi as AbiEventFragment & { signature: string }, r, [])
+						.returnValues[0],
+			);
+			// test type BigInt
+			const res3: Array<any> = await web3Eth.getPastLogs({
+				address: contractDeployed.options.address as string,
+				fromBlock: BigInt(Math.min(...resTx.map(d => Number(d.blockNumber)))),
+				toBlock: BigInt(1000),
+			});
+			const results3 = res3.map(
+				r =>
+					decodeEventABI(eventAbi as AbiEventFragment & { signature: string }, r, [])
+						.returnValues[0],
+			);
 			for (const l of listOfStrings) {
 				expect(results).toContain(l);
+				expect(results2).toContain(l);
+				expect(results3).toContain(l);
 			}
 		});
 	});

packages/web3-eth/test/unit/format_rpc_methods.test.ts

@@ -0,0 +1,55 @@
+/*
+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 { ethRpcMethods } from 'web3-rpc-methods';
+import { DEFAULT_RETURN_FORMAT } from 'web3-types';
+import { numberToHex, isNullish } from 'web3-utils';
+import * as rpcMethodWrappers from '../../src/rpc_method_wrappers';
+import { getPastLogsValidFormatData } from '../fixtures/web3_eth_methods_with_parameters';
+import Web3Eth from '../../src/index';
+
+jest.mock('web3-rpc-methods');
+describe('web3_eth_methods formatting', () => {
+	let web3Eth: Web3Eth;
+
+	beforeAll(() => {
+		web3Eth = new Web3Eth('http://127.0.0.1:8545');
+	});
+
+	describe('getPastLogs makes sure data is prepared properly', () => {
+		it.each(getPastLogsValidFormatData)('input: %s\nrpcMethodParameters: %s', async filter => {
+			jest.spyOn(ethRpcMethods, 'getLogs').mockResolvedValue(['']);
+			await rpcMethodWrappers.getLogs(web3Eth, filter, DEFAULT_RETURN_FORMAT);
+			let { fromBlock, toBlock } = filter;
+			if (
+				!isNullish(filter.fromBlock) &&
+				(typeof filter.fromBlock === 'bigint' || typeof filter.fromBlock === 'number')
+			)
+				fromBlock = numberToHex(filter.fromBlock);
+			if (
+				!isNullish(filter.toBlock) &&
+				(typeof filter.toBlock === 'bigint' || typeof filter.toBlock === 'number')
+			)
+				toBlock = numberToHex(filter.toBlock);
+			expect(ethRpcMethods.getLogs).toHaveBeenCalledWith(web3Eth.requestManager, {
+				...filter,
+				toBlock,
+				fromBlock,
+			});
+		});
+	});
+});

packages/web3-eth/test/unit/web3_eth_methods_with_parameters.test.ts

@@ -26,15 +26,12 @@ import {
 } from '../fixtures/rpc_methods_wrappers';
 import {
 	estimateGasValidData,
-	// estimateGasValidData,
 	getBalanceValidData,
 	getBlockTransactionCountValidData,
 	getBlockUncleCountValidData,
 	getBlockValidData,
 	getCodeValidData,
 	getFeeHistoryValidData,
-	// getCodeValidData,
-	// getFeeHistoryValidData,
 	getPastLogsValidData,
 	getProofValidData,
 	getStorageAtValidData,
@@ -341,6 +338,18 @@ describe('web3_eth_methods_with_parameters', () => {
 						},
 					);
 				});
+				describe('getPastLogs called with rpcMethodWrappers', () => {
+					it.each(getPastLogsValidData)(
+						'input: %s\nrpcMethodParameters: %s',
+						async (_, rpcMethodParameters) => {
+							await rpcMethodWrappers.getLogs(web3Eth, ...rpcMethodParameters);
+							expect(rpcMethodWrappers.getLogs).toHaveBeenCalledWith(
+								web3Eth,
+								...rpcMethodParameters,
+							);
+						},
+					);
+				});
 
 				describe('createAccessList', () => {
 					it.each(createAccessListTestData)(

packages/web3-rpc-methods/CHANGELOG.md

@@ -97,3 +97,7 @@ Documentation:
 -   Dependencies updated
 
 ## [Unreleased]
+
+### Fixed
+
+-   Rpc method `getPastLogs` accept blockHash as a parameter https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs (#6181)

packages/web3-types/CHANGELOG.md

@@ -135,3 +135,7 @@ Documentation:
 -   Fixed bug #6185, now web3.js compiles on typescript v5 (#6195)
 
 ## [Unreleased]
+
+### Fixed
+
+-   type `Filter` includes `blockHash` (#6206)

packages/web3-types/src/eth_types.ts

@@ -226,7 +226,7 @@ export interface Filter {
 	readonly fromBlock?: BlockNumberOrTag;
 	readonly toBlock?: BlockNumberOrTag;
 	readonly address?: Address | Address[];
-
+	readonly blockHash?: Address;
 	// Using "null" type intentionally to match specifications
 	// eslint-disable-next-line @typescript-eslint/ban-types
 	readonly topics?: (null | Topic | Topic[])[];

packages/web3-utils/CHANGELOG.md

@@ -135,3 +135,7 @@ Documentation:
 -   Dependencies updated
 
 ## [Unreleased]
+
+### Fixed
+
+-   BigInts pass validation within the method `numberToHex` (#6206)

packages/web3-utils/src/converters.ts

@@ -175,11 +175,10 @@ export const toDecimal = hexToNumber;
  * ```
  */
 export const numberToHex = (value: Numbers, hexstrict?: boolean): HexString => {
-	validator.validate(['int'], [value]);
+	if (typeof value !== 'bigint') validator.validate(['int'], [value]);
 	// To avoid duplicate code and circular dependency we will
 	// use `numberToHex` implementation from `web3-validator`
 	let updatedValue = validatorUtils.numberToHex(value);
-	// return validatorUtils.numberToHex(value);
 	if (hexstrict) {
 		if (!updatedValue.startsWith('-') && updatedValue.length % 2 === 1) {
 			// To avoid duplicate a circular dependancy we will not be using the padLeft method

packages/web3-validator/src/validation/filter.ts

@@ -33,6 +33,7 @@ export const isFilterObject = (value: Filter) => {
 		'toBlock',
 		'address',
 		'topics',
+		'blockHash',
 	];
 	if (isNullish(value) || typeof value !== 'object') return false;