Init getRevertReason tests and parseTransactionError tests

packages/web3-eth/test/unit/utils/get_revert_reason.test.ts

@@ -0,0 +1,125 @@
+/*
+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 { Web3Context } from 'web3-core';
+import { DEFAULT_RETURN_FORMAT } from 'web3-utils';
+
+import * as RpcMethodWrappers from '../../../src/rpc_method_wrappers';
+import * as GetRevertReason from '../../../src/utils/get_revert_reason';
+import { SimpleRevertAbi } from '../../fixtures/simple_revert';
+
+describe('getRevertReason', () => {
+	const web3Context = new Web3Context();
+
+	it('should use the call rpc wrapper', async () => {
+		const callSpy = jest.spyOn(RpcMethodWrappers, 'call').mockImplementation();
+
+		const transaction = {
+			from: '0x4fec0a51024b13030d26e70904b066c6d41157a5',
+			to: '0x36361143b7e2c676f8ccd67743a89d26437f0529',
+			data: '0x819f48fe',
+			gasPrice: '0x15ab8f14',
+			maxPriorityFeePerGas: undefined,
+			maxFeePerGas: undefined,
+		};
+
+		await GetRevertReason.getRevertReason(web3Context, transaction);
+
+		expect(callSpy).toHaveBeenCalledWith(
+			web3Context,
+			transaction,
+			web3Context.defaultBlock,
+			DEFAULT_RETURN_FORMAT,
+		);
+	});
+
+	it('should return undefined', async () => {
+		jest.spyOn(RpcMethodWrappers, 'call').mockResolvedValueOnce(
+			'0x000000000000000000000000000000000000000000000000000000000000000a',
+		);
+
+		const transaction = {
+			from: '0x4fec0a51024b13030d26e70904b066c6d41157a5',
+			to: '0x36361143b7e2c676f8ccd67743a89d26437f0529',
+			data: '0x819f48fe',
+			gasPrice: '0x15ab8f14',
+			maxPriorityFeePerGas: undefined,
+			maxFeePerGas: undefined,
+		};
+
+		const result = await GetRevertReason.getRevertReason(web3Context, transaction);
+
+		expect(result).toBeUndefined();
+	});
+
+	it('should call parseTransactionError without contractAbi', async () => {
+		const expectedError = {
+			jsonrpc: '2.0',
+			id: 1,
+			error: {
+				code: -32000,
+				message:
+					'err: insufficient funds for gas * price + value: address 0x0000000000000000000000000000000000000000 have 66 want 9983799287684 (supplied gas 26827)',
+			},
+		};
+		const parseTransactionErrorSpy = jest
+			.spyOn(GetRevertReason, 'parseTransactionError')
+			.mockImplementation();
+		jest.spyOn(RpcMethodWrappers, 'call').mockRejectedValueOnce(expectedError);
+
+		const transaction = {
+			from: '0x4fec0a51024b13030d26e70904b066c6d41157a5',
+			to: '0x36361143b7e2c676f8ccd67743a89d26437f0529',
+			data: '0x819f48fe',
+			gasPrice: '0x15ab8f14',
+			maxPriorityFeePerGas: undefined,
+			maxFeePerGas: undefined,
+		};
+
+		await GetRevertReason.getRevertReason(web3Context, transaction);
+
+		expect(parseTransactionErrorSpy).toHaveBeenCalledWith(expectedError, undefined);
+	});
+
+	it('should call parseTransactionError with contractAbi', async () => {
+		const expectedError = {
+			jsonrpc: '2.0',
+			id: 1,
+			error: {
+				code: -32000,
+				message:
+					'err: insufficient funds for gas * price + value: address 0x0000000000000000000000000000000000000000 have 66 want 9983799287684 (supplied gas 26827)',
+			},
+		};
+		const parseTransactionErrorSpy = jest
+			.spyOn(GetRevertReason, 'parseTransactionError')
+			.mockImplementation();
+		jest.spyOn(RpcMethodWrappers, 'call').mockRejectedValueOnce(expectedError);
+
+		const transaction = {
+			from: '0x4fec0a51024b13030d26e70904b066c6d41157a5',
+			to: '0x36361143b7e2c676f8ccd67743a89d26437f0529',
+			data: '0x819f48fe',
+			gasPrice: '0x15ab8f14',
+			maxPriorityFeePerGas: undefined,
+			maxFeePerGas: undefined,
+		};
+
+		await GetRevertReason.getRevertReason(web3Context, transaction, SimpleRevertAbi);
+
+		expect(parseTransactionErrorSpy).toHaveBeenCalledWith(expectedError, SimpleRevertAbi);
+	});
+});

packages/web3-eth/test/unit/utils/parse_transaction_error.test.ts

@@ -0,0 +1,89 @@
+/*
+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 { ContractExecutionError, InvalidResponseError } from 'web3-errors';
+
+import { parseTransactionError } from '../../../src/utils/get_revert_reason';
+import { SimpleRevertAbi } from '../../fixtures/simple_revert';
+
+describe('parseTransactionError', () => {
+	it('should return object of type RevertReason', () => {
+		const error = new ContractExecutionError({
+			code: 3,
+			message: 'execution reverted: This is a send revert',
+			data: '0x08c379a0000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000155468697320697320612073656e64207265766572740000000000000000000000',
+		});
+
+		const result = parseTransactionError(error);
+		expect(result).toStrictEqual({
+			reason: 'execution reverted: This is a send revert',
+			signature: '0x08c379a0',
+			data: '000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000155468697320697320612073656e64207265766572740000000000000000000000',
+		});
+	});
+
+	it('should return object of type RevertReasonWithCustomError', () => {
+		const error = new ContractExecutionError({
+			code: 3,
+			message: 'execution reverted',
+			data: '0xc85bda60000000000000000000000000000000000000000000000000000000000000002a0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000001c5468697320697320616e206572726f72207769746820706172616d7300000000',
+		});
+
+		const result = parseTransactionError(error, SimpleRevertAbi);
+		expect(result).toStrictEqual({
+			reason: 'execution reverted',
+			signature: '0xc85bda60',
+			data: '000000000000000000000000000000000000000000000000000000000000002a0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000001c5468697320697320616e206572726f72207769746820706172616d7300000000',
+			customErrorName: 'ErrorWithParams',
+			customErrorDecodedSignature: 'ErrorWithParams(uint256,string)',
+			customErrorArguments: {
+				'0': BigInt(42),
+				'1': 'This is an error with params',
+				__length__: 2,
+				code: BigInt(42),
+				message: 'This is an error with params',
+			},
+		});
+	});
+
+	it('should return object of type string', () => {
+		const error = new InvalidResponseError({
+			jsonrpc: '2.0',
+			id: '3f839900-afdd-4553-bca7-b4e2b835c687',
+			error: { code: -32000, message: 'intrinsic gas too low' },
+		});
+
+		const result = parseTransactionError(error);
+		expect(result).toBe('intrinsic gas too low');
+	});
+
+	it('should throw an error', () => {
+		const error = new InvalidResponseError([
+			{
+				jsonrpc: '2.0',
+				id: '3f839900-afdd-4553-bca7-b4e2b835c687',
+				error: { code: -32000, message: 'intrinsic gas too low' },
+			},
+			{
+				jsonrpc: '2.0',
+				id: '3f839900-afdd-4553-bca7-b4e2b835c687',
+				error: { code: -32000, message: 'intrinsic gas too low' },
+			},
+		]);
+
+		expect(() => parseTransactionError(error)).toThrowError(error);
+	});
+});