deps: Replace eth-sig-util@^2 with @metamask/eth-sig-util@^6 #157

adonesky1 · 2022-12-20T16:56:22Z

TODO:

Fix mocking with sandbox... not properly mocking recoverPersonalSignature with this update.

socket-security · 2022-12-20T16:57:51Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring: [email protected], [email protected], [email protected], [email protected], [email protected], @lavamoat/[email protected], [email protected], [email protected], [email protected]

Next steps

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of package-name@version specifiers. e.g. @SocketSecurity ignore [email protected] bar@* or ignore all packages with @SocketSecurity ignore-all

adonesky1 · 2022-12-21T17:38:23Z

@SocketSecurity ignore @ethereumjs/[email protected] [email protected]

(these are both packages we use throughout are dependency graph that we trust)

legobeat · 2023-05-01T12:32:04Z

@adonesky1 Are you still intending to pick this up? FYI v5.1.0 was recently released.

socket-security · 2023-10-03T04:53:29Z

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

🚮 Removed packages: @lavamoat/[email protected], @types/[email protected]

legobeat · 2023-10-03T05:21:23Z

@SocketSecurity ignore [email protected]
@SocketSecurity ignore [email protected]

network access ok

legobeat · 2023-10-03T05:27:25Z

SocketSecurity alerts addressed in:

devDeps: @lavamoat/allow-scripts@^2.0.3->^2.5.1 #197

legobeat · 2023-10-03T05:37:12Z

@SocketSecurity ignore [email protected]
@SocketSecurity ignore [email protected]
@SocketSecurity ignore [email protected]
@SocketSecurity ignore [email protected]
@SocketSecurity ignore [email protected]
@SocketSecurity ignore @lavamoat/[email protected]
@SocketSecurity ignore [email protected]

legobeat · 2023-10-03T05:40:46Z

@adonesky1 I bumped this to eth-sig-util v6 (v7 blocked by Node.js v14 support) and resolved the test mocking (borrowed from here

adonesky1 · 2023-10-04T16:32:22Z

src/ledger-keyring.test.ts

+jest.mock('@metamask/eth-sig-util', () => {
+  return {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    __esModule: true,
+    ...jest.requireActual('@metamask/eth-sig-util'),
+  };
+});
+


@legobeat is this necessary. Don't understand what, if anything, this is doing?

This is in order to mock the new version (see error this is addressing here:

FAIL src/ledger-keyring.test.ts (14.651 s) ● LedgerKeyring › signPersonalMessage › should call create a listener waiting for the iframe response Cannot spyOn on a primitive value; undefined given 616 | 617 | jest > 618 | .spyOn(sigUtil, 'recoverPersonalSignature') | ^ 619 | .mockReturnValue(fakeAccounts[0]); 620 | 621 | await keyring.signPersonalMessage(fakeAccounts[0], 'some message'); at ModuleMocker.spyOn (node_modules/jest-mock/build/index.js:774:13) at Object.<anonymous> (src/ledger-keyring.test.ts:618:10)

Yes, this is a common approach when bundling all exports from an import into one variable and then spying on an individual export. Basically we're making a copy of sigUtil so that all properties are writable (jest.spyOn reassigns the property you spy on).

adonesky1 · 2023-10-04T16:36:33Z

@legobeat this looks good to me. I can't approve since I opened the PR

mcmire · 2023-10-19T16:33:16Z

src/ledger-keyring.test.ts

+jest.mock('@metamask/eth-sig-util', () => {
+  return {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    __esModule: true,
+    ...jest.requireActual('@metamask/eth-sig-util'),
+  };
+});
+


Yes, this is a common approach when bundling all exports from an import into one variable and then spying on an individual export. Basically we're making a copy of sigUtil so that all properties are writable (jest.spyOn reassigns the property you spy on).

mcmire · 2023-10-19T16:39:16Z

package.json

    "hdkey": "0.8.0"
  },
  "devDependencies": {
    "@ethereumjs/common": "^3.1.1",
    "@lavamoat/allow-scripts": "^2.3.0",
    "@ledgerhq/hw-app-eth": "^6.32.0",
+    "@ledgerhq/types-cryptoassets": "^7.6.0",


Why are these extra dependencies necessary? I don't see them being used in this PR.

They're used by sibling modules: https://github.com/MetaMask/eth-ledger-bridge-keyring/actions/runs/6577714417/job/17869959528?pr=201

Error: node_modules/@ledgerhq/domain-service/lib/types.d.ts(1,26): error TS2307: Cannot find module '@ledgerhq/types-cryptoassets' or its corresponding type declarations. Error: node_modules/@ledgerhq/types-live/lib/account.d.ts(2,58): error TS2307: Cannot find module '@ledgerhq/types-cryptoassets' or its corresponding type declarations. Error: node_modules/@ledgerhq/types-live/lib/bridge.d.ts(3,37): error TS2307: Cannot find module '@ledgerhq/types-cryptoassets' or its corresponding type declarations. Error: node_modules/@ledgerhq/types-live/lib/manager.d.ts(3,37): error TS2307: Cannot find module '@ledgerhq/types-cryptoassets' or its corresponding type declarations. Error: node_modules/@ledgerhq/types-live/lib/portfolio.d.ts(2,52): error TS2307: Cannot find module '@ledgerhq/types-cryptoassets' or its corresponding type declarations. Error: node_modules/@ledgerhq/types-live/lib/transaction.d.ts(2,27): error TS2307: Cannot find module '@ledgerhq/types-cryptoassets' or its corresponding type declarations. Error: Process completed with exit code 2.

mcmire

Looks good!

update eth-sig-util version to latest

6ec437d

adonesky1 force-pushed the update-eth-sig-util-version branch from 1b3e758 to 6ec437d Compare December 20, 2022 16:57

adonesky1 added 3 commits December 20, 2022 10:58

bump minimum node version

4c48fc3

cleanup

cc1973c

lint

860f7bd

adonesky1 mentioned this pull request Dec 21, 2022

Update @metamask/eth-sig-util version (v5.0.2) across the dependency tree MetaMask/metamask-extension#15906

Open

8 tasks

Merge branch main into update-eth-sig-util-version

6398b18

legobeat changed the title ~~update eth-sig-util version to latest~~ deps: Replace eth-sig-util@^2 with @metamask/eth-sig-util@^5 Oct 3, 2023

legobeat added the dependencies Pull requests that update a dependency file label Oct 3, 2023

deps: @metamask/eth-sig-util@^5.0.2->^6.0.1

6923199

legobeat changed the title ~~deps: Replace eth-sig-util@^2 with @metamask/eth-sig-util@^5~~ deps: Replace eth-sig-util@^2 with @metamask/eth-sig-util@^6 Oct 3, 2023

legobeat added 2 commits October 3, 2023 14:03

devDeps: add missing @ledgerhq/types implicit peerDeps

44fc2d5

lint:fix

4c032c5

legobeat force-pushed the update-eth-sig-util-version branch from 070eb91 to 4c032c5 Compare October 3, 2023 05:04

legobeat added 3 commits October 3, 2023 14:05

test: lint:fix

b89f0be

fixups after eth-sig-util update

f5c2c98

test: fix jest.spyOn of @metamask/eth-sig-util by mocking es module

36d2ab4

legobeat marked this pull request as ready for review October 3, 2023 05:40

legobeat requested a review from a team as a code owner October 3, 2023 05:40

adonesky1 commented Oct 4, 2023

View reviewed changes

legobeat previously approved these changes Oct 4, 2023

View reviewed changes

legobeat requested review from a team October 4, 2023 22:43

legobeat dismissed their stale review via f709645 October 10, 2023 22:59

Merge branch main into update-eth-sig-util-version

88625cd

legobeat force-pushed the update-eth-sig-util-version branch from f709645 to 88625cd Compare October 10, 2023 23:00

legobeat previously approved these changes Oct 10, 2023

View reviewed changes

mcmire reviewed Oct 19, 2023

View reviewed changes

Merge branch 'main' into update-eth-sig-util-version

d10891f

legobeat dismissed their stale review via d10891f October 19, 2023 16:53

yarn dedupe

f9457eb

legobeat requested a review from mcmire October 19, 2023 16:55

legobeat approved these changes Oct 19, 2023

View reviewed changes

mcmire approved these changes Oct 19, 2023

View reviewed changes

legobeat merged commit 94caef9 into main Oct 19, 2023
19 checks passed

legobeat deleted the update-eth-sig-util-version branch October 19, 2023 23:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

deps: Replace eth-sig-util@^2 with @metamask/eth-sig-util@^6 #157

deps: Replace eth-sig-util@^2 with @metamask/eth-sig-util@^6 #157

adonesky1 commented Dec 20, 2022 •

edited by legobeat

Loading

socket-security bot commented Dec 20, 2022 •

edited

Loading

adonesky1 commented Dec 21, 2022 •

edited

Loading

legobeat commented May 1, 2023

socket-security bot commented Oct 3, 2023 •

edited

Loading

legobeat commented Oct 3, 2023

legobeat commented Oct 3, 2023 •

edited

Loading

legobeat commented Oct 3, 2023

legobeat commented Oct 3, 2023

adonesky1 Oct 4, 2023

legobeat Oct 4, 2023

mcmire Oct 19, 2023

adonesky1 commented Oct 4, 2023

mcmire Oct 19, 2023

mcmire Oct 19, 2023

legobeat Oct 19, 2023 •

edited

Loading

mcmire left a comment

deps: Replace eth-sig-util@^2 with @metamask/eth-sig-util@^6 #157

deps: Replace eth-sig-util@^2 with @metamask/eth-sig-util@^6 #157

Conversation

adonesky1 commented Dec 20, 2022 • edited by legobeat Loading

socket-security bot commented Dec 20, 2022 • edited Loading

Next steps

adonesky1 commented Dec 21, 2022 • edited Loading

legobeat commented May 1, 2023

socket-security bot commented Oct 3, 2023 • edited Loading

legobeat commented Oct 3, 2023

legobeat commented Oct 3, 2023 • edited Loading

legobeat commented Oct 3, 2023

legobeat commented Oct 3, 2023

adonesky1 Oct 4, 2023

Choose a reason for hiding this comment

legobeat Oct 4, 2023

Choose a reason for hiding this comment

mcmire Oct 19, 2023

Choose a reason for hiding this comment

adonesky1 commented Oct 4, 2023

mcmire Oct 19, 2023

Choose a reason for hiding this comment

mcmire Oct 19, 2023

Choose a reason for hiding this comment

legobeat Oct 19, 2023 • edited Loading

Choose a reason for hiding this comment

mcmire left a comment

Choose a reason for hiding this comment

adonesky1 commented Dec 20, 2022 •

edited by legobeat

Loading

socket-security bot commented Dec 20, 2022 •

edited

Loading

adonesky1 commented Dec 21, 2022 •

edited

Loading

socket-security bot commented Oct 3, 2023 •

edited

Loading

legobeat commented Oct 3, 2023 •

edited

Loading

legobeat Oct 19, 2023 •

edited

Loading