From 03b89d81ae5ea978ab6bef0eedfaadd3525ceb3d Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Tue, 5 Nov 2024 23:23:46 +0530 Subject: [PATCH 01/31] UI changes to show decoding data for permits --- .../static-simulation/static-simulation.tsx | 18 +- .../permit-simulation.test.tsx.snap | 43 ++- .../decoded-simulation.test.tsx.snap | 9 + .../decoded-simulation.test.tsx | 21 ++ .../decoded-simulation/decoded-simulation.tsx | 7 + .../decoded-simulation/index.ts | 1 + .../default-simulation.test.tsx.snap | 246 ++++++++++++++++++ .../default-simulation.test.tsx | 60 +++++ .../default-simulation/default-simulation.tsx | 118 +++++++++ .../default-simulation/index.ts | 1 + .../permit-simulation.test.tsx | 51 +++- .../permit-simulation/permit-simulation.tsx | 120 +-------- ui/pages/confirmations/types/confirm.ts | 11 + 13 files changed, 574 insertions(+), 132 deletions(-) create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/index.ts create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.test.tsx create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.tsx create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/index.ts diff --git a/ui/pages/confirmations/components/confirm/info/shared/static-simulation/static-simulation.tsx b/ui/pages/confirmations/components/confirm/info/shared/static-simulation/static-simulation.tsx index 7901854b91d1..cf8ad9cd5773 100644 --- a/ui/pages/confirmations/components/confirm/info/shared/static-simulation/static-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/shared/static-simulation/static-simulation.tsx @@ -1,22 +1,36 @@ import React from 'react'; + +import { Box } from '../../../../../../../components/component-library'; import { ConfirmInfoRow, ConfirmInfoRowText, } from '../../../../../../../components/app/confirm/info/row'; import { ConfirmInfoSection } from '../../../../../../../components/app/confirm/info/row/section'; +import { + Display, + JustifyContent, +} from '../../../../../../../helpers/constants/design-system'; +import Preloader from '../../../../../../../components/ui/icon/preloader'; const StaticSimulation: React.FC<{ title: string; titleTooltip: string; description: string; simulationElements: React.ReactNode; -}> = ({ title, titleTooltip, description, simulationElements }) => { + isLoading?: boolean; +}> = ({ title, titleTooltip, description, simulationElements, isLoading }) => { return ( - {simulationElements} + {isLoading ? ( + + + + ) : ( + simulationElements + )} ); }; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap index f35e2218cbfb..16e7f5fa79d9 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap @@ -1,6 +1,14 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`PermitSimulation renders component correctly 1`] = ` +exports[`PermitSimulation should not render default simulation if decodingLoading is true 1`] = ` +
+
+ "DECODED SIMULATION IMPLEMENTATION" +
+
+`; + +exports[`PermitSimulation should render default simulation if decoding api does not return result 1`] = `
`; -exports[`PermitSimulation renders correctly for NFT permit 1`] = ` +exports[`PermitSimulation should render default simulation if decoding api returns error 1`] = `
- You're giving someone else permission to withdraw NFTs from your account. + You're giving the spender permission to spend this many tokens from your account.

@@ -190,7 +198,7 @@ exports[`PermitSimulation renders correctly for NFT permit 1`] = `

- Withdraw + Spending cap

@@ -207,14 +215,25 @@ exports[`PermitSimulation renders correctly for NFT permit 1`] = `
-
-

+

- #3606393 -

+

+ 30 +

+
- 0xC3644...1FE88 + 0xCcCCc...ccccC

diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap new file mode 100644 index 000000000000..9c190acccee9 --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap @@ -0,0 +1,9 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`DecodedSimulation renders component correctly 1`] = ` +
+
+ "DECODED SIMULATION IMPLEMENTATION" +
+
+`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx new file mode 100644 index 000000000000..00e0fbadb496 --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx @@ -0,0 +1,21 @@ +import React from 'react'; +import configureMockStore from 'redux-mock-store'; + +import { getMockTypedSignConfirmStateForRequest } from '../../../../../../../../../test/data/confirmations/helper'; +import { renderWithConfirmContextProvider } from '../../../../../../../../../test/lib/confirmations/render-helpers'; +import { permitSignatureMsg } from '../../../../../../../../../test/data/confirmations/typed_sign'; +import PermitSimulation from './decoded-simulation'; + +describe('DecodedSimulation', () => { + it('renders component correctly', async () => { + const state = getMockTypedSignConfirmStateForRequest(permitSignatureMsg); + const mockStore = configureMockStore([])(state); + + const { container } = renderWithConfirmContextProvider( + , + mockStore, + ); + + expect(container).toMatchSnapshot(); + }); +}); diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx new file mode 100644 index 000000000000..f4767dbee264 --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx @@ -0,0 +1,7 @@ +import React from 'react'; + +const DecodedSimulation: React.FC = () => ( +
"DECODED SIMULATION IMPLEMENTATION"
+); + +export default DecodedSimulation; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/index.ts b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/index.ts new file mode 100644 index 000000000000..a13982b1b09d --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/index.ts @@ -0,0 +1 @@ +export { default as DecodedSimulation } from './decoded-simulation'; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap new file mode 100644 index 000000000000..a378d0befcc4 --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap @@ -0,0 +1,246 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`DefaultSimulation renders component correctly 1`] = ` +
+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+

+ You're giving the spender permission to spend this many tokens from your account. +

+
+
+
+
+
+

+ Spending cap +

+
+
+
+
+
+
+
+
+

+ 30 +

+
+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+
+
+
+`; + +exports[`DefaultSimulation renders correctly for NFT permit 1`] = ` +
+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+

+ You're giving someone else permission to withdraw NFTs from your account. +

+
+
+
+
+
+

+ Withdraw +

+
+
+
+
+
+
+
+

+ #3606393 +

+
+
+
+
+ +

+ 0xC3644...1FE88 +

+
+
+
+
+
+
+
+
+
+`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.test.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.test.tsx new file mode 100644 index 000000000000..b9e095292bce --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.test.tsx @@ -0,0 +1,60 @@ +import React from 'react'; +import configureMockStore from 'redux-mock-store'; +import { act } from 'react-dom/test-utils'; + +import { getMockTypedSignConfirmStateForRequest } from '../../../../../../../../../test/data/confirmations/helper'; +import { renderWithConfirmContextProvider } from '../../../../../../../../../test/lib/confirmations/render-helpers'; +import { + permitNFTSignatureMsg, + permitSignatureMsg, +} from '../../../../../../../../../test/data/confirmations/typed_sign'; +import { memoizedGetTokenStandardAndDetails } from '../../../../../../utils/token'; +import DefaultSimulation from './default-simulation'; + +jest.mock('../../../../../../../../store/actions', () => { + return { + getTokenStandardAndDetails: jest + .fn() + .mockResolvedValue({ decimals: 2, standard: 'ERC20' }), + }; +}); + +describe('DefaultSimulation', () => { + afterEach(() => { + jest.clearAllMocks(); + + /** Reset memoized function using getTokenStandardAndDetails for each test */ + memoizedGetTokenStandardAndDetails?.cache?.clear?.(); + }); + + it('renders component correctly', async () => { + const state = getMockTypedSignConfirmStateForRequest(permitSignatureMsg); + const mockStore = configureMockStore([])(state); + + await act(async () => { + const { container, findByText } = renderWithConfirmContextProvider( + , + mockStore, + ); + + expect(await findByText('30')).toBeInTheDocument(); + expect(container).toMatchSnapshot(); + }); + }); + + it('renders correctly for NFT permit', async () => { + const state = getMockTypedSignConfirmStateForRequest(permitNFTSignatureMsg); + const mockStore = configureMockStore([])(state); + + await act(async () => { + const { container, findByText } = renderWithConfirmContextProvider( + , + mockStore, + ); + + expect(await findByText('Withdraw')).toBeInTheDocument(); + expect(await findByText('#3606393')).toBeInTheDocument(); + expect(container).toMatchSnapshot(); + }); + }); +}); diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.tsx new file mode 100644 index 000000000000..c39a88585e35 --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.tsx @@ -0,0 +1,118 @@ +import { Hex } from '@metamask/utils'; +import React from 'react'; +import { PrimaryType } from '../../../../../../../../../shared/constants/signatures'; +import { parseTypedDataMessage } from '../../../../../../../../../shared/modules/transaction.utils'; +import { ConfirmInfoRow } from '../../../../../../../../components/app/confirm/info/row'; +import { Box } from '../../../../../../../../components/component-library'; +import { + Display, + FlexDirection, +} from '../../../../../../../../helpers/constants/design-system'; +import { useI18nContext } from '../../../../../../../../hooks/useI18nContext'; +import { useConfirmContext } from '../../../../../../context/confirm'; +import { SignatureRequestType } from '../../../../../../types/confirm'; +import StaticSimulation from '../../../shared/static-simulation/static-simulation'; +import PermitSimulationValueDisplay from '../value-display/value-display'; + +function extractTokenDetailsByPrimaryType( + message: Record, + primaryType: PrimaryType, +): object[] | unknown { + let tokenDetails; + + switch (primaryType) { + case PrimaryType.PermitBatch: + case PrimaryType.PermitSingle: + tokenDetails = message?.details; + break; + case PrimaryType.PermitBatchTransferFrom: + case PrimaryType.PermitTransferFrom: + tokenDetails = message?.permitted; + break; + default: + break; + } + + const isNonArrayObject = tokenDetails && !Array.isArray(tokenDetails); + + return isNonArrayObject ? [tokenDetails] : tokenDetails; +} + +const DefaultPermitSimulation: React.FC = () => { + const t = useI18nContext(); + const { currentConfirmation } = useConfirmContext(); + const msgData = currentConfirmation.msgParams?.data; + const chainId = currentConfirmation.chainId as Hex; + const { + domain: { verifyingContract }, + message, + message: { tokenId }, + primaryType, + } = parseTypedDataMessage(msgData as string); + const isNFT = tokenId !== undefined; + + const tokenDetails = extractTokenDetailsByPrimaryType(message, primaryType); + + const TokenDetail = ({ + token, + amount, + i, + }: { + token: Hex | string; + amount: number | string; + i: number; + }) => ( + + ); + + const SpendingCapRow = ( + + + {Array.isArray(tokenDetails) ? ( + + {tokenDetails.map( + ( + { token, amount }: { token: string; amount: string }, + i: number, + ) => ( + + ), + )} + + ) : ( + + )} + + + ); + + return ( + + ); +}; + +export default DefaultPermitSimulation; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/index.ts b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/index.ts new file mode 100644 index 000000000000..b9f6c48b65db --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/index.ts @@ -0,0 +1 @@ +export { default as DefaultSimulation } from './default-simulation'; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.test.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.test.tsx index 0d67715867d9..d0183d1ac2e7 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.test.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.test.tsx @@ -1,13 +1,11 @@ import React from 'react'; import configureMockStore from 'redux-mock-store'; import { act } from 'react-dom/test-utils'; +import { waitFor } from '@testing-library/dom'; import { getMockTypedSignConfirmStateForRequest } from '../../../../../../../../test/data/confirmations/helper'; import { renderWithConfirmContextProvider } from '../../../../../../../../test/lib/confirmations/render-helpers'; -import { - permitNFTSignatureMsg, - permitSignatureMsg, -} from '../../../../../../../../test/data/confirmations/typed_sign'; +import { permitSignatureMsg } from '../../../../../../../../test/data/confirmations/typed_sign'; import { memoizedGetTokenStandardAndDetails } from '../../../../../utils/token'; import PermitSimulation from './permit-simulation'; @@ -27,8 +25,12 @@ describe('PermitSimulation', () => { memoizedGetTokenStandardAndDetails?.cache?.clear?.(); }); - it('renders component correctly', async () => { - const state = getMockTypedSignConfirmStateForRequest(permitSignatureMsg); + it('should render default simulation if decoding api does not return result', async () => { + const state = getMockTypedSignConfirmStateForRequest({ + ...permitSignatureMsg, + decodingLoading: false, + decodingData: undefined, + }); const mockStore = configureMockStore([])(state); await act(async () => { @@ -42,8 +44,18 @@ describe('PermitSimulation', () => { }); }); - it('renders correctly for NFT permit', async () => { - const state = getMockTypedSignConfirmStateForRequest(permitNFTSignatureMsg); + it('should render default simulation if decoding api returns error', async () => { + const state = getMockTypedSignConfirmStateForRequest({ + ...permitSignatureMsg, + decodingLoading: false, + decodingData: { + stateChanges: null, + error: { + message: 'some error', + type: 'SOME_ERROR', + }, + }, + }); const mockStore = configureMockStore([])(state); await act(async () => { @@ -52,9 +64,28 @@ describe('PermitSimulation', () => { mockStore, ); - expect(await findByText('Withdraw')).toBeInTheDocument(); - expect(await findByText('#3606393')).toBeInTheDocument(); + expect(await findByText('30')).toBeInTheDocument(); expect(container).toMatchSnapshot(); }); }); + + it('should not render default simulation if decodingLoading is true', async () => { + const state = getMockTypedSignConfirmStateForRequest({ + ...permitSignatureMsg, + decodingLoading: true, + }); + const mockStore = configureMockStore([])(state); + + await act(async () => { + const { container, queryByTestId } = renderWithConfirmContextProvider( + , + mockStore, + ); + + await waitFor(() => { + expect(queryByTestId('30')).not.toBeInTheDocument(); + expect(container).toMatchSnapshot(); + }); + }); + }); }); diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.tsx index 855f7837ba42..0b4d9eed22d4 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.tsx @@ -1,118 +1,22 @@ -import { Hex } from '@metamask/utils'; import React from 'react'; -import { PrimaryType } from '../../../../../../../../shared/constants/signatures'; -import { parseTypedDataMessage } from '../../../../../../../../shared/modules/transaction.utils'; -import { ConfirmInfoRow } from '../../../../../../../components/app/confirm/info/row'; -import { Box } from '../../../../../../../components/component-library'; -import { - Display, - FlexDirection, -} from '../../../../../../../helpers/constants/design-system'; -import { useI18nContext } from '../../../../../../../hooks/useI18nContext'; -import { useConfirmContext } from '../../../../../context/confirm'; -import { SignatureRequestType } from '../../../../../types/confirm'; -import StaticSimulation from '../../shared/static-simulation/static-simulation'; -import PermitSimulationValueDisplay from './value-display/value-display'; - -function extractTokenDetailsByPrimaryType( - message: Record, - primaryType: PrimaryType, -): object[] | unknown { - let tokenDetails; - - switch (primaryType) { - case PrimaryType.PermitBatch: - case PrimaryType.PermitSingle: - tokenDetails = message?.details; - break; - case PrimaryType.PermitBatchTransferFrom: - case PrimaryType.PermitTransferFrom: - tokenDetails = message?.permitted; - break; - default: - break; - } - - const isNonArrayObject = tokenDetails && !Array.isArray(tokenDetails); - return isNonArrayObject ? [tokenDetails] : tokenDetails; -} +import { SignatureRequestType } from '../../../../../types/confirm'; +import { useConfirmContext } from '../../../../../context/confirm'; +import { DefaultSimulation } from './default-simulation'; +import { DecodedSimulation } from './decoded-simulation'; const PermitSimulation: React.FC = () => { - const t = useI18nContext(); const { currentConfirmation } = useConfirmContext(); - const msgData = currentConfirmation.msgParams?.data; - const chainId = currentConfirmation.chainId as Hex; - const { - domain: { verifyingContract }, - message, - message: { tokenId }, - primaryType, - } = parseTypedDataMessage(msgData as string); - const isNFT = tokenId !== undefined; - - const tokenDetails = extractTokenDetailsByPrimaryType(message, primaryType); + const { decodingLoading, decodingData } = currentConfirmation; - const TokenDetail = ({ - token, - amount, - i, - }: { - token: Hex | string; - amount: number | string; - i: number; - }) => ( - - ); - - const SpendingCapRow = ( - - - {Array.isArray(tokenDetails) ? ( - - {tokenDetails.map( - ( - { token, amount }: { token: string; amount: string }, - i: number, - ) => ( - - ), - )} - - ) : ( - - )} - - - ); + if ( + decodingData?.error || + (decodingData === undefined && decodingLoading !== true) + ) { + return ; + } - return ( - - ); + return ; }; export default PermitSimulation; diff --git a/ui/pages/confirmations/types/confirm.ts b/ui/pages/confirmations/types/confirm.ts index b7c0c1160b3c..28960219ae3c 100644 --- a/ui/pages/confirmations/types/confirm.ts +++ b/ui/pages/confirmations/types/confirm.ts @@ -23,6 +23,15 @@ export type SecurityAlertResponse = { source?: SecurityAlertSource; }; +// todo: DecodingData to be imported from signature controller once its updated in extension +export type DecodingData = { + stateChanges: unknown[] | null; + error?: { + message: string; + type: string; + }; +}; + export type SignatureRequestType = { chainId?: string; id: string; @@ -38,6 +47,8 @@ export type SignatureRequestType = { type: TransactionType; custodyId?: string; securityAlertResponse?: SecurityAlertResponse; + decodingLoading?: boolean; + decodingData?: DecodingData; }; export type Confirmation = SignatureRequestType | TransactionMeta; From 7fed6fa98033a414b7a294002d8b1aa3d102acdd Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Fri, 8 Nov 2024 00:22:30 +0530 Subject: [PATCH 02/31] Display ERC20 and ERC721 token details returns by decoding api --- app/_locales/en/messages.json | 18 ++++ .../static-simulation/static-simulation.tsx | 4 +- .../permit-simulation.test.tsx.snap | 82 +++++++++++++- .../decoded-simulation.test.tsx.snap | 100 +++++++++++++++++- .../decoded-simulation.test.tsx | 18 +++- .../decoded-simulation/decoded-simulation.tsx | 96 ++++++++++++++++- .../value-display/value-display.tsx | 31 +++++- ui/pages/confirmations/types/confirm.ts | 10 +- 8 files changed, 337 insertions(+), 22 deletions(-) diff --git a/app/_locales/en/messages.json b/app/_locales/en/messages.json index ab6b06411731..0210135f0b2b 100644 --- a/app/_locales/en/messages.json +++ b/app/_locales/en/messages.json @@ -4103,6 +4103,24 @@ "permissionsPageTourTitle": { "message": "Connected sites are now permissions" }, + "permitSimulationChange_transfer": { + "message": "You send" + }, + "permitSimulationChange_receive": { + "message": "You receive" + }, + "permitSimulationChange_approve": { + "message": "Spending cap" + }, + "permitSimulationChange_revoke": { + "message": "Spending cap" + }, + "permitSimulationChange_bidding": { + "message": "You bid" + }, + "permitSimulationChange_listing": { + "message": "You list" + }, "permitSimulationDetailInfo": { "message": "You're giving the spender permission to spend this many tokens from your account." }, diff --git a/ui/pages/confirmations/components/confirm/info/shared/static-simulation/static-simulation.tsx b/ui/pages/confirmations/components/confirm/info/shared/static-simulation/static-simulation.tsx index cf8ad9cd5773..9a34abd8009d 100644 --- a/ui/pages/confirmations/components/confirm/info/shared/static-simulation/static-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/shared/static-simulation/static-simulation.tsx @@ -15,14 +15,14 @@ import Preloader from '../../../../../../../components/ui/icon/preloader'; const StaticSimulation: React.FC<{ title: string; titleTooltip: string; - description: string; + description?: string; simulationElements: React.ReactNode; isLoading?: boolean; }> = ({ title, titleTooltip, description, simulationElements, isLoading }) => { return ( - + {description && } {isLoading ? ( diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap index 16e7f5fa79d9..45eebc590b7b 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap @@ -2,8 +2,86 @@ exports[`PermitSimulation should not render default simulation if decodingLoading is true 1`] = `
-
- "DECODED SIMULATION IMPLEMENTATION" +
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+
+ + + + + + + + + +
`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap index 9c190acccee9..9a794df953fc 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap @@ -2,8 +2,104 @@ exports[`DecodedSimulation renders component correctly 1`] = `
-
- "DECODED SIMULATION IMPLEMENTATION" +
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+
+

+ Spending cap +

+
+
+
+
+
+

+ 1,461,501,637,3... +

+
+
+
+
+
+ +

+ 0x6B175...71d0F +

+
+
+
+
+
+
`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx index 00e0fbadb496..785d6ab72aaf 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx @@ -6,9 +6,25 @@ import { renderWithConfirmContextProvider } from '../../../../../../../../../tes import { permitSignatureMsg } from '../../../../../../../../../test/data/confirmations/typed_sign'; import PermitSimulation from './decoded-simulation'; +const decodingData = { + stateChanges: [ + { + assetType: 'ERC20', + changeType: 'APPROVE', + address: '0x3fc91a3afd70395cd496c647d5a6cc9d4b2b7fad', + amount: '1461501637330902918203684832716283019655932542975', + contractAddress: '0x6b175474e89094c44da98b954eedeac495271d0f', + }, + ], +}; + describe('DecodedSimulation', () => { it('renders component correctly', async () => { - const state = getMockTypedSignConfirmStateForRequest(permitSignatureMsg); + const state = getMockTypedSignConfirmStateForRequest({ + ...permitSignatureMsg, + decodingLoading: false, + decodingData, + }); const mockStore = configureMockStore([])(state); const { container } = renderWithConfirmContextProvider( diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx index f4767dbee264..39cda822b94f 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx @@ -1,7 +1,95 @@ -import React from 'react'; +import React, { ReactNode } from 'react'; +import { + DecodingDataChangeType, + DecodingDataStateChange, +} from '@metamask/signature-controller'; +import { Hex } from '@metamask/utils'; -const DecodedSimulation: React.FC = () => ( -
"DECODED SIMULATION IMPLEMENTATION"
-); +import { TokenStandard } from '../../../../../../../../../shared/constants/transaction'; +import { + Box, + Text, +} from '../../../../../../../../components/component-library'; +import { + TextColor, + TextVariant, +} from '../../../../../../../../helpers/constants/design-system'; +import { useI18nContext } from '../../../../../../../../hooks/useI18nContext'; +import { SignatureRequestType } from '../../../../../../types/confirm'; +import { useConfirmContext } from '../../../../../../context/confirm'; +import StaticSimulation from '../../../shared/static-simulation/static-simulation'; +import PermitSimulationValueDisplay from '../value-display/value-display'; + +const getStateChangeLabelMap = ( + t: ReturnType, + changeType: string, +) => + ({ + [DecodingDataChangeType.Transfer]: t('permitSimulationChange_transfer'), + [DecodingDataChangeType.Receive]: t('permitSimulationChange_receive'), + [DecodingDataChangeType.Approve]: t('permitSimulationChange_approve'), + [DecodingDataChangeType.Revoke]: t('permitSimulationChange_revoke'), + [DecodingDataChangeType.Bidding]: t('permitSimulationChange_bidding'), + [DecodingDataChangeType.Listing]: t('permitSimulationChange_listing'), + }[changeType]); + +const StateChangeRow = ({ + stateChange, + chainId, +}: { + stateChange: DecodingDataStateChange; + chainId: Hex; +}) => { + const t = useI18nContext(); + const { assetType, changeType, amount, contractAddress, tokenID } = + stateChange; + return ( + + + {getStateChangeLabelMap(t, changeType)} + + {(assetType === TokenStandard.ERC20 || + assetType === TokenStandard.ERC721) && ( + + )} + + ); +}; + +const DecodedSimulation: React.FC = () => { + const t = useI18nContext(); + const { currentConfirmation } = useConfirmContext(); + const chainId = currentConfirmation.chainId as Hex; + const { decodingLoading, decodingData } = currentConfirmation; + + let stateChangeFragment: ReactNode[] = []; + if (decodingData && decodingData.stateChanges) { + stateChangeFragment = decodingData.stateChanges.map( + (change: DecodingDataStateChange) => ( + + ), + ); + } + + return ( + + ); +}; export default DecodedSimulation; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/value-display.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/value-display.tsx index c7a9eae6a496..19c1bbb33d7f 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/value-display.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/value-display.tsx @@ -27,6 +27,7 @@ import { Display, JustifyContent, TextAlign, + TextColor, } from '../../../../../../../../helpers/constants/design-system'; import Name from '../../../../../../../../components/app/name/name'; import { TokenDetailsERC20 } from '../../../../../../utils/token'; @@ -50,11 +51,25 @@ type PermitSimulationValueDisplayParams = { /** The tokenId for NFT */ tokenId?: string; + + /** True if value is being credited to wallet */ + credit?: boolean; + + /** True if value is being debited to wallet */ + debit?: boolean; }; const PermitSimulationValueDisplay: React.FC< PermitSimulationValueDisplayParams -> = ({ chainId, primaryType, tokenContract, tokenId, value }) => { +> = ({ + chainId, + primaryType, + tokenContract, + tokenId, + value, + credit, + debit, +}) => { const exchangeRate = useTokenExchangeRate(tokenContract); const tokenDetails = useGetTokenStandardAndDetails(tokenContract); @@ -97,6 +112,17 @@ const PermitSimulationValueDisplay: React.FC< return null; } + let valueColor = TextColor.textDefault; + let valueBackgroundColor = BackgroundColor.backgroundAlternative; + + if (credit) { + valueColor = TextColor.successDefault; + valueBackgroundColor = BackgroundColor.successMuted; + } else if (debit) { + valueColor = TextColor.errorDefault; + valueBackgroundColor = BackgroundColor.errorMuted; + } + return ( @@ -113,8 +139,9 @@ const PermitSimulationValueDisplay: React.FC< > Date: Fri, 8 Nov 2024 10:37:40 +0530 Subject: [PATCH 03/31] Display native values returned from decoding api --- app/scripts/metamask-controller.js | 11 +- .../decoded-simulation/decoded-simulation.tsx | 14 ++- .../native-value-display.test.tsx.snap | 66 ++++++++++ .../native-value-display.test.tsx | 24 ++++ .../native-value-display.tsx | 116 ++++++++++++++++++ .../value-display/value-display.tsx | 20 +-- .../components/confirm/info/utils.ts | 18 +++ 7 files changed, 250 insertions(+), 19 deletions(-) create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/__snapshots__/native-value-display.test.tsx.snap create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.test.tsx create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.tsx diff --git a/app/scripts/metamask-controller.js b/app/scripts/metamask-controller.js index 89d91f134ae2..5741f54bae9c 100644 --- a/app/scripts/metamask-controller.js +++ b/app/scripts/metamask-controller.js @@ -1999,6 +1999,11 @@ export default class MetamaskController extends EventEmitter { ], }), trace, + decodingApiUrl: + 'https://qtgdj2huxh.execute-api.us-east-2.amazonaws.com/uat/v1', + isDecodeSignatureRequestEnabled: () => + this.preferencesController.state.useExternalServices === true && + this.preferencesController.state.useTransactionSimulations, }); this.signatureController.hub.on( @@ -3320,8 +3325,6 @@ export default class MetamaskController extends EventEmitter { preferencesController.setWatchEthereumAccountEnabled.bind( preferencesController, ), - ///: END:ONLY_INCLUDE_IF - ///: BEGIN:ONLY_INCLUDE_IF(solana) setSolanaSupportEnabled: preferencesController.setSolanaSupportEnabled.bind( preferencesController, @@ -6400,7 +6403,9 @@ export default class MetamaskController extends EventEmitter { process.env.TRANSACTION_MULTICHAIN ? networkClientId : undefined, ); nonceLock.releaseLock(); - return nonceLock.nextNonce; + const nn = nonceLock.nextNonce; + console.log('-- nn --', nn); + return nn; } /** diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx index 39cda822b94f..623f1edb1c3b 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx @@ -1,5 +1,6 @@ import React, { ReactNode } from 'react'; import { + DecodingData, DecodingDataChangeType, DecodingDataStateChange, } from '@metamask/signature-controller'; @@ -18,7 +19,8 @@ import { useI18nContext } from '../../../../../../../../hooks/useI18nContext'; import { SignatureRequestType } from '../../../../../../types/confirm'; import { useConfirmContext } from '../../../../../../context/confirm'; import StaticSimulation from '../../../shared/static-simulation/static-simulation'; -import PermitSimulationValueDisplay from '../value-display/value-display'; +import TokenValueDisplay from '../value-display/value-display'; +import NativeValueDisplay from '../native-value-display/native-value-display'; const getStateChangeLabelMap = ( t: ReturnType, @@ -54,7 +56,7 @@ const StateChangeRow = ({ {(assetType === TokenStandard.ERC20 || assetType === TokenStandard.ERC721) && ( - )} + {assetType === 'NATIVE' && ( + + )} ); }; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/__snapshots__/native-value-display.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/__snapshots__/native-value-display.test.tsx.snap new file mode 100644 index 000000000000..462ae9ea4181 --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/__snapshots__/native-value-display.test.tsx.snap @@ -0,0 +1,66 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`NativeValueDisplay renders component correctly 1`] = ` +
+
+
+
+
+
+

+ <0.000001 +

+
+
+
+
+
+
+ ETH logo +
+

+ ETH +

+
+
+
+
+
+
+`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.test.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.test.tsx new file mode 100644 index 000000000000..1b8f65ac46b4 --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.test.tsx @@ -0,0 +1,24 @@ +import React from 'react'; +import configureMockStore from 'redux-mock-store'; + +import mockState from '../../../../../../../../../test/data/mock-state.json'; +import { renderWithProvider } from '../../../../../../../../../test/lib/render-helpers'; +import NativeValueDisplay from './native-value-display'; + + +describe('NativeValueDisplay', () => { + it('renders component correctly', async () => { + const mockStore = configureMockStore([])(mockState); + + const { container, findByText } = renderWithProvider( + , + mockStore, + ); + + expect(await findByText('<0.000001')).toBeInTheDocument(); + expect(container).toMatchSnapshot(); + }); +}); diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.tsx new file mode 100644 index 000000000000..141fb3e9a6df --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.tsx @@ -0,0 +1,116 @@ +import BigNumber from 'bignumber.js'; +import { Hex } from '@metamask/utils'; +import React, { useMemo } from 'react'; +import { useSelector } from 'react-redux'; + +import { TokenStandard } from '../../../../../../../../../shared/constants/transaction'; +import { calcTokenAmount } from '../../../../../../../../../shared/lib/transactions-controller-utils'; +import { + Box, + Text, +} from '../../../../../../../../components/component-library'; +import { + BlockSize, + BorderRadius, + Display, + JustifyContent, + TextAlign, +} from '../../../../../../../../helpers/constants/design-system'; +import Tooltip from '../../../../../../../../components/ui/tooltip'; +import { getConversionRate } from '../../../../../../../../ducks/metamask/metamask'; +import { shortenString } from '../../../../../../../../helpers/utils/util'; +import { AssetPill } from '../../../../../simulation-details/asset-pill'; +import { + formatAmount, + formatAmountMaxPrecision, +} from '../../../../../simulation-details/formatAmount'; +import { IndividualFiatDisplay } from '../../../../../simulation-details/fiat-display'; +import { getAmountColors } from '../../../utils'; + +const NATIVE_DECIMALS = 18; + +type PermitSimulationValueDisplayParams = { + /** ID of the associated chain. */ + chainId: Hex; + + /** The token amount */ + value: number | string; + + /** True if value is being credited to wallet */ + credit?: boolean; + + /** True if value is being debited to wallet */ + debit?: boolean; +}; + +const NativeValueDisplay: React.FC = ({ + chainId, + value, + credit, + debit, +}) => { + const nativeFiatRate = useSelector(getConversionRate); + + const { fiatValue, tokenValue, tokenValueMaxPrecision } = useMemo(() => { + if (!value) { + return { tokenValue: null, tokenValueMaxPrecision: null }; + } + + const tokenAmount = calcTokenAmount(value, NATIVE_DECIMALS); + + return { + fiatValue: nativeFiatRate + ? new BigNumber(tokenAmount).times(String(nativeFiatRate)).toNumber() + : undefined, + tokenValue: formatAmount('en-US', tokenAmount), + tokenValueMaxPrecision: formatAmountMaxPrecision('en-US', tokenAmount), + }; + }, [nativeFiatRate, value]); + + const { color, backgroundColor} = getAmountColors(credit, debit); + + return ( + + + + + + {credit && '+ '} + {debit && '- '} + {tokenValue !== null && + shortenString(tokenValue || '', { + truncatedCharLimit: 15, + truncatedStartChars: 15, + truncatedEndChars: 0, + skipCharacterInEnd: true, + })} + + + + + + + {fiatValue && } + + + ); +}; + +export default NativeValueDisplay; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/value-display.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/value-display.tsx index 19c1bbb33d7f..86971569e9b9 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/value-display.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/value-display.tsx @@ -21,16 +21,15 @@ import { } from '../../../../../../../../components/component-library'; import Tooltip from '../../../../../../../../components/ui/tooltip'; import { - BackgroundColor, BlockSize, BorderRadius, Display, JustifyContent, TextAlign, - TextColor, } from '../../../../../../../../helpers/constants/design-system'; import Name from '../../../../../../../../components/app/name/name'; import { TokenDetailsERC20 } from '../../../../../../utils/token'; +import { getAmountColors } from '../../../utils'; type PermitSimulationValueDisplayParams = { /** ID of the associated chain. */ @@ -112,16 +111,7 @@ const PermitSimulationValueDisplay: React.FC< return null; } - let valueColor = TextColor.textDefault; - let valueBackgroundColor = BackgroundColor.backgroundAlternative; - - if (credit) { - valueColor = TextColor.successDefault; - valueBackgroundColor = BackgroundColor.successMuted; - } else if (debit) { - valueColor = TextColor.errorDefault; - valueBackgroundColor = BackgroundColor.errorMuted; - } + const { color, backgroundColor } = getAmountColors(credit, debit); return ( @@ -139,13 +129,15 @@ const PermitSimulationValueDisplay: React.FC< > + {credit && '+ '} + {debit && '- '} {tokenValue !== null && shortenString(tokenValue || '', { truncatedCharLimit: 15, diff --git a/ui/pages/confirmations/components/confirm/info/utils.ts b/ui/pages/confirmations/components/confirm/info/utils.ts index a80d604fed83..0ad8479ac7b9 100644 --- a/ui/pages/confirmations/components/confirm/info/utils.ts +++ b/ui/pages/confirmations/components/confirm/info/utils.ts @@ -1,4 +1,8 @@ import { DecodedTransactionDataResponse } from '../../../../../../shared/types/transaction-decode'; +import { + BackgroundColor, + TextColor, +} from '../../../../../helpers/constants/design-system'; export function getIsRevokeSetApprovalForAll( value: DecodedTransactionDataResponse | undefined, @@ -9,3 +13,17 @@ export function getIsRevokeSetApprovalForAll( return isRevokeSetApprovalForAll; } + +export const getAmountColors = (credit?: boolean, debit?: boolean) => { + let color = TextColor.textDefault; + let backgroundColor = BackgroundColor.backgroundAlternative; + + if (credit) { + color = TextColor.successDefault; + backgroundColor = BackgroundColor.successMuted; + } else if (debit) { + color = TextColor.errorDefault; + backgroundColor = BackgroundColor.errorMuted; + } + return { color, backgroundColor }; +}; From 569abbc80aa38528407d5bb951c48f7ce4703461 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Fri, 8 Nov 2024 10:40:23 +0530 Subject: [PATCH 04/31] Display native values returned from decoding api --- app/scripts/metamask-controller copy.js | 7218 +++++++++++++++++++++++ app/scripts/metamask-controller.js | 11 +- 2 files changed, 7221 insertions(+), 8 deletions(-) create mode 100644 app/scripts/metamask-controller copy.js diff --git a/app/scripts/metamask-controller copy.js b/app/scripts/metamask-controller copy.js new file mode 100644 index 000000000000..5741f54bae9c --- /dev/null +++ b/app/scripts/metamask-controller copy.js @@ -0,0 +1,7218 @@ +import EventEmitter from 'events'; +import { finished, pipeline } from 'readable-stream'; +import { + AssetsContractController, + CurrencyRateController, + NftController, + NftDetectionController, + TokenDetectionController, + TokenListController, + TokenRatesController, + TokensController, + CodefiTokenPricesServiceV2, + RatesController, + fetchMultiExchangeRate, +} from '@metamask/assets-controllers'; +import { JsonRpcEngine } from '@metamask/json-rpc-engine'; +import { createEngineStream } from '@metamask/json-rpc-middleware-stream'; +import { ObservableStore } from '@metamask/obs-store'; +import { storeAsStream } from '@metamask/obs-store/dist/asStream'; +import { providerAsMiddleware } from '@metamask/eth-json-rpc-middleware'; +import { debounce, throttle, memoize, wrap } from 'lodash'; +import { + KeyringController, + keyringBuilderFactory, +} from '@metamask/keyring-controller'; +import createFilterMiddleware from '@metamask/eth-json-rpc-filters'; +import createSubscriptionManager from '@metamask/eth-json-rpc-filters/subscriptionManager'; +import { + errorCodes as rpcErrorCodes, + JsonRpcError, + providerErrors, +} from '@metamask/rpc-errors'; + +import { Mutex } from 'await-semaphore'; +import log from 'loglevel'; +import { + TrezorConnectBridge, + TrezorKeyring, +} from '@metamask/eth-trezor-keyring'; +import { + LedgerKeyring, + LedgerIframeBridge, +} from '@metamask/eth-ledger-bridge-keyring'; +import LatticeKeyring from 'eth-lattice-keyring'; +import { rawChainData } from 'eth-chainlist'; +import { MetaMaskKeyring as QRHardwareKeyring } from '@keystonehq/metamask-airgapped-keyring'; +import EthQuery from '@metamask/eth-query'; +import EthJSQuery from '@metamask/ethjs-query'; +import nanoid from 'nanoid'; +import { captureException } from '@sentry/browser'; +import { AddressBookController } from '@metamask/address-book-controller'; +import { + ApprovalController, + ApprovalRequestNotFoundError, +} from '@metamask/approval-controller'; +import { ControllerMessenger } from '@metamask/base-controller'; +import { EnsController } from '@metamask/ens-controller'; +import { PhishingController } from '@metamask/phishing-controller'; +import { AnnouncementController } from '@metamask/announcement-controller'; +import { + NetworkController, + getDefaultNetworkControllerState, +} from '@metamask/network-controller'; +import { GasFeeController } from '@metamask/gas-fee-controller'; +import { + PermissionController, + PermissionDoesNotExistError, + PermissionsRequestNotFoundError, + SubjectMetadataController, + SubjectType, +} from '@metamask/permission-controller'; +import SmartTransactionsController from '@metamask/smart-transactions-controller'; +import { + METAMASK_DOMAIN, + SelectedNetworkController, + createSelectedNetworkMiddleware, +} from '@metamask/selected-network-controller'; +import { LoggingController, LogType } from '@metamask/logging-controller'; +import { PermissionLogController } from '@metamask/permission-log-controller'; + +import { RateLimitController } from '@metamask/rate-limit-controller'; +import { NotificationController } from '@metamask/notification-controller'; +import { + CronjobController, + JsonSnapsRegistry, + SnapController, + IframeExecutionService, + SnapInterfaceController, + SnapInsightsController, + OffscreenExecutionService, +} from '@metamask/snaps-controllers'; +import { + createSnapsMethodMiddleware, + buildSnapEndowmentSpecifications, + buildSnapRestrictedMethodSpecifications, +} from '@metamask/snaps-rpc-methods'; +import { + ApprovalType, + ERC1155, + ERC20, + ERC721, + BlockExplorerUrl, +} from '@metamask/controller-utils'; + +import { AccountsController } from '@metamask/accounts-controller'; + +///: BEGIN:ONLY_INCLUDE_IF(build-mmi) +import { + CUSTODIAN_TYPES, + MmiConfigurationController, +} from '@metamask-institutional/custody-keyring'; +import { InstitutionalFeaturesController } from '@metamask-institutional/institutional-features'; +import { CustodyController } from '@metamask-institutional/custody-controller'; +import { TransactionUpdateController } from '@metamask-institutional/transaction-update'; +///: END:ONLY_INCLUDE_IF +import { SignatureController } from '@metamask/signature-controller'; +import { PPOMController } from '@metamask/ppom-validator'; +import { wordlist } from '@metamask/scure-bip39/dist/wordlists/english'; + +import { + NameController, + ENSNameProvider, + EtherscanNameProvider, + TokenNameProvider, + LensNameProvider, +} from '@metamask/name-controller'; + +import { + QueuedRequestController, + createQueuedRequestMiddleware, +} from '@metamask/queued-request-controller'; + +import { UserOperationController } from '@metamask/user-operation-controller'; + +import { + TransactionController, + TransactionStatus, + TransactionType, +} from '@metamask/transaction-controller'; + +///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) +import { + getLocalizedSnapManifest, + stripSnapPrefix, +} from '@metamask/snaps-utils'; +///: END:ONLY_INCLUDE_IF + +import { Interface } from '@ethersproject/abi'; +import { abiERC1155, abiERC721 } from '@metamask/metamask-eth-abis'; +import { isEvmAccountType } from '@metamask/keyring-api'; +import { + AuthenticationController, + UserStorageController, +} from '@metamask/profile-sync-controller'; +import { + NotificationServicesPushController, + NotificationServicesController, +} from '@metamask/notification-services-controller'; +import { + methodsRequiringNetworkSwitch, + methodsThatCanSwitchNetworkWithoutApproval, + methodsThatShouldBeEnqueued, +} from '../../shared/constants/methods-tags'; + +///: BEGIN:ONLY_INCLUDE_IF(build-mmi) +import { toChecksumHexAddress } from '../../shared/modules/hexstring-utils'; +///: END:ONLY_INCLUDE_IF + +import { AssetType, TokenStandard } from '../../shared/constants/transaction'; +import { + GAS_API_BASE_URL, + GAS_DEV_API_BASE_URL, + SWAPS_CLIENT_ID, +} from '../../shared/constants/swaps'; +import { + CHAIN_IDS, + CHAIN_SPEC_URL, + NETWORK_TYPES, + NetworkStatus, + MAINNET_DISPLAY_NAME, +} from '../../shared/constants/network'; +import { getAllowedSmartTransactionsChainIds } from '../../shared/constants/smartTransactions'; + +import { + HardwareDeviceNames, + LedgerTransportTypes, +} from '../../shared/constants/hardware-wallets'; +import { KeyringType } from '../../shared/constants/keyring'; +import { + CaveatTypes, + RestrictedMethods, + EndowmentPermissions, + ExcludedSnapPermissions, + ExcludedSnapEndowments, +} from '../../shared/constants/permissions'; +import { UI_NOTIFICATIONS } from '../../shared/notifications'; +import { MILLISECOND, SECOND } from '../../shared/constants/time'; +import { + ORIGIN_METAMASK, + POLLING_TOKEN_ENVIRONMENT_TYPES, +} from '../../shared/constants/app'; +import { + MetaMetricsEventCategory, + MetaMetricsEventName, + MetaMetricsUserTrait, +} from '../../shared/constants/metametrics'; +import { LOG_EVENT } from '../../shared/constants/logs'; + +import { + getStorageItem, + setStorageItem, +} from '../../shared/lib/storage-helpers'; +import { + getTokenIdParam, + fetchTokenBalance, + fetchERC1155Balance, +} from '../../shared/lib/token-util'; +import { isEqualCaseInsensitive } from '../../shared/modules/string-utils'; +import { parseStandardTokenTransactionData } from '../../shared/modules/transaction.utils'; +import { STATIC_MAINNET_TOKEN_LIST } from '../../shared/constants/tokens'; +import { getTokenValueParam } from '../../shared/lib/metamask-controller-utils'; +import { isManifestV3 } from '../../shared/modules/mv3.utils'; +import { convertNetworkId } from '../../shared/modules/network.utils'; +import { + getIsSmartTransaction, + isHardwareWallet, + getFeatureFlagsByChainId, + getCurrentChainSupportsSmartTransactions, + getHardwareWalletType, + getSmartTransactionsPreferenceEnabled, +} from '../../shared/modules/selectors'; +import { createCaipStream } from '../../shared/modules/caip-stream'; +import { BaseUrl } from '../../shared/constants/urls'; +import { + TOKEN_TRANSFER_LOG_TOPIC_HASH, + TRANSFER_SINFLE_LOG_TOPIC_HASH, +} from '../../shared/lib/transactions-controller-utils'; +// TODO: Remove restricted import +// eslint-disable-next-line import/no-restricted-paths +import { getCurrentChainId } from '../../ui/selectors'; +// TODO: Remove restricted import +// eslint-disable-next-line import/no-restricted-paths +import { getProviderConfig } from '../../ui/ducks/metamask/metamask'; +import { endTrace, trace } from '../../shared/lib/trace'; +// eslint-disable-next-line import/no-restricted-paths +import { isSnapId } from '../../ui/helpers/utils/snaps'; +import { BalancesController as MultichainBalancesController } from './lib/accounts/BalancesController'; +import { + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + handleMMITransactionUpdate, + ///: END:ONLY_INCLUDE_IF + handleTransactionAdded, + handleTransactionApproved, + handleTransactionFailed, + handleTransactionConfirmed, + handleTransactionDropped, + handleTransactionRejected, + handleTransactionSubmitted, + handlePostTransactionBalanceUpdate, + createTransactionEventFragmentWithTxId, +} from './lib/transaction/metrics'; +///: BEGIN:ONLY_INCLUDE_IF(build-mmi) +import { + afterTransactionSign as afterTransactionSignMMI, + beforeCheckPendingTransaction as beforeCheckPendingTransactionMMI, + beforeTransactionPublish as beforeTransactionPublishMMI, + getAdditionalSignArguments as getAdditionalSignArgumentsMMI, +} from './lib/transaction/mmi-hooks'; +///: END:ONLY_INCLUDE_IF +import { submitSmartTransactionHook } from './lib/transaction/smart-transactions'; +///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) +import { keyringSnapPermissionsBuilder } from './lib/snap-keyring/keyring-snaps-permissions'; +///: END:ONLY_INCLUDE_IF + +import { SnapsNameProvider } from './lib/SnapsNameProvider'; +import { AddressBookPetnamesBridge } from './lib/AddressBookPetnamesBridge'; +import { AccountIdentitiesPetnamesBridge } from './lib/AccountIdentitiesPetnamesBridge'; +import { createPPOMMiddleware } from './lib/ppom/ppom-middleware'; +import * as PPOMModule from './lib/ppom/ppom'; +import { + onMessageReceived, + checkForMultipleVersionsRunning, +} from './detect-multiple-instances'; +///: BEGIN:ONLY_INCLUDE_IF(build-mmi) +import MMIController from './controllers/mmi-controller'; +import { mmiKeyringBuilderFactory } from './mmi-keyring-builder-factory'; +///: END:ONLY_INCLUDE_IF +import ComposableObservableStore from './lib/ComposableObservableStore'; +import AccountTrackerController from './controllers/account-tracker-controller'; +import createDupeReqFilterStream from './lib/createDupeReqFilterStream'; +import createLoggerMiddleware from './lib/createLoggerMiddleware'; +import { + createLegacyMethodMiddleware, + createMethodMiddleware, + createUnsupportedMethodMiddleware, +} from './lib/rpc-method-middleware'; +import createOriginMiddleware from './lib/createOriginMiddleware'; +import createTabIdMiddleware from './lib/createTabIdMiddleware'; +import { NetworkOrderController } from './controllers/network-order'; +import { AccountOrderController } from './controllers/account-order'; +import createOnboardingMiddleware from './lib/createOnboardingMiddleware'; +import { isStreamWritable, setupMultiplex } from './lib/stream-utils'; +import { PreferencesController } from './controllers/preferences-controller'; +import { AppStateController } from './controllers/app-state-controller'; +import { AlertController } from './controllers/alert-controller'; +import OnboardingController from './controllers/onboarding'; +import Backup from './lib/backup'; +import DecryptMessageController from './controllers/decrypt-message'; +import SwapsController from './controllers/swaps'; +import MetaMetricsController from './controllers/metametrics'; +import { segment } from './lib/segment'; +import createMetaRPCHandler from './lib/createMetaRPCHandler'; +import { + addHexPrefix, + getMethodDataName, + previousValueComparator, +} from './lib/util'; +import createMetamaskMiddleware from './lib/createMetamaskMiddleware'; +import { hardwareKeyringBuilderFactory } from './lib/hardware-keyring-builder-factory'; +import EncryptionPublicKeyController from './controllers/encryption-public-key'; +import AppMetadataController from './controllers/app-metadata'; + +import { + CaveatFactories, + CaveatMutatorFactories, + getCaveatSpecifications, + diffMap, + getPermissionBackgroundApiMethods, + getPermissionSpecifications, + getPermittedAccountsByOrigin, + getPermittedChainsByOrigin, + NOTIFICATION_NAMES, + PermissionNames, + unrestrictedMethods, +} from './controllers/permissions'; +import { MetaMetricsDataDeletionController } from './controllers/metametrics-data-deletion/metametrics-data-deletion'; +import { DataDeletionService } from './services/data-deletion-service'; +import createRPCMethodTrackingMiddleware from './lib/createRPCMethodTrackingMiddleware'; +import { IndexedDBPPOMStorage } from './lib/ppom/indexed-db-backend'; +import { updateCurrentLocale } from './translate'; +import { TrezorOffscreenBridge } from './lib/offscreen-bridge/trezor-offscreen-bridge'; +import { LedgerOffscreenBridge } from './lib/offscreen-bridge/ledger-offscreen-bridge'; +///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) +import { snapKeyringBuilder, getAccountsBySnapId } from './lib/snap-keyring'; +///: END:ONLY_INCLUDE_IF +import { encryptorFactory } from './lib/encryptor-factory'; +import { addDappTransaction, addTransaction } from './lib/transaction/util'; +///: BEGIN:ONLY_INCLUDE_IF(build-main,build-beta,build-flask) +import { addTypedMessage, addPersonalMessage } from './lib/signature/util'; +///: END:ONLY_INCLUDE_IF +import { LatticeKeyringOffscreen } from './lib/offscreen-bridge/lattice-offscreen-keyring'; +import PREINSTALLED_SNAPS from './snaps/preinstalled-snaps'; +import { WeakRefObjectMap } from './lib/WeakRefObjectMap'; +import { METAMASK_COOKIE_HANDLER } from './constants/stream'; + +// Notification controllers +import { createTxVerificationMiddleware } from './lib/tx-verification/tx-verification-middleware'; +import { updateSecurityAlertResponse } from './lib/ppom/ppom-util'; +import createEvmMethodsToNonEvmAccountReqFilterMiddleware from './lib/createEvmMethodsToNonEvmAccountReqFilterMiddleware'; +import { isEthAddress } from './lib/multichain/address'; +import { decodeTransactionData } from './lib/transaction/decode/util'; +import { + BridgeUserAction, + BridgeBackgroundAction, +} from './controllers/bridge/types'; +import BridgeController from './controllers/bridge/bridge-controller'; +import { BRIDGE_CONTROLLER_NAME } from './controllers/bridge/constants'; +import { + onPushNotificationClicked, + onPushNotificationReceived, +} from './controllers/push-notifications'; +import createTracingMiddleware from './lib/createTracingMiddleware'; +import { PatchStore } from './lib/PatchStore'; +import { sanitizeUIState } from './lib/state-utils'; + +export const METAMASK_CONTROLLER_EVENTS = { + // Fired after state changes that impact the extension badge (unapproved msg count) + // The process of updating the badge happens in app/scripts/background.js. + UPDATE_BADGE: 'updateBadge', + // TODO: Add this and similar enums to the `controllers` repo and export them + APPROVAL_STATE_CHANGE: 'ApprovalController:stateChange', + QUEUED_REQUEST_STATE_CHANGE: 'QueuedRequestController:stateChange', + METAMASK_NOTIFICATIONS_LIST_UPDATED: + 'NotificationServicesController:notificationsListUpdated', + METAMASK_NOTIFICATIONS_MARK_AS_READ: + 'NotificationServicesController:markNotificationsAsRead', + NOTIFICATIONS_STATE_CHANGE: 'NotificationController:stateChange', +}; + +// stream channels +const PHISHING_SAFELIST = 'metamask-phishing-safelist'; + +// OneKey devices can connect to Metamask using Trezor USB transport. They use a specific device minor version (99) to differentiate between genuine Trezor and OneKey devices. +export const ONE_KEY_VIA_TREZOR_MINOR_VERSION = 99; + +export default class MetamaskController extends EventEmitter { + /** + * @param {object} opts + */ + constructor(opts) { + super(); + + const { isFirstMetaMaskControllerSetup } = opts; + + this.defaultMaxListeners = 20; + + this.sendUpdate = debounce( + this.privateSendUpdate.bind(this), + MILLISECOND * 200, + ); + this.opts = opts; + this.extension = opts.browser; + this.platform = opts.platform; + this.notificationManager = opts.notificationManager; + const initState = opts.initState || {}; + const version = process.env.METAMASK_VERSION; + this.recordFirstTimeInfo(initState); + this.featureFlags = opts.featureFlags; + + // this keeps track of how many "controllerStream" connections are open + // the only thing that uses controller connections are open metamask UI instances + this.activeControllerConnections = 0; + + this.offscreenPromise = opts.offscreenPromise ?? Promise.resolve(); + + this.getRequestAccountTabIds = opts.getRequestAccountTabIds; + this.getOpenMetamaskTabsIds = opts.getOpenMetamaskTabsIds; + + this.initializeChainlist(); + + this.controllerMessenger = new ControllerMessenger(); + + this.loggingController = new LoggingController({ + messenger: this.controllerMessenger.getRestricted({ + name: 'LoggingController', + allowedActions: [], + allowedEvents: [], + }), + state: initState.LoggingController, + }); + + // instance of a class that wraps the extension's storage local API. + this.localStoreApiWrapper = opts.localStore; + + this.currentMigrationVersion = opts.currentMigrationVersion; + + // observable state store + this.store = new ComposableObservableStore({ + state: initState, + controllerMessenger: this.controllerMessenger, + persist: true, + }); + + // external connections by origin + // Do not modify directly. Use the associated methods. + this.connections = {}; + + // lock to ensure only one vault created at once + this.createVaultMutex = new Mutex(); + + this.extension.runtime.onInstalled.addListener((details) => { + if (details.reason === 'update') { + if (version === '8.1.0') { + this.platform.openExtensionInBrowser(); + } + this.loggingController.add({ + type: LogType.GenericLog, + data: { + event: LOG_EVENT.VERSION_UPDATE, + previousVersion: details.previousVersion, + version, + }, + }); + } + }); + + this.appMetadataController = new AppMetadataController({ + state: initState.AppMetadataController, + currentMigrationVersion: this.currentMigrationVersion, + currentAppVersion: version, + }); + + // next, we will initialize the controllers + // controller initialization order matters + const clearPendingConfirmations = () => { + this.encryptionPublicKeyController.clearUnapproved(); + this.decryptMessageController.clearUnapproved(); + this.signatureController.clearUnapproved(); + this.approvalController.clear(providerErrors.userRejectedRequest()); + }; + + this.approvalController = new ApprovalController({ + messenger: this.controllerMessenger.getRestricted({ + name: 'ApprovalController', + }), + showApprovalRequest: opts.showUserConfirmation, + typesExcludedFromRateLimiting: [ + ApprovalType.PersonalSign, + ApprovalType.EthSignTypedData, + ApprovalType.Transaction, + ApprovalType.WatchAsset, + ApprovalType.EthGetEncryptionPublicKey, + ApprovalType.EthDecrypt, + ], + }); + + this.queuedRequestController = new QueuedRequestController({ + messenger: this.controllerMessenger.getRestricted({ + name: 'QueuedRequestController', + allowedActions: [ + 'NetworkController:getState', + 'NetworkController:setActiveNetwork', + 'SelectedNetworkController:getNetworkClientIdForDomain', + ], + allowedEvents: ['SelectedNetworkController:stateChange'], + }), + shouldRequestSwitchNetwork: ({ method }) => + methodsRequiringNetworkSwitch.includes(method), + canRequestSwitchNetworkWithoutApproval: ({ method }) => + methodsThatCanSwitchNetworkWithoutApproval.includes(method), + clearPendingConfirmations, + showApprovalRequest: () => { + if (this.approvalController.getTotalApprovalCount() > 0) { + opts.showUserConfirmation(); + } + }, + }); + + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + this.mmiConfigurationController = new MmiConfigurationController({ + initState: initState.MmiConfigurationController, + mmiConfigurationServiceUrl: process.env.MMI_CONFIGURATION_SERVICE_URL, + }); + ///: END:ONLY_INCLUDE_IF + + const networkControllerMessenger = this.controllerMessenger.getRestricted({ + name: 'NetworkController', + }); + + let initialNetworkControllerState = initState.NetworkController; + if (!initialNetworkControllerState) { + initialNetworkControllerState = getDefaultNetworkControllerState(); + + const networks = + initialNetworkControllerState.networkConfigurationsByChainId; + + // Note: Consider changing `getDefaultNetworkControllerState` + // on the controller side to include some of these tweaks. + networks[CHAIN_IDS.MAINNET].name = MAINNET_DISPLAY_NAME; + delete networks[CHAIN_IDS.GOERLI]; + delete networks[CHAIN_IDS.LINEA_GOERLI]; + + Object.values(networks).forEach((network) => { + const id = network.rpcEndpoints[0].networkClientId; + network.blockExplorerUrls = [BlockExplorerUrl[id]]; + network.defaultBlockExplorerUrlIndex = 0; + }); + + let network; + if (process.env.IN_TEST) { + network = { + chainId: CHAIN_IDS.LOCALHOST, + name: 'Localhost 8545', + nativeCurrency: 'ETH', + blockExplorerUrls: [], + defaultRpcEndpointIndex: 0, + rpcEndpoints: [ + { + networkClientId: 'networkConfigurationId', + url: 'http://localhost:8545', + type: 'custom', + }, + ], + }; + networks[CHAIN_IDS.LOCALHOST] = network; + } else if ( + process.env.METAMASK_DEBUG || + process.env.METAMASK_ENVIRONMENT === 'test' + ) { + network = networks[CHAIN_IDS.SEPOLIA]; + } else { + network = networks[CHAIN_IDS.MAINNET]; + } + + initialNetworkControllerState.selectedNetworkClientId = + network.rpcEndpoints[network.defaultRpcEndpointIndex].networkClientId; + } + + this.networkController = new NetworkController({ + messenger: networkControllerMessenger, + state: initialNetworkControllerState, + infuraProjectId: opts.infuraProjectId, + }); + this.networkController.initializeProvider(); + this.provider = + this.networkController.getProviderAndBlockTracker().provider; + this.blockTracker = + this.networkController.getProviderAndBlockTracker().blockTracker; + this.deprecatedNetworkVersions = {}; + + const accountsControllerMessenger = this.controllerMessenger.getRestricted({ + name: 'AccountsController', + allowedEvents: [ + 'SnapController:stateChange', + 'KeyringController:accountRemoved', + 'KeyringController:stateChange', + ], + allowedActions: [ + 'KeyringController:getAccounts', + 'KeyringController:getKeyringsByType', + 'KeyringController:getKeyringForAccount', + ], + }); + + this.accountsController = new AccountsController({ + messenger: accountsControllerMessenger, + state: initState.AccountsController, + }); + + const preferencesMessenger = this.controllerMessenger.getRestricted({ + name: 'PreferencesController', + allowedActions: [ + 'AccountsController:setSelectedAccount', + 'AccountsController:getSelectedAccount', + 'AccountsController:getAccountByAddress', + 'AccountsController:setAccountName', + 'NetworkController:getState', + ], + allowedEvents: ['AccountsController:stateChange'], + }); + + this.preferencesController = new PreferencesController({ + state: { + currentLocale: opts.initLangCode ?? '', + ...initState.PreferencesController, + }, + messenger: preferencesMessenger, + }); + + const tokenListMessenger = this.controllerMessenger.getRestricted({ + name: 'TokenListController', + allowedActions: ['NetworkController:getNetworkClientById'], + allowedEvents: ['NetworkController:stateChange'], + }); + + this.tokenListController = new TokenListController({ + chainId: getCurrentChainId({ metamask: this.networkController.state }), + preventPollingOnNetworkRestart: !this.#isTokenListPollingRequired( + this.preferencesController.state, + ), + messenger: tokenListMessenger, + state: initState.TokenListController, + }); + + const assetsContractControllerMessenger = + this.controllerMessenger.getRestricted({ + name: 'AssetsContractController', + allowedActions: [ + 'NetworkController:getNetworkClientById', + 'NetworkController:getNetworkConfigurationByNetworkClientId', + 'NetworkController:getSelectedNetworkClient', + 'NetworkController:getState', + ], + allowedEvents: [ + 'PreferencesController:stateChange', + 'NetworkController:networkDidChange', + ], + }); + this.assetsContractController = new AssetsContractController({ + messenger: assetsContractControllerMessenger, + chainId: getCurrentChainId({ metamask: this.networkController.state }), + }); + + const tokensControllerMessenger = this.controllerMessenger.getRestricted({ + name: 'TokensController', + allowedActions: [ + 'ApprovalController:addRequest', + 'NetworkController:getNetworkClientById', + 'AccountsController:getSelectedAccount', + 'AccountsController:getAccount', + ], + allowedEvents: [ + 'NetworkController:networkDidChange', + 'AccountsController:selectedEvmAccountChange', + 'PreferencesController:stateChange', + 'TokenListController:stateChange', + ], + }); + this.tokensController = new TokensController({ + state: initState.TokensController, + provider: this.provider, + messenger: tokensControllerMessenger, + chainId: getCurrentChainId({ metamask: this.networkController.state }), + }); + + const nftControllerMessenger = this.controllerMessenger.getRestricted({ + name: 'NftController', + allowedEvents: [ + 'PreferencesController:stateChange', + 'NetworkController:networkDidChange', + 'AccountsController:selectedEvmAccountChange', + ], + allowedActions: [ + `${this.approvalController.name}:addRequest`, + `${this.networkController.name}:getNetworkClientById`, + 'AccountsController:getSelectedAccount', + 'AccountsController:getAccount', + 'AssetsContractController:getERC721AssetName', + 'AssetsContractController:getERC721AssetSymbol', + 'AssetsContractController:getERC721TokenURI', + 'AssetsContractController:getERC721OwnerOf', + 'AssetsContractController:getERC1155BalanceOf', + 'AssetsContractController:getERC1155TokenURI', + ], + }); + this.nftController = new NftController({ + state: initState.NftController, + messenger: nftControllerMessenger, + chainId: getCurrentChainId({ metamask: this.networkController.state }), + onNftAdded: ({ address, symbol, tokenId, standard, source }) => + this.metaMetricsController.trackEvent({ + event: MetaMetricsEventName.NftAdded, + category: MetaMetricsEventCategory.Wallet, + sensitiveProperties: { + token_contract_address: address, + token_symbol: symbol, + token_id: tokenId, + token_standard: standard, + asset_type: AssetType.NFT, + source, + }, + }), + }); + + this.nftController.setApiKey(process.env.OPENSEA_KEY); + + const nftDetectionControllerMessenger = + this.controllerMessenger.getRestricted({ + name: 'NftDetectionController', + allowedEvents: [ + 'NetworkController:stateChange', + 'PreferencesController:stateChange', + ], + allowedActions: [ + 'ApprovalController:addRequest', + 'NetworkController:getState', + 'NetworkController:getNetworkClientById', + 'AccountsController:getSelectedAccount', + ], + }); + + this.nftDetectionController = new NftDetectionController({ + messenger: nftDetectionControllerMessenger, + chainId: getCurrentChainId({ metamask: this.networkController.state }), + getOpenSeaApiKey: () => this.nftController.openSeaApiKey, + getBalancesInSingleCall: + this.assetsContractController.getBalancesInSingleCall.bind( + this.assetsContractController, + ), + addNft: this.nftController.addNft.bind(this.nftController), + getNftState: () => this.nftController.state, + // added this to track previous value of useNftDetection, should be true on very first initializing of controller[] + disabled: !this.preferencesController.state.useNftDetection, + }); + + this.metaMetricsController = new MetaMetricsController({ + initState: initState.MetaMetricsController, + segment, + preferencesControllerState: { + currentLocale: this.preferencesController.state.currentLocale, + selectedAddress: this.preferencesController.state.selectedAddress, + }, + onPreferencesStateChange: preferencesMessenger.subscribe.bind( + preferencesMessenger, + 'PreferencesController:stateChange', + ), + onNetworkDidChange: networkControllerMessenger.subscribe.bind( + networkControllerMessenger, + 'NetworkController:networkDidChange', + ), + getCurrentChainId: () => + getCurrentChainId({ metamask: this.networkController.state }), + version: process.env.METAMASK_VERSION, + environment: process.env.METAMASK_ENVIRONMENT, + extension: this.extension, + captureException, + }); + + this.on('update', (update) => { + this.metaMetricsController.handleMetaMaskStateUpdate(update); + }); + + const dataDeletionService = new DataDeletionService(); + const metaMetricsDataDeletionMessenger = + this.controllerMessenger.getRestricted({ + name: 'MetaMetricsDataDeletionController', + }); + this.metaMetricsDataDeletionController = + new MetaMetricsDataDeletionController({ + dataDeletionService, + messenger: metaMetricsDataDeletionMessenger, + state: initState.metaMetricsDataDeletionController, + getMetaMetricsId: () => this.metaMetricsController.state.metaMetricsId, + }); + + const gasFeeMessenger = this.controllerMessenger.getRestricted({ + name: 'GasFeeController', + allowedActions: [ + 'NetworkController:getEIP1559Compatibility', + 'NetworkController:getNetworkClientById', + 'NetworkController:getState', + ], + allowedEvents: ['NetworkController:stateChange'], + }); + + const gasApiBaseUrl = process.env.SWAPS_USE_DEV_APIS + ? GAS_DEV_API_BASE_URL + : GAS_API_BASE_URL; + + this.gasFeeController = new GasFeeController({ + state: initState.GasFeeController, + interval: 10000, + messenger: gasFeeMessenger, + clientId: SWAPS_CLIENT_ID, + getProvider: () => + this.networkController.getProviderAndBlockTracker().provider, + onNetworkDidChange: (eventHandler) => { + networkControllerMessenger.subscribe( + 'NetworkController:networkDidChange', + () => eventHandler(this.networkController.state), + ); + }, + getCurrentNetworkEIP1559Compatibility: + this.networkController.getEIP1559Compatibility.bind( + this.networkController, + ), + getCurrentAccountEIP1559Compatibility: + this.getCurrentAccountEIP1559Compatibility.bind(this), + legacyAPIEndpoint: `${gasApiBaseUrl}/networks//gasPrices`, + EIP1559APIEndpoint: `${gasApiBaseUrl}/networks//suggestedGasFees`, + getCurrentNetworkLegacyGasAPICompatibility: () => { + const chainId = getCurrentChainId({ + metamask: this.networkController.state, + }); + return chainId === CHAIN_IDS.BSC; + }, + getChainId: () => + getCurrentChainId({ metamask: this.networkController.state }), + }); + + this.appStateController = new AppStateController({ + addUnlockListener: this.on.bind(this, 'unlock'), + isUnlocked: this.isUnlocked.bind(this), + initState: initState.AppStateController, + onInactiveTimeout: () => this.setLocked(), + messenger: this.controllerMessenger.getRestricted({ + name: 'AppStateController', + allowedActions: [ + `${this.approvalController.name}:addRequest`, + `${this.approvalController.name}:acceptRequest`, + `PreferencesController:getState`, + ], + allowedEvents: [ + `KeyringController:qrKeyringStateChange`, + 'PreferencesController:stateChange', + ], + }), + extension: this.extension, + }); + + const currencyRateMessenger = this.controllerMessenger.getRestricted({ + name: 'CurrencyRateController', + allowedActions: [`${this.networkController.name}:getNetworkClientById`], + }); + this.currencyRateController = new CurrencyRateController({ + includeUsdRate: true, + messenger: currencyRateMessenger, + state: initState.CurrencyController, + }); + const initialFetchMultiExchangeRate = + this.currencyRateController.fetchMultiExchangeRate.bind( + this.currencyRateController, + ); + this.currencyRateController.fetchMultiExchangeRate = (...args) => { + if (this.preferencesController.state.useCurrencyRateCheck) { + return initialFetchMultiExchangeRate(...args); + } + return { + conversionRate: null, + usdConversionRate: null, + }; + }; + + const phishingControllerMessenger = this.controllerMessenger.getRestricted({ + name: 'PhishingController', + }); + + this.phishingController = new PhishingController({ + messenger: phishingControllerMessenger, + state: initState.PhishingController, + hotlistRefreshInterval: process.env.IN_TEST ? 5 * SECOND : undefined, + stalelistRefreshInterval: process.env.IN_TEST ? 30 * SECOND : undefined, + }); + + this.ppomController = new PPOMController({ + messenger: this.controllerMessenger.getRestricted({ + name: 'PPOMController', + allowedEvents: [ + 'NetworkController:stateChange', + 'NetworkController:networkDidChange', + ], + allowedActions: ['NetworkController:getNetworkClientById'], + }), + storageBackend: new IndexedDBPPOMStorage('PPOMDB', 1), + provider: this.provider, + ppomProvider: { + PPOM: PPOMModule.PPOM, + ppomInit: () => PPOMModule.default(process.env.PPOM_URI), + }, + state: initState.PPOMController, + chainId: getCurrentChainId({ metamask: this.networkController.state }), + securityAlertsEnabled: + this.preferencesController.state.securityAlertsEnabled, + onPreferencesChange: preferencesMessenger.subscribe.bind( + preferencesMessenger, + 'PreferencesController:stateChange', + ), + cdnBaseUrl: process.env.BLOCKAID_FILE_CDN, + blockaidPublicKey: process.env.BLOCKAID_PUBLIC_KEY, + }); + + const announcementMessenger = this.controllerMessenger.getRestricted({ + name: 'AnnouncementController', + }); + + this.announcementController = new AnnouncementController({ + messenger: announcementMessenger, + allAnnouncements: UI_NOTIFICATIONS, + state: initState.AnnouncementController, + }); + + const networkOrderMessenger = this.controllerMessenger.getRestricted({ + name: 'NetworkOrderController', + allowedEvents: ['NetworkController:stateChange'], + }); + this.networkOrderController = new NetworkOrderController({ + messenger: networkOrderMessenger, + state: initState.NetworkOrderController, + }); + + const accountOrderMessenger = this.controllerMessenger.getRestricted({ + name: 'AccountOrderController', + }); + this.accountOrderController = new AccountOrderController({ + messenger: accountOrderMessenger, + state: initState.AccountOrderController, + }); + + const multichainBalancesControllerMessenger = + this.controllerMessenger.getRestricted({ + name: 'BalancesController', + allowedEvents: [ + 'AccountsController:accountAdded', + 'AccountsController:accountRemoved', + ], + allowedActions: [ + 'AccountsController:listMultichainAccounts', + 'SnapController:handleRequest', + ], + }); + + this.multichainBalancesController = new MultichainBalancesController({ + messenger: multichainBalancesControllerMessenger, + state: initState.MultichainBalancesController, + }); + + const multichainRatesControllerMessenger = + this.controllerMessenger.getRestricted({ + name: 'RatesController', + }); + this.multichainRatesController = new RatesController({ + state: initState.MultichainRatesController, + messenger: multichainRatesControllerMessenger, + includeUsdRate: true, + fetchMultiExchangeRate, + }); + + const tokenRatesMessenger = this.controllerMessenger.getRestricted({ + name: 'TokenRatesController', + allowedActions: [ + 'TokensController:getState', + 'NetworkController:getNetworkClientById', + 'NetworkController:getState', + 'AccountsController:getAccount', + 'AccountsController:getSelectedAccount', + ], + allowedEvents: [ + 'NetworkController:stateChange', + 'AccountsController:selectedEvmAccountChange', + 'PreferencesController:stateChange', + 'TokensController:stateChange', + ], + }); + + // token exchange rate tracker + this.tokenRatesController = new TokenRatesController({ + state: initState.TokenRatesController, + messenger: tokenRatesMessenger, + tokenPricesService: new CodefiTokenPricesServiceV2(), + disabled: !this.preferencesController.state.useCurrencyRateCheck, + }); + + this.controllerMessenger.subscribe( + 'PreferencesController:stateChange', + previousValueComparator((prevState, currState) => { + const { useCurrencyRateCheck: prevUseCurrencyRateCheck } = prevState; + const { useCurrencyRateCheck: currUseCurrencyRateCheck } = currState; + if (currUseCurrencyRateCheck && !prevUseCurrencyRateCheck) { + this.tokenRatesController.enable(); + } else if (!currUseCurrencyRateCheck && prevUseCurrencyRateCheck) { + this.tokenRatesController.disable(); + } + }, this.preferencesController.state), + ); + + this.ensController = new EnsController({ + messenger: this.controllerMessenger.getRestricted({ + name: 'EnsController', + allowedActions: ['NetworkController:getNetworkClientById'], + allowedEvents: [], + }), + provider: this.provider, + onNetworkDidChange: networkControllerMessenger.subscribe.bind( + networkControllerMessenger, + 'NetworkController:networkDidChange', + ), + }); + + const onboardingControllerMessenger = + this.controllerMessenger.getRestricted({ + name: 'OnboardingController', + allowedActions: [], + allowedEvents: [], + }); + this.onboardingController = new OnboardingController({ + messenger: onboardingControllerMessenger, + state: initState.OnboardingController, + }); + + let additionalKeyrings = [keyringBuilderFactory(QRHardwareKeyring)]; + + const keyringOverrides = this.opts.overrides?.keyrings; + + if (isManifestV3 === false) { + const additionalKeyringTypes = [ + keyringOverrides?.lattice || LatticeKeyring, + QRHardwareKeyring, + ]; + + const additionalBridgedKeyringTypes = [ + { + keyring: keyringOverrides?.trezor || TrezorKeyring, + bridge: keyringOverrides?.trezorBridge || TrezorConnectBridge, + }, + { + keyring: keyringOverrides?.ledger || LedgerKeyring, + bridge: keyringOverrides?.ledgerBridge || LedgerIframeBridge, + }, + ]; + + additionalKeyrings = additionalKeyringTypes.map((keyringType) => + keyringBuilderFactory(keyringType), + ); + + additionalBridgedKeyringTypes.forEach((keyringType) => + additionalKeyrings.push( + hardwareKeyringBuilderFactory( + keyringType.keyring, + keyringType.bridge, + ), + ), + ); + } else { + additionalKeyrings.push( + hardwareKeyringBuilderFactory( + TrezorKeyring, + keyringOverrides?.trezorBridge || TrezorOffscreenBridge, + ), + hardwareKeyringBuilderFactory( + LedgerKeyring, + keyringOverrides?.ledgerBridge || LedgerOffscreenBridge, + ), + keyringBuilderFactory(LatticeKeyringOffscreen), + ); + } + + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + for (const custodianType of Object.keys(CUSTODIAN_TYPES)) { + additionalKeyrings.push( + mmiKeyringBuilderFactory(CUSTODIAN_TYPES[custodianType].keyringClass, { + mmiConfigurationController: this.mmiConfigurationController, + captureException, + }), + ); + } + ///: END:ONLY_INCLUDE_IF + + ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) + const snapKeyringBuildMessenger = this.controllerMessenger.getRestricted({ + name: 'SnapKeyringBuilder', + allowedActions: [ + 'ApprovalController:addRequest', + 'ApprovalController:acceptRequest', + 'ApprovalController:rejectRequest', + 'ApprovalController:startFlow', + 'ApprovalController:endFlow', + 'ApprovalController:showSuccess', + 'ApprovalController:showError', + 'PhishingController:test', + 'PhishingController:maybeUpdateState', + 'KeyringController:getAccounts', + 'AccountsController:setSelectedAccount', + 'AccountsController:getAccountByAddress', + 'AccountsController:setAccountName', + ], + }); + + const getSnapController = () => this.snapController; + + // Necessary to persist the keyrings and update the accounts both within the keyring controller and accounts controller + const persistAndUpdateAccounts = async () => { + await this.keyringController.persistAllKeyrings(); + await this.accountsController.updateAccounts(); + }; + + const getSnapName = (id) => { + if (!id) { + return null; + } + + const currentLocale = this.getLocale(); + const { snaps } = this.snapController.state; + const snap = snaps[id]; + + if (!snap) { + return stripSnapPrefix(id); + } + + if (snap.localizationFiles) { + const localizedManifest = getLocalizedSnapManifest( + snap.manifest, + currentLocale, + snap.localizationFiles, + ); + return localizedManifest.proposedName; + } + + return snap.manifest.proposedName; + }; + + const isSnapPreinstalled = (id) => { + return PREINSTALLED_SNAPS.some((snap) => snap.snapId === id); + }; + + additionalKeyrings.push( + snapKeyringBuilder( + snapKeyringBuildMessenger, + getSnapController, + persistAndUpdateAccounts, + (address) => this.removeAccount(address), + this.metaMetricsController.trackEvent.bind(this.metaMetricsController), + getSnapName, + isSnapPreinstalled, + ), + ); + + ///: END:ONLY_INCLUDE_IF + + const keyringControllerMessenger = this.controllerMessenger.getRestricted({ + name: 'KeyringController', + }); + + this.keyringController = new KeyringController({ + cacheEncryptionKey: true, + keyringBuilders: additionalKeyrings, + state: initState.KeyringController, + encryptor: opts.encryptor || encryptorFactory(600_000), + messenger: keyringControllerMessenger, + }); + + this.controllerMessenger.subscribe('KeyringController:unlock', () => + this._onUnlock(), + ); + this.controllerMessenger.subscribe('KeyringController:lock', () => + this._onLock(), + ); + + this.controllerMessenger.subscribe( + 'KeyringController:stateChange', + (state) => { + this._onKeyringControllerUpdate(state); + }, + ); + + this.permissionController = new PermissionController({ + messenger: this.controllerMessenger.getRestricted({ + name: 'PermissionController', + allowedActions: [ + `${this.approvalController.name}:addRequest`, + `${this.approvalController.name}:hasRequest`, + `${this.approvalController.name}:acceptRequest`, + `${this.approvalController.name}:rejectRequest`, + `SnapController:getPermitted`, + `SnapController:install`, + `SubjectMetadataController:getSubjectMetadata`, + ], + }), + state: initState.PermissionController, + caveatSpecifications: getCaveatSpecifications({ + getInternalAccounts: this.accountsController.listAccounts.bind( + this.accountsController, + ), + findNetworkClientIdByChainId: + this.networkController.findNetworkClientIdByChainId.bind( + this.networkController, + ), + }), + permissionSpecifications: { + ...getPermissionSpecifications({ + getInternalAccounts: this.accountsController.listAccounts.bind( + this.accountsController, + ), + getAllAccounts: this.keyringController.getAccounts.bind( + this.keyringController, + ), + captureKeyringTypesWithMissingIdentities: ( + internalAccounts = [], + accounts = [], + ) => { + const accountsMissingIdentities = accounts.filter( + (address) => + !internalAccounts.some( + (account) => + account.address.toLowerCase() === address.toLowerCase(), + ), + ); + const keyringTypesWithMissingIdentities = + accountsMissingIdentities.map((address) => + this.keyringController.getAccountKeyringType(address), + ); + + const internalAccountCount = internalAccounts.length; + + const accountTrackerCount = Object.keys( + this.accountTrackerController.state.accounts || {}, + ).length; + + captureException( + new Error( + `Attempt to get permission specifications failed because their were ${accounts.length} accounts, but ${internalAccountCount} identities, and the ${keyringTypesWithMissingIdentities} keyrings included accounts with missing identities. Meanwhile, there are ${accountTrackerCount} accounts in the account tracker.`, + ), + ); + }, + }), + ...this.getSnapPermissionSpecifications(), + }, + unrestrictedMethods, + }); + + this.selectedNetworkController = new SelectedNetworkController({ + messenger: this.controllerMessenger.getRestricted({ + name: 'SelectedNetworkController', + allowedActions: [ + 'NetworkController:getNetworkClientById', + 'NetworkController:getState', + 'NetworkController:getSelectedNetworkClient', + 'PermissionController:hasPermissions', + 'PermissionController:getSubjectNames', + ], + allowedEvents: [ + 'NetworkController:stateChange', + 'PermissionController:stateChange', + ], + }), + state: initState.SelectedNetworkController, + useRequestQueuePreference: + this.preferencesController.state.useRequestQueue, + onPreferencesStateChange: (listener) => { + preferencesMessenger.subscribe( + 'PreferencesController:stateChange', + listener, + ); + }, + domainProxyMap: new WeakRefObjectMap(), + }); + + this.permissionLogController = new PermissionLogController({ + messenger: this.controllerMessenger.getRestricted({ + name: 'PermissionLogController', + }), + restrictedMethods: new Set(Object.keys(RestrictedMethods)), + state: initState.PermissionLogController, + }); + + this.subjectMetadataController = new SubjectMetadataController({ + messenger: this.controllerMessenger.getRestricted({ + name: 'SubjectMetadataController', + allowedActions: [`${this.permissionController.name}:hasPermissions`], + }), + state: initState.SubjectMetadataController, + subjectCacheLimit: 100, + }); + + const shouldUseOffscreenExecutionService = + isManifestV3 && + typeof chrome !== 'undefined' && + // eslint-disable-next-line no-undef + typeof chrome.offscreen !== 'undefined'; + + const snapExecutionServiceArgs = { + messenger: this.controllerMessenger.getRestricted({ + name: 'ExecutionService', + }), + setupSnapProvider: this.setupSnapProvider.bind(this), + }; + + this.snapExecutionService = + shouldUseOffscreenExecutionService === false + ? new IframeExecutionService({ + ...snapExecutionServiceArgs, + iframeUrl: new URL(process.env.IFRAME_EXECUTION_ENVIRONMENT_URL), + }) + : new OffscreenExecutionService({ + ...snapExecutionServiceArgs, + offscreenPromise: this.offscreenPromise, + }); + + const snapControllerMessenger = this.controllerMessenger.getRestricted({ + name: 'SnapController', + allowedEvents: [ + 'ExecutionService:unhandledError', + 'ExecutionService:outboundRequest', + 'ExecutionService:outboundResponse', + ], + allowedActions: [ + `${this.permissionController.name}:getEndowments`, + `${this.permissionController.name}:getPermissions`, + `${this.permissionController.name}:hasPermission`, + `${this.permissionController.name}:hasPermissions`, + `${this.permissionController.name}:requestPermissions`, + `${this.permissionController.name}:revokeAllPermissions`, + `${this.permissionController.name}:revokePermissions`, + `${this.permissionController.name}:revokePermissionForAllSubjects`, + `${this.permissionController.name}:getSubjectNames`, + `${this.permissionController.name}:updateCaveat`, + `${this.approvalController.name}:addRequest`, + `${this.approvalController.name}:updateRequestState`, + `${this.permissionController.name}:grantPermissions`, + `${this.subjectMetadataController.name}:getSubjectMetadata`, + `${this.subjectMetadataController.name}:addSubjectMetadata`, + 'ExecutionService:executeSnap', + 'ExecutionService:getRpcRequestHandler', + 'ExecutionService:terminateSnap', + 'ExecutionService:terminateAllSnaps', + 'ExecutionService:handleRpcRequest', + 'SnapsRegistry:get', + 'SnapsRegistry:getMetadata', + 'SnapsRegistry:update', + 'SnapsRegistry:resolveVersion', + `SnapInterfaceController:createInterface`, + `SnapInterfaceController:getInterface`, + ], + }); + + const allowLocalSnaps = process.env.ALLOW_LOCAL_SNAPS; + const requireAllowlist = process.env.REQUIRE_SNAPS_ALLOWLIST; + const rejectInvalidPlatformVersion = + process.env.REJECT_INVALID_SNAPS_PLATFORM_VERSION; + + this.snapController = new SnapController({ + environmentEndowmentPermissions: Object.values(EndowmentPermissions), + excludedPermissions: { + ...ExcludedSnapPermissions, + ...ExcludedSnapEndowments, + }, + closeAllConnections: this.removeAllConnections.bind(this), + state: initState.SnapController, + messenger: snapControllerMessenger, + featureFlags: { + dappsCanUpdateSnaps: true, + allowLocalSnaps, + requireAllowlist, + rejectInvalidPlatformVersion, + }, + encryptor: encryptorFactory(600_000), + getMnemonic: this.getPrimaryKeyringMnemonic.bind(this), + preinstalledSnaps: PREINSTALLED_SNAPS, + getFeatureFlags: () => { + return { + disableSnaps: + this.preferencesController.state.useExternalServices === false, + }; + }, + }); + + this.notificationController = new NotificationController({ + messenger: this.controllerMessenger.getRestricted({ + name: 'NotificationController', + }), + state: initState.NotificationController, + }); + + this.rateLimitController = new RateLimitController({ + state: initState.RateLimitController, + messenger: this.controllerMessenger.getRestricted({ + name: 'RateLimitController', + }), + implementations: { + showNativeNotification: { + method: (origin, message) => { + const subjectMetadataState = this.controllerMessenger.call( + 'SubjectMetadataController:getState', + ); + + const originMetadata = subjectMetadataState.subjectMetadata[origin]; + + this.platform + ._showNotification(originMetadata?.name ?? origin, message) + .catch((error) => { + log.error('Failed to create notification', error); + }); + + return null; + }, + // 2 calls per 5 minutes + rateLimitCount: 2, + rateLimitTimeout: 300000, + }, + showInAppNotification: { + method: (origin, message) => { + this.controllerMessenger.call( + 'NotificationController:show', + origin, + message, + ); + + return null; + }, + // 5 calls per minute + rateLimitCount: 5, + rateLimitTimeout: 60000, + }, + }, + }); + const cronjobControllerMessenger = this.controllerMessenger.getRestricted({ + name: 'CronjobController', + allowedEvents: [ + 'SnapController:snapInstalled', + 'SnapController:snapUpdated', + 'SnapController:snapUninstalled', + 'SnapController:snapEnabled', + 'SnapController:snapDisabled', + ], + allowedActions: [ + `${this.permissionController.name}:getPermissions`, + 'SnapController:handleRequest', + 'SnapController:getAll', + ], + }); + this.cronjobController = new CronjobController({ + state: initState.CronjobController, + messenger: cronjobControllerMessenger, + }); + + const snapsRegistryMessenger = this.controllerMessenger.getRestricted({ + name: 'SnapsRegistry', + allowedEvents: [], + allowedActions: [], + }); + + this.snapsRegistry = new JsonSnapsRegistry({ + state: initState.SnapsRegistry, + messenger: snapsRegistryMessenger, + refetchOnAllowlistMiss: requireAllowlist, + url: { + registry: 'https://acl.execution.metamask.io/latest/registry.json', + signature: 'https://acl.execution.metamask.io/latest/signature.json', + }, + publicKey: + '0x025b65308f0f0fb8bc7f7ff87bfc296e0330eee5d3c1d1ee4a048b2fd6a86fa0a6', + }); + + const snapInterfaceControllerMessenger = + this.controllerMessenger.getRestricted({ + name: 'SnapInterfaceController', + allowedActions: [ + `${this.phishingController.name}:maybeUpdateState`, + `${this.phishingController.name}:testOrigin`, + `${this.approvalController.name}:hasRequest`, + `${this.approvalController.name}:acceptRequest`, + `${this.snapController.name}:get`, + ], + }); + + this.snapInterfaceController = new SnapInterfaceController({ + state: initState.SnapInterfaceController, + messenger: snapInterfaceControllerMessenger, + }); + + const snapInsightsControllerMessenger = + this.controllerMessenger.getRestricted({ + name: 'SnapInsightsController', + allowedActions: [ + `${this.snapController.name}:handleRequest`, + `${this.snapController.name}:getAll`, + `${this.permissionController.name}:getPermissions`, + `${this.snapInterfaceController.name}:deleteInterface`, + ], + allowedEvents: [ + `TransactionController:unapprovedTransactionAdded`, + `TransactionController:transactionStatusUpdated`, + `SignatureController:stateChange`, + ], + }); + + this.snapInsightsController = new SnapInsightsController({ + state: initState.SnapInsightsController, + messenger: snapInsightsControllerMessenger, + }); + + // Notification Controllers + this.authenticationController = new AuthenticationController.Controller({ + state: initState.AuthenticationController, + messenger: this.controllerMessenger.getRestricted({ + name: 'AuthenticationController', + allowedActions: [ + 'KeyringController:getState', + 'SnapController:handleRequest', + ], + allowedEvents: ['KeyringController:lock', 'KeyringController:unlock'], + }), + metametrics: { + getMetaMetricsId: () => this.metaMetricsController.getMetaMetricsId(), + agent: 'extension', + }, + }); + + this.userStorageController = new UserStorageController.Controller({ + getMetaMetricsState: () => + this.metaMetricsController.state.participateInMetaMetrics ?? false, + state: initState.UserStorageController, + config: { + accountSyncing: { + onAccountAdded: (profileId) => { + this.metaMetricsController.trackEvent({ + category: MetaMetricsEventCategory.ProfileSyncing, + event: MetaMetricsEventName.AccountsSyncAdded, + properties: { + profile_id: profileId, + }, + }); + }, + onAccountNameUpdated: (profileId) => { + this.metaMetricsController.trackEvent({ + category: MetaMetricsEventCategory.ProfileSyncing, + event: MetaMetricsEventName.AccountsSyncNameUpdated, + properties: { + profile_id: profileId, + }, + }); + }, + }, + }, + env: { + isAccountSyncingEnabled: isManifestV3, + }, + messenger: this.controllerMessenger.getRestricted({ + name: 'UserStorageController', + allowedActions: [ + 'KeyringController:getState', + 'KeyringController:addNewAccount', + 'SnapController:handleRequest', + 'AuthenticationController:getBearerToken', + 'AuthenticationController:getSessionProfile', + 'AuthenticationController:isSignedIn', + 'AuthenticationController:performSignOut', + 'AuthenticationController:performSignIn', + 'NotificationServicesController:disableNotificationServices', + 'NotificationServicesController:selectIsNotificationServicesEnabled', + 'AccountsController:listAccounts', + 'AccountsController:updateAccountMetadata', + ], + allowedEvents: [ + 'KeyringController:lock', + 'KeyringController:unlock', + 'AccountsController:accountAdded', + 'AccountsController:accountRenamed', + ], + }), + }); + + const notificationServicesPushControllerMessenger = + this.controllerMessenger.getRestricted({ + name: 'NotificationServicesPushController', + allowedActions: ['AuthenticationController:getBearerToken'], + allowedEvents: [], + }); + this.notificationServicesPushController = + new NotificationServicesPushController.Controller({ + messenger: notificationServicesPushControllerMessenger, + state: initState.NotificationServicesPushController, + env: { + apiKey: process.env.FIREBASE_API_KEY ?? '', + authDomain: process.env.FIREBASE_AUTH_DOMAIN ?? '', + storageBucket: process.env.FIREBASE_STORAGE_BUCKET ?? '', + projectId: process.env.FIREBASE_PROJECT_ID ?? '', + messagingSenderId: process.env.FIREBASE_MESSAGING_SENDER_ID ?? '', + appId: process.env.FIREBASE_APP_ID ?? '', + measurementId: process.env.FIREBASE_MEASUREMENT_ID ?? '', + vapidKey: process.env.VAPID_KEY ?? '', + }, + config: { + isPushEnabled: isManifestV3, + platform: 'extension', + onPushNotificationReceived, + onPushNotificationClicked, + }, + }); + notificationServicesPushControllerMessenger.subscribe( + 'NotificationServicesPushController:onNewNotifications', + (notification) => { + this.metaMetricsController.trackEvent({ + category: MetaMetricsEventCategory.PushNotifications, + event: MetaMetricsEventName.PushNotificationReceived, + properties: { + notification_id: notification.id, + notification_type: notification.type, + chain_id: notification?.chain_id, + }, + }); + }, + ); + notificationServicesPushControllerMessenger.subscribe( + 'NotificationServicesPushController:pushNotificationClicked', + (notification) => { + this.metaMetricsController.trackEvent({ + category: MetaMetricsEventCategory.PushNotifications, + event: MetaMetricsEventName.PushNotificationClicked, + properties: { + notification_id: notification.id, + notification_type: notification.type, + chain_id: notification?.chain_id, + }, + }); + }, + ); + + this.notificationServicesController = + new NotificationServicesController.Controller({ + messenger: this.controllerMessenger.getRestricted({ + name: 'NotificationServicesController', + allowedActions: [ + 'KeyringController:getAccounts', + 'KeyringController:getState', + 'AuthenticationController:getBearerToken', + 'AuthenticationController:isSignedIn', + 'UserStorageController:enableProfileSyncing', + 'UserStorageController:getStorageKey', + 'UserStorageController:performGetStorage', + 'UserStorageController:performSetStorage', + 'NotificationServicesPushController:enablePushNotifications', + 'NotificationServicesPushController:disablePushNotifications', + 'NotificationServicesPushController:subscribeToPushNotifications', + 'NotificationServicesPushController:updateTriggerPushNotifications', + ], + allowedEvents: [ + 'KeyringController:stateChange', + 'KeyringController:lock', + 'KeyringController:unlock', + 'NotificationServicesPushController:onNewNotifications', + ], + }), + state: initState.NotificationServicesController, + env: { + isPushIntegrated: isManifestV3, + featureAnnouncements: { + platform: 'extension', + spaceId: process.env.CONTENTFUL_ACCESS_SPACE_ID ?? '', + accessToken: process.env.CONTENTFUL_ACCESS_TOKEN ?? '', + }, + }, + }); + + // account tracker watches balances, nonces, and any code at their address + this.accountTrackerController = new AccountTrackerController({ + state: { accounts: {} }, + messenger: this.controllerMessenger.getRestricted({ + name: 'AccountTrackerController', + allowedActions: [ + 'AccountsController:getSelectedAccount', + 'NetworkController:getState', + 'NetworkController:getNetworkClientById', + 'OnboardingController:getState', + 'PreferencesController:getState', + ], + allowedEvents: [ + 'AccountsController:selectedEvmAccountChange', + 'OnboardingController:stateChange', + 'KeyringController:accountRemoved', + ], + }), + provider: this.provider, + blockTracker: this.blockTracker, + getNetworkIdentifier: (providerConfig) => { + const { type, rpcUrl } = + providerConfig ?? + getProviderConfig({ + metamask: this.networkController.state, + }); + return type === NETWORK_TYPES.RPC ? rpcUrl : type; + }, + }); + + // start and stop polling for balances based on activeControllerConnections + this.on('controllerConnectionChanged', (activeControllerConnections) => { + const { completedOnboarding } = this.onboardingController.state; + if (activeControllerConnections > 0 && completedOnboarding) { + this.triggerNetworkrequests(); + } else { + this.stopNetworkRequests(); + } + }); + + this.controllerMessenger.subscribe( + `${this.onboardingController.name}:stateChange`, + previousValueComparator(async (prevState, currState) => { + const { completedOnboarding: prevCompletedOnboarding } = prevState; + const { completedOnboarding: currCompletedOnboarding } = currState; + if (!prevCompletedOnboarding && currCompletedOnboarding) { + const { address } = this.accountsController.getSelectedAccount(); + + this._addAccountsWithBalance(); + + this.postOnboardingInitialization(); + this.triggerNetworkrequests(); + // execute once the token detection on the post-onboarding + await this.tokenDetectionController.detectTokens({ + selectedAddress: address, + }); + } + }, this.onboardingController.state), + ); + + const tokenDetectionControllerMessenger = + this.controllerMessenger.getRestricted({ + name: 'TokenDetectionController', + allowedActions: [ + 'AccountsController:getAccount', + 'AccountsController:getSelectedAccount', + 'KeyringController:getState', + 'NetworkController:getNetworkClientById', + 'NetworkController:getNetworkConfigurationByNetworkClientId', + 'NetworkController:getState', + 'PreferencesController:getState', + 'TokenListController:getState', + 'TokensController:getState', + 'TokensController:addDetectedTokens', + ], + allowedEvents: [ + 'AccountsController:selectedEvmAccountChange', + 'KeyringController:lock', + 'KeyringController:unlock', + 'NetworkController:networkDidChange', + 'PreferencesController:stateChange', + 'TokenListController:stateChange', + ], + }); + + this.tokenDetectionController = new TokenDetectionController({ + messenger: tokenDetectionControllerMessenger, + getBalancesInSingleCall: + this.assetsContractController.getBalancesInSingleCall.bind( + this.assetsContractController, + ), + trackMetaMetricsEvent: this.metaMetricsController.trackEvent.bind( + this.metaMetricsController, + ), + useAccountsAPI: true, + platform: 'extension', + }); + + const addressBookControllerMessenger = + this.controllerMessenger.getRestricted({ + name: 'AddressBookController', + allowedActions: [], + allowedEvents: [], + }); + + this.addressBookController = new AddressBookController({ + messenger: addressBookControllerMessenger, + state: initState.AddressBookController, + }); + + this.alertController = new AlertController({ + state: initState.AlertController, + messenger: this.controllerMessenger.getRestricted({ + name: 'AlertController', + allowedEvents: ['AccountsController:selectedAccountChange'], + allowedActions: ['AccountsController:getSelectedAccount'], + }), + }); + + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + this.custodyController = new CustodyController({ + initState: initState.CustodyController, + captureException, + }); + this.institutionalFeaturesController = new InstitutionalFeaturesController({ + initState: initState.InstitutionalFeaturesController, + showConfirmRequest: opts.showUserConfirmation, + }); + this.transactionUpdateController = new TransactionUpdateController({ + initState: initState.TransactionUpdateController, + getCustodyKeyring: this.getCustodyKeyringIfExists.bind(this), + mmiConfigurationController: this.mmiConfigurationController, + captureException, + }); + ///: END:ONLY_INCLUDE_IF + + this.backup = new Backup({ + preferencesController: this.preferencesController, + addressBookController: this.addressBookController, + accountsController: this.accountsController, + networkController: this.networkController, + trackMetaMetricsEvent: this.metaMetricsController.trackEvent.bind( + this.metaMetricsController, + ), + }); + + // This gets used as a ...spread parameter in two places: new TransactionController() and createRPCMethodTrackingMiddleware() + this.snapAndHardwareMetricsParams = { + getSelectedAccount: this.accountsController.getSelectedAccount.bind( + this.accountsController, + ), + getAccountType: this.getAccountType.bind(this), + getDeviceModel: this.getDeviceModel.bind(this), + snapAndHardwareMessenger: this.controllerMessenger.getRestricted({ + name: 'SnapAndHardwareMessenger', + allowedActions: [ + 'KeyringController:getKeyringForAccount', + 'SnapController:get', + 'AccountsController:getSelectedAccount', + ], + }), + }; + + const transactionControllerMessenger = + this.controllerMessenger.getRestricted({ + name: 'TransactionController', + allowedActions: [ + `${this.approvalController.name}:addRequest`, + 'NetworkController:findNetworkClientIdByChainId', + 'NetworkController:getNetworkClientById', + 'AccountsController:getSelectedAccount', + ], + allowedEvents: [`NetworkController:stateChange`], + }); + this.txController = new TransactionController({ + blockTracker: this.blockTracker, + getCurrentNetworkEIP1559Compatibility: + this.networkController.getEIP1559Compatibility.bind( + this.networkController, + ), + getCurrentAccountEIP1559Compatibility: + this.getCurrentAccountEIP1559Compatibility.bind(this), + getExternalPendingTransactions: + this.getExternalPendingTransactions.bind(this), + getGasFeeEstimates: this.gasFeeController.fetchGasFeeEstimates.bind( + this.gasFeeController, + ), + getNetworkClientRegistry: + this.networkController.getNetworkClientRegistry.bind( + this.networkController, + ), + getNetworkState: () => this.networkController.state, + getPermittedAccounts: this.getPermittedAccounts.bind(this), + getSavedGasFees: () => + this.preferencesController.state.advancedGasFee[ + getCurrentChainId({ metamask: this.networkController.state }) + ], + incomingTransactions: { + etherscanApiKeysByChainId: { + [CHAIN_IDS.MAINNET]: process.env.ETHERSCAN_API_KEY, + [CHAIN_IDS.SEPOLIA]: process.env.ETHERSCAN_API_KEY, + }, + includeTokenTransfers: false, + isEnabled: () => + Boolean( + this.preferencesController.state.incomingTransactionsPreferences?.[ + getCurrentChainId({ metamask: this.networkController.state }) + ] && this.onboardingController.state.completedOnboarding, + ), + queryEntireHistory: false, + updateTransactions: false, + }, + isMultichainEnabled: process.env.TRANSACTION_MULTICHAIN, + isSimulationEnabled: () => + this.preferencesController.state.useTransactionSimulations, + messenger: transactionControllerMessenger, + onNetworkStateChange: (listener) => { + networkControllerMessenger.subscribe( + 'NetworkController:networkDidChange', + () => listener(), + ); + }, + pendingTransactions: { + isResubmitEnabled: () => { + const state = this._getMetaMaskState(); + return !( + getSmartTransactionsPreferenceEnabled(state) && + getCurrentChainSupportsSmartTransactions(state) + ); + }, + }, + provider: this.provider, + testGasFeeFlows: process.env.TEST_GAS_FEE_FLOWS, + trace, + hooks: { + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + afterSign: (txMeta, signedEthTx) => + afterTransactionSignMMI( + txMeta, + signedEthTx, + this.transactionUpdateController.addTransactionToWatchList.bind( + this.transactionUpdateController, + ), + ), + beforeCheckPendingTransaction: + beforeCheckPendingTransactionMMI.bind(this), + beforePublish: beforeTransactionPublishMMI.bind(this), + getAdditionalSignArguments: getAdditionalSignArgumentsMMI.bind(this), + ///: END:ONLY_INCLUDE_IF + publish: this._publishSmartTransactionHook.bind(this), + }, + sign: (...args) => this.keyringController.signTransaction(...args), + state: initState.TransactionController, + }); + + this._addTransactionControllerListeners(); + + this.decryptMessageController = new DecryptMessageController({ + getState: this.getState.bind(this), + messenger: this.controllerMessenger.getRestricted({ + name: 'DecryptMessageController', + allowedActions: [ + `${this.approvalController.name}:addRequest`, + `${this.approvalController.name}:acceptRequest`, + `${this.approvalController.name}:rejectRequest`, + `${this.keyringController.name}:decryptMessage`, + ], + }), + metricsEvent: this.metaMetricsController.trackEvent.bind( + this.metaMetricsController, + ), + }); + + this.encryptionPublicKeyController = new EncryptionPublicKeyController({ + messenger: this.controllerMessenger.getRestricted({ + name: 'EncryptionPublicKeyController', + allowedActions: [ + `${this.approvalController.name}:addRequest`, + `${this.approvalController.name}:acceptRequest`, + `${this.approvalController.name}:rejectRequest`, + ], + }), + getEncryptionPublicKey: + this.keyringController.getEncryptionPublicKey.bind( + this.keyringController, + ), + getAccountKeyringType: this.keyringController.getAccountKeyringType.bind( + this.keyringController, + ), + getState: this.getState.bind(this), + metricsEvent: this.metaMetricsController.trackEvent.bind( + this.metaMetricsController, + ), + }); + + this.signatureController = new SignatureController({ + messenger: this.controllerMessenger.getRestricted({ + name: 'SignatureController', + allowedActions: [ + `${this.approvalController.name}:addRequest`, + `${this.keyringController.name}:signMessage`, + `${this.keyringController.name}:signPersonalMessage`, + `${this.keyringController.name}:signTypedMessage`, + `${this.loggingController.name}:add`, + `${this.networkController.name}:getNetworkClientById`, + ], + }), + trace, + decodingApiUrl: + 'https://qtgdj2huxh.execute-api.us-east-2.amazonaws.com/uat/v1', + isDecodeSignatureRequestEnabled: () => + this.preferencesController.state.useExternalServices === true && + this.preferencesController.state.useTransactionSimulations, + }); + + this.signatureController.hub.on( + 'cancelWithReason', + ({ message, reason }) => { + this.metaMetricsController.trackEvent({ + event: reason, + category: MetaMetricsEventCategory.Transactions, + properties: { + action: 'Sign Request', + type: message.type, + }, + }); + }, + ); + + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + const transactionMetricsRequest = this.getTransactionMetricsRequest(); + + const mmiControllerMessenger = this.controllerMessenger.getRestricted({ + name: 'MMIController', + allowedActions: [ + 'AccountsController:getAccountByAddress', + 'AccountsController:setAccountName', + 'AccountsController:listAccounts', + 'AccountsController:getSelectedAccount', + 'AccountsController:setSelectedAccount', + ], + }); + + this.mmiController = new MMIController({ + messenger: mmiControllerMessenger, + mmiConfigurationController: this.mmiConfigurationController, + keyringController: this.keyringController, + preferencesController: this.preferencesController, + appStateController: this.appStateController, + transactionUpdateController: this.transactionUpdateController, + custodyController: this.custodyController, + getState: this.getState.bind(this), + getPendingNonce: this.getPendingNonce.bind(this), + accountTrackerController: this.accountTrackerController, + metaMetricsController: this.metaMetricsController, + networkController: this.networkController, + permissionController: this.permissionController, + signatureController: this.signatureController, + platform: this.platform, + extension: this.extension, + getTransactions: this.txController.getTransactions.bind( + this.txController, + ), + setTxStatusSigned: (id) => + this.txController.updateCustodialTransaction(id, { + status: TransactionStatus.signed, + }), + setTxStatusSubmitted: (id) => + this.txController.updateCustodialTransaction(id, { + status: TransactionStatus.submitted, + }), + setTxStatusFailed: (id, reason) => + this.txController.updateCustodialTransaction(id, { + status: TransactionStatus.failed, + errorMessage: reason, + }), + trackTransactionEvents: handleMMITransactionUpdate.bind( + null, + transactionMetricsRequest, + ), + updateTransaction: (txMeta, note) => + this.txController.updateTransaction(txMeta, note), + updateTransactionHash: (id, hash) => + this.txController.updateCustodialTransaction(id, { hash }), + setChannelId: (channelId) => + this.institutionalFeaturesController.setChannelId(channelId), + setConnectionRequest: (payload) => + this.institutionalFeaturesController.setConnectionRequest(payload), + }); + ///: END:ONLY_INCLUDE_IF + + const swapsControllerMessenger = this.controllerMessenger.getRestricted({ + name: 'SwapsController', + // TODO: allow these internal calls once GasFeeController and TransactionController + // export these action types and register its action handlers + // allowedActions: [ + // 'GasFeeController:getEIP1559GasFeeEstimates', + // 'TransactionController:getLayer1GasFee', + // ], + allowedActions: [ + 'NetworkController:getState', + 'NetworkController:getNetworkClientById', + 'TokenRatesController:getState', + ], + allowedEvents: [], + }); + + this.swapsController = new SwapsController( + { + messenger: swapsControllerMessenger, + provider: this.provider, + // TODO: Remove once TransactionController exports this action type + getBufferedGasLimit: async (txMeta, multiplier) => { + const { gas: gasLimit, simulationFails } = + await this.txController.estimateGasBuffered( + txMeta.txParams, + multiplier, + ); + + return { gasLimit, simulationFails }; + }, + // TODO: Remove once GasFeeController exports this action type + getEIP1559GasFeeEstimates: + this.gasFeeController.fetchGasFeeEstimates.bind( + this.gasFeeController, + ), + // TODO: Remove once TransactionController exports this action type + getLayer1GasFee: this.txController.getLayer1GasFee.bind( + this.txController, + ), + trackMetaMetricsEvent: this.metaMetricsController.trackEvent.bind( + this.metaMetricsController, + ), + }, + initState.SwapsController, + ); + + const bridgeControllerMessenger = this.controllerMessenger.getRestricted({ + name: BRIDGE_CONTROLLER_NAME, + allowedActions: ['AccountsController:getSelectedAccount'], + allowedEvents: [], + }); + this.bridgeController = new BridgeController({ + messenger: bridgeControllerMessenger, + }); + + const smartTransactionsControllerMessenger = + this.controllerMessenger.getRestricted({ + name: 'SmartTransactionsController', + allowedActions: ['NetworkController:getNetworkClientById'], + allowedEvents: ['NetworkController:stateChange'], + }); + this.smartTransactionsController = new SmartTransactionsController({ + supportedChainIds: getAllowedSmartTransactionsChainIds(), + getNonceLock: this.txController.getNonceLock.bind(this.txController), + confirmExternalTransaction: + this.txController.confirmExternalTransaction.bind(this.txController), + trackMetaMetricsEvent: this.metaMetricsController.trackEvent.bind( + this.metaMetricsController, + ), + state: initState.SmartTransactionsController, + messenger: smartTransactionsControllerMessenger, + getTransactions: this.txController.getTransactions.bind( + this.txController, + ), + getMetaMetricsProps: async () => { + const selectedAddress = + this.accountsController.getSelectedAccount().address; + const accountHardwareType = await getHardwareWalletType( + this._getMetaMaskState(), + ); + const accountType = await this.getAccountType(selectedAddress); + const deviceModel = await this.getDeviceModel(selectedAddress); + return { + accountHardwareType, + accountType, + deviceModel, + }; + }, + }); + + const isExternalNameSourcesEnabled = () => + this.preferencesController.state.useExternalNameSources; + + this.nameController = new NameController({ + messenger: this.controllerMessenger.getRestricted({ + name: 'NameController', + allowedActions: [], + }), + providers: [ + new ENSNameProvider({ + reverseLookup: this.ensController.reverseResolveAddress.bind( + this.ensController, + ), + }), + new EtherscanNameProvider({ isEnabled: isExternalNameSourcesEnabled }), + new TokenNameProvider({ isEnabled: isExternalNameSourcesEnabled }), + new LensNameProvider({ isEnabled: isExternalNameSourcesEnabled }), + new SnapsNameProvider({ + messenger: this.controllerMessenger.getRestricted({ + name: 'SnapsNameProvider', + allowedActions: [ + 'SnapController:getAll', + 'SnapController:get', + 'SnapController:handleRequest', + 'PermissionController:getState', + ], + }), + }), + ], + state: initState.NameController, + }); + + const petnamesBridgeMessenger = this.controllerMessenger.getRestricted({ + name: 'PetnamesBridge', + allowedEvents: [ + 'NameController:stateChange', + 'AccountsController:stateChange', + 'AddressBookController:stateChange', + ], + allowedActions: ['AccountsController:listAccounts'], + }); + + new AddressBookPetnamesBridge({ + addressBookController: this.addressBookController, + nameController: this.nameController, + messenger: petnamesBridgeMessenger, + }).init(); + + new AccountIdentitiesPetnamesBridge({ + nameController: this.nameController, + messenger: petnamesBridgeMessenger, + }).init(); + + this.userOperationController = new UserOperationController({ + entrypoint: process.env.EIP_4337_ENTRYPOINT, + getGasFeeEstimates: this.gasFeeController.fetchGasFeeEstimates.bind( + this.gasFeeController, + ), + messenger: this.controllerMessenger.getRestricted({ + name: 'UserOperationController', + allowedActions: [ + 'ApprovalController:addRequest', + 'NetworkController:getNetworkClientById', + 'KeyringController:prepareUserOperation', + 'KeyringController:patchUserOperation', + 'KeyringController:signUserOperation', + ], + }), + state: initState.UserOperationController, + }); + + this.userOperationController.hub.on( + 'user-operation-added', + this._onUserOperationAdded.bind(this), + ); + + this.userOperationController.hub.on( + 'transaction-updated', + this._onUserOperationTransactionUpdated.bind(this), + ); + + // ensure AccountTrackerController updates balances after network change + networkControllerMessenger.subscribe( + 'NetworkController:networkDidChange', + () => { + this.accountTrackerController.updateAccounts(); + }, + ); + + // clear unapproved transactions and messages when the network will change + networkControllerMessenger.subscribe( + 'NetworkController:networkWillChange', + clearPendingConfirmations.bind(this), + ); + + this.metamaskMiddleware = createMetamaskMiddleware({ + static: { + eth_syncing: false, + web3_clientVersion: `MetaMask/v${version}`, + }, + version, + // account mgmt + getAccounts: async ( + { origin: innerOrigin }, + { suppressUnauthorizedError = true } = {}, + ) => { + if (innerOrigin === ORIGIN_METAMASK) { + const selectedAddress = + this.accountsController.getSelectedAccount().address; + return selectedAddress ? [selectedAddress] : []; + } else if (this.isUnlocked()) { + return await this.getPermittedAccounts(innerOrigin, { + suppressUnauthorizedError, + }); + } + return []; // changing this is a breaking change + }, + // tx signing + processTransaction: (transactionParams, dappRequest) => + addDappTransaction( + this.getAddTransactionRequest({ transactionParams, dappRequest }), + ), + // msg signing + ///: BEGIN:ONLY_INCLUDE_IF(build-main,build-beta,build-flask) + + processTypedMessage: (...args) => + addTypedMessage({ + signatureController: this.signatureController, + signatureParams: args, + }), + processTypedMessageV3: (...args) => + addTypedMessage({ + signatureController: this.signatureController, + signatureParams: args, + }), + processTypedMessageV4: (...args) => + addTypedMessage({ + signatureController: this.signatureController, + signatureParams: args, + }), + processPersonalMessage: (...args) => + addPersonalMessage({ + signatureController: this.signatureController, + signatureParams: args, + }), + ///: END:ONLY_INCLUDE_IF + + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + /* eslint-disable no-dupe-keys */ + processTypedMessage: this.mmiController.newUnsignedMessage.bind( + this.mmiController, + ), + processTypedMessageV3: this.mmiController.newUnsignedMessage.bind( + this.mmiController, + ), + processTypedMessageV4: this.mmiController.newUnsignedMessage.bind( + this.mmiController, + ), + processPersonalMessage: this.mmiController.newUnsignedMessage.bind( + this.mmiController, + ), + setTypedMessageInProgress: + this.signatureController.setTypedMessageInProgress.bind( + this.signatureController, + ), + setPersonalMessageInProgress: + this.signatureController.setPersonalMessageInProgress.bind( + this.signatureController, + ), + /* eslint-enable no-dupe-keys */ + ///: END:ONLY_INCLUDE_IF + + processEncryptionPublicKey: + this.encryptionPublicKeyController.newRequestEncryptionPublicKey.bind( + this.encryptionPublicKeyController, + ), + + processDecryptMessage: + this.decryptMessageController.newRequestDecryptMessage.bind( + this.decryptMessageController, + ), + getPendingNonce: this.getPendingNonce.bind(this), + getPendingTransactionByHash: (hash) => + this.txController.state.transactions.find( + (meta) => + meta.hash === hash && meta.status === TransactionStatus.submitted, + ), + }); + + // ensure isClientOpenAndUnlocked is updated when memState updates + this.on('update', (memState) => this._onStateUpdate(memState)); + + /** + * All controllers in Memstore but not in store. They are not persisted. + * On chrome profile re-start, they will be re-initialized. + */ + const resetOnRestartStore = { + AccountTracker: this.accountTrackerController, + TokenRatesController: this.tokenRatesController, + DecryptMessageController: this.decryptMessageController, + EncryptionPublicKeyController: this.encryptionPublicKeyController, + SignatureController: this.signatureController, + SwapsController: this.swapsController, + BridgeController: this.bridgeController, + EnsController: this.ensController, + ApprovalController: this.approvalController, + PPOMController: this.ppomController, + }; + + this.store.updateStructure({ + AccountsController: this.accountsController, + AppStateController: this.appStateController.store, + AppMetadataController: this.appMetadataController.store, + MultichainBalancesController: this.multichainBalancesController, + TransactionController: this.txController, + KeyringController: this.keyringController, + PreferencesController: this.preferencesController, + MetaMetricsController: this.metaMetricsController.store, + MetaMetricsDataDeletionController: this.metaMetricsDataDeletionController, + AddressBookController: this.addressBookController, + CurrencyController: this.currencyRateController, + NetworkController: this.networkController, + AlertController: this.alertController, + OnboardingController: this.onboardingController, + PermissionController: this.permissionController, + PermissionLogController: this.permissionLogController, + SubjectMetadataController: this.subjectMetadataController, + AnnouncementController: this.announcementController, + NetworkOrderController: this.networkOrderController, + AccountOrderController: this.accountOrderController, + GasFeeController: this.gasFeeController, + TokenListController: this.tokenListController, + TokensController: this.tokensController, + SmartTransactionsController: this.smartTransactionsController, + NftController: this.nftController, + PhishingController: this.phishingController, + SelectedNetworkController: this.selectedNetworkController, + LoggingController: this.loggingController, + MultichainRatesController: this.multichainRatesController, + SnapController: this.snapController, + CronjobController: this.cronjobController, + SnapsRegistry: this.snapsRegistry, + NotificationController: this.notificationController, + SnapInterfaceController: this.snapInterfaceController, + SnapInsightsController: this.snapInsightsController, + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + CustodyController: this.custodyController.store, + InstitutionalFeaturesController: + this.institutionalFeaturesController.store, + MmiConfigurationController: this.mmiConfigurationController.store, + ///: END:ONLY_INCLUDE_IF + PPOMController: this.ppomController, + NameController: this.nameController, + UserOperationController: this.userOperationController, + // Notification Controllers + AuthenticationController: this.authenticationController, + UserStorageController: this.userStorageController, + NotificationServicesController: this.notificationServicesController, + NotificationServicesPushController: + this.notificationServicesPushController, + ...resetOnRestartStore, + }); + + this.memStore = new ComposableObservableStore({ + config: { + AccountsController: this.accountsController, + AppStateController: this.appStateController.store, + AppMetadataController: this.appMetadataController.store, + MultichainBalancesController: this.multichainBalancesController, + NetworkController: this.networkController, + KeyringController: this.keyringController, + PreferencesController: this.preferencesController, + MetaMetricsController: this.metaMetricsController.store, + MetaMetricsDataDeletionController: + this.metaMetricsDataDeletionController, + AddressBookController: this.addressBookController, + CurrencyController: this.currencyRateController, + AlertController: this.alertController, + OnboardingController: this.onboardingController, + PermissionController: this.permissionController, + PermissionLogController: this.permissionLogController, + SubjectMetadataController: this.subjectMetadataController, + AnnouncementController: this.announcementController, + NetworkOrderController: this.networkOrderController, + AccountOrderController: this.accountOrderController, + GasFeeController: this.gasFeeController, + TokenListController: this.tokenListController, + TokensController: this.tokensController, + SmartTransactionsController: this.smartTransactionsController, + NftController: this.nftController, + SelectedNetworkController: this.selectedNetworkController, + LoggingController: this.loggingController, + TxController: this.txController, + MultichainRatesController: this.multichainRatesController, + SnapController: this.snapController, + CronjobController: this.cronjobController, + SnapsRegistry: this.snapsRegistry, + NotificationController: this.notificationController, + SnapInterfaceController: this.snapInterfaceController, + SnapInsightsController: this.snapInsightsController, + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + CustodyController: this.custodyController.store, + InstitutionalFeaturesController: + this.institutionalFeaturesController.store, + MmiConfigurationController: this.mmiConfigurationController.store, + ///: END:ONLY_INCLUDE_IF + NameController: this.nameController, + UserOperationController: this.userOperationController, + // Notification Controllers + AuthenticationController: this.authenticationController, + UserStorageController: this.userStorageController, + NotificationServicesController: this.notificationServicesController, + QueuedRequestController: this.queuedRequestController, + NotificationServicesPushController: + this.notificationServicesPushController, + ...resetOnRestartStore, + }, + controllerMessenger: this.controllerMessenger, + }); + + // if this is the first time, clear the state of by calling these methods + const resetMethods = [ + this.accountTrackerController.resetState.bind( + this.accountTrackerController, + ), + this.decryptMessageController.resetState.bind( + this.decryptMessageController, + ), + this.encryptionPublicKeyController.resetState.bind( + this.encryptionPublicKeyController, + ), + this.signatureController.resetState.bind(this.signatureController), + this.swapsController.resetState.bind(this.swapsController), + this.bridgeController.resetState.bind(this.bridgeController), + this.ensController.resetState.bind(this.ensController), + this.approvalController.clear.bind(this.approvalController), + // WE SHOULD ADD TokenListController.resetState here too. But it's not implemented yet. + ]; + + if (isManifestV3) { + if (isFirstMetaMaskControllerSetup === true) { + this.resetStates(resetMethods); + this.extension.storage.session.set({ + isFirstMetaMaskControllerSetup: false, + }); + } + } else { + // it's always the first time in MV2 + this.resetStates(resetMethods); + } + + // Automatic login via config password + const password = process.env.PASSWORD; + if ( + !this.isUnlocked() && + this.onboardingController.state.completedOnboarding && + password && + !process.env.IN_TEST + ) { + this._loginUser(password); + } else { + this._startUISync(); + } + + // Lazily update the store with the current extension environment + this.extension.runtime.getPlatformInfo().then(({ os }) => { + this.appStateController.setBrowserEnvironment( + os, + // This method is presently only supported by Firefox + this.extension.runtime.getBrowserInfo === undefined + ? 'chrome' + : 'firefox', + ); + }); + + this.setupControllerEventSubscriptions(); + this.setupMultichainDataAndSubscriptions(); + + // For more information about these legacy streams, see here: + // https://github.com/MetaMask/metamask-extension/issues/15491 + // TODO:LegacyProvider: Delete + this.publicConfigStore = this.createPublicConfigStore(); + + // Multiple MetaMask instances launched warning + this.extension.runtime.onMessageExternal.addListener(onMessageReceived); + // Fire a ping message to check if other extensions are running + checkForMultipleVersionsRunning(); + + if (this.onboardingController.state.completedOnboarding) { + this.postOnboardingInitialization(); + } + } + + postOnboardingInitialization() { + const { usePhishDetect } = this.preferencesController.state; + + this.networkController.lookupNetwork(); + + if (usePhishDetect) { + this.phishingController.maybeUpdateState(); + } + + // post onboarding emit detectTokens event + const preferencesControllerState = this.preferencesController.state; + const { useTokenDetection, useNftDetection } = + preferencesControllerState ?? {}; + this.metaMetricsController.trackEvent({ + category: MetaMetricsEventCategory.Onboarding, + event: MetaMetricsUserTrait.TokenDetectionEnabled, + properties: { + [MetaMetricsUserTrait.TokenDetectionEnabled]: useTokenDetection, + }, + }); + this.metaMetricsController.trackEvent({ + category: MetaMetricsEventCategory.Onboarding, + event: MetaMetricsUserTrait.NftAutodetectionEnabled, + properties: { + [MetaMetricsUserTrait.NftAutodetectionEnabled]: useNftDetection, + }, + }); + } + + triggerNetworkrequests() { + this.accountTrackerController.start(); + this.txController.startIncomingTransactionPolling(); + this.tokenDetectionController.enable(); + + const preferencesControllerState = this.preferencesController.state; + + if (this.#isTokenListPollingRequired(preferencesControllerState)) { + this.tokenListController.start(); + } + } + + stopNetworkRequests() { + this.accountTrackerController.stop(); + this.txController.stopIncomingTransactionPolling(); + this.tokenDetectionController.disable(); + + const preferencesControllerState = this.preferencesController.state; + + if (this.#isTokenListPollingRequired(preferencesControllerState)) { + this.tokenListController.stop(); + } + } + + resetStates(resetMethods) { + resetMethods.forEach((resetMethod) => { + try { + resetMethod(); + } catch (err) { + console.error(err); + } + }); + } + + ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) + /** + * Initialize the snap keyring if it is not present. + * + * @returns {SnapKeyring} + */ + async getSnapKeyring() { + let [snapKeyring] = this.keyringController.getKeyringsByType( + KeyringType.snap, + ); + if (!snapKeyring) { + snapKeyring = await this.keyringController.addNewKeyring( + KeyringType.snap, + ); + } + return snapKeyring; + } + ///: END:ONLY_INCLUDE_IF + + trackInsightSnapView(snapId) { + this.metaMetricsController.trackEvent({ + event: MetaMetricsEventName.InsightSnapViewed, + category: MetaMetricsEventCategory.Snaps, + properties: { + snap_id: snapId, + }, + }); + } + + /** + * Get snap metadata from the current state without refreshing the registry database. + * + * @param {string} snapId - A snap id. + * @returns The available metadata for the snap, if any. + */ + _getSnapMetadata(snapId) { + return this.snapsRegistry.state.database?.verifiedSnaps?.[snapId]?.metadata; + } + + /** + * Tracks snaps export usage. + * Note: This function is throttled to 1 call per 60 seconds per snap id + handler combination. + * + * @param {string} snapId - The ID of the snap the handler is being triggered on. + * @param {string} handler - The handler to trigger on the snap for the request. + * @param {boolean} success - Whether the invocation was successful or not. + * @param {string} origin - The origin of the request. + */ + _trackSnapExportUsage = wrap( + memoize( + () => + throttle( + (snapId, handler, success, origin) => + this.metaMetricsController.trackEvent({ + event: MetaMetricsEventName.SnapExportUsed, + category: MetaMetricsEventCategory.Snaps, + properties: { + snap_id: snapId, + export: handler, + snap_category: this._getSnapMetadata(snapId)?.category, + success, + origin, + }, + }), + SECOND * 60, + ), + (snapId, handler, _, origin) => `${snapId}${handler}${origin}`, + ), + (getFunc, ...args) => getFunc(...args)(...args), + ); + + /** + * Passes a JSON-RPC request object to the SnapController for execution. + * + * @param {object} args - A bag of options. + * @param {string} args.snapId - The ID of the recipient snap. + * @param {string} args.origin - The origin of the RPC request. + * @param {string} args.handler - The handler to trigger on the snap for the request. + * @param {object} args.request - The JSON-RPC request object. + * @returns The result of the JSON-RPC request. + */ + async handleSnapRequest(args) { + try { + const response = await this.controllerMessenger.call( + 'SnapController:handleRequest', + args, + ); + this._trackSnapExportUsage(args.snapId, args.handler, true, args.origin); + return response; + } catch (error) { + this._trackSnapExportUsage(args.snapId, args.handler, false, args.origin); + throw error; + } + } + + /** + * Gets the currently selected locale from the PreferencesController. + * + * @returns The currently selected locale. + */ + getLocale() { + const { currentLocale } = this.preferencesController.state; + + return currentLocale; + } + + /** + * Constructor helper for getting Snap permission specifications. + */ + getSnapPermissionSpecifications() { + return { + ...buildSnapEndowmentSpecifications(Object.keys(ExcludedSnapEndowments)), + ...buildSnapRestrictedMethodSpecifications( + Object.keys(ExcludedSnapPermissions), + { + getPreferences: () => { + const locale = this.getLocale(); + const currency = this.currencyRateController.state.currentCurrency; + return { locale, currency }; + }, + clearSnapState: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:clearSnapState', + ), + getMnemonic: this.getPrimaryKeyringMnemonic.bind(this), + getUnlockPromise: this.appStateController.getUnlockPromise.bind( + this.appStateController, + ), + getSnap: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:get', + ), + handleSnapRpcRequest: this.handleSnapRequest.bind(this), + getSnapState: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:getSnapState', + ), + requestUserApproval: + this.approvalController.addAndShowApprovalRequest.bind( + this.approvalController, + ), + showNativeNotification: (origin, args) => + this.controllerMessenger.call( + 'RateLimitController:call', + origin, + 'showNativeNotification', + origin, + args.message, + ), + showInAppNotification: (origin, args) => + this.controllerMessenger.call( + 'RateLimitController:call', + origin, + 'showInAppNotification', + origin, + args.message, + ), + updateSnapState: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:updateSnapState', + ), + maybeUpdatePhishingList: () => { + const { usePhishDetect } = this.preferencesController.state; + + if (!usePhishDetect) { + return; + } + + this.controllerMessenger.call( + 'PhishingController:maybeUpdateState', + ); + }, + isOnPhishingList: (url) => { + const { usePhishDetect } = + this.preferencesController.store.getState(); + + if (!usePhishDetect) { + return false; + } + + return this.controllerMessenger.call( + 'PhishingController:testOrigin', + url, + ).result; + }, + createInterface: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapInterfaceController:createInterface', + ), + getInterface: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapInterfaceController:getInterface', + ), + ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) + getSnapKeyring: this.getSnapKeyring.bind(this), + ///: END:ONLY_INCLUDE_IF + }, + ), + }; + } + + /** + * Deletes the specified notifications from state. + * + * @param {string[]} ids - The notifications ids to delete. + */ + dismissNotifications(ids) { + this.notificationController.dismiss(ids); + } + + /** + * Updates the readDate attribute of the specified notifications. + * + * @param {string[]} ids - The notifications ids to mark as read. + */ + markNotificationsAsRead(ids) { + this.notificationController.markRead(ids); + } + + /** + * Sets up BaseController V2 event subscriptions. Currently, this includes + * the subscriptions necessary to notify permission subjects of account + * changes. + * + * Some of the subscriptions in this method are ControllerMessenger selector + * event subscriptions. See the relevant documentation for + * `@metamask/base-controller` for more information. + * + * Note that account-related notifications emitted when the extension + * becomes unlocked are handled in MetaMaskController._onUnlock. + */ + setupControllerEventSubscriptions() { + let lastSelectedAddress; + this.controllerMessenger.subscribe( + 'PreferencesController:stateChange', + previousValueComparator(async (prevState, currState) => { + const { currentLocale } = currState; + const chainId = getCurrentChainId({ + metamask: this.networkController.state, + }); + + await updateCurrentLocale(currentLocale); + if (currState.incomingTransactionsPreferences?.[chainId]) { + this.txController.startIncomingTransactionPolling(); + } else { + this.txController.stopIncomingTransactionPolling(); + } + + this.#checkTokenListPolling(currState, prevState); + }, this.preferencesController.state), + ); + + this.controllerMessenger.subscribe( + `${this.accountsController.name}:selectedAccountChange`, + async (account) => { + if (account.address && account.address !== lastSelectedAddress) { + lastSelectedAddress = account.address; + await this._onAccountChange(account.address); + } + }, + ); + + // This handles account changes every time relevant permission state + // changes, for any reason. + this.controllerMessenger.subscribe( + `${this.permissionController.name}:stateChange`, + async (currentValue, previousValue) => { + const changedAccounts = diffMap(currentValue, previousValue); + + for (const [origin, accounts] of changedAccounts.entries()) { + this._notifyAccountsChange(origin, accounts); + } + }, + getPermittedAccountsByOrigin, + ); + + this.controllerMessenger.subscribe( + `${this.permissionController.name}:stateChange`, + async (currentValue, previousValue) => { + const changedChains = diffMap(currentValue, previousValue); + + // This operates under the assumption that there will be at maximum + // one origin permittedChains value change per event handler call + for (const [origin, chains] of changedChains.entries()) { + const currentNetworkClientIdForOrigin = + this.selectedNetworkController.getNetworkClientIdForDomain(origin); + const { chainId: currentChainIdForOrigin } = + this.networkController.getNetworkConfigurationByNetworkClientId( + currentNetworkClientIdForOrigin, + ); + // if(chains.length === 0) { + // TODO: This particular case should also occur at the same time + // that eth_accounts is revoked. When eth_accounts is revoked, + // the networkClientId for that origin should be reset to track + // the globally selected network. + // } + if (chains.length > 0 && !chains.includes(currentChainIdForOrigin)) { + const networkClientId = + this.networkController.findNetworkClientIdByChainId(chains[0]); + this.selectedNetworkController.setNetworkClientIdForDomain( + origin, + networkClientId, + ); + this.networkController.setActiveNetwork(networkClientId); + } + } + }, + getPermittedChainsByOrigin, + ); + + this.controllerMessenger.subscribe( + 'NetworkController:networkDidChange', + async () => { + await this.txController.updateIncomingTransactions(); + }, + ); + + this.controllerMessenger.subscribe( + `${this.snapController.name}:snapInstallStarted`, + (snapId, origin, isUpdate) => { + const snapCategory = this._getSnapMetadata(snapId)?.category; + this.metaMetricsController.trackEvent({ + event: isUpdate + ? MetaMetricsEventName.SnapUpdateStarted + : MetaMetricsEventName.SnapInstallStarted, + category: MetaMetricsEventCategory.Snaps, + properties: { + snap_id: snapId, + origin, + snap_category: snapCategory, + }, + }); + }, + ); + + this.controllerMessenger.subscribe( + `${this.snapController.name}:snapInstallFailed`, + (snapId, origin, isUpdate, error) => { + const isRejected = error.includes('User rejected the request.'); + const failedEvent = isUpdate + ? MetaMetricsEventName.SnapUpdateFailed + : MetaMetricsEventName.SnapInstallFailed; + const rejectedEvent = isUpdate + ? MetaMetricsEventName.SnapUpdateRejected + : MetaMetricsEventName.SnapInstallRejected; + + const snapCategory = this._getSnapMetadata(snapId)?.category; + this.metaMetricsController.trackEvent({ + event: isRejected ? rejectedEvent : failedEvent, + category: MetaMetricsEventCategory.Snaps, + properties: { + snap_id: snapId, + origin, + snap_category: snapCategory, + }, + }); + }, + ); + + this.controllerMessenger.subscribe( + `${this.snapController.name}:snapInstalled`, + (truncatedSnap, origin) => { + const snapId = truncatedSnap.id; + const snapCategory = this._getSnapMetadata(snapId)?.category; + this.metaMetricsController.trackEvent({ + event: MetaMetricsEventName.SnapInstalled, + category: MetaMetricsEventCategory.Snaps, + properties: { + snap_id: snapId, + version: truncatedSnap.version, + origin, + snap_category: snapCategory, + }, + }); + }, + ); + + this.controllerMessenger.subscribe( + `${this.snapController.name}:snapUpdated`, + (newSnap, oldVersion, origin) => { + const snapId = newSnap.id; + const snapCategory = this._getSnapMetadata(snapId)?.category; + this.metaMetricsController.trackEvent({ + event: MetaMetricsEventName.SnapUpdated, + category: MetaMetricsEventCategory.Snaps, + properties: { + snap_id: snapId, + old_version: oldVersion, + new_version: newSnap.version, + origin, + snap_category: snapCategory, + }, + }); + }, + ); + + this.controllerMessenger.subscribe( + `${this.snapController.name}:snapTerminated`, + (truncatedSnap) => { + const approvals = Object.values( + this.approvalController.state.pendingApprovals, + ).filter( + (approval) => + approval.origin === truncatedSnap.id && + approval.type.startsWith(RestrictedMethods.snap_dialog), + ); + for (const approval of approvals) { + this.approvalController.reject( + approval.id, + new Error('Snap was terminated.'), + ); + } + }, + ); + + this.controllerMessenger.subscribe( + `${this.snapController.name}:snapUninstalled`, + (truncatedSnap) => { + const notificationIds = Object.values( + this.notificationController.state.notifications, + ).reduce((idList, notification) => { + if (notification.origin === truncatedSnap.id) { + idList.push(notification.id); + } + return idList; + }, []); + + this.dismissNotifications(notificationIds); + + const snapId = truncatedSnap.id; + const snapCategory = this._getSnapMetadata(snapId)?.category; + this.metaMetricsController.trackEvent({ + event: MetaMetricsEventName.SnapUninstalled, + category: MetaMetricsEventCategory.Snaps, + properties: { + snap_id: snapId, + version: truncatedSnap.version, + snap_category: snapCategory, + }, + }); + }, + ); + } + + /** + * Sets up multichain data and subscriptions. + * This method is called during the MetaMaskController constructor. + * It starts the MultichainRatesController if selected account is non-EVM + * and subscribes to account changes. + */ + setupMultichainDataAndSubscriptions() { + if ( + !isEvmAccountType( + this.accountsController.getSelectedMultichainAccount().type, + ) + ) { + this.multichainRatesController.start(); + } + + this.controllerMessenger.subscribe( + 'AccountsController:selectedAccountChange', + (selectedAccount) => { + if (isEvmAccountType(selectedAccount.type)) { + this.multichainRatesController.stop(); + return; + } + this.multichainRatesController.start(); + }, + ); + this.multichainBalancesController.start(); + this.multichainBalancesController.updateBalances(); + } + + /** + * TODO:LegacyProvider: Delete + * Constructor helper: initialize a public config store. + * This store is used to make some config info available to Dapps synchronously. + */ + createPublicConfigStore() { + // subset of state for metamask inpage provider + const publicConfigStore = new ObservableStore(); + + const selectPublicState = async ({ isUnlocked }) => { + const { chainId, networkVersion } = await this.getProviderNetworkState(); + + return { + isUnlocked, + chainId, + networkVersion: networkVersion ?? 'loading', + }; + }; + + const updatePublicConfigStore = async (memState) => { + const networkStatus = + memState.networksMetadata[memState.selectedNetworkClientId]?.status; + if (networkStatus === NetworkStatus.Available) { + publicConfigStore.putState(await selectPublicState(memState)); + } + }; + + // setup memStore subscription hooks + this.on('update', updatePublicConfigStore); + updatePublicConfigStore(this.getState()); + + return publicConfigStore; + } + + /** + * Gets relevant state for the provider of an external origin. + * + * @param {string} origin - The origin to get the provider state for. + * @returns {Promise<{ isUnlocked: boolean, networkVersion: string, chainId: string, accounts: string[] }>} An object with relevant state properties. + */ + async getProviderState(origin) { + const providerNetworkState = await this.getProviderNetworkState( + this.preferencesController.getUseRequestQueue() ? origin : undefined, + ); + + return { + isUnlocked: this.isUnlocked(), + accounts: await this.getPermittedAccounts(origin), + ...providerNetworkState, + }; + } + + /** + * Retrieves network state information relevant for external providers. + * + * @param {string} origin - The origin identifier for which network state is requested (default: 'metamask'). + * @returns {object} An object containing important network state properties, including chainId and networkVersion. + */ + async getProviderNetworkState(origin = METAMASK_DOMAIN) { + const networkClientId = this.controllerMessenger.call( + 'SelectedNetworkController:getNetworkClientIdForDomain', + origin, + ); + + const networkClient = this.controllerMessenger.call( + 'NetworkController:getNetworkClientById', + networkClientId, + ); + + const { chainId } = networkClient.configuration; + + const { completedOnboarding } = this.onboardingController.state; + + let networkVersion = this.deprecatedNetworkVersions[networkClientId]; + if (!networkVersion && completedOnboarding) { + const ethQuery = new EthQuery(networkClient.provider); + networkVersion = await new Promise((resolve) => { + ethQuery.sendAsync({ method: 'net_version' }, (error, result) => { + if (error) { + console.error(error); + resolve(null); + } else { + resolve(convertNetworkId(result)); + } + }); + }); + this.deprecatedNetworkVersions[networkClientId] = networkVersion; + } + + return { + chainId, + networkVersion: networkVersion ?? 'loading', + }; + } + + //============================================================================= + // EXPOSED TO THE UI SUBSYSTEM + //============================================================================= + + /** + * The metamask-state of the various controllers, made available to the UI + * + * @returns {object} status + */ + getState() { + const { vault } = this.keyringController.state; + const isInitialized = Boolean(vault); + const flatState = this.memStore.getFlatState(); + + return { + isInitialized, + ...sanitizeUIState(flatState), + }; + } + + /** + * Returns an Object containing API Callback Functions. + * These functions are the interface for the UI. + * The API object can be transmitted over a stream via JSON-RPC. + * + * @returns {object} Object containing API functions. + */ + getApi() { + const { + accountsController, + addressBookController, + alertController, + appStateController, + keyringController, + nftController, + nftDetectionController, + currencyRateController, + tokenDetectionController, + ensController, + gasFeeController, + metaMetricsController, + networkController, + announcementController, + onboardingController, + permissionController, + preferencesController, + tokensController, + smartTransactionsController, + txController, + assetsContractController, + backup, + approvalController, + phishingController, + tokenRatesController, + // Notification Controllers + authenticationController, + userStorageController, + notificationServicesController, + notificationServicesPushController, + } = this; + + return { + // etc + getState: this.getState.bind(this), + setCurrentCurrency: currencyRateController.setCurrentCurrency.bind( + currencyRateController, + ), + setUseBlockie: preferencesController.setUseBlockie.bind( + preferencesController, + ), + setUseNonceField: preferencesController.setUseNonceField.bind( + preferencesController, + ), + setUsePhishDetect: preferencesController.setUsePhishDetect.bind( + preferencesController, + ), + setUseMultiAccountBalanceChecker: + preferencesController.setUseMultiAccountBalanceChecker.bind( + preferencesController, + ), + setUseSafeChainsListValidation: + preferencesController.setUseSafeChainsListValidation.bind( + preferencesController, + ), + setUseTokenDetection: preferencesController.setUseTokenDetection.bind( + preferencesController, + ), + setUseNftDetection: preferencesController.setUseNftDetection.bind( + preferencesController, + ), + setUse4ByteResolution: preferencesController.setUse4ByteResolution.bind( + preferencesController, + ), + setUseCurrencyRateCheck: + preferencesController.setUseCurrencyRateCheck.bind( + preferencesController, + ), + setOpenSeaEnabled: preferencesController.setOpenSeaEnabled.bind( + preferencesController, + ), + getUseRequestQueue: this.preferencesController.getUseRequestQueue.bind( + this.preferencesController, + ), + getProviderConfig: () => + getProviderConfig({ + metamask: this.networkController.state, + }), + grantPermissionsIncremental: + this.permissionController.grantPermissionsIncremental.bind( + this.permissionController, + ), + grantPermissions: this.permissionController.grantPermissions.bind( + this.permissionController, + ), + setSecurityAlertsEnabled: + preferencesController.setSecurityAlertsEnabled.bind( + preferencesController, + ), + ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) + setAddSnapAccountEnabled: + preferencesController.setAddSnapAccountEnabled.bind( + preferencesController, + ), + ///: END:ONLY_INCLUDE_IF + ///: BEGIN:ONLY_INCLUDE_IF(build-flask) + setWatchEthereumAccountEnabled: + preferencesController.setWatchEthereumAccountEnabled.bind( + preferencesController, + ), + setSolanaSupportEnabled: + preferencesController.setSolanaSupportEnabled.bind( + preferencesController, + ), + ///: END:ONLY_INCLUDE_IF + setBitcoinSupportEnabled: + preferencesController.setBitcoinSupportEnabled.bind( + preferencesController, + ), + setBitcoinTestnetSupportEnabled: + preferencesController.setBitcoinTestnetSupportEnabled.bind( + preferencesController, + ), + setUseExternalNameSources: + preferencesController.setUseExternalNameSources.bind( + preferencesController, + ), + setUseTransactionSimulations: + preferencesController.setUseTransactionSimulations.bind( + preferencesController, + ), + setUseRequestQueue: this.setUseRequestQueue.bind(this), + setIpfsGateway: preferencesController.setIpfsGateway.bind( + preferencesController, + ), + setIsIpfsGatewayEnabled: + preferencesController.setIsIpfsGatewayEnabled.bind( + preferencesController, + ), + setUseAddressBarEnsResolution: + preferencesController.setUseAddressBarEnsResolution.bind( + preferencesController, + ), + setParticipateInMetaMetrics: + metaMetricsController.setParticipateInMetaMetrics.bind( + metaMetricsController, + ), + setDataCollectionForMarketing: + metaMetricsController.setDataCollectionForMarketing.bind( + metaMetricsController, + ), + setMarketingCampaignCookieId: + metaMetricsController.setMarketingCampaignCookieId.bind( + metaMetricsController, + ), + setCurrentLocale: preferencesController.setCurrentLocale.bind( + preferencesController, + ), + setIncomingTransactionsPreferences: + preferencesController.setIncomingTransactionsPreferences.bind( + preferencesController, + ), + setServiceWorkerKeepAlivePreference: + preferencesController.setServiceWorkerKeepAlivePreference.bind( + preferencesController, + ), + markPasswordForgotten: this.markPasswordForgotten.bind(this), + unMarkPasswordForgotten: this.unMarkPasswordForgotten.bind(this), + getRequestAccountTabIds: this.getRequestAccountTabIds, + getOpenMetamaskTabsIds: this.getOpenMetamaskTabsIds, + markNotificationPopupAsAutomaticallyClosed: () => + this.notificationManager.markAsAutomaticallyClosed(), + + // approval + requestUserApproval: + approvalController.addAndShowApprovalRequest.bind(approvalController), + + // primary keyring management + addNewAccount: this.addNewAccount.bind(this), + getSeedPhrase: this.getSeedPhrase.bind(this), + resetAccount: this.resetAccount.bind(this), + removeAccount: this.removeAccount.bind(this), + importAccountWithStrategy: this.importAccountWithStrategy.bind(this), + getNextAvailableAccountName: + accountsController.getNextAvailableAccountName.bind(accountsController), + ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) + getAccountsBySnapId: (snapId) => getAccountsBySnapId(this, snapId), + ///: END:ONLY_INCLUDE_IF + + // hardware wallets + connectHardware: this.connectHardware.bind(this), + forgetDevice: this.forgetDevice.bind(this), + checkHardwareStatus: this.checkHardwareStatus.bind(this), + getDeviceNameForMetric: this.getDeviceNameForMetric.bind(this), + unlockHardwareWalletAccount: this.unlockHardwareWalletAccount.bind(this), + attemptLedgerTransportCreation: + this.attemptLedgerTransportCreation.bind(this), + + // qr hardware devices + submitQRHardwareCryptoHDKey: + keyringController.submitQRCryptoHDKey.bind(keyringController), + submitQRHardwareCryptoAccount: + keyringController.submitQRCryptoAccount.bind(keyringController), + cancelSyncQRHardware: + keyringController.cancelQRSynchronization.bind(keyringController), + submitQRHardwareSignature: + keyringController.submitQRSignature.bind(keyringController), + cancelQRHardwareSignRequest: + keyringController.cancelQRSignRequest.bind(keyringController), + + // vault management + submitPassword: this.submitPassword.bind(this), + verifyPassword: this.verifyPassword.bind(this), + + // network management + setActiveNetwork: (networkConfigurationId) => { + return this.networkController.setActiveNetwork(networkConfigurationId); + }, + // Avoids returning the promise so that initial call to switch network + // doesn't block on the network lookup step + setActiveNetworkConfigurationId: (networkConfigurationId) => { + this.networkController.setActiveNetwork(networkConfigurationId); + }, + setNetworkClientIdForDomain: (origin, networkClientId) => { + return this.selectedNetworkController.setNetworkClientIdForDomain( + origin, + networkClientId, + ); + }, + rollbackToPreviousProvider: + networkController.rollbackToPreviousProvider.bind(networkController), + addNetwork: this.networkController.addNetwork.bind( + this.networkController, + ), + updateNetwork: this.networkController.updateNetwork.bind( + this.networkController, + ), + removeNetwork: this.networkController.removeNetwork.bind( + this.networkController, + ), + getCurrentNetworkEIP1559Compatibility: + this.networkController.getEIP1559Compatibility.bind( + this.networkController, + ), + getNetworkConfigurationByNetworkClientId: + this.networkController.getNetworkConfigurationByNetworkClientId.bind( + this.networkController, + ), + // PreferencesController + setSelectedAddress: (address) => { + const account = this.accountsController.getAccountByAddress(address); + if (account) { + this.accountsController.setSelectedAccount(account.id); + } else { + throw new Error(`No account found for address: ${address}`); + } + }, + toggleExternalServices: this.toggleExternalServices.bind(this), + addToken: tokensController.addToken.bind(tokensController), + updateTokenType: tokensController.updateTokenType.bind(tokensController), + setFeatureFlag: preferencesController.setFeatureFlag.bind( + preferencesController, + ), + setPreference: preferencesController.setPreference.bind( + preferencesController, + ), + + addKnownMethodData: preferencesController.addKnownMethodData.bind( + preferencesController, + ), + setDismissSeedBackUpReminder: + preferencesController.setDismissSeedBackUpReminder.bind( + preferencesController, + ), + setAdvancedGasFee: preferencesController.setAdvancedGasFee.bind( + preferencesController, + ), + setTheme: preferencesController.setTheme.bind(preferencesController), + ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) + setSnapsAddSnapAccountModalDismissed: + preferencesController.setSnapsAddSnapAccountModalDismissed.bind( + preferencesController, + ), + ///: END:ONLY_INCLUDE_IF + + // AccountsController + setSelectedInternalAccount: (id) => { + const account = this.accountsController.getAccount(id); + if (account) { + this.accountsController.setSelectedAccount(id); + } + }, + + setAccountName: + accountsController.setAccountName.bind(accountsController), + + setAccountLabel: (address, label) => { + const account = this.accountsController.getAccountByAddress(address); + if (account === undefined) { + throw new Error(`No account found for address: ${address}`); + } + this.accountsController.setAccountName(account.id, label); + }, + + // AssetsContractController + getTokenStandardAndDetails: this.getTokenStandardAndDetails.bind(this), + getTokenSymbol: this.getTokenSymbol.bind(this), + + // NftController + addNft: nftController.addNft.bind(nftController), + + addNftVerifyOwnership: + nftController.addNftVerifyOwnership.bind(nftController), + + removeAndIgnoreNft: nftController.removeAndIgnoreNft.bind(nftController), + + removeNft: nftController.removeNft.bind(nftController), + + checkAndUpdateAllNftsOwnershipStatus: + nftController.checkAndUpdateAllNftsOwnershipStatus.bind(nftController), + + checkAndUpdateSingleNftOwnershipStatus: + nftController.checkAndUpdateSingleNftOwnershipStatus.bind( + nftController, + ), + + getNFTContractInfo: nftController.getNFTContractInfo.bind(nftController), + + isNftOwner: nftController.isNftOwner.bind(nftController), + + // AddressController + setAddressBook: addressBookController.set.bind(addressBookController), + removeFromAddressBook: addressBookController.delete.bind( + addressBookController, + ), + + // AppStateController + setLastActiveTime: + appStateController.setLastActiveTime.bind(appStateController), + setCurrentExtensionPopupId: + appStateController.setCurrentExtensionPopupId.bind(appStateController), + setDefaultHomeActiveTabName: + appStateController.setDefaultHomeActiveTabName.bind(appStateController), + setConnectedStatusPopoverHasBeenShown: + appStateController.setConnectedStatusPopoverHasBeenShown.bind( + appStateController, + ), + setRecoveryPhraseReminderHasBeenShown: + appStateController.setRecoveryPhraseReminderHasBeenShown.bind( + appStateController, + ), + setRecoveryPhraseReminderLastShown: + appStateController.setRecoveryPhraseReminderLastShown.bind( + appStateController, + ), + setTermsOfUseLastAgreed: + appStateController.setTermsOfUseLastAgreed.bind(appStateController), + setSurveyLinkLastClickedOrClosed: + appStateController.setSurveyLinkLastClickedOrClosed.bind( + appStateController, + ), + setOnboardingDate: + appStateController.setOnboardingDate.bind(appStateController), + setLastViewedUserSurvey: + appStateController.setLastViewedUserSurvey.bind(appStateController), + setNewPrivacyPolicyToastClickedOrClosed: + appStateController.setNewPrivacyPolicyToastClickedOrClosed.bind( + appStateController, + ), + setNewPrivacyPolicyToastShownDate: + appStateController.setNewPrivacyPolicyToastShownDate.bind( + appStateController, + ), + setSnapsInstallPrivacyWarningShownStatus: + appStateController.setSnapsInstallPrivacyWarningShownStatus.bind( + appStateController, + ), + setOutdatedBrowserWarningLastShown: + appStateController.setOutdatedBrowserWarningLastShown.bind( + appStateController, + ), + setShowTestnetMessageInDropdown: + appStateController.setShowTestnetMessageInDropdown.bind( + appStateController, + ), + setShowBetaHeader: + appStateController.setShowBetaHeader.bind(appStateController), + setShowPermissionsTour: + appStateController.setShowPermissionsTour.bind(appStateController), + setShowAccountBanner: + appStateController.setShowAccountBanner.bind(appStateController), + setShowNetworkBanner: + appStateController.setShowNetworkBanner.bind(appStateController), + updateNftDropDownState: + appStateController.updateNftDropDownState.bind(appStateController), + setFirstTimeUsedNetwork: + appStateController.setFirstTimeUsedNetwork.bind(appStateController), + setSwitchedNetworkDetails: + appStateController.setSwitchedNetworkDetails.bind(appStateController), + clearSwitchedNetworkDetails: + appStateController.clearSwitchedNetworkDetails.bind(appStateController), + setSwitchedNetworkNeverShowMessage: + appStateController.setSwitchedNetworkNeverShowMessage.bind( + appStateController, + ), + getLastInteractedConfirmationInfo: + appStateController.getLastInteractedConfirmationInfo.bind( + appStateController, + ), + setLastInteractedConfirmationInfo: + appStateController.setLastInteractedConfirmationInfo.bind( + appStateController, + ), + + // EnsController + tryReverseResolveAddress: + ensController.reverseResolveAddress.bind(ensController), + + // KeyringController + setLocked: this.setLocked.bind(this), + createNewVaultAndKeychain: this.createNewVaultAndKeychain.bind(this), + createNewVaultAndRestore: this.createNewVaultAndRestore.bind(this), + exportAccount: this.exportAccount.bind(this), + + // txController + updateTransaction: txController.updateTransaction.bind(txController), + approveTransactionsWithSameNonce: + txController.approveTransactionsWithSameNonce.bind(txController), + createCancelTransaction: this.createCancelTransaction.bind(this), + createSpeedUpTransaction: this.createSpeedUpTransaction.bind(this), + estimateGas: this.estimateGas.bind(this), + estimateGasFee: txController.estimateGasFee.bind(txController), + getNextNonce: this.getNextNonce.bind(this), + addTransaction: (transactionParams, transactionOptions) => + addTransaction( + this.getAddTransactionRequest({ + transactionParams, + transactionOptions, + waitForSubmit: false, + }), + ), + addTransactionAndWaitForPublish: ( + transactionParams, + transactionOptions, + ) => + addTransaction( + this.getAddTransactionRequest({ + transactionParams, + transactionOptions, + waitForSubmit: true, + }), + ), + createTransactionEventFragment: + createTransactionEventFragmentWithTxId.bind( + null, + this.getTransactionMetricsRequest(), + ), + getTransactions: this.txController.getTransactions.bind( + this.txController, + ), + updateEditableParams: this.txController.updateEditableParams.bind( + this.txController, + ), + updateTransactionGasFees: + txController.updateTransactionGasFees.bind(txController), + updateTransactionSendFlowHistory: + txController.updateTransactionSendFlowHistory.bind(txController), + updatePreviousGasParams: + txController.updatePreviousGasParams.bind(txController), + abortTransactionSigning: + txController.abortTransactionSigning.bind(txController), + getLayer1GasFee: txController.getLayer1GasFee.bind(txController), + + // decryptMessageController + decryptMessage: this.decryptMessageController.decryptMessage.bind( + this.decryptMessageController, + ), + decryptMessageInline: + this.decryptMessageController.decryptMessageInline.bind( + this.decryptMessageController, + ), + cancelDecryptMessage: + this.decryptMessageController.cancelDecryptMessage.bind( + this.decryptMessageController, + ), + + // EncryptionPublicKeyController + encryptionPublicKey: + this.encryptionPublicKeyController.encryptionPublicKey.bind( + this.encryptionPublicKeyController, + ), + cancelEncryptionPublicKey: + this.encryptionPublicKeyController.cancelEncryptionPublicKey.bind( + this.encryptionPublicKeyController, + ), + + // onboarding controller + setSeedPhraseBackedUp: + onboardingController.setSeedPhraseBackedUp.bind(onboardingController), + completeOnboarding: + onboardingController.completeOnboarding.bind(onboardingController), + setFirstTimeFlowType: + onboardingController.setFirstTimeFlowType.bind(onboardingController), + + // alert controller + setAlertEnabledness: + alertController.setAlertEnabledness.bind(alertController), + setUnconnectedAccountAlertShown: + alertController.setUnconnectedAccountAlertShown.bind(alertController), + setWeb3ShimUsageAlertDismissed: + alertController.setWeb3ShimUsageAlertDismissed.bind(alertController), + + // permissions + removePermissionsFor: this.removePermissionsFor, + approvePermissionsRequest: this.acceptPermissionsRequest, + rejectPermissionsRequest: this.rejectPermissionsRequest, + ...getPermissionBackgroundApiMethods(permissionController), + + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + connectCustodyAddresses: this.mmiController.connectCustodyAddresses.bind( + this.mmiController, + ), + getCustodianAccounts: this.mmiController.getCustodianAccounts.bind( + this.mmiController, + ), + getCustodianTransactionDeepLink: + this.mmiController.getCustodianTransactionDeepLink.bind( + this.mmiController, + ), + getCustodianConfirmDeepLink: + this.mmiController.getCustodianConfirmDeepLink.bind(this.mmiController), + getCustodianSignMessageDeepLink: + this.mmiController.getCustodianSignMessageDeepLink.bind( + this.mmiController, + ), + getCustodianToken: this.mmiController.getCustodianToken.bind( + this.mmiController, + ), + getCustodianJWTList: this.mmiController.getCustodianJWTList.bind( + this.mmiController, + ), + getAllCustodianAccountsWithToken: + this.mmiController.getAllCustodianAccountsWithToken.bind( + this.mmiController, + ), + setCustodianNewRefreshToken: + this.mmiController.setCustodianNewRefreshToken.bind(this.mmiController), + setWaitForConfirmDeepLinkDialog: + this.custodyController.setWaitForConfirmDeepLinkDialog.bind( + this.custodyController, + ), + getMmiConfiguration: + this.mmiConfigurationController.getConfiguration.bind( + this.mmiConfigurationController, + ), + removeAddTokenConnectRequest: + this.institutionalFeaturesController.removeAddTokenConnectRequest.bind( + this.institutionalFeaturesController, + ), + setConnectionRequest: + this.institutionalFeaturesController.setConnectionRequest.bind( + this.institutionalFeaturesController, + ), + showInteractiveReplacementTokenBanner: + appStateController.showInteractiveReplacementTokenBanner.bind( + appStateController, + ), + setCustodianDeepLink: + appStateController.setCustodianDeepLink.bind(appStateController), + setNoteToTraderMessage: + appStateController.setNoteToTraderMessage.bind(appStateController), + logAndStoreApiRequest: this.mmiController.logAndStoreApiRequest.bind( + this.mmiController, + ), + ///: END:ONLY_INCLUDE_IF + + // snaps + disableSnap: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:disable', + ), + enableSnap: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:enable', + ), + updateSnap: (origin, requestedSnaps) => { + // We deliberately do not await this promise as that would mean waiting for the update to complete + // Instead we return null to signal to the UI that it is safe to redirect to the update flow + this.controllerMessenger.call( + 'SnapController:install', + origin, + requestedSnaps, + ); + return null; + }, + removeSnap: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:remove', + ), + handleSnapRequest: this.handleSnapRequest.bind(this), + revokeDynamicSnapPermissions: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:revokeDynamicPermissions', + ), + dismissNotifications: this.dismissNotifications.bind(this), + markNotificationsAsRead: this.markNotificationsAsRead.bind(this), + disconnectOriginFromSnap: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:disconnectOrigin', + ), + updateNetworksList: this.updateNetworksList.bind(this), + updateAccountsList: this.updateAccountsList.bind(this), + updateHiddenAccountsList: this.updateHiddenAccountsList.bind(this), + getPhishingResult: async (website) => { + await phishingController.maybeUpdateState(); + + return phishingController.test(website); + }, + deleteInterface: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapInterfaceController:deleteInterface', + ), + updateInterfaceState: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapInterfaceController:updateInterfaceState', + ), + + // swaps + fetchAndSetQuotes: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:fetchAndSetQuotes', + ), + setSelectedQuoteAggId: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setSelectedQuoteAggId', + ), + resetSwapsState: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:resetSwapsState', + ), + setSwapsTokens: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setSwapsTokens', + ), + clearSwapsQuotes: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:clearSwapsQuotes', + ), + setApproveTxId: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setApproveTxId', + ), + setTradeTxId: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setTradeTxId', + ), + setSwapsTxGasPrice: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setSwapsTxGasPrice', + ), + setSwapsTxGasLimit: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setSwapsTxGasLimit', + ), + setSwapsTxMaxFeePerGas: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setSwapsTxMaxFeePerGas', + ), + setSwapsTxMaxFeePriorityPerGas: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setSwapsTxMaxFeePriorityPerGas', + ), + safeRefetchQuotes: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:safeRefetchQuotes', + ), + stopPollingForQuotes: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:stopPollingForQuotes', + ), + setBackgroundSwapRouteState: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setBackgroundSwapRouteState', + ), + resetPostFetchState: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:resetPostFetchState', + ), + setSwapsErrorKey: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setSwapsErrorKey', + ), + setInitialGasEstimate: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setInitialGasEstimate', + ), + setCustomApproveTxData: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setCustomApproveTxData', + ), + setSwapsLiveness: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setSwapsLiveness', + ), + setSwapsFeatureFlags: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setSwapsFeatureFlags', + ), + setSwapsUserFeeLevel: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setSwapsUserFeeLevel', + ), + setSwapsQuotesPollingLimitEnabled: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SwapsController:setSwapsQuotesPollingLimitEnabled', + ), + + // Bridge + [BridgeBackgroundAction.SET_FEATURE_FLAGS]: + this.controllerMessenger.call.bind( + this.controllerMessenger, + `${BRIDGE_CONTROLLER_NAME}:${BridgeBackgroundAction.SET_FEATURE_FLAGS}`, + ), + [BridgeUserAction.SELECT_SRC_NETWORK]: this.controllerMessenger.call.bind( + this.controllerMessenger, + `${BRIDGE_CONTROLLER_NAME}:${BridgeUserAction.SELECT_SRC_NETWORK}`, + ), + [BridgeUserAction.SELECT_DEST_NETWORK]: + this.controllerMessenger.call.bind( + this.controllerMessenger, + `${BRIDGE_CONTROLLER_NAME}:${BridgeUserAction.SELECT_DEST_NETWORK}`, + ), + [BridgeUserAction.UPDATE_QUOTE_PARAMS]: + this.controllerMessenger.call.bind( + this.controllerMessenger, + `${BRIDGE_CONTROLLER_NAME}:${BridgeUserAction.UPDATE_QUOTE_PARAMS}`, + ), + + // Smart Transactions + fetchSmartTransactionFees: smartTransactionsController.getFees.bind( + smartTransactionsController, + ), + clearSmartTransactionFees: smartTransactionsController.clearFees.bind( + smartTransactionsController, + ), + submitSignedTransactions: + smartTransactionsController.submitSignedTransactions.bind( + smartTransactionsController, + ), + cancelSmartTransaction: + smartTransactionsController.cancelSmartTransaction.bind( + smartTransactionsController, + ), + fetchSmartTransactionsLiveness: + smartTransactionsController.fetchLiveness.bind( + smartTransactionsController, + ), + updateSmartTransaction: + smartTransactionsController.updateSmartTransaction.bind( + smartTransactionsController, + ), + setStatusRefreshInterval: + smartTransactionsController.setStatusRefreshInterval.bind( + smartTransactionsController, + ), + + // MetaMetrics + trackMetaMetricsEvent: metaMetricsController.trackEvent.bind( + metaMetricsController, + ), + trackMetaMetricsPage: metaMetricsController.trackPage.bind( + metaMetricsController, + ), + createEventFragment: metaMetricsController.createEventFragment.bind( + metaMetricsController, + ), + updateEventFragment: metaMetricsController.updateEventFragment.bind( + metaMetricsController, + ), + finalizeEventFragment: metaMetricsController.finalizeEventFragment.bind( + metaMetricsController, + ), + trackInsightSnapView: this.trackInsightSnapView.bind(this), + + // approval controller + resolvePendingApproval: this.resolvePendingApproval, + rejectPendingApproval: this.rejectPendingApproval, + + // Notifications + resetViewedNotifications: announcementController.resetViewed.bind( + announcementController, + ), + updateViewedNotifications: announcementController.updateViewed.bind( + announcementController, + ), + + // CurrencyRateController + currencyRateStartPolling: currencyRateController.startPolling.bind( + currencyRateController, + ), + currencyRateStopPollingByPollingToken: + currencyRateController.stopPollingByPollingToken.bind( + currencyRateController, + ), + + tokenRatesStartPolling: + tokenRatesController.startPolling.bind(tokenRatesController), + tokenRatesStopPollingByPollingToken: + tokenRatesController.stopPollingByPollingToken.bind( + tokenRatesController, + ), + + // GasFeeController + gasFeeStartPollingByNetworkClientId: + gasFeeController.startPollingByNetworkClientId.bind(gasFeeController), + gasFeeStopPollingByPollingToken: + gasFeeController.stopPollingByPollingToken.bind(gasFeeController), + + getGasFeeTimeEstimate: + gasFeeController.getTimeEstimate.bind(gasFeeController), + + addPollingTokenToAppState: + appStateController.addPollingToken.bind(appStateController), + + removePollingTokenFromAppState: + appStateController.removePollingToken.bind(appStateController), + + // Backup + backupUserData: backup.backupUserData.bind(backup), + restoreUserData: backup.restoreUserData.bind(backup), + + // TokenDetectionController + detectTokens: tokenDetectionController.detectTokens.bind( + tokenDetectionController, + ), + + // DetectCollectibleController + detectNfts: nftDetectionController.detectNfts.bind( + nftDetectionController, + ), + + /** Token Detection V2 */ + addDetectedTokens: + tokensController.addDetectedTokens.bind(tokensController), + addImportedTokens: tokensController.addTokens.bind(tokensController), + ignoreTokens: tokensController.ignoreTokens.bind(tokensController), + getBalancesInSingleCall: + assetsContractController.getBalancesInSingleCall.bind( + assetsContractController, + ), + + // Authentication Controller + performSignIn: authenticationController.performSignIn.bind( + authenticationController, + ), + performSignOut: authenticationController.performSignOut.bind( + authenticationController, + ), + + // UserStorageController + enableProfileSyncing: userStorageController.enableProfileSyncing.bind( + userStorageController, + ), + disableProfileSyncing: userStorageController.disableProfileSyncing.bind( + userStorageController, + ), + setIsProfileSyncingEnabled: + userStorageController.setIsProfileSyncingEnabled.bind( + userStorageController, + ), + syncInternalAccountsWithUserStorage: + userStorageController.syncInternalAccountsWithUserStorage.bind( + userStorageController, + ), + deleteAccountSyncingDataFromUserStorage: + userStorageController.performDeleteStorageAllFeatureEntries.bind( + userStorageController, + ), + + // NotificationServicesController + checkAccountsPresence: + notificationServicesController.checkAccountsPresence.bind( + notificationServicesController, + ), + createOnChainTriggers: + notificationServicesController.createOnChainTriggers.bind( + notificationServicesController, + ), + deleteOnChainTriggersByAccount: + notificationServicesController.deleteOnChainTriggersByAccount.bind( + notificationServicesController, + ), + updateOnChainTriggersByAccount: + notificationServicesController.updateOnChainTriggersByAccount.bind( + notificationServicesController, + ), + fetchAndUpdateMetamaskNotifications: + notificationServicesController.fetchAndUpdateMetamaskNotifications.bind( + notificationServicesController, + ), + markMetamaskNotificationsAsRead: + notificationServicesController.markMetamaskNotificationsAsRead.bind( + notificationServicesController, + ), + setFeatureAnnouncementsEnabled: + notificationServicesController.setFeatureAnnouncementsEnabled.bind( + notificationServicesController, + ), + enablePushNotifications: + notificationServicesPushController.enablePushNotifications.bind( + notificationServicesPushController, + ), + disablePushNotifications: + notificationServicesPushController.disablePushNotifications.bind( + notificationServicesPushController, + ), + updateTriggerPushNotifications: + notificationServicesPushController.updateTriggerPushNotifications.bind( + notificationServicesPushController, + ), + enableMetamaskNotifications: + notificationServicesController.enableMetamaskNotifications.bind( + notificationServicesController, + ), + disableMetamaskNotifications: + notificationServicesController.disableNotificationServices.bind( + notificationServicesController, + ), + + // E2E testing + throwTestError: this.throwTestError.bind(this), + + // NameController + updateProposedNames: this.nameController.updateProposedNames.bind( + this.nameController, + ), + setName: this.nameController.setName.bind(this.nameController), + + // MultichainBalancesController + multichainUpdateBalance: (accountId) => + this.multichainBalancesController.updateBalance(accountId), + + multichainUpdateBalances: () => + this.multichainBalancesController.updateBalances(), + + // Transaction Decode + decodeTransactionData: (request) => + decodeTransactionData({ + ...request, + ethQuery: new EthQuery(this.provider), + }), + // metrics data deleteion + createMetaMetricsDataDeletionTask: + this.metaMetricsDataDeletionController.createMetaMetricsDataDeletionTask.bind( + this.metaMetricsDataDeletionController, + ), + updateDataDeletionTaskStatus: + this.metaMetricsDataDeletionController.updateDataDeletionTaskStatus.bind( + this.metaMetricsDataDeletionController, + ), + // Trace + endTrace, + }; + } + + async exportAccount(address, password) { + await this.verifyPassword(password); + return this.keyringController.exportAccount(password, address); + } + + async getTokenStandardAndDetails(address, userAddress, tokenId) { + const { tokenList } = this.tokenListController.state; + const { tokens } = this.tokensController.state; + + const staticTokenListDetails = + STATIC_MAINNET_TOKEN_LIST[address?.toLowerCase()] || {}; + const tokenListDetails = tokenList[address.toLowerCase()] || {}; + const userDefinedTokenDetails = + tokens.find(({ address: _address }) => + isEqualCaseInsensitive(_address, address), + ) || {}; + + const tokenDetails = { + ...staticTokenListDetails, + ...tokenListDetails, + ...userDefinedTokenDetails, + }; + + const tokenDetailsStandardIsERC20 = + isEqualCaseInsensitive(tokenDetails.standard, TokenStandard.ERC20) || + tokenDetails.erc20 === true; + + const noEvidenceThatTokenIsAnNFT = + !tokenId && + !isEqualCaseInsensitive(tokenDetails.standard, TokenStandard.ERC1155) && + !isEqualCaseInsensitive(tokenDetails.standard, TokenStandard.ERC721) && + !tokenDetails.erc721; + + const otherDetailsAreERC20Like = + tokenDetails.decimals !== undefined && tokenDetails.symbol; + + const tokenCanBeTreatedAsAnERC20 = + tokenDetailsStandardIsERC20 || + (noEvidenceThatTokenIsAnNFT && otherDetailsAreERC20Like); + + let details; + if (tokenCanBeTreatedAsAnERC20) { + try { + const balance = userAddress + ? await fetchTokenBalance(address, userAddress, this.provider) + : undefined; + + details = { + address, + balance, + standard: TokenStandard.ERC20, + decimals: tokenDetails.decimals, + symbol: tokenDetails.symbol, + }; + } catch (e) { + // If the `fetchTokenBalance` call failed, `details` remains undefined, and we + // fall back to the below `assetsContractController.getTokenStandardAndDetails` call + log.warn(`Failed to get token balance. Error: ${e}`); + } + } + + // `details`` will be undefined if `tokenCanBeTreatedAsAnERC20`` is false, + // or if it is true but the `fetchTokenBalance`` call failed. In either case, we should + // attempt to retrieve details from `assetsContractController.getTokenStandardAndDetails` + if (details === undefined) { + details = await this.assetsContractController.getTokenStandardAndDetails( + address, + userAddress, + tokenId, + ); + } + + const tokenDetailsStandardIsERC1155 = isEqualCaseInsensitive( + details.standard, + TokenStandard.ERC1155, + ); + + if (tokenDetailsStandardIsERC1155) { + try { + const balance = await fetchERC1155Balance( + address, + userAddress, + tokenId, + this.provider, + ); + + const balanceToUse = balance?._hex + ? parseInt(balance._hex, 16).toString() + : null; + + details = { + ...details, + balance: balanceToUse, + }; + } catch (e) { + // If the `fetchTokenBalance` call failed, `details` remains undefined, and we + // fall back to the below `assetsContractController.getTokenStandardAndDetails` call + log.warn('Failed to get token balance. Error:', e); + } + } + + return { + ...details, + decimals: details?.decimals?.toString(10), + balance: details?.balance?.toString(10), + }; + } + + async getTokenSymbol(address) { + try { + const details = + await this.assetsContractController.getTokenStandardAndDetails(address); + return details?.symbol; + } catch (e) { + return null; + } + } + + //============================================================================= + // VAULT / KEYRING RELATED METHODS + //============================================================================= + + /** + * Creates a new Vault and create a new keychain. + * + * A vault, or KeyringController, is a controller that contains + * many different account strategies, currently called Keyrings. + * Creating it new means wiping all previous keyrings. + * + * A keychain, or keyring, controls many accounts with a single backup and signing strategy. + * For example, a mnemonic phrase can generate many accounts, and is a keyring. + * + * @param {string} password + * @returns {object} vault + */ + async createNewVaultAndKeychain(password) { + const releaseLock = await this.createVaultMutex.acquire(); + try { + return await this.keyringController.createNewVaultAndKeychain(password); + } finally { + releaseLock(); + } + } + + /** + * Create a new Vault and restore an existent keyring. + * + * @param {string} password + * @param {number[]} encodedSeedPhrase - The seed phrase, encoded as an array + * of UTF-8 bytes. + */ + async createNewVaultAndRestore(password, encodedSeedPhrase) { + const releaseLock = await this.createVaultMutex.acquire(); + try { + const { completedOnboarding } = this.onboardingController.state; + + const seedPhraseAsBuffer = Buffer.from(encodedSeedPhrase); + + // clear permissions + this.permissionController.clearState(); + + // Clear snap state + this.snapController.clearState(); + // Clear notification state + this.notificationController.clear(); + + // clear accounts in AccountTrackerController + this.accountTrackerController.clearAccounts(); + + this.txController.clearUnapprovedTransactions(); + + if (completedOnboarding) { + this.tokenDetectionController.enable(); + } + + // create new vault + await this.keyringController.createNewVaultAndRestore( + password, + this._convertMnemonicToWordlistIndices(seedPhraseAsBuffer), + ); + + if (completedOnboarding) { + await this._addAccountsWithBalance(); + + // This must be set as soon as possible to communicate to the + // keyring's iframe and have the setting initialized properly + // Optimistically called to not block MetaMask login due to + // Ledger Keyring GitHub downtime + this.setLedgerTransportPreference(); + } + } finally { + releaseLock(); + } + } + + async _addAccountsWithBalance() { + // Scan accounts until we find an empty one + const chainId = getCurrentChainId({ + metamask: this.networkController.state, + }); + const ethQuery = new EthQuery(this.provider); + const accounts = await this.keyringController.getAccounts(); + let address = accounts[accounts.length - 1]; + + for (let count = accounts.length; ; count++) { + const balance = await this.getBalance(address, ethQuery); + + if (balance === '0x0') { + // This account has no balance, so check for tokens + await this.tokenDetectionController.detectTokens({ + selectedAddress: address, + }); + + const tokens = + this.tokensController.state.allTokens?.[chainId]?.[address]; + const detectedTokens = + this.tokensController.state.allDetectedTokens?.[chainId]?.[address]; + + if ( + (tokens?.length ?? 0) === 0 && + (detectedTokens?.length ?? 0) === 0 + ) { + // This account has no balance or tokens + if (count !== 1) { + await this.removeAccount(address); + } + break; + } + } + + // This account has assets, so check the next one + address = await this.keyringController.addNewAccount(count); + } + } + + /** + * Encodes a BIP-39 mnemonic as the indices of words in the English BIP-39 wordlist. + * + * @param {Buffer} mnemonic - The BIP-39 mnemonic. + * @returns {Buffer} The Unicode code points for the seed phrase formed from the words in the wordlist. + */ + _convertMnemonicToWordlistIndices(mnemonic) { + const indices = mnemonic + .toString() + .split(' ') + .map((word) => wordlist.indexOf(word)); + return new Uint8Array(new Uint16Array(indices).buffer); + } + + /** + * Converts a BIP-39 mnemonic stored as indices of words in the English wordlist to a buffer of Unicode code points. + * + * @param {Uint8Array} wordlistIndices - Indices to specific words in the BIP-39 English wordlist. + * @returns {Buffer} The BIP-39 mnemonic formed from the words in the English wordlist, encoded as a list of Unicode code points. + */ + _convertEnglishWordlistIndicesToCodepoints(wordlistIndices) { + return Buffer.from( + Array.from(new Uint16Array(wordlistIndices.buffer)) + .map((i) => wordlist[i]) + .join(' '), + ); + } + + /** + * Get an account balance from the AccountTrackerController or request it directly from the network. + * + * @param {string} address - The account address + * @param {EthQuery} ethQuery - The EthQuery instance to use when asking the network + */ + getBalance(address, ethQuery) { + return new Promise((resolve, reject) => { + const cached = this.accountTrackerController.state.accounts[address]; + + if (cached && cached.balance) { + resolve(cached.balance); + } else { + ethQuery.getBalance(address, (error, balance) => { + if (error) { + reject(error); + log.error(error); + } else { + resolve(balance || '0x0'); + } + }); + } + }); + } + + /** + * Submits the user's password and attempts to unlock the vault. + * Also synchronizes the preferencesController, to ensure its schema + * is up to date with known accounts once the vault is decrypted. + * + * @param {string} password - The user's password + */ + async submitPassword(password) { + const { completedOnboarding } = this.onboardingController.state; + + // Before attempting to unlock the keyrings, we need the offscreen to have loaded. + await this.offscreenPromise; + + await this.keyringController.submitPassword(password); + + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + this.mmiController.onSubmitPassword(); + ///: END:ONLY_INCLUDE_IF + + try { + await this.blockTracker.checkForLatestBlock(); + } catch (error) { + log.error('Error while unlocking extension.', error); + } + + await this.accountsController.updateAccounts(); + + // This must be set as soon as possible to communicate to the + // keyring's iframe and have the setting initialized properly + // Optimistically called to not block MetaMask login due to + // Ledger Keyring GitHub downtime + if (completedOnboarding) { + this.setLedgerTransportPreference(); + } + } + + async _loginUser(password) { + try { + // Automatic login via config password + await this.submitPassword(password); + + // Updating accounts in this.accountTrackerController before starting UI syncing ensure that + // state has account balance before it is synced with UI + await this.accountTrackerController.updateAccountsAllActiveNetworks(); + } finally { + this._startUISync(); + } + } + + _startUISync() { + // Message startUISync is used to start syncing state with UI + // Sending this message after login is completed helps to ensure that incomplete state without + // account details are not flushed to UI. + this.emit('startUISync'); + this.startUISync = true; + this.memStore.subscribe(this.sendUpdate.bind(this)); + } + + /** + * Submits a user's encryption key to log the user in via login token + */ + async submitEncryptionKey() { + try { + const { loginToken, loginSalt } = + await this.extension.storage.session.get(['loginToken', 'loginSalt']); + if (loginToken && loginSalt) { + const { vault } = this.keyringController.state; + + const jsonVault = JSON.parse(vault); + + if (jsonVault.salt !== loginSalt) { + console.warn( + 'submitEncryptionKey: Stored salt and vault salt do not match', + ); + await this.clearLoginArtifacts(); + return; + } + + await this.keyringController.submitEncryptionKey(loginToken, loginSalt); + } + } catch (e) { + // If somehow this login token doesn't work properly, + // remove it and the user will get shown back to the unlock screen + await this.clearLoginArtifacts(); + throw e; + } + } + + async clearLoginArtifacts() { + await this.extension.storage.session.remove(['loginToken', 'loginSalt']); + } + + /** + * Submits a user's password to check its validity. + * + * @param {string} password - The user's password + */ + async verifyPassword(password) { + await this.keyringController.verifyPassword(password); + } + + /** + * @type Identity + * @property {string} name - The account nickname. + * @property {string} address - The account's ethereum address, in lower case. + * receiving funds from our automatic Ropsten faucet. + */ + + /** + * Gets the mnemonic of the user's primary keyring. + */ + getPrimaryKeyringMnemonic() { + const [keyring] = this.keyringController.getKeyringsByType( + KeyringType.hdKeyTree, + ); + if (!keyring.mnemonic) { + throw new Error('Primary keyring mnemonic unavailable.'); + } + + return keyring.mnemonic; + } + + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + async getCustodyKeyringIfExists(address) { + const custodyType = this.custodyController.getCustodyTypeByAddress( + toChecksumHexAddress(address), + ); + const keyring = this.keyringController.getKeyringsByType(custodyType)[0]; + return keyring?.getAccountDetails(address) ? keyring : undefined; + } + ///: END:ONLY_INCLUDE_IF + + // + // Hardware + // + + async getKeyringForDevice(deviceName, hdPath = null) { + const keyringOverrides = this.opts.overrides?.keyrings; + let keyringName = null; + switch (deviceName) { + case HardwareDeviceNames.trezor: + keyringName = keyringOverrides?.trezor?.type || TrezorKeyring.type; + break; + case HardwareDeviceNames.ledger: + keyringName = keyringOverrides?.ledger?.type || LedgerKeyring.type; + break; + case HardwareDeviceNames.qr: + keyringName = QRHardwareKeyring.type; + break; + case HardwareDeviceNames.lattice: + keyringName = keyringOverrides?.lattice?.type || LatticeKeyring.type; + break; + default: + throw new Error( + 'MetamaskController:getKeyringForDevice - Unknown device', + ); + } + let [keyring] = await this.keyringController.getKeyringsByType(keyringName); + if (!keyring) { + keyring = await this.keyringController.addNewKeyring(keyringName); + } + if (hdPath && keyring.setHdPath) { + keyring.setHdPath(hdPath); + } + if (deviceName === HardwareDeviceNames.lattice) { + keyring.appName = 'MetaMask'; + } + if (deviceName === HardwareDeviceNames.trezor) { + const model = keyring.getModel(); + this.appStateController.setTrezorModel(model); + } + + keyring.network = getProviderConfig({ + metamask: this.networkController.state, + }).type; + + return keyring; + } + + async attemptLedgerTransportCreation() { + const keyring = await this.getKeyringForDevice(HardwareDeviceNames.ledger); + return await keyring.attemptMakeApp(); + } + + /** + * Fetch account list from a hardware device. + * + * @param deviceName + * @param page + * @param hdPath + * @returns [] accounts + */ + async connectHardware(deviceName, page, hdPath) { + const keyring = await this.getKeyringForDevice(deviceName, hdPath); + + if (deviceName === HardwareDeviceNames.ledger) { + await this.setLedgerTransportPreference(keyring); + } + + let accounts = []; + switch (page) { + case -1: + accounts = await keyring.getPreviousPage(); + break; + case 1: + accounts = await keyring.getNextPage(); + break; + default: + accounts = await keyring.getFirstPage(); + } + + // Merge with existing accounts + // and make sure addresses are not repeated + const oldAccounts = await this.keyringController.getAccounts(); + + const accountsToTrack = [ + ...new Set( + oldAccounts.concat(accounts.map((a) => a.address.toLowerCase())), + ), + ]; + this.accountTrackerController.syncWithAddresses(accountsToTrack); + return accounts; + } + + /** + * Check if the device is unlocked + * + * @param deviceName + * @param hdPath + * @returns {Promise} + */ + async checkHardwareStatus(deviceName, hdPath) { + const keyring = await this.getKeyringForDevice(deviceName, hdPath); + return keyring.isUnlocked(); + } + + /** + * Get hardware device name for metric logging. + * + * @param deviceName - HardwareDeviceNames + * @param hdPath - string + * @returns {Promise} + */ + async getDeviceNameForMetric(deviceName, hdPath) { + if (deviceName === HardwareDeviceNames.trezor) { + const keyring = await this.getKeyringForDevice(deviceName, hdPath); + const { minorVersion } = keyring.bridge; + // Specific case for OneKey devices, see `ONE_KEY_VIA_TREZOR_MINOR_VERSION` for further details. + if (minorVersion && minorVersion === ONE_KEY_VIA_TREZOR_MINOR_VERSION) { + return HardwareDeviceNames.oneKeyViaTrezor; + } + } + + return deviceName; + } + + /** + * Clear + * + * @param deviceName + * @returns {Promise} + */ + async forgetDevice(deviceName) { + const keyring = await this.getKeyringForDevice(deviceName); + + for (const address of keyring.accounts) { + await this.removeAccount(address); + } + + keyring.forgetDevice(); + return true; + } + + /** + * Retrieves the keyring for the selected address and using the .type returns + * a subtype for the account. Either 'hardware', 'imported', 'snap', or 'MetaMask'. + * + * @param {string} address - Address to retrieve keyring for + * @returns {'hardware' | 'imported' | 'snap' | 'MetaMask'} + */ + async getAccountType(address) { + const keyringType = await this.keyringController.getAccountKeyringType( + address, + ); + switch (keyringType) { + case KeyringType.trezor: + case KeyringType.lattice: + case KeyringType.qr: + case KeyringType.ledger: + return 'hardware'; + case KeyringType.imported: + return 'imported'; + case KeyringType.snap: + return 'snap'; + default: + return 'MetaMask'; + } + } + + /** + * Retrieves the keyring for the selected address and using the .type + * determines if a more specific name for the device is available. Returns + * undefined for non hardware wallets. + * + * @param {string} address - Address to retrieve keyring for + * @returns {'ledger' | 'lattice' | string | undefined} + */ + async getDeviceModel(address) { + const keyring = await this.keyringController.getKeyringForAccount(address); + switch (keyring.type) { + case KeyringType.trezor: + return keyring.getModel(); + case KeyringType.qr: + return keyring.getName(); + case KeyringType.ledger: + // TODO: get model after ledger keyring exposes method + return HardwareDeviceNames.ledger; + case KeyringType.lattice: + // TODO: get model after lattice keyring exposes method + return HardwareDeviceNames.lattice; + default: + return undefined; + } + } + + /** + * get hardware account label + * + * @param name + * @param index + * @param hdPathDescription + * @returns string label + */ + getAccountLabel(name, index, hdPathDescription) { + return `${name[0].toUpperCase()}${name.slice(1)} ${ + parseInt(index, 10) + 1 + } ${hdPathDescription || ''}`.trim(); + } + + /** + * Imports an account from a Trezor or Ledger device. + * + * @param index + * @param deviceName + * @param hdPath + * @param hdPathDescription + * @returns {} keyState + */ + async unlockHardwareWalletAccount( + index, + deviceName, + hdPath, + hdPathDescription, + ) { + const keyring = await this.getKeyringForDevice(deviceName, hdPath); + + keyring.setAccountToUnlock(index); + const unlockedAccount = + await this.keyringController.addNewAccountForKeyring(keyring); + const label = this.getAccountLabel( + deviceName === HardwareDeviceNames.qr ? keyring.getName() : deviceName, + index, + hdPathDescription, + ); + // Set the account label to Trezor 1 / Ledger 1 / QR Hardware 1, etc + this.preferencesController.setAccountLabel(unlockedAccount, label); + // Select the account + this.preferencesController.setSelectedAddress(unlockedAccount); + + // It is expected that the account also exist in the accounts-controller + // in other case, an error shall be thrown + const account = + this.accountsController.getAccountByAddress(unlockedAccount); + this.accountsController.setAccountName(account.id, label); + + const accounts = this.accountsController.listAccounts(); + + const { identities } = this.preferencesController.state; + return { unlockedAccount, identities, accounts }; + } + + // + // Account Management + // + + /** + * Adds a new account to the default (first) HD seed phrase Keyring. + * + * @param accountCount + * @returns {Promise} The address of the newly-created account. + */ + async addNewAccount(accountCount) { + const oldAccounts = await this.keyringController.getAccounts(); + + const addedAccountAddress = await this.keyringController.addNewAccount( + accountCount, + ); + + if (!oldAccounts.includes(addedAccountAddress)) { + this.preferencesController.setSelectedAddress(addedAccountAddress); + } + + return addedAccountAddress; + } + + /** + * Verifies the validity of the current vault's seed phrase. + * + * Validity: seed phrase restores the accounts belonging to the current vault. + * + * Called when the first account is created and on unlocking the vault. + * + * @param password + * @returns {Promise} The seed phrase to be confirmed by the user, + * encoded as an array of UTF-8 bytes. + */ + async getSeedPhrase(password) { + return this._convertEnglishWordlistIndicesToCodepoints( + await this.keyringController.exportSeedPhrase(password), + ); + } + + /** + * Clears the transaction history, to allow users to force-reset their nonces. + * Mostly used in development environments, when networks are restarted with + * the same network ID. + * + * @returns {Promise} The current selected address. + */ + async resetAccount() { + const selectedAddress = + this.accountsController.getSelectedAccount().address; + this.txController.wipeTransactions(false, selectedAddress); + this.smartTransactionsController.wipeSmartTransactions({ + address: selectedAddress, + ignoreNetwork: false, + }); + this.networkController.resetConnection(); + + return selectedAddress; + } + + /** + * Gets the permitted accounts for the specified origin. Returns an empty + * array if no accounts are permitted. + * + * @param {string} origin - The origin whose exposed accounts to retrieve. + * @param {boolean} [suppressUnauthorizedError] - Suppresses the unauthorized error. + * @returns {Promise} The origin's permitted accounts, or an empty + * array. + */ + async getPermittedAccounts( + origin, + { suppressUnauthorizedError = true } = {}, + ) { + try { + return await this.permissionController.executeRestrictedMethod( + origin, + RestrictedMethods.eth_accounts, + ); + } catch (error) { + if ( + suppressUnauthorizedError && + error.code === rpcErrorCodes.provider.unauthorized + ) { + return []; + } + throw error; + } + } + + /** + * Stops exposing the specified chain ID to all third parties. + * Exposed chain IDs are stored in caveats of the `endowment:permitted-chains` + * permission. This method uses `PermissionController.updatePermissionsByCaveat` + * to remove the specified chain ID from every `endowment:permitted-chains` + * permission. If a permission only included this chain ID, the permission is + * revoked entirely. + * + * @param {string} targetChainId - The chain ID to stop exposing + * to third parties. + */ + removeAllChainIdPermissions(targetChainId) { + this.permissionController.updatePermissionsByCaveat( + CaveatTypes.restrictNetworkSwitching, + (existingChainIds) => + CaveatMutatorFactories[ + CaveatTypes.restrictNetworkSwitching + ].removeChainId(targetChainId, existingChainIds), + ); + } + + /** + * Stops exposing the account with the specified address to all third parties. + * Exposed accounts are stored in caveats of the eth_accounts permission. This + * method uses `PermissionController.updatePermissionsByCaveat` to + * remove the specified address from every eth_accounts permission. If a + * permission only included this address, the permission is revoked entirely. + * + * @param {string} targetAccount - The address of the account to stop exposing + * to third parties. + */ + removeAllAccountPermissions(targetAccount) { + this.permissionController.updatePermissionsByCaveat( + CaveatTypes.restrictReturnedAccounts, + (existingAccounts) => + CaveatMutatorFactories[ + CaveatTypes.restrictReturnedAccounts + ].removeAccount(targetAccount, existingAccounts), + ); + } + + /** + * Removes an account from state / storage. + * + * @param {string[]} address - A hex address + */ + async removeAccount(address) { + // Remove all associated permissions + this.removeAllAccountPermissions(address); + + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + this.custodyController.removeAccount(address); + ///: END:ONLY_INCLUDE_IF(build-mmi) + + const keyring = await this.keyringController.getKeyringForAccount(address); + // Remove account from the keyring + await this.keyringController.removeAccount(address); + const updatedKeyringAccounts = keyring ? await keyring.getAccounts() : {}; + if (updatedKeyringAccounts?.length === 0) { + keyring.destroy?.(); + } + + return address; + } + + /** + * Imports an account with the specified import strategy. + * These are defined in @metamask/keyring-controller + * Each strategy represents a different way of serializing an Ethereum key pair. + * + * @param {'privateKey' | 'json'} strategy - A unique identifier for an account import strategy. + * @param {any} args - The data required by that strategy to import an account. + */ + async importAccountWithStrategy(strategy, args) { + const importedAccountAddress = + await this.keyringController.importAccountWithStrategy(strategy, args); + // set new account as selected + this.preferencesController.setSelectedAddress(importedAccountAddress); + } + + // --------------------------------------------------------------------------- + // Identity Management (signature operations) + + getAddTransactionRequest({ + transactionParams, + transactionOptions, + dappRequest, + ...otherParams + }) { + return { + internalAccounts: this.accountsController.listAccounts(), + dappRequest, + networkClientId: + dappRequest?.networkClientId ?? + this.networkController.state.selectedNetworkClientId, + selectedAccount: this.accountsController.getAccountByAddress( + transactionParams.from, + ), + transactionController: this.txController, + transactionOptions, + transactionParams, + userOperationController: this.userOperationController, + chainId: getCurrentChainId({ metamask: this.networkController.state }), + ppomController: this.ppomController, + securityAlertsEnabled: + this.preferencesController.state?.securityAlertsEnabled, + updateSecurityAlertResponse: this.updateSecurityAlertResponse.bind(this), + ...otherParams, + }; + } + + /** + * @returns {boolean} true if the keyring type supports EIP-1559 + */ + async getCurrentAccountEIP1559Compatibility() { + return true; + } + + //============================================================================= + // END (VAULT / KEYRING RELATED METHODS) + //============================================================================= + + /** + * Allows a user to attempt to cancel a previously submitted transaction + * by creating a new transaction. + * + * @param {number} originalTxId - the id of the txMeta that you want to + * attempt to cancel + * @param {import( + * './controllers/transactions' + * ).CustomGasSettings} [customGasSettings] - overrides to use for gas params + * instead of allowing this method to generate them + * @param options + * @returns {object} MetaMask state + */ + async createCancelTransaction(originalTxId, customGasSettings, options) { + await this.txController.stopTransaction( + originalTxId, + customGasSettings, + options, + ); + const state = this.getState(); + return state; + } + + /** + * Allows a user to attempt to speed up a previously submitted transaction + * by creating a new transaction. + * + * @param {number} originalTxId - the id of the txMeta that you want to + * attempt to speed up + * @param {import( + * './controllers/transactions' + * ).CustomGasSettings} [customGasSettings] - overrides to use for gas params + * instead of allowing this method to generate them + * @param options + * @returns {object} MetaMask state + */ + async createSpeedUpTransaction(originalTxId, customGasSettings, options) { + await this.txController.speedUpTransaction( + originalTxId, + customGasSettings, + options, + ); + const state = this.getState(); + return state; + } + + async estimateGas(estimateGasParams) { + return new Promise((resolve, reject) => { + return new EthJSQuery(this.provider).estimateGas( + estimateGasParams, + (err, res) => { + if (err) { + return reject(err); + } + + return resolve(res.toString(16)); + }, + ); + }); + } + + handleWatchAssetRequest = ({ asset, type, origin, networkClientId }) => { + switch (type) { + case ERC20: + return this.tokensController.watchAsset({ + asset, + type, + networkClientId, + }); + case ERC721: + case ERC1155: + return this.nftController.watchNft(asset, type, origin); + default: + throw new Error(`Asset type ${type} not supported`); + } + }; + + async updateSecurityAlertResponse( + method, + securityAlertId, + securityAlertResponse, + ) { + updateSecurityAlertResponse({ + appStateController: this.appStateController, + method, + securityAlertId, + securityAlertResponse, + signatureController: this.signatureController, + transactionController: this.txController, + }); + } + + //============================================================================= + // PASSWORD MANAGEMENT + //============================================================================= + + /** + * Allows a user to begin the seed phrase recovery process. + */ + markPasswordForgotten() { + this.preferencesController.setPasswordForgotten(true); + this.sendUpdate(); + } + + /** + * Allows a user to end the seed phrase recovery process. + */ + unMarkPasswordForgotten() { + this.preferencesController.setPasswordForgotten(false); + this.sendUpdate(); + } + + //============================================================================= + // REQUEST QUEUE + //============================================================================= + + setUseRequestQueue(value) { + this.preferencesController.setUseRequestQueue(value); + } + + //============================================================================= + // SETUP + //============================================================================= + + /** + * A runtime.MessageSender object, as provided by the browser: + * + * @see https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/MessageSender + * @typedef {object} MessageSender + * @property {string} - The URL of the page or frame hosting the script that sent the message. + */ + + /** + * A Snap sender object. + * + * @typedef {object} SnapSender + * @property {string} snapId - The ID of the snap. + */ + + /** + * Used to create a multiplexed stream for connecting to an untrusted context + * like a Dapp or other extension. + * + * @param options - Options bag. + * @param {ReadableStream} options.connectionStream - The Duplex stream to connect to. + * @param {MessageSender | SnapSender} options.sender - The sender of the messages on this stream. + * @param {string} [options.subjectType] - The type of the sender, i.e. subject. + */ + setupUntrustedCommunicationEip1193({ + connectionStream, + sender, + subjectType, + }) { + if (sender.url) { + if (this.onboardingController.state.completedOnboarding) { + if (this.preferencesController.state.usePhishDetect) { + const { hostname } = new URL(sender.url); + this.phishingController.maybeUpdateState(); + // Check if new connection is blocked if phishing detection is on + const phishingTestResponse = this.phishingController.test(sender.url); + if (phishingTestResponse?.result) { + this.sendPhishingWarning(connectionStream, hostname); + this.metaMetricsController.trackEvent({ + event: MetaMetricsEventName.PhishingPageDisplayed, + category: MetaMetricsEventCategory.Phishing, + properties: { + url: hostname, + }, + }); + return; + } + } + } + } + + let inputSubjectType; + if (subjectType) { + inputSubjectType = subjectType; + } else if (sender.id && sender.id !== this.extension.runtime.id) { + inputSubjectType = SubjectType.Extension; + } else { + inputSubjectType = SubjectType.Website; + } + + // setup multiplexing + const mux = setupMultiplex(connectionStream); + + // messages between inpage and background + this.setupProviderConnectionEip1193( + mux.createStream('metamask-provider'), + sender, + inputSubjectType, + ); + + // TODO:LegacyProvider: Delete + if (sender.url) { + // legacy streams + this.setupPublicConfig(mux.createStream('publicConfig')); + } + } + + /** + * Used to create a CAIP stream for connecting to an untrusted context. + * + * @param options - Options bag. + * @param {ReadableStream} options.connectionStream - The Duplex stream to connect to. + * @param {MessageSender | SnapSender} options.sender - The sender of the messages on this stream. + * @param {string} [options.subjectType] - The type of the sender, i.e. subject. + */ + + setupUntrustedCommunicationCaip({ connectionStream, sender, subjectType }) { + let inputSubjectType; + if (subjectType) { + inputSubjectType = subjectType; + } else if (sender.id && sender.id !== this.extension.runtime.id) { + inputSubjectType = SubjectType.Extension; + } else { + inputSubjectType = SubjectType.Website; + } + + const caipStream = createCaipStream(connectionStream); + + // messages between subject and background + this.setupProviderConnectionCaip(caipStream, sender, inputSubjectType); + } + + /** + * Used to create a multiplexed stream for connecting to a trusted context, + * like our own user interfaces, which have the provider APIs, but also + * receive the exported API from this controller, which includes trusted + * functions, like the ability to approve transactions or sign messages. + * + * @param {*} connectionStream - The duplex stream to connect to. + * @param {MessageSender} sender - The sender of the messages on this stream + */ + setupTrustedCommunication(connectionStream, sender) { + // setup multiplexing + const mux = setupMultiplex(connectionStream); + // connect features + this.setupControllerConnection(mux.createStream('controller')); + this.setupProviderConnectionEip1193( + mux.createStream('provider'), + sender, + SubjectType.Internal, + ); + } + + /** + * Used to create a multiplexed stream for connecting to the phishing warning page. + * + * @param options - Options bag. + * @param {ReadableStream} options.connectionStream - The Duplex stream to connect to. + */ + setupPhishingCommunication({ connectionStream }) { + const { usePhishDetect } = this.preferencesController.state; + + if (!usePhishDetect) { + return; + } + + // setup multiplexing + const mux = setupMultiplex(connectionStream); + const phishingStream = mux.createStream(PHISHING_SAFELIST); + + // set up postStream transport + phishingStream.on( + 'data', + createMetaRPCHandler( + { + safelistPhishingDomain: this.safelistPhishingDomain.bind(this), + backToSafetyPhishingWarning: + this.backToSafetyPhishingWarning.bind(this), + }, + phishingStream, + ), + ); + } + + setUpCookieHandlerCommunication({ connectionStream }) { + const { + metaMetricsId, + dataCollectionForMarketing, + participateInMetaMetrics, + } = this.metaMetricsController.store.getState(); + + if ( + metaMetricsId && + dataCollectionForMarketing && + participateInMetaMetrics + ) { + // setup multiplexing + const mux = setupMultiplex(connectionStream); + const metamaskCookieHandlerStream = mux.createStream( + METAMASK_COOKIE_HANDLER, + ); + // set up postStream transport + metamaskCookieHandlerStream.on( + 'data', + createMetaRPCHandler( + { + getCookieFromMarketingPage: + this.getCookieFromMarketingPage.bind(this), + }, + metamaskCookieHandlerStream, + ), + ); + } + } + + getCookieFromMarketingPage(data) { + const { ga_client_id: cookieId } = data; + this.metaMetricsController.setMarketingCampaignCookieId(cookieId); + } + + /** + * Called when we detect a suspicious domain. Requests the browser redirects + * to our anti-phishing page. + * + * @private + * @param {*} connectionStream - The duplex stream to the per-page script, + * for sending the reload attempt to. + * @param {string} hostname - The hostname that triggered the suspicion. + */ + sendPhishingWarning(connectionStream, hostname) { + const mux = setupMultiplex(connectionStream); + const phishingStream = mux.createStream('phishing'); + phishingStream.write({ hostname }); + } + + /** + * A method for providing our API over a stream using JSON-RPC. + * + * @param {*} outStream - The stream to provide our API over. + */ + setupControllerConnection(outStream) { + const patchStore = new PatchStore(this.memStore); + let uiReady = false; + + const handleUpdate = () => { + if (!isStreamWritable(outStream) || !uiReady) { + return; + } + + const patches = patchStore.flushPendingPatches(); + + outStream.write({ + jsonrpc: '2.0', + method: 'sendUpdate', + params: [patches], + }); + }; + + const api = { + ...this.getApi(), + startPatches: () => { + uiReady = true; + handleUpdate(); + }, + getStatePatches: () => patchStore.flushPendingPatches(), + }; + + this.on('update', handleUpdate); + + // report new active controller connection + this.activeControllerConnections += 1; + this.emit('controllerConnectionChanged', this.activeControllerConnections); + + // set up postStream transport + outStream.on('data', createMetaRPCHandler(api, outStream)); + + const startUISync = () => { + if (!isStreamWritable(outStream)) { + return; + } + // send notification to client-side + outStream.write({ + jsonrpc: '2.0', + method: 'startUISync', + }); + }; + + if (this.startUISync) { + startUISync(); + } else { + this.once('startUISync', startUISync); + } + + const outstreamEndHandler = () => { + if (!outStream.mmFinished) { + this.activeControllerConnections -= 1; + this.emit( + 'controllerConnectionChanged', + this.activeControllerConnections, + ); + outStream.mmFinished = true; + this.removeListener('update', handleUpdate); + patchStore.destroy(); + } + }; + + // The presence of both of the below handlers may be redundant. + // After upgrading metamask/object-multiples to v2.0.0, which included + // an upgrade of readable-streams from v2 to v3, we saw that the + // `outStream.on('end'` handler was almost never being called. This seems to + // related to how v3 handles errors vs how v2 handles errors; there + // are "premature close" errors in both cases, although in the case + // of v2 they don't prevent `outStream.on('end'` from being called. + // At the time that this comment was committed, it was known that we + // need to investigate and resolve the underlying error, however, + // for expediency, we are not addressing them at this time. Instead, we + // can observe that `readableStream.finished` preserves the same + // functionality as we had when we relied on readable-stream v2. Meanwhile, + // the `outStream.on('end')` handler was observed to have been called at least once. + // In an abundance of caution to prevent against unexpected future behavioral changes in + // streams implementations, we redundantly use multiple paths to attach the same event handler. + // The outstreamEndHandler therefore needs to be idempotent, which introduces the `mmFinished` property. + + outStream.mmFinished = false; + finished(outStream, outstreamEndHandler); + outStream.once('close', outstreamEndHandler); + outStream.once('end', outstreamEndHandler); + } + + /** + * A method for serving our ethereum provider over a given stream. + * + * @param {*} outStream - The stream to provide over. + * @param {MessageSender | SnapSender} sender - The sender of the messages on this stream + * @param {SubjectType} subjectType - The type of the sender, i.e. subject. + */ + setupProviderConnectionEip1193(outStream, sender, subjectType) { + let origin; + if (subjectType === SubjectType.Internal) { + origin = ORIGIN_METAMASK; + } else if (subjectType === SubjectType.Snap) { + origin = sender.snapId; + } else { + origin = new URL(sender.url).origin; + } + + if (sender.id && sender.id !== this.extension.runtime.id) { + this.subjectMetadataController.addSubjectMetadata({ + origin, + extensionId: sender.id, + subjectType: SubjectType.Extension, + }); + } + + let tabId; + if (sender.tab && sender.tab.id) { + tabId = sender.tab.id; + } + + const engine = this.setupProviderEngineEip1193({ + origin, + sender, + subjectType, + tabId, + }); + + const dupeReqFilterStream = createDupeReqFilterStream(); + + // setup connection + const providerStream = createEngineStream({ engine }); + + const connectionId = this.addConnection(origin, { engine }); + + pipeline( + outStream, + dupeReqFilterStream, + providerStream, + outStream, + (err) => { + // handle any middleware cleanup + engine.destroy(); + connectionId && this.removeConnection(origin, connectionId); + // For context and todos related to the error message match, see https://github.com/MetaMask/metamask-extension/issues/26337 + if (err && !err.message?.match('Premature close')) { + log.error(err); + } + }, + ); + + // Used to show wallet liveliness to the provider + if (subjectType !== SubjectType.Internal) { + this._notifyChainChangeForConnection({ engine }, origin); + } + } + + /** + * A method for serving our CAIP provider over a given stream. + * + * @param {*} outStream - The stream to provide over. + * @param {MessageSender | SnapSender} sender - The sender of the messages on this stream + * @param {SubjectType} subjectType - The type of the sender, i.e. subject. + */ + setupProviderConnectionCaip(outStream, sender, subjectType) { + let origin; + if (subjectType === SubjectType.Internal) { + origin = ORIGIN_METAMASK; + } else if (subjectType === SubjectType.Snap) { + origin = sender.snapId; + } else { + origin = new URL(sender.url).origin; + } + + if (sender.id && sender.id !== this.extension.runtime.id) { + this.subjectMetadataController.addSubjectMetadata({ + origin, + extensionId: sender.id, + subjectType: SubjectType.Extension, + }); + } + + let tabId; + if (sender.tab && sender.tab.id) { + tabId = sender.tab.id; + } + + const engine = this.setupProviderEngineCaip({ + origin, + tabId, + }); + + const dupeReqFilterStream = createDupeReqFilterStream(); + + // setup connection + const providerStream = createEngineStream({ engine }); + + const connectionId = this.addConnection(origin, { engine }); + + pipeline( + outStream, + dupeReqFilterStream, + providerStream, + outStream, + (err) => { + // handle any middleware cleanup + engine._middleware.forEach((mid) => { + if (mid.destroy && typeof mid.destroy === 'function') { + mid.destroy(); + } + }); + connectionId && this.removeConnection(origin, connectionId); + if (err) { + log.error(err); + } + }, + ); + + // Used to show wallet liveliness to the provider + if (subjectType !== SubjectType.Internal) { + this._notifyChainChangeForConnection({ engine }, origin); + } + } + + /** + * For snaps running in workers. + * + * @param snapId + * @param connectionStream + */ + setupSnapProvider(snapId, connectionStream) { + this.setupUntrustedCommunicationEip1193({ + connectionStream, + sender: { snapId }, + subjectType: SubjectType.Snap, + }); + } + + /** + * A method for creating an ethereum provider that is safely restricted for the requesting subject. + * + * @param {object} options - Provider engine options + * @param {string} options.origin - The origin of the sender + * @param {MessageSender | SnapSender} options.sender - The sender object. + * @param {string} options.subjectType - The type of the sender subject. + * @param {tabId} [options.tabId] - The tab ID of the sender - if the sender is within a tab + */ + setupProviderEngineEip1193({ origin, subjectType, sender, tabId }) { + const engine = new JsonRpcEngine(); + + // Append origin to each request + engine.push(createOriginMiddleware({ origin })); + + // Append selectedNetworkClientId to each request + engine.push(createSelectedNetworkMiddleware(this.controllerMessenger)); + + // Add a middleware that will switch chain on each request (as needed) + const requestQueueMiddleware = createQueuedRequestMiddleware({ + enqueueRequest: this.queuedRequestController.enqueueRequest.bind( + this.queuedRequestController, + ), + useRequestQueue: this.preferencesController.getUseRequestQueue.bind( + this.preferencesController, + ), + shouldEnqueueRequest: (request) => { + return methodsThatShouldBeEnqueued.includes(request.method); + }, + }); + engine.push(requestQueueMiddleware); + + // If the origin is not in the selectedNetworkController's `domains` state + // when the provider engine is created, the selectedNetworkController will + // fetch the globally selected networkClient from the networkController and wrap + // it in a proxy which can be switched to use its own state if/when the origin + // is added to the `domains` state + const proxyClient = + this.selectedNetworkController.getProviderAndBlockTracker(origin); + + // We create the filter and subscription manager middleware now, but they will + // be inserted into the engine later. + const filterMiddleware = createFilterMiddleware(proxyClient); + const subscriptionManager = createSubscriptionManager(proxyClient); + subscriptionManager.events.on('notification', (message) => + engine.emit('notification', message), + ); + + // Append tabId to each request if it exists + if (tabId) { + engine.push(createTabIdMiddleware({ tabId })); + } + + engine.push(createLoggerMiddleware({ origin })); + engine.push(this.permissionLogController.createMiddleware()); + + if (origin === BaseUrl.Portfolio) { + engine.push(createTxVerificationMiddleware(this.networkController)); + } + + engine.push(createTracingMiddleware()); + + engine.push( + createPPOMMiddleware( + this.ppomController, + this.preferencesController, + this.networkController, + this.appStateController, + this.accountsController, + this.updateSecurityAlertResponse.bind(this), + ), + ); + + const isConfirmationRedesignEnabled = () => { + return this.preferencesController.state.preferences + .redesignedConfirmationsEnabled; + }; + + engine.push( + createRPCMethodTrackingMiddleware({ + getMetricsState: this.metaMetricsController.store.getState.bind( + this.metaMetricsController.store, + ), + getAccountType: this.getAccountType.bind(this), + getDeviceModel: this.getDeviceModel.bind(this), + isConfirmationRedesignEnabled, + snapAndHardwareMessenger: this.controllerMessenger.getRestricted({ + name: 'SnapAndHardwareMessenger', + allowedActions: [ + 'KeyringController:getKeyringForAccount', + 'SnapController:get', + 'AccountsController:getSelectedAccount', + ], + }), + appStateController: this.appStateController, + metaMetricsController: this.metaMetricsController, + }), + ); + + engine.push(createUnsupportedMethodMiddleware()); + + // Legacy RPC methods that need to be implemented _ahead of_ the permission + // middleware. + engine.push( + createLegacyMethodMiddleware({ + getAccounts: this.getPermittedAccounts.bind(this, origin), + }), + ); + + if (subjectType !== SubjectType.Internal) { + engine.push( + this.permissionController.createPermissionMiddleware({ + origin, + }), + ); + } + + if (subjectType === SubjectType.Website) { + engine.push( + createOnboardingMiddleware({ + location: sender.url, + registerOnboarding: this.onboardingController.registerOnboarding, + }), + ); + } + + // EVM requests and eth permissions should not be passed to non-EVM accounts + // this middleware intercepts these requests and returns an error. + engine.push( + createEvmMethodsToNonEvmAccountReqFilterMiddleware({ + messenger: this.controllerMessenger.getRestricted({ + name: 'EvmMethodsToNonEvmAccountFilterMessenger', + allowedActions: ['AccountsController:getSelectedAccount'], + }), + }), + ); + + // Unrestricted/permissionless RPC method implementations. + // They must nevertheless be placed _behind_ the permission middleware. + engine.push( + createMethodMiddleware({ + origin, + + subjectType, + + // Miscellaneous + addSubjectMetadata: + this.subjectMetadataController.addSubjectMetadata.bind( + this.subjectMetadataController, + ), + metamaskState: this.getState(), + getProviderState: this.getProviderState.bind(this), + getUnlockPromise: this.appStateController.getUnlockPromise.bind( + this.appStateController, + ), + handleWatchAssetRequest: this.handleWatchAssetRequest.bind(this), + requestUserApproval: + this.approvalController.addAndShowApprovalRequest.bind( + this.approvalController, + ), + startApprovalFlow: this.approvalController.startFlow.bind( + this.approvalController, + ), + endApprovalFlow: this.approvalController.endFlow.bind( + this.approvalController, + ), + sendMetrics: this.metaMetricsController.trackEvent.bind( + this.metaMetricsController, + ), + // Permission-related + getAccounts: this.getPermittedAccounts.bind(this, origin), + getPermissionsForOrigin: this.permissionController.getPermissions.bind( + this.permissionController, + origin, + ), + hasPermission: this.permissionController.hasPermission.bind( + this.permissionController, + origin, + ), + requestAccountsPermission: + this.permissionController.requestPermissions.bind( + this.permissionController, + { origin }, + { + eth_accounts: {}, + ...(!isSnapId(origin) && { + [PermissionNames.permittedChains]: {}, + }), + }, + ), + requestPermittedChainsPermission: (chainIds) => + this.permissionController.requestPermissionsIncremental( + { origin }, + { + [PermissionNames.permittedChains]: { + caveats: [ + CaveatFactories[CaveatTypes.restrictNetworkSwitching]( + chainIds, + ), + ], + }, + }, + ), + grantPermittedChainsPermissionIncremental: (chainIds) => + this.permissionController.grantPermissionsIncremental({ + subject: { origin }, + approvedPermissions: { + [PermissionNames.permittedChains]: { + caveats: [ + CaveatFactories[CaveatTypes.restrictNetworkSwitching]( + chainIds, + ), + ], + }, + }, + }), + requestPermissionsForOrigin: (requestedPermissions) => + this.permissionController.requestPermissions( + { origin }, + { + ...(requestedPermissions[PermissionNames.eth_accounts] && { + [PermissionNames.permittedChains]: {}, + }), + ...(requestedPermissions[PermissionNames.permittedChains] && { + [PermissionNames.eth_accounts]: {}, + }), + ...requestedPermissions, + }, + ), + revokePermissionsForOrigin: (permissionKeys) => { + try { + this.permissionController.revokePermissions({ + [origin]: permissionKeys, + }); + } catch (e) { + // we dont want to handle errors here because + // the revokePermissions api method should just + // return `null` if the permissions were not + // successfully revoked or if the permissions + // for the origin do not exist + console.log(e); + } + }, + getCaveat: ({ target, caveatType }) => { + try { + return this.permissionController.getCaveat( + origin, + target, + caveatType, + ); + } catch (e) { + if (e instanceof PermissionDoesNotExistError) { + // suppress expected error in case that the origin + // does not have the target permission yet + } else { + throw e; + } + } + + return undefined; + }, + // network configuration-related + setActiveNetwork: async (networkClientId) => { + await this.networkController.setActiveNetwork(networkClientId); + // if the origin has the eth_accounts permission + // we set per dapp network selection state + if ( + this.permissionController.hasPermission( + origin, + PermissionNames.eth_accounts, + ) + ) { + this.selectedNetworkController.setNetworkClientIdForDomain( + origin, + networkClientId, + ); + } + }, + addNetwork: this.networkController.addNetwork.bind( + this.networkController, + ), + updateNetwork: this.networkController.updateNetwork.bind( + this.networkController, + ), + getNetworkConfigurationByChainId: + this.networkController.getNetworkConfigurationByChainId.bind( + this.networkController, + ), + getCurrentChainIdForDomain: (domain) => { + const networkClientId = + this.selectedNetworkController.getNetworkClientIdForDomain(domain); + const { chainId } = + this.networkController.getNetworkConfigurationByNetworkClientId( + networkClientId, + ); + return chainId; + }, + + // Web3 shim-related + getWeb3ShimUsageState: this.alertController.getWeb3ShimUsageState.bind( + this.alertController, + ), + setWeb3ShimUsageRecorded: + this.alertController.setWeb3ShimUsageRecorded.bind( + this.alertController, + ), + + ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) + handleMmiAuthenticate: + this.institutionalFeaturesController.handleMmiAuthenticate.bind( + this.institutionalFeaturesController, + ), + handleMmiCheckIfTokenIsPresent: + this.mmiController.handleMmiCheckIfTokenIsPresent.bind( + this.mmiController, + ), + handleMmiDashboardData: this.mmiController.handleMmiDashboardData.bind( + this.mmiController, + ), + handleMmiSetAccountAndNetwork: + this.mmiController.setAccountAndNetwork.bind(this.mmiController), + handleMmiOpenAddHardwareWallet: + this.mmiController.handleMmiOpenAddHardwareWallet.bind( + this.mmiController, + ), + ///: END:ONLY_INCLUDE_IF + }), + ); + + engine.push( + createSnapsMethodMiddleware(subjectType === SubjectType.Snap, { + getUnlockPromise: this.appStateController.getUnlockPromise.bind( + this.appStateController, + ), + getSnaps: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:getPermitted', + origin, + ), + requestPermissions: async (requestedPermissions) => + await this.permissionController.requestPermissions( + { origin }, + requestedPermissions, + ), + getPermissions: this.permissionController.getPermissions.bind( + this.permissionController, + origin, + ), + getSnapFile: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:getFile', + origin, + ), + installSnaps: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:install', + origin, + ), + invokeSnap: this.permissionController.executeRestrictedMethod.bind( + this.permissionController, + origin, + RestrictedMethods.wallet_snap, + ), + getIsLocked: () => { + return !this.appStateController.isUnlocked(); + }, + getInterfaceState: (...args) => + this.controllerMessenger.call( + 'SnapInterfaceController:getInterface', + origin, + ...args, + ).state, + createInterface: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapInterfaceController:createInterface', + origin, + ), + updateInterface: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapInterfaceController:updateInterface', + origin, + ), + resolveInterface: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapInterfaceController:resolveInterface', + origin, + ), + getSnap: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:get', + ), + getAllSnaps: this.controllerMessenger.call.bind( + this.controllerMessenger, + 'SnapController:getAll', + ), + getCurrencyRate: (currency) => { + const rate = this.multichainRatesController.state.rates[currency]; + const { fiatCurrency } = this.multichainRatesController.state; + + if (!rate) { + return undefined; + } + + return { + ...rate, + currency: fiatCurrency, + }; + }, + ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) + hasPermission: this.permissionController.hasPermission.bind( + this.permissionController, + origin, + ), + handleSnapRpcRequest: (args) => + this.handleSnapRequest({ ...args, origin }), + getAllowedKeyringMethods: keyringSnapPermissionsBuilder( + this.subjectMetadataController, + origin, + ), + ///: END:ONLY_INCLUDE_IF + }), + ); + + engine.push(filterMiddleware); + engine.push(subscriptionManager.middleware); + + engine.push(this.metamaskMiddleware); + + engine.push(providerAsMiddleware(proxyClient.provider)); + + return engine; + } + + /** + * A method for creating a CAIP provider that is safely restricted for the requesting subject. + * + * @param {object} options - Provider engine options + * @param {string} options.origin - The origin of the sender + * @param {tabId} [options.tabId] - The tab ID of the sender - if the sender is within a tab + */ + setupProviderEngineCaip({ origin, tabId }) { + const engine = new JsonRpcEngine(); + + engine.push((request, _res, _next, end) => { + console.log('CAIP request received', { origin, tabId, request }); + return end(new Error('CAIP RPC Pipeline not yet implemented.')); + }); + + return engine; + } + + /** + * TODO:LegacyProvider: Delete + * A method for providing our public config info over a stream. + * This includes info we like to be synchronous if possible, like + * the current selected account, and network ID. + * + * Since synchronous methods have been deprecated in web3, + * this is a good candidate for deprecation. + * + * @param {*} outStream - The stream to provide public config over. + */ + setupPublicConfig(outStream) { + const configStream = storeAsStream(this.publicConfigStore); + + pipeline(configStream, outStream, (err) => { + configStream.destroy(); + // For context and todos related to the error message match, see https://github.com/MetaMask/metamask-extension/issues/26337 + if (err && !err.message?.match('Premature close')) { + log.error(err); + } + }); + } + + /** + * Adds a reference to a connection by origin. Ignores the 'metamask' origin. + * Caller must ensure that the returned id is stored such that the reference + * can be deleted later. + * + * @param {string} origin - The connection's origin string. + * @param {object} options - Data associated with the connection + * @param {object} options.engine - The connection's JSON Rpc Engine + * @returns {string} The connection's id (so that it can be deleted later) + */ + addConnection(origin, { engine }) { + if (origin === ORIGIN_METAMASK) { + return null; + } + + if (!this.connections[origin]) { + this.connections[origin] = {}; + } + + const id = nanoid(); + this.connections[origin][id] = { + engine, + }; + + return id; + } + + /** + * Deletes a reference to a connection, by origin and id. + * Ignores unknown origins. + * + * @param {string} origin - The connection's origin string. + * @param {string} id - The connection's id, as returned from addConnection. + */ + removeConnection(origin, id) { + const connections = this.connections[origin]; + if (!connections) { + return; + } + + delete connections[id]; + + if (Object.keys(connections).length === 0) { + delete this.connections[origin]; + } + } + + /** + * Closes all connections for the given origin, and removes the references + * to them. + * Ignores unknown origins. + * + * @param {string} origin - The origin string. + */ + removeAllConnections(origin) { + const connections = this.connections[origin]; + if (!connections) { + return; + } + + Object.keys(connections).forEach((id) => { + this.removeConnection(origin, id); + }); + } + + /** + * Causes the RPC engines associated with the connections to the given origin + * to emit a notification event with the given payload. + * + * The caller is responsible for ensuring that only permitted notifications + * are sent. + * + * Ignores unknown origins. + * + * @param {string} origin - The connection's origin string. + * @param {unknown} payload - The event payload. + */ + notifyConnections(origin, payload) { + const connections = this.connections[origin]; + + if (connections) { + Object.values(connections).forEach((conn) => { + if (conn.engine) { + conn.engine.emit('notification', payload); + } + }); + } + } + + /** + * Causes the RPC engines associated with all connections to emit a + * notification event with the given payload. + * + * If the "payload" parameter is a function, the payload for each connection + * will be the return value of that function called with the connection's + * origin. + * + * The caller is responsible for ensuring that only permitted notifications + * are sent. + * + * @param {unknown} payload - The event payload, or payload getter function. + */ + notifyAllConnections(payload) { + const getPayload = + typeof payload === 'function' + ? (origin) => payload(origin) + : () => payload; + + Object.keys(this.connections).forEach((origin) => { + Object.values(this.connections[origin]).forEach(async (conn) => { + try { + this.notifyConnection(conn, await getPayload(origin)); + } catch (err) { + console.error(err); + } + }); + }); + } + + /** + * Causes the RPC engine for passed connection to emit a + * notification event with the given payload. + * + * The caller is responsible for ensuring that only permitted notifications + * are sent. + * + * @param {object} connection - Data associated with the connection + * @param {object} connection.engine - The connection's JSON Rpc Engine + * @param {unknown} payload - The event payload + */ + notifyConnection(connection, payload) { + try { + if (connection.engine) { + connection.engine.emit('notification', payload); + } + } catch (err) { + console.error(err); + } + } + + // handlers + + /** + * Handle a KeyringController update + * + * @param {object} state - the KC state + * @returns {Promise} + * @private + */ + async _onKeyringControllerUpdate(state) { + const { keyrings } = state; + + // The accounts tracker only supports EVM addresses and the keyring + // controller may pass non-EVM addresses, so we filter them out + const addresses = keyrings + .reduce((acc, { accounts }) => acc.concat(accounts), []) + .filter(isEthAddress); + + if (!addresses.length) { + return; + } + + this.accountTrackerController.syncWithAddresses(addresses); + } + + /** + * Handle global application unlock. + * Notifies all connections that the extension is unlocked, and which + * account(s) are currently accessible, if any. + */ + _onUnlock() { + this.notifyAllConnections(async (origin) => { + return { + method: NOTIFICATION_NAMES.unlockStateChanged, + params: { + isUnlocked: true, + accounts: await this.getPermittedAccounts(origin), + }, + }; + }); + + this.unMarkPasswordForgotten(); + + // In the current implementation, this handler is triggered by a + // KeyringController event. Other controllers subscribe to the 'unlock' + // event of the MetaMaskController itself. + this.emit('unlock'); + } + + /** + * Handle global application lock. + * Notifies all connections that the extension is locked. + */ + _onLock() { + this.notifyAllConnections({ + method: NOTIFICATION_NAMES.unlockStateChanged, + params: { + isUnlocked: false, + }, + }); + + // In the current implementation, this handler is triggered by a + // KeyringController event. Other controllers subscribe to the 'lock' + // event of the MetaMaskController itself. + this.emit('lock'); + } + + /** + * Handle memory state updates. + * - Ensure isClientOpenAndUnlocked is updated + * - Notifies all connections with the new provider network state + * - The external providers handle diffing the state + * + * @param newState + */ + _onStateUpdate(newState) { + this.isClientOpenAndUnlocked = newState.isUnlocked && this._isClientOpen; + this._notifyChainChange(); + } + + // misc + + /** + * A method for emitting the full MetaMask state to all registered listeners. + * + * @private + */ + privateSendUpdate() { + this.emit('update', this.getState()); + } + + /** + * @returns {boolean} Whether the extension is unlocked. + */ + isUnlocked() { + return this.keyringController.state.isUnlocked; + } + + //============================================================================= + // MISCELLANEOUS + //============================================================================= + + getExternalPendingTransactions(address) { + return this.smartTransactionsController.getTransactions({ + addressFrom: address, + status: 'pending', + }); + } + + /** + * The chain list is fetched live at runtime, falling back to a cache. + * This preseeds the cache at startup with a static list provided at build. + */ + async initializeChainlist() { + const cacheKey = `cachedFetch:${CHAIN_SPEC_URL}`; + const { cachedResponse } = (await getStorageItem(cacheKey)) || {}; + if (cachedResponse) { + return; + } + await setStorageItem(cacheKey, { + cachedResponse: rawChainData(), + // Cached value is immediately invalidated + cachedTime: 0, + }); + } + + /** + * Returns the nonce that will be associated with a transaction once approved + * + * @param {string} address - The hex string address for the transaction + * @param networkClientId - The optional networkClientId to get the nonce lock with + * @returns {Promise} + */ + async getPendingNonce(address, networkClientId) { + const { nonceDetails, releaseLock } = await this.txController.getNonceLock( + address, + process.env.TRANSACTION_MULTICHAIN ? networkClientId : undefined, + ); + + const pendingNonce = nonceDetails.params.highestSuggested; + + releaseLock(); + return pendingNonce; + } + + /** + * Returns the next nonce according to the nonce-tracker + * + * @param {string} address - The hex string address for the transaction + * @param networkClientId - The optional networkClientId to get the nonce lock with + * @returns {Promise} + */ + async getNextNonce(address, networkClientId) { + const nonceLock = await this.txController.getNonceLock( + address, + process.env.TRANSACTION_MULTICHAIN ? networkClientId : undefined, + ); + nonceLock.releaseLock(); + const nn = nonceLock.nextNonce; + console.log('-- nn --', nn); + return nn; + } + + /** + * Throw an artificial error in a timeout handler for testing purposes. + * + * @param message - The error message. + * @deprecated This is only mean to facilitiate E2E testing. We should not + * use this for handling errors. + */ + throwTestError(message) { + setTimeout(() => { + const error = new Error(message); + error.name = 'TestError'; + throw error; + }); + } + + /** + * A method for setting TransactionController event listeners + */ + _addTransactionControllerListeners() { + const transactionMetricsRequest = this.getTransactionMetricsRequest(); + + this.controllerMessenger.subscribe( + 'TransactionController:postTransactionBalanceUpdated', + handlePostTransactionBalanceUpdate.bind(null, transactionMetricsRequest), + ); + + this.controllerMessenger.subscribe( + 'TransactionController:unapprovedTransactionAdded', + (transactionMeta) => + handleTransactionAdded(transactionMetricsRequest, { transactionMeta }), + ); + + this.controllerMessenger.subscribe( + 'TransactionController:transactionApproved', + handleTransactionApproved.bind(null, transactionMetricsRequest), + ); + + this.controllerMessenger.subscribe( + 'TransactionController:transactionDropped', + handleTransactionDropped.bind(null, transactionMetricsRequest), + ); + + this.controllerMessenger.subscribe( + 'TransactionController:transactionConfirmed', + handleTransactionConfirmed.bind(null, transactionMetricsRequest), + ); + + this.controllerMessenger.subscribe( + 'TransactionController:transactionFailed', + handleTransactionFailed.bind(null, transactionMetricsRequest), + ); + + this.controllerMessenger.subscribe( + 'TransactionController:transactionNewSwap', + ({ transactionMeta }) => + // TODO: This can be called internally by the TransactionController + // since Swaps Controller registers this action handler + this.controllerMessenger.call( + 'SwapsController:setTradeTxId', + transactionMeta.id, + ), + ); + + this.controllerMessenger.subscribe( + 'TransactionController:transactionNewSwapApproval', + ({ transactionMeta }) => + // TODO: This can be called internally by the TransactionController + // since Swaps Controller registers this action handler + this.controllerMessenger.call( + 'SwapsController:setApproveTxId', + transactionMeta.id, + ), + ); + + this.controllerMessenger.subscribe( + 'TransactionController:transactionRejected', + handleTransactionRejected.bind(null, transactionMetricsRequest), + ); + + this.controllerMessenger.subscribe( + 'TransactionController:transactionSubmitted', + handleTransactionSubmitted.bind(null, transactionMetricsRequest), + ); + + this.controllerMessenger.subscribe( + 'TransactionController:transactionStatusUpdated', + ({ transactionMeta }) => { + this._onFinishedTransaction(transactionMeta); + }, + ); + } + + getTransactionMetricsRequest() { + const controllerActions = { + // Metametrics Actions + createEventFragment: this.metaMetricsController.createEventFragment.bind( + this.metaMetricsController, + ), + finalizeEventFragment: + this.metaMetricsController.finalizeEventFragment.bind( + this.metaMetricsController, + ), + getEventFragmentById: + this.metaMetricsController.getEventFragmentById.bind( + this.metaMetricsController, + ), + getParticipateInMetrics: () => + this.metaMetricsController.state.participateInMetaMetrics, + trackEvent: this.metaMetricsController.trackEvent.bind( + this.metaMetricsController, + ), + updateEventFragment: this.metaMetricsController.updateEventFragment.bind( + this.metaMetricsController, + ), + // Other dependencies + getAccountType: this.getAccountType.bind(this), + getDeviceModel: this.getDeviceModel.bind(this), + getEIP1559GasFeeEstimates: + this.gasFeeController.fetchGasFeeEstimates.bind(this.gasFeeController), + getSelectedAddress: () => + this.accountsController.getSelectedAccount().address, + getTokenStandardAndDetails: this.getTokenStandardAndDetails.bind(this), + getTransaction: (id) => + this.txController.state.transactions.find((tx) => tx.id === id), + getIsSmartTransaction: () => { + return getIsSmartTransaction(this._getMetaMaskState()); + }, + getSmartTransactionByMinedTxHash: (txHash) => { + return this.smartTransactionsController.getSmartTransactionByMinedTxHash( + txHash, + ); + }, + getRedesignedConfirmationsEnabled: () => { + return this.preferencesController.getRedesignedConfirmationsEnabled; + }, + getRedesignedTransactionsEnabled: () => { + return this.preferencesController.getRedesignedTransactionsEnabled; + }, + getMethodData: (data) => { + if (!data) { + return null; + } + const { knownMethodData, use4ByteResolution } = + this.preferencesController.state; + const prefixedData = addHexPrefix(data); + return getMethodDataName( + knownMethodData, + use4ByteResolution, + prefixedData, + this.preferencesController.addKnownMethodData.bind( + this.preferencesController, + ), + this.provider, + ); + }, + getIsRedesignedConfirmationsDeveloperEnabled: () => { + return this.preferencesController.state.preferences + .isRedesignedConfirmationsDeveloperEnabled; + }, + getIsConfirmationAdvancedDetailsOpen: () => { + return this.preferencesController.state.preferences + .showConfirmationAdvancedDetails; + }, + }; + return { + ...controllerActions, + snapAndHardwareMessenger: this.controllerMessenger.getRestricted({ + name: 'SnapAndHardwareMessenger', + allowedActions: [ + 'KeyringController:getKeyringForAccount', + 'SnapController:get', + 'AccountsController:getSelectedAccount', + ], + }), + provider: this.provider, + }; + } + + toggleExternalServices(useExternal) { + this.preferencesController.toggleExternalServices(useExternal); + this.tokenListController.updatePreventPollingOnNetworkRestart(!useExternal); + if (useExternal) { + this.tokenDetectionController.enable(); + this.gasFeeController.enableNonRPCGasFeeApis(); + } else { + this.tokenDetectionController.disable(); + this.gasFeeController.disableNonRPCGasFeeApis(); + } + } + + //============================================================================= + // CONFIG + //============================================================================= + + /** + * Sets the Ledger Live preference to use for Ledger hardware wallet support + * + * @param _keyring + * @deprecated This method is deprecated and will be removed in the future. + * Only webhid connections are supported in chrome and u2f in firefox. + */ + async setLedgerTransportPreference(_keyring) { + const transportType = window.navigator.hid + ? LedgerTransportTypes.webhid + : LedgerTransportTypes.u2f; + const keyring = + _keyring || (await this.getKeyringForDevice(HardwareDeviceNames.ledger)); + if (keyring?.updateTransportMethod) { + return keyring.updateTransportMethod(transportType).catch((e) => { + throw e; + }); + } + + return undefined; + } + + /** + * A method for initializing storage the first time. + * + * @param {object} initState - The default state to initialize with. + * @private + */ + recordFirstTimeInfo(initState) { + if (!('firstTimeInfo' in initState)) { + const version = process.env.METAMASK_VERSION; + initState.firstTimeInfo = { + version, + date: Date.now(), + }; + } + } + + // TODO: Replace isClientOpen methods with `controllerConnectionChanged` events. + /* eslint-disable accessor-pairs */ + /** + * A method for recording whether the MetaMask user interface is open or not. + * + * @param {boolean} open + */ + set isClientOpen(open) { + this._isClientOpen = open; + } + /* eslint-enable accessor-pairs */ + + /** + * A method that is called by the background when all instances of metamask are closed. + * Currently used to stop controller polling. + */ + onClientClosed() { + try { + this.gasFeeController.stopAllPolling(); + this.currencyRateController.stopAllPolling(); + this.tokenRatesController.stopAllPolling(); + this.appStateController.clearPollingTokens(); + } catch (error) { + console.error(error); + } + } + + /** + * A method that is called by the background when a particular environment type is closed (fullscreen, popup, notification). + * Currently used to stop polling in the gasFeeController for only that environement type + * + * @param environmentType + */ + onEnvironmentTypeClosed(environmentType) { + const appStatePollingTokenType = + POLLING_TOKEN_ENVIRONMENT_TYPES[environmentType]; + const pollingTokensToDisconnect = + this.appStateController.store.getState()[appStatePollingTokenType]; + pollingTokensToDisconnect.forEach((pollingToken) => { + this.gasFeeController.stopPollingByPollingToken(pollingToken); + this.currencyRateController.stopPollingByPollingToken(pollingToken); + this.appStateController.removePollingToken( + pollingToken, + appStatePollingTokenType, + ); + }); + } + + /** + * Adds a domain to the PhishingController safelist + * + * @param {string} origin - the domain to safelist + */ + safelistPhishingDomain(origin) { + this.metaMetricsController.trackEvent({ + category: MetaMetricsEventCategory.Phishing, + event: MetaMetricsEventName.ProceedAnywayClicked, + properties: { + url: origin, + referrer: { + url: origin, + }, + }, + }); + + return this.phishingController.bypass(origin); + } + + async backToSafetyPhishingWarning() { + const portfolioBaseURL = process.env.PORTFOLIO_URL; + const portfolioURL = `${portfolioBaseURL}/?metamaskEntry=phishing_page_portfolio_button`; + + this.metaMetricsController.trackEvent({ + category: MetaMetricsEventCategory.Navigation, + event: MetaMetricsEventName.PortfolioLinkClicked, + properties: { + location: 'phishing_page', + text: 'Back to safety', + }, + }); + + await this.platform.switchToAnotherURL(undefined, portfolioURL); + } + + /** + * Locks MetaMask + */ + setLocked() { + return this.keyringController.setLocked(); + } + + removePermissionsFor = (subjects) => { + try { + this.permissionController.revokePermissions(subjects); + } catch (exp) { + if (!(exp instanceof PermissionsRequestNotFoundError)) { + throw exp; + } + } + }; + + updateCaveat = (origin, target, caveatType, caveatValue) => { + try { + this.controllerMessenger.call( + 'PermissionController:updateCaveat', + origin, + target, + caveatType, + caveatValue, + ); + } catch (exp) { + if (!(exp instanceof PermissionsRequestNotFoundError)) { + throw exp; + } + } + }; + + updateNetworksList = (chainIds) => { + try { + this.networkOrderController.updateNetworksList(chainIds); + } catch (err) { + log.error(err.message); + throw err; + } + }; + + updateAccountsList = (pinnedAccountList) => { + try { + this.accountOrderController.updateAccountsList(pinnedAccountList); + } catch (err) { + log.error(err.message); + throw err; + } + }; + + updateHiddenAccountsList = (hiddenAccountList) => { + try { + this.accountOrderController.updateHiddenAccountsList(hiddenAccountList); + } catch (err) { + log.error(err.message); + throw err; + } + }; + + rejectPermissionsRequest = (requestId) => { + try { + this.permissionController.rejectPermissionsRequest(requestId); + } catch (exp) { + if (!(exp instanceof PermissionsRequestNotFoundError)) { + throw exp; + } + } + }; + + acceptPermissionsRequest = (request) => { + try { + this.permissionController.acceptPermissionsRequest(request); + } catch (exp) { + if (!(exp instanceof PermissionsRequestNotFoundError)) { + throw exp; + } + } + }; + + resolvePendingApproval = async (id, value, options) => { + try { + await this.approvalController.accept(id, value, options); + } catch (exp) { + if (!(exp instanceof ApprovalRequestNotFoundError)) { + throw exp; + } + } + }; + + rejectPendingApproval = (id, error) => { + try { + this.approvalController.reject( + id, + new JsonRpcError(error.code, error.message, error.data), + ); + } catch (exp) { + if (!(exp instanceof ApprovalRequestNotFoundError)) { + throw exp; + } + } + }; + + async _onAccountChange(newAddress) { + const permittedAccountsMap = getPermittedAccountsByOrigin( + this.permissionController.state, + ); + + for (const [origin, accounts] of permittedAccountsMap.entries()) { + if (accounts.includes(newAddress)) { + this._notifyAccountsChange(origin, accounts); + } + } + + await this.txController.updateIncomingTransactions(); + } + + async _notifyAccountsChange(origin, newAccounts) { + if (this.isUnlocked()) { + this.notifyConnections(origin, { + method: NOTIFICATION_NAMES.accountsChanged, + // This should be the same as the return value of `eth_accounts`, + // namely an array of the current / most recently selected Ethereum + // account. + params: + newAccounts.length < 2 + ? // If the length is 1 or 0, the accounts are sorted by definition. + newAccounts + : // If the length is 2 or greater, we have to execute + // `eth_accounts` vi this method. + await this.getPermittedAccounts(origin), + }); + } + + this.permissionLogController.updateAccountsHistory(origin, newAccounts); + } + + async _notifyChainChange() { + if (this.preferencesController.getUseRequestQueue()) { + this.notifyAllConnections(async (origin) => ({ + method: NOTIFICATION_NAMES.chainChanged, + params: await this.getProviderNetworkState(origin), + })); + } else { + this.notifyAllConnections({ + method: NOTIFICATION_NAMES.chainChanged, + params: await this.getProviderNetworkState(), + }); + } + } + + async _notifyChainChangeForConnection(connection, origin) { + if (this.preferencesController.getUseRequestQueue()) { + this.notifyConnection(connection, { + method: NOTIFICATION_NAMES.chainChanged, + params: await this.getProviderNetworkState(origin), + }); + } else { + this.notifyConnection(connection, { + method: NOTIFICATION_NAMES.chainChanged, + params: await this.getProviderNetworkState(), + }); + } + } + + async _onFinishedTransaction(transactionMeta) { + if ( + ![TransactionStatus.confirmed, TransactionStatus.failed].includes( + transactionMeta.status, + ) + ) { + return; + } + + await this._createTransactionNotifcation(transactionMeta); + await this._updateNFTOwnership(transactionMeta); + this._trackTransactionFailure(transactionMeta); + } + + async _createTransactionNotifcation(transactionMeta) { + const { chainId } = transactionMeta; + let rpcPrefs = {}; + + if (chainId) { + const networkConfiguration = + this.networkController.state.networkConfigurationsByChainId?.[chainId]; + + const blockExplorerUrl = + networkConfiguration?.blockExplorerUrls?.[ + networkConfiguration?.defaultBlockExplorerUrlIndex + ]; + + rpcPrefs = { blockExplorerUrl }; + } + + try { + await this.platform.showTransactionNotification( + transactionMeta, + rpcPrefs, + ); + } catch (error) { + log.error('Failed to create transaction notification', error); + } + } + + async _updateNFTOwnership(transactionMeta) { + // if this is a transferFrom method generated from within the app it may be an NFT transfer transaction + // in which case we will want to check and update ownership status of the transferred NFT. + + const { type, txParams, chainId, txReceipt } = transactionMeta; + const selectedAddress = + this.accountsController.getSelectedAccount().address; + + const { allNfts } = this.nftController.state; + const txReceiptLogs = txReceipt?.logs; + + const isContractInteractionTx = + type === TransactionType.contractInteraction && txReceiptLogs; + const isTransferFromTx = + (type === TransactionType.tokenMethodTransferFrom || + type === TransactionType.tokenMethodSafeTransferFrom) && + txParams !== undefined; + + if (!isContractInteractionTx && !isTransferFromTx) { + return; + } + + if (isTransferFromTx) { + const { data, to: contractAddress, from: userAddress } = txParams; + const transactionData = parseStandardTokenTransactionData(data); + // Sometimes the tokenId value is parsed as "_value" param. Not seeing this often any more, but still occasionally: + // i.e. call approve() on BAYC contract - https://etherscan.io/token/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d#writeContract, and tokenId shows up as _value, + // not sure why since it doesn't match the ERC721 ABI spec we use to parse these transactions - https://github.com/MetaMask/metamask-eth-abis/blob/d0474308a288f9252597b7c93a3a8deaad19e1b2/src/abis/abiERC721.ts#L62. + const transactionDataTokenId = + getTokenIdParam(transactionData) ?? getTokenValueParam(transactionData); + + // check if its a known NFT + const knownNft = allNfts?.[userAddress]?.[chainId]?.find( + ({ address, tokenId }) => + isEqualCaseInsensitive(address, contractAddress) && + tokenId === transactionDataTokenId, + ); + + // if it is we check and update ownership status. + if (knownNft) { + this.nftController.checkAndUpdateSingleNftOwnershipStatus( + knownNft, + false, + // TODO add networkClientId once it is available in the transactionMeta + // the chainId previously passed here didn't actually allow us to check for ownership on a non globally selected network + // because the check would use the provider for the globally selected network, not the chainId passed here. + { userAddress }, + ); + } + } else { + // Else if contract interaction we will parse the logs + + const allNftTransferLog = txReceiptLogs.map((txReceiptLog) => { + const isERC1155NftTransfer = + txReceiptLog.topics && + txReceiptLog.topics[0] === TRANSFER_SINFLE_LOG_TOPIC_HASH; + const isERC721NftTransfer = + txReceiptLog.topics && + txReceiptLog.topics[0] === TOKEN_TRANSFER_LOG_TOPIC_HASH; + let isTransferToSelectedAddress; + + if (isERC1155NftTransfer) { + isTransferToSelectedAddress = + txReceiptLog.topics && + txReceiptLog.topics[3] && + txReceiptLog.topics[3].match(selectedAddress?.slice(2)); + } + + if (isERC721NftTransfer) { + isTransferToSelectedAddress = + txReceiptLog.topics && + txReceiptLog.topics[2] && + txReceiptLog.topics[2].match(selectedAddress?.slice(2)); + } + + return { + isERC1155NftTransfer, + isERC721NftTransfer, + isTransferToSelectedAddress, + ...txReceiptLog, + }; + }); + if (allNftTransferLog.length !== 0) { + const allNftParsedLog = []; + allNftTransferLog.forEach((singleLog) => { + if ( + singleLog.isTransferToSelectedAddress && + (singleLog.isERC1155NftTransfer || singleLog.isERC721NftTransfer) + ) { + let iface; + if (singleLog.isERC1155NftTransfer) { + iface = new Interface(abiERC1155); + } else { + iface = new Interface(abiERC721); + } + try { + const parsedLog = iface.parseLog({ + data: singleLog.data, + topics: singleLog.topics, + }); + allNftParsedLog.push({ + contract: singleLog.address, + ...parsedLog, + }); + } catch (err) { + // ignore + } + } + }); + // Filter known nfts and new Nfts + const knownNFTs = []; + const newNFTs = []; + allNftParsedLog.forEach((single) => { + const tokenIdFromLog = getTokenIdParam(single); + const existingNft = allNfts?.[selectedAddress]?.[chainId]?.find( + ({ address, tokenId }) => { + return ( + isEqualCaseInsensitive(address, single.contract) && + tokenId === tokenIdFromLog + ); + }, + ); + if (existingNft) { + knownNFTs.push(existingNft); + } else { + newNFTs.push({ + tokenId: tokenIdFromLog, + ...single, + }); + } + }); + // For known nfts only refresh ownership + const refreshOwnershipNFts = knownNFTs.map(async (singleNft) => { + return this.nftController.checkAndUpdateSingleNftOwnershipStatus( + singleNft, + false, + // TODO add networkClientId once it is available in the transactionMeta + // the chainId previously passed here didn't actually allow us to check for ownership on a non globally selected network + // because the check would use the provider for the globally selected network, not the chainId passed here. + { selectedAddress }, + ); + }); + await Promise.allSettled(refreshOwnershipNFts); + // For new nfts, add them to state + const addNftPromises = newNFTs.map(async (singleNft) => { + return this.nftController.addNft( + singleNft.contract, + singleNft.tokenId, + ); + }); + await Promise.allSettled(addNftPromises); + } + } + } + + _trackTransactionFailure(transactionMeta) { + const { txReceipt } = transactionMeta; + const metamaskState = this.getState(); + + if (!txReceipt || txReceipt.status !== '0x0') { + return; + } + + this.metaMetricsController.trackEvent( + { + event: 'Tx Status Update: On-Chain Failure', + category: MetaMetricsEventCategory.Background, + properties: { + action: 'Transactions', + errorMessage: transactionMeta.simulationFails?.reason, + numberOfTokens: metamaskState.tokens.length, + numberOfAccounts: Object.keys(metamaskState.accounts).length, + }, + }, + { + matomoEvent: true, + }, + ); + } + + _onUserOperationAdded(userOperationMeta) { + const transactionMeta = this.txController.state.transactions.find( + (tx) => tx.id === userOperationMeta.id, + ); + + if (!transactionMeta) { + return; + } + + if (transactionMeta.type === TransactionType.swap) { + this.controllerMessenger.publish( + 'TransactionController:transactionNewSwap', + { transactionMeta }, + ); + } else if (transactionMeta.type === TransactionType.swapApproval) { + this.controllerMessenger.publish( + 'TransactionController:transactionNewSwapApproval', + { transactionMeta }, + ); + } + } + + _onUserOperationTransactionUpdated(transactionMeta) { + const updatedTransactionMeta = { + ...transactionMeta, + txParams: { + ...transactionMeta.txParams, + from: this.accountsController.getSelectedAccount().address, + }, + }; + + const transactionExists = this.txController.state.transactions.some( + (tx) => tx.id === updatedTransactionMeta.id, + ); + + if (!transactionExists) { + this.txController.update((state) => { + state.transactions.push(updatedTransactionMeta); + }); + } + + this.txController.updateTransaction( + updatedTransactionMeta, + 'Generated from user operation', + ); + + this.controllerMessenger.publish( + 'TransactionController:transactionStatusUpdated', + { transactionMeta: updatedTransactionMeta }, + ); + } + + _publishSmartTransactionHook(transactionMeta, signedTransactionInHex) { + const state = this._getMetaMaskState(); + const isSmartTransaction = getIsSmartTransaction(state); + if (!isSmartTransaction) { + // Will cause TransactionController to publish to the RPC provider as normal. + return { transactionHash: undefined }; + } + const featureFlags = getFeatureFlagsByChainId(state); + return submitSmartTransactionHook({ + transactionMeta, + signedTransactionInHex, + transactionController: this.txController, + smartTransactionsController: this.smartTransactionsController, + controllerMessenger: this.controllerMessenger, + isSmartTransaction, + isHardwareWallet: isHardwareWallet(state), + featureFlags, + }); + } + + _getMetaMaskState() { + return { + metamask: this.getState(), + }; + } + + #checkTokenListPolling(currentState, previousState) { + const previousEnabled = this.#isTokenListPollingRequired(previousState); + const newEnabled = this.#isTokenListPollingRequired(currentState); + + if (previousEnabled === newEnabled) { + return; + } + + this.tokenListController.updatePreventPollingOnNetworkRestart(!newEnabled); + + if (newEnabled) { + log.debug('Started token list controller polling'); + this.tokenListController.start(); + } else { + log.debug('Stopped token list controller polling'); + this.tokenListController.clearingTokenListData(); + this.tokenListController.stop(); + } + } + + #isTokenListPollingRequired(preferencesControllerState) { + const { useTokenDetection, useTransactionSimulations, preferences } = + preferencesControllerState ?? {}; + + const { petnamesEnabled } = preferences ?? {}; + + return useTokenDetection || petnamesEnabled || useTransactionSimulations; + } +} diff --git a/app/scripts/metamask-controller.js b/app/scripts/metamask-controller.js index 5741f54bae9c..89d91f134ae2 100644 --- a/app/scripts/metamask-controller.js +++ b/app/scripts/metamask-controller.js @@ -1999,11 +1999,6 @@ export default class MetamaskController extends EventEmitter { ], }), trace, - decodingApiUrl: - 'https://qtgdj2huxh.execute-api.us-east-2.amazonaws.com/uat/v1', - isDecodeSignatureRequestEnabled: () => - this.preferencesController.state.useExternalServices === true && - this.preferencesController.state.useTransactionSimulations, }); this.signatureController.hub.on( @@ -3325,6 +3320,8 @@ export default class MetamaskController extends EventEmitter { preferencesController.setWatchEthereumAccountEnabled.bind( preferencesController, ), + ///: END:ONLY_INCLUDE_IF + ///: BEGIN:ONLY_INCLUDE_IF(solana) setSolanaSupportEnabled: preferencesController.setSolanaSupportEnabled.bind( preferencesController, @@ -6403,9 +6400,7 @@ export default class MetamaskController extends EventEmitter { process.env.TRANSACTION_MULTICHAIN ? networkClientId : undefined, ); nonceLock.releaseLock(); - const nn = nonceLock.nextNonce; - console.log('-- nn --', nn); - return nn; + return nonceLock.nextNonce; } /** From 4810bdd6cccc4f65e507dea003b119664fabd826 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Fri, 8 Nov 2024 10:42:31 +0530 Subject: [PATCH 05/31] Display native values returned from decoding api --- app/scripts/metamask-controller copy.js | 7218 ----------------------- 1 file changed, 7218 deletions(-) delete mode 100644 app/scripts/metamask-controller copy.js diff --git a/app/scripts/metamask-controller copy.js b/app/scripts/metamask-controller copy.js deleted file mode 100644 index 5741f54bae9c..000000000000 --- a/app/scripts/metamask-controller copy.js +++ /dev/null @@ -1,7218 +0,0 @@ -import EventEmitter from 'events'; -import { finished, pipeline } from 'readable-stream'; -import { - AssetsContractController, - CurrencyRateController, - NftController, - NftDetectionController, - TokenDetectionController, - TokenListController, - TokenRatesController, - TokensController, - CodefiTokenPricesServiceV2, - RatesController, - fetchMultiExchangeRate, -} from '@metamask/assets-controllers'; -import { JsonRpcEngine } from '@metamask/json-rpc-engine'; -import { createEngineStream } from '@metamask/json-rpc-middleware-stream'; -import { ObservableStore } from '@metamask/obs-store'; -import { storeAsStream } from '@metamask/obs-store/dist/asStream'; -import { providerAsMiddleware } from '@metamask/eth-json-rpc-middleware'; -import { debounce, throttle, memoize, wrap } from 'lodash'; -import { - KeyringController, - keyringBuilderFactory, -} from '@metamask/keyring-controller'; -import createFilterMiddleware from '@metamask/eth-json-rpc-filters'; -import createSubscriptionManager from '@metamask/eth-json-rpc-filters/subscriptionManager'; -import { - errorCodes as rpcErrorCodes, - JsonRpcError, - providerErrors, -} from '@metamask/rpc-errors'; - -import { Mutex } from 'await-semaphore'; -import log from 'loglevel'; -import { - TrezorConnectBridge, - TrezorKeyring, -} from '@metamask/eth-trezor-keyring'; -import { - LedgerKeyring, - LedgerIframeBridge, -} from '@metamask/eth-ledger-bridge-keyring'; -import LatticeKeyring from 'eth-lattice-keyring'; -import { rawChainData } from 'eth-chainlist'; -import { MetaMaskKeyring as QRHardwareKeyring } from '@keystonehq/metamask-airgapped-keyring'; -import EthQuery from '@metamask/eth-query'; -import EthJSQuery from '@metamask/ethjs-query'; -import nanoid from 'nanoid'; -import { captureException } from '@sentry/browser'; -import { AddressBookController } from '@metamask/address-book-controller'; -import { - ApprovalController, - ApprovalRequestNotFoundError, -} from '@metamask/approval-controller'; -import { ControllerMessenger } from '@metamask/base-controller'; -import { EnsController } from '@metamask/ens-controller'; -import { PhishingController } from '@metamask/phishing-controller'; -import { AnnouncementController } from '@metamask/announcement-controller'; -import { - NetworkController, - getDefaultNetworkControllerState, -} from '@metamask/network-controller'; -import { GasFeeController } from '@metamask/gas-fee-controller'; -import { - PermissionController, - PermissionDoesNotExistError, - PermissionsRequestNotFoundError, - SubjectMetadataController, - SubjectType, -} from '@metamask/permission-controller'; -import SmartTransactionsController from '@metamask/smart-transactions-controller'; -import { - METAMASK_DOMAIN, - SelectedNetworkController, - createSelectedNetworkMiddleware, -} from '@metamask/selected-network-controller'; -import { LoggingController, LogType } from '@metamask/logging-controller'; -import { PermissionLogController } from '@metamask/permission-log-controller'; - -import { RateLimitController } from '@metamask/rate-limit-controller'; -import { NotificationController } from '@metamask/notification-controller'; -import { - CronjobController, - JsonSnapsRegistry, - SnapController, - IframeExecutionService, - SnapInterfaceController, - SnapInsightsController, - OffscreenExecutionService, -} from '@metamask/snaps-controllers'; -import { - createSnapsMethodMiddleware, - buildSnapEndowmentSpecifications, - buildSnapRestrictedMethodSpecifications, -} from '@metamask/snaps-rpc-methods'; -import { - ApprovalType, - ERC1155, - ERC20, - ERC721, - BlockExplorerUrl, -} from '@metamask/controller-utils'; - -import { AccountsController } from '@metamask/accounts-controller'; - -///: BEGIN:ONLY_INCLUDE_IF(build-mmi) -import { - CUSTODIAN_TYPES, - MmiConfigurationController, -} from '@metamask-institutional/custody-keyring'; -import { InstitutionalFeaturesController } from '@metamask-institutional/institutional-features'; -import { CustodyController } from '@metamask-institutional/custody-controller'; -import { TransactionUpdateController } from '@metamask-institutional/transaction-update'; -///: END:ONLY_INCLUDE_IF -import { SignatureController } from '@metamask/signature-controller'; -import { PPOMController } from '@metamask/ppom-validator'; -import { wordlist } from '@metamask/scure-bip39/dist/wordlists/english'; - -import { - NameController, - ENSNameProvider, - EtherscanNameProvider, - TokenNameProvider, - LensNameProvider, -} from '@metamask/name-controller'; - -import { - QueuedRequestController, - createQueuedRequestMiddleware, -} from '@metamask/queued-request-controller'; - -import { UserOperationController } from '@metamask/user-operation-controller'; - -import { - TransactionController, - TransactionStatus, - TransactionType, -} from '@metamask/transaction-controller'; - -///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) -import { - getLocalizedSnapManifest, - stripSnapPrefix, -} from '@metamask/snaps-utils'; -///: END:ONLY_INCLUDE_IF - -import { Interface } from '@ethersproject/abi'; -import { abiERC1155, abiERC721 } from '@metamask/metamask-eth-abis'; -import { isEvmAccountType } from '@metamask/keyring-api'; -import { - AuthenticationController, - UserStorageController, -} from '@metamask/profile-sync-controller'; -import { - NotificationServicesPushController, - NotificationServicesController, -} from '@metamask/notification-services-controller'; -import { - methodsRequiringNetworkSwitch, - methodsThatCanSwitchNetworkWithoutApproval, - methodsThatShouldBeEnqueued, -} from '../../shared/constants/methods-tags'; - -///: BEGIN:ONLY_INCLUDE_IF(build-mmi) -import { toChecksumHexAddress } from '../../shared/modules/hexstring-utils'; -///: END:ONLY_INCLUDE_IF - -import { AssetType, TokenStandard } from '../../shared/constants/transaction'; -import { - GAS_API_BASE_URL, - GAS_DEV_API_BASE_URL, - SWAPS_CLIENT_ID, -} from '../../shared/constants/swaps'; -import { - CHAIN_IDS, - CHAIN_SPEC_URL, - NETWORK_TYPES, - NetworkStatus, - MAINNET_DISPLAY_NAME, -} from '../../shared/constants/network'; -import { getAllowedSmartTransactionsChainIds } from '../../shared/constants/smartTransactions'; - -import { - HardwareDeviceNames, - LedgerTransportTypes, -} from '../../shared/constants/hardware-wallets'; -import { KeyringType } from '../../shared/constants/keyring'; -import { - CaveatTypes, - RestrictedMethods, - EndowmentPermissions, - ExcludedSnapPermissions, - ExcludedSnapEndowments, -} from '../../shared/constants/permissions'; -import { UI_NOTIFICATIONS } from '../../shared/notifications'; -import { MILLISECOND, SECOND } from '../../shared/constants/time'; -import { - ORIGIN_METAMASK, - POLLING_TOKEN_ENVIRONMENT_TYPES, -} from '../../shared/constants/app'; -import { - MetaMetricsEventCategory, - MetaMetricsEventName, - MetaMetricsUserTrait, -} from '../../shared/constants/metametrics'; -import { LOG_EVENT } from '../../shared/constants/logs'; - -import { - getStorageItem, - setStorageItem, -} from '../../shared/lib/storage-helpers'; -import { - getTokenIdParam, - fetchTokenBalance, - fetchERC1155Balance, -} from '../../shared/lib/token-util'; -import { isEqualCaseInsensitive } from '../../shared/modules/string-utils'; -import { parseStandardTokenTransactionData } from '../../shared/modules/transaction.utils'; -import { STATIC_MAINNET_TOKEN_LIST } from '../../shared/constants/tokens'; -import { getTokenValueParam } from '../../shared/lib/metamask-controller-utils'; -import { isManifestV3 } from '../../shared/modules/mv3.utils'; -import { convertNetworkId } from '../../shared/modules/network.utils'; -import { - getIsSmartTransaction, - isHardwareWallet, - getFeatureFlagsByChainId, - getCurrentChainSupportsSmartTransactions, - getHardwareWalletType, - getSmartTransactionsPreferenceEnabled, -} from '../../shared/modules/selectors'; -import { createCaipStream } from '../../shared/modules/caip-stream'; -import { BaseUrl } from '../../shared/constants/urls'; -import { - TOKEN_TRANSFER_LOG_TOPIC_HASH, - TRANSFER_SINFLE_LOG_TOPIC_HASH, -} from '../../shared/lib/transactions-controller-utils'; -// TODO: Remove restricted import -// eslint-disable-next-line import/no-restricted-paths -import { getCurrentChainId } from '../../ui/selectors'; -// TODO: Remove restricted import -// eslint-disable-next-line import/no-restricted-paths -import { getProviderConfig } from '../../ui/ducks/metamask/metamask'; -import { endTrace, trace } from '../../shared/lib/trace'; -// eslint-disable-next-line import/no-restricted-paths -import { isSnapId } from '../../ui/helpers/utils/snaps'; -import { BalancesController as MultichainBalancesController } from './lib/accounts/BalancesController'; -import { - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - handleMMITransactionUpdate, - ///: END:ONLY_INCLUDE_IF - handleTransactionAdded, - handleTransactionApproved, - handleTransactionFailed, - handleTransactionConfirmed, - handleTransactionDropped, - handleTransactionRejected, - handleTransactionSubmitted, - handlePostTransactionBalanceUpdate, - createTransactionEventFragmentWithTxId, -} from './lib/transaction/metrics'; -///: BEGIN:ONLY_INCLUDE_IF(build-mmi) -import { - afterTransactionSign as afterTransactionSignMMI, - beforeCheckPendingTransaction as beforeCheckPendingTransactionMMI, - beforeTransactionPublish as beforeTransactionPublishMMI, - getAdditionalSignArguments as getAdditionalSignArgumentsMMI, -} from './lib/transaction/mmi-hooks'; -///: END:ONLY_INCLUDE_IF -import { submitSmartTransactionHook } from './lib/transaction/smart-transactions'; -///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) -import { keyringSnapPermissionsBuilder } from './lib/snap-keyring/keyring-snaps-permissions'; -///: END:ONLY_INCLUDE_IF - -import { SnapsNameProvider } from './lib/SnapsNameProvider'; -import { AddressBookPetnamesBridge } from './lib/AddressBookPetnamesBridge'; -import { AccountIdentitiesPetnamesBridge } from './lib/AccountIdentitiesPetnamesBridge'; -import { createPPOMMiddleware } from './lib/ppom/ppom-middleware'; -import * as PPOMModule from './lib/ppom/ppom'; -import { - onMessageReceived, - checkForMultipleVersionsRunning, -} from './detect-multiple-instances'; -///: BEGIN:ONLY_INCLUDE_IF(build-mmi) -import MMIController from './controllers/mmi-controller'; -import { mmiKeyringBuilderFactory } from './mmi-keyring-builder-factory'; -///: END:ONLY_INCLUDE_IF -import ComposableObservableStore from './lib/ComposableObservableStore'; -import AccountTrackerController from './controllers/account-tracker-controller'; -import createDupeReqFilterStream from './lib/createDupeReqFilterStream'; -import createLoggerMiddleware from './lib/createLoggerMiddleware'; -import { - createLegacyMethodMiddleware, - createMethodMiddleware, - createUnsupportedMethodMiddleware, -} from './lib/rpc-method-middleware'; -import createOriginMiddleware from './lib/createOriginMiddleware'; -import createTabIdMiddleware from './lib/createTabIdMiddleware'; -import { NetworkOrderController } from './controllers/network-order'; -import { AccountOrderController } from './controllers/account-order'; -import createOnboardingMiddleware from './lib/createOnboardingMiddleware'; -import { isStreamWritable, setupMultiplex } from './lib/stream-utils'; -import { PreferencesController } from './controllers/preferences-controller'; -import { AppStateController } from './controllers/app-state-controller'; -import { AlertController } from './controllers/alert-controller'; -import OnboardingController from './controllers/onboarding'; -import Backup from './lib/backup'; -import DecryptMessageController from './controllers/decrypt-message'; -import SwapsController from './controllers/swaps'; -import MetaMetricsController from './controllers/metametrics'; -import { segment } from './lib/segment'; -import createMetaRPCHandler from './lib/createMetaRPCHandler'; -import { - addHexPrefix, - getMethodDataName, - previousValueComparator, -} from './lib/util'; -import createMetamaskMiddleware from './lib/createMetamaskMiddleware'; -import { hardwareKeyringBuilderFactory } from './lib/hardware-keyring-builder-factory'; -import EncryptionPublicKeyController from './controllers/encryption-public-key'; -import AppMetadataController from './controllers/app-metadata'; - -import { - CaveatFactories, - CaveatMutatorFactories, - getCaveatSpecifications, - diffMap, - getPermissionBackgroundApiMethods, - getPermissionSpecifications, - getPermittedAccountsByOrigin, - getPermittedChainsByOrigin, - NOTIFICATION_NAMES, - PermissionNames, - unrestrictedMethods, -} from './controllers/permissions'; -import { MetaMetricsDataDeletionController } from './controllers/metametrics-data-deletion/metametrics-data-deletion'; -import { DataDeletionService } from './services/data-deletion-service'; -import createRPCMethodTrackingMiddleware from './lib/createRPCMethodTrackingMiddleware'; -import { IndexedDBPPOMStorage } from './lib/ppom/indexed-db-backend'; -import { updateCurrentLocale } from './translate'; -import { TrezorOffscreenBridge } from './lib/offscreen-bridge/trezor-offscreen-bridge'; -import { LedgerOffscreenBridge } from './lib/offscreen-bridge/ledger-offscreen-bridge'; -///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) -import { snapKeyringBuilder, getAccountsBySnapId } from './lib/snap-keyring'; -///: END:ONLY_INCLUDE_IF -import { encryptorFactory } from './lib/encryptor-factory'; -import { addDappTransaction, addTransaction } from './lib/transaction/util'; -///: BEGIN:ONLY_INCLUDE_IF(build-main,build-beta,build-flask) -import { addTypedMessage, addPersonalMessage } from './lib/signature/util'; -///: END:ONLY_INCLUDE_IF -import { LatticeKeyringOffscreen } from './lib/offscreen-bridge/lattice-offscreen-keyring'; -import PREINSTALLED_SNAPS from './snaps/preinstalled-snaps'; -import { WeakRefObjectMap } from './lib/WeakRefObjectMap'; -import { METAMASK_COOKIE_HANDLER } from './constants/stream'; - -// Notification controllers -import { createTxVerificationMiddleware } from './lib/tx-verification/tx-verification-middleware'; -import { updateSecurityAlertResponse } from './lib/ppom/ppom-util'; -import createEvmMethodsToNonEvmAccountReqFilterMiddleware from './lib/createEvmMethodsToNonEvmAccountReqFilterMiddleware'; -import { isEthAddress } from './lib/multichain/address'; -import { decodeTransactionData } from './lib/transaction/decode/util'; -import { - BridgeUserAction, - BridgeBackgroundAction, -} from './controllers/bridge/types'; -import BridgeController from './controllers/bridge/bridge-controller'; -import { BRIDGE_CONTROLLER_NAME } from './controllers/bridge/constants'; -import { - onPushNotificationClicked, - onPushNotificationReceived, -} from './controllers/push-notifications'; -import createTracingMiddleware from './lib/createTracingMiddleware'; -import { PatchStore } from './lib/PatchStore'; -import { sanitizeUIState } from './lib/state-utils'; - -export const METAMASK_CONTROLLER_EVENTS = { - // Fired after state changes that impact the extension badge (unapproved msg count) - // The process of updating the badge happens in app/scripts/background.js. - UPDATE_BADGE: 'updateBadge', - // TODO: Add this and similar enums to the `controllers` repo and export them - APPROVAL_STATE_CHANGE: 'ApprovalController:stateChange', - QUEUED_REQUEST_STATE_CHANGE: 'QueuedRequestController:stateChange', - METAMASK_NOTIFICATIONS_LIST_UPDATED: - 'NotificationServicesController:notificationsListUpdated', - METAMASK_NOTIFICATIONS_MARK_AS_READ: - 'NotificationServicesController:markNotificationsAsRead', - NOTIFICATIONS_STATE_CHANGE: 'NotificationController:stateChange', -}; - -// stream channels -const PHISHING_SAFELIST = 'metamask-phishing-safelist'; - -// OneKey devices can connect to Metamask using Trezor USB transport. They use a specific device minor version (99) to differentiate between genuine Trezor and OneKey devices. -export const ONE_KEY_VIA_TREZOR_MINOR_VERSION = 99; - -export default class MetamaskController extends EventEmitter { - /** - * @param {object} opts - */ - constructor(opts) { - super(); - - const { isFirstMetaMaskControllerSetup } = opts; - - this.defaultMaxListeners = 20; - - this.sendUpdate = debounce( - this.privateSendUpdate.bind(this), - MILLISECOND * 200, - ); - this.opts = opts; - this.extension = opts.browser; - this.platform = opts.platform; - this.notificationManager = opts.notificationManager; - const initState = opts.initState || {}; - const version = process.env.METAMASK_VERSION; - this.recordFirstTimeInfo(initState); - this.featureFlags = opts.featureFlags; - - // this keeps track of how many "controllerStream" connections are open - // the only thing that uses controller connections are open metamask UI instances - this.activeControllerConnections = 0; - - this.offscreenPromise = opts.offscreenPromise ?? Promise.resolve(); - - this.getRequestAccountTabIds = opts.getRequestAccountTabIds; - this.getOpenMetamaskTabsIds = opts.getOpenMetamaskTabsIds; - - this.initializeChainlist(); - - this.controllerMessenger = new ControllerMessenger(); - - this.loggingController = new LoggingController({ - messenger: this.controllerMessenger.getRestricted({ - name: 'LoggingController', - allowedActions: [], - allowedEvents: [], - }), - state: initState.LoggingController, - }); - - // instance of a class that wraps the extension's storage local API. - this.localStoreApiWrapper = opts.localStore; - - this.currentMigrationVersion = opts.currentMigrationVersion; - - // observable state store - this.store = new ComposableObservableStore({ - state: initState, - controllerMessenger: this.controllerMessenger, - persist: true, - }); - - // external connections by origin - // Do not modify directly. Use the associated methods. - this.connections = {}; - - // lock to ensure only one vault created at once - this.createVaultMutex = new Mutex(); - - this.extension.runtime.onInstalled.addListener((details) => { - if (details.reason === 'update') { - if (version === '8.1.0') { - this.platform.openExtensionInBrowser(); - } - this.loggingController.add({ - type: LogType.GenericLog, - data: { - event: LOG_EVENT.VERSION_UPDATE, - previousVersion: details.previousVersion, - version, - }, - }); - } - }); - - this.appMetadataController = new AppMetadataController({ - state: initState.AppMetadataController, - currentMigrationVersion: this.currentMigrationVersion, - currentAppVersion: version, - }); - - // next, we will initialize the controllers - // controller initialization order matters - const clearPendingConfirmations = () => { - this.encryptionPublicKeyController.clearUnapproved(); - this.decryptMessageController.clearUnapproved(); - this.signatureController.clearUnapproved(); - this.approvalController.clear(providerErrors.userRejectedRequest()); - }; - - this.approvalController = new ApprovalController({ - messenger: this.controllerMessenger.getRestricted({ - name: 'ApprovalController', - }), - showApprovalRequest: opts.showUserConfirmation, - typesExcludedFromRateLimiting: [ - ApprovalType.PersonalSign, - ApprovalType.EthSignTypedData, - ApprovalType.Transaction, - ApprovalType.WatchAsset, - ApprovalType.EthGetEncryptionPublicKey, - ApprovalType.EthDecrypt, - ], - }); - - this.queuedRequestController = new QueuedRequestController({ - messenger: this.controllerMessenger.getRestricted({ - name: 'QueuedRequestController', - allowedActions: [ - 'NetworkController:getState', - 'NetworkController:setActiveNetwork', - 'SelectedNetworkController:getNetworkClientIdForDomain', - ], - allowedEvents: ['SelectedNetworkController:stateChange'], - }), - shouldRequestSwitchNetwork: ({ method }) => - methodsRequiringNetworkSwitch.includes(method), - canRequestSwitchNetworkWithoutApproval: ({ method }) => - methodsThatCanSwitchNetworkWithoutApproval.includes(method), - clearPendingConfirmations, - showApprovalRequest: () => { - if (this.approvalController.getTotalApprovalCount() > 0) { - opts.showUserConfirmation(); - } - }, - }); - - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - this.mmiConfigurationController = new MmiConfigurationController({ - initState: initState.MmiConfigurationController, - mmiConfigurationServiceUrl: process.env.MMI_CONFIGURATION_SERVICE_URL, - }); - ///: END:ONLY_INCLUDE_IF - - const networkControllerMessenger = this.controllerMessenger.getRestricted({ - name: 'NetworkController', - }); - - let initialNetworkControllerState = initState.NetworkController; - if (!initialNetworkControllerState) { - initialNetworkControllerState = getDefaultNetworkControllerState(); - - const networks = - initialNetworkControllerState.networkConfigurationsByChainId; - - // Note: Consider changing `getDefaultNetworkControllerState` - // on the controller side to include some of these tweaks. - networks[CHAIN_IDS.MAINNET].name = MAINNET_DISPLAY_NAME; - delete networks[CHAIN_IDS.GOERLI]; - delete networks[CHAIN_IDS.LINEA_GOERLI]; - - Object.values(networks).forEach((network) => { - const id = network.rpcEndpoints[0].networkClientId; - network.blockExplorerUrls = [BlockExplorerUrl[id]]; - network.defaultBlockExplorerUrlIndex = 0; - }); - - let network; - if (process.env.IN_TEST) { - network = { - chainId: CHAIN_IDS.LOCALHOST, - name: 'Localhost 8545', - nativeCurrency: 'ETH', - blockExplorerUrls: [], - defaultRpcEndpointIndex: 0, - rpcEndpoints: [ - { - networkClientId: 'networkConfigurationId', - url: 'http://localhost:8545', - type: 'custom', - }, - ], - }; - networks[CHAIN_IDS.LOCALHOST] = network; - } else if ( - process.env.METAMASK_DEBUG || - process.env.METAMASK_ENVIRONMENT === 'test' - ) { - network = networks[CHAIN_IDS.SEPOLIA]; - } else { - network = networks[CHAIN_IDS.MAINNET]; - } - - initialNetworkControllerState.selectedNetworkClientId = - network.rpcEndpoints[network.defaultRpcEndpointIndex].networkClientId; - } - - this.networkController = new NetworkController({ - messenger: networkControllerMessenger, - state: initialNetworkControllerState, - infuraProjectId: opts.infuraProjectId, - }); - this.networkController.initializeProvider(); - this.provider = - this.networkController.getProviderAndBlockTracker().provider; - this.blockTracker = - this.networkController.getProviderAndBlockTracker().blockTracker; - this.deprecatedNetworkVersions = {}; - - const accountsControllerMessenger = this.controllerMessenger.getRestricted({ - name: 'AccountsController', - allowedEvents: [ - 'SnapController:stateChange', - 'KeyringController:accountRemoved', - 'KeyringController:stateChange', - ], - allowedActions: [ - 'KeyringController:getAccounts', - 'KeyringController:getKeyringsByType', - 'KeyringController:getKeyringForAccount', - ], - }); - - this.accountsController = new AccountsController({ - messenger: accountsControllerMessenger, - state: initState.AccountsController, - }); - - const preferencesMessenger = this.controllerMessenger.getRestricted({ - name: 'PreferencesController', - allowedActions: [ - 'AccountsController:setSelectedAccount', - 'AccountsController:getSelectedAccount', - 'AccountsController:getAccountByAddress', - 'AccountsController:setAccountName', - 'NetworkController:getState', - ], - allowedEvents: ['AccountsController:stateChange'], - }); - - this.preferencesController = new PreferencesController({ - state: { - currentLocale: opts.initLangCode ?? '', - ...initState.PreferencesController, - }, - messenger: preferencesMessenger, - }); - - const tokenListMessenger = this.controllerMessenger.getRestricted({ - name: 'TokenListController', - allowedActions: ['NetworkController:getNetworkClientById'], - allowedEvents: ['NetworkController:stateChange'], - }); - - this.tokenListController = new TokenListController({ - chainId: getCurrentChainId({ metamask: this.networkController.state }), - preventPollingOnNetworkRestart: !this.#isTokenListPollingRequired( - this.preferencesController.state, - ), - messenger: tokenListMessenger, - state: initState.TokenListController, - }); - - const assetsContractControllerMessenger = - this.controllerMessenger.getRestricted({ - name: 'AssetsContractController', - allowedActions: [ - 'NetworkController:getNetworkClientById', - 'NetworkController:getNetworkConfigurationByNetworkClientId', - 'NetworkController:getSelectedNetworkClient', - 'NetworkController:getState', - ], - allowedEvents: [ - 'PreferencesController:stateChange', - 'NetworkController:networkDidChange', - ], - }); - this.assetsContractController = new AssetsContractController({ - messenger: assetsContractControllerMessenger, - chainId: getCurrentChainId({ metamask: this.networkController.state }), - }); - - const tokensControllerMessenger = this.controllerMessenger.getRestricted({ - name: 'TokensController', - allowedActions: [ - 'ApprovalController:addRequest', - 'NetworkController:getNetworkClientById', - 'AccountsController:getSelectedAccount', - 'AccountsController:getAccount', - ], - allowedEvents: [ - 'NetworkController:networkDidChange', - 'AccountsController:selectedEvmAccountChange', - 'PreferencesController:stateChange', - 'TokenListController:stateChange', - ], - }); - this.tokensController = new TokensController({ - state: initState.TokensController, - provider: this.provider, - messenger: tokensControllerMessenger, - chainId: getCurrentChainId({ metamask: this.networkController.state }), - }); - - const nftControllerMessenger = this.controllerMessenger.getRestricted({ - name: 'NftController', - allowedEvents: [ - 'PreferencesController:stateChange', - 'NetworkController:networkDidChange', - 'AccountsController:selectedEvmAccountChange', - ], - allowedActions: [ - `${this.approvalController.name}:addRequest`, - `${this.networkController.name}:getNetworkClientById`, - 'AccountsController:getSelectedAccount', - 'AccountsController:getAccount', - 'AssetsContractController:getERC721AssetName', - 'AssetsContractController:getERC721AssetSymbol', - 'AssetsContractController:getERC721TokenURI', - 'AssetsContractController:getERC721OwnerOf', - 'AssetsContractController:getERC1155BalanceOf', - 'AssetsContractController:getERC1155TokenURI', - ], - }); - this.nftController = new NftController({ - state: initState.NftController, - messenger: nftControllerMessenger, - chainId: getCurrentChainId({ metamask: this.networkController.state }), - onNftAdded: ({ address, symbol, tokenId, standard, source }) => - this.metaMetricsController.trackEvent({ - event: MetaMetricsEventName.NftAdded, - category: MetaMetricsEventCategory.Wallet, - sensitiveProperties: { - token_contract_address: address, - token_symbol: symbol, - token_id: tokenId, - token_standard: standard, - asset_type: AssetType.NFT, - source, - }, - }), - }); - - this.nftController.setApiKey(process.env.OPENSEA_KEY); - - const nftDetectionControllerMessenger = - this.controllerMessenger.getRestricted({ - name: 'NftDetectionController', - allowedEvents: [ - 'NetworkController:stateChange', - 'PreferencesController:stateChange', - ], - allowedActions: [ - 'ApprovalController:addRequest', - 'NetworkController:getState', - 'NetworkController:getNetworkClientById', - 'AccountsController:getSelectedAccount', - ], - }); - - this.nftDetectionController = new NftDetectionController({ - messenger: nftDetectionControllerMessenger, - chainId: getCurrentChainId({ metamask: this.networkController.state }), - getOpenSeaApiKey: () => this.nftController.openSeaApiKey, - getBalancesInSingleCall: - this.assetsContractController.getBalancesInSingleCall.bind( - this.assetsContractController, - ), - addNft: this.nftController.addNft.bind(this.nftController), - getNftState: () => this.nftController.state, - // added this to track previous value of useNftDetection, should be true on very first initializing of controller[] - disabled: !this.preferencesController.state.useNftDetection, - }); - - this.metaMetricsController = new MetaMetricsController({ - initState: initState.MetaMetricsController, - segment, - preferencesControllerState: { - currentLocale: this.preferencesController.state.currentLocale, - selectedAddress: this.preferencesController.state.selectedAddress, - }, - onPreferencesStateChange: preferencesMessenger.subscribe.bind( - preferencesMessenger, - 'PreferencesController:stateChange', - ), - onNetworkDidChange: networkControllerMessenger.subscribe.bind( - networkControllerMessenger, - 'NetworkController:networkDidChange', - ), - getCurrentChainId: () => - getCurrentChainId({ metamask: this.networkController.state }), - version: process.env.METAMASK_VERSION, - environment: process.env.METAMASK_ENVIRONMENT, - extension: this.extension, - captureException, - }); - - this.on('update', (update) => { - this.metaMetricsController.handleMetaMaskStateUpdate(update); - }); - - const dataDeletionService = new DataDeletionService(); - const metaMetricsDataDeletionMessenger = - this.controllerMessenger.getRestricted({ - name: 'MetaMetricsDataDeletionController', - }); - this.metaMetricsDataDeletionController = - new MetaMetricsDataDeletionController({ - dataDeletionService, - messenger: metaMetricsDataDeletionMessenger, - state: initState.metaMetricsDataDeletionController, - getMetaMetricsId: () => this.metaMetricsController.state.metaMetricsId, - }); - - const gasFeeMessenger = this.controllerMessenger.getRestricted({ - name: 'GasFeeController', - allowedActions: [ - 'NetworkController:getEIP1559Compatibility', - 'NetworkController:getNetworkClientById', - 'NetworkController:getState', - ], - allowedEvents: ['NetworkController:stateChange'], - }); - - const gasApiBaseUrl = process.env.SWAPS_USE_DEV_APIS - ? GAS_DEV_API_BASE_URL - : GAS_API_BASE_URL; - - this.gasFeeController = new GasFeeController({ - state: initState.GasFeeController, - interval: 10000, - messenger: gasFeeMessenger, - clientId: SWAPS_CLIENT_ID, - getProvider: () => - this.networkController.getProviderAndBlockTracker().provider, - onNetworkDidChange: (eventHandler) => { - networkControllerMessenger.subscribe( - 'NetworkController:networkDidChange', - () => eventHandler(this.networkController.state), - ); - }, - getCurrentNetworkEIP1559Compatibility: - this.networkController.getEIP1559Compatibility.bind( - this.networkController, - ), - getCurrentAccountEIP1559Compatibility: - this.getCurrentAccountEIP1559Compatibility.bind(this), - legacyAPIEndpoint: `${gasApiBaseUrl}/networks//gasPrices`, - EIP1559APIEndpoint: `${gasApiBaseUrl}/networks//suggestedGasFees`, - getCurrentNetworkLegacyGasAPICompatibility: () => { - const chainId = getCurrentChainId({ - metamask: this.networkController.state, - }); - return chainId === CHAIN_IDS.BSC; - }, - getChainId: () => - getCurrentChainId({ metamask: this.networkController.state }), - }); - - this.appStateController = new AppStateController({ - addUnlockListener: this.on.bind(this, 'unlock'), - isUnlocked: this.isUnlocked.bind(this), - initState: initState.AppStateController, - onInactiveTimeout: () => this.setLocked(), - messenger: this.controllerMessenger.getRestricted({ - name: 'AppStateController', - allowedActions: [ - `${this.approvalController.name}:addRequest`, - `${this.approvalController.name}:acceptRequest`, - `PreferencesController:getState`, - ], - allowedEvents: [ - `KeyringController:qrKeyringStateChange`, - 'PreferencesController:stateChange', - ], - }), - extension: this.extension, - }); - - const currencyRateMessenger = this.controllerMessenger.getRestricted({ - name: 'CurrencyRateController', - allowedActions: [`${this.networkController.name}:getNetworkClientById`], - }); - this.currencyRateController = new CurrencyRateController({ - includeUsdRate: true, - messenger: currencyRateMessenger, - state: initState.CurrencyController, - }); - const initialFetchMultiExchangeRate = - this.currencyRateController.fetchMultiExchangeRate.bind( - this.currencyRateController, - ); - this.currencyRateController.fetchMultiExchangeRate = (...args) => { - if (this.preferencesController.state.useCurrencyRateCheck) { - return initialFetchMultiExchangeRate(...args); - } - return { - conversionRate: null, - usdConversionRate: null, - }; - }; - - const phishingControllerMessenger = this.controllerMessenger.getRestricted({ - name: 'PhishingController', - }); - - this.phishingController = new PhishingController({ - messenger: phishingControllerMessenger, - state: initState.PhishingController, - hotlistRefreshInterval: process.env.IN_TEST ? 5 * SECOND : undefined, - stalelistRefreshInterval: process.env.IN_TEST ? 30 * SECOND : undefined, - }); - - this.ppomController = new PPOMController({ - messenger: this.controllerMessenger.getRestricted({ - name: 'PPOMController', - allowedEvents: [ - 'NetworkController:stateChange', - 'NetworkController:networkDidChange', - ], - allowedActions: ['NetworkController:getNetworkClientById'], - }), - storageBackend: new IndexedDBPPOMStorage('PPOMDB', 1), - provider: this.provider, - ppomProvider: { - PPOM: PPOMModule.PPOM, - ppomInit: () => PPOMModule.default(process.env.PPOM_URI), - }, - state: initState.PPOMController, - chainId: getCurrentChainId({ metamask: this.networkController.state }), - securityAlertsEnabled: - this.preferencesController.state.securityAlertsEnabled, - onPreferencesChange: preferencesMessenger.subscribe.bind( - preferencesMessenger, - 'PreferencesController:stateChange', - ), - cdnBaseUrl: process.env.BLOCKAID_FILE_CDN, - blockaidPublicKey: process.env.BLOCKAID_PUBLIC_KEY, - }); - - const announcementMessenger = this.controllerMessenger.getRestricted({ - name: 'AnnouncementController', - }); - - this.announcementController = new AnnouncementController({ - messenger: announcementMessenger, - allAnnouncements: UI_NOTIFICATIONS, - state: initState.AnnouncementController, - }); - - const networkOrderMessenger = this.controllerMessenger.getRestricted({ - name: 'NetworkOrderController', - allowedEvents: ['NetworkController:stateChange'], - }); - this.networkOrderController = new NetworkOrderController({ - messenger: networkOrderMessenger, - state: initState.NetworkOrderController, - }); - - const accountOrderMessenger = this.controllerMessenger.getRestricted({ - name: 'AccountOrderController', - }); - this.accountOrderController = new AccountOrderController({ - messenger: accountOrderMessenger, - state: initState.AccountOrderController, - }); - - const multichainBalancesControllerMessenger = - this.controllerMessenger.getRestricted({ - name: 'BalancesController', - allowedEvents: [ - 'AccountsController:accountAdded', - 'AccountsController:accountRemoved', - ], - allowedActions: [ - 'AccountsController:listMultichainAccounts', - 'SnapController:handleRequest', - ], - }); - - this.multichainBalancesController = new MultichainBalancesController({ - messenger: multichainBalancesControllerMessenger, - state: initState.MultichainBalancesController, - }); - - const multichainRatesControllerMessenger = - this.controllerMessenger.getRestricted({ - name: 'RatesController', - }); - this.multichainRatesController = new RatesController({ - state: initState.MultichainRatesController, - messenger: multichainRatesControllerMessenger, - includeUsdRate: true, - fetchMultiExchangeRate, - }); - - const tokenRatesMessenger = this.controllerMessenger.getRestricted({ - name: 'TokenRatesController', - allowedActions: [ - 'TokensController:getState', - 'NetworkController:getNetworkClientById', - 'NetworkController:getState', - 'AccountsController:getAccount', - 'AccountsController:getSelectedAccount', - ], - allowedEvents: [ - 'NetworkController:stateChange', - 'AccountsController:selectedEvmAccountChange', - 'PreferencesController:stateChange', - 'TokensController:stateChange', - ], - }); - - // token exchange rate tracker - this.tokenRatesController = new TokenRatesController({ - state: initState.TokenRatesController, - messenger: tokenRatesMessenger, - tokenPricesService: new CodefiTokenPricesServiceV2(), - disabled: !this.preferencesController.state.useCurrencyRateCheck, - }); - - this.controllerMessenger.subscribe( - 'PreferencesController:stateChange', - previousValueComparator((prevState, currState) => { - const { useCurrencyRateCheck: prevUseCurrencyRateCheck } = prevState; - const { useCurrencyRateCheck: currUseCurrencyRateCheck } = currState; - if (currUseCurrencyRateCheck && !prevUseCurrencyRateCheck) { - this.tokenRatesController.enable(); - } else if (!currUseCurrencyRateCheck && prevUseCurrencyRateCheck) { - this.tokenRatesController.disable(); - } - }, this.preferencesController.state), - ); - - this.ensController = new EnsController({ - messenger: this.controllerMessenger.getRestricted({ - name: 'EnsController', - allowedActions: ['NetworkController:getNetworkClientById'], - allowedEvents: [], - }), - provider: this.provider, - onNetworkDidChange: networkControllerMessenger.subscribe.bind( - networkControllerMessenger, - 'NetworkController:networkDidChange', - ), - }); - - const onboardingControllerMessenger = - this.controllerMessenger.getRestricted({ - name: 'OnboardingController', - allowedActions: [], - allowedEvents: [], - }); - this.onboardingController = new OnboardingController({ - messenger: onboardingControllerMessenger, - state: initState.OnboardingController, - }); - - let additionalKeyrings = [keyringBuilderFactory(QRHardwareKeyring)]; - - const keyringOverrides = this.opts.overrides?.keyrings; - - if (isManifestV3 === false) { - const additionalKeyringTypes = [ - keyringOverrides?.lattice || LatticeKeyring, - QRHardwareKeyring, - ]; - - const additionalBridgedKeyringTypes = [ - { - keyring: keyringOverrides?.trezor || TrezorKeyring, - bridge: keyringOverrides?.trezorBridge || TrezorConnectBridge, - }, - { - keyring: keyringOverrides?.ledger || LedgerKeyring, - bridge: keyringOverrides?.ledgerBridge || LedgerIframeBridge, - }, - ]; - - additionalKeyrings = additionalKeyringTypes.map((keyringType) => - keyringBuilderFactory(keyringType), - ); - - additionalBridgedKeyringTypes.forEach((keyringType) => - additionalKeyrings.push( - hardwareKeyringBuilderFactory( - keyringType.keyring, - keyringType.bridge, - ), - ), - ); - } else { - additionalKeyrings.push( - hardwareKeyringBuilderFactory( - TrezorKeyring, - keyringOverrides?.trezorBridge || TrezorOffscreenBridge, - ), - hardwareKeyringBuilderFactory( - LedgerKeyring, - keyringOverrides?.ledgerBridge || LedgerOffscreenBridge, - ), - keyringBuilderFactory(LatticeKeyringOffscreen), - ); - } - - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - for (const custodianType of Object.keys(CUSTODIAN_TYPES)) { - additionalKeyrings.push( - mmiKeyringBuilderFactory(CUSTODIAN_TYPES[custodianType].keyringClass, { - mmiConfigurationController: this.mmiConfigurationController, - captureException, - }), - ); - } - ///: END:ONLY_INCLUDE_IF - - ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) - const snapKeyringBuildMessenger = this.controllerMessenger.getRestricted({ - name: 'SnapKeyringBuilder', - allowedActions: [ - 'ApprovalController:addRequest', - 'ApprovalController:acceptRequest', - 'ApprovalController:rejectRequest', - 'ApprovalController:startFlow', - 'ApprovalController:endFlow', - 'ApprovalController:showSuccess', - 'ApprovalController:showError', - 'PhishingController:test', - 'PhishingController:maybeUpdateState', - 'KeyringController:getAccounts', - 'AccountsController:setSelectedAccount', - 'AccountsController:getAccountByAddress', - 'AccountsController:setAccountName', - ], - }); - - const getSnapController = () => this.snapController; - - // Necessary to persist the keyrings and update the accounts both within the keyring controller and accounts controller - const persistAndUpdateAccounts = async () => { - await this.keyringController.persistAllKeyrings(); - await this.accountsController.updateAccounts(); - }; - - const getSnapName = (id) => { - if (!id) { - return null; - } - - const currentLocale = this.getLocale(); - const { snaps } = this.snapController.state; - const snap = snaps[id]; - - if (!snap) { - return stripSnapPrefix(id); - } - - if (snap.localizationFiles) { - const localizedManifest = getLocalizedSnapManifest( - snap.manifest, - currentLocale, - snap.localizationFiles, - ); - return localizedManifest.proposedName; - } - - return snap.manifest.proposedName; - }; - - const isSnapPreinstalled = (id) => { - return PREINSTALLED_SNAPS.some((snap) => snap.snapId === id); - }; - - additionalKeyrings.push( - snapKeyringBuilder( - snapKeyringBuildMessenger, - getSnapController, - persistAndUpdateAccounts, - (address) => this.removeAccount(address), - this.metaMetricsController.trackEvent.bind(this.metaMetricsController), - getSnapName, - isSnapPreinstalled, - ), - ); - - ///: END:ONLY_INCLUDE_IF - - const keyringControllerMessenger = this.controllerMessenger.getRestricted({ - name: 'KeyringController', - }); - - this.keyringController = new KeyringController({ - cacheEncryptionKey: true, - keyringBuilders: additionalKeyrings, - state: initState.KeyringController, - encryptor: opts.encryptor || encryptorFactory(600_000), - messenger: keyringControllerMessenger, - }); - - this.controllerMessenger.subscribe('KeyringController:unlock', () => - this._onUnlock(), - ); - this.controllerMessenger.subscribe('KeyringController:lock', () => - this._onLock(), - ); - - this.controllerMessenger.subscribe( - 'KeyringController:stateChange', - (state) => { - this._onKeyringControllerUpdate(state); - }, - ); - - this.permissionController = new PermissionController({ - messenger: this.controllerMessenger.getRestricted({ - name: 'PermissionController', - allowedActions: [ - `${this.approvalController.name}:addRequest`, - `${this.approvalController.name}:hasRequest`, - `${this.approvalController.name}:acceptRequest`, - `${this.approvalController.name}:rejectRequest`, - `SnapController:getPermitted`, - `SnapController:install`, - `SubjectMetadataController:getSubjectMetadata`, - ], - }), - state: initState.PermissionController, - caveatSpecifications: getCaveatSpecifications({ - getInternalAccounts: this.accountsController.listAccounts.bind( - this.accountsController, - ), - findNetworkClientIdByChainId: - this.networkController.findNetworkClientIdByChainId.bind( - this.networkController, - ), - }), - permissionSpecifications: { - ...getPermissionSpecifications({ - getInternalAccounts: this.accountsController.listAccounts.bind( - this.accountsController, - ), - getAllAccounts: this.keyringController.getAccounts.bind( - this.keyringController, - ), - captureKeyringTypesWithMissingIdentities: ( - internalAccounts = [], - accounts = [], - ) => { - const accountsMissingIdentities = accounts.filter( - (address) => - !internalAccounts.some( - (account) => - account.address.toLowerCase() === address.toLowerCase(), - ), - ); - const keyringTypesWithMissingIdentities = - accountsMissingIdentities.map((address) => - this.keyringController.getAccountKeyringType(address), - ); - - const internalAccountCount = internalAccounts.length; - - const accountTrackerCount = Object.keys( - this.accountTrackerController.state.accounts || {}, - ).length; - - captureException( - new Error( - `Attempt to get permission specifications failed because their were ${accounts.length} accounts, but ${internalAccountCount} identities, and the ${keyringTypesWithMissingIdentities} keyrings included accounts with missing identities. Meanwhile, there are ${accountTrackerCount} accounts in the account tracker.`, - ), - ); - }, - }), - ...this.getSnapPermissionSpecifications(), - }, - unrestrictedMethods, - }); - - this.selectedNetworkController = new SelectedNetworkController({ - messenger: this.controllerMessenger.getRestricted({ - name: 'SelectedNetworkController', - allowedActions: [ - 'NetworkController:getNetworkClientById', - 'NetworkController:getState', - 'NetworkController:getSelectedNetworkClient', - 'PermissionController:hasPermissions', - 'PermissionController:getSubjectNames', - ], - allowedEvents: [ - 'NetworkController:stateChange', - 'PermissionController:stateChange', - ], - }), - state: initState.SelectedNetworkController, - useRequestQueuePreference: - this.preferencesController.state.useRequestQueue, - onPreferencesStateChange: (listener) => { - preferencesMessenger.subscribe( - 'PreferencesController:stateChange', - listener, - ); - }, - domainProxyMap: new WeakRefObjectMap(), - }); - - this.permissionLogController = new PermissionLogController({ - messenger: this.controllerMessenger.getRestricted({ - name: 'PermissionLogController', - }), - restrictedMethods: new Set(Object.keys(RestrictedMethods)), - state: initState.PermissionLogController, - }); - - this.subjectMetadataController = new SubjectMetadataController({ - messenger: this.controllerMessenger.getRestricted({ - name: 'SubjectMetadataController', - allowedActions: [`${this.permissionController.name}:hasPermissions`], - }), - state: initState.SubjectMetadataController, - subjectCacheLimit: 100, - }); - - const shouldUseOffscreenExecutionService = - isManifestV3 && - typeof chrome !== 'undefined' && - // eslint-disable-next-line no-undef - typeof chrome.offscreen !== 'undefined'; - - const snapExecutionServiceArgs = { - messenger: this.controllerMessenger.getRestricted({ - name: 'ExecutionService', - }), - setupSnapProvider: this.setupSnapProvider.bind(this), - }; - - this.snapExecutionService = - shouldUseOffscreenExecutionService === false - ? new IframeExecutionService({ - ...snapExecutionServiceArgs, - iframeUrl: new URL(process.env.IFRAME_EXECUTION_ENVIRONMENT_URL), - }) - : new OffscreenExecutionService({ - ...snapExecutionServiceArgs, - offscreenPromise: this.offscreenPromise, - }); - - const snapControllerMessenger = this.controllerMessenger.getRestricted({ - name: 'SnapController', - allowedEvents: [ - 'ExecutionService:unhandledError', - 'ExecutionService:outboundRequest', - 'ExecutionService:outboundResponse', - ], - allowedActions: [ - `${this.permissionController.name}:getEndowments`, - `${this.permissionController.name}:getPermissions`, - `${this.permissionController.name}:hasPermission`, - `${this.permissionController.name}:hasPermissions`, - `${this.permissionController.name}:requestPermissions`, - `${this.permissionController.name}:revokeAllPermissions`, - `${this.permissionController.name}:revokePermissions`, - `${this.permissionController.name}:revokePermissionForAllSubjects`, - `${this.permissionController.name}:getSubjectNames`, - `${this.permissionController.name}:updateCaveat`, - `${this.approvalController.name}:addRequest`, - `${this.approvalController.name}:updateRequestState`, - `${this.permissionController.name}:grantPermissions`, - `${this.subjectMetadataController.name}:getSubjectMetadata`, - `${this.subjectMetadataController.name}:addSubjectMetadata`, - 'ExecutionService:executeSnap', - 'ExecutionService:getRpcRequestHandler', - 'ExecutionService:terminateSnap', - 'ExecutionService:terminateAllSnaps', - 'ExecutionService:handleRpcRequest', - 'SnapsRegistry:get', - 'SnapsRegistry:getMetadata', - 'SnapsRegistry:update', - 'SnapsRegistry:resolveVersion', - `SnapInterfaceController:createInterface`, - `SnapInterfaceController:getInterface`, - ], - }); - - const allowLocalSnaps = process.env.ALLOW_LOCAL_SNAPS; - const requireAllowlist = process.env.REQUIRE_SNAPS_ALLOWLIST; - const rejectInvalidPlatformVersion = - process.env.REJECT_INVALID_SNAPS_PLATFORM_VERSION; - - this.snapController = new SnapController({ - environmentEndowmentPermissions: Object.values(EndowmentPermissions), - excludedPermissions: { - ...ExcludedSnapPermissions, - ...ExcludedSnapEndowments, - }, - closeAllConnections: this.removeAllConnections.bind(this), - state: initState.SnapController, - messenger: snapControllerMessenger, - featureFlags: { - dappsCanUpdateSnaps: true, - allowLocalSnaps, - requireAllowlist, - rejectInvalidPlatformVersion, - }, - encryptor: encryptorFactory(600_000), - getMnemonic: this.getPrimaryKeyringMnemonic.bind(this), - preinstalledSnaps: PREINSTALLED_SNAPS, - getFeatureFlags: () => { - return { - disableSnaps: - this.preferencesController.state.useExternalServices === false, - }; - }, - }); - - this.notificationController = new NotificationController({ - messenger: this.controllerMessenger.getRestricted({ - name: 'NotificationController', - }), - state: initState.NotificationController, - }); - - this.rateLimitController = new RateLimitController({ - state: initState.RateLimitController, - messenger: this.controllerMessenger.getRestricted({ - name: 'RateLimitController', - }), - implementations: { - showNativeNotification: { - method: (origin, message) => { - const subjectMetadataState = this.controllerMessenger.call( - 'SubjectMetadataController:getState', - ); - - const originMetadata = subjectMetadataState.subjectMetadata[origin]; - - this.platform - ._showNotification(originMetadata?.name ?? origin, message) - .catch((error) => { - log.error('Failed to create notification', error); - }); - - return null; - }, - // 2 calls per 5 minutes - rateLimitCount: 2, - rateLimitTimeout: 300000, - }, - showInAppNotification: { - method: (origin, message) => { - this.controllerMessenger.call( - 'NotificationController:show', - origin, - message, - ); - - return null; - }, - // 5 calls per minute - rateLimitCount: 5, - rateLimitTimeout: 60000, - }, - }, - }); - const cronjobControllerMessenger = this.controllerMessenger.getRestricted({ - name: 'CronjobController', - allowedEvents: [ - 'SnapController:snapInstalled', - 'SnapController:snapUpdated', - 'SnapController:snapUninstalled', - 'SnapController:snapEnabled', - 'SnapController:snapDisabled', - ], - allowedActions: [ - `${this.permissionController.name}:getPermissions`, - 'SnapController:handleRequest', - 'SnapController:getAll', - ], - }); - this.cronjobController = new CronjobController({ - state: initState.CronjobController, - messenger: cronjobControllerMessenger, - }); - - const snapsRegistryMessenger = this.controllerMessenger.getRestricted({ - name: 'SnapsRegistry', - allowedEvents: [], - allowedActions: [], - }); - - this.snapsRegistry = new JsonSnapsRegistry({ - state: initState.SnapsRegistry, - messenger: snapsRegistryMessenger, - refetchOnAllowlistMiss: requireAllowlist, - url: { - registry: 'https://acl.execution.metamask.io/latest/registry.json', - signature: 'https://acl.execution.metamask.io/latest/signature.json', - }, - publicKey: - '0x025b65308f0f0fb8bc7f7ff87bfc296e0330eee5d3c1d1ee4a048b2fd6a86fa0a6', - }); - - const snapInterfaceControllerMessenger = - this.controllerMessenger.getRestricted({ - name: 'SnapInterfaceController', - allowedActions: [ - `${this.phishingController.name}:maybeUpdateState`, - `${this.phishingController.name}:testOrigin`, - `${this.approvalController.name}:hasRequest`, - `${this.approvalController.name}:acceptRequest`, - `${this.snapController.name}:get`, - ], - }); - - this.snapInterfaceController = new SnapInterfaceController({ - state: initState.SnapInterfaceController, - messenger: snapInterfaceControllerMessenger, - }); - - const snapInsightsControllerMessenger = - this.controllerMessenger.getRestricted({ - name: 'SnapInsightsController', - allowedActions: [ - `${this.snapController.name}:handleRequest`, - `${this.snapController.name}:getAll`, - `${this.permissionController.name}:getPermissions`, - `${this.snapInterfaceController.name}:deleteInterface`, - ], - allowedEvents: [ - `TransactionController:unapprovedTransactionAdded`, - `TransactionController:transactionStatusUpdated`, - `SignatureController:stateChange`, - ], - }); - - this.snapInsightsController = new SnapInsightsController({ - state: initState.SnapInsightsController, - messenger: snapInsightsControllerMessenger, - }); - - // Notification Controllers - this.authenticationController = new AuthenticationController.Controller({ - state: initState.AuthenticationController, - messenger: this.controllerMessenger.getRestricted({ - name: 'AuthenticationController', - allowedActions: [ - 'KeyringController:getState', - 'SnapController:handleRequest', - ], - allowedEvents: ['KeyringController:lock', 'KeyringController:unlock'], - }), - metametrics: { - getMetaMetricsId: () => this.metaMetricsController.getMetaMetricsId(), - agent: 'extension', - }, - }); - - this.userStorageController = new UserStorageController.Controller({ - getMetaMetricsState: () => - this.metaMetricsController.state.participateInMetaMetrics ?? false, - state: initState.UserStorageController, - config: { - accountSyncing: { - onAccountAdded: (profileId) => { - this.metaMetricsController.trackEvent({ - category: MetaMetricsEventCategory.ProfileSyncing, - event: MetaMetricsEventName.AccountsSyncAdded, - properties: { - profile_id: profileId, - }, - }); - }, - onAccountNameUpdated: (profileId) => { - this.metaMetricsController.trackEvent({ - category: MetaMetricsEventCategory.ProfileSyncing, - event: MetaMetricsEventName.AccountsSyncNameUpdated, - properties: { - profile_id: profileId, - }, - }); - }, - }, - }, - env: { - isAccountSyncingEnabled: isManifestV3, - }, - messenger: this.controllerMessenger.getRestricted({ - name: 'UserStorageController', - allowedActions: [ - 'KeyringController:getState', - 'KeyringController:addNewAccount', - 'SnapController:handleRequest', - 'AuthenticationController:getBearerToken', - 'AuthenticationController:getSessionProfile', - 'AuthenticationController:isSignedIn', - 'AuthenticationController:performSignOut', - 'AuthenticationController:performSignIn', - 'NotificationServicesController:disableNotificationServices', - 'NotificationServicesController:selectIsNotificationServicesEnabled', - 'AccountsController:listAccounts', - 'AccountsController:updateAccountMetadata', - ], - allowedEvents: [ - 'KeyringController:lock', - 'KeyringController:unlock', - 'AccountsController:accountAdded', - 'AccountsController:accountRenamed', - ], - }), - }); - - const notificationServicesPushControllerMessenger = - this.controllerMessenger.getRestricted({ - name: 'NotificationServicesPushController', - allowedActions: ['AuthenticationController:getBearerToken'], - allowedEvents: [], - }); - this.notificationServicesPushController = - new NotificationServicesPushController.Controller({ - messenger: notificationServicesPushControllerMessenger, - state: initState.NotificationServicesPushController, - env: { - apiKey: process.env.FIREBASE_API_KEY ?? '', - authDomain: process.env.FIREBASE_AUTH_DOMAIN ?? '', - storageBucket: process.env.FIREBASE_STORAGE_BUCKET ?? '', - projectId: process.env.FIREBASE_PROJECT_ID ?? '', - messagingSenderId: process.env.FIREBASE_MESSAGING_SENDER_ID ?? '', - appId: process.env.FIREBASE_APP_ID ?? '', - measurementId: process.env.FIREBASE_MEASUREMENT_ID ?? '', - vapidKey: process.env.VAPID_KEY ?? '', - }, - config: { - isPushEnabled: isManifestV3, - platform: 'extension', - onPushNotificationReceived, - onPushNotificationClicked, - }, - }); - notificationServicesPushControllerMessenger.subscribe( - 'NotificationServicesPushController:onNewNotifications', - (notification) => { - this.metaMetricsController.trackEvent({ - category: MetaMetricsEventCategory.PushNotifications, - event: MetaMetricsEventName.PushNotificationReceived, - properties: { - notification_id: notification.id, - notification_type: notification.type, - chain_id: notification?.chain_id, - }, - }); - }, - ); - notificationServicesPushControllerMessenger.subscribe( - 'NotificationServicesPushController:pushNotificationClicked', - (notification) => { - this.metaMetricsController.trackEvent({ - category: MetaMetricsEventCategory.PushNotifications, - event: MetaMetricsEventName.PushNotificationClicked, - properties: { - notification_id: notification.id, - notification_type: notification.type, - chain_id: notification?.chain_id, - }, - }); - }, - ); - - this.notificationServicesController = - new NotificationServicesController.Controller({ - messenger: this.controllerMessenger.getRestricted({ - name: 'NotificationServicesController', - allowedActions: [ - 'KeyringController:getAccounts', - 'KeyringController:getState', - 'AuthenticationController:getBearerToken', - 'AuthenticationController:isSignedIn', - 'UserStorageController:enableProfileSyncing', - 'UserStorageController:getStorageKey', - 'UserStorageController:performGetStorage', - 'UserStorageController:performSetStorage', - 'NotificationServicesPushController:enablePushNotifications', - 'NotificationServicesPushController:disablePushNotifications', - 'NotificationServicesPushController:subscribeToPushNotifications', - 'NotificationServicesPushController:updateTriggerPushNotifications', - ], - allowedEvents: [ - 'KeyringController:stateChange', - 'KeyringController:lock', - 'KeyringController:unlock', - 'NotificationServicesPushController:onNewNotifications', - ], - }), - state: initState.NotificationServicesController, - env: { - isPushIntegrated: isManifestV3, - featureAnnouncements: { - platform: 'extension', - spaceId: process.env.CONTENTFUL_ACCESS_SPACE_ID ?? '', - accessToken: process.env.CONTENTFUL_ACCESS_TOKEN ?? '', - }, - }, - }); - - // account tracker watches balances, nonces, and any code at their address - this.accountTrackerController = new AccountTrackerController({ - state: { accounts: {} }, - messenger: this.controllerMessenger.getRestricted({ - name: 'AccountTrackerController', - allowedActions: [ - 'AccountsController:getSelectedAccount', - 'NetworkController:getState', - 'NetworkController:getNetworkClientById', - 'OnboardingController:getState', - 'PreferencesController:getState', - ], - allowedEvents: [ - 'AccountsController:selectedEvmAccountChange', - 'OnboardingController:stateChange', - 'KeyringController:accountRemoved', - ], - }), - provider: this.provider, - blockTracker: this.blockTracker, - getNetworkIdentifier: (providerConfig) => { - const { type, rpcUrl } = - providerConfig ?? - getProviderConfig({ - metamask: this.networkController.state, - }); - return type === NETWORK_TYPES.RPC ? rpcUrl : type; - }, - }); - - // start and stop polling for balances based on activeControllerConnections - this.on('controllerConnectionChanged', (activeControllerConnections) => { - const { completedOnboarding } = this.onboardingController.state; - if (activeControllerConnections > 0 && completedOnboarding) { - this.triggerNetworkrequests(); - } else { - this.stopNetworkRequests(); - } - }); - - this.controllerMessenger.subscribe( - `${this.onboardingController.name}:stateChange`, - previousValueComparator(async (prevState, currState) => { - const { completedOnboarding: prevCompletedOnboarding } = prevState; - const { completedOnboarding: currCompletedOnboarding } = currState; - if (!prevCompletedOnboarding && currCompletedOnboarding) { - const { address } = this.accountsController.getSelectedAccount(); - - this._addAccountsWithBalance(); - - this.postOnboardingInitialization(); - this.triggerNetworkrequests(); - // execute once the token detection on the post-onboarding - await this.tokenDetectionController.detectTokens({ - selectedAddress: address, - }); - } - }, this.onboardingController.state), - ); - - const tokenDetectionControllerMessenger = - this.controllerMessenger.getRestricted({ - name: 'TokenDetectionController', - allowedActions: [ - 'AccountsController:getAccount', - 'AccountsController:getSelectedAccount', - 'KeyringController:getState', - 'NetworkController:getNetworkClientById', - 'NetworkController:getNetworkConfigurationByNetworkClientId', - 'NetworkController:getState', - 'PreferencesController:getState', - 'TokenListController:getState', - 'TokensController:getState', - 'TokensController:addDetectedTokens', - ], - allowedEvents: [ - 'AccountsController:selectedEvmAccountChange', - 'KeyringController:lock', - 'KeyringController:unlock', - 'NetworkController:networkDidChange', - 'PreferencesController:stateChange', - 'TokenListController:stateChange', - ], - }); - - this.tokenDetectionController = new TokenDetectionController({ - messenger: tokenDetectionControllerMessenger, - getBalancesInSingleCall: - this.assetsContractController.getBalancesInSingleCall.bind( - this.assetsContractController, - ), - trackMetaMetricsEvent: this.metaMetricsController.trackEvent.bind( - this.metaMetricsController, - ), - useAccountsAPI: true, - platform: 'extension', - }); - - const addressBookControllerMessenger = - this.controllerMessenger.getRestricted({ - name: 'AddressBookController', - allowedActions: [], - allowedEvents: [], - }); - - this.addressBookController = new AddressBookController({ - messenger: addressBookControllerMessenger, - state: initState.AddressBookController, - }); - - this.alertController = new AlertController({ - state: initState.AlertController, - messenger: this.controllerMessenger.getRestricted({ - name: 'AlertController', - allowedEvents: ['AccountsController:selectedAccountChange'], - allowedActions: ['AccountsController:getSelectedAccount'], - }), - }); - - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - this.custodyController = new CustodyController({ - initState: initState.CustodyController, - captureException, - }); - this.institutionalFeaturesController = new InstitutionalFeaturesController({ - initState: initState.InstitutionalFeaturesController, - showConfirmRequest: opts.showUserConfirmation, - }); - this.transactionUpdateController = new TransactionUpdateController({ - initState: initState.TransactionUpdateController, - getCustodyKeyring: this.getCustodyKeyringIfExists.bind(this), - mmiConfigurationController: this.mmiConfigurationController, - captureException, - }); - ///: END:ONLY_INCLUDE_IF - - this.backup = new Backup({ - preferencesController: this.preferencesController, - addressBookController: this.addressBookController, - accountsController: this.accountsController, - networkController: this.networkController, - trackMetaMetricsEvent: this.metaMetricsController.trackEvent.bind( - this.metaMetricsController, - ), - }); - - // This gets used as a ...spread parameter in two places: new TransactionController() and createRPCMethodTrackingMiddleware() - this.snapAndHardwareMetricsParams = { - getSelectedAccount: this.accountsController.getSelectedAccount.bind( - this.accountsController, - ), - getAccountType: this.getAccountType.bind(this), - getDeviceModel: this.getDeviceModel.bind(this), - snapAndHardwareMessenger: this.controllerMessenger.getRestricted({ - name: 'SnapAndHardwareMessenger', - allowedActions: [ - 'KeyringController:getKeyringForAccount', - 'SnapController:get', - 'AccountsController:getSelectedAccount', - ], - }), - }; - - const transactionControllerMessenger = - this.controllerMessenger.getRestricted({ - name: 'TransactionController', - allowedActions: [ - `${this.approvalController.name}:addRequest`, - 'NetworkController:findNetworkClientIdByChainId', - 'NetworkController:getNetworkClientById', - 'AccountsController:getSelectedAccount', - ], - allowedEvents: [`NetworkController:stateChange`], - }); - this.txController = new TransactionController({ - blockTracker: this.blockTracker, - getCurrentNetworkEIP1559Compatibility: - this.networkController.getEIP1559Compatibility.bind( - this.networkController, - ), - getCurrentAccountEIP1559Compatibility: - this.getCurrentAccountEIP1559Compatibility.bind(this), - getExternalPendingTransactions: - this.getExternalPendingTransactions.bind(this), - getGasFeeEstimates: this.gasFeeController.fetchGasFeeEstimates.bind( - this.gasFeeController, - ), - getNetworkClientRegistry: - this.networkController.getNetworkClientRegistry.bind( - this.networkController, - ), - getNetworkState: () => this.networkController.state, - getPermittedAccounts: this.getPermittedAccounts.bind(this), - getSavedGasFees: () => - this.preferencesController.state.advancedGasFee[ - getCurrentChainId({ metamask: this.networkController.state }) - ], - incomingTransactions: { - etherscanApiKeysByChainId: { - [CHAIN_IDS.MAINNET]: process.env.ETHERSCAN_API_KEY, - [CHAIN_IDS.SEPOLIA]: process.env.ETHERSCAN_API_KEY, - }, - includeTokenTransfers: false, - isEnabled: () => - Boolean( - this.preferencesController.state.incomingTransactionsPreferences?.[ - getCurrentChainId({ metamask: this.networkController.state }) - ] && this.onboardingController.state.completedOnboarding, - ), - queryEntireHistory: false, - updateTransactions: false, - }, - isMultichainEnabled: process.env.TRANSACTION_MULTICHAIN, - isSimulationEnabled: () => - this.preferencesController.state.useTransactionSimulations, - messenger: transactionControllerMessenger, - onNetworkStateChange: (listener) => { - networkControllerMessenger.subscribe( - 'NetworkController:networkDidChange', - () => listener(), - ); - }, - pendingTransactions: { - isResubmitEnabled: () => { - const state = this._getMetaMaskState(); - return !( - getSmartTransactionsPreferenceEnabled(state) && - getCurrentChainSupportsSmartTransactions(state) - ); - }, - }, - provider: this.provider, - testGasFeeFlows: process.env.TEST_GAS_FEE_FLOWS, - trace, - hooks: { - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - afterSign: (txMeta, signedEthTx) => - afterTransactionSignMMI( - txMeta, - signedEthTx, - this.transactionUpdateController.addTransactionToWatchList.bind( - this.transactionUpdateController, - ), - ), - beforeCheckPendingTransaction: - beforeCheckPendingTransactionMMI.bind(this), - beforePublish: beforeTransactionPublishMMI.bind(this), - getAdditionalSignArguments: getAdditionalSignArgumentsMMI.bind(this), - ///: END:ONLY_INCLUDE_IF - publish: this._publishSmartTransactionHook.bind(this), - }, - sign: (...args) => this.keyringController.signTransaction(...args), - state: initState.TransactionController, - }); - - this._addTransactionControllerListeners(); - - this.decryptMessageController = new DecryptMessageController({ - getState: this.getState.bind(this), - messenger: this.controllerMessenger.getRestricted({ - name: 'DecryptMessageController', - allowedActions: [ - `${this.approvalController.name}:addRequest`, - `${this.approvalController.name}:acceptRequest`, - `${this.approvalController.name}:rejectRequest`, - `${this.keyringController.name}:decryptMessage`, - ], - }), - metricsEvent: this.metaMetricsController.trackEvent.bind( - this.metaMetricsController, - ), - }); - - this.encryptionPublicKeyController = new EncryptionPublicKeyController({ - messenger: this.controllerMessenger.getRestricted({ - name: 'EncryptionPublicKeyController', - allowedActions: [ - `${this.approvalController.name}:addRequest`, - `${this.approvalController.name}:acceptRequest`, - `${this.approvalController.name}:rejectRequest`, - ], - }), - getEncryptionPublicKey: - this.keyringController.getEncryptionPublicKey.bind( - this.keyringController, - ), - getAccountKeyringType: this.keyringController.getAccountKeyringType.bind( - this.keyringController, - ), - getState: this.getState.bind(this), - metricsEvent: this.metaMetricsController.trackEvent.bind( - this.metaMetricsController, - ), - }); - - this.signatureController = new SignatureController({ - messenger: this.controllerMessenger.getRestricted({ - name: 'SignatureController', - allowedActions: [ - `${this.approvalController.name}:addRequest`, - `${this.keyringController.name}:signMessage`, - `${this.keyringController.name}:signPersonalMessage`, - `${this.keyringController.name}:signTypedMessage`, - `${this.loggingController.name}:add`, - `${this.networkController.name}:getNetworkClientById`, - ], - }), - trace, - decodingApiUrl: - 'https://qtgdj2huxh.execute-api.us-east-2.amazonaws.com/uat/v1', - isDecodeSignatureRequestEnabled: () => - this.preferencesController.state.useExternalServices === true && - this.preferencesController.state.useTransactionSimulations, - }); - - this.signatureController.hub.on( - 'cancelWithReason', - ({ message, reason }) => { - this.metaMetricsController.trackEvent({ - event: reason, - category: MetaMetricsEventCategory.Transactions, - properties: { - action: 'Sign Request', - type: message.type, - }, - }); - }, - ); - - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - const transactionMetricsRequest = this.getTransactionMetricsRequest(); - - const mmiControllerMessenger = this.controllerMessenger.getRestricted({ - name: 'MMIController', - allowedActions: [ - 'AccountsController:getAccountByAddress', - 'AccountsController:setAccountName', - 'AccountsController:listAccounts', - 'AccountsController:getSelectedAccount', - 'AccountsController:setSelectedAccount', - ], - }); - - this.mmiController = new MMIController({ - messenger: mmiControllerMessenger, - mmiConfigurationController: this.mmiConfigurationController, - keyringController: this.keyringController, - preferencesController: this.preferencesController, - appStateController: this.appStateController, - transactionUpdateController: this.transactionUpdateController, - custodyController: this.custodyController, - getState: this.getState.bind(this), - getPendingNonce: this.getPendingNonce.bind(this), - accountTrackerController: this.accountTrackerController, - metaMetricsController: this.metaMetricsController, - networkController: this.networkController, - permissionController: this.permissionController, - signatureController: this.signatureController, - platform: this.platform, - extension: this.extension, - getTransactions: this.txController.getTransactions.bind( - this.txController, - ), - setTxStatusSigned: (id) => - this.txController.updateCustodialTransaction(id, { - status: TransactionStatus.signed, - }), - setTxStatusSubmitted: (id) => - this.txController.updateCustodialTransaction(id, { - status: TransactionStatus.submitted, - }), - setTxStatusFailed: (id, reason) => - this.txController.updateCustodialTransaction(id, { - status: TransactionStatus.failed, - errorMessage: reason, - }), - trackTransactionEvents: handleMMITransactionUpdate.bind( - null, - transactionMetricsRequest, - ), - updateTransaction: (txMeta, note) => - this.txController.updateTransaction(txMeta, note), - updateTransactionHash: (id, hash) => - this.txController.updateCustodialTransaction(id, { hash }), - setChannelId: (channelId) => - this.institutionalFeaturesController.setChannelId(channelId), - setConnectionRequest: (payload) => - this.institutionalFeaturesController.setConnectionRequest(payload), - }); - ///: END:ONLY_INCLUDE_IF - - const swapsControllerMessenger = this.controllerMessenger.getRestricted({ - name: 'SwapsController', - // TODO: allow these internal calls once GasFeeController and TransactionController - // export these action types and register its action handlers - // allowedActions: [ - // 'GasFeeController:getEIP1559GasFeeEstimates', - // 'TransactionController:getLayer1GasFee', - // ], - allowedActions: [ - 'NetworkController:getState', - 'NetworkController:getNetworkClientById', - 'TokenRatesController:getState', - ], - allowedEvents: [], - }); - - this.swapsController = new SwapsController( - { - messenger: swapsControllerMessenger, - provider: this.provider, - // TODO: Remove once TransactionController exports this action type - getBufferedGasLimit: async (txMeta, multiplier) => { - const { gas: gasLimit, simulationFails } = - await this.txController.estimateGasBuffered( - txMeta.txParams, - multiplier, - ); - - return { gasLimit, simulationFails }; - }, - // TODO: Remove once GasFeeController exports this action type - getEIP1559GasFeeEstimates: - this.gasFeeController.fetchGasFeeEstimates.bind( - this.gasFeeController, - ), - // TODO: Remove once TransactionController exports this action type - getLayer1GasFee: this.txController.getLayer1GasFee.bind( - this.txController, - ), - trackMetaMetricsEvent: this.metaMetricsController.trackEvent.bind( - this.metaMetricsController, - ), - }, - initState.SwapsController, - ); - - const bridgeControllerMessenger = this.controllerMessenger.getRestricted({ - name: BRIDGE_CONTROLLER_NAME, - allowedActions: ['AccountsController:getSelectedAccount'], - allowedEvents: [], - }); - this.bridgeController = new BridgeController({ - messenger: bridgeControllerMessenger, - }); - - const smartTransactionsControllerMessenger = - this.controllerMessenger.getRestricted({ - name: 'SmartTransactionsController', - allowedActions: ['NetworkController:getNetworkClientById'], - allowedEvents: ['NetworkController:stateChange'], - }); - this.smartTransactionsController = new SmartTransactionsController({ - supportedChainIds: getAllowedSmartTransactionsChainIds(), - getNonceLock: this.txController.getNonceLock.bind(this.txController), - confirmExternalTransaction: - this.txController.confirmExternalTransaction.bind(this.txController), - trackMetaMetricsEvent: this.metaMetricsController.trackEvent.bind( - this.metaMetricsController, - ), - state: initState.SmartTransactionsController, - messenger: smartTransactionsControllerMessenger, - getTransactions: this.txController.getTransactions.bind( - this.txController, - ), - getMetaMetricsProps: async () => { - const selectedAddress = - this.accountsController.getSelectedAccount().address; - const accountHardwareType = await getHardwareWalletType( - this._getMetaMaskState(), - ); - const accountType = await this.getAccountType(selectedAddress); - const deviceModel = await this.getDeviceModel(selectedAddress); - return { - accountHardwareType, - accountType, - deviceModel, - }; - }, - }); - - const isExternalNameSourcesEnabled = () => - this.preferencesController.state.useExternalNameSources; - - this.nameController = new NameController({ - messenger: this.controllerMessenger.getRestricted({ - name: 'NameController', - allowedActions: [], - }), - providers: [ - new ENSNameProvider({ - reverseLookup: this.ensController.reverseResolveAddress.bind( - this.ensController, - ), - }), - new EtherscanNameProvider({ isEnabled: isExternalNameSourcesEnabled }), - new TokenNameProvider({ isEnabled: isExternalNameSourcesEnabled }), - new LensNameProvider({ isEnabled: isExternalNameSourcesEnabled }), - new SnapsNameProvider({ - messenger: this.controllerMessenger.getRestricted({ - name: 'SnapsNameProvider', - allowedActions: [ - 'SnapController:getAll', - 'SnapController:get', - 'SnapController:handleRequest', - 'PermissionController:getState', - ], - }), - }), - ], - state: initState.NameController, - }); - - const petnamesBridgeMessenger = this.controllerMessenger.getRestricted({ - name: 'PetnamesBridge', - allowedEvents: [ - 'NameController:stateChange', - 'AccountsController:stateChange', - 'AddressBookController:stateChange', - ], - allowedActions: ['AccountsController:listAccounts'], - }); - - new AddressBookPetnamesBridge({ - addressBookController: this.addressBookController, - nameController: this.nameController, - messenger: petnamesBridgeMessenger, - }).init(); - - new AccountIdentitiesPetnamesBridge({ - nameController: this.nameController, - messenger: petnamesBridgeMessenger, - }).init(); - - this.userOperationController = new UserOperationController({ - entrypoint: process.env.EIP_4337_ENTRYPOINT, - getGasFeeEstimates: this.gasFeeController.fetchGasFeeEstimates.bind( - this.gasFeeController, - ), - messenger: this.controllerMessenger.getRestricted({ - name: 'UserOperationController', - allowedActions: [ - 'ApprovalController:addRequest', - 'NetworkController:getNetworkClientById', - 'KeyringController:prepareUserOperation', - 'KeyringController:patchUserOperation', - 'KeyringController:signUserOperation', - ], - }), - state: initState.UserOperationController, - }); - - this.userOperationController.hub.on( - 'user-operation-added', - this._onUserOperationAdded.bind(this), - ); - - this.userOperationController.hub.on( - 'transaction-updated', - this._onUserOperationTransactionUpdated.bind(this), - ); - - // ensure AccountTrackerController updates balances after network change - networkControllerMessenger.subscribe( - 'NetworkController:networkDidChange', - () => { - this.accountTrackerController.updateAccounts(); - }, - ); - - // clear unapproved transactions and messages when the network will change - networkControllerMessenger.subscribe( - 'NetworkController:networkWillChange', - clearPendingConfirmations.bind(this), - ); - - this.metamaskMiddleware = createMetamaskMiddleware({ - static: { - eth_syncing: false, - web3_clientVersion: `MetaMask/v${version}`, - }, - version, - // account mgmt - getAccounts: async ( - { origin: innerOrigin }, - { suppressUnauthorizedError = true } = {}, - ) => { - if (innerOrigin === ORIGIN_METAMASK) { - const selectedAddress = - this.accountsController.getSelectedAccount().address; - return selectedAddress ? [selectedAddress] : []; - } else if (this.isUnlocked()) { - return await this.getPermittedAccounts(innerOrigin, { - suppressUnauthorizedError, - }); - } - return []; // changing this is a breaking change - }, - // tx signing - processTransaction: (transactionParams, dappRequest) => - addDappTransaction( - this.getAddTransactionRequest({ transactionParams, dappRequest }), - ), - // msg signing - ///: BEGIN:ONLY_INCLUDE_IF(build-main,build-beta,build-flask) - - processTypedMessage: (...args) => - addTypedMessage({ - signatureController: this.signatureController, - signatureParams: args, - }), - processTypedMessageV3: (...args) => - addTypedMessage({ - signatureController: this.signatureController, - signatureParams: args, - }), - processTypedMessageV4: (...args) => - addTypedMessage({ - signatureController: this.signatureController, - signatureParams: args, - }), - processPersonalMessage: (...args) => - addPersonalMessage({ - signatureController: this.signatureController, - signatureParams: args, - }), - ///: END:ONLY_INCLUDE_IF - - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - /* eslint-disable no-dupe-keys */ - processTypedMessage: this.mmiController.newUnsignedMessage.bind( - this.mmiController, - ), - processTypedMessageV3: this.mmiController.newUnsignedMessage.bind( - this.mmiController, - ), - processTypedMessageV4: this.mmiController.newUnsignedMessage.bind( - this.mmiController, - ), - processPersonalMessage: this.mmiController.newUnsignedMessage.bind( - this.mmiController, - ), - setTypedMessageInProgress: - this.signatureController.setTypedMessageInProgress.bind( - this.signatureController, - ), - setPersonalMessageInProgress: - this.signatureController.setPersonalMessageInProgress.bind( - this.signatureController, - ), - /* eslint-enable no-dupe-keys */ - ///: END:ONLY_INCLUDE_IF - - processEncryptionPublicKey: - this.encryptionPublicKeyController.newRequestEncryptionPublicKey.bind( - this.encryptionPublicKeyController, - ), - - processDecryptMessage: - this.decryptMessageController.newRequestDecryptMessage.bind( - this.decryptMessageController, - ), - getPendingNonce: this.getPendingNonce.bind(this), - getPendingTransactionByHash: (hash) => - this.txController.state.transactions.find( - (meta) => - meta.hash === hash && meta.status === TransactionStatus.submitted, - ), - }); - - // ensure isClientOpenAndUnlocked is updated when memState updates - this.on('update', (memState) => this._onStateUpdate(memState)); - - /** - * All controllers in Memstore but not in store. They are not persisted. - * On chrome profile re-start, they will be re-initialized. - */ - const resetOnRestartStore = { - AccountTracker: this.accountTrackerController, - TokenRatesController: this.tokenRatesController, - DecryptMessageController: this.decryptMessageController, - EncryptionPublicKeyController: this.encryptionPublicKeyController, - SignatureController: this.signatureController, - SwapsController: this.swapsController, - BridgeController: this.bridgeController, - EnsController: this.ensController, - ApprovalController: this.approvalController, - PPOMController: this.ppomController, - }; - - this.store.updateStructure({ - AccountsController: this.accountsController, - AppStateController: this.appStateController.store, - AppMetadataController: this.appMetadataController.store, - MultichainBalancesController: this.multichainBalancesController, - TransactionController: this.txController, - KeyringController: this.keyringController, - PreferencesController: this.preferencesController, - MetaMetricsController: this.metaMetricsController.store, - MetaMetricsDataDeletionController: this.metaMetricsDataDeletionController, - AddressBookController: this.addressBookController, - CurrencyController: this.currencyRateController, - NetworkController: this.networkController, - AlertController: this.alertController, - OnboardingController: this.onboardingController, - PermissionController: this.permissionController, - PermissionLogController: this.permissionLogController, - SubjectMetadataController: this.subjectMetadataController, - AnnouncementController: this.announcementController, - NetworkOrderController: this.networkOrderController, - AccountOrderController: this.accountOrderController, - GasFeeController: this.gasFeeController, - TokenListController: this.tokenListController, - TokensController: this.tokensController, - SmartTransactionsController: this.smartTransactionsController, - NftController: this.nftController, - PhishingController: this.phishingController, - SelectedNetworkController: this.selectedNetworkController, - LoggingController: this.loggingController, - MultichainRatesController: this.multichainRatesController, - SnapController: this.snapController, - CronjobController: this.cronjobController, - SnapsRegistry: this.snapsRegistry, - NotificationController: this.notificationController, - SnapInterfaceController: this.snapInterfaceController, - SnapInsightsController: this.snapInsightsController, - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - CustodyController: this.custodyController.store, - InstitutionalFeaturesController: - this.institutionalFeaturesController.store, - MmiConfigurationController: this.mmiConfigurationController.store, - ///: END:ONLY_INCLUDE_IF - PPOMController: this.ppomController, - NameController: this.nameController, - UserOperationController: this.userOperationController, - // Notification Controllers - AuthenticationController: this.authenticationController, - UserStorageController: this.userStorageController, - NotificationServicesController: this.notificationServicesController, - NotificationServicesPushController: - this.notificationServicesPushController, - ...resetOnRestartStore, - }); - - this.memStore = new ComposableObservableStore({ - config: { - AccountsController: this.accountsController, - AppStateController: this.appStateController.store, - AppMetadataController: this.appMetadataController.store, - MultichainBalancesController: this.multichainBalancesController, - NetworkController: this.networkController, - KeyringController: this.keyringController, - PreferencesController: this.preferencesController, - MetaMetricsController: this.metaMetricsController.store, - MetaMetricsDataDeletionController: - this.metaMetricsDataDeletionController, - AddressBookController: this.addressBookController, - CurrencyController: this.currencyRateController, - AlertController: this.alertController, - OnboardingController: this.onboardingController, - PermissionController: this.permissionController, - PermissionLogController: this.permissionLogController, - SubjectMetadataController: this.subjectMetadataController, - AnnouncementController: this.announcementController, - NetworkOrderController: this.networkOrderController, - AccountOrderController: this.accountOrderController, - GasFeeController: this.gasFeeController, - TokenListController: this.tokenListController, - TokensController: this.tokensController, - SmartTransactionsController: this.smartTransactionsController, - NftController: this.nftController, - SelectedNetworkController: this.selectedNetworkController, - LoggingController: this.loggingController, - TxController: this.txController, - MultichainRatesController: this.multichainRatesController, - SnapController: this.snapController, - CronjobController: this.cronjobController, - SnapsRegistry: this.snapsRegistry, - NotificationController: this.notificationController, - SnapInterfaceController: this.snapInterfaceController, - SnapInsightsController: this.snapInsightsController, - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - CustodyController: this.custodyController.store, - InstitutionalFeaturesController: - this.institutionalFeaturesController.store, - MmiConfigurationController: this.mmiConfigurationController.store, - ///: END:ONLY_INCLUDE_IF - NameController: this.nameController, - UserOperationController: this.userOperationController, - // Notification Controllers - AuthenticationController: this.authenticationController, - UserStorageController: this.userStorageController, - NotificationServicesController: this.notificationServicesController, - QueuedRequestController: this.queuedRequestController, - NotificationServicesPushController: - this.notificationServicesPushController, - ...resetOnRestartStore, - }, - controllerMessenger: this.controllerMessenger, - }); - - // if this is the first time, clear the state of by calling these methods - const resetMethods = [ - this.accountTrackerController.resetState.bind( - this.accountTrackerController, - ), - this.decryptMessageController.resetState.bind( - this.decryptMessageController, - ), - this.encryptionPublicKeyController.resetState.bind( - this.encryptionPublicKeyController, - ), - this.signatureController.resetState.bind(this.signatureController), - this.swapsController.resetState.bind(this.swapsController), - this.bridgeController.resetState.bind(this.bridgeController), - this.ensController.resetState.bind(this.ensController), - this.approvalController.clear.bind(this.approvalController), - // WE SHOULD ADD TokenListController.resetState here too. But it's not implemented yet. - ]; - - if (isManifestV3) { - if (isFirstMetaMaskControllerSetup === true) { - this.resetStates(resetMethods); - this.extension.storage.session.set({ - isFirstMetaMaskControllerSetup: false, - }); - } - } else { - // it's always the first time in MV2 - this.resetStates(resetMethods); - } - - // Automatic login via config password - const password = process.env.PASSWORD; - if ( - !this.isUnlocked() && - this.onboardingController.state.completedOnboarding && - password && - !process.env.IN_TEST - ) { - this._loginUser(password); - } else { - this._startUISync(); - } - - // Lazily update the store with the current extension environment - this.extension.runtime.getPlatformInfo().then(({ os }) => { - this.appStateController.setBrowserEnvironment( - os, - // This method is presently only supported by Firefox - this.extension.runtime.getBrowserInfo === undefined - ? 'chrome' - : 'firefox', - ); - }); - - this.setupControllerEventSubscriptions(); - this.setupMultichainDataAndSubscriptions(); - - // For more information about these legacy streams, see here: - // https://github.com/MetaMask/metamask-extension/issues/15491 - // TODO:LegacyProvider: Delete - this.publicConfigStore = this.createPublicConfigStore(); - - // Multiple MetaMask instances launched warning - this.extension.runtime.onMessageExternal.addListener(onMessageReceived); - // Fire a ping message to check if other extensions are running - checkForMultipleVersionsRunning(); - - if (this.onboardingController.state.completedOnboarding) { - this.postOnboardingInitialization(); - } - } - - postOnboardingInitialization() { - const { usePhishDetect } = this.preferencesController.state; - - this.networkController.lookupNetwork(); - - if (usePhishDetect) { - this.phishingController.maybeUpdateState(); - } - - // post onboarding emit detectTokens event - const preferencesControllerState = this.preferencesController.state; - const { useTokenDetection, useNftDetection } = - preferencesControllerState ?? {}; - this.metaMetricsController.trackEvent({ - category: MetaMetricsEventCategory.Onboarding, - event: MetaMetricsUserTrait.TokenDetectionEnabled, - properties: { - [MetaMetricsUserTrait.TokenDetectionEnabled]: useTokenDetection, - }, - }); - this.metaMetricsController.trackEvent({ - category: MetaMetricsEventCategory.Onboarding, - event: MetaMetricsUserTrait.NftAutodetectionEnabled, - properties: { - [MetaMetricsUserTrait.NftAutodetectionEnabled]: useNftDetection, - }, - }); - } - - triggerNetworkrequests() { - this.accountTrackerController.start(); - this.txController.startIncomingTransactionPolling(); - this.tokenDetectionController.enable(); - - const preferencesControllerState = this.preferencesController.state; - - if (this.#isTokenListPollingRequired(preferencesControllerState)) { - this.tokenListController.start(); - } - } - - stopNetworkRequests() { - this.accountTrackerController.stop(); - this.txController.stopIncomingTransactionPolling(); - this.tokenDetectionController.disable(); - - const preferencesControllerState = this.preferencesController.state; - - if (this.#isTokenListPollingRequired(preferencesControllerState)) { - this.tokenListController.stop(); - } - } - - resetStates(resetMethods) { - resetMethods.forEach((resetMethod) => { - try { - resetMethod(); - } catch (err) { - console.error(err); - } - }); - } - - ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) - /** - * Initialize the snap keyring if it is not present. - * - * @returns {SnapKeyring} - */ - async getSnapKeyring() { - let [snapKeyring] = this.keyringController.getKeyringsByType( - KeyringType.snap, - ); - if (!snapKeyring) { - snapKeyring = await this.keyringController.addNewKeyring( - KeyringType.snap, - ); - } - return snapKeyring; - } - ///: END:ONLY_INCLUDE_IF - - trackInsightSnapView(snapId) { - this.metaMetricsController.trackEvent({ - event: MetaMetricsEventName.InsightSnapViewed, - category: MetaMetricsEventCategory.Snaps, - properties: { - snap_id: snapId, - }, - }); - } - - /** - * Get snap metadata from the current state without refreshing the registry database. - * - * @param {string} snapId - A snap id. - * @returns The available metadata for the snap, if any. - */ - _getSnapMetadata(snapId) { - return this.snapsRegistry.state.database?.verifiedSnaps?.[snapId]?.metadata; - } - - /** - * Tracks snaps export usage. - * Note: This function is throttled to 1 call per 60 seconds per snap id + handler combination. - * - * @param {string} snapId - The ID of the snap the handler is being triggered on. - * @param {string} handler - The handler to trigger on the snap for the request. - * @param {boolean} success - Whether the invocation was successful or not. - * @param {string} origin - The origin of the request. - */ - _trackSnapExportUsage = wrap( - memoize( - () => - throttle( - (snapId, handler, success, origin) => - this.metaMetricsController.trackEvent({ - event: MetaMetricsEventName.SnapExportUsed, - category: MetaMetricsEventCategory.Snaps, - properties: { - snap_id: snapId, - export: handler, - snap_category: this._getSnapMetadata(snapId)?.category, - success, - origin, - }, - }), - SECOND * 60, - ), - (snapId, handler, _, origin) => `${snapId}${handler}${origin}`, - ), - (getFunc, ...args) => getFunc(...args)(...args), - ); - - /** - * Passes a JSON-RPC request object to the SnapController for execution. - * - * @param {object} args - A bag of options. - * @param {string} args.snapId - The ID of the recipient snap. - * @param {string} args.origin - The origin of the RPC request. - * @param {string} args.handler - The handler to trigger on the snap for the request. - * @param {object} args.request - The JSON-RPC request object. - * @returns The result of the JSON-RPC request. - */ - async handleSnapRequest(args) { - try { - const response = await this.controllerMessenger.call( - 'SnapController:handleRequest', - args, - ); - this._trackSnapExportUsage(args.snapId, args.handler, true, args.origin); - return response; - } catch (error) { - this._trackSnapExportUsage(args.snapId, args.handler, false, args.origin); - throw error; - } - } - - /** - * Gets the currently selected locale from the PreferencesController. - * - * @returns The currently selected locale. - */ - getLocale() { - const { currentLocale } = this.preferencesController.state; - - return currentLocale; - } - - /** - * Constructor helper for getting Snap permission specifications. - */ - getSnapPermissionSpecifications() { - return { - ...buildSnapEndowmentSpecifications(Object.keys(ExcludedSnapEndowments)), - ...buildSnapRestrictedMethodSpecifications( - Object.keys(ExcludedSnapPermissions), - { - getPreferences: () => { - const locale = this.getLocale(); - const currency = this.currencyRateController.state.currentCurrency; - return { locale, currency }; - }, - clearSnapState: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:clearSnapState', - ), - getMnemonic: this.getPrimaryKeyringMnemonic.bind(this), - getUnlockPromise: this.appStateController.getUnlockPromise.bind( - this.appStateController, - ), - getSnap: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:get', - ), - handleSnapRpcRequest: this.handleSnapRequest.bind(this), - getSnapState: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:getSnapState', - ), - requestUserApproval: - this.approvalController.addAndShowApprovalRequest.bind( - this.approvalController, - ), - showNativeNotification: (origin, args) => - this.controllerMessenger.call( - 'RateLimitController:call', - origin, - 'showNativeNotification', - origin, - args.message, - ), - showInAppNotification: (origin, args) => - this.controllerMessenger.call( - 'RateLimitController:call', - origin, - 'showInAppNotification', - origin, - args.message, - ), - updateSnapState: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:updateSnapState', - ), - maybeUpdatePhishingList: () => { - const { usePhishDetect } = this.preferencesController.state; - - if (!usePhishDetect) { - return; - } - - this.controllerMessenger.call( - 'PhishingController:maybeUpdateState', - ); - }, - isOnPhishingList: (url) => { - const { usePhishDetect } = - this.preferencesController.store.getState(); - - if (!usePhishDetect) { - return false; - } - - return this.controllerMessenger.call( - 'PhishingController:testOrigin', - url, - ).result; - }, - createInterface: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapInterfaceController:createInterface', - ), - getInterface: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapInterfaceController:getInterface', - ), - ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) - getSnapKeyring: this.getSnapKeyring.bind(this), - ///: END:ONLY_INCLUDE_IF - }, - ), - }; - } - - /** - * Deletes the specified notifications from state. - * - * @param {string[]} ids - The notifications ids to delete. - */ - dismissNotifications(ids) { - this.notificationController.dismiss(ids); - } - - /** - * Updates the readDate attribute of the specified notifications. - * - * @param {string[]} ids - The notifications ids to mark as read. - */ - markNotificationsAsRead(ids) { - this.notificationController.markRead(ids); - } - - /** - * Sets up BaseController V2 event subscriptions. Currently, this includes - * the subscriptions necessary to notify permission subjects of account - * changes. - * - * Some of the subscriptions in this method are ControllerMessenger selector - * event subscriptions. See the relevant documentation for - * `@metamask/base-controller` for more information. - * - * Note that account-related notifications emitted when the extension - * becomes unlocked are handled in MetaMaskController._onUnlock. - */ - setupControllerEventSubscriptions() { - let lastSelectedAddress; - this.controllerMessenger.subscribe( - 'PreferencesController:stateChange', - previousValueComparator(async (prevState, currState) => { - const { currentLocale } = currState; - const chainId = getCurrentChainId({ - metamask: this.networkController.state, - }); - - await updateCurrentLocale(currentLocale); - if (currState.incomingTransactionsPreferences?.[chainId]) { - this.txController.startIncomingTransactionPolling(); - } else { - this.txController.stopIncomingTransactionPolling(); - } - - this.#checkTokenListPolling(currState, prevState); - }, this.preferencesController.state), - ); - - this.controllerMessenger.subscribe( - `${this.accountsController.name}:selectedAccountChange`, - async (account) => { - if (account.address && account.address !== lastSelectedAddress) { - lastSelectedAddress = account.address; - await this._onAccountChange(account.address); - } - }, - ); - - // This handles account changes every time relevant permission state - // changes, for any reason. - this.controllerMessenger.subscribe( - `${this.permissionController.name}:stateChange`, - async (currentValue, previousValue) => { - const changedAccounts = diffMap(currentValue, previousValue); - - for (const [origin, accounts] of changedAccounts.entries()) { - this._notifyAccountsChange(origin, accounts); - } - }, - getPermittedAccountsByOrigin, - ); - - this.controllerMessenger.subscribe( - `${this.permissionController.name}:stateChange`, - async (currentValue, previousValue) => { - const changedChains = diffMap(currentValue, previousValue); - - // This operates under the assumption that there will be at maximum - // one origin permittedChains value change per event handler call - for (const [origin, chains] of changedChains.entries()) { - const currentNetworkClientIdForOrigin = - this.selectedNetworkController.getNetworkClientIdForDomain(origin); - const { chainId: currentChainIdForOrigin } = - this.networkController.getNetworkConfigurationByNetworkClientId( - currentNetworkClientIdForOrigin, - ); - // if(chains.length === 0) { - // TODO: This particular case should also occur at the same time - // that eth_accounts is revoked. When eth_accounts is revoked, - // the networkClientId for that origin should be reset to track - // the globally selected network. - // } - if (chains.length > 0 && !chains.includes(currentChainIdForOrigin)) { - const networkClientId = - this.networkController.findNetworkClientIdByChainId(chains[0]); - this.selectedNetworkController.setNetworkClientIdForDomain( - origin, - networkClientId, - ); - this.networkController.setActiveNetwork(networkClientId); - } - } - }, - getPermittedChainsByOrigin, - ); - - this.controllerMessenger.subscribe( - 'NetworkController:networkDidChange', - async () => { - await this.txController.updateIncomingTransactions(); - }, - ); - - this.controllerMessenger.subscribe( - `${this.snapController.name}:snapInstallStarted`, - (snapId, origin, isUpdate) => { - const snapCategory = this._getSnapMetadata(snapId)?.category; - this.metaMetricsController.trackEvent({ - event: isUpdate - ? MetaMetricsEventName.SnapUpdateStarted - : MetaMetricsEventName.SnapInstallStarted, - category: MetaMetricsEventCategory.Snaps, - properties: { - snap_id: snapId, - origin, - snap_category: snapCategory, - }, - }); - }, - ); - - this.controllerMessenger.subscribe( - `${this.snapController.name}:snapInstallFailed`, - (snapId, origin, isUpdate, error) => { - const isRejected = error.includes('User rejected the request.'); - const failedEvent = isUpdate - ? MetaMetricsEventName.SnapUpdateFailed - : MetaMetricsEventName.SnapInstallFailed; - const rejectedEvent = isUpdate - ? MetaMetricsEventName.SnapUpdateRejected - : MetaMetricsEventName.SnapInstallRejected; - - const snapCategory = this._getSnapMetadata(snapId)?.category; - this.metaMetricsController.trackEvent({ - event: isRejected ? rejectedEvent : failedEvent, - category: MetaMetricsEventCategory.Snaps, - properties: { - snap_id: snapId, - origin, - snap_category: snapCategory, - }, - }); - }, - ); - - this.controllerMessenger.subscribe( - `${this.snapController.name}:snapInstalled`, - (truncatedSnap, origin) => { - const snapId = truncatedSnap.id; - const snapCategory = this._getSnapMetadata(snapId)?.category; - this.metaMetricsController.trackEvent({ - event: MetaMetricsEventName.SnapInstalled, - category: MetaMetricsEventCategory.Snaps, - properties: { - snap_id: snapId, - version: truncatedSnap.version, - origin, - snap_category: snapCategory, - }, - }); - }, - ); - - this.controllerMessenger.subscribe( - `${this.snapController.name}:snapUpdated`, - (newSnap, oldVersion, origin) => { - const snapId = newSnap.id; - const snapCategory = this._getSnapMetadata(snapId)?.category; - this.metaMetricsController.trackEvent({ - event: MetaMetricsEventName.SnapUpdated, - category: MetaMetricsEventCategory.Snaps, - properties: { - snap_id: snapId, - old_version: oldVersion, - new_version: newSnap.version, - origin, - snap_category: snapCategory, - }, - }); - }, - ); - - this.controllerMessenger.subscribe( - `${this.snapController.name}:snapTerminated`, - (truncatedSnap) => { - const approvals = Object.values( - this.approvalController.state.pendingApprovals, - ).filter( - (approval) => - approval.origin === truncatedSnap.id && - approval.type.startsWith(RestrictedMethods.snap_dialog), - ); - for (const approval of approvals) { - this.approvalController.reject( - approval.id, - new Error('Snap was terminated.'), - ); - } - }, - ); - - this.controllerMessenger.subscribe( - `${this.snapController.name}:snapUninstalled`, - (truncatedSnap) => { - const notificationIds = Object.values( - this.notificationController.state.notifications, - ).reduce((idList, notification) => { - if (notification.origin === truncatedSnap.id) { - idList.push(notification.id); - } - return idList; - }, []); - - this.dismissNotifications(notificationIds); - - const snapId = truncatedSnap.id; - const snapCategory = this._getSnapMetadata(snapId)?.category; - this.metaMetricsController.trackEvent({ - event: MetaMetricsEventName.SnapUninstalled, - category: MetaMetricsEventCategory.Snaps, - properties: { - snap_id: snapId, - version: truncatedSnap.version, - snap_category: snapCategory, - }, - }); - }, - ); - } - - /** - * Sets up multichain data and subscriptions. - * This method is called during the MetaMaskController constructor. - * It starts the MultichainRatesController if selected account is non-EVM - * and subscribes to account changes. - */ - setupMultichainDataAndSubscriptions() { - if ( - !isEvmAccountType( - this.accountsController.getSelectedMultichainAccount().type, - ) - ) { - this.multichainRatesController.start(); - } - - this.controllerMessenger.subscribe( - 'AccountsController:selectedAccountChange', - (selectedAccount) => { - if (isEvmAccountType(selectedAccount.type)) { - this.multichainRatesController.stop(); - return; - } - this.multichainRatesController.start(); - }, - ); - this.multichainBalancesController.start(); - this.multichainBalancesController.updateBalances(); - } - - /** - * TODO:LegacyProvider: Delete - * Constructor helper: initialize a public config store. - * This store is used to make some config info available to Dapps synchronously. - */ - createPublicConfigStore() { - // subset of state for metamask inpage provider - const publicConfigStore = new ObservableStore(); - - const selectPublicState = async ({ isUnlocked }) => { - const { chainId, networkVersion } = await this.getProviderNetworkState(); - - return { - isUnlocked, - chainId, - networkVersion: networkVersion ?? 'loading', - }; - }; - - const updatePublicConfigStore = async (memState) => { - const networkStatus = - memState.networksMetadata[memState.selectedNetworkClientId]?.status; - if (networkStatus === NetworkStatus.Available) { - publicConfigStore.putState(await selectPublicState(memState)); - } - }; - - // setup memStore subscription hooks - this.on('update', updatePublicConfigStore); - updatePublicConfigStore(this.getState()); - - return publicConfigStore; - } - - /** - * Gets relevant state for the provider of an external origin. - * - * @param {string} origin - The origin to get the provider state for. - * @returns {Promise<{ isUnlocked: boolean, networkVersion: string, chainId: string, accounts: string[] }>} An object with relevant state properties. - */ - async getProviderState(origin) { - const providerNetworkState = await this.getProviderNetworkState( - this.preferencesController.getUseRequestQueue() ? origin : undefined, - ); - - return { - isUnlocked: this.isUnlocked(), - accounts: await this.getPermittedAccounts(origin), - ...providerNetworkState, - }; - } - - /** - * Retrieves network state information relevant for external providers. - * - * @param {string} origin - The origin identifier for which network state is requested (default: 'metamask'). - * @returns {object} An object containing important network state properties, including chainId and networkVersion. - */ - async getProviderNetworkState(origin = METAMASK_DOMAIN) { - const networkClientId = this.controllerMessenger.call( - 'SelectedNetworkController:getNetworkClientIdForDomain', - origin, - ); - - const networkClient = this.controllerMessenger.call( - 'NetworkController:getNetworkClientById', - networkClientId, - ); - - const { chainId } = networkClient.configuration; - - const { completedOnboarding } = this.onboardingController.state; - - let networkVersion = this.deprecatedNetworkVersions[networkClientId]; - if (!networkVersion && completedOnboarding) { - const ethQuery = new EthQuery(networkClient.provider); - networkVersion = await new Promise((resolve) => { - ethQuery.sendAsync({ method: 'net_version' }, (error, result) => { - if (error) { - console.error(error); - resolve(null); - } else { - resolve(convertNetworkId(result)); - } - }); - }); - this.deprecatedNetworkVersions[networkClientId] = networkVersion; - } - - return { - chainId, - networkVersion: networkVersion ?? 'loading', - }; - } - - //============================================================================= - // EXPOSED TO THE UI SUBSYSTEM - //============================================================================= - - /** - * The metamask-state of the various controllers, made available to the UI - * - * @returns {object} status - */ - getState() { - const { vault } = this.keyringController.state; - const isInitialized = Boolean(vault); - const flatState = this.memStore.getFlatState(); - - return { - isInitialized, - ...sanitizeUIState(flatState), - }; - } - - /** - * Returns an Object containing API Callback Functions. - * These functions are the interface for the UI. - * The API object can be transmitted over a stream via JSON-RPC. - * - * @returns {object} Object containing API functions. - */ - getApi() { - const { - accountsController, - addressBookController, - alertController, - appStateController, - keyringController, - nftController, - nftDetectionController, - currencyRateController, - tokenDetectionController, - ensController, - gasFeeController, - metaMetricsController, - networkController, - announcementController, - onboardingController, - permissionController, - preferencesController, - tokensController, - smartTransactionsController, - txController, - assetsContractController, - backup, - approvalController, - phishingController, - tokenRatesController, - // Notification Controllers - authenticationController, - userStorageController, - notificationServicesController, - notificationServicesPushController, - } = this; - - return { - // etc - getState: this.getState.bind(this), - setCurrentCurrency: currencyRateController.setCurrentCurrency.bind( - currencyRateController, - ), - setUseBlockie: preferencesController.setUseBlockie.bind( - preferencesController, - ), - setUseNonceField: preferencesController.setUseNonceField.bind( - preferencesController, - ), - setUsePhishDetect: preferencesController.setUsePhishDetect.bind( - preferencesController, - ), - setUseMultiAccountBalanceChecker: - preferencesController.setUseMultiAccountBalanceChecker.bind( - preferencesController, - ), - setUseSafeChainsListValidation: - preferencesController.setUseSafeChainsListValidation.bind( - preferencesController, - ), - setUseTokenDetection: preferencesController.setUseTokenDetection.bind( - preferencesController, - ), - setUseNftDetection: preferencesController.setUseNftDetection.bind( - preferencesController, - ), - setUse4ByteResolution: preferencesController.setUse4ByteResolution.bind( - preferencesController, - ), - setUseCurrencyRateCheck: - preferencesController.setUseCurrencyRateCheck.bind( - preferencesController, - ), - setOpenSeaEnabled: preferencesController.setOpenSeaEnabled.bind( - preferencesController, - ), - getUseRequestQueue: this.preferencesController.getUseRequestQueue.bind( - this.preferencesController, - ), - getProviderConfig: () => - getProviderConfig({ - metamask: this.networkController.state, - }), - grantPermissionsIncremental: - this.permissionController.grantPermissionsIncremental.bind( - this.permissionController, - ), - grantPermissions: this.permissionController.grantPermissions.bind( - this.permissionController, - ), - setSecurityAlertsEnabled: - preferencesController.setSecurityAlertsEnabled.bind( - preferencesController, - ), - ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) - setAddSnapAccountEnabled: - preferencesController.setAddSnapAccountEnabled.bind( - preferencesController, - ), - ///: END:ONLY_INCLUDE_IF - ///: BEGIN:ONLY_INCLUDE_IF(build-flask) - setWatchEthereumAccountEnabled: - preferencesController.setWatchEthereumAccountEnabled.bind( - preferencesController, - ), - setSolanaSupportEnabled: - preferencesController.setSolanaSupportEnabled.bind( - preferencesController, - ), - ///: END:ONLY_INCLUDE_IF - setBitcoinSupportEnabled: - preferencesController.setBitcoinSupportEnabled.bind( - preferencesController, - ), - setBitcoinTestnetSupportEnabled: - preferencesController.setBitcoinTestnetSupportEnabled.bind( - preferencesController, - ), - setUseExternalNameSources: - preferencesController.setUseExternalNameSources.bind( - preferencesController, - ), - setUseTransactionSimulations: - preferencesController.setUseTransactionSimulations.bind( - preferencesController, - ), - setUseRequestQueue: this.setUseRequestQueue.bind(this), - setIpfsGateway: preferencesController.setIpfsGateway.bind( - preferencesController, - ), - setIsIpfsGatewayEnabled: - preferencesController.setIsIpfsGatewayEnabled.bind( - preferencesController, - ), - setUseAddressBarEnsResolution: - preferencesController.setUseAddressBarEnsResolution.bind( - preferencesController, - ), - setParticipateInMetaMetrics: - metaMetricsController.setParticipateInMetaMetrics.bind( - metaMetricsController, - ), - setDataCollectionForMarketing: - metaMetricsController.setDataCollectionForMarketing.bind( - metaMetricsController, - ), - setMarketingCampaignCookieId: - metaMetricsController.setMarketingCampaignCookieId.bind( - metaMetricsController, - ), - setCurrentLocale: preferencesController.setCurrentLocale.bind( - preferencesController, - ), - setIncomingTransactionsPreferences: - preferencesController.setIncomingTransactionsPreferences.bind( - preferencesController, - ), - setServiceWorkerKeepAlivePreference: - preferencesController.setServiceWorkerKeepAlivePreference.bind( - preferencesController, - ), - markPasswordForgotten: this.markPasswordForgotten.bind(this), - unMarkPasswordForgotten: this.unMarkPasswordForgotten.bind(this), - getRequestAccountTabIds: this.getRequestAccountTabIds, - getOpenMetamaskTabsIds: this.getOpenMetamaskTabsIds, - markNotificationPopupAsAutomaticallyClosed: () => - this.notificationManager.markAsAutomaticallyClosed(), - - // approval - requestUserApproval: - approvalController.addAndShowApprovalRequest.bind(approvalController), - - // primary keyring management - addNewAccount: this.addNewAccount.bind(this), - getSeedPhrase: this.getSeedPhrase.bind(this), - resetAccount: this.resetAccount.bind(this), - removeAccount: this.removeAccount.bind(this), - importAccountWithStrategy: this.importAccountWithStrategy.bind(this), - getNextAvailableAccountName: - accountsController.getNextAvailableAccountName.bind(accountsController), - ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) - getAccountsBySnapId: (snapId) => getAccountsBySnapId(this, snapId), - ///: END:ONLY_INCLUDE_IF - - // hardware wallets - connectHardware: this.connectHardware.bind(this), - forgetDevice: this.forgetDevice.bind(this), - checkHardwareStatus: this.checkHardwareStatus.bind(this), - getDeviceNameForMetric: this.getDeviceNameForMetric.bind(this), - unlockHardwareWalletAccount: this.unlockHardwareWalletAccount.bind(this), - attemptLedgerTransportCreation: - this.attemptLedgerTransportCreation.bind(this), - - // qr hardware devices - submitQRHardwareCryptoHDKey: - keyringController.submitQRCryptoHDKey.bind(keyringController), - submitQRHardwareCryptoAccount: - keyringController.submitQRCryptoAccount.bind(keyringController), - cancelSyncQRHardware: - keyringController.cancelQRSynchronization.bind(keyringController), - submitQRHardwareSignature: - keyringController.submitQRSignature.bind(keyringController), - cancelQRHardwareSignRequest: - keyringController.cancelQRSignRequest.bind(keyringController), - - // vault management - submitPassword: this.submitPassword.bind(this), - verifyPassword: this.verifyPassword.bind(this), - - // network management - setActiveNetwork: (networkConfigurationId) => { - return this.networkController.setActiveNetwork(networkConfigurationId); - }, - // Avoids returning the promise so that initial call to switch network - // doesn't block on the network lookup step - setActiveNetworkConfigurationId: (networkConfigurationId) => { - this.networkController.setActiveNetwork(networkConfigurationId); - }, - setNetworkClientIdForDomain: (origin, networkClientId) => { - return this.selectedNetworkController.setNetworkClientIdForDomain( - origin, - networkClientId, - ); - }, - rollbackToPreviousProvider: - networkController.rollbackToPreviousProvider.bind(networkController), - addNetwork: this.networkController.addNetwork.bind( - this.networkController, - ), - updateNetwork: this.networkController.updateNetwork.bind( - this.networkController, - ), - removeNetwork: this.networkController.removeNetwork.bind( - this.networkController, - ), - getCurrentNetworkEIP1559Compatibility: - this.networkController.getEIP1559Compatibility.bind( - this.networkController, - ), - getNetworkConfigurationByNetworkClientId: - this.networkController.getNetworkConfigurationByNetworkClientId.bind( - this.networkController, - ), - // PreferencesController - setSelectedAddress: (address) => { - const account = this.accountsController.getAccountByAddress(address); - if (account) { - this.accountsController.setSelectedAccount(account.id); - } else { - throw new Error(`No account found for address: ${address}`); - } - }, - toggleExternalServices: this.toggleExternalServices.bind(this), - addToken: tokensController.addToken.bind(tokensController), - updateTokenType: tokensController.updateTokenType.bind(tokensController), - setFeatureFlag: preferencesController.setFeatureFlag.bind( - preferencesController, - ), - setPreference: preferencesController.setPreference.bind( - preferencesController, - ), - - addKnownMethodData: preferencesController.addKnownMethodData.bind( - preferencesController, - ), - setDismissSeedBackUpReminder: - preferencesController.setDismissSeedBackUpReminder.bind( - preferencesController, - ), - setAdvancedGasFee: preferencesController.setAdvancedGasFee.bind( - preferencesController, - ), - setTheme: preferencesController.setTheme.bind(preferencesController), - ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) - setSnapsAddSnapAccountModalDismissed: - preferencesController.setSnapsAddSnapAccountModalDismissed.bind( - preferencesController, - ), - ///: END:ONLY_INCLUDE_IF - - // AccountsController - setSelectedInternalAccount: (id) => { - const account = this.accountsController.getAccount(id); - if (account) { - this.accountsController.setSelectedAccount(id); - } - }, - - setAccountName: - accountsController.setAccountName.bind(accountsController), - - setAccountLabel: (address, label) => { - const account = this.accountsController.getAccountByAddress(address); - if (account === undefined) { - throw new Error(`No account found for address: ${address}`); - } - this.accountsController.setAccountName(account.id, label); - }, - - // AssetsContractController - getTokenStandardAndDetails: this.getTokenStandardAndDetails.bind(this), - getTokenSymbol: this.getTokenSymbol.bind(this), - - // NftController - addNft: nftController.addNft.bind(nftController), - - addNftVerifyOwnership: - nftController.addNftVerifyOwnership.bind(nftController), - - removeAndIgnoreNft: nftController.removeAndIgnoreNft.bind(nftController), - - removeNft: nftController.removeNft.bind(nftController), - - checkAndUpdateAllNftsOwnershipStatus: - nftController.checkAndUpdateAllNftsOwnershipStatus.bind(nftController), - - checkAndUpdateSingleNftOwnershipStatus: - nftController.checkAndUpdateSingleNftOwnershipStatus.bind( - nftController, - ), - - getNFTContractInfo: nftController.getNFTContractInfo.bind(nftController), - - isNftOwner: nftController.isNftOwner.bind(nftController), - - // AddressController - setAddressBook: addressBookController.set.bind(addressBookController), - removeFromAddressBook: addressBookController.delete.bind( - addressBookController, - ), - - // AppStateController - setLastActiveTime: - appStateController.setLastActiveTime.bind(appStateController), - setCurrentExtensionPopupId: - appStateController.setCurrentExtensionPopupId.bind(appStateController), - setDefaultHomeActiveTabName: - appStateController.setDefaultHomeActiveTabName.bind(appStateController), - setConnectedStatusPopoverHasBeenShown: - appStateController.setConnectedStatusPopoverHasBeenShown.bind( - appStateController, - ), - setRecoveryPhraseReminderHasBeenShown: - appStateController.setRecoveryPhraseReminderHasBeenShown.bind( - appStateController, - ), - setRecoveryPhraseReminderLastShown: - appStateController.setRecoveryPhraseReminderLastShown.bind( - appStateController, - ), - setTermsOfUseLastAgreed: - appStateController.setTermsOfUseLastAgreed.bind(appStateController), - setSurveyLinkLastClickedOrClosed: - appStateController.setSurveyLinkLastClickedOrClosed.bind( - appStateController, - ), - setOnboardingDate: - appStateController.setOnboardingDate.bind(appStateController), - setLastViewedUserSurvey: - appStateController.setLastViewedUserSurvey.bind(appStateController), - setNewPrivacyPolicyToastClickedOrClosed: - appStateController.setNewPrivacyPolicyToastClickedOrClosed.bind( - appStateController, - ), - setNewPrivacyPolicyToastShownDate: - appStateController.setNewPrivacyPolicyToastShownDate.bind( - appStateController, - ), - setSnapsInstallPrivacyWarningShownStatus: - appStateController.setSnapsInstallPrivacyWarningShownStatus.bind( - appStateController, - ), - setOutdatedBrowserWarningLastShown: - appStateController.setOutdatedBrowserWarningLastShown.bind( - appStateController, - ), - setShowTestnetMessageInDropdown: - appStateController.setShowTestnetMessageInDropdown.bind( - appStateController, - ), - setShowBetaHeader: - appStateController.setShowBetaHeader.bind(appStateController), - setShowPermissionsTour: - appStateController.setShowPermissionsTour.bind(appStateController), - setShowAccountBanner: - appStateController.setShowAccountBanner.bind(appStateController), - setShowNetworkBanner: - appStateController.setShowNetworkBanner.bind(appStateController), - updateNftDropDownState: - appStateController.updateNftDropDownState.bind(appStateController), - setFirstTimeUsedNetwork: - appStateController.setFirstTimeUsedNetwork.bind(appStateController), - setSwitchedNetworkDetails: - appStateController.setSwitchedNetworkDetails.bind(appStateController), - clearSwitchedNetworkDetails: - appStateController.clearSwitchedNetworkDetails.bind(appStateController), - setSwitchedNetworkNeverShowMessage: - appStateController.setSwitchedNetworkNeverShowMessage.bind( - appStateController, - ), - getLastInteractedConfirmationInfo: - appStateController.getLastInteractedConfirmationInfo.bind( - appStateController, - ), - setLastInteractedConfirmationInfo: - appStateController.setLastInteractedConfirmationInfo.bind( - appStateController, - ), - - // EnsController - tryReverseResolveAddress: - ensController.reverseResolveAddress.bind(ensController), - - // KeyringController - setLocked: this.setLocked.bind(this), - createNewVaultAndKeychain: this.createNewVaultAndKeychain.bind(this), - createNewVaultAndRestore: this.createNewVaultAndRestore.bind(this), - exportAccount: this.exportAccount.bind(this), - - // txController - updateTransaction: txController.updateTransaction.bind(txController), - approveTransactionsWithSameNonce: - txController.approveTransactionsWithSameNonce.bind(txController), - createCancelTransaction: this.createCancelTransaction.bind(this), - createSpeedUpTransaction: this.createSpeedUpTransaction.bind(this), - estimateGas: this.estimateGas.bind(this), - estimateGasFee: txController.estimateGasFee.bind(txController), - getNextNonce: this.getNextNonce.bind(this), - addTransaction: (transactionParams, transactionOptions) => - addTransaction( - this.getAddTransactionRequest({ - transactionParams, - transactionOptions, - waitForSubmit: false, - }), - ), - addTransactionAndWaitForPublish: ( - transactionParams, - transactionOptions, - ) => - addTransaction( - this.getAddTransactionRequest({ - transactionParams, - transactionOptions, - waitForSubmit: true, - }), - ), - createTransactionEventFragment: - createTransactionEventFragmentWithTxId.bind( - null, - this.getTransactionMetricsRequest(), - ), - getTransactions: this.txController.getTransactions.bind( - this.txController, - ), - updateEditableParams: this.txController.updateEditableParams.bind( - this.txController, - ), - updateTransactionGasFees: - txController.updateTransactionGasFees.bind(txController), - updateTransactionSendFlowHistory: - txController.updateTransactionSendFlowHistory.bind(txController), - updatePreviousGasParams: - txController.updatePreviousGasParams.bind(txController), - abortTransactionSigning: - txController.abortTransactionSigning.bind(txController), - getLayer1GasFee: txController.getLayer1GasFee.bind(txController), - - // decryptMessageController - decryptMessage: this.decryptMessageController.decryptMessage.bind( - this.decryptMessageController, - ), - decryptMessageInline: - this.decryptMessageController.decryptMessageInline.bind( - this.decryptMessageController, - ), - cancelDecryptMessage: - this.decryptMessageController.cancelDecryptMessage.bind( - this.decryptMessageController, - ), - - // EncryptionPublicKeyController - encryptionPublicKey: - this.encryptionPublicKeyController.encryptionPublicKey.bind( - this.encryptionPublicKeyController, - ), - cancelEncryptionPublicKey: - this.encryptionPublicKeyController.cancelEncryptionPublicKey.bind( - this.encryptionPublicKeyController, - ), - - // onboarding controller - setSeedPhraseBackedUp: - onboardingController.setSeedPhraseBackedUp.bind(onboardingController), - completeOnboarding: - onboardingController.completeOnboarding.bind(onboardingController), - setFirstTimeFlowType: - onboardingController.setFirstTimeFlowType.bind(onboardingController), - - // alert controller - setAlertEnabledness: - alertController.setAlertEnabledness.bind(alertController), - setUnconnectedAccountAlertShown: - alertController.setUnconnectedAccountAlertShown.bind(alertController), - setWeb3ShimUsageAlertDismissed: - alertController.setWeb3ShimUsageAlertDismissed.bind(alertController), - - // permissions - removePermissionsFor: this.removePermissionsFor, - approvePermissionsRequest: this.acceptPermissionsRequest, - rejectPermissionsRequest: this.rejectPermissionsRequest, - ...getPermissionBackgroundApiMethods(permissionController), - - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - connectCustodyAddresses: this.mmiController.connectCustodyAddresses.bind( - this.mmiController, - ), - getCustodianAccounts: this.mmiController.getCustodianAccounts.bind( - this.mmiController, - ), - getCustodianTransactionDeepLink: - this.mmiController.getCustodianTransactionDeepLink.bind( - this.mmiController, - ), - getCustodianConfirmDeepLink: - this.mmiController.getCustodianConfirmDeepLink.bind(this.mmiController), - getCustodianSignMessageDeepLink: - this.mmiController.getCustodianSignMessageDeepLink.bind( - this.mmiController, - ), - getCustodianToken: this.mmiController.getCustodianToken.bind( - this.mmiController, - ), - getCustodianJWTList: this.mmiController.getCustodianJWTList.bind( - this.mmiController, - ), - getAllCustodianAccountsWithToken: - this.mmiController.getAllCustodianAccountsWithToken.bind( - this.mmiController, - ), - setCustodianNewRefreshToken: - this.mmiController.setCustodianNewRefreshToken.bind(this.mmiController), - setWaitForConfirmDeepLinkDialog: - this.custodyController.setWaitForConfirmDeepLinkDialog.bind( - this.custodyController, - ), - getMmiConfiguration: - this.mmiConfigurationController.getConfiguration.bind( - this.mmiConfigurationController, - ), - removeAddTokenConnectRequest: - this.institutionalFeaturesController.removeAddTokenConnectRequest.bind( - this.institutionalFeaturesController, - ), - setConnectionRequest: - this.institutionalFeaturesController.setConnectionRequest.bind( - this.institutionalFeaturesController, - ), - showInteractiveReplacementTokenBanner: - appStateController.showInteractiveReplacementTokenBanner.bind( - appStateController, - ), - setCustodianDeepLink: - appStateController.setCustodianDeepLink.bind(appStateController), - setNoteToTraderMessage: - appStateController.setNoteToTraderMessage.bind(appStateController), - logAndStoreApiRequest: this.mmiController.logAndStoreApiRequest.bind( - this.mmiController, - ), - ///: END:ONLY_INCLUDE_IF - - // snaps - disableSnap: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:disable', - ), - enableSnap: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:enable', - ), - updateSnap: (origin, requestedSnaps) => { - // We deliberately do not await this promise as that would mean waiting for the update to complete - // Instead we return null to signal to the UI that it is safe to redirect to the update flow - this.controllerMessenger.call( - 'SnapController:install', - origin, - requestedSnaps, - ); - return null; - }, - removeSnap: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:remove', - ), - handleSnapRequest: this.handleSnapRequest.bind(this), - revokeDynamicSnapPermissions: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:revokeDynamicPermissions', - ), - dismissNotifications: this.dismissNotifications.bind(this), - markNotificationsAsRead: this.markNotificationsAsRead.bind(this), - disconnectOriginFromSnap: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:disconnectOrigin', - ), - updateNetworksList: this.updateNetworksList.bind(this), - updateAccountsList: this.updateAccountsList.bind(this), - updateHiddenAccountsList: this.updateHiddenAccountsList.bind(this), - getPhishingResult: async (website) => { - await phishingController.maybeUpdateState(); - - return phishingController.test(website); - }, - deleteInterface: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapInterfaceController:deleteInterface', - ), - updateInterfaceState: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapInterfaceController:updateInterfaceState', - ), - - // swaps - fetchAndSetQuotes: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:fetchAndSetQuotes', - ), - setSelectedQuoteAggId: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setSelectedQuoteAggId', - ), - resetSwapsState: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:resetSwapsState', - ), - setSwapsTokens: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setSwapsTokens', - ), - clearSwapsQuotes: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:clearSwapsQuotes', - ), - setApproveTxId: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setApproveTxId', - ), - setTradeTxId: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setTradeTxId', - ), - setSwapsTxGasPrice: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setSwapsTxGasPrice', - ), - setSwapsTxGasLimit: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setSwapsTxGasLimit', - ), - setSwapsTxMaxFeePerGas: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setSwapsTxMaxFeePerGas', - ), - setSwapsTxMaxFeePriorityPerGas: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setSwapsTxMaxFeePriorityPerGas', - ), - safeRefetchQuotes: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:safeRefetchQuotes', - ), - stopPollingForQuotes: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:stopPollingForQuotes', - ), - setBackgroundSwapRouteState: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setBackgroundSwapRouteState', - ), - resetPostFetchState: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:resetPostFetchState', - ), - setSwapsErrorKey: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setSwapsErrorKey', - ), - setInitialGasEstimate: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setInitialGasEstimate', - ), - setCustomApproveTxData: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setCustomApproveTxData', - ), - setSwapsLiveness: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setSwapsLiveness', - ), - setSwapsFeatureFlags: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setSwapsFeatureFlags', - ), - setSwapsUserFeeLevel: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setSwapsUserFeeLevel', - ), - setSwapsQuotesPollingLimitEnabled: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SwapsController:setSwapsQuotesPollingLimitEnabled', - ), - - // Bridge - [BridgeBackgroundAction.SET_FEATURE_FLAGS]: - this.controllerMessenger.call.bind( - this.controllerMessenger, - `${BRIDGE_CONTROLLER_NAME}:${BridgeBackgroundAction.SET_FEATURE_FLAGS}`, - ), - [BridgeUserAction.SELECT_SRC_NETWORK]: this.controllerMessenger.call.bind( - this.controllerMessenger, - `${BRIDGE_CONTROLLER_NAME}:${BridgeUserAction.SELECT_SRC_NETWORK}`, - ), - [BridgeUserAction.SELECT_DEST_NETWORK]: - this.controllerMessenger.call.bind( - this.controllerMessenger, - `${BRIDGE_CONTROLLER_NAME}:${BridgeUserAction.SELECT_DEST_NETWORK}`, - ), - [BridgeUserAction.UPDATE_QUOTE_PARAMS]: - this.controllerMessenger.call.bind( - this.controllerMessenger, - `${BRIDGE_CONTROLLER_NAME}:${BridgeUserAction.UPDATE_QUOTE_PARAMS}`, - ), - - // Smart Transactions - fetchSmartTransactionFees: smartTransactionsController.getFees.bind( - smartTransactionsController, - ), - clearSmartTransactionFees: smartTransactionsController.clearFees.bind( - smartTransactionsController, - ), - submitSignedTransactions: - smartTransactionsController.submitSignedTransactions.bind( - smartTransactionsController, - ), - cancelSmartTransaction: - smartTransactionsController.cancelSmartTransaction.bind( - smartTransactionsController, - ), - fetchSmartTransactionsLiveness: - smartTransactionsController.fetchLiveness.bind( - smartTransactionsController, - ), - updateSmartTransaction: - smartTransactionsController.updateSmartTransaction.bind( - smartTransactionsController, - ), - setStatusRefreshInterval: - smartTransactionsController.setStatusRefreshInterval.bind( - smartTransactionsController, - ), - - // MetaMetrics - trackMetaMetricsEvent: metaMetricsController.trackEvent.bind( - metaMetricsController, - ), - trackMetaMetricsPage: metaMetricsController.trackPage.bind( - metaMetricsController, - ), - createEventFragment: metaMetricsController.createEventFragment.bind( - metaMetricsController, - ), - updateEventFragment: metaMetricsController.updateEventFragment.bind( - metaMetricsController, - ), - finalizeEventFragment: metaMetricsController.finalizeEventFragment.bind( - metaMetricsController, - ), - trackInsightSnapView: this.trackInsightSnapView.bind(this), - - // approval controller - resolvePendingApproval: this.resolvePendingApproval, - rejectPendingApproval: this.rejectPendingApproval, - - // Notifications - resetViewedNotifications: announcementController.resetViewed.bind( - announcementController, - ), - updateViewedNotifications: announcementController.updateViewed.bind( - announcementController, - ), - - // CurrencyRateController - currencyRateStartPolling: currencyRateController.startPolling.bind( - currencyRateController, - ), - currencyRateStopPollingByPollingToken: - currencyRateController.stopPollingByPollingToken.bind( - currencyRateController, - ), - - tokenRatesStartPolling: - tokenRatesController.startPolling.bind(tokenRatesController), - tokenRatesStopPollingByPollingToken: - tokenRatesController.stopPollingByPollingToken.bind( - tokenRatesController, - ), - - // GasFeeController - gasFeeStartPollingByNetworkClientId: - gasFeeController.startPollingByNetworkClientId.bind(gasFeeController), - gasFeeStopPollingByPollingToken: - gasFeeController.stopPollingByPollingToken.bind(gasFeeController), - - getGasFeeTimeEstimate: - gasFeeController.getTimeEstimate.bind(gasFeeController), - - addPollingTokenToAppState: - appStateController.addPollingToken.bind(appStateController), - - removePollingTokenFromAppState: - appStateController.removePollingToken.bind(appStateController), - - // Backup - backupUserData: backup.backupUserData.bind(backup), - restoreUserData: backup.restoreUserData.bind(backup), - - // TokenDetectionController - detectTokens: tokenDetectionController.detectTokens.bind( - tokenDetectionController, - ), - - // DetectCollectibleController - detectNfts: nftDetectionController.detectNfts.bind( - nftDetectionController, - ), - - /** Token Detection V2 */ - addDetectedTokens: - tokensController.addDetectedTokens.bind(tokensController), - addImportedTokens: tokensController.addTokens.bind(tokensController), - ignoreTokens: tokensController.ignoreTokens.bind(tokensController), - getBalancesInSingleCall: - assetsContractController.getBalancesInSingleCall.bind( - assetsContractController, - ), - - // Authentication Controller - performSignIn: authenticationController.performSignIn.bind( - authenticationController, - ), - performSignOut: authenticationController.performSignOut.bind( - authenticationController, - ), - - // UserStorageController - enableProfileSyncing: userStorageController.enableProfileSyncing.bind( - userStorageController, - ), - disableProfileSyncing: userStorageController.disableProfileSyncing.bind( - userStorageController, - ), - setIsProfileSyncingEnabled: - userStorageController.setIsProfileSyncingEnabled.bind( - userStorageController, - ), - syncInternalAccountsWithUserStorage: - userStorageController.syncInternalAccountsWithUserStorage.bind( - userStorageController, - ), - deleteAccountSyncingDataFromUserStorage: - userStorageController.performDeleteStorageAllFeatureEntries.bind( - userStorageController, - ), - - // NotificationServicesController - checkAccountsPresence: - notificationServicesController.checkAccountsPresence.bind( - notificationServicesController, - ), - createOnChainTriggers: - notificationServicesController.createOnChainTriggers.bind( - notificationServicesController, - ), - deleteOnChainTriggersByAccount: - notificationServicesController.deleteOnChainTriggersByAccount.bind( - notificationServicesController, - ), - updateOnChainTriggersByAccount: - notificationServicesController.updateOnChainTriggersByAccount.bind( - notificationServicesController, - ), - fetchAndUpdateMetamaskNotifications: - notificationServicesController.fetchAndUpdateMetamaskNotifications.bind( - notificationServicesController, - ), - markMetamaskNotificationsAsRead: - notificationServicesController.markMetamaskNotificationsAsRead.bind( - notificationServicesController, - ), - setFeatureAnnouncementsEnabled: - notificationServicesController.setFeatureAnnouncementsEnabled.bind( - notificationServicesController, - ), - enablePushNotifications: - notificationServicesPushController.enablePushNotifications.bind( - notificationServicesPushController, - ), - disablePushNotifications: - notificationServicesPushController.disablePushNotifications.bind( - notificationServicesPushController, - ), - updateTriggerPushNotifications: - notificationServicesPushController.updateTriggerPushNotifications.bind( - notificationServicesPushController, - ), - enableMetamaskNotifications: - notificationServicesController.enableMetamaskNotifications.bind( - notificationServicesController, - ), - disableMetamaskNotifications: - notificationServicesController.disableNotificationServices.bind( - notificationServicesController, - ), - - // E2E testing - throwTestError: this.throwTestError.bind(this), - - // NameController - updateProposedNames: this.nameController.updateProposedNames.bind( - this.nameController, - ), - setName: this.nameController.setName.bind(this.nameController), - - // MultichainBalancesController - multichainUpdateBalance: (accountId) => - this.multichainBalancesController.updateBalance(accountId), - - multichainUpdateBalances: () => - this.multichainBalancesController.updateBalances(), - - // Transaction Decode - decodeTransactionData: (request) => - decodeTransactionData({ - ...request, - ethQuery: new EthQuery(this.provider), - }), - // metrics data deleteion - createMetaMetricsDataDeletionTask: - this.metaMetricsDataDeletionController.createMetaMetricsDataDeletionTask.bind( - this.metaMetricsDataDeletionController, - ), - updateDataDeletionTaskStatus: - this.metaMetricsDataDeletionController.updateDataDeletionTaskStatus.bind( - this.metaMetricsDataDeletionController, - ), - // Trace - endTrace, - }; - } - - async exportAccount(address, password) { - await this.verifyPassword(password); - return this.keyringController.exportAccount(password, address); - } - - async getTokenStandardAndDetails(address, userAddress, tokenId) { - const { tokenList } = this.tokenListController.state; - const { tokens } = this.tokensController.state; - - const staticTokenListDetails = - STATIC_MAINNET_TOKEN_LIST[address?.toLowerCase()] || {}; - const tokenListDetails = tokenList[address.toLowerCase()] || {}; - const userDefinedTokenDetails = - tokens.find(({ address: _address }) => - isEqualCaseInsensitive(_address, address), - ) || {}; - - const tokenDetails = { - ...staticTokenListDetails, - ...tokenListDetails, - ...userDefinedTokenDetails, - }; - - const tokenDetailsStandardIsERC20 = - isEqualCaseInsensitive(tokenDetails.standard, TokenStandard.ERC20) || - tokenDetails.erc20 === true; - - const noEvidenceThatTokenIsAnNFT = - !tokenId && - !isEqualCaseInsensitive(tokenDetails.standard, TokenStandard.ERC1155) && - !isEqualCaseInsensitive(tokenDetails.standard, TokenStandard.ERC721) && - !tokenDetails.erc721; - - const otherDetailsAreERC20Like = - tokenDetails.decimals !== undefined && tokenDetails.symbol; - - const tokenCanBeTreatedAsAnERC20 = - tokenDetailsStandardIsERC20 || - (noEvidenceThatTokenIsAnNFT && otherDetailsAreERC20Like); - - let details; - if (tokenCanBeTreatedAsAnERC20) { - try { - const balance = userAddress - ? await fetchTokenBalance(address, userAddress, this.provider) - : undefined; - - details = { - address, - balance, - standard: TokenStandard.ERC20, - decimals: tokenDetails.decimals, - symbol: tokenDetails.symbol, - }; - } catch (e) { - // If the `fetchTokenBalance` call failed, `details` remains undefined, and we - // fall back to the below `assetsContractController.getTokenStandardAndDetails` call - log.warn(`Failed to get token balance. Error: ${e}`); - } - } - - // `details`` will be undefined if `tokenCanBeTreatedAsAnERC20`` is false, - // or if it is true but the `fetchTokenBalance`` call failed. In either case, we should - // attempt to retrieve details from `assetsContractController.getTokenStandardAndDetails` - if (details === undefined) { - details = await this.assetsContractController.getTokenStandardAndDetails( - address, - userAddress, - tokenId, - ); - } - - const tokenDetailsStandardIsERC1155 = isEqualCaseInsensitive( - details.standard, - TokenStandard.ERC1155, - ); - - if (tokenDetailsStandardIsERC1155) { - try { - const balance = await fetchERC1155Balance( - address, - userAddress, - tokenId, - this.provider, - ); - - const balanceToUse = balance?._hex - ? parseInt(balance._hex, 16).toString() - : null; - - details = { - ...details, - balance: balanceToUse, - }; - } catch (e) { - // If the `fetchTokenBalance` call failed, `details` remains undefined, and we - // fall back to the below `assetsContractController.getTokenStandardAndDetails` call - log.warn('Failed to get token balance. Error:', e); - } - } - - return { - ...details, - decimals: details?.decimals?.toString(10), - balance: details?.balance?.toString(10), - }; - } - - async getTokenSymbol(address) { - try { - const details = - await this.assetsContractController.getTokenStandardAndDetails(address); - return details?.symbol; - } catch (e) { - return null; - } - } - - //============================================================================= - // VAULT / KEYRING RELATED METHODS - //============================================================================= - - /** - * Creates a new Vault and create a new keychain. - * - * A vault, or KeyringController, is a controller that contains - * many different account strategies, currently called Keyrings. - * Creating it new means wiping all previous keyrings. - * - * A keychain, or keyring, controls many accounts with a single backup and signing strategy. - * For example, a mnemonic phrase can generate many accounts, and is a keyring. - * - * @param {string} password - * @returns {object} vault - */ - async createNewVaultAndKeychain(password) { - const releaseLock = await this.createVaultMutex.acquire(); - try { - return await this.keyringController.createNewVaultAndKeychain(password); - } finally { - releaseLock(); - } - } - - /** - * Create a new Vault and restore an existent keyring. - * - * @param {string} password - * @param {number[]} encodedSeedPhrase - The seed phrase, encoded as an array - * of UTF-8 bytes. - */ - async createNewVaultAndRestore(password, encodedSeedPhrase) { - const releaseLock = await this.createVaultMutex.acquire(); - try { - const { completedOnboarding } = this.onboardingController.state; - - const seedPhraseAsBuffer = Buffer.from(encodedSeedPhrase); - - // clear permissions - this.permissionController.clearState(); - - // Clear snap state - this.snapController.clearState(); - // Clear notification state - this.notificationController.clear(); - - // clear accounts in AccountTrackerController - this.accountTrackerController.clearAccounts(); - - this.txController.clearUnapprovedTransactions(); - - if (completedOnboarding) { - this.tokenDetectionController.enable(); - } - - // create new vault - await this.keyringController.createNewVaultAndRestore( - password, - this._convertMnemonicToWordlistIndices(seedPhraseAsBuffer), - ); - - if (completedOnboarding) { - await this._addAccountsWithBalance(); - - // This must be set as soon as possible to communicate to the - // keyring's iframe and have the setting initialized properly - // Optimistically called to not block MetaMask login due to - // Ledger Keyring GitHub downtime - this.setLedgerTransportPreference(); - } - } finally { - releaseLock(); - } - } - - async _addAccountsWithBalance() { - // Scan accounts until we find an empty one - const chainId = getCurrentChainId({ - metamask: this.networkController.state, - }); - const ethQuery = new EthQuery(this.provider); - const accounts = await this.keyringController.getAccounts(); - let address = accounts[accounts.length - 1]; - - for (let count = accounts.length; ; count++) { - const balance = await this.getBalance(address, ethQuery); - - if (balance === '0x0') { - // This account has no balance, so check for tokens - await this.tokenDetectionController.detectTokens({ - selectedAddress: address, - }); - - const tokens = - this.tokensController.state.allTokens?.[chainId]?.[address]; - const detectedTokens = - this.tokensController.state.allDetectedTokens?.[chainId]?.[address]; - - if ( - (tokens?.length ?? 0) === 0 && - (detectedTokens?.length ?? 0) === 0 - ) { - // This account has no balance or tokens - if (count !== 1) { - await this.removeAccount(address); - } - break; - } - } - - // This account has assets, so check the next one - address = await this.keyringController.addNewAccount(count); - } - } - - /** - * Encodes a BIP-39 mnemonic as the indices of words in the English BIP-39 wordlist. - * - * @param {Buffer} mnemonic - The BIP-39 mnemonic. - * @returns {Buffer} The Unicode code points for the seed phrase formed from the words in the wordlist. - */ - _convertMnemonicToWordlistIndices(mnemonic) { - const indices = mnemonic - .toString() - .split(' ') - .map((word) => wordlist.indexOf(word)); - return new Uint8Array(new Uint16Array(indices).buffer); - } - - /** - * Converts a BIP-39 mnemonic stored as indices of words in the English wordlist to a buffer of Unicode code points. - * - * @param {Uint8Array} wordlistIndices - Indices to specific words in the BIP-39 English wordlist. - * @returns {Buffer} The BIP-39 mnemonic formed from the words in the English wordlist, encoded as a list of Unicode code points. - */ - _convertEnglishWordlistIndicesToCodepoints(wordlistIndices) { - return Buffer.from( - Array.from(new Uint16Array(wordlistIndices.buffer)) - .map((i) => wordlist[i]) - .join(' '), - ); - } - - /** - * Get an account balance from the AccountTrackerController or request it directly from the network. - * - * @param {string} address - The account address - * @param {EthQuery} ethQuery - The EthQuery instance to use when asking the network - */ - getBalance(address, ethQuery) { - return new Promise((resolve, reject) => { - const cached = this.accountTrackerController.state.accounts[address]; - - if (cached && cached.balance) { - resolve(cached.balance); - } else { - ethQuery.getBalance(address, (error, balance) => { - if (error) { - reject(error); - log.error(error); - } else { - resolve(balance || '0x0'); - } - }); - } - }); - } - - /** - * Submits the user's password and attempts to unlock the vault. - * Also synchronizes the preferencesController, to ensure its schema - * is up to date with known accounts once the vault is decrypted. - * - * @param {string} password - The user's password - */ - async submitPassword(password) { - const { completedOnboarding } = this.onboardingController.state; - - // Before attempting to unlock the keyrings, we need the offscreen to have loaded. - await this.offscreenPromise; - - await this.keyringController.submitPassword(password); - - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - this.mmiController.onSubmitPassword(); - ///: END:ONLY_INCLUDE_IF - - try { - await this.blockTracker.checkForLatestBlock(); - } catch (error) { - log.error('Error while unlocking extension.', error); - } - - await this.accountsController.updateAccounts(); - - // This must be set as soon as possible to communicate to the - // keyring's iframe and have the setting initialized properly - // Optimistically called to not block MetaMask login due to - // Ledger Keyring GitHub downtime - if (completedOnboarding) { - this.setLedgerTransportPreference(); - } - } - - async _loginUser(password) { - try { - // Automatic login via config password - await this.submitPassword(password); - - // Updating accounts in this.accountTrackerController before starting UI syncing ensure that - // state has account balance before it is synced with UI - await this.accountTrackerController.updateAccountsAllActiveNetworks(); - } finally { - this._startUISync(); - } - } - - _startUISync() { - // Message startUISync is used to start syncing state with UI - // Sending this message after login is completed helps to ensure that incomplete state without - // account details are not flushed to UI. - this.emit('startUISync'); - this.startUISync = true; - this.memStore.subscribe(this.sendUpdate.bind(this)); - } - - /** - * Submits a user's encryption key to log the user in via login token - */ - async submitEncryptionKey() { - try { - const { loginToken, loginSalt } = - await this.extension.storage.session.get(['loginToken', 'loginSalt']); - if (loginToken && loginSalt) { - const { vault } = this.keyringController.state; - - const jsonVault = JSON.parse(vault); - - if (jsonVault.salt !== loginSalt) { - console.warn( - 'submitEncryptionKey: Stored salt and vault salt do not match', - ); - await this.clearLoginArtifacts(); - return; - } - - await this.keyringController.submitEncryptionKey(loginToken, loginSalt); - } - } catch (e) { - // If somehow this login token doesn't work properly, - // remove it and the user will get shown back to the unlock screen - await this.clearLoginArtifacts(); - throw e; - } - } - - async clearLoginArtifacts() { - await this.extension.storage.session.remove(['loginToken', 'loginSalt']); - } - - /** - * Submits a user's password to check its validity. - * - * @param {string} password - The user's password - */ - async verifyPassword(password) { - await this.keyringController.verifyPassword(password); - } - - /** - * @type Identity - * @property {string} name - The account nickname. - * @property {string} address - The account's ethereum address, in lower case. - * receiving funds from our automatic Ropsten faucet. - */ - - /** - * Gets the mnemonic of the user's primary keyring. - */ - getPrimaryKeyringMnemonic() { - const [keyring] = this.keyringController.getKeyringsByType( - KeyringType.hdKeyTree, - ); - if (!keyring.mnemonic) { - throw new Error('Primary keyring mnemonic unavailable.'); - } - - return keyring.mnemonic; - } - - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - async getCustodyKeyringIfExists(address) { - const custodyType = this.custodyController.getCustodyTypeByAddress( - toChecksumHexAddress(address), - ); - const keyring = this.keyringController.getKeyringsByType(custodyType)[0]; - return keyring?.getAccountDetails(address) ? keyring : undefined; - } - ///: END:ONLY_INCLUDE_IF - - // - // Hardware - // - - async getKeyringForDevice(deviceName, hdPath = null) { - const keyringOverrides = this.opts.overrides?.keyrings; - let keyringName = null; - switch (deviceName) { - case HardwareDeviceNames.trezor: - keyringName = keyringOverrides?.trezor?.type || TrezorKeyring.type; - break; - case HardwareDeviceNames.ledger: - keyringName = keyringOverrides?.ledger?.type || LedgerKeyring.type; - break; - case HardwareDeviceNames.qr: - keyringName = QRHardwareKeyring.type; - break; - case HardwareDeviceNames.lattice: - keyringName = keyringOverrides?.lattice?.type || LatticeKeyring.type; - break; - default: - throw new Error( - 'MetamaskController:getKeyringForDevice - Unknown device', - ); - } - let [keyring] = await this.keyringController.getKeyringsByType(keyringName); - if (!keyring) { - keyring = await this.keyringController.addNewKeyring(keyringName); - } - if (hdPath && keyring.setHdPath) { - keyring.setHdPath(hdPath); - } - if (deviceName === HardwareDeviceNames.lattice) { - keyring.appName = 'MetaMask'; - } - if (deviceName === HardwareDeviceNames.trezor) { - const model = keyring.getModel(); - this.appStateController.setTrezorModel(model); - } - - keyring.network = getProviderConfig({ - metamask: this.networkController.state, - }).type; - - return keyring; - } - - async attemptLedgerTransportCreation() { - const keyring = await this.getKeyringForDevice(HardwareDeviceNames.ledger); - return await keyring.attemptMakeApp(); - } - - /** - * Fetch account list from a hardware device. - * - * @param deviceName - * @param page - * @param hdPath - * @returns [] accounts - */ - async connectHardware(deviceName, page, hdPath) { - const keyring = await this.getKeyringForDevice(deviceName, hdPath); - - if (deviceName === HardwareDeviceNames.ledger) { - await this.setLedgerTransportPreference(keyring); - } - - let accounts = []; - switch (page) { - case -1: - accounts = await keyring.getPreviousPage(); - break; - case 1: - accounts = await keyring.getNextPage(); - break; - default: - accounts = await keyring.getFirstPage(); - } - - // Merge with existing accounts - // and make sure addresses are not repeated - const oldAccounts = await this.keyringController.getAccounts(); - - const accountsToTrack = [ - ...new Set( - oldAccounts.concat(accounts.map((a) => a.address.toLowerCase())), - ), - ]; - this.accountTrackerController.syncWithAddresses(accountsToTrack); - return accounts; - } - - /** - * Check if the device is unlocked - * - * @param deviceName - * @param hdPath - * @returns {Promise} - */ - async checkHardwareStatus(deviceName, hdPath) { - const keyring = await this.getKeyringForDevice(deviceName, hdPath); - return keyring.isUnlocked(); - } - - /** - * Get hardware device name for metric logging. - * - * @param deviceName - HardwareDeviceNames - * @param hdPath - string - * @returns {Promise} - */ - async getDeviceNameForMetric(deviceName, hdPath) { - if (deviceName === HardwareDeviceNames.trezor) { - const keyring = await this.getKeyringForDevice(deviceName, hdPath); - const { minorVersion } = keyring.bridge; - // Specific case for OneKey devices, see `ONE_KEY_VIA_TREZOR_MINOR_VERSION` for further details. - if (minorVersion && minorVersion === ONE_KEY_VIA_TREZOR_MINOR_VERSION) { - return HardwareDeviceNames.oneKeyViaTrezor; - } - } - - return deviceName; - } - - /** - * Clear - * - * @param deviceName - * @returns {Promise} - */ - async forgetDevice(deviceName) { - const keyring = await this.getKeyringForDevice(deviceName); - - for (const address of keyring.accounts) { - await this.removeAccount(address); - } - - keyring.forgetDevice(); - return true; - } - - /** - * Retrieves the keyring for the selected address and using the .type returns - * a subtype for the account. Either 'hardware', 'imported', 'snap', or 'MetaMask'. - * - * @param {string} address - Address to retrieve keyring for - * @returns {'hardware' | 'imported' | 'snap' | 'MetaMask'} - */ - async getAccountType(address) { - const keyringType = await this.keyringController.getAccountKeyringType( - address, - ); - switch (keyringType) { - case KeyringType.trezor: - case KeyringType.lattice: - case KeyringType.qr: - case KeyringType.ledger: - return 'hardware'; - case KeyringType.imported: - return 'imported'; - case KeyringType.snap: - return 'snap'; - default: - return 'MetaMask'; - } - } - - /** - * Retrieves the keyring for the selected address and using the .type - * determines if a more specific name for the device is available. Returns - * undefined for non hardware wallets. - * - * @param {string} address - Address to retrieve keyring for - * @returns {'ledger' | 'lattice' | string | undefined} - */ - async getDeviceModel(address) { - const keyring = await this.keyringController.getKeyringForAccount(address); - switch (keyring.type) { - case KeyringType.trezor: - return keyring.getModel(); - case KeyringType.qr: - return keyring.getName(); - case KeyringType.ledger: - // TODO: get model after ledger keyring exposes method - return HardwareDeviceNames.ledger; - case KeyringType.lattice: - // TODO: get model after lattice keyring exposes method - return HardwareDeviceNames.lattice; - default: - return undefined; - } - } - - /** - * get hardware account label - * - * @param name - * @param index - * @param hdPathDescription - * @returns string label - */ - getAccountLabel(name, index, hdPathDescription) { - return `${name[0].toUpperCase()}${name.slice(1)} ${ - parseInt(index, 10) + 1 - } ${hdPathDescription || ''}`.trim(); - } - - /** - * Imports an account from a Trezor or Ledger device. - * - * @param index - * @param deviceName - * @param hdPath - * @param hdPathDescription - * @returns {} keyState - */ - async unlockHardwareWalletAccount( - index, - deviceName, - hdPath, - hdPathDescription, - ) { - const keyring = await this.getKeyringForDevice(deviceName, hdPath); - - keyring.setAccountToUnlock(index); - const unlockedAccount = - await this.keyringController.addNewAccountForKeyring(keyring); - const label = this.getAccountLabel( - deviceName === HardwareDeviceNames.qr ? keyring.getName() : deviceName, - index, - hdPathDescription, - ); - // Set the account label to Trezor 1 / Ledger 1 / QR Hardware 1, etc - this.preferencesController.setAccountLabel(unlockedAccount, label); - // Select the account - this.preferencesController.setSelectedAddress(unlockedAccount); - - // It is expected that the account also exist in the accounts-controller - // in other case, an error shall be thrown - const account = - this.accountsController.getAccountByAddress(unlockedAccount); - this.accountsController.setAccountName(account.id, label); - - const accounts = this.accountsController.listAccounts(); - - const { identities } = this.preferencesController.state; - return { unlockedAccount, identities, accounts }; - } - - // - // Account Management - // - - /** - * Adds a new account to the default (first) HD seed phrase Keyring. - * - * @param accountCount - * @returns {Promise} The address of the newly-created account. - */ - async addNewAccount(accountCount) { - const oldAccounts = await this.keyringController.getAccounts(); - - const addedAccountAddress = await this.keyringController.addNewAccount( - accountCount, - ); - - if (!oldAccounts.includes(addedAccountAddress)) { - this.preferencesController.setSelectedAddress(addedAccountAddress); - } - - return addedAccountAddress; - } - - /** - * Verifies the validity of the current vault's seed phrase. - * - * Validity: seed phrase restores the accounts belonging to the current vault. - * - * Called when the first account is created and on unlocking the vault. - * - * @param password - * @returns {Promise} The seed phrase to be confirmed by the user, - * encoded as an array of UTF-8 bytes. - */ - async getSeedPhrase(password) { - return this._convertEnglishWordlistIndicesToCodepoints( - await this.keyringController.exportSeedPhrase(password), - ); - } - - /** - * Clears the transaction history, to allow users to force-reset their nonces. - * Mostly used in development environments, when networks are restarted with - * the same network ID. - * - * @returns {Promise} The current selected address. - */ - async resetAccount() { - const selectedAddress = - this.accountsController.getSelectedAccount().address; - this.txController.wipeTransactions(false, selectedAddress); - this.smartTransactionsController.wipeSmartTransactions({ - address: selectedAddress, - ignoreNetwork: false, - }); - this.networkController.resetConnection(); - - return selectedAddress; - } - - /** - * Gets the permitted accounts for the specified origin. Returns an empty - * array if no accounts are permitted. - * - * @param {string} origin - The origin whose exposed accounts to retrieve. - * @param {boolean} [suppressUnauthorizedError] - Suppresses the unauthorized error. - * @returns {Promise} The origin's permitted accounts, or an empty - * array. - */ - async getPermittedAccounts( - origin, - { suppressUnauthorizedError = true } = {}, - ) { - try { - return await this.permissionController.executeRestrictedMethod( - origin, - RestrictedMethods.eth_accounts, - ); - } catch (error) { - if ( - suppressUnauthorizedError && - error.code === rpcErrorCodes.provider.unauthorized - ) { - return []; - } - throw error; - } - } - - /** - * Stops exposing the specified chain ID to all third parties. - * Exposed chain IDs are stored in caveats of the `endowment:permitted-chains` - * permission. This method uses `PermissionController.updatePermissionsByCaveat` - * to remove the specified chain ID from every `endowment:permitted-chains` - * permission. If a permission only included this chain ID, the permission is - * revoked entirely. - * - * @param {string} targetChainId - The chain ID to stop exposing - * to third parties. - */ - removeAllChainIdPermissions(targetChainId) { - this.permissionController.updatePermissionsByCaveat( - CaveatTypes.restrictNetworkSwitching, - (existingChainIds) => - CaveatMutatorFactories[ - CaveatTypes.restrictNetworkSwitching - ].removeChainId(targetChainId, existingChainIds), - ); - } - - /** - * Stops exposing the account with the specified address to all third parties. - * Exposed accounts are stored in caveats of the eth_accounts permission. This - * method uses `PermissionController.updatePermissionsByCaveat` to - * remove the specified address from every eth_accounts permission. If a - * permission only included this address, the permission is revoked entirely. - * - * @param {string} targetAccount - The address of the account to stop exposing - * to third parties. - */ - removeAllAccountPermissions(targetAccount) { - this.permissionController.updatePermissionsByCaveat( - CaveatTypes.restrictReturnedAccounts, - (existingAccounts) => - CaveatMutatorFactories[ - CaveatTypes.restrictReturnedAccounts - ].removeAccount(targetAccount, existingAccounts), - ); - } - - /** - * Removes an account from state / storage. - * - * @param {string[]} address - A hex address - */ - async removeAccount(address) { - // Remove all associated permissions - this.removeAllAccountPermissions(address); - - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - this.custodyController.removeAccount(address); - ///: END:ONLY_INCLUDE_IF(build-mmi) - - const keyring = await this.keyringController.getKeyringForAccount(address); - // Remove account from the keyring - await this.keyringController.removeAccount(address); - const updatedKeyringAccounts = keyring ? await keyring.getAccounts() : {}; - if (updatedKeyringAccounts?.length === 0) { - keyring.destroy?.(); - } - - return address; - } - - /** - * Imports an account with the specified import strategy. - * These are defined in @metamask/keyring-controller - * Each strategy represents a different way of serializing an Ethereum key pair. - * - * @param {'privateKey' | 'json'} strategy - A unique identifier for an account import strategy. - * @param {any} args - The data required by that strategy to import an account. - */ - async importAccountWithStrategy(strategy, args) { - const importedAccountAddress = - await this.keyringController.importAccountWithStrategy(strategy, args); - // set new account as selected - this.preferencesController.setSelectedAddress(importedAccountAddress); - } - - // --------------------------------------------------------------------------- - // Identity Management (signature operations) - - getAddTransactionRequest({ - transactionParams, - transactionOptions, - dappRequest, - ...otherParams - }) { - return { - internalAccounts: this.accountsController.listAccounts(), - dappRequest, - networkClientId: - dappRequest?.networkClientId ?? - this.networkController.state.selectedNetworkClientId, - selectedAccount: this.accountsController.getAccountByAddress( - transactionParams.from, - ), - transactionController: this.txController, - transactionOptions, - transactionParams, - userOperationController: this.userOperationController, - chainId: getCurrentChainId({ metamask: this.networkController.state }), - ppomController: this.ppomController, - securityAlertsEnabled: - this.preferencesController.state?.securityAlertsEnabled, - updateSecurityAlertResponse: this.updateSecurityAlertResponse.bind(this), - ...otherParams, - }; - } - - /** - * @returns {boolean} true if the keyring type supports EIP-1559 - */ - async getCurrentAccountEIP1559Compatibility() { - return true; - } - - //============================================================================= - // END (VAULT / KEYRING RELATED METHODS) - //============================================================================= - - /** - * Allows a user to attempt to cancel a previously submitted transaction - * by creating a new transaction. - * - * @param {number} originalTxId - the id of the txMeta that you want to - * attempt to cancel - * @param {import( - * './controllers/transactions' - * ).CustomGasSettings} [customGasSettings] - overrides to use for gas params - * instead of allowing this method to generate them - * @param options - * @returns {object} MetaMask state - */ - async createCancelTransaction(originalTxId, customGasSettings, options) { - await this.txController.stopTransaction( - originalTxId, - customGasSettings, - options, - ); - const state = this.getState(); - return state; - } - - /** - * Allows a user to attempt to speed up a previously submitted transaction - * by creating a new transaction. - * - * @param {number} originalTxId - the id of the txMeta that you want to - * attempt to speed up - * @param {import( - * './controllers/transactions' - * ).CustomGasSettings} [customGasSettings] - overrides to use for gas params - * instead of allowing this method to generate them - * @param options - * @returns {object} MetaMask state - */ - async createSpeedUpTransaction(originalTxId, customGasSettings, options) { - await this.txController.speedUpTransaction( - originalTxId, - customGasSettings, - options, - ); - const state = this.getState(); - return state; - } - - async estimateGas(estimateGasParams) { - return new Promise((resolve, reject) => { - return new EthJSQuery(this.provider).estimateGas( - estimateGasParams, - (err, res) => { - if (err) { - return reject(err); - } - - return resolve(res.toString(16)); - }, - ); - }); - } - - handleWatchAssetRequest = ({ asset, type, origin, networkClientId }) => { - switch (type) { - case ERC20: - return this.tokensController.watchAsset({ - asset, - type, - networkClientId, - }); - case ERC721: - case ERC1155: - return this.nftController.watchNft(asset, type, origin); - default: - throw new Error(`Asset type ${type} not supported`); - } - }; - - async updateSecurityAlertResponse( - method, - securityAlertId, - securityAlertResponse, - ) { - updateSecurityAlertResponse({ - appStateController: this.appStateController, - method, - securityAlertId, - securityAlertResponse, - signatureController: this.signatureController, - transactionController: this.txController, - }); - } - - //============================================================================= - // PASSWORD MANAGEMENT - //============================================================================= - - /** - * Allows a user to begin the seed phrase recovery process. - */ - markPasswordForgotten() { - this.preferencesController.setPasswordForgotten(true); - this.sendUpdate(); - } - - /** - * Allows a user to end the seed phrase recovery process. - */ - unMarkPasswordForgotten() { - this.preferencesController.setPasswordForgotten(false); - this.sendUpdate(); - } - - //============================================================================= - // REQUEST QUEUE - //============================================================================= - - setUseRequestQueue(value) { - this.preferencesController.setUseRequestQueue(value); - } - - //============================================================================= - // SETUP - //============================================================================= - - /** - * A runtime.MessageSender object, as provided by the browser: - * - * @see https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/MessageSender - * @typedef {object} MessageSender - * @property {string} - The URL of the page or frame hosting the script that sent the message. - */ - - /** - * A Snap sender object. - * - * @typedef {object} SnapSender - * @property {string} snapId - The ID of the snap. - */ - - /** - * Used to create a multiplexed stream for connecting to an untrusted context - * like a Dapp or other extension. - * - * @param options - Options bag. - * @param {ReadableStream} options.connectionStream - The Duplex stream to connect to. - * @param {MessageSender | SnapSender} options.sender - The sender of the messages on this stream. - * @param {string} [options.subjectType] - The type of the sender, i.e. subject. - */ - setupUntrustedCommunicationEip1193({ - connectionStream, - sender, - subjectType, - }) { - if (sender.url) { - if (this.onboardingController.state.completedOnboarding) { - if (this.preferencesController.state.usePhishDetect) { - const { hostname } = new URL(sender.url); - this.phishingController.maybeUpdateState(); - // Check if new connection is blocked if phishing detection is on - const phishingTestResponse = this.phishingController.test(sender.url); - if (phishingTestResponse?.result) { - this.sendPhishingWarning(connectionStream, hostname); - this.metaMetricsController.trackEvent({ - event: MetaMetricsEventName.PhishingPageDisplayed, - category: MetaMetricsEventCategory.Phishing, - properties: { - url: hostname, - }, - }); - return; - } - } - } - } - - let inputSubjectType; - if (subjectType) { - inputSubjectType = subjectType; - } else if (sender.id && sender.id !== this.extension.runtime.id) { - inputSubjectType = SubjectType.Extension; - } else { - inputSubjectType = SubjectType.Website; - } - - // setup multiplexing - const mux = setupMultiplex(connectionStream); - - // messages between inpage and background - this.setupProviderConnectionEip1193( - mux.createStream('metamask-provider'), - sender, - inputSubjectType, - ); - - // TODO:LegacyProvider: Delete - if (sender.url) { - // legacy streams - this.setupPublicConfig(mux.createStream('publicConfig')); - } - } - - /** - * Used to create a CAIP stream for connecting to an untrusted context. - * - * @param options - Options bag. - * @param {ReadableStream} options.connectionStream - The Duplex stream to connect to. - * @param {MessageSender | SnapSender} options.sender - The sender of the messages on this stream. - * @param {string} [options.subjectType] - The type of the sender, i.e. subject. - */ - - setupUntrustedCommunicationCaip({ connectionStream, sender, subjectType }) { - let inputSubjectType; - if (subjectType) { - inputSubjectType = subjectType; - } else if (sender.id && sender.id !== this.extension.runtime.id) { - inputSubjectType = SubjectType.Extension; - } else { - inputSubjectType = SubjectType.Website; - } - - const caipStream = createCaipStream(connectionStream); - - // messages between subject and background - this.setupProviderConnectionCaip(caipStream, sender, inputSubjectType); - } - - /** - * Used to create a multiplexed stream for connecting to a trusted context, - * like our own user interfaces, which have the provider APIs, but also - * receive the exported API from this controller, which includes trusted - * functions, like the ability to approve transactions or sign messages. - * - * @param {*} connectionStream - The duplex stream to connect to. - * @param {MessageSender} sender - The sender of the messages on this stream - */ - setupTrustedCommunication(connectionStream, sender) { - // setup multiplexing - const mux = setupMultiplex(connectionStream); - // connect features - this.setupControllerConnection(mux.createStream('controller')); - this.setupProviderConnectionEip1193( - mux.createStream('provider'), - sender, - SubjectType.Internal, - ); - } - - /** - * Used to create a multiplexed stream for connecting to the phishing warning page. - * - * @param options - Options bag. - * @param {ReadableStream} options.connectionStream - The Duplex stream to connect to. - */ - setupPhishingCommunication({ connectionStream }) { - const { usePhishDetect } = this.preferencesController.state; - - if (!usePhishDetect) { - return; - } - - // setup multiplexing - const mux = setupMultiplex(connectionStream); - const phishingStream = mux.createStream(PHISHING_SAFELIST); - - // set up postStream transport - phishingStream.on( - 'data', - createMetaRPCHandler( - { - safelistPhishingDomain: this.safelistPhishingDomain.bind(this), - backToSafetyPhishingWarning: - this.backToSafetyPhishingWarning.bind(this), - }, - phishingStream, - ), - ); - } - - setUpCookieHandlerCommunication({ connectionStream }) { - const { - metaMetricsId, - dataCollectionForMarketing, - participateInMetaMetrics, - } = this.metaMetricsController.store.getState(); - - if ( - metaMetricsId && - dataCollectionForMarketing && - participateInMetaMetrics - ) { - // setup multiplexing - const mux = setupMultiplex(connectionStream); - const metamaskCookieHandlerStream = mux.createStream( - METAMASK_COOKIE_HANDLER, - ); - // set up postStream transport - metamaskCookieHandlerStream.on( - 'data', - createMetaRPCHandler( - { - getCookieFromMarketingPage: - this.getCookieFromMarketingPage.bind(this), - }, - metamaskCookieHandlerStream, - ), - ); - } - } - - getCookieFromMarketingPage(data) { - const { ga_client_id: cookieId } = data; - this.metaMetricsController.setMarketingCampaignCookieId(cookieId); - } - - /** - * Called when we detect a suspicious domain. Requests the browser redirects - * to our anti-phishing page. - * - * @private - * @param {*} connectionStream - The duplex stream to the per-page script, - * for sending the reload attempt to. - * @param {string} hostname - The hostname that triggered the suspicion. - */ - sendPhishingWarning(connectionStream, hostname) { - const mux = setupMultiplex(connectionStream); - const phishingStream = mux.createStream('phishing'); - phishingStream.write({ hostname }); - } - - /** - * A method for providing our API over a stream using JSON-RPC. - * - * @param {*} outStream - The stream to provide our API over. - */ - setupControllerConnection(outStream) { - const patchStore = new PatchStore(this.memStore); - let uiReady = false; - - const handleUpdate = () => { - if (!isStreamWritable(outStream) || !uiReady) { - return; - } - - const patches = patchStore.flushPendingPatches(); - - outStream.write({ - jsonrpc: '2.0', - method: 'sendUpdate', - params: [patches], - }); - }; - - const api = { - ...this.getApi(), - startPatches: () => { - uiReady = true; - handleUpdate(); - }, - getStatePatches: () => patchStore.flushPendingPatches(), - }; - - this.on('update', handleUpdate); - - // report new active controller connection - this.activeControllerConnections += 1; - this.emit('controllerConnectionChanged', this.activeControllerConnections); - - // set up postStream transport - outStream.on('data', createMetaRPCHandler(api, outStream)); - - const startUISync = () => { - if (!isStreamWritable(outStream)) { - return; - } - // send notification to client-side - outStream.write({ - jsonrpc: '2.0', - method: 'startUISync', - }); - }; - - if (this.startUISync) { - startUISync(); - } else { - this.once('startUISync', startUISync); - } - - const outstreamEndHandler = () => { - if (!outStream.mmFinished) { - this.activeControllerConnections -= 1; - this.emit( - 'controllerConnectionChanged', - this.activeControllerConnections, - ); - outStream.mmFinished = true; - this.removeListener('update', handleUpdate); - patchStore.destroy(); - } - }; - - // The presence of both of the below handlers may be redundant. - // After upgrading metamask/object-multiples to v2.0.0, which included - // an upgrade of readable-streams from v2 to v3, we saw that the - // `outStream.on('end'` handler was almost never being called. This seems to - // related to how v3 handles errors vs how v2 handles errors; there - // are "premature close" errors in both cases, although in the case - // of v2 they don't prevent `outStream.on('end'` from being called. - // At the time that this comment was committed, it was known that we - // need to investigate and resolve the underlying error, however, - // for expediency, we are not addressing them at this time. Instead, we - // can observe that `readableStream.finished` preserves the same - // functionality as we had when we relied on readable-stream v2. Meanwhile, - // the `outStream.on('end')` handler was observed to have been called at least once. - // In an abundance of caution to prevent against unexpected future behavioral changes in - // streams implementations, we redundantly use multiple paths to attach the same event handler. - // The outstreamEndHandler therefore needs to be idempotent, which introduces the `mmFinished` property. - - outStream.mmFinished = false; - finished(outStream, outstreamEndHandler); - outStream.once('close', outstreamEndHandler); - outStream.once('end', outstreamEndHandler); - } - - /** - * A method for serving our ethereum provider over a given stream. - * - * @param {*} outStream - The stream to provide over. - * @param {MessageSender | SnapSender} sender - The sender of the messages on this stream - * @param {SubjectType} subjectType - The type of the sender, i.e. subject. - */ - setupProviderConnectionEip1193(outStream, sender, subjectType) { - let origin; - if (subjectType === SubjectType.Internal) { - origin = ORIGIN_METAMASK; - } else if (subjectType === SubjectType.Snap) { - origin = sender.snapId; - } else { - origin = new URL(sender.url).origin; - } - - if (sender.id && sender.id !== this.extension.runtime.id) { - this.subjectMetadataController.addSubjectMetadata({ - origin, - extensionId: sender.id, - subjectType: SubjectType.Extension, - }); - } - - let tabId; - if (sender.tab && sender.tab.id) { - tabId = sender.tab.id; - } - - const engine = this.setupProviderEngineEip1193({ - origin, - sender, - subjectType, - tabId, - }); - - const dupeReqFilterStream = createDupeReqFilterStream(); - - // setup connection - const providerStream = createEngineStream({ engine }); - - const connectionId = this.addConnection(origin, { engine }); - - pipeline( - outStream, - dupeReqFilterStream, - providerStream, - outStream, - (err) => { - // handle any middleware cleanup - engine.destroy(); - connectionId && this.removeConnection(origin, connectionId); - // For context and todos related to the error message match, see https://github.com/MetaMask/metamask-extension/issues/26337 - if (err && !err.message?.match('Premature close')) { - log.error(err); - } - }, - ); - - // Used to show wallet liveliness to the provider - if (subjectType !== SubjectType.Internal) { - this._notifyChainChangeForConnection({ engine }, origin); - } - } - - /** - * A method for serving our CAIP provider over a given stream. - * - * @param {*} outStream - The stream to provide over. - * @param {MessageSender | SnapSender} sender - The sender of the messages on this stream - * @param {SubjectType} subjectType - The type of the sender, i.e. subject. - */ - setupProviderConnectionCaip(outStream, sender, subjectType) { - let origin; - if (subjectType === SubjectType.Internal) { - origin = ORIGIN_METAMASK; - } else if (subjectType === SubjectType.Snap) { - origin = sender.snapId; - } else { - origin = new URL(sender.url).origin; - } - - if (sender.id && sender.id !== this.extension.runtime.id) { - this.subjectMetadataController.addSubjectMetadata({ - origin, - extensionId: sender.id, - subjectType: SubjectType.Extension, - }); - } - - let tabId; - if (sender.tab && sender.tab.id) { - tabId = sender.tab.id; - } - - const engine = this.setupProviderEngineCaip({ - origin, - tabId, - }); - - const dupeReqFilterStream = createDupeReqFilterStream(); - - // setup connection - const providerStream = createEngineStream({ engine }); - - const connectionId = this.addConnection(origin, { engine }); - - pipeline( - outStream, - dupeReqFilterStream, - providerStream, - outStream, - (err) => { - // handle any middleware cleanup - engine._middleware.forEach((mid) => { - if (mid.destroy && typeof mid.destroy === 'function') { - mid.destroy(); - } - }); - connectionId && this.removeConnection(origin, connectionId); - if (err) { - log.error(err); - } - }, - ); - - // Used to show wallet liveliness to the provider - if (subjectType !== SubjectType.Internal) { - this._notifyChainChangeForConnection({ engine }, origin); - } - } - - /** - * For snaps running in workers. - * - * @param snapId - * @param connectionStream - */ - setupSnapProvider(snapId, connectionStream) { - this.setupUntrustedCommunicationEip1193({ - connectionStream, - sender: { snapId }, - subjectType: SubjectType.Snap, - }); - } - - /** - * A method for creating an ethereum provider that is safely restricted for the requesting subject. - * - * @param {object} options - Provider engine options - * @param {string} options.origin - The origin of the sender - * @param {MessageSender | SnapSender} options.sender - The sender object. - * @param {string} options.subjectType - The type of the sender subject. - * @param {tabId} [options.tabId] - The tab ID of the sender - if the sender is within a tab - */ - setupProviderEngineEip1193({ origin, subjectType, sender, tabId }) { - const engine = new JsonRpcEngine(); - - // Append origin to each request - engine.push(createOriginMiddleware({ origin })); - - // Append selectedNetworkClientId to each request - engine.push(createSelectedNetworkMiddleware(this.controllerMessenger)); - - // Add a middleware that will switch chain on each request (as needed) - const requestQueueMiddleware = createQueuedRequestMiddleware({ - enqueueRequest: this.queuedRequestController.enqueueRequest.bind( - this.queuedRequestController, - ), - useRequestQueue: this.preferencesController.getUseRequestQueue.bind( - this.preferencesController, - ), - shouldEnqueueRequest: (request) => { - return methodsThatShouldBeEnqueued.includes(request.method); - }, - }); - engine.push(requestQueueMiddleware); - - // If the origin is not in the selectedNetworkController's `domains` state - // when the provider engine is created, the selectedNetworkController will - // fetch the globally selected networkClient from the networkController and wrap - // it in a proxy which can be switched to use its own state if/when the origin - // is added to the `domains` state - const proxyClient = - this.selectedNetworkController.getProviderAndBlockTracker(origin); - - // We create the filter and subscription manager middleware now, but they will - // be inserted into the engine later. - const filterMiddleware = createFilterMiddleware(proxyClient); - const subscriptionManager = createSubscriptionManager(proxyClient); - subscriptionManager.events.on('notification', (message) => - engine.emit('notification', message), - ); - - // Append tabId to each request if it exists - if (tabId) { - engine.push(createTabIdMiddleware({ tabId })); - } - - engine.push(createLoggerMiddleware({ origin })); - engine.push(this.permissionLogController.createMiddleware()); - - if (origin === BaseUrl.Portfolio) { - engine.push(createTxVerificationMiddleware(this.networkController)); - } - - engine.push(createTracingMiddleware()); - - engine.push( - createPPOMMiddleware( - this.ppomController, - this.preferencesController, - this.networkController, - this.appStateController, - this.accountsController, - this.updateSecurityAlertResponse.bind(this), - ), - ); - - const isConfirmationRedesignEnabled = () => { - return this.preferencesController.state.preferences - .redesignedConfirmationsEnabled; - }; - - engine.push( - createRPCMethodTrackingMiddleware({ - getMetricsState: this.metaMetricsController.store.getState.bind( - this.metaMetricsController.store, - ), - getAccountType: this.getAccountType.bind(this), - getDeviceModel: this.getDeviceModel.bind(this), - isConfirmationRedesignEnabled, - snapAndHardwareMessenger: this.controllerMessenger.getRestricted({ - name: 'SnapAndHardwareMessenger', - allowedActions: [ - 'KeyringController:getKeyringForAccount', - 'SnapController:get', - 'AccountsController:getSelectedAccount', - ], - }), - appStateController: this.appStateController, - metaMetricsController: this.metaMetricsController, - }), - ); - - engine.push(createUnsupportedMethodMiddleware()); - - // Legacy RPC methods that need to be implemented _ahead of_ the permission - // middleware. - engine.push( - createLegacyMethodMiddleware({ - getAccounts: this.getPermittedAccounts.bind(this, origin), - }), - ); - - if (subjectType !== SubjectType.Internal) { - engine.push( - this.permissionController.createPermissionMiddleware({ - origin, - }), - ); - } - - if (subjectType === SubjectType.Website) { - engine.push( - createOnboardingMiddleware({ - location: sender.url, - registerOnboarding: this.onboardingController.registerOnboarding, - }), - ); - } - - // EVM requests and eth permissions should not be passed to non-EVM accounts - // this middleware intercepts these requests and returns an error. - engine.push( - createEvmMethodsToNonEvmAccountReqFilterMiddleware({ - messenger: this.controllerMessenger.getRestricted({ - name: 'EvmMethodsToNonEvmAccountFilterMessenger', - allowedActions: ['AccountsController:getSelectedAccount'], - }), - }), - ); - - // Unrestricted/permissionless RPC method implementations. - // They must nevertheless be placed _behind_ the permission middleware. - engine.push( - createMethodMiddleware({ - origin, - - subjectType, - - // Miscellaneous - addSubjectMetadata: - this.subjectMetadataController.addSubjectMetadata.bind( - this.subjectMetadataController, - ), - metamaskState: this.getState(), - getProviderState: this.getProviderState.bind(this), - getUnlockPromise: this.appStateController.getUnlockPromise.bind( - this.appStateController, - ), - handleWatchAssetRequest: this.handleWatchAssetRequest.bind(this), - requestUserApproval: - this.approvalController.addAndShowApprovalRequest.bind( - this.approvalController, - ), - startApprovalFlow: this.approvalController.startFlow.bind( - this.approvalController, - ), - endApprovalFlow: this.approvalController.endFlow.bind( - this.approvalController, - ), - sendMetrics: this.metaMetricsController.trackEvent.bind( - this.metaMetricsController, - ), - // Permission-related - getAccounts: this.getPermittedAccounts.bind(this, origin), - getPermissionsForOrigin: this.permissionController.getPermissions.bind( - this.permissionController, - origin, - ), - hasPermission: this.permissionController.hasPermission.bind( - this.permissionController, - origin, - ), - requestAccountsPermission: - this.permissionController.requestPermissions.bind( - this.permissionController, - { origin }, - { - eth_accounts: {}, - ...(!isSnapId(origin) && { - [PermissionNames.permittedChains]: {}, - }), - }, - ), - requestPermittedChainsPermission: (chainIds) => - this.permissionController.requestPermissionsIncremental( - { origin }, - { - [PermissionNames.permittedChains]: { - caveats: [ - CaveatFactories[CaveatTypes.restrictNetworkSwitching]( - chainIds, - ), - ], - }, - }, - ), - grantPermittedChainsPermissionIncremental: (chainIds) => - this.permissionController.grantPermissionsIncremental({ - subject: { origin }, - approvedPermissions: { - [PermissionNames.permittedChains]: { - caveats: [ - CaveatFactories[CaveatTypes.restrictNetworkSwitching]( - chainIds, - ), - ], - }, - }, - }), - requestPermissionsForOrigin: (requestedPermissions) => - this.permissionController.requestPermissions( - { origin }, - { - ...(requestedPermissions[PermissionNames.eth_accounts] && { - [PermissionNames.permittedChains]: {}, - }), - ...(requestedPermissions[PermissionNames.permittedChains] && { - [PermissionNames.eth_accounts]: {}, - }), - ...requestedPermissions, - }, - ), - revokePermissionsForOrigin: (permissionKeys) => { - try { - this.permissionController.revokePermissions({ - [origin]: permissionKeys, - }); - } catch (e) { - // we dont want to handle errors here because - // the revokePermissions api method should just - // return `null` if the permissions were not - // successfully revoked or if the permissions - // for the origin do not exist - console.log(e); - } - }, - getCaveat: ({ target, caveatType }) => { - try { - return this.permissionController.getCaveat( - origin, - target, - caveatType, - ); - } catch (e) { - if (e instanceof PermissionDoesNotExistError) { - // suppress expected error in case that the origin - // does not have the target permission yet - } else { - throw e; - } - } - - return undefined; - }, - // network configuration-related - setActiveNetwork: async (networkClientId) => { - await this.networkController.setActiveNetwork(networkClientId); - // if the origin has the eth_accounts permission - // we set per dapp network selection state - if ( - this.permissionController.hasPermission( - origin, - PermissionNames.eth_accounts, - ) - ) { - this.selectedNetworkController.setNetworkClientIdForDomain( - origin, - networkClientId, - ); - } - }, - addNetwork: this.networkController.addNetwork.bind( - this.networkController, - ), - updateNetwork: this.networkController.updateNetwork.bind( - this.networkController, - ), - getNetworkConfigurationByChainId: - this.networkController.getNetworkConfigurationByChainId.bind( - this.networkController, - ), - getCurrentChainIdForDomain: (domain) => { - const networkClientId = - this.selectedNetworkController.getNetworkClientIdForDomain(domain); - const { chainId } = - this.networkController.getNetworkConfigurationByNetworkClientId( - networkClientId, - ); - return chainId; - }, - - // Web3 shim-related - getWeb3ShimUsageState: this.alertController.getWeb3ShimUsageState.bind( - this.alertController, - ), - setWeb3ShimUsageRecorded: - this.alertController.setWeb3ShimUsageRecorded.bind( - this.alertController, - ), - - ///: BEGIN:ONLY_INCLUDE_IF(build-mmi) - handleMmiAuthenticate: - this.institutionalFeaturesController.handleMmiAuthenticate.bind( - this.institutionalFeaturesController, - ), - handleMmiCheckIfTokenIsPresent: - this.mmiController.handleMmiCheckIfTokenIsPresent.bind( - this.mmiController, - ), - handleMmiDashboardData: this.mmiController.handleMmiDashboardData.bind( - this.mmiController, - ), - handleMmiSetAccountAndNetwork: - this.mmiController.setAccountAndNetwork.bind(this.mmiController), - handleMmiOpenAddHardwareWallet: - this.mmiController.handleMmiOpenAddHardwareWallet.bind( - this.mmiController, - ), - ///: END:ONLY_INCLUDE_IF - }), - ); - - engine.push( - createSnapsMethodMiddleware(subjectType === SubjectType.Snap, { - getUnlockPromise: this.appStateController.getUnlockPromise.bind( - this.appStateController, - ), - getSnaps: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:getPermitted', - origin, - ), - requestPermissions: async (requestedPermissions) => - await this.permissionController.requestPermissions( - { origin }, - requestedPermissions, - ), - getPermissions: this.permissionController.getPermissions.bind( - this.permissionController, - origin, - ), - getSnapFile: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:getFile', - origin, - ), - installSnaps: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:install', - origin, - ), - invokeSnap: this.permissionController.executeRestrictedMethod.bind( - this.permissionController, - origin, - RestrictedMethods.wallet_snap, - ), - getIsLocked: () => { - return !this.appStateController.isUnlocked(); - }, - getInterfaceState: (...args) => - this.controllerMessenger.call( - 'SnapInterfaceController:getInterface', - origin, - ...args, - ).state, - createInterface: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapInterfaceController:createInterface', - origin, - ), - updateInterface: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapInterfaceController:updateInterface', - origin, - ), - resolveInterface: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapInterfaceController:resolveInterface', - origin, - ), - getSnap: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:get', - ), - getAllSnaps: this.controllerMessenger.call.bind( - this.controllerMessenger, - 'SnapController:getAll', - ), - getCurrencyRate: (currency) => { - const rate = this.multichainRatesController.state.rates[currency]; - const { fiatCurrency } = this.multichainRatesController.state; - - if (!rate) { - return undefined; - } - - return { - ...rate, - currency: fiatCurrency, - }; - }, - ///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps) - hasPermission: this.permissionController.hasPermission.bind( - this.permissionController, - origin, - ), - handleSnapRpcRequest: (args) => - this.handleSnapRequest({ ...args, origin }), - getAllowedKeyringMethods: keyringSnapPermissionsBuilder( - this.subjectMetadataController, - origin, - ), - ///: END:ONLY_INCLUDE_IF - }), - ); - - engine.push(filterMiddleware); - engine.push(subscriptionManager.middleware); - - engine.push(this.metamaskMiddleware); - - engine.push(providerAsMiddleware(proxyClient.provider)); - - return engine; - } - - /** - * A method for creating a CAIP provider that is safely restricted for the requesting subject. - * - * @param {object} options - Provider engine options - * @param {string} options.origin - The origin of the sender - * @param {tabId} [options.tabId] - The tab ID of the sender - if the sender is within a tab - */ - setupProviderEngineCaip({ origin, tabId }) { - const engine = new JsonRpcEngine(); - - engine.push((request, _res, _next, end) => { - console.log('CAIP request received', { origin, tabId, request }); - return end(new Error('CAIP RPC Pipeline not yet implemented.')); - }); - - return engine; - } - - /** - * TODO:LegacyProvider: Delete - * A method for providing our public config info over a stream. - * This includes info we like to be synchronous if possible, like - * the current selected account, and network ID. - * - * Since synchronous methods have been deprecated in web3, - * this is a good candidate for deprecation. - * - * @param {*} outStream - The stream to provide public config over. - */ - setupPublicConfig(outStream) { - const configStream = storeAsStream(this.publicConfigStore); - - pipeline(configStream, outStream, (err) => { - configStream.destroy(); - // For context and todos related to the error message match, see https://github.com/MetaMask/metamask-extension/issues/26337 - if (err && !err.message?.match('Premature close')) { - log.error(err); - } - }); - } - - /** - * Adds a reference to a connection by origin. Ignores the 'metamask' origin. - * Caller must ensure that the returned id is stored such that the reference - * can be deleted later. - * - * @param {string} origin - The connection's origin string. - * @param {object} options - Data associated with the connection - * @param {object} options.engine - The connection's JSON Rpc Engine - * @returns {string} The connection's id (so that it can be deleted later) - */ - addConnection(origin, { engine }) { - if (origin === ORIGIN_METAMASK) { - return null; - } - - if (!this.connections[origin]) { - this.connections[origin] = {}; - } - - const id = nanoid(); - this.connections[origin][id] = { - engine, - }; - - return id; - } - - /** - * Deletes a reference to a connection, by origin and id. - * Ignores unknown origins. - * - * @param {string} origin - The connection's origin string. - * @param {string} id - The connection's id, as returned from addConnection. - */ - removeConnection(origin, id) { - const connections = this.connections[origin]; - if (!connections) { - return; - } - - delete connections[id]; - - if (Object.keys(connections).length === 0) { - delete this.connections[origin]; - } - } - - /** - * Closes all connections for the given origin, and removes the references - * to them. - * Ignores unknown origins. - * - * @param {string} origin - The origin string. - */ - removeAllConnections(origin) { - const connections = this.connections[origin]; - if (!connections) { - return; - } - - Object.keys(connections).forEach((id) => { - this.removeConnection(origin, id); - }); - } - - /** - * Causes the RPC engines associated with the connections to the given origin - * to emit a notification event with the given payload. - * - * The caller is responsible for ensuring that only permitted notifications - * are sent. - * - * Ignores unknown origins. - * - * @param {string} origin - The connection's origin string. - * @param {unknown} payload - The event payload. - */ - notifyConnections(origin, payload) { - const connections = this.connections[origin]; - - if (connections) { - Object.values(connections).forEach((conn) => { - if (conn.engine) { - conn.engine.emit('notification', payload); - } - }); - } - } - - /** - * Causes the RPC engines associated with all connections to emit a - * notification event with the given payload. - * - * If the "payload" parameter is a function, the payload for each connection - * will be the return value of that function called with the connection's - * origin. - * - * The caller is responsible for ensuring that only permitted notifications - * are sent. - * - * @param {unknown} payload - The event payload, or payload getter function. - */ - notifyAllConnections(payload) { - const getPayload = - typeof payload === 'function' - ? (origin) => payload(origin) - : () => payload; - - Object.keys(this.connections).forEach((origin) => { - Object.values(this.connections[origin]).forEach(async (conn) => { - try { - this.notifyConnection(conn, await getPayload(origin)); - } catch (err) { - console.error(err); - } - }); - }); - } - - /** - * Causes the RPC engine for passed connection to emit a - * notification event with the given payload. - * - * The caller is responsible for ensuring that only permitted notifications - * are sent. - * - * @param {object} connection - Data associated with the connection - * @param {object} connection.engine - The connection's JSON Rpc Engine - * @param {unknown} payload - The event payload - */ - notifyConnection(connection, payload) { - try { - if (connection.engine) { - connection.engine.emit('notification', payload); - } - } catch (err) { - console.error(err); - } - } - - // handlers - - /** - * Handle a KeyringController update - * - * @param {object} state - the KC state - * @returns {Promise} - * @private - */ - async _onKeyringControllerUpdate(state) { - const { keyrings } = state; - - // The accounts tracker only supports EVM addresses and the keyring - // controller may pass non-EVM addresses, so we filter them out - const addresses = keyrings - .reduce((acc, { accounts }) => acc.concat(accounts), []) - .filter(isEthAddress); - - if (!addresses.length) { - return; - } - - this.accountTrackerController.syncWithAddresses(addresses); - } - - /** - * Handle global application unlock. - * Notifies all connections that the extension is unlocked, and which - * account(s) are currently accessible, if any. - */ - _onUnlock() { - this.notifyAllConnections(async (origin) => { - return { - method: NOTIFICATION_NAMES.unlockStateChanged, - params: { - isUnlocked: true, - accounts: await this.getPermittedAccounts(origin), - }, - }; - }); - - this.unMarkPasswordForgotten(); - - // In the current implementation, this handler is triggered by a - // KeyringController event. Other controllers subscribe to the 'unlock' - // event of the MetaMaskController itself. - this.emit('unlock'); - } - - /** - * Handle global application lock. - * Notifies all connections that the extension is locked. - */ - _onLock() { - this.notifyAllConnections({ - method: NOTIFICATION_NAMES.unlockStateChanged, - params: { - isUnlocked: false, - }, - }); - - // In the current implementation, this handler is triggered by a - // KeyringController event. Other controllers subscribe to the 'lock' - // event of the MetaMaskController itself. - this.emit('lock'); - } - - /** - * Handle memory state updates. - * - Ensure isClientOpenAndUnlocked is updated - * - Notifies all connections with the new provider network state - * - The external providers handle diffing the state - * - * @param newState - */ - _onStateUpdate(newState) { - this.isClientOpenAndUnlocked = newState.isUnlocked && this._isClientOpen; - this._notifyChainChange(); - } - - // misc - - /** - * A method for emitting the full MetaMask state to all registered listeners. - * - * @private - */ - privateSendUpdate() { - this.emit('update', this.getState()); - } - - /** - * @returns {boolean} Whether the extension is unlocked. - */ - isUnlocked() { - return this.keyringController.state.isUnlocked; - } - - //============================================================================= - // MISCELLANEOUS - //============================================================================= - - getExternalPendingTransactions(address) { - return this.smartTransactionsController.getTransactions({ - addressFrom: address, - status: 'pending', - }); - } - - /** - * The chain list is fetched live at runtime, falling back to a cache. - * This preseeds the cache at startup with a static list provided at build. - */ - async initializeChainlist() { - const cacheKey = `cachedFetch:${CHAIN_SPEC_URL}`; - const { cachedResponse } = (await getStorageItem(cacheKey)) || {}; - if (cachedResponse) { - return; - } - await setStorageItem(cacheKey, { - cachedResponse: rawChainData(), - // Cached value is immediately invalidated - cachedTime: 0, - }); - } - - /** - * Returns the nonce that will be associated with a transaction once approved - * - * @param {string} address - The hex string address for the transaction - * @param networkClientId - The optional networkClientId to get the nonce lock with - * @returns {Promise} - */ - async getPendingNonce(address, networkClientId) { - const { nonceDetails, releaseLock } = await this.txController.getNonceLock( - address, - process.env.TRANSACTION_MULTICHAIN ? networkClientId : undefined, - ); - - const pendingNonce = nonceDetails.params.highestSuggested; - - releaseLock(); - return pendingNonce; - } - - /** - * Returns the next nonce according to the nonce-tracker - * - * @param {string} address - The hex string address for the transaction - * @param networkClientId - The optional networkClientId to get the nonce lock with - * @returns {Promise} - */ - async getNextNonce(address, networkClientId) { - const nonceLock = await this.txController.getNonceLock( - address, - process.env.TRANSACTION_MULTICHAIN ? networkClientId : undefined, - ); - nonceLock.releaseLock(); - const nn = nonceLock.nextNonce; - console.log('-- nn --', nn); - return nn; - } - - /** - * Throw an artificial error in a timeout handler for testing purposes. - * - * @param message - The error message. - * @deprecated This is only mean to facilitiate E2E testing. We should not - * use this for handling errors. - */ - throwTestError(message) { - setTimeout(() => { - const error = new Error(message); - error.name = 'TestError'; - throw error; - }); - } - - /** - * A method for setting TransactionController event listeners - */ - _addTransactionControllerListeners() { - const transactionMetricsRequest = this.getTransactionMetricsRequest(); - - this.controllerMessenger.subscribe( - 'TransactionController:postTransactionBalanceUpdated', - handlePostTransactionBalanceUpdate.bind(null, transactionMetricsRequest), - ); - - this.controllerMessenger.subscribe( - 'TransactionController:unapprovedTransactionAdded', - (transactionMeta) => - handleTransactionAdded(transactionMetricsRequest, { transactionMeta }), - ); - - this.controllerMessenger.subscribe( - 'TransactionController:transactionApproved', - handleTransactionApproved.bind(null, transactionMetricsRequest), - ); - - this.controllerMessenger.subscribe( - 'TransactionController:transactionDropped', - handleTransactionDropped.bind(null, transactionMetricsRequest), - ); - - this.controllerMessenger.subscribe( - 'TransactionController:transactionConfirmed', - handleTransactionConfirmed.bind(null, transactionMetricsRequest), - ); - - this.controllerMessenger.subscribe( - 'TransactionController:transactionFailed', - handleTransactionFailed.bind(null, transactionMetricsRequest), - ); - - this.controllerMessenger.subscribe( - 'TransactionController:transactionNewSwap', - ({ transactionMeta }) => - // TODO: This can be called internally by the TransactionController - // since Swaps Controller registers this action handler - this.controllerMessenger.call( - 'SwapsController:setTradeTxId', - transactionMeta.id, - ), - ); - - this.controllerMessenger.subscribe( - 'TransactionController:transactionNewSwapApproval', - ({ transactionMeta }) => - // TODO: This can be called internally by the TransactionController - // since Swaps Controller registers this action handler - this.controllerMessenger.call( - 'SwapsController:setApproveTxId', - transactionMeta.id, - ), - ); - - this.controllerMessenger.subscribe( - 'TransactionController:transactionRejected', - handleTransactionRejected.bind(null, transactionMetricsRequest), - ); - - this.controllerMessenger.subscribe( - 'TransactionController:transactionSubmitted', - handleTransactionSubmitted.bind(null, transactionMetricsRequest), - ); - - this.controllerMessenger.subscribe( - 'TransactionController:transactionStatusUpdated', - ({ transactionMeta }) => { - this._onFinishedTransaction(transactionMeta); - }, - ); - } - - getTransactionMetricsRequest() { - const controllerActions = { - // Metametrics Actions - createEventFragment: this.metaMetricsController.createEventFragment.bind( - this.metaMetricsController, - ), - finalizeEventFragment: - this.metaMetricsController.finalizeEventFragment.bind( - this.metaMetricsController, - ), - getEventFragmentById: - this.metaMetricsController.getEventFragmentById.bind( - this.metaMetricsController, - ), - getParticipateInMetrics: () => - this.metaMetricsController.state.participateInMetaMetrics, - trackEvent: this.metaMetricsController.trackEvent.bind( - this.metaMetricsController, - ), - updateEventFragment: this.metaMetricsController.updateEventFragment.bind( - this.metaMetricsController, - ), - // Other dependencies - getAccountType: this.getAccountType.bind(this), - getDeviceModel: this.getDeviceModel.bind(this), - getEIP1559GasFeeEstimates: - this.gasFeeController.fetchGasFeeEstimates.bind(this.gasFeeController), - getSelectedAddress: () => - this.accountsController.getSelectedAccount().address, - getTokenStandardAndDetails: this.getTokenStandardAndDetails.bind(this), - getTransaction: (id) => - this.txController.state.transactions.find((tx) => tx.id === id), - getIsSmartTransaction: () => { - return getIsSmartTransaction(this._getMetaMaskState()); - }, - getSmartTransactionByMinedTxHash: (txHash) => { - return this.smartTransactionsController.getSmartTransactionByMinedTxHash( - txHash, - ); - }, - getRedesignedConfirmationsEnabled: () => { - return this.preferencesController.getRedesignedConfirmationsEnabled; - }, - getRedesignedTransactionsEnabled: () => { - return this.preferencesController.getRedesignedTransactionsEnabled; - }, - getMethodData: (data) => { - if (!data) { - return null; - } - const { knownMethodData, use4ByteResolution } = - this.preferencesController.state; - const prefixedData = addHexPrefix(data); - return getMethodDataName( - knownMethodData, - use4ByteResolution, - prefixedData, - this.preferencesController.addKnownMethodData.bind( - this.preferencesController, - ), - this.provider, - ); - }, - getIsRedesignedConfirmationsDeveloperEnabled: () => { - return this.preferencesController.state.preferences - .isRedesignedConfirmationsDeveloperEnabled; - }, - getIsConfirmationAdvancedDetailsOpen: () => { - return this.preferencesController.state.preferences - .showConfirmationAdvancedDetails; - }, - }; - return { - ...controllerActions, - snapAndHardwareMessenger: this.controllerMessenger.getRestricted({ - name: 'SnapAndHardwareMessenger', - allowedActions: [ - 'KeyringController:getKeyringForAccount', - 'SnapController:get', - 'AccountsController:getSelectedAccount', - ], - }), - provider: this.provider, - }; - } - - toggleExternalServices(useExternal) { - this.preferencesController.toggleExternalServices(useExternal); - this.tokenListController.updatePreventPollingOnNetworkRestart(!useExternal); - if (useExternal) { - this.tokenDetectionController.enable(); - this.gasFeeController.enableNonRPCGasFeeApis(); - } else { - this.tokenDetectionController.disable(); - this.gasFeeController.disableNonRPCGasFeeApis(); - } - } - - //============================================================================= - // CONFIG - //============================================================================= - - /** - * Sets the Ledger Live preference to use for Ledger hardware wallet support - * - * @param _keyring - * @deprecated This method is deprecated and will be removed in the future. - * Only webhid connections are supported in chrome and u2f in firefox. - */ - async setLedgerTransportPreference(_keyring) { - const transportType = window.navigator.hid - ? LedgerTransportTypes.webhid - : LedgerTransportTypes.u2f; - const keyring = - _keyring || (await this.getKeyringForDevice(HardwareDeviceNames.ledger)); - if (keyring?.updateTransportMethod) { - return keyring.updateTransportMethod(transportType).catch((e) => { - throw e; - }); - } - - return undefined; - } - - /** - * A method for initializing storage the first time. - * - * @param {object} initState - The default state to initialize with. - * @private - */ - recordFirstTimeInfo(initState) { - if (!('firstTimeInfo' in initState)) { - const version = process.env.METAMASK_VERSION; - initState.firstTimeInfo = { - version, - date: Date.now(), - }; - } - } - - // TODO: Replace isClientOpen methods with `controllerConnectionChanged` events. - /* eslint-disable accessor-pairs */ - /** - * A method for recording whether the MetaMask user interface is open or not. - * - * @param {boolean} open - */ - set isClientOpen(open) { - this._isClientOpen = open; - } - /* eslint-enable accessor-pairs */ - - /** - * A method that is called by the background when all instances of metamask are closed. - * Currently used to stop controller polling. - */ - onClientClosed() { - try { - this.gasFeeController.stopAllPolling(); - this.currencyRateController.stopAllPolling(); - this.tokenRatesController.stopAllPolling(); - this.appStateController.clearPollingTokens(); - } catch (error) { - console.error(error); - } - } - - /** - * A method that is called by the background when a particular environment type is closed (fullscreen, popup, notification). - * Currently used to stop polling in the gasFeeController for only that environement type - * - * @param environmentType - */ - onEnvironmentTypeClosed(environmentType) { - const appStatePollingTokenType = - POLLING_TOKEN_ENVIRONMENT_TYPES[environmentType]; - const pollingTokensToDisconnect = - this.appStateController.store.getState()[appStatePollingTokenType]; - pollingTokensToDisconnect.forEach((pollingToken) => { - this.gasFeeController.stopPollingByPollingToken(pollingToken); - this.currencyRateController.stopPollingByPollingToken(pollingToken); - this.appStateController.removePollingToken( - pollingToken, - appStatePollingTokenType, - ); - }); - } - - /** - * Adds a domain to the PhishingController safelist - * - * @param {string} origin - the domain to safelist - */ - safelistPhishingDomain(origin) { - this.metaMetricsController.trackEvent({ - category: MetaMetricsEventCategory.Phishing, - event: MetaMetricsEventName.ProceedAnywayClicked, - properties: { - url: origin, - referrer: { - url: origin, - }, - }, - }); - - return this.phishingController.bypass(origin); - } - - async backToSafetyPhishingWarning() { - const portfolioBaseURL = process.env.PORTFOLIO_URL; - const portfolioURL = `${portfolioBaseURL}/?metamaskEntry=phishing_page_portfolio_button`; - - this.metaMetricsController.trackEvent({ - category: MetaMetricsEventCategory.Navigation, - event: MetaMetricsEventName.PortfolioLinkClicked, - properties: { - location: 'phishing_page', - text: 'Back to safety', - }, - }); - - await this.platform.switchToAnotherURL(undefined, portfolioURL); - } - - /** - * Locks MetaMask - */ - setLocked() { - return this.keyringController.setLocked(); - } - - removePermissionsFor = (subjects) => { - try { - this.permissionController.revokePermissions(subjects); - } catch (exp) { - if (!(exp instanceof PermissionsRequestNotFoundError)) { - throw exp; - } - } - }; - - updateCaveat = (origin, target, caveatType, caveatValue) => { - try { - this.controllerMessenger.call( - 'PermissionController:updateCaveat', - origin, - target, - caveatType, - caveatValue, - ); - } catch (exp) { - if (!(exp instanceof PermissionsRequestNotFoundError)) { - throw exp; - } - } - }; - - updateNetworksList = (chainIds) => { - try { - this.networkOrderController.updateNetworksList(chainIds); - } catch (err) { - log.error(err.message); - throw err; - } - }; - - updateAccountsList = (pinnedAccountList) => { - try { - this.accountOrderController.updateAccountsList(pinnedAccountList); - } catch (err) { - log.error(err.message); - throw err; - } - }; - - updateHiddenAccountsList = (hiddenAccountList) => { - try { - this.accountOrderController.updateHiddenAccountsList(hiddenAccountList); - } catch (err) { - log.error(err.message); - throw err; - } - }; - - rejectPermissionsRequest = (requestId) => { - try { - this.permissionController.rejectPermissionsRequest(requestId); - } catch (exp) { - if (!(exp instanceof PermissionsRequestNotFoundError)) { - throw exp; - } - } - }; - - acceptPermissionsRequest = (request) => { - try { - this.permissionController.acceptPermissionsRequest(request); - } catch (exp) { - if (!(exp instanceof PermissionsRequestNotFoundError)) { - throw exp; - } - } - }; - - resolvePendingApproval = async (id, value, options) => { - try { - await this.approvalController.accept(id, value, options); - } catch (exp) { - if (!(exp instanceof ApprovalRequestNotFoundError)) { - throw exp; - } - } - }; - - rejectPendingApproval = (id, error) => { - try { - this.approvalController.reject( - id, - new JsonRpcError(error.code, error.message, error.data), - ); - } catch (exp) { - if (!(exp instanceof ApprovalRequestNotFoundError)) { - throw exp; - } - } - }; - - async _onAccountChange(newAddress) { - const permittedAccountsMap = getPermittedAccountsByOrigin( - this.permissionController.state, - ); - - for (const [origin, accounts] of permittedAccountsMap.entries()) { - if (accounts.includes(newAddress)) { - this._notifyAccountsChange(origin, accounts); - } - } - - await this.txController.updateIncomingTransactions(); - } - - async _notifyAccountsChange(origin, newAccounts) { - if (this.isUnlocked()) { - this.notifyConnections(origin, { - method: NOTIFICATION_NAMES.accountsChanged, - // This should be the same as the return value of `eth_accounts`, - // namely an array of the current / most recently selected Ethereum - // account. - params: - newAccounts.length < 2 - ? // If the length is 1 or 0, the accounts are sorted by definition. - newAccounts - : // If the length is 2 or greater, we have to execute - // `eth_accounts` vi this method. - await this.getPermittedAccounts(origin), - }); - } - - this.permissionLogController.updateAccountsHistory(origin, newAccounts); - } - - async _notifyChainChange() { - if (this.preferencesController.getUseRequestQueue()) { - this.notifyAllConnections(async (origin) => ({ - method: NOTIFICATION_NAMES.chainChanged, - params: await this.getProviderNetworkState(origin), - })); - } else { - this.notifyAllConnections({ - method: NOTIFICATION_NAMES.chainChanged, - params: await this.getProviderNetworkState(), - }); - } - } - - async _notifyChainChangeForConnection(connection, origin) { - if (this.preferencesController.getUseRequestQueue()) { - this.notifyConnection(connection, { - method: NOTIFICATION_NAMES.chainChanged, - params: await this.getProviderNetworkState(origin), - }); - } else { - this.notifyConnection(connection, { - method: NOTIFICATION_NAMES.chainChanged, - params: await this.getProviderNetworkState(), - }); - } - } - - async _onFinishedTransaction(transactionMeta) { - if ( - ![TransactionStatus.confirmed, TransactionStatus.failed].includes( - transactionMeta.status, - ) - ) { - return; - } - - await this._createTransactionNotifcation(transactionMeta); - await this._updateNFTOwnership(transactionMeta); - this._trackTransactionFailure(transactionMeta); - } - - async _createTransactionNotifcation(transactionMeta) { - const { chainId } = transactionMeta; - let rpcPrefs = {}; - - if (chainId) { - const networkConfiguration = - this.networkController.state.networkConfigurationsByChainId?.[chainId]; - - const blockExplorerUrl = - networkConfiguration?.blockExplorerUrls?.[ - networkConfiguration?.defaultBlockExplorerUrlIndex - ]; - - rpcPrefs = { blockExplorerUrl }; - } - - try { - await this.platform.showTransactionNotification( - transactionMeta, - rpcPrefs, - ); - } catch (error) { - log.error('Failed to create transaction notification', error); - } - } - - async _updateNFTOwnership(transactionMeta) { - // if this is a transferFrom method generated from within the app it may be an NFT transfer transaction - // in which case we will want to check and update ownership status of the transferred NFT. - - const { type, txParams, chainId, txReceipt } = transactionMeta; - const selectedAddress = - this.accountsController.getSelectedAccount().address; - - const { allNfts } = this.nftController.state; - const txReceiptLogs = txReceipt?.logs; - - const isContractInteractionTx = - type === TransactionType.contractInteraction && txReceiptLogs; - const isTransferFromTx = - (type === TransactionType.tokenMethodTransferFrom || - type === TransactionType.tokenMethodSafeTransferFrom) && - txParams !== undefined; - - if (!isContractInteractionTx && !isTransferFromTx) { - return; - } - - if (isTransferFromTx) { - const { data, to: contractAddress, from: userAddress } = txParams; - const transactionData = parseStandardTokenTransactionData(data); - // Sometimes the tokenId value is parsed as "_value" param. Not seeing this often any more, but still occasionally: - // i.e. call approve() on BAYC contract - https://etherscan.io/token/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d#writeContract, and tokenId shows up as _value, - // not sure why since it doesn't match the ERC721 ABI spec we use to parse these transactions - https://github.com/MetaMask/metamask-eth-abis/blob/d0474308a288f9252597b7c93a3a8deaad19e1b2/src/abis/abiERC721.ts#L62. - const transactionDataTokenId = - getTokenIdParam(transactionData) ?? getTokenValueParam(transactionData); - - // check if its a known NFT - const knownNft = allNfts?.[userAddress]?.[chainId]?.find( - ({ address, tokenId }) => - isEqualCaseInsensitive(address, contractAddress) && - tokenId === transactionDataTokenId, - ); - - // if it is we check and update ownership status. - if (knownNft) { - this.nftController.checkAndUpdateSingleNftOwnershipStatus( - knownNft, - false, - // TODO add networkClientId once it is available in the transactionMeta - // the chainId previously passed here didn't actually allow us to check for ownership on a non globally selected network - // because the check would use the provider for the globally selected network, not the chainId passed here. - { userAddress }, - ); - } - } else { - // Else if contract interaction we will parse the logs - - const allNftTransferLog = txReceiptLogs.map((txReceiptLog) => { - const isERC1155NftTransfer = - txReceiptLog.topics && - txReceiptLog.topics[0] === TRANSFER_SINFLE_LOG_TOPIC_HASH; - const isERC721NftTransfer = - txReceiptLog.topics && - txReceiptLog.topics[0] === TOKEN_TRANSFER_LOG_TOPIC_HASH; - let isTransferToSelectedAddress; - - if (isERC1155NftTransfer) { - isTransferToSelectedAddress = - txReceiptLog.topics && - txReceiptLog.topics[3] && - txReceiptLog.topics[3].match(selectedAddress?.slice(2)); - } - - if (isERC721NftTransfer) { - isTransferToSelectedAddress = - txReceiptLog.topics && - txReceiptLog.topics[2] && - txReceiptLog.topics[2].match(selectedAddress?.slice(2)); - } - - return { - isERC1155NftTransfer, - isERC721NftTransfer, - isTransferToSelectedAddress, - ...txReceiptLog, - }; - }); - if (allNftTransferLog.length !== 0) { - const allNftParsedLog = []; - allNftTransferLog.forEach((singleLog) => { - if ( - singleLog.isTransferToSelectedAddress && - (singleLog.isERC1155NftTransfer || singleLog.isERC721NftTransfer) - ) { - let iface; - if (singleLog.isERC1155NftTransfer) { - iface = new Interface(abiERC1155); - } else { - iface = new Interface(abiERC721); - } - try { - const parsedLog = iface.parseLog({ - data: singleLog.data, - topics: singleLog.topics, - }); - allNftParsedLog.push({ - contract: singleLog.address, - ...parsedLog, - }); - } catch (err) { - // ignore - } - } - }); - // Filter known nfts and new Nfts - const knownNFTs = []; - const newNFTs = []; - allNftParsedLog.forEach((single) => { - const tokenIdFromLog = getTokenIdParam(single); - const existingNft = allNfts?.[selectedAddress]?.[chainId]?.find( - ({ address, tokenId }) => { - return ( - isEqualCaseInsensitive(address, single.contract) && - tokenId === tokenIdFromLog - ); - }, - ); - if (existingNft) { - knownNFTs.push(existingNft); - } else { - newNFTs.push({ - tokenId: tokenIdFromLog, - ...single, - }); - } - }); - // For known nfts only refresh ownership - const refreshOwnershipNFts = knownNFTs.map(async (singleNft) => { - return this.nftController.checkAndUpdateSingleNftOwnershipStatus( - singleNft, - false, - // TODO add networkClientId once it is available in the transactionMeta - // the chainId previously passed here didn't actually allow us to check for ownership on a non globally selected network - // because the check would use the provider for the globally selected network, not the chainId passed here. - { selectedAddress }, - ); - }); - await Promise.allSettled(refreshOwnershipNFts); - // For new nfts, add them to state - const addNftPromises = newNFTs.map(async (singleNft) => { - return this.nftController.addNft( - singleNft.contract, - singleNft.tokenId, - ); - }); - await Promise.allSettled(addNftPromises); - } - } - } - - _trackTransactionFailure(transactionMeta) { - const { txReceipt } = transactionMeta; - const metamaskState = this.getState(); - - if (!txReceipt || txReceipt.status !== '0x0') { - return; - } - - this.metaMetricsController.trackEvent( - { - event: 'Tx Status Update: On-Chain Failure', - category: MetaMetricsEventCategory.Background, - properties: { - action: 'Transactions', - errorMessage: transactionMeta.simulationFails?.reason, - numberOfTokens: metamaskState.tokens.length, - numberOfAccounts: Object.keys(metamaskState.accounts).length, - }, - }, - { - matomoEvent: true, - }, - ); - } - - _onUserOperationAdded(userOperationMeta) { - const transactionMeta = this.txController.state.transactions.find( - (tx) => tx.id === userOperationMeta.id, - ); - - if (!transactionMeta) { - return; - } - - if (transactionMeta.type === TransactionType.swap) { - this.controllerMessenger.publish( - 'TransactionController:transactionNewSwap', - { transactionMeta }, - ); - } else if (transactionMeta.type === TransactionType.swapApproval) { - this.controllerMessenger.publish( - 'TransactionController:transactionNewSwapApproval', - { transactionMeta }, - ); - } - } - - _onUserOperationTransactionUpdated(transactionMeta) { - const updatedTransactionMeta = { - ...transactionMeta, - txParams: { - ...transactionMeta.txParams, - from: this.accountsController.getSelectedAccount().address, - }, - }; - - const transactionExists = this.txController.state.transactions.some( - (tx) => tx.id === updatedTransactionMeta.id, - ); - - if (!transactionExists) { - this.txController.update((state) => { - state.transactions.push(updatedTransactionMeta); - }); - } - - this.txController.updateTransaction( - updatedTransactionMeta, - 'Generated from user operation', - ); - - this.controllerMessenger.publish( - 'TransactionController:transactionStatusUpdated', - { transactionMeta: updatedTransactionMeta }, - ); - } - - _publishSmartTransactionHook(transactionMeta, signedTransactionInHex) { - const state = this._getMetaMaskState(); - const isSmartTransaction = getIsSmartTransaction(state); - if (!isSmartTransaction) { - // Will cause TransactionController to publish to the RPC provider as normal. - return { transactionHash: undefined }; - } - const featureFlags = getFeatureFlagsByChainId(state); - return submitSmartTransactionHook({ - transactionMeta, - signedTransactionInHex, - transactionController: this.txController, - smartTransactionsController: this.smartTransactionsController, - controllerMessenger: this.controllerMessenger, - isSmartTransaction, - isHardwareWallet: isHardwareWallet(state), - featureFlags, - }); - } - - _getMetaMaskState() { - return { - metamask: this.getState(), - }; - } - - #checkTokenListPolling(currentState, previousState) { - const previousEnabled = this.#isTokenListPollingRequired(previousState); - const newEnabled = this.#isTokenListPollingRequired(currentState); - - if (previousEnabled === newEnabled) { - return; - } - - this.tokenListController.updatePreventPollingOnNetworkRestart(!newEnabled); - - if (newEnabled) { - log.debug('Started token list controller polling'); - this.tokenListController.start(); - } else { - log.debug('Stopped token list controller polling'); - this.tokenListController.clearingTokenListData(); - this.tokenListController.stop(); - } - } - - #isTokenListPollingRequired(preferencesControllerState) { - const { useTokenDetection, useTransactionSimulations, preferences } = - preferencesControllerState ?? {}; - - const { petnamesEnabled } = preferences ?? {}; - - return useTokenDetection || petnamesEnabled || useTransactionSimulations; - } -} From 399086b8a73029daf018aca1d1bc7093ecf79091 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Fri, 8 Nov 2024 15:23:25 +0530 Subject: [PATCH 06/31] Display native values returned from decoding api --- ui/components/app/confirm/info/row/row.tsx | 2 +- .../decoded-simulation/decoded-simulation.tsx | 22 ++++--------------- 2 files changed, 5 insertions(+), 19 deletions(-) diff --git a/ui/components/app/confirm/info/row/row.tsx b/ui/components/app/confirm/info/row/row.tsx index 55821f7080f5..461febe0b0a2 100644 --- a/ui/components/app/confirm/info/row/row.tsx +++ b/ui/components/app/confirm/info/row/row.tsx @@ -99,7 +99,7 @@ export const ConfirmInfoRow: React.FC = ({ flexDirection={isCollapsible ? FlexDirection.Column : FlexDirection.Row} justifyContent={JustifyContent.spaceBetween} flexWrap={FlexWrap.Wrap} - alignItems={isCollapsible ? AlignItems.flexStart : AlignItems.center} + alignItems={AlignItems.flexStart} backgroundColor={BACKGROUND_COLORS[variant]} borderRadius={BorderRadius.LG} marginTop={2} diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx index 623f1edb1c3b..ed3d01e7fba8 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx @@ -1,26 +1,18 @@ import React, { ReactNode } from 'react'; import { - DecodingData, DecodingDataChangeType, DecodingDataStateChange, } from '@metamask/signature-controller'; import { Hex } from '@metamask/utils'; import { TokenStandard } from '../../../../../../../../../shared/constants/transaction'; -import { - Box, - Text, -} from '../../../../../../../../components/component-library'; -import { - TextColor, - TextVariant, -} from '../../../../../../../../helpers/constants/design-system'; import { useI18nContext } from '../../../../../../../../hooks/useI18nContext'; import { SignatureRequestType } from '../../../../../../types/confirm'; import { useConfirmContext } from '../../../../../../context/confirm'; import StaticSimulation from '../../../shared/static-simulation/static-simulation'; import TokenValueDisplay from '../value-display/value-display'; import NativeValueDisplay from '../native-value-display/native-value-display'; +import { ConfirmInfoRow } from '../../../../../../../../components/app/confirm/info/row'; const getStateChangeLabelMap = ( t: ReturnType, @@ -46,14 +38,7 @@ const StateChangeRow = ({ const { assetType, changeType, amount, contractAddress, tokenID } = stateChange; return ( - - - {getStateChangeLabelMap(t, changeType)} - + {(assetType === TokenStandard.ERC20 || assetType === TokenStandard.ERC721) && ( )} - + ); }; @@ -82,6 +67,7 @@ const DecodedSimulation: React.FC = () => { const { currentConfirmation } = useConfirmContext(); const chainId = currentConfirmation.chainId as Hex; const { decodingLoading, decodingData } = currentConfirmation; + console.log('decodingData = ', decodingData); let stateChangeFragment: ReactNode[] = []; if (decodingData && decodingData.stateChanges) { From 602fb20c0af1cac385467ead2a08af2023745c7a Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Mon, 11 Nov 2024 10:23:46 +0530 Subject: [PATCH 07/31] Update signature controller and integrate decoding api --- app/scripts/metamask-controller.js | 11 ++++++++--- builds.yml | 4 ++++ package.json | 2 +- yarn.lock | 12 ++++++------ 4 files changed, 19 insertions(+), 10 deletions(-) diff --git a/app/scripts/metamask-controller.js b/app/scripts/metamask-controller.js index d43c12ff24a1..ed0868e027d1 100644 --- a/app/scripts/metamask-controller.js +++ b/app/scripts/metamask-controller.js @@ -2000,6 +2000,11 @@ export default class MetamaskController extends EventEmitter { ], }), trace, + decodingApiUrl: process.env.DECODING_API_URL, + isDecodeSignatureRequestEnabled: () => + this.preferencesController.state.useExternalServices === true && + this.preferencesController.state.useTransactionSimulations && + process.env.ENABLE_SIGNATURE_DECODING === true, }); this.signatureController.hub.on( @@ -3321,8 +3326,6 @@ export default class MetamaskController extends EventEmitter { preferencesController.setWatchEthereumAccountEnabled.bind( preferencesController, ), - ///: END:ONLY_INCLUDE_IF - ///: BEGIN:ONLY_INCLUDE_IF(solana) setSolanaSupportEnabled: preferencesController.setSolanaSupportEnabled.bind( preferencesController, @@ -6405,7 +6408,9 @@ export default class MetamaskController extends EventEmitter { process.env.TRANSACTION_MULTICHAIN ? networkClientId : undefined, ); nonceLock.releaseLock(); - return nonceLock.nextNonce; + const nn = nonceLock.nextNonce; + console.log('-- nn --', nn); + return nn; } /** diff --git a/builds.yml b/builds.yml index 2442ad51475a..cafabe0a6e51 100644 --- a/builds.yml +++ b/builds.yml @@ -235,6 +235,10 @@ env: # Used to enable confirmation redesigned pages - ENABLE_CONFIRMATION_REDESIGN: '' + # Used to enable signature decoding + - ENABLE_SIGNATURE_DECODING: '' + # Url of the decoding api + - DECODING_API_URL: null # Determines if feature flagged Settings Page - Developer Options should be used - ENABLE_SETTINGS_PAGE_DEV_OPTIONS: false # Used for debugging changes to the phishing warning page. diff --git a/package.json b/package.json index 13bddaa69287..82761929b27a 100644 --- a/package.json +++ b/package.json @@ -339,7 +339,7 @@ "@metamask/safe-event-emitter": "^3.1.1", "@metamask/scure-bip39": "^2.0.3", "@metamask/selected-network-controller": "^18.0.2", - "@metamask/signature-controller": "^21.0.0", + "@metamask/signature-controller": "^21.1.0", "@metamask/smart-transactions-controller": "^13.0.0", "@metamask/snaps-controllers": "^9.12.0", "@metamask/snaps-execution-environments": "^6.9.2", diff --git a/yarn.lock b/yarn.lock index bb91a8129ac2..896bdc3a0b78 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6149,12 +6149,12 @@ __metadata: languageName: node linkType: hard -"@metamask/signature-controller@npm:^21.0.0": - version: 21.0.0 - resolution: "@metamask/signature-controller@npm:21.0.0" +"@metamask/signature-controller@npm:^21.1.0": + version: 21.1.0 + resolution: "@metamask/signature-controller@npm:21.1.0" dependencies: "@metamask/base-controller": "npm:^7.0.2" - "@metamask/controller-utils": "npm:^11.4.1" + "@metamask/controller-utils": "npm:^11.4.2" "@metamask/eth-sig-util": "npm:^8.0.0" "@metamask/utils": "npm:^10.0.0" jsonschema: "npm:^1.2.4" @@ -6165,7 +6165,7 @@ __metadata: "@metamask/keyring-controller": ^17.0.0 "@metamask/logging-controller": ^6.0.0 "@metamask/network-controller": ^22.0.0 - checksum: 10/4c1b1cbf909004099adb3f0d2b01c8fe640ae9a13a8e53ffbcf05c7a1a23384f6077b96b845c22c4edf3bceaaff2a705769d4623f37affac7e429ab0dae06912 + checksum: 10/00d28234d6402632ecf000d7c908a134a0f49cbbdb165a7cfe72895bc91248de82947cd9628dbbe953ffb8b6054f84a0dc1ad824a1aff369d8f2189a78fd56a9 languageName: node linkType: hard @@ -26580,7 +26580,7 @@ __metadata: "@metamask/safe-event-emitter": "npm:^3.1.1" "@metamask/scure-bip39": "npm:^2.0.3" "@metamask/selected-network-controller": "npm:^18.0.2" - "@metamask/signature-controller": "npm:^21.0.0" + "@metamask/signature-controller": "npm:^21.1.0" "@metamask/smart-transactions-controller": "npm:^13.0.0" "@metamask/snaps-controllers": "npm:^9.12.0" "@metamask/snaps-execution-environments": "npm:^6.9.2" From fc6ab5e88b1140bab68c6943c43e86b7b1840f8d Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Mon, 11 Nov 2024 10:28:38 +0530 Subject: [PATCH 08/31] Update signature controller and integrate decoding api --- app/scripts/metamask-controller.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/app/scripts/metamask-controller.js b/app/scripts/metamask-controller.js index ed0868e027d1..46e46e4e72dc 100644 --- a/app/scripts/metamask-controller.js +++ b/app/scripts/metamask-controller.js @@ -3326,6 +3326,8 @@ export default class MetamaskController extends EventEmitter { preferencesController.setWatchEthereumAccountEnabled.bind( preferencesController, ), + ///: END:ONLY_INCLUDE_IF + ///: BEGIN:ONLY_INCLUDE_IF(solana) setSolanaSupportEnabled: preferencesController.setSolanaSupportEnabled.bind( preferencesController, @@ -6408,9 +6410,7 @@ export default class MetamaskController extends EventEmitter { process.env.TRANSACTION_MULTICHAIN ? networkClientId : undefined, ); nonceLock.releaseLock(); - const nn = nonceLock.nextNonce; - console.log('-- nn --', nn); - return nn; + return nonceLock.nextNonce; } /** From 228796ca5af15c236a45aac7bb5a06e6d2ab20d0 Mon Sep 17 00:00:00 2001 From: MetaMask Bot Date: Mon, 11 Nov 2024 05:15:48 +0000 Subject: [PATCH 09/31] Update LavaMoat policies --- lavamoat/browserify/beta/policy.json | 3 +++ lavamoat/browserify/flask/policy.json | 3 +++ lavamoat/browserify/main/policy.json | 3 +++ lavamoat/browserify/mmi/policy.json | 3 +++ 4 files changed, 12 insertions(+) diff --git a/lavamoat/browserify/beta/policy.json b/lavamoat/browserify/beta/policy.json index eaac48a8f5f0..974d7726cb5f 100644 --- a/lavamoat/browserify/beta/policy.json +++ b/lavamoat/browserify/beta/policy.json @@ -2456,6 +2456,9 @@ } }, "@metamask/signature-controller": { + "globals": { + "fetch": true + }, "packages": { "@metamask/base-controller": true, "@metamask/controller-utils": true, diff --git a/lavamoat/browserify/flask/policy.json b/lavamoat/browserify/flask/policy.json index eaac48a8f5f0..974d7726cb5f 100644 --- a/lavamoat/browserify/flask/policy.json +++ b/lavamoat/browserify/flask/policy.json @@ -2456,6 +2456,9 @@ } }, "@metamask/signature-controller": { + "globals": { + "fetch": true + }, "packages": { "@metamask/base-controller": true, "@metamask/controller-utils": true, diff --git a/lavamoat/browserify/main/policy.json b/lavamoat/browserify/main/policy.json index eaac48a8f5f0..974d7726cb5f 100644 --- a/lavamoat/browserify/main/policy.json +++ b/lavamoat/browserify/main/policy.json @@ -2456,6 +2456,9 @@ } }, "@metamask/signature-controller": { + "globals": { + "fetch": true + }, "packages": { "@metamask/base-controller": true, "@metamask/controller-utils": true, diff --git a/lavamoat/browserify/mmi/policy.json b/lavamoat/browserify/mmi/policy.json index 467ef781215c..f4ab43c4c8c5 100644 --- a/lavamoat/browserify/mmi/policy.json +++ b/lavamoat/browserify/mmi/policy.json @@ -2548,6 +2548,9 @@ } }, "@metamask/signature-controller": { + "globals": { + "fetch": true + }, "packages": { "@metamask/base-controller": true, "@metamask/controller-utils": true, From 2943ebf5e629f6d56ff3b0aab2bc5cbaee4104d7 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Mon, 11 Nov 2024 10:47:46 +0530 Subject: [PATCH 10/31] update --- app/scripts/controllers/mmi-controller.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/scripts/controllers/mmi-controller.ts b/app/scripts/controllers/mmi-controller.ts index ac8de8b76656..c015092728f6 100644 --- a/app/scripts/controllers/mmi-controller.ts +++ b/app/scripts/controllers/mmi-controller.ts @@ -24,9 +24,9 @@ import { NetworkState } from '@metamask/network-controller'; import { MessageParamsPersonal, MessageParamsTyped, + OriginalRequest, SignatureController, } from '@metamask/signature-controller'; -import { OriginalRequest } from '@metamask/message-manager'; import { InternalAccount } from '@metamask/keyring-api'; import { toHex } from '@metamask/controller-utils'; import { toChecksumHexAddress } from '../../../shared/modules/hexstring-utils'; From 25e9a00ecfd26b23a2057f846bd7727d54439551 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Tue, 5 Nov 2024 23:23:46 +0530 Subject: [PATCH 11/31] UI changes to show decoding data for permits --- .../static-simulation/static-simulation.tsx | 18 +- .../permit-simulation.test.tsx.snap | 43 ++- .../decoded-simulation.test.tsx.snap | 9 + .../decoded-simulation.test.tsx | 21 ++ .../decoded-simulation/decoded-simulation.tsx | 7 + .../decoded-simulation/index.ts | 1 + .../default-simulation.test.tsx.snap | 246 ++++++++++++++++++ .../default-simulation.test.tsx | 60 +++++ .../default-simulation/default-simulation.tsx | 118 +++++++++ .../default-simulation/index.ts | 1 + .../permit-simulation.test.tsx | 51 +++- .../permit-simulation/permit-simulation.tsx | 120 +-------- ui/pages/confirmations/types/confirm.ts | 11 + 13 files changed, 574 insertions(+), 132 deletions(-) create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/index.ts create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.test.tsx create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.tsx create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/index.ts diff --git a/ui/pages/confirmations/components/confirm/info/shared/static-simulation/static-simulation.tsx b/ui/pages/confirmations/components/confirm/info/shared/static-simulation/static-simulation.tsx index 7901854b91d1..cf8ad9cd5773 100644 --- a/ui/pages/confirmations/components/confirm/info/shared/static-simulation/static-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/shared/static-simulation/static-simulation.tsx @@ -1,22 +1,36 @@ import React from 'react'; + +import { Box } from '../../../../../../../components/component-library'; import { ConfirmInfoRow, ConfirmInfoRowText, } from '../../../../../../../components/app/confirm/info/row'; import { ConfirmInfoSection } from '../../../../../../../components/app/confirm/info/row/section'; +import { + Display, + JustifyContent, +} from '../../../../../../../helpers/constants/design-system'; +import Preloader from '../../../../../../../components/ui/icon/preloader'; const StaticSimulation: React.FC<{ title: string; titleTooltip: string; description: string; simulationElements: React.ReactNode; -}> = ({ title, titleTooltip, description, simulationElements }) => { + isLoading?: boolean; +}> = ({ title, titleTooltip, description, simulationElements, isLoading }) => { return ( - {simulationElements} + {isLoading ? ( + + + + ) : ( + simulationElements + )} ); }; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap index f35e2218cbfb..16e7f5fa79d9 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap @@ -1,6 +1,14 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`PermitSimulation renders component correctly 1`] = ` +exports[`PermitSimulation should not render default simulation if decodingLoading is true 1`] = ` +
+
+ "DECODED SIMULATION IMPLEMENTATION" +
+
+`; + +exports[`PermitSimulation should render default simulation if decoding api does not return result 1`] = `
`; -exports[`PermitSimulation renders correctly for NFT permit 1`] = ` +exports[`PermitSimulation should render default simulation if decoding api returns error 1`] = `
- You're giving someone else permission to withdraw NFTs from your account. + You're giving the spender permission to spend this many tokens from your account.

@@ -190,7 +198,7 @@ exports[`PermitSimulation renders correctly for NFT permit 1`] = `

- Withdraw + Spending cap

@@ -207,14 +215,25 @@ exports[`PermitSimulation renders correctly for NFT permit 1`] = `
-
-

+

- #3606393 -

+

+ 30 +

+
- 0xC3644...1FE88 + 0xCcCCc...ccccC

diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap new file mode 100644 index 000000000000..9c190acccee9 --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap @@ -0,0 +1,9 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`DecodedSimulation renders component correctly 1`] = ` +
+
+ "DECODED SIMULATION IMPLEMENTATION" +
+
+`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx new file mode 100644 index 000000000000..00e0fbadb496 --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx @@ -0,0 +1,21 @@ +import React from 'react'; +import configureMockStore from 'redux-mock-store'; + +import { getMockTypedSignConfirmStateForRequest } from '../../../../../../../../../test/data/confirmations/helper'; +import { renderWithConfirmContextProvider } from '../../../../../../../../../test/lib/confirmations/render-helpers'; +import { permitSignatureMsg } from '../../../../../../../../../test/data/confirmations/typed_sign'; +import PermitSimulation from './decoded-simulation'; + +describe('DecodedSimulation', () => { + it('renders component correctly', async () => { + const state = getMockTypedSignConfirmStateForRequest(permitSignatureMsg); + const mockStore = configureMockStore([])(state); + + const { container } = renderWithConfirmContextProvider( + , + mockStore, + ); + + expect(container).toMatchSnapshot(); + }); +}); diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx new file mode 100644 index 000000000000..f4767dbee264 --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx @@ -0,0 +1,7 @@ +import React from 'react'; + +const DecodedSimulation: React.FC = () => ( +
"DECODED SIMULATION IMPLEMENTATION"
+); + +export default DecodedSimulation; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/index.ts b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/index.ts new file mode 100644 index 000000000000..a13982b1b09d --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/index.ts @@ -0,0 +1 @@ +export { default as DecodedSimulation } from './decoded-simulation'; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap new file mode 100644 index 000000000000..a378d0befcc4 --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap @@ -0,0 +1,246 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`DefaultSimulation renders component correctly 1`] = ` +
+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+

+ You're giving the spender permission to spend this many tokens from your account. +

+
+
+
+
+
+

+ Spending cap +

+
+
+
+
+
+
+
+
+

+ 30 +

+
+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+
+
+
+`; + +exports[`DefaultSimulation renders correctly for NFT permit 1`] = ` +
+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+

+ You're giving someone else permission to withdraw NFTs from your account. +

+
+
+
+
+
+

+ Withdraw +

+
+
+
+
+
+
+
+

+ #3606393 +

+
+
+
+
+ +

+ 0xC3644...1FE88 +

+
+
+
+
+
+
+
+
+
+`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.test.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.test.tsx new file mode 100644 index 000000000000..b9e095292bce --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.test.tsx @@ -0,0 +1,60 @@ +import React from 'react'; +import configureMockStore from 'redux-mock-store'; +import { act } from 'react-dom/test-utils'; + +import { getMockTypedSignConfirmStateForRequest } from '../../../../../../../../../test/data/confirmations/helper'; +import { renderWithConfirmContextProvider } from '../../../../../../../../../test/lib/confirmations/render-helpers'; +import { + permitNFTSignatureMsg, + permitSignatureMsg, +} from '../../../../../../../../../test/data/confirmations/typed_sign'; +import { memoizedGetTokenStandardAndDetails } from '../../../../../../utils/token'; +import DefaultSimulation from './default-simulation'; + +jest.mock('../../../../../../../../store/actions', () => { + return { + getTokenStandardAndDetails: jest + .fn() + .mockResolvedValue({ decimals: 2, standard: 'ERC20' }), + }; +}); + +describe('DefaultSimulation', () => { + afterEach(() => { + jest.clearAllMocks(); + + /** Reset memoized function using getTokenStandardAndDetails for each test */ + memoizedGetTokenStandardAndDetails?.cache?.clear?.(); + }); + + it('renders component correctly', async () => { + const state = getMockTypedSignConfirmStateForRequest(permitSignatureMsg); + const mockStore = configureMockStore([])(state); + + await act(async () => { + const { container, findByText } = renderWithConfirmContextProvider( + , + mockStore, + ); + + expect(await findByText('30')).toBeInTheDocument(); + expect(container).toMatchSnapshot(); + }); + }); + + it('renders correctly for NFT permit', async () => { + const state = getMockTypedSignConfirmStateForRequest(permitNFTSignatureMsg); + const mockStore = configureMockStore([])(state); + + await act(async () => { + const { container, findByText } = renderWithConfirmContextProvider( + , + mockStore, + ); + + expect(await findByText('Withdraw')).toBeInTheDocument(); + expect(await findByText('#3606393')).toBeInTheDocument(); + expect(container).toMatchSnapshot(); + }); + }); +}); diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.tsx new file mode 100644 index 000000000000..c39a88585e35 --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/default-simulation.tsx @@ -0,0 +1,118 @@ +import { Hex } from '@metamask/utils'; +import React from 'react'; +import { PrimaryType } from '../../../../../../../../../shared/constants/signatures'; +import { parseTypedDataMessage } from '../../../../../../../../../shared/modules/transaction.utils'; +import { ConfirmInfoRow } from '../../../../../../../../components/app/confirm/info/row'; +import { Box } from '../../../../../../../../components/component-library'; +import { + Display, + FlexDirection, +} from '../../../../../../../../helpers/constants/design-system'; +import { useI18nContext } from '../../../../../../../../hooks/useI18nContext'; +import { useConfirmContext } from '../../../../../../context/confirm'; +import { SignatureRequestType } from '../../../../../../types/confirm'; +import StaticSimulation from '../../../shared/static-simulation/static-simulation'; +import PermitSimulationValueDisplay from '../value-display/value-display'; + +function extractTokenDetailsByPrimaryType( + message: Record, + primaryType: PrimaryType, +): object[] | unknown { + let tokenDetails; + + switch (primaryType) { + case PrimaryType.PermitBatch: + case PrimaryType.PermitSingle: + tokenDetails = message?.details; + break; + case PrimaryType.PermitBatchTransferFrom: + case PrimaryType.PermitTransferFrom: + tokenDetails = message?.permitted; + break; + default: + break; + } + + const isNonArrayObject = tokenDetails && !Array.isArray(tokenDetails); + + return isNonArrayObject ? [tokenDetails] : tokenDetails; +} + +const DefaultPermitSimulation: React.FC = () => { + const t = useI18nContext(); + const { currentConfirmation } = useConfirmContext(); + const msgData = currentConfirmation.msgParams?.data; + const chainId = currentConfirmation.chainId as Hex; + const { + domain: { verifyingContract }, + message, + message: { tokenId }, + primaryType, + } = parseTypedDataMessage(msgData as string); + const isNFT = tokenId !== undefined; + + const tokenDetails = extractTokenDetailsByPrimaryType(message, primaryType); + + const TokenDetail = ({ + token, + amount, + i, + }: { + token: Hex | string; + amount: number | string; + i: number; + }) => ( + + ); + + const SpendingCapRow = ( + + + {Array.isArray(tokenDetails) ? ( + + {tokenDetails.map( + ( + { token, amount }: { token: string; amount: string }, + i: number, + ) => ( + + ), + )} + + ) : ( + + )} + + + ); + + return ( + + ); +}; + +export default DefaultPermitSimulation; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/index.ts b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/index.ts new file mode 100644 index 000000000000..b9f6c48b65db --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/index.ts @@ -0,0 +1 @@ +export { default as DefaultSimulation } from './default-simulation'; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.test.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.test.tsx index 0d67715867d9..d0183d1ac2e7 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.test.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.test.tsx @@ -1,13 +1,11 @@ import React from 'react'; import configureMockStore from 'redux-mock-store'; import { act } from 'react-dom/test-utils'; +import { waitFor } from '@testing-library/dom'; import { getMockTypedSignConfirmStateForRequest } from '../../../../../../../../test/data/confirmations/helper'; import { renderWithConfirmContextProvider } from '../../../../../../../../test/lib/confirmations/render-helpers'; -import { - permitNFTSignatureMsg, - permitSignatureMsg, -} from '../../../../../../../../test/data/confirmations/typed_sign'; +import { permitSignatureMsg } from '../../../../../../../../test/data/confirmations/typed_sign'; import { memoizedGetTokenStandardAndDetails } from '../../../../../utils/token'; import PermitSimulation from './permit-simulation'; @@ -27,8 +25,12 @@ describe('PermitSimulation', () => { memoizedGetTokenStandardAndDetails?.cache?.clear?.(); }); - it('renders component correctly', async () => { - const state = getMockTypedSignConfirmStateForRequest(permitSignatureMsg); + it('should render default simulation if decoding api does not return result', async () => { + const state = getMockTypedSignConfirmStateForRequest({ + ...permitSignatureMsg, + decodingLoading: false, + decodingData: undefined, + }); const mockStore = configureMockStore([])(state); await act(async () => { @@ -42,8 +44,18 @@ describe('PermitSimulation', () => { }); }); - it('renders correctly for NFT permit', async () => { - const state = getMockTypedSignConfirmStateForRequest(permitNFTSignatureMsg); + it('should render default simulation if decoding api returns error', async () => { + const state = getMockTypedSignConfirmStateForRequest({ + ...permitSignatureMsg, + decodingLoading: false, + decodingData: { + stateChanges: null, + error: { + message: 'some error', + type: 'SOME_ERROR', + }, + }, + }); const mockStore = configureMockStore([])(state); await act(async () => { @@ -52,9 +64,28 @@ describe('PermitSimulation', () => { mockStore, ); - expect(await findByText('Withdraw')).toBeInTheDocument(); - expect(await findByText('#3606393')).toBeInTheDocument(); + expect(await findByText('30')).toBeInTheDocument(); expect(container).toMatchSnapshot(); }); }); + + it('should not render default simulation if decodingLoading is true', async () => { + const state = getMockTypedSignConfirmStateForRequest({ + ...permitSignatureMsg, + decodingLoading: true, + }); + const mockStore = configureMockStore([])(state); + + await act(async () => { + const { container, queryByTestId } = renderWithConfirmContextProvider( + , + mockStore, + ); + + await waitFor(() => { + expect(queryByTestId('30')).not.toBeInTheDocument(); + expect(container).toMatchSnapshot(); + }); + }); + }); }); diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.tsx index 855f7837ba42..0b4d9eed22d4 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.tsx @@ -1,118 +1,22 @@ -import { Hex } from '@metamask/utils'; import React from 'react'; -import { PrimaryType } from '../../../../../../../../shared/constants/signatures'; -import { parseTypedDataMessage } from '../../../../../../../../shared/modules/transaction.utils'; -import { ConfirmInfoRow } from '../../../../../../../components/app/confirm/info/row'; -import { Box } from '../../../../../../../components/component-library'; -import { - Display, - FlexDirection, -} from '../../../../../../../helpers/constants/design-system'; -import { useI18nContext } from '../../../../../../../hooks/useI18nContext'; -import { useConfirmContext } from '../../../../../context/confirm'; -import { SignatureRequestType } from '../../../../../types/confirm'; -import StaticSimulation from '../../shared/static-simulation/static-simulation'; -import PermitSimulationValueDisplay from './value-display/value-display'; - -function extractTokenDetailsByPrimaryType( - message: Record, - primaryType: PrimaryType, -): object[] | unknown { - let tokenDetails; - - switch (primaryType) { - case PrimaryType.PermitBatch: - case PrimaryType.PermitSingle: - tokenDetails = message?.details; - break; - case PrimaryType.PermitBatchTransferFrom: - case PrimaryType.PermitTransferFrom: - tokenDetails = message?.permitted; - break; - default: - break; - } - - const isNonArrayObject = tokenDetails && !Array.isArray(tokenDetails); - return isNonArrayObject ? [tokenDetails] : tokenDetails; -} +import { SignatureRequestType } from '../../../../../types/confirm'; +import { useConfirmContext } from '../../../../../context/confirm'; +import { DefaultSimulation } from './default-simulation'; +import { DecodedSimulation } from './decoded-simulation'; const PermitSimulation: React.FC = () => { - const t = useI18nContext(); const { currentConfirmation } = useConfirmContext(); - const msgData = currentConfirmation.msgParams?.data; - const chainId = currentConfirmation.chainId as Hex; - const { - domain: { verifyingContract }, - message, - message: { tokenId }, - primaryType, - } = parseTypedDataMessage(msgData as string); - const isNFT = tokenId !== undefined; - - const tokenDetails = extractTokenDetailsByPrimaryType(message, primaryType); + const { decodingLoading, decodingData } = currentConfirmation; - const TokenDetail = ({ - token, - amount, - i, - }: { - token: Hex | string; - amount: number | string; - i: number; - }) => ( - - ); - - const SpendingCapRow = ( - - - {Array.isArray(tokenDetails) ? ( - - {tokenDetails.map( - ( - { token, amount }: { token: string; amount: string }, - i: number, - ) => ( - - ), - )} - - ) : ( - - )} - - - ); + if ( + decodingData?.error || + (decodingData === undefined && decodingLoading !== true) + ) { + return ; + } - return ( - - ); + return ; }; export default PermitSimulation; diff --git a/ui/pages/confirmations/types/confirm.ts b/ui/pages/confirmations/types/confirm.ts index b7c0c1160b3c..28960219ae3c 100644 --- a/ui/pages/confirmations/types/confirm.ts +++ b/ui/pages/confirmations/types/confirm.ts @@ -23,6 +23,15 @@ export type SecurityAlertResponse = { source?: SecurityAlertSource; }; +// todo: DecodingData to be imported from signature controller once its updated in extension +export type DecodingData = { + stateChanges: unknown[] | null; + error?: { + message: string; + type: string; + }; +}; + export type SignatureRequestType = { chainId?: string; id: string; @@ -38,6 +47,8 @@ export type SignatureRequestType = { type: TransactionType; custodyId?: string; securityAlertResponse?: SecurityAlertResponse; + decodingLoading?: boolean; + decodingData?: DecodingData; }; export type Confirmation = SignatureRequestType | TransactionMeta; From 45f64fe179b0185dba148e50f4cf685de651cb48 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Mon, 11 Nov 2024 12:06:54 +0530 Subject: [PATCH 12/31] update --- app/_locales/en/messages.json | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/app/_locales/en/messages.json b/app/_locales/en/messages.json index 34a45d238337..74e7d745cae7 100644 --- a/app/_locales/en/messages.json +++ b/app/_locales/en/messages.json @@ -4132,24 +4132,24 @@ "permissionsPageTourTitle": { "message": "Connected sites are now permissions" }, - "permitSimulationChange_transfer": { - "message": "You send" - }, - "permitSimulationChange_receive": { - "message": "You receive" - }, "permitSimulationChange_approve": { "message": "Spending cap" }, - "permitSimulationChange_revoke": { - "message": "Spending cap" - }, "permitSimulationChange_bidding": { "message": "You bid" }, "permitSimulationChange_listing": { "message": "You list" }, + "permitSimulationChange_receive": { + "message": "You receive" + }, + "permitSimulationChange_revoke": { + "message": "Spending cap" + }, + "permitSimulationChange_transfer": { + "message": "You send" + }, "permitSimulationDetailInfo": { "message": "You're giving the spender permission to spend this many tokens from your account." }, From b4347bf7423f9682375e53184e0bc3b63d75053c Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Mon, 11 Nov 2024 14:59:52 +0530 Subject: [PATCH 13/31] update --- .../permit-simulation/decoded-simulation/decoded-simulation.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx index 39cda822b94f..0f3e1a84e85b 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx @@ -74,7 +74,7 @@ const DecodedSimulation: React.FC = () => { const { decodingLoading, decodingData } = currentConfirmation; let stateChangeFragment: ReactNode[] = []; - if (decodingData && decodingData.stateChanges) { + if (decodingData?.stateChanges) { stateChangeFragment = decodingData.stateChanges.map( (change: DecodingDataStateChange) => ( From c9fed998dd2aaaac3234dd8a183bfa3e241efe68 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Mon, 11 Nov 2024 15:44:52 +0530 Subject: [PATCH 14/31] update --- .../decoded-simulation/decoded-simulation.test.tsx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx index 785d6ab72aaf..690cfb5b5195 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx @@ -1,16 +1,20 @@ import React from 'react'; import configureMockStore from 'redux-mock-store'; +import { + DecodingData, + DecodingDataChangeType, +} from '@metamask/signature-controller'; import { getMockTypedSignConfirmStateForRequest } from '../../../../../../../../../test/data/confirmations/helper'; import { renderWithConfirmContextProvider } from '../../../../../../../../../test/lib/confirmations/render-helpers'; import { permitSignatureMsg } from '../../../../../../../../../test/data/confirmations/typed_sign'; import PermitSimulation from './decoded-simulation'; -const decodingData = { +const decodingData: DecodingData = { stateChanges: [ { assetType: 'ERC20', - changeType: 'APPROVE', + changeType: DecodingDataChangeType.Approve, address: '0x3fc91a3afd70395cd496c647d5a6cc9d4b2b7fad', amount: '1461501637330902918203684832716283019655932542975', contractAddress: '0x6b175474e89094c44da98b954eedeac495271d0f', From 8671d56d0b40d853b20d5a55c59cf9a1d15e32fa Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Mon, 11 Nov 2024 16:33:24 +0530 Subject: [PATCH 15/31] update --- .../expandable-row.test.tsx.snap | 2 +- .../approve-details.test.tsx.snap | 4 ++-- .../approve-static-simulation.test.tsx.snap | 4 ++-- .../native-transfer.test.tsx.snap | 10 ++++----- .../nft-token-transfer.test.tsx.snap | 10 ++++----- ...al-for-all-static-simulation.test.tsx.snap | 6 +++--- ...al-for-all-static-simulation.test.tsx.snap | 4 ++-- .../gas-fees-details.test.tsx.snap | 4 ++-- .../__snapshots__/gas-fees-row.test.tsx.snap | 2 +- .../token-details-section.test.tsx.snap | 4 ++-- .../token-transfer.test.tsx.snap | 10 ++++----- .../permit-simulation.test.tsx.snap | 10 ++++----- .../decoded-simulation.test.tsx.snap | 21 +++++++++++++------ .../default-simulation.test.tsx.snap | 8 +++---- .../native-value-display.test.tsx | 6 +----- .../native-value-display.tsx | 4 ++-- 16 files changed, 57 insertions(+), 52 deletions(-) diff --git a/ui/components/app/confirm/info/row/__snapshots__/expandable-row.test.tsx.snap b/ui/components/app/confirm/info/row/__snapshots__/expandable-row.test.tsx.snap index c3958d886710..7251697c229e 100644 --- a/ui/components/app/confirm/info/row/__snapshots__/expandable-row.test.tsx.snap +++ b/ui/components/app/confirm/info/row/__snapshots__/expandable-row.test.tsx.snap @@ -3,7 +3,7 @@ exports[`ConfirmInfoExpandableRow should match snapshot 1`] = `
renders component for approve details 1`] = ` data-testid="advanced-details-data-section" >
renders component for approve details for setApprova data-testid="advanced-details-data-section" >
renders component 1`] = ` data-testid="confirmation__simulation_section" >
renders component 1`] = `
@@ -344,7 +344,7 @@ exports[`NativeTransferInfo renders correctly 1`] = `
diff --git a/ui/pages/confirmations/components/confirm/info/nft-token-transfer/__snapshots__/nft-token-transfer.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/nft-token-transfer/__snapshots__/nft-token-transfer.test.tsx.snap index 77794c9e70a4..fd8ba88384ae 100644 --- a/ui/pages/confirmations/components/confirm/info/nft-token-transfer/__snapshots__/nft-token-transfer.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/nft-token-transfer/__snapshots__/nft-token-transfer.test.tsx.snap @@ -71,7 +71,7 @@ exports[`NFTTokenTransferInfo renders correctly 1`] = ` class="mm-box mm-box--display-flex mm-box--flex-direction-row mm-box--justify-content-space-between mm-box--align-items-center" >
@@ -345,7 +345,7 @@ exports[`NFTTokenTransferInfo renders correctly 1`] = `
diff --git a/ui/pages/confirmations/components/confirm/info/set-approval-for-all-info/revoke-set-approval-for-all-static-simulation/__snapshots__/revoke-set-approval-for-all-static-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/set-approval-for-all-info/revoke-set-approval-for-all-static-simulation/__snapshots__/revoke-set-approval-for-all-static-simulation.test.tsx.snap index 8c94061320fe..abe3dca0bbc6 100644 --- a/ui/pages/confirmations/components/confirm/info/set-approval-for-all-info/revoke-set-approval-for-all-static-simulation/__snapshots__/revoke-set-approval-for-all-static-simulation.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/set-approval-for-all-info/revoke-set-approval-for-all-static-simulation/__snapshots__/revoke-set-approval-for-all-static-simulation.test.tsx.snap @@ -7,7 +7,7 @@ exports[` renders component for setAp data-testid="confirmation__simulation_section" >
renders component for setAp
renders component for setAp
renders component for approve req data-testid="confirmation__simulation_section" >
renders component for approve req
renders component for gas fees section 1`] = `
@@ -67,7 +67,7 @@ exports[` renders component for gas fees section 1`] = `
diff --git a/ui/pages/confirmations/components/confirm/info/shared/gas-fees-row/__snapshots__/gas-fees-row.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/shared/gas-fees-row/__snapshots__/gas-fees-row.test.tsx.snap index 5de2d2361b38..94432ffdf196 100644 --- a/ui/pages/confirmations/components/confirm/info/shared/gas-fees-row/__snapshots__/gas-fees-row.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/shared/gas-fees-row/__snapshots__/gas-fees-row.test.tsx.snap @@ -3,7 +3,7 @@ exports[` renders component 1`] = `
@@ -373,7 +373,7 @@ exports[`TokenTransferInfo renders correctly 1`] = `
diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap index 45eebc590b7b..cefcbf38fee9 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap @@ -7,7 +7,7 @@ exports[`PermitSimulation should not render default simulation if decodingLoadin data-testid="confirmation__simulation_section" >
-

- Spending cap -

+
+

+ Spending cap +

+
+
diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap index a378d0befcc4..cc9133561314 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap @@ -7,7 +7,7 @@ exports[`DefaultSimulation renders component correctly 1`] = ` data-testid="confirmation__simulation_section" >
{ it('renders component correctly', async () => { const mockStore = configureMockStore([])(mockState); const { container, findByText } = renderWithProvider( - , + , mockStore, ); diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.tsx index 141fb3e9a6df..5faaaeb0e6c1 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.tsx @@ -1,4 +1,4 @@ -import BigNumber from 'bignumber.js'; +import { BigNumber } from 'bignumber.js'; import { Hex } from '@metamask/utils'; import React, { useMemo } from 'react'; import { useSelector } from 'react-redux'; @@ -67,7 +67,7 @@ const NativeValueDisplay: React.FC = ({ }; }, [nativeFiatRate, value]); - const { color, backgroundColor} = getAmountColors(credit, debit); + const { color, backgroundColor } = getAmountColors(credit, debit); return ( From 82f42b0cf8083b0b2d775aedf4c986298cae5d4b Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Mon, 11 Nov 2024 17:41:47 +0530 Subject: [PATCH 16/31] update --- .../info/row/__snapshots__/row.test.tsx.snap | 4 +- .../__snapshots__/alert-row.test.tsx.snap | 2 +- .../info/__snapshots__/info.test.tsx.snap | 62 +++++----- .../__snapshots__/approve.test.tsx.snap | 30 ++--- .../__snapshots__/spending-cap.test.tsx.snap | 4 +- .../base-transaction-info.test.tsx.snap | 10 +- .../__snapshots__/personal-sign.test.tsx.snap | 4 +- .../set-approval-for-all-info.test.tsx.snap | 10 +- .../advanced-details.test.tsx.snap | 8 +- .../edit-gas-fees-row.test.tsx.snap | 2 +- .../gas-fees-section.test.tsx.snap | 4 +- .../transaction-data.test.tsx.snap | 96 ++++++++-------- .../transaction-details.test.tsx.snap | 4 +- .../__snapshots__/typed-sign-v1.test.tsx.snap | 6 +- .../__snapshots__/typed-sign.test.tsx.snap | 108 +++++++++--------- .../row/__snapshots__/dataTree.test.tsx.snap | 56 ++++----- .../typedSignDataV1.test.tsx.snap | 4 +- .../__snapshots__/typedSignData.test.tsx.snap | 30 ++--- .../__snapshots__/confirm.test.tsx.snap | 94 +++++++-------- 19 files changed, 269 insertions(+), 269 deletions(-) diff --git a/ui/components/app/confirm/info/row/__snapshots__/row.test.tsx.snap b/ui/components/app/confirm/info/row/__snapshots__/row.test.tsx.snap index 7dad4ee50357..a6a52806b2cf 100644 --- a/ui/components/app/confirm/info/row/__snapshots__/row.test.tsx.snap +++ b/ui/components/app/confirm/info/row/__snapshots__/row.test.tsx.snap @@ -3,7 +3,7 @@ exports[`ConfirmInfoRow should match snapshot 1`] = `
@@ -707,7 +707,7 @@ exports[` renders component for approve request 1`] = ` class="mm-box mm-box--padding-left-2" >
@@ -799,7 +799,7 @@ exports[` renders component for approve request 1`] = `
diff --git a/ui/pages/confirmations/components/confirm/info/approve/spending-cap/__snapshots__/spending-cap.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/approve/spending-cap/__snapshots__/spending-cap.test.tsx.snap index 3579fe496673..9fca2dce8f70 100644 --- a/ui/pages/confirmations/components/confirm/info/approve/spending-cap/__snapshots__/spending-cap.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/approve/spending-cap/__snapshots__/spending-cap.test.tsx.snap @@ -7,7 +7,7 @@ exports[` renders component 1`] = ` data-testid="confirmation__approve-spending-cap-section" >
renders component 1`] = ` style="height: 1px; margin-left: -8px; margin-right: -8px;" />
diff --git a/ui/pages/confirmations/components/confirm/info/base-transaction-info/__snapshots__/base-transaction-info.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/base-transaction-info/__snapshots__/base-transaction-info.test.tsx.snap index 47d28a0ba29d..d7054050f710 100644 --- a/ui/pages/confirmations/components/confirm/info/base-transaction-info/__snapshots__/base-transaction-info.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/base-transaction-info/__snapshots__/base-transaction-info.test.tsx.snap @@ -15,7 +15,7 @@ exports[` renders component for contract interaction requ class="mm-box mm-box--display-flex mm-box--flex-direction-row mm-box--justify-content-space-between mm-box--align-items-center" >
renders component for contract interaction requ data-testid="transaction-details-section" >
@@ -142,7 +142,7 @@ exports[` renders component for contract interaction requ
@@ -239,7 +239,7 @@ exports[` renders component for contract interaction requ data-testid="gas-fee-section" >
@@ -303,7 +303,7 @@ exports[` renders component for contract interaction requ
diff --git a/ui/pages/confirmations/components/confirm/info/personal-sign/__snapshots__/personal-sign.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/personal-sign/__snapshots__/personal-sign.test.tsx.snap index 92ac3628363e..8932bc3bb41d 100644 --- a/ui/pages/confirmations/components/confirm/info/personal-sign/__snapshots__/personal-sign.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/personal-sign/__snapshots__/personal-sign.test.tsx.snap @@ -6,7 +6,7 @@ exports[`PersonalSignInfo handle reverse string properly 1`] = ` class="mm-box mm-box--margin-bottom-4 mm-box--padding-2 mm-box--background-color-background-default mm-box--rounded-md" >
renders component for approve request 1`] = ` data-testid="confirmation__simulation_section" >
renders component for approve request 1`] = `
renders component for approve request 1`] = ` data-testid="confirmation__approve-details" >
@@ -160,7 +160,7 @@ exports[` renders component for approve request 1`] = ` data-testid="gas-fee-section" >
@@ -224,7 +224,7 @@ exports[` renders component for approve request 1`] = `
diff --git a/ui/pages/confirmations/components/confirm/info/shared/advanced-details/__snapshots__/advanced-details.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/shared/advanced-details/__snapshots__/advanced-details.test.tsx.snap index 3a93bae1e26d..0be66fa4d7ba 100644 --- a/ui/pages/confirmations/components/confirm/info/shared/advanced-details/__snapshots__/advanced-details.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/shared/advanced-details/__snapshots__/advanced-details.test.tsx.snap @@ -9,7 +9,7 @@ exports[` renders component when the prop override is passed data-testid="advanced-details-nonce-section" >
renders component when the prop override is passed data-testid="advanced-details-data-section" >
renders component when the state property is true 1 data-testid="advanced-details-nonce-section" >
renders component when the state property is true 1 data-testid="advanced-details-data-section" >
renders component 1`] = `
diff --git a/ui/pages/confirmations/components/confirm/info/shared/gas-fees-section/__snapshots__/gas-fees-section.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/shared/gas-fees-section/__snapshots__/gas-fees-section.test.tsx.snap index 5901dd2e8f2d..9300030d9b85 100644 --- a/ui/pages/confirmations/components/confirm/info/shared/gas-fees-section/__snapshots__/gas-fees-section.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/shared/gas-fees-section/__snapshots__/gas-fees-section.test.tsx.snap @@ -9,7 +9,7 @@ exports[` renders component for gas fees section 1`] = ` data-testid="gas-fee-section" >
@@ -73,7 +73,7 @@ exports[` renders component for gas fees section 1`] = `
diff --git a/ui/pages/confirmations/components/confirm/info/shared/transaction-data/__snapshots__/transaction-data.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/shared/transaction-data/__snapshots__/transaction-data.test.tsx.snap index 1b7fd2aeb460..5f76378d010f 100644 --- a/ui/pages/confirmations/components/confirm/info/shared/transaction-data/__snapshots__/transaction-data.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/shared/transaction-data/__snapshots__/transaction-data.test.tsx.snap @@ -7,7 +7,7 @@ exports[`TransactionData renders decoded data with names and descriptions 1`] = data-testid="advanced-details-data-section" >
@@ -146,7 +146,7 @@ exports[`TransactionData renders decoded data with names and descriptions 1`] =
@@ -197,7 +197,7 @@ exports[`TransactionData renders decoded data with names and descriptions 1`] = style="height: 1px; margin-left: -8px; margin-right: -8px;" />
@@ -305,7 +305,7 @@ exports[`TransactionData renders decoded data with names and descriptions 1`] =
@@ -350,7 +350,7 @@ exports[`TransactionData renders decoded data with names and descriptions 1`] =
@@ -395,7 +395,7 @@ exports[`TransactionData renders decoded data with names and descriptions 1`] =
@@ -517,7 +517,7 @@ exports[`TransactionData renders decoded data with names and descriptions 1`] =
@@ -568,7 +568,7 @@ exports[`TransactionData renders decoded data with names and descriptions 1`] = style="height: 1px; margin-left: -8px; margin-right: -8px;" />
@@ -676,7 +676,7 @@ exports[`TransactionData renders decoded data with names and descriptions 1`] =
@@ -732,7 +732,7 @@ exports[`TransactionData renders decoded data with names and descriptions 1`] =
@@ -783,7 +783,7 @@ exports[`TransactionData renders decoded data with names and descriptions 1`] = style="height: 1px; margin-left: -8px; margin-right: -8px;" />
@@ -891,7 +891,7 @@ exports[`TransactionData renders decoded data with names and descriptions 1`] =
@@ -947,7 +947,7 @@ exports[`TransactionData renders decoded data with names and descriptions 1`] =
@@ -1005,7 +1005,7 @@ exports[`TransactionData renders decoded data with no names 1`] = ` data-testid="advanced-details-data-section" >
@@ -1068,7 +1068,7 @@ exports[`TransactionData renders decoded data with no names 1`] = ` class="mm-box mm-box--padding-left-2" >
@@ -1113,7 +1113,7 @@ exports[`TransactionData renders decoded data with no names 1`] = `
@@ -1169,7 +1169,7 @@ exports[`TransactionData renders decoded data with no names 1`] = `
@@ -1225,7 +1225,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = ` data-testid="advanced-details-data-section" >
@@ -1304,7 +1304,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = ` class="mm-box mm-box--padding-left-2" >
@@ -1360,7 +1360,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -1398,7 +1398,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = ` class="mm-box mm-box--padding-left-2" >
@@ -1436,7 +1436,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = ` class="mm-box mm-box--padding-left-2" >
@@ -1474,7 +1474,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = ` class="mm-box mm-box--padding-left-2" >
@@ -1530,7 +1530,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -1575,7 +1575,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -1620,7 +1620,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -1666,7 +1666,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -1704,7 +1704,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = ` class="mm-box mm-box--padding-left-2" >
@@ -1760,7 +1760,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -1805,7 +1805,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -1850,7 +1850,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -1896,7 +1896,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -1934,7 +1934,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = ` class="mm-box mm-box--padding-left-2" >
@@ -1990,7 +1990,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -2035,7 +2035,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -2080,7 +2080,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -2127,7 +2127,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -2183,7 +2183,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -2229,7 +2229,7 @@ exports[`TransactionData renders decoded data with tuples and arrays 1`] = `
@@ -2287,7 +2287,7 @@ exports[`TransactionData renders raw hexadecimal if no decoded data 1`] = ` data-testid="advanced-details-data-section" >
renders component for transaction details 1`] = data-testid="transaction-details-section" >
@@ -60,7 +60,7 @@ exports[` renders component for transaction details 1`] =
diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign-v1/__snapshots__/typed-sign-v1.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign-v1/__snapshots__/typed-sign-v1.test.tsx.snap index d4b07b83a269..e80d317f574b 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign-v1/__snapshots__/typed-sign-v1.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/typed-sign-v1/__snapshots__/typed-sign-v1.test.tsx.snap @@ -6,7 +6,7 @@ exports[`TypedSignInfo correctly renders typed sign data request 1`] = ` class="mm-box mm-box--margin-bottom-4 mm-box--padding-2 mm-box--background-color-background-default mm-box--rounded-md" >
Date: Mon, 11 Nov 2024 18:15:35 +0530 Subject: [PATCH 17/31] update --- .../native-value-display/native-value-display.tsx | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.tsx index 5faaaeb0e6c1..5aaac3d3482a 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/native-value-display.tsx @@ -17,8 +17,8 @@ import { TextAlign, } from '../../../../../../../../helpers/constants/design-system'; import Tooltip from '../../../../../../../../components/ui/tooltip'; -import { getConversionRate } from '../../../../../../../../ducks/metamask/metamask'; import { shortenString } from '../../../../../../../../helpers/utils/util'; +import { selectConversionRateByChainId } from '../../../../../../../../selectors'; import { AssetPill } from '../../../../../simulation-details/asset-pill'; import { formatAmount, @@ -49,7 +49,9 @@ const NativeValueDisplay: React.FC = ({ credit, debit, }) => { - const nativeFiatRate = useSelector(getConversionRate); + const conversionRate = useSelector((state) => + selectConversionRateByChainId(state, chainId), + ); const { fiatValue, tokenValue, tokenValueMaxPrecision } = useMemo(() => { if (!value) { @@ -59,13 +61,13 @@ const NativeValueDisplay: React.FC = ({ const tokenAmount = calcTokenAmount(value, NATIVE_DECIMALS); return { - fiatValue: nativeFiatRate - ? new BigNumber(tokenAmount).times(String(nativeFiatRate)).toNumber() + fiatValue: conversionRate + ? new BigNumber(tokenAmount).times(String(conversionRate)).toNumber() : undefined, tokenValue: formatAmount('en-US', tokenAmount), tokenValueMaxPrecision: formatAmountMaxPrecision('en-US', tokenAmount), }; - }, [nativeFiatRate, value]); + }, [conversionRate, value]); const { color, backgroundColor } = getAmountColors(credit, debit); From 8de0e98ea60cead7f055541311d10de2b37acd5d Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Mon, 11 Nov 2024 18:24:28 +0530 Subject: [PATCH 18/31] update --- .../permit-simulation/decoded-simulation/decoded-simulation.tsx | 1 - 1 file changed, 1 deletion(-) diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx index 0684235999c6..283dea0b4beb 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx @@ -67,7 +67,6 @@ const DecodedSimulation: React.FC = () => { const { currentConfirmation } = useConfirmContext(); const chainId = currentConfirmation.chainId as Hex; const { decodingLoading, decodingData } = currentConfirmation; - console.log('decodingData = ', decodingData); let stateChangeFragment: ReactNode[] = []; if (decodingData?.stateChanges) { From 41004316767caf6bb87083c595f3c344ebc0f759 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Wed, 13 Nov 2024 10:45:31 +0530 Subject: [PATCH 19/31] Adding tooltip to signature decoding state changes --- app/_locales/en/messages.json | 6 ++ .../decoded-simulation.test.tsx | 59 ++++++++++++++++++- .../decoded-simulation/decoded-simulation.tsx | 42 ++++++++++++- 3 files changed, 104 insertions(+), 3 deletions(-) diff --git a/app/_locales/en/messages.json b/app/_locales/en/messages.json index 74e7d745cae7..ce86a22d105e 100644 --- a/app/_locales/en/messages.json +++ b/app/_locales/en/messages.json @@ -5032,6 +5032,12 @@ "simulationDetailsTitleTooltip": { "message": "Estimated changes are what might happen if you go through with this transaction. This is just a prediction, not a guarantee." }, + "signature_decoding_list_nft_tooltip": { + "message": "Expect changes only if someone buys your NFTs." + }, + "signature_decoding_bid_nft_tooltip": { + "message": "The NFT will be reflected in your wallet, when the bid is accepted." + }, "simulationDetailsTotalFiat": { "message": "Total = $1", "description": "$1 is the total amount in fiat currency on one side of the transaction" diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx index 690cfb5b5195..86f30472b0e5 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.test.tsx @@ -3,12 +3,13 @@ import configureMockStore from 'redux-mock-store'; import { DecodingData, DecodingDataChangeType, + DecodingDataStateChanges, } from '@metamask/signature-controller'; import { getMockTypedSignConfirmStateForRequest } from '../../../../../../../../../test/data/confirmations/helper'; import { renderWithConfirmContextProvider } from '../../../../../../../../../test/lib/confirmations/render-helpers'; import { permitSignatureMsg } from '../../../../../../../../../test/data/confirmations/typed_sign'; -import PermitSimulation from './decoded-simulation'; +import PermitSimulation, { getStateChangeToolip } from './decoded-simulation'; const decodingData: DecodingData = { stateChanges: [ @@ -22,6 +23,42 @@ const decodingData: DecodingData = { ], }; +const decodingDataListing: DecodingDataStateChanges = [ + { + assetType: 'NATIVE', + changeType: DecodingDataChangeType.Receive, + address: '', + amount: '900000000000000000', + contractAddress: '', + }, + { + assetType: 'ERC721', + changeType: DecodingDataChangeType.Listing, + address: '', + amount: '', + contractAddress: '0xafd4896984CA60d2feF66136e57f958dCe9482d5', + tokenID: '2101', + }, +]; + +const decodingDataBidding: DecodingDataStateChanges = [ + { + assetType: 'ERC721', + changeType: DecodingDataChangeType.Receive, + address: '', + amount: '900000000000000000', + contractAddress: '', + }, + { + assetType: 'Native', + changeType: DecodingDataChangeType.Bidding, + address: '', + amount: '', + contractAddress: '0xafd4896984CA60d2feF66136e57f958dCe9482d5', + tokenID: '2101', + }, +]; + describe('DecodedSimulation', () => { it('renders component correctly', async () => { const state = getMockTypedSignConfirmStateForRequest({ @@ -38,4 +75,24 @@ describe('DecodedSimulation', () => { expect(container).toMatchSnapshot(); }); + + describe('getStateChangeToolip', () => { + it('return correct tooltip when permit is for listing NFT', async () => { + const tooltip = getStateChangeToolip( + decodingDataListing, + decodingDataListing?.[0], + (str: string) => str, + ); + expect(tooltip).toBe('signature_decoding_list_nft_tooltip'); + }); + }); + + it('return correct tooltip when permit is for bidding NFT', async () => { + const tooltip = getStateChangeToolip( + decodingDataBidding, + decodingDataBidding?.[0], + (str: string) => str, + ); + expect(tooltip).toBe('signature_decoding_bid_nft_tooltip'); + }); }); diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx index 283dea0b4beb..510ccb71f95c 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx @@ -2,6 +2,7 @@ import React, { ReactNode } from 'react'; import { DecodingDataChangeType, DecodingDataStateChange, + DecodingDataStateChanges, } from '@metamask/signature-controller'; import { Hex } from '@metamask/utils'; @@ -14,6 +15,33 @@ import TokenValueDisplay from '../value-display/value-display'; import NativeValueDisplay from '../native-value-display/native-value-display'; import { ConfirmInfoRow } from '../../../../../../../../components/app/confirm/info/row'; +export const getStateChangeToolip = ( + stateChangeList: DecodingDataStateChanges | null, + stateChange: DecodingDataStateChange, + t: ReturnType, +): string | undefined => { + if (stateChange.changeType === DecodingDataChangeType.Receive) { + if ( + stateChangeList?.some( + (change) => + change.changeType === DecodingDataChangeType.Listing && + change.assetType === TokenStandard.ERC721, + ) + ) { + return t('signature_decoding_list_nft_tooltip'); + } + if ( + stateChange.assetType === TokenStandard.ERC721 && + stateChangeList?.some( + (change) => change.changeType === DecodingDataChangeType.Bidding, + ) + ) { + return t('signature_decoding_bid_nft_tooltip'); + } + } + return undefined; +}; + const getStateChangeLabelMap = ( t: ReturnType, changeType: string, @@ -28,17 +56,23 @@ const getStateChangeLabelMap = ( }[changeType]); const StateChangeRow = ({ + stateChangeList, stateChange, chainId, }: { + stateChangeList: DecodingDataStateChanges | null; stateChange: DecodingDataStateChange; chainId: Hex; }) => { const t = useI18nContext(); const { assetType, changeType, amount, contractAddress, tokenID } = stateChange; + const tooltip = getStateChangeToolip(stateChangeList, stateChange, t); return ( - + {(assetType === TokenStandard.ERC20 || assetType === TokenStandard.ERC721) && ( = () => { if (decodingData?.stateChanges) { stateChangeFragment = decodingData.stateChanges.map( (change: DecodingDataStateChange) => ( - + ), ); } From a54859d71cd0da4f9755b85b4362e05f9c38ad7f Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Wed, 13 Nov 2024 10:57:06 +0530 Subject: [PATCH 20/31] Adding tooltip to signature decoding state changes --- app/_locales/en/messages.json | 12 +++++----- .../decoded-simulation/decoded-simulation.tsx | 23 ++++++++++++++++++- 2 files changed, 28 insertions(+), 7 deletions(-) diff --git a/app/_locales/en/messages.json b/app/_locales/en/messages.json index ce86a22d105e..123022ad025f 100644 --- a/app/_locales/en/messages.json +++ b/app/_locales/en/messages.json @@ -4987,6 +4987,12 @@ "signatureRequestGuidance": { "message": "Only sign this message if you fully understand the content and trust the requesting site." }, + "signature_decoding_bid_nft_tooltip": { + "message": "The NFT will be reflected in your wallet, when the bid is accepted." + }, + "signature_decoding_list_nft_tooltip": { + "message": "Expect changes only if someone buys your NFTs." + }, "signed": { "message": "Signed" }, @@ -5032,12 +5038,6 @@ "simulationDetailsTitleTooltip": { "message": "Estimated changes are what might happen if you go through with this transaction. This is just a prediction, not a guarantee." }, - "signature_decoding_list_nft_tooltip": { - "message": "Expect changes only if someone buys your NFTs." - }, - "signature_decoding_bid_nft_tooltip": { - "message": "The NFT will be reflected in your wallet, when the bid is accepted." - }, "simulationDetailsTotalFiat": { "message": "Total = $1", "description": "$1 is the total amount in fiat currency on one side of the transaction" diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx index 510ccb71f95c..89be061dbea9 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx @@ -15,6 +15,26 @@ import TokenValueDisplay from '../value-display/value-display'; import NativeValueDisplay from '../native-value-display/native-value-display'; import { ConfirmInfoRow } from '../../../../../../../../components/app/confirm/info/row'; +const decodingData = { + "stateChanges": [ + { + "assetType": "NATIVE", + "changeType": "RECEIVE", + "address": "", + "amount": "900000000000000000", + "contractAddress": "" + }, + { + "assetType": "ERC721", + "changeType": "LISTING", + "address": "", + "amount": "", + "contractAddress": "0xafd4896984CA60d2feF66136e57f958dCe9482d5", + "tokenID": "2101" + } + ] +}; + export const getStateChangeToolip = ( stateChangeList: DecodingDataStateChanges | null, stateChange: DecodingDataStateChange, @@ -100,7 +120,8 @@ const DecodedSimulation: React.FC = () => { const t = useI18nContext(); const { currentConfirmation } = useConfirmContext(); const chainId = currentConfirmation.chainId as Hex; - const { decodingLoading, decodingData } = currentConfirmation; + const { decodingLoading } = currentConfirmation; + // const { decodingLoading, decodingData } = currentConfirmation; let stateChangeFragment: ReactNode[] = []; if (decodingData?.stateChanges) { From 4600859266de614b8e9cf622a028cd14789a89b0 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Wed, 13 Nov 2024 11:09:05 +0530 Subject: [PATCH 21/31] Adding tooltip to signature decoding state changes --- .../decoded-simulation.test.tsx.snap | 91 +++++++++++++++++-- 1 file changed, 85 insertions(+), 6 deletions(-) diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap index 906bc817ae09..3a505f0322f0 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap @@ -52,8 +52,23 @@ exports[`DecodedSimulation renders component correctly 1`] = `

- Spending cap + You receive

+
+
+ +
+

- 1,461,501,637,3... + + + 0.9

+
+
+
+ E +
+

+ ETH +

+
+
+ +
+
+ +
+
+
+

+ You list +

+
+
+
+
+
+
+

+ #2101 +

+
+
@@ -99,7 +178,7 @@ exports[`DecodedSimulation renders component correctly 1`] = `

- 0x6B175...71d0F + 0xafd48...482d5

From bb6d9dea2f304747c063fb05c3f6944997a6e904 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Wed, 13 Nov 2024 15:51:46 +0530 Subject: [PATCH 22/31] update --- .../info/typed-sign/permit-simulation/permit-simulation.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.tsx index 0b4d9eed22d4..86055425fa46 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/permit-simulation.tsx @@ -11,7 +11,7 @@ const PermitSimulation: React.FC = () => { if ( decodingData?.error || - (decodingData === undefined && decodingLoading !== true) + (decodingData?.stateChanges === undefined && decodingLoading !== true) ) { return ; } From 0a87bf1df511b8f8196ea7ea8a62338bbda7be73 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Sat, 16 Nov 2024 16:25:22 +0530 Subject: [PATCH 23/31] update --- ui/components/app/confirm/info/row/row.tsx | 2 +- .../__snapshots__/permit-simulation.test.tsx.snap | 12 +++++++----- .../__snapshots__/decoded-simulation.test.tsx.snap | 5 +++-- .../__snapshots__/native-value-display.test.tsx.snap | 1 + .../native-value-display/native-value-display.tsx | 2 +- .../__snapshots__/value-display.test.tsx.snap | 1 + .../value-display/value-display.tsx | 2 +- 7 files changed, 15 insertions(+), 10 deletions(-) diff --git a/ui/components/app/confirm/info/row/row.tsx b/ui/components/app/confirm/info/row/row.tsx index b628e2256575..63d2242461ea 100644 --- a/ui/components/app/confirm/info/row/row.tsx +++ b/ui/components/app/confirm/info/row/row.tsx @@ -99,7 +99,7 @@ export const ConfirmInfoRow: React.FC = ({ flexDirection={isCollapsible ? FlexDirection.Column : FlexDirection.Row} justifyContent={JustifyContent.spaceBetween} flexWrap={FlexWrap.Wrap} - alignItems={AlignItems.flexStart} + alignItems={isCollapsible ? AlignItems.flexStart : AlignItems.center} backgroundColor={BACKGROUND_COLORS[variant]} borderRadius={BorderRadius.LG} marginTop={2} diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap index cefcbf38fee9..7df5c808ab4c 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap @@ -7,7 +7,7 @@ exports[`PermitSimulation should not render default simulation if decodingLoadin data-testid="confirmation__simulation_section" >
= ({ const { color, backgroundColor } = getAmountColors(credit, debit); return ( - +
+ Date: Sat, 16 Nov 2024 16:42:30 +0530 Subject: [PATCH 24/31] update --- ui/components/app/confirm/info/row/row.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ui/components/app/confirm/info/row/row.tsx b/ui/components/app/confirm/info/row/row.tsx index 63d2242461ea..b628e2256575 100644 --- a/ui/components/app/confirm/info/row/row.tsx +++ b/ui/components/app/confirm/info/row/row.tsx @@ -99,7 +99,7 @@ export const ConfirmInfoRow: React.FC = ({ flexDirection={isCollapsible ? FlexDirection.Column : FlexDirection.Row} justifyContent={JustifyContent.spaceBetween} flexWrap={FlexWrap.Wrap} - alignItems={isCollapsible ? AlignItems.flexStart : AlignItems.center} + alignItems={AlignItems.flexStart} backgroundColor={BACKGROUND_COLORS[variant]} borderRadius={BorderRadius.LG} marginTop={2} From ed4aba6bb7f3b6c2a29f65fbcf731cfcf9579aee Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Sat, 16 Nov 2024 17:21:12 +0530 Subject: [PATCH 25/31] update --- .../typed-sign/__snapshots__/typed-sign.test.tsx.snap | 2 ++ .../__snapshots__/permit-simulation.test.tsx.snap | 10 +++++----- .../__snapshots__/decoded-simulation.test.tsx.snap | 4 ++-- .../__snapshots__/default-simulation.test.tsx.snap | 2 ++ .../confirm/__snapshots__/confirm.test.tsx.snap | 4 ++++ 5 files changed, 15 insertions(+), 7 deletions(-) diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/__snapshots__/typed-sign.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/__snapshots__/typed-sign.test.tsx.snap index 148f9a98ab0f..bd079c965a7e 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/__snapshots__/typed-sign.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/__snapshots__/typed-sign.test.tsx.snap @@ -72,6 +72,7 @@ exports[`TypedSignInfo correctly renders permit sign type 1`] = ` >
Date: Sat, 16 Nov 2024 19:21:20 +0530 Subject: [PATCH 26/31] update --- .../decoded-simulation/decoded-simulation.tsx | 23 +------------------ 1 file changed, 1 insertion(+), 22 deletions(-) diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx index 89be061dbea9..510ccb71f95c 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx @@ -15,26 +15,6 @@ import TokenValueDisplay from '../value-display/value-display'; import NativeValueDisplay from '../native-value-display/native-value-display'; import { ConfirmInfoRow } from '../../../../../../../../components/app/confirm/info/row'; -const decodingData = { - "stateChanges": [ - { - "assetType": "NATIVE", - "changeType": "RECEIVE", - "address": "", - "amount": "900000000000000000", - "contractAddress": "" - }, - { - "assetType": "ERC721", - "changeType": "LISTING", - "address": "", - "amount": "", - "contractAddress": "0xafd4896984CA60d2feF66136e57f958dCe9482d5", - "tokenID": "2101" - } - ] -}; - export const getStateChangeToolip = ( stateChangeList: DecodingDataStateChanges | null, stateChange: DecodingDataStateChange, @@ -120,8 +100,7 @@ const DecodedSimulation: React.FC = () => { const t = useI18nContext(); const { currentConfirmation } = useConfirmContext(); const chainId = currentConfirmation.chainId as Hex; - const { decodingLoading } = currentConfirmation; - // const { decodingLoading, decodingData } = currentConfirmation; + const { decodingLoading, decodingData } = currentConfirmation; let stateChangeFragment: ReactNode[] = []; if (decodingData?.stateChanges) { From 6debf04d714ae8d47cdecd1d48f60f6996cef6a4 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Sat, 16 Nov 2024 19:48:55 +0530 Subject: [PATCH 27/31] update --- .../decoded-simulation.test.tsx.snap | 91 ++----------------- 1 file changed, 6 insertions(+), 85 deletions(-) diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap index 7801da02a856..608e4fa4d889 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap @@ -52,23 +52,8 @@ exports[`DecodedSimulation renders component correctly 1`] = `

- You receive + Spending cap

-
-
- -
-

- + - 0.9 + 1,461,501,637,3...

-
-
-
- E -
-

- ETH -

-
-
- -
-
- -
-
-
-

- You list -

-
-
-
-
-
-
-

- #2101 -

-
-
@@ -179,7 +100,7 @@ exports[`DecodedSimulation renders component correctly 1`] = `

- 0xafd48...482d5 + 0x6B175...71d0F

From dda245a8e2e03b75f2ef4e7d8580e36cfde19d34 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Fri, 22 Nov 2024 17:07:57 +0530 Subject: [PATCH 28/31] update --- .../native-value-display.test.tsx.snap | 67 ------------------- 1 file changed, 67 deletions(-) delete mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/__snapshots__/native-value-display.test.tsx.snap diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/__snapshots__/native-value-display.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/__snapshots__/native-value-display.test.tsx.snap deleted file mode 100644 index 815265757269..000000000000 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/native-value-display/__snapshots__/native-value-display.test.tsx.snap +++ /dev/null @@ -1,67 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`NativeValueDisplay renders component correctly 1`] = ` -
-
-
-
-
-
-

- <0.000001 -

-
-
-
-
-
-
- ETH logo -
-

- ETH -

-
-
-
-
-
-
-`; From cc65aee9f1a11d53dbb6a822a35cb7e8ea3ffe04 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Fri, 22 Nov 2024 17:32:40 +0530 Subject: [PATCH 29/31] update --- .../__snapshots__/typed-sign.test.tsx.snap | 2941 ------------- .../permit-simulation.test.tsx.snap | 345 -- .../decoded-simulation.test.tsx.snap | 115 - .../decoded-simulation/decoded-simulation.tsx | 2 +- .../default-simulation.test.tsx.snap | 248 -- .../__snapshots__/value-display.test.tsx.snap | 59 - .../value-display/value-display.tsx | 2 +- .../__snapshots__/confirm.test.tsx.snap | 3735 ----------------- 8 files changed, 2 insertions(+), 7445 deletions(-) delete mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/__snapshots__/typed-sign.test.tsx.snap delete mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap delete mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap delete mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap delete mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/__snapshots__/value-display.test.tsx.snap delete mode 100644 ui/pages/confirmations/confirm/__snapshots__/confirm.test.tsx.snap diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/__snapshots__/typed-sign.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/__snapshots__/typed-sign.test.tsx.snap deleted file mode 100644 index bd079c965a7e..000000000000 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/__snapshots__/typed-sign.test.tsx.snap +++ /dev/null @@ -1,2941 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`TypedSignInfo correctly renders permit sign type 1`] = ` -
-
-
-
-
-

- Estimated changes -

-
-
- -
-
-
-
-
-

- You're giving the spender permission to spend this many tokens from your account. -

-
-
-
-
-
-

- Spending cap -

-
-
-
-
-
-
-
-
-

- 3,000 -

-
-
-
-
-
- -

- 0xCcCCc...ccccC -

-
-
-
-
-
-
-
-
-
-
-
-
-

- Spender -

-
-
-
-
- -

- 0x5B38D...eddC4 -

-
-
-
-
-
-
-
-

- Request from -

-
-
- -
-
-
-
-
-

- metamask.github.io -

-
-
-
-
-
-

- Interacting with -

-
-
-
-
- -

- 0xCcCCc...ccccC -

-
-
-
-
-
-
- - -
-
-

- Message -

-
-
-
-
-
-`; - -exports[`TypedSignInfo correctly renders permit sign type with no deadline 1`] = ` -
-
-
-
-
-

- Estimated changes -

-
-
- -
-
-
-
-
-

- You're giving the spender permission to spend this many tokens from your account. -

-
-
-
-
-
-

- Spending cap -

-
-
-
-
-
-
-
-
-

- 3,000 -

-
-
-
-
-
- -

- 0xCcCCc...ccccC -

-
-
-
-
-
-
-
-
-
-
-
-
-

- Spender -

-
-
-
-
- -

- 0x5B38D...eddC4 -

-
-
-
-
-
-
-
-

- Request from -

-
-
- -
-
-
-
-
-

- metamask.github.io -

-
-
-
-
-
-

- Interacting with -

-
-
-
-
- -

- 0xCcCCc...ccccC -

-
-
-
-
-
-
- - -
-
-

- Message -

-
-
-
-
-
-`; - -exports[`TypedSignInfo does not render if required data is not present in the transaction 1`] = `
`; - -exports[`TypedSignInfo renders origin for typed sign data request 1`] = ` -
-
-
-
-
-

- Request from -

-
-
- -
-
-
-
-
-

- metamask.github.io -

-
-
-
-
-
-

- Interacting with -

-
-
-
-
- -

- 0xCcCCc...ccccC -

-
-
-
-
-
-
- - -
-
-

- Message -

-
-
-
-
-
-
-

- Primary type: -

-
-
-
-

- Mail -

-
-
-
-
-
-
-
-

- Contents: -

-
-
-
-

- Hello, Bob! -

-
-
-
-
-
-

- From: -

-
-
-
-
-
-
-

- Name: -

-
-
-
-

- Cow -

-
-
-
-
-
-

- Wallets: -

-
-
-
-
-
-
-

- 0: -

-
-
-
-
- -

- 0xCD2a3...DD826 -

-
-
-
-
-
-
-

- 1: -

-
-
-
-
- -

- 0xDeaDb...DbeeF -

-
-
-
-
-
-
-

- 2: -

-
-
-
-
- -

- 0x06195...43896 -

-
-
-
-
-
-
-
-
-
-
-

- To: -

-
-
-
-
-
-
-

- 0: -

-
-
-
-
-
-
-

- Name: -

-
-
-
-

- Bob -

-
-
-
-
-
-

- Wallets: -

-
-
-
-
-
-
-

- 0: -

-
-
-
-
- -

- 0xbBbBB...bBBbB -

-
-
-
-
-
-
-

- 1: -

-
-
-
-
- -

- 0xB0Bda...bEa57 -

-
-
-
-
-
-
-

- 2: -

-
-
-
-
- -

- 0xB0B0b...00000 -

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-`; - -exports[`TypedSignInfo should render message for typed sign v3 request 1`] = ` -
-
-
-
-
-

- Request from -

-
-
- -
-
-
-
-
-

- metamask.github.io -

-
-
-
-
-
-

- Interacting with -

-
-
-
-
- -

- 0xCcCCc...ccccC -

-
-
-
-
-
-
- - -
-
-

- Message -

-
-
-
-
-
-
-

- Primary type: -

-
-
-
-

- Mail -

-
-
-
-
-
-
-
-

- From: -

-
-
-
-
-
-
-

- Name: -

-
-
-
-

- Cow -

-
-
-
-
-
-

- Wallet: -

-
-
-
-
- -

- 0xCD2a3...DD826 -

-
-
-
-
-
-
-
-
-

- To: -

-
-
-
-
-
-
-

- Name: -

-
-
-
-

- Bob -

-
-
-
-
-
-

- Wallet: -

-
-
-
-
- -

- 0xbBbBB...bBBbB -

-
-
-
-
-
-
-
-
-

- Contents: -

-
-
-
-

- Hello, Bob! -

-
-
-
-
-
-
-
-
-`; - -exports[`TypedSignInfo should render message for typed sign v4 request 1`] = ` -
-
-
-
-
-

- Request from -

-
-
- -
-
-
-
-
-

- metamask.github.io -

-
-
-
-
-
-

- Interacting with -

-
-
-
-
- -

- 0xCcCCc...ccccC -

-
-
-
-
-
-
- - -
-
-

- Message -

-
-
-
-
-
-
-

- Primary type: -

-
-
-
-

- Mail -

-
-
-
-
-
-
-
-

- Contents: -

-
-
-
-

- Hello, Bob! -

-
-
-
-
-
-

- From: -

-
-
-
-
-
-
-

- Name: -

-
-
-
-

- Cow -

-
-
-
-
-
-

- Wallets: -

-
-
-
-
-
-
-

- 0: -

-
-
-
-
- -

- 0xCD2a3...DD826 -

-
-
-
-
-
-
-

- 1: -

-
-
-
-
- -

- 0xDeaDb...DbeeF -

-
-
-
-
-
-
-

- 2: -

-
-
-
-
- -

- 0x06195...43896 -

-
-
-
-
-
-
-
-
-
-
-

- To: -

-
-
-
-
-
-
-

- 0: -

-
-
-
-
-
-
-

- Name: -

-
-
-
-

- Bob -

-
-
-
-
-
-

- Wallets: -

-
-
-
-
-
-
-

- 0: -

-
-
-
-
- -

- 0xbBbBB...bBBbB -

-
-
-
-
-
-
-

- 1: -

-
-
-
-
- -

- 0xB0Bda...bEa57 -

-
-
-
-
-
-
-

- 2: -

-
-
-
-
- -

- 0xB0B0b...00000 -

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap deleted file mode 100644 index 49a39c25bcdc..000000000000 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap +++ /dev/null @@ -1,345 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`PermitSimulation should not render default simulation if decodingLoading is true 1`] = ` -
-
-
-
-
-

- Estimated changes -

-
-
- -
-
-
-
-
-
- - - - - - - - - -
-
-
-`; - -exports[`PermitSimulation should render default simulation if decoding api does not return result 1`] = ` -
-
-
-
-
-

- Estimated changes -

-
-
- -
-
-
-
-
-

- You're giving the spender permission to spend this many tokens from your account. -

-
-
-
-
-
-

- Spending cap -

-
-
-
-
-
-
-
-
-

- 30 -

-
-
-
-
-
- -

- 0xCcCCc...ccccC -

-
-
-
-
-
-
-
-
-
-`; - -exports[`PermitSimulation should render default simulation if decoding api returns error 1`] = ` -
-
-
-
-
-

- Estimated changes -

-
-
- -
-
-
-
-
-

- You're giving the spender permission to spend this many tokens from your account. -

-
-
-
-
-
-

- Spending cap -

-
-
-
-
-
-
-
-
-

- 30 -

-
-
-
-
-
- -

- 0xCcCCc...ccccC -

-
-
-
-
-
-
-
-
-
-`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap deleted file mode 100644 index 608e4fa4d889..000000000000 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap +++ /dev/null @@ -1,115 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`DecodedSimulation renders component correctly 1`] = ` -
-
-
-
-
-

- Estimated changes -

-
-
- -
-
-
-
-
-
-
-
-

- Spending cap -

-
-
-
-
-
-
-
-

- 1,461,501,637,3... -

-
-
-
-
-
- -

- 0x6B175...71d0F -

-
-
-
-
-
-
-
-
-`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx index b11aef744b77..cf774483ee6c 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/decoded-simulation.tsx @@ -7,13 +7,13 @@ import { import { Hex } from '@metamask/utils'; import { TokenStandard } from '../../../../../../../../../shared/constants/transaction'; +import { ConfirmInfoRow } from '../../../../../../../../components/app/confirm/info/row'; import { useI18nContext } from '../../../../../../../../hooks/useI18nContext'; import { SignatureRequestType } from '../../../../../../types/confirm'; import { useConfirmContext } from '../../../../../../context/confirm'; import StaticSimulation from '../../../shared/static-simulation/static-simulation'; import TokenValueDisplay from '../value-display/value-display'; import NativeValueDisplay from '../native-value-display/native-value-display'; -import { ConfirmInfoRow } from '../../../../../../../../components/app/confirm/info/row'; export const getStateChangeToolip = ( stateChangeList: DecodingDataStateChanges | null, diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap deleted file mode 100644 index c6f420f6200d..000000000000 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap +++ /dev/null @@ -1,248 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`DefaultSimulation renders component correctly 1`] = ` -
-
-
-
-
-

- Estimated changes -

-
-
- -
-
-
-
-
-

- You're giving the spender permission to spend this many tokens from your account. -

-
-
-
-
-
-

- Spending cap -

-
-
-
-
-
-
-
-
-

- 30 -

-
-
-
-
-
- -

- 0xCcCCc...ccccC -

-
-
-
-
-
-
-
-
-
-`; - -exports[`DefaultSimulation renders correctly for NFT permit 1`] = ` -
-
-
-
-
-

- Estimated changes -

-
-
- -
-
-
-
-
-

- You're giving someone else permission to withdraw NFTs from your account. -

-
-
-
-
-
-

- Withdraw -

-
-
-
-
-
-
-
-

- #3606393 -

-
-
-
-
- -

- 0xC3644...1FE88 -

-
-
-
-
-
-
-
-
-
-`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/__snapshots__/value-display.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/__snapshots__/value-display.test.tsx.snap deleted file mode 100644 index 5104077b6822..000000000000 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/__snapshots__/value-display.test.tsx.snap +++ /dev/null @@ -1,59 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`PermitSimulationValueDisplay renders component correctly 1`] = ` -
-
-
-
-
-
-

- 0.432 -

-
-
-
-
-
- -

- 0xA0b86...6eB48 -

-
-
-
-
-
-
-`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/value-display.tsx b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/value-display.tsx index 795063f13059..2867522b42ab 100644 --- a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/value-display.tsx +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/value-display.tsx @@ -114,7 +114,7 @@ const PermitSimulationValueDisplay: React.FC< const { color, backgroundColor } = getAmountColors(credit, debit); return ( - + -
-
-
-
-
-
-
-
- - - - - -
-
-
-
- G -
-
-
-

- Test Account -

-

- Goerli -

-
-
-
-
-
-
- -
-
-
-
-
-
-
-

- Signature request -

-

- Review request details before you confirm. -

-
-
-
-
-

- Request from -

-
-
- -
-
-
-
-
-

- metamask.github.io -

-
-
-
-
-
- - -
-
-

- Message -

-
-
-
-

- Example \`personal_sign\` message -

-
-
-
-
-
-
- - -
-
-
-
-`; - -exports[`Confirm should match snapshot for signature - typed sign - V4 - PermitBatch 1`] = ` -
-
-
-
-
-
-
-
-
- - - - - -
-
-
-
- G -
-
-
-

-

- Goerli -

-
-
-
-
-
-
- -
-
-
-
-
-
-
-

- Spending cap request -

-

- This site wants permission to spend your tokens. -

-
-
-
-
-

- Estimated changes -

-
-
- -
-
-
-
-
-

- You're giving the spender permission to spend this many tokens from your account. -

-
-
-
-
-
-

- Spending cap -

-
-
-
-
-
-
-
-
-
-

- 14,615,016,373,... -

-
-
-
-
-
- -

- 0xA0b86...6eB48 -

-
-
-
-
-
-
-
-
-
-
-

- 24,615,016,373,... -

-
-
-
-
-
- -

- 0xb0B86...6EB48 -

-
-
-
-
-
-
-
-
-
-
-
-
-
-

- Spender -

-
-
-
-
- -

- 0x3fC91...b7FAD -

-
-
-
-
-
-
-
-

- Request from -

-
-
- -
-
-
-
-
-

- metamask.github.io -

-
-
-
-
-
-

- Interacting with -

-
-
-
-
- -

- 0x00000...78BA3 -

-
-
-
-
-
-
- - -
-
-

- Message -

-
-
-
-
-
-
-
- - -
-
-
-
-`; - -exports[`Confirm should match snapshot for signature - typed sign - V4 - PermitSingle 1`] = ` -
-
-
-
-
-
-
-
-
- - - - - -
-
-
-
- G -
-
-
-

-

- Goerli -

-
-
-
-
-
-
- -
-
-
-
-
-
-
-

- Spending cap request -

-

- This site wants permission to spend your tokens. -

-
-
-
-
-

- Estimated changes -

-
-
- -
-
-
-
-
-

- You're giving the spender permission to spend this many tokens from your account. -

-
-
-
-
-
-

- Spending cap -

-
-
-
-
-
-
-
-
-
-

- 14,615,016,373,... -

-
-
-
-
-
- -

- 0xA0b86...6eB48 -

-
-
-
-
-
-
-
-
-
-
-
-
-
-

- Spender -

-
-
-
-
- -

- 0x3fC91...b7FAD -

-
-
-
-
-
-
-
-

- Request from -

-
-
- -
-
-
-
-
-

- metamask.github.io -

-
-
-
-
-
-

- Interacting with -

-
-
-
-
- -

- 0x00000...78BA3 -

-
-
-
-
-
-
- - -
-
-

- Message -

-
-
-
-
-
-
-
- - -
-
-
-
-`; - -exports[`Confirm should match snapshot for signature - typed sign - V4 1`] = ` -
-
-
-
-
-
-
-
-
- - - - - -
-
-
-
- G -
-
-
-

- Test Account -

-

- Goerli -

-
-
-
-
-
-
- -
-
-
-
-
-
-
-

- Signature request -

-

- Review request details before you confirm. -

-
-
-
-
-

- Request from -

-
-
- -
-
-
-
-
-

- metamask.github.io -

-
-
-
-
-
-

- Interacting with -

-
-
-
-
- -

- 0xCcCCc...ccccC -

-
-
-
-
-
-
- - -
-
-

- Message -

-
-
-
-
-
-
-

- Primary type: -

-
-
-
-

- Mail -

-
-
-
-
-
-
-
-

- Contents: -

-
-
-
-

- Hello, Bob! -

-
-
-
-
-
-

- From: -

-
-
-
-
-
-
-

- Name: -

-
-
-
-

- Cow -

-
-
-
-
-
-

- Wallets: -

-
-
-
-
-
-
-

- 0: -

-
-
-
-
- -

- 0xCD2a3...DD826 -

-
-
-
-
-
-
-

- 1: -

-
-
-
-
- -

- 0xDeaDb...DbeeF -

-
-
-
-
-
-
-

- 2: -

-
-
-
-
- -

- 0x06195...43896 -

-
-
-
-
-
-
-
-
-
-
-

- To: -

-
-
-
-
-
-
-

- 0: -

-
-
-
-
-
-
-

- Name: -

-
-
-
-

- Bob -

-
-
-
-
-
-

- Wallets: -

-
-
-
-
-
-
-

- 0: -

-
-
-
-
- -

- 0xbBbBB...bBBbB -

-
-
-
-
-
-
-

- 1: -

-
-
-
-
- -

- 0xB0Bda...bEa57 -

-
-
-
-
-
-
-

- 2: -

-
-
-
-
- -

- 0xB0B0b...00000 -

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - -
-
-
-
-`; - -exports[`Confirm should match snapshot for signature - typed sign - permit 1`] = ` -
-
-
-
-
-
-
-
-
- - - - - -
-
-
-
- G -
-
-
-

-

- Goerli -

-
-
-
-
-
-
- -
-
-
-
-
-
-
-

- Spending cap request -

-

- This site wants permission to spend your tokens. -

-
-
-
-
-

- Estimated changes -

-
-
- -
-
-
-
-
-

- You're giving the spender permission to spend this many tokens from your account. -

-
-
-
-
-
-

- Spending cap -

-
-
-
-
-
-
-
-
-

- 30 -

-
-
-
-
-
- -

- 0xCcCCc...ccccC -

-
-
-
-
-
-
-
-
-
-
-
-
-

- Spender -

-
-
-
-
- -

- 0x5B38D...eddC4 -

-
-
-
-
-
-
-
-

- Request from -

-
-
- -
-
-
-
-
-

- metamask.github.io -

-
-
-
-
-
-

- Interacting with -

-
-
-
-
- -

- 0xCcCCc...ccccC -

-
-
-
-
-
-
- - -
-
-

- Message -

-
-
-
-
-
-
-
- - -
-
-
-
-`; - -exports[`Confirm should match snapshot signature - typed sign - order 1`] = ` -
-
-
-
-
-
-
-
-
- - - - - -
-
-
-
- G -
-
-
-

-

- Goerli -

-
-
-
-
-
-
- -
-
-
-
-
-
-
-

- Signature request -

-

- Review request details before you confirm. -

-
-
-
-
-

- Request from -

-
-
- -
-
-
-
-
-

- metamask.github.io -

-
-
-
-
-
-

- Interacting with -

-
-
-
-
- -

- 0xDef1C...25EfF -

-
-
-
-
-
-
- - -
-
-

- Message -

-
-
-
-
-
-
-

- Primary type: -

-
-
-
-

- Order -

-
-
-
-
-
-
-
-

- Direction: -

-
-
-
-

- 0 -

-
-
-
-
-
-

- Maker: -

-
-
-
-
- -

- Test Account -

-
-
-
-
-
-
-

- Taker: -

-
-
-
-
- -

- 0xCD2a3...DD826 -

-
-
-
-
-
-
-

- Expiry: -

-
-
-
-

- 2524604400 -

-
-
-
-
-
-

- Nonce: -

-
-
-
-

- 100131415900000000000000000000000000000083840314483690155566137712510085002484 -

-
-
-
-
-
-

- Erc20Token: -

-
-
-
-
- -

- 0xC02aa...56Cc2 -

-
-
-
-
-
-
-

- Erc20TokenAmount: -

-
-
-
-

- 42000000000000 -

-
-
-
-
-
-

- Fees: -

-
-
-
-
-
-
-
-

- Erc721Token: -

-
-
-
-
- -

- 0x8a90C...8992e -

-
-
-
-
-
-
-

- Erc721TokenId: -

-
-
-
-

- 2516 -

-
-
-
-
-
-

- Erc721TokenProperties: -

-
-
-
-
-
-
-
-
-
-
-
-
- - -
-
-
-
-`; From 166635689967ee92f197c76da23437b81404dbc8 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Fri, 22 Nov 2024 17:33:11 +0530 Subject: [PATCH 30/31] update --- .../__snapshots__/typed-sign.test.tsx.snap | 2941 +++++++++++++ .../permit-simulation.test.tsx.snap | 345 ++ .../default-simulation.test.tsx.snap | 248 ++ .../__snapshots__/value-display.test.tsx.snap | 59 + .../__snapshots__/confirm.test.tsx.snap | 3735 +++++++++++++++++ 5 files changed, 7328 insertions(+) create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/__snapshots__/typed-sign.test.tsx.snap create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/__snapshots__/value-display.test.tsx.snap create mode 100644 ui/pages/confirmations/confirm/__snapshots__/confirm.test.tsx.snap diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/__snapshots__/typed-sign.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/__snapshots__/typed-sign.test.tsx.snap new file mode 100644 index 000000000000..e34d9b1b5b8f --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/__snapshots__/typed-sign.test.tsx.snap @@ -0,0 +1,2941 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`TypedSignInfo correctly renders permit sign type 1`] = ` +
+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+

+ You're giving the spender permission to spend this many tokens from your account. +

+
+
+
+
+
+

+ Spending cap +

+
+
+
+
+
+
+
+
+

+ 3,000 +

+
+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+
+
+
+
+
+
+

+ Spender +

+
+
+
+
+ +

+ 0x5B38D...eddC4 +

+
+
+
+
+
+
+
+

+ Request from +

+
+
+ +
+
+
+
+
+

+ metamask.github.io +

+
+
+
+
+
+

+ Interacting with +

+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+ + +
+
+

+ Message +

+
+
+
+
+
+`; + +exports[`TypedSignInfo correctly renders permit sign type with no deadline 1`] = ` +
+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+

+ You're giving the spender permission to spend this many tokens from your account. +

+
+
+
+
+
+

+ Spending cap +

+
+
+
+
+
+
+
+
+

+ 3,000 +

+
+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+
+
+
+
+
+
+

+ Spender +

+
+
+
+
+ +

+ 0x5B38D...eddC4 +

+
+
+
+
+
+
+
+

+ Request from +

+
+
+ +
+
+
+
+
+

+ metamask.github.io +

+
+
+
+
+
+

+ Interacting with +

+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+ + +
+
+

+ Message +

+
+
+
+
+
+`; + +exports[`TypedSignInfo does not render if required data is not present in the transaction 1`] = `
`; + +exports[`TypedSignInfo renders origin for typed sign data request 1`] = ` +
+
+
+
+
+

+ Request from +

+
+
+ +
+
+
+
+
+

+ metamask.github.io +

+
+
+
+
+
+

+ Interacting with +

+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+ + +
+
+

+ Message +

+
+
+
+
+
+
+

+ Primary type: +

+
+
+
+

+ Mail +

+
+
+
+
+
+
+
+

+ Contents: +

+
+
+
+

+ Hello, Bob! +

+
+
+
+
+
+

+ From: +

+
+
+
+
+
+
+

+ Name: +

+
+
+
+

+ Cow +

+
+
+
+
+
+

+ Wallets: +

+
+
+
+
+
+
+

+ 0: +

+
+
+
+
+ +

+ 0xCD2a3...DD826 +

+
+
+
+
+
+
+

+ 1: +

+
+
+
+
+ +

+ 0xDeaDb...DbeeF +

+
+
+
+
+
+
+

+ 2: +

+
+
+
+
+ +

+ 0x06195...43896 +

+
+
+
+
+
+
+
+
+
+
+

+ To: +

+
+
+
+
+
+
+

+ 0: +

+
+
+
+
+
+
+

+ Name: +

+
+
+
+

+ Bob +

+
+
+
+
+
+

+ Wallets: +

+
+
+
+
+
+
+

+ 0: +

+
+
+
+
+ +

+ 0xbBbBB...bBBbB +

+
+
+
+
+
+
+

+ 1: +

+
+
+
+
+ +

+ 0xB0Bda...bEa57 +

+
+
+
+
+
+
+

+ 2: +

+
+
+
+
+ +

+ 0xB0B0b...00000 +

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+`; + +exports[`TypedSignInfo should render message for typed sign v3 request 1`] = ` +
+
+
+
+
+

+ Request from +

+
+
+ +
+
+
+
+
+

+ metamask.github.io +

+
+
+
+
+
+

+ Interacting with +

+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+ + +
+
+

+ Message +

+
+
+
+
+
+
+

+ Primary type: +

+
+
+
+

+ Mail +

+
+
+
+
+
+
+
+

+ From: +

+
+
+
+
+
+
+

+ Name: +

+
+
+
+

+ Cow +

+
+
+
+
+
+

+ Wallet: +

+
+
+
+
+ +

+ 0xCD2a3...DD826 +

+
+
+
+
+
+
+
+
+

+ To: +

+
+
+
+
+
+
+

+ Name: +

+
+
+
+

+ Bob +

+
+
+
+
+
+

+ Wallet: +

+
+
+
+
+ +

+ 0xbBbBB...bBBbB +

+
+
+
+
+
+
+
+
+

+ Contents: +

+
+
+
+

+ Hello, Bob! +

+
+
+
+
+
+
+
+
+`; + +exports[`TypedSignInfo should render message for typed sign v4 request 1`] = ` +
+
+
+
+
+

+ Request from +

+
+
+ +
+
+
+
+
+

+ metamask.github.io +

+
+
+
+
+
+

+ Interacting with +

+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+ + +
+
+

+ Message +

+
+
+
+
+
+
+

+ Primary type: +

+
+
+
+

+ Mail +

+
+
+
+
+
+
+
+

+ Contents: +

+
+
+
+

+ Hello, Bob! +

+
+
+
+
+
+

+ From: +

+
+
+
+
+
+
+

+ Name: +

+
+
+
+

+ Cow +

+
+
+
+
+
+

+ Wallets: +

+
+
+
+
+
+
+

+ 0: +

+
+
+
+
+ +

+ 0xCD2a3...DD826 +

+
+
+
+
+
+
+

+ 1: +

+
+
+
+
+ +

+ 0xDeaDb...DbeeF +

+
+
+
+
+
+
+

+ 2: +

+
+
+
+
+ +

+ 0x06195...43896 +

+
+
+
+
+
+
+
+
+
+
+

+ To: +

+
+
+
+
+
+
+

+ 0: +

+
+
+
+
+
+
+

+ Name: +

+
+
+
+

+ Bob +

+
+
+
+
+
+

+ Wallets: +

+
+
+
+
+
+
+

+ 0: +

+
+
+
+
+ +

+ 0xbBbBB...bBBbB +

+
+
+
+
+
+
+

+ 1: +

+
+
+
+
+ +

+ 0xB0Bda...bEa57 +

+
+
+
+
+
+
+

+ 2: +

+
+
+
+
+ +

+ 0xB0B0b...00000 +

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap new file mode 100644 index 000000000000..1551e2a8bf8a --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/__snapshots__/permit-simulation.test.tsx.snap @@ -0,0 +1,345 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`PermitSimulation should not render default simulation if decodingLoading is true 1`] = ` +
+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+
+ + + + + + + + + +
+
+
+`; + +exports[`PermitSimulation should render default simulation if decoding api does not return result 1`] = ` +
+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+

+ You're giving the spender permission to spend this many tokens from your account. +

+
+
+
+
+
+

+ Spending cap +

+
+
+
+
+
+
+
+
+

+ 30 +

+
+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+
+
+
+`; + +exports[`PermitSimulation should render default simulation if decoding api returns error 1`] = ` +
+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+

+ You're giving the spender permission to spend this many tokens from your account. +

+
+
+
+
+
+

+ Spending cap +

+
+
+
+
+
+
+
+
+

+ 30 +

+
+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+
+
+
+`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap new file mode 100644 index 000000000000..2b6dee2b8c0c --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/default-simulation/__snapshots__/default-simulation.test.tsx.snap @@ -0,0 +1,248 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`DefaultSimulation renders component correctly 1`] = ` +
+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+

+ You're giving the spender permission to spend this many tokens from your account. +

+
+
+
+
+
+

+ Spending cap +

+
+
+
+
+
+
+
+
+

+ 30 +

+
+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+
+
+
+`; + +exports[`DefaultSimulation renders correctly for NFT permit 1`] = ` +
+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+

+ You're giving someone else permission to withdraw NFTs from your account. +

+
+
+
+
+
+

+ Withdraw +

+
+
+
+
+
+
+
+

+ #3606393 +

+
+
+
+
+ +

+ 0xC3644...1FE88 +

+
+
+
+
+
+
+
+
+
+`; diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/__snapshots__/value-display.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/__snapshots__/value-display.test.tsx.snap new file mode 100644 index 000000000000..37e3a25ad5b6 --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/value-display/__snapshots__/value-display.test.tsx.snap @@ -0,0 +1,59 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`PermitSimulationValueDisplay renders component correctly 1`] = ` +
+
+
+
+
+
+

+ 0.432 +

+
+
+
+
+
+ +

+ 0xA0b86...6eB48 +

+
+
+
+
+
+
+`; diff --git a/ui/pages/confirmations/confirm/__snapshots__/confirm.test.tsx.snap b/ui/pages/confirmations/confirm/__snapshots__/confirm.test.tsx.snap new file mode 100644 index 000000000000..2fff18bc9084 --- /dev/null +++ b/ui/pages/confirmations/confirm/__snapshots__/confirm.test.tsx.snap @@ -0,0 +1,3735 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`Confirm matches snapshot for signature - personal sign type 1`] = ` +
+
+
+
+
+
+
+
+
+ + + + + +
+
+
+
+ G +
+
+
+

+ Test Account +

+

+ Goerli +

+
+
+
+
+
+
+ +
+
+
+
+
+
+
+

+ Signature request +

+

+ Review request details before you confirm. +

+
+
+
+
+

+ Request from +

+
+
+ +
+
+
+
+
+

+ metamask.github.io +

+
+
+
+
+
+ + +
+
+

+ Message +

+
+
+
+

+ Example \`personal_sign\` message +

+
+
+
+
+
+
+ + +
+
+
+
+`; + +exports[`Confirm should match snapshot for signature - typed sign - V4 - PermitBatch 1`] = ` +
+
+
+
+
+
+
+
+
+ + + + + +
+
+
+
+ G +
+
+
+

+

+ Goerli +

+
+
+
+
+
+
+ +
+
+
+
+
+
+
+

+ Spending cap request +

+

+ This site wants permission to spend your tokens. +

+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+

+ You're giving the spender permission to spend this many tokens from your account. +

+
+
+
+
+
+

+ Spending cap +

+
+
+
+
+
+
+
+
+
+

+ 14,615,016,373,... +

+
+
+
+
+
+ +

+ 0xA0b86...6eB48 +

+
+
+
+
+
+
+
+
+
+
+

+ 24,615,016,373,... +

+
+
+
+
+
+ +

+ 0xb0B86...6EB48 +

+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ Spender +

+
+
+
+
+ +

+ 0x3fC91...b7FAD +

+
+
+
+
+
+
+
+

+ Request from +

+
+
+ +
+
+
+
+
+

+ metamask.github.io +

+
+
+
+
+
+

+ Interacting with +

+
+
+
+
+ +

+ 0x00000...78BA3 +

+
+
+
+
+
+
+ + +
+
+

+ Message +

+
+
+
+
+
+
+
+ + +
+
+
+
+`; + +exports[`Confirm should match snapshot for signature - typed sign - V4 - PermitSingle 1`] = ` +
+
+
+
+
+
+
+
+
+ + + + + +
+
+
+
+ G +
+
+
+

+

+ Goerli +

+
+
+
+
+
+
+ +
+
+
+
+
+
+
+

+ Spending cap request +

+

+ This site wants permission to spend your tokens. +

+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+

+ You're giving the spender permission to spend this many tokens from your account. +

+
+
+
+
+
+

+ Spending cap +

+
+
+
+
+
+
+
+
+
+

+ 14,615,016,373,... +

+
+
+
+
+
+ +

+ 0xA0b86...6eB48 +

+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ Spender +

+
+
+
+
+ +

+ 0x3fC91...b7FAD +

+
+
+
+
+
+
+
+

+ Request from +

+
+
+ +
+
+
+
+
+

+ metamask.github.io +

+
+
+
+
+
+

+ Interacting with +

+
+
+
+
+ +

+ 0x00000...78BA3 +

+
+
+
+
+
+
+ + +
+
+

+ Message +

+
+
+
+
+
+
+
+ + +
+
+
+
+`; + +exports[`Confirm should match snapshot for signature - typed sign - V4 1`] = ` +
+
+
+
+
+
+
+
+
+ + + + + +
+
+
+
+ G +
+
+
+

+ Test Account +

+

+ Goerli +

+
+
+
+
+
+
+ +
+
+
+
+
+
+
+

+ Signature request +

+

+ Review request details before you confirm. +

+
+
+
+
+

+ Request from +

+
+
+ +
+
+
+
+
+

+ metamask.github.io +

+
+
+
+
+
+

+ Interacting with +

+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+ + +
+
+

+ Message +

+
+
+
+
+
+
+

+ Primary type: +

+
+
+
+

+ Mail +

+
+
+
+
+
+
+
+

+ Contents: +

+
+
+
+

+ Hello, Bob! +

+
+
+
+
+
+

+ From: +

+
+
+
+
+
+
+

+ Name: +

+
+
+
+

+ Cow +

+
+
+
+
+
+

+ Wallets: +

+
+
+
+
+
+
+

+ 0: +

+
+
+
+
+ +

+ 0xCD2a3...DD826 +

+
+
+
+
+
+
+

+ 1: +

+
+
+
+
+ +

+ 0xDeaDb...DbeeF +

+
+
+
+
+
+
+

+ 2: +

+
+
+
+
+ +

+ 0x06195...43896 +

+
+
+
+
+
+
+
+
+
+
+

+ To: +

+
+
+
+
+
+
+

+ 0: +

+
+
+
+
+
+
+

+ Name: +

+
+
+
+

+ Bob +

+
+
+
+
+
+

+ Wallets: +

+
+
+
+
+
+
+

+ 0: +

+
+
+
+
+ +

+ 0xbBbBB...bBBbB +

+
+
+
+
+
+
+

+ 1: +

+
+
+
+
+ +

+ 0xB0Bda...bEa57 +

+
+
+
+
+
+
+

+ 2: +

+
+
+
+
+ +

+ 0xB0B0b...00000 +

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + +
+
+
+
+`; + +exports[`Confirm should match snapshot for signature - typed sign - permit 1`] = ` +
+
+
+
+
+
+
+
+
+ + + + + +
+
+
+
+ G +
+
+
+

+

+ Goerli +

+
+
+
+
+
+
+ +
+
+
+
+
+
+
+

+ Spending cap request +

+

+ This site wants permission to spend your tokens. +

+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+

+ You're giving the spender permission to spend this many tokens from your account. +

+
+
+
+
+
+

+ Spending cap +

+
+
+
+
+
+
+
+
+

+ 30 +

+
+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+
+
+
+
+
+
+

+ Spender +

+
+
+
+
+ +

+ 0x5B38D...eddC4 +

+
+
+
+
+
+
+
+

+ Request from +

+
+
+ +
+
+
+
+
+

+ metamask.github.io +

+
+
+
+
+
+

+ Interacting with +

+
+
+
+
+ +

+ 0xCcCCc...ccccC +

+
+
+
+
+
+
+ + +
+
+

+ Message +

+
+
+
+
+
+
+
+ + +
+
+
+
+`; + +exports[`Confirm should match snapshot signature - typed sign - order 1`] = ` +
+
+
+
+
+
+
+
+
+ + + + + +
+
+
+
+ G +
+
+
+

+

+ Goerli +

+
+
+
+
+
+
+ +
+
+
+
+
+
+
+

+ Signature request +

+

+ Review request details before you confirm. +

+
+
+
+
+

+ Request from +

+
+
+ +
+
+
+
+
+

+ metamask.github.io +

+
+
+
+
+
+

+ Interacting with +

+
+
+
+
+ +

+ 0xDef1C...25EfF +

+
+
+
+
+
+
+ + +
+
+

+ Message +

+
+
+
+
+
+
+

+ Primary type: +

+
+
+
+

+ Order +

+
+
+
+
+
+
+
+

+ Direction: +

+
+
+
+

+ 0 +

+
+
+
+
+
+

+ Maker: +

+
+
+
+
+ +

+ Test Account +

+
+
+
+
+
+
+

+ Taker: +

+
+
+
+
+ +

+ 0xCD2a3...DD826 +

+
+
+
+
+
+
+

+ Expiry: +

+
+
+
+

+ 2524604400 +

+
+
+
+
+
+

+ Nonce: +

+
+
+
+

+ 100131415900000000000000000000000000000083840314483690155566137712510085002484 +

+
+
+
+
+
+

+ Erc20Token: +

+
+
+
+
+ +

+ 0xC02aa...56Cc2 +

+
+
+
+
+
+
+

+ Erc20TokenAmount: +

+
+
+
+

+ 42000000000000 +

+
+
+
+
+
+

+ Fees: +

+
+
+
+
+
+
+
+

+ Erc721Token: +

+
+
+
+
+ +

+ 0x8a90C...8992e +

+
+
+
+
+
+
+

+ Erc721TokenId: +

+
+
+
+

+ 2516 +

+
+
+
+
+
+

+ Erc721TokenProperties: +

+
+
+
+
+
+
+
+
+
+
+
+
+ + +
+
+
+
+`; From dc8f1b9e3c6e3c0cd7b5b46c9bd89c2245023072 Mon Sep 17 00:00:00 2001 From: Jyoti Puri Date: Fri, 22 Nov 2024 17:34:01 +0530 Subject: [PATCH 31/31] update --- .../decoded-simulation.test.tsx.snap | 115 ++++++++++++++++++ 1 file changed, 115 insertions(+) create mode 100644 ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap diff --git a/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap new file mode 100644 index 000000000000..ed4b45276a4b --- /dev/null +++ b/ui/pages/confirmations/components/confirm/info/typed-sign/permit-simulation/decoded-simulation/__snapshots__/decoded-simulation.test.tsx.snap @@ -0,0 +1,115 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`DecodedSimulation renders component correctly 1`] = ` +
+
+
+
+
+

+ Estimated changes +

+
+
+ +
+
+
+
+
+
+
+
+

+ Spending cap +

+
+
+
+
+
+
+
+

+ 1,461,501,637,3... +

+
+
+
+
+
+ +

+ 0x6B175...71d0F +

+
+
+
+
+
+
+
+
+`;