Enhance transaction validation with standardized RPC errors #1690

vinistevam · 2023-09-20T10:05:41Z

Explanation

This PR aims to update the TransactionController to throw standardised rpcErrors.invalidParams errors using the @metamask/rpc-errors package that will ensure they are standardised and more easily parsed and recognised by the dApps.

Context
The extension TransactionController uses the eth-rpc-errors package to throw standardised errors when validation fails. This update is a part of the ongoing TransactionController unification effort.

Note: As the colleagues pointed out in this PR eth-rpc-errors is deprecated so for equivalence the @metamask/rpc-errors package was added in the TransactionController and usages in the code was replaced accordingly.

Bump @metamask/rpc-errors to v6 in transaction-controller and assets-controller.

References

Changelog

`@metamask/transaction-controller`

CHANGED: update validateTxParams to throw standardised errors using the @metamask/rpc-errors package.
- add @metamask/rpc-errors package.
- remove eth-rpc-errors and replace usage with the new package.

Checklist

I've updated the test suite for new or updated code as appropriate
I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
I've highlighted breaking changes using the "BREAKING" category above as appropriate

legobeat · 2023-09-20T10:24:26Z

eth-rpc-errors is deprecated - would it be possible to standardize directly on updated and maintained @metamask/rpc-errors?

There is an open draft PR for @metamask/rpc-errors update here:

deps: Bump @metamask/{eth-json-rpc-provider,rpc-errors} #1653

matthewwalsh0 · 2023-09-21T21:07:43Z

eth-rpc-errors is deprecated - would it be possible to standardize directly on updated and maintained @metamask/rpc-errors?

There is an open draft PR for @metamask/rpc-errors update here:

deps: Bump @metamask/{eth-json-rpc-provider,rpc-errors,utils} #1653

This makes sense to me assuming it's functionally identical and the resulting exception are the same?

The goal here is to align with the extension so if this diverges further, it may be best to update the package down the line.

legobeat · 2023-09-21T22:25:05Z

@matthewwalsh0 Yes, the direction is that all active use of eth-rpc-errors must be actively removed/replaced with @metamask/rpc-errors including in MetaMask libraries, extension, and mobile. v4 and v6 are not completely identical.

The changelog is here: https://github.com/MetaMask/rpc-errors/blob/main/CHANGELOG.md

See esp v5.0.0 for API changes in the package.

The major thing here is the version upgrade - it's an associated package rename, not a change of dependencies per se.

Mrtenz

Please use @metamask/rpc-errors.

vinistevam · 2023-09-22T12:29:34Z

Please use @metamask/rpc-errors.

Thanks for the heads up @legobeat and @Mrtenz 🙏 I pushed the changes to use @metamask/rpc-errors instead of eth-rpc-errors

Fixed

legobeat

v6 has compatibility fixes in types

packages/transaction-controller/package.json

Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>

socket-security · 2023-09-25T09:50:10Z

Removed dependencies detected. Learn more about Socket for GitHub ↗︎

🚮 Removed packages: @metamask/rpc-errors@5.1.1

this now uses @metamask/rpc-errors@6.0.0

legobeat

LGTM

## Explanation This replaces obsolete `eth-rpc-errors` with `@metamask/rpc-errors` in `@metamask/approval-controller`. This should be coupled with #1639 and can be merged before or after. ## References #### Broken out from - #1731 #### Blocking - #1724 #### Related - #1690 ## Changelog ### `@metamask/approval-controller` - **Changed**: Replaced `eth-rpc-errors` with `@metamask/rpc-errors` ### `@metamask/controller-utils` - **Fixed**: Removed unused dependency `eth-rpc-errors` ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate

## Explanation This PR aims to update the `TransactionController` to throw standardised `rpcErrors.invalidParams` errors using the `@metamask/rpc-errors` package that will ensure they are standardised and more easily parsed and recognised by the dApps. **Context** The extension `TransactionController` uses the `eth-rpc-errors` package to throw standardised errors when validation fails. This update is a part of the ongoing TransactionController unification effort. Note: As the colleagues pointed out in this PR `eth-rpc-errors` is deprecated so for equivalence the `@metamask/rpc-errors` package was added in the `TransactionController` and usages in the code was replaced accordingly. Bump `@metamask/rpc-errors` to v6 in `transaction-controller` and `assets-controller`. ### `@metamask/transaction-controller` - **CHANGED**: update `validateTxParams` to throw standardised errors using the `@metamask/rpc-errors` package. - add `@metamask/rpc-errors` package. - remove `eth-rpc-errors` and replace usage with the new package.

## Explanation This replaces obsolete `eth-rpc-errors` with `@metamask/rpc-errors` in `@metamask/approval-controller`. This should be coupled with #1639 and can be merged before or after. ## References #### Broken out from - #1731 #### Blocking - #1724 #### Related - #1690 ## Changelog ### `@metamask/approval-controller` - **Changed**: Replaced `eth-rpc-errors` with `@metamask/rpc-errors` ### `@metamask/controller-utils` - **Fixed**: Removed unused dependency `eth-rpc-errors` ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate

## Explanation This PR aims to update the `TransactionController` to throw standardised `rpcErrors.invalidParams` errors using the `@metamask/rpc-errors` package that will ensure they are standardised and more easily parsed and recognised by the dApps. **Context** The extension `TransactionController` uses the `eth-rpc-errors` package to throw standardised errors when validation fails. This update is a part of the ongoing TransactionController unification effort. Note: As the colleagues pointed out in this PR `eth-rpc-errors` is deprecated so for equivalence the `@metamask/rpc-errors` package was added in the `TransactionController` and usages in the code was replaced accordingly. Bump `@metamask/rpc-errors` to v6 in `transaction-controller` and `assets-controller`. ### `@metamask/transaction-controller` - **CHANGED**: update `validateTxParams` to throw standardised errors using the `@metamask/rpc-errors` package. - add `@metamask/rpc-errors` package. - remove `eth-rpc-errors` and replace usage with the new package.

## Explanation This replaces obsolete `eth-rpc-errors` with `@metamask/rpc-errors` in `@metamask/approval-controller`. This should be coupled with #1639 and can be merged before or after. ## References #### Broken out from - #1731 #### Blocking - #1724 #### Related - #1690 ## Changelog ### `@metamask/approval-controller` - **Changed**: Replaced `eth-rpc-errors` with `@metamask/rpc-errors` ### `@metamask/controller-utils` - **Fixed**: Removed unused dependency `eth-rpc-errors` ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate

vinistevam and others added 2 commits September 20, 2023 10:42

Refactor: Throw standardized RPC errors

0036869

Merge branch 'main' into refactor/973-throw-rpc-error-validation

ff4441a

vinistevam changed the title ~~Refactor: Throw standardized RPC errors using eth-rpc-errors when validation fails adding transaction~~ Throw standardized RPC errors using eth-rpc-errors when validation fails adding transaction Sep 20, 2023

vinistevam changed the title ~~Throw standardized RPC errors using eth-rpc-errors when validation fails adding transaction~~ Enhance transaction validation with standardized RPC errors using eth-rpc-errors Sep 20, 2023

vinistevam marked this pull request as ready for review September 20, 2023 10:19

vinistevam requested a review from a team as a code owner September 20, 2023 10:19

OGPoyraz previously approved these changes Sep 20, 2023

View reviewed changes

vinistevam mentioned this pull request Sep 21, 2023

Add EIP-1559 compatibility validation for transaction creation #1693

Merged

3 tasks

Mrtenz previously requested changes Sep 22, 2023

View reviewed changes

use @metamask/rpc-errors to standardize errors

c989fdc

vinistevam dismissed OGPoyraz’s stale review via c989fdc September 22, 2023 12:13

Merge branch 'main' into refactor/973-throw-rpc-error-validation

e39129b

vinistevam changed the title ~~Enhance transaction validation with standardized RPC errors using eth-rpc-errors~~ Enhance transaction validation with standardized RPC errors Sep 22, 2023

Merge branch 'main' into refactor/973-throw-rpc-error-validation

566c941

legobeat previously requested changes Sep 22, 2023

View reviewed changes

packages/transaction-controller/package.json Outdated Show resolved Hide resolved

vinistevam and others added 4 commits September 25, 2023 09:08

Update packages/transaction-controller/package.json

1c7e573

Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>

Merge branch 'main' into refactor/973-throw-rpc-error-validation

96720f3

update yarn.lock

ca1900f

revert rpc-errors due constraint incompatibility

919d77b

vinistevam force-pushed the refactor/973-throw-rpc-error-validation branch from 1c098a1 to 919d77b Compare September 25, 2023 08:46

vinistevam and others added 2 commits September 25, 2023 09:50

Merge branch 'main' into refactor/973-throw-rpc-error-validation

e35b7f3

bump rpc-errors to v6

094c55d

Merge branch 'main' into refactor/973-throw-rpc-error-validation

dba7fa2

Mrtenz mentioned this pull request Sep 26, 2023

Update @metamask/json-rpc-engine and @metamask/utils #1724

Closed

3 tasks

FrederikBolding previously approved these changes Sep 26, 2023

View reviewed changes

Merge branch 'main' into refactor/973-throw-rpc-error-validation

eeb053a

vinistevam dismissed FrederikBolding’s stale review via eeb053a September 26, 2023 14:59

Merge branch 'main' into refactor/973-throw-rpc-error-validation

1593458

legobeat approved these changes Sep 26, 2023

View reviewed changes

This was referenced Sep 27, 2023

Use @metamask/rpc-errors in approval-controller #1731

Closed

deps: Bump @metamask/{eth-json-rpc-provider,rpc-errors} #1653

Merged

vinistevam merged commit 762882d into main Sep 27, 2023
107 checks passed

vinistevam deleted the refactor/973-throw-rpc-error-validation branch September 27, 2023 07:08

legobeat mentioned this pull request Sep 29, 2023

deps(approval-controller): move to @metamask/rpc-errors #1743

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance transaction validation with standardized RPC errors #1690

Enhance transaction validation with standardized RPC errors #1690

vinistevam commented Sep 20, 2023 •

edited

Loading

legobeat commented Sep 20, 2023 •

edited

Loading

matthewwalsh0 commented Sep 21, 2023

legobeat commented Sep 21, 2023 •

edited

Loading

Mrtenz left a comment

vinistevam commented Sep 22, 2023

legobeat left a comment

socket-security bot commented Sep 25, 2023

legobeat left a comment

Enhance transaction validation with standardized RPC errors #1690

Enhance transaction validation with standardized RPC errors #1690

Conversation

vinistevam commented Sep 20, 2023 • edited Loading

Explanation

References

Changelog

@metamask/transaction-controller

Checklist

legobeat commented Sep 20, 2023 • edited Loading

matthewwalsh0 commented Sep 21, 2023

legobeat commented Sep 21, 2023 • edited Loading

Mrtenz left a comment

Choose a reason for hiding this comment

vinistevam commented Sep 22, 2023

legobeat left a comment

Choose a reason for hiding this comment

socket-security bot commented Sep 25, 2023

legobeat left a comment

Choose a reason for hiding this comment

vinistevam commented Sep 20, 2023 •

edited

Loading

`@metamask/transaction-controller`

legobeat commented Sep 20, 2023 •

edited

Loading

legobeat commented Sep 21, 2023 •

edited

Loading