Merge branch 'wyatt/4.x/5091-chainlink-plugin' of github.com:ChainSafe/web3.js into wyatt/4.x/5091-chainlink-plugin

Author: spacesailor24

CHANGELOG.md

@@ -602,6 +602,9 @@ Released with 1.0.0-beta.37 code base.
 
 ## [4.0.0-alpha.0]
 
+Note: Yarn is resolving to some old deprecated package versions for 4.0.0-alpha.0 instead of latest alpha versions. A patch bump is posted so yarn users
+should use 4.0.1-alpha.0 for testing.
+
 ### Added
 
 #### web3-errors

packages/web3-core/src/web3_config.ts

@@ -104,6 +104,8 @@ export abstract class Web3Config
 	 * - myContract.methods.myMethod().call()
 	 * - myContract.methods.myMethod().send()
 	 * Default is `false`.
+	 *
+	 * `Note`: At the moment `handleRevert` is only supported for `sendTransaction` and not for `sendSignedTransaction`
 	 */
 	public get handleRevert() {
 		return this._config.handleRevert;

packages/web3-errors/src/errors/transaction_errors.ts

@@ -60,8 +60,8 @@ export class TransactionRevertError extends Web3Error {
 
 	public constructor(
 		public reason: string,
-		public signature: string,
-		public receipt: TransactionReceipt,
+		public signature?: string,
+		public receipt?: TransactionReceipt,
 	) {
 		super(
 			`Transaction has been reverted by the EVM:\n ${JSON.stringify(receipt, undefined, 2)}`,

packages/web3-eth/src/rpc_method_wrappers.ts

@@ -50,7 +50,7 @@ import {
 	waitWithTimeout,
 } from 'web3-utils';
 import { isBlockTag, isBytes, isNullish, isString } from 'web3-validator';
-import { TransactionError } from 'web3-errors';
+import { TransactionError, TransactionRevertError } from 'web3-errors';
 import { SignatureError, TransactionSendTimeoutError } from './errors';
 import * as rpcMethods from './rpc_methods';
 import {
@@ -1071,6 +1071,15 @@ export function sendTransaction<
 							ETH_DATA_FORMAT,
 						);
 
+						if (web3Context.handleRevert) {
+							// eslint-disable-next-line no-use-before-define
+							await getRevertReason(
+								web3Context,
+								transactionFormatted as TransactionCall,
+								returnFormat,
+							);
+						}
+
 						if (
 							!options?.ignoreGasPricing &&
 							isNullish(transactionFormatted.gasPrice) &&
@@ -1320,6 +1329,11 @@ export function sendSignedTransaction<
 						if (promiEvent.listenerCount('sending') > 0) {
 							promiEvent.emit('sending', signedTransactionFormattedHex);
 						}
+						// todo enable handleRevert for sendSignedTransaction when we have a function to decode transactions
+						// importing a package for this would increase the size of the library
+						// if (web3Context.handleRevert) {
+						// 	await getRevertReason(web3Context, transaction, returnFormat);
+						// }
 
 						const transactionHash = await rpcMethods.sendRawTransaction(
 							web3Context.requestManager,
@@ -1893,3 +1907,19 @@ export async function getFeeHistory<ReturnFormat extends DataFormat>(
 
 	return format(feeHistorySchema, response as unknown as FeeHistory, returnFormat);
 }
+/**
+ *
+ * @param web3Context
+ * @param transaction
+ */
+async function getRevertReason<ReturnFormat extends DataFormat>(
+	web3Context: Web3Context<EthExecutionAPI>,
+	transaction: TransactionCall,
+	returnFormat: ReturnFormat,
+) {
+	try {
+		await call(web3Context, transaction, web3Context.defaultBlock, returnFormat);
+	} catch (err) {
+		throw new TransactionRevertError((err as Error).message);
+	}
+}

packages/web3/test/integration/handle_revert.test.ts

@@ -0,0 +1,136 @@
+/*
+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 WebSocketProvider from 'web3-providers-ws';
+import { Contract } from 'web3-eth-contract';
+import { TransactionRevertError } from 'web3-errors';
+import Web3 from '../../src/index';
+import {
+	createNewAccount,
+	getSystemTestProvider,
+	isWs,
+} from '../shared_fixtures/system_tests_utils';
+import { BasicAbi, BasicBytecode } from '../shared_fixtures/build/Basic';
+
+Error.stackTraceLimit = Infinity;
+
+describe('eth', () => {
+	let web3: Web3;
+	let accounts: string[] = [];
+	let clientUrl: string;
+
+	let contract: Contract<typeof BasicAbi>;
+	let deployOptions: Record<string, unknown>;
+	let sendOptions: Record<string, unknown>;
+
+	beforeAll(async () => {
+		clientUrl = getSystemTestProvider();
+		const acc1 = await createNewAccount({ unlock: true, refill: true });
+		const acc2 = await createNewAccount({ unlock: true, refill: true });
+		accounts = [acc1.address, acc2.address];
+		web3 = new Web3(getSystemTestProvider());
+		if (isWs) {
+			web3 = new Web3(
+				new WebSocketProvider(
+					clientUrl,
+					{},
+					{ delay: 1, autoReconnect: false, maxAttempts: 1 },
+				),
+			);
+		} else {
+			web3 = new Web3(clientUrl);
+		}
+
+		if (isWs) {
+			contract = new web3.eth.Contract(BasicAbi, undefined, {
+				provider: new WebSocketProvider(
+					clientUrl,
+					{},
+					{ delay: 1, autoReconnect: false, maxAttempts: 1 },
+				),
+			});
+		} else {
+			contract = new web3.eth.Contract(BasicAbi, undefined, {
+				provider: clientUrl,
+			});
+		}
+
+		deployOptions = {
+			data: BasicBytecode,
+			arguments: [10, 'string init value'],
+		};
+
+		sendOptions = { from: accounts[0], gas: '1000000' };
+
+		contract = await contract.deploy(deployOptions).send(sendOptions);
+	});
+	afterAll(() => {
+		if (isWs && web3?.provider) {
+			(web3.provider as WebSocketProvider).disconnect();
+			(contract.provider as WebSocketProvider).disconnect();
+		}
+	});
+
+	describe('handleRevert', () => {
+		// todo enable when figure out what happening in eth_call (doesn't throw error)
+		// eslint-disable-next-line jest/expect-expect
+		it('should get revert reason', async () => {
+			contract.handleRevert = true;
+			await expect(contract.methods.reverts().send({ from: accounts[0] })).rejects.toThrow(
+				new TransactionRevertError(
+					'Returned error: execution reverted: REVERTED WITH REVERT',
+				),
+			);
+		});
+
+		it('should get revert reason for eth tx', async () => {
+			web3.eth.handleRevert = true;
+			await expect(
+				web3.eth.sendTransaction({
+					from: accounts[0],
+					gas: '0x3d0900',
+					gasPrice: '0x3B9ACBF4',
+					input: '0x608060405234801561001057600080fdklkl',
+					nonce: '0x10',
+					to: undefined,
+					value: '0x0',
+					type: '0x0',
+					v: '0xa96',
+					r: '0x1ba80b16306d1de8ff809c00f67c305e8636326096aba282828d331aa2ec30a1',
+					s: '0x39f77e0b68d5524826e4385ad4e1f01e748f32c177840184ae65d9592fdfe5c',
+				}),
+			).rejects.toThrow(
+				new TransactionRevertError(
+					'Returned error: invalid argument 0: json: cannot unmarshal invalid hex string into Go struct field TransactionArgs.data of type hexutil.Bytes',
+				),
+			);
+		});
+
+		it('should execute transaction', async () => {
+			web3.eth.handleRevert = true;
+			await expect(
+				web3.eth.sendTransaction({
+					from: accounts[0],
+					to: accounts[1],
+					gas: '0x76c0',
+					gasPrice: '0x9184e72a000',
+					value: '0x9184e72a',
+					data: '0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675',
+				}),
+			).resolves.toBeDefined();
+		});
+	});
+});

packages/web3/test/shared_fixtures/build

@@ -0,0 +1 @@
+../../../../fixtures/build