`sendTransaction` and `sendSignedTransaction` Error Refactors #5854

spacesailor24 · 2023-02-22T07:47:02Z

Added

web3-errors

request property to ResponseError (sendTransaction and sendSignedTransaction Error Refactors #5854)
data property to TransactionRevertInstructionError (sendTransaction and sendSignedTransaction Error Refactors #5854)
TransactionRevertWithCustomError was added to handle custom solidity errors (sendTransaction and sendSignedTransaction Error Refactors #5854)

web3-eth

contractAbi option to SendTransactionOptions and SendSignedTransactionOptions to added the ability to parse custom solidity errors (sendTransaction and sendSignedTransaction Error Refactors #5854)

Changed

web3-errors

Renamed TransactionRevertError to TransactionRevertInstructionError to remain consistent with 1.x (sendTransaction and sendSignedTransaction Error Refactors #5854)

web3-eth

sendTransaction and sendSignedTransaction now errors with (and error event emits) the following possible errors: TransactionRevertedWithoutReasonError, TransactionRevertInstructionError, TransactionRevertWithCustomError, InvalidResponseError, or ContractExecutionError (sendTransaction and sendSignedTransaction Error Refactors #5854)

spacesailor24 · 2023-02-23T05:59:40Z

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

@@ -55,16 +65,24 @@ export class ResponseError<ErrorType = unknown> extends BaseWeb3Error {
 				? response.map(r => r.error?.data as ErrorType)
 				: response?.error?.data;
 		}
+
+		this.request = request;


I've added request to the error object as I wanted to add sent transaction details to failed transaction errors to give the user more context (e.g. the sending account when the error Unknown account or Insufficient funds is thrown) on what exactly was sent to provider

spacesailor24 · 2023-02-23T06:08:50Z

packages/web3-eth/src/rpc_method_wrappers.ts

-						if (web3Context.handleRevert) {
-							// eslint-disable-next-line no-use-before-define
-							await getRevertReason(
-								web3Context,
-								transactionFormatted as TransactionCall,
-							);
-						}
-


This is part of addressing #5839, the revert reason is retrieved after the transaction has been processed by the network and when transactionReceipt.status === BigInt(0)

spacesailor24 · 2023-02-23T06:36:26Z

packages/web3-eth/src/rpc_method_wrappers.ts

-								promiEvent.emit(
-									'error',
-									new TransactionError(
-										'Transaction failed',
-										transactionReceiptFormatted,
-									),
-								);


This was the cause of #5837

spacesailor24 · 2023-02-23T06:39:10Z

packages/web3-eth/src/rpc_method_wrappers.ts

-						if (error instanceof ContractExecutionError) {
-							promiEvent.emit('contractExecutionError', error);
-						}


I don't think there's a reason to have an contractExecutionError event when we already have a generic error event that every other error uses (@nikoulai please let me know if there was a specific reason for it since you added it in #5659)

I see now that it's being using in web3-eth-contract

web3-eth-contract was updated to check for error instanceof ContractExecutionError instead of relying on an emission of contractExecutionError event

spacesailor24 · 2023-02-23T07:56:59Z

packages/web3-eth/src/utils/get_revert_reason.ts

@@ -25,6 +25,45 @@ import { DataFormat, DEFAULT_RETURN_FORMAT } from 'web3-utils';
 import { call } from '../rpc_method_wrappers';
 import { RevertReason, RevertReasonWithCustomError } from '../types';

+export const parseTransactionError = (error: unknown, contractAbi?: ContractAbi) => {


Moved to it's own function so it could make getRevertReason more concise and because the new util method getTransactionError uses it

…ts with BigInts

…to SendTransactionOptions

github-actions · 2023-02-24T02:27:46Z

Bundle Stats

Hey there, this message comes from a github action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Asset	Old size	New size	Diff	Diff %
Total	1.18 MB	1.06 MB	-116 KB	-9.61%

View detailed bundle breakdown

Added

Asset	New size	Diff	Diff %
../lib/eth.exports.d.ts.map	358 bytes	358 bytes	-
../lib/eth.exports.d.ts	321 bytes	321 bytes	-
../lib/providers.exports.d.ts.map	292 bytes	292 bytes	-
../lib/providers.exports.d.ts	238 bytes	238 bytes	-

Removed

No assets were removed

Bigger

Asset	Old size	New size	Diff	Diff %
../lib/index.d.ts	77 bytes	899 bytes	822 bytes	1067.53%
../lib/index.d.ts.map	155 bytes	919 bytes	764 bytes	492.90%

Smaller

Asset	Old size	New size	Diff	Diff %
web3.min.js	1.17 MB	1.05 MB	-118 KB	-9.88%
../lib/types.d.ts	1.92 KB	1.68 KB	-253 bytes	-12.84%
../lib/types.d.ts.map	1.75 KB	1.51 KB	-241 bytes	-13.46%

Unchanged

Asset	Old size	New size	Diff	Diff %
../lib/accounts.d.ts	3.42 KB	3.42 KB	0	0.00%
../lib/abi.d.ts	1020 bytes	999 bytes	-18 bytes	-1.77%
../lib/web3.d.ts	842 bytes	842 bytes	0	0.00%
../lib/web3.d.ts.map	693 bytes	694 bytes	1 bytes	0.14%
../lib/accounts.d.ts.map	528 bytes	528 bytes	0	0.00%
../lib/version.d.ts.map	140 bytes	140 bytes	0	0.00%
../lib/abi.d.ts.map	124 bytes	124 bytes	0	0.00%
../lib/version.d.ts	97 bytes	97 bytes	0	0.00%

cloudflare-workers-and-pages · 2023-02-24T02:31:19Z

Deploying with Cloudflare Pages

Latest commit:	`c216751`
Status:	✅ Deploy successful!
Preview URL:	https://4e10d048.web3-js-docs.pages.dev
Branch Preview URL:	https://wyatt-4-x-5840-requstmanger-.web3-js-docs.pages.dev

View logs

…on_error.ts

…act class

…scendants (#5891) * rename `_providerOptions` to `_socketOptions` * pass `_socketOptions` from IpcProvider constructor to the underlying connection * move a comment to its correct position at `SocketProvider` * expose the getter of `SocketConnection` from `SocketProvider`. * update CHANGELOG.md files * add extremely simple unit test for SocketProvider

* version fix * use geth binary * try 1.11.2

* use `v1` instead of short Sha for cloudflare/pages-action

spacesailor24 added 4 commits February 21, 2023 17:16

Add payload as optional argument for InvalidResponseError

43d93de

Init Transaction Error Scenarios tests

db9cb50

Init ERR_TX_REVERT_TRANSACTION_CUSTOM_ERROR

8eb82ba

WIP

e4a2891

spacesailor24 added the 4.x 4.0 related label Feb 22, 2023

spacesailor24 self-assigned this Feb 22, 2023

spacesailor24 commented Feb 23, 2023

View reviewed changes

WIP

36c9b0d

spacesailor24 commented Feb 23, 2023

View reviewed changes

spacesailor24 added 8 commits February 23, 2023 15:10

Update TransactionRevertedWithoutReasonError to handle receipts objec…

2378e6a

…ts with BigInts

Update sendTransaction revert tests

044fea2

Add contractAbi argument to getTransactionError

3a12870

sendTransation emits error for ContractExecutionError

63554f2

Add ContractExecutionError to SendTransactionEvents. Add contractAbi …

8c33881

…to SendTransactionOptions

Replace use of contractExecutionError sendTransaction event with error

853d0b2

Update contract_methods reverts test

bd4ff70

Merge branch '4.x' into wyatt/4.x/5840-requstmanger-return-errors

75a99f2

Update web3-errors test

d075a86

github-actions bot temporarily deployed to Preview: (wyatt/4.x/5840-requstmanger-return-errors) February 24, 2023 02:30 Inactive

github-actions bot temporarily deployed to Preview: (wyatt/4.x/5840-requstmanger-return-errors) February 24, 2023 02:31 Inactive

spacesailor24 added 2 commits February 23, 2023 17:05

Update expected error mesage for contract_deploy_test

2b59dc6

Add expectedErrorObject based on test backend

7e830d2

github-actions bot temporarily deployed to Preview: (wyatt/4.x/5840-requstmanger-return-errors) February 24, 2023 03:20 Inactive

Correct web3-errors test snapshots

91a4e6f

github-actions bot temporarily deployed to Preview: (wyatt/4.x/5840-requstmanger-return-errors) February 24, 2023 04:17 Inactive

spacesailor24 and others added 22 commits March 9, 2023 09:20

Add example to dev comment for sendSignedTransaction

d6fc658

Removed implemented TODO in packages/web3-eth/src/utils/get_transacti…

3d3e7bc

…on_error.ts

Update CHANGELOGs

64a3e1f

Update CHANGELOG.md

fedc918

Init get_transaction_error tests

c54d2b9

Add mock to getRevertReason for get_transaction_error tests

683515c

Init getRevertReason tests and parseTransactionError tests

547f9be

Add check for revert before sending tx

9e3c637

Update web3-plugin-example test to account for getRevertReason check

f4f43f8

Turn off checkRevertBeforeSending for sendFewTxes helper

d72206c

Fix test data for send_signed_transaction tests

2b816bf

Fix bug in get_transaction_error

c4180b6

Fix send_transaction error test

306b650

Add checkRevertBeforeSending: false to sendTransaction calls in Contr…

76ee3da

…act class

Add checkRevertBeforeSending: false for send tx test helpers

bcffc9f

Remove getRevertReason mock

2828b41

Fix failed tx test for ganache

e79e59f

Update expected transaction errors for ganache

a2175ff

Fix method handler crashed (#5905)

5cbb9bf

* version fix * use geth binary * try 1.11.2

Test fix

e267663

Use v1 instead of Short Sha for cloudflare/pages-action (#5909)

2662eaf

* use `v1` instead of short Sha for cloudflare/pages-action

spacesailor24 force-pushed the wyatt/4.x/5840-requstmanger-return-errors branch from 679d2fa to 2662eaf Compare March 9, 2023 19:21

Merge branch '4.x' into wyatt/4.x/5840-requstmanger-return-errors

c216751

github-actions bot deployed to web3-js-docs (Preview) March 9, 2023 19:30 View deployment

github-actions bot deployed to web3-js-docs (Preview) March 9, 2023 19:39 View deployment

spacesailor24 merged commit f758099 into 4.x Mar 9, 2023

spacesailor24 deleted the wyatt/4.x/5840-requstmanger-return-errors branch March 9, 2023 20:04

jdevcs mentioned this pull request Mar 10, 2023

Release/4.0.1 rc.0 #5912

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`sendTransaction` and `sendSignedTransaction` Error Refactors #5854

`sendTransaction` and `sendSignedTransaction` Error Refactors #5854

spacesailor24 commented Feb 22, 2023 •

edited

Loading

spacesailor24 Feb 23, 2023

spacesailor24 Feb 23, 2023

spacesailor24 Feb 23, 2023

spacesailor24 Feb 23, 2023

spacesailor24 Feb 23, 2023

spacesailor24 Feb 25, 2023 •

edited

Loading

spacesailor24 Feb 23, 2023 •

edited

Loading

github-actions bot commented Feb 24, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Feb 24, 2023 •

edited

Loading

sendTransaction and sendSignedTransaction Error Refactors #5854

sendTransaction and sendSignedTransaction Error Refactors #5854

Conversation

spacesailor24 commented Feb 22, 2023 • edited Loading

Added

web3-errors

web3-eth

Changed

web3-errors

web3-eth

spacesailor24 Feb 23, 2023

Choose a reason for hiding this comment

spacesailor24 Feb 23, 2023

Choose a reason for hiding this comment

spacesailor24 Feb 23, 2023

Choose a reason for hiding this comment

spacesailor24 Feb 23, 2023

Choose a reason for hiding this comment

spacesailor24 Feb 23, 2023

Choose a reason for hiding this comment

spacesailor24 Feb 25, 2023 • edited Loading

Choose a reason for hiding this comment

spacesailor24 Feb 23, 2023 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Feb 24, 2023 • edited Loading

Bundle Stats

cloudflare-workers-and-pages bot commented Feb 24, 2023 • edited Loading

Deploying with Cloudflare Pages

`sendTransaction` and `sendSignedTransaction` Error Refactors #5854

`sendTransaction` and `sendSignedTransaction` Error Refactors #5854

spacesailor24 commented Feb 22, 2023 •

edited

Loading

spacesailor24 Feb 25, 2023 •

edited

Loading

spacesailor24 Feb 23, 2023 •

edited

Loading

github-actions bot commented Feb 24, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Feb 24, 2023 •

edited

Loading