From 83d9a9b1c48a63d0095dd059ed0c5dee67d3fba9 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 05:43:37 +0000 Subject: [PATCH 01/31] Show loading shimmer while switching popup wallets --- app/ts/components/App.tsx | 25 ++++++++++++++-------- app/ts/components/pages/Home.tsx | 5 +++-- app/ts/types/user-interface-types.ts | 2 ++ test/tests/homeClearEmptyState.test.ts | 29 ++++++++++++++++++++++++++ 4 files changed, 50 insertions(+), 11 deletions(-) diff --git a/app/ts/components/App.tsx b/app/ts/components/App.tsx index 134b8ac42..3dd0b2b6f 100644 --- a/app/ts/components/App.tsx +++ b/app/ts/components/App.tsx @@ -71,20 +71,26 @@ export function App() { }, }) const boundaryResetKey = useSignal(0) + const isActiveAddressChanging = useSignal(false) async function setActiveAddressAndInformAboutIt(address: bigint | 'signer', persistedEntry?: AddressBookEntry) { - if (!isSettingsLoaded.value) return + if (!isSettingsLoaded.value || isActiveAddressChanging.value) return const selectableAddresses = includePersistedAddressBookEntry(activeAddresses.value, persistedEntry) if (!isActiveAddressSelectionAllowed(address, selectableAddresses, simulationMode.value, rpcNetwork.value?.chainId, tabState.value?.signerAccounts ?? [])) return - await requestActiveAddressChange(address, simulationMode.value) - const optimisticSelection = getOptimisticActiveAddressSelection(address, simulationMode.value, tabState.value?.signerAccounts ?? []) - if (optimisticSelection.mode === 'simulation') { - activeSimulationAddress.value = optimisticSelection.activeSimulationAddress - useSignersAddressAsActiveAddress.value = optimisticSelection.useSignersAddressAsActiveAddress - return + isActiveAddressChanging.value = true + try { + await requestActiveAddressChange(address, simulationMode.value) + const optimisticSelection = getOptimisticActiveAddressSelection(address, simulationMode.value, tabState.value?.signerAccounts ?? []) + if (optimisticSelection.mode === 'simulation') { + activeSimulationAddress.value = optimisticSelection.activeSimulationAddress + useSignersAddressAsActiveAddress.value = optimisticSelection.useSignersAddressAsActiveAddress + return + } + displayedSigningAddress.value = optimisticSelection.displayedSigningAddress + activeSigningSafeAddress.value = address === 'signer' ? undefined : optimisticSelection.displayedSigningAddress + } finally { + isActiveAddressChanging.value = false } - displayedSigningAddress.value = optimisticSelection.displayedSigningAddress - activeSigningSafeAddress.value = address === 'signer' ? undefined : optimisticSelection.displayedSigningAddress } function isSignerConnected() { @@ -250,6 +256,7 @@ export function App() { { if (!param.isInitialHomeDataLoaded.value) return @@ -615,7 +615,7 @@ function FirstCard(param: FirstCardParams) { } { isActiveAddressLoading - ? + ? :
} changeActiveAddress: () => void makeCurrentAddressRich: Signal activeAddresses: Signal @@ -73,6 +74,7 @@ export type ChangeActiveAddressParam = { } export type FirstCardParams = { + isActiveAddressChanging: Signal activeAddress: Signal useSignersAddressAsActiveAddress: Signal activeAddresses: Signal diff --git a/test/tests/homeClearEmptyState.test.ts b/test/tests/homeClearEmptyState.test.ts index 982ffb478..fc597907f 100644 --- a/test/tests/homeClearEmptyState.test.ts +++ b/test/tests/homeClearEmptyState.test.ts @@ -254,6 +254,7 @@ const createPendingSignedMessageSimulationResults = (): SimulationAndVisualisati function createHomeParams(overrides: Partial = {}): HomeParams { return { + isActiveAddressChanging: new Signal(false), changeActiveAddress: () => undefined, makeCurrentAddressRich: new Signal(false), activeAddresses: new Signal([activeAddressEntry]), @@ -402,6 +403,34 @@ function getMessageWithMethod(messages: readonly unknown[], method: string) { } describe('Home popup clear empty state', () => { + for (const succeeds of [true, false]) { + test(`shows the address shimmer during a switch and restores the address after ${ succeeds ? 'success' : 'failure' }`, async () => { + const dom = installDomMock() + const params = createHomeParams() + const addressRow = () => collectElements(dom.document.body, 'div').find((element) => element.getAttribute?.('class')?.split(/\s+/).includes('active-address-row')) + try { + await act(() => { render(h(Home, params), dom.document.body) }) + assert.equal(addressRow()?.getAttribute?.('aria-busy'), undefined) + await act(() => { params.isActiveAddressChanging.value = true }) + assert.equal(addressRow()?.getAttribute?.('aria-label'), 'Switching active address') + assert.equal(String(addressRow()?.getAttribute?.('aria-busy')), 'true') + assert.equal(collectElements(addressRow(), 'button').every((button) => button.getAttribute?.('disabled') !== undefined), true) + await act(() => { + if (succeeds) { + params.activeAddresses.value = [{ ...activeAddressEntry, address: 2n, name: 'New wallet' }] + params.activeSimulationAddress.value = 2n + } + params.isActiveAddressChanging.value = false + }) + assert.equal(addressRow()?.getAttribute?.('aria-busy'), undefined) + assert.equal(addressRow()?.textContent?.includes(succeeds ? 'New wallet' : activeAddressEntry.name ?? ''), true) + } finally { + render(undefined, dom.document.body) + dom.restore() + } + }) + } + test('shows a skeleton until initial simulation status is known', async () => { const dom = installDomMock() const simulationUpdatingState = new Signal<'done' | 'updating' | 'failed' | undefined>(undefined) From e9a588b3b308f4fb40eb38e75e38a02cd6ca827e Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 06:14:52 +0000 Subject: [PATCH 02/31] Reveal committed wallet selection before background refresh completes --- app/ts/background/activeSettings.ts | 7 ++ app/ts/background/popupMessageHandlers.ts | 2 + app/ts/components/App.tsx | 29 +++-- app/ts/components/activeAddressChange.ts | 18 +-- .../hooks/useLiveSimulationHomeData.ts | 6 +- app/ts/components/pages/Home.tsx | 3 +- app/ts/types/interceptor-messages.ts | 13 +- app/ts/types/interceptor-reply-messages.ts | 17 +-- app/ts/types/user-interface-types.ts | 2 + .../backgroundAccountPermissions.test.ts | 42 +++++++ test/tests/homeClearEmptyState.test.ts | 19 +++ test/tests/simulationVisualizerOpen.test.tsx | 111 +++++++++++++++++- 12 files changed, 222 insertions(+), 47 deletions(-) diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index d591ee0f4..deaede2d5 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -62,6 +62,7 @@ export async function changeActiveAddressAndChain( signingAddressSelection?: 'signer' | 'safe', rpcNetwork?: RpcNetwork, promptForAccessesIfNeeded?: boolean, + addressChangeRequestId?: string, }, ) { if (change.simulationMode && change.activeAddress !== undefined) await keepTrackOfPreviousAddressForRichList() @@ -85,6 +86,10 @@ export async function changeActiveAddressAndChain( } const updatedSettings = await getSettings() + if (change.addressChangeRequestId !== undefined) { + // Confirm the persisted selection before waiting for website permissions, icons, and simulation work. + await sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: updatedSettings, popupRefreshGeneration: bumpPopupRefreshGeneration(), committedAddressChange: { requestId: change.addressChangeRequestId, activeAddress: change.activeAddress } }) + } const popupRefreshGeneration = await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, updatedSettings, change.promptForAccessesIfNeeded ?? true) sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: updatedSettings, popupRefreshGeneration }) sendPopupMessageToOpenWindows({ method: 'popup_accounts_update' }) @@ -120,6 +125,7 @@ export async function activateAddressSelection( readonly signerAddress: bigint | undefined readonly rpcNetwork?: RpcNetwork readonly promptForAccessesIfNeeded?: boolean + readonly addressChangeRequestId?: string }, ) { const useSignerAddress = selection?.type === 'signer' || (!options.simulationMode && selection === undefined) @@ -128,6 +134,7 @@ export async function activateAddressSelection( } await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { simulationMode: options.simulationMode, + addressChangeRequestId: options.addressChangeRequestId, activeAddress: selection?.type === 'signer' ? selection.address : selection?.entry.address, ...(!options.simulationMode ? { signingAddressSelection: selection?.type === 'addressBookEntry' && selection.entry.type === 'safe' ? 'safe' as const : 'signer' as const } : {}), ...(options.rpcNetwork === undefined ? {} : { rpcNetwork: options.rpcNetwork }), diff --git a/app/ts/background/popupMessageHandlers.ts b/app/ts/background/popupMessageHandlers.ts index 046106583..ed6a9dc69 100644 --- a/app/ts/background/popupMessageHandlers.ts +++ b/app/ts/background/popupMessageHandlers.ts @@ -232,6 +232,7 @@ export async function changeActiveAddress(ethereum: EthereumClientService, token if (addressChange.data.activeAddress === 'signer') { await activateAddressSelection(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, undefined, { simulationMode: false, + addressChangeRequestId: addressChange.data.addressChangeRequestId, signerAddress: undefined, }) return { type: 'ChangeActiveAddressReply', ok: true } as const @@ -250,6 +251,7 @@ export async function changeActiveAddress(ethereum: EthereumClientService, token } await activateAddressSelection(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, selection, { simulationMode: addressChange.data.simulationMode, + addressChangeRequestId: addressChange.data.addressChangeRequestId, signerAddress: signerAccount, }) return { type: 'ChangeActiveAddressReply', ok: true } as const diff --git a/app/ts/components/App.tsx b/app/ts/components/App.tsx index 3dd0b2b6f..e40373084 100644 --- a/app/ts/components/App.tsx +++ b/app/ts/components/App.tsx @@ -20,13 +20,15 @@ import { useLiveSimulationHomeData } from './hooks/useLiveSimulationHomeData.js' import { NetworkErrors } from './subcomponents/NetworkErrors.js' import { ProviderErrors } from './subcomponents/ProviderErrors.js' import { PopupModal, type PopupPage } from './PopupModal.js' -import { getOptimisticActiveAddressSelection, getSelectableActiveAddresses, includePersistedAddressBookEntry, isActiveAddressSelectionAllowed, isSignerConnectedForMode } from '../utils/activeAddressSelection.js' +import { getSelectableActiveAddresses, includePersistedAddressBookEntry, isActiveAddressSelectionAllowed, isSignerConnectedForMode } from '../utils/activeAddressSelection.js' import { requestActiveAddressChange } from './activeAddressChange.js' import { useModeActiveAddress } from './hooks/useModeActiveAddress.js' export { NetworkErrors } from './subcomponents/NetworkErrors.js' export function App() { const appPage = useSignal({ page: 'Unknown' }) + const pendingAddressChangeRequestId = useSignal(undefined) + const isActiveAddressChanging = useSignal(false) const { activeAddresses, walletSelectedAddressBookEntry, @@ -61,6 +63,11 @@ export function App() { answerSimulationDataConsumerOpen: true, requestFreshHomeDataOnMount: true, requestHomeDataOnSimulationStateChange: true, + onAddressSelectionCommitted({ requestId, activeAddress }, settings) { + if (pendingAddressChangeRequestId.value !== requestId) return + if (!settings.simulationMode) displayedSigningAddress.value = activeAddress + isActiveAddressChanging.value = false + }, onInitialSettings(settings: Settings) { if (appPage.value.page !== 'Unknown') return if (settings.openedPage.page === 'AddNewAddress' || settings.openedPage.page === 'ModifyAddress') { @@ -71,24 +78,23 @@ export function App() { }, }) const boundaryResetKey = useSignal(0) - const isActiveAddressChanging = useSignal(false) + const isActiveAddressChangePending = useComputed(() => pendingAddressChangeRequestId.value !== undefined) async function setActiveAddressAndInformAboutIt(address: bigint | 'signer', persistedEntry?: AddressBookEntry) { - if (!isSettingsLoaded.value || isActiveAddressChanging.value) return + if (!isSettingsLoaded.value || isActiveAddressChangePending.value) return const selectableAddresses = includePersistedAddressBookEntry(activeAddresses.value, persistedEntry) if (!isActiveAddressSelectionAllowed(address, selectableAddresses, simulationMode.value, rpcNetwork.value?.chainId, tabState.value?.signerAccounts ?? [])) return + const requestId = crypto.randomUUID() + pendingAddressChangeRequestId.value = requestId isActiveAddressChanging.value = true try { - await requestActiveAddressChange(address, simulationMode.value) - const optimisticSelection = getOptimisticActiveAddressSelection(address, simulationMode.value, tabState.value?.signerAccounts ?? []) - if (optimisticSelection.mode === 'simulation') { - activeSimulationAddress.value = optimisticSelection.activeSimulationAddress - useSignersAddressAsActiveAddress.value = optimisticSelection.useSignersAddressAsActiveAddress - return + await requestActiveAddressChange(address, simulationMode.value, undefined, requestId) + // Recover a missed commit notification from current background state, never from the original selection. + if (isActiveAddressChanging.value) { + await sendPopupMessageToBackgroundPage({ method: 'popup_requestNewHomeData', data: { refreshSignerAccounts: false, includeWebsiteAccessAddressMetadata: true } }) } - displayedSigningAddress.value = optimisticSelection.displayedSigningAddress - activeSigningSafeAddress.value = address === 'signer' ? undefined : optimisticSelection.displayedSigningAddress } finally { + pendingAddressChangeRequestId.value = undefined isActiveAddressChanging.value = false } } @@ -257,6 +263,7 @@ export function App() { Promise = sendPopupMessageWithReply, + sendMessage: (message: ChangeActiveAddress) => Promise = sendPopupMessageWithReply, + addressChangeRequestId?: string, ) { - const reply = await sendMessage({ method: 'popup_changeActiveAddress', data: { activeAddress, simulationMode } }) + const reply = await sendMessage({ method: 'popup_changeActiveAddress', data: { activeAddress, simulationMode, ...(addressChangeRequestId === undefined ? {} : { addressChangeRequestId }) } }) if (reply === undefined) throw new Error(getMissingPopupReplyErrorMessage('Changing the active address')) if (!reply.ok) throw new Error(reply.message) } diff --git a/app/ts/components/hooks/useLiveSimulationHomeData.ts b/app/ts/components/hooks/useLiveSimulationHomeData.ts index b8ab9aec8..ce4dfcae6 100644 --- a/app/ts/components/hooks/useLiveSimulationHomeData.ts +++ b/app/ts/components/hooks/useLiveSimulationHomeData.ts @@ -21,6 +21,7 @@ type LiveSimulationHomeDataOptions = { requireActiveModeAddress?: boolean requestHomeDataOnSimulationStateChange?: boolean onInitialSettings?: (settings: Settings) => void + onAddressSelectionCommitted?: (selection: { requestId: string, activeAddress: bigint | undefined }, settings: Settings) => void } type CachedHomeDataRequest = { @@ -239,11 +240,12 @@ export function useLiveSimulationHomeData(options: LiveSimulationHomeDataOptions unexpectedError.value = parsed return undefined case 'popup_settingsUpdated': { - if (shouldIgnoreOutdatedPopupRefreshMessage(parsed.popupRefreshGeneration)) return undefined + if (shouldIgnoreOutdatedPopupRefreshMessage(parsed.popupRefreshGeneration, Math.max(popupRefreshGeneration.value, pendingPopupRefreshGeneration.value))) return undefined const previousActiveStackContext = getCurrentActiveStackContext() const updatedActiveStackContext = getActiveStackContext(parsed.data) updateHomePageSettings(parsed.data) - if (previousActiveStackContext === undefined || !activeStackContextsEqual(previousActiveStackContext, updatedActiveStackContext)) { + if (parsed.committedAddressChange !== undefined) options.onAddressSelectionCommitted?.(parsed.committedAddressChange, parsed.data) + if (parsed.committedAddressChange !== undefined || previousActiveStackContext === undefined || !activeStackContextsEqual(previousActiveStackContext, updatedActiveStackContext)) { simVisResults.value = PASSTHROUGH_STATE simulationUpdatingState.value = undefined simulationResultState.value = undefined diff --git a/app/ts/components/pages/Home.tsx b/app/ts/components/pages/Home.tsx index fd07bddb8..8fff32bc1 100644 --- a/app/ts/components/pages/Home.tsx +++ b/app/ts/components/pages/Home.tsx @@ -620,7 +620,7 @@ function FirstCard(param: FirstCardParams) { -export const ChangeActiveAddress = funtypes.ReadonlyObject({ - method: funtypes.Literal('popup_changeActiveAddress'), - data: funtypes.ReadonlyObject({ - simulationMode: funtypes.Boolean, - activeAddress: funtypes.Union(EthereumAddress, funtypes.Literal('signer')) - }) -}).asReadonly() +export { ChangeActiveAddress } from './interceptor-reply-messages.js' export type ModifyMakeMeRich = funtypes.Static export const ModifyMakeMeRich = funtypes.ReadonlyObject({ @@ -792,7 +785,7 @@ const SettingsUpdated = funtypes.ReadonlyObject({ method: funtypes.Literal('popup_settingsUpdated'), data: Settings, popupRefreshGeneration: PopupRefreshGeneration, -}) +}).And(funtypes.ReadonlyPartial({ committedAddressChange: funtypes.ReadonlyObject({ requestId: funtypes.String, activeAddress: OptionalEthereumAddress }) })) type PartiallyParsedSimulateExecutionReply = funtypes.Static const PartiallyParsedSimulateExecutionReply = funtypes.ReadonlyObject({ diff --git a/app/ts/types/interceptor-reply-messages.ts b/app/ts/types/interceptor-reply-messages.ts index 94aef3eae..b3ffa68ed 100644 --- a/app/ts/types/interceptor-reply-messages.ts +++ b/app/ts/types/interceptor-reply-messages.ts @@ -94,6 +94,15 @@ export const AddOrModifyAddressBookEntryReply = funtypes.Union( }), ) +export type ChangeActiveAddress = funtypes.Static +export const ChangeActiveAddress = funtypes.ReadonlyObject({ + method: funtypes.Literal('popup_changeActiveAddress'), + data: funtypes.ReadonlyObject({ + simulationMode: funtypes.Boolean, + activeAddress: funtypes.Union(EthereumAddress, funtypes.Literal('signer')), + }).And(funtypes.ReadonlyPartial({ addressChangeRequestId: funtypes.String })) +}).asReadonly() + export type ChangeActiveAddressReply = funtypes.Static export const ChangeActiveAddressReply = funtypes.Union( funtypes.ReadonlyObject({ @@ -341,13 +350,7 @@ export const PopupMessageReplyRequests = funtypes.Union( funtypes.ReadonlyObject({ method: funtypes.Literal('popup_requestInterceptorSimulationInput') }), funtypes.ReadonlyObject({ method: funtypes.Literal('popup_importSimulationStack'), data: InterceptorSimulationExport }), funtypes.ReadonlyObject({ method: funtypes.Literal('popup_addOrModifyAddressBookEntry'), data: AddressBookEntry }), - funtypes.ReadonlyObject({ - method: funtypes.Literal('popup_changeActiveAddress'), - data: funtypes.ReadonlyObject({ - activeAddress: funtypes.Union(EthereumAddress, funtypes.Literal('signer')), - simulationMode: funtypes.Boolean, - }), - }), + ChangeActiveAddress, SetSafeSimulationSigner, funtypes.ReadonlyObject({ method: funtypes.Literal('popup_requestSafeStackExport') }), funtypes.ReadonlyObject({ method: funtypes.Literal('popup_importSafeStack'), data: SafeStackExport }), diff --git a/app/ts/types/user-interface-types.ts b/app/ts/types/user-interface-types.ts index f773c0cce..d4a9d12b9 100644 --- a/app/ts/types/user-interface-types.ts +++ b/app/ts/types/user-interface-types.ts @@ -33,6 +33,7 @@ export type AddAddressParam = { export type HomeParams = { isActiveAddressChanging: Signal + isActiveAddressChangePending: ReadonlySignal changeActiveAddress: () => void makeCurrentAddressRich: Signal activeAddresses: Signal @@ -75,6 +76,7 @@ export type ChangeActiveAddressParam = { export type FirstCardParams = { isActiveAddressChanging: Signal + isActiveAddressChangePending: ReadonlySignal activeAddress: Signal useSignersAddressAsActiveAddress: Signal activeAddresses: Signal diff --git a/test/tests/backgroundAccountPermissions.test.ts b/test/tests/backgroundAccountPermissions.test.ts index 8762316fa..ba06687dd 100644 --- a/test/tests/backgroundAccountPermissions.test.ts +++ b/test/tests/backgroundAccountPermissions.test.ts @@ -3,6 +3,48 @@ import { describe, test } from 'bun:test' import { addressString, confirmedSignerOwnership, createDeferredValue, createEthereumWithGetBlockCounter, createPort, installBrowserMock, loadModules, noopPublishRpcConnectionStatus, waitForPortMessageCount } from './backgroundEthAccountsTestHarness.js' describe('background eth_accounts', () => { + test('confirms a persisted popup address before slow permission work completes', async () => { + const { runtimeMessages } = installBrowserMock() + const { changeActiveAddress, changeSimulationMode, getSettings, updateUserAddressBookEntries, updateWebsiteAccess } = await loadModules() + const { MessageToPopup } = await import('../../app/ts/types/interceptor-messages.js') + const previousAddress = 1n + const nextAddress = 2n + await changeSimulationMode({ simulationMode: true, activeSimulationAddress: previousAddress }) + await updateUserAddressBookEntries(() => [{ type: 'contact', name: 'Next wallet', address: nextAddress, entrySource: 'User', useAsActiveAddress: true }]) + await updateWebsiteAccess(() => [{ website: { websiteOrigin: 'https://address-switch-test.example' }, access: true, addressAccess: [], declarativeNetRequestBlockMode: 'block-all' }]) + const permissionWorkStarted = createDeferredValue() + const releasePermissionWork = createDeferredValue() + Object.defineProperty(browser.declarativeNetRequest, 'getDynamicRules', { + configurable: true, + value: async () => { + permissionWorkStarted.resolve(undefined) + await releasePermissionWork.promise + return [] + }, + }) + const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + let completed = false + const change = changeActiveAddress(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + method: 'popup_changeActiveAddress', + data: { activeAddress: nextAddress, simulationMode: true, addressChangeRequestId: 'test-switch' }, + }).then((reply) => { completed = true; return reply }) + try { + await permissionWorkStarted.promise + assert.equal(completed, false) + assert.equal((await getSettings()).activeSimulationAddress, nextAddress) + const committed = runtimeMessages.map((message) => MessageToPopup.safeParse(message)).find((parsed) => parsed.success && parsed.value.method === 'popup_settingsUpdated' && parsed.value.committedAddressChange?.requestId === 'test-switch') + assert.ok(committed?.success && committed.value.method === 'popup_settingsUpdated') + if (committed?.success && committed.value.method === 'popup_settingsUpdated') { + assert.equal(committed.value.data.activeSimulationAddress, nextAddress) + assert.equal(committed.value.committedAddressChange?.activeAddress, nextAddress) + } + } finally { + releasePermissionWork.resolve(undefined) + await change + } + assert.equal((await change).ok, true) + }) + test('refreshes the cached signing visualization when selecting another Safe on the same chain', async () => { installBrowserMock() const messages: unknown[] = [] diff --git a/test/tests/homeClearEmptyState.test.ts b/test/tests/homeClearEmptyState.test.ts index fc597907f..6dc163ffe 100644 --- a/test/tests/homeClearEmptyState.test.ts +++ b/test/tests/homeClearEmptyState.test.ts @@ -255,6 +255,7 @@ const createPendingSignedMessageSimulationResults = (): SimulationAndVisualisati function createHomeParams(overrides: Partial = {}): HomeParams { return { isActiveAddressChanging: new Signal(false), + isActiveAddressChangePending: new Signal(false), changeActiveAddress: () => undefined, makeCurrentAddressRich: new Signal(false), activeAddresses: new Signal([activeAddressEntry]), @@ -431,6 +432,24 @@ describe('Home popup clear empty state', () => { }) } + test('shows the committed wallet while keeping further selections disabled until the request finishes', async () => { + const dom = installDomMock() + const pending = new Signal(true) + try { + await act(() => { render(h(Home, createHomeParams({ isActiveAddressChangePending: pending })), dom.document.body) }) + const addressRow = () => collectElements(dom.document.body, 'div').find((element) => element.getAttribute?.('class')?.split(/\s+/).includes('active-address-row')) + assert.equal(addressRow()?.getAttribute?.('aria-busy'), undefined) + assert.equal(addressRow()?.textContent?.includes(activeAddressEntry.name ?? ''), true) + const changeButton = () => collectElements(addressRow(), 'button').find((button) => button.textContent === 'Change') + assert.equal(String(changeButton()?.getAttribute?.('disabled')), 'true') + await act(() => { pending.value = false }) + assert.equal(changeButton()?.getAttribute?.('disabled'), undefined) + } finally { + render(undefined, dom.document.body) + dom.restore() + } + }) + test('shows a skeleton until initial simulation status is known', async () => { const dom = installDomMock() const simulationUpdatingState = new Signal<'done' | 'updating' | 'failed' | undefined>(undefined) diff --git a/test/tests/simulationVisualizerOpen.test.tsx b/test/tests/simulationVisualizerOpen.test.tsx index 5fef68a77..212238a47 100644 --- a/test/tests/simulationVisualizerOpen.test.tsx +++ b/test/tests/simulationVisualizerOpen.test.tsx @@ -3,11 +3,12 @@ import { describe, test } from 'bun:test' import { h, render } from 'preact' import { act } from 'preact/test-utils' import { useLiveSimulationHomeData } from '../../app/ts/components/hooks/useLiveSimulationHomeData.js' +import { App } from '../../app/ts/components/App.js' import { SimulationStackPage } from '../../app/ts/components/pages/SimulationStackPage.js' import { mockSignTransaction } from '../../app/ts/simulation/services/SimulationModeEthereumClientService.js' import { createPassthroughCompleteVisualizedSimulation } from '../../app/ts/types/visualizer-types.js' -import type { BlockTimeManipulation, CompleteVisualizedSimulation, PreSimulationTransaction } from '../../app/ts/types/visualizer-types.js' -import { MessageToPopup, UpdateHomePage, type Settings } from '../../app/ts/types/interceptor-messages.js' +import { CompleteVisualizedSimulation, type BlockTimeManipulation, type PreSimulationTransaction } from '../../app/ts/types/visualizer-types.js' +import { MessageToPopup, PopupMessage, UpdateHomePage, type Settings } from '../../app/ts/types/interceptor-messages.js' import { serialize, type EthereumUnsignedTransaction } from '../../app/ts/types/wire-types.js' import { installDomMock } from './domMock.js' import { getSimulationStackTargetHash } from '../../app/ts/utils/simulationStackTargets.js' @@ -101,6 +102,16 @@ function MainPopupSimulationStateProbe() { return
{ simVisResults.value.kind }
} +function AddressSelectionProbe({ onCommitted }: { onCommitted: (selection: { requestId: string, activeAddress: bigint | undefined }, settings: Settings) => void }) { + const { activeSimulationAddress, simVisResults, simulationUpdatingState } = useLiveSimulationHomeData({ + answerMainPopupOpen: true, + answerSimulationDataConsumerOpen: true, + requestFreshHomeDataOnMount: false, + onAddressSelectionCommitted: onCommitted, + }) + return
{ activeSimulationAddress.value?.toString() }/{ simVisResults.value.kind }/{ simulationUpdatingState.value ?? 'loading' }
+} + function CrossTabStackVisualizerHookProbe() { const { tabState } = useLiveSimulationHomeData({ answerMainPopupOpen: false, @@ -1171,6 +1182,102 @@ describe('simulation visualizer open replies', () => { } }) + test('popup reveals the committed wallet before the address-change reply and preserves later settings', async () => { + const dom = installDomMock() + let finishChange: (reply: unknown) => void = () => undefined + const changeReply = new Promise((resolve) => { finishChange = resolve }) + let requestId: string | undefined + const { listeners } = installBrowserMock((message) => { + const parsed = PopupMessage.safeParse(message) + if (parsed.success && parsed.value.method === 'popup_changeActiveAddress') { + requestId = parsed.value.data.addressChangeRequestId + return changeReply + } + return undefined + }) + try { + await act(() => { render(h(App, {}), dom.document.body) }) + const listener = listeners[0] + if (listener === undefined) throw new Error('Expected a runtime listener') + const initial = createSimulationStackHomePageUpdate(25, 1, 'Simulation popup') + const nextEntry = createRichAddressEntry(2n, 'Next wallet') + await act(() => { + listener({ role: 'all', ...serialize(UpdateHomePage, { ...initial, data: { ...initial.data, activeAddresses: [...initial.data.activeAddresses, nextEntry] } }) }, {}, () => undefined) + }) + await act(async () => { + await clickElement(getButtonByText(dom.document.body, 'Change')) + await new Promise((resolve) => setTimeout(resolve, 0)) + }) + await act(async () => { await import('../../app/ts/components/pages/ChangeActiveAddress.js') }) + const nextCard = collectElements(dom.document.body, 'div').find((element) => element.getAttribute?.('class') === 'card hoverable' && element.textContent?.includes('Next wallet')) + if (nextCard === undefined) throw new Error('Expected the next wallet in the address picker') + await act(async () => { await clickElement(nextCard) }) + assert.ok(requestId) + const addressRow = () => collectElements(dom.document.body, 'div').find((element) => hasClass(element, 'active-address-row')) + assert.equal(addressRow()?.getAttribute?.('aria-label'), 'Switching active address') + await act(() => { + listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: { ...initial.data.settings, activeSimulationAddress: 2n }, popupRefreshGeneration: 3, committedAddressChange: { requestId, activeAddress: 2n } }), {}, () => undefined) + }) + assert.equal(addressRow()?.textContent?.includes('Next wallet'), true) + assert.equal(String(getButtonByText(dom.document.body, 'Change').getAttribute?.('disabled')), 'true') + await act(() => { + listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: initial.data.settings, popupRefreshGeneration: 4 }), {}, () => undefined) + }) + await act(async () => { + finishChange({ type: 'ChangeActiveAddressReply', ok: true }) + await changeReply + await new Promise((resolve) => setTimeout(resolve, 0)) + }) + assert.equal(addressRow()?.textContent?.includes('Simulation address'), true) + assert.equal(getButtonByText(dom.document.body, 'Change').getAttribute?.('disabled'), undefined) + } finally { + finishChange(undefined) + render(undefined, dom.document.body) + dom.restore() + } + }) + + test('reveals committed address settings while withholding stale simulation and older settings', async () => { + const dom = installDomMock() + let finishRefresh: (reply: unknown) => void = () => undefined + const refresh = new Promise((resolve) => { finishRefresh = resolve }) + const { listeners } = installBrowserMock((message) => ( + typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_requestCompleteVisualizedSimulation' + ? refresh : undefined + )) + const confirmations: string[] = [] + try { + await act(() => { render(h(AddressSelectionProbe, { onCommitted: ({ requestId }) => { confirmations.push(requestId) } }), dom.document.body) }) + const listener = listeners[0] + if (listener === undefined) throw new Error('Expected a runtime listener') + const initial = createSimulationStackHomePageUpdate(25, 1, 'Simulation popup') + await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, initial) }, {}, () => undefined) }) + const settings = { ...initial.data.settings, activeSimulationAddress: 2n } + await act(() => { + listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: settings, popupRefreshGeneration: 3, committedAddressChange: { requestId: 'switch-2', activeAddress: 2n } }), {}, () => undefined) + }) + assert.equal(dom.document.body.textContent, '2/passthrough/loading') + assert.deepEqual(confirmations, ['switch-2']) + await act(() => { + listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: initial.data.settings, popupRefreshGeneration: 2, committedAddressChange: { requestId: 'older-switch', activeAddress: initial.data.settings.activeSimulationAddress } }), {}, () => undefined) + listener({ role: 'all', ...serialize(UpdateHomePage, initial) }, {}, () => undefined) + listener(serialize(MessageToPopup, createSimulationStateChangedMessage(initial.data.visualizedSimulatorState)), {}, () => undefined) + }) + assert.equal(dom.document.body.textContent, '2/passthrough/loading') + assert.deepEqual(confirmations, ['switch-2']) + await act(async () => { + finishRefresh({ method: 'popup_requestCompleteVisualizedSimulation', visualizedSimulatorState: serialize(CompleteVisualizedSimulation, createSimulatedCompleteVisualizedSimulation(settings)) }) + await refresh + await new Promise((resolve) => setTimeout(resolve, 0)) + }) + assert.equal(dom.document.body.textContent, '2/simulated/done') + } finally { + finishRefresh(undefined) + render(undefined, dom.document.body) + dom.restore() + } + }) + test('open stack visualizer switches modes immediately when settings change', async () => { const dom = installDomMock() let resolveVisualizationRefresh: ((reply: unknown) => void) | undefined From 895ca808ddf66656beef438adafa9d02a05cc2a8 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 07:08:58 +0000 Subject: [PATCH 03/31] Improve popup mode, RPC, and rich switching feedback --- app/ts/background/activeSettings.ts | 56 +++-- app/ts/background/background-startup.ts | 1 + app/ts/background/popupMessageDispatcher.ts | 16 +- app/ts/background/popupMessageHandlers.ts | 27 ++- app/ts/background/popupSimulationRefresh.ts | 34 +++ app/ts/background/providerMessageHandlers.ts | 18 +- app/ts/background/windows/changeChain.ts | 98 ++++---- app/ts/components/App.tsx | 34 ++- .../hooks/useLiveSimulationHomeData.ts | 3 +- app/ts/components/pages/Home.tsx | 74 ++++-- app/ts/components/popupSettingsChange.ts | 8 + app/ts/simulation/serviceLifecycle.ts | 2 +- app/ts/types/interceptor-messages.ts | 25 +- app/ts/types/interceptor-reply-messages.ts | 39 +++ app/ts/types/user-interface-types.ts | 10 +- test/tests/backgroundSignerLifecycle.test.ts | 7 +- test/tests/homeClearEmptyState.test.ts | 110 ++++++++- test/tests/popupSettingsChanges.test.ts | 223 ++++++++++++++++++ 18 files changed, 643 insertions(+), 142 deletions(-) create mode 100644 app/ts/background/popupSimulationRefresh.ts create mode 100644 app/ts/components/popupSettingsChange.ts create mode 100644 test/tests/popupSettingsChanges.test.ts diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index deaede2d5..90a519b71 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -1,3 +1,4 @@ +import { refreshPopupSimulation } from './popupSimulationRefresh.js' import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' import type { ResetSimulationServices } from '../simulation/serviceLifecycle.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' @@ -10,12 +11,12 @@ import { updatePopupVisualisationIfNeeded } from './popupVisualisationUpdater.js import { bumpPopupRefreshGeneration } from './popupRefreshGeneration.js' import { sendCallbackToConfirmedSignerOwner } from './signerStateOwnership.js' import { changeSimulationMode, getSettings, setUseSignersAddressAsActiveAddress, trackPreviousActiveAddressForMakeMeRichList } from './settings.js' -import { promoteRpcAsPrimary, updateTransactionState } from './storageVariables.js' +import { updateTransactionState } from './storageVariables.js' import type { ActiveAddressSelection } from '../utils/activeAddressSelection.js' import { rememberSigningAddressSelection } from './signingAddressSelection.js' import { activeStackContextsEqual, getActiveStackContext, operationBelongsToActiveStackContext } from '../utils/activeStackContext.js' -export async function resetSimulationStateFromConfig(ethereum: EthereumClientService, tokenPriceService: TokenPriceService) { +async function clearSimulationStateFromConfig() { const settings = await getSettings() const activeStackContext = getActiveStackContext(settings) await updateTransactionState((previousState) => { @@ -42,6 +43,10 @@ export async function resetSimulationStateFromConfig(ethereum: EthereumClientSer ), } }) +} + +export async function resetSimulationStateFromConfig(ethereum: EthereumClientService, tokenPriceService: TokenPriceService) { + await clearSimulationStateFromConfig() await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, false, false) } @@ -86,30 +91,28 @@ export async function changeActiveAddressAndChain( } const updatedSettings = await getSettings() - if (change.addressChangeRequestId !== undefined) { - // Confirm the persisted selection before waiting for website permissions, icons, and simulation work. - await sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: updatedSettings, popupRefreshGeneration: bumpPopupRefreshGeneration(), committedAddressChange: { requestId: change.addressChangeRequestId, activeAddress: change.activeAddress } }) - } - const popupRefreshGeneration = await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, updatedSettings, change.promptForAccessesIfNeeded ?? true) - sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: updatedSettings, popupRefreshGeneration }) - sendPopupMessageToOpenWindows({ method: 'popup_accounts_update' }) + const rpcChainChanged = previousSettings.activeRpcNetwork.chainId !== updatedSettings.activeRpcNetwork.chainId + const rpcEndpointChanged = rpcChainChanged || previousSettings.activeRpcNetwork.httpsRpc !== updatedSettings.activeRpcNetwork.httpsRpc + const activeServices = rpcEndpointChanged && change.rpcNetwork?.httpsRpc !== undefined + ? resetSimulationServices(change.rpcNetwork) ?? { ethereum, tokenPriceService } + : { ethereum, tokenPriceService } + if (updatedSettings.simulationMode && rpcChainChanged) await clearSimulationStateFromConfig() + // Publish only after the selected provider and stack are ready for requests using the new settings. + await sendPopupMessageToOpenWindows({ + method: 'popup_settingsUpdated', data: updatedSettings, popupRefreshGeneration: bumpPopupRefreshGeneration(), + ...(change.addressChangeRequestId === undefined ? {} : { committedAddressChange: { requestId: change.addressChangeRequestId, activeAddress: change.activeAddress } }), + }) + const popupRefreshGeneration = await updateWebsiteApprovalAccesses(activeServices.ethereum, activeServices.tokenPriceService, resetSimulationServices, websiteTabConnections, updatedSettings, change.promptForAccessesIfNeeded ?? true) + await sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: updatedSettings, popupRefreshGeneration }) + await sendPopupMessageToOpenWindows({ method: 'popup_accounts_update' }) await changeActiveAddressAndChainSemaphore.execute(async () => { - const activeSigningSafeContextChanged = !updatedSettings.simulationMode - && updatedSettings.activeSigningSafeAddress !== undefined - && !activeStackContextsEqual(getActiveStackContext(previousSettings), getActiveStackContext(updatedSettings)) - if (change.rpcNetwork !== undefined) { - const rpcChainChanged = previousSettings.activeRpcNetwork.chainId !== change.rpcNetwork.chainId - if (change.rpcNetwork.httpsRpc !== undefined) resetSimulationServices(change.rpcNetwork) - sendMessageToApprovedWebsitePorts(websiteTabConnections, { method: 'chainChanged', result: change.rpcNetwork.chainId }) - sendPopupMessageToOpenWindows({ method: 'popup_chain_update' }) - - if (updatedSettings.simulationMode && rpcChainChanged) { - await resetSimulationStateFromConfig(ethereum, tokenPriceService) - } else if (updatedSettings.simulationMode) { - await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, false, false) - } + if (rpcChainChanged) { + sendMessageToApprovedWebsitePorts(websiteTabConnections, { method: 'chainChanged', result: updatedSettings.activeRpcNetwork.chainId }) + await sendPopupMessageToOpenWindows({ method: 'popup_chain_update' }) + } + if (rpcEndpointChanged || !activeStackContextsEqual(getActiveStackContext(previousSettings), getActiveStackContext(updatedSettings))) { + await refreshPopupSimulation(activeServices) } - if (activeSigningSafeContextChanged) await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, false, false) await sendActiveAccountChangeToApprovedWebsitePorts(websiteTabConnections, await getSettings()) }) } @@ -155,6 +158,10 @@ export async function activateAddressSelection( } export async function changeActiveRpc(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, simulationMode: boolean, signerTabId: number | undefined) { + const currentRpc = (await getSettings()).activeRpcNetwork + if (currentRpc.chainId === rpcNetwork.chainId && currentRpc.httpsRpc === rpcNetwork.httpsRpc) { + return simulationMode ? { type: 'completedLocally' as const } : { type: 'signerRequestNotNeeded' as const } + } if (simulationMode) { await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { simulationMode, rpcNetwork }) return { type: 'completedLocally' as const } @@ -168,7 +175,6 @@ export async function changeActiveRpc(ethereum: EthereumClientService, tokenPric const settings = await getSettings() const popupRefreshGeneration = bumpPopupRefreshGeneration() await sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: settings, popupRefreshGeneration }) - await promoteRpcAsPrimary(rpcNetwork) return signerStateToken === false ? { type: 'signerUnavailable' as const } : { type: 'signerRequestSent' as const, signerStateToken } diff --git a/app/ts/background/background-startup.ts b/app/ts/background/background-startup.ts index 9f2a90bd3..78f2f51fa 100644 --- a/app/ts/background/background-startup.ts +++ b/app/ts/background/background-startup.ts @@ -279,6 +279,7 @@ async function startup() { simulationServices = createSimulationServices(simulatorNetwork, newBlockAttemptCallback, onErrorBlockCallback, 60000, rpcRequestLifecycleCallbacks) resetActiveRpcNetwork = (rpcNetwork) => { simulationServices = resetSimulationServices(getSimulationServices(), rpcNetwork, newBlockAttemptCallback, onErrorBlockCallback, rpcRequestLifecycleCallbacks) + return simulationServices } await recoverPendingTerminalState() const recursiveCheckIfInterceptorShouldSleep = async () => { diff --git a/app/ts/background/popupMessageDispatcher.ts b/app/ts/background/popupMessageDispatcher.ts index 13d0bd9f3..30fe3343c 100644 --- a/app/ts/background/popupMessageDispatcher.ts +++ b/app/ts/background/popupMessageDispatcher.ts @@ -1,9 +1,9 @@ +import { refreshPopupSimulation } from './popupSimulationRefresh.js' import type { PopupMessage } from '../types/interceptor-messages.js' import type { PopupReplyOption } from '../types/interceptor-reply-messages.js' import { getSimulationStackTargetHash } from '../utils/simulationStackTargets.js' import { setLatestUnexpectedError } from './storageVariables.js' import { bumpPopupRefreshGeneration } from './popupRefreshGeneration.js' -import { updatePopupVisualisationIfNeeded } from './popupVisualisationUpdater.js' import { changeActiveAddress, changeChainDialog, changePage, changePreSimulationBlockTimeManipulation, confirmDialog, enableSimulationMode, fetchSimulationStackRequestConfirmation, forceSetGasLimitForTransaction, importSafeStack, importSimulationStack, modifyMakeMeRich, openNewTab, openWebPage, popupReadyAndListening, refreshHomeData, refreshPopupConfirmTransactionMetadata, refreshPopupConfirmTransactionSimulation, removeTransactionOrSignedMessage, reportUnexpectedErrorInWindow, requestAccountsFromSigner, requestActiveAddresses, requestCompleteVisualizedSimulation, requestHomePageBootstrap, requestInterceptorSimulationInput, requestLatestUnexpectedError, requestMakeMeRichList, requestNewHomeData, requestSafeStackExport, requestSimulationMetadata, requestSimulationMode, setSafeSimulationSigner, setTransactionOrMessageBlockTimeManipulator, simulateGnosisSafeTransactionOnPass, simulateGovernanceContractExecutionOnPass, watchAssetDialog } from './popupMessageHandlers.js' import { popupMessageHandler, type PopupMessageDispatcherContext, type PopupMessageHandlerMap } from './popupMessageHandlerRegistry.js' import { addressBookPopupMessageHandlers } from './popupMessageHandlerRegistries/addressBook.js' @@ -16,19 +16,27 @@ export type { PopupMessageDispatcherContext } from './popupMessageHandlerRegistr const popupMessageHandlers = { popup_confirmDialog: popupMessageHandler('popup_confirmDialog', async (context, request) => await confirmDialog(context.ethereum, context.tokenPriceService, context.websiteTabConnections, request)), popup_changeActiveAddress: popupMessageHandler('popup_changeActiveAddress', async (context, request) => await changeActiveAddress(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), - popup_modifyMakeMeRich: popupMessageHandler('popup_modifyMakeMeRich', async (_context, request) => await modifyMakeMeRich(request)), + popup_modifyMakeMeRich: popupMessageHandler('popup_modifyMakeMeRich', async (context, request) => { + if (await modifyMakeMeRich(request) && !await refreshPopupSimulation({ ethereum: context.ethereum, tokenPriceService: context.tokenPriceService, invalidateOldState: true })) { + return { type: 'PopupSettingsChangeReply', ok: false, message: 'The rich setting was saved, but balances could not be refreshed. Please refresh the simulation to retry.' } + } + return { type: 'PopupSettingsChangeReply', ok: true } + }), popup_changePage: popupMessageHandler('popup_changePage', async (_context, request) => await changePage(request)), popup_requestAccountsFromSigner: popupMessageHandler('popup_requestAccountsFromSigner', async (context, request) => await requestAccountsFromSigner(context.websiteTabConnections, request)), popup_resetSimulation: popupMessageHandler('popup_resetSimulation', async (context) => await context.resetSimulationState()), popup_removeTransactionOrSignedMessage: popupMessageHandler('popup_removeTransactionOrSignedMessage', async (context, request) => await removeTransactionOrSignedMessage(context.ethereum, context.tokenPriceService, request)), popup_refreshSimulation: popupMessageHandler('popup_refreshSimulation', async (context) => { - await updatePopupVisualisationIfNeeded(context.ethereum, context.tokenPriceService, false, false, true) + await refreshPopupSimulation({ ...context, invalidateOldState: true }) }), popup_refreshConfirmTransactionDialogSimulation: popupMessageHandler('popup_refreshConfirmTransactionDialogSimulation', async (context) => await refreshPopupConfirmTransactionSimulation(context.ethereum, context.tokenPriceService)), popup_refreshConfirmTransactionMetadata: popupMessageHandler('popup_refreshConfirmTransactionMetadata', async (context) => await refreshPopupConfirmTransactionMetadata(context.ethereum, context.tokenPriceService, context.confirmTransactionAbortController)), popup_changeChainDialog: popupMessageHandler('popup_changeChainDialog', async (context, request) => await changeChainDialog(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), popup_watchAssetDialog: popupMessageHandler('popup_watchAssetDialog', async (context, request) => await watchAssetDialog(context.websiteTabConnections, request)), - popup_enableSimulationMode: popupMessageHandler('popup_enableSimulationMode', async (context, request) => await enableSimulationMode(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), + popup_enableSimulationMode: popupMessageHandler('popup_enableSimulationMode', async (context, request) => { + await enableSimulationMode(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request) + return { type: 'PopupSettingsChangeReply', ok: true } + }), popup_setSafeSimulationSigner: popupMessageHandler('popup_setSafeSimulationSigner', async (context, request) => await setSafeSimulationSigner(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), popup_requestNewHomeData: popupMessageHandler('popup_requestNewHomeData', async (context, request) => await requestNewHomeData(context.ethereum, context.websiteTabConnections, request.data.refreshSignerAccounts, request.data.includeWebsiteAccessAddressMetadata, context.simulationAbortController, bumpPopupRefreshGeneration())), popup_requestHomePageBootstrap: popupMessageHandler('popup_requestHomePageBootstrap', async (context) => await requestHomePageBootstrap(context.websiteTabConnections, bumpPopupRefreshGeneration())), diff --git a/app/ts/background/popupMessageHandlers.ts b/app/ts/background/popupMessageHandlers.ts index ed6a9dc69..550d69e40 100644 --- a/app/ts/background/popupMessageHandlers.ts +++ b/app/ts/background/popupMessageHandlers.ts @@ -1,3 +1,4 @@ +import { refreshPopupSimulation } from './popupSimulationRefresh.js' import { refreshConfirmTransactionSimulation } from './confirmTransactionSimulation.js' import { activateAddressSelection, changeActiveAddressAndChain, changeActiveRpc } from './activeSettings.js' import { getUpdatedSimulationStackSnapshot, getUpdatedSimulationState } from './simulationUpdating.js' @@ -7,7 +8,7 @@ import { parseEvents, parseInputData } from '../simulation/parsing.js' import { type ChangeActiveAddress, type ModifyMakeMeRich, type ChangePage, type RemoveTransaction, type RequestAccountsFromSigner, type TransactionConfirmation, type InterceptorAccess, type ChangeInterceptorAccess, type ChainChangeConfirmation, type WatchAssetConfirmation, type EnableSimulationMode, type ChangeActiveChain, type AddOrEditAddressBookEntry, type GetAddressBookData, type RemoveAddressBookEntry, type InterceptorAccessRefresh, type InterceptorAccessChangeAddress, type Settings, type ChangeSettings, type UpdateHomePage, type SimulateGovernanceContractExecution, type ChangeAddOrModifyAddressWindowState, type OpenWebPage, type SetEnsNameForHash, UpdateConfirmTransactionDialog, UpdateConfirmTransactionDialogPendingTransactions, type ForceSetGasLimitForTransaction, type ChangePreSimulationBlockTimeManipulation, type SetTransactionOrMessageBlockTimeManipulator, type FetchSimulationStackRequestConfirmation, type ImportSimulationStack, type PopupReadyAndListeningPage } from '../types/interceptor-messages.js' import { formEthSendTransaction, formSendRawTransaction, resolvePendingTransactionOrMessage, updateConfirmTransactionView, setGasLimitForTransaction, toPopupPendingTransactionOrSignableMessage } from './windows/confirmTransaction.js' import { askForSignerAccountsFromSignerIfNotAvailable, getAddressMetadataForAccess, refreshSignerAccountsForTab, refreshSignerAccountsFromApprovedWebsitePorts, requestAddressChange, resolveInterceptorAccess, type SignerAccountRefreshOptions } from './windows/interceptorAccess.js' -import { resolveChainChange } from './windows/changeChain.js' +import { requestSignerChainChange, resolveChainChange } from './windows/changeChain.js' import { updateWebsiteApprovalAccesses } from './accessManagement.js' import { getActiveOrFirstSignerAddress, getHtmlFile, sendPopupMessageToOpenWindows } from './backgroundUtils.js' import { getActiveAddressForCurrentSignerState, sendCallbackToAllConfirmedSignerOwners, sendCallbackToConfirmedSignerOwner } from './signerStateOwnership.js' @@ -58,7 +59,7 @@ export { exportSettings, importSettings, setNewRpcList, settingsOpened } from '. export { allowOrPreventAddressAccessForWebsite, blockOrAllowExternalRequests, disableInterceptor, reloadConnectedTabs, removeWebsiteAccess, removeWebsiteAddressAccess, retrieveWebsiteAccess } from './popupMessageHandlers/websiteAccess.js' import { getLastKnownCurrentTabId } from './currentTab.js' import { disableInterceptorForPage } from './popupMessageHandlers/websiteAccess.js' -import { getConfiguredSigningSafeForChain } from './signingAddressSelection.js' +import { getConfiguredSigningSafe, getConfiguredSigningSafeForChain } from './signingAddressSelection.js' type TimestampedPopupVisualisation = { data: { @@ -259,11 +260,10 @@ export async function changeActiveAddress(ethereum: EthereumClientService, token export async function modifyMakeMeRich(makeMeRichChange: ModifyMakeMeRich) { if (makeMeRichChange.data.address === 'CurrentAddress') { - await updateMakeCurrentAddressRich(() => makeMeRichChange.data.add) - return + return await updateMakeCurrentAddressRich(() => makeMeRichChange.data.add) } const address = makeMeRichChange.data.address - await updateFixedMakeMeRichList((currentList) => updateRichListAddress( + return await updateFixedMakeMeRichList((currentList) => updateRichListAddress( currentList, address, makeMeRichChange.data.add, @@ -667,7 +667,18 @@ export async function refreshPopupConfirmTransactionSimulation(ethereum: Ethereu } export async function popupChangeActiveRpc(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, params: ChangeActiveChain, settings: Settings) { - await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, params.data, settings.simulationMode, await getLastKnownCurrentTabId()) + if (!settings.simulationMode && params.data.chainId !== settings.activeRpcNetwork.chainId) { + const tabId = await getLastKnownCurrentTabId() + if (tabId === undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: 'No wallet is connected to switch networks.' } as const + if (await getConfiguredSigningSafe(settings, (await getTabState(tabId)).signerAccounts) !== undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: 'This Safe is tied to its current network. Select your wallet account before switching networks.' } as const + const result = await requestSignerChainChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, params.data, tabId) + if ('error' in result && result.error !== undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: result.error.message } as const + const activeRpc = (await getSettings()).activeRpcNetwork + if (activeRpc.chainId !== params.data.chainId || activeRpc.httpsRpc !== params.data.httpsRpc) return { type: 'PopupSettingsChangeReply', ok: false, message: 'The wallet switched networks, but the active Interceptor network did not change. Please select the network again.' } as const + } else { + await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, params.data, settings.simulationMode, await getLastKnownCurrentTabId()) + } + return { type: 'PopupSettingsChangeReply', ok: true } as const } export async function changeChainDialog(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, chainChange: ChainChangeConfirmation) { @@ -683,6 +694,7 @@ export async function enableSimulationMode( signerAccountRefreshOptions: SignerAccountRefreshOptions = {}, ) { const settings = await getSettings() + if (settings.simulationMode === params.data) return // if we are on unsupported chain, force change to a supported one if (settings.useSignersAddressAsActiveAddress || params.data === false) { const tabId = await getLastKnownCurrentTabId() @@ -1274,7 +1286,8 @@ export async function importSimulationStack(ethereum: EthereumClientService, tok } export async function requestCompleteVisualizedSimulation(ethereum: EthereumClientService, tokenPriceService: TokenPriceService) { - const visualizedSimulatorState = await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, false, false, true) + await refreshPopupSimulation({ ethereum, tokenPriceService }) + const visualizedSimulatorState = await getPopupVisualisationState() return { method: 'popup_requestCompleteVisualizedSimulation' as const, visualizedSimulatorState } } diff --git a/app/ts/background/popupSimulationRefresh.ts b/app/ts/background/popupSimulationRefresh.ts new file mode 100644 index 000000000..4830ec2c4 --- /dev/null +++ b/app/ts/background/popupSimulationRefresh.ts @@ -0,0 +1,34 @@ +import type { SimulationServices } from '../simulation/serviceLifecycle.js' +import { updatePopupVisualisationIfNeeded } from './popupVisualisationUpdater.js' + +export type PopupSimulationRefresh = SimulationServices & { readonly invalidateOldState?: boolean } + +// All callers await the same drain; updates arriving during a refresh trigger one follow-up with the latest services. +export function createPopupSimulationRefresher(refresh: (services: PopupSimulationRefresh) => Promise) { + let pendingServices: PopupSimulationRefresh | undefined + let running: Promise | undefined + return (services: PopupSimulationRefresh): Promise => { + pendingServices = { ...services, invalidateOldState: services.invalidateOldState || pendingServices?.invalidateOldState } + if (running !== undefined) return running + running = Promise.resolve().then(async () => { + try { + let refreshed = true + while (pendingServices !== undefined) { + const currentServices = pendingServices + pendingServices = undefined + refreshed = await refresh(currentServices) + } + return refreshed + } finally { + pendingServices = undefined + running = undefined + } + }) + return running + } +} + +export const refreshPopupSimulation = createPopupSimulationRefresher(async ({ ethereum, tokenPriceService, invalidateOldState = false }) => { + const result = await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, invalidateOldState, false, !invalidateOldState) + return result.simulationUpdatingState !== 'failed' && result.simulationResultState !== 'invalid' +}) diff --git a/app/ts/background/providerMessageHandlers.ts b/app/ts/background/providerMessageHandlers.ts index 3746bde81..b6a9a3e0b 100644 --- a/app/ts/background/providerMessageHandlers.ts +++ b/app/ts/background/providerMessageHandlers.ts @@ -1,11 +1,12 @@ +import type { RpcNetwork } from '../types/rpc.js' import { ConnectedToSigner, SignerReply, WalletSwitchEthereumChainReply, WatchAssetSignerRequest } from '../types/interceptor-messages.js' import type { TabState, WebsiteTabConnections } from '../types/user-interface-types.js' import { EthereumAccountsReply, EthereumChainReply } from '../types/JsonRpc-types.js' import { activateAddressSelection, changeActiveAddressAndChain } from './activeSettings.js' import { getSocketFromPort, sendInternalWindowMessage, sendPopupMessageToOpenWindows } from './backgroundUtils.js' -import { getRpcNetworkForChain, setDefaultSignerName, updatePendingTransactionOrMessage, updateTabState } from './storageVariables.js' +import { getRpcNetworkForChain, promoteRpcAsPrimary, setDefaultSignerName, updatePendingTransactionOrMessage, updateTabState } from './storageVariables.js' import { getMetamaskCompatibilityMode, getSettings } from './settings.js' -import { getPendingSignerChainChangeTokenForCallback, isPendingSignerChainChangeReply, resolveSignerChainChange } from './windows/changeChain.js' +import { getPendingSignerChainChangeRpc, getPendingSignerChainChangeTokenForCallback, isPendingSignerChainChangeReply, resolveSignerChainChange } from './windows/changeChain.js' import { type ApprovalState, withSuppressedUnscopedConnectionEventsForSocketAsync } from './accessManagement.js' import type { ProviderMessage } from '../utils/requests.js' import { METAMASK_ERROR_USER_REJECTED_REQUEST } from '../utils/constants.js' @@ -124,7 +125,7 @@ export async function ethAccountsReply(ethereum: EthereumClientService, tokenPri }) } -async function changeSignerChain(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, signerStateToken: SignerStateToken, signerChain: bigint, approval: ApprovalState) { +async function changeSignerChain(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, signerStateToken: SignerStateToken, signerChain: bigint, approval: ApprovalState, requestedRpcNetwork?: RpcNetwork) { if (approval !== 'hasAccess') return const tabStateChange = await updateTabState(signerStateToken.socket.tabId, (previousState: TabState) => { return previousState.signerChain === signerChain ? previousState : modifyObject(previousState, { signerChain }) @@ -142,8 +143,8 @@ async function changeSignerChain(ethereum: EthereumClientService, tokenPriceServ } return } - if ((settings.useSignersAddressAsActiveAddress || !settings.simulationMode) && settings.activeRpcNetwork.chainId !== signerChain) { - const rpcNetwork = await getRpcNetworkForChain(signerChain) + if ((settings.useSignersAddressAsActiveAddress || !settings.simulationMode) && (settings.activeRpcNetwork.chainId !== signerChain || (requestedRpcNetwork !== undefined && settings.activeRpcNetwork.httpsRpc !== requestedRpcNetwork.httpsRpc))) { + const rpcNetwork = requestedRpcNetwork ?? await getRpcNetworkForChain(signerChain) const signerAddress = getWalletSelectedAccount(tabStateChange.newState) return changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { simulationMode: settings.simulationMode, @@ -192,7 +193,12 @@ export async function walletSwitchEthereumChainReply(ethereum: EthereumClientSer }) return returnValue } - if (params.accept) await changeSignerChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, currentSignerStateToken, params.chainId, 'hasAccess') + if (params.accept) { + const requestedRpc = getPendingSignerChainChangeRpc(callbackSignerStateToken, params.chainId) + await changeSignerChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, currentSignerStateToken, params.chainId, 'hasAccess', requestedRpc) + const activeRpc = (await getSettings()).activeRpcNetwork + if (requestedRpc !== undefined && activeRpc.chainId === requestedRpc.chainId && activeRpc.httpsRpc === requestedRpc.httpsRpc) await promoteRpcAsPrimary(requestedRpc) + } resolveSignerChainChange(callbackSignerStateToken, { method: 'popup_signerChangeChainDialog', data: [params], diff --git a/app/ts/background/windows/changeChain.ts b/app/ts/background/windows/changeChain.ts index 33fc444fa..6b86921f6 100644 --- a/app/ts/background/windows/changeChain.ts +++ b/app/ts/background/windows/changeChain.ts @@ -24,7 +24,7 @@ type PendingSignerChainChange = { | { readonly type: 'replacement', readonly error: typeof signerUnavailableError } > readonly requestTabId: number - readonly requestedChainId: bigint + readonly requestedRpcNetwork: RpcNetwork signerStateToken: SignerStateToken | undefined readonly repliesBeforeToken: Array<{ readonly signerStateToken: SignerStateToken, readonly confirmation: SignerChainChangeConfirmation }> readonly replacementsBeforeToken: Array<{ readonly signerStateToken: SignerStateToken, readonly error: typeof signerUnavailableError }> @@ -71,7 +71,7 @@ async function runExclusiveChainChangeResolution(resolution: () => Promise } function doesPendingSignerChainChangeMatch(pending: PendingSignerChainChange, signerStateToken: SignerStateToken, chainId: bigint) { - if (pending.requestedChainId !== chainId) return false + if (pending.requestedRpcNetwork.chainId !== chainId) return false return pending.signerStateToken === undefined ? pending.requestTabId === signerStateToken.socket.tabId : doSignerStateTokensMatch(pending.signerStateToken, signerStateToken) @@ -79,7 +79,7 @@ function doesPendingSignerChainChangeMatch(pending: PendingSignerChainChange, si export function getPendingSignerChainChangeTokenForCallback(port: browser.runtime.Port, signerProviderGeneration: number, chainId: bigint) { const signerStateToken = pendingSignerChainChange?.signerStateToken - if (signerStateToken === undefined || pendingSignerChainChange?.requestedChainId !== chainId) return undefined + if (signerStateToken === undefined || pendingSignerChainChange?.requestedRpcNetwork.chainId !== chainId) return undefined if (signerStateToken.port !== port || signerStateToken.signerProviderGeneration !== signerProviderGeneration) return undefined return signerStateToken } @@ -88,6 +88,12 @@ export function isPendingSignerChainChangeReply(signerStateToken: SignerStateTok return pendingSignerChainChange !== undefined && doesPendingSignerChainChangeMatch(pendingSignerChainChange, signerStateToken, chainId) } +// Keep the requested endpoint in memory until the matching wallet accepts; a rejected request must not change RPC preferences. +export function getPendingSignerChainChangeRpc(signerStateToken: SignerStateToken, chainId: bigint) { + const pending = pendingSignerChainChange + return pending !== undefined && doesPendingSignerChainChangeMatch(pending, signerStateToken, chainId) ? pending.requestedRpcNetwork : undefined +} + export function resolveSignerChainChange(signerStateToken: SignerStateToken, confirmation: SignerChainChangeConfirmation) { const pending = pendingSignerChainChange if (pending === undefined || !doesPendingSignerChainChangeMatch(pending, signerStateToken, confirmation.data[0].chainId)) return false @@ -192,48 +198,54 @@ async function resolve(ethereum: EthereumClientService, tokenPriceService: Token await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, reply.data.rpcNetwork, simulationMode, reply.data.uniqueRequestIdentifier.requestSocket.tabId) return { result: null } } - const pending: PendingSignerChainChange = { - future: new Future< - | { readonly type: 'reply', readonly confirmation: SignerChainChangeConfirmation } - | { readonly type: 'replacement', readonly error: typeof signerUnavailableError } - >(), - requestTabId: reply.data.uniqueRequestIdentifier.requestSocket.tabId, - requestedChainId: reply.data.rpcNetwork.chainId, - signerStateToken: undefined, - repliesBeforeToken: [], - replacementsBeforeToken: [], + return await requestSignerChainChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, reply.data.rpcNetwork, reply.data.uniqueRequestIdentifier.requestSocket.tabId) + } + return userDeniedChange +} + +export async function requestSignerChainChange(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, requestTabId: number) { + if (pendingSignerChainChange !== undefined) return { error: { code: -32002, message: 'A network switch is already waiting for your wallet.' } } + const pending: PendingSignerChainChange = { + future: new Future< + | { readonly type: 'reply', readonly confirmation: SignerChainChangeConfirmation } + | { readonly type: 'replacement', readonly error: typeof signerUnavailableError } + >(), + requestTabId: requestTabId, + requestedRpcNetwork: rpcNetwork, + signerStateToken: undefined, + repliesBeforeToken: [], + replacementsBeforeToken: [], + } + const removeReplacementListener = addSignerStateReplacementListener((signerStateToken, error) => { + if (pending.signerStateToken === undefined) { + pending.replacementsBeforeToken.push({ signerStateToken, error }) + return + } + if (doSignerStateTokensMatch(pending.signerStateToken, signerStateToken)) pending.future.resolve({ type: 'replacement', error }) + }) + pendingSignerChainChange = pending + try { + const changeActiveRpcResult = await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, rpcNetwork, false, requestTabId) + if (changeActiveRpcResult.type !== 'signerRequestSent') { + return changeActiveRpcResult.type === 'signerRequestNotNeeded' + ? { result: null } as const + : { error: signerUnavailableError } as const } - const removeReplacementListener = addSignerStateReplacementListener((signerStateToken, error) => { - if (pending.signerStateToken === undefined) { - pending.replacementsBeforeToken.push({ signerStateToken, error }) - return - } - if (doSignerStateTokensMatch(pending.signerStateToken, signerStateToken)) pending.future.resolve({ type: 'replacement', error }) + pending.signerStateToken = changeActiveRpcResult.signerStateToken + const precedingReply = pending.repliesBeforeToken.find(({ signerStateToken, confirmation }) => { + return doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, signerStateToken) + && confirmation.data[0].chainId === pending.requestedRpcNetwork.chainId }) - pendingSignerChainChange = pending - try { - const changeActiveRpcResult = await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, reply.data.rpcNetwork, simulationMode, reply.data.uniqueRequestIdentifier.requestSocket.tabId) - if (changeActiveRpcResult.type !== 'signerRequestSent') { - return changeActiveRpcResult.type === 'signerRequestNotNeeded' - ? { result: null } as const - : { error: signerUnavailableError } as const - } - pending.signerStateToken = changeActiveRpcResult.signerStateToken - const precedingReply = pending.repliesBeforeToken.find(({ signerStateToken, confirmation }) => { - return doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, signerStateToken) - && confirmation.data[0].chainId === pending.requestedChainId - }) - if (precedingReply !== undefined) pending.future.resolve({ type: 'reply', confirmation: precedingReply.confirmation }) - const precedingReplacement = pending.replacementsBeforeToken.find(({ signerStateToken }) => doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, signerStateToken)) - if (precedingReplacement !== undefined) pending.future.resolve({ type: 'replacement', error: precedingReplacement.error }) - const signerResult = await pending.future - if (signerResult.type === 'replacement') return { error: signerResult.error } as const - if (signerResult.confirmation.data[0].accept === false) return { error: signerResult.confirmation.data[0].error } as const // forward signers error to the application - if (signerResult.confirmation.data[0].chainId === reply.data.rpcNetwork.chainId) return { result: null } - } finally { - removeReplacementListener() - if (pendingSignerChainChange === pending) pendingSignerChainChange = undefined - } + if (precedingReply !== undefined) pending.future.resolve({ type: 'reply', confirmation: precedingReply.confirmation }) + const precedingReplacement = pending.replacementsBeforeToken.find(({ signerStateToken }) => doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, signerStateToken)) + if (precedingReplacement !== undefined) pending.future.resolve({ type: 'replacement', error: precedingReplacement.error }) + const signerResult = await pending.future + if (signerResult.type === 'replacement') return { error: signerResult.error } as const + if (signerResult.confirmation.data[0].accept === false) return { error: signerResult.confirmation.data[0].error } as const // forward signers error to the application + if (signerResult.confirmation.data[0].chainId === rpcNetwork.chainId) return { result: null } + } finally { + removeReplacementListener() + if (pendingSignerChainChange === pending) pendingSignerChainChange = undefined } return userDeniedChange } diff --git a/app/ts/components/App.tsx b/app/ts/components/App.tsx index e40373084..98d086f2e 100644 --- a/app/ts/components/App.tsx +++ b/app/ts/components/App.tsx @@ -20,7 +20,9 @@ import { useLiveSimulationHomeData } from './hooks/useLiveSimulationHomeData.js' import { NetworkErrors } from './subcomponents/NetworkErrors.js' import { ProviderErrors } from './subcomponents/ProviderErrors.js' import { PopupModal, type PopupPage } from './PopupModal.js' -import { getSelectableActiveAddresses, includePersistedAddressBookEntry, isActiveAddressSelectionAllowed, isSignerConnectedForMode } from '../utils/activeAddressSelection.js' +import { getSelectableActiveAddresses, includePersistedAddressBookEntry, isActiveAddressSelectionAllowed } from '../utils/activeAddressSelection.js' +import { requestPopupSettingsChange } from './popupSettingsChange.js' +import type { ChangeActiveChain, EnableSimulationMode, ModifyMakeMeRich } from '../types/interceptor-reply-messages.js' import { requestActiveAddressChange } from './activeAddressChange.js' import { useModeActiveAddress } from './hooks/useModeActiveAddress.js' export { NetworkErrors } from './subcomponents/NetworkErrors.js' @@ -29,6 +31,7 @@ export function App() { const appPage = useSignal({ page: 'Unknown' }) const pendingAddressChangeRequestId = useSignal(undefined) const isActiveAddressChanging = useSignal(false) + const pendingSettingsChange = useSignal(false) const { activeAddresses, walletSelectedAddressBookEntry, @@ -79,9 +82,10 @@ export function App() { }) const boundaryResetKey = useSignal(0) const isActiveAddressChangePending = useComputed(() => pendingAddressChangeRequestId.value !== undefined) + const isSettingsChangePending = useComputed(() => isActiveAddressChangePending.value || pendingSettingsChange.value) async function setActiveAddressAndInformAboutIt(address: bigint | 'signer', persistedEntry?: AddressBookEntry) { - if (!isSettingsLoaded.value || isActiveAddressChangePending.value) return + if (!isSettingsLoaded.value || isSettingsChangePending.value) return const selectableAddresses = includePersistedAddressBookEntry(activeAddresses.value, persistedEntry) if (!isActiveAddressSelectionAllowed(address, selectableAddresses, simulationMode.value, rpcNetwork.value?.chainId, tabState.value?.signerAccounts ?? [])) return const requestId = crypto.randomUUID() @@ -99,17 +103,26 @@ export function App() { } } - function isSignerConnected() { - return isSignerConnectedForMode(simulationMode.value, activeSimulationAddress.value, tabState.value) + async function changePopupSettings(message: ChangeActiveChain | EnableSimulationMode | ModifyMakeMeRich) { + if (!isSettingsLoaded.value || isSettingsChangePending.value) return + pendingSettingsChange.value = true + try { + await requestPopupSettingsChange(message) + } finally { + pendingSettingsChange.value = false + } } async function setActiveRpcAndInformAboutIt(entry: RpcEntry) { - if (!isSettingsLoaded.value) return - sendPopupMessageToBackgroundPage({ method: 'popup_changeActiveRpc', data: entry }) - if(!isSignerConnected()) { - rpcNetwork.value = entry - } + await changePopupSettings({ method: 'popup_changeActiveRpc', data: entry }) + } + async function setSimulationMode(enabled: boolean) { + await changePopupSettings({ method: 'popup_enableSimulationMode', data: enabled }) } + async function setRichState(add: boolean, address: bigint | 'CurrentAddress') { + await changePopupSettings({ method: 'popup_modifyMakeMeRich', data: { add, address } }) + } + useEffect(() => { markPerformanceOnce(POPUP_PERFORMANCE_MARKS.homeFirstCommit) }, []) @@ -264,6 +277,9 @@ export function App() { () const simulatingPending = setSimulatingState.value.state === 'pending' const signingPending = setSigningState.value.state === 'pending' + const { value: rpcChangeState, waitFor: waitForRpcChange } = useAsyncState() + const requestedRpc = useSignal(undefined) + const rpcPending = rpcChangeState.value.state === 'pending' + const controlsDisabled = !param.isInitialHomeDataLoaded.value || param.isSettingsChangePending.value || simulatingPending || signingPending || rpcPending + const changeRpc = (entry: RpcEntry) => { + if (controlsDisabled || entry.httpsRpc === param.rpcNetwork.value?.httpsRpc) return + requestedRpc.value = entry + void waitForRpcChange(async () => { await param.changeActiveRpc(entry) }) + } async function enableSimulationMode(enabled: boolean ) { - if (!param.isInitialHomeDataLoaded.value) return - await sendPopupMessageToBackgroundPage( { method: 'popup_enableSimulationMode', data: enabled } ) + if (controlsDisabled) return + await param.setSimulationMode(enabled) } const enableSimulating = () => { void waitForSetSimulating(() => enableSimulationMode(true)) @@ -276,10 +286,10 @@ function FirstCardHeader(param: FirstCardParams) { class = { `button is-primary ${ param.simulationMode.value ? '' : 'is-outlined' }` } style = { `margin-bottom: 0px; border-color: transparent; ${ param.simulationMode.value ? 'opacity: 1;' : '' }` } state = { setSimulatingState.value.state } - disabled = { param.simulationMode.value || signingPending || !param.isInitialHomeDataLoaded.value } + disabled = { param.simulationMode.value || controlsDisabled } keepTextWhilePending = { true } pendingIndicatorPlacement = 'overlay' - pendingText = 'Switching to simulating mode...' + pendingText = { param.simulationMode.value ? 'Refreshing simulation...' : 'Switching to simulating mode...' } text = 'Simulating' onClick = { enableSimulating } /> @@ -287,19 +297,23 @@ function FirstCardHeader(param: FirstCardParams) { class = { `button is-primary ${ param.simulationMode.value ? 'is-outlined' : ''}` } style = { `margin-bottom: 0px; border-color: transparent; ${ param.simulationMode.value ? '' : 'opacity: 1;' }` } state = { setSigningState.value.state } - disabled = { !param.simulationMode.value || simulatingPending || !param.isInitialHomeDataLoaded.value } + disabled = { !param.simulationMode.value || controlsDisabled } keepTextWhilePending = { true } pendingIndicatorPlacement = 'overlay' text = { } - pendingText = 'Switching to signing mode...' + pendingText = { !param.simulationMode.value ? 'Updating signing mode...' : 'Switching to signing mode...' } onClick = { enableSigning } />
- + + { rpcPending ? { !param.simulationMode.value && requestedRpc.value?.chainId !== param.rpcNetwork.value?.chainId ? 'Waiting for wallet to switch network...' : 'Updating network...' } : <> }
+ { setSimulatingState.value.state === 'rejected' ? : <> } + { setSigningState.value.state === 'rejected' ? : <> } + { rpcChangeState.value.state === 'rejected' ? : <> } } @@ -334,6 +348,8 @@ function InterceptorDisabledButton({ disableInterceptorToggle, interceptorDisabl } type RichListParams = { + isSettingsChangePending: ReadonlySignal + setRichState: (enabled: boolean, address: bigint | 'CurrentAddress') => Promise makeCurrentAddressRich: Signal activeAddress: Signal richList: Signal @@ -341,14 +357,27 @@ type RichListParams = { isInitialHomeDataLoaded: Signal } -function RichList({ makeCurrentAddressRich, activeAddress, richList, renameAddressCallBack, isInitialHomeDataLoaded }: RichListParams) { - async function enableMakeCurrentAddressRich(enabled: boolean) { - if (!isInitialHomeDataLoaded.value) return - sendPopupMessageToBackgroundPage( { method: 'popup_modifyMakeMeRich', data: { add: enabled, address: 'CurrentAddress'} } ) +function RichList({ makeCurrentAddressRich, activeAddress, richList, renameAddressCallBack, isInitialHomeDataLoaded, isSettingsChangePending, setRichState }: RichListParams) { + const { value: richChangeState, waitFor: waitForRichChange } = useAsyncState() + const controlsDisabled = !isInitialHomeDataLoaded.value || isSettingsChangePending.value || richChangeState.value.state === 'pending' + const saveRichChange = (enabled: boolean, address: bigint | 'CurrentAddress') => { + void waitForRichChange(async () => { + try { + await setRichState(enabled, address) + } catch (error) { + // Read persisted settings: a failed visualization refresh does not undo a successful save. + await sendPopupMessageToBackgroundPage({ method: 'popup_requestNewHomeData', data: { refreshSignerAccounts: false, includeWebsiteAccessAddressMetadata: false } }) + throw error + } + }) + } + function enableMakeCurrentAddressRich(enabled: boolean) { + if (controlsDisabled) return makeCurrentAddressRich.value = enabled + saveRichChange(enabled, 'CurrentAddress') } - async function modifyRichList(addressBookEntry: AddressBookEntry, makeRich: boolean) { - if (!isInitialHomeDataLoaded.value) return + function modifyRichList(addressBookEntry: AddressBookEntry, makeRich: boolean) { + if (controlsDisabled) return richList.value = updateRichListAddress( richList.value, addressBookEntry.address, @@ -356,7 +385,7 @@ function RichList({ makeCurrentAddressRich, activeAddress, richList, renameAddre (element) => element.addressBookEntry.address, () => ({ addressBookEntry, makingRich: true, type: 'UserAdded' as const }), ) - sendPopupMessageToBackgroundPage( { method: 'popup_modifyMakeMeRich', data: { add: makeRich, address: addressBookEntry.address } } ) + saveRichChange(makeRich, addressBookEntry.address) } const showList = useSignal(false) @@ -377,7 +406,7 @@ function RichList({ makeCurrentAddressRich, activeAddress, richList, renameAddre
{ showList.value = !showList.value } }>

Make current account rich

@@ -386,11 +415,13 @@ function RichList({ makeCurrentAddressRich, activeAddress, richList, renameAddre
+ { richChangeState.value.state === 'pending' ?
Updating balances...
: <> } + { richChangeState.value.state === 'rejected' ? : <> } { !showList.value ? <> { !activeAddressSetAsRichViaFixedAddressList.value || activeAddress.value === undefined ? <> : <>
@@ -400,7 +431,7 @@ function RichList({ makeCurrentAddressRich, activeAddress, richList, renameAddre

Addresses being made rich

{ visibleRichList.value.map((richListElement) => ) } @@ -620,7 +651,7 @@ function FirstCard(param: FirstCardParams) { : !param.isFreshHomeDataLoaded.value ? :
- +
Promise export type OnErrorBlockCallback = (ethereumClientService: EthereumClientService, error: unknown) => Promise -export type ResetSimulationServices = (rpcNetwork: RpcEntry) => void +export type ResetSimulationServices = (rpcNetwork: RpcEntry) => SimulationServices | void export type SimulationServices = { ethereum: EthereumClientService diff --git a/app/ts/types/interceptor-messages.ts b/app/ts/types/interceptor-messages.ts index c950c027f..a60b52165 100644 --- a/app/ts/types/interceptor-messages.ts +++ b/app/ts/types/interceptor-messages.ts @@ -9,10 +9,10 @@ import { Page } from './exportedSettingsTypes.js' import { Website, WebsiteAccess, WebsiteAccessArray } from './websiteAccessTypes.js' import { SignerName } from './signerTypes.js' import { PendingAccessRequests, PopupPendingTransactionOrSignableMessage } from './accessRequest.js' -import { RpcEntries, RpcEntry, RpcNetwork } from './rpc.js' +import { RpcEntries, RpcNetwork } from './rpc.js' import { OldSignTypedDataParams, PersonalSignParams, SignTypedDataParams } from './jsonRpc-signing-types.js' import { GetSimulationStackReplyV1, GetSimulationStackReplyV2 } from './simulationStackTypes.js' -import { ChangeActiveAddress, EnrichedRichListElement, PopupMessageReplyRequests, UnexpectedErrorOccured } from './interceptor-reply-messages.js' +import { ChangeActiveAddress, ModifyMakeMeRich, EnableSimulationMode, ChangeActiveChain, EnrichedRichListElement, PopupMessageReplyRequests, UnexpectedErrorOccured } from './interceptor-reply-messages.js' import { ErrorWithCodeAndOptionalData } from './error.js' import { SimulateExecutionReply as SharedSimulateExecutionReply, SimulateExecutionReplyData as SharedSimulateExecutionReplyData } from './simulateExecutionReply.js' import { SimulateGnosisSafeTransaction as SharedSimulateGnosisSafeTransaction, SimulateGovernanceContractExecution as SharedSimulateGovernanceContractExecution } from './simulateExecutionRequests.js' @@ -287,14 +287,7 @@ export const InterceptorAccessChangeAddress = funtypes.ReadonlyObject({ export { ChangeActiveAddress } from './interceptor-reply-messages.js' -export type ModifyMakeMeRich = funtypes.Static -export const ModifyMakeMeRich = funtypes.ReadonlyObject({ - method: funtypes.Literal('popup_modifyMakeMeRich'), - data: funtypes.ReadonlyObject({ - add: funtypes.Boolean, - address: funtypes.Union(funtypes.Literal('CurrentAddress'), EthereumAddress), - }) -}).asReadonly() +export { ModifyMakeMeRich } from './interceptor-reply-messages.js' export type AddressBookCategory = funtypes.Static export const AddressBookCategory = funtypes.Union( @@ -335,11 +328,7 @@ export const RequestAccountsFromSigner = funtypes.ReadonlyObject({ data: funtypes.Boolean }).asReadonly() -export type EnableSimulationMode = funtypes.Static -export const EnableSimulationMode = funtypes.ReadonlyObject({ - method: funtypes.Literal('popup_enableSimulationMode'), - data: funtypes.Boolean -}).asReadonly() +export { EnableSimulationMode } from './interceptor-reply-messages.js' export type TransactionOrMessageIdentifier = funtypes.Static export const TransactionOrMessageIdentifier = funtypes.Union( @@ -723,11 +712,7 @@ const UpdateRPCList = funtypes.ReadonlyObject({ data: RpcEntries, }) -export type ChangeActiveChain = funtypes.Static -export const ChangeActiveChain = funtypes.ReadonlyObject({ - method: funtypes.Literal('popup_changeActiveRpc'), - data: RpcEntry, -}).asReadonly() +export { ChangeActiveChain } from './interceptor-reply-messages.js' export type ChainChangeConfirmation = funtypes.Static export const ChainChangeConfirmation = funtypes.ReadonlyObject({ diff --git a/app/ts/types/interceptor-reply-messages.ts b/app/ts/types/interceptor-reply-messages.ts index b3ffa68ed..d6ec9c392 100644 --- a/app/ts/types/interceptor-reply-messages.ts +++ b/app/ts/types/interceptor-reply-messages.ts @@ -1,3 +1,4 @@ +import { RpcEntry } from './rpc.js' import * as funtypes from 'funtypes' import { AddressBookEntry, ChainIdWithUniversal } from '../types/addressBookTypes.js' @@ -94,6 +95,33 @@ export const AddOrModifyAddressBookEntryReply = funtypes.Union( }), ) +export type ModifyMakeMeRich = funtypes.Static +export const ModifyMakeMeRich = funtypes.ReadonlyObject({ + method: funtypes.Literal('popup_modifyMakeMeRich'), + data: funtypes.ReadonlyObject({ + add: funtypes.Boolean, + address: funtypes.Union(funtypes.Literal('CurrentAddress'), EthereumAddress), + }) +}).asReadonly() + +export type EnableSimulationMode = funtypes.Static +export const EnableSimulationMode = funtypes.ReadonlyObject({ + method: funtypes.Literal('popup_enableSimulationMode'), + data: funtypes.Boolean +}).asReadonly() + +export type ChangeActiveChain = funtypes.Static +export const ChangeActiveChain = funtypes.ReadonlyObject({ + method: funtypes.Literal('popup_changeActiveRpc'), + data: RpcEntry, +}).asReadonly() + +export type PopupSettingsChangeReply = funtypes.Static +export const PopupSettingsChangeReply = funtypes.Union( + funtypes.ReadonlyObject({ type: funtypes.Literal('PopupSettingsChangeReply'), ok: funtypes.Literal(true) }), + funtypes.ReadonlyObject({ type: funtypes.Literal('PopupSettingsChangeReply'), ok: funtypes.Literal(false), message: funtypes.String }), +) + export type ChangeActiveAddress = funtypes.Static export const ChangeActiveAddress = funtypes.ReadonlyObject({ method: funtypes.Literal('popup_changeActiveAddress'), @@ -288,6 +316,9 @@ type PopupRequestsRepliesMap = { popup_importSimulationStack: typeof ImportSimulationStackReply popup_addOrModifyAddressBookEntry: typeof AddOrModifyAddressBookEntryReply popup_changeActiveAddress: typeof ChangeActiveAddressReply + popup_enableSimulationMode: typeof PopupSettingsChangeReply + popup_changeActiveRpc: typeof PopupSettingsChangeReply + popup_modifyMakeMeRich: typeof PopupSettingsChangeReply popup_setSafeSimulationSigner: typeof SetSafeSimulationSignerReply popup_requestSafeStackExport: typeof RequestSafeStackExportReply popup_importSafeStack: typeof ImportSafeStackReply @@ -312,6 +343,9 @@ export const PopupRequestsReplies: PopupRequestsRepliesMap = { popup_importSimulationStack: ImportSimulationStackReply, popup_addOrModifyAddressBookEntry: AddOrModifyAddressBookEntryReply, popup_changeActiveAddress: ChangeActiveAddressReply, + popup_enableSimulationMode: PopupSettingsChangeReply, + popup_changeActiveRpc: PopupSettingsChangeReply, + popup_modifyMakeMeRich: PopupSettingsChangeReply, popup_setSafeSimulationSigner: SetSafeSimulationSignerReply, popup_requestSafeStackExport: RequestSafeStackExportReply, popup_importSafeStack: ImportSafeStackReply, @@ -351,6 +385,9 @@ export const PopupMessageReplyRequests = funtypes.Union( funtypes.ReadonlyObject({ method: funtypes.Literal('popup_importSimulationStack'), data: InterceptorSimulationExport }), funtypes.ReadonlyObject({ method: funtypes.Literal('popup_addOrModifyAddressBookEntry'), data: AddressBookEntry }), ChangeActiveAddress, + EnableSimulationMode, + ChangeActiveChain, + ModifyMakeMeRich, SetSafeSimulationSigner, funtypes.ReadonlyObject({ method: funtypes.Literal('popup_requestSafeStackExport') }), funtypes.ReadonlyObject({ method: funtypes.Literal('popup_importSafeStack'), data: SafeStackExport }), @@ -383,6 +420,7 @@ export type PopupReplyOption = | RequestInterceptorSimulationInputReply | ImportSimulationStackReply | AddOrModifyAddressBookEntryReply + | PopupSettingsChangeReply | ChangeActiveAddressReply | SetSafeSimulationSignerReply | RequestSafeStackExportReply @@ -406,6 +444,7 @@ export const PopupReplyOption: funtypes.Codec = funtypes.Union RequestInterceptorSimulationInputReply, ImportSimulationStackReply, AddOrModifyAddressBookEntryReply, + PopupSettingsChangeReply, ChangeActiveAddressReply, SetSafeSimulationSignerReply, RequestSafeStackExportReply, diff --git a/app/ts/types/user-interface-types.ts b/app/ts/types/user-interface-types.ts index d4a9d12b9..bbd900572 100644 --- a/app/ts/types/user-interface-types.ts +++ b/app/ts/types/user-interface-types.ts @@ -34,6 +34,9 @@ export type AddAddressParam = { export type HomeParams = { isActiveAddressChanging: Signal isActiveAddressChangePending: ReadonlySignal + isSettingsChangePending: ReadonlySignal + setSimulationMode: (enabled: boolean) => Promise + setRichState: (enabled: boolean, address: bigint | 'CurrentAddress') => Promise changeActiveAddress: () => void makeCurrentAddressRich: Signal activeAddresses: Signal @@ -45,7 +48,7 @@ export type HomeParams = { useSignersAddressAsActiveAddress: Signal simVisResults: Signal rpcNetwork: Signal - setActiveRpcAndInformAboutIt: (entry: RpcEntry) => void + setActiveRpcAndInformAboutIt: (entry: RpcEntry) => Promise simulationMode: Signal tabIconDetails: Signal currentBlockNumber: Signal @@ -77,11 +80,14 @@ export type ChangeActiveAddressParam = { export type FirstCardParams = { isActiveAddressChanging: Signal isActiveAddressChangePending: ReadonlySignal + isSettingsChangePending: ReadonlySignal + setSimulationMode: (enabled: boolean) => Promise + setRichState: (enabled: boolean, address: bigint | 'CurrentAddress') => Promise activeAddress: Signal useSignersAddressAsActiveAddress: Signal activeAddresses: Signal walletSelectedAddressBookEntry: Signal - changeActiveRpc: (rpcEntry: RpcEntry) => void + changeActiveRpc: (rpcEntry: RpcEntry) => Promise rpcNetwork: Signal simulationMode: Signal changeActiveAddress: () => void diff --git a/test/tests/backgroundSignerLifecycle.test.ts b/test/tests/backgroundSignerLifecycle.test.ts index 7372138ca..0cdb651a7 100644 --- a/test/tests/backgroundSignerLifecycle.test.ts +++ b/test/tests/backgroundSignerLifecycle.test.ts @@ -495,7 +495,7 @@ describe('background eth_accounts', () => { assert.equal(reply?.result, null) }) - test('does not let another tab chain reply settle the pending dapp switch', async () => { + test('rejects a conflicting popup switch and ignores another tab reply while a dapp switch is pending', async () => { installBrowserMock() const { changeSimulationMode, @@ -574,11 +574,12 @@ describe('background eth_accounts', () => { await new Promise((resolve) => setTimeout(resolve, 0)) await saveCurrentTabId(popupSocket.tabId) - await popupChangeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + const popupReply = await popupChangeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { method: 'popup_changeActiveRpc', data: popupRpcNetwork, }, await getSettings()) - await waitForPortMessageCount(popupMessages, 'request_signer_to_wallet_switchEthereumChain', 1) + assert.deepEqual(popupReply, { type: 'PopupSettingsChangeReply', ok: false, message: 'A network switch is already waiting for your wallet.' }) + assert.equal(popupMessages.some((message) => message.method === 'request_signer_to_wallet_switchEthereumChain'), false) await handleInterceptedRequest(popupPort, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, popupSocket, { interceptorRequest: true, interceptorInternalRequest: true, diff --git a/test/tests/homeClearEmptyState.test.ts b/test/tests/homeClearEmptyState.test.ts index 6dc163ffe..f289a125d 100644 --- a/test/tests/homeClearEmptyState.test.ts +++ b/test/tests/homeClearEmptyState.test.ts @@ -256,6 +256,9 @@ function createHomeParams(overrides: Partial = {}): HomeParams { return { isActiveAddressChanging: new Signal(false), isActiveAddressChangePending: new Signal(false), + isSettingsChangePending: new Signal(false), + setSimulationMode: async () => undefined, + setRichState: async () => undefined, changeActiveAddress: () => undefined, makeCurrentAddressRich: new Signal(false), activeAddresses: new Signal([activeAddressEntry]), @@ -267,7 +270,7 @@ function createHomeParams(overrides: Partial = {}): HomeParams { useSignersAddressAsActiveAddress: new Signal(false), simVisResults: new Signal(toResolvedSimulationResults(createSimulationResults())), rpcNetwork: new Signal(rpcNetwork), - setActiveRpcAndInformAboutIt: () => undefined, + setActiveRpcAndInformAboutIt: async () => undefined, simulationMode: new Signal(true), tabIconDetails: new Signal({ icon: ICON_SIMULATING, iconReason: 'Simulating transactions.' }), currentBlockNumber: new Signal(101n), @@ -404,6 +407,111 @@ function getMessageWithMethod(messages: readonly unknown[], method: string) { } describe('Home popup clear empty state', () => { + test('keeps mode switching busy after the saved mode arrives and exposes failures', async () => { + const dom = installDomMock() + let rejectChange: ((error: Error) => void) | undefined + const change = new Promise((_resolve, reject) => { rejectChange = reject }) + const params = createHomeParams({ setSimulationMode: async () => { await change } }) + try { + await act(() => { render(h(Home, params), dom.document.body) }) + await act(async () => { await clickElement(getButtonByText(dom.document.body, 'Signing')) }) + assert.equal(getButtonByText(dom.document.body, 'Signing').getAttribute?.('aria-busy'), true) + await act(() => { params.simulationMode.value = false }) + assert.equal(getButtonByText(dom.document.body, 'Signing').getAttribute?.('aria-busy'), true) + assert.equal(String(getButtonByText(dom.document.body, 'Simulating').getAttribute?.('disabled')), 'true') + await act(async () => { + if (rejectChange === undefined) throw new Error('Expected pending change') + rejectChange(new Error('Unable to refresh mode')) + await new Promise((resolve) => setTimeout(resolve, 0)) + }) + assert.equal(dom.document.body.textContent?.includes('Unable to refresh mode'), true) + assert.equal(getButtonByText(dom.document.body, 'Simulating').getAttribute?.('disabled'), undefined) + } finally { + render(undefined, dom.document.body) + dom.restore() + } + }) + + test('shows wallet approval progress for RPC changes and keeps the old network on rejection', async () => { + const dom = installDomMock() + const nextRpc = { ...rpcNetwork, name: 'Other network', chainId: 2n, httpsRpc: 'https://other.example.test' } + let rejectChange: ((error: Error) => void) | undefined + const change = new Promise((_resolve, reject) => { rejectChange = reject }) + const params = createHomeParams({ simulationMode: new Signal(false), rpcEntries: new Signal([rpcNetwork, nextRpc]), setActiveRpcAndInformAboutIt: async () => { await change } }) + try { + await act(() => { render(h(Home, params), dom.document.body) }) + await act(async () => { await clickElement(getButtonByText(dom.document.body, 'Other network')) }) + assert.equal(dom.document.body.textContent?.includes('Waiting for wallet to switch network...'), true) + assert.equal(params.rpcNetwork.value?.httpsRpc, rpcNetwork.httpsRpc) + await act(async () => { + if (rejectChange === undefined) throw new Error('Expected pending change') + rejectChange(new Error('Wallet rejected network change')) + await new Promise((resolve) => setTimeout(resolve, 0)) + }) + assert.equal(dom.document.body.textContent?.includes('Wallet rejected network change'), true) + assert.equal(dom.document.body.textContent?.includes('Waiting for wallet to switch network...'), false) + assert.equal(params.rpcNetwork.value?.httpsRpc, rpcNetwork.httpsRpc) + } finally { + render(undefined, dom.document.body) + dom.restore() + } + }) + + test('shows progress for a rich toggle and reconciles persisted settings after a refresh failure', async () => { + const dom = installDomMock() + const previousInputElement = globalThis.HTMLInputElement + Object.defineProperty(globalThis, 'HTMLInputElement', { configurable: true, writable: true, value: globalThis.Element }) + const browserMock = installBrowserMock() + let rejectChange: ((error: Error) => void) | undefined + const change = new Promise((_resolve, reject) => { rejectChange = reject }) + const params = createHomeParams({ setRichState: async (enabled, address) => { + assert.equal(enabled, true) + assert.equal(address, 'CurrentAddress') + await change + } }) + try { + await act(() => { render(h(Home, params), dom.document.body) }) + const checkbox = collectElements(dom.document.body, 'input').find((element) => element.getAttribute?.('type') === 'checkbox') + if (checkbox === undefined) throw new Error('Expected rich checkbox') + const handler = Object.entries(checkbox.l ?? {}).find(([key]) => key.toLowerCase().startsWith('input'))?.[1] + if (handler === undefined) throw new Error('Expected rich toggle handler') + Reflect.set(checkbox, 'checked', true) + await act(async () => { await handler({ target: checkbox }) }) + assert.equal(params.makeCurrentAddressRich.value, true) + assert.equal(dom.document.body.textContent?.includes('Updating balances...'), true) + assert.equal(String(checkbox.getAttribute?.('disabled')), 'true') + await act(async () => { + if (rejectChange === undefined) throw new Error('Expected pending change') + rejectChange(new Error('Balances could not be refreshed')) + await new Promise((resolve) => setTimeout(resolve, 0)) + }) + assert.equal(dom.document.body.textContent?.includes('Balances could not be refreshed'), true) + assert.equal(dom.document.body.textContent?.includes('Updating balances...'), false) + assert.ok(getMessageWithMethod(browserMock.sentMessages, 'popup_requestNewHomeData')) + } finally { + render(undefined, dom.document.body) + globalThis.HTMLInputElement = previousInputElement + browserMock.restore() + dom.restore() + } + }) + + test('disables wallet, mode, RPC and rich controls during another settings change', async () => { + const dom = installDomMock() + const params = createHomeParams({ isSettingsChangePending: new Signal(true) }) + try { + await act(() => { render(h(Home, params), dom.document.body) }) + assert.equal(String(getButtonByText(dom.document.body, 'Signing').getAttribute?.('disabled')), 'true') + assert.equal(String(getButtonByText(dom.document.body, 'Change').getAttribute?.('disabled')), 'true') + for (const input of collectElements(dom.document.body, 'input').filter((element) => element.getAttribute?.('type') === 'checkbox')) { + assert.equal(String(input.getAttribute?.('disabled')), 'true') + } + } finally { + render(undefined, dom.document.body) + dom.restore() + } + }) + for (const succeeds of [true, false]) { test(`shows the address shimmer during a switch and restores the address after ${ succeeds ? 'success' : 'failure' }`, async () => { const dom = installDomMock() diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts new file mode 100644 index 000000000..e133f149f --- /dev/null +++ b/test/tests/popupSettingsChanges.test.ts @@ -0,0 +1,223 @@ +import * as assert from 'assert' +import { describe, test } from 'bun:test' +import { confirmedSignerOwnership, createDeferredValue, createEthereumWithGetBlockCounter, createPort, installBrowserMock, loadModules, waitForPortMessageCount } from './backgroundEthAccountsTestHarness.js' +import type { PopupSimulationRefresh } from '../../app/ts/background/popupSimulationRefresh.js' + +describe('popup settings changes', () => { + test('coalesces refreshes and waits for changes arriving during an active refresh', async () => { + installBrowserMock() + const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') + const first = createDeferredValue() + const last = createDeferredValue() + const calls: PopupSimulationRefresh[] = [] + const refresh = createPopupSimulationRefresher(async (services) => { + calls.push(services) + return await (calls.length === 1 ? first.promise : last.promise) + }) + const services = createEthereumWithGetBlockCounter({ count: 0 }) + const result = refresh(services) + assert.equal(refresh({ ...services, invalidateOldState: true }), result) + await Promise.resolve() + assert.equal(calls.length, 1) + assert.equal(calls[0]?.invalidateOldState, true) + const newerServices = createEthereumWithGetBlockCounter({ count: 0 }) + assert.equal(refresh({ ...services, invalidateOldState: true }), result) + assert.equal(refresh(newerServices), result) + let completed = false + void result.then(() => { completed = true }) + first.resolve(true) + await new Promise((resolve) => setTimeout(resolve, 0)) + assert.equal(calls.length, 2) + assert.equal(calls[1]?.ethereum, newerServices.ethereum) + assert.equal(calls[1]?.invalidateOldState, true) + assert.equal(completed, false) + last.resolve(false) + assert.equal(await result, false) + }) + + test('allows retry after a rejected refresh', async () => { + installBrowserMock() + const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') + let attempts = 0 + const refresh = createPopupSimulationRefresher(async () => { + if (++attempts === 1) throw new Error('Refresh failed') + return true + }) + const services = createEthereumWithGetBlockCounter({ count: 0 }) + await assert.rejects(refresh(services), /Refresh failed/) + assert.equal(await refresh(services), true) + }) + + test('skips work when reselecting the current mode or RPC', async () => { + const { runtimeMessages } = installBrowserMock() + const { changeSimulationMode, getSettings } = await loadModules() + const { enableSimulationMode } = await import('../../app/ts/background/popupMessageHandlers.js') + const { changeActiveRpc } = await import('../../app/ts/background/activeSettings.js') + await changeSimulationMode({ simulationMode: true }) + const { ethereum, tokenPriceService } = createEthereumWithGetBlockCounter({ count: 0 }) + const reset = () => { throw new Error('Should not reset services') } + const count = runtimeMessages.length + await enableSimulationMode(ethereum, tokenPriceService, reset, new Map(), { method: 'popup_enableSimulationMode', data: true }) + await changeActiveRpc(ethereum, tokenPriceService, reset, new Map(), (await getSettings()).activeRpcNetwork, true, undefined) + assert.equal(runtimeMessages.length, count) + }) + + test('publishes a saved mode before slow permission work finishes', async () => { + const { runtimeMessages } = installBrowserMock() + const { changeSimulationMode, changeActiveAddressAndChain, updateWebsiteAccess } = await loadModules() + const { MessageToPopup } = await import('../../app/ts/types/interceptor-messages.js') + await changeSimulationMode({ simulationMode: false }) + await updateWebsiteAccess(() => [{ website: { websiteOrigin: 'https://mode-switch-test.example' }, access: true, addressAccess: [], declarativeNetRequestBlockMode: 'block-all' }]) + const started = createDeferredValue() + const release = createDeferredValue() + Object.defineProperty(browser.declarativeNetRequest, 'getDynamicRules', { configurable: true, value: async () => { + started.resolve(undefined) + await release.promise + return [] + } }) + const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + let completed = false + const pending = changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, new Map(), { simulationMode: true }).then(() => { completed = true }) + try { + await started.promise + assert.equal(completed, false) + assert.equal(runtimeMessages.some((message) => { + const parsed = MessageToPopup.safeParse(message) + return parsed.success && parsed.value.method === 'popup_settingsUpdated' && parsed.value.data.simulationMode + }), true) + } finally { + release.resolve(undefined) + await pending + } + }) + + test('installs the selected RPC service before publishing its settings', async () => { + installBrowserMock() + const { changeSimulationMode, changeActiveAddressAndChain, getSettings } = await loadModules() + const { MessageToPopup } = await import('../../app/ts/types/interceptor-messages.js') + await changeSimulationMode({ simulationMode: true }) + const rpc = { ...(await getSettings()).activeRpcNetwork, httpsRpc: 'https://replacement.example.test' } + const services = createEthereumWithGetBlockCounter({ count: 0 }) + let installed = false + let announced = false + Object.defineProperty(browser.runtime, 'sendMessage', { configurable: true, value: async (message: unknown) => { + const parsed = MessageToPopup.safeParse(message) + if (parsed.success && parsed.value.method === 'popup_settingsUpdated' && parsed.value.data.activeRpcNetwork.httpsRpc === rpc.httpsRpc) { + assert.equal(installed, true) + announced = true + } + return undefined + } }) + await changeActiveAddressAndChain(services.ethereum, services.tokenPriceService, (entry) => { + assert.equal(entry.httpsRpc, rpc.httpsRpc) + installed = true + return services + }, new Map(), { simulationMode: true, rpcNetwork: rpc }) + assert.equal(announced, true) + }) + + test('rich changes request a visualization refresh immediately and unchanged values skip it', async () => { + const { runtimeMessages } = installBrowserMock() + const { getSettings } = await loadModules() + const { dispatchPopupMessage } = await import('../../app/ts/background/popupMessageDispatcher.js') + const services = createEthereumWithGetBlockCounter({ count: 0 }) + const context = { + ...services, settings: await getSettings(), websiteTabConnections: new Map(), + publishRpcConnectionStatus: async () => undefined, + simulationAbortController: new AbortController(), confirmTransactionAbortController: new AbortController(), + resetSimulationState: async () => undefined, + } + const refreshRequests = () => runtimeMessages.filter((message) => { + return typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_isSimulationVisualizerOpen' + }).length + const request = { method: 'popup_modifyMakeMeRich' as const, data: { address: 'CurrentAddress' as const, add: true } } + const initialCount = refreshRequests() + await dispatchPopupMessage(context, request) + assert.ok(refreshRequests() > initialCount) + const refreshedCount = refreshRequests() + await dispatchPopupMessage(context, request) + assert.equal(refreshRequests(), refreshedCount) + }) + + for (const outcome of ['accept', 'reject', 'safe'] as const) { + test(`preserves RPC preferences until a popup wallet switch is accepted (${ outcome })`, async () => { + installBrowserMock() + const { changeSimulationMode, getSettings, websiteSocketToString, updateTabState, updateUserAddressBookEntries, saveCurrentTabId } = await loadModules() + const { popupChangeActiveRpc } = await import('../../app/ts/background/popupMessageHandlers.js') + const { walletSwitchEthereumChainReply } = await import('../../app/ts/background/providerMessageHandlers.js') + const { setRpcList, getRpcList } = await import('../../app/ts/background/storageVariables.js') + const currentRpc = (await getSettings()).activeRpcNetwork + const primaryRpc = { ...currentRpc, chainId: 2n, httpsRpc: 'https://primary.example.test', primary: true } + const requestedRpc = { ...primaryRpc, httpsRpc: 'https://alternative.example.test', primary: false } + const originalRpcList = [currentRpc, primaryRpc, requestedRpc] + await setRpcList(originalRpcList) + await changeSimulationMode({ simulationMode: false, activeSigningAddress: 1n, activeSigningSafeAddress: outcome === 'safe' ? 3n : undefined }) + await updateUserAddressBookEntries(() => [{ type: 'safe', name: 'Signing Safe', address: 3n, chainId: currentRpc.chainId, entrySource: 'User', useAsActiveAddress: true, safeSignerAddresses: [1n] }]) + await updateTabState(1, (previous) => ({ ...previous, signerAccounts: [1n], activeSigningAddress: 1n, signerChain: currentRpc.chainId })) + await saveCurrentTabId(1) + const socket = { tabId: 1, connectionName: 0n } + const { port, messages } = createPort(1) + const connections = new Map([[1, { ...confirmedSignerOwnership(socket), connections: { + [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'https://example.test', approved: true, wantsToConnect: true }, + } }]]) + const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const pending = popupChangeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, connections, { method: 'popup_changeActiveRpc', data: requestedRpc }, await getSettings()) + if (outcome !== 'safe') { + await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) + assert.deepEqual(await getRpcList(), originalRpcList) + await walletSwitchEthereumChainReply(ethereum, tokenPriceService, resetSimulationServices, connections, port, { + method: 'wallet_switchEthereumChain_reply', + params: outcome === 'accept' ? [{ accept: true, chainId: '0x2', signerProviderGeneration: 1 }] : [{ accept: false, chainId: '0x2', error: { code: 4001, message: 'Rejected' }, signerProviderGeneration: 1 }], + }, 'hasAccess', 1n) + } + const reply = await pending + const activeRpc = (await getSettings()).activeRpcNetwork + if (outcome === 'accept') { + assert.equal(reply.ok, true) + assert.equal(activeRpc.httpsRpc, requestedRpc.httpsRpc) + assert.equal((await getRpcList()).find((entry) => entry.chainId === 2n && entry.primary)?.httpsRpc, requestedRpc.httpsRpc) + } else { + assert.equal(reply.ok, false) + assert.equal(activeRpc.httpsRpc, currentRpc.httpsRpc) + assert.deepEqual(await getRpcList(), originalRpcList) + if (outcome === 'safe') { + assert.equal(messages.some((message) => message.method === 'request_signer_to_wallet_switchEthereumChain'), false) + assert.ok(!reply.ok && reply.message.includes('Safe')) + } + } + }) + } + + for (const accept of [true, false]) { + test(`waits for the matching wallet network ${ accept ? 'acceptance' : 'rejection' }`, async () => { + installBrowserMock() + const { changeSimulationMode, getSettings, websiteSocketToString } = await loadModules() + const { requestSignerChainChange, resolveSignerChainChange } = await import('../../app/ts/background/windows/changeChain.js') + await changeSimulationMode({ simulationMode: false }) + const socket = { tabId: 1, connectionName: 0n } + const ownership = confirmedSignerOwnership(socket) + const { port, messages } = createPort(socket.tabId) + const connections = new Map([[1, { ...ownership, connections: { + [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'https://example.test', approved: true, wantsToConnect: true }, + } }]]) + const rpc = { ...(await getSettings()).activeRpcNetwork, chainId: 2n, httpsRpc: 'https://rpc.example.test' } + const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + let completed = false + const pending = requestSignerChainChange(ethereum, tokenPriceService, resetSimulationServices, connections, rpc, 1).then((result) => { completed = true; return result }) + await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) + assert.equal(completed, false) + const concurrent = await requestSignerChainChange(ethereum, tokenPriceService, resetSimulationServices, connections, rpc, 1) + assert.equal(concurrent.error?.code, -32002) + const { getConfirmedSignerStateToken } = await import('../../app/ts/background/signerStateOwnership.js') + const token = getConfirmedSignerStateToken(connections, 1) + if (token === undefined) throw new Error('Expected signer owner') + resolveSignerChainChange(token, { + method: 'popup_signerChangeChainDialog', + data: accept ? [{ accept: true, chainId: rpc.chainId }] : [{ accept: false, chainId: rpc.chainId, error: { code: 4001, message: 'User rejected network change' } }], + }) + const result = await pending + if (accept) assert.equal(result.result, null) + else assert.equal(result.error?.message, 'User rejected network change') + }) + } +}) From 712383ab1d05df0c05f06a8b2154c12ef6272e64 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 08:15:25 +0000 Subject: [PATCH 04/31] Coordinate popup settings and share snapshot-bound refreshes --- app/ts/background/background-startup.ts | 7 +- app/ts/background/popupMessageDispatcher.ts | 18 +- app/ts/background/popupSimulationRefresh.ts | 44 +++- .../background/popupVisualisationUpdater.ts | 25 +- app/ts/background/simulationUpdating.ts | 6 +- .../subcomponents/ConfigureRpcConnection.tsx | 5 +- package.json | 1 + test/benchmarks/README.md | 31 +++ test/benchmarks/popupSwitchingChrome.ts | 246 ++++++++++++++++++ test/tests/backgroundUtilsMessaging.test.ts | 10 +- test/tests/popupClearReset.test.ts | 14 + test/tests/popupSettingsChanges.test.ts | 105 +++++++- test/tests/uiBoundaryFixes.test.tsx | 21 ++ 13 files changed, 498 insertions(+), 35 deletions(-) create mode 100644 test/benchmarks/popupSwitchingChrome.ts diff --git a/app/ts/background/background-startup.ts b/app/ts/background/background-startup.ts index 78f2f51fa..d9a0156c2 100644 --- a/app/ts/background/background-startup.ts +++ b/app/ts/background/background-startup.ts @@ -349,7 +349,10 @@ browser.runtime.onConnect.addListener((port) => catchAllErrorsAndCall(async () = return await onContentScriptConnected(waitForBackgroundStartup, port, websiteTabConnections) })) browser.runtime.onMessage.addListener((message: unknown) => Promise.resolve(catchAllErrorsAndCall(async () => { - const { simulationServices, resetActiveRpcNetwork } = await waitForBackgroundStartup() - return await popupMessageHandler(websiteTabConnections, simulationServices.ethereum, simulationServices.tokenPriceService, resetActiveRpcNetwork, message, await getSettings(), rpcConnectionStatusPublisher.publishRpcConnectionStatus) + const { resetActiveRpcNetwork } = await waitForBackgroundStartup() + const settings = await getSettings() + // A preceding popup RPC switch can replace services while settings are being read. + const simulationServices = getSimulationServices() + return await popupMessageHandler(websiteTabConnections, simulationServices.ethereum, simulationServices.tokenPriceService, resetActiveRpcNetwork, message, settings, rpcConnectionStatusPublisher.publishRpcConnectionStatus) }))) addWindowTabListeners(onCloseWindow, onCloseTab) diff --git a/app/ts/background/popupMessageDispatcher.ts b/app/ts/background/popupMessageDispatcher.ts index 30fe3343c..fa87d967c 100644 --- a/app/ts/background/popupMessageDispatcher.ts +++ b/app/ts/background/popupMessageDispatcher.ts @@ -1,3 +1,4 @@ +import { getSettings } from './settings.js' import { refreshPopupSimulation } from './popupSimulationRefresh.js' import type { PopupMessage } from '../types/interceptor-messages.js' import type { PopupReplyOption } from '../types/interceptor-reply-messages.js' @@ -70,6 +71,21 @@ const popupMessageHandlers = { ...websiteAccessPopupMessageHandlers, } satisfies PopupMessageHandlerMap +let settingsChangePending = false + export async function dispatchPopupMessage(context: PopupMessageDispatcherContext, request: PopupMessage): Promise { - return await popupMessageHandlers[request.method](context, request) + const isSettingsChange = request.method === 'popup_changeActiveAddress' || request.method === 'popup_enableSimulationMode' || request.method === 'popup_changeActiveRpc' || request.method === 'popup_modifyMakeMeRich' + if (!isSettingsChange) return await popupMessageHandlers[request.method](context, request) + if (settingsChangePending) return { + type: request.method === 'popup_changeActiveAddress' ? 'ChangeActiveAddressReply' : 'PopupSettingsChangeReply', + ok: false, + message: 'Another popup is changing settings. Please wait for it to finish, then try again.', + } + // Admit before the first await. Provider callbacks and read requests remain available while a wallet reply is pending. + settingsChangePending = true + try { + return await popupMessageHandlers[request.method]({ ...context, settings: await getSettings() }, request) + } finally { + settingsChangePending = false + } } diff --git a/app/ts/background/popupSimulationRefresh.ts b/app/ts/background/popupSimulationRefresh.ts index 4830ec2c4..45130e17d 100644 --- a/app/ts/background/popupSimulationRefresh.ts +++ b/app/ts/background/popupSimulationRefresh.ts @@ -1,13 +1,25 @@ import type { SimulationServices } from '../simulation/serviceLifecycle.js' -import { updatePopupVisualisationIfNeeded } from './popupVisualisationUpdater.js' +import { getAddressesbeingMadeRich, getCurrentSimulationInput } from './simulationUpdating.js' +import { getPopupVisualisationFingerprint } from './popupSimulationFingerprint.js' +import { getSettings } from './settings.js' +import { getActiveStackContext } from '../utils/activeStackContext.js' +import { stringifyJSONWithBigInts } from '../utils/bigint.js' +import { type PopupSimulationSnapshot, updatePopupVisualisationIfNeeded } from './popupVisualisationUpdater.js' export type PopupSimulationRefresh = SimulationServices & { readonly invalidateOldState?: boolean } +export type RevisionedPopupSimulationRefresh = PopupSimulationRefresh & { readonly revision: string | symbol } -// All callers await the same drain; updates arriving during a refresh trigger one follow-up with the latest services. -export function createPopupSimulationRefresher(refresh: (services: PopupSimulationRefresh) => Promise) { - let pendingServices: PopupSimulationRefresh | undefined +// Identical revisions join active work unless a newer request is queued: in A → B → A, the last A must replace pending B. +export function createPopupSimulationRefresher(refresh: (services: T) => Promise) { + let pendingServices: T | undefined + let activeServices: T | undefined let running: Promise | undefined - return (services: PopupSimulationRefresh): Promise => { + return (services: T): Promise => { + if (pendingServices === undefined && running !== undefined && activeServices !== undefined + && activeServices.revision === services.revision + && activeServices.ethereum === services.ethereum + && activeServices.tokenPriceService === services.tokenPriceService + && (!services.invalidateOldState || activeServices.invalidateOldState)) return running pendingServices = { ...services, invalidateOldState: services.invalidateOldState || pendingServices?.invalidateOldState } if (running !== undefined) return running running = Promise.resolve().then(async () => { @@ -16,11 +28,13 @@ export function createPopupSimulationRefresher(refresh: (services: PopupSimulati while (pendingServices !== undefined) { const currentServices = pendingServices pendingServices = undefined + activeServices = currentServices refreshed = await refresh(currentServices) } return refreshed } finally { pendingServices = undefined + activeServices = undefined running = undefined } }) @@ -28,7 +42,23 @@ export function createPopupSimulationRefresher(refresh: (services: PopupSimulati } } -export const refreshPopupSimulation = createPopupSimulationRefresher(async ({ ethereum, tokenPriceService, invalidateOldState = false }) => { - const result = await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, invalidateOldState, false, !invalidateOldState) +const refreshRevision = createPopupSimulationRefresher(async ({ ethereum, tokenPriceService, invalidateOldState = false, snapshot }) => { + const result = await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, invalidateOldState, false, !invalidateOldState, snapshot) return result.simulationUpdatingState !== 'failed' && result.simulationResultState !== 'invalid' }) + +export async function refreshPopupSimulation(services: PopupSimulationRefresh) { + const richAddresses = await getAddressesbeingMadeRich() + const [input, settings] = await Promise.all([getCurrentSimulationInput(richAddresses), getSettings()]) + // Keep the revision and the input consumed after asynchronous consumer/storage checks together. + const snapshot = { simulationStateInput: input, numberOfAddressesMadeRich: richAddresses.length } + const block = services.ethereum.getCachedBlock() + // Without a cached head we cannot prove that two requests cover the same block; keep the follow-up refresh. + const revision = block === undefined ? Symbol('uncached block') : stringifyJSONWithBigInts([ + getPopupVisualisationFingerprint(input, services.ethereum.getRpcEntry(), block.number), + block.hash, + snapshot.numberOfAddressesMadeRich, + getActiveStackContext(settings), + ]) + return await refreshRevision({ ...services, revision, snapshot }) +} diff --git a/app/ts/background/popupVisualisationUpdater.ts b/app/ts/background/popupVisualisationUpdater.ts index 34642aa77..a16312305 100644 --- a/app/ts/background/popupVisualisationUpdater.ts +++ b/app/ts/background/popupVisualisationUpdater.ts @@ -1,7 +1,7 @@ import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' -import type { CompleteVisualizedSimulation, SimulationState } from '../types/visualizer-types.js' +import type { CompleteVisualizedSimulation, SimulationState, SimulationStateInput } from '../types/visualizer-types.js' import { createPassthroughCompleteVisualizedSimulation, toResolvedSimulationState } from '../types/visualizer-types.js' import { NEW_BLOCK_ABORT, TIME_BETWEEN_BLOCKS } from '../utils/constants.js' import { reportUnexpectedError, isExpectedInfrastructureError, isFailedToFetchError, isNewBlockAbort } from '../utils/errors.js' @@ -14,6 +14,11 @@ import { getPopupVisualisationFingerprint } from './popupSimulationFingerprint.j import { getAddressesbeingMadeRich, getCurrentSimulationInput, visualizeSimulatorState } from './simulationUpdating.js' import { getPopupVisualisationState, setPopupVisualisationState } from './storageVariables.js' +export type PopupSimulationSnapshot = { + readonly simulationStateInput: SimulationStateInput + readonly numberOfAddressesMadeRich: number +} + let abortController = new AbortController() function buildPassthroughVisualizedState( @@ -54,7 +59,7 @@ const hasSimulationInputOperations = (simulationState: SimulationState) => ( simulationState.simulationStateInput.some((block) => block.transactions.length > 0 || block.signedMessages.length > 0) ) -export const updatePopupVisualisationIfNeeded = async (ethereum: EthereumClientService, tokenPriceService: TokenPriceService, invalidateOldState = false, onlyIfNotAlreadyUpdating = false, skipIfUnchanged = false) => { +export const updatePopupVisualisationIfNeeded = async (ethereum: EthereumClientService, tokenPriceService: TokenPriceService, invalidateOldState = false, onlyIfNotAlreadyUpdating = false, skipIfUnchanged = false, snapshot?: PopupSimulationSnapshot) => { try { const popupVisualisation = await getPopupVisualisationState() if (onlyIfNotAlreadyUpdating && updateSimulationVisualisationSemaphore.getPermits() === 0) return popupVisualisation @@ -65,14 +70,14 @@ export const updatePopupVisualisationIfNeeded = async (ethereum: EthereumClientS const isSimulationDataConsumerOpenReply = await requestIsSimulationDataConsumerOpen() if (!(isSimulationDataConsumerOpenReply?.data.isOpen === true)) return popupVisualisation if (skipIfUnchanged && popupVisualisation.simulationState.kind === 'simulated') { - const currentSimulationInput = await getCurrentSimulationStateInput(ethereum) + const currentSimulationInput = await getCurrentSimulationStateInput(ethereum, snapshot) const currentFingerprint = getPopupVisualisationFingerprint(currentSimulationInput.simulationStateInput, currentSimulationInput.rpcNetwork, currentSimulationInput.blockNumber) const cachedFingerprint = getPopupVisualisationFingerprint( popupVisualisation.simulationState.value.simulationStateInput, popupVisualisation.simulationState.value.rpcNetwork, popupVisualisation.simulationState.value.blockNumber, ) - if (currentFingerprint === cachedFingerprint) return popupVisualisation + if (currentFingerprint === cachedFingerprint && (snapshot === undefined || snapshot.numberOfAddressesMadeRich === popupVisualisation.numberOfAddressesMadeRich)) return popupVisualisation } abortController.abort(NEW_BLOCK_ABORT) abortController = new AbortController() @@ -82,7 +87,7 @@ export const updatePopupVisualisationIfNeeded = async (ethereum: EthereumClientS const visualizedSimulatorState = await setPopupVisualisationState(modifyObject(popupVisualisation, { simulationId, simulationResultState: 'invalid', simulationUpdatingState: 'updating' })) await sendPopupMessageToOpenWindows({ method: 'popup_simulation_state_changed', data: { visualizedSimulatorState } }) } - await updatePopupVisualisationState(ethereum, tokenPriceService, thisAbortController) + await updatePopupVisualisationState(ethereum, tokenPriceService, thisAbortController, false, snapshot) } catch(error: unknown) { if (isExpectedInfrastructureError(error)) return await getPopupVisualisationState() await reportUnexpectedError(error) @@ -106,15 +111,15 @@ export async function refreshPopupVisualisationForOpenConsumer(ethereum: Ethereu } const updateSimulationVisualisationSemaphore = new Semaphore(1) -export async function updatePopupVisualisationState(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, abortController: AbortController | undefined, throwOnUnexpectedError = false) { +export async function updatePopupVisualisationState(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, abortController: AbortController | undefined, throwOnUnexpectedError = false, snapshot?: PopupSimulationSnapshot) { try { return await updateSimulationVisualisationSemaphore.execute(async () => { if (abortController?.signal.aborted) return const popupVisualisation = await getPopupVisualisationState() const simulationId = popupVisualisation.simulationId + 1 - const simulationState = await getUpdatedSimulationState(ethereum) + const simulationState = await getUpdatedSimulationState(ethereum, snapshot?.simulationStateInput) const doneState = { simulationUpdatingState: 'done' as const, simulationResultState: 'done' as const, simulationId } - const numberOfAddressesMadeRich = (await getAddressesbeingMadeRich()).length + const numberOfAddressesMadeRich = snapshot?.numberOfAddressesMadeRich ?? (await getAddressesbeingMadeRich()).length if (simulationState.kind === 'passthrough') { const newState = buildPassthroughVisualizedState(simulationId, numberOfAddressesMadeRich) await setPopupVisualisationState(newState) @@ -162,9 +167,9 @@ export async function updatePopupVisualisationState(ethereum: EthereumClientServ } } -async function getCurrentSimulationStateInput(ethereum: EthereumClientService) { +async function getCurrentSimulationStateInput(ethereum: EthereumClientService, snapshot?: PopupSimulationSnapshot) { return { - simulationStateInput: await getCurrentSimulationInput(), + simulationStateInput: snapshot?.simulationStateInput ?? await getCurrentSimulationInput(), rpcNetwork: ethereum.getRpcEntry(), blockNumber: await ethereum.getBlockNumber(undefined), } diff --git a/app/ts/background/simulationUpdating.ts b/app/ts/background/simulationUpdating.ts index 50226afaf..22293aa3f 100644 --- a/app/ts/background/simulationUpdating.ts +++ b/app/ts/background/simulationUpdating.ts @@ -45,7 +45,7 @@ const delegateCallExecuteAbi = [ }, ] as const satisfies Abi -const getMakeCurrentAddressRichStateOverride = (addressesToMakeRich: bigint[]) => { +const getMakeCurrentAddressRichStateOverride = (addressesToMakeRich: readonly bigint[]) => { if (addressesToMakeRich.length === 0) return {} return Object.fromEntries( addressesToMakeRich.map(currentAddress => { @@ -62,12 +62,12 @@ export const getAddressesbeingMadeRich = async () => { return [...makeRichAddressList.filter((x) => x.makingRich).map((x) => x.address), ...currentAddressBeingRich === undefined ? [] : [currentAddressBeingRich]] } -export const getCurrentSimulationInput = async (): Promise => { +export const getCurrentSimulationInput = async (richAddresses?: readonly bigint[]): Promise => { const [settings, preSimulationBlockTimeManipulation] = await Promise.all([ getSettings(), getPreSimulationBlockTimeManipulation() ]) - const richListPromise = silenceChromeUnCaughtPromise(getAddressesbeingMadeRich()) + const richListPromise = silenceChromeUnCaughtPromise(richAddresses === undefined ? getAddressesbeingMadeRich() : Promise.resolve(richAddresses)) const stack = await getInterceptorTransactionStack() const inputBlocks: SimulationStateInputBlock[] = [] let currentBlockTransactions: PreSimulationTransaction[] = [] diff --git a/app/ts/components/subcomponents/ConfigureRpcConnection.tsx b/app/ts/components/subcomponents/ConfigureRpcConnection.tsx index 844383765..ee2136e59 100644 --- a/app/ts/components/subcomponents/ConfigureRpcConnection.tsx +++ b/app/ts/components/subcomponents/ConfigureRpcConnection.tsx @@ -15,6 +15,7 @@ import { EthereumQuantity } from '../../types/wire-types.js' import { isBrowserFetchTransportError } from '../../utils/caughtErrors.js' import { AsyncStatusIcon } from './AsyncAction.js' import { parseRpcFormData } from '../../utils/rpcFormData.js' +import { requestPopupSettingsChange } from '../popupSettingsChange.js' import { ErrorComponent } from './Error.js' type RpcProbeResult = { @@ -122,7 +123,7 @@ export const ConfigureRpcConnection = ({ rpcInfo }: { rpcInfo?: RpcEntry }) => { const { activeRpcNetwork } = await getSettings() await saveRpcEntryAndKeepActiveRpcConsistent(rpcEntry, rpcEntries.value, activeRpcNetwork, async (entries) => await sendPopupMessageToBackgroundPageWithoutUnexpectedErrorReport({ method: 'popup_set_rpc_list', data: entries }), - async (entry) => await sendPopupMessageToBackgroundPageWithoutUnexpectedErrorReport({ method: 'popup_changeActiveRpc', data: entry }) + async (entry) => await requestPopupSettingsChange({ method: 'popup_changeActiveRpc', data: entry }) ) } @@ -130,7 +131,7 @@ export const ConfigureRpcConnection = ({ rpcInfo }: { rpcInfo?: RpcEntry }) => { const { activeRpcNetwork } = await getSettings() await removeRpcEntryAndKeepActiveRpcConsistent(url, rpcEntries.value, activeRpcNetwork, async (entries) => await sendPopupMessageToBackgroundPageWithoutUnexpectedErrorReport({ method: 'popup_set_rpc_list', data: entries }), - async (entry) => await sendPopupMessageToBackgroundPageWithoutUnexpectedErrorReport({ method: 'popup_changeActiveRpc', data: entry }) + async (entry) => await requestPopupSettingsChange({ method: 'popup_changeActiveRpc', data: entry }) ) } diff --git a/package.json b/package.json index 8983d72c7..9e3d6fb9a 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,7 @@ "build-chrome": "bun run generate-extension-pages && bun run compile-app && bun run bundle && bun run chrome", "screenshots:safe-ui": "bun run setup-chrome && bun ./scripts/capture-safe-ui-screenshots.mts", "screenshots:safe-ui:firefox": "bun run setup-firefox && SAFE_UI_SCREENSHOT_BROWSER=firefox bun ./scripts/capture-safe-ui-screenshots.mts", + "benchmark:popup-switching": "bun ./test/benchmarks/popupSwitchingChrome.ts", "benchmark:popup-lifecycle": "bun ./test/benchmarks/popupLifecycleChrome.ts", "benchmark:dispatch-event-reload": "bun ./test/benchmarks/dispatchEventReloadComparison.ts", "test:chrome-communication": "bun ./test/benchmarks/chromeCommunication.ts", diff --git a/test/benchmarks/README.md b/test/benchmarks/README.md index bf98b426a..3dc7ba27c 100644 --- a/test/benchmarks/README.md +++ b/test/benchmarks/README.md @@ -55,3 +55,34 @@ BENCH_SCENARIO=stacked bun run benchmark:popup-lifecycle The real browser benchmark does not seed `browser.storage.local` and it does not use a local JSON-RPC fixture server. For the `stacked` scenario, it prints the send-transaction setup phases, the end-to-end send-transaction-to-main-popup path, the RPCs from the transaction/balance setup, and the RPCs observed while the main popup itself is opening. + +## Switching controls with controlled delays + +After `bun run setup-chrome`, run: + +```bash +bun run benchmark:popup-switching +``` + +This benchmark uses the existing Chromium/CDP harness, an isolated temporary profile, a local JSON-RPC fixture, and an EIP-6963 fake wallet. Each iteration starts a fresh profile and seeds two contact wallets and RPC endpoints before measurement. It covers wallet selection, both modes, same-chain RPC switching, rich on/off, and wallet-required network acceptance/rejection. It deliberately uses an empty transaction stack; these results do not predict real-wallet or large-stack performance. + +Configure the fixture delays and sample count: + +```bash +BENCH_RPC_DELAY_MS=150 BENCH_WALLET_DELAY_MS=300 BENCH_ITERATIONS=3 bun run benchmark:popup-switching +``` + +The defaults are shown above. `CHROME_BIN` selects the browser binary. Persistent profile variables are rejected because the benchmark seeds settings. No existing profile is modified. + +The JSON report includes each sample and per-scenario minimum, median (upper middle for even counts), and maximum timings: + +- `feedbackFrameMs`: first animation frame observing pending feedback, the selected value, or a new error. +- `persistedMs`: the setting's storage-change event, when one occurs; rejected switches do not have this field. +- `selectionFrameMs`: first frame showing the selected value. For rich mode this is the optimistic checkbox state, not completed balance refresh. Rejected switches omit this field. +- `replyMs`: completion of the real popup/background request, including wallet approval when required. +- `completedFrameMs`: first frame after the reply with pending feedback removed. +- `rpcRequests`: local fixture RPC requests completed during the sample; cache hits and empty-stack changes can require none. + +The popup is brought to the foreground for frame sampling. These are animation-frame observations, not GPU paint timestamps. The benchmark fails for wrong outcomes, missing visual feedback or successful-setting persistence events, unsupported fixture RPC calls, wallet switches completing before the configured wallet delay, or rejected switches changing persisted RPC state. It imposes no machine-dependent speed threshold. + +For comparisons, build each revision and run the same command with the same browser, delays, iteration count, and host load. Compare feedback and selected-value timings separately from total completion time. Fixture setup is excluded from sample timings. diff --git a/test/benchmarks/popupSwitchingChrome.ts b/test/benchmarks/popupSwitchingChrome.ts new file mode 100644 index 000000000..2d8125b3f --- /dev/null +++ b/test/benchmarks/popupSwitchingChrome.ts @@ -0,0 +1,246 @@ +import { Multicall3ABI } from '../../app/ts/utils/constants.js' +import { encodeFunctionReturn } from '../../app/ts/utils/abiRuntime.js' +import { EthSimulateV1Result } from '../../app/ts/types/ethSimulate-types.js' +import { connectTarget, createTargetPage, launchChromeSession, waitForInterceptorExtensionServiceWorker, waitForPerformanceMarks, waitForRegisteredContentScripts } from './chromeHarness.js' +import type { CdpConnection } from './chromeHarness.js' +import { EthereumBlockHeader, serialize } from '../../app/ts/types/wire-types.js' +import { eth_getBlockByNumber_goerli_8443561_false } from '../RPCResponses.js' + +function delay(ms: number) { return new Promise((resolve) => setTimeout(resolve, ms)) } +function positiveInteger(value: string | undefined, fallback: number) { + const result = value === undefined ? fallback : Number(value) + if (!Number.isSafeInteger(result) || result < 0) throw new Error('Benchmark delays and iteration count must be nonnegative integers') + return result +} +const rpcDelayMs = positiveInteger(process.env.BENCH_RPC_DELAY_MS, 150) +const walletDelayMs = positiveInteger(process.env.BENCH_WALLET_DELAY_MS, 300) +const iterations = positiveInteger(process.env.BENCH_ITERATIONS, 3) +if (iterations === 0) throw new Error('BENCH_ITERATIONS must be positive') +if (process.env.CHROME_USER_DATA_DIR !== undefined || process.env.INTERCEPTOR_CHROME_PROFILE_DIR !== undefined) throw new Error('Switching benchmarks require an isolated temporary Chrome profile') +const walletA = '0x1000000000000000000000000000000000000001' +const walletB = '0x1000000000000000000000000000000000000002' +const blockResponse: unknown = JSON.parse(eth_getBlockByNumber_goerli_8443561_false) +if (!isRecord(blockResponse) || !isRecord(blockResponse.result)) throw new Error('Invalid block fixture') +const block = EthereumBlockHeader.parse({ ...blockResponse.result, transactions: [] }) +if (block === null) throw new Error('Missing fixture block') +const rpcRequests: { method: string, elapsedMs: number }[] = [] +const unexpectedMethods = new Set() + +function isRecord(value: unknown): value is Record { + return typeof value === 'object' && value !== null && !Array.isArray(value) +} + +const pageHtml = await Bun.file(new URL('./chromeCommunicationPage.html', import.meta.url)).text() +const server = Bun.serve({ + port: 0, + hostname: '127.0.0.1', + async fetch(request) { + if (request.method !== 'POST') return new Response(pageHtml, { headers: { 'Content-Type': 'text/html' } }) + const rpc: unknown = await request.json() + if (!isRecord(rpc) || typeof rpc.method !== 'string') return new Response('Invalid RPC request', { status: 400 }) + const started = performance.now() + await delay(rpcDelayMs) + let result: unknown + switch (rpc.method) { + case 'eth_chainId': result = new URL(request.url).pathname === '/rpc2' ? '0x2' : '0x1'; break + case 'eth_blockNumber': result = `0x${ block.number.toString(16) }`; break + case 'eth_getBlockByNumber': result = serialize(EthereumBlockHeader, { ...block, timestamp: new Date(), transactions: [] }); break + case 'eth_getBalance': + case 'eth_getTransactionCount': + case 'eth_gasPrice': + case 'eth_maxPriorityFeePerGas': result = '0x0'; break + case 'eth_getCode': result = '0x'; break + case 'eth_simulateV1': { + const payload = Array.isArray(rpc.params) ? rpc.params[0] : undefined + if (!isRecord(payload) || !Array.isArray(payload.blockStateCalls)) throw new Error('Invalid simulation request') + const balance = encodeFunctionReturn(Multicall3ABI, 'getEthBalance', [0n]) + const aggregate = encodeFunctionReturn(Multicall3ABI, 'aggregate3', [[{ success: true, returnData: balance }]]) + result = serialize(EthSimulateV1Result, payload.blockStateCalls.map((stateCall: unknown, index: number) => { + if (!isRecord(stateCall) || !Array.isArray(stateCall.calls)) throw new Error('Invalid simulation calls') + return { number: block.number + BigInt(index + 1), hash: 0x1234n, timestamp: BigInt(Math.floor(Date.now() / 1000)), gasLimit: 30_000_000n, gasUsed: 0n, baseFeePerGas: 1n, + calls: stateCall.calls.map(() => ({ status: 'success' as const, gasUsed: 0n, logs: [], returnData: Uint8Array.from(Buffer.from(aggregate.slice(2), 'hex')) })) } + })) + break + } + + case 'eth_getLogs': result = []; break + default: + unexpectedMethods.add(rpc.method) + return Response.json({ jsonrpc: '2.0', id: rpc.id, error: { code: -32601, message: `Unsupported benchmark RPC: ${ rpc.method }` } }) + } + rpcRequests.push({ method: rpc.method, elapsedMs: performance.now() - started }) + return Response.json({ jsonrpc: '2.0', id: rpc.id, result }, { headers: { 'Access-Control-Allow-Origin': '*' } }) + }, +}) +const networkA = { name: 'Benchmark A', chainId: '0x1', httpsRpc: `${ server.url }rpc1`, currencyName: 'Ether', currencyTicker: 'ETH', primary: true, minimized: false } +const networkB = { ...networkA, name: 'Benchmark B', httpsRpc: `${ server.url }rpc1-alternate`, primary: false } +const networkC = { ...networkA, name: 'Benchmark chain 2', chainId: '0x2', httpsRpc: `${ server.url }rpc2` } + +const fakeSigner = `(() => { + let chain = '0x1'; + const listeners = new Map(); + globalThis.__benchmarkRejectSwitch = false; + const signer = { + isMetaMask: true, selectedAddress: ${ JSON.stringify(walletA) }, isConnected: () => true, + request: async ({ method, params }) => { + if (method === 'eth_chainId') return chain; + if (method === 'eth_accounts' || method === 'eth_requestAccounts') return [${ JSON.stringify(walletA) }]; + if (method !== 'wallet_switchEthereumChain') throw new Error('Unsupported benchmark wallet method: ' + method); + await new Promise(resolve => setTimeout(resolve, ${ walletDelayMs })); + if (globalThis.__benchmarkRejectSwitch) throw Object.assign(new Error('Benchmark wallet rejected network change'), { code: 4001 }); + chain = params[0].chainId; + for (const listener of listeners.get('chainChanged') ?? []) listener(chain); + return null; + }, + on: (event, listener) => { listeners.set(event, [...listeners.get(event) ?? [], listener]); return signer; }, + removeListener: (event, listener) => { listeners.set(event, (listeners.get(event) ?? []).filter(value => value !== listener)); return signer; } + }; + globalThis.ethereum = signer; + globalThis.addEventListener('eip6963:requestProvider', () => globalThis.dispatchEvent(new CustomEvent('eip6963:announceProvider', { + detail: { info: { uuid: '12345678-1234-4234-8234-123456789abc', name: 'MetaMask', icon: 'data:image/svg+xml,', rdns: 'io.metamask' }, provider: signer } + }))); +})()` + +async function waitFor(connection: CdpConnection, expression: string, label: string) { + const deadline = Date.now() + 30_000 + while (!await connection.evaluate(expression)) { + if (Date.now() > deadline) throw new Error(`Timed out waiting for ${ label }`) + await delay(25) + } +} +const modeButton = (name: string) => `Array.from(document.querySelectorAll('.popup-home-mode-selector button')).find(button => button.textContent.trim() === ${ JSON.stringify(name) })` +const rpcButton = (name: string) => `Array.from(document.querySelectorAll('.popup-home-rpc-selector .dropdown-item')).find(button => button.textContent.trim() === ${ JSON.stringify(name) })` +const ready = `document.querySelector('.active-address-row button')?.disabled === false && !document.querySelector('.popup-home-header-layout [aria-busy="true"]')` + +type SwitchSample = { + name: string + feedbackFrameMs: number + selectionFrameMs?: number + replyMs: number + persistedMs?: number + completedFrameMs: number + ok: boolean + rpcRequests: number +} + +async function measure(popup: CdpConnection, name: string, method: string, click: string, pending: string, selected: string, expectedSuccess = true) { + await popup.send('Page.bringToFront') + await waitFor(popup, ready, 'popup ready for switching') + console.warn(`Measuring ${ name }`) + const rpcStart = rpcRequests.length + const sample = await popup.evaluate>(`(async () => { + const runtime = browser.runtime; + const original = runtime.sendMessage; + const started = performance.now(); + const sample = { name: ${ JSON.stringify(name) } }; + const errorCountBefore = document.querySelectorAll('.error-notification').length; + let replyReceived = false; + const storageKey = { popup_changeActiveAddress: 'independentActiveSimulationAddress', popup_enableSimulationMode: 'simulationMode', popup_changeActiveRpc: 'activeRpcNetwork', popup_modifyMakeMeRich: 'makeCurrentAddressRich' }[${ JSON.stringify(method) }]; + const onStorageChange = changes => { if (storageKey in changes && sample.persistedMs === undefined) sample.persistedMs = performance.now() - started; }; + browser.storage.onChanged.addListener(onStorageChange); + runtime.sendMessage = function(message, ...args) { + const promise = original.call(runtime, message, ...args); + if (message.method === ${ JSON.stringify(method) }) promise.then(reply => { + sample.replyMs = performance.now() - started; + sample.ok = reply?.ok === true; + replyReceived = true; + }, error => { sample.error = String(error); replyReceived = true; }); + return promise; + }; + try { + try { ${ click }; } catch (error) { throw new Error(${ JSON.stringify(name) } + ': ' + String(error) + ' ' + document.body.textContent); } + while (performance.now() - started < 30000) { + await new Promise((resolve, reject) => { const timeout = setTimeout(() => reject(new Error('Popup stopped rendering frames')), 30000); requestAnimationFrame(() => { clearTimeout(timeout); resolve(); }); }); + if ((${ pending }) && sample.feedbackFrameMs === undefined) sample.feedbackFrameMs = performance.now() - started; + if ((${ selected }) && sample.selectionFrameMs === undefined) sample.selectionFrameMs = performance.now() - started; + if (sample.feedbackFrameMs === undefined && (sample.selectionFrameMs !== undefined || document.querySelectorAll('.error-notification').length > errorCountBefore)) sample.feedbackFrameMs = performance.now() - started; + if (replyReceived && !(${ pending })) { + sample.completedFrameMs = performance.now() - started; + return sample; + } + } + throw new Error('Switch timed out: ' + ${ JSON.stringify(name) }); + } finally { runtime.sendMessage = original; browser.storage.onChanged.removeListener(onStorageChange); } + })()`) + if (sample.ok !== expectedSuccess) throw new Error(`Unexpected switch outcome: ${ JSON.stringify(sample) }`) + if (sample.feedbackFrameMs === undefined) throw new Error(`No switching feedback was rendered: ${ JSON.stringify(sample) }`) + if (expectedSuccess && sample.selectionFrameMs === undefined) throw new Error(`Selected value was not rendered: ${ JSON.stringify(sample) }`) + if (expectedSuccess && sample.persistedMs === undefined) throw new Error(`Successful switch did not report persistence: ${ JSON.stringify(sample) }`) + return { ...sample, rpcRequests: rpcRequests.length - rpcStart } +} + +async function runIteration() { + const chrome = await launchChromeSession() + const connections: CdpConnection[] = [] + try { + const worker = await waitForInterceptorExtensionServiceWorker(chrome.browserDebugPort, 30_000) + const workerConnection = await connectTarget(chrome.browserDebugPort, worker.id) + connections.push(workerConnection) + await waitForPerformanceMarks(workerConnection, ['interceptor:background:loaded'], 30_000) + await waitForRegisteredContentScripts(workerConnection, ['inpage', 'inpage2'], 30_000) + await workerConnection.evaluate(`browser.storage.local.set(${ JSON.stringify({ + simulationMode: true, useSignersAddressAsActiveAddress: false, independentActiveSimulationAddress: walletA, + makeCurrentAddressRich: false, rpcEntries: [networkA, networkB, networkC], + websiteAccess: [{ website: { websiteOrigin: server.url.host }, access: true, addressAccess: [walletA, walletB].map(address => ({ address, access: true })) }], + userAddressBookEntriesV3: [walletA, walletB].map((address, index) => ({ type: 'contact', address, name: `Wallet ${ index === 0 ? 'A' : 'B' }`, entrySource: 'User', useAsActiveAddress: true, askForAddressAccess: false })), + }) })`) + const popup = await connectTarget(chrome.browserDebugPort, await createTargetPage(chrome.browserConnection, `chrome-extension://${ new URL(worker.url).host }/html3/popupV3.html`)) + connections.push(popup) + await waitFor(popup, `typeof browser !== 'undefined'`, 'popup runtime') + await popup.evaluate(`browser.runtime.sendMessage({ method: 'popup_changeActiveRpc', data: ${ JSON.stringify(networkA) } })`) + const page = await connectTarget(chrome.browserDebugPort, await createTargetPage(chrome.browserConnection, 'about:blank')) + connections.push(page) + await page.send('Page.enable') + await page.send('Page.addScriptToEvaluateOnNewDocument', { source: fakeSigner }) + await page.send('Page.navigate', { url: server.url.toString() }) + await waitFor(page, `globalThis.__interceptorChromeCommunicationState?.phase === 'access-granted'`, 'fixture account access') + await popup.evaluate(`browser.runtime.sendMessage({ method: 'popup_requestNewHomeData', data: { refreshSignerAccounts: true, includeWebsiteAccessAddressMetadata: false } })`) + const samples: SwitchSample[] = [] + await waitFor(popup, ready, 'ready popup') + await popup.evaluate(`Array.from(document.querySelectorAll('.active-address-row button')).find(button => button.textContent.trim() === 'Change').click()`) + await waitFor(popup, `Array.from(document.querySelectorAll('.modal-card-body .card.hoverable')).some(card => card.textContent.includes('Wallet B'))`, 'wallet selector') + samples.push(await measure(popup, 'wallet', 'popup_changeActiveAddress', `Array.from(document.querySelectorAll('.modal-card-body .card.hoverable')).find(card => card.textContent.includes('Wallet B')).click()`, `!!document.querySelector('.active-address-row[aria-busy="true"]')`, `document.querySelector('.active-address-row')?.textContent.includes('Wallet B')`)) + samples.push(await measure(popup, 'rich on', 'popup_modifyMakeMeRich', `document.querySelector('input[type="checkbox"]').click()`, `document.body.textContent.includes('Updating balances...')`, `document.querySelector('input[type="checkbox"]')?.checked === true`)) + samples.push(await measure(popup, 'rich off', 'popup_modifyMakeMeRich', `document.querySelector('input[type="checkbox"]').click()`, `document.body.textContent.includes('Updating balances...')`, `document.querySelector('input[type="checkbox"]')?.checked === false`)) + samples.push(await measure(popup, 'RPC endpoint', 'popup_changeActiveRpc', `${ rpcButton(networkB.name) }.click()`, `!!document.querySelector('.popup-home-rpc-selector [role="status"]')`, `document.querySelector('.popup-home-rpc-selector .dropdown-trigger button')?.title === ${ JSON.stringify(networkB.name) }`)) + samples.push(await measure(popup, 'signing', 'popup_enableSimulationMode', `${ modeButton('Signing') }.click()`, `${ modeButton('Signing') }?.getAttribute('aria-busy') === 'true'`, `${ modeButton('Signing') }?.classList.contains('is-outlined') === false`)) + await page.evaluate('globalThis.__benchmarkRejectSwitch = true') + const beforeRejection = await workerConnection.evaluate(`browser.storage.local.get(['activeRpcNetwork', 'rpcEntries'])`) + samples.push(await measure(popup, 'wallet RPC rejection', 'popup_changeActiveRpc', `${ rpcButton(networkC.name) }.click()`, `!!document.querySelector('.popup-home-rpc-selector [role="status"]')`, 'false', false)) + const afterRejection = await workerConnection.evaluate(`browser.storage.local.get(['activeRpcNetwork', 'rpcEntries'])`) + if (JSON.stringify(beforeRejection) !== JSON.stringify(afterRejection)) throw new Error('Rejected switch changed persisted RPC state') + await page.evaluate('globalThis.__benchmarkRejectSwitch = false') + samples.push(await measure(popup, 'wallet RPC acceptance', 'popup_changeActiveRpc', `${ rpcButton(networkC.name) }.click()`, `!!document.querySelector('.popup-home-rpc-selector [role="status"]')`, `document.querySelector('.popup-home-rpc-selector .dropdown-trigger button')?.title === ${ JSON.stringify(networkC.name) }`)) + samples.push(await measure(popup, 'simulating', 'popup_enableSimulationMode', `${ modeButton('Simulating') }.click()`, `${ modeButton('Simulating') }?.getAttribute('aria-busy') === 'true'`, `${ modeButton('Simulating') }?.classList.contains('is-outlined') === false`)) + return samples + } finally { + for (const connection of connections) connection.close() + await chrome.close() + } +} +function timingStats(values: number[]) { + const sorted = values.toSorted((first, second) => first - second) + return { minMs: sorted[0], medianMs: sorted[Math.floor(sorted.length / 2)], maxMs: sorted.at(-1) } +} + +async function main() { + const samples: SwitchSample[] = [] + for (let iteration = 0; iteration < iterations; iteration++) samples.push(...await runIteration()) + for (const sample of samples.filter(sample => sample.name.startsWith('wallet RPC'))) { + if (sample.replyMs < walletDelayMs) throw new Error('Wallet switch completed before the fixture wallet replied') + } + if (unexpectedMethods.size > 0) throw new Error(`Missing fixture RPC methods: ${ [...unexpectedMethods].join(', ') }`) + const summaries = [...new Set(samples.map(sample => sample.name))].map(name => { + const group = samples.filter(sample => sample.name === name) + return { + name, + feedback: timingStats(group.map(sample => sample.feedbackFrameMs)), + persistence: timingStats(group.flatMap(sample => sample.persistedMs === undefined ? [] : [sample.persistedMs])), + reply: timingStats(group.map(sample => sample.replyMs)), + selection: timingStats(group.flatMap(sample => sample.selectionFrameMs === undefined ? [] : [sample.selectionFrameMs])), + completion: timingStats(group.map(sample => sample.completedFrameMs)), + } + }) + process.stdout.write(JSON.stringify({ rpcDelayMs, walletDelayMs, iterations, fixture: 'empty stack, local RPC, fake EIP-6963 wallet', summaries, samples }, undefined, 2) + '\n') +} +try { await main() } finally { server.stop(true) } diff --git a/test/tests/backgroundUtilsMessaging.test.ts b/test/tests/backgroundUtilsMessaging.test.ts index 819f4132a..35a7dabdc 100644 --- a/test/tests/backgroundUtilsMessaging.test.ts +++ b/test/tests/backgroundUtilsMessaging.test.ts @@ -1,3 +1,4 @@ +import { createEthereumWithGetBlockCounter } from './backgroundEthAccountsTestHarness.js' import * as assert from 'assert' import { describe, test } from 'bun:test' @@ -203,11 +204,12 @@ describe('backgroundUtils messaging', () => { globalThis.browser.runtime.sendMessage = async () => undefined const { popupMessageHandler, PopupRequestsReplies } = await loadModules() + const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) const reply = await popupMessageHandler( - new Map() as unknown as import('../../app/ts/types/user-interface-types.js').WebsiteTabConnections, - {} as unknown as import('../../app/ts/simulation/services/EthereumClientService.js').EthereumClientService, - {} as unknown as import('../../app/ts/simulation/services/priceEstimator.js').TokenPriceService, - (() => undefined) as unknown as import('../../app/ts/simulation/serviceLifecycle.js').ResetSimulationServices, + new Map(), + ethereum, + tokenPriceService, + resetSimulationServices, { method: 'popup_requestCompleteVisualizedSimulation' }, { activeSimulationAddress: 0xd8da6bf26964af9d7eed9e03e53415d37aa96045n, diff --git a/test/tests/popupClearReset.test.ts b/test/tests/popupClearReset.test.ts index bf64afc3d..c3d4e74aa 100644 --- a/test/tests/popupClearReset.test.ts +++ b/test/tests/popupClearReset.test.ts @@ -425,6 +425,20 @@ describe('popup clear reset', () => { assert.equal(getSimulationStateChangedMessages(browserMock.sentMessages).length, 0) }) + test('renders the captured refresh input and rich count after live settings change', async () => { + browserMock.reset() + await browserStorageLocalSet({ independentActiveSimulationAddress: activeAddress, makeCurrentAddressRich: false, interceptorTransactionStack: { operations: [] } }) + const modules = await modulesPromise + const snapshot = { simulationStateInput: await modules.getCurrentSimulationInput(), numberOfAddressesMadeRich: 0 } + await browserStorageLocalSet({ makeCurrentAddressRich: true }) + assert.notDeepEqual(await modules.getCurrentSimulationInput(), snapshot.simulationStateInput) + const result = await updatePopupVisualisationIfNeeded(fakeEthereum, fakeTokenPriceService, false, false, false, snapshot) + assert.equal(result.numberOfAddressesMadeRich, 0) + assert.equal(result.simulationState.kind, 'simulated') + if (result.simulationState.kind !== 'simulated') throw new Error('Expected a simulated snapshot') + assert.deepEqual(result.simulationState.value.simulationStateInput, snapshot.simulationStateInput) + }) + test('updates the cached popup active address without restamping the simulation', async () => { browserMock.reset() const nextActiveAddress = defaultActiveAddresses.find((entry) => entry.address !== activeAddress)?.address diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index e133f149f..5188d7328 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -1,7 +1,7 @@ import * as assert from 'assert' import { describe, test } from 'bun:test' import { confirmedSignerOwnership, createDeferredValue, createEthereumWithGetBlockCounter, createPort, installBrowserMock, loadModules, waitForPortMessageCount } from './backgroundEthAccountsTestHarness.js' -import type { PopupSimulationRefresh } from '../../app/ts/background/popupSimulationRefresh.js' +import type { RevisionedPopupSimulationRefresh } from '../../app/ts/background/popupSimulationRefresh.js' describe('popup settings changes', () => { test('coalesces refreshes and waits for changes arriving during an active refresh', async () => { @@ -9,20 +9,21 @@ describe('popup settings changes', () => { const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') const first = createDeferredValue() const last = createDeferredValue() - const calls: PopupSimulationRefresh[] = [] + const calls: RevisionedPopupSimulationRefresh[] = [] const refresh = createPopupSimulationRefresher(async (services) => { calls.push(services) return await (calls.length === 1 ? first.promise : last.promise) }) - const services = createEthereumWithGetBlockCounter({ count: 0 }) + const services = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'first' } const result = refresh(services) assert.equal(refresh({ ...services, invalidateOldState: true }), result) await Promise.resolve() assert.equal(calls.length, 1) assert.equal(calls[0]?.invalidateOldState, true) - const newerServices = createEthereumWithGetBlockCounter({ count: 0 }) + assert.equal(refresh(services), result) + const newerServices = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'second' } assert.equal(refresh({ ...services, invalidateOldState: true }), result) - assert.equal(refresh(newerServices), result) + assert.equal(refresh({ ...newerServices, invalidateOldState: true }), result) let completed = false void result.then(() => { completed = true }) first.resolve(true) @@ -35,6 +36,45 @@ describe('popup settings changes', () => { assert.equal(await result, false) }) + for (const change of ['same', 'revision', 'provider', 'force'] as const) { + test(`shares only refresh work that covers the requested revision and invalidation (${ change })`, async () => { + installBrowserMock() + const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') + const release = createDeferredValue() + let calls = 0 + const refresh = createPopupSimulationRefresher(async () => { calls++; return await release.promise }) + const services = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'one' } + const pending = refresh(services) + await Promise.resolve() + const next = change === 'provider' ? { ...services, ...createEthereumWithGetBlockCounter({ count: 0 }) } + : change === 'revision' ? { ...services, revision: 'two' } + : change === 'force' ? { ...services, invalidateOldState: true } : services + for (let i = 0; i < 5; i++) assert.equal(refresh(next), pending) + release.resolve(true) + assert.equal(await pending, true) + assert.equal(calls, change === 'same' ? 1 : 2) + // Completed work never suppresses a later retry or explicit refresh. + await refresh(next) + assert.equal(calls, change === 'same' ? 2 : 3) + }) + } + + test('keeps the latest A request when B was queued during an active A refresh', async () => { + installBrowserMock() + const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') + const release = createDeferredValue() + const revisions: (string | symbol)[] = [] + const refresh = createPopupSimulationRefresher(async (services) => { revisions.push(services.revision); return await release.promise }) + const services = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'A' } + const pending = refresh(services) + await Promise.resolve() + refresh({ ...services, revision: 'B' }) + refresh(services) + release.resolve(true) + await pending + assert.deepEqual(revisions, ['A', 'A']) + }) + test('allows retry after a rejected refresh', async () => { installBrowserMock() const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') @@ -43,11 +83,64 @@ describe('popup settings changes', () => { if (++attempts === 1) throw new Error('Refresh failed') return true }) - const services = createEthereumWithGetBlockCounter({ count: 0 }) + const services = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'retry' } await assert.rejects(refresh(services), /Refresh failed/) assert.equal(await refresh(services), true) }) + test('coordinates settings changes across dispatchers without blocking wallet replies or reads', async () => { + installBrowserMock() + const { changeSimulationMode, getSettings, saveCurrentTabId, websiteSocketToString } = await loadModules() + const { dispatchPopupMessage } = await import('../../app/ts/background/popupMessageDispatcher.js') + const { getConfirmedSignerStateToken } = await import('../../app/ts/background/signerStateOwnership.js') + const { resolveSignerChainChange } = await import('../../app/ts/background/windows/changeChain.js') + await changeSimulationMode({ simulationMode: false }) + await saveCurrentTabId(1) + const socket = { tabId: 1, connectionName: 0n } + const { port, messages } = createPort(1) + const connections = new Map([[1, { ...confirmedSignerOwnership(socket), connections: { + [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'https://example.test', approved: true, wantsToConnect: true }, + } }]]) + const settings = await getSettings() + const context = { + ...createEthereumWithGetBlockCounter({ count: 0 }), settings, websiteTabConnections: connections, + publishRpcConnectionStatus: async () => undefined, + simulationAbortController: new AbortController(), confirmTransactionAbortController: new AbortController(), resetSimulationState: async () => undefined, + } + const rpc = { ...settings.activeRpcNetwork, chainId: 2n, httpsRpc: 'https://other.example.test' } + const pending = dispatchPopupMessage(context, { method: 'popup_changeActiveRpc', data: rpc }) + try { + await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) + for (const request of [ + { method: 'popup_changeActiveRpc', data: rpc }, + { method: 'popup_enableSimulationMode', data: true }, + { method: 'popup_modifyMakeMeRich', data: { address: 'CurrentAddress', add: true } }, + { method: 'popup_changeActiveAddress', data: { simulationMode: true, activeAddress: 2n } }, + ] as const) { + const reply = await dispatchPopupMessage({ ...context }, request) + assert.ok(reply !== undefined && 'ok' in reply && !reply.ok && reply.message.includes('Another popup')) + } + assert.equal((await getSettings()).simulationMode, false) + await dispatchPopupMessage({ ...context }, { method: 'popup_requestSimulationMode' }) + } finally { + const token = getConfirmedSignerStateToken(connections, 1) + if (token === undefined) throw new Error('Missing signer token') + resolveSignerChainChange(token, { method: 'popup_signerChangeChainDialog', data: [{ accept: false, chainId: 2n, error: { code: 4001, message: 'Rejected' } }] }) + await pending + } + const retry = await dispatchPopupMessage(context, { method: 'popup_enableSimulationMode', data: false }) + assert.deepEqual(retry, { type: 'PopupSettingsChangeReply', ok: true }) + const setStorage = browser.storage.local.set + try { + Object.defineProperty(browser.storage.local, 'set', { configurable: true, value: async () => { throw new Error('Storage unavailable') } }) + await assert.rejects(dispatchPopupMessage(context, { method: 'popup_modifyMakeMeRich', data: { address: 'CurrentAddress', add: true } }), /Storage unavailable/) + } finally { + Object.defineProperty(browser.storage.local, 'set', { configurable: true, value: setStorage }) + } + assert.deepEqual(await dispatchPopupMessage(context, { method: 'popup_enableSimulationMode', data: false }), { type: 'PopupSettingsChangeReply', ok: true }) + + }) + test('skips work when reselecting the current mode or RPC', async () => { const { runtimeMessages } = installBrowserMock() const { changeSimulationMode, getSettings } = await loadModules() diff --git a/test/tests/uiBoundaryFixes.test.tsx b/test/tests/uiBoundaryFixes.test.tsx index bab794af6..d88b5b234 100644 --- a/test/tests/uiBoundaryFixes.test.tsx +++ b/test/tests/uiBoundaryFixes.test.tsx @@ -1,5 +1,7 @@ import * as assert from 'assert' import { describe, test } from 'bun:test' +import { installBrowserMock } from './backgroundEthAccountsTestHarness.js' +import { requestPopupSettingsChange } from '../../app/ts/components/popupSettingsChange.js' import { signal } from '@preact/signals' import { render } from 'preact' import { act } from 'preact/test-utils' @@ -212,6 +214,25 @@ describe('UI boundary fixes', () => { assert.deepEqual(operations, [`change-active:${ fallbackRpc.httpsRpc }`]) }) + for (const operation of ['edit', 'remove'] as const) { + test(`keeps the RPC list and dialog intact when the background rejects an active RPC ${ operation }`, async () => { + installBrowserMock() + Object.defineProperty(browser.runtime, 'sendMessage', { configurable: true, value: async () => ({ type: 'PopupSettingsChangeReply', ok: false, message: 'Another popup is changing settings.' }) }) + const active = { name: 'Active', chainId: 1n, httpsRpc: 'https://active.example', currencyName: 'Ether', currencyTicker: 'ETH', primary: true, minimized: false } + const fallback = { ...active, httpsRpc: 'https://fallback.example', primary: false } + let persisted = false + let closed = false + const persist = async () => { persisted = true } + const change = async (entry: typeof active) => await requestPopupSettingsChange({ method: 'popup_changeActiveRpc', data: entry }) + await assert.rejects(completeRpcFormMutation(async () => { + if (operation === 'edit') await saveRpcEntryAndKeepActiveRpcConsistent({ ...active, name: 'Edited' }, [active, fallback], active, persist, change) + else await removeRpcEntryAndKeepActiveRpcConsistent(active.httpsRpc, [active, fallback], active, persist, change) + }, () => { closed = true }), /Another popup/) + assert.equal(persisted, false) + assert.equal(closed, false) + }) + } + test('requires a confirmed same-chain fallback before removing an active RPC', async () => { const activeRpc = { name: 'Active', chainId: 1n, httpsRpc: 'https://active.example', currencyName: 'Ether', currencyTicker: 'ETH', primary: true, minimized: false } const crossChainRpc = { ...activeRpc, name: 'Other chain', chainId: 2n, httpsRpc: 'https://other-chain.example', primary: false } From 672a65ef55b5f1984b6ae58b6d4e20efeeddf0be Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 09:15:22 +0000 Subject: [PATCH 05/31] Recover stalled wallet switches and share popup pending status --- app/ts/background/activeSettings.ts | 5 +- app/ts/background/popupMessageDispatcher.ts | 17 +++- app/ts/background/providerMessageHandlers.ts | 33 ++++--- app/ts/background/windows/changeChain.ts | 35 ++++++- app/ts/components/App.tsx | 18 +++- .../hooks/useLiveSimulationHomeData.ts | 16 +-- app/ts/types/interceptor-messages.ts | 12 +++ app/ts/types/popupMessageProtocol.ts | 1 + test/benchmarks/README.md | 6 +- test/benchmarks/popupSwitchingChrome.ts | 80 +++++++++++++-- test/tests/popupSettingsChanges.test.ts | 98 ++++++++++++++++++- test/tests/simulationVisualizerOpen.test.tsx | 25 +++++ 12 files changed, 304 insertions(+), 42 deletions(-) diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index 90a519b71..91c9bd5ef 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -2,7 +2,7 @@ import { refreshPopupSimulation } from './popupSimulationRefresh.js' import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' import type { ResetSimulationServices } from '../simulation/serviceLifecycle.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' -import type { RpcNetwork } from '../types/rpc.js' +import { RpcNetwork } from '../types/rpc.js' import type { WebsiteTabConnections } from '../types/user-interface-types.js' import { Semaphore } from '../utils/semaphore.js' import { sendActiveAccountChangeToApprovedWebsitePorts, sendMessageToApprovedWebsitePorts, updateWebsiteApprovalAccesses } from './accessManagement.js' @@ -159,7 +159,8 @@ export async function activateAddressSelection( export async function changeActiveRpc(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, simulationMode: boolean, signerTabId: number | undefined) { const currentRpc = (await getSettings()).activeRpcNetwork - if (currentRpc.chainId === rpcNetwork.chainId && currentRpc.httpsRpc === rpcNetwork.httpsRpc) { + // Metadata edits at the same endpoint still need to update the active selection. + if (JSON.stringify(RpcNetwork.serialize(currentRpc)) === JSON.stringify(RpcNetwork.serialize(rpcNetwork))) { return simulationMode ? { type: 'completedLocally' as const } : { type: 'signerRequestNotNeeded' as const } } if (simulationMode) { diff --git a/app/ts/background/popupMessageDispatcher.ts b/app/ts/background/popupMessageDispatcher.ts index fa87d967c..6b3091f08 100644 --- a/app/ts/background/popupMessageDispatcher.ts +++ b/app/ts/background/popupMessageDispatcher.ts @@ -1,3 +1,5 @@ +import { sendPopupMessageToOpenWindows } from './backgroundUtils.js' +import type { PopupSettingsChangeStatus } from '../types/interceptor-messages.js' import { getSettings } from './settings.js' import { refreshPopupSimulation } from './popupSimulationRefresh.js' import type { PopupMessage } from '../types/interceptor-messages.js' @@ -15,6 +17,7 @@ import { websiteAccessPopupMessageHandlers } from './popupMessageHandlerRegistri export type { PopupMessageDispatcherContext } from './popupMessageHandlerRegistry.js' const popupMessageHandlers = { + popup_requestSettingsChangeStatus: popupMessageHandler('popup_requestSettingsChangeStatus', async () => await publishSettingsChangeStatus()), popup_confirmDialog: popupMessageHandler('popup_confirmDialog', async (context, request) => await confirmDialog(context.ethereum, context.tokenPriceService, context.websiteTabConnections, request)), popup_changeActiveAddress: popupMessageHandler('popup_changeActiveAddress', async (context, request) => await changeActiveAddress(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), popup_modifyMakeMeRich: popupMessageHandler('popup_modifyMakeMeRich', async (context, request) => { @@ -71,21 +74,27 @@ const popupMessageHandlers = { ...websiteAccessPopupMessageHandlers, } satisfies PopupMessageHandlerMap -let settingsChangePending = false +let settingsChangeStatus: PopupSettingsChangeStatus['data'] = { revision: Date.now(), operation: undefined } +const publishSettingsChangeStatus = async () => await sendPopupMessageToOpenWindows({ method: 'popup_settingsChangeStatus', data: settingsChangeStatus }) +function setSettingsChangeOperation(operation: PopupSettingsChangeStatus['data']['operation']) { + settingsChangeStatus = { revision: Math.max(Date.now(), settingsChangeStatus.revision + 1), operation } +} export async function dispatchPopupMessage(context: PopupMessageDispatcherContext, request: PopupMessage): Promise { const isSettingsChange = request.method === 'popup_changeActiveAddress' || request.method === 'popup_enableSimulationMode' || request.method === 'popup_changeActiveRpc' || request.method === 'popup_modifyMakeMeRich' if (!isSettingsChange) return await popupMessageHandlers[request.method](context, request) - if (settingsChangePending) return { + if (settingsChangeStatus.operation !== undefined) return { type: request.method === 'popup_changeActiveAddress' ? 'ChangeActiveAddressReply' : 'PopupSettingsChangeReply', ok: false, message: 'Another popup is changing settings. Please wait for it to finish, then try again.', } // Admit before the first await. Provider callbacks and read requests remain available while a wallet reply is pending. - settingsChangePending = true + setSettingsChangeOperation(request.method === 'popup_changeActiveAddress' ? 'wallet' : request.method === 'popup_enableSimulationMode' ? 'mode' : request.method === 'popup_changeActiveRpc' ? 'rpc' : 'rich') try { + await publishSettingsChangeStatus() return await popupMessageHandlers[request.method]({ ...context, settings: await getSettings() }, request) } finally { - settingsChangePending = false + setSettingsChangeOperation(undefined) + await publishSettingsChangeStatus() } } diff --git a/app/ts/background/providerMessageHandlers.ts b/app/ts/background/providerMessageHandlers.ts index b6a9a3e0b..c707e2043 100644 --- a/app/ts/background/providerMessageHandlers.ts +++ b/app/ts/background/providerMessageHandlers.ts @@ -6,10 +6,10 @@ import { activateAddressSelection, changeActiveAddressAndChain } from './activeS import { getSocketFromPort, sendInternalWindowMessage, sendPopupMessageToOpenWindows } from './backgroundUtils.js' import { getRpcNetworkForChain, promoteRpcAsPrimary, setDefaultSignerName, updatePendingTransactionOrMessage, updateTabState } from './storageVariables.js' import { getMetamaskCompatibilityMode, getSettings } from './settings.js' -import { getPendingSignerChainChangeRpc, getPendingSignerChainChangeTokenForCallback, isPendingSignerChainChangeReply, resolveSignerChainChange } from './windows/changeChain.js' +import { consumeExpiredSignerChainReply, markSignerChainReplyReceived, getPendingSignerChainChangeRpc, getPendingSignerChainChangeTokenForCallback, isPendingSignerChainChangeReply, resolveSignerChainChange } from './windows/changeChain.js' import { type ApprovalState, withSuppressedUnscopedConnectionEventsForSocketAsync } from './accessManagement.js' import type { ProviderMessage } from '../utils/requests.js' -import { METAMASK_ERROR_USER_REJECTED_REQUEST } from '../utils/constants.js' +import { JSON_RPC_ERROR_CODE_INTERNAL_ERROR, METAMASK_ERROR_USER_REJECTED_REQUEST } from '../utils/constants.js' import { reportUnexpectedError } from '../utils/errors.js' import { refreshPendingSafeSignerSelectionErrors, resolvePendingTransactionOrMessage, updateConfirmTransactionView } from './windows/confirmTransaction.js' import { resolveWatchAssetSignerReply } from './windows/watchAsset.js' @@ -179,6 +179,7 @@ export async function walletSwitchEthereumChainReply(ethereum: EthereumClientSer return await runSignerStateOperation(websiteTabConnections, socket.tabId, async () => { const currentSignerStateToken = getConfirmedSignerStateToken(websiteTabConnections, socket.tabId) if (currentSignerStateToken?.socket.connectionName !== socket.connectionName || currentSignerStateToken.port !== port) return returnValue + if (consumeExpiredSignerChainReply(port, params.signerProviderGeneration, params.chainId)) return returnValue const pendingSignerStateToken = getPendingSignerChainChangeTokenForCallback(port, params.signerProviderGeneration, params.chainId) const callbackSignerStateToken = pendingSignerStateToken ?? (currentSignerStateToken.signerProviderGeneration === params.signerProviderGeneration ? currentSignerStateToken : undefined) @@ -193,16 +194,26 @@ export async function walletSwitchEthereumChainReply(ethereum: EthereumClientSer }) return returnValue } - if (params.accept) { - const requestedRpc = getPendingSignerChainChangeRpc(callbackSignerStateToken, params.chainId) - await changeSignerChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, currentSignerStateToken, params.chainId, 'hasAccess', requestedRpc) - const activeRpc = (await getSettings()).activeRpcNetwork - if (requestedRpc !== undefined && activeRpc.chainId === requestedRpc.chainId && activeRpc.httpsRpc === requestedRpc.httpsRpc) await promoteRpcAsPrimary(requestedRpc) + markSignerChainReplyReceived(callbackSignerStateToken, params.chainId) + try { + if (params.accept) { + const requestedRpc = getPendingSignerChainChangeRpc(callbackSignerStateToken, params.chainId) + await changeSignerChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, currentSignerStateToken, params.chainId, 'hasAccess', requestedRpc) + const activeRpc = (await getSettings()).activeRpcNetwork + if (requestedRpc !== undefined && activeRpc.chainId === requestedRpc.chainId && activeRpc.httpsRpc === requestedRpc.httpsRpc) await promoteRpcAsPrimary(requestedRpc) + } + resolveSignerChainChange(callbackSignerStateToken, { + method: 'popup_signerChangeChainDialog', + data: [params], + }) + } catch (error) { + // Delivery ended the wallet deadline; a failure while applying the reply must also release the waiting popup. + resolveSignerChainChange(callbackSignerStateToken, { + method: 'popup_signerChangeChainDialog', + data: [{ accept: false, chainId: params.chainId, signerProviderGeneration: params.signerProviderGeneration, error: { code: JSON_RPC_ERROR_CODE_INTERNAL_ERROR, message: 'The wallet replied, but updating the selected network failed. Refresh the popup and try again.' } }], + }) + throw error } - resolveSignerChainChange(callbackSignerStateToken, { - method: 'popup_signerChangeChainDialog', - data: [params], - }) return returnValue }) } diff --git a/app/ts/background/windows/changeChain.ts b/app/ts/background/windows/changeChain.ts index 6b86921f6..3c121f7c7 100644 --- a/app/ts/background/windows/changeChain.ts +++ b/app/ts/background/windows/changeChain.ts @@ -14,7 +14,7 @@ import type { EthereumClientService } from '../../simulation/services/EthereumCl import type { TokenPriceService } from '../../simulation/services/priceEstimator.js' import type { ResetSimulationServices } from '../../simulation/serviceLifecycle.js' import { type PopupOrTab, addWindowTabListeners, closePopupOrTabById, getPopupOrTabById, openPopupOrTab, removeWindowTabListeners } from '../../utils/popupOrTab.js' -import { addSignerStateReplacementListener, doSignerStateTokensMatch, signerUnavailableError, type SignerStateToken } from '../signerStateOwnership.js' +import { addSignerStateReplacementListener, doSignerStateTokensMatch, getConfirmedSignerStateToken, signerUnavailableError, type SignerStateToken } from '../signerStateOwnership.js' let pendForUserReply: Future | undefined @@ -22,7 +22,9 @@ type PendingSignerChainChange = { readonly future: Future< | { readonly type: 'reply', readonly confirmation: SignerChainChangeConfirmation } | { readonly type: 'replacement', readonly error: typeof signerUnavailableError } + | { readonly type: 'timeout' } > + timeout: ReturnType | undefined readonly requestTabId: number readonly requestedRpcNetwork: RpcNetwork signerStateToken: SignerStateToken | undefined @@ -31,6 +33,22 @@ type PendingSignerChainChange = { } let pendingSignerChainChange: PendingSignerChainChange | undefined +// The wallet protocol has no per-command identifier. Keep timed-out commands isolated until their reply or a new signer generation, so a late reply cannot complete a retry. +const expiredSignerChainChanges = new WeakMap() +const WALLET_SWITCH_TIMEOUT_MS = 120_000 + +export function consumeExpiredSignerChainReply(port: browser.runtime.Port, signerProviderGeneration: number, chainId: bigint) { + const expired = expiredSignerChainChanges.get(port) + if (expired === undefined || expired.token.signerProviderGeneration !== signerProviderGeneration || expired.chainId !== chainId) return false + expiredSignerChainChanges.delete(port) + return true +} + +export function markSignerChainReplyReceived(token: SignerStateToken, chainId: bigint) { + const pending = pendingSignerChainChange + if (pending !== undefined && doesPendingSignerChainChangeMatch(pending, token, chainId)) clearTimeout(pending.timeout) +} + let chainChangeResolutionInProgress = false let openedDialog: PopupOrTab | undefined @@ -95,6 +113,8 @@ export function getPendingSignerChainChangeRpc(signerStateToken: SignerStateToke } export function resolveSignerChainChange(signerStateToken: SignerStateToken, confirmation: SignerChainChangeConfirmation) { + if (consumeExpiredSignerChainReply(signerStateToken.port, signerStateToken.signerProviderGeneration, confirmation.data[0].chainId)) return false + markSignerChainReplyReceived(signerStateToken, confirmation.data[0].chainId) const pending = pendingSignerChainChange if (pending === undefined || !doesPendingSignerChainChangeMatch(pending, signerStateToken, confirmation.data[0].chainId)) return false if (pending.signerStateToken === undefined) { @@ -203,12 +223,17 @@ async function resolve(ethereum: EthereumClientService, tokenPriceService: Token return userDeniedChange } -export async function requestSignerChainChange(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, requestTabId: number) { +export async function requestSignerChainChange(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, requestTabId: number, timeoutMs = WALLET_SWITCH_TIMEOUT_MS) { if (pendingSignerChainChange !== undefined) return { error: { code: -32002, message: 'A network switch is already waiting for your wallet.' } } + const currentToken = getConfirmedSignerStateToken(websiteTabConnections, requestTabId) + const expired = currentToken === undefined ? undefined : expiredSignerChainChanges.get(currentToken.port) + if (expired !== undefined && currentToken !== undefined && expired.token.signerProviderGeneration === currentToken.signerProviderGeneration) return { error: { code: -32002, message: 'The previous network request is still open in your wallet. Dismiss it or reconnect the wallet before trying again.' } } const pending: PendingSignerChainChange = { + timeout: undefined, future: new Future< | { readonly type: 'reply', readonly confirmation: SignerChainChangeConfirmation } | { readonly type: 'replacement', readonly error: typeof signerUnavailableError } + | { readonly type: 'timeout' } >(), requestTabId: requestTabId, requestedRpcNetwork: rpcNetwork, @@ -232,6 +257,10 @@ export async function requestSignerChainChange(ethereum: EthereumClientService, : { error: signerUnavailableError } as const } pending.signerStateToken = changeActiveRpcResult.signerStateToken + pending.timeout = setTimeout(() => { + expiredSignerChainChanges.set(changeActiveRpcResult.signerStateToken.port, { token: changeActiveRpcResult.signerStateToken, chainId: rpcNetwork.chainId }) + pending.future.resolve({ type: 'timeout' }) + }, timeoutMs) const precedingReply = pending.repliesBeforeToken.find(({ signerStateToken, confirmation }) => { return doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, signerStateToken) && confirmation.data[0].chainId === pending.requestedRpcNetwork.chainId @@ -240,10 +269,12 @@ export async function requestSignerChainChange(ethereum: EthereumClientService, const precedingReplacement = pending.replacementsBeforeToken.find(({ signerStateToken }) => doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, signerStateToken)) if (precedingReplacement !== undefined) pending.future.resolve({ type: 'replacement', error: precedingReplacement.error }) const signerResult = await pending.future + if (signerResult.type === 'timeout') return { error: { code: -32002, message: 'Your wallet did not answer the network request in time. Other settings are available again. Dismiss the request in your wallet or reconnect it before retrying.' } } if (signerResult.type === 'replacement') return { error: signerResult.error } as const if (signerResult.confirmation.data[0].accept === false) return { error: signerResult.confirmation.data[0].error } as const // forward signers error to the application if (signerResult.confirmation.data[0].chainId === rpcNetwork.chainId) return { result: null } } finally { + clearTimeout(pending.timeout) removeReplacementListener() if (pendingSignerChainChange === pending) pendingSignerChainChange = undefined } diff --git a/app/ts/components/App.tsx b/app/ts/components/App.tsx index 98d086f2e..4b317627d 100644 --- a/app/ts/components/App.tsx +++ b/app/ts/components/App.tsx @@ -4,7 +4,7 @@ import Hint from './subcomponents/Hint.js' import { getAddress, isAddress } from '../utils/ethereumPrimitives.js' import { PasteCatcher } from './subcomponents/PasteCatcher.js' import { truncateAddr } from '../utils/ethereum.js' -import type { Settings } from '../types/interceptor-messages.js' +import type { PopupSettingsChangeStatus, Settings } from '../types/interceptor-messages.js' import { version, gitCommitSha } from '../version.js' import { sendPopupMessageToBackgroundPage } from '../background/backgroundUtils.js' import type { EthereumBytes32 } from '../types/wire-types.js' @@ -32,6 +32,7 @@ export function App() { const pendingAddressChangeRequestId = useSignal(undefined) const isActiveAddressChanging = useSignal(false) const pendingSettingsChange = useSignal(false) + const backgroundSettingsChange = useSignal({ revision: 0, operation: undefined }) const { activeAddresses, walletSelectedAddressBookEntry, @@ -71,6 +72,9 @@ export function App() { if (!settings.simulationMode) displayedSigningAddress.value = activeAddress isActiveAddressChanging.value = false }, + onSettingsChangeStatus(status) { + if (status.revision >= backgroundSettingsChange.value.revision) backgroundSettingsChange.value = status + }, onInitialSettings(settings: Settings) { if (appPage.value.page !== 'Unknown') return if (settings.openedPage.page === 'AddNewAddress' || settings.openedPage.page === 'ModifyAddress') { @@ -82,10 +86,11 @@ export function App() { }) const boundaryResetKey = useSignal(0) const isActiveAddressChangePending = useComputed(() => pendingAddressChangeRequestId.value !== undefined) - const isSettingsChangePending = useComputed(() => isActiveAddressChangePending.value || pendingSettingsChange.value) + const isSettingsChangePending = useComputed(() => isActiveAddressChangePending.value || pendingSettingsChange.value || backgroundSettingsChange.value.operation !== undefined) async function setActiveAddressAndInformAboutIt(address: bigint | 'signer', persistedEntry?: AddressBookEntry) { - if (!isSettingsLoaded.value || isSettingsChangePending.value) return + if (!isSettingsLoaded.value) return + if (isSettingsChangePending.value) throw new Error('A settings change is already in progress. Please wait for it to finish.') const selectableAddresses = includePersistedAddressBookEntry(activeAddresses.value, persistedEntry) if (!isActiveAddressSelectionAllowed(address, selectableAddresses, simulationMode.value, rpcNetwork.value?.chainId, tabState.value?.signerAccounts ?? [])) return const requestId = crypto.randomUUID() @@ -104,7 +109,8 @@ export function App() { } async function changePopupSettings(message: ChangeActiveChain | EnableSimulationMode | ModifyMakeMeRich) { - if (!isSettingsLoaded.value || isSettingsChangePending.value) return + if (!isSettingsLoaded.value) return + if (isSettingsChangePending.value) throw new Error('A settings change is already in progress. Please wait for it to finish.') pendingSettingsChange.value = true try { await requestPopupSettingsChange(message) @@ -274,6 +280,10 @@ export function App() { + { backgroundSettingsChange.value.operation !== undefined && !pendingSettingsChange.value && !isActiveAddressChangePending.value + ?
{ { + wallet: 'Changing wallet...', mode: 'Changing mode...', rpc: 'Changing network. Check your wallet if approval is required.', rich: 'Updating balances...', + }[backgroundSettingsChange.value.operation] }
: <> } void onInitialSettings?: (settings: Settings) => void onAddressSelectionCommitted?: (selection: { requestId: string, activeAddress: bigint | undefined }, settings: Settings) => void } @@ -233,6 +234,9 @@ export function useLiveSimulationHomeData(options: LiveSimulationHomeDataOptions const parsed = maybeParsed.value if (parsed.role === 'confirmTransaction') return undefined switch(parsed.method) { + case 'popup_settingsChangeStatus': + options.onSettingsChangeStatus?.(parsed.data) + return undefined case 'popup_homePageBootstrap': updateHomePageBootstrap(parsed) return undefined @@ -308,19 +312,15 @@ export function useLiveSimulationHomeData(options: LiveSimulationHomeDataOptions useEffect(() => { void (async () => { + const settingsStatusRequest = options.answerMainPopupOpen ? sendPopupMessageToBackgroundPage({ method: 'popup_requestSettingsChangeStatus' }) : undefined if (options.requestFreshHomeDataOnMount) { const homePageBootstrapRequest = options.answerMainPopupOpen ? sendPopupMessageToBackgroundPage({ method: 'popup_requestHomePageBootstrap' }) : undefined - const freshHomeDataRequest = requestFreshHomeData() - if (homePageBootstrapRequest !== undefined) { - await Promise.all([homePageBootstrapRequest, freshHomeDataRequest]) - return - } - await freshHomeDataRequest + await Promise.all([settingsStatusRequest, homePageBootstrapRequest, requestFreshHomeData()]) return } - await requestCachedHomeData({ refreshSignerAccounts: false, includeWebsiteAccessAddressMetadata: false }) + await Promise.all([settingsStatusRequest, requestCachedHomeData({ refreshSignerAccounts: false, includeWebsiteAccessAddressMetadata: false })]) })() }, []) diff --git a/app/ts/types/interceptor-messages.ts b/app/ts/types/interceptor-messages.ts index a60b52165..e0d86adb3 100644 --- a/app/ts/types/interceptor-messages.ts +++ b/app/ts/types/interceptor-messages.ts @@ -943,7 +943,17 @@ const PopupIsMainPopupWindowOpen = funtypes.ReadonlyObject({ method: funtypes.Literal('popup_isMainPopupWindowOpen'), }).asReadonly() +export type PopupSettingsChangeStatus = funtypes.Static +export const PopupSettingsChangeStatus = funtypes.ReadonlyObject({ + method: funtypes.Literal('popup_settingsChangeStatus'), + data: funtypes.ReadonlyObject({ + revision: funtypes.Number, + operation: funtypes.Union(funtypes.Undefined, funtypes.Literal('wallet'), funtypes.Literal('mode'), funtypes.Literal('rpc'), funtypes.Literal('rich')), + }), +}) + const messageToPopupPayloadCodecs: [ + typeof PopupSettingsChangeStatus, typeof MessageToPopupSimple, typeof WebsiteIconChanged, typeof GetAddressBookDataReply, @@ -970,6 +980,7 @@ const messageToPopupPayloadCodecs: [ typeof FetchSimulationStackRequest, typeof PopupIsMainPopupWindowOpen, ] = [ + PopupSettingsChangeStatus, MessageToPopupSimple, WebsiteIconChanged, GetAddressBookDataReply, @@ -1036,6 +1047,7 @@ const PopupMessageRuntype = funtypes.Union( }), }), funtypes.ReadonlyObject({ method: funtypes.Literal('popup_requestHomePageBootstrap') }), + funtypes.ReadonlyObject({ method: funtypes.Literal('popup_requestSettingsChangeStatus') }), funtypes.ReadonlyObject({ method: funtypes.Literal('popup_refreshHomeData') }), funtypes.ReadonlyObject({ method: funtypes.Literal('popup_openSettings') }), funtypes.ReadonlyObject({ method: funtypes.Literal('popup_clearUnexpectedError') }), diff --git a/app/ts/types/popupMessageProtocol.ts b/app/ts/types/popupMessageProtocol.ts index cd3e4e389..55f762e47 100644 --- a/app/ts/types/popupMessageProtocol.ts +++ b/app/ts/types/popupMessageProtocol.ts @@ -33,6 +33,7 @@ export const popupMessageProtocol = { popup_openAddressBook: { domain: 'navigation' }, popup_requestNewHomeData: { domain: 'home' }, popup_requestHomePageBootstrap: { domain: 'home' }, + popup_requestSettingsChangeStatus: { domain: 'home' }, popup_refreshHomeData: { domain: 'home' }, popup_requestSettings: { domain: 'settings' }, popup_refreshInterceptorAccessMetadata: { domain: 'website-access' }, diff --git a/test/benchmarks/README.md b/test/benchmarks/README.md index 3dc7ba27c..453fd7e67 100644 --- a/test/benchmarks/README.md +++ b/test/benchmarks/README.md @@ -64,7 +64,7 @@ After `bun run setup-chrome`, run: bun run benchmark:popup-switching ``` -This benchmark uses the existing Chromium/CDP harness, an isolated temporary profile, a local JSON-RPC fixture, and an EIP-6963 fake wallet. Each iteration starts a fresh profile and seeds two contact wallets and RPC endpoints before measurement. It covers wallet selection, both modes, same-chain RPC switching, rich on/off, and wallet-required network acceptance/rejection. It deliberately uses an empty transaction stack; these results do not predict real-wallet or large-stack performance. +This benchmark uses the existing Chromium/CDP harness, an isolated temporary profile, a local JSON-RPC fixture, and an EIP-6963 fake wallet. Each iteration starts a fresh profile and seeds two contact wallets and RPC endpoints before measurement. It covers wallet selection, both modes, same-chain RPC switching, rich on/off, and wallet-required network acceptance/rejection. It measures empty-stack switching and rich-mode changes with one simulated transaction, injects an uncached RPC simulation failure, and verifies recovery. It also holds a wallet reply while opening a second popup and closing/reopening the initiating popup, checking shared pending status and disabled controls. These results do not predict real-wallet or large-stack performance. Configure the fixture delays and sample count: @@ -85,4 +85,8 @@ The JSON report includes each sample and per-scenario minimum, median (upper mid The popup is brought to the foreground for frame sampling. These are animation-frame observations, not GPU paint timestamps. The benchmark fails for wrong outcomes, missing visual feedback or successful-setting persistence events, unsupported fixture RPC calls, wallet switches completing before the configured wallet delay, or rejected switches changing persisted RPC state. It imposes no machine-dependent speed threshold. +The transient RPC failure scenario expects the rich setting to be saved while the popup displays a failed simulation; an explicit refresh must recover once the fixture RPC is restored. + +The wallet-response deadline is covered by focused tests using a shortened timeout; the browser fixture holds and releases replies explicitly rather than waiting two minutes. Timing samples cover ten scenarios; popup lifecycle/conflict and RPC-recovery assertions run alongside them without speed thresholds. + For comparisons, build each revision and run the same command with the same browser, delays, iteration count, and host load. Compare feedback and selected-value timings separately from total completion time. Fixture setup is excluded from sample timings. diff --git a/test/benchmarks/popupSwitchingChrome.ts b/test/benchmarks/popupSwitchingChrome.ts index 2d8125b3f..1fb770ccf 100644 --- a/test/benchmarks/popupSwitchingChrome.ts +++ b/test/benchmarks/popupSwitchingChrome.ts @@ -1,5 +1,7 @@ -import { Multicall3ABI } from '../../app/ts/utils/constants.js' -import { encodeFunctionReturn } from '../../app/ts/utils/abiRuntime.js' +import { mockSignTransaction } from '../../app/ts/simulation/services/SimulationModeEthereumClientService.js' +import { InterceptorTransactionStack } from '../../app/ts/types/visualizer-types.js' +import { JSON_RPC_ERROR_CODE_RESOURCE_UNAVAILABLE, Multicall3ABI } from '../../app/ts/utils/constants.js' +import { decodeFunctionDataStrict, encodeFunctionReturn } from '../../app/ts/utils/abiRuntime.js' import { EthSimulateV1Result } from '../../app/ts/types/ethSimulate-types.js' import { connectTarget, createTargetPage, launchChromeSession, waitForInterceptorExtensionServiceWorker, waitForPerformanceMarks, waitForRegisteredContentScripts } from './chromeHarness.js' import type { CdpConnection } from './chromeHarness.js' @@ -25,11 +27,25 @@ const block = EthereumBlockHeader.parse({ ...blockResponse.result, transactions: if (block === null) throw new Error('Missing fixture block') const rpcRequests: { method: string, elapsedMs: number }[] = [] const unexpectedMethods = new Set() +let failSimulation = false +let injectedFailures = 0 function isRecord(value: unknown): value is Record { return typeof value === 'object' && value !== null && !Array.isArray(value) } +function simulationReturnData(call: unknown) { + if (!isRecord(call)) throw new Error('Invalid fixture call') + const input = call.input ?? call.data + if (input === undefined || input === '0x') return new Uint8Array() + if (typeof input !== 'string' || !input.startsWith('0x82ad56cb')) throw new Error('Unsupported fixture call data') + const decoded = decodeFunctionDataStrict(Multicall3ABI, Uint8Array.from(Buffer.from(input.slice(2), 'hex'))) + if (decoded.functionName !== 'aggregate3') throw new Error('Expected aggregate balance query') + const balance = encodeFunctionReturn(Multicall3ABI, 'getEthBalance', [0n]) + const result = encodeFunctionReturn(Multicall3ABI, 'aggregate3', [decoded.args[0].map(() => ({ success: true, returnData: balance }))]) + return Uint8Array.from(Buffer.from(result.slice(2), 'hex')) +} + const pageHtml = await Bun.file(new URL('./chromeCommunicationPage.html', import.meta.url)).text() const server = Bun.serve({ port: 0, @@ -51,14 +67,17 @@ const server = Bun.serve({ case 'eth_maxPriorityFeePerGas': result = '0x0'; break case 'eth_getCode': result = '0x'; break case 'eth_simulateV1': { + if (failSimulation) { + injectedFailures++ + rpcRequests.push({ method: rpc.method, elapsedMs: performance.now() - started }) + return Response.json({ jsonrpc: '2.0', id: rpc.id, error: { code: JSON_RPC_ERROR_CODE_RESOURCE_UNAVAILABLE, message: 'Benchmark RPC simulation failure' } }) + } const payload = Array.isArray(rpc.params) ? rpc.params[0] : undefined if (!isRecord(payload) || !Array.isArray(payload.blockStateCalls)) throw new Error('Invalid simulation request') - const balance = encodeFunctionReturn(Multicall3ABI, 'getEthBalance', [0n]) - const aggregate = encodeFunctionReturn(Multicall3ABI, 'aggregate3', [[{ success: true, returnData: balance }]]) result = serialize(EthSimulateV1Result, payload.blockStateCalls.map((stateCall: unknown, index: number) => { if (!isRecord(stateCall) || !Array.isArray(stateCall.calls)) throw new Error('Invalid simulation calls') return { number: block.number + BigInt(index + 1), hash: 0x1234n, timestamp: BigInt(Math.floor(Date.now() / 1000)), gasLimit: 30_000_000n, gasUsed: 0n, baseFeePerGas: 1n, - calls: stateCall.calls.map(() => ({ status: 'success' as const, gasUsed: 0n, logs: [], returnData: Uint8Array.from(Buffer.from(aggregate.slice(2), 'hex')) })) } + calls: stateCall.calls.map((call: unknown) => ({ status: 'success' as const, gasUsed: 21_000n, logs: [], returnData: simulationReturnData(call) })) } })) break } @@ -87,6 +106,7 @@ const fakeSigner = `(() => { if (method === 'eth_accounts' || method === 'eth_requestAccounts') return [${ JSON.stringify(walletA) }]; if (method !== 'wallet_switchEthereumChain') throw new Error('Unsupported benchmark wallet method: ' + method); await new Promise(resolve => setTimeout(resolve, ${ walletDelayMs })); + if (globalThis.__benchmarkHoldSwitch) await new Promise(resolve => { globalThis.__benchmarkReleaseSwitch = resolve; }); if (globalThis.__benchmarkRejectSwitch) throw Object.assign(new Error('Benchmark wallet rejected network change'), { code: 4001 }); chain = params[0].chainId; for (const listener of listeners.get('chainChanged') ?? []) listener(chain); @@ -104,13 +124,13 @@ const fakeSigner = `(() => { async function waitFor(connection: CdpConnection, expression: string, label: string) { const deadline = Date.now() + 30_000 while (!await connection.evaluate(expression)) { - if (Date.now() > deadline) throw new Error(`Timed out waiting for ${ label }`) + if (Date.now() > deadline) throw new Error(`Timed out waiting for ${ label }: ${ await connection.evaluate('document.body.textContent') }`) await delay(25) } } const modeButton = (name: string) => `Array.from(document.querySelectorAll('.popup-home-mode-selector button')).find(button => button.textContent.trim() === ${ JSON.stringify(name) })` const rpcButton = (name: string) => `Array.from(document.querySelectorAll('.popup-home-rpc-selector .dropdown-item')).find(button => button.textContent.trim() === ${ JSON.stringify(name) })` -const ready = `document.querySelector('.active-address-row button')?.disabled === false && !document.querySelector('.popup-home-header-layout [aria-busy="true"]')` +const ready = `document.querySelector('.popup-home-rpc-selector .dropdown-trigger > button')?.disabled === false && !document.querySelector('.popup-settings-change-status') && !document.querySelector('.popup-home-header-layout [aria-busy="true"]')` type SwitchSample = { name: string @@ -184,7 +204,9 @@ async function runIteration() { websiteAccess: [{ website: { websiteOrigin: server.url.host }, access: true, addressAccess: [walletA, walletB].map(address => ({ address, access: true })) }], userAddressBookEntriesV3: [walletA, walletB].map((address, index) => ({ type: 'contact', address, name: `Wallet ${ index === 0 ? 'A' : 'B' }`, entrySource: 'User', useAsActiveAddress: true, askForAddressAccess: false })), }) })`) - const popup = await connectTarget(chrome.browserDebugPort, await createTargetPage(chrome.browserConnection, `chrome-extension://${ new URL(worker.url).host }/html3/popupV3.html`)) + const popupUrl = `chrome-extension://${ new URL(worker.url).host }/html3/popupV3.html` + const popupTarget = await createTargetPage(chrome.browserConnection, popupUrl) + const popup = await connectTarget(chrome.browserDebugPort, popupTarget) connections.push(popup) await waitFor(popup, `typeof browser !== 'undefined'`, 'popup runtime') await popup.evaluate(`browser.runtime.sendMessage({ method: 'popup_changeActiveRpc', data: ${ JSON.stringify(networkA) } })`) @@ -212,6 +234,46 @@ async function runIteration() { await page.evaluate('globalThis.__benchmarkRejectSwitch = false') samples.push(await measure(popup, 'wallet RPC acceptance', 'popup_changeActiveRpc', `${ rpcButton(networkC.name) }.click()`, `!!document.querySelector('.popup-home-rpc-selector [role="status"]')`, `document.querySelector('.popup-home-rpc-selector .dropdown-trigger button')?.title === ${ JSON.stringify(networkC.name) }`)) samples.push(await measure(popup, 'simulating', 'popup_enableSimulationMode', `${ modeButton('Simulating') }.click()`, `${ modeButton('Simulating') }?.getAttribute('aria-busy') === 'true'`, `${ modeButton('Simulating') }?.classList.contains('is-outlined') === false`)) + const transaction = { from: BigInt(walletA), to: BigInt(walletB), value: 0n, input: new Uint8Array() } + const stack: InterceptorTransactionStack = { operations: [{ type: 'Transaction', preSimulationTransaction: { + signedTransaction: mockSignTransaction({ type: '1559', ...transaction, nonce: 0n, gas: 21_000n, chainId: 2n, maxFeePerGas: 2n, maxPriorityFeePerGas: 1n }), + website: { websiteOrigin: server.url.host }, created: new Date(), originalRequestParameters: { method: 'eth_sendTransaction', params: [{ ...transaction, maxFeePerGas: 2n, maxPriorityFeePerGas: 1n }] }, + transactionIdentifier: 1n, simulationOptions: { requiredChainId: 2n, simulateWithZeroBaseFee: false }, + } }] } + await workerConnection.evaluate(`browser.storage.local.set({ interceptorTransactionStack: ${ JSON.stringify(serialize(InterceptorTransactionStack, stack)) } })`) + await popup.evaluate(`browser.runtime.sendMessage({ method: 'popup_refreshSimulation' })`) + await waitFor(popup, `document.body.textContent.includes('Contract Fallback Method')`, 'populated simulation stack') + samples.push(await measure(popup, 'stacked rich on', 'popup_modifyMakeMeRich', `document.querySelector('input[type="checkbox"]').click()`, `document.body.textContent.includes('Updating balances...')`, `document.querySelector('input[type="checkbox"]')?.checked === true`)) + // Change the input before injecting failure so an earlier successful cached response cannot satisfy the request. + await workerConnection.evaluate(`browser.storage.local.set({ preSimulationBlockTimeManipulation: { type: 'AddToTimestamp', deltaToAdd: '0x9d', deltaUnit: 'Seconds' } })`) + const failuresBefore = injectedFailures + failSimulation = true + try { + samples.push(await measure(popup, 'stacked rich off with RPC failure', 'popup_modifyMakeMeRich', `document.querySelector('input[type="checkbox"]').click()`, `document.body.textContent.includes('Updating balances...')`, `document.querySelector('input[type="checkbox"]')?.checked === false`)) + if (injectedFailures === failuresBefore) throw new Error('RPC failure scenario did not exercise the fixture') + await waitFor(popup, `document.body.textContent.includes('Benchmark RPC simulation failure')`, 'visible RPC simulation failure') + } finally { failSimulation = false } + await popup.evaluate(`browser.runtime.sendMessage({ method: 'popup_refreshSimulation' })`) + await waitFor(popup, `!document.body.textContent.includes('Benchmark RPC simulation failure')`, 'RPC recovery') + await popup.evaluate(`browser.runtime.sendMessage({ method: 'popup_enableSimulationMode', data: false })`) + const second = await connectTarget(chrome.browserDebugPort, await createTargetPage(chrome.browserConnection, popupUrl)) + connections.push(second) + await waitFor(second, ready, 'second popup ready') + await page.evaluate('globalThis.__benchmarkHoldSwitch = true; globalThis.__benchmarkRejectSwitch = true') + await popup.evaluate(`${ rpcButton(networkA.name) }.click()`) + await waitFor(page, `typeof globalThis.__benchmarkReleaseSwitch === 'function'`, 'held wallet switch') + const sharedBusy = `!!document.querySelector('.popup-settings-change-status') && document.querySelector('.active-address-row .media-right > button')?.disabled === true && Array.from(document.querySelectorAll('.popup-home-mode-selector button, .popup-home-rpc-selector .dropdown-trigger button, input[type="checkbox"]')).every(button => button.disabled)` + await waitFor(second, sharedBusy, 'pending status in second popup') + const conflict = await second.evaluate<{ ok: boolean }>(`browser.runtime.sendMessage({ method: 'popup_enableSimulationMode', data: true })`) + if (conflict.ok !== false) throw new Error('Second popup bypassed background coordination') + await chrome.browserConnection.send('Target.closeTarget', { targetId: popupTarget }) + const reopened = await connectTarget(chrome.browserDebugPort, await createTargetPage(chrome.browserConnection, popupUrl)) + connections.push(reopened) + await waitFor(reopened, sharedBusy, 'pending status after close and reopen') + await page.evaluate('globalThis.__benchmarkHoldSwitch = false; globalThis.__benchmarkReleaseSwitch()') + await waitFor(second, ready, 'second popup released after wallet rejection') + await waitFor(reopened, ready, 'reopened popup released after wallet rejection') + if (await reopened.evaluate(`!!document.querySelector('.popup-settings-change-status')`)) throw new Error('Stale pending status after completion') return samples } finally { for (const connection of connections) connection.close() @@ -241,6 +303,6 @@ async function main() { completion: timingStats(group.map(sample => sample.completedFrameMs)), } }) - process.stdout.write(JSON.stringify({ rpcDelayMs, walletDelayMs, iterations, fixture: 'empty stack, local RPC, fake EIP-6963 wallet', summaries, samples }, undefined, 2) + '\n') + process.stdout.write(JSON.stringify({ rpcDelayMs, walletDelayMs, iterations, fixture: 'empty and one-transaction stacks, local RPC including failure/recovery, fake EIP-6963 wallet, concurrent and reopened popups', summaries, samples }, undefined, 2) + '\n') } try { await main() } finally { server.stop(true) } diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index 5188d7328..b9f4d6921 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -89,7 +89,9 @@ describe('popup settings changes', () => { }) test('coordinates settings changes across dispatchers without blocking wallet replies or reads', async () => { - installBrowserMock() + const { runtimeMessages } = installBrowserMock() + const { PopupSettingsChangeStatus } = await import('../../app/ts/types/interceptor-messages.js') + const statuses = () => runtimeMessages.flatMap(message => { const parsed = PopupSettingsChangeStatus.safeParse(message); return parsed.success ? [parsed.value.data] : [] }) const { changeSimulationMode, getSettings, saveCurrentTabId, websiteSocketToString } = await loadModules() const { dispatchPopupMessage } = await import('../../app/ts/background/popupMessageDispatcher.js') const { getConfirmedSignerStateToken } = await import('../../app/ts/background/signerStateOwnership.js') @@ -111,6 +113,11 @@ describe('popup settings changes', () => { const pending = dispatchPopupMessage(context, { method: 'popup_changeActiveRpc', data: rpc }) try { await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) + assert.equal(statuses().at(-1)?.operation, 'rpc') + const pendingRevision = statuses().at(-1)?.revision + await dispatchPopupMessage(context, { method: 'popup_requestSettingsChangeStatus' }) + assert.equal(statuses().at(-1)?.revision, pendingRevision) + assert.equal(statuses().at(-1)?.operation, 'rpc') for (const request of [ { method: 'popup_changeActiveRpc', data: rpc }, { method: 'popup_enableSimulationMode', data: true }, @@ -128,6 +135,8 @@ describe('popup settings changes', () => { resolveSignerChainChange(token, { method: 'popup_signerChangeChainDialog', data: [{ accept: false, chainId: 2n, error: { code: 4001, message: 'Rejected' } }] }) await pending } + assert.equal(statuses().at(-1)?.operation, undefined) + assert.ok((statuses().at(-1)?.revision ?? 0) > (statuses()[0]?.revision ?? 0)) const retry = await dispatchPopupMessage(context, { method: 'popup_enableSimulationMode', data: false }) assert.deepEqual(retry, { type: 'PopupSettingsChangeReply', ok: true }) const setStorage = browser.storage.local.set @@ -155,6 +164,20 @@ describe('popup settings changes', () => { assert.equal(runtimeMessages.length, count) }) + for (const simulationMode of [true, false]) test(`saves active RPC metadata without resetting services in ${ simulationMode ? 'simulation' : 'signing' } mode`, async () => { + installBrowserMock() + const { changeSimulationMode, getSettings } = await loadModules() + const { changeActiveRpc } = await import('../../app/ts/background/activeSettings.js') + await changeSimulationMode({ simulationMode }) + const currentRpc = (await getSettings()).activeRpcNetwork + if (currentRpc.httpsRpc === undefined) throw new Error('Expected a configured RPC') + const editedRpc = { ...currentRpc, name: 'Renamed network', currencyName: 'Updated currency', currencyTicker: 'NEW', currencyLogoUri: 'updated.svg', blockExplorer: { apiUrl: 'https://explorer.example/api', apiKey: 'updated-key' }, primary: !currentRpc.primary, minimized: !currentRpc.minimized } + const { ethereum, tokenPriceService } = createEthereumWithGetBlockCounter({ count: 0 }) + const reset = () => { throw new Error('Metadata edits should not reset services') } + assert.deepEqual(await changeActiveRpc(ethereum, tokenPriceService, reset, new Map(), editedRpc, simulationMode, undefined), { type: simulationMode ? 'completedLocally' : 'signerRequestNotNeeded' }) + assert.deepEqual((await getSettings()).activeRpcNetwork, editedRpc) + }) + test('publishes a saved mode before slow permission work finishes', async () => { const { runtimeMessages } = installBrowserMock() const { changeSimulationMode, changeActiveAddressAndChain, updateWebsiteAccess } = await loadModules() @@ -281,6 +304,79 @@ describe('popup settings changes', () => { }) } + for (const outcome of ['timeout', 'reply', 'failure'] as const) { + test(`wallet deadline releases a silent request but does not expire a received reply (${ outcome })`, async () => { + installBrowserMock() + const { changeSimulationMode, getSettings, websiteSocketToString } = await loadModules() + const { requestSignerChainChange, resolveSignerChainChange, markSignerChainReplyReceived } = await import('../../app/ts/background/windows/changeChain.js') + const { getConfirmedSignerStateToken } = await import('../../app/ts/background/signerStateOwnership.js') + await changeSimulationMode({ simulationMode: false }) + const socket = { tabId: 1, connectionName: 0n } + const { port, messages } = createPort(1) + const connections = new Map([[1, { ...confirmedSignerOwnership(socket), connections: { + [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'https://example.test', approved: true, wantsToConnect: true }, + } }]]) + const rpc = { ...(await getSettings()).activeRpcNetwork, chainId: 2n, httpsRpc: 'https://timeout.example.test' } + const services = createEthereumWithGetBlockCounter({ count: 0 }) + const request = (timeoutMs: number) => requestSignerChainChange(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, rpc, 1, timeoutMs) + const pending = request(30) + await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) + const token = getConfirmedSignerStateToken(connections, 1) + if (token === undefined) throw new Error('Missing signer token') + const reply = { method: 'popup_signerChangeChainDialog', data: [{ accept: false, chainId: 2n, error: { code: 4001, message: 'Rejected' } }] } as const + if (outcome === 'failure') { + const { walletSwitchEthereumChainReply } = await import('../../app/ts/background/providerMessageHandlers.js') + const originalSet = browser.storage.local.set + try { + Object.defineProperty(browser.storage.local, 'set', { configurable: true, value: async () => { throw new Error('Storage write failed') } }) + await assert.rejects(walletSwitchEthereumChainReply(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, port, { + method: 'wallet_switchEthereumChain_reply', params: [{ accept: true, chainId: '0x2', signerProviderGeneration: token.signerProviderGeneration }], + interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, + }, 'hasAccess', undefined), /Storage write failed/) + } finally { Object.defineProperty(browser.storage.local, 'set', { configurable: true, value: originalSet }) } + assert.match((await pending).error?.message ?? '', /updating the selected network failed/) + } else if (outcome === 'reply') { + // Delivery has begun, but applying the accepted wallet state can involve slower RPC work. + await new Promise(resolve => setTimeout(resolve, 0)) + markSignerChainReplyReceived(token, 2n) + await new Promise(resolve => setTimeout(resolve, 60)) + resolveSignerChainChange(token, reply) + assert.equal((await pending).error?.code, 4001) + } else { + assert.match((await pending).error?.message ?? '', /did not answer/) + assert.match((await request(30)).error?.message ?? '', /previous network request/) + assert.equal(messages.filter(message => message.method === 'request_signer_to_wallet_switchEthereumChain').length, 1) + const { walletSwitchEthereumChainReply } = await import('../../app/ts/background/providerMessageHandlers.js') + const beforeLateReply = await getSettings() + await walletSwitchEthereumChainReply(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, port, { + method: 'wallet_switchEthereumChain_reply', params: [{ accept: true, chainId: '0x2', signerProviderGeneration: token.signerProviderGeneration }], + interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, + }, 'hasAccess', undefined) + assert.deepEqual((await getSettings()).activeRpcNetwork, beforeLateReply.activeRpcNetwork) + const retry = request(1000) + await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 2) + resolveSignerChainChange(token, reply) + assert.equal((await retry).error?.code, 4001) + await request(30) + const tab = connections.get(1) + if (tab === undefined) throw new Error('Missing tab') + tab.signerStateOwner.providerGeneration++ + let newRequestCompleted = false + const newRequest = request(1000).then(result => { newRequestCompleted = true; return result }) + await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 4) + await walletSwitchEthereumChainReply(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, port, { + method: 'wallet_switchEthereumChain_reply', params: [{ accept: true, chainId: '0x2', signerProviderGeneration: token.signerProviderGeneration }], + interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 2, requestSocket: socket }, + }, 'hasAccess', undefined) + assert.equal(newRequestCompleted, false) + const newToken = getConfirmedSignerStateToken(connections, 1) + if (newToken === undefined) throw new Error('Missing reconnected signer') + resolveSignerChainChange(newToken, reply) + assert.equal((await newRequest).error?.code, 4001) + } + }) + } + for (const accept of [true, false]) { test(`waits for the matching wallet network ${ accept ? 'acceptance' : 'rejection' }`, async () => { installBrowserMock() diff --git a/test/tests/simulationVisualizerOpen.test.tsx b/test/tests/simulationVisualizerOpen.test.tsx index 212238a47..7f7e15360 100644 --- a/test/tests/simulationVisualizerOpen.test.tsx +++ b/test/tests/simulationVisualizerOpen.test.tsx @@ -1182,6 +1182,31 @@ describe('simulation visualizer open replies', () => { } }) + test('popup displays shared pending work and ignores an older busy status after completion', async () => { + const dom = installDomMock() + const { listeners, sentMessages } = installBrowserMock() + try { + await act(() => { render(h(App, {}), dom.document.body) }) + const listener = listeners[0] + if (listener === undefined) throw new Error('Expected a runtime listener') + await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createSimulationStackHomePageUpdate(25, 1, 'Popup')) }, {}, () => undefined) }) + assert.ok(sentMessages.some(message => PopupMessage.safeParse(message).success && typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_requestSettingsChangeStatus')) + const status = async (revision: number, operation: 'rpc' | undefined) => await act(() => { + listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsChangeStatus', data: { revision, operation } }), {}, () => undefined) + }) + await status(10, 'rpc') + assert.ok(dom.document.body.textContent.includes('Changing network. Check your wallet')) + assert.equal(String(getButtonByText(dom.document.body, 'Change').getAttribute?.('disabled')), 'true') + await status(11, undefined) + await status(10, 'rpc') + assert.equal(dom.document.body.textContent.includes('Changing network. Check your wallet'), false) + assert.equal(getButtonByText(dom.document.body, 'Change').getAttribute?.('disabled'), undefined) + } finally { + render(undefined, dom.document.body) + dom.restore() + } + }) + test('popup reveals the committed wallet before the address-change reply and preserves later settings', async () => { const dom = installDomMock() let finishChange: (reply: unknown) => void = () => undefined From 41cd08af6fb5c9ae6eec40626af1d4f6d5529ecf Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 10:49:31 +0000 Subject: [PATCH 06/31] Clarify active service results and popup request ownership --- app/ts/background/activeSettings.ts | 16 +++++---- app/ts/background/providerMessageHandlers.ts | 3 +- app/ts/components/App.tsx | 2 +- app/ts/components/activeAddressChange.ts | 3 +- app/ts/components/popupSettingsChange.ts | 2 +- app/ts/simulation/serviceLifecycle.ts | 3 +- app/ts/types/interceptor-messages.ts | 11 ++++--- app/ts/types/interceptor-reply-messages.ts | 33 +------------------ app/ts/types/popupSettingsRequests.ts | 33 +++++++++++++++++++ .../tests/backgroundEthAccountsTestHarness.ts | 5 +-- test/tests/backgroundEthSimulateV1.test.ts | 5 +-- test/tests/popupClearReset.test.ts | 2 ++ test/tests/popupMessageDispatcher.test.ts | 2 +- test/tests/popupSettingsChanges.test.ts | 26 +++++++++++++++ 14 files changed, 92 insertions(+), 54 deletions(-) create mode 100644 app/ts/types/popupSettingsRequests.ts diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index 91c9bd5ef..6921de4df 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -1,6 +1,6 @@ import { refreshPopupSimulation } from './popupSimulationRefresh.js' import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' -import type { ResetSimulationServices } from '../simulation/serviceLifecycle.js' +import type { ResetSimulationServices, SimulationServices } from '../simulation/serviceLifecycle.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' import { RpcNetwork } from '../types/rpc.js' import type { WebsiteTabConnections } from '../types/user-interface-types.js' @@ -69,7 +69,7 @@ export async function changeActiveAddressAndChain( promptForAccessesIfNeeded?: boolean, addressChangeRequestId?: string, }, -) { +): Promise { if (change.simulationMode && change.activeAddress !== undefined) await keepTrackOfPreviousAddressForRichList() const previousSettings = await getSettings() @@ -94,7 +94,7 @@ export async function changeActiveAddressAndChain( const rpcChainChanged = previousSettings.activeRpcNetwork.chainId !== updatedSettings.activeRpcNetwork.chainId const rpcEndpointChanged = rpcChainChanged || previousSettings.activeRpcNetwork.httpsRpc !== updatedSettings.activeRpcNetwork.httpsRpc const activeServices = rpcEndpointChanged && change.rpcNetwork?.httpsRpc !== undefined - ? resetSimulationServices(change.rpcNetwork) ?? { ethereum, tokenPriceService } + ? resetSimulationServices(change.rpcNetwork) : { ethereum, tokenPriceService } if (updatedSettings.simulationMode && rpcChainChanged) await clearSimulationStateFromConfig() // Publish only after the selected provider and stack are ready for requests using the new settings. @@ -115,6 +115,7 @@ export async function changeActiveAddressAndChain( } await sendActiveAccountChangeToApprovedWebsitePorts(websiteTabConnections, await getSettings()) }) + return activeServices } export async function activateAddressSelection( @@ -130,12 +131,12 @@ export async function activateAddressSelection( readonly promptForAccessesIfNeeded?: boolean readonly addressChangeRequestId?: string }, -) { +): Promise { const useSignerAddress = selection?.type === 'signer' || (!options.simulationMode && selection === undefined) if (options.simulationMode) { await setUseSignersAddressAsActiveAddress(useSignerAddress, useSignerAddress ? selection?.type === 'signer' ? selection.address : options.signerAddress : undefined) } - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + const activeServices = await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { simulationMode: options.simulationMode, addressChangeRequestId: options.addressChangeRequestId, activeAddress: selection?.type === 'signer' ? selection.address : selection?.entry.address, @@ -143,10 +144,10 @@ export async function activateAddressSelection( ...(options.rpcNetwork === undefined ? {} : { rpcNetwork: options.rpcNetwork }), ...(options.promptForAccessesIfNeeded === undefined ? {} : { promptForAccessesIfNeeded: options.promptForAccessesIfNeeded }), }) - if (options.simulationMode || options.signerAddress === undefined || selection === undefined) return + if (options.simulationMode || options.signerAddress === undefined || selection === undefined) return activeServices if (selection.type === 'signer') { await rememberSigningAddressSelection({ signerAddress: options.signerAddress, selection: 'signer' }) - return + return activeServices } if (selection.entry.type !== 'safe') throw new Error('Signing mode can only activate the external signer or an owned Gnosis Safe.') await rememberSigningAddressSelection({ @@ -155,6 +156,7 @@ export async function activateAddressSelection( safeAddress: selection.entry.address, chainId: selection.entry.chainId, }) + return activeServices } export async function changeActiveRpc(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, simulationMode: boolean, signerTabId: number | undefined) { diff --git a/app/ts/background/providerMessageHandlers.ts b/app/ts/background/providerMessageHandlers.ts index c707e2043..f4cda153f 100644 --- a/app/ts/background/providerMessageHandlers.ts +++ b/app/ts/background/providerMessageHandlers.ts @@ -146,12 +146,13 @@ async function changeSignerChain(ethereum: EthereumClientService, tokenPriceServ if ((settings.useSignersAddressAsActiveAddress || !settings.simulationMode) && (settings.activeRpcNetwork.chainId !== signerChain || (requestedRpcNetwork !== undefined && settings.activeRpcNetwork.httpsRpc !== requestedRpcNetwork.httpsRpc))) { const rpcNetwork = requestedRpcNetwork ?? await getRpcNetworkForChain(signerChain) const signerAddress = getWalletSelectedAccount(tabStateChange.newState) - return changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { simulationMode: settings.simulationMode, rpcNetwork, activeAddress: signerAddress, ...(!settings.simulationMode ? { signingAddressSelection: 'signer' as const } : {}), }) + return } if (oldSignerChain !== signerChain) sendPopupMessageToOpenWindows({ method: 'popup_chain_update' }) } diff --git a/app/ts/components/App.tsx b/app/ts/components/App.tsx index 4b317627d..07b089ed1 100644 --- a/app/ts/components/App.tsx +++ b/app/ts/components/App.tsx @@ -22,7 +22,7 @@ import { ProviderErrors } from './subcomponents/ProviderErrors.js' import { PopupModal, type PopupPage } from './PopupModal.js' import { getSelectableActiveAddresses, includePersistedAddressBookEntry, isActiveAddressSelectionAllowed } from '../utils/activeAddressSelection.js' import { requestPopupSettingsChange } from './popupSettingsChange.js' -import type { ChangeActiveChain, EnableSimulationMode, ModifyMakeMeRich } from '../types/interceptor-reply-messages.js' +import type { ChangeActiveChain, EnableSimulationMode, ModifyMakeMeRich } from '../types/popupSettingsRequests.js' import { requestActiveAddressChange } from './activeAddressChange.js' import { useModeActiveAddress } from './hooks/useModeActiveAddress.js' export { NetworkErrors } from './subcomponents/NetworkErrors.js' diff --git a/app/ts/components/activeAddressChange.ts b/app/ts/components/activeAddressChange.ts index 9c4c435a3..e8a84e7d2 100644 --- a/app/ts/components/activeAddressChange.ts +++ b/app/ts/components/activeAddressChange.ts @@ -1,5 +1,6 @@ import { getMissingPopupReplyErrorMessage, sendPopupMessageWithReply } from '../background/backgroundUtils.js' -import type { ChangeActiveAddress, ChangeActiveAddressReply } from '../types/interceptor-reply-messages.js' +import type { ChangeActiveAddress } from '../types/popupSettingsRequests.js' +import type { ChangeActiveAddressReply } from '../types/interceptor-reply-messages.js' export async function requestActiveAddressChange( activeAddress: bigint | 'signer', diff --git a/app/ts/components/popupSettingsChange.ts b/app/ts/components/popupSettingsChange.ts index 1990632c0..e43e7389c 100644 --- a/app/ts/components/popupSettingsChange.ts +++ b/app/ts/components/popupSettingsChange.ts @@ -1,5 +1,5 @@ import { getMissingPopupReplyErrorMessage, sendPopupMessageWithReply } from '../background/backgroundUtils.js' -import type { ChangeActiveChain, EnableSimulationMode, ModifyMakeMeRich } from '../types/interceptor-reply-messages.js' +import type { ChangeActiveChain, EnableSimulationMode, ModifyMakeMeRich } from '../types/popupSettingsRequests.js' export async function requestPopupSettingsChange(message: ChangeActiveChain | EnableSimulationMode | ModifyMakeMeRich) { const reply = await sendPopupMessageWithReply(message) diff --git a/app/ts/simulation/serviceLifecycle.ts b/app/ts/simulation/serviceLifecycle.ts index e355eb43b..7af61fa4a 100644 --- a/app/ts/simulation/serviceLifecycle.ts +++ b/app/ts/simulation/serviceLifecycle.ts @@ -6,7 +6,8 @@ import { TokenPriceService } from './services/priceEstimator.js' export type NewBlockAttemptCallback = (blockHeader: EthereumBlockHeader, ethereumClientService: EthereumClientService, isNewBlock: boolean) => Promise export type OnErrorBlockCallback = (ethereumClientService: EthereumClientService, error: unknown) => Promise -export type ResetSimulationServices = (rpcNetwork: RpcEntry) => SimulationServices | void +// Installs the selected RPC services and returns the pair that subsequent work must use. +export type ResetSimulationServices = (rpcNetwork: RpcEntry) => SimulationServices export type SimulationServices = { ethereum: EthereumClientService diff --git a/app/ts/types/interceptor-messages.ts b/app/ts/types/interceptor-messages.ts index e0d86adb3..a43c96250 100644 --- a/app/ts/types/interceptor-messages.ts +++ b/app/ts/types/interceptor-messages.ts @@ -1,3 +1,4 @@ +import { ModifyMakeMeRich, EnableSimulationMode, ChangeActiveChain, ChangeActiveAddress } from './popupSettingsRequests.js' import * as funtypes from 'funtypes' import { PendingChainChangeConfirmationPromise, PendingFetchSimulationStackRequestPromise, PendingWatchAssetRequest, RpcConnectionStatus, TabIconDetails, TabState } from './user-interface-types.js' import { EthereumAddress, EthereumBlockHeaderWithTransactionHashes, EthereumBytes32, EthereumData, EthereumQuantity, EthereumSignedTransactionWithBlockData, NonHexBigInt, OptionalEthereumAddress } from './wire-types.js' @@ -12,7 +13,7 @@ import { PendingAccessRequests, PopupPendingTransactionOrSignableMessage } from import { RpcEntries, RpcNetwork } from './rpc.js' import { OldSignTypedDataParams, PersonalSignParams, SignTypedDataParams } from './jsonRpc-signing-types.js' import { GetSimulationStackReplyV1, GetSimulationStackReplyV2 } from './simulationStackTypes.js' -import { ChangeActiveAddress, ModifyMakeMeRich, EnableSimulationMode, ChangeActiveChain, EnrichedRichListElement, PopupMessageReplyRequests, UnexpectedErrorOccured } from './interceptor-reply-messages.js' +import { EnrichedRichListElement, PopupMessageReplyRequests, UnexpectedErrorOccured } from './interceptor-reply-messages.js' import { ErrorWithCodeAndOptionalData } from './error.js' import { SimulateExecutionReply as SharedSimulateExecutionReply, SimulateExecutionReplyData as SharedSimulateExecutionReplyData } from './simulateExecutionReply.js' import { SimulateGnosisSafeTransaction as SharedSimulateGnosisSafeTransaction, SimulateGovernanceContractExecution as SharedSimulateGovernanceContractExecution } from './simulateExecutionRequests.js' @@ -285,9 +286,9 @@ export const InterceptorAccessChangeAddress = funtypes.ReadonlyObject({ }), }).asReadonly() -export { ChangeActiveAddress } from './interceptor-reply-messages.js' +export { ChangeActiveAddress } from './popupSettingsRequests.js' -export { ModifyMakeMeRich } from './interceptor-reply-messages.js' +export { ModifyMakeMeRich } from './popupSettingsRequests.js' export type AddressBookCategory = funtypes.Static export const AddressBookCategory = funtypes.Union( @@ -328,7 +329,7 @@ export const RequestAccountsFromSigner = funtypes.ReadonlyObject({ data: funtypes.Boolean }).asReadonly() -export { EnableSimulationMode } from './interceptor-reply-messages.js' +export { EnableSimulationMode } from './popupSettingsRequests.js' export type TransactionOrMessageIdentifier = funtypes.Static export const TransactionOrMessageIdentifier = funtypes.Union( @@ -712,7 +713,7 @@ const UpdateRPCList = funtypes.ReadonlyObject({ data: RpcEntries, }) -export { ChangeActiveChain } from './interceptor-reply-messages.js' +export { ChangeActiveChain } from './popupSettingsRequests.js' export type ChainChangeConfirmation = funtypes.Static export const ChainChangeConfirmation = funtypes.ReadonlyObject({ diff --git a/app/ts/types/interceptor-reply-messages.ts b/app/ts/types/interceptor-reply-messages.ts index d6ec9c392..f26e6fafb 100644 --- a/app/ts/types/interceptor-reply-messages.ts +++ b/app/ts/types/interceptor-reply-messages.ts @@ -1,5 +1,4 @@ -import { RpcEntry } from './rpc.js' - +import { ModifyMakeMeRich, EnableSimulationMode, ChangeActiveChain, ChangeActiveAddress } from './popupSettingsRequests.js' import * as funtypes from 'funtypes' import { AddressBookEntry, ChainIdWithUniversal } from '../types/addressBookTypes.js' import { PopupOrTabId } from './websiteAccessTypes.js' @@ -95,42 +94,12 @@ export const AddOrModifyAddressBookEntryReply = funtypes.Union( }), ) -export type ModifyMakeMeRich = funtypes.Static -export const ModifyMakeMeRich = funtypes.ReadonlyObject({ - method: funtypes.Literal('popup_modifyMakeMeRich'), - data: funtypes.ReadonlyObject({ - add: funtypes.Boolean, - address: funtypes.Union(funtypes.Literal('CurrentAddress'), EthereumAddress), - }) -}).asReadonly() - -export type EnableSimulationMode = funtypes.Static -export const EnableSimulationMode = funtypes.ReadonlyObject({ - method: funtypes.Literal('popup_enableSimulationMode'), - data: funtypes.Boolean -}).asReadonly() - -export type ChangeActiveChain = funtypes.Static -export const ChangeActiveChain = funtypes.ReadonlyObject({ - method: funtypes.Literal('popup_changeActiveRpc'), - data: RpcEntry, -}).asReadonly() - export type PopupSettingsChangeReply = funtypes.Static export const PopupSettingsChangeReply = funtypes.Union( funtypes.ReadonlyObject({ type: funtypes.Literal('PopupSettingsChangeReply'), ok: funtypes.Literal(true) }), funtypes.ReadonlyObject({ type: funtypes.Literal('PopupSettingsChangeReply'), ok: funtypes.Literal(false), message: funtypes.String }), ) -export type ChangeActiveAddress = funtypes.Static -export const ChangeActiveAddress = funtypes.ReadonlyObject({ - method: funtypes.Literal('popup_changeActiveAddress'), - data: funtypes.ReadonlyObject({ - simulationMode: funtypes.Boolean, - activeAddress: funtypes.Union(EthereumAddress, funtypes.Literal('signer')), - }).And(funtypes.ReadonlyPartial({ addressChangeRequestId: funtypes.String })) -}).asReadonly() - export type ChangeActiveAddressReply = funtypes.Static export const ChangeActiveAddressReply = funtypes.Union( funtypes.ReadonlyObject({ diff --git a/app/ts/types/popupSettingsRequests.ts b/app/ts/types/popupSettingsRequests.ts new file mode 100644 index 000000000..588c0af09 --- /dev/null +++ b/app/ts/types/popupSettingsRequests.ts @@ -0,0 +1,33 @@ +import * as funtypes from 'funtypes' +import { EthereumAddress } from './wire-types.js' +import { RpcEntry } from './rpc.js' + +export type ModifyMakeMeRich = funtypes.Static +export const ModifyMakeMeRich = funtypes.ReadonlyObject({ + method: funtypes.Literal('popup_modifyMakeMeRich'), + data: funtypes.ReadonlyObject({ + add: funtypes.Boolean, + address: funtypes.Union(funtypes.Literal('CurrentAddress'), EthereumAddress), + }) +}).asReadonly() + +export type EnableSimulationMode = funtypes.Static +export const EnableSimulationMode = funtypes.ReadonlyObject({ + method: funtypes.Literal('popup_enableSimulationMode'), + data: funtypes.Boolean +}).asReadonly() + +export type ChangeActiveChain = funtypes.Static +export const ChangeActiveChain = funtypes.ReadonlyObject({ + method: funtypes.Literal('popup_changeActiveRpc'), + data: RpcEntry, +}).asReadonly() + +export type ChangeActiveAddress = funtypes.Static +export const ChangeActiveAddress = funtypes.ReadonlyObject({ + method: funtypes.Literal('popup_changeActiveAddress'), + data: funtypes.ReadonlyObject({ + simulationMode: funtypes.Boolean, + activeAddress: funtypes.Union(EthereumAddress, funtypes.Literal('signer')), + }).And(funtypes.ReadonlyPartial({ addressChangeRequestId: funtypes.String })) +}).asReadonly() diff --git a/test/tests/backgroundEthAccountsTestHarness.ts b/test/tests/backgroundEthAccountsTestHarness.ts index 70eb07bca..27be9357e 100644 --- a/test/tests/backgroundEthAccountsTestHarness.ts +++ b/test/tests/backgroundEthAccountsTestHarness.ts @@ -226,10 +226,11 @@ export function createEthereumWithGetBlockCounter( }, }, ) + const tokenPriceService = new TokenPriceService(ethereum, 60_000) return { ethereum, - tokenPriceService: new TokenPriceService(ethereum, 60_000), - resetSimulationServices: (() => undefined) satisfies ResetSimulationServices, + tokenPriceService, + resetSimulationServices: (() => ({ ethereum, tokenPriceService })) satisfies ResetSimulationServices, } } diff --git a/test/tests/backgroundEthSimulateV1.test.ts b/test/tests/backgroundEthSimulateV1.test.ts index 6e04329be..ffa89e7e9 100644 --- a/test/tests/backgroundEthSimulateV1.test.ts +++ b/test/tests/backgroundEthSimulateV1.test.ts @@ -132,11 +132,12 @@ function createEthereum(rpcEntry: RpcEntry, ethSimulateV1Result?: unknown) { }, }, ) + const tokenPriceService = new TokenPriceService(ethereum, 60_000) return { ethereum, requestHandler, - tokenPriceService: new TokenPriceService(ethereum, 60_000), - resetSimulationServices: (() => undefined) satisfies ResetSimulationServices, + tokenPriceService, + resetSimulationServices: (() => ({ ethereum, tokenPriceService })) satisfies ResetSimulationServices, } } diff --git a/test/tests/popupClearReset.test.ts b/test/tests/popupClearReset.test.ts index c3d4e74aa..73935570a 100644 --- a/test/tests/popupClearReset.test.ts +++ b/test/tests/popupClearReset.test.ts @@ -586,6 +586,7 @@ describe('popup clear reset', () => { const resets: RpcNetwork[] = [] const resetSimulationServices = (nextRpcEntry: RpcNetwork) => { resets.push(nextRpcEntry) + return { ethereum: fakeEthereum, tokenPriceService: fakeTokenPriceService } } const interceptorTransactionStack = { operations: [{ type: 'TimeManipulation', blockTimeManipulation: DEFAULT_BLOCK_MANIPULATION }] as const } await browserStorageLocalSet({ @@ -614,6 +615,7 @@ describe('popup clear reset', () => { const resets: RpcNetwork[] = [] const resetSimulationServices = (nextRpcEntry: RpcNetwork) => { resets.push(nextRpcEntry) + return { ethereum: fakeEthereum, tokenPriceService: fakeTokenPriceService } } await browserStorageLocalSet({ independentActiveSimulationAddress: activeAddress, diff --git a/test/tests/popupMessageDispatcher.test.ts b/test/tests/popupMessageDispatcher.test.ts index 9c89ae0c2..896eb9d99 100644 --- a/test/tests/popupMessageDispatcher.test.ts +++ b/test/tests/popupMessageDispatcher.test.ts @@ -120,7 +120,7 @@ function createDispatcherContext(resetSimulationState: () => Promise): Pop websiteTabConnections: new Map(), ethereum, tokenPriceService, - resetSimulationServices: () => undefined, + resetSimulationServices: () => ({ ethereum, tokenPriceService }), settings, publishRpcConnectionStatus: async () => undefined, simulationAbortController: new AbortController(), diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index b9f4d6921..83f84cad3 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -178,6 +178,32 @@ describe('popup settings changes', () => { assert.deepEqual((await getSettings()).activeRpcNetwork, editedRpc) }) + test('activation returns the installed services and preserves them when the endpoint is unchanged', async () => { + installBrowserMock() + const { changeSimulationMode, getSettings } = await loadModules() + const { activateAddressSelection } = await import('../../app/ts/background/activeSettings.js') + await changeSimulationMode({ simulationMode: true }) + const currentRpc = (await getSettings()).activeRpcNetwork + if (currentRpc.httpsRpc === undefined) throw new Error('Expected a configured RPC') + const nextRpc = { ...currentRpc, httpsRpc: 'https://replacement.example' } + const original = createEthereumWithGetBlockCounter({ count: 0 }) + const installed = createEthereumWithGetBlockCounter({ count: 0 }) + let resets = 0 + const reset = (rpc: typeof nextRpc) => { + assert.deepEqual(rpc, nextRpc) + resets += 1 + return installed + } + const options = { simulationMode: true, signerAddress: undefined, rpcNetwork: nextRpc } + const active = await activateAddressSelection(original.ethereum, original.tokenPriceService, reset, new Map(), undefined, options) + assert.equal(active.ethereum, installed.ethereum) + assert.equal(active.tokenPriceService, installed.tokenPriceService) + const unchanged = await activateAddressSelection(active.ethereum, active.tokenPriceService, reset, new Map(), undefined, options) + assert.equal(unchanged.ethereum, installed.ethereum) + assert.equal(unchanged.tokenPriceService, installed.tokenPriceService) + assert.equal(resets, 1) + }) + test('publishes a saved mode before slow permission work finishes', async () => { const { runtimeMessages } = installBrowserMock() const { changeSimulationMode, changeActiveAddressAndChain, updateWebsiteAccess } = await loadModules() From ac3bb09351e115fd4b4e09b81729f393a2a5ebad Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 11:54:58 +0000 Subject: [PATCH 07/31] Isolate wallet switch replies and centralize settings ownership --- app/inpage/ts/inpage.ts | 18 +++-- app/ts/background/activeSettings.ts | 5 +- app/ts/background/background-startup.ts | 21 ++--- app/ts/background/popupMessageDispatcher.ts | 29 +++---- app/ts/background/popupSettingsCoordinator.ts | 23 ++++++ app/ts/background/providerMessageHandlers.ts | 16 ++-- app/ts/background/windows/changeChain.ts | 37 +++++---- app/ts/components/App.tsx | 12 +-- app/ts/components/popupSettingsChange.ts | 4 +- app/ts/simulation/serviceLifecycle.ts | 23 +++++- app/ts/types/interceptor-messages.ts | 14 ++-- app/ts/types/interceptor-reply-messages.ts | 17 ++-- app/ts/types/popupSettingsProtocol.ts | 26 ++++++ app/ts/types/popupSettingsRequests.ts | 4 + test/benchmarks/README.md | 2 +- .../tests/backgroundEthAccountsTestHarness.ts | 8 +- test/tests/backgroundSignerLifecycle.test.ts | 16 ++-- test/tests/inpageSignerBridge.test.ts | 29 +++++++ test/tests/popupSettingsChanges.test.ts | 79 ++++++++++--------- test/tests/popupSettingsCoordinator.test.ts | 28 +++++++ test/tests/simulationServicesOwner.test.ts | 21 +++++ 21 files changed, 294 insertions(+), 138 deletions(-) create mode 100644 app/ts/background/popupSettingsCoordinator.ts create mode 100644 app/ts/types/popupSettingsProtocol.ts create mode 100644 test/tests/popupSettingsCoordinator.test.ts create mode 100644 test/tests/simulationServicesOwner.test.ts diff --git a/app/inpage/ts/inpage.ts b/app/inpage/ts/inpage.ts index 9c2069f67..326b5de5d 100644 --- a/app/inpage/ts/inpage.ts +++ b/app/inpage/ts/inpage.ts @@ -74,6 +74,7 @@ const INTERNAL_BACKGROUND_METHODS = [ const isInternalBackgroundMethod = (method: string) => INTERNAL_BACKGROUND_METHODS.some((internalMethod) => internalMethod === method) type InterceptedRequestBase = { + readonly walletSwitchRequestId?: string, readonly interceptorApproved: true, readonly requestId?: number, readonly method: string, @@ -113,6 +114,7 @@ function chainIdToNetworkVersion(chainId: string) { } type InterceptorApprovedMessageCandidate = { + readonly walletSwitchRequestId?: unknown readonly interceptorApproved?: unknown readonly method?: unknown readonly type?: unknown @@ -204,6 +206,7 @@ function parseInterceptorApprovedMessage(data: unknown): InterceptedRequestForwa ...(typeof requestId === 'number' ? { requestId } : {}), ...(Array.isArray(params) ? { params } : {}), ...(typeof subscription === 'string' ? { subscription } : {}), + ...(typeof data.walletSwitchRequestId === 'string' ? { walletSwitchRequestId: data.walletSwitchRequestId } : {}), } if (type === 'forwardToSigner') return { ...base, @@ -1195,13 +1198,13 @@ class InterceptorMessageListener { throw new Error('wrong type') } - private readonly requestChangeChainFromSigner = async (chainId: string) => { + private readonly requestChangeChainFromSigner = async (chainId: string, walletSwitchRequestId: string) => { if (this.signerWindowEthereumRequest === undefined) { await this.sendInternalMessageToBackgroundPage({ method: 'wallet_switchEthereumChain_reply', params: [{ accept: false, - chainId, + chainId, walletSwitchRequestId, signerProviderGeneration: this.signerProviderGeneration, error: { code: METAMASK_ERROR_PROVIDER_DISCONNECTED, message: 'No signer wallet is available to this page. Enable your wallet extension for this site, then try again.' }, }], @@ -1212,10 +1215,10 @@ class InterceptorMessageListener { const outcome = await this.requestFromCurrentSigner({ method: 'wallet_switchEthereumChain', params: [{ chainId }] }) if (outcome.type === 'success') { const params = outcome.reply === null - ? { accept: true as const, chainId, signerProviderGeneration: outcome.signerProviderGeneration } + ? { accept: true as const, chainId, walletSwitchRequestId, signerProviderGeneration: outcome.signerProviderGeneration } : { accept: false as const, - chainId, + chainId, walletSwitchRequestId, signerProviderGeneration: outcome.signerProviderGeneration, error: { code: METAMASK_ERROR_BLANKET_ERROR, message: 'Signer returned an invalid wallet_switchEthereumChain reply.' }, } @@ -1227,7 +1230,7 @@ class InterceptorMessageListener { : this.normalizeSignerErrorForBackground(outcome.error) await this.sendInternalMessageToBackgroundPage({ method: 'wallet_switchEthereumChain_reply', - params: [{ accept: false, chainId, error, signerProviderGeneration: outcome.signerProviderGeneration }], + params: [{ accept: false, chainId, walletSwitchRequestId, error, signerProviderGeneration: outcome.signerProviderGeneration }], }) } @@ -1383,7 +1386,10 @@ class InterceptorMessageListener { } case 'request_signer_to_eth_requestAccounts': return await this.requestAccountsFromSigner() case 'request_signer_to_eth_accounts': return await this.getAccountsFromSigner() - case 'request_signer_to_wallet_switchEthereumChain': return await this.requestChangeChainFromSigner(replyRequest.result as string) + case 'request_signer_to_wallet_switchEthereumChain': { + if (typeof replyRequest.result !== 'string' || typeof replyRequest.walletSwitchRequestId !== 'string') throw new Error('Invalid wallet switch command') + return await this.requestChangeChainFromSigner(replyRequest.result, replyRequest.walletSwitchRequestId) + } case 'request_signer_to_wallet_watchAsset': return await this.requestWatchAssetFromSigner(replyRequest.result) case 'request_signer_connection_status': return await this.connectToSigner(this.signerName) case 'request_signer_chainId': return await this.requestChainIdFromSigner() diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index 462e93c0d..a2fd88904 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -82,6 +82,7 @@ async function runActiveSettingsChange( ): Promise { const { change } = transition let accessUpdate: WebsiteAccessUpdate | undefined + // This is the transition snapshot, not a second registry of the currently installed services. let activeServices: SimulationServices = { ethereum, tokenPriceService } try { // Settings, approvals, resets, notifications and selection preferences form one ordered transition. @@ -195,7 +196,7 @@ export async function activateAddressSelection( }) } -export async function changeActiveRpc(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, simulationMode: boolean, signerTabId: number | undefined) { +export async function changeActiveRpc(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, simulationMode: boolean, signerTabId: number | undefined, walletSwitchRequestId: string = crypto.randomUUID()) { const currentRpc = (await getSettings()).activeRpcNetwork // Metadata edits at the same endpoint still need to update the active selection. if (JSON.stringify(RpcNetwork.serialize(currentRpc)) === JSON.stringify(RpcNetwork.serialize(rpcNetwork))) { @@ -210,7 +211,7 @@ export async function changeActiveRpc(ethereum: EthereumClientService, tokenPric return { type: 'signerRequestNotNeeded' as const } } const signerStateToken = signerTabId !== undefined - && sendCallbackToConfirmedSignerOwner(websiteTabConnections, signerTabId, { method: 'request_signer_to_wallet_switchEthereumChain', result: rpcNetwork.chainId }) + && sendCallbackToConfirmedSignerOwner(websiteTabConnections, signerTabId, { method: 'request_signer_to_wallet_switchEthereumChain', result: rpcNetwork.chainId, walletSwitchRequestId }) const settings = await getSettings() const popupRefreshGeneration = bumpPopupRefreshGeneration() await sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: settings, popupRefreshGeneration }) diff --git a/app/ts/background/background-startup.ts b/app/ts/background/background-startup.ts index 55d3b58a5..0367b1084 100644 --- a/app/ts/background/background-startup.ts +++ b/app/ts/background/background-startup.ts @@ -25,7 +25,7 @@ import { updateDeclarativeNetRequestBlocks } from './accessManagement.js' import { updatePopupVisualisationIfNeeded } from './popupVisualisationUpdater.js' import { POPUP_PERFORMANCE_MARKS, markPerformance } from '../utils/popupPerformance.js' import { removeWebsiteTabConnection } from './websiteTabConnections.js' -import { createSimulationServices, resetSimulationServices, type ResetSimulationServices, type SimulationServices } from '../simulation/serviceLifecycle.js' +import { createSimulationServicesOwner, type SimulationServicesOwner, type ResetSimulationServices, type SimulationServices } from '../simulation/serviceLifecycle.js' import { addWindowTabListeners } from '../utils/popupOrTab.js' import { migrateAddressBook } from './addressBookMigration.js' import { migrateWebsiteAccess } from './websiteAccessMigration.js' @@ -40,15 +40,14 @@ import { sendSubscriptionReplyOrCallBackToPort } from './messageSending.js' import { initializeTabStateStorage } from './tabStateLifecycle.js' const websiteTabConnections = new Map() -let simulationServices: SimulationServices | undefined -let resetActiveRpcNetwork: ResetSimulationServices | undefined +let simulationServicesOwner: SimulationServicesOwner | undefined const slowRpcRequests = new Map() // Keep request watermarks across port reconnects so replayed messages are acknowledged without being handled twice. Tab removal clears them. const latestReceivedBridgeRequestIds = new Map() function getSimulationServices() { - if (simulationServices === undefined) throw new Error('Simulation services are not initialized') - return simulationServices + if (simulationServicesOwner === undefined) throw new Error('Simulation services are not initialized') + return simulationServicesOwner.getCurrent() } async function publishRpcConnectionStatus(method: RpcConnectionStatusChangeMethod, rpcConnectionStatus: DefinedRpcConnectionStatus) { @@ -278,11 +277,7 @@ async function startup() { const settings = await getSettings() const userSpecifiedSimulatorNetwork = settings.activeRpcNetwork.httpsRpc === undefined ? await getPrimaryRpcForChain(1n) : settings.activeRpcNetwork const simulatorNetwork = userSpecifiedSimulatorNetwork === undefined ? DEFAULT_RPCS[0] : userSpecifiedSimulatorNetwork - simulationServices = createSimulationServices(simulatorNetwork, newBlockAttemptCallback, onErrorBlockCallback, 60000, rpcRequestLifecycleCallbacks) - resetActiveRpcNetwork = (rpcNetwork) => { - simulationServices = resetSimulationServices(getSimulationServices(), rpcNetwork, newBlockAttemptCallback, onErrorBlockCallback, rpcRequestLifecycleCallbacks) - return simulationServices - } + simulationServicesOwner = createSimulationServicesOwner(simulatorNetwork, newBlockAttemptCallback, onErrorBlockCallback, rpcRequestLifecycleCallbacks) await recoverPendingTerminalState() const recursiveCheckIfInterceptorShouldSleep = async () => { await catchAllErrorsAndCall(async () => checkIfInterceptorShouldSleep(getSimulationServices().ethereum, rpcConnectionStatusPublisher.publishRpcConnectionStatus)) @@ -315,10 +310,10 @@ const backgroundStartupPromise = startup() async function waitForBackgroundStartup() { await backgroundStartupPromise - const currentResetActiveRpcNetwork = resetActiveRpcNetwork - if (currentResetActiveRpcNetwork === undefined) throw new Error('Background startup reset handler is not initialized') + const owner = simulationServicesOwner + if (owner === undefined) throw new Error('Background startup reset handler is not initialized') return { - resetActiveRpcNetwork: currentResetActiveRpcNetwork, + resetActiveRpcNetwork: owner.reset, simulationServices: getSimulationServices(), } } diff --git a/app/ts/background/popupMessageDispatcher.ts b/app/ts/background/popupMessageDispatcher.ts index 6b3091f08..d78cef20b 100644 --- a/app/ts/background/popupMessageDispatcher.ts +++ b/app/ts/background/popupMessageDispatcher.ts @@ -1,5 +1,6 @@ import { sendPopupMessageToOpenWindows } from './backgroundUtils.js' -import type { PopupSettingsChangeStatus } from '../types/interceptor-messages.js' +import { getPopupSettingsOperation } from '../types/popupSettingsProtocol.js' +import { createPopupSettingsCoordinator } from './popupSettingsCoordinator.js' import { getSettings } from './settings.js' import { refreshPopupSimulation } from './popupSimulationRefresh.js' import type { PopupMessage } from '../types/interceptor-messages.js' @@ -17,7 +18,7 @@ import { websiteAccessPopupMessageHandlers } from './popupMessageHandlerRegistri export type { PopupMessageDispatcherContext } from './popupMessageHandlerRegistry.js' const popupMessageHandlers = { - popup_requestSettingsChangeStatus: popupMessageHandler('popup_requestSettingsChangeStatus', async () => await publishSettingsChangeStatus()), + popup_requestSettingsChangeStatus: popupMessageHandler('popup_requestSettingsChangeStatus', async () => await settingsCoordinator.publish()), popup_confirmDialog: popupMessageHandler('popup_confirmDialog', async (context, request) => await confirmDialog(context.ethereum, context.tokenPriceService, context.websiteTabConnections, request)), popup_changeActiveAddress: popupMessageHandler('popup_changeActiveAddress', async (context, request) => await changeActiveAddress(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), popup_modifyMakeMeRich: popupMessageHandler('popup_modifyMakeMeRich', async (context, request) => { @@ -74,27 +75,15 @@ const popupMessageHandlers = { ...websiteAccessPopupMessageHandlers, } satisfies PopupMessageHandlerMap -let settingsChangeStatus: PopupSettingsChangeStatus['data'] = { revision: Date.now(), operation: undefined } -const publishSettingsChangeStatus = async () => await sendPopupMessageToOpenWindows({ method: 'popup_settingsChangeStatus', data: settingsChangeStatus }) -function setSettingsChangeOperation(operation: PopupSettingsChangeStatus['data']['operation']) { - settingsChangeStatus = { revision: Math.max(Date.now(), settingsChangeStatus.revision + 1), operation } -} +const settingsCoordinator = createPopupSettingsCoordinator(async (data) => await sendPopupMessageToOpenWindows({ method: 'popup_settingsChangeStatus', data })) export async function dispatchPopupMessage(context: PopupMessageDispatcherContext, request: PopupMessage): Promise { - const isSettingsChange = request.method === 'popup_changeActiveAddress' || request.method === 'popup_enableSimulationMode' || request.method === 'popup_changeActiveRpc' || request.method === 'popup_modifyMakeMeRich' - if (!isSettingsChange) return await popupMessageHandlers[request.method](context, request) - if (settingsChangeStatus.operation !== undefined) return { - type: request.method === 'popup_changeActiveAddress' ? 'ChangeActiveAddressReply' : 'PopupSettingsChangeReply', + const descriptor = getPopupSettingsOperation(request.method) + if (descriptor === undefined) return await popupMessageHandlers[request.method](context, request) + const admission = await settingsCoordinator.run(descriptor.operation, async () => await popupMessageHandlers[request.method]({ ...context, settings: await getSettings() }, request)) + return admission.accepted ? admission.result : { + type: descriptor.replyType, ok: false, message: 'Another popup is changing settings. Please wait for it to finish, then try again.', } - // Admit before the first await. Provider callbacks and read requests remain available while a wallet reply is pending. - setSettingsChangeOperation(request.method === 'popup_changeActiveAddress' ? 'wallet' : request.method === 'popup_enableSimulationMode' ? 'mode' : request.method === 'popup_changeActiveRpc' ? 'rpc' : 'rich') - try { - await publishSettingsChangeStatus() - return await popupMessageHandlers[request.method]({ ...context, settings: await getSettings() }, request) - } finally { - setSettingsChangeOperation(undefined) - await publishSettingsChangeStatus() - } } diff --git a/app/ts/background/popupSettingsCoordinator.ts b/app/ts/background/popupSettingsCoordinator.ts new file mode 100644 index 000000000..7df6d8da7 --- /dev/null +++ b/app/ts/background/popupSettingsCoordinator.ts @@ -0,0 +1,23 @@ +import type { PopupSettingsChangeStatus, PopupSettingsOperation } from '../types/popupSettingsProtocol.js' + +export function createPopupSettingsCoordinator(publish: (status: PopupSettingsChangeStatus['data']) => Promise, now = Date.now) { + let status: PopupSettingsChangeStatus['data'] = { revision: now(), operation: undefined } + const setOperation = (operation: PopupSettingsOperation | undefined) => { + status = { revision: Math.max(now(), status.revision + 1), operation } + } + return { + publish: async () => { await publish(status) }, + async run(operation: PopupSettingsOperation, action: () => Promise) { + if (status.operation !== undefined) return { accepted: false } as const + // Admission is synchronous; this status stream also orders broadcasts against reopen queries. + setOperation(operation) + try { + await publish(status) + return { accepted: true, result: await action() } as const + } finally { + setOperation(undefined) + await publish(status) + } + }, + } +} diff --git a/app/ts/background/providerMessageHandlers.ts b/app/ts/background/providerMessageHandlers.ts index f4cda153f..93bd7cbf0 100644 --- a/app/ts/background/providerMessageHandlers.ts +++ b/app/ts/background/providerMessageHandlers.ts @@ -6,7 +6,7 @@ import { activateAddressSelection, changeActiveAddressAndChain } from './activeS import { getSocketFromPort, sendInternalWindowMessage, sendPopupMessageToOpenWindows } from './backgroundUtils.js' import { getRpcNetworkForChain, promoteRpcAsPrimary, setDefaultSignerName, updatePendingTransactionOrMessage, updateTabState } from './storageVariables.js' import { getMetamaskCompatibilityMode, getSettings } from './settings.js' -import { consumeExpiredSignerChainReply, markSignerChainReplyReceived, getPendingSignerChainChangeRpc, getPendingSignerChainChangeTokenForCallback, isPendingSignerChainChangeReply, resolveSignerChainChange } from './windows/changeChain.js' +import { isPendingWalletSwitchRequest, markSignerChainReplyReceived, getPendingSignerChainChangeRpc, getPendingSignerChainChangeTokenForCallback, isPendingSignerChainChangeReply, resolveSignerChainChange } from './windows/changeChain.js' import { type ApprovalState, withSuppressedUnscopedConnectionEventsForSocketAsync } from './accessManagement.js' import type { ProviderMessage } from '../utils/requests.js' import { JSON_RPC_ERROR_CODE_INTERNAL_ERROR, METAMASK_ERROR_USER_REJECTED_REQUEST } from '../utils/constants.js' @@ -172,7 +172,7 @@ export async function signerChainChanged(ethereum: EthereumClientService, tokenP }) } -export async function walletSwitchEthereumChainReply(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, _activeAddress: bigint | undefined) { +export async function walletSwitchEthereumChainReply(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, _approval: ApprovalState, _activeAddress: bigint | undefined) { const returnValue = { type: 'result' as const, method: 'wallet_switchEthereumChain_reply' as const, result: '0x' as const } const params = WalletSwitchEthereumChainReply.parse(request).params[0] const socket = getSocketFromPort(port) @@ -180,22 +180,22 @@ export async function walletSwitchEthereumChainReply(ethereum: EthereumClientSer return await runSignerStateOperation(websiteTabConnections, socket.tabId, async () => { const currentSignerStateToken = getConfirmedSignerStateToken(websiteTabConnections, socket.tabId) if (currentSignerStateToken?.socket.connectionName !== socket.connectionName || currentSignerStateToken.port !== port) return returnValue - if (consumeExpiredSignerChainReply(port, params.signerProviderGeneration, params.chainId)) return returnValue + if (!isPendingWalletSwitchRequest(params.walletSwitchRequestId)) return returnValue const pendingSignerStateToken = getPendingSignerChainChangeTokenForCallback(port, params.signerProviderGeneration, params.chainId) const callbackSignerStateToken = pendingSignerStateToken ?? (currentSignerStateToken.signerProviderGeneration === params.signerProviderGeneration ? currentSignerStateToken : undefined) if (callbackSignerStateToken === undefined) return returnValue const solicitedReply = isPendingSignerChainChangeReply(callbackSignerStateToken, params.chainId) - // A solicited wallet reply retains the tab authorization captured when its command was dispatched. Unsolicited chainChanged-style updates still require a currently approved frame. - if (!solicitedReply && !hasSignerCallbackAccess(websiteTabConnections, socket.tabId, approval)) return returnValue + // Only this command's owner and chain may apply its reply. Unsolicited chain events use signerChainChanged. + if (!solicitedReply) return returnValue if (currentSignerStateToken.signerProviderGeneration !== params.signerProviderGeneration) { resolveSignerChainChange(callbackSignerStateToken, { method: 'popup_signerChangeChainDialog', - data: [{ accept: false, chainId: params.chainId, error: signerConnectionReplacedError, signerProviderGeneration: params.signerProviderGeneration }], + data: [{ accept: false, chainId: params.chainId, walletSwitchRequestId: params.walletSwitchRequestId, error: signerConnectionReplacedError, signerProviderGeneration: params.signerProviderGeneration }], }) return returnValue } - markSignerChainReplyReceived(callbackSignerStateToken, params.chainId) + markSignerChainReplyReceived(callbackSignerStateToken, params.chainId, params.walletSwitchRequestId) try { if (params.accept) { const requestedRpc = getPendingSignerChainChangeRpc(callbackSignerStateToken, params.chainId) @@ -211,7 +211,7 @@ export async function walletSwitchEthereumChainReply(ethereum: EthereumClientSer // Delivery ended the wallet deadline; a failure while applying the reply must also release the waiting popup. resolveSignerChainChange(callbackSignerStateToken, { method: 'popup_signerChangeChainDialog', - data: [{ accept: false, chainId: params.chainId, signerProviderGeneration: params.signerProviderGeneration, error: { code: JSON_RPC_ERROR_CODE_INTERNAL_ERROR, message: 'The wallet replied, but updating the selected network failed. Refresh the popup and try again.' } }], + data: [{ accept: false, chainId: params.chainId, walletSwitchRequestId: params.walletSwitchRequestId, signerProviderGeneration: params.signerProviderGeneration, error: { code: JSON_RPC_ERROR_CODE_INTERNAL_ERROR, message: 'The wallet replied, but updating the selected network failed. Refresh the popup and try again.' } }], }) throw error } diff --git a/app/ts/background/windows/changeChain.ts b/app/ts/background/windows/changeChain.ts index 3c121f7c7..8069557f5 100644 --- a/app/ts/background/windows/changeChain.ts +++ b/app/ts/background/windows/changeChain.ts @@ -14,16 +14,18 @@ import type { EthereumClientService } from '../../simulation/services/EthereumCl import type { TokenPriceService } from '../../simulation/services/priceEstimator.js' import type { ResetSimulationServices } from '../../simulation/serviceLifecycle.js' import { type PopupOrTab, addWindowTabListeners, closePopupOrTabById, getPopupOrTabById, openPopupOrTab, removeWindowTabListeners } from '../../utils/popupOrTab.js' -import { addSignerStateReplacementListener, doSignerStateTokensMatch, getConfirmedSignerStateToken, signerUnavailableError, type SignerStateToken } from '../signerStateOwnership.js' +import { addSignerStateReplacementListener, doSignerStateTokensMatch, signerUnavailableError, type SignerStateToken } from '../signerStateOwnership.js' let pendForUserReply: Future | undefined type PendingSignerChainChange = { + readonly walletSwitchRequestId: string readonly future: Future< | { readonly type: 'reply', readonly confirmation: SignerChainChangeConfirmation } | { readonly type: 'replacement', readonly error: typeof signerUnavailableError } | { readonly type: 'timeout' } > + replyReceived: boolean timeout: ReturnType | undefined readonly requestTabId: number readonly requestedRpcNetwork: RpcNetwork @@ -33,20 +35,19 @@ type PendingSignerChainChange = { } let pendingSignerChainChange: PendingSignerChainChange | undefined -// The wallet protocol has no per-command identifier. Keep timed-out commands isolated until their reply or a new signer generation, so a late reply cannot complete a retry. -const expiredSignerChainChanges = new WeakMap() const WALLET_SWITCH_TIMEOUT_MS = 120_000 -export function consumeExpiredSignerChainReply(port: browser.runtime.Port, signerProviderGeneration: number, chainId: bigint) { - const expired = expiredSignerChainChanges.get(port) - if (expired === undefined || expired.token.signerProviderGeneration !== signerProviderGeneration || expired.chainId !== chainId) return false - expiredSignerChainChanges.delete(port) - return true +// Command IDs isolate replies across popup/dapp requests, including retries after a deadline. +export function isPendingWalletSwitchRequest(walletSwitchRequestId: string) { + return pendingSignerChainChange?.walletSwitchRequestId === walletSwitchRequestId } -export function markSignerChainReplyReceived(token: SignerStateToken, chainId: bigint) { +export function markSignerChainReplyReceived(token: SignerStateToken, chainId: bigint, walletSwitchRequestId: string) { const pending = pendingSignerChainChange - if (pending !== undefined && doesPendingSignerChainChangeMatch(pending, token, chainId)) clearTimeout(pending.timeout) + if (pending !== undefined && pending.walletSwitchRequestId === walletSwitchRequestId && doesPendingSignerChainChangeMatch(pending, token, chainId)) { + pending.replyReceived = true + clearTimeout(pending.timeout) + } } let chainChangeResolutionInProgress = false @@ -113,8 +114,8 @@ export function getPendingSignerChainChangeRpc(signerStateToken: SignerStateToke } export function resolveSignerChainChange(signerStateToken: SignerStateToken, confirmation: SignerChainChangeConfirmation) { - if (consumeExpiredSignerChainReply(signerStateToken.port, signerStateToken.signerProviderGeneration, confirmation.data[0].chainId)) return false - markSignerChainReplyReceived(signerStateToken, confirmation.data[0].chainId) + if (!isPendingWalletSwitchRequest(confirmation.data[0].walletSwitchRequestId)) return false + markSignerChainReplyReceived(signerStateToken, confirmation.data[0].chainId, confirmation.data[0].walletSwitchRequestId) const pending = pendingSignerChainChange if (pending === undefined || !doesPendingSignerChainChangeMatch(pending, signerStateToken, confirmation.data[0].chainId)) return false if (pending.signerStateToken === undefined) { @@ -225,10 +226,9 @@ async function resolve(ethereum: EthereumClientService, tokenPriceService: Token export async function requestSignerChainChange(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, requestTabId: number, timeoutMs = WALLET_SWITCH_TIMEOUT_MS) { if (pendingSignerChainChange !== undefined) return { error: { code: -32002, message: 'A network switch is already waiting for your wallet.' } } - const currentToken = getConfirmedSignerStateToken(websiteTabConnections, requestTabId) - const expired = currentToken === undefined ? undefined : expiredSignerChainChanges.get(currentToken.port) - if (expired !== undefined && currentToken !== undefined && expired.token.signerProviderGeneration === currentToken.signerProviderGeneration) return { error: { code: -32002, message: 'The previous network request is still open in your wallet. Dismiss it or reconnect the wallet before trying again.' } } const pending: PendingSignerChainChange = { + walletSwitchRequestId: crypto.randomUUID(), + replyReceived: false, timeout: undefined, future: new Future< | { readonly type: 'reply', readonly confirmation: SignerChainChangeConfirmation } @@ -250,15 +250,14 @@ export async function requestSignerChainChange(ethereum: EthereumClientService, }) pendingSignerChainChange = pending try { - const changeActiveRpcResult = await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, rpcNetwork, false, requestTabId) + const changeActiveRpcResult = await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, rpcNetwork, false, requestTabId, pending.walletSwitchRequestId) if (changeActiveRpcResult.type !== 'signerRequestSent') { return changeActiveRpcResult.type === 'signerRequestNotNeeded' ? { result: null } as const : { error: signerUnavailableError } as const } pending.signerStateToken = changeActiveRpcResult.signerStateToken - pending.timeout = setTimeout(() => { - expiredSignerChainChanges.set(changeActiveRpcResult.signerStateToken.port, { token: changeActiveRpcResult.signerStateToken, chainId: rpcNetwork.chainId }) + if (!pending.replyReceived) pending.timeout = setTimeout(() => { pending.future.resolve({ type: 'timeout' }) }, timeoutMs) const precedingReply = pending.repliesBeforeToken.find(({ signerStateToken, confirmation }) => { @@ -269,7 +268,7 @@ export async function requestSignerChainChange(ethereum: EthereumClientService, const precedingReplacement = pending.replacementsBeforeToken.find(({ signerStateToken }) => doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, signerStateToken)) if (precedingReplacement !== undefined) pending.future.resolve({ type: 'replacement', error: precedingReplacement.error }) const signerResult = await pending.future - if (signerResult.type === 'timeout') return { error: { code: -32002, message: 'Your wallet did not answer the network request in time. Other settings are available again. Dismiss the request in your wallet or reconnect it before retrying.' } } + if (signerResult.type === 'timeout') return { error: { code: -32002, message: 'Your wallet did not answer the network request in time. You can retry or change other settings. Your wallet may still show the previous request.' } } if (signerResult.type === 'replacement') return { error: signerResult.error } as const if (signerResult.confirmation.data[0].accept === false) return { error: signerResult.confirmation.data[0].error } as const // forward signers error to the application if (signerResult.confirmation.data[0].chainId === rpcNetwork.chainId) return { result: null } diff --git a/app/ts/components/App.tsx b/app/ts/components/App.tsx index 07b089ed1..ac5b7a1af 100644 --- a/app/ts/components/App.tsx +++ b/app/ts/components/App.tsx @@ -1,3 +1,4 @@ +import { acceptPopupSettingsChangeStatus, getPopupSettingsOperationLabel } from '../types/popupSettingsProtocol.js' import { useEffect } from 'preact/hooks' import { Home } from './pages/Home.js' import Hint from './subcomponents/Hint.js' @@ -22,7 +23,7 @@ import { ProviderErrors } from './subcomponents/ProviderErrors.js' import { PopupModal, type PopupPage } from './PopupModal.js' import { getSelectableActiveAddresses, includePersistedAddressBookEntry, isActiveAddressSelectionAllowed } from '../utils/activeAddressSelection.js' import { requestPopupSettingsChange } from './popupSettingsChange.js' -import type { ChangeActiveChain, EnableSimulationMode, ModifyMakeMeRich } from '../types/popupSettingsRequests.js' +import type { PopupSettingsRequestWithSharedReply } from '../types/popupSettingsRequests.js' import { requestActiveAddressChange } from './activeAddressChange.js' import { useModeActiveAddress } from './hooks/useModeActiveAddress.js' export { NetworkErrors } from './subcomponents/NetworkErrors.js' @@ -31,6 +32,7 @@ export function App() { const appPage = useSignal({ page: 'Unknown' }) const pendingAddressChangeRequestId = useSignal(undefined) const isActiveAddressChanging = useSignal(false) + // Local state covers dispatch latency; shared status coordinates other and reopened popups. const pendingSettingsChange = useSignal(false) const backgroundSettingsChange = useSignal({ revision: 0, operation: undefined }) const { @@ -73,7 +75,7 @@ export function App() { isActiveAddressChanging.value = false }, onSettingsChangeStatus(status) { - if (status.revision >= backgroundSettingsChange.value.revision) backgroundSettingsChange.value = status + backgroundSettingsChange.value = acceptPopupSettingsChangeStatus(backgroundSettingsChange.value, status) }, onInitialSettings(settings: Settings) { if (appPage.value.page !== 'Unknown') return @@ -108,7 +110,7 @@ export function App() { } } - async function changePopupSettings(message: ChangeActiveChain | EnableSimulationMode | ModifyMakeMeRich) { + async function changePopupSettings(message: PopupSettingsRequestWithSharedReply) { if (!isSettingsLoaded.value) return if (isSettingsChangePending.value) throw new Error('A settings change is already in progress. Please wait for it to finish.') pendingSettingsChange.value = true @@ -281,9 +283,7 @@ export function App() { { backgroundSettingsChange.value.operation !== undefined && !pendingSettingsChange.value && !isActiveAddressChangePending.value - ?
{ { - wallet: 'Changing wallet...', mode: 'Changing mode...', rpc: 'Changing network. Check your wallet if approval is required.', rich: 'Updating balances...', - }[backgroundSettingsChange.value.operation] }
: <> } + ?
{ getPopupSettingsOperationLabel(backgroundSettingsChange.value.operation) }
: <> } SimulationServices export type SimulationServices = { - ethereum: EthereumClientService - tokenPriceService: TokenPriceService + readonly ethereum: EthereumClientService + readonly tokenPriceService: TokenPriceService } export function createEthereumClientService( @@ -63,3 +63,22 @@ export function resetSimulationServices( rpcRequestLifecycleCallbacks, ) } + +export type SimulationServicesOwner = ReturnType + +// One owner publishes installed services. Returned pairs are snapshots for an operation; independent message handlers must read getCurrent() when their work starts. +export function createSimulationServicesOwner( + rpcNetwork: RpcEntry, + newBlockAttemptCallback: NewBlockAttemptCallback, + onErrorBlockCallback: OnErrorBlockCallback, + rpcRequestLifecycleCallbacks: RpcRequestLifecycleCallbacks = {}, +) { + let current = createSimulationServices(rpcNetwork, newBlockAttemptCallback, onErrorBlockCallback, 60000, rpcRequestLifecycleCallbacks) + return { + getCurrent: () => current, + reset: (nextRpc: RpcEntry): SimulationServices => { + current = resetSimulationServices(current, nextRpc, newBlockAttemptCallback, onErrorBlockCallback, rpcRequestLifecycleCallbacks) + return current + }, + } +} diff --git a/app/ts/types/interceptor-messages.ts b/app/ts/types/interceptor-messages.ts index a43c96250..442651d76 100644 --- a/app/ts/types/interceptor-messages.ts +++ b/app/ts/types/interceptor-messages.ts @@ -1,3 +1,4 @@ +import { PopupSettingsChangeStatus } from './popupSettingsProtocol.js' import { ModifyMakeMeRich, EnableSimulationMode, ChangeActiveChain, ChangeActiveAddress } from './popupSettingsRequests.js' import * as funtypes from 'funtypes' import { PendingChainChangeConfirmationPromise, PendingFetchSimulationStackRequestPromise, PendingWatchAssetRequest, RpcConnectionStatus, TabIconDetails, TabState } from './user-interface-types.js' @@ -25,12 +26,14 @@ const WalletSwitchEthereumChainReplyParams = funtypes.Tuple(funtypes.Union( accept: funtypes.Literal(true), chainId: EthereumQuantity, signerProviderGeneration: funtypes.Number, + walletSwitchRequestId: funtypes.String, }), funtypes.ReadonlyObject({ accept: funtypes.Literal(false), chainId: EthereumQuantity, error: ErrorWithCodeAndOptionalData, signerProviderGeneration: funtypes.Number, + walletSwitchRequestId: funtypes.String, }) )) @@ -80,7 +83,7 @@ export const InpageScriptCallBack = funtypes.Union( ErrorReturn, funtypes.ReadonlyObject({ method: funtypes.Literal('request_signer_connection_status'), result: funtypes.ReadonlyTuple() }), funtypes.ReadonlyObject({ method: funtypes.Literal('request_signer_chainId'), result: funtypes.ReadonlyTuple() }), - funtypes.ReadonlyObject({ method: funtypes.Literal('request_signer_to_wallet_switchEthereumChain'), result: EthereumQuantity }), + funtypes.ReadonlyObject({ method: funtypes.Literal('request_signer_to_wallet_switchEthereumChain'), result: EthereumQuantity, walletSwitchRequestId: funtypes.String }), funtypes.ReadonlyObject({ method: funtypes.Literal('request_signer_to_wallet_watchAsset'), result: WatchAssetSignerRequest }), funtypes.ReadonlyObject({ method: funtypes.Literal('request_signer_to_eth_requestAccounts'), result: funtypes.ReadonlyTuple() }), funtypes.ReadonlyObject({ method: funtypes.Literal('request_signer_to_eth_accounts'), result: funtypes.ReadonlyTuple() }), @@ -944,14 +947,7 @@ const PopupIsMainPopupWindowOpen = funtypes.ReadonlyObject({ method: funtypes.Literal('popup_isMainPopupWindowOpen'), }).asReadonly() -export type PopupSettingsChangeStatus = funtypes.Static -export const PopupSettingsChangeStatus = funtypes.ReadonlyObject({ - method: funtypes.Literal('popup_settingsChangeStatus'), - data: funtypes.ReadonlyObject({ - revision: funtypes.Number, - operation: funtypes.Union(funtypes.Undefined, funtypes.Literal('wallet'), funtypes.Literal('mode'), funtypes.Literal('rpc'), funtypes.Literal('rich')), - }), -}) +export { PopupSettingsChangeStatus } from './popupSettingsProtocol.js' const messageToPopupPayloadCodecs: [ typeof PopupSettingsChangeStatus, diff --git a/app/ts/types/interceptor-reply-messages.ts b/app/ts/types/interceptor-reply-messages.ts index f26e6fafb..7fc253f2f 100644 --- a/app/ts/types/interceptor-reply-messages.ts +++ b/app/ts/types/interceptor-reply-messages.ts @@ -1,4 +1,5 @@ import { ModifyMakeMeRich, EnableSimulationMode, ChangeActiveChain, ChangeActiveAddress } from './popupSettingsRequests.js' +import type { popupSettingsOperations } from './popupSettingsProtocol.js' import * as funtypes from 'funtypes' import { AddressBookEntry, ChainIdWithUniversal } from '../types/addressBookTypes.js' import { PopupOrTabId } from './websiteAccessTypes.js' @@ -276,7 +277,17 @@ const PopupReadyAndListeningReply = funtypes.ReadonlyObject({ }), }).asReadonly() -type PopupRequestsRepliesMap = { +type PopupSettingsReplyCodecs = { + ChangeActiveAddressReply: typeof ChangeActiveAddressReply + PopupSettingsChangeReply: typeof PopupSettingsChangeReply +} + +// Every registered settings operation must provide the reply codec declared by its descriptor. +type PopupSettingsRepliesMap = { + [Method in keyof typeof popupSettingsOperations]: PopupSettingsReplyCodecs[typeof popupSettingsOperations[Method]['replyType']] +} + +type PopupRequestsRepliesMap = PopupSettingsRepliesMap & { popup_requestMakeMeRichData: typeof RequestMakeMeRichDataReply popup_requestActiveAddresses: typeof RequestActiveAddressesReply popup_requestSimulationMode: typeof RequestSimulationModeReply @@ -284,10 +295,6 @@ type PopupRequestsRepliesMap = { popup_requestInterceptorSimulationInput: typeof RequestInterceptorSimulationInputReply popup_importSimulationStack: typeof ImportSimulationStackReply popup_addOrModifyAddressBookEntry: typeof AddOrModifyAddressBookEntryReply - popup_changeActiveAddress: typeof ChangeActiveAddressReply - popup_enableSimulationMode: typeof PopupSettingsChangeReply - popup_changeActiveRpc: typeof PopupSettingsChangeReply - popup_modifyMakeMeRich: typeof PopupSettingsChangeReply popup_setSafeSimulationSigner: typeof SetSafeSimulationSignerReply popup_requestSafeStackExport: typeof RequestSafeStackExportReply popup_importSafeStack: typeof ImportSafeStackReply diff --git a/app/ts/types/popupSettingsProtocol.ts b/app/ts/types/popupSettingsProtocol.ts new file mode 100644 index 000000000..2de3f5d32 --- /dev/null +++ b/app/ts/types/popupSettingsProtocol.ts @@ -0,0 +1,26 @@ +import * as funtypes from 'funtypes' +import type { PopupSettingsRequest } from './popupSettingsRequests.js' + +// Exhaustive over settings requests: admission, shared status, and UI text use this definition. +export const popupSettingsOperations = { + popup_changeActiveAddress: { operation: 'wallet', label: 'Changing wallet...', replyType: 'ChangeActiveAddressReply' }, + popup_enableSimulationMode: { operation: 'mode', label: 'Changing mode...', replyType: 'PopupSettingsChangeReply' }, + popup_changeActiveRpc: { operation: 'rpc', label: 'Changing network. Check your wallet if approval is required.', replyType: 'PopupSettingsChangeReply' }, + popup_modifyMakeMeRich: { operation: 'rich', label: 'Updating balances...', replyType: 'PopupSettingsChangeReply' }, +} as const satisfies Record + +const operations = Object.values(popupSettingsOperations) +export type PopupSettingsOperation = typeof operations[number]['operation'] +export const PopupSettingsOperation = funtypes.String.withGuard((value): value is PopupSettingsOperation => operations.some(entry => entry.operation === value)) +export const getPopupSettingsOperation = (method: string) => Object.entries(popupSettingsOperations).find(([key]) => key === method)?.[1] +export const getPopupSettingsOperationLabel = (operation: PopupSettingsOperation) => operations.find(entry => entry.operation === operation)?.label + +export type PopupSettingsChangeStatus = funtypes.Static +export const PopupSettingsChangeStatus = funtypes.ReadonlyObject({ + method: funtypes.Literal('popup_settingsChangeStatus'), + data: funtypes.ReadonlyObject({ revision: funtypes.Number, operation: funtypes.Union(funtypes.Undefined, PopupSettingsOperation) }), +}) + +export function acceptPopupSettingsChangeStatus(current: PopupSettingsChangeStatus['data'], incoming: PopupSettingsChangeStatus['data']) { + return incoming.revision >= current.revision ? incoming : current +} diff --git a/app/ts/types/popupSettingsRequests.ts b/app/ts/types/popupSettingsRequests.ts index 588c0af09..c0d13dfa0 100644 --- a/app/ts/types/popupSettingsRequests.ts +++ b/app/ts/types/popupSettingsRequests.ts @@ -31,3 +31,7 @@ export const ChangeActiveAddress = funtypes.ReadonlyObject({ activeAddress: funtypes.Union(EthereumAddress, funtypes.Literal('signer')), }).And(funtypes.ReadonlyPartial({ addressChangeRequestId: funtypes.String })) }).asReadonly() + +export type PopupSettingsRequest = ModifyMakeMeRich | EnableSimulationMode | ChangeActiveChain | ChangeActiveAddress + +export type PopupSettingsRequestWithSharedReply = Exclude diff --git a/test/benchmarks/README.md b/test/benchmarks/README.md index d629ccf42..f76df0c2e 100644 --- a/test/benchmarks/README.md +++ b/test/benchmarks/README.md @@ -89,6 +89,6 @@ After a successful chain switch and return to simulation mode, the same connecte The transient RPC failure scenario expects the rich setting to be saved while the popup displays a failed simulation; an explicit refresh must recover once the fixture RPC is restored. -The wallet-response deadline is covered by focused tests using a shortened timeout; the browser fixture holds and releases replies explicitly rather than waiting two minutes. Timing samples cover ten scenarios; popup lifecycle/conflict and RPC-recovery assertions run alongside them without speed thresholds. +The wallet-response deadline and a later dapp request on the same signer connection are covered by focused tests using a shortened timeout. Per-command IDs prevent expired or reordered wallet replies from completing another switch; the browser fixture holds and releases replies explicitly rather than waiting two minutes. Timing samples cover ten scenarios; popup lifecycle/conflict and RPC-recovery assertions run alongside them without speed thresholds. For comparisons, build each revision and run the same command with the same browser, delays, iteration count, and host load. Compare feedback and selected-value timings separately from total completion time. Fixture setup is excluded from sample timings. diff --git a/test/tests/backgroundEthAccountsTestHarness.ts b/test/tests/backgroundEthAccountsTestHarness.ts index 27be9357e..e1e325b5a 100644 --- a/test/tests/backgroundEthAccountsTestHarness.ts +++ b/test/tests/backgroundEthAccountsTestHarness.ts @@ -9,7 +9,7 @@ import { EthereumJsonRpcRequest } from '../../app/ts/types/JsonRpc-types.js' import { addressString } from '../../app/ts/utils/bigint.js' type Listener = () => void -type PortMessage = { type?: unknown, method?: unknown, result?: unknown, requestId?: unknown, error?: { code?: unknown, message?: unknown } } +type PortMessage = { walletSwitchRequestId?: unknown, type?: unknown, method?: unknown, result?: unknown, requestId?: unknown, error?: { code?: unknown, message?: unknown } } export const noopPublishRpcConnectionStatus: PublishRpcConnectionStatus = async () => undefined export function createDeferredSignal() { @@ -235,3 +235,9 @@ export function createEthereumWithGetBlockCounter( } export { addressString, createSafeTx, EthereumJsonRpcRequest, safeTxToTypedDataJson } + +export function getWalletSwitchRequestId(messages: readonly PortMessage[], index = -1) { + const id = messages.filter(message => message.method === 'request_signer_to_wallet_switchEthereumChain').at(index)?.walletSwitchRequestId + if (typeof id !== 'string') throw new Error('Missing wallet switch request ID') + return id +} diff --git a/test/tests/backgroundSignerLifecycle.test.ts b/test/tests/backgroundSignerLifecycle.test.ts index 0cdb651a7..a49318511 100644 --- a/test/tests/backgroundSignerLifecycle.test.ts +++ b/test/tests/backgroundSignerLifecycle.test.ts @@ -1,6 +1,6 @@ import * as assert from 'assert' import { describe, test } from 'bun:test' -import { confirmedSignerOwnership, createEthereumWithGetBlockCounter, createPort, installBrowserMock, loadModules, noopPublishRpcConnectionStatus, waitForPortMessageCount } from './backgroundEthAccountsTestHarness.js' +import { getWalletSwitchRequestId, confirmedSignerOwnership, createEthereumWithGetBlockCounter, createPort, installBrowserMock, loadModules, noopPublishRpcConnectionStatus, waitForPortMessageCount } from './backgroundEthAccountsTestHarness.js' describe('background eth_accounts', () => { test('awaits retry-state publishing before replying to a waking RPC request', async () => { @@ -257,7 +257,7 @@ describe('background eth_accounts', () => { assert.equal(interactiveRequestsBeforePassiveReply, 0) assert.equal(childMessages.some((message) => message.method === 'request_signer_to_eth_accounts' || message.method === 'request_signer_to_eth_requestAccounts'), false) assert.deepEqual(messages.filter((message) => message.method === 'eth_accounts' && message.requestId === 71).at(-1)?.result, [accountString]) - const signerStateToken = sendCallbackToConfirmedSignerOwner(websiteTabConnections, socket.tabId, { method: 'request_signer_to_wallet_switchEthereumChain', result: 2n }) + const signerStateToken = sendCallbackToConfirmedSignerOwner(websiteTabConnections, socket.tabId, { method: 'request_signer_to_wallet_switchEthereumChain', result: 2n, walletSwitchRequestId: 'test-switch' }) assert.notEqual(signerStateToken, false) if (signerStateToken === false) throw new Error('Expected a confirmed signer owner') assert.equal(signerStateToken.port, port) @@ -305,7 +305,7 @@ describe('background eth_accounts', () => { assert.deepEqual((await getTabState(socket.tabId)).signerAccounts, [0x2424242424242424242424242424242424242424n]) assert.equal(childMessages.some((message) => message.method === 'request_signer_to_eth_accounts'), false) - const signerStateToken = sendCallbackToConfirmedSignerOwner(websiteTabConnections, socket.tabId, { method: 'request_signer_to_wallet_switchEthereumChain', result: 2n }) + const signerStateToken = sendCallbackToConfirmedSignerOwner(websiteTabConnections, socket.tabId, { method: 'request_signer_to_wallet_switchEthereumChain', result: 2n, walletSwitchRequestId: 'test-switch' }) assert.notEqual(signerStateToken, false) assert.equal(messages.filter((message) => message.method === 'request_signer_to_wallet_switchEthereumChain').length, 1) assert.equal(childMessages.some((message) => message.method === 'request_signer_to_wallet_switchEthereumChain'), false) @@ -338,7 +338,7 @@ describe('background eth_accounts', () => { connectionName: expectedSocket.connectionName, ownerGeneration: 1, signerProviderGeneration: 1, - }, { method: 'request_signer_to_wallet_switchEthereumChain', result: 2n }) + }, { method: 'request_signer_to_wallet_switchEthereumChain', result: 2n, walletSwitchRequestId: 'test-switch' }) assert.equal(result, false) assert.equal(currentSignerMessages.length, 0) @@ -484,7 +484,7 @@ describe('background eth_accounts', () => { usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 96, requestSocket: ownerSocket }, method: 'wallet_switchEthereumChain_reply', - params: [{ accept: true, chainId: '0xaa36a7', signerProviderGeneration: 1 }], + params: [{ accept: true, chainId: '0xaa36a7', signerProviderGeneration: 1, walletSwitchRequestId: getWalletSwitchRequestId(ownerMessages) }], }, websiteTabConnections, noopPublishRpcConnectionStatus) await Promise.race([ resolution, @@ -586,7 +586,7 @@ describe('background eth_accounts', () => { usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 98, requestSocket: popupSocket }, method: 'wallet_switchEthereumChain_reply', - params: [{ accept: false, chainId: '0x4268', error: { code: 4001, message: 'Popup tab rejected' }, signerProviderGeneration: 1 }], + params: [{ accept: false, chainId: '0x4268', error: { code: 4001, message: 'Popup tab rejected' }, walletSwitchRequestId: getWalletSwitchRequestId(requestMessages), signerProviderGeneration: 1 }], }, websiteTabConnections, noopPublishRpcConnectionStatus) await new Promise((resolve) => setTimeout(resolve, 0)) assert.equal(requestSettled, false) @@ -597,7 +597,7 @@ describe('background eth_accounts', () => { usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 99, requestSocket }, method: 'wallet_switchEthereumChain_reply', - params: [{ accept: false, chainId: '0xaa36a7', error: { code: 4001, message: 'Dapp tab rejected' }, signerProviderGeneration: 1 }], + params: [{ accept: false, chainId: '0xaa36a7', error: { code: 4001, message: 'Dapp tab rejected' }, walletSwitchRequestId: getWalletSwitchRequestId(requestMessages), signerProviderGeneration: 1 }], }, websiteTabConnections, noopPublishRpcConnectionStatus) await resolution @@ -718,7 +718,7 @@ describe('background eth_accounts', () => { usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 102, requestSocket: socket }, method: 'wallet_switchEthereumChain_reply', - params: [{ accept: false, chainId: '0xaa36a7', error: { code: 4001, message: 'First signer rejected' }, signerProviderGeneration: 1 }], + params: [{ accept: false, chainId: '0xaa36a7', error: { code: 4001, message: 'First signer rejected' }, walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: 1 }], }, websiteTabConnections, noopPublishRpcConnectionStatus) const firstResult = await Promise.race([ firstResolution, diff --git a/test/tests/inpageSignerBridge.test.ts b/test/tests/inpageSignerBridge.test.ts index 1dd75782e..3354b7174 100644 --- a/test/tests/inpageSignerBridge.test.ts +++ b/test/tests/inpageSignerBridge.test.ts @@ -787,6 +787,7 @@ describe('inpage signer bridge', () => { interceptorApproved: true, type: 'result', method: 'request_signer_to_wallet_switchEthereumChain', + walletSwitchRequestId: 'test-switch', result: '0x2', }) await waitFor(() => chainSwitchRequestCount === 1) @@ -798,6 +799,7 @@ describe('inpage signer bridge', () => { if (!isRecord(reply) || !isRecord(reply.error)) throw new Error('Malformed chain switch reply') assert.equal(reply.accept, false) assert.equal(reply.chainId, '0x2') + assert.equal(reply.walletSwitchRequestId, 'test-switch') assert.equal(reply.error.code, 4900) assert.equal(reply.error.message, 'Signer connection changed before the previous wallet replied.') }) @@ -827,6 +829,7 @@ describe('inpage signer bridge', () => { interceptorApproved: true, type: 'result', method: 'request_signer_to_wallet_switchEthereumChain', + walletSwitchRequestId: 'test-switch', result: '0x2', }) await waitFor(() => chainSwitchReplies.length === 1) @@ -862,6 +865,7 @@ describe('inpage signer bridge', () => { interceptorApproved: true, type: 'result', method: 'request_signer_to_wallet_switchEthereumChain', + walletSwitchRequestId: 'test-switch', result: '0x2', }) await waitFor(() => chainSwitchReplies.length === 1) @@ -874,6 +878,31 @@ describe('inpage signer bridge', () => { assert.match(String(reply.error.message), /No signer wallet is available/) }) + test('keeps wallet switch request IDs when replies arrive out of order', async () => { + const replies: unknown[] = [] + const complete: ((value: unknown) => void)[] = [] + const { fakeWindow, sendBackgroundMessage } = createFakeWindow({ + handleRequest: (request, respond) => { + if (request.method !== 'wallet_switchEthereumChain_reply') return false + replies.push(request.params?.[0]) + respond({ interceptorApproved: true, type: 'result', requestId: request.requestId, method: request.method, result: '0x' }) + return true + }, + handleSignerRequest: ({ method }) => method === 'wallet_switchEthereumChain' ? new Promise(resolve => complete.push(resolve)) : undefined, + }) + await withFakeInpageWindow(fakeWindow, '../../app/inpage/ts/inpage.js?out-of-order-wallet-switches', async () => { + for (const walletSwitchRequestId of ['expired', 'current']) { + sendBackgroundMessage({ interceptorApproved: true, type: 'result', method: 'request_signer_to_wallet_switchEthereumChain', result: '0x2', walletSwitchRequestId }) + } + await waitFor(() => complete.length === 2) + complete[1]?.(null) + await waitFor(() => replies.length === 1) + complete[0]?.(null) + await waitFor(() => replies.length === 2) + }) + assert.deepEqual(replies.map(reply => isRecord(reply) ? [reply.walletSwitchRequestId, reply.accept] : undefined), [['current', true], ['expired', true]]) + }) + test('forwards an approved watch-asset dialog action to the selected signer', async () => { const signerRequests: SignerRequest[] = [] let signerReply: unknown diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index 83f84cad3..91811026a 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -1,6 +1,6 @@ import * as assert from 'assert' import { describe, test } from 'bun:test' -import { confirmedSignerOwnership, createDeferredValue, createEthereumWithGetBlockCounter, createPort, installBrowserMock, loadModules, waitForPortMessageCount } from './backgroundEthAccountsTestHarness.js' +import { getWalletSwitchRequestId, confirmedSignerOwnership, createDeferredValue, createEthereumWithGetBlockCounter, createPort, installBrowserMock, loadModules, waitForPortMessageCount } from './backgroundEthAccountsTestHarness.js' import type { RevisionedPopupSimulationRefresh } from '../../app/ts/background/popupSimulationRefresh.js' describe('popup settings changes', () => { @@ -132,7 +132,7 @@ describe('popup settings changes', () => { } finally { const token = getConfirmedSignerStateToken(connections, 1) if (token === undefined) throw new Error('Missing signer token') - resolveSignerChainChange(token, { method: 'popup_signerChangeChainDialog', data: [{ accept: false, chainId: 2n, error: { code: 4001, message: 'Rejected' } }] }) + resolveSignerChainChange(token, { method: 'popup_signerChangeChainDialog', data: [{ accept: false, chainId: 2n, walletSwitchRequestId: getWalletSwitchRequestId(messages), error: { code: 4001, message: 'Rejected' } }] }) await pending } assert.equal(statuses().at(-1)?.operation, undefined) @@ -309,7 +309,7 @@ describe('popup settings changes', () => { assert.deepEqual(await getRpcList(), originalRpcList) await walletSwitchEthereumChainReply(ethereum, tokenPriceService, resetSimulationServices, connections, port, { method: 'wallet_switchEthereumChain_reply', - params: outcome === 'accept' ? [{ accept: true, chainId: '0x2', signerProviderGeneration: 1 }] : [{ accept: false, chainId: '0x2', error: { code: 4001, message: 'Rejected' }, signerProviderGeneration: 1 }], + params: outcome === 'accept' ? [{ accept: true, chainId: '0x2', walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: 1 }] : [{ accept: false, chainId: '0x2', walletSwitchRequestId: getWalletSwitchRequestId(messages), error: { code: 4001, message: 'Rejected' }, signerProviderGeneration: 1 }], }, 'hasAccess', 1n) } const reply = await pending @@ -345,60 +345,67 @@ describe('popup settings changes', () => { const rpc = { ...(await getSettings()).activeRpcNetwork, chainId: 2n, httpsRpc: 'https://timeout.example.test' } const services = createEthereumWithGetBlockCounter({ count: 0 }) const request = (timeoutMs: number) => requestSignerChainChange(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, rpc, 1, timeoutMs) - const pending = request(30) - await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) const token = getConfirmedSignerStateToken(connections, 1) if (token === undefined) throw new Error('Missing signer token') - const reply = { method: 'popup_signerChangeChainDialog', data: [{ accept: false, chainId: 2n, error: { code: 4001, message: 'Rejected' } }] } as const + if (outcome === 'reply') { + const postMessage = port.postMessage + port.postMessage = message => { + postMessage(message) + // Simulate delivery before changeActiveRpc has returned its signer token. + markSignerChainReplyReceived(token, 2n, getWalletSwitchRequestId(messages)) + } + } + const pending = request(30) + await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) + const reply = { method: 'popup_signerChangeChainDialog', data: [{ accept: false, chainId: 2n, walletSwitchRequestId: getWalletSwitchRequestId(messages), error: { code: 4001, message: 'Rejected' } }] } as const if (outcome === 'failure') { const { walletSwitchEthereumChainReply } = await import('../../app/ts/background/providerMessageHandlers.js') const originalSet = browser.storage.local.set try { Object.defineProperty(browser.storage.local, 'set', { configurable: true, value: async () => { throw new Error('Storage write failed') } }) await assert.rejects(walletSwitchEthereumChainReply(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, port, { - method: 'wallet_switchEthereumChain_reply', params: [{ accept: true, chainId: '0x2', signerProviderGeneration: token.signerProviderGeneration }], + method: 'wallet_switchEthereumChain_reply', params: [{ accept: true, chainId: '0x2', walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: token.signerProviderGeneration }], interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, }, 'hasAccess', undefined), /Storage write failed/) } finally { Object.defineProperty(browser.storage.local, 'set', { configurable: true, value: originalSet }) } assert.match((await pending).error?.message ?? '', /updating the selected network failed/) } else if (outcome === 'reply') { // Delivery has begun, but applying the accepted wallet state can involve slower RPC work. - await new Promise(resolve => setTimeout(resolve, 0)) - markSignerChainReplyReceived(token, 2n) await new Promise(resolve => setTimeout(resolve, 60)) resolveSignerChainChange(token, reply) assert.equal((await pending).error?.code, 4001) } else { assert.match((await pending).error?.message ?? '', /did not answer/) - assert.match((await request(30)).error?.message ?? '', /previous network request/) - assert.equal(messages.filter(message => message.method === 'request_signer_to_wallet_switchEthereumChain').length, 1) + const expiredId = getWalletSwitchRequestId(messages) const { walletSwitchEthereumChainReply } = await import('../../app/ts/background/providerMessageHandlers.js') - const beforeLateReply = await getSettings() - await walletSwitchEthereumChainReply(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, port, { - method: 'wallet_switchEthereumChain_reply', params: [{ accept: true, chainId: '0x2', signerProviderGeneration: token.signerProviderGeneration }], - interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, - }, 'hasAccess', undefined) - assert.deepEqual((await getSettings()).activeRpcNetwork, beforeLateReply.activeRpcNetwork) - const retry = request(1000) + const { setChainChangeConfirmationPromise, resolveChainChange } = await loadModules() + const dappRpc = { ...rpc, httpsRpc: 'https://dapp-switch.example.test' } + const uniqueRequestIdentifier = { requestId: 55, requestSocket: socket } + await setChainChangeConfirmationPromise({ + website: { websiteOrigin: 'https://example.test' }, popupOrTabId: { type: 'popup', id: 10 }, simulationMode: false, rpcNetwork: dappRpc, + request: { method: 'wallet_switchEthereumChain', params: [{ chainId: 2n }], interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier }, + }) + let completed = false + const dappSwitch = resolveChainChange(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, { + method: 'popup_changeChainDialog', data: { rpcNetwork: dappRpc, uniqueRequestIdentifier, accept: true }, + }).then(() => { completed = true }) await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 2) - resolveSignerChainChange(token, reply) - assert.equal((await retry).error?.code, 4001) - await request(30) - const tab = connections.get(1) - if (tab === undefined) throw new Error('Missing tab') - tab.signerStateOwner.providerGeneration++ - let newRequestCompleted = false - const newRequest = request(1000).then(result => { newRequestCompleted = true; return result }) - await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 4) - await walletSwitchEthereumChainReply(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, port, { - method: 'wallet_switchEthereumChain_reply', params: [{ accept: true, chainId: '0x2', signerProviderGeneration: token.signerProviderGeneration }], - interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 2, requestSocket: socket }, + const dappId = getWalletSwitchRequestId(messages) + assert.notEqual(dappId, expiredId) + const deliver = (walletSwitchRequestId: string) => walletSwitchEthereumChainReply(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, port, { + method: 'wallet_switchEthereumChain_reply', params: [{ accept: true, chainId: '0x2', walletSwitchRequestId, signerProviderGeneration: token.signerProviderGeneration }], + interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, }, 'hasAccess', undefined) - assert.equal(newRequestCompleted, false) - const newToken = getConfirmedSignerStateToken(connections, 1) - if (newToken === undefined) throw new Error('Missing reconnected signer') - resolveSignerChainChange(newToken, reply) - assert.equal((await newRequest).error?.code, 4001) + const beforeLateReply = (await getSettings()).activeRpcNetwork + await deliver(expiredId) + assert.equal(completed, false) + assert.deepEqual((await getSettings()).activeRpcNetwork, beforeLateReply) + await deliver(dappId) + await dappSwitch + assert.equal((await getSettings()).activeRpcNetwork.httpsRpc, dappRpc.httpsRpc) + assert.equal(messages.find(message => message.method === 'wallet_switchEthereumChain' && message.requestId === 55)?.result, null) + await deliver(expiredId) + assert.equal((await getSettings()).activeRpcNetwork.httpsRpc, dappRpc.httpsRpc) } }) } @@ -428,7 +435,7 @@ describe('popup settings changes', () => { if (token === undefined) throw new Error('Expected signer owner') resolveSignerChainChange(token, { method: 'popup_signerChangeChainDialog', - data: accept ? [{ accept: true, chainId: rpc.chainId }] : [{ accept: false, chainId: rpc.chainId, error: { code: 4001, message: 'User rejected network change' } }], + data: accept ? [{ accept: true, chainId: rpc.chainId, walletSwitchRequestId: getWalletSwitchRequestId(messages) }] : [{ accept: false, chainId: rpc.chainId, walletSwitchRequestId: getWalletSwitchRequestId(messages), error: { code: 4001, message: 'User rejected network change' } }], }) const result = await pending if (accept) assert.equal(result.result, null) diff --git a/test/tests/popupSettingsCoordinator.test.ts b/test/tests/popupSettingsCoordinator.test.ts new file mode 100644 index 000000000..6442800c8 --- /dev/null +++ b/test/tests/popupSettingsCoordinator.test.ts @@ -0,0 +1,28 @@ +import * as assert from 'assert' +import { test } from 'bun:test' +import { createPopupSettingsCoordinator } from '../../app/ts/background/popupSettingsCoordinator.js' +import { acceptPopupSettingsChangeStatus, type PopupSettingsChangeStatus } from '../../app/ts/types/popupSettingsProtocol.js' +import { createDeferredValue } from './backgroundEthAccountsTestHarness.js' + +test('coordinator admits once, orders status despite clock rollback, and recovers after failure', async () => { + const statuses: PopupSettingsChangeStatus['data'][] = [] + let clock = 100 + const coordinator = createPopupSettingsCoordinator(async status => { statuses.push(status) }, () => clock) + const release = createDeferredValue() + const pending = coordinator.run('rpc', async () => { await release.promise; return 'saved' }) + assert.deepEqual(await coordinator.run('wallet', async () => { throw new Error('Busy action must not run') }), { accepted: false }) + await coordinator.publish() + assert.equal(statuses[0]?.operation, 'rpc') + assert.deepEqual(statuses[1], statuses[0]) + clock = 0 + release.resolve(undefined) + assert.deepEqual(await pending, { accepted: true, result: 'saved' }) + const busy = statuses[0] + const idle = statuses.at(-1) + if (busy === undefined || idle === undefined) throw new Error('Missing coordinator status') + assert.ok(idle.revision > busy.revision) + assert.equal(acceptPopupSettingsChangeStatus(idle, busy), idle) + await assert.rejects(coordinator.run('rich', async () => { throw new Error('Storage failed') }), /Storage failed/) + assert.equal(statuses.at(-1)?.operation, undefined) + assert.deepEqual(await coordinator.run('mode', async () => 'saved'), { accepted: true, result: 'saved' }) +}) diff --git a/test/tests/simulationServicesOwner.test.ts b/test/tests/simulationServicesOwner.test.ts new file mode 100644 index 000000000..5674510a4 --- /dev/null +++ b/test/tests/simulationServicesOwner.test.ts @@ -0,0 +1,21 @@ +import * as assert from 'assert' +import { test } from 'bun:test' +import { createSimulationServicesOwner } from '../../app/ts/simulation/serviceLifecycle.js' + +test('the service owner publishes the exact pair returned by every reset', () => { + const rpc = { name: 'Initial', chainId: 1n, httpsRpc: 'https://initial.invalid', currencyName: 'Ether', currencyTicker: 'ETH', primary: true, minimized: false } + const owner = createSimulationServicesOwner(rpc, async () => undefined, async (_ethereum, error) => { throw error }) + const original = owner.getCurrent() + try { + for (const chainId of [2n, 3n]) { + const network = { ...rpc, chainId, httpsRpc: `https://chain${ chainId }.invalid` } + const replacement = owner.reset(network) + assert.equal(owner.getCurrent(), replacement) + assert.notEqual(replacement.ethereum, original.ethereum) + assert.deepEqual(replacement.ethereum.getRpcEntry(), network) + } + // A captured pair remains a snapshot; it cannot mutate the owner's current selection. + assert.deepEqual(original.ethereum.getRpcEntry(), rpc) + assert.notEqual(owner.getCurrent(), original) + } finally { owner.getCurrent().ethereum.cleanup() } +}) From 55b4072bdb140a2f20f34d6ceba6ce5f3ee26e71 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 12:35:35 +0000 Subject: [PATCH 08/31] Extract popup settings controller and publish settings once --- app/ts/background/activeSettings.ts | 3 +- app/ts/components/App.tsx | 71 +-------- .../hooks/useLiveSimulationHomeData.ts | 13 +- .../hooks/usePopupSettingsChanges.ts | 92 ++++++++++++ .../backgroundAccountPermissions.test.ts | 2 + test/tests/popupIconResync.test.ts | 9 +- test/tests/simulationVisualizerOpen.test.tsx | 139 ++++++------------ 7 files changed, 155 insertions(+), 174 deletions(-) create mode 100644 app/ts/components/hooks/usePopupSettingsChanges.ts diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index a2fd88904..8fa67a417 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -117,7 +117,7 @@ async function runActiveSettingsChange( try { if (rpcEndpointChanged && change.rpcNetwork?.httpsRpc !== undefined) activeServices = resetSimulationServices(change.rpcNetwork) if (updatedSettings.simulationMode && rpcChainChanged) await clearSimulationStateFromConfig() - // Publish the committed selection once its provider and stack are ready, before slow access work. + // Publish settings exactly once when committed; access reconciliation later publishes account and icon updates. await sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: updatedSettings, popupRefreshGeneration: bumpPopupRefreshGeneration(), ...(change.addressChangeRequestId === undefined ? {} : { committedAddressChange: { requestId: change.addressChangeRequestId, activeAddress: change.activeAddress } }), @@ -126,7 +126,6 @@ async function runActiveSettingsChange( // Persisted settings still need access reconciliation if provider preparation or publication fails. accessUpdate = await reconcileWebsiteApprovalAccesses(websiteTabConnections, updatedSettings) } - await sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: updatedSettings, popupRefreshGeneration: accessUpdate.popupRefreshGeneration }) await sendPopupMessageToOpenWindows({ method: 'popup_accounts_update' }) if (rpcChainChanged) { sendMessageToApprovedWebsitePorts(websiteTabConnections, { method: 'chainChanged', result: updatedSettings.activeRpcNetwork.chainId }) diff --git a/app/ts/components/App.tsx b/app/ts/components/App.tsx index ac5b7a1af..882e95cc8 100644 --- a/app/ts/components/App.tsx +++ b/app/ts/components/App.tsx @@ -1,17 +1,16 @@ -import { acceptPopupSettingsChangeStatus, getPopupSettingsOperationLabel } from '../types/popupSettingsProtocol.js' +import { usePopupSettingsChanges } from './hooks/usePopupSettingsChanges.js' import { useEffect } from 'preact/hooks' import { Home } from './pages/Home.js' import Hint from './subcomponents/Hint.js' import { getAddress, isAddress } from '../utils/ethereumPrimitives.js' import { PasteCatcher } from './subcomponents/PasteCatcher.js' import { truncateAddr } from '../utils/ethereum.js' -import type { PopupSettingsChangeStatus, Settings } from '../types/interceptor-messages.js' +import type { Settings } from '../types/interceptor-messages.js' import { version, gitCommitSha } from '../version.js' import { sendPopupMessageToBackgroundPage } from '../background/backgroundUtils.js' import type { EthereumBytes32 } from '../types/wire-types.js' import { checksummedAddress } from '../utils/bigint.js' import type { AddressBookEntry } from '../types/addressBookTypes.js' -import type { RpcEntry } from '../types/rpc.js' import { UnexpectedError } from './subcomponents/Error.js' import { addressEditEntry } from './ui-utils.js' import { Signal, useComputed, useSignal } from '@preact/signals' @@ -21,20 +20,12 @@ import { useLiveSimulationHomeData } from './hooks/useLiveSimulationHomeData.js' import { NetworkErrors } from './subcomponents/NetworkErrors.js' import { ProviderErrors } from './subcomponents/ProviderErrors.js' import { PopupModal, type PopupPage } from './PopupModal.js' -import { getSelectableActiveAddresses, includePersistedAddressBookEntry, isActiveAddressSelectionAllowed } from '../utils/activeAddressSelection.js' -import { requestPopupSettingsChange } from './popupSettingsChange.js' -import type { PopupSettingsRequestWithSharedReply } from '../types/popupSettingsRequests.js' -import { requestActiveAddressChange } from './activeAddressChange.js' +import { getSelectableActiveAddresses } from '../utils/activeAddressSelection.js' import { useModeActiveAddress } from './hooks/useModeActiveAddress.js' export { NetworkErrors } from './subcomponents/NetworkErrors.js' export function App() { const appPage = useSignal({ page: 'Unknown' }) - const pendingAddressChangeRequestId = useSignal(undefined) - const isActiveAddressChanging = useSignal(false) - // Local state covers dispatch latency; shared status coordinates other and reopened popups. - const pendingSettingsChange = useSignal(false) - const backgroundSettingsChange = useSignal({ revision: 0, operation: undefined }) const { activeAddresses, walletSelectedAddressBookEntry, @@ -69,14 +60,6 @@ export function App() { answerSimulationDataConsumerOpen: true, requestFreshHomeDataOnMount: true, requestHomeDataOnSimulationStateChange: true, - onAddressSelectionCommitted({ requestId, activeAddress }, settings) { - if (pendingAddressChangeRequestId.value !== requestId) return - if (!settings.simulationMode) displayedSigningAddress.value = activeAddress - isActiveAddressChanging.value = false - }, - onSettingsChangeStatus(status) { - backgroundSettingsChange.value = acceptPopupSettingsChangeStatus(backgroundSettingsChange.value, status) - }, onInitialSettings(settings: Settings) { if (appPage.value.page !== 'Unknown') return if (settings.openedPage.page === 'AddNewAddress' || settings.openedPage.page === 'ModifyAddress') { @@ -87,49 +70,7 @@ export function App() { }, }) const boundaryResetKey = useSignal(0) - const isActiveAddressChangePending = useComputed(() => pendingAddressChangeRequestId.value !== undefined) - const isSettingsChangePending = useComputed(() => isActiveAddressChangePending.value || pendingSettingsChange.value || backgroundSettingsChange.value.operation !== undefined) - - async function setActiveAddressAndInformAboutIt(address: bigint | 'signer', persistedEntry?: AddressBookEntry) { - if (!isSettingsLoaded.value) return - if (isSettingsChangePending.value) throw new Error('A settings change is already in progress. Please wait for it to finish.') - const selectableAddresses = includePersistedAddressBookEntry(activeAddresses.value, persistedEntry) - if (!isActiveAddressSelectionAllowed(address, selectableAddresses, simulationMode.value, rpcNetwork.value?.chainId, tabState.value?.signerAccounts ?? [])) return - const requestId = crypto.randomUUID() - pendingAddressChangeRequestId.value = requestId - isActiveAddressChanging.value = true - try { - await requestActiveAddressChange(address, simulationMode.value, undefined, requestId) - // Recover a missed commit notification from current background state, never from the original selection. - if (isActiveAddressChanging.value) { - await sendPopupMessageToBackgroundPage({ method: 'popup_requestNewHomeData', data: { refreshSignerAccounts: false, includeWebsiteAccessAddressMetadata: true } }) - } - } finally { - pendingAddressChangeRequestId.value = undefined - isActiveAddressChanging.value = false - } - } - - async function changePopupSettings(message: PopupSettingsRequestWithSharedReply) { - if (!isSettingsLoaded.value) return - if (isSettingsChangePending.value) throw new Error('A settings change is already in progress. Please wait for it to finish.') - pendingSettingsChange.value = true - try { - await requestPopupSettingsChange(message) - } finally { - pendingSettingsChange.value = false - } - } - - async function setActiveRpcAndInformAboutIt(entry: RpcEntry) { - await changePopupSettings({ method: 'popup_changeActiveRpc', data: entry }) - } - async function setSimulationMode(enabled: boolean) { - await changePopupSettings({ method: 'popup_enableSimulationMode', data: enabled }) - } - async function setRichState(add: boolean, address: bigint | 'CurrentAddress') { - await changePopupSettings({ method: 'popup_modifyMakeMeRich', data: { add, address } }) - } + const { isActiveAddressChanging, isActiveAddressChangePending, isSettingsChangePending, sharedStatusLabel, setActiveAddressAndInformAboutIt, setActiveRpcAndInformAboutIt, setSimulationMode, setRichState } = usePopupSettingsChanges({ isSettingsLoaded, activeAddresses, simulationMode, rpcNetwork, tabState, displayedSigningAddress }) useEffect(() => { markPerformanceOnce(POPUP_PERFORMANCE_MARKS.homeFirstCommit) @@ -282,8 +223,8 @@ export function App() { - { backgroundSettingsChange.value.operation !== undefined && !pendingSettingsChange.value && !isActiveAddressChangePending.value - ?
{ getPopupSettingsOperationLabel(backgroundSettingsChange.value.operation) }
: <> } + { sharedStatusLabel.value !== undefined + ?
{ sharedStatusLabel.value }
: <> } void onInitialSettings?: (settings: Settings) => void - onAddressSelectionCommitted?: (selection: { requestId: string, activeAddress: bigint | undefined }, settings: Settings) => void } type CachedHomeDataRequest = { @@ -234,9 +232,6 @@ export function useLiveSimulationHomeData(options: LiveSimulationHomeDataOptions const parsed = maybeParsed.value if (parsed.role === 'confirmTransaction') return undefined switch(parsed.method) { - case 'popup_settingsChangeStatus': - options.onSettingsChangeStatus?.(parsed.data) - return undefined case 'popup_homePageBootstrap': updateHomePageBootstrap(parsed) return undefined @@ -249,7 +244,6 @@ export function useLiveSimulationHomeData(options: LiveSimulationHomeDataOptions const previousActiveStackContext = getCurrentActiveStackContext() const updatedActiveStackContext = getActiveStackContext(parsed.data) updateHomePageSettings(parsed.data) - if (parsed.committedAddressChange !== undefined) options.onAddressSelectionCommitted?.(parsed.committedAddressChange, parsed.data) if (rpcChanged || parsed.committedAddressChange !== undefined || previousActiveStackContext === undefined || !activeStackContextsEqual(previousActiveStackContext, updatedActiveStackContext)) { simVisResults.value = PASSTHROUGH_STATE simulationUpdatingState.value = undefined @@ -312,15 +306,14 @@ export function useLiveSimulationHomeData(options: LiveSimulationHomeDataOptions useEffect(() => { void (async () => { - const settingsStatusRequest = options.answerMainPopupOpen ? sendPopupMessageToBackgroundPage({ method: 'popup_requestSettingsChangeStatus' }) : undefined if (options.requestFreshHomeDataOnMount) { const homePageBootstrapRequest = options.answerMainPopupOpen ? sendPopupMessageToBackgroundPage({ method: 'popup_requestHomePageBootstrap' }) : undefined - await Promise.all([settingsStatusRequest, homePageBootstrapRequest, requestFreshHomeData()]) + await Promise.all([homePageBootstrapRequest, requestFreshHomeData()]) return } - await Promise.all([settingsStatusRequest, requestCachedHomeData({ refreshSignerAccounts: false, includeWebsiteAccessAddressMetadata: false })]) + await requestCachedHomeData({ refreshSignerAccounts: false, includeWebsiteAccessAddressMetadata: false }) })() }, []) diff --git a/app/ts/components/hooks/usePopupSettingsChanges.ts b/app/ts/components/hooks/usePopupSettingsChanges.ts new file mode 100644 index 000000000..0d93e48ae --- /dev/null +++ b/app/ts/components/hooks/usePopupSettingsChanges.ts @@ -0,0 +1,92 @@ +import { useEffect } from 'preact/hooks' +import { useComputed, useSignal } from '@preact/signals' +import { MessageToPopup, type PopupSettingsChangeStatus } from '../../types/interceptor-messages.js' +import { acceptPopupSettingsChangeStatus, getPopupSettingsOperationLabel } from '../../types/popupSettingsProtocol.js' +import type { PopupSettingsRequestWithSharedReply } from '../../types/popupSettingsRequests.js' +import type { AddressBookEntry } from '../../types/addressBookTypes.js' +import type { RpcEntry } from '../../types/rpc.js' +import { sendPopupMessageToBackgroundPage } from '../../background/backgroundUtils.js' +import { includePersistedAddressBookEntry, isActiveAddressSelectionAllowed } from '../../utils/activeAddressSelection.js' +import { requestActiveAddressChange } from '../activeAddressChange.js' +import { requestPopupSettingsChange } from '../popupSettingsChange.js' +import type { useLiveSimulationHomeData } from './useLiveSimulationHomeData.js' + +type SettingsChangeHomeData = Pick, 'isSettingsLoaded' | 'activeAddresses' | 'simulationMode' | 'rpcNetwork' | 'tabState' | 'displayedSigningAddress'> + +export function usePopupSettingsChanges({ isSettingsLoaded, activeAddresses, simulationMode, rpcNetwork, tabState, displayedSigningAddress }: SettingsChangeHomeData) { + const pendingAddressChangeRequestId = useSignal(undefined) + const isActiveAddressChanging = useSignal(false) + // Local state covers dispatch latency; shared status coordinates other and reopened popups. + const pendingSettingsChange = useSignal(false) + const backgroundSettingsChange = useSignal({ revision: 0, operation: undefined }) + const isActiveAddressChangePending = useComputed(() => pendingAddressChangeRequestId.value !== undefined) + const sharedStatusLabel = useComputed(() => !pendingSettingsChange.value && !isActiveAddressChangePending.value && backgroundSettingsChange.value.operation !== undefined ? getPopupSettingsOperationLabel(backgroundSettingsChange.value.operation) : undefined) + const isSettingsChangePending = useComputed(() => isActiveAddressChangePending.value || pendingSettingsChange.value || backgroundSettingsChange.value.operation !== undefined) + + async function setActiveAddressAndInformAboutIt(address: bigint | 'signer', persistedEntry?: AddressBookEntry) { + if (!isSettingsLoaded.value) return + if (isSettingsChangePending.value) throw new Error('A settings change is already in progress. Please wait for it to finish.') + const selectableAddresses = includePersistedAddressBookEntry(activeAddresses.value, persistedEntry) + if (!isActiveAddressSelectionAllowed(address, selectableAddresses, simulationMode.value, rpcNetwork.value?.chainId, tabState.value?.signerAccounts ?? [])) return + const requestId = crypto.randomUUID() + pendingAddressChangeRequestId.value = requestId + isActiveAddressChanging.value = true + try { + await requestActiveAddressChange(address, simulationMode.value, undefined, requestId) + // Recover a missed commit notification from current background state, never from the original selection. + if (isActiveAddressChanging.value) { + await sendPopupMessageToBackgroundPage({ method: 'popup_requestNewHomeData', data: { refreshSignerAccounts: false, includeWebsiteAccessAddressMetadata: true } }) + } + } finally { + pendingAddressChangeRequestId.value = undefined + isActiveAddressChanging.value = false + } + } + + async function changePopupSettings(message: PopupSettingsRequestWithSharedReply) { + if (!isSettingsLoaded.value) return + if (isSettingsChangePending.value) throw new Error('A settings change is already in progress. Please wait for it to finish.') + pendingSettingsChange.value = true + try { + await requestPopupSettingsChange(message) + } finally { + pendingSettingsChange.value = false + } + } + + async function setActiveRpcAndInformAboutIt(entry: RpcEntry) { + await changePopupSettings({ method: 'popup_changeActiveRpc', data: entry }) + } + async function setSimulationMode(enabled: boolean) { + await changePopupSettings({ method: 'popup_enableSimulationMode', data: enabled }) + } + async function setRichState(add: boolean, address: bigint | 'CurrentAddress') { + await changePopupSettings({ method: 'popup_modifyMakeMeRich', data: { add, address } }) + } + + useEffect(() => { + let latestSettingsGeneration = 0 + const listener = (message: unknown) => { + const parsed = MessageToPopup.safeParse(message) + if (!parsed.success || parsed.value.role === 'confirmTransaction') return + const update = parsed.value + if (update.method === 'popup_settingsChangeStatus') { + backgroundSettingsChange.value = acceptPopupSettingsChangeStatus(backgroundSettingsChange.value, update.data) + } + if (update.method === 'popup_settingsUpdated' || update.method === 'popup_UpdateHomePage' || update.method === 'popup_homePageBootstrap') { + if (update.popupRefreshGeneration < latestSettingsGeneration) return + latestSettingsGeneration = update.popupRefreshGeneration + } + if (update.method !== 'popup_settingsUpdated' || update.committedAddressChange === undefined) return + const { requestId, activeAddress } = update.committedAddressChange + if (pendingAddressChangeRequestId.value !== requestId) return + if (!update.data.simulationMode) displayedSigningAddress.value = activeAddress + isActiveAddressChanging.value = false + } + browser.runtime.onMessage.addListener(listener) + void sendPopupMessageToBackgroundPage({ method: 'popup_requestSettingsChangeStatus' }) + return () => browser.runtime.onMessage.removeListener(listener) + }, []) + + return { isActiveAddressChanging, isActiveAddressChangePending, isSettingsChangePending, sharedStatusLabel, setActiveAddressAndInformAboutIt, setActiveRpcAndInformAboutIt, setSimulationMode, setRichState } +} diff --git a/test/tests/backgroundAccountPermissions.test.ts b/test/tests/backgroundAccountPermissions.test.ts index ba06687dd..b2a1143d5 100644 --- a/test/tests/backgroundAccountPermissions.test.ts +++ b/test/tests/backgroundAccountPermissions.test.ts @@ -43,6 +43,8 @@ describe('background eth_accounts', () => { await change } assert.equal((await change).ok, true) + const settingsBroadcasts = runtimeMessages.map(message => MessageToPopup.safeParse(message)).filter(parsed => parsed.success && parsed.value.method === 'popup_settingsUpdated') + assert.equal(settingsBroadcasts.length, 1, 'One authoritative settings broadcast must cover the entire transition') }) test('refreshes the cached signing visualization when selecting another Safe on the same chain', async () => { diff --git a/test/tests/popupIconResync.test.ts b/test/tests/popupIconResync.test.ts index c42328b99..920cdf8e4 100644 --- a/test/tests/popupIconResync.test.ts +++ b/test/tests/popupIconResync.test.ts @@ -13,7 +13,10 @@ type RuntimeMessageListener = (message: unknown, sender: unknown, sendResponse: function installBrowserMock(replyToMessage: (message: unknown) => unknown | Promise = () => undefined) { const sentMessages: unknown[] = [] - let messageListener: RuntimeMessageListener | undefined + const messageListeners = new Set() + const messageListener: RuntimeMessageListener = (message, sender, sendResponse) => { + for (const listener of messageListeners) listener(message, sender, sendResponse) + } Object.defineProperty(globalThis, 'browser', { configurable: true, value: { runtime: { @@ -25,9 +28,9 @@ function installBrowserMock(replyToMessage: (message: unknown) => unknown | Prom getManifest: () => ({ manifest_version: 3 }), onMessage: { addListener: (listener: RuntimeMessageListener) => { - messageListener = listener + messageListeners.add(listener) }, - removeListener: () => undefined, + removeListener: (listener: RuntimeMessageListener) => messageListeners.delete(listener), }, onConnect: { addListener: () => undefined, removeListener: () => undefined }, }, diff --git a/test/tests/simulationVisualizerOpen.test.tsx b/test/tests/simulationVisualizerOpen.test.tsx index 7f7e15360..1747fdf82 100644 --- a/test/tests/simulationVisualizerOpen.test.tsx +++ b/test/tests/simulationVisualizerOpen.test.tsx @@ -55,7 +55,14 @@ function installBrowserMock(sendMessageReply?: (message: unknown) => unknown | P writable: true, value: { runtime: { id: 'test-extension' } }, }) - return { listeners, sentMessages } + const dispatchMessage: RuntimeMessageListener = (message, sender, sendResponse) => { + let responsePending: boolean | undefined + for (const listener of listeners) { + if (listener(message, sender, sendResponse) === true) responsePending = true + } + return responsePending + } + return { listeners, sentMessages, dispatchMessage } } function installClipboardMock() { @@ -102,12 +109,11 @@ function MainPopupSimulationStateProbe() { return
{ simVisResults.value.kind }
} -function AddressSelectionProbe({ onCommitted }: { onCommitted: (selection: { requestId: string, activeAddress: bigint | undefined }, settings: Settings) => void }) { +function AddressSelectionProbe() { const { activeSimulationAddress, simVisResults, simulationUpdatingState } = useLiveSimulationHomeData({ answerMainPopupOpen: true, answerSimulationDataConsumerOpen: true, requestFreshHomeDataOnMount: false, - onAddressSelectionCommitted: onCommitted, }) return
{ activeSimulationAddress.value?.toString() }/{ simVisResults.value.kind }/{ simulationUpdatingState.value ?? 'loading' }
} @@ -571,13 +577,13 @@ describe('simulation visualizer open replies', () => { test('stack visualizer hook answers the visualizer-open probe but not the main-popup probe', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener, sentMessages } = installBrowserMock() try { await act(() => { render(h(StackVisualizerHookProbe, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected hook to register a runtime listener') + + assert.equal(sentMessages.some(message => PopupMessage.safeParse(message).success && typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_requestSettingsChangeStatus'), false) const visualizerReply = sendRuntimeMessage(listener, { method: 'popup_isSimulationVisualizerOpen' }) assert.equal(visualizerReply.returned, true) @@ -593,13 +599,11 @@ describe('simulation visualizer open replies', () => { test('stack visualizer hook accepts updates from a different tab id', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() try { await act(() => { render(h(CrossTabStackVisualizerHookProbe, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected hook to register a runtime listener') await act(() => { listener({ role: 'all', ...createHomePageUpdate(10, 1, 'First tab') }, {}, () => undefined) @@ -618,13 +622,11 @@ describe('simulation visualizer open replies', () => { test('main popup hook keeps Safe simulation results without a simulation-mode address', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() try { await act(() => { render(h(MainPopupSimulationStateProbe, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected hook to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createStackHomePageUpdate(12, 1, 'Safe stack')) }, {}, () => undefined) @@ -638,7 +640,7 @@ describe('simulation visualizer open replies', () => { test('stack visualizer page shows rich-only state instead of the empty-state dino', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() const richList = [ createRichListElement(0x1000000000000000000000000000000000000001n, 'Treasury One'), createRichListElement(0x2000000000000000000000000000000000000002n, 'Treasury Two'), @@ -648,8 +650,6 @@ describe('simulation visualizer open replies', () => { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createSerializableRichHomePageUpdate(12, 1, 'Rich tab', 3, richList)) }, {}, () => undefined) @@ -687,7 +687,7 @@ describe('simulation visualizer open replies', () => { test('stack visualizer rich address sentence handles one entry', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() const richList = [ createRichListElement(0x1000000000000000000000000000000000000001n, 'Treasury One'), ] @@ -695,8 +695,6 @@ describe('simulation visualizer open replies', () => { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createSerializableRichHomePageUpdate(12, 1, 'Rich tab', 1, richList)) }, {}, () => undefined) @@ -711,13 +709,11 @@ describe('simulation visualizer open replies', () => { test('stack visualizer page shows stack operations without an active simulation address', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() try { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createSimulationStackHomePageUpdate(13, 1, 'Stack tab')) }, {}, () => undefined) @@ -750,14 +746,12 @@ describe('simulation visualizer open replies', () => { test('stack visualizer uses the signing Safe as the visualized address in signing mode', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() const update = createStackHomePageUpdate(13, 1, 'Safe signing stack', [1n], 1) try { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ @@ -777,14 +771,12 @@ describe('simulation visualizer open replies', () => { test('stack visualizer remains a Gnosis Safe stack when the current tab cannot resolve the Safe owner', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() const update = createStackHomePageUpdate(13, 1, 'Safe signing stack', [1n], 0) try { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ @@ -811,14 +803,12 @@ describe('simulation visualizer open replies', () => { test('stack visualizer keeps the page header first when an unexpected error is visible', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() const update = createStackHomePageUpdate(13, 1, 'Stack tab') try { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ @@ -857,7 +847,7 @@ describe('simulation visualizer open replies', () => { test('stack visualizer page shows rich addresses in simulated stack state', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() const richList = [ createRichListElement(0x3000000000000000000000000000000000000003n, 'Treasury Three'), createRichListElement(0x4000000000000000000000000000000000000004n, 'Treasury Four'), @@ -866,8 +856,6 @@ describe('simulation visualizer open replies', () => { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createStackHomePageUpdate(13, 1, 'Stack tab', [1n], 2, richList)) }, {}, () => undefined) @@ -896,14 +884,12 @@ describe('simulation visualizer open replies', () => { test('stack visualizer refreshes rich metadata after live simulation updates', async () => { const dom = installDomMock() - const { listeners, sentMessages } = installBrowserMock() + const { dispatchMessage: listener, sentMessages } = installBrowserMock() const serializableSettings = createSerializableSettings() try { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createSimulationStackHomePageUpdate(19, 1, 'Stack tab')) }, {}, () => undefined) }) @@ -921,13 +907,11 @@ describe('simulation visualizer open replies', () => { test('stack visualizer failure banner stays readable outside blurred simulation content', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() try { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createFailedStackHomePageUpdate(16, 1, 'Failed stack tab')) }, {}, () => undefined) @@ -949,7 +933,7 @@ describe('simulation visualizer open replies', () => { const dom = installDomMock() const clipboardMock = installClipboardMock() const exportPayload = '{ "name": "Interceptor Simulation Export" }' - const { listeners, sentMessages } = installBrowserMock((message) => { + const { dispatchMessage: listener, sentMessages } = installBrowserMock((message) => { if (typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_requestInterceptorSimulationInput') { return { method: 'popup_requestInterceptorSimulationInput', ok: true, ethSimulateV1InputString: exportPayload } } @@ -959,8 +943,6 @@ describe('simulation visualizer open replies', () => { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createSimulationStackHomePageUpdate(19, 1, 'Stack tab')) }, {}, () => undefined) @@ -984,7 +966,7 @@ describe('simulation visualizer open replies', () => { test('stack visualizer hides a simulation export error after switching to Safe mode', async () => { const dom = installDomMock() const exportError = 'Simulation stack export failed.' - const { listeners } = installBrowserMock((message) => { + const { dispatchMessage: listener } = installBrowserMock((message) => { if (typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_requestInterceptorSimulationInput') { return { method: 'popup_requestInterceptorSimulationInput', ok: false, message: exportError } } @@ -994,8 +976,6 @@ describe('simulation visualizer open replies', () => { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') const simulationUpdate = createSimulationStackHomePageUpdate(26, 1, 'Simulation stack tab') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, simulationUpdate) }, {}, () => undefined) @@ -1025,7 +1005,7 @@ describe('simulation visualizer open replies', () => { const dom = installDomMock() const clipboardMock = installClipboardMock() const safeExportPayload = '{ "name": "Interceptor Safe Stack" }' - const { listeners } = installBrowserMock((message) => { + const { dispatchMessage: listener } = installBrowserMock((message) => { if (typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_requestSafeStackExport') { return { method: 'popup_requestSafeStackExport', ok: true, safeStackJson: safeExportPayload } } @@ -1035,8 +1015,6 @@ describe('simulation visualizer open replies', () => { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createStackHomePageUpdate(24, 1, 'Stack tab')) }, {}, () => undefined) }) @@ -1057,13 +1035,11 @@ describe('simulation visualizer open replies', () => { test('stack visualizer hides simulation import and export in Safe signing mode', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() try { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createStackHomePageUpdate(20, 1, 'Stack tab')) }, {}, () => undefined) @@ -1080,7 +1056,7 @@ describe('simulation visualizer open replies', () => { test('stack visualizer shows the reason when copying Safe transactions is refused', async () => { const dom = installDomMock() const exportError = 'The simulation stack has no Safe proposals to export.' - const { listeners } = installBrowserMock((message) => { + const { dispatchMessage: listener } = installBrowserMock((message) => { if (typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_requestSafeStackExport') { return { method: 'popup_requestSafeStackExport', ok: false, message: exportError } } @@ -1090,8 +1066,6 @@ describe('simulation visualizer open replies', () => { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createStackHomePageUpdate(21, 1, 'Stack tab')) }, {}, () => undefined) @@ -1110,13 +1084,11 @@ describe('simulation visualizer open replies', () => { test('stack visualizer shows Safe actions only when signing with an active Safe', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock(() => undefined) + const { dispatchMessage: listener } = installBrowserMock(() => undefined) try { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') const update = createStackHomePageUpdate(23, 1, 'Stack tab') const activeSafe = update.data.activeAddresses[0] if (activeSafe?.type !== 'safe') throw new Error('Expected a Safe fixture') @@ -1156,13 +1128,11 @@ describe('simulation visualizer open replies', () => { test('stack visualizer switches between mutually exclusive Safe and simulation controls', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() try { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createStackHomePageUpdate(22, 1, 'Stack tab')) }, {}, () => undefined) @@ -1184,11 +1154,9 @@ describe('simulation visualizer open replies', () => { test('popup displays shared pending work and ignores an older busy status after completion', async () => { const dom = installDomMock() - const { listeners, sentMessages } = installBrowserMock() + const { dispatchMessage: listener, sentMessages } = installBrowserMock() try { await act(() => { render(h(App, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createSimulationStackHomePageUpdate(25, 1, 'Popup')) }, {}, () => undefined) }) assert.ok(sentMessages.some(message => PopupMessage.safeParse(message).success && typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_requestSettingsChangeStatus')) const status = async (revision: number, operation: 'rpc' | undefined) => await act(() => { @@ -1212,7 +1180,7 @@ describe('simulation visualizer open replies', () => { let finishChange: (reply: unknown) => void = () => undefined const changeReply = new Promise((resolve) => { finishChange = resolve }) let requestId: string | undefined - const { listeners } = installBrowserMock((message) => { + const { dispatchMessage: listener } = installBrowserMock((message) => { const parsed = PopupMessage.safeParse(message) if (parsed.success && parsed.value.method === 'popup_changeActiveAddress') { requestId = parsed.value.data.addressChangeRequestId @@ -1222,8 +1190,6 @@ describe('simulation visualizer open replies', () => { }) try { await act(() => { render(h(App, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected a runtime listener') const initial = createSimulationStackHomePageUpdate(25, 1, 'Simulation popup') const nextEntry = createRichAddressEntry(2n, 'Next wallet') await act(() => { @@ -1240,6 +1206,10 @@ describe('simulation visualizer open replies', () => { assert.ok(requestId) const addressRow = () => collectElements(dom.document.body, 'div').find((element) => hasClass(element, 'active-address-row')) assert.equal(addressRow()?.getAttribute?.('aria-label'), 'Switching active address') + await act(() => { + listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: initial.data.settings, popupRefreshGeneration: 2, committedAddressChange: { requestId: 'another-popup-request', activeAddress: initial.data.settings.activeSimulationAddress } }), {}, () => undefined) + }) + assert.equal(addressRow()?.getAttribute?.('aria-label'), 'Switching active address') await act(() => { listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: { ...initial.data.settings, activeSimulationAddress: 2n }, popupRefreshGeneration: 3, committedAddressChange: { requestId, activeAddress: 2n } }), {}, () => undefined) }) @@ -1266,15 +1236,12 @@ describe('simulation visualizer open replies', () => { const dom = installDomMock() let finishRefresh: (reply: unknown) => void = () => undefined const refresh = new Promise((resolve) => { finishRefresh = resolve }) - const { listeners } = installBrowserMock((message) => ( + const { dispatchMessage: listener } = installBrowserMock((message) => ( typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_requestCompleteVisualizedSimulation' ? refresh : undefined )) - const confirmations: string[] = [] try { - await act(() => { render(h(AddressSelectionProbe, { onCommitted: ({ requestId }) => { confirmations.push(requestId) } }), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected a runtime listener') + await act(() => { render(h(AddressSelectionProbe, {}), dom.document.body) }) const initial = createSimulationStackHomePageUpdate(25, 1, 'Simulation popup') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, initial) }, {}, () => undefined) }) const settings = { ...initial.data.settings, activeSimulationAddress: 2n } @@ -1282,14 +1249,12 @@ describe('simulation visualizer open replies', () => { listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: settings, popupRefreshGeneration: 3, committedAddressChange: { requestId: 'switch-2', activeAddress: 2n } }), {}, () => undefined) }) assert.equal(dom.document.body.textContent, '2/passthrough/loading') - assert.deepEqual(confirmations, ['switch-2']) await act(() => { listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: initial.data.settings, popupRefreshGeneration: 2, committedAddressChange: { requestId: 'older-switch', activeAddress: initial.data.settings.activeSimulationAddress } }), {}, () => undefined) listener({ role: 'all', ...serialize(UpdateHomePage, initial) }, {}, () => undefined) listener(serialize(MessageToPopup, createSimulationStateChangedMessage(initial.data.visualizedSimulatorState)), {}, () => undefined) }) assert.equal(dom.document.body.textContent, '2/passthrough/loading') - assert.deepEqual(confirmations, ['switch-2']) await act(async () => { finishRefresh({ method: 'popup_requestCompleteVisualizedSimulation', visualizedSimulatorState: serialize(CompleteVisualizedSimulation, createSimulatedCompleteVisualizedSimulation(settings)) }) await refresh @@ -1307,7 +1272,7 @@ describe('simulation visualizer open replies', () => { const dom = installDomMock() let resolveVisualizationRefresh: ((reply: unknown) => void) | undefined const visualizationRefresh = new Promise((resolve) => { resolveVisualizationRefresh = resolve }) - const { listeners } = installBrowserMock((message) => ( + const { dispatchMessage: listener } = installBrowserMock((message) => ( typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_requestCompleteVisualizedSimulation' ? visualizationRefresh : undefined @@ -1316,8 +1281,6 @@ describe('simulation visualizer open replies', () => { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') const safeUpdate = createStackHomePageUpdate(25, 1, 'Safe stack tab') await act(() => { @@ -1396,7 +1359,7 @@ describe('simulation visualizer open replies', () => { const dom = installDomMock() let resolveVisualizationRefresh: ((reply: unknown) => void) | undefined const visualizationRefresh = new Promise((resolve) => { resolveVisualizationRefresh = resolve }) - const { listeners } = installBrowserMock((message) => ( + const { dispatchMessage: listener } = installBrowserMock((message) => ( typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_requestCompleteVisualizedSimulation' ? visualizationRefresh : undefined @@ -1405,8 +1368,6 @@ describe('simulation visualizer open replies', () => { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') const simulationUpdate = createSimulationStackHomePageUpdate(27, 1, 'Simulation stack tab') const safeSettings = createStackHomePageUpdate(27, 2, 'Safe stack tab').data.settings @@ -1452,13 +1413,11 @@ describe('simulation visualizer open replies', () => { test('stack visualizer transaction cards collapse and reopen independently', async () => { const dom = installDomMock() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() try { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createStackHomePageUpdate(18, 1, 'Stack tab', [1n, 2n])) }, {}, () => undefined) @@ -1510,7 +1469,7 @@ describe('simulation visualizer open replies', () => { test('stack visualizer target hash no-ops when the target element cannot scroll', async () => { const dom = installDomMock() const flushAnimationFrames = installQueuedAnimationFrames() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() Object.defineProperty(globalThis.window, 'location', { configurable: true, writable: true, @@ -1524,8 +1483,6 @@ describe('simulation visualizer open replies', () => { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createStackHomePageUpdate(14, 1, 'Stack tab')) }, {}, () => undefined) @@ -1545,7 +1502,7 @@ describe('simulation visualizer open replies', () => { test('stack visualizer target hash no-ops when target lookup is unavailable', async () => { const dom = installDomMock() const flushAnimationFrames = installQueuedAnimationFrames() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() Object.defineProperty(globalThis.window, 'location', { configurable: true, writable: true, @@ -1559,8 +1516,6 @@ describe('simulation visualizer open replies', () => { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createStackHomePageUpdate(16, 1, 'Stack tab')) }, {}, () => undefined) @@ -1580,7 +1535,7 @@ describe('simulation visualizer open replies', () => { test('stack visualizer target hash scrolls to and highlights the matching row', async () => { const dom = installDomMock() const flushAnimationFrames = installQueuedAnimationFrames() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() const scrollCalls: ScrollIntoViewOptions[] = [] Object.defineProperty(globalThis.window, 'location', { configurable: true, @@ -1602,8 +1557,6 @@ describe('simulation visualizer open replies', () => { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, createStackHomePageUpdate(15, 1, 'Stack tab')) }, {}, () => undefined) @@ -1631,7 +1584,7 @@ describe('simulation visualizer open replies', () => { test('stack visualizer target hash does not replay after same-hash updates', async () => { const dom = installDomMock() const flushAnimationFrames = installQueuedAnimationFrames() - const { listeners } = installBrowserMock() + const { dispatchMessage: listener } = installBrowserMock() const scrollCalls: ScrollIntoViewOptions[] = [] Object.defineProperty(globalThis.window, 'location', { configurable: true, @@ -1653,8 +1606,6 @@ describe('simulation visualizer open replies', () => { await act(() => { render(h(SimulationStackPage, {}), dom.document.body) }) - const listener = listeners[0] - if (listener === undefined) throw new Error('Expected page to register a runtime listener') await act(() => { flushAnimationFrames() From 55e1a03e1d945f294babdf0dd1dae7f6ecb38db2 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 13:06:03 +0000 Subject: [PATCH 09/31] Centralize RPC change classification and clarify failure benchmark --- app/ts/background/activeSettings.ts | 12 ++++----- app/ts/background/popupMessageHandlers.ts | 5 ++-- app/ts/background/providerMessageHandlers.ts | 24 ++++++++++-------- .../hooks/useLiveSimulationHomeData.ts | 4 +-- app/ts/types/rpc.ts | 10 ++++++++ test/benchmarks/popupSwitchingChrome.ts | 6 ++++- test/tests/popupSettingsChanges.test.ts | 15 +++++++++-- test/tests/rpcNetworkChange.test.ts | 25 +++++++++++++++++++ 8 files changed, 77 insertions(+), 24 deletions(-) create mode 100644 test/tests/rpcNetworkChange.test.ts diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index 8fa67a417..d19e752f2 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -3,7 +3,7 @@ import type { EthereumClientService } from '../simulation/services/EthereumClien import type { ResetSimulationServices, SimulationServices } from '../simulation/serviceLifecycle.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' import type { SigningAddressPreference } from '../types/signerTypes.js' -import { RpcNetwork } from '../types/rpc.js' +import { getRpcNetworkChange, type RpcNetwork } from '../types/rpc.js' import type { WebsiteTabConnections } from '../types/user-interface-types.js' import { Semaphore } from '../utils/semaphore.js' import type { WebsiteAccessUpdate } from './accessManagement.js' @@ -112,8 +112,7 @@ async function runActiveSettingsChange( } const updatedSettings = await getSettings() - const rpcChainChanged = previousSettings.activeRpcNetwork.chainId !== updatedSettings.activeRpcNetwork.chainId - const rpcEndpointChanged = rpcChainChanged || previousSettings.activeRpcNetwork.httpsRpc !== updatedSettings.activeRpcNetwork.httpsRpc + const { chainChanged: rpcChainChanged, endpointChanged: rpcEndpointChanged } = getRpcNetworkChange(previousSettings.activeRpcNetwork, updatedSettings.activeRpcNetwork) try { if (rpcEndpointChanged && change.rpcNetwork?.httpsRpc !== undefined) activeServices = resetSimulationServices(change.rpcNetwork) if (updatedSettings.simulationMode && rpcChainChanged) await clearSimulationStateFromConfig() @@ -197,15 +196,16 @@ export async function activateAddressSelection( export async function changeActiveRpc(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, simulationMode: boolean, signerTabId: number | undefined, walletSwitchRequestId: string = crypto.randomUUID()) { const currentRpc = (await getSettings()).activeRpcNetwork - // Metadata edits at the same endpoint still need to update the active selection. - if (JSON.stringify(RpcNetwork.serialize(currentRpc)) === JSON.stringify(RpcNetwork.serialize(rpcNetwork))) { + const { chainChanged, selectionChanged } = getRpcNetworkChange(currentRpc, rpcNetwork) + if (!selectionChanged) { return simulationMode ? { type: 'completedLocally' as const } : { type: 'signerRequestNotNeeded' as const } } if (simulationMode) { await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { simulationMode, rpcNetwork }) return { type: 'completedLocally' as const } } - if (rpcNetwork.chainId === (await getSettings()).activeRpcNetwork.chainId) { + // Same-chain endpoint and metadata edits are local, even when a signer is connected. + if (!chainChanged) { await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { simulationMode, rpcNetwork }) return { type: 'signerRequestNotNeeded' as const } } diff --git a/app/ts/background/popupMessageHandlers.ts b/app/ts/background/popupMessageHandlers.ts index 550d69e40..3f9ac54b9 100644 --- a/app/ts/background/popupMessageHandlers.ts +++ b/app/ts/background/popupMessageHandlers.ts @@ -1,3 +1,4 @@ +import { getRpcNetworkChange } from '../types/rpc.js' import { refreshPopupSimulation } from './popupSimulationRefresh.js' import { refreshConfirmTransactionSimulation } from './confirmTransactionSimulation.js' import { activateAddressSelection, changeActiveAddressAndChain, changeActiveRpc } from './activeSettings.js' @@ -667,14 +668,14 @@ export async function refreshPopupConfirmTransactionSimulation(ethereum: Ethereu } export async function popupChangeActiveRpc(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, params: ChangeActiveChain, settings: Settings) { - if (!settings.simulationMode && params.data.chainId !== settings.activeRpcNetwork.chainId) { + if (!settings.simulationMode && getRpcNetworkChange(settings.activeRpcNetwork, params.data).chainChanged) { const tabId = await getLastKnownCurrentTabId() if (tabId === undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: 'No wallet is connected to switch networks.' } as const if (await getConfiguredSigningSafe(settings, (await getTabState(tabId)).signerAccounts) !== undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: 'This Safe is tied to its current network. Select your wallet account before switching networks.' } as const const result = await requestSignerChainChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, params.data, tabId) if ('error' in result && result.error !== undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: result.error.message } as const const activeRpc = (await getSettings()).activeRpcNetwork - if (activeRpc.chainId !== params.data.chainId || activeRpc.httpsRpc !== params.data.httpsRpc) return { type: 'PopupSettingsChangeReply', ok: false, message: 'The wallet switched networks, but the active Interceptor network did not change. Please select the network again.' } as const + if (getRpcNetworkChange(activeRpc, params.data).endpointChanged) return { type: 'PopupSettingsChangeReply', ok: false, message: 'The wallet switched networks, but the active Interceptor network did not change. Please select the network again.' } as const } else { await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, params.data, settings.simulationMode, await getLastKnownCurrentTabId()) } diff --git a/app/ts/background/providerMessageHandlers.ts b/app/ts/background/providerMessageHandlers.ts index 93bd7cbf0..fad9fcad9 100644 --- a/app/ts/background/providerMessageHandlers.ts +++ b/app/ts/background/providerMessageHandlers.ts @@ -1,4 +1,4 @@ -import type { RpcNetwork } from '../types/rpc.js' +import { getRpcNetworkChange, type RpcNetwork } from '../types/rpc.js' import { ConnectedToSigner, SignerReply, WalletSwitchEthereumChainReply, WatchAssetSignerRequest } from '../types/interceptor-messages.js' import type { TabState, WebsiteTabConnections } from '../types/user-interface-types.js' import { EthereumAccountsReply, EthereumChainReply } from '../types/JsonRpc-types.js' @@ -143,16 +143,18 @@ async function changeSignerChain(ethereum: EthereumClientService, tokenPriceServ } return } - if ((settings.useSignersAddressAsActiveAddress || !settings.simulationMode) && (settings.activeRpcNetwork.chainId !== signerChain || (requestedRpcNetwork !== undefined && settings.activeRpcNetwork.httpsRpc !== requestedRpcNetwork.httpsRpc))) { - const rpcNetwork = requestedRpcNetwork ?? await getRpcNetworkForChain(signerChain) - const signerAddress = getWalletSelectedAccount(tabStateChange.newState) - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { - simulationMode: settings.simulationMode, - rpcNetwork, - activeAddress: signerAddress, - ...(!settings.simulationMode ? { signingAddressSelection: 'signer' as const } : {}), - }) - return + if (settings.useSignersAddressAsActiveAddress || !settings.simulationMode) { + const rpcNetwork = requestedRpcNetwork ?? (settings.activeRpcNetwork.chainId === signerChain ? settings.activeRpcNetwork : await getRpcNetworkForChain(signerChain)) + if (getRpcNetworkChange(settings.activeRpcNetwork, rpcNetwork).endpointChanged) { + const signerAddress = getWalletSelectedAccount(tabStateChange.newState) + await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + simulationMode: settings.simulationMode, + rpcNetwork, + activeAddress: signerAddress, + ...(!settings.simulationMode ? { signingAddressSelection: 'signer' as const } : {}), + }) + return + } } if (oldSignerChain !== signerChain) sendPopupMessageToOpenWindows({ method: 'popup_chain_update' }) } diff --git a/app/ts/components/hooks/useLiveSimulationHomeData.ts b/app/ts/components/hooks/useLiveSimulationHomeData.ts index c522fde8a..d4236483d 100644 --- a/app/ts/components/hooks/useLiveSimulationHomeData.ts +++ b/app/ts/components/hooks/useLiveSimulationHomeData.ts @@ -3,7 +3,7 @@ import { MessageToPopup, type HomePageBootstrap, type UpdateHomePage, type Setti import type { RpcConnectionStatus, TabIconDetails, TabState } from '../../types/user-interface-types.js' import { PASSTHROUGH_STATE, type BlockTimeManipulation, type CompleteVisualizedSimulation, type NamedTokenId, type ResolvedSimulationResults, type ResolvedSimulationState, type SimulationResultState, type SimulationUpdatingState, type TokenPriceEstimate, type VisualizedSimulationState, toResolvedSimulationResults } from '../../types/visualizer-types.js' import type { AddressBookEntries, AddressBookEntry } from '../../types/addressBookTypes.js' -import type { RpcEntries, RpcNetwork } from '../../types/rpc.js' +import { getRpcNetworkChange, type RpcEntries, type RpcNetwork } from '../../types/rpc.js' import type { WebsiteAccessArray } from '../../types/websiteAccessTypes.js' import type { EnrichedRichListElement, UnexpectedErrorOccured } from '../../types/interceptor-reply-messages.js' import { PopupMessageReplyRequests } from '../../types/interceptor-reply-messages.js' @@ -240,7 +240,7 @@ export function useLiveSimulationHomeData(options: LiveSimulationHomeDataOptions return undefined case 'popup_settingsUpdated': { if (shouldIgnoreOutdatedPopupRefreshMessage(parsed.popupRefreshGeneration, Math.max(popupRefreshGeneration.value, pendingPopupRefreshGeneration.value))) return undefined - const rpcChanged = rpcNetwork.value?.chainId !== parsed.data.activeRpcNetwork.chainId || rpcNetwork.value?.httpsRpc !== parsed.data.activeRpcNetwork.httpsRpc + const rpcChanged = getRpcNetworkChange(rpcNetwork.value, parsed.data.activeRpcNetwork).endpointChanged const previousActiveStackContext = getCurrentActiveStackContext() const updatedActiveStackContext = getActiveStackContext(parsed.data) updateHomePageSettings(parsed.data) diff --git a/app/ts/types/rpc.ts b/app/ts/types/rpc.ts index 87de0fb09..239c14db8 100644 --- a/app/ts/types/rpc.ts +++ b/app/ts/types/rpc.ts @@ -49,3 +49,13 @@ export const RpcNetwork = funtypes.Union( minimized: funtypes.Literal(true), }) ) + +// Chain changes require wallet approval; endpoint changes replace services; metadata changes only update the selection. +export function getRpcNetworkChange(previous: RpcNetwork | undefined, next: RpcNetwork) { + const chainChanged = previous?.chainId !== next.chainId + return { + chainChanged, + endpointChanged: chainChanged || previous?.httpsRpc !== next.httpsRpc, + selectionChanged: previous === undefined || JSON.stringify(RpcNetwork.serialize(previous)) !== JSON.stringify(RpcNetwork.serialize(next)), + } +} diff --git a/test/benchmarks/popupSwitchingChrome.ts b/test/benchmarks/popupSwitchingChrome.ts index 23b2433b5..75119f041 100644 --- a/test/benchmarks/popupSwitchingChrome.ts +++ b/test/benchmarks/popupSwitchingChrome.ts @@ -253,9 +253,13 @@ async function runIteration() { const failuresBefore = injectedFailures failSimulation = true try { - samples.push(await measure(popup, 'stacked rich off with RPC failure', 'popup_modifyMakeMeRich', `document.querySelector('input[type="checkbox"]').click()`, `document.body.textContent.includes('Updating balances...')`, `document.querySelector('input[type="checkbox"]')?.checked === false`)) + // A handled simulation error is rendered successfully: the setting is saved and the command replies ok, unlike a failed visualization refresh. + samples.push(await measure(popup, 'stacked rich off with RPC failure', 'popup_modifyMakeMeRich', `document.querySelector('input[type="checkbox"]').click()`, `document.body.textContent.includes('Updating balances...')`, `document.querySelector('input[type="checkbox"]')?.checked === false`, true)) if (injectedFailures === failuresBefore) throw new Error('RPC failure scenario did not exercise the fixture') await waitFor(popup, `document.body.textContent.includes('Benchmark RPC simulation failure')`, 'visible RPC simulation failure') + const failureState = await popup.evaluate<{ visualizedSimulatorState: { simulationUpdatingState: string, simulationResultState: string, simulationState: { kind: string, value?: { success: boolean } } } }>(`browser.runtime.sendMessage({ method: 'popup_requestCompleteVisualizedSimulation' })`) + const visualized = failureState.visualizedSimulatorState + if (visualized.simulationUpdatingState !== 'done' || visualized.simulationResultState !== 'done' || visualized.simulationState.kind !== 'simulated' || visualized.simulationState.value?.success !== false) throw new Error('Expected a completed visualization of the simulation error') } finally { failSimulation = false } await popup.evaluate(`browser.runtime.sendMessage({ method: 'popup_refreshSimulation' })`) await waitFor(popup, `!document.body.textContent.includes('Benchmark RPC simulation failure')`, 'RPC recovery') diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index 91811026a..0999dbd03 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -166,16 +166,27 @@ describe('popup settings changes', () => { for (const simulationMode of [true, false]) test(`saves active RPC metadata without resetting services in ${ simulationMode ? 'simulation' : 'signing' } mode`, async () => { installBrowserMock() - const { changeSimulationMode, getSettings } = await loadModules() + const { changeSimulationMode, getSettings, saveCurrentTabId, websiteSocketToString } = await loadModules() const { changeActiveRpc } = await import('../../app/ts/background/activeSettings.js') + const { popupChangeActiveRpc } = await import('../../app/ts/background/popupMessageHandlers.js') + await saveCurrentTabId(1) + const socket = { tabId: 1, connectionName: 0n } + const { port, messages } = createPort(1) + const connections = new Map([[1, { ...confirmedSignerOwnership(socket), connections: { + [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'https://example.test', approved: true, wantsToConnect: true }, + } }]]) await changeSimulationMode({ simulationMode }) const currentRpc = (await getSettings()).activeRpcNetwork if (currentRpc.httpsRpc === undefined) throw new Error('Expected a configured RPC') const editedRpc = { ...currentRpc, name: 'Renamed network', currencyName: 'Updated currency', currencyTicker: 'NEW', currencyLogoUri: 'updated.svg', blockExplorer: { apiUrl: 'https://explorer.example/api', apiKey: 'updated-key' }, primary: !currentRpc.primary, minimized: !currentRpc.minimized } const { ethereum, tokenPriceService } = createEthereumWithGetBlockCounter({ count: 0 }) const reset = () => { throw new Error('Metadata edits should not reset services') } - assert.deepEqual(await changeActiveRpc(ethereum, tokenPriceService, reset, new Map(), editedRpc, simulationMode, undefined), { type: simulationMode ? 'completedLocally' : 'signerRequestNotNeeded' }) + assert.deepEqual(await changeActiveRpc(ethereum, tokenPriceService, reset, connections, editedRpc, simulationMode, 1), { type: simulationMode ? 'completedLocally' : 'signerRequestNotNeeded' }) assert.deepEqual((await getSettings()).activeRpcNetwork, editedRpc) + const popupEdit = { ...editedRpc, name: 'Renamed through popup' } + assert.deepEqual(await popupChangeActiveRpc(ethereum, tokenPriceService, reset, connections, { method: 'popup_changeActiveRpc', data: popupEdit }, await getSettings()), { type: 'PopupSettingsChangeReply', ok: true }) + assert.deepEqual((await getSettings()).activeRpcNetwork, popupEdit) + assert.equal(messages.some(message => message.method === 'request_signer_to_wallet_switchEthereumChain'), false, 'Metadata edits must not ask a connected wallet to switch chains') }) test('activation returns the installed services and preserves them when the endpoint is unchanged', async () => { diff --git a/test/tests/rpcNetworkChange.test.ts b/test/tests/rpcNetworkChange.test.ts new file mode 100644 index 000000000..aec9985c8 --- /dev/null +++ b/test/tests/rpcNetworkChange.test.ts @@ -0,0 +1,25 @@ +import { describe, test } from 'bun:test' +import * as assert from 'assert' +import { getRpcNetworkChange, type RpcNetwork } from '../../app/ts/types/rpc.js' + +const network: RpcNetwork = { chainId: 1n, httpsRpc: 'https://rpc.example', name: 'Network', currencyName: 'Ether', currencyTicker: 'ETH', primary: true, minimized: false } + +describe('RPC network change classification', () => { + test('unchanged values do not depend on object identity or property order', () => { + assert.deepEqual(getRpcNetworkChange(network, { minimized: false, primary: true, currencyTicker: 'ETH', currencyName: 'Ether', name: 'Network', httpsRpc: 'https://rpc.example', chainId: 1n }), { chainChanged: false, endpointChanged: false, selectionChanged: false }) + }) + test('metadata only changes the persisted selection', () => { + assert.deepEqual(getRpcNetworkChange(network, { ...network, name: 'Renamed', primary: false, minimized: true, currencyName: 'New currency', currencyTicker: 'NEW', blockExplorer: { apiUrl: 'https://explorer.example', apiKey: 'key' } }), { chainChanged: false, endpointChanged: false, selectionChanged: true }) + }) + test('a same-chain endpoint change replaces services without changing wallet chains', () => { + assert.deepEqual(getRpcNetworkChange(network, { ...network, httpsRpc: 'https://other.example' }), { chainChanged: false, endpointChanged: true, selectionChanged: true }) + }) + test('a chain change also replaces services even if the URL stays the same', () => { + assert.deepEqual(getRpcNetworkChange(network, { ...network, chainId: 2n }), { chainChanged: true, endpointChanged: true, selectionChanged: true }) + }) + test('signer-only and missing networks are distinct from a configured endpoint', () => { + const signerOnly: RpcNetwork = { chainId: 1n, httpsRpc: undefined, name: 'Signer', currencyName: 'Ether?', currencyTicker: 'ETH?', primary: false, minimized: true } + assert.deepEqual(getRpcNetworkChange(signerOnly, network), { chainChanged: false, endpointChanged: true, selectionChanged: true }) + assert.deepEqual(getRpcNetworkChange(undefined, network), { chainChanged: true, endpointChanged: true, selectionChanged: true }) + }) +}) From caa87fe3b422b328efb568af99043fdd38fbee8c Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 13:29:31 +0000 Subject: [PATCH 10/31] Encapsulate wallet switch replies and stop returning service snapshots --- app/ts/background/activeSettings.ts | 9 ++- app/ts/background/providerMessageHandlers.ts | 50 ++----------- app/ts/background/windows/changeChain.ts | 76 ++++++++++++++++---- test/tests/popupSettingsChanges.test.ts | 34 +++++---- 4 files changed, 90 insertions(+), 79 deletions(-) diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index d19e752f2..142631d62 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -79,10 +79,10 @@ async function runActiveSettingsChange( resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, transition: ActiveSettingsTransition, -): Promise { +): Promise { const { change } = transition let accessUpdate: WebsiteAccessUpdate | undefined - // This is the transition snapshot, not a second registry of the currently installed services. + // Use the installed pair for work within this transition; nested access prompts may install another pair before completion. let activeServices: SimulationServices = { ethereum, tokenPriceService } try { // Settings, approvals, resets, notifications and selection preferences form one ordered transition. @@ -142,7 +142,6 @@ async function runActiveSettingsChange( await finishWebsiteAccessUpdate(activeServices.ethereum, activeServices.tokenPriceService, resetSimulationServices, websiteTabConnections, accessUpdate, change.promptForAccessesIfNeeded ?? true) } } - return activeServices } export async function changeActiveAddressAndChain( @@ -151,7 +150,7 @@ export async function changeActiveAddressAndChain( resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, change: ActiveAddressAndChainChange, -): Promise { +): Promise { return await runActiveSettingsChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { change }) } @@ -168,7 +167,7 @@ export async function activateAddressSelection( readonly promptForAccessesIfNeeded?: boolean readonly addressChangeRequestId?: string }, -): Promise { +): Promise { const selectedSafe = selection?.type === 'addressBookEntry' && selection.entry.type === 'safe' ? selection.entry : undefined if (!options.simulationMode && selection?.type === 'addressBookEntry' && selectedSafe === undefined) throw new Error('Signing mode can only activate the external signer or an owned Gnosis Safe.') const useSignerAddress = selection?.type === 'signer' || (!options.simulationMode && selection === undefined) diff --git a/app/ts/background/providerMessageHandlers.ts b/app/ts/background/providerMessageHandlers.ts index fad9fcad9..1bc6e266e 100644 --- a/app/ts/background/providerMessageHandlers.ts +++ b/app/ts/background/providerMessageHandlers.ts @@ -4,12 +4,12 @@ import type { TabState, WebsiteTabConnections } from '../types/user-interface-ty import { EthereumAccountsReply, EthereumChainReply } from '../types/JsonRpc-types.js' import { activateAddressSelection, changeActiveAddressAndChain } from './activeSettings.js' import { getSocketFromPort, sendInternalWindowMessage, sendPopupMessageToOpenWindows } from './backgroundUtils.js' -import { getRpcNetworkForChain, promoteRpcAsPrimary, setDefaultSignerName, updatePendingTransactionOrMessage, updateTabState } from './storageVariables.js' +import { getRpcNetworkForChain, setDefaultSignerName, updatePendingTransactionOrMessage, updateTabState } from './storageVariables.js' import { getMetamaskCompatibilityMode, getSettings } from './settings.js' -import { isPendingWalletSwitchRequest, markSignerChainReplyReceived, getPendingSignerChainChangeRpc, getPendingSignerChainChangeTokenForCallback, isPendingSignerChainChangeReply, resolveSignerChainChange } from './windows/changeChain.js' +import { applyWalletSwitchReply } from './windows/changeChain.js' import { type ApprovalState, withSuppressedUnscopedConnectionEventsForSocketAsync } from './accessManagement.js' import type { ProviderMessage } from '../utils/requests.js' -import { JSON_RPC_ERROR_CODE_INTERNAL_ERROR, METAMASK_ERROR_USER_REJECTED_REQUEST } from '../utils/constants.js' +import { METAMASK_ERROR_USER_REJECTED_REQUEST } from '../utils/constants.js' import { reportUnexpectedError } from '../utils/errors.js' import { refreshPendingSafeSignerSelectionErrors, resolvePendingTransactionOrMessage, updateConfirmTransactionView } from './windows/confirmTransaction.js' import { resolveWatchAssetSignerReply } from './windows/watchAsset.js' @@ -177,48 +177,10 @@ export async function signerChainChanged(ethereum: EthereumClientService, tokenP export async function walletSwitchEthereumChainReply(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, _approval: ApprovalState, _activeAddress: bigint | undefined) { const returnValue = { type: 'result' as const, method: 'wallet_switchEthereumChain_reply' as const, result: '0x' as const } const params = WalletSwitchEthereumChainReply.parse(request).params[0] - const socket = getSocketFromPort(port) - if (socket === undefined) return returnValue - return await runSignerStateOperation(websiteTabConnections, socket.tabId, async () => { - const currentSignerStateToken = getConfirmedSignerStateToken(websiteTabConnections, socket.tabId) - if (currentSignerStateToken?.socket.connectionName !== socket.connectionName || currentSignerStateToken.port !== port) return returnValue - if (!isPendingWalletSwitchRequest(params.walletSwitchRequestId)) return returnValue - const pendingSignerStateToken = getPendingSignerChainChangeTokenForCallback(port, params.signerProviderGeneration, params.chainId) - const callbackSignerStateToken = pendingSignerStateToken - ?? (currentSignerStateToken.signerProviderGeneration === params.signerProviderGeneration ? currentSignerStateToken : undefined) - if (callbackSignerStateToken === undefined) return returnValue - const solicitedReply = isPendingSignerChainChangeReply(callbackSignerStateToken, params.chainId) - // Only this command's owner and chain may apply its reply. Unsolicited chain events use signerChainChanged. - if (!solicitedReply) return returnValue - if (currentSignerStateToken.signerProviderGeneration !== params.signerProviderGeneration) { - resolveSignerChainChange(callbackSignerStateToken, { - method: 'popup_signerChangeChainDialog', - data: [{ accept: false, chainId: params.chainId, walletSwitchRequestId: params.walletSwitchRequestId, error: signerConnectionReplacedError, signerProviderGeneration: params.signerProviderGeneration }], - }) - return returnValue - } - markSignerChainReplyReceived(callbackSignerStateToken, params.chainId, params.walletSwitchRequestId) - try { - if (params.accept) { - const requestedRpc = getPendingSignerChainChangeRpc(callbackSignerStateToken, params.chainId) - await changeSignerChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, currentSignerStateToken, params.chainId, 'hasAccess', requestedRpc) - const activeRpc = (await getSettings()).activeRpcNetwork - if (requestedRpc !== undefined && activeRpc.chainId === requestedRpc.chainId && activeRpc.httpsRpc === requestedRpc.httpsRpc) await promoteRpcAsPrimary(requestedRpc) - } - resolveSignerChainChange(callbackSignerStateToken, { - method: 'popup_signerChangeChainDialog', - data: [params], - }) - } catch (error) { - // Delivery ended the wallet deadline; a failure while applying the reply must also release the waiting popup. - resolveSignerChainChange(callbackSignerStateToken, { - method: 'popup_signerChangeChainDialog', - data: [{ accept: false, chainId: params.chainId, walletSwitchRequestId: params.walletSwitchRequestId, signerProviderGeneration: params.signerProviderGeneration, error: { code: JSON_RPC_ERROR_CODE_INTERNAL_ERROR, message: 'The wallet replied, but updating the selected network failed. Refresh the popup and try again.' } }], - }) - throw error - } - return returnValue + await applyWalletSwitchReply(websiteTabConnections, port, params, async (token, chainId, rpc) => { + await changeSignerChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, token, chainId, 'hasAccess', rpc) }) + return returnValue } export async function connectedToSigner(_ethereum: EthereumClientService, _tokenPriceService: TokenPriceService, _resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, _activeAddress: bigint | undefined) { diff --git a/app/ts/background/windows/changeChain.ts b/app/ts/background/windows/changeChain.ts index 8069557f5..810f02560 100644 --- a/app/ts/background/windows/changeChain.ts +++ b/app/ts/background/windows/changeChain.ts @@ -1,11 +1,12 @@ -import { METAMASK_ERROR_USER_REJECTED_REQUEST } from '../../utils/constants.js' +import { getSettings } from '../settings.js' +import { JSON_RPC_ERROR_CODE_INTERNAL_ERROR, METAMASK_ERROR_USER_REJECTED_REQUEST } from '../../utils/constants.js' import { Future } from '../../utils/future.js' -import type { ChainChangeConfirmation, SignerChainChangeConfirmation } from '../../types/interceptor-messages.js' +import type { ChainChangeConfirmation, SignerChainChangeConfirmation, WalletSwitchEthereumChainReply } from '../../types/interceptor-messages.js' import type { WebsiteTabConnections } from '../../types/user-interface-types.js' import { changeActiveRpc } from '../activeSettings.js' -import { getHtmlFile, sendPopupMessageToOpenWindows } from '../backgroundUtils.js' -import { getChainChangeConfirmationPromise, getRpcNetworkForChain, setChainChangeConfirmationPromise } from '../storageVariables.js' -import type { RpcNetwork } from '../../types/rpc.js' +import { getHtmlFile, getSocketFromPort, sendPopupMessageToOpenWindows } from '../backgroundUtils.js' +import { getChainChangeConfirmationPromise, getRpcNetworkForChain, promoteRpcAsPrimary, setChainChangeConfirmationPromise } from '../storageVariables.js' +import { getRpcNetworkChange, type RpcNetwork } from '../../types/rpc.js' import { type InterceptedRequest, type UniqueRequestIdentifier, doesUniqueRequestIdentifiersMatch } from '../../utils/requests.js' import { replyToInterceptedRequest } from '../messageSending.js' import type { SwitchEthereumChainParams } from '../../types/JsonRpc-types.js' @@ -14,7 +15,7 @@ import type { EthereumClientService } from '../../simulation/services/EthereumCl import type { TokenPriceService } from '../../simulation/services/priceEstimator.js' import type { ResetSimulationServices } from '../../simulation/serviceLifecycle.js' import { type PopupOrTab, addWindowTabListeners, closePopupOrTabById, getPopupOrTabById, openPopupOrTab, removeWindowTabListeners } from '../../utils/popupOrTab.js' -import { addSignerStateReplacementListener, doSignerStateTokensMatch, signerUnavailableError, type SignerStateToken } from '../signerStateOwnership.js' +import { getConfirmedSignerStateToken, runSignerStateOperation, signerConnectionReplacedError, addSignerStateReplacementListener, doSignerStateTokensMatch, signerUnavailableError, type SignerStateToken } from '../signerStateOwnership.js' let pendForUserReply: Future | undefined @@ -38,11 +39,11 @@ let pendingSignerChainChange: PendingSignerChainChange | undefined const WALLET_SWITCH_TIMEOUT_MS = 120_000 // Command IDs isolate replies across popup/dapp requests, including retries after a deadline. -export function isPendingWalletSwitchRequest(walletSwitchRequestId: string) { +function isPendingWalletSwitchRequest(walletSwitchRequestId: string) { return pendingSignerChainChange?.walletSwitchRequestId === walletSwitchRequestId } -export function markSignerChainReplyReceived(token: SignerStateToken, chainId: bigint, walletSwitchRequestId: string) { +function markSignerChainReplyReceived(token: SignerStateToken, chainId: bigint, walletSwitchRequestId: string) { const pending = pendingSignerChainChange if (pending !== undefined && pending.walletSwitchRequestId === walletSwitchRequestId && doesPendingSignerChainChangeMatch(pending, token, chainId)) { pending.replyReceived = true @@ -96,24 +97,24 @@ function doesPendingSignerChainChangeMatch(pending: PendingSignerChainChange, si : doSignerStateTokensMatch(pending.signerStateToken, signerStateToken) } -export function getPendingSignerChainChangeTokenForCallback(port: browser.runtime.Port, signerProviderGeneration: number, chainId: bigint) { +function getPendingSignerChainChangeTokenForCallback(port: browser.runtime.Port, signerProviderGeneration: number, chainId: bigint) { const signerStateToken = pendingSignerChainChange?.signerStateToken if (signerStateToken === undefined || pendingSignerChainChange?.requestedRpcNetwork.chainId !== chainId) return undefined if (signerStateToken.port !== port || signerStateToken.signerProviderGeneration !== signerProviderGeneration) return undefined return signerStateToken } -export function isPendingSignerChainChangeReply(signerStateToken: SignerStateToken, chainId: bigint) { +function isPendingSignerChainChangeReply(signerStateToken: SignerStateToken, chainId: bigint) { return pendingSignerChainChange !== undefined && doesPendingSignerChainChangeMatch(pendingSignerChainChange, signerStateToken, chainId) } // Keep the requested endpoint in memory until the matching wallet accepts; a rejected request must not change RPC preferences. -export function getPendingSignerChainChangeRpc(signerStateToken: SignerStateToken, chainId: bigint) { +function getPendingSignerChainChangeRpc(signerStateToken: SignerStateToken, chainId: bigint) { const pending = pendingSignerChainChange return pending !== undefined && doesPendingSignerChainChangeMatch(pending, signerStateToken, chainId) ? pending.requestedRpcNetwork : undefined } -export function resolveSignerChainChange(signerStateToken: SignerStateToken, confirmation: SignerChainChangeConfirmation) { +function resolveSignerChainChange(signerStateToken: SignerStateToken, confirmation: SignerChainChangeConfirmation) { if (!isPendingWalletSwitchRequest(confirmation.data[0].walletSwitchRequestId)) return false markSignerChainReplyReceived(signerStateToken, confirmation.data[0].chainId, confirmation.data[0].walletSwitchRequestId) const pending = pendingSignerChainChange @@ -279,3 +280,54 @@ export async function requestSignerChainChange(ethereum: EthereumClientService, } return userDeniedChange } + +// Own reply matching, deadline cancellation and settlement together, including failures while applying wallet state. +export async function applyWalletSwitchReply( + websiteTabConnections: WebsiteTabConnections, + port: browser.runtime.Port, + params: WalletSwitchEthereumChainReply['params'][0], + applyChain: (token: SignerStateToken, chainId: bigint, rpc: RpcNetwork | undefined) => Promise, +) { + const socket = getSocketFromPort(port) + if (socket === undefined) return + await runSignerStateOperation(websiteTabConnections, socket.tabId, async () => { + const currentSignerStateToken = getConfirmedSignerStateToken(websiteTabConnections, socket.tabId) + if (currentSignerStateToken?.socket.connectionName !== socket.connectionName || currentSignerStateToken.port !== port) return + if (!isPendingWalletSwitchRequest(params.walletSwitchRequestId)) return + const pendingSignerStateToken = getPendingSignerChainChangeTokenForCallback(port, params.signerProviderGeneration, params.chainId) + const callbackSignerStateToken = pendingSignerStateToken + ?? (currentSignerStateToken.signerProviderGeneration === params.signerProviderGeneration ? currentSignerStateToken : undefined) + if (callbackSignerStateToken === undefined) return + const solicitedReply = isPendingSignerChainChangeReply(callbackSignerStateToken, params.chainId) + // Only this command's owner and chain may apply its reply. Unsolicited chain events use signerChainChanged. + if (!solicitedReply) return + if (currentSignerStateToken.signerProviderGeneration !== params.signerProviderGeneration) { + resolveSignerChainChange(callbackSignerStateToken, { + method: 'popup_signerChangeChainDialog', + data: [{ accept: false, chainId: params.chainId, walletSwitchRequestId: params.walletSwitchRequestId, error: signerConnectionReplacedError, signerProviderGeneration: params.signerProviderGeneration }], + }) + return + } + markSignerChainReplyReceived(callbackSignerStateToken, params.chainId, params.walletSwitchRequestId) + try { + if (params.accept) { + const requestedRpc = getPendingSignerChainChangeRpc(callbackSignerStateToken, params.chainId) + await applyChain(currentSignerStateToken, params.chainId, requestedRpc) + const activeRpc = (await getSettings()).activeRpcNetwork + if (requestedRpc !== undefined && !getRpcNetworkChange(activeRpc, requestedRpc).endpointChanged) await promoteRpcAsPrimary(requestedRpc) + } + resolveSignerChainChange(callbackSignerStateToken, { + method: 'popup_signerChangeChainDialog', + data: [params], + }) + } catch (error) { + // Delivery ended the wallet deadline; a failure while applying the reply must also release the waiting popup. + resolveSignerChainChange(callbackSignerStateToken, { + method: 'popup_signerChangeChainDialog', + data: [{ accept: false, chainId: params.chainId, walletSwitchRequestId: params.walletSwitchRequestId, signerProviderGeneration: params.signerProviderGeneration, error: { code: JSON_RPC_ERROR_CODE_INTERNAL_ERROR, message: 'The wallet replied, but updating the selected network failed. Refresh the popup and try again.' } }], + }) + throw error + } + return + }) +} diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index 0999dbd03..0fc9842d4 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -95,7 +95,7 @@ describe('popup settings changes', () => { const { changeSimulationMode, getSettings, saveCurrentTabId, websiteSocketToString } = await loadModules() const { dispatchPopupMessage } = await import('../../app/ts/background/popupMessageDispatcher.js') const { getConfirmedSignerStateToken } = await import('../../app/ts/background/signerStateOwnership.js') - const { resolveSignerChainChange } = await import('../../app/ts/background/windows/changeChain.js') + const { applyWalletSwitchReply } = await import('../../app/ts/background/windows/changeChain.js') await changeSimulationMode({ simulationMode: false }) await saveCurrentTabId(1) const socket = { tabId: 1, connectionName: 0n } @@ -132,7 +132,7 @@ describe('popup settings changes', () => { } finally { const token = getConfirmedSignerStateToken(connections, 1) if (token === undefined) throw new Error('Missing signer token') - resolveSignerChainChange(token, { method: 'popup_signerChangeChainDialog', data: [{ accept: false, chainId: 2n, walletSwitchRequestId: getWalletSwitchRequestId(messages), error: { code: 4001, message: 'Rejected' } }] }) + await applyWalletSwitchReply(connections, port, { accept: false, chainId: 2n, walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: token.signerProviderGeneration, error: { code: 4001, message: 'Rejected' } }, async () => undefined) await pending } assert.equal(statuses().at(-1)?.operation, undefined) @@ -189,7 +189,7 @@ describe('popup settings changes', () => { assert.equal(messages.some(message => message.method === 'request_signer_to_wallet_switchEthereumChain'), false, 'Metadata edits must not ask a connected wallet to switch chains') }) - test('activation returns the installed services and preserves them when the endpoint is unchanged', async () => { + test('activation installs services once without exposing a potentially superseded snapshot', async () => { installBrowserMock() const { changeSimulationMode, getSettings } = await loadModules() const { activateAddressSelection } = await import('../../app/ts/background/activeSettings.js') @@ -207,11 +207,9 @@ describe('popup settings changes', () => { } const options = { simulationMode: true, signerAddress: undefined, rpcNetwork: nextRpc } const active = await activateAddressSelection(original.ethereum, original.tokenPriceService, reset, new Map(), undefined, options) - assert.equal(active.ethereum, installed.ethereum) - assert.equal(active.tokenPriceService, installed.tokenPriceService) - const unchanged = await activateAddressSelection(active.ethereum, active.tokenPriceService, reset, new Map(), undefined, options) - assert.equal(unchanged.ethereum, installed.ethereum) - assert.equal(unchanged.tokenPriceService, installed.tokenPriceService) + assert.equal(active, undefined) + const unchanged = await activateAddressSelection(installed.ethereum, installed.tokenPriceService, reset, new Map(), undefined, options) + assert.equal(unchanged, undefined) assert.equal(resets, 1) }) @@ -345,7 +343,7 @@ describe('popup settings changes', () => { test(`wallet deadline releases a silent request but does not expire a received reply (${ outcome })`, async () => { installBrowserMock() const { changeSimulationMode, getSettings, websiteSocketToString } = await loadModules() - const { requestSignerChainChange, resolveSignerChainChange, markSignerChainReplyReceived } = await import('../../app/ts/background/windows/changeChain.js') + const { requestSignerChainChange, applyWalletSwitchReply } = await import('../../app/ts/background/windows/changeChain.js') const { getConfirmedSignerStateToken } = await import('../../app/ts/background/signerStateOwnership.js') await changeSimulationMode({ simulationMode: false }) const socket = { tabId: 1, connectionName: 0n } @@ -358,17 +356,18 @@ describe('popup settings changes', () => { const request = (timeoutMs: number) => requestSignerChainChange(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, rpc, 1, timeoutMs) const token = getConfirmedSignerStateToken(connections, 1) if (token === undefined) throw new Error('Missing signer token') + const application = createDeferredValue() + let delivery: Promise | undefined if (outcome === 'reply') { const postMessage = port.postMessage port.postMessage = message => { postMessage(message) // Simulate delivery before changeActiveRpc has returned its signer token. - markSignerChainReplyReceived(token, 2n, getWalletSwitchRequestId(messages)) + if (message.method === 'request_signer_to_wallet_switchEthereumChain') delivery = applyWalletSwitchReply(connections, port, { accept: true, chainId: 2n, walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: token.signerProviderGeneration }, async () => await application.promise) } } const pending = request(30) await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) - const reply = { method: 'popup_signerChangeChainDialog', data: [{ accept: false, chainId: 2n, walletSwitchRequestId: getWalletSwitchRequestId(messages), error: { code: 4001, message: 'Rejected' } }] } as const if (outcome === 'failure') { const { walletSwitchEthereumChainReply } = await import('../../app/ts/background/providerMessageHandlers.js') const originalSet = browser.storage.local.set @@ -383,8 +382,9 @@ describe('popup settings changes', () => { } else if (outcome === 'reply') { // Delivery has begun, but applying the accepted wallet state can involve slower RPC work. await new Promise(resolve => setTimeout(resolve, 60)) - resolveSignerChainChange(token, reply) - assert.equal((await pending).error?.code, 4001) + application.resolve(undefined) + await delivery + assert.equal((await pending).result, null) } else { assert.match((await pending).error?.message ?? '', /did not answer/) const expiredId = getWalletSwitchRequestId(messages) @@ -425,7 +425,7 @@ describe('popup settings changes', () => { test(`waits for the matching wallet network ${ accept ? 'acceptance' : 'rejection' }`, async () => { installBrowserMock() const { changeSimulationMode, getSettings, websiteSocketToString } = await loadModules() - const { requestSignerChainChange, resolveSignerChainChange } = await import('../../app/ts/background/windows/changeChain.js') + const { requestSignerChainChange, applyWalletSwitchReply } = await import('../../app/ts/background/windows/changeChain.js') await changeSimulationMode({ simulationMode: false }) const socket = { tabId: 1, connectionName: 0n } const ownership = confirmedSignerOwnership(socket) @@ -444,10 +444,8 @@ describe('popup settings changes', () => { const { getConfirmedSignerStateToken } = await import('../../app/ts/background/signerStateOwnership.js') const token = getConfirmedSignerStateToken(connections, 1) if (token === undefined) throw new Error('Expected signer owner') - resolveSignerChainChange(token, { - method: 'popup_signerChangeChainDialog', - data: accept ? [{ accept: true, chainId: rpc.chainId, walletSwitchRequestId: getWalletSwitchRequestId(messages) }] : [{ accept: false, chainId: rpc.chainId, walletSwitchRequestId: getWalletSwitchRequestId(messages), error: { code: 4001, message: 'User rejected network change' } }], - }) + const replyBase = { chainId: rpc.chainId, walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: token.signerProviderGeneration } + await applyWalletSwitchReply(connections, port, accept ? { ...replyBase, accept: true } : { ...replyBase, accept: false, error: { code: 4001, message: 'User rejected network change' } }, async () => undefined) const result = await pending if (accept) assert.equal(result.result, null) else assert.equal(result.error?.message, 'User rejected network change') From 60c37f06fbf3f2db26577e0d4bc503fa942b77b5 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 13:47:15 +0000 Subject: [PATCH 11/31] Move RPC change classification out of wire codecs --- app/ts/background/activeSettings.ts | 3 ++- app/ts/background/popupMessageHandlers.ts | 2 +- app/ts/background/providerMessageHandlers.ts | 3 ++- app/ts/background/windows/changeChain.ts | 3 ++- .../hooks/useLiveSimulationHomeData.ts | 3 ++- app/ts/types/rpc.ts | 10 ---------- app/ts/utils/rpcNetworkChange.ts | 17 +++++++++++++++++ test/tests/rpcNetworkChange.test.ts | 3 ++- 8 files changed, 28 insertions(+), 16 deletions(-) create mode 100644 app/ts/utils/rpcNetworkChange.ts diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index 142631d62..2a06c32b6 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -3,7 +3,8 @@ import type { EthereumClientService } from '../simulation/services/EthereumClien import type { ResetSimulationServices, SimulationServices } from '../simulation/serviceLifecycle.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' import type { SigningAddressPreference } from '../types/signerTypes.js' -import { getRpcNetworkChange, type RpcNetwork } from '../types/rpc.js' +import { getRpcNetworkChange } from '../utils/rpcNetworkChange.js' +import type { RpcNetwork } from '../types/rpc.js' import type { WebsiteTabConnections } from '../types/user-interface-types.js' import { Semaphore } from '../utils/semaphore.js' import type { WebsiteAccessUpdate } from './accessManagement.js' diff --git a/app/ts/background/popupMessageHandlers.ts b/app/ts/background/popupMessageHandlers.ts index 3f9ac54b9..57ab45a1f 100644 --- a/app/ts/background/popupMessageHandlers.ts +++ b/app/ts/background/popupMessageHandlers.ts @@ -1,4 +1,4 @@ -import { getRpcNetworkChange } from '../types/rpc.js' +import { getRpcNetworkChange } from '../utils/rpcNetworkChange.js' import { refreshPopupSimulation } from './popupSimulationRefresh.js' import { refreshConfirmTransactionSimulation } from './confirmTransactionSimulation.js' import { activateAddressSelection, changeActiveAddressAndChain, changeActiveRpc } from './activeSettings.js' diff --git a/app/ts/background/providerMessageHandlers.ts b/app/ts/background/providerMessageHandlers.ts index 1bc6e266e..b0ab01760 100644 --- a/app/ts/background/providerMessageHandlers.ts +++ b/app/ts/background/providerMessageHandlers.ts @@ -1,4 +1,5 @@ -import { getRpcNetworkChange, type RpcNetwork } from '../types/rpc.js' +import { getRpcNetworkChange } from '../utils/rpcNetworkChange.js' +import type { RpcNetwork } from '../types/rpc.js' import { ConnectedToSigner, SignerReply, WalletSwitchEthereumChainReply, WatchAssetSignerRequest } from '../types/interceptor-messages.js' import type { TabState, WebsiteTabConnections } from '../types/user-interface-types.js' import { EthereumAccountsReply, EthereumChainReply } from '../types/JsonRpc-types.js' diff --git a/app/ts/background/windows/changeChain.ts b/app/ts/background/windows/changeChain.ts index 810f02560..4df39fbef 100644 --- a/app/ts/background/windows/changeChain.ts +++ b/app/ts/background/windows/changeChain.ts @@ -6,7 +6,8 @@ import type { WebsiteTabConnections } from '../../types/user-interface-types.js' import { changeActiveRpc } from '../activeSettings.js' import { getHtmlFile, getSocketFromPort, sendPopupMessageToOpenWindows } from '../backgroundUtils.js' import { getChainChangeConfirmationPromise, getRpcNetworkForChain, promoteRpcAsPrimary, setChainChangeConfirmationPromise } from '../storageVariables.js' -import { getRpcNetworkChange, type RpcNetwork } from '../../types/rpc.js' +import { getRpcNetworkChange } from '../../utils/rpcNetworkChange.js' +import type { RpcNetwork } from '../../types/rpc.js' import { type InterceptedRequest, type UniqueRequestIdentifier, doesUniqueRequestIdentifiersMatch } from '../../utils/requests.js' import { replyToInterceptedRequest } from '../messageSending.js' import type { SwitchEthereumChainParams } from '../../types/JsonRpc-types.js' diff --git a/app/ts/components/hooks/useLiveSimulationHomeData.ts b/app/ts/components/hooks/useLiveSimulationHomeData.ts index d4236483d..9986f72d8 100644 --- a/app/ts/components/hooks/useLiveSimulationHomeData.ts +++ b/app/ts/components/hooks/useLiveSimulationHomeData.ts @@ -3,7 +3,8 @@ import { MessageToPopup, type HomePageBootstrap, type UpdateHomePage, type Setti import type { RpcConnectionStatus, TabIconDetails, TabState } from '../../types/user-interface-types.js' import { PASSTHROUGH_STATE, type BlockTimeManipulation, type CompleteVisualizedSimulation, type NamedTokenId, type ResolvedSimulationResults, type ResolvedSimulationState, type SimulationResultState, type SimulationUpdatingState, type TokenPriceEstimate, type VisualizedSimulationState, toResolvedSimulationResults } from '../../types/visualizer-types.js' import type { AddressBookEntries, AddressBookEntry } from '../../types/addressBookTypes.js' -import { getRpcNetworkChange, type RpcEntries, type RpcNetwork } from '../../types/rpc.js' +import { getRpcNetworkChange } from '../../utils/rpcNetworkChange.js' +import type { RpcEntries, RpcNetwork } from '../../types/rpc.js' import type { WebsiteAccessArray } from '../../types/websiteAccessTypes.js' import type { EnrichedRichListElement, UnexpectedErrorOccured } from '../../types/interceptor-reply-messages.js' import { PopupMessageReplyRequests } from '../../types/interceptor-reply-messages.js' diff --git a/app/ts/types/rpc.ts b/app/ts/types/rpc.ts index 239c14db8..87de0fb09 100644 --- a/app/ts/types/rpc.ts +++ b/app/ts/types/rpc.ts @@ -49,13 +49,3 @@ export const RpcNetwork = funtypes.Union( minimized: funtypes.Literal(true), }) ) - -// Chain changes require wallet approval; endpoint changes replace services; metadata changes only update the selection. -export function getRpcNetworkChange(previous: RpcNetwork | undefined, next: RpcNetwork) { - const chainChanged = previous?.chainId !== next.chainId - return { - chainChanged, - endpointChanged: chainChanged || previous?.httpsRpc !== next.httpsRpc, - selectionChanged: previous === undefined || JSON.stringify(RpcNetwork.serialize(previous)) !== JSON.stringify(RpcNetwork.serialize(next)), - } -} diff --git a/app/ts/utils/rpcNetworkChange.ts b/app/ts/utils/rpcNetworkChange.ts new file mode 100644 index 000000000..cc2cfb786 --- /dev/null +++ b/app/ts/utils/rpcNetworkChange.ts @@ -0,0 +1,17 @@ +import { RpcNetwork } from '../types/rpc.js' + +export type RpcNetworkChange = { + readonly chainChanged: boolean + readonly endpointChanged: boolean + readonly selectionChanged: boolean +} + +// Chain changes require wallet approval; endpoint changes replace services; metadata changes only update the selection. +export function getRpcNetworkChange(previous: RpcNetwork | undefined, next: RpcNetwork): RpcNetworkChange { + const chainChanged = previous?.chainId !== next.chainId + return { + chainChanged, + endpointChanged: chainChanged || previous?.httpsRpc !== next.httpsRpc, + selectionChanged: previous === undefined || JSON.stringify(RpcNetwork.serialize(previous)) !== JSON.stringify(RpcNetwork.serialize(next)), + } +} diff --git a/test/tests/rpcNetworkChange.test.ts b/test/tests/rpcNetworkChange.test.ts index aec9985c8..114da99cf 100644 --- a/test/tests/rpcNetworkChange.test.ts +++ b/test/tests/rpcNetworkChange.test.ts @@ -1,6 +1,7 @@ import { describe, test } from 'bun:test' import * as assert from 'assert' -import { getRpcNetworkChange, type RpcNetwork } from '../../app/ts/types/rpc.js' +import { getRpcNetworkChange } from '../../app/ts/utils/rpcNetworkChange.js' +import type { RpcNetwork } from '../../app/ts/types/rpc.js' const network: RpcNetwork = { chainId: 1n, httpsRpc: 'https://rpc.example', name: 'Network', currencyName: 'Ether', currencyTicker: 'ETH', primary: true, minimized: false } From 268749dc49a83bc5870766b4c7d40c83f5e5f683 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 14:11:31 +0000 Subject: [PATCH 12/31] Keep coalesced refresh outcomes scoped to each request --- app/ts/background/popupSimulationRefresh.ts | 69 ++++++++------- test/tests/popupSettingsChanges.test.ts | 93 ++++++++++++--------- 2 files changed, 95 insertions(+), 67 deletions(-) diff --git a/app/ts/background/popupSimulationRefresh.ts b/app/ts/background/popupSimulationRefresh.ts index 45130e17d..b57dcc290 100644 --- a/app/ts/background/popupSimulationRefresh.ts +++ b/app/ts/background/popupSimulationRefresh.ts @@ -1,3 +1,4 @@ +import { Future } from '../utils/future.js' import type { SimulationServices } from '../simulation/serviceLifecycle.js' import { getAddressesbeingMadeRich, getCurrentSimulationInput } from './simulationUpdating.js' import { getPopupVisualisationFingerprint } from './popupSimulationFingerprint.js' @@ -9,36 +10,48 @@ import { type PopupSimulationSnapshot, updatePopupVisualisationIfNeeded } from ' export type PopupSimulationRefresh = SimulationServices & { readonly invalidateOldState?: boolean } export type RevisionedPopupSimulationRefresh = PopupSimulationRefresh & { readonly revision: string | symbol } -// Identical revisions join active work unless a newer request is queued: in A → B → A, the last A must replace pending B. +// Identical revisions share their own outcome; superseded queued work resolves false because it was not refreshed. export function createPopupSimulationRefresher(refresh: (services: T) => Promise) { - let pendingServices: T | undefined - let activeServices: T | undefined - let running: Promise | undefined + type Entry = { services: T, readonly result: Future } + let pending: Entry | undefined + let active: Entry | undefined + let draining = false + const sameRevision = (left: T, right: T) => left.revision === right.revision + && left.ethereum === right.ethereum && left.tokenPriceService === right.tokenPriceService + + const drain = async () => { + while (pending !== undefined) { + const entry = pending + pending = undefined + active = entry + // Settle only this entry, including thrown failures, then continue with independently queued work. + await Promise.resolve().then(() => refresh(entry.services)).then( + value => { active = undefined; entry.result.resolve(value) }, + error => { active = undefined; entry.result.reject(error) }, + ) + } + draining = false + } + return (services: T): Promise => { - if (pendingServices === undefined && running !== undefined && activeServices !== undefined - && activeServices.revision === services.revision - && activeServices.ethereum === services.ethereum - && activeServices.tokenPriceService === services.tokenPriceService - && (!services.invalidateOldState || activeServices.invalidateOldState)) return running - pendingServices = { ...services, invalidateOldState: services.invalidateOldState || pendingServices?.invalidateOldState } - if (running !== undefined) return running - running = Promise.resolve().then(async () => { - try { - let refreshed = true - while (pendingServices !== undefined) { - const currentServices = pendingServices - pendingServices = undefined - activeServices = currentServices - refreshed = await refresh(currentServices) - } - return refreshed - } finally { - pendingServices = undefined - activeServices = undefined - running = undefined - } - }) - return running + if (pending !== undefined && sameRevision(pending.services, services)) { + pending.services = { ...services, invalidateOldState: services.invalidateOldState || pending.services.invalidateOldState } + return pending.result.asPromise + } + // In A → B → A, the last A must replace pending B rather than join the active A. + if (pending === undefined && active !== undefined && sameRevision(active.services, services) + && (!services.invalidateOldState || active.services.invalidateOldState)) return active.result.asPromise + const entry: Entry = { + services: { ...services, invalidateOldState: services.invalidateOldState || pending?.services.invalidateOldState }, + result: new Future(), + } + pending?.result.resolve(false) + pending = entry + if (!draining) { + draining = true + void Promise.resolve().then(drain) + } + return entry.result.asPromise } } diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index 0fc9842d4..bf34b409f 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -4,36 +4,26 @@ import { getWalletSwitchRequestId, confirmedSignerOwnership, createDeferredValue import type { RevisionedPopupSimulationRefresh } from '../../app/ts/background/popupSimulationRefresh.js' describe('popup settings changes', () => { - test('coalesces refreshes and waits for changes arriving during an active refresh', async () => { + for (const firstSucceeded of [true, false]) test(`keeps overlapping refresh outcomes independent (first=${ firstSucceeded })`, async () => { installBrowserMock() const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') const first = createDeferredValue() const last = createDeferredValue() - const calls: RevisionedPopupSimulationRefresh[] = [] - const refresh = createPopupSimulationRefresher(async (services) => { - calls.push(services) - return await (calls.length === 1 ? first.promise : last.promise) + const started = createDeferredValue() + const refresh = createPopupSimulationRefresher(async services => { + if (services.revision === 'first') { started.resolve(undefined); return await first.promise } + return await last.promise }) const services = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'first' } const result = refresh(services) - assert.equal(refresh({ ...services, invalidateOldState: true }), result) - await Promise.resolve() - assert.equal(calls.length, 1) - assert.equal(calls[0]?.invalidateOldState, true) + await started.promise assert.equal(refresh(services), result) - const newerServices = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'second' } - assert.equal(refresh({ ...services, invalidateOldState: true }), result) - assert.equal(refresh({ ...newerServices, invalidateOldState: true }), result) - let completed = false - void result.then(() => { completed = true }) - first.resolve(true) - await new Promise((resolve) => setTimeout(resolve, 0)) - assert.equal(calls.length, 2) - assert.equal(calls[1]?.ethereum, newerServices.ethereum) - assert.equal(calls[1]?.invalidateOldState, true) - assert.equal(completed, false) - last.resolve(false) - assert.equal(await result, false) + const next = refresh({ ...services, revision: 'second' }) + assert.notEqual(next, result) + first.resolve(firstSucceeded) + assert.equal(await result, firstSucceeded) + last.resolve(!firstSucceeded) + assert.equal(await next, !firstSucceeded) }) for (const change of ['same', 'revision', 'provider', 'force'] as const) { @@ -41,50 +31,75 @@ describe('popup settings changes', () => { installBrowserMock() const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') const release = createDeferredValue() + const started = createDeferredValue() let calls = 0 - const refresh = createPopupSimulationRefresher(async () => { calls++; return await release.promise }) + const refresh = createPopupSimulationRefresher(async () => { calls++; started.resolve(undefined); return await release.promise }) const services = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'one' } const pending = refresh(services) - await Promise.resolve() + await started.promise const next = change === 'provider' ? { ...services, ...createEthereumWithGetBlockCounter({ count: 0 }) } : change === 'revision' ? { ...services, revision: 'two' } : change === 'force' ? { ...services, invalidateOldState: true } : services - for (let i = 0; i < 5; i++) assert.equal(refresh(next), pending) + const nextResult = refresh(next) + assert.equal(nextResult === pending, change === 'same') + for (let i = 0; i < 5; i++) assert.equal(refresh(next), nextResult) release.resolve(true) assert.equal(await pending, true) + assert.equal(await nextResult, true) assert.equal(calls, change === 'same' ? 1 : 2) - // Completed work never suppresses a later retry or explicit refresh. await refresh(next) assert.equal(calls, change === 'same' ? 2 : 3) }) } - test('keeps the latest A request when B was queued during an active A refresh', async () => { + test('supersedes queued B with the latest A and carries forward invalidation', async () => { installBrowserMock() const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') const release = createDeferredValue() - const revisions: (string | symbol)[] = [] - const refresh = createPopupSimulationRefresher(async (services) => { revisions.push(services.revision); return await release.promise }) + const started = createDeferredValue() + const calls: RevisionedPopupSimulationRefresh[] = [] + const refresh = createPopupSimulationRefresher(async services => { calls.push(services); started.resolve(undefined); return await release.promise }) const services = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'A' } - const pending = refresh(services) - await Promise.resolve() - refresh({ ...services, revision: 'B' }) - refresh(services) + const first = refresh(services) + await started.promise + const skipped = refresh({ ...services, revision: 'B', invalidateOldState: true }) + const last = refresh(services) + assert.notEqual(first, last) + assert.equal(await skipped, false) release.resolve(true) - await pending - assert.deepEqual(revisions, ['A', 'A']) + assert.equal(await first, true) + assert.equal(await last, true) + assert.deepEqual(calls.map(call => call.revision), ['A', 'A']) + assert.equal(calls[1]?.invalidateOldState, true) }) - test('allows retry after a rejected refresh', async () => { + test('merges invalidation for equivalent work before it starts', async () => { installBrowserMock() const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') + const refresh = createPopupSimulationRefresher(async services => services.invalidateOldState === true) + const services = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'A' } + const result = refresh(services) + assert.equal(refresh({ ...services, invalidateOldState: true }), result) + assert.equal(await result, true) + }) + + test('rejects only the failed entry and continues queued work and retries', async () => { + installBrowserMock() + const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') + const release = createDeferredValue() + const started = createDeferredValue() let attempts = 0 const refresh = createPopupSimulationRefresher(async () => { - if (++attempts === 1) throw new Error('Refresh failed') + if (++attempts === 1) { started.resolve(undefined); await release.promise; throw new Error('Refresh failed') } return true }) - const services = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'retry' } - await assert.rejects(refresh(services), /Refresh failed/) + const services = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'first' } + const failed = assert.rejects(refresh(services), /Refresh failed/) + await started.promise + const queued = refresh({ ...services, revision: 'second' }) + release.resolve(undefined) + await failed + assert.equal(await queued, true) assert.equal(await refresh(services), true) }) From 8d0d8fbe86d2d405098f97cbc5b022a4936d70b2 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 14:36:34 +0000 Subject: [PATCH 13/31] Keep popup status copy in the UI layer --- app/ts/components/hooks/usePopupSettingsChanges.ts | 11 +++++++++-- app/ts/types/popupSettingsProtocol.ts | 13 ++++++------- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/app/ts/components/hooks/usePopupSettingsChanges.ts b/app/ts/components/hooks/usePopupSettingsChanges.ts index 0d93e48ae..8faa0a077 100644 --- a/app/ts/components/hooks/usePopupSettingsChanges.ts +++ b/app/ts/components/hooks/usePopupSettingsChanges.ts @@ -1,7 +1,7 @@ import { useEffect } from 'preact/hooks' import { useComputed, useSignal } from '@preact/signals' import { MessageToPopup, type PopupSettingsChangeStatus } from '../../types/interceptor-messages.js' -import { acceptPopupSettingsChangeStatus, getPopupSettingsOperationLabel } from '../../types/popupSettingsProtocol.js' +import { acceptPopupSettingsChangeStatus, type PopupSettingsOperation } from '../../types/popupSettingsProtocol.js' import type { PopupSettingsRequestWithSharedReply } from '../../types/popupSettingsRequests.js' import type { AddressBookEntry } from '../../types/addressBookTypes.js' import type { RpcEntry } from '../../types/rpc.js' @@ -11,6 +11,13 @@ import { requestActiveAddressChange } from '../activeAddressChange.js' import { requestPopupSettingsChange } from '../popupSettingsChange.js' import type { useLiveSimulationHomeData } from './useLiveSimulationHomeData.js' +const popupSettingsOperationLabels: Readonly> = { + wallet: 'Changing wallet...', + mode: 'Changing mode...', + rpc: 'Changing network. Check your wallet if approval is required.', + rich: 'Updating balances...', +} + type SettingsChangeHomeData = Pick, 'isSettingsLoaded' | 'activeAddresses' | 'simulationMode' | 'rpcNetwork' | 'tabState' | 'displayedSigningAddress'> export function usePopupSettingsChanges({ isSettingsLoaded, activeAddresses, simulationMode, rpcNetwork, tabState, displayedSigningAddress }: SettingsChangeHomeData) { @@ -20,7 +27,7 @@ export function usePopupSettingsChanges({ isSettingsLoaded, activeAddresses, sim const pendingSettingsChange = useSignal(false) const backgroundSettingsChange = useSignal({ revision: 0, operation: undefined }) const isActiveAddressChangePending = useComputed(() => pendingAddressChangeRequestId.value !== undefined) - const sharedStatusLabel = useComputed(() => !pendingSettingsChange.value && !isActiveAddressChangePending.value && backgroundSettingsChange.value.operation !== undefined ? getPopupSettingsOperationLabel(backgroundSettingsChange.value.operation) : undefined) + const sharedStatusLabel = useComputed(() => !pendingSettingsChange.value && !isActiveAddressChangePending.value && backgroundSettingsChange.value.operation !== undefined ? popupSettingsOperationLabels[backgroundSettingsChange.value.operation] : undefined) const isSettingsChangePending = useComputed(() => isActiveAddressChangePending.value || pendingSettingsChange.value || backgroundSettingsChange.value.operation !== undefined) async function setActiveAddressAndInformAboutIt(address: bigint | 'signer', persistedEntry?: AddressBookEntry) { diff --git a/app/ts/types/popupSettingsProtocol.ts b/app/ts/types/popupSettingsProtocol.ts index 2de3f5d32..256d203b2 100644 --- a/app/ts/types/popupSettingsProtocol.ts +++ b/app/ts/types/popupSettingsProtocol.ts @@ -1,19 +1,18 @@ import * as funtypes from 'funtypes' import type { PopupSettingsRequest } from './popupSettingsRequests.js' -// Exhaustive over settings requests: admission, shared status, and UI text use this definition. +// Exhaustive over settings requests: admission and shared status use this definition. export const popupSettingsOperations = { - popup_changeActiveAddress: { operation: 'wallet', label: 'Changing wallet...', replyType: 'ChangeActiveAddressReply' }, - popup_enableSimulationMode: { operation: 'mode', label: 'Changing mode...', replyType: 'PopupSettingsChangeReply' }, - popup_changeActiveRpc: { operation: 'rpc', label: 'Changing network. Check your wallet if approval is required.', replyType: 'PopupSettingsChangeReply' }, - popup_modifyMakeMeRich: { operation: 'rich', label: 'Updating balances...', replyType: 'PopupSettingsChangeReply' }, -} as const satisfies Record + popup_changeActiveAddress: { operation: 'wallet', replyType: 'ChangeActiveAddressReply' }, + popup_enableSimulationMode: { operation: 'mode', replyType: 'PopupSettingsChangeReply' }, + popup_changeActiveRpc: { operation: 'rpc', replyType: 'PopupSettingsChangeReply' }, + popup_modifyMakeMeRich: { operation: 'rich', replyType: 'PopupSettingsChangeReply' }, +} as const satisfies Record const operations = Object.values(popupSettingsOperations) export type PopupSettingsOperation = typeof operations[number]['operation'] export const PopupSettingsOperation = funtypes.String.withGuard((value): value is PopupSettingsOperation => operations.some(entry => entry.operation === value)) export const getPopupSettingsOperation = (method: string) => Object.entries(popupSettingsOperations).find(([key]) => key === method)?.[1] -export const getPopupSettingsOperationLabel = (operation: PopupSettingsOperation) => operations.find(entry => entry.operation === operation)?.label export type PopupSettingsChangeStatus = funtypes.Static export const PopupSettingsChangeStatus = funtypes.ReadonlyObject({ From 326cdb4f5263048fb664be543c0e9268f5c9aea4 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 14:57:13 +0000 Subject: [PATCH 14/31] Clarify refresh queue boundaries and route reset through queue --- app/ts/background/activeSettings.ts | 7 +++---- app/ts/background/popupMessageDispatcher.ts | 6 +++--- app/ts/background/popupMessageHandlers.ts | 4 ++-- ...fresh.ts => popupSimulationRefreshQueue.ts} | 3 ++- app/ts/background/popupVisualisationUpdater.ts | 5 ++++- docs/popup-simulation-refresh.md | 18 ++++++++++++++++++ test/tests/popupClearReset.test.ts | 5 ++++- test/tests/popupSettingsChanges.test.ts | 12 ++++++------ 8 files changed, 42 insertions(+), 18 deletions(-) rename app/ts/background/{popupSimulationRefresh.ts => popupSimulationRefreshQueue.ts} (93%) create mode 100644 docs/popup-simulation-refresh.md diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index 2a06c32b6..753f8016c 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -1,4 +1,4 @@ -import { refreshPopupSimulation } from './popupSimulationRefresh.js' +import { queuePopupSimulationRefresh } from './popupSimulationRefreshQueue.js' import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' import type { ResetSimulationServices, SimulationServices } from '../simulation/serviceLifecycle.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' @@ -10,7 +10,6 @@ import { Semaphore } from '../utils/semaphore.js' import type { WebsiteAccessUpdate } from './accessManagement.js' import { reconcileWebsiteApprovalAccesses, finishWebsiteAccessUpdate, sendActiveAccountChangeToApprovedWebsitePorts, sendMessageToApprovedWebsitePorts } from './accessManagement.js' import { sendPopupMessageToOpenWindows } from './backgroundUtils.js' -import { updatePopupVisualisationIfNeeded } from './popupVisualisationUpdater.js' import { bumpPopupRefreshGeneration } from './popupRefreshGeneration.js' import { sendCallbackToConfirmedSignerOwner } from './signerStateOwnership.js' import { changeSimulationMode, getSettings, setUseSignersAddressAsActiveAddress, trackPreviousActiveAddressForMakeMeRichList } from './settings.js' @@ -50,7 +49,7 @@ async function clearSimulationStateFromConfig() { export async function resetSimulationStateFromConfig(ethereum: EthereumClientService, tokenPriceService: TokenPriceService) { await clearSimulationStateFromConfig() - await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, false, false) + await queuePopupSimulationRefresh({ ethereum, tokenPriceService, invalidateOldState: true }) } const keepTrackOfPreviousAddressForRichList = async () => { @@ -132,7 +131,7 @@ async function runActiveSettingsChange( await sendPopupMessageToOpenWindows({ method: 'popup_chain_update' }) } if (rpcEndpointChanged || !activeStackContextsEqual(getActiveStackContext(previousSettings), getActiveStackContext(updatedSettings))) { - await refreshPopupSimulation(activeServices) + await queuePopupSimulationRefresh(activeServices) } await sendActiveAccountChangeToApprovedWebsitePorts(websiteTabConnections, await getSettings()) if (transition.signingPreference !== undefined) await rememberSigningAddressSelection(transition.signingPreference) diff --git a/app/ts/background/popupMessageDispatcher.ts b/app/ts/background/popupMessageDispatcher.ts index d78cef20b..c7a049ff1 100644 --- a/app/ts/background/popupMessageDispatcher.ts +++ b/app/ts/background/popupMessageDispatcher.ts @@ -2,7 +2,7 @@ import { sendPopupMessageToOpenWindows } from './backgroundUtils.js' import { getPopupSettingsOperation } from '../types/popupSettingsProtocol.js' import { createPopupSettingsCoordinator } from './popupSettingsCoordinator.js' import { getSettings } from './settings.js' -import { refreshPopupSimulation } from './popupSimulationRefresh.js' +import { queuePopupSimulationRefresh } from './popupSimulationRefreshQueue.js' import type { PopupMessage } from '../types/interceptor-messages.js' import type { PopupReplyOption } from '../types/interceptor-reply-messages.js' import { getSimulationStackTargetHash } from '../utils/simulationStackTargets.js' @@ -22,7 +22,7 @@ const popupMessageHandlers = { popup_confirmDialog: popupMessageHandler('popup_confirmDialog', async (context, request) => await confirmDialog(context.ethereum, context.tokenPriceService, context.websiteTabConnections, request)), popup_changeActiveAddress: popupMessageHandler('popup_changeActiveAddress', async (context, request) => await changeActiveAddress(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), popup_modifyMakeMeRich: popupMessageHandler('popup_modifyMakeMeRich', async (context, request) => { - if (await modifyMakeMeRich(request) && !await refreshPopupSimulation({ ethereum: context.ethereum, tokenPriceService: context.tokenPriceService, invalidateOldState: true })) { + if (await modifyMakeMeRich(request) && !await queuePopupSimulationRefresh({ ethereum: context.ethereum, tokenPriceService: context.tokenPriceService, invalidateOldState: true })) { return { type: 'PopupSettingsChangeReply', ok: false, message: 'The rich setting was saved, but balances could not be refreshed. Please refresh the simulation to retry.' } } return { type: 'PopupSettingsChangeReply', ok: true } @@ -32,7 +32,7 @@ const popupMessageHandlers = { popup_resetSimulation: popupMessageHandler('popup_resetSimulation', async (context) => await context.resetSimulationState()), popup_removeTransactionOrSignedMessage: popupMessageHandler('popup_removeTransactionOrSignedMessage', async (context, request) => await removeTransactionOrSignedMessage(context.ethereum, context.tokenPriceService, request)), popup_refreshSimulation: popupMessageHandler('popup_refreshSimulation', async (context) => { - await refreshPopupSimulation({ ...context, invalidateOldState: true }) + await queuePopupSimulationRefresh({ ...context, invalidateOldState: true }) }), popup_refreshConfirmTransactionDialogSimulation: popupMessageHandler('popup_refreshConfirmTransactionDialogSimulation', async (context) => await refreshPopupConfirmTransactionSimulation(context.ethereum, context.tokenPriceService)), popup_refreshConfirmTransactionMetadata: popupMessageHandler('popup_refreshConfirmTransactionMetadata', async (context) => await refreshPopupConfirmTransactionMetadata(context.ethereum, context.tokenPriceService, context.confirmTransactionAbortController)), diff --git a/app/ts/background/popupMessageHandlers.ts b/app/ts/background/popupMessageHandlers.ts index 57ab45a1f..cb3283593 100644 --- a/app/ts/background/popupMessageHandlers.ts +++ b/app/ts/background/popupMessageHandlers.ts @@ -1,5 +1,5 @@ import { getRpcNetworkChange } from '../utils/rpcNetworkChange.js' -import { refreshPopupSimulation } from './popupSimulationRefresh.js' +import { queuePopupSimulationRefresh } from './popupSimulationRefreshQueue.js' import { refreshConfirmTransactionSimulation } from './confirmTransactionSimulation.js' import { activateAddressSelection, changeActiveAddressAndChain, changeActiveRpc } from './activeSettings.js' import { getUpdatedSimulationStackSnapshot, getUpdatedSimulationState } from './simulationUpdating.js' @@ -1287,7 +1287,7 @@ export async function importSimulationStack(ethereum: EthereumClientService, tok } export async function requestCompleteVisualizedSimulation(ethereum: EthereumClientService, tokenPriceService: TokenPriceService) { - await refreshPopupSimulation({ ethereum, tokenPriceService }) + await queuePopupSimulationRefresh({ ethereum, tokenPriceService }) const visualizedSimulatorState = await getPopupVisualisationState() return { method: 'popup_requestCompleteVisualizedSimulation' as const, visualizedSimulatorState } } diff --git a/app/ts/background/popupSimulationRefresh.ts b/app/ts/background/popupSimulationRefreshQueue.ts similarity index 93% rename from app/ts/background/popupSimulationRefresh.ts rename to app/ts/background/popupSimulationRefreshQueue.ts index b57dcc290..8cb0c9d1f 100644 --- a/app/ts/background/popupSimulationRefresh.ts +++ b/app/ts/background/popupSimulationRefreshQueue.ts @@ -1,3 +1,4 @@ +// Optional interactive scheduling above popupVisualisationUpdater; queue guarantees do not cover direct block, bootstrap or persistence updates. See docs/popup-simulation-refresh.md. import { Future } from '../utils/future.js' import type { SimulationServices } from '../simulation/serviceLifecycle.js' import { getAddressesbeingMadeRich, getCurrentSimulationInput } from './simulationUpdating.js' @@ -60,7 +61,7 @@ const refreshRevision = createPopupSimulationRefresher ( simulationState.simulationStateInput.some((block) => block.transactions.length > 0 || block.signedMessages.length > 0) ) +// Visibility/throttle-aware execution: callers such as block updates can replace obsolete work without entering the interactive queue. export const updatePopupVisualisationIfNeeded = async (ethereum: EthereumClientService, tokenPriceService: TokenPriceService, invalidateOldState = false, onlyIfNotAlreadyUpdating = false, skipIfUnchanged = false, snapshot?: PopupSimulationSnapshot) => { try { const popupVisualisation = await getPopupVisualisationState() @@ -101,6 +102,7 @@ export type OpenConsumerVisualisationDependencies = { readonly reportError?: typeof reportUnexpectedError } +// Bootstrap already knows a consumer is open; refresh without the visibility probe and retain the stored fallback on reported errors. export async function refreshPopupVisualisationForOpenConsumer(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, dependencies: OpenConsumerVisualisationDependencies = {}) { try { await (dependencies.update ?? updatePopupVisualisationState)(ethereum, tokenPriceService, undefined, true) @@ -111,6 +113,7 @@ export async function refreshPopupVisualisationForOpenConsumer(ethereum: Ethereu } const updateSimulationVisualisationSemaphore = new Semaphore(1) +// Serialized execution without a visibility probe; persistence callers can require unexpected errors to propagate. export async function updatePopupVisualisationState(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, abortController: AbortController | undefined, throwOnUnexpectedError = false, snapshot?: PopupSimulationSnapshot) { try { return await updateSimulationVisualisationSemaphore.execute(async () => { diff --git a/docs/popup-simulation-refresh.md b/docs/popup-simulation-refresh.md new file mode 100644 index 000000000..2d72485bc --- /dev/null +++ b/docs/popup-simulation-refresh.md @@ -0,0 +1,18 @@ +# Popup simulation refresh ownership + +`popupVisualisationUpdater.ts` is the shared execution layer. Its semaphore serializes visualization execution for both queued and direct callers. It owns the abort controller, visibility/throttling checks, visualization construction, and publication. The queue is an optional scheduling policy above this layer, not a replacement for it or a global ordering guarantee. + +## Choosing an entry point + +| Need | Entry point | Contract | +| --- | --- | --- | +| Interactive settings changes, reset, explicit refresh, or requested complete visualization | `queuePopupSimulationRefresh` in `popupSimulationRefreshQueue.ts` | Capture input and rich-count together; share equivalent revisions, keep the latest pending request, carry invalidation forward, and settle each executed entry with its own outcome. Superseded queued requests resolve false. Reset forces invalidation after clearing the stack. | +| New-block updates, throttled editing, or existing flows that require an immediate refresh attempt | `updatePopupVisualisationIfNeeded` | Probe for an open consumer, optionally skip recent/unchanged work, and cancel obsolete cancellable execution. Returns the stored visualization, not a queued caller's success flag. | +| Bootstrap for an already-open consumer | `refreshPopupVisualisationForOpenConsumer` | Avoid another visibility probe; report unexpected errors and return the stored fallback so other bootstrap data can still load. | +| Import/persistence that must observe visualization errors | `updatePopupVisualisationState` | Execute under the same semaphore without visibility/throttling checks; `throwOnUnexpectedError` lets the caller report persistence failure explicitly. | + +The direct paths deliberately retain their existing contracts. A block update must be able to cancel obsolete work promptly; an import cannot silently become a superseded queue entry; bootstrap must not depend on a second open-consumer probe. Routing these paths through a boolean-returning, latest-pending queue would change those guarantees. + +Queue identity and supersession apply only among queue callers. Direct execution may run between queued entries or cancel their underlying cancellable execution. A queue result describes that entry's refresh attempt; it does not promise that the stored visualization remains unchanged afterward. All paths use the execution layer's serialization and storage/publication logic. + +When adding a trigger, choose the required cancellation, visibility, error, and return-value contract from the table. Changes to visualization execution belong in `popupVisualisationUpdater.ts`; changes to interactive sharing/supersession belong in `popupSimulationRefreshQueue.ts`. diff --git a/test/tests/popupClearReset.test.ts b/test/tests/popupClearReset.test.ts index 73935570a..f6ec62764 100644 --- a/test/tests/popupClearReset.test.ts +++ b/test/tests/popupClearReset.test.ts @@ -536,7 +536,10 @@ describe('popup clear reset', () => { assertDefinedEmptyPopupVisualisation(popupVisualisation, DEFAULT_BLOCK_MANIPULATION) const changedMessages = getSimulationStateChangedMessages(browserMock.sentMessages) - assert.equal(changedMessages.length > 0, true) + assert.equal(changedMessages.some(message => { + const parsed = PopupSimulationChangedMessage.safeParse(message) + return parsed.success && parsed.value.data.visualizedSimulatorState.simulationResultState === 'invalid' + }), true, 'Reset must invalidate the old visualization before publishing the cleared stack') assert.deepEqual(changedMessages.at(-1), getExpectedPopupSimulationChangedMessage(popupVisualisation)) }) diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index bf34b409f..f8fd9fde1 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -1,12 +1,12 @@ import * as assert from 'assert' import { describe, test } from 'bun:test' import { getWalletSwitchRequestId, confirmedSignerOwnership, createDeferredValue, createEthereumWithGetBlockCounter, createPort, installBrowserMock, loadModules, waitForPortMessageCount } from './backgroundEthAccountsTestHarness.js' -import type { RevisionedPopupSimulationRefresh } from '../../app/ts/background/popupSimulationRefresh.js' +import type { RevisionedPopupSimulationRefresh } from '../../app/ts/background/popupSimulationRefreshQueue.js' describe('popup settings changes', () => { for (const firstSucceeded of [true, false]) test(`keeps overlapping refresh outcomes independent (first=${ firstSucceeded })`, async () => { installBrowserMock() - const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') + const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefreshQueue.js') const first = createDeferredValue() const last = createDeferredValue() const started = createDeferredValue() @@ -29,7 +29,7 @@ describe('popup settings changes', () => { for (const change of ['same', 'revision', 'provider', 'force'] as const) { test(`shares only refresh work that covers the requested revision and invalidation (${ change })`, async () => { installBrowserMock() - const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') + const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefreshQueue.js') const release = createDeferredValue() const started = createDeferredValue() let calls = 0 @@ -54,7 +54,7 @@ describe('popup settings changes', () => { test('supersedes queued B with the latest A and carries forward invalidation', async () => { installBrowserMock() - const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') + const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefreshQueue.js') const release = createDeferredValue() const started = createDeferredValue() const calls: RevisionedPopupSimulationRefresh[] = [] @@ -75,7 +75,7 @@ describe('popup settings changes', () => { test('merges invalidation for equivalent work before it starts', async () => { installBrowserMock() - const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') + const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefreshQueue.js') const refresh = createPopupSimulationRefresher(async services => services.invalidateOldState === true) const services = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'A' } const result = refresh(services) @@ -85,7 +85,7 @@ describe('popup settings changes', () => { test('rejects only the failed entry and continues queued work and retries', async () => { installBrowserMock() - const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefresh.js') + const { createPopupSimulationRefresher } = await import('../../app/ts/background/popupSimulationRefreshQueue.js') const release = createDeferredValue() const started = createDeferredValue() let attempts = 0 From cc114c406bd0bc3c3b98095a268694f4d886eba3 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Mon, 7 Sep 2026 19:42:28 +0000 Subject: [PATCH 15/31] Guard unsupported simulation and centralize verified switch outcomes --- app/ts/background/activeSettings.ts | 1 + app/ts/background/popupMessageHandlers.ts | 6 +- .../background/popupVisualisationUpdater.ts | 3 +- app/ts/background/simulationUpdating.ts | 2 + app/ts/background/windows/changeChain.ts | 9 ++- docs/popup-simulation-refresh.md | 6 +- test/tests/popupClearReset.test.ts | 57 +++++++++++++++++++ test/tests/popupSettingsChanges.test.ts | 21 ++++--- 8 files changed, 89 insertions(+), 16 deletions(-) diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index 753f8016c..73797bce2 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -114,6 +114,7 @@ async function runActiveSettingsChange( const updatedSettings = await getSettings() const { chainChanged: rpcChainChanged, endpointChanged: rpcEndpointChanged } = getRpcNetworkChange(previousSettings.activeRpcNetwork, updatedSettings.activeRpcNetwork) try { + // A signer-only chain has no provider to install; simulation is disabled until a configured endpoint is selected. if (rpcEndpointChanged && change.rpcNetwork?.httpsRpc !== undefined) activeServices = resetSimulationServices(change.rpcNetwork) if (updatedSettings.simulationMode && rpcChainChanged) await clearSimulationStateFromConfig() // Publish settings exactly once when committed; access reconciliation later publishes account and icon updates. diff --git a/app/ts/background/popupMessageHandlers.ts b/app/ts/background/popupMessageHandlers.ts index cb3283593..b44a2762d 100644 --- a/app/ts/background/popupMessageHandlers.ts +++ b/app/ts/background/popupMessageHandlers.ts @@ -1,5 +1,4 @@ import { getRpcNetworkChange } from '../utils/rpcNetworkChange.js' -import { queuePopupSimulationRefresh } from './popupSimulationRefreshQueue.js' import { refreshConfirmTransactionSimulation } from './confirmTransactionSimulation.js' import { activateAddressSelection, changeActiveAddressAndChain, changeActiveRpc } from './activeSettings.js' import { getUpdatedSimulationStackSnapshot, getUpdatedSimulationState } from './simulationUpdating.js' @@ -674,8 +673,6 @@ export async function popupChangeActiveRpc(ethereum: EthereumClientService, toke if (await getConfiguredSigningSafe(settings, (await getTabState(tabId)).signerAccounts) !== undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: 'This Safe is tied to its current network. Select your wallet account before switching networks.' } as const const result = await requestSignerChainChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, params.data, tabId) if ('error' in result && result.error !== undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: result.error.message } as const - const activeRpc = (await getSettings()).activeRpcNetwork - if (getRpcNetworkChange(activeRpc, params.data).endpointChanged) return { type: 'PopupSettingsChangeReply', ok: false, message: 'The wallet switched networks, but the active Interceptor network did not change. Please select the network again.' } as const } else { await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, params.data, settings.simulationMode, await getLastKnownCurrentTabId()) } @@ -1287,8 +1284,7 @@ export async function importSimulationStack(ethereum: EthereumClientService, tok } export async function requestCompleteVisualizedSimulation(ethereum: EthereumClientService, tokenPriceService: TokenPriceService) { - await queuePopupSimulationRefresh({ ethereum, tokenPriceService }) - const visualizedSimulatorState = await getPopupVisualisationState() + const visualizedSimulatorState = await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, false, false) return { method: 'popup_requestCompleteVisualizedSimulation' as const, visualizedSimulatorState } } diff --git a/app/ts/background/popupVisualisationUpdater.ts b/app/ts/background/popupVisualisationUpdater.ts index 67b7f0803..c61ed781a 100644 --- a/app/ts/background/popupVisualisationUpdater.ts +++ b/app/ts/background/popupVisualisationUpdater.ts @@ -1,3 +1,4 @@ +import { getSettings } from './settings.js' // Shared execution layer for popup visualization refreshes; the optional interactive queue adds caller-local scheduling, not global ordering. See docs/popup-simulation-refresh.md. import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' @@ -70,7 +71,7 @@ export const updatePopupVisualisationIfNeeded = async (ethereum: EthereumClientS } const isSimulationDataConsumerOpenReply = await requestIsSimulationDataConsumerOpen() if (!(isSimulationDataConsumerOpenReply?.data.isOpen === true)) return popupVisualisation - if (skipIfUnchanged && popupVisualisation.simulationState.kind === 'simulated') { + if (skipIfUnchanged && popupVisualisation.simulationState.kind === 'simulated' && (await getSettings()).activeRpcNetwork.httpsRpc !== undefined) { const currentSimulationInput = await getCurrentSimulationStateInput(ethereum, snapshot) const currentFingerprint = getPopupVisualisationFingerprint(currentSimulationInput.simulationStateInput, currentSimulationInput.rpcNetwork, currentSimulationInput.blockNumber) const cachedFingerprint = getPopupVisualisationFingerprint( diff --git a/app/ts/background/simulationUpdating.ts b/app/ts/background/simulationUpdating.ts index 5cf1dfed5..e0b20a26e 100644 --- a/app/ts/background/simulationUpdating.ts +++ b/app/ts/background/simulationUpdating.ts @@ -141,6 +141,8 @@ export const getCurrentSimulationInput = async (richAddresses?: readonly bigint[ export async function getUpdatedSimulationState(ethereum: EthereumClientService, simulationInput?: SimulationStateInput) { // An unreadable persisted stack must abort refresh, otherwise the simulation fallback could overwrite saved popup results. const currentSimulationInput = simulationInput ?? await getCurrentSimulationInput() + // Signer-only networks have no simulation endpoint; the retained supported provider must not execute their stack. + if ((await getSettings()).activeRpcNetwork.httpsRpc === undefined) return PASSTHROUGH_STATE try { return toResolvedSimulationState(await createSimulationStateWithNonceAndBaseFeeFixing(currentSimulationInput, ethereum)) } catch(error: unknown) { diff --git a/app/ts/background/windows/changeChain.ts b/app/ts/background/windows/changeChain.ts index 4df39fbef..9552bb7f9 100644 --- a/app/ts/background/windows/changeChain.ts +++ b/app/ts/background/windows/changeChain.ts @@ -315,7 +315,14 @@ export async function applyWalletSwitchReply( const requestedRpc = getPendingSignerChainChangeRpc(callbackSignerStateToken, params.chainId) await applyChain(currentSignerStateToken, params.chainId, requestedRpc) const activeRpc = (await getSettings()).activeRpcNetwork - if (requestedRpc !== undefined && !getRpcNetworkChange(activeRpc, requestedRpc).endpointChanged) await promoteRpcAsPrimary(requestedRpc) + if (requestedRpc !== undefined && getRpcNetworkChange(activeRpc, requestedRpc).endpointChanged) { + resolveSignerChainChange(callbackSignerStateToken, { + method: 'popup_signerChangeChainDialog', + data: [{ accept: false, chainId: params.chainId, walletSwitchRequestId: params.walletSwitchRequestId, signerProviderGeneration: params.signerProviderGeneration, error: { code: JSON_RPC_ERROR_CODE_INTERNAL_ERROR, message: 'The wallet switched networks, but Interceptor could not activate the requested network.' } }], + }) + return + } + if (requestedRpc !== undefined) await promoteRpcAsPrimary(requestedRpc) } resolveSignerChainChange(callbackSignerStateToken, { method: 'popup_signerChangeChainDialog', diff --git a/docs/popup-simulation-refresh.md b/docs/popup-simulation-refresh.md index 2d72485bc..2ca3e618b 100644 --- a/docs/popup-simulation-refresh.md +++ b/docs/popup-simulation-refresh.md @@ -6,8 +6,8 @@ | Need | Entry point | Contract | | --- | --- | --- | -| Interactive settings changes, reset, explicit refresh, or requested complete visualization | `queuePopupSimulationRefresh` in `popupSimulationRefreshQueue.ts` | Capture input and rich-count together; share equivalent revisions, keep the latest pending request, carry invalidation forward, and settle each executed entry with its own outcome. Superseded queued requests resolve false. Reset forces invalidation after clearing the stack. | -| New-block updates, throttled editing, or existing flows that require an immediate refresh attempt | `updatePopupVisualisationIfNeeded` | Probe for an open consumer, optionally skip recent/unchanged work, and cancel obsolete cancellable execution. Returns the stored visualization, not a queued caller's success flag. | +| Interactive settings changes, reset, or explicit refresh | `queuePopupSimulationRefresh` in `popupSimulationRefreshQueue.ts` | Capture input and rich-count together; share equivalent revisions, keep the latest pending request, carry invalidation forward, and settle each executed entry with its own outcome. Superseded queued requests resolve false. Reset forces invalidation after clearing the stack. | +| Complete-visualization requests, new-block updates, throttled editing, or existing flows that require an immediate refresh attempt | `updatePopupVisualisationIfNeeded` | Probe for an open consumer, optionally skip recent/unchanged work, and cancel obsolete cancellable execution. Returns the stored visualization, not a queued caller's success flag. | | Bootstrap for an already-open consumer | `refreshPopupVisualisationForOpenConsumer` | Avoid another visibility probe; report unexpected errors and return the stored fallback so other bootstrap data can still load. | | Import/persistence that must observe visualization errors | `updatePopupVisualisationState` | Execute under the same semaphore without visibility/throttling checks; `throwOnUnexpectedError` lets the caller report persistence failure explicitly. | @@ -16,3 +16,5 @@ The direct paths deliberately retain their existing contracts. A block update mu Queue identity and supersession apply only among queue callers. Direct execution may run between queued entries or cancel their underlying cancellable execution. A queue result describes that entry's refresh attempt; it does not promise that the stored visualization remains unchanged afterward. All paths use the execution layer's serialization and storage/publication logic. When adding a trigger, choose the required cancellation, visibility, error, and return-value contract from the table. Changes to visualization execution belong in `popupVisualisationUpdater.ts`; changes to interactive sharing/supersession belong in `popupSimulationRefreshQueue.ts`. + +Signer-only networks keep a supported provider available for a later configured selection, but simulation returns passthrough without executing that provider. Cache-fingerprint checks also skip provider reads on signer-only networks. A missing RPC URL cannot be used to construct replacement RPC services. diff --git a/test/tests/popupClearReset.test.ts b/test/tests/popupClearReset.test.ts index f6ec62764..bea1ca084 100644 --- a/test/tests/popupClearReset.test.ts +++ b/test/tests/popupClearReset.test.ts @@ -390,6 +390,63 @@ const fakeEthereum = createFakeEthereum(rpcNetwork) as never as Parameters[1] describe('popup clear reset', () => { + test('signer-only networks publish passthrough without reading the previous provider', async () => { + browserMock.reset() + const signerOnly: RpcNetwork = { chainId: 99999n, httpsRpc: undefined, name: 'Signer only', currencyName: 'Ether?', currencyTicker: 'ETH?', primary: false, minimized: true } + await browserStorageLocalSet({ activeRpcNetwork: signerOnly, independentActiveSimulationAddress: activeAddress, popupVisualisation: stalePopupVisualisation, interceptorTransactionStack: { operations: [] } }) + const originalBlock = fakeEthereum.getBlock + const originalNumber = fakeEthereum.getBlockNumber + let providerReads = 0 + fakeEthereum.getBlock = async (...args) => { providerReads++; return await originalBlock(...args) } + fakeEthereum.getBlockNumber = async (...args) => { providerReads++; return await originalNumber(...args) } + try { + const result = await updatePopupVisualisationIfNeeded(fakeEthereum, fakeTokenPriceService, false, false, true) + assert.equal(providerReads, 0) + assert.equal(result.simulationState.kind, 'passthrough') + assert.equal(result.simulationUpdatingState, 'done') + assert.equal(result.simulationResultState, 'done') + } finally { + fakeEthereum.getBlock = originalBlock + fakeEthereum.getBlockNumber = originalNumber + } + }) + + test('complete visualization requests do not join a held interactive queue entry', async () => { + browserMock.reset() + await browserStorageLocalSet({ activeRpcNetwork: rpcNetwork, independentActiveSimulationAddress: activeAddress, popupVisualisation: stalePopupVisualisation, interceptorTransactionStack: { operations: [] } }) + const { queuePopupSimulationRefresh } = await import('../../app/ts/background/popupSimulationRefreshQueue.js') + const { requestCompleteVisualizedSimulation } = await import('../../app/ts/background/popupMessageHandlers.js') + const { Future } = await import('../../app/ts/utils/future.js') + const started = new Future() + const release = new Future() + const originalSend = browser.runtime.sendMessage + let held = false + browser.runtime.sendMessage = async message => { + if (typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_isSimulationVisualizerOpen' && !held) { + held = true + started.resolve(undefined) + await release + } + return await originalSend(message) + } + const queued = queuePopupSimulationRefresh({ ethereum: fakeEthereum, tokenPriceService: fakeTokenPriceService, invalidateOldState: true }) + let timeout: ReturnType | undefined + try { + await started + const result = await Promise.race([ + requestCompleteVisualizedSimulation(fakeEthereum, fakeTokenPriceService), + new Promise((_resolve, reject) => { timeout = setTimeout(() => reject(new Error('Complete visualization request joined the held queue')), 1000) }), + ]) + assert.equal(result.visualizedSimulatorState.simulationUpdatingState, 'done') + assert.equal(result.visualizedSimulatorState.simulationResultState, 'done') + } finally { + clearTimeout(timeout) + release.resolve(undefined) + await queued + browser.runtime.sendMessage = originalSend + } + }) + test('keeps the cached popup timestamp when refresh finds no simulation change', async () => { browserMock.reset() await browserStorageLocalSet({ diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index f8fd9fde1..9e0d4e9c1 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -378,7 +378,7 @@ describe('popup settings changes', () => { port.postMessage = message => { postMessage(message) // Simulate delivery before changeActiveRpc has returned its signer token. - if (message.method === 'request_signer_to_wallet_switchEthereumChain') delivery = applyWalletSwitchReply(connections, port, { accept: true, chainId: 2n, walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: token.signerProviderGeneration }, async () => await application.promise) + if (message.method === 'request_signer_to_wallet_switchEthereumChain') delivery = applyWalletSwitchReply(connections, port, { accept: true, chainId: 2n, walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: token.signerProviderGeneration }, async () => { await application.promise; await changeSimulationMode({ simulationMode: false, rpcNetwork: rpc }) }) } } const pending = request(30) @@ -399,7 +399,8 @@ describe('popup settings changes', () => { await new Promise(resolve => setTimeout(resolve, 60)) application.resolve(undefined) await delivery - assert.equal((await pending).result, null) + assert.equal((await pending).error, undefined) + assert.strictEqual((await pending).result, null) } else { assert.match((await pending).error?.message ?? '', /did not answer/) const expiredId = getWalletSwitchRequestId(messages) @@ -436,8 +437,9 @@ describe('popup settings changes', () => { }) } - for (const accept of [true, false]) { - test(`waits for the matching wallet network ${ accept ? 'acceptance' : 'rejection' }`, async () => { + for (const outcome of ['acceptance', 'rejection', 'endpoint mismatch'] as const) { + const accept = outcome !== 'rejection' + test(`waits for the matching wallet network ${ outcome }`, async () => { installBrowserMock() const { changeSimulationMode, getSettings, websiteSocketToString } = await loadModules() const { requestSignerChainChange, applyWalletSwitchReply } = await import('../../app/ts/background/windows/changeChain.js') @@ -460,10 +462,15 @@ describe('popup settings changes', () => { const token = getConfirmedSignerStateToken(connections, 1) if (token === undefined) throw new Error('Expected signer owner') const replyBase = { chainId: rpc.chainId, walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: token.signerProviderGeneration } - await applyWalletSwitchReply(connections, port, accept ? { ...replyBase, accept: true } : { ...replyBase, accept: false, error: { code: 4001, message: 'User rejected network change' } }, async () => undefined) + await applyWalletSwitchReply(connections, port, accept ? { ...replyBase, accept: true } : { ...replyBase, accept: false, error: { code: 4001, message: 'User rejected network change' } }, async () => { if (outcome === 'acceptance') await changeSimulationMode({ simulationMode: false, rpcNetwork: rpc }) }) const result = await pending - if (accept) assert.equal(result.result, null) - else assert.equal(result.error?.message, 'User rejected network change') + if (outcome === 'acceptance') { + assert.equal(result.error, undefined) + assert.strictEqual(result.result, null) + } else if (outcome === 'endpoint mismatch') { + assert.match(result.error?.message ?? '', /could not activate the requested network/) + assert.notEqual((await getSettings()).activeRpcNetwork.httpsRpc, rpc.httpsRpc) + } else assert.equal(result.error?.message, 'User rejected network change') }) } }) From c11997eac078fcc79cd3738bd28ee7446c7aaf26 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Tue, 8 Sep 2026 05:41:56 +0000 Subject: [PATCH 16/31] Resolve signer display from settings and separate wallet switch ownership --- app/ts/background/activeSettings.ts | 4 - app/ts/background/popupMessageHandlers.ts | 5 +- app/ts/background/providerMessageHandlers.ts | 4 +- app/ts/background/walletSwitch.ts | 197 ++++++++++++++++++ app/ts/background/windows/changeChain.ts | 197 +----------------- app/ts/components/App.tsx | 2 +- app/ts/components/activeAddressChange.ts | 3 +- .../hooks/useLiveSimulationHomeData.ts | 5 +- .../hooks/usePopupSettingsChanges.ts | 29 +-- app/ts/types/interceptor-messages.ts | 2 +- app/ts/types/popupSettingsRequests.ts | 2 +- .../backgroundAccountPermissions.test.ts | 5 +- test/tests/popupSettingsChanges.test.ts | 23 +- test/tests/simulationVisualizerOpen.test.tsx | 57 ++++- 14 files changed, 298 insertions(+), 237 deletions(-) create mode 100644 app/ts/background/walletSwitch.ts diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index 73797bce2..a20c2e0fa 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -63,7 +63,6 @@ type ActiveAddressAndChainChange = { signingAddressSelection?: 'signer' | 'safe' rpcNetwork?: RpcNetwork promptForAccessesIfNeeded?: boolean - addressChangeRequestId?: string } type ActiveSettingsTransition = { @@ -120,7 +119,6 @@ async function runActiveSettingsChange( // Publish settings exactly once when committed; access reconciliation later publishes account and icon updates. await sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: updatedSettings, popupRefreshGeneration: bumpPopupRefreshGeneration(), - ...(change.addressChangeRequestId === undefined ? {} : { committedAddressChange: { requestId: change.addressChangeRequestId, activeAddress: change.activeAddress } }), }) } finally { // Persisted settings still need access reconciliation if provider preparation or publication fails. @@ -166,7 +164,6 @@ export async function activateAddressSelection( readonly signerAddress: bigint | undefined readonly rpcNetwork?: RpcNetwork readonly promptForAccessesIfNeeded?: boolean - readonly addressChangeRequestId?: string }, ): Promise { const selectedSafe = selection?.type === 'addressBookEntry' && selection.entry.type === 'safe' ? selection.entry : undefined @@ -180,7 +177,6 @@ export async function activateAddressSelection( return await runActiveSettingsChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { change: { simulationMode: options.simulationMode, - addressChangeRequestId: options.addressChangeRequestId, activeAddress: selection?.type === 'signer' ? selection.address : selection?.entry.address, ...(!options.simulationMode ? { signingAddressSelection: selectedSafe === undefined ? 'signer' as const : 'safe' as const } : {}), ...(options.rpcNetwork === undefined ? {} : { rpcNetwork: options.rpcNetwork }), diff --git a/app/ts/background/popupMessageHandlers.ts b/app/ts/background/popupMessageHandlers.ts index b44a2762d..967a246ea 100644 --- a/app/ts/background/popupMessageHandlers.ts +++ b/app/ts/background/popupMessageHandlers.ts @@ -8,7 +8,8 @@ import { parseEvents, parseInputData } from '../simulation/parsing.js' import { type ChangeActiveAddress, type ModifyMakeMeRich, type ChangePage, type RemoveTransaction, type RequestAccountsFromSigner, type TransactionConfirmation, type InterceptorAccess, type ChangeInterceptorAccess, type ChainChangeConfirmation, type WatchAssetConfirmation, type EnableSimulationMode, type ChangeActiveChain, type AddOrEditAddressBookEntry, type GetAddressBookData, type RemoveAddressBookEntry, type InterceptorAccessRefresh, type InterceptorAccessChangeAddress, type Settings, type ChangeSettings, type UpdateHomePage, type SimulateGovernanceContractExecution, type ChangeAddOrModifyAddressWindowState, type OpenWebPage, type SetEnsNameForHash, UpdateConfirmTransactionDialog, UpdateConfirmTransactionDialogPendingTransactions, type ForceSetGasLimitForTransaction, type ChangePreSimulationBlockTimeManipulation, type SetTransactionOrMessageBlockTimeManipulator, type FetchSimulationStackRequestConfirmation, type ImportSimulationStack, type PopupReadyAndListeningPage } from '../types/interceptor-messages.js' import { formEthSendTransaction, formSendRawTransaction, resolvePendingTransactionOrMessage, updateConfirmTransactionView, setGasLimitForTransaction, toPopupPendingTransactionOrSignableMessage } from './windows/confirmTransaction.js' import { askForSignerAccountsFromSignerIfNotAvailable, getAddressMetadataForAccess, refreshSignerAccountsForTab, refreshSignerAccountsFromApprovedWebsitePorts, requestAddressChange, resolveInterceptorAccess, type SignerAccountRefreshOptions } from './windows/interceptorAccess.js' -import { requestSignerChainChange, resolveChainChange } from './windows/changeChain.js' +import { resolveChainChange } from './windows/changeChain.js' +import { requestSignerChainChange } from './walletSwitch.js' import { updateWebsiteApprovalAccesses } from './accessManagement.js' import { getActiveOrFirstSignerAddress, getHtmlFile, sendPopupMessageToOpenWindows } from './backgroundUtils.js' import { getActiveAddressForCurrentSignerState, sendCallbackToAllConfirmedSignerOwners, sendCallbackToConfirmedSignerOwner } from './signerStateOwnership.js' @@ -233,7 +234,6 @@ export async function changeActiveAddress(ethereum: EthereumClientService, token if (addressChange.data.activeAddress === 'signer') { await activateAddressSelection(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, undefined, { simulationMode: false, - addressChangeRequestId: addressChange.data.addressChangeRequestId, signerAddress: undefined, }) return { type: 'ChangeActiveAddressReply', ok: true } as const @@ -252,7 +252,6 @@ export async function changeActiveAddress(ethereum: EthereumClientService, token } await activateAddressSelection(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, selection, { simulationMode: addressChange.data.simulationMode, - addressChangeRequestId: addressChange.data.addressChangeRequestId, signerAddress: signerAccount, }) return { type: 'ChangeActiveAddressReply', ok: true } as const diff --git a/app/ts/background/providerMessageHandlers.ts b/app/ts/background/providerMessageHandlers.ts index b0ab01760..1b9f37245 100644 --- a/app/ts/background/providerMessageHandlers.ts +++ b/app/ts/background/providerMessageHandlers.ts @@ -7,7 +7,7 @@ import { activateAddressSelection, changeActiveAddressAndChain } from './activeS import { getSocketFromPort, sendInternalWindowMessage, sendPopupMessageToOpenWindows } from './backgroundUtils.js' import { getRpcNetworkForChain, setDefaultSignerName, updatePendingTransactionOrMessage, updateTabState } from './storageVariables.js' import { getMetamaskCompatibilityMode, getSettings } from './settings.js' -import { applyWalletSwitchReply } from './windows/changeChain.js' +import { applyWalletSwitchReply } from './walletSwitch.js' import { type ApprovalState, withSuppressedUnscopedConnectionEventsForSocketAsync } from './accessManagement.js' import type { ProviderMessage } from '../utils/requests.js' import { METAMASK_ERROR_USER_REJECTED_REQUEST } from '../utils/constants.js' @@ -146,7 +146,7 @@ async function changeSignerChain(ethereum: EthereumClientService, tokenPriceServ } if (settings.useSignersAddressAsActiveAddress || !settings.simulationMode) { const rpcNetwork = requestedRpcNetwork ?? (settings.activeRpcNetwork.chainId === signerChain ? settings.activeRpcNetwork : await getRpcNetworkForChain(signerChain)) - if (getRpcNetworkChange(settings.activeRpcNetwork, rpcNetwork).endpointChanged) { + if (getRpcNetworkChange(settings.activeRpcNetwork, rpcNetwork).selectionChanged) { const signerAddress = getWalletSelectedAccount(tabStateChange.newState) await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { simulationMode: settings.simulationMode, diff --git a/app/ts/background/walletSwitch.ts b/app/ts/background/walletSwitch.ts new file mode 100644 index 000000000..c76a38798 --- /dev/null +++ b/app/ts/background/walletSwitch.ts @@ -0,0 +1,197 @@ +import { getSettings } from './settings.js' +import { JSON_RPC_ERROR_CODE_INTERNAL_ERROR, METAMASK_ERROR_USER_REJECTED_REQUEST } from '../utils/constants.js' +import { Future } from '../utils/future.js' +import type { SignerChainChangeConfirmation, WalletSwitchEthereumChainReply } from '../types/interceptor-messages.js' +import type { WebsiteTabConnections } from '../types/user-interface-types.js' +import { changeActiveRpc } from './activeSettings.js' +import { getSocketFromPort } from './backgroundUtils.js' +import { promoteRpcAsPrimary } from './storageVariables.js' +import { getRpcNetworkChange } from '../utils/rpcNetworkChange.js' +import type { RpcNetwork } from '../types/rpc.js' +import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' +import type { TokenPriceService } from '../simulation/services/priceEstimator.js' +import type { ResetSimulationServices } from '../simulation/serviceLifecycle.js' +import { getConfirmedSignerStateToken, runSignerStateOperation, signerConnectionReplacedError, addSignerStateReplacementListener, doSignerStateTokensMatch, signerUnavailableError, type SignerStateToken } from './signerStateOwnership.js' + +type PendingSignerChainChange = { + readonly walletSwitchRequestId: string + readonly future: Future< + | { readonly type: 'reply', readonly confirmation: SignerChainChangeConfirmation } + | { readonly type: 'replacement', readonly error: typeof signerUnavailableError } + | { readonly type: 'timeout' } + > + replyReceived: boolean + timeout: ReturnType | undefined + readonly requestTabId: number + readonly requestedRpcNetwork: RpcNetwork + signerStateToken: SignerStateToken | undefined + readonly repliesBeforeToken: Array<{ readonly signerStateToken: SignerStateToken, readonly confirmation: SignerChainChangeConfirmation }> + readonly replacementsBeforeToken: Array<{ readonly signerStateToken: SignerStateToken, readonly error: typeof signerUnavailableError }> +} + +let pendingSignerChainChange: PendingSignerChainChange | undefined +const WALLET_SWITCH_TIMEOUT_MS = 120_000 + +// Command IDs isolate replies across popup/dapp requests, including retries after a deadline. +function isPendingWalletSwitchRequest(walletSwitchRequestId: string) { + return pendingSignerChainChange?.walletSwitchRequestId === walletSwitchRequestId +} + +function markSignerChainReplyReceived(token: SignerStateToken, chainId: bigint, walletSwitchRequestId: string) { + const pending = pendingSignerChainChange + if (pending !== undefined && pending.walletSwitchRequestId === walletSwitchRequestId && doesPendingSignerChainChangeMatch(pending, token, chainId)) { + pending.replyReceived = true + clearTimeout(pending.timeout) + } +} + +export const isSignerChainChangePending = () => pendingSignerChainChange !== undefined + +function doesPendingSignerChainChangeMatch(pending: PendingSignerChainChange, signerStateToken: SignerStateToken, chainId: bigint) { + if (pending.requestedRpcNetwork.chainId !== chainId) return false + return pending.signerStateToken === undefined + ? pending.requestTabId === signerStateToken.socket.tabId + : doSignerStateTokensMatch(pending.signerStateToken, signerStateToken) +} + +function getPendingSignerChainChangeTokenForCallback(port: browser.runtime.Port, signerProviderGeneration: number, chainId: bigint) { + const signerStateToken = pendingSignerChainChange?.signerStateToken + if (signerStateToken === undefined || pendingSignerChainChange?.requestedRpcNetwork.chainId !== chainId) return undefined + if (signerStateToken.port !== port || signerStateToken.signerProviderGeneration !== signerProviderGeneration) return undefined + return signerStateToken +} + +function isPendingSignerChainChangeReply(signerStateToken: SignerStateToken, chainId: bigint) { + return pendingSignerChainChange !== undefined && doesPendingSignerChainChangeMatch(pendingSignerChainChange, signerStateToken, chainId) +} + +// Keep the requested endpoint in memory until the matching wallet accepts; a rejected request must not change RPC preferences. +function getPendingSignerChainChangeRpc(signerStateToken: SignerStateToken, chainId: bigint) { + const pending = pendingSignerChainChange + return pending !== undefined && doesPendingSignerChainChangeMatch(pending, signerStateToken, chainId) ? pending.requestedRpcNetwork : undefined +} + +function resolveSignerChainChange(signerStateToken: SignerStateToken, confirmation: SignerChainChangeConfirmation) { + if (!isPendingWalletSwitchRequest(confirmation.data[0].walletSwitchRequestId)) return false + markSignerChainReplyReceived(signerStateToken, confirmation.data[0].chainId, confirmation.data[0].walletSwitchRequestId) + const pending = pendingSignerChainChange + if (pending === undefined || !doesPendingSignerChainChangeMatch(pending, signerStateToken, confirmation.data[0].chainId)) return false + if (pending.signerStateToken === undefined) { + pending.repliesBeforeToken.push({ signerStateToken, confirmation }) + return true + } + pending.future.resolve({ type: 'reply', confirmation }) + return true +} + +export async function requestSignerChainChange(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, requestTabId: number, timeoutMs = WALLET_SWITCH_TIMEOUT_MS) { + if (pendingSignerChainChange !== undefined) return { error: { code: -32002, message: 'A network switch is already waiting for your wallet.' } } + const pending: PendingSignerChainChange = { + walletSwitchRequestId: crypto.randomUUID(), + replyReceived: false, + timeout: undefined, + future: new Future< + | { readonly type: 'reply', readonly confirmation: SignerChainChangeConfirmation } + | { readonly type: 'replacement', readonly error: typeof signerUnavailableError } + | { readonly type: 'timeout' } + >(), + requestTabId: requestTabId, + requestedRpcNetwork: rpcNetwork, + signerStateToken: undefined, + repliesBeforeToken: [], + replacementsBeforeToken: [], + } + const removeReplacementListener = addSignerStateReplacementListener((signerStateToken, error) => { + if (pending.signerStateToken === undefined) { + pending.replacementsBeforeToken.push({ signerStateToken, error }) + return + } + if (doSignerStateTokensMatch(pending.signerStateToken, signerStateToken)) pending.future.resolve({ type: 'replacement', error }) + }) + pendingSignerChainChange = pending + try { + const changeActiveRpcResult = await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, rpcNetwork, false, requestTabId, pending.walletSwitchRequestId) + if (changeActiveRpcResult.type !== 'signerRequestSent') { + return changeActiveRpcResult.type === 'signerRequestNotNeeded' + ? { result: null } as const + : { error: signerUnavailableError } as const + } + pending.signerStateToken = changeActiveRpcResult.signerStateToken + if (!pending.replyReceived) pending.timeout = setTimeout(() => { + pending.future.resolve({ type: 'timeout' }) + }, timeoutMs) + const precedingReply = pending.repliesBeforeToken.find(({ signerStateToken, confirmation }) => { + return doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, signerStateToken) + && confirmation.data[0].chainId === pending.requestedRpcNetwork.chainId + }) + if (precedingReply !== undefined) pending.future.resolve({ type: 'reply', confirmation: precedingReply.confirmation }) + const precedingReplacement = pending.replacementsBeforeToken.find(({ signerStateToken }) => doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, signerStateToken)) + if (precedingReplacement !== undefined) pending.future.resolve({ type: 'replacement', error: precedingReplacement.error }) + const signerResult = await pending.future + if (signerResult.type === 'timeout') return { error: { code: -32002, message: 'Your wallet did not answer the network request in time. You can retry or change other settings. Your wallet may still show the previous request.' } } + if (signerResult.type === 'replacement') return { error: signerResult.error } as const + if (signerResult.confirmation.data[0].accept === false) return { error: signerResult.confirmation.data[0].error } as const // forward signers error to the application + if (signerResult.confirmation.data[0].chainId === rpcNetwork.chainId) return { result: null } + } finally { + clearTimeout(pending.timeout) + removeReplacementListener() + if (pendingSignerChainChange === pending) pendingSignerChainChange = undefined + } + return { error: { code: METAMASK_ERROR_USER_REJECTED_REQUEST, message: 'User denied the chain change.' } } +} + +function rejectWalletSwitchReply(token: SignerStateToken, params: WalletSwitchEthereumChainReply['params'][0], error: { readonly code: number, readonly message: string }) { + resolveSignerChainChange(token, { + method: 'popup_signerChangeChainDialog', + data: [{ ...params, accept: false, error }], + }) +} + +// Own reply matching, deadline cancellation and settlement together, including failures while applying wallet state. +export async function applyWalletSwitchReply( + websiteTabConnections: WebsiteTabConnections, + port: browser.runtime.Port, + params: WalletSwitchEthereumChainReply['params'][0], + applyChain: (token: SignerStateToken, chainId: bigint, rpc: RpcNetwork | undefined) => Promise, +) { + const socket = getSocketFromPort(port) + if (socket === undefined) return + await runSignerStateOperation(websiteTabConnections, socket.tabId, async () => { + const currentSignerStateToken = getConfirmedSignerStateToken(websiteTabConnections, socket.tabId) + if (currentSignerStateToken?.socket.connectionName !== socket.connectionName || currentSignerStateToken.port !== port) return + if (!isPendingWalletSwitchRequest(params.walletSwitchRequestId)) return + const pendingSignerStateToken = getPendingSignerChainChangeTokenForCallback(port, params.signerProviderGeneration, params.chainId) + const callbackSignerStateToken = pendingSignerStateToken + ?? (currentSignerStateToken.signerProviderGeneration === params.signerProviderGeneration ? currentSignerStateToken : undefined) + if (callbackSignerStateToken === undefined) return + const solicitedReply = isPendingSignerChainChangeReply(callbackSignerStateToken, params.chainId) + // Only this command's owner and chain may apply its reply. Unsolicited chain events use signerChainChanged. + if (!solicitedReply) return + if (currentSignerStateToken.signerProviderGeneration !== params.signerProviderGeneration) { + rejectWalletSwitchReply(callbackSignerStateToken, params, signerConnectionReplacedError) + return + } + markSignerChainReplyReceived(callbackSignerStateToken, params.chainId, params.walletSwitchRequestId) + try { + if (params.accept) { + const requestedRpc = getPendingSignerChainChangeRpc(callbackSignerStateToken, params.chainId) + await applyChain(currentSignerStateToken, params.chainId, requestedRpc) + const activeRpc = (await getSettings()).activeRpcNetwork + if (requestedRpc !== undefined && getRpcNetworkChange(activeRpc, requestedRpc).endpointChanged) { + rejectWalletSwitchReply(callbackSignerStateToken, params, { code: JSON_RPC_ERROR_CODE_INTERNAL_ERROR, message: 'The wallet switched networks, but Interceptor could not activate the requested network.' }) + return + } + if (requestedRpc !== undefined) await promoteRpcAsPrimary(requestedRpc) + } + resolveSignerChainChange(callbackSignerStateToken, { + method: 'popup_signerChangeChainDialog', + data: [params], + }) + } catch (error) { + // Delivery ended the wallet deadline; a failure while applying the reply must also release the waiting popup. + rejectWalletSwitchReply(callbackSignerStateToken, params, { code: JSON_RPC_ERROR_CODE_INTERNAL_ERROR, message: 'The wallet replied, but updating the selected network failed. Refresh the popup and try again.' }) + throw error + } + return + }) +} diff --git a/app/ts/background/windows/changeChain.ts b/app/ts/background/windows/changeChain.ts index 9552bb7f9..9eae3bca9 100644 --- a/app/ts/background/windows/changeChain.ts +++ b/app/ts/background/windows/changeChain.ts @@ -1,12 +1,11 @@ -import { getSettings } from '../settings.js' -import { JSON_RPC_ERROR_CODE_INTERNAL_ERROR, METAMASK_ERROR_USER_REJECTED_REQUEST } from '../../utils/constants.js' +import { isSignerChainChangePending, requestSignerChainChange } from '../walletSwitch.js' +import { METAMASK_ERROR_USER_REJECTED_REQUEST } from '../../utils/constants.js' import { Future } from '../../utils/future.js' -import type { ChainChangeConfirmation, SignerChainChangeConfirmation, WalletSwitchEthereumChainReply } from '../../types/interceptor-messages.js' +import type { ChainChangeConfirmation } from '../../types/interceptor-messages.js' import type { WebsiteTabConnections } from '../../types/user-interface-types.js' import { changeActiveRpc } from '../activeSettings.js' -import { getHtmlFile, getSocketFromPort, sendPopupMessageToOpenWindows } from '../backgroundUtils.js' -import { getChainChangeConfirmationPromise, getRpcNetworkForChain, promoteRpcAsPrimary, setChainChangeConfirmationPromise } from '../storageVariables.js' -import { getRpcNetworkChange } from '../../utils/rpcNetworkChange.js' +import { getHtmlFile, sendPopupMessageToOpenWindows } from '../backgroundUtils.js' +import { getChainChangeConfirmationPromise, getRpcNetworkForChain, setChainChangeConfirmationPromise } from '../storageVariables.js' import type { RpcNetwork } from '../../types/rpc.js' import { type InterceptedRequest, type UniqueRequestIdentifier, doesUniqueRequestIdentifiersMatch } from '../../utils/requests.js' import { replyToInterceptedRequest } from '../messageSending.js' @@ -16,42 +15,9 @@ import type { EthereumClientService } from '../../simulation/services/EthereumCl import type { TokenPriceService } from '../../simulation/services/priceEstimator.js' import type { ResetSimulationServices } from '../../simulation/serviceLifecycle.js' import { type PopupOrTab, addWindowTabListeners, closePopupOrTabById, getPopupOrTabById, openPopupOrTab, removeWindowTabListeners } from '../../utils/popupOrTab.js' -import { getConfirmedSignerStateToken, runSignerStateOperation, signerConnectionReplacedError, addSignerStateReplacementListener, doSignerStateTokensMatch, signerUnavailableError, type SignerStateToken } from '../signerStateOwnership.js' let pendForUserReply: Future | undefined -type PendingSignerChainChange = { - readonly walletSwitchRequestId: string - readonly future: Future< - | { readonly type: 'reply', readonly confirmation: SignerChainChangeConfirmation } - | { readonly type: 'replacement', readonly error: typeof signerUnavailableError } - | { readonly type: 'timeout' } - > - replyReceived: boolean - timeout: ReturnType | undefined - readonly requestTabId: number - readonly requestedRpcNetwork: RpcNetwork - signerStateToken: SignerStateToken | undefined - readonly repliesBeforeToken: Array<{ readonly signerStateToken: SignerStateToken, readonly confirmation: SignerChainChangeConfirmation }> - readonly replacementsBeforeToken: Array<{ readonly signerStateToken: SignerStateToken, readonly error: typeof signerUnavailableError }> -} - -let pendingSignerChainChange: PendingSignerChainChange | undefined -const WALLET_SWITCH_TIMEOUT_MS = 120_000 - -// Command IDs isolate replies across popup/dapp requests, including retries after a deadline. -function isPendingWalletSwitchRequest(walletSwitchRequestId: string) { - return pendingSignerChainChange?.walletSwitchRequestId === walletSwitchRequestId -} - -function markSignerChainReplyReceived(token: SignerStateToken, chainId: bigint, walletSwitchRequestId: string) { - const pending = pendingSignerChainChange - if (pending !== undefined && pending.walletSwitchRequestId === walletSwitchRequestId && doesPendingSignerChainChangeMatch(pending, token, chainId)) { - pending.replyReceived = true - clearTimeout(pending.timeout) - } -} - let chainChangeResolutionInProgress = false let openedDialog: PopupOrTab | undefined @@ -91,43 +57,6 @@ async function runExclusiveChainChangeResolution(resolution: () => Promise } } -function doesPendingSignerChainChangeMatch(pending: PendingSignerChainChange, signerStateToken: SignerStateToken, chainId: bigint) { - if (pending.requestedRpcNetwork.chainId !== chainId) return false - return pending.signerStateToken === undefined - ? pending.requestTabId === signerStateToken.socket.tabId - : doSignerStateTokensMatch(pending.signerStateToken, signerStateToken) -} - -function getPendingSignerChainChangeTokenForCallback(port: browser.runtime.Port, signerProviderGeneration: number, chainId: bigint) { - const signerStateToken = pendingSignerChainChange?.signerStateToken - if (signerStateToken === undefined || pendingSignerChainChange?.requestedRpcNetwork.chainId !== chainId) return undefined - if (signerStateToken.port !== port || signerStateToken.signerProviderGeneration !== signerProviderGeneration) return undefined - return signerStateToken -} - -function isPendingSignerChainChangeReply(signerStateToken: SignerStateToken, chainId: bigint) { - return pendingSignerChainChange !== undefined && doesPendingSignerChainChangeMatch(pendingSignerChainChange, signerStateToken, chainId) -} - -// Keep the requested endpoint in memory until the matching wallet accepts; a rejected request must not change RPC preferences. -function getPendingSignerChainChangeRpc(signerStateToken: SignerStateToken, chainId: bigint) { - const pending = pendingSignerChainChange - return pending !== undefined && doesPendingSignerChainChangeMatch(pending, signerStateToken, chainId) ? pending.requestedRpcNetwork : undefined -} - -function resolveSignerChainChange(signerStateToken: SignerStateToken, confirmation: SignerChainChangeConfirmation) { - if (!isPendingWalletSwitchRequest(confirmation.data[0].walletSwitchRequestId)) return false - markSignerChainReplyReceived(signerStateToken, confirmation.data[0].chainId, confirmation.data[0].walletSwitchRequestId) - const pending = pendingSignerChainChange - if (pending === undefined || !doesPendingSignerChainChangeMatch(pending, signerStateToken, confirmation.data[0].chainId)) return false - if (pending.signerStateToken === undefined) { - pending.repliesBeforeToken.push({ signerStateToken, confirmation }) - return true - } - pending.future.resolve({ type: 'reply', confirmation }) - return true -} - function rejectMessage(rpcNetwork: RpcNetwork, uniqueRequestIdentifier: UniqueRequestIdentifier) { return { method: 'popup_changeChainDialog', @@ -156,7 +85,7 @@ export const openChangeChainDialog = async ( website: Website, params: SwitchEthereumChainParams, ) => { - if (openedDialog !== undefined || pendForUserReply || pendingSignerChainChange || chainChangeResolutionInProgress) return userDeniedChange + if (openedDialog !== undefined || pendForUserReply || isSignerChainChangePending() || chainChangeResolutionInProgress) return userDeniedChange pendForUserReply = new Future() @@ -225,117 +154,3 @@ async function resolve(ethereum: EthereumClientService, tokenPriceService: Token } return userDeniedChange } - -export async function requestSignerChainChange(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, requestTabId: number, timeoutMs = WALLET_SWITCH_TIMEOUT_MS) { - if (pendingSignerChainChange !== undefined) return { error: { code: -32002, message: 'A network switch is already waiting for your wallet.' } } - const pending: PendingSignerChainChange = { - walletSwitchRequestId: crypto.randomUUID(), - replyReceived: false, - timeout: undefined, - future: new Future< - | { readonly type: 'reply', readonly confirmation: SignerChainChangeConfirmation } - | { readonly type: 'replacement', readonly error: typeof signerUnavailableError } - | { readonly type: 'timeout' } - >(), - requestTabId: requestTabId, - requestedRpcNetwork: rpcNetwork, - signerStateToken: undefined, - repliesBeforeToken: [], - replacementsBeforeToken: [], - } - const removeReplacementListener = addSignerStateReplacementListener((signerStateToken, error) => { - if (pending.signerStateToken === undefined) { - pending.replacementsBeforeToken.push({ signerStateToken, error }) - return - } - if (doSignerStateTokensMatch(pending.signerStateToken, signerStateToken)) pending.future.resolve({ type: 'replacement', error }) - }) - pendingSignerChainChange = pending - try { - const changeActiveRpcResult = await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, rpcNetwork, false, requestTabId, pending.walletSwitchRequestId) - if (changeActiveRpcResult.type !== 'signerRequestSent') { - return changeActiveRpcResult.type === 'signerRequestNotNeeded' - ? { result: null } as const - : { error: signerUnavailableError } as const - } - pending.signerStateToken = changeActiveRpcResult.signerStateToken - if (!pending.replyReceived) pending.timeout = setTimeout(() => { - pending.future.resolve({ type: 'timeout' }) - }, timeoutMs) - const precedingReply = pending.repliesBeforeToken.find(({ signerStateToken, confirmation }) => { - return doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, signerStateToken) - && confirmation.data[0].chainId === pending.requestedRpcNetwork.chainId - }) - if (precedingReply !== undefined) pending.future.resolve({ type: 'reply', confirmation: precedingReply.confirmation }) - const precedingReplacement = pending.replacementsBeforeToken.find(({ signerStateToken }) => doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, signerStateToken)) - if (precedingReplacement !== undefined) pending.future.resolve({ type: 'replacement', error: precedingReplacement.error }) - const signerResult = await pending.future - if (signerResult.type === 'timeout') return { error: { code: -32002, message: 'Your wallet did not answer the network request in time. You can retry or change other settings. Your wallet may still show the previous request.' } } - if (signerResult.type === 'replacement') return { error: signerResult.error } as const - if (signerResult.confirmation.data[0].accept === false) return { error: signerResult.confirmation.data[0].error } as const // forward signers error to the application - if (signerResult.confirmation.data[0].chainId === rpcNetwork.chainId) return { result: null } - } finally { - clearTimeout(pending.timeout) - removeReplacementListener() - if (pendingSignerChainChange === pending) pendingSignerChainChange = undefined - } - return userDeniedChange -} - -// Own reply matching, deadline cancellation and settlement together, including failures while applying wallet state. -export async function applyWalletSwitchReply( - websiteTabConnections: WebsiteTabConnections, - port: browser.runtime.Port, - params: WalletSwitchEthereumChainReply['params'][0], - applyChain: (token: SignerStateToken, chainId: bigint, rpc: RpcNetwork | undefined) => Promise, -) { - const socket = getSocketFromPort(port) - if (socket === undefined) return - await runSignerStateOperation(websiteTabConnections, socket.tabId, async () => { - const currentSignerStateToken = getConfirmedSignerStateToken(websiteTabConnections, socket.tabId) - if (currentSignerStateToken?.socket.connectionName !== socket.connectionName || currentSignerStateToken.port !== port) return - if (!isPendingWalletSwitchRequest(params.walletSwitchRequestId)) return - const pendingSignerStateToken = getPendingSignerChainChangeTokenForCallback(port, params.signerProviderGeneration, params.chainId) - const callbackSignerStateToken = pendingSignerStateToken - ?? (currentSignerStateToken.signerProviderGeneration === params.signerProviderGeneration ? currentSignerStateToken : undefined) - if (callbackSignerStateToken === undefined) return - const solicitedReply = isPendingSignerChainChangeReply(callbackSignerStateToken, params.chainId) - // Only this command's owner and chain may apply its reply. Unsolicited chain events use signerChainChanged. - if (!solicitedReply) return - if (currentSignerStateToken.signerProviderGeneration !== params.signerProviderGeneration) { - resolveSignerChainChange(callbackSignerStateToken, { - method: 'popup_signerChangeChainDialog', - data: [{ accept: false, chainId: params.chainId, walletSwitchRequestId: params.walletSwitchRequestId, error: signerConnectionReplacedError, signerProviderGeneration: params.signerProviderGeneration }], - }) - return - } - markSignerChainReplyReceived(callbackSignerStateToken, params.chainId, params.walletSwitchRequestId) - try { - if (params.accept) { - const requestedRpc = getPendingSignerChainChangeRpc(callbackSignerStateToken, params.chainId) - await applyChain(currentSignerStateToken, params.chainId, requestedRpc) - const activeRpc = (await getSettings()).activeRpcNetwork - if (requestedRpc !== undefined && getRpcNetworkChange(activeRpc, requestedRpc).endpointChanged) { - resolveSignerChainChange(callbackSignerStateToken, { - method: 'popup_signerChangeChainDialog', - data: [{ accept: false, chainId: params.chainId, walletSwitchRequestId: params.walletSwitchRequestId, signerProviderGeneration: params.signerProviderGeneration, error: { code: JSON_RPC_ERROR_CODE_INTERNAL_ERROR, message: 'The wallet switched networks, but Interceptor could not activate the requested network.' } }], - }) - return - } - if (requestedRpc !== undefined) await promoteRpcAsPrimary(requestedRpc) - } - resolveSignerChainChange(callbackSignerStateToken, { - method: 'popup_signerChangeChainDialog', - data: [params], - }) - } catch (error) { - // Delivery ended the wallet deadline; a failure while applying the reply must also release the waiting popup. - resolveSignerChainChange(callbackSignerStateToken, { - method: 'popup_signerChangeChainDialog', - data: [{ accept: false, chainId: params.chainId, walletSwitchRequestId: params.walletSwitchRequestId, signerProviderGeneration: params.signerProviderGeneration, error: { code: JSON_RPC_ERROR_CODE_INTERNAL_ERROR, message: 'The wallet replied, but updating the selected network failed. Refresh the popup and try again.' } }], - }) - throw error - } - return - }) -} diff --git a/app/ts/components/App.tsx b/app/ts/components/App.tsx index 882e95cc8..b39e85065 100644 --- a/app/ts/components/App.tsx +++ b/app/ts/components/App.tsx @@ -70,7 +70,7 @@ export function App() { }, }) const boundaryResetKey = useSignal(0) - const { isActiveAddressChanging, isActiveAddressChangePending, isSettingsChangePending, sharedStatusLabel, setActiveAddressAndInformAboutIt, setActiveRpcAndInformAboutIt, setSimulationMode, setRichState } = usePopupSettingsChanges({ isSettingsLoaded, activeAddresses, simulationMode, rpcNetwork, tabState, displayedSigningAddress }) + const { isActiveAddressChanging, isActiveAddressChangePending, isSettingsChangePending, sharedStatusLabel, setActiveAddressAndInformAboutIt, setActiveRpcAndInformAboutIt, setSimulationMode, setRichState } = usePopupSettingsChanges({ isSettingsLoaded, activeAddresses, simulationMode, rpcNetwork, tabState }) useEffect(() => { markPerformanceOnce(POPUP_PERFORMANCE_MARKS.homeFirstCommit) diff --git a/app/ts/components/activeAddressChange.ts b/app/ts/components/activeAddressChange.ts index e8a84e7d2..403cf6221 100644 --- a/app/ts/components/activeAddressChange.ts +++ b/app/ts/components/activeAddressChange.ts @@ -6,9 +6,8 @@ export async function requestActiveAddressChange( activeAddress: bigint | 'signer', simulationMode: boolean, sendMessage: (message: ChangeActiveAddress) => Promise = sendPopupMessageWithReply, - addressChangeRequestId?: string, ) { - const reply = await sendMessage({ method: 'popup_changeActiveAddress', data: { activeAddress, simulationMode, ...(addressChangeRequestId === undefined ? {} : { addressChangeRequestId }) } }) + const reply = await sendMessage({ method: 'popup_changeActiveAddress', data: { activeAddress, simulationMode } }) if (reply === undefined) throw new Error(getMissingPopupReplyErrorMessage('Changing the active address')) if (!reply.ok) throw new Error(reply.message) } diff --git a/app/ts/components/hooks/useLiveSimulationHomeData.ts b/app/ts/components/hooks/useLiveSimulationHomeData.ts index 9986f72d8..9a3926ec4 100644 --- a/app/ts/components/hooks/useLiveSimulationHomeData.ts +++ b/app/ts/components/hooks/useLiveSimulationHomeData.ts @@ -1,3 +1,4 @@ +import { getWalletSelectedAccount } from '../../utils/activeAddressSelection.js' import { useEffect } from 'preact/hooks' import { MessageToPopup, type HomePageBootstrap, type UpdateHomePage, type Settings } from '../../types/interceptor-messages.js' import type { RpcConnectionStatus, TabIconDetails, TabState } from '../../types/user-interface-types.js' @@ -242,10 +243,12 @@ export function useLiveSimulationHomeData(options: LiveSimulationHomeDataOptions case 'popup_settingsUpdated': { if (shouldIgnoreOutdatedPopupRefreshMessage(parsed.popupRefreshGeneration, Math.max(popupRefreshGeneration.value, pendingPopupRefreshGeneration.value))) return undefined const rpcChanged = getRpcNetworkChange(rpcNetwork.value, parsed.data.activeRpcNetwork).endpointChanged + const simulationAddressChanged = activeSimulationAddress.value !== parsed.data.activeSimulationAddress const previousActiveStackContext = getCurrentActiveStackContext() const updatedActiveStackContext = getActiveStackContext(parsed.data) updateHomePageSettings(parsed.data) - if (rpcChanged || parsed.committedAddressChange !== undefined || previousActiveStackContext === undefined || !activeStackContextsEqual(previousActiveStackContext, updatedActiveStackContext)) { + if (!parsed.data.simulationMode) displayedSigningAddress.value = parsed.data.activeSigningSafeAddress ?? getWalletSelectedAccount(tabState.value) + if (rpcChanged || simulationAddressChanged || previousActiveStackContext === undefined || !activeStackContextsEqual(previousActiveStackContext, updatedActiveStackContext)) { simVisResults.value = PASSTHROUGH_STATE simulationUpdatingState.value = undefined simulationResultState.value = undefined diff --git a/app/ts/components/hooks/usePopupSettingsChanges.ts b/app/ts/components/hooks/usePopupSettingsChanges.ts index 8faa0a077..5551f2a3d 100644 --- a/app/ts/components/hooks/usePopupSettingsChanges.ts +++ b/app/ts/components/hooks/usePopupSettingsChanges.ts @@ -18,15 +18,15 @@ const popupSettingsOperationLabels: Readonly, 'isSettingsLoaded' | 'activeAddresses' | 'simulationMode' | 'rpcNetwork' | 'tabState' | 'displayedSigningAddress'> +type SettingsChangeHomeData = Pick, 'isSettingsLoaded' | 'activeAddresses' | 'simulationMode' | 'rpcNetwork' | 'tabState'> -export function usePopupSettingsChanges({ isSettingsLoaded, activeAddresses, simulationMode, rpcNetwork, tabState, displayedSigningAddress }: SettingsChangeHomeData) { - const pendingAddressChangeRequestId = useSignal(undefined) +export function usePopupSettingsChanges({ isSettingsLoaded, activeAddresses, simulationMode, rpcNetwork, tabState }: SettingsChangeHomeData) { + const pendingAddressSelection = useSignal<{ address: bigint | 'signer', simulationMode: boolean } | undefined>(undefined) const isActiveAddressChanging = useSignal(false) // Local state covers dispatch latency; shared status coordinates other and reopened popups. const pendingSettingsChange = useSignal(false) const backgroundSettingsChange = useSignal({ revision: 0, operation: undefined }) - const isActiveAddressChangePending = useComputed(() => pendingAddressChangeRequestId.value !== undefined) + const isActiveAddressChangePending = useComputed(() => pendingAddressSelection.value !== undefined) const sharedStatusLabel = useComputed(() => !pendingSettingsChange.value && !isActiveAddressChangePending.value && backgroundSettingsChange.value.operation !== undefined ? popupSettingsOperationLabels[backgroundSettingsChange.value.operation] : undefined) const isSettingsChangePending = useComputed(() => isActiveAddressChangePending.value || pendingSettingsChange.value || backgroundSettingsChange.value.operation !== undefined) @@ -35,17 +35,16 @@ export function usePopupSettingsChanges({ isSettingsLoaded, activeAddresses, sim if (isSettingsChangePending.value) throw new Error('A settings change is already in progress. Please wait for it to finish.') const selectableAddresses = includePersistedAddressBookEntry(activeAddresses.value, persistedEntry) if (!isActiveAddressSelectionAllowed(address, selectableAddresses, simulationMode.value, rpcNetwork.value?.chainId, tabState.value?.signerAccounts ?? [])) return - const requestId = crypto.randomUUID() - pendingAddressChangeRequestId.value = requestId + pendingAddressSelection.value = { address, simulationMode: simulationMode.value } isActiveAddressChanging.value = true try { - await requestActiveAddressChange(address, simulationMode.value, undefined, requestId) + await requestActiveAddressChange(address, simulationMode.value) // Recover a missed commit notification from current background state, never from the original selection. if (isActiveAddressChanging.value) { await sendPopupMessageToBackgroundPage({ method: 'popup_requestNewHomeData', data: { refreshSignerAccounts: false, includeWebsiteAccessAddressMetadata: true } }) } } finally { - pendingAddressChangeRequestId.value = undefined + pendingAddressSelection.value = undefined isActiveAddressChanging.value = false } } @@ -84,10 +83,16 @@ export function usePopupSettingsChanges({ isSettingsLoaded, activeAddresses, sim if (update.popupRefreshGeneration < latestSettingsGeneration) return latestSettingsGeneration = update.popupRefreshGeneration } - if (update.method !== 'popup_settingsUpdated' || update.committedAddressChange === undefined) return - const { requestId, activeAddress } = update.committedAddressChange - if (pendingAddressChangeRequestId.value !== requestId) return - if (!update.data.simulationMode) displayedSigningAddress.value = activeAddress + const pending = pendingAddressSelection.value + if (update.method !== 'popup_settingsUpdated' || pending === undefined || !isActiveAddressChanging.value) return + const settings = update.data + if (settings.simulationMode !== pending.simulationMode) return + // Reveal canonical settings as soon as they match the selection; the request reply still owns completion and errors. + const selectedAddress = settings.simulationMode ? settings.activeSimulationAddress : settings.activeSigningSafeAddress + const matchesSelection = pending.address === 'signer' + ? settings.simulationMode ? settings.useSignersAddressAsActiveAddress : settings.activeSigningSafeAddress === undefined + : selectedAddress === pending.address + if (!matchesSelection) return isActiveAddressChanging.value = false } browser.runtime.onMessage.addListener(listener) diff --git a/app/ts/types/interceptor-messages.ts b/app/ts/types/interceptor-messages.ts index 442651d76..a17ec7089 100644 --- a/app/ts/types/interceptor-messages.ts +++ b/app/ts/types/interceptor-messages.ts @@ -774,7 +774,7 @@ const SettingsUpdated = funtypes.ReadonlyObject({ method: funtypes.Literal('popup_settingsUpdated'), data: Settings, popupRefreshGeneration: PopupRefreshGeneration, -}).And(funtypes.ReadonlyPartial({ committedAddressChange: funtypes.ReadonlyObject({ requestId: funtypes.String, activeAddress: OptionalEthereumAddress }) })) +}) type PartiallyParsedSimulateExecutionReply = funtypes.Static const PartiallyParsedSimulateExecutionReply = funtypes.ReadonlyObject({ diff --git a/app/ts/types/popupSettingsRequests.ts b/app/ts/types/popupSettingsRequests.ts index c0d13dfa0..787550e07 100644 --- a/app/ts/types/popupSettingsRequests.ts +++ b/app/ts/types/popupSettingsRequests.ts @@ -29,7 +29,7 @@ export const ChangeActiveAddress = funtypes.ReadonlyObject({ data: funtypes.ReadonlyObject({ simulationMode: funtypes.Boolean, activeAddress: funtypes.Union(EthereumAddress, funtypes.Literal('signer')), - }).And(funtypes.ReadonlyPartial({ addressChangeRequestId: funtypes.String })) + }) }).asReadonly() export type PopupSettingsRequest = ModifyMakeMeRich | EnableSimulationMode | ChangeActiveChain | ChangeActiveAddress diff --git a/test/tests/backgroundAccountPermissions.test.ts b/test/tests/backgroundAccountPermissions.test.ts index b2a1143d5..b46fd4c49 100644 --- a/test/tests/backgroundAccountPermissions.test.ts +++ b/test/tests/backgroundAccountPermissions.test.ts @@ -26,17 +26,16 @@ describe('background eth_accounts', () => { let completed = false const change = changeActiveAddress(ethereum, tokenPriceService, resetSimulationServices, new Map(), { method: 'popup_changeActiveAddress', - data: { activeAddress: nextAddress, simulationMode: true, addressChangeRequestId: 'test-switch' }, + data: { activeAddress: nextAddress, simulationMode: true }, }).then((reply) => { completed = true; return reply }) try { await permissionWorkStarted.promise assert.equal(completed, false) assert.equal((await getSettings()).activeSimulationAddress, nextAddress) - const committed = runtimeMessages.map((message) => MessageToPopup.safeParse(message)).find((parsed) => parsed.success && parsed.value.method === 'popup_settingsUpdated' && parsed.value.committedAddressChange?.requestId === 'test-switch') + const committed = runtimeMessages.map((message) => MessageToPopup.safeParse(message)).find((parsed) => parsed.success && parsed.value.method === 'popup_settingsUpdated') assert.ok(committed?.success && committed.value.method === 'popup_settingsUpdated') if (committed?.success && committed.value.method === 'popup_settingsUpdated') { assert.equal(committed.value.data.activeSimulationAddress, nextAddress) - assert.equal(committed.value.committedAddressChange?.activeAddress, nextAddress) } } finally { releasePermissionWork.resolve(undefined) diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index 9e0d4e9c1..ac2401d67 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -110,7 +110,7 @@ describe('popup settings changes', () => { const { changeSimulationMode, getSettings, saveCurrentTabId, websiteSocketToString } = await loadModules() const { dispatchPopupMessage } = await import('../../app/ts/background/popupMessageDispatcher.js') const { getConfirmedSignerStateToken } = await import('../../app/ts/background/signerStateOwnership.js') - const { applyWalletSwitchReply } = await import('../../app/ts/background/windows/changeChain.js') + const { applyWalletSwitchReply } = await import('../../app/ts/background/walletSwitch.js') await changeSimulationMode({ simulationMode: false }) await saveCurrentTabId(1) const socket = { tabId: 1, connectionName: 0n } @@ -305,16 +305,16 @@ describe('popup settings changes', () => { assert.equal(refreshRequests(), refreshedCount) }) - for (const outcome of ['accept', 'reject', 'safe'] as const) { + for (const outcome of ['accept', 'reject', 'safe', 'metadata after chain event'] as const) { test(`preserves RPC preferences until a popup wallet switch is accepted (${ outcome })`, async () => { installBrowserMock() const { changeSimulationMode, getSettings, websiteSocketToString, updateTabState, updateUserAddressBookEntries, saveCurrentTabId } = await loadModules() const { popupChangeActiveRpc } = await import('../../app/ts/background/popupMessageHandlers.js') - const { walletSwitchEthereumChainReply } = await import('../../app/ts/background/providerMessageHandlers.js') + const { walletSwitchEthereumChainReply, signerChainChanged } = await import('../../app/ts/background/providerMessageHandlers.js') const { setRpcList, getRpcList } = await import('../../app/ts/background/storageVariables.js') const currentRpc = (await getSettings()).activeRpcNetwork const primaryRpc = { ...currentRpc, chainId: 2n, httpsRpc: 'https://primary.example.test', primary: true } - const requestedRpc = { ...primaryRpc, httpsRpc: 'https://alternative.example.test', primary: false } + const requestedRpc = { ...primaryRpc, name: 'Requested network', httpsRpc: outcome === 'metadata after chain event' ? primaryRpc.httpsRpc : 'https://alternative.example.test', primary: false } const originalRpcList = [currentRpc, primaryRpc, requestedRpc] await setRpcList(originalRpcList) await changeSimulationMode({ simulationMode: false, activeSigningAddress: 1n, activeSigningSafeAddress: outcome === 'safe' ? 3n : undefined }) @@ -331,16 +331,21 @@ describe('popup settings changes', () => { if (outcome !== 'safe') { await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) assert.deepEqual(await getRpcList(), originalRpcList) + if (outcome === 'metadata after chain event') { + await signerChainChanged(ethereum, tokenPriceService, resetSimulationServices, connections, port, { method: 'signer_chainChanged', params: ['0x2', 1] }, 'hasAccess', 1n) + assert.deepEqual((await getSettings()).activeRpcNetwork, primaryRpc) + } await walletSwitchEthereumChainReply(ethereum, tokenPriceService, resetSimulationServices, connections, port, { method: 'wallet_switchEthereumChain_reply', - params: outcome === 'accept' ? [{ accept: true, chainId: '0x2', walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: 1 }] : [{ accept: false, chainId: '0x2', walletSwitchRequestId: getWalletSwitchRequestId(messages), error: { code: 4001, message: 'Rejected' }, signerProviderGeneration: 1 }], + params: outcome !== 'reject' ? [{ accept: true, chainId: '0x2', walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: 1 }] : [{ accept: false, chainId: '0x2', walletSwitchRequestId: getWalletSwitchRequestId(messages), error: { code: 4001, message: 'Rejected' }, signerProviderGeneration: 1 }], }, 'hasAccess', 1n) } const reply = await pending const activeRpc = (await getSettings()).activeRpcNetwork - if (outcome === 'accept') { + if (outcome === 'accept' || outcome === 'metadata after chain event') { assert.equal(reply.ok, true) - assert.equal(activeRpc.httpsRpc, requestedRpc.httpsRpc) + assert.deepEqual(activeRpc, requestedRpc) + assert.equal((await getRpcList()).find((entry) => entry.name === requestedRpc.name)?.primary, true) assert.equal((await getRpcList()).find((entry) => entry.chainId === 2n && entry.primary)?.httpsRpc, requestedRpc.httpsRpc) } else { assert.equal(reply.ok, false) @@ -358,7 +363,7 @@ describe('popup settings changes', () => { test(`wallet deadline releases a silent request but does not expire a received reply (${ outcome })`, async () => { installBrowserMock() const { changeSimulationMode, getSettings, websiteSocketToString } = await loadModules() - const { requestSignerChainChange, applyWalletSwitchReply } = await import('../../app/ts/background/windows/changeChain.js') + const { requestSignerChainChange, applyWalletSwitchReply } = await import('../../app/ts/background/walletSwitch.js') const { getConfirmedSignerStateToken } = await import('../../app/ts/background/signerStateOwnership.js') await changeSimulationMode({ simulationMode: false }) const socket = { tabId: 1, connectionName: 0n } @@ -442,7 +447,7 @@ describe('popup settings changes', () => { test(`waits for the matching wallet network ${ outcome }`, async () => { installBrowserMock() const { changeSimulationMode, getSettings, websiteSocketToString } = await loadModules() - const { requestSignerChainChange, applyWalletSwitchReply } = await import('../../app/ts/background/windows/changeChain.js') + const { requestSignerChainChange, applyWalletSwitchReply } = await import('../../app/ts/background/walletSwitch.js') await changeSimulationMode({ simulationMode: false }) const socket = { tabId: 1, connectionName: 0n } const ownership = confirmedSignerOwnership(socket) diff --git a/test/tests/simulationVisualizerOpen.test.tsx b/test/tests/simulationVisualizerOpen.test.tsx index 1747fdf82..fabcb1594 100644 --- a/test/tests/simulationVisualizerOpen.test.tsx +++ b/test/tests/simulationVisualizerOpen.test.tsx @@ -1,3 +1,4 @@ +import { usePopupSettingsChanges } from '../../app/ts/components/hooks/usePopupSettingsChanges.js' import * as assert from 'assert' import { describe, test } from 'bun:test' import { h, render } from 'preact' @@ -1175,15 +1176,57 @@ describe('simulation visualizer open replies', () => { } }) + test('signer selection reveals the current wallet account before permission work finishes', async () => { + const dom = installDomMock() + let finishChange: (reply: unknown) => void = () => undefined + const changeReply = new Promise((resolve) => { finishChange = resolve }) + const { dispatchMessage: listener } = installBrowserMock((message) => { + const parsed = PopupMessage.safeParse(message) + return parsed.success && parsed.value.method === 'popup_changeActiveAddress' ? changeReply : undefined + }) + function Harness() { + const home = useLiveSimulationHomeData({ answerMainPopupOpen: true, answerSimulationDataConsumerOpen: true, requestFreshHomeDataOnMount: false }) + const changes = usePopupSettingsChanges(home) + return h('div', {}, [ + h('button', { onClick: () => changes.setActiveAddressAndInformAboutIt('signer') }, 'Select signer'), + h('span', {}, `${home.displayedSigningAddress.value}:${changes.isActiveAddressChanging.value}:${changes.isActiveAddressChangePending.value}`), + ]) + } + try { + await act(() => { render(h(Harness, {}), dom.document.body) }) + const initial = createStackHomePageUpdate(25, 1, 'Signing popup') + await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, initial) }, {}, () => undefined) }) + // Start the request without awaiting its deliberately delayed permission-work reply. + await act(() => { void clickElement(getButtonByText(dom.document.body, 'Select signer')) }) + assert.ok(dom.document.body.textContent.includes(':true:true')) + await act(() => { + listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: { ...initial.data.settings, activeSigningSafeAddress: undefined }, popupRefreshGeneration: 2 }), {}, () => undefined) + }) + assert.ok(dom.document.body.textContent.includes(`${initial.data.tabState.activeSigningAddress}:false:true`)) + // A newer authoritative selection must survive the original request's eventual reply. + await act(() => { listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: initial.data.settings, popupRefreshGeneration: 3 }), {}, () => undefined) }) + await act(async () => { + finishChange({ type: 'ChangeActiveAddressReply', ok: true }) + await changeReply + await new Promise((resolve) => setTimeout(resolve, 0)) + }) + assert.ok(dom.document.body.textContent.includes(`${initial.data.settings.activeSigningSafeAddress}:false:false`)) + } finally { + finishChange(undefined) + render(undefined, dom.document.body) + dom.restore() + } + }) + test('popup reveals the committed wallet before the address-change reply and preserves later settings', async () => { const dom = installDomMock() let finishChange: (reply: unknown) => void = () => undefined const changeReply = new Promise((resolve) => { finishChange = resolve }) - let requestId: string | undefined + let changeRequested = false const { dispatchMessage: listener } = installBrowserMock((message) => { const parsed = PopupMessage.safeParse(message) if (parsed.success && parsed.value.method === 'popup_changeActiveAddress') { - requestId = parsed.value.data.addressChangeRequestId + changeRequested = true return changeReply } return undefined @@ -1203,15 +1246,15 @@ describe('simulation visualizer open replies', () => { const nextCard = collectElements(dom.document.body, 'div').find((element) => element.getAttribute?.('class') === 'card hoverable' && element.textContent?.includes('Next wallet')) if (nextCard === undefined) throw new Error('Expected the next wallet in the address picker') await act(async () => { await clickElement(nextCard) }) - assert.ok(requestId) + assert.ok(changeRequested) const addressRow = () => collectElements(dom.document.body, 'div').find((element) => hasClass(element, 'active-address-row')) assert.equal(addressRow()?.getAttribute?.('aria-label'), 'Switching active address') await act(() => { - listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: initial.data.settings, popupRefreshGeneration: 2, committedAddressChange: { requestId: 'another-popup-request', activeAddress: initial.data.settings.activeSimulationAddress } }), {}, () => undefined) + listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: initial.data.settings, popupRefreshGeneration: 2 }), {}, () => undefined) }) assert.equal(addressRow()?.getAttribute?.('aria-label'), 'Switching active address') await act(() => { - listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: { ...initial.data.settings, activeSimulationAddress: 2n }, popupRefreshGeneration: 3, committedAddressChange: { requestId, activeAddress: 2n } }), {}, () => undefined) + listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: { ...initial.data.settings, activeSimulationAddress: 2n }, popupRefreshGeneration: 3 }), {}, () => undefined) }) assert.equal(addressRow()?.textContent?.includes('Next wallet'), true) assert.equal(String(getButtonByText(dom.document.body, 'Change').getAttribute?.('disabled')), 'true') @@ -1246,11 +1289,11 @@ describe('simulation visualizer open replies', () => { await act(() => { listener({ role: 'all', ...serialize(UpdateHomePage, initial) }, {}, () => undefined) }) const settings = { ...initial.data.settings, activeSimulationAddress: 2n } await act(() => { - listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: settings, popupRefreshGeneration: 3, committedAddressChange: { requestId: 'switch-2', activeAddress: 2n } }), {}, () => undefined) + listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: settings, popupRefreshGeneration: 3 }), {}, () => undefined) }) assert.equal(dom.document.body.textContent, '2/passthrough/loading') await act(() => { - listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: initial.data.settings, popupRefreshGeneration: 2, committedAddressChange: { requestId: 'older-switch', activeAddress: initial.data.settings.activeSimulationAddress } }), {}, () => undefined) + listener(serialize(MessageToPopup, { role: 'all', method: 'popup_settingsUpdated', data: initial.data.settings, popupRefreshGeneration: 2 }), {}, () => undefined) listener({ role: 'all', ...serialize(UpdateHomePage, initial) }, {}, () => undefined) listener(serialize(MessageToPopup, createSimulationStateChangedMessage(initial.data.visualizedSimulatorState)), {}, () => undefined) }) From 549a51f0d5a036f7f9612a43f63b2ff88b71891e Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Tue, 8 Sep 2026 06:26:09 +0000 Subject: [PATCH 17/31] Decouple signing switches from simulation and unify RPC entry identity --- app/ts/background/activeSettings.ts | 3 +- app/ts/background/popupMessageDispatcher.ts | 31 +------ .../popupMessageHandlerRegistries/settings.ts | 3 +- app/ts/background/popupSettingsCommands.ts | 41 ++++++++++ app/ts/background/storageVariables.ts | 6 +- app/ts/components/pages/Home.tsx | 3 +- .../subcomponents/ChainSelector.tsx | 42 +++++++--- .../subcomponents/ConfigureRpcConnection.tsx | 42 +++++----- app/ts/types/popupSettingsProtocol.ts | 1 - app/ts/utils/rpcNetworkChange.ts | 7 +- docs/popup-simulation-refresh.md | 2 + test/tests/auditabilityArchitecture.test.ts | 2 + test/tests/homeClearEmptyState.test.ts | 15 ++++ test/tests/popupSettingsChanges.test.ts | 14 +++- test/tests/uiBoundaryFixes.test.tsx | 80 ++++++++++++++++--- 15 files changed, 213 insertions(+), 79 deletions(-) create mode 100644 app/ts/background/popupSettingsCommands.ts diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index a20c2e0fa..9ce7a05f3 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -129,7 +129,8 @@ async function runActiveSettingsChange( sendMessageToApprovedWebsitePorts(websiteTabConnections, { method: 'chainChanged', result: updatedSettings.activeRpcNetwork.chainId }) await sendPopupMessageToOpenWindows({ method: 'popup_chain_update' }) } - if (rpcEndpointChanged || !activeStackContextsEqual(getActiveStackContext(previousSettings), getActiveStackContext(updatedSettings))) { + // External-wallet signing has no simulated stack; Safe signing retains its separate stack visualization. + if ((updatedSettings.simulationMode || updatedSettings.activeSigningSafeAddress !== undefined) && (rpcEndpointChanged || !activeStackContextsEqual(getActiveStackContext(previousSettings), getActiveStackContext(updatedSettings)))) { await queuePopupSimulationRefresh(activeServices) } await sendActiveAccountChangeToApprovedWebsitePorts(websiteTabConnections, await getSettings()) diff --git a/app/ts/background/popupMessageDispatcher.ts b/app/ts/background/popupMessageDispatcher.ts index c7a049ff1..85bfd66c3 100644 --- a/app/ts/background/popupMessageDispatcher.ts +++ b/app/ts/background/popupMessageDispatcher.ts @@ -1,14 +1,11 @@ -import { sendPopupMessageToOpenWindows } from './backgroundUtils.js' -import { getPopupSettingsOperation } from '../types/popupSettingsProtocol.js' -import { createPopupSettingsCoordinator } from './popupSettingsCoordinator.js' -import { getSettings } from './settings.js' +import { popupSettingsCommandHandlers } from './popupSettingsCommands.js' import { queuePopupSimulationRefresh } from './popupSimulationRefreshQueue.js' import type { PopupMessage } from '../types/interceptor-messages.js' import type { PopupReplyOption } from '../types/interceptor-reply-messages.js' import { getSimulationStackTargetHash } from '../utils/simulationStackTargets.js' import { setLatestUnexpectedError } from './storageVariables.js' import { bumpPopupRefreshGeneration } from './popupRefreshGeneration.js' -import { changeActiveAddress, changeChainDialog, changePage, changePreSimulationBlockTimeManipulation, confirmDialog, enableSimulationMode, fetchSimulationStackRequestConfirmation, forceSetGasLimitForTransaction, importSafeStack, importSimulationStack, modifyMakeMeRich, openNewTab, openWebPage, popupReadyAndListening, refreshHomeData, refreshPopupConfirmTransactionMetadata, refreshPopupConfirmTransactionSimulation, removeTransactionOrSignedMessage, reportUnexpectedErrorInWindow, requestAccountsFromSigner, requestActiveAddresses, requestCompleteVisualizedSimulation, requestHomePageBootstrap, requestInterceptorSimulationInput, requestLatestUnexpectedError, requestMakeMeRichList, requestNewHomeData, requestSafeStackExport, requestSimulationMetadata, requestSimulationMode, setSafeSimulationSigner, setTransactionOrMessageBlockTimeManipulator, simulateGnosisSafeTransactionOnPass, simulateGovernanceContractExecutionOnPass, watchAssetDialog } from './popupMessageHandlers.js' +import { changeChainDialog, changePage, changePreSimulationBlockTimeManipulation, confirmDialog, fetchSimulationStackRequestConfirmation, forceSetGasLimitForTransaction, importSafeStack, importSimulationStack, openNewTab, openWebPage, popupReadyAndListening, refreshHomeData, refreshPopupConfirmTransactionMetadata, refreshPopupConfirmTransactionSimulation, removeTransactionOrSignedMessage, reportUnexpectedErrorInWindow, requestAccountsFromSigner, requestActiveAddresses, requestCompleteVisualizedSimulation, requestHomePageBootstrap, requestInterceptorSimulationInput, requestLatestUnexpectedError, requestMakeMeRichList, requestNewHomeData, requestSafeStackExport, requestSimulationMetadata, requestSimulationMode, setSafeSimulationSigner, setTransactionOrMessageBlockTimeManipulator, simulateGnosisSafeTransactionOnPass, simulateGovernanceContractExecutionOnPass, watchAssetDialog } from './popupMessageHandlers.js' import { popupMessageHandler, type PopupMessageDispatcherContext, type PopupMessageHandlerMap } from './popupMessageHandlerRegistry.js' import { addressBookPopupMessageHandlers } from './popupMessageHandlerRegistries/addressBook.js' import { settingsPopupMessageHandlers } from './popupMessageHandlerRegistries/settings.js' @@ -18,15 +15,7 @@ import { websiteAccessPopupMessageHandlers } from './popupMessageHandlerRegistri export type { PopupMessageDispatcherContext } from './popupMessageHandlerRegistry.js' const popupMessageHandlers = { - popup_requestSettingsChangeStatus: popupMessageHandler('popup_requestSettingsChangeStatus', async () => await settingsCoordinator.publish()), popup_confirmDialog: popupMessageHandler('popup_confirmDialog', async (context, request) => await confirmDialog(context.ethereum, context.tokenPriceService, context.websiteTabConnections, request)), - popup_changeActiveAddress: popupMessageHandler('popup_changeActiveAddress', async (context, request) => await changeActiveAddress(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), - popup_modifyMakeMeRich: popupMessageHandler('popup_modifyMakeMeRich', async (context, request) => { - if (await modifyMakeMeRich(request) && !await queuePopupSimulationRefresh({ ethereum: context.ethereum, tokenPriceService: context.tokenPriceService, invalidateOldState: true })) { - return { type: 'PopupSettingsChangeReply', ok: false, message: 'The rich setting was saved, but balances could not be refreshed. Please refresh the simulation to retry.' } - } - return { type: 'PopupSettingsChangeReply', ok: true } - }), popup_changePage: popupMessageHandler('popup_changePage', async (_context, request) => await changePage(request)), popup_requestAccountsFromSigner: popupMessageHandler('popup_requestAccountsFromSigner', async (context, request) => await requestAccountsFromSigner(context.websiteTabConnections, request)), popup_resetSimulation: popupMessageHandler('popup_resetSimulation', async (context) => await context.resetSimulationState()), @@ -38,10 +27,6 @@ const popupMessageHandlers = { popup_refreshConfirmTransactionMetadata: popupMessageHandler('popup_refreshConfirmTransactionMetadata', async (context) => await refreshPopupConfirmTransactionMetadata(context.ethereum, context.tokenPriceService, context.confirmTransactionAbortController)), popup_changeChainDialog: popupMessageHandler('popup_changeChainDialog', async (context, request) => await changeChainDialog(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), popup_watchAssetDialog: popupMessageHandler('popup_watchAssetDialog', async (context, request) => await watchAssetDialog(context.websiteTabConnections, request)), - popup_enableSimulationMode: popupMessageHandler('popup_enableSimulationMode', async (context, request) => { - await enableSimulationMode(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request) - return { type: 'PopupSettingsChangeReply', ok: true } - }), popup_setSafeSimulationSigner: popupMessageHandler('popup_setSafeSimulationSigner', async (context, request) => await setSafeSimulationSigner(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), popup_requestNewHomeData: popupMessageHandler('popup_requestNewHomeData', async (context, request) => await requestNewHomeData(context.ethereum, context.websiteTabConnections, request.data.refreshSignerAccounts, request.data.includeWebsiteAccessAddressMetadata, context.simulationAbortController, bumpPopupRefreshGeneration())), popup_requestHomePageBootstrap: popupMessageHandler('popup_requestHomePageBootstrap', async (context) => await requestHomePageBootstrap(context.websiteTabConnections, bumpPopupRefreshGeneration())), @@ -72,18 +57,10 @@ const popupMessageHandlers = { ...addressBookPopupMessageHandlers, ...safePopupMessageHandlers, ...settingsPopupMessageHandlers, + ...popupSettingsCommandHandlers, ...websiteAccessPopupMessageHandlers, } satisfies PopupMessageHandlerMap -const settingsCoordinator = createPopupSettingsCoordinator(async (data) => await sendPopupMessageToOpenWindows({ method: 'popup_settingsChangeStatus', data })) - export async function dispatchPopupMessage(context: PopupMessageDispatcherContext, request: PopupMessage): Promise { - const descriptor = getPopupSettingsOperation(request.method) - if (descriptor === undefined) return await popupMessageHandlers[request.method](context, request) - const admission = await settingsCoordinator.run(descriptor.operation, async () => await popupMessageHandlers[request.method]({ ...context, settings: await getSettings() }, request)) - return admission.accepted ? admission.result : { - type: descriptor.replyType, - ok: false, - message: 'Another popup is changing settings. Please wait for it to finish, then try again.', - } + return await popupMessageHandlers[request.method](context, request) } diff --git a/app/ts/background/popupMessageHandlerRegistries/settings.ts b/app/ts/background/popupMessageHandlerRegistries/settings.ts index 7065bbdb1..1b657668f 100644 --- a/app/ts/background/popupMessageHandlerRegistries/settings.ts +++ b/app/ts/background/popupMessageHandlerRegistries/settings.ts @@ -1,11 +1,10 @@ import { updateWebsiteApprovalAccesses } from '../accessManagement.js' import { sendPopupMessageToOpenWindows } from '../backgroundUtils.js' import { popupMessageHandler, type PopupMessageHandlerMap } from '../popupMessageHandlerRegistry.js' -import { changeSettings, exportSettings, importSettings, openNewTab, popupChangeActiveRpc, setNewRpcList, settingsOpened } from '../popupMessageHandlers.js' +import { changeSettings, exportSettings, importSettings, openNewTab, setNewRpcList, settingsOpened } from '../popupMessageHandlers.js' import { getSettings } from '../settings.js' export const settingsPopupMessageHandlers = { - popup_changeActiveRpc: popupMessageHandler('popup_changeActiveRpc', async (context, request) => await popupChangeActiveRpc(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request, context.settings)), popup_requestSettings: popupMessageHandler('popup_requestSettings', async () => await settingsOpened()), popup_ChangeSettings: popupMessageHandler('popup_ChangeSettings', async (context, request) => await changeSettings(context.ethereum, context.tokenPriceService, context.resetSimulationServices, request, context.simulationAbortController)), popup_openSettings: popupMessageHandler('popup_openSettings', async () => await openNewTab('settingsView')), diff --git a/app/ts/background/popupSettingsCommands.ts b/app/ts/background/popupSettingsCommands.ts new file mode 100644 index 000000000..8d26aaa28 --- /dev/null +++ b/app/ts/background/popupSettingsCommands.ts @@ -0,0 +1,41 @@ +import { sendPopupMessageToOpenWindows } from './backgroundUtils.js' +import { createPopupSettingsCoordinator } from './popupSettingsCoordinator.js' +import { popupSettingsOperations } from '../types/popupSettingsProtocol.js' +import type { PopupSettingsRequest } from '../types/popupSettingsRequests.js' +import type { PopupMessage } from '../types/interceptor-messages.js' +import type { PopupReplyOption } from '../types/interceptor-reply-messages.js' +import { popupMessageHandler, type PopupMessageDispatcherContext, type PopupMessageHandlerMap } from './popupMessageHandlerRegistry.js' +import { getSettings } from './settings.js' +import { changeActiveAddress, enableSimulationMode, modifyMakeMeRich, popupChangeActiveRpc } from './popupMessageHandlers.js' +import { queuePopupSimulationRefresh } from './popupSimulationRefreshQueue.js' + +const settingsCoordinator = createPopupSettingsCoordinator(async (data) => await sendPopupMessageToOpenWindows({ method: 'popup_settingsChangeStatus', data })) + +function settingsCommand(method: Method, action: (context: PopupMessageDispatcherContext, request: Extract) => Promise) { + return popupMessageHandler(method, async (context, request) => { + const descriptor = popupSettingsOperations[method] + const admission = await settingsCoordinator.run(descriptor.operation, async () => await action({ ...context, settings: await getSettings() }, request)) + return admission.accepted ? admission.result : { + type: descriptor.replyType, + ok: false, + message: 'Another popup is changing settings. Please wait for it to finish, then try again.', + } + }) +} + +// The protocol descriptor is the exhaustive operation/reply source; this boundary owns admission and command completion. +export const popupSettingsCommandHandlers = { + popup_requestSettingsChangeStatus: popupMessageHandler('popup_requestSettingsChangeStatus', async () => await settingsCoordinator.publish()), + popup_changeActiveAddress: settingsCommand('popup_changeActiveAddress', async (context, request) => await changeActiveAddress(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), + popup_changeActiveRpc: settingsCommand('popup_changeActiveRpc', async (context, request) => await popupChangeActiveRpc(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request, context.settings)), + popup_enableSimulationMode: settingsCommand('popup_enableSimulationMode', async (context, request) => { + await enableSimulationMode(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request) + return { type: 'PopupSettingsChangeReply', ok: true } + }), + popup_modifyMakeMeRich: settingsCommand('popup_modifyMakeMeRich', async (context, request) => { + if (await modifyMakeMeRich(request) && !await queuePopupSimulationRefresh({ ethereum: context.ethereum, tokenPriceService: context.tokenPriceService, invalidateOldState: true })) { + return { type: 'PopupSettingsChangeReply', ok: false, message: 'The rich setting was saved, but balances could not be refreshed. Please refresh the simulation to retry.' } + } + return { type: 'PopupSettingsChangeReply', ok: true } + }), +} satisfies Pick diff --git a/app/ts/background/storageVariables.ts b/app/ts/background/storageVariables.ts index cf20d31b7..c078f190d 100644 --- a/app/ts/background/storageVariables.ts +++ b/app/ts/background/storageVariables.ts @@ -1,3 +1,4 @@ +import { getRpcEntryIdentityKey } from '../utils/rpcNetworkChange.js' import { DEFAULT_TAB_CONNECTION, getChainName } from '../utils/constants.js' import { Semaphore } from '../utils/semaphore.js' import type { PendingChainChangeConfirmationPromise, PendingFetchSimulationStackRequestPromise, RpcConnectionStatus, StoredWatchAssetRequest, TabState } from '../types/user-interface-types.js' @@ -221,9 +222,10 @@ export const setInterceptorStartSleepingTimestamp = async(interceptorStartSleepi export const getInterceptorStartSleepingTimestamp = async () => (await browserStorageLocalGet('interceptorStartSleepingTimestamp'))?.interceptorStartSleepingTimestamp ?? 0 export const promoteRpcAsPrimary = async (rpcNetwork: RpcNetwork) => { - if (rpcNetwork.primary) return const rpcs = await getRpcList() - await setRpcList(rpcs.map((rpc) => rpc.chainId === rpcNetwork.chainId ? modifyObject(rpc, { primary: rpc.httpsRpc === rpcNetwork.httpsRpc }) : rpc)) + const selectedIndex = rpcs.findIndex((rpc) => getRpcEntryIdentityKey(rpc) === getRpcEntryIdentityKey(rpcNetwork)) + if (selectedIndex === -1) return + await setRpcList(rpcs.map((rpc, index) => rpc.chainId === rpcNetwork.chainId ? modifyObject(rpc, { primary: index === selectedIndex }) : rpc)) } export const getPrimaryRpcForChain = async (chainId: bigint) => { diff --git a/app/ts/components/pages/Home.tsx b/app/ts/components/pages/Home.tsx index 3a5116e41..734c7426e 100644 --- a/app/ts/components/pages/Home.tsx +++ b/app/ts/components/pages/Home.tsx @@ -1,3 +1,4 @@ +import { getRpcNetworkChange } from '../../utils/rpcNetworkChange.js' import type { HomeParams, FirstCardParams, SimulationStateParam, RenameAddressCallBack, TabState } from '../../types/user-interface-types.js' import { type SimulationAndVisualisationResults, isEmptySimulationAndVisualisationResults } from '../../types/visualizer-types.js' import { ActiveAddressComponent, SmallAddress, StaticBigAddress, WebsiteOriginText, getActiveAddressEntry } from '../subcomponents/address.js' @@ -257,7 +258,7 @@ function FirstCardHeader(param: FirstCardParams) { const rpcPending = rpcChangeState.value.state === 'pending' const controlsDisabled = !param.isInitialHomeDataLoaded.value || param.isSettingsChangePending.value || simulatingPending || signingPending || rpcPending const changeRpc = (entry: RpcEntry) => { - if (controlsDisabled || entry.httpsRpc === param.rpcNetwork.value?.httpsRpc) return + if (controlsDisabled || !getRpcNetworkChange(param.rpcNetwork.value, entry).selectionChanged) return requestedRpc.value = entry void waitForRpcChange(async () => { await param.changeActiveRpc(entry) }) } diff --git a/app/ts/components/subcomponents/ChainSelector.tsx b/app/ts/components/subcomponents/ChainSelector.tsx index 38c506748..7f146ae8d 100644 --- a/app/ts/components/subcomponents/ChainSelector.tsx +++ b/app/ts/components/subcomponents/ChainSelector.tsx @@ -1,3 +1,4 @@ +import { getRpcEntryIdentityKey } from '../../utils/rpcNetworkChange.js' import { rpcEntriesToChainEntriesWithAllChainsEntry } from '../ui-utils.js' import type { ChainEntry, RpcEntries, RpcEntry, RpcNetwork } from '../../types/rpc.js' import { type ReadonlySignal, type Signal, useComputed } from '@preact/signals' @@ -11,24 +12,39 @@ interface RpcSelectorParams { disabled?: boolean } -export function findRpcEntryByUrl(rpcEntries: RpcEntries, rpcUrl: string) { - return rpcEntries.find((rpcEntry) => rpcEntry.httpsRpc === rpcUrl) +export function findRpcEntryByIdentityKey(rpcEntries: RpcEntries, key: string) { + return rpcEntries.find((entry) => getRpcEntryIdentityKey(entry) === key) } -export function getRpcEntryLabel(rpcEntries: RpcEntries, rpcUrl: string) { - const entry = findRpcEntryByUrl(rpcEntries, rpcUrl) - if (entry === undefined) return rpcUrl - const hasDuplicateName = rpcEntries.some((otherEntry) => otherEntry.name === entry.name && otherEntry.httpsRpc !== entry.httpsRpc) - return hasDuplicateName ? `${ entry.name } (${ entry.httpsRpc })` : entry.name +function getBaseRpcEntryLabel(rpcEntries: RpcEntries, entry: RpcNetwork) { + const sameName = rpcEntries.filter((other) => other.name === entry.name) + if (sameName.some((other) => other.chainId !== entry.chainId && other.httpsRpc === entry.httpsRpc)) return `${ entry.name } (chain ${ entry.chainId }, ${ entry.httpsRpc })` + return sameName.some((other) => other.httpsRpc !== entry.httpsRpc) ? `${ entry.name } (${ entry.httpsRpc })` : entry.name +} + +export function getRpcEntryLabel(rpcEntries: RpcEntries, entry: RpcNetwork) { + const baseLabel = getBaseRpcEntryLabel(rpcEntries, entry) + const matching = rpcEntries.filter(other => getBaseRpcEntryLabel(rpcEntries, other) === baseLabel) + const currencyDiffers = matching.some(other => other.currencyName !== entry.currencyName || other.currencyTicker !== entry.currencyTicker) + const label = currencyDiffers ? `${ baseLabel } (${ entry.currencyTicker }, ${ entry.currencyName })` : baseLabel + const variants = Array.from(new Map(matching + .filter(other => !currencyDiffers || other.currencyName === entry.currencyName && other.currencyTicker === entry.currencyTicker) + .map(other => [getRpcEntryIdentityKey(other), other])).keys()) + const index = variants.indexOf(getRpcEntryIdentityKey(entry)) + // List order gives otherwise identical labels a stable discriminator without exposing credentials from metadata. + return variants.length > 1 && index !== -1 ? `${ label } (connection ${ index + 1 })` : label } export function RpcSelector(params: RpcSelectorParams) { - const options = useComputed(() => params.rpcEntries.value.map((rpcEntry) => rpcEntry.httpsRpc)) - const selected = useComputed(() => params.rpcNetwork.value?.httpsRpc ?? 'No RPC Selected') - const getOptionLabel = (rpcUrl: string) => getRpcEntryLabel(params.rpcEntries.value, rpcUrl) - const onChangedCallBack = (rpcUrl: string) => { - const newEntry = findRpcEntryByUrl(params.rpcEntries.value, rpcUrl) - if (newEntry === undefined) throw new Error(`Tried to change rpc that does not exist: ${ rpcUrl }`) + const options = useComputed(() => params.rpcEntries.value.map(getRpcEntryIdentityKey)) + const selected = useComputed(() => params.rpcNetwork.value === undefined ? '' : getRpcEntryIdentityKey(params.rpcNetwork.value)) + const getOptionLabel = (key: string) => { + const entry = findRpcEntryByIdentityKey(params.rpcEntries.value, key) ?? params.rpcNetwork.value + return entry === undefined ? 'No RPC Selected' : getRpcEntryLabel(params.rpcEntries.value, entry) + } + const onChangedCallBack = (key: string) => { + const newEntry = findRpcEntryByIdentityKey(params.rpcEntries.value, key) + if (newEntry === undefined) throw new Error('Tried to select an RPC entry that is no longer available.') params.changeRpc(newEntry) } return diff --git a/app/ts/components/subcomponents/ConfigureRpcConnection.tsx b/app/ts/components/subcomponents/ConfigureRpcConnection.tsx index ee2136e59..1ddd05f1b 100644 --- a/app/ts/components/subcomponents/ConfigureRpcConnection.tsx +++ b/app/ts/components/subcomponents/ConfigureRpcConnection.tsx @@ -1,9 +1,10 @@ +import { getRpcEntryIdentityKey } from '../../utils/rpcNetworkChange.js' import { createContext, type ComponentChildren } from 'preact' import { useComputed, useSignal, useSignalEffect } from '@preact/signals' import { useContext, useRef } from 'preact/hooks' import { useAsyncState } from '../../utils/preact-utilities.js' import { TextInput } from './TextField.js' -import type { RpcEntries, RpcEntry } from '../../types/rpc.js' +import type { RpcEntries, RpcEntry, RpcNetwork } from '../../types/rpc.js' import { sendPopupMessageToBackgroundPageWithoutUnexpectedErrorReport } from '../../background/backgroundUtils.js' import { getSettings } from '../../background/settings.js' import { getChainName } from '../../utils/constants.js' @@ -121,15 +122,15 @@ export const ConfigureRpcConnection = ({ rpcInfo }: { rpcInfo?: RpcEntry }) => { const saveRpcEntry = async (rpcEntry: RpcEntry) => { const { activeRpcNetwork } = await getSettings() - await saveRpcEntryAndKeepActiveRpcConsistent(rpcEntry, rpcEntries.value, activeRpcNetwork, + await saveRpcEntryAndKeepActiveRpcConsistent(rpcEntry, rpcInfo, rpcEntries.value, activeRpcNetwork, async (entries) => await sendPopupMessageToBackgroundPageWithoutUnexpectedErrorReport({ method: 'popup_set_rpc_list', data: entries }), async (entry) => await requestPopupSettingsChange({ method: 'popup_changeActiveRpc', data: entry }) ) } - const removeRpcEntryByUrl = async (url: string) => { + const removeRpcEntry = async (entry: RpcEntry) => { const { activeRpcNetwork } = await getSettings() - await removeRpcEntryAndKeepActiveRpcConsistent(url, rpcEntries.value, activeRpcNetwork, + await removeRpcEntryAndKeepActiveRpcConsistent(entry, rpcEntries.value, activeRpcNetwork, async (entries) => await sendPopupMessageToBackgroundPageWithoutUnexpectedErrorReport({ method: 'popup_set_rpc_list', data: entries }), async (entry) => await requestPopupSettingsChange({ method: 'popup_changeActiveRpc', data: entry }) ) @@ -142,7 +143,7 @@ export const ConfigureRpcConnection = ({ rpcInfo }: { rpcInfo?: RpcEntry }) => { : } - 1 ? removeRpcEntryByUrl : undefined } /> + 1 ? removeRpcEntry : undefined } /> ) @@ -150,24 +151,27 @@ export const ConfigureRpcConnection = ({ rpcInfo }: { rpcInfo?: RpcEntry }) => { type PersistRpcEntries = (entries: RpcEntries) => Promise type ChangeActiveRpc = (entry: RpcEntry) => Promise -type ActiveRpcSelection = { readonly httpsRpc: string | undefined, readonly chainId: bigint } - -export async function saveRpcEntryAndKeepActiveRpcConsistent(rpcEntry: RpcEntry, rpcEntries: RpcEntries, activeRpcNetwork: ActiveRpcSelection, persistRpcEntries: PersistRpcEntries, changeActiveRpc: ChangeActiveRpc) { - const updatedRpcEntries = [rpcEntry].concat(rpcEntries.filter(entry => entry.httpsRpc !== rpcEntry.httpsRpc)) - if (activeRpcNetwork.httpsRpc === rpcEntry.httpsRpc) { - if (activeRpcNetwork.chainId !== rpcEntry.chainId) throw new Error('Switch to another RPC before changing the active connection chain ID.') - console.warn(`Automatically switched to recently added or modified RPC (${ rpcEntry.httpsRpc })`) - await changeActiveRpc(rpcEntry) +export async function saveRpcEntryAndKeepActiveRpcConsistent(rpcEntry: RpcEntry, originalEntry: RpcEntry | undefined, rpcEntries: RpcEntries, activeRpcNetwork: RpcNetwork, persistRpcEntries: PersistRpcEntries, changeActiveRpc: ChangeActiveRpc) { + const originalIndex = originalEntry === undefined ? -1 : rpcEntries.findIndex(entry => getRpcEntryIdentityKey(entry) === getRpcEntryIdentityKey(originalEntry)) + if (originalEntry !== undefined && originalIndex === -1) throw new Error('This RPC connection changed. Reopen the editor and try again.') + if (rpcEntries.some((entry, index) => index !== originalIndex && getRpcEntryIdentityKey(entry) === getRpcEntryIdentityKey(rpcEntry))) throw new Error('An identical RPC connection already exists.') + const previousEntry = rpcEntries[originalIndex] + const savedEntry = previousEntry === undefined ? rpcEntry : { ...rpcEntry, primary: previousEntry.primary, minimized: previousEntry.minimized } + const updatedRpcEntries = originalIndex === -1 ? [...rpcEntries, savedEntry] : rpcEntries.map((entry, index) => index === originalIndex ? savedEntry : entry) + if (originalEntry !== undefined && getRpcEntryIdentityKey(activeRpcNetwork) === getRpcEntryIdentityKey(originalEntry)) { + if (activeRpcNetwork.chainId !== savedEntry.chainId) throw new Error('Switch to another RPC before changing the active connection chain ID.') + await changeActiveRpc(savedEntry) } await persistRpcEntries(updatedRpcEntries) } -export async function removeRpcEntryAndKeepActiveRpcConsistent(url: string, rpcEntries: RpcEntries, activeRpcNetwork: ActiveRpcSelection, persistRpcEntries: PersistRpcEntries, changeActiveRpc: ChangeActiveRpc) { - const reducedRpcEntries = rpcEntries.filter(entry => entry.httpsRpc !== url) - if (url === activeRpcNetwork.httpsRpc) { +export async function removeRpcEntryAndKeepActiveRpcConsistent(removedEntry: RpcEntry, rpcEntries: RpcEntries, activeRpcNetwork: RpcNetwork, persistRpcEntries: PersistRpcEntries, changeActiveRpc: ChangeActiveRpc) { + const removedIndex = rpcEntries.findIndex(entry => getRpcEntryIdentityKey(entry) === getRpcEntryIdentityKey(removedEntry)) + if (removedIndex === -1) throw new Error('This RPC connection changed. Reopen the editor and try again.') + const reducedRpcEntries = rpcEntries.filter((_entry, index) => index !== removedIndex) + if (getRpcEntryIdentityKey(removedEntry) === getRpcEntryIdentityKey(activeRpcNetwork)) { const rpcToSwitchTo = reducedRpcEntries.find(entry => entry.chainId === activeRpcNetwork.chainId) if (rpcToSwitchTo === undefined) throw new Error('Switch to another RPC on this chain before removing the active connection.') - console.warn('Switching RPC as a result of the removal of the currently active connection') await changeActiveRpc(rpcToSwitchTo) } await persistRpcEntries(reducedRpcEntries) @@ -177,7 +181,7 @@ type ConfigureRpcFormProps = { defaultValues?: RpcEntry, onCancel: () => void onSave: (rpcEntry: RpcEntry) => Promise - onRemove?: (rpcUrl: string) => Promise + onRemove?: (rpcEntry: RpcEntry) => Promise } export async function completeRpcFormMutation(mutation: () => Promise, onSuccess: () => void) { @@ -215,7 +219,7 @@ const ConfigureRpcForm = ({ defaultValues, onCancel, onSave, onRemove }: Configu case 'remove': if (defaultValues !== undefined && onRemove !== undefined) { void waitForMutation(async () => await completeRpcFormMutation( - async () => await onRemove(defaultValues.httpsRpc), + async () => await onRemove(defaultValues), () => completeForm(form) )) } diff --git a/app/ts/types/popupSettingsProtocol.ts b/app/ts/types/popupSettingsProtocol.ts index 256d203b2..964d6faa8 100644 --- a/app/ts/types/popupSettingsProtocol.ts +++ b/app/ts/types/popupSettingsProtocol.ts @@ -12,7 +12,6 @@ export const popupSettingsOperations = { const operations = Object.values(popupSettingsOperations) export type PopupSettingsOperation = typeof operations[number]['operation'] export const PopupSettingsOperation = funtypes.String.withGuard((value): value is PopupSettingsOperation => operations.some(entry => entry.operation === value)) -export const getPopupSettingsOperation = (method: string) => Object.entries(popupSettingsOperations).find(([key]) => key === method)?.[1] export type PopupSettingsChangeStatus = funtypes.Static export const PopupSettingsChangeStatus = funtypes.ReadonlyObject({ diff --git a/app/ts/utils/rpcNetworkChange.ts b/app/ts/utils/rpcNetworkChange.ts index cc2cfb786..4a260c9fb 100644 --- a/app/ts/utils/rpcNetworkChange.ts +++ b/app/ts/utils/rpcNetworkChange.ts @@ -6,12 +6,17 @@ export type RpcNetworkChange = { readonly selectionChanged: boolean } +export const getRpcNetworkSelectionKey = (network: RpcNetwork) => JSON.stringify(RpcNetwork.serialize(network)) + +// List preferences can change independently of the active selection; they do not identify a different RPC entry. +export const getRpcEntryIdentityKey = (network: RpcNetwork) => getRpcNetworkSelectionKey(network.httpsRpc === undefined ? network : { ...network, primary: false, minimized: false }) + // Chain changes require wallet approval; endpoint changes replace services; metadata changes only update the selection. export function getRpcNetworkChange(previous: RpcNetwork | undefined, next: RpcNetwork): RpcNetworkChange { const chainChanged = previous?.chainId !== next.chainId return { chainChanged, endpointChanged: chainChanged || previous?.httpsRpc !== next.httpsRpc, - selectionChanged: previous === undefined || JSON.stringify(RpcNetwork.serialize(previous)) !== JSON.stringify(RpcNetwork.serialize(next)), + selectionChanged: previous === undefined || getRpcNetworkSelectionKey(previous) !== getRpcNetworkSelectionKey(next), } } diff --git a/docs/popup-simulation-refresh.md b/docs/popup-simulation-refresh.md index 2ca3e618b..d73f75e34 100644 --- a/docs/popup-simulation-refresh.md +++ b/docs/popup-simulation-refresh.md @@ -18,3 +18,5 @@ Queue identity and supersession apply only among queue callers. Direct execution When adding a trigger, choose the required cancellation, visibility, error, and return-value contract from the table. Changes to visualization execution belong in `popupVisualisationUpdater.ts`; changes to interactive sharing/supersession belong in `popupSimulationRefreshQueue.ts`. Signer-only networks keep a supported provider available for a later configured selection, but simulation returns passthrough without executing that provider. Cache-fingerprint checks also skip provider reads on signer-only networks. A missing RPC URL cannot be used to construct replacement RPC services. + +External-wallet signing transitions do not enqueue simulation refreshes: wallet acknowledgment depends on applying the selected network, not RPC simulation availability. Simulation-mode transitions and selected Safe signing stacks retain their visualization refreshes. diff --git a/test/tests/auditabilityArchitecture.test.ts b/test/tests/auditabilityArchitecture.test.ts index b5c9779e8..075a1e2bb 100644 --- a/test/tests/auditabilityArchitecture.test.ts +++ b/test/tests/auditabilityArchitecture.test.ts @@ -11,6 +11,7 @@ const popupHandlerRegistrySources = [ Bun.file(new URL('../../app/ts/background/popupMessageHandlerRegistries/settings.ts', import.meta.url)), Bun.file(new URL('../../app/ts/background/popupMessageHandlerRegistries/websiteAccess.ts', import.meta.url)), Bun.file(new URL('../../app/ts/background/popupMessageHandlerRegistries/safe.ts', import.meta.url)), + Bun.file(new URL('../../app/ts/background/popupSettingsCommands.ts', import.meta.url)), ] const safeConfirmationResolverSource = await Bun.file(new URL('../../app/ts/background/safeConfirmationResolver.ts', import.meta.url)).text() const safeConfirmationPersistenceSource = await Bun.file(new URL('../../app/ts/background/safeConfirmationPersistence.ts', import.meta.url)).text() @@ -73,6 +74,7 @@ test('popup handler registries agree with the protocol domain inventory', () => { source: popupHandlerRegistrySources[2], domains: new Set(['settings', 'navigation']) }, { source: popupHandlerRegistrySources[3], domains: new Set(['website-access', 'navigation']) }, { source: popupHandlerRegistrySources[4], domains: new Set(['safe']) }, + { source: popupHandlerRegistrySources[5], domains: new Set(['home', 'settings', 'simulation']) }, ] return Promise.all(expectedRegistryDomains.map(async ({ source, domains }) => { if (source === undefined) throw new Error('Popup handler registry source is missing') diff --git a/test/tests/homeClearEmptyState.test.ts b/test/tests/homeClearEmptyState.test.ts index 031c2ecd9..9f625202c 100644 --- a/test/tests/homeClearEmptyState.test.ts +++ b/test/tests/homeClearEmptyState.test.ts @@ -432,6 +432,21 @@ describe('Home popup clear empty state', () => { } }) + for (const selection of ['other chain', 'metadata edit'] as const) test(`selects an RPC with the same URL and a different ${ selection }`, async () => { + const dom = installDomMock() + const nextRpc = { ...rpcNetwork, name: 'Requested network', chainId: selection === 'other chain' ? rpcNetwork.chainId + 1n : rpcNetwork.chainId } + const requests: RpcEntry[] = [] + const params = createHomeParams({ rpcEntries: new Signal([rpcNetwork, nextRpc]), setActiveRpcAndInformAboutIt: async (entry) => { requests.push(entry) } }) + try { + await act(() => { render(h(Home, params), dom.document.body) }) + await act(async () => { await clickElement(getButtonByText(dom.document.body, 'Requested network')) }) + assert.deepEqual(requests, [nextRpc]) + } finally { + render(undefined, dom.document.body) + dom.restore() + } + }) + test('shows wallet approval progress for RPC changes and keeps the old network on rejection', async () => { const dom = installDomMock() const nextRpc = { ...rpcNetwork, name: 'Other network', chainId: 2n, httpsRpc: 'https://other.example.test' } diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index ac2401d67..4a5a73e03 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -305,13 +305,13 @@ describe('popup settings changes', () => { assert.equal(refreshRequests(), refreshedCount) }) - for (const outcome of ['accept', 'reject', 'safe', 'metadata after chain event'] as const) { + for (const outcome of ['accept', 'reject', 'safe', 'metadata after chain event', 'unavailable simulation'] as const) { test(`preserves RPC preferences until a popup wallet switch is accepted (${ outcome })`, async () => { installBrowserMock() const { changeSimulationMode, getSettings, websiteSocketToString, updateTabState, updateUserAddressBookEntries, saveCurrentTabId } = await loadModules() const { popupChangeActiveRpc } = await import('../../app/ts/background/popupMessageHandlers.js') const { walletSwitchEthereumChainReply, signerChainChanged } = await import('../../app/ts/background/providerMessageHandlers.js') - const { setRpcList, getRpcList } = await import('../../app/ts/background/storageVariables.js') + const { setRpcList, getRpcList, getPrimaryRpcForChain } = await import('../../app/ts/background/storageVariables.js') const currentRpc = (await getSettings()).activeRpcNetwork const primaryRpc = { ...currentRpc, chainId: 2n, httpsRpc: 'https://primary.example.test', primary: true } const requestedRpc = { ...primaryRpc, name: 'Requested network', httpsRpc: outcome === 'metadata after chain event' ? primaryRpc.httpsRpc : 'https://alternative.example.test', primary: false } @@ -327,6 +327,11 @@ describe('popup settings changes', () => { [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'https://example.test', approved: true, wantsToConnect: true }, } }]]) const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + let simulationReads = 0 + if (outcome === 'unavailable simulation') Object.defineProperty(ethereum, 'getCachedBlock', { value: () => { + simulationReads += 1 + throw new Error('Simulation RPC is unavailable') + } }) const pending = popupChangeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, connections, { method: 'popup_changeActiveRpc', data: requestedRpc }, await getSettings()) if (outcome !== 'safe') { await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) @@ -342,11 +347,14 @@ describe('popup settings changes', () => { } const reply = await pending const activeRpc = (await getSettings()).activeRpcNetwork - if (outcome === 'accept' || outcome === 'metadata after chain event') { + if (outcome !== 'reject' && outcome !== 'safe') { + assert.equal(simulationReads, 0, 'External-wallet signing must not read simulation state before acknowledging the switch') assert.equal(reply.ok, true) assert.deepEqual(activeRpc, requestedRpc) assert.equal((await getRpcList()).find((entry) => entry.name === requestedRpc.name)?.primary, true) assert.equal((await getRpcList()).find((entry) => entry.chainId === 2n && entry.primary)?.httpsRpc, requestedRpc.httpsRpc) + assert.equal((await getRpcList()).filter((entry) => entry.chainId === 2n && entry.primary).length, 1) + assert.deepEqual(await getPrimaryRpcForChain(2n), { ...requestedRpc, primary: true }) } else { assert.equal(reply.ok, false) assert.equal(activeRpc.httpsRpc, currentRpc.httpsRpc) diff --git a/test/tests/uiBoundaryFixes.test.tsx b/test/tests/uiBoundaryFixes.test.tsx index d88b5b234..599db253f 100644 --- a/test/tests/uiBoundaryFixes.test.tsx +++ b/test/tests/uiBoundaryFixes.test.tsx @@ -1,3 +1,5 @@ +import type { RpcEntries, RpcEntry } from '../../app/ts/types/rpc.js' +import { getRpcEntryIdentityKey } from '../../app/ts/utils/rpcNetworkChange.js' import * as assert from 'assert' import { describe, test } from 'bun:test' import { installBrowserMock } from './backgroundEthAccountsTestHarness.js' @@ -5,7 +7,7 @@ import { requestPopupSettingsChange } from '../../app/ts/components/popupSetting import { signal } from '@preact/signals' import { render } from 'preact' import { act } from 'preact/test-utils' -import { findChainEntryByName, findRpcEntryByUrl, getRpcEntryLabel } from '../../app/ts/components/subcomponents/ChainSelector.js' +import { findChainEntryByName, findRpcEntryByIdentityKey, getRpcEntryLabel } from '../../app/ts/components/subcomponents/ChainSelector.js' import { DropDownMenu } from '../../app/ts/components/subcomponents/DropDownMenu.js' import { InlineCard } from '../../app/ts/components/subcomponents/InlineCard.js' import { hasValidTimePickerValue, parseTimePickerDeltaValue, TimePicker } from '../../app/ts/components/subcomponents/TimePicker.js' @@ -64,8 +66,31 @@ describe('UI boundary fixes', () => { { name: 'Same name', chainId: 1n, httpsRpc: 'https://second.example', currencyName: 'Ether', currencyTicker: 'ETH', primary: false, minimized: true }, ] as const - assert.equal(findRpcEntryByUrl(entries, 'https://second.example'), entries[1]) - assert.equal(getRpcEntryLabel(entries, 'https://second.example'), 'Same name (https://second.example)') + assert.equal(findRpcEntryByIdentityKey(entries, getRpcEntryIdentityKey(entries[1])), entries[1]) + assert.equal(getRpcEntryLabel(entries, entries[1]), 'Same name (https://second.example)') + }) + + test('distinguishes same-named chains sharing an RPC gateway', () => { + const first = { name: 'Shared gateway', chainId: 1n, httpsRpc: 'https://shared.example', currencyName: 'Ether', currencyTicker: 'ETH', primary: true, minimized: false } + const second = { ...first, chainId: 2n } + const entries = [first, second] + assert.equal(findRpcEntryByIdentityKey(entries, getRpcEntryIdentityKey(second)), second) + assert.equal(getRpcEntryLabel(entries, second), 'Shared gateway (chain 2, https://shared.example)') + }) + + test('distinguishes RPC metadata variants without displaying API keys', () => { + const first: RpcEntry = { name: 'Shared gateway', chainId: 1n, httpsRpc: 'https://shared.example', currencyName: 'Ether', currencyTicker: 'ETH', primary: true, minimized: false, blockExplorer: { apiUrl: 'https://explorer.example/api', apiKey: 'secret-first' } } + const second = { ...first, blockExplorer: { ...first.blockExplorer, apiUrl: 'https://explorer.example/api', apiKey: 'secret-second' } } + const third = { ...first, currencyTicker: 'OTHER', currencyName: 'Other currency' } + const entries = [first, second, third] + const labels = entries.map(entry => getRpcEntryLabel(entries, entry)) + assert.equal(new Set(labels).size, 3) + assert.ok(labels.every(label => !label.includes('secret-'))) + assert.equal(labels[0], 'Shared gateway (ETH, Ether) (connection 1)') + assert.equal(labels[1], 'Shared gateway (ETH, Ether) (connection 2)') + assert.equal(labels[2], 'Shared gateway (OTHER, Other currency)') + assert.equal(getRpcEntryLabel([first, second], first), 'Shared gateway (connection 1)') + assert.equal(getRpcEntryLabel([first, second], second), 'Shared gateway (connection 2)') }) test('keeps dropdown controls from submitting surrounding forms', async () => { @@ -172,12 +197,49 @@ describe('UI boundary fixes', () => { assert.equal(cleanupCount, 1) }) + for (const operation of ['edit', 'remove', 'add'] as const) test(`RPC ${ operation } preserves other entries sharing its gateway`, async () => { + const selected: RpcEntry = { name: 'Selected', chainId: 1n, httpsRpc: 'https://shared.example', currencyName: 'Ether', currencyTicker: 'ETH', primary: true, minimized: false } + const peer = { ...selected, name: 'Same chain peer', primary: false } + const otherChain = { ...selected, chainId: 2n } + const entries = [selected, peer, otherChain] + let persisted: RpcEntries | undefined + const changes: RpcEntry[] = [] + const persist = async (value: RpcEntries) => { persisted = value } + const change = async (value: RpcEntry) => { changes.push(value) } + // List preferences may have changed since the active network snapshot was saved. + const active = { ...selected, primary: false, minimized: true } + const edited = { ...selected, name: 'Edited', httpsRpc: 'https://edited.example' } + if (operation === 'remove') { + await removeRpcEntryAndKeepActiveRpcConsistent(selected, entries, active, persist, change) + assert.deepEqual(persisted, [peer, otherChain]) + assert.deepEqual(changes, [peer]) + } else if (operation === 'edit') { + await saveRpcEntryAndKeepActiveRpcConsistent(edited, selected, entries, active, persist, change) + assert.deepEqual(persisted, [edited, peer, otherChain]) + assert.deepEqual(changes, [edited]) + } else { + const added = { ...selected, name: 'Added', primary: false } + await saveRpcEntryAndKeepActiveRpcConsistent(added, undefined, entries, active, persist, change) + assert.deepEqual(persisted, [...entries, added]) + assert.deepEqual(changes, []) + } + }) + + test('rejects stale RPC edits and duplicate connections before persistence', async () => { + const entry: RpcEntry = { name: 'Original', chainId: 1n, httpsRpc: 'https://rpc.example', currencyName: 'Ether', currencyTicker: 'ETH', primary: true, minimized: false } + const stale = { ...entry, name: 'Stale' } + const unexpectedMutation = async () => { throw new Error('Unexpected mutation') } + await assert.rejects(saveRpcEntryAndKeepActiveRpcConsistent(entry, stale, [entry], entry, unexpectedMutation, unexpectedMutation), /Reopen the editor/) + await assert.rejects(removeRpcEntryAndKeepActiveRpcConsistent(stale, [entry], entry, unexpectedMutation, unexpectedMutation), /Reopen the editor/) + await assert.rejects(saveRpcEntryAndKeepActiveRpcConsistent({ ...entry, primary: false }, undefined, [entry], entry, unexpectedMutation, unexpectedMutation), /identical RPC/) + }) + test('does not broadcast an active RPC edit before its active-network update succeeds', async () => { const activeRpc = { name: 'Active', chainId: 1n, httpsRpc: 'https://active.example', currencyName: 'Ether', currencyTicker: 'ETH', primary: true, minimized: false } const editedRpc = { ...activeRpc, name: 'Edited active RPC' } const operations: string[] = [] - await assert.rejects(saveRpcEntryAndKeepActiveRpcConsistent(editedRpc, [activeRpc], activeRpc, + await assert.rejects(saveRpcEntryAndKeepActiveRpcConsistent(editedRpc, activeRpc, [activeRpc], activeRpc, async () => { operations.push('persist-list') }, async () => { operations.push('change-active') @@ -192,7 +254,7 @@ describe('UI boundary fixes', () => { const crossChainEdit = { ...activeRpc, chainId: 2n } const operations: string[] = [] - await assert.rejects(saveRpcEntryAndKeepActiveRpcConsistent(crossChainEdit, [activeRpc], activeRpc, + await assert.rejects(saveRpcEntryAndKeepActiveRpcConsistent(crossChainEdit, activeRpc, [activeRpc], activeRpc, async () => { operations.push('persist-list') }, async () => { operations.push('change-active') } ), /Switch to another RPC before changing/) @@ -204,7 +266,7 @@ describe('UI boundary fixes', () => { const fallbackRpc = { ...activeRpc, name: 'Fallback', httpsRpc: 'https://fallback.example', primary: false } const operations: string[] = [] - await assert.rejects(removeRpcEntryAndKeepActiveRpcConsistent(activeRpc.httpsRpc, [activeRpc, fallbackRpc], activeRpc, + await assert.rejects(removeRpcEntryAndKeepActiveRpcConsistent(activeRpc, [activeRpc, fallbackRpc], activeRpc, async () => { operations.push('persist-list') }, async (entry) => { operations.push(`change-active:${ entry.httpsRpc }`) @@ -225,8 +287,8 @@ describe('UI boundary fixes', () => { const persist = async () => { persisted = true } const change = async (entry: typeof active) => await requestPopupSettingsChange({ method: 'popup_changeActiveRpc', data: entry }) await assert.rejects(completeRpcFormMutation(async () => { - if (operation === 'edit') await saveRpcEntryAndKeepActiveRpcConsistent({ ...active, name: 'Edited' }, [active, fallback], active, persist, change) - else await removeRpcEntryAndKeepActiveRpcConsistent(active.httpsRpc, [active, fallback], active, persist, change) + if (operation === 'edit') await saveRpcEntryAndKeepActiveRpcConsistent({ ...active, name: 'Edited' }, active, [active, fallback], active, persist, change) + else await removeRpcEntryAndKeepActiveRpcConsistent(active, [active, fallback], active, persist, change) }, () => { closed = true }), /Another popup/) assert.equal(persisted, false) assert.equal(closed, false) @@ -238,7 +300,7 @@ describe('UI boundary fixes', () => { const crossChainRpc = { ...activeRpc, name: 'Other chain', chainId: 2n, httpsRpc: 'https://other-chain.example', primary: false } const operations: string[] = [] - await assert.rejects(removeRpcEntryAndKeepActiveRpcConsistent(activeRpc.httpsRpc, [activeRpc, crossChainRpc], activeRpc, + await assert.rejects(removeRpcEntryAndKeepActiveRpcConsistent(activeRpc, [activeRpc, crossChainRpc], activeRpc, async () => { operations.push('persist-list') }, async () => { operations.push('change-active') } ), /Switch to another RPC on this chain/) From 8a5478b8d9ce09a837690e86927051d77b02d40a Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Wed, 9 Sep 2026 14:00:47 +0000 Subject: [PATCH 18/31] Restore local RPC preferences and clarify refresh outcomes --- app/ts/background/activeSettings.ts | 5 ++- app/ts/background/popupSettingsCommands.ts | 7 ++-- .../background/popupSimulationRefreshQueue.ts | 16 +++++---- .../background/popupVisualisationUpdater.ts | 3 +- app/ts/background/simulationUpdating.ts | 3 +- app/ts/utils/rpcNetworkChange.ts | 3 ++ docs/popup-simulation-refresh.md | 6 ++-- test/tests/popupSettingsChanges.test.ts | 36 +++++++++++++------ test/tests/rpcNetworkChange.test.ts | 4 ++- 9 files changed, 57 insertions(+), 26 deletions(-) diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index 9ce7a05f3..bdfb35f86 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -13,7 +13,7 @@ import { sendPopupMessageToOpenWindows } from './backgroundUtils.js' import { bumpPopupRefreshGeneration } from './popupRefreshGeneration.js' import { sendCallbackToConfirmedSignerOwner } from './signerStateOwnership.js' import { changeSimulationMode, getSettings, setUseSignersAddressAsActiveAddress, trackPreviousActiveAddressForMakeMeRichList } from './settings.js' -import { updateTransactionState } from './storageVariables.js' +import { promoteRpcAsPrimary, updateTransactionState } from './storageVariables.js' import type { ActiveAddressSelection } from '../utils/activeAddressSelection.js' import { rememberSigningAddressSelection } from './signingAddressSelection.js' import { activeStackContextsEqual, getActiveStackContext, operationBelongsToActiveStackContext } from '../utils/activeStackContext.js' @@ -195,15 +195,18 @@ export async function changeActiveRpc(ethereum: EthereumClientService, tokenPric const currentRpc = (await getSettings()).activeRpcNetwork const { chainChanged, selectionChanged } = getRpcNetworkChange(currentRpc, rpcNetwork) if (!selectionChanged) { + await promoteRpcAsPrimary(rpcNetwork) return simulationMode ? { type: 'completedLocally' as const } : { type: 'signerRequestNotNeeded' as const } } if (simulationMode) { await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { simulationMode, rpcNetwork }) + await promoteRpcAsPrimary(rpcNetwork) return { type: 'completedLocally' as const } } // Same-chain endpoint and metadata edits are local, even when a signer is connected. if (!chainChanged) { await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { simulationMode, rpcNetwork }) + await promoteRpcAsPrimary(rpcNetwork) return { type: 'signerRequestNotNeeded' as const } } const signerStateToken = signerTabId !== undefined diff --git a/app/ts/background/popupSettingsCommands.ts b/app/ts/background/popupSettingsCommands.ts index 8d26aaa28..eb1123e33 100644 --- a/app/ts/background/popupSettingsCommands.ts +++ b/app/ts/background/popupSettingsCommands.ts @@ -33,8 +33,11 @@ export const popupSettingsCommandHandlers = { return { type: 'PopupSettingsChangeReply', ok: true } }), popup_modifyMakeMeRich: settingsCommand('popup_modifyMakeMeRich', async (context, request) => { - if (await modifyMakeMeRich(request) && !await queuePopupSimulationRefresh({ ethereum: context.ethereum, tokenPriceService: context.tokenPriceService, invalidateOldState: true })) { - return { type: 'PopupSettingsChangeReply', ok: false, message: 'The rich setting was saved, but balances could not be refreshed. Please refresh the simulation to retry.' } + if (await modifyMakeMeRich(request)) { + const outcome = await queuePopupSimulationRefresh({ ethereum: context.ethereum, tokenPriceService: context.tokenPriceService, invalidateOldState: true }) + if (outcome.status === 'observed' && !outcome.available) { + return { type: 'PopupSettingsChangeReply', ok: false, message: 'The rich setting was saved, but the latest simulation is unavailable. Please refresh the simulation to retry.' } + } } return { type: 'PopupSettingsChangeReply', ok: true } }), diff --git a/app/ts/background/popupSimulationRefreshQueue.ts b/app/ts/background/popupSimulationRefreshQueue.ts index 8cb0c9d1f..9af641c7d 100644 --- a/app/ts/background/popupSimulationRefreshQueue.ts +++ b/app/ts/background/popupSimulationRefreshQueue.ts @@ -1,4 +1,4 @@ -// Optional interactive scheduling above popupVisualisationUpdater; queue guarantees do not cover direct block, bootstrap or persistence updates. See docs/popup-simulation-refresh.md. +// Coalesce interactive requests only; popupVisualisationUpdater owns execution, cancellation and stored state. See docs/popup-simulation-refresh.md. import { Future } from '../utils/future.js' import type { SimulationServices } from '../simulation/serviceLifecycle.js' import { getAddressesbeingMadeRich, getCurrentSimulationInput } from './simulationUpdating.js' @@ -11,9 +11,11 @@ import { type PopupSimulationSnapshot, updatePopupVisualisationIfNeeded } from ' export type PopupSimulationRefresh = SimulationServices & { readonly invalidateOldState?: boolean } export type RevisionedPopupSimulationRefresh = PopupSimulationRefresh & { readonly revision: string | symbol } -// Identical revisions share their own outcome; superseded queued work resolves false because it was not refreshed. +export type PopupSimulationRefreshOutcome = { readonly status: 'superseded' } | { readonly status: 'observed', readonly available: boolean } + +// An observed result describes stored availability after an attempt, not which request published it. export function createPopupSimulationRefresher(refresh: (services: T) => Promise) { - type Entry = { services: T, readonly result: Future } + type Entry = { services: T, readonly result: Future } let pending: Entry | undefined let active: Entry | undefined let draining = false @@ -27,14 +29,14 @@ export function createPopupSimulationRefresher refresh(entry.services)).then( - value => { active = undefined; entry.result.resolve(value) }, + value => { active = undefined; entry.result.resolve({ status: 'observed', available: value }) }, error => { active = undefined; entry.result.reject(error) }, ) } draining = false } - return (services: T): Promise => { + return (services: T): Promise => { if (pending !== undefined && sameRevision(pending.services, services)) { pending.services = { ...services, invalidateOldState: services.invalidateOldState || pending.services.invalidateOldState } return pending.result.asPromise @@ -44,9 +46,9 @@ export function createPopupSimulationRefresher(), + result: new Future(), } - pending?.result.resolve(false) + pending?.result.resolve({ status: 'superseded' }) pending = entry if (!draining) { draining = true diff --git a/app/ts/background/popupVisualisationUpdater.ts b/app/ts/background/popupVisualisationUpdater.ts index c61ed781a..c86d7bdb2 100644 --- a/app/ts/background/popupVisualisationUpdater.ts +++ b/app/ts/background/popupVisualisationUpdater.ts @@ -1,3 +1,4 @@ +import { isSignerOnlyNetwork } from '../utils/rpcNetworkChange.js' import { getSettings } from './settings.js' // Shared execution layer for popup visualization refreshes; the optional interactive queue adds caller-local scheduling, not global ordering. See docs/popup-simulation-refresh.md. import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' @@ -71,7 +72,7 @@ export const updatePopupVisualisationIfNeeded = async (ethereum: EthereumClientS } const isSimulationDataConsumerOpenReply = await requestIsSimulationDataConsumerOpen() if (!(isSimulationDataConsumerOpenReply?.data.isOpen === true)) return popupVisualisation - if (skipIfUnchanged && popupVisualisation.simulationState.kind === 'simulated' && (await getSettings()).activeRpcNetwork.httpsRpc !== undefined) { + if (skipIfUnchanged && popupVisualisation.simulationState.kind === 'simulated' && !isSignerOnlyNetwork((await getSettings()).activeRpcNetwork)) { const currentSimulationInput = await getCurrentSimulationStateInput(ethereum, snapshot) const currentFingerprint = getPopupVisualisationFingerprint(currentSimulationInput.simulationStateInput, currentSimulationInput.rpcNetwork, currentSimulationInput.blockNumber) const cachedFingerprint = getPopupVisualisationFingerprint( diff --git a/app/ts/background/simulationUpdating.ts b/app/ts/background/simulationUpdating.ts index 3ae3e420c..1b81bada2 100644 --- a/app/ts/background/simulationUpdating.ts +++ b/app/ts/background/simulationUpdating.ts @@ -1,3 +1,4 @@ +import { isSignerOnlyNetwork } from '../utils/rpcNetworkChange.js' import { prepareSafeDelegateSimulationInput, prepareSafeDelegateStateOverrides, ORIGINAL_GNOSIS_SAFE, SAFE_DELEGATE_EXECUTE_ABI } from '../safe/safeSimulation.js' import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' import { appendTransactionToInputAndSimulate, createExecutionSimulationState, createSimulationState, getAddressToMakeRich, getBaseFeeAdjustmentBalances, getNonceFixedSimulationStateInput, getSimulatedCode, getTokenBalancesAfterForTransaction, getWebsiteCreatedEthereumTransactions, simulateEstimateGasFromInput, sliceSimulationState } from '../simulation/services/SimulationModeEthereumClientService.js' @@ -129,7 +130,7 @@ export async function getUpdatedSimulationState(ethereum: EthereumClientService, // An unreadable persisted stack must abort refresh, otherwise the simulation fallback could overwrite saved popup results. const currentSimulationInput = simulationInput ?? await getCurrentSimulationInput() // Signer-only networks have no simulation endpoint; the retained supported provider must not execute their stack. - if ((await getSettings()).activeRpcNetwork.httpsRpc === undefined) return PASSTHROUGH_STATE + if (isSignerOnlyNetwork((await getSettings()).activeRpcNetwork)) return PASSTHROUGH_STATE try { return toResolvedSimulationState(await createSimulationStateWithNonceAndBaseFeeFixing(currentSimulationInput, ethereum)) } catch(error: unknown) { diff --git a/app/ts/utils/rpcNetworkChange.ts b/app/ts/utils/rpcNetworkChange.ts index 4a260c9fb..819f73bf9 100644 --- a/app/ts/utils/rpcNetworkChange.ts +++ b/app/ts/utils/rpcNetworkChange.ts @@ -20,3 +20,6 @@ export function getRpcNetworkChange(previous: RpcNetwork | undefined, next: RpcN selectionChanged: previous === undefined || getRpcNetworkSelectionKey(previous) !== getRpcNetworkSelectionKey(next), } } + +// Signer-only selections retain a fallback service, but it must not be used for simulation or cache probes. +export const isSignerOnlyNetwork = (network: RpcNetwork) => network.httpsRpc === undefined diff --git a/docs/popup-simulation-refresh.md b/docs/popup-simulation-refresh.md index d73f75e34..a998dc328 100644 --- a/docs/popup-simulation-refresh.md +++ b/docs/popup-simulation-refresh.md @@ -6,14 +6,14 @@ | Need | Entry point | Contract | | --- | --- | --- | -| Interactive settings changes, reset, or explicit refresh | `queuePopupSimulationRefresh` in `popupSimulationRefreshQueue.ts` | Capture input and rich-count together; share equivalent revisions, keep the latest pending request, carry invalidation forward, and settle each executed entry with its own outcome. Superseded queued requests resolve false. Reset forces invalidation after clearing the stack. | +| Interactive settings changes, reset, or explicit refresh | `queuePopupSimulationRefresh` in `popupSimulationRefreshQueue.ts` | Capture input and rich-count together; share equivalent revisions, keep the latest pending request, carry invalidation forward, and settle each executed entry with its own outcome. Superseded queued requests return `status: 'superseded'`, not a failure. Reset forces invalidation after clearing the stack. | | Complete-visualization requests, new-block updates, throttled editing, or existing flows that require an immediate refresh attempt | `updatePopupVisualisationIfNeeded` | Probe for an open consumer, optionally skip recent/unchanged work, and cancel obsolete cancellable execution. Returns the stored visualization, not a queued caller's success flag. | | Bootstrap for an already-open consumer | `refreshPopupVisualisationForOpenConsumer` | Avoid another visibility probe; report unexpected errors and return the stored fallback so other bootstrap data can still load. | | Import/persistence that must observe visualization errors | `updatePopupVisualisationState` | Execute under the same semaphore without visibility/throttling checks; `throwOnUnexpectedError` lets the caller report persistence failure explicitly. | -The direct paths deliberately retain their existing contracts. A block update must be able to cancel obsolete work promptly; an import cannot silently become a superseded queue entry; bootstrap must not depend on a second open-consumer probe. Routing these paths through a boolean-returning, latest-pending queue would change those guarantees. +The direct paths deliberately retain their existing contracts. A block update must be able to cancel obsolete work promptly; an import cannot silently become a superseded queue entry; bootstrap must not depend on a second open-consumer probe. Routing these paths through a latest-pending queue would change those guarantees. -Queue identity and supersession apply only among queue callers. Direct execution may run between queued entries or cancel their underlying cancellable execution. A queue result describes that entry's refresh attempt; it does not promise that the stored visualization remains unchanged afterward. All paths use the execution layer's serialization and storage/publication logic. +Queue identity and supersession apply only among queue callers. Direct execution may run between queued entries or cancel their underlying cancellable execution. An executed queue entry returns `status: 'observed'` with the stored visualization's availability after its attempt. It does not attribute that state to a particular request or promise that it remains unchanged afterward. Superseded entries never report availability; callers must not interpret supersession as a simulation failure. All paths use the execution layer's serialization and storage/publication logic. When adding a trigger, choose the required cancellation, visibility, error, and return-value contract from the table. Changes to visualization execution belong in `popupVisualisationUpdater.ts`; changes to interactive sharing/supersession belong in `popupSimulationRefreshQueue.ts`. diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index 4a5a73e03..bc93e9d9c 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -21,9 +21,9 @@ describe('popup settings changes', () => { const next = refresh({ ...services, revision: 'second' }) assert.notEqual(next, result) first.resolve(firstSucceeded) - assert.equal(await result, firstSucceeded) + assert.deepEqual(await result, { status: 'observed', available: firstSucceeded }) last.resolve(!firstSucceeded) - assert.equal(await next, !firstSucceeded) + assert.deepEqual(await next, { status: 'observed', available: !firstSucceeded }) }) for (const change of ['same', 'revision', 'provider', 'force'] as const) { @@ -44,8 +44,8 @@ describe('popup settings changes', () => { assert.equal(nextResult === pending, change === 'same') for (let i = 0; i < 5; i++) assert.equal(refresh(next), nextResult) release.resolve(true) - assert.equal(await pending, true) - assert.equal(await nextResult, true) + assert.deepEqual(await pending, { status: 'observed', available: true }) + assert.deepEqual(await nextResult, { status: 'observed', available: true }) assert.equal(calls, change === 'same' ? 1 : 2) await refresh(next) assert.equal(calls, change === 'same' ? 2 : 3) @@ -65,10 +65,10 @@ describe('popup settings changes', () => { const skipped = refresh({ ...services, revision: 'B', invalidateOldState: true }) const last = refresh(services) assert.notEqual(first, last) - assert.equal(await skipped, false) + assert.deepEqual(await skipped, { status: 'superseded' }) release.resolve(true) - assert.equal(await first, true) - assert.equal(await last, true) + assert.deepEqual(await first, { status: 'observed', available: true }) + assert.deepEqual(await last, { status: 'observed', available: true }) assert.deepEqual(calls.map(call => call.revision), ['A', 'A']) assert.equal(calls[1]?.invalidateOldState, true) }) @@ -80,7 +80,7 @@ describe('popup settings changes', () => { const services = { ...createEthereumWithGetBlockCounter({ count: 0 }), revision: 'A' } const result = refresh(services) assert.equal(refresh({ ...services, invalidateOldState: true }), result) - assert.equal(await result, true) + assert.deepEqual(await result, { status: 'observed', available: true }) }) test('rejects only the failed entry and continues queued work and retries', async () => { @@ -99,8 +99,8 @@ describe('popup settings changes', () => { const queued = refresh({ ...services, revision: 'second' }) release.resolve(undefined) await failed - assert.equal(await queued, true) - assert.equal(await refresh(services), true) + assert.deepEqual(await queued, { status: 'observed', available: true }) + assert.deepEqual(await refresh(services), { status: 'observed', available: true }) }) test('coordinates settings changes across dispatchers without blocking wallet replies or reads', async () => { @@ -204,6 +204,22 @@ describe('popup settings changes', () => { assert.equal(messages.some(message => message.method === 'request_signer_to_wallet_switchEthereumChain'), false, 'Metadata edits must not ask a connected wallet to switch chains') }) + for (const simulationMode of [true, false]) for (const reselect of [true, false]) test(`local RPC selection persists the chain preference (simulation=${ simulationMode }, reselect=${ reselect })`, async () => { + installBrowserMock() + const { changeSimulationMode, getSettings } = await loadModules() + const { changeActiveRpc } = await import('../../app/ts/background/activeSettings.js') + const { setRpcList, getPrimaryRpcForChain } = await import('../../app/ts/background/storageVariables.js') + const current = (await getSettings()).activeRpcNetwork + if (current.httpsRpc === undefined) throw new Error('Expected a configured RPC') + const selected = { ...current, httpsRpc: 'https://selected.example', primary: false } + await setRpcList([{ ...current, primary: true }, selected]) + await changeSimulationMode({ simulationMode, rpcNetwork: reselect ? selected : current }) + const services = createEthereumWithGetBlockCounter({ count: 0 }) + await changeActiveRpc(services.ethereum, services.tokenPriceService, () => services, new Map(), selected, simulationMode, undefined) + assert.equal((await getPrimaryRpcForChain(selected.chainId))?.httpsRpc, selected.httpsRpc) + assert.equal((await getSettings()).activeRpcNetwork.httpsRpc, selected.httpsRpc) + }) + test('activation installs services once without exposing a potentially superseded snapshot', async () => { installBrowserMock() const { changeSimulationMode, getSettings } = await loadModules() diff --git a/test/tests/rpcNetworkChange.test.ts b/test/tests/rpcNetworkChange.test.ts index 114da99cf..e7d2016de 100644 --- a/test/tests/rpcNetworkChange.test.ts +++ b/test/tests/rpcNetworkChange.test.ts @@ -1,6 +1,6 @@ import { describe, test } from 'bun:test' import * as assert from 'assert' -import { getRpcNetworkChange } from '../../app/ts/utils/rpcNetworkChange.js' +import { getRpcNetworkChange, isSignerOnlyNetwork } from '../../app/ts/utils/rpcNetworkChange.js' import type { RpcNetwork } from '../../app/ts/types/rpc.js' const network: RpcNetwork = { chainId: 1n, httpsRpc: 'https://rpc.example', name: 'Network', currencyName: 'Ether', currencyTicker: 'ETH', primary: true, minimized: false } @@ -20,6 +20,8 @@ describe('RPC network change classification', () => { }) test('signer-only and missing networks are distinct from a configured endpoint', () => { const signerOnly: RpcNetwork = { chainId: 1n, httpsRpc: undefined, name: 'Signer', currencyName: 'Ether?', currencyTicker: 'ETH?', primary: false, minimized: true } + assert.equal(isSignerOnlyNetwork(signerOnly), true) + assert.equal(isSignerOnlyNetwork(network), false) assert.deepEqual(getRpcNetworkChange(signerOnly, network), { chainChanged: false, endpointChanged: true, selectionChanged: true }) assert.deepEqual(getRpcNetworkChange(undefined, network), { chainChanged: true, endpointChanged: true, selectionChanged: true }) }) From e21045eaab71e482564663cb8d974313c4284910 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Wed, 9 Sep 2026 14:15:09 +0000 Subject: [PATCH 19/31] Read current simulation services after background startup --- app/ts/background/background-startup.ts | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/app/ts/background/background-startup.ts b/app/ts/background/background-startup.ts index dd8929908..5ff56ab4e 100644 --- a/app/ts/background/background-startup.ts +++ b/app/ts/background/background-startup.ts @@ -26,7 +26,7 @@ import { updateDeclarativeNetRequestBlocks } from './accessManagement.js' import { updatePopupVisualisationIfNeeded } from './popupVisualisationUpdater.js' import { POPUP_PERFORMANCE_MARKS, markPerformance } from '../utils/popupPerformance.js' import { removeWebsiteTabConnection } from './websiteTabConnections.js' -import { createSimulationServicesOwner, type SimulationServicesOwner, type ResetSimulationServices, type SimulationServices } from '../simulation/serviceLifecycle.js' +import { createSimulationServicesOwner, type SimulationServicesOwner, type ResetSimulationServices } from '../simulation/serviceLifecycle.js' import { addWindowTabListeners } from '../utils/popupOrTab.js' import { migrateAddressBook } from './addressBookMigration.js' import { migrateWebsiteAccess } from './websiteAccessMigration.js' @@ -132,7 +132,7 @@ if (isManifestV2) { const pendingRequestLimiter = new Semaphore(40) // only allow 40 requests pending globally -async function onContentScriptConnected(waitForStartup: () => Promise<{ resetActiveRpcNetwork: ResetSimulationServices, simulationServices: SimulationServices }>, port: browser.runtime.Port, websiteTabConnections: WebsiteTabConnections) { +async function onContentScriptConnected(waitForStartup: () => Promise<{ resetActiveRpcNetwork: ResetSimulationServices }>, port: browser.runtime.Port, websiteTabConnections: WebsiteTabConnections) { const socket = getSocketFromPort(port) if (port?.sender?.url === undefined || socket === undefined) { printError(`Could not connect to a port: ${ port.name}`) @@ -318,7 +318,6 @@ async function waitForBackgroundStartup() { if (owner === undefined) throw new Error('Background startup reset handler is not initialized') return { resetActiveRpcNetwork: owner.reset, - simulationServices: getSimulationServices(), } } @@ -335,12 +334,14 @@ const onTabUpdated = async (tabId: number, changeInfo: browser.tabs._OnUpdatedCh }) const onCloseWindow = async (id: number) => await catchAllErrorsAndCall(async () => { - const { simulationServices } = await waitForBackgroundStartup() + await waitForBackgroundStartup() + const simulationServices = getSimulationServices() return await onCloseWindowOrTab({ type: 'popup' as const, id }, simulationServices.ethereum, simulationServices.tokenPriceService, websiteTabConnections) }) const onCloseTab = async (id: number) => await catchAllErrorsAndCall(async () => { - const { simulationServices } = await waitForBackgroundStartup() + await waitForBackgroundStartup() + const simulationServices = getSimulationServices() return await onCloseWindowOrTab({ type: 'tab' as const, id }, simulationServices.ethereum, simulationServices.tokenPriceService, websiteTabConnections) }) From 87222a52fd09018e86f0b38a9ca606edc0890f13 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Wed, 9 Sep 2026 14:35:16 +0000 Subject: [PATCH 20/31] Bind wallet deadlines to signer tokens and unify transition services --- app/ts/background/activeSettings.ts | 10 +++---- app/ts/background/walletSwitch.ts | 11 ++++---- test/tests/popupSettingsChanges.test.ts | 37 +++++++++++++++++++++++++ 3 files changed, 47 insertions(+), 11 deletions(-) diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index bdfb35f86..97f6b492b 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -73,16 +73,14 @@ type ActiveSettingsTransition = { const changeActiveAddressAndChainSemaphore = new Semaphore(1) async function runActiveSettingsChange( - ethereum: EthereumClientService, - tokenPriceService: TokenPriceService, + activeServices: SimulationServices, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, transition: ActiveSettingsTransition, ): Promise { const { change } = transition let accessUpdate: WebsiteAccessUpdate | undefined - // Use the installed pair for work within this transition; nested access prompts may install another pair before completion. - let activeServices: SimulationServices = { ethereum, tokenPriceService } + // This pair is the sole service reference for the transition and is replaced when an endpoint is installed. try { // Settings, approvals, resets, notifications and selection preferences form one ordered transition. await changeActiveAddressAndChainSemaphore.execute(async () => { @@ -151,7 +149,7 @@ export async function changeActiveAddressAndChain( websiteTabConnections: WebsiteTabConnections, change: ActiveAddressAndChainChange, ): Promise { - return await runActiveSettingsChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { change }) + return await runActiveSettingsChange({ ethereum, tokenPriceService }, resetSimulationServices, websiteTabConnections, { change }) } export async function activateAddressSelection( @@ -175,7 +173,7 @@ export async function activateAddressSelection( : selectedSafe === undefined ? { signerAddress: options.signerAddress, selection: 'signer' } : { signerAddress: options.signerAddress, selection: 'safe', safeAddress: selectedSafe.address, chainId: selectedSafe.chainId } - return await runActiveSettingsChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + return await runActiveSettingsChange({ ethereum, tokenPriceService }, resetSimulationServices, websiteTabConnections, { change: { simulationMode: options.simulationMode, activeAddress: selection?.type === 'signer' ? selection.address : selection?.entry.address, diff --git a/app/ts/background/walletSwitch.ts b/app/ts/background/walletSwitch.ts index c76a38798..b8ee5185c 100644 --- a/app/ts/background/walletSwitch.ts +++ b/app/ts/background/walletSwitch.ts @@ -20,7 +20,7 @@ type PendingSignerChainChange = { | { readonly type: 'replacement', readonly error: typeof signerUnavailableError } | { readonly type: 'timeout' } > - replyReceived: boolean + readonly receivedReplyTokens: SignerStateToken[] timeout: ReturnType | undefined readonly requestTabId: number readonly requestedRpcNetwork: RpcNetwork @@ -40,8 +40,9 @@ function isPendingWalletSwitchRequest(walletSwitchRequestId: string) { function markSignerChainReplyReceived(token: SignerStateToken, chainId: bigint, walletSwitchRequestId: string) { const pending = pendingSignerChainChange if (pending !== undefined && pending.walletSwitchRequestId === walletSwitchRequestId && doesPendingSignerChainChangeMatch(pending, token, chainId)) { - pending.replyReceived = true - clearTimeout(pending.timeout) + // Early delivery cannot disarm the deadline until the dispatched request's token is known. + if (pending.signerStateToken === undefined) pending.receivedReplyTokens.push(token) + else clearTimeout(pending.timeout) } } @@ -88,7 +89,7 @@ export async function requestSignerChainChange(ethereum: EthereumClientService, if (pendingSignerChainChange !== undefined) return { error: { code: -32002, message: 'A network switch is already waiting for your wallet.' } } const pending: PendingSignerChainChange = { walletSwitchRequestId: crypto.randomUUID(), - replyReceived: false, + receivedReplyTokens: [], timeout: undefined, future: new Future< | { readonly type: 'reply', readonly confirmation: SignerChainChangeConfirmation } @@ -117,7 +118,7 @@ export async function requestSignerChainChange(ethereum: EthereumClientService, : { error: signerUnavailableError } as const } pending.signerStateToken = changeActiveRpcResult.signerStateToken - if (!pending.replyReceived) pending.timeout = setTimeout(() => { + if (!pending.receivedReplyTokens.some(token => doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, token))) pending.timeout = setTimeout(() => { pending.future.resolve({ type: 'timeout' }) }, timeoutMs) const precedingReply = pending.repliesBeforeToken.find(({ signerStateToken, confirmation }) => { diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index bc93e9d9c..92d00502c 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -383,6 +383,43 @@ describe('popup settings changes', () => { }) } + for (const matchesDispatchedToken of [true, false]) test(`early reply deadline ownership matches the dispatched signer token (${ matchesDispatchedToken })`, async () => { + installBrowserMock() + const { changeSimulationMode, getSettings, websiteSocketToString } = await loadModules() + const { requestSignerChainChange, applyWalletSwitchReply } = await import('../../app/ts/background/walletSwitch.js') + await changeSimulationMode({ simulationMode: false }) + const socket = { tabId: 1, connectionName: 0n } + const { port, messages } = createPort(1) + const ownership = confirmedSignerOwnership(socket) + const connections = new Map([[1, { ...ownership, connections: { + [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'https://example.test', approved: true, wantsToConnect: true }, + } }]]) + const rpc = { ...(await getSettings()).activeRpcNetwork, chainId: 2n, httpsRpc: 'https://early-reply.example.test' } + const services = createEthereumWithGetBlockCounter({ count: 0 }) + let delivery: Promise | undefined + const originalPost = port.postMessage + port.postMessage = message => { + originalPost(message) + if (message.method !== 'request_signer_to_wallet_switchEthereumChain') return + // Exercise receipt before the send path returns its captured token, independently of replacement notifications. + if (!matchesDispatchedToken) ownership.signerStateOwner.generation += 1 + delivery = applyWalletSwitchReply(connections, port, { + accept: false, chainId: rpc.chainId, walletSwitchRequestId: getWalletSwitchRequestId(messages), + signerProviderGeneration: ownership.signerStateOwner.providerGeneration, + error: { code: 4001, message: 'Rejected early' }, + }, async () => { throw new Error('A rejected reply must not apply a chain') }) + } + const originalSend = browser.runtime.sendMessage + try { + Object.defineProperty(browser.runtime, 'sendMessage', { configurable: true, value: async (message: unknown) => { + await delivery + return await originalSend(message) + } }) + const result = await requestSignerChainChange(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, rpc, 1, 20) + assert.match(result.error?.message ?? '', matchesDispatchedToken ? /Rejected early/ : /did not answer/) + } finally { Object.defineProperty(browser.runtime, 'sendMessage', { configurable: true, value: originalSend }) } + }) + for (const outcome of ['timeout', 'reply', 'failure'] as const) { test(`wallet deadline releases a silent request but does not expire a received reply (${ outcome })`, async () => { installBrowserMock() From 1feb22d18d12be9bdd4efe670966d520d31c1d96 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Wed, 9 Sep 2026 14:55:08 +0000 Subject: [PATCH 21/31] Document RPC snapshot identity and label tradeoffs --- .../subcomponents/ChainSelector.tsx | 2 +- app/ts/utils/rpcNetworkChange.ts | 1 + docs/rpc-entry-identity.md | 33 +++++++++++++++++++ 3 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 docs/rpc-entry-identity.md diff --git a/app/ts/components/subcomponents/ChainSelector.tsx b/app/ts/components/subcomponents/ChainSelector.tsx index 7f146ae8d..dd1255a98 100644 --- a/app/ts/components/subcomponents/ChainSelector.tsx +++ b/app/ts/components/subcomponents/ChainSelector.tsx @@ -31,7 +31,7 @@ export function getRpcEntryLabel(rpcEntries: RpcEntries, entry: RpcNetwork) { .filter(other => !currencyDiffers || other.currencyName === entry.currencyName && other.currencyTicker === entry.currencyTicker) .map(other => [getRpcEntryIdentityKey(other), other])).keys()) const index = variants.indexOf(getRpcEntryIdentityKey(entry)) - // List order gives otherwise identical labels a stable discriminator without exposing credentials from metadata. + // Presentation only: ordinals can change with the list. Entry keys own selection; see docs/rpc-entry-identity.md. return variants.length > 1 && index !== -1 ? `${ label } (connection ${ index + 1 })` : label } diff --git a/app/ts/utils/rpcNetworkChange.ts b/app/ts/utils/rpcNetworkChange.ts index 819f73bf9..5c6d40983 100644 --- a/app/ts/utils/rpcNetworkChange.ts +++ b/app/ts/utils/rpcNetworkChange.ts @@ -6,6 +6,7 @@ export type RpcNetworkChange = { readonly selectionChanged: boolean } +// Transient snapshot keys, not persistent connection IDs; schema/edit tradeoffs are in docs/rpc-entry-identity.md. export const getRpcNetworkSelectionKey = (network: RpcNetwork) => JSON.stringify(RpcNetwork.serialize(network)) // List preferences can change independently of the active selection; they do not identify a different RPC entry. diff --git a/docs/rpc-entry-identity.md b/docs/rpc-entry-identity.md new file mode 100644 index 000000000..bd4fb6cb5 --- /dev/null +++ b/docs/rpc-entry-identity.md @@ -0,0 +1,33 @@ +# RPC selection and entry matching + +`app/ts/utils/rpcNetworkChange.ts` owns three different comparisons: + +| Comparison | Meaning | Consumers | +| --- | --- | --- | +| Chain ID | The wallet must select a different chain. | Wallet-switch routing | +| Chain ID and RPC URL | The simulation endpoint changed. | Service replacement and accepted-endpoint verification | +| Serialized selection or entry snapshot | The selected configuration or a configured list entry changed. | Settings publication, dropdown selection, editing, removal, and primary promotion | + +## Decision and scope + +The selection key includes the full `RpcNetwork` serialization. The entry key uses that serialization with configured-entry `primary` and `minimized` preferences normalized away. Preference changes therefore do not detach the active selection from its list entry. These are transient value-comparison keys, not persisted IDs or a versioned wire format. Entry keys do not depend on list order. + +URL-only matching cannot distinguish entries that share an endpoint across chains, or same-chain entries with different currency or explorer configuration. The current list model permits those entries. Keeping their complete configuration distinct prevents editing, removing, or promoting an unrelated entry. Exact duplicates are rejected by the editor. Metadata changes do not require a provider reset: that decision uses the separate endpoint comparison. + +The tradeoff is intentional: renaming an entry or rotating its explorer API key changes its snapshot key. `saveRpcEntryAndKeepActiveRpcConsistent` receives the original entry so it can locate the old snapshot, check whether it is active, and replace it with the edited value. It rejects an original snapshot missing from the supplied list and preserves the current list preferences. Removal and promotion also match entry snapshots; a caller must not retain a key as a durable reference across edits. + +Keys can contain credentials, including explorer API keys and credential-bearing RPC URLs. They are internal comparison values: do not log them, render them as labels, or use them as public identifiers. Hashing this serialization would conceal its literal contents but would not make its identity stable across edits. + +## Schema evolution + +`RpcNetwork.serialize` currently canonicalizes property order for comparisons within one schema. It is not a promise that keys remain byte-identical after a codec change. Adding fields, changing defaults, or reordering codec fields requires reviewing the shared helpers and their consumers. No persisted key migration is needed today, because keys are recomputed from values; persisted active selections and list entries still need compatible field/default migrations so equivalent configurations continue to match. + +When changing the RPC schema, explicitly decide whether each field affects chain routing, endpoint replacement, entry matching, or only list preferences. Extend the existing classification, editor, promotion, and dropdown tests to cover that decision. In particular, retain coverage for same-URL entries, edits to an active entry, preference changes, stale editor snapshots, and credential-safe labels. Do not add an independent key derivation in a new consumer. + +If a feature needs identity that survives renames, credential rotation, reordering, or import/export, introduce an explicit persisted entry ID with a migration for existing entries and active references. Define ID allocation, copying/import collisions, and deletion semantics together. That is a storage-model change, rather than another serialization or hashing convention, and is outside this popup-switching change. + +## Display labels + +`ChainSelector.getRpcEntryLabel` uses name, endpoint/chain differences, and currency metadata to distinguish options. When otherwise identical visible labels remain, it appends `connection N` according to the current list order instead of displaying secret-bearing metadata. + +Those numbers are temporary presentation disambiguators. Removing or reordering entries can renumber them, and a lone remaining variant loses the suffix. Selection and mutation use the entry key, never the number or label. Features requiring a stable user-facing connection name should use explicit user-provided names or a persisted identity model, not rely on these ordinals. From 3c614e161822e1f10cfb2564963f3dbd93b4affa Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Wed, 9 Sep 2026 15:43:05 +0000 Subject: [PATCH 22/31] Capture simulation settings explicitly and centralize RPC routing --- app/ts/background/activeSettings.ts | 16 ++---- app/ts/background/background-startup.ts | 7 ++- app/ts/background/popupMessageHandlers.ts | 8 +-- .../background/popupSimulationRefreshQueue.ts | 20 +++---- .../background/popupVisualisationUpdater.ts | 36 ++++++------ app/ts/background/simulationUpdating.ts | 56 +++++++++++++------ .../background/windows/confirmTransaction.ts | 4 +- .../SimulationModeEthereumClientService.ts | 5 +- app/ts/utils/rpcNetworkChange.ts | 7 +++ docs/popup-simulation-refresh.md | 2 +- test/tests/popupClearReset.test.ts | 35 +++++++++++- test/tests/rpcNetworkChange.test.ts | 11 +++- 12 files changed, 132 insertions(+), 75 deletions(-) diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index 97f6b492b..21841373c 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -3,7 +3,7 @@ import type { EthereumClientService } from '../simulation/services/EthereumClien import type { ResetSimulationServices, SimulationServices } from '../simulation/serviceLifecycle.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' import type { SigningAddressPreference } from '../types/signerTypes.js' -import { getRpcNetworkChange } from '../utils/rpcNetworkChange.js' +import { getRpcNetworkChange, getRpcChangeRoute } from '../utils/rpcNetworkChange.js' import type { RpcNetwork } from '../types/rpc.js' import type { WebsiteTabConnections } from '../types/user-interface-types.js' import { Semaphore } from '../utils/semaphore.js' @@ -191,21 +191,15 @@ export async function activateAddressSelection( export async function changeActiveRpc(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, simulationMode: boolean, signerTabId: number | undefined, walletSwitchRequestId: string = crypto.randomUUID()) { const currentRpc = (await getSettings()).activeRpcNetwork - const { chainChanged, selectionChanged } = getRpcNetworkChange(currentRpc, rpcNetwork) - if (!selectionChanged) { + const route = getRpcChangeRoute(currentRpc, rpcNetwork, simulationMode) + if (route === 'unchanged') { await promoteRpcAsPrimary(rpcNetwork) return simulationMode ? { type: 'completedLocally' as const } : { type: 'signerRequestNotNeeded' as const } } - if (simulationMode) { + if (route === 'local') { await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { simulationMode, rpcNetwork }) await promoteRpcAsPrimary(rpcNetwork) - return { type: 'completedLocally' as const } - } - // Same-chain endpoint and metadata edits are local, even when a signer is connected. - if (!chainChanged) { - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { simulationMode, rpcNetwork }) - await promoteRpcAsPrimary(rpcNetwork) - return { type: 'signerRequestNotNeeded' as const } + return simulationMode ? { type: 'completedLocally' as const } : { type: 'signerRequestNotNeeded' as const } } const signerStateToken = signerTabId !== undefined && sendCallbackToConfirmedSignerOwner(websiteTabConnections, signerTabId, { method: 'request_signer_to_wallet_switchEthereumChain', result: rpcNetwork.chainId, walletSwitchRequestId }) diff --git a/app/ts/background/background-startup.ts b/app/ts/background/background-startup.ts index 5ff56ab4e..bf07b186b 100644 --- a/app/ts/background/background-startup.ts +++ b/app/ts/background/background-startup.ts @@ -3,7 +3,7 @@ import 'webextension-polyfill' import { getSettings, updateKnownWebsiteMetadata } from './settings.js' import { DEFAULT_RPCS } from '../config/defaults.js' import { handleInterceptedRequest } from './background.js' -import { getUpdatedSimulationState } from './simulationUpdating.js' +import { captureSimulationSnapshot, getUpdatedSimulationState } from './simulationUpdating.js' import { popupMessageHandler } from './popupMessageRouting.js' import { retrieveWebsiteDetails, updateExtensionBadge, updateExtensionIcon } from './iconHandler.js' import { getPrimaryRpcForChain, getRpcConnectionStatus, removeTabState, setRpcConnectionStatus, updateTabState } from './storageVariables.js' @@ -240,14 +240,15 @@ async function newBlockAttemptCallback(blockheader: EthereumBlockHeader, ethereu } await rpcConnectionStatusPublisher.publishRpcConnectionStatus('popup_new_block_arrived', rpcConnectionStatus) if (isNewBlock) { + const simulateCurrentStack = async (ethereum: EthereumClientService) => await getUpdatedSimulationState(ethereum, await captureSimulationSnapshot()) const settings = await getSettings() if (settings.simulationMode) { const { ethereum, tokenPriceService } = getSimulationServices() const updatePopupVisualisationPromise = updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, false, false) silenceChromeUnCaughtPromise(updatePopupVisualisationPromise) - return await sendSubscriptionMessagesForNewBlock(blockheader.number, ethereumClientService, settings.simulationMode, websiteTabConnections, getUpdatedSimulationState) + return await sendSubscriptionMessagesForNewBlock(blockheader.number, ethereumClientService, settings.simulationMode, websiteTabConnections, simulateCurrentStack) } - return await sendSubscriptionMessagesForNewBlock(blockheader.number, ethereumClientService, settings.simulationMode, websiteTabConnections, getUpdatedSimulationState) + return await sendSubscriptionMessagesForNewBlock(blockheader.number, ethereumClientService, settings.simulationMode, websiteTabConnections, simulateCurrentStack) } } catch(error) { if (isExpectedInfrastructureError(error)) return diff --git a/app/ts/background/popupMessageHandlers.ts b/app/ts/background/popupMessageHandlers.ts index 3035b6326..7d6460b75 100644 --- a/app/ts/background/popupMessageHandlers.ts +++ b/app/ts/background/popupMessageHandlers.ts @@ -1,7 +1,7 @@ -import { getRpcNetworkChange } from '../utils/rpcNetworkChange.js' +import { getRpcChangeRoute } from '../utils/rpcNetworkChange.js' import { refreshConfirmTransactionSimulation } from './confirmTransactionSimulation.js' import { activateAddressSelection, changeActiveAddressAndChain, changeActiveRpc } from './activeSettings.js' -import { getUpdatedSimulationStackSnapshot, getUpdatedSimulationState } from './simulationUpdating.js' +import { captureSimulationSnapshot, getUpdatedSimulationStackSnapshot, getUpdatedSimulationState } from './simulationUpdating.js' import { getSettings, setUseTabsInsteadOfPopup, setPage, updateWebsiteAccess, getMakeCurrentAddressRich, setMetamaskCompatibilityMode, setSafeAppsCompatibilityMode, getPage, setPreSimulationBlockTimeManipulation, getPreSimulationBlockTimeManipulation, getFixedAddressRichList, getWebsiteAccess, updateMakeCurrentAddressRich, updateFixedMakeMeRichList } from './settings.js' import { getPendingTransactionsAndMessages, getTabState, getRpcList, getPrimaryRpcForChain, getRpcConnectionStatus, updateUserAddressBookEntries, getPopupVisualisationState, setIdsOfOpenedTabs, getIdsOfOpenedTabs, updatePendingTransactionOrMessage, addEnsLabelHash, addEnsNodeHash, updateInterceptorTransactionStack, getLatestUnexpectedError, getInterceptorTransactionStack, getChainChangeConfirmationPromise, getFetchSimulationStackRequestPromise, getPendingAccessRequests, updateTransactionState, getUserAddressBookEntries, getUserAddressBookEntriesForChainIdMorePreciseFirst, getSafeTransactionStacks } from './storageVariables.js' import { parseEvents, parseInputData } from '../simulation/parsing.js' @@ -666,7 +666,7 @@ export async function refreshPopupConfirmTransactionSimulation(ethereum: Ethereu } export async function popupChangeActiveRpc(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, params: ChangeActiveChain, settings: Settings) { - if (!settings.simulationMode && getRpcNetworkChange(settings.activeRpcNetwork, params.data).chainChanged) { + if (getRpcChangeRoute(settings.activeRpcNetwork, params.data, settings.simulationMode) === 'wallet') { const tabId = await getLastKnownCurrentTabId() if (tabId === undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: 'No wallet is connected to switch networks.' } as const if (await getConfiguredSigningSafe(settings, (await getTabState(tabId)).signerAccounts) !== undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: 'This Safe is tied to its current network. Select your wallet account before switching networks.' } as const @@ -1292,7 +1292,7 @@ export async function requestCompleteVisualizedSimulation(ethereum: EthereumClie export async function requestSimulationMetadata(ethereumClientService: EthereumClientService) { const settings = await getSettings() - const simulationState = settings.simulationMode ? await getUpdatedSimulationState(ethereumClientService) : { kind: 'passthrough' as const } + const simulationState = settings.simulationMode ? await getUpdatedSimulationState(ethereumClientService, await captureSimulationSnapshot()) : { kind: 'passthrough' as const } if (simulationState.kind === 'passthrough' || simulationState.value.success === false) return { method: 'popup_requestSimulationMetadata' as const, metadata: { diff --git a/app/ts/background/popupSimulationRefreshQueue.ts b/app/ts/background/popupSimulationRefreshQueue.ts index 9af641c7d..75e4a48ed 100644 --- a/app/ts/background/popupSimulationRefreshQueue.ts +++ b/app/ts/background/popupSimulationRefreshQueue.ts @@ -1,12 +1,10 @@ // Coalesce interactive requests only; popupVisualisationUpdater owns execution, cancellation and stored state. See docs/popup-simulation-refresh.md. import { Future } from '../utils/future.js' import type { SimulationServices } from '../simulation/serviceLifecycle.js' -import { getAddressesbeingMadeRich, getCurrentSimulationInput } from './simulationUpdating.js' +import { captureSimulationSnapshot, getSimulationProviderForSnapshot, type SimulationSnapshot } from './simulationUpdating.js' import { getPopupVisualisationFingerprint } from './popupSimulationFingerprint.js' -import { getSettings } from './settings.js' -import { getActiveStackContext } from '../utils/activeStackContext.js' import { stringifyJSONWithBigInts } from '../utils/bigint.js' -import { type PopupSimulationSnapshot, updatePopupVisualisationIfNeeded } from './popupVisualisationUpdater.js' +import { updatePopupVisualisationIfNeeded } from './popupVisualisationUpdater.js' export type PopupSimulationRefresh = SimulationServices & { readonly invalidateOldState?: boolean } export type RevisionedPopupSimulationRefresh = PopupSimulationRefresh & { readonly revision: string | symbol } @@ -58,23 +56,21 @@ export function createPopupSimulationRefresher(async ({ ethereum, tokenPriceService, invalidateOldState = false, snapshot }) => { +const refreshRevision = createPopupSimulationRefresher(async ({ ethereum, tokenPriceService, invalidateOldState = false, snapshot }) => { const result = await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, invalidateOldState, false, !invalidateOldState, snapshot) return result.simulationUpdatingState !== 'failed' && result.simulationResultState !== 'invalid' }) export async function queuePopupSimulationRefresh(services: PopupSimulationRefresh) { - const richAddresses = await getAddressesbeingMadeRich() - const [input, settings] = await Promise.all([getCurrentSimulationInput(richAddresses), getSettings()]) - // Keep the revision and the input consumed after asynchronous consumer/storage checks together. - const snapshot = { simulationStateInput: input, numberOfAddressesMadeRich: richAddresses.length } - const block = services.ethereum.getCachedBlock() + const snapshot = await captureSimulationSnapshot() + const provider = getSimulationProviderForSnapshot(services.ethereum, snapshot) + const block = provider?.getCachedBlock() // Without a cached head we cannot prove that two requests cover the same block; keep the follow-up refresh. const revision = block === undefined ? Symbol('uncached block') : stringifyJSONWithBigInts([ - getPopupVisualisationFingerprint(input, services.ethereum.getRpcEntry(), block.number), + getPopupVisualisationFingerprint(snapshot.simulationStateInput, services.ethereum.getRpcEntry(), block.number), block.hash, snapshot.numberOfAddressesMadeRich, - getActiveStackContext(settings), + snapshot.activeStackContext, ]) return await refreshRevision({ ...services, revision, snapshot }) } diff --git a/app/ts/background/popupVisualisationUpdater.ts b/app/ts/background/popupVisualisationUpdater.ts index c86d7bdb2..e5ccd4828 100644 --- a/app/ts/background/popupVisualisationUpdater.ts +++ b/app/ts/background/popupVisualisationUpdater.ts @@ -1,26 +1,19 @@ -import { isSignerOnlyNetwork } from '../utils/rpcNetworkChange.js' -import { getSettings } from './settings.js' // Shared execution layer for popup visualization refreshes; the optional interactive queue adds caller-local scheduling, not global ordering. See docs/popup-simulation-refresh.md. import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' -import type { CompleteVisualizedSimulation, SimulationState, SimulationStateInput } from '../types/visualizer-types.js' +import type { CompleteVisualizedSimulation, SimulationState } from '../types/visualizer-types.js' import { createPassthroughCompleteVisualizedSimulation, toResolvedSimulationState } from '../types/visualizer-types.js' import { NEW_BLOCK_ABORT, TIME_BETWEEN_BLOCKS } from '../utils/constants.js' import { reportUnexpectedError, isExpectedInfrastructureError, isFailedToFetchError, isNewBlockAbort } from '../utils/errors.js' import { silenceChromeUnCaughtPromise } from '../utils/requests.js' import { Semaphore } from '../utils/semaphore.js' import { modifyObject } from '../utils/typescript.js' -import { getUpdatedSimulationState } from './simulationUpdating.js' +import { captureSimulationSnapshot, getSimulationProviderForSnapshot, type SimulationSnapshot, getUpdatedSimulationState } from './simulationUpdating.js' import { requestIsSimulationDataConsumerOpen, sendPopupMessageToOpenWindows } from './backgroundUtils.js' import { getPopupVisualisationFingerprint } from './popupSimulationFingerprint.js' -import { getAddressesbeingMadeRich, getCurrentSimulationInput, visualizeSimulatorState } from './simulationUpdating.js' +import { visualizeSimulatorState } from './simulationUpdating.js' import { getPopupVisualisationState, setPopupVisualisationState } from './storageVariables.js' -export type PopupSimulationSnapshot = { - readonly simulationStateInput: SimulationStateInput - readonly numberOfAddressesMadeRich: number -} - let abortController = new AbortController() function buildPassthroughVisualizedState( @@ -62,7 +55,7 @@ const hasSimulationInputOperations = (simulationState: SimulationState) => ( ) // Visibility/throttle-aware execution: callers such as block updates can replace obsolete work without entering the interactive queue. -export const updatePopupVisualisationIfNeeded = async (ethereum: EthereumClientService, tokenPriceService: TokenPriceService, invalidateOldState = false, onlyIfNotAlreadyUpdating = false, skipIfUnchanged = false, snapshot?: PopupSimulationSnapshot) => { +export const updatePopupVisualisationIfNeeded = async (ethereum: EthereumClientService, tokenPriceService: TokenPriceService, invalidateOldState = false, onlyIfNotAlreadyUpdating = false, skipIfUnchanged = false, snapshot?: SimulationSnapshot) => { try { const popupVisualisation = await getPopupVisualisationState() if (onlyIfNotAlreadyUpdating && updateSimulationVisualisationSemaphore.getPermits() === 0) return popupVisualisation @@ -72,15 +65,17 @@ export const updatePopupVisualisationIfNeeded = async (ethereum: EthereumClientS } const isSimulationDataConsumerOpenReply = await requestIsSimulationDataConsumerOpen() if (!(isSimulationDataConsumerOpenReply?.data.isOpen === true)) return popupVisualisation - if (skipIfUnchanged && popupVisualisation.simulationState.kind === 'simulated' && !isSignerOnlyNetwork((await getSettings()).activeRpcNetwork)) { - const currentSimulationInput = await getCurrentSimulationStateInput(ethereum, snapshot) + const capturedSnapshot = snapshot ?? await captureSimulationSnapshot() + const provider = getSimulationProviderForSnapshot(ethereum, capturedSnapshot) + if (skipIfUnchanged && popupVisualisation.simulationState.kind === 'simulated' && provider !== undefined) { + const currentSimulationInput = await getCurrentSimulationStateInput(provider, capturedSnapshot) const currentFingerprint = getPopupVisualisationFingerprint(currentSimulationInput.simulationStateInput, currentSimulationInput.rpcNetwork, currentSimulationInput.blockNumber) const cachedFingerprint = getPopupVisualisationFingerprint( popupVisualisation.simulationState.value.simulationStateInput, popupVisualisation.simulationState.value.rpcNetwork, popupVisualisation.simulationState.value.blockNumber, ) - if (currentFingerprint === cachedFingerprint && (snapshot === undefined || snapshot.numberOfAddressesMadeRich === popupVisualisation.numberOfAddressesMadeRich)) return popupVisualisation + if (currentFingerprint === cachedFingerprint && (capturedSnapshot.numberOfAddressesMadeRich === popupVisualisation.numberOfAddressesMadeRich)) return popupVisualisation } abortController.abort(NEW_BLOCK_ABORT) abortController = new AbortController() @@ -90,7 +85,7 @@ export const updatePopupVisualisationIfNeeded = async (ethereum: EthereumClientS const visualizedSimulatorState = await setPopupVisualisationState(modifyObject(popupVisualisation, { simulationId, simulationResultState: 'invalid', simulationUpdatingState: 'updating' })) await sendPopupMessageToOpenWindows({ method: 'popup_simulation_state_changed', data: { visualizedSimulatorState } }) } - await updatePopupVisualisationState(ethereum, tokenPriceService, thisAbortController, false, snapshot) + await updatePopupVisualisationState(ethereum, tokenPriceService, thisAbortController, false, capturedSnapshot) } catch(error: unknown) { if (isExpectedInfrastructureError(error)) return await getPopupVisualisationState() await reportUnexpectedError(error) @@ -116,15 +111,16 @@ export async function refreshPopupVisualisationForOpenConsumer(ethereum: Ethereu const updateSimulationVisualisationSemaphore = new Semaphore(1) // Serialized execution without a visibility probe; persistence callers can require unexpected errors to propagate. -export async function updatePopupVisualisationState(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, abortController: AbortController | undefined, throwOnUnexpectedError = false, snapshot?: PopupSimulationSnapshot) { +export async function updatePopupVisualisationState(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, abortController: AbortController | undefined, throwOnUnexpectedError = false, snapshot?: SimulationSnapshot) { try { return await updateSimulationVisualisationSemaphore.execute(async () => { if (abortController?.signal.aborted) return const popupVisualisation = await getPopupVisualisationState() const simulationId = popupVisualisation.simulationId + 1 - const simulationState = await getUpdatedSimulationState(ethereum, snapshot?.simulationStateInput) + const capturedSnapshot = snapshot ?? await captureSimulationSnapshot() + const simulationState = await getUpdatedSimulationState(ethereum, capturedSnapshot) const doneState = { simulationUpdatingState: 'done' as const, simulationResultState: 'done' as const, simulationId } - const numberOfAddressesMadeRich = snapshot?.numberOfAddressesMadeRich ?? (await getAddressesbeingMadeRich()).length + const numberOfAddressesMadeRich = capturedSnapshot.numberOfAddressesMadeRich if (simulationState.kind === 'passthrough') { const newState = buildPassthroughVisualizedState(simulationId, numberOfAddressesMadeRich) await setPopupVisualisationState(newState) @@ -172,9 +168,9 @@ export async function updatePopupVisualisationState(ethereum: EthereumClientServ } } -async function getCurrentSimulationStateInput(ethereum: EthereumClientService, snapshot?: PopupSimulationSnapshot) { +async function getCurrentSimulationStateInput(ethereum: EthereumClientService, snapshot: SimulationSnapshot) { return { - simulationStateInput: snapshot?.simulationStateInput ?? await getCurrentSimulationInput(), + simulationStateInput: snapshot.simulationStateInput, rpcNetwork: ethereum.getRpcEntry(), blockNumber: await ethereum.getBlockNumber(undefined), } diff --git a/app/ts/background/simulationUpdating.ts b/app/ts/background/simulationUpdating.ts index 1b81bada2..204303c6c 100644 --- a/app/ts/background/simulationUpdating.ts +++ b/app/ts/background/simulationUpdating.ts @@ -1,3 +1,5 @@ +import type { Settings } from '../types/interceptor-messages.js' +import type { RpcNetwork } from '../types/rpc.js' import { isSignerOnlyNetwork } from '../utils/rpcNetworkChange.js' import { prepareSafeDelegateSimulationInput, prepareSafeDelegateStateOverrides, ORIGINAL_GNOSIS_SAFE, SAFE_DELEGATE_EXECUTE_ABI } from '../safe/safeSimulation.js' import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' @@ -43,19 +45,20 @@ const getMakeCurrentAddressRichStateOverride = (addressesToMakeRich: readonly bi ) } -export const getAddressesbeingMadeRich = async () => { - if (!(await getSettings()).simulationMode) return [] - const currentAddressBeingRich = await getAddressToMakeRich() +export const getAddressesbeingMadeRich = async (settingsSnapshot?: Settings) => { + const settings = settingsSnapshot ?? await getSettings() + if (!settings.simulationMode) return [] + const currentAddressBeingRich = await getAddressToMakeRich(settings) const makeRichAddressList = await getFixedAddressRichList() return [...makeRichAddressList.filter((x) => x.makingRich).map((x) => x.address), ...currentAddressBeingRich === undefined ? [] : [currentAddressBeingRich]] } -export const getCurrentSimulationInput = async (richAddresses?: readonly bigint[]): Promise => { +export const getCurrentSimulationInput = async (richAddresses?: readonly bigint[], settingsSnapshot?: Settings): Promise => { const [settings, preSimulationBlockTimeManipulation] = await Promise.all([ - getSettings(), + settingsSnapshot ?? getSettings(), getPreSimulationBlockTimeManipulation() ]) - const richListPromise = silenceChromeUnCaughtPromise(richAddresses === undefined ? getAddressesbeingMadeRich() : Promise.resolve(richAddresses)) + const richListPromise = silenceChromeUnCaughtPromise(richAddresses === undefined ? getAddressesbeingMadeRich(settings) : Promise.resolve(richAddresses)) const stack = await getInterceptorTransactionStack() const inputBlocks: SimulationStateInputBlock[] = [] let currentBlockTransactions: PreSimulationTransaction[] = [] @@ -126,13 +129,34 @@ export const getCurrentSimulationInput = async (richAddresses?: readonly bigint[ return inputBlocks } -export async function getUpdatedSimulationState(ethereum: EthereumClientService, simulationInput?: SimulationStateInput) { - // An unreadable persisted stack must abort refresh, otherwise the simulation fallback could overwrite saved popup results. - const currentSimulationInput = simulationInput ?? await getCurrentSimulationInput() - // Signer-only networks have no simulation endpoint; the retained supported provider must not execute their stack. - if (isSignerOnlyNetwork((await getSettings()).activeRpcNetwork)) return PASSTHROUGH_STATE +export type SimulationSnapshot = { + readonly activeRpcNetwork: RpcNetwork + readonly activeStackContext: ReturnType + readonly simulationStateInput: SimulationStateInput + readonly numberOfAddressesMadeRich: number +} + +// Capture selection and input at the storage boundary. An unreadable stack must abort before publishing any fallback. +export async function captureSimulationSnapshot(): Promise { + const settings = await getSettings() + const richAddresses = await getAddressesbeingMadeRich(settings) + return { + activeRpcNetwork: settings.activeRpcNetwork, + activeStackContext: getActiveStackContext(settings), + simulationStateInput: await getCurrentSimulationInput(richAddresses, settings), + numberOfAddressesMadeRich: richAddresses.length, + } +} + +export const getSimulationProviderForSnapshot = (ethereum: EthereumClientService, snapshot: SimulationSnapshot) => ( + isSignerOnlyNetwork(snapshot.activeRpcNetwork) ? undefined : ethereum +) + +export async function getUpdatedSimulationState(ethereum: EthereumClientService, snapshot: SimulationSnapshot) { + const provider = getSimulationProviderForSnapshot(ethereum, snapshot) + if (provider === undefined) return PASSTHROUGH_STATE try { - return toResolvedSimulationState(await createSimulationStateWithNonceAndBaseFeeFixing(currentSimulationInput, ethereum)) + return toResolvedSimulationState(await createSimulationStateWithNonceAndBaseFeeFixing(snapshot.simulationStateInput, provider)) } catch(error: unknown) { if (isExpectedInfrastructureError(error)) return PASSTHROUGH_STATE await reportUnexpectedError(error, { code: 'simulation_state_refresh_failed' }) @@ -143,10 +167,10 @@ export async function getUpdatedSimulationState(ethereum: EthereumClientService, /** Builds the simulation-stack overlay used by simulation mode and Gnosis Safe signing mode. */ export async function getUpdatedSimulationStackSnapshot(ethereum: EthereumClientService, simulationOverlayEnabled: boolean) { if (!simulationOverlayEnabled) return { simulationInput: PASSTHROUGH_STATE, simulationState: PASSTHROUGH_STATE } - const simulationInput = await getCurrentSimulationInput() + const snapshot = await captureSimulationSnapshot() return { - simulationInput: toResolvedSimulationInput(simulationInput), - simulationState: await getUpdatedSimulationState(ethereum, simulationInput), + simulationInput: toResolvedSimulationInput(snapshot.simulationStateInput), + simulationState: await getUpdatedSimulationState(ethereum, snapshot), } } @@ -357,7 +381,7 @@ export const simulateGnosisSafeMetaTransaction = async (gnosisSafeMessage: Visua to: gnosisSafeMessage.to.address, input: gnosisSafeMessage.parsedMessageData.input } } - const simulationState = await getUpdatedSimulationState(ethereumClientService) + const simulationState = await getUpdatedSimulationState(ethereumClientService, await captureSimulationSnapshot()) if (simulationState.kind === 'passthrough') throw new Error('Failed to fetch simulation state for Gnosis Safe transaction.') if (simulationState.value.success === false) throw new JsonRpcResponseError(simulationState.value.jsonRpcError) const resolvedSimulationState = simulationState.value diff --git a/app/ts/background/windows/confirmTransaction.ts b/app/ts/background/windows/confirmTransaction.ts index 3d59468cf..2f94ae145 100644 --- a/app/ts/background/windows/confirmTransaction.ts +++ b/app/ts/background/windows/confirmTransaction.ts @@ -12,7 +12,7 @@ import type { WebsiteTabConnections } from '../../types/user-interface-types.js' import { type InterceptorTransactionStack, PASSTHROUGH_STATE, type WebsiteCreatedEthereumTransaction, type WebsiteCreatedEthereumTransactionOrFailed, createPassthroughCompleteVisualizedSimulation } from '../../types/visualizer-types.js' import type { SendRawTransactionParams, SendTransactionParams } from '../../types/JsonRpc-types.js' import { refreshConfirmTransactionSimulation } from '../confirmTransactionSimulation.js' -import { getUpdatedSimulationState } from '../simulationUpdating.js' +import { captureSimulationSnapshot, getUpdatedSimulationState } from '../simulationUpdating.js' import { getHtmlFile, sendPopupMessageToOpenWindows } from '../backgroundUtils.js' import { appendPendingTransactionOrMessage, getInterceptorTransactionStack, getPendingTransactionsAndMessages, getRpcConnectionStatus, getTabState, getUserAddressBookEntriesForChainIdMorePreciseFirst, removePendingTransactionOrMessage, updateInterceptorTransactionStack, updatePendingTransactionOrMessage } from '../storageVariables.js' import { type InterceptedRequest, type UniqueRequestIdentifier, doesUniqueRequestIdentifiersMatch, getUniqueRequestIdentifierString, silenceChromeUnCaughtPromise } from '../../utils/requests.js' @@ -535,7 +535,7 @@ export type TransactionGasPayment = 'transaction-sender' | 'external-executor' export const formEthSendTransaction = async(ethereumClientService: EthereumClientService, requestAbortController: AbortController | undefined, activeAddress: bigint | undefined, website: Website, sendTransactionParams: SendTransactionParams, created: Date, transactionIdentifier: EthereumQuantity, simulationMode = true, gasPayment: TransactionGasPayment = 'transaction-sender'): Promise => { const simulationState = simulationMode || gasPayment === 'external-executor' - ? await getUpdatedSimulationState(ethereumClientService) + ? await getUpdatedSimulationState(ethereumClientService, await captureSimulationSnapshot()) : PASSTHROUGH_STATE const transactionDetails = sendTransactionParams.params[0] if (activeAddress === undefined) throw new Error('Access to active address is denied') diff --git a/app/ts/simulation/services/SimulationModeEthereumClientService.ts b/app/ts/simulation/services/SimulationModeEthereumClientService.ts index 0f9e3a6d8..0c8205531 100644 --- a/app/ts/simulation/services/SimulationModeEthereumClientService.ts +++ b/app/ts/simulation/services/SimulationModeEthereumClientService.ts @@ -1,3 +1,4 @@ +import type { Settings } from '../../types/interceptor-messages.js' import { type EthereumClientService, getNextBlockTimeStampOverride } from './EthereumClientService.js' import type { PreparedEthSimulateV1Input } from './EthereumClientService.js' import { type EthereumSignedTransactionWithBlockData, type EthereumBlockTag, type EthereumAddress, type EthereumBlockHeader, type EthereumBlockHeaderWithTransactionHashes, EthereumData, EthereumQuantity, EthereumBytes32, type EthereumSendableSignedTransaction } from '../../types/wire-types.js' @@ -421,8 +422,8 @@ export const simulateEstimateGas = async (ethereumClientService: EthereumClientS } } -export const getAddressToMakeRich = async () => { - const settings = await getSettings() +export const getAddressToMakeRich = async (settingsSnapshot?: Settings) => { + const settings = settingsSnapshot ?? await getSettings() if (!settings.simulationMode) return undefined return await getMakeCurrentAddressRich() ? settings.activeSimulationAddress : undefined } diff --git a/app/ts/utils/rpcNetworkChange.ts b/app/ts/utils/rpcNetworkChange.ts index 5c6d40983..5844385a7 100644 --- a/app/ts/utils/rpcNetworkChange.ts +++ b/app/ts/utils/rpcNetworkChange.ts @@ -24,3 +24,10 @@ export function getRpcNetworkChange(previous: RpcNetwork | undefined, next: RpcN // Signer-only selections retain a fallback service, but it must not be used for simulation or cache probes. export const isSignerOnlyNetwork = (network: RpcNetwork) => network.httpsRpc === undefined + +// Re-evaluate at each command boundary using fresh settings, but keep the routing policy shared. +export function getRpcChangeRoute(previous: RpcNetwork, next: RpcNetwork, simulationMode: boolean) { + const change = getRpcNetworkChange(previous, next) + if (!change.selectionChanged) return 'unchanged' + return !simulationMode && change.chainChanged ? 'wallet' : 'local' +} diff --git a/docs/popup-simulation-refresh.md b/docs/popup-simulation-refresh.md index a998dc328..938282dad 100644 --- a/docs/popup-simulation-refresh.md +++ b/docs/popup-simulation-refresh.md @@ -17,6 +17,6 @@ Queue identity and supersession apply only among queue callers. Direct execution When adding a trigger, choose the required cancellation, visibility, error, and return-value contract from the table. Changes to visualization execution belong in `popupVisualisationUpdater.ts`; changes to interactive sharing/supersession belong in `popupSimulationRefreshQueue.ts`. -Signer-only networks keep a supported provider available for a later configured selection, but simulation returns passthrough without executing that provider. Cache-fingerprint checks also skip provider reads on signer-only networks. A missing RPC URL cannot be used to construct replacement RPC services. +`captureSimulationSnapshot` reads the selected network, stack context, input and rich count at the storage boundary. Execution requires that snapshot; cache checks and execution share `getSimulationProviderForSnapshot`, which uses its network selection without re-reading global settings. Signer-only snapshots expose no simulation provider even though the service owner retains a supported provider for a later configured selection. The interactive queue carries the same snapshot through fingerprinting and execution. A missing RPC URL cannot be used to construct replacement RPC services. External-wallet signing transitions do not enqueue simulation refreshes: wallet acknowledgment depends on applying the selected network, not RPC simulation availability. Simulation-mode transitions and selected Safe signing stacks retain their visualization refreshes. diff --git a/test/tests/popupClearReset.test.ts b/test/tests/popupClearReset.test.ts index bea1ca084..34717e71f 100644 --- a/test/tests/popupClearReset.test.ts +++ b/test/tests/popupClearReset.test.ts @@ -390,17 +390,21 @@ const fakeEthereum = createFakeEthereum(rpcNetwork) as never as Parameters[1] describe('popup clear reset', () => { - test('signer-only networks publish passthrough without reading the previous provider', async () => { + for (const captured of [false, true]) test(`signer-only snapshots publish passthrough without reading the previous provider (captured=${ captured })`, async () => { browserMock.reset() const signerOnly: RpcNetwork = { chainId: 99999n, httpsRpc: undefined, name: 'Signer only', currencyName: 'Ether?', currencyTicker: 'ETH?', primary: false, minimized: true } await browserStorageLocalSet({ activeRpcNetwork: signerOnly, independentActiveSimulationAddress: activeAddress, popupVisualisation: stalePopupVisualisation, interceptorTransactionStack: { operations: [] } }) + const { captureSimulationSnapshot, getUpdatedSimulationState } = await import('../../app/ts/background/simulationUpdating.js') + const snapshot = captured ? await captureSimulationSnapshot() : undefined + if (captured) await browserStorageLocalSet({ activeRpcNetwork: rpcNetwork }) const originalBlock = fakeEthereum.getBlock const originalNumber = fakeEthereum.getBlockNumber let providerReads = 0 fakeEthereum.getBlock = async (...args) => { providerReads++; return await originalBlock(...args) } fakeEthereum.getBlockNumber = async (...args) => { providerReads++; return await originalNumber(...args) } try { - const result = await updatePopupVisualisationIfNeeded(fakeEthereum, fakeTokenPriceService, false, false, true) + const result = await updatePopupVisualisationIfNeeded(fakeEthereum, fakeTokenPriceService, false, false, true, snapshot) + if (snapshot !== undefined) assert.equal((await getUpdatedSimulationState(fakeEthereum, snapshot)).kind, 'passthrough') assert.equal(providerReads, 0) assert.equal(result.simulationState.kind, 'passthrough') assert.equal(result.simulationUpdatingState, 'done') @@ -411,6 +415,30 @@ describe('popup clear reset', () => { } }) + for (const nextSimulationMode of [true, false]) test(`capture keeps the original rich address and stack mode during a settings change (nextSimulationMode=${ nextSimulationMode })`, async () => { + browserMock.reset() + await browserStorageLocalSet({ activeRpcNetwork: rpcNetwork, independentActiveSimulationAddress: activeAddress, simulationMode: true, makeCurrentAddressRich: true, interceptorTransactionStack: { operations: [] } }) + const { captureSimulationSnapshot } = await import('../../app/ts/background/simulationUpdating.js') + const originalGet = browser.storage.local.get + let changed = false + browser.storage.local.get = async keys => { + const result = await originalGet(keys) + if (!changed && Array.isArray(keys) && keys.includes('activeRpcNetwork')) { + changed = true + // Initial settings reads have captured their values; rich-address resolution has not started yet. + await browserStorageLocalSet({ independentActiveSimulationAddress: activeAddress + 1n, simulationMode: nextSimulationMode }) + } + return result + } + try { + const snapshot = await captureSimulationSnapshot() + assert.equal(changed, true) + assert.deepEqual(snapshot.activeStackContext, { simulationMode: true }) + assert.equal(snapshot.numberOfAddressesMadeRich, 1) + assert.deepEqual(snapshot.simulationStateInput.flatMap(block => Object.keys(block.stateOverrides)), [`0x${ activeAddress.toString(16).padStart(40, '0') }`]) + } finally { browser.storage.local.get = originalGet } + }) + test('complete visualization requests do not join a held interactive queue entry', async () => { browserMock.reset() await browserStorageLocalSet({ activeRpcNetwork: rpcNetwork, independentActiveSimulationAddress: activeAddress, popupVisualisation: stalePopupVisualisation, interceptorTransactionStack: { operations: [] } }) @@ -486,7 +514,8 @@ describe('popup clear reset', () => { browserMock.reset() await browserStorageLocalSet({ independentActiveSimulationAddress: activeAddress, makeCurrentAddressRich: false, interceptorTransactionStack: { operations: [] } }) const modules = await modulesPromise - const snapshot = { simulationStateInput: await modules.getCurrentSimulationInput(), numberOfAddressesMadeRich: 0 } + const { captureSimulationSnapshot } = await import('../../app/ts/background/simulationUpdating.js') + const snapshot = await captureSimulationSnapshot() await browserStorageLocalSet({ makeCurrentAddressRich: true }) assert.notDeepEqual(await modules.getCurrentSimulationInput(), snapshot.simulationStateInput) const result = await updatePopupVisualisationIfNeeded(fakeEthereum, fakeTokenPriceService, false, false, false, snapshot) diff --git a/test/tests/rpcNetworkChange.test.ts b/test/tests/rpcNetworkChange.test.ts index e7d2016de..b7d7414dc 100644 --- a/test/tests/rpcNetworkChange.test.ts +++ b/test/tests/rpcNetworkChange.test.ts @@ -1,6 +1,6 @@ import { describe, test } from 'bun:test' import * as assert from 'assert' -import { getRpcNetworkChange, isSignerOnlyNetwork } from '../../app/ts/utils/rpcNetworkChange.js' +import { getRpcNetworkChange, getRpcChangeRoute, isSignerOnlyNetwork } from '../../app/ts/utils/rpcNetworkChange.js' import type { RpcNetwork } from '../../app/ts/types/rpc.js' const network: RpcNetwork = { chainId: 1n, httpsRpc: 'https://rpc.example', name: 'Network', currencyName: 'Ether', currencyTicker: 'ETH', primary: true, minimized: false } @@ -26,3 +26,12 @@ describe('RPC network change classification', () => { assert.deepEqual(getRpcNetworkChange(undefined, network), { chainChanged: true, endpointChanged: true, selectionChanged: true }) }) }) + +for (const simulationMode of [true, false]) test(`RPC routing uses one policy for local and wallet commands (simulation=${ simulationMode })`, () => { + assert.equal(getRpcChangeRoute(network, { ...network }, simulationMode), 'unchanged') + assert.equal(getRpcChangeRoute(network, { ...network, name: 'Renamed' }, simulationMode), 'local') + assert.equal(getRpcChangeRoute(network, { ...network, httpsRpc: 'https://second.example' }, simulationMode), 'local') + assert.equal(getRpcChangeRoute(network, { ...network, chainId: 2n }, simulationMode), simulationMode ? 'local' : 'wallet') + const signerOnly: RpcNetwork = { chainId: 2n, httpsRpc: undefined, name: 'Signer only', currencyName: 'Ether?', currencyTicker: 'ETH?', primary: false, minimized: true } + assert.equal(getRpcChangeRoute(network, signerOnly, simulationMode), simulationMode ? 'local' : 'wallet') +}) From 47eaddec58d01bcbfacfee3384e1c7e4b4a93c77 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Wed, 9 Sep 2026 16:12:07 +0000 Subject: [PATCH 23/31] Preserve committed selection follow-ups after provider reset failure --- app/ts/background/activeSettings.ts | 25 ++++++++++++------- .../background/popupVisualisationUpdater.ts | 13 ++++++++++ test/tests/activeSettingsConcurrency.test.ts | 24 ++++++++++++++++++ 3 files changed, 53 insertions(+), 9 deletions(-) diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index 21841373c..491d028d2 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -1,3 +1,4 @@ +import { publishFailedPopupVisualisation } from './popupVisualisationUpdater.js' import { queuePopupSimulationRefresh } from './popupSimulationRefreshQueue.js' import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' import type { ResetSimulationServices, SimulationServices } from '../simulation/serviceLifecycle.js' @@ -111,15 +112,22 @@ async function runActiveSettingsChange( const updatedSettings = await getSettings() const { chainChanged: rpcChainChanged, endpointChanged: rpcEndpointChanged } = getRpcNetworkChange(previousSettings.activeRpcNetwork, updatedSettings.activeRpcNetwork) try { - // A signer-only chain has no provider to install; simulation is disabled until a configured endpoint is selected. - if (rpcEndpointChanged && change.rpcNetwork?.httpsRpc !== undefined) activeServices = resetSimulationServices(change.rpcNetwork) - if (updatedSettings.simulationMode && rpcChainChanged) await clearSimulationStateFromConfig() - // Publish settings exactly once when committed; access reconciliation later publishes account and icon updates. - await sendPopupMessageToOpenWindows({ - method: 'popup_settingsUpdated', data: updatedSettings, popupRefreshGeneration: bumpPopupRefreshGeneration(), - }) + try { + // The preference belongs to the committed selection, even if later provider preparation fails. + if (transition.signingPreference !== undefined) await rememberSigningAddressSelection(transition.signingPreference) + // A signer-only chain has no provider to install; simulation is disabled until a configured endpoint is selected. + if (rpcEndpointChanged && change.rpcNetwork?.httpsRpc !== undefined) activeServices = resetSimulationServices(change.rpcNetwork) + if (updatedSettings.simulationMode && rpcChainChanged) await clearSimulationStateFromConfig() + } finally { + // Publish committed settings even if installing their services fails. + await sendPopupMessageToOpenWindows({ + method: 'popup_settingsUpdated', data: updatedSettings, popupRefreshGeneration: bumpPopupRefreshGeneration(), + }) + } + } catch (error) { + await publishFailedPopupVisualisation() + throw error } finally { - // Persisted settings still need access reconciliation if provider preparation or publication fails. accessUpdate = await reconcileWebsiteApprovalAccesses(websiteTabConnections, updatedSettings) } await sendPopupMessageToOpenWindows({ method: 'popup_accounts_update' }) @@ -132,7 +140,6 @@ async function runActiveSettingsChange( await queuePopupSimulationRefresh(activeServices) } await sendActiveAccountChangeToApprovedWebsitePorts(websiteTabConnections, await getSettings()) - if (transition.signingPreference !== undefined) await rememberSigningAddressSelection(transition.signingPreference) }) } finally { // Complete committed access updates after releasing the semaphore, even if a later reset or notification fails. diff --git a/app/ts/background/popupVisualisationUpdater.ts b/app/ts/background/popupVisualisationUpdater.ts index e5ccd4828..efe338d8c 100644 --- a/app/ts/background/popupVisualisationUpdater.ts +++ b/app/ts/background/popupVisualisationUpdater.ts @@ -110,6 +110,19 @@ export async function refreshPopupVisualisationForOpenConsumer(ethereum: Ethereu } const updateSimulationVisualisationSemaphore = new Semaphore(1) +// Failed provider preparation must retire old results without executing the retained provider. +export async function publishFailedPopupVisualisation() { + abortController.abort(NEW_BLOCK_ABORT) + await updateSimulationVisualisationSemaphore.execute(async () => { + const previous = await getPopupVisualisationState() + const failed = await setPopupVisualisationState({ + ...createPassthroughCompleteVisualizedSimulation(previous.simulationId + 1, 'invalid'), + simulationUpdatingState: 'failed', + }) + await sendPopupMessageToOpenWindows({ method: 'popup_simulation_state_changed', data: { visualizedSimulatorState: failed } }) + }) +} + // Serialized execution without a visibility probe; persistence callers can require unexpected errors to propagate. export async function updatePopupVisualisationState(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, abortController: AbortController | undefined, throwOnUnexpectedError = false, snapshot?: SimulationSnapshot) { try { diff --git a/test/tests/activeSettingsConcurrency.test.ts b/test/tests/activeSettingsConcurrency.test.ts index caf258271..bcc6b9636 100644 --- a/test/tests/activeSettingsConcurrency.test.ts +++ b/test/tests/activeSettingsConcurrency.test.ts @@ -125,6 +125,30 @@ describe('active settings concurrency', () => { ]) }) + test('retains committed Safe preferences and invalidates the popup after provider reset failure', async () => { + const { runtimeMessages } = installBrowserMock() + const { activateAddressSelection, getSettings, getSigningAddressPreferences, updateUserAddressBookEntries } = await loadModules() + const { getPopupVisualisationState } = await import('../../app/ts/background/storageVariables.js') + const safe: SafeEntry = { type: 'safe', name: 'Owned Safe', address: 3n, chainId: (await getSettings()).activeRpcNetwork.chainId, entrySource: 'User', useAsActiveAddress: true, safeSignerAddresses: [firstAddress.address] } + await updateUserAddressBookEntries(() => [firstAddress, safe]) + const counter = { count: 0 } + const services = createEthereumWithGetBlockCounter(counter) + const rpcNetwork = { ...(await getSettings()).activeRpcNetwork, httpsRpc: 'https://failed-install.example' } + const failure = new Error('Injected provider reset failure') + await assert.rejects(activateAddressSelection(services.ethereum, services.tokenPriceService, () => { throw failure }, new Map(), { type: 'addressBookEntry', entry: safe }, { + simulationMode: false, signerAddress: firstAddress.address, rpcNetwork, promptForAccessesIfNeeded: false, + }), error => error === failure) + assert.equal((await getSettings()).activeSigningSafeAddress, safe.address) + assert.deepEqual(await getSigningAddressPreferences(), [{ signerAddress: firstAddress.address, selection: 'safe', safeAddress: safe.address, chainId: safe.chainId }]) + const visualisation = await getPopupVisualisationState() + assert.equal(visualisation.simulationUpdatingState, 'failed') + assert.equal(visualisation.simulationResultState, 'invalid') + assert.equal(visualisation.simulationState.kind, 'passthrough') + assert.equal(counter.count, 0, 'Failure handling must not simulate on the old provider') + assert.equal(runtimeMessages.some(message => message.method === 'popup_simulation_state_changed'), true) + assert.equal(runtimeMessages.some(message => message.method === 'popup_settingsUpdated'), true) + }) + test('settles an address change that prompts for access alongside an approval that selects another address', async () => { installBrowserMock() const { changeActiveAddressAndChain, changeSimulationMode, getSettings, updateUserAddressBookEntries, websiteSocketToString, requestAccessFromUser, getPendingAccessRequests, resolveInterceptorAccess } = await loadModules() From 626fa615dfcca3dcbd9a58c1de2854e7fee7aaa2 Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Thu, 10 Sep 2026 07:08:08 +0000 Subject: [PATCH 24/31] Centralize RPC switching and use current simulation services --- app/ts/background/accessManagement.ts | 28 +- app/ts/background/activeSettings.ts | 58 +--- app/ts/background/background-startup.ts | 16 +- app/ts/background/background.ts | 38 +-- app/ts/background/popupMessageDispatcher.ts | 4 +- .../addressBook.ts | 4 +- .../popupMessageHandlerRegistries/settings.ts | 6 +- .../websiteAccess.ts | 12 +- .../background/popupMessageHandlerRegistry.ts | 4 +- app/ts/background/popupMessageHandlers.ts | 80 +++-- .../popupMessageHandlers/settings.ts | 6 +- .../popupMessageHandlers/websiteAccess.ts | 18 +- app/ts/background/popupMessageRouting.ts | 8 +- app/ts/background/popupSettingsCommands.ts | 8 +- .../background/popupSimulationRefreshQueue.ts | 2 +- .../background/popupVisualisationUpdater.ts | 9 +- app/ts/background/providerMessageHandlers.ts | 22 +- .../background/safeConfirmationPersistence.ts | 2 +- app/ts/background/safeStackHandlers.ts | 2 +- app/ts/background/simulationModeHandlers.ts | 6 +- app/ts/background/walletSwitch.ts | 60 ++-- app/ts/background/windows/changeChain.ts | 25 +- .../background/windows/confirmTransaction.ts | 6 +- .../background/windows/interceptorAccess.ts | 36 +-- app/ts/simulation/serviceLifecycle.ts | 7 +- docs/popup-simulation-refresh.md | 4 + test/tests/activeSettingsConcurrency.test.ts | 108 ++++--- .../backgroundAccountPermissions.test.ts | 290 +++++++++--------- .../tests/backgroundEthAccountsTestHarness.ts | 12 +- test/tests/backgroundEthSimulateV1.test.ts | 24 +- test/tests/backgroundProviderRouting.test.ts | 154 +++++----- test/tests/backgroundSignerLifecycle.test.ts | 78 ++--- test/tests/backgroundUtilsMessaging.test.ts | 7 +- test/tests/interceptorAccessCloseRace.test.ts | 24 +- test/tests/popupClearReset.test.ts | 27 +- test/tests/popupMessageDispatcher.test.ts | 3 +- test/tests/popupSettingsChanges.test.ts | 67 ++-- test/tests/safeSignerConfirmation.suite.ts | 5 +- test/tests/safeSignerRouting.suite.ts | 15 +- 39 files changed, 664 insertions(+), 621 deletions(-) diff --git a/app/ts/background/accessManagement.ts b/app/ts/background/accessManagement.ts index 47cafc39c..effa3bf38 100644 --- a/app/ts/background/accessManagement.ts +++ b/app/ts/background/accessManagement.ts @@ -15,7 +15,7 @@ import type { AddressBookEntries, AddressBookEntry } from '../types/addressBookT import { Semaphore } from '../utils/semaphore.js' import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' -import type { ResetSimulationServices } from '../simulation/serviceLifecycle.js' +import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import { mergeStoredWebsiteMetadata } from '../utils/websiteIcons.js' import { reportUnexpectedError } from '../utils/errors.js' import { bumpPopupRefreshGeneration } from './popupRefreshGeneration.js' @@ -232,12 +232,12 @@ export async function getAssociatedAddresses(settings: Settings, websiteOrigin: return getUniqueItemsByProperties(all, ['address']) } -async function askUserForAccessOnConnectionUpdate(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, websiteOrigin: string, activeAddress: AddressBookEntry | undefined, settings: Settings) { +async function askUserForAccessOnConnectionUpdate(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, websiteOrigin: string, activeAddress: AddressBookEntry | undefined, settings: Settings) { const details = getWebsiteSocketConnection(websiteTabConnections, socket) if (details === undefined) return const website = { websiteOrigin, ...await retrieveWebsiteDetails(socket.tabId, websiteOrigin) } - await requestAccessFromUser(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, socket, website, undefined, activeAddress, settings, activeAddress, undefined) + await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, website, undefined, activeAddress, settings, activeAddress, undefined) } function addIconRefreshTarget(iconRefreshTargets: Map, tabId: number, websiteOrigin: string) { @@ -273,7 +273,7 @@ async function updateTabConnections( return iconRefreshTargets } -async function promptForWebsiteAccesses(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, throwOnError = false) { +async function promptForWebsiteAccesses(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, throwOnError = false) { for (const tabConnection of websiteTabConnections.values()) { for (const connection of Object.values(tabConnection.connections)) { if (!connection.wantsToConnect) continue @@ -282,7 +282,7 @@ async function promptForWebsiteAccesses(ethereum: EthereumClientService, tokenPr const settings = await getSettings() const { activeAddress, access } = await getConnectionAccess(websiteTabConnections, connection, settings) if (access !== 'askAccess') continue - await askUserForAccessOnConnectionUpdate(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, connection.socket, connection.websiteOrigin, activeAddress, settings) + await askUserForAccessOnConnectionUpdate(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, connection.socket, connection.websiteOrigin, activeAddress, settings) } catch (error) { if (throwOnError) throw error await reportUnexpectedError(error) @@ -425,7 +425,7 @@ export async function reconcileWebsiteApprovalAccesses( export async function finishWebsiteAccessUpdate( ethereum: EthereumClientService | undefined, tokenPriceService: TokenPriceService | undefined, - resetSimulationServices: ResetSimulationServices | undefined, + simulationServicesOwner: SimulationServicesOwner | undefined, websiteTabConnections: WebsiteTabConnections, update: WebsiteAccessUpdate, promptForAccessesIfNeeded: boolean, @@ -433,8 +433,8 @@ export async function finishWebsiteAccessUpdate( ) { const iconRefreshTargets = new Map() for (const target of update.iconRefreshTargets) addIconRefreshTarget(iconRefreshTargets, target.tabId, target.websiteOrigin) - if (promptForAccessesIfNeeded && ethereum !== undefined && tokenPriceService !== undefined && resetSimulationServices !== undefined) { - await promptForWebsiteAccesses(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, throwOnError) + if (promptForAccessesIfNeeded && ethereum !== undefined && tokenPriceService !== undefined && simulationServicesOwner !== undefined) { + await promptForWebsiteAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, throwOnError) } try { for (const tabState of await getAllTabStates()) { @@ -454,21 +454,21 @@ export async function finishWebsiteAccessUpdate( export async function updateWebsiteApprovalAccesses( ethereum: EthereumClientService | undefined, tokenPriceService: TokenPriceService | undefined, - resetSimulationServices: ResetSimulationServices | undefined, + simulationServicesOwner: SimulationServicesOwner | undefined, websiteTabConnections: WebsiteTabConnections, settings: Settings, promptForAccessesIfNeeded: boolean, throwOnError = false, ): Promise { const update = await reconcileWebsiteApprovalAccesses(websiteTabConnections, settings, throwOnError) - await finishWebsiteAccessUpdate(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, update, promptForAccessesIfNeeded, throwOnError) + await finishWebsiteAccessUpdate(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, update, promptForAccessesIfNeeded, throwOnError) return update.popupRefreshGeneration } export async function finalizeWebsiteAccessChange( ethereum: EthereumClientService | undefined, tokenPriceService: TokenPriceService | undefined, - resetSimulationServices: ResetSimulationServices | undefined, + simulationServicesOwner: SimulationServicesOwner | undefined, websiteTabConnections: WebsiteTabConnections, settings: Settings, promptForAccessesIfNeeded: boolean, @@ -476,7 +476,7 @@ export async function finalizeWebsiteAccessChange( await updateWebsiteApprovalAccesses( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, settings, promptForAccessesIfNeeded, @@ -488,7 +488,7 @@ export async function finalizeWebsiteAccessChange( export async function persistWebsiteAccessChange( ethereum: EthereumClientService | undefined, tokenPriceService: TokenPriceService | undefined, - resetSimulationServices: ResetSimulationServices | undefined, + simulationServicesOwner: SimulationServicesOwner | undefined, websiteTabConnections: WebsiteTabConnections, website: Website, access: boolean, @@ -499,7 +499,7 @@ export async function persistWebsiteAccessChange( return await finalizeWebsiteAccessChange( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, await getSettings(), promptForAccessesIfNeeded, diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index 491d028d2..aadff3e2f 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -1,10 +1,8 @@ import { publishFailedPopupVisualisation } from './popupVisualisationUpdater.js' import { queuePopupSimulationRefresh } from './popupSimulationRefreshQueue.js' -import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' -import type { ResetSimulationServices, SimulationServices } from '../simulation/serviceLifecycle.js' -import type { TokenPriceService } from '../simulation/services/priceEstimator.js' +import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import type { SigningAddressPreference } from '../types/signerTypes.js' -import { getRpcNetworkChange, getRpcChangeRoute } from '../utils/rpcNetworkChange.js' +import { getRpcNetworkChange } from '../utils/rpcNetworkChange.js' import type { RpcNetwork } from '../types/rpc.js' import type { WebsiteTabConnections } from '../types/user-interface-types.js' import { Semaphore } from '../utils/semaphore.js' @@ -12,9 +10,8 @@ import type { WebsiteAccessUpdate } from './accessManagement.js' import { reconcileWebsiteApprovalAccesses, finishWebsiteAccessUpdate, sendActiveAccountChangeToApprovedWebsitePorts, sendMessageToApprovedWebsitePorts } from './accessManagement.js' import { sendPopupMessageToOpenWindows } from './backgroundUtils.js' import { bumpPopupRefreshGeneration } from './popupRefreshGeneration.js' -import { sendCallbackToConfirmedSignerOwner } from './signerStateOwnership.js' import { changeSimulationMode, getSettings, setUseSignersAddressAsActiveAddress, trackPreviousActiveAddressForMakeMeRichList } from './settings.js' -import { promoteRpcAsPrimary, updateTransactionState } from './storageVariables.js' +import { updateTransactionState } from './storageVariables.js' import type { ActiveAddressSelection } from '../utils/activeAddressSelection.js' import { rememberSigningAddressSelection } from './signingAddressSelection.js' import { activeStackContextsEqual, getActiveStackContext, operationBelongsToActiveStackContext } from '../utils/activeStackContext.js' @@ -48,9 +45,9 @@ async function clearSimulationStateFromConfig() { }) } -export async function resetSimulationStateFromConfig(ethereum: EthereumClientService, tokenPriceService: TokenPriceService) { +export async function resetSimulationStateFromConfig(simulationServicesOwner: SimulationServicesOwner) { await clearSimulationStateFromConfig() - await queuePopupSimulationRefresh({ ethereum, tokenPriceService, invalidateOldState: true }) + await queuePopupSimulationRefresh({ ...simulationServicesOwner.getCurrent(), invalidateOldState: true }) } const keepTrackOfPreviousAddressForRichList = async () => { @@ -74,14 +71,12 @@ type ActiveSettingsTransition = { const changeActiveAddressAndChainSemaphore = new Semaphore(1) async function runActiveSettingsChange( - activeServices: SimulationServices, - resetSimulationServices: ResetSimulationServices, + simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, transition: ActiveSettingsTransition, ): Promise { const { change } = transition let accessUpdate: WebsiteAccessUpdate | undefined - // This pair is the sole service reference for the transition and is replaced when an endpoint is installed. try { // Settings, approvals, resets, notifications and selection preferences form one ordered transition. await changeActiveAddressAndChainSemaphore.execute(async () => { @@ -116,7 +111,7 @@ async function runActiveSettingsChange( // The preference belongs to the committed selection, even if later provider preparation fails. if (transition.signingPreference !== undefined) await rememberSigningAddressSelection(transition.signingPreference) // A signer-only chain has no provider to install; simulation is disabled until a configured endpoint is selected. - if (rpcEndpointChanged && change.rpcNetwork?.httpsRpc !== undefined) activeServices = resetSimulationServices(change.rpcNetwork) + if (rpcEndpointChanged && change.rpcNetwork?.httpsRpc !== undefined) simulationServicesOwner.reset(change.rpcNetwork) if (updatedSettings.simulationMode && rpcChainChanged) await clearSimulationStateFromConfig() } finally { // Publish committed settings even if installing their services fails. @@ -137,32 +132,29 @@ async function runActiveSettingsChange( } // External-wallet signing has no simulated stack; Safe signing retains its separate stack visualization. if ((updatedSettings.simulationMode || updatedSettings.activeSigningSafeAddress !== undefined) && (rpcEndpointChanged || !activeStackContextsEqual(getActiveStackContext(previousSettings), getActiveStackContext(updatedSettings)))) { - await queuePopupSimulationRefresh(activeServices) + await queuePopupSimulationRefresh(simulationServicesOwner.getCurrent()) } await sendActiveAccountChangeToApprovedWebsitePorts(websiteTabConnections, await getSettings()) }) } finally { // Complete committed access updates after releasing the semaphore, even if a later reset or notification fails. if (accessUpdate !== undefined) { - await finishWebsiteAccessUpdate(activeServices.ethereum, activeServices.tokenPriceService, resetSimulationServices, websiteTabConnections, accessUpdate, change.promptForAccessesIfNeeded ?? true) + const services = simulationServicesOwner.getCurrent() + await finishWebsiteAccessUpdate(services.ethereum, services.tokenPriceService, simulationServicesOwner, websiteTabConnections, accessUpdate, change.promptForAccessesIfNeeded ?? true) } } } export async function changeActiveAddressAndChain( - ethereum: EthereumClientService, - tokenPriceService: TokenPriceService, - resetSimulationServices: ResetSimulationServices, + simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, change: ActiveAddressAndChainChange, ): Promise { - return await runActiveSettingsChange({ ethereum, tokenPriceService }, resetSimulationServices, websiteTabConnections, { change }) + return await runActiveSettingsChange(simulationServicesOwner, websiteTabConnections, { change }) } export async function activateAddressSelection( - ethereum: EthereumClientService, - tokenPriceService: TokenPriceService, - resetSimulationServices: ResetSimulationServices, + simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, selection: ActiveAddressSelection | undefined, options: { @@ -180,7 +172,7 @@ export async function activateAddressSelection( : selectedSafe === undefined ? { signerAddress: options.signerAddress, selection: 'signer' } : { signerAddress: options.signerAddress, selection: 'safe', safeAddress: selectedSafe.address, chainId: selectedSafe.chainId } - return await runActiveSettingsChange({ ethereum, tokenPriceService }, resetSimulationServices, websiteTabConnections, { + return await runActiveSettingsChange(simulationServicesOwner, websiteTabConnections, { change: { simulationMode: options.simulationMode, activeAddress: selection?.type === 'signer' ? selection.address : selection?.entry.address, @@ -195,25 +187,3 @@ export async function activateAddressSelection( ...(signingPreference === undefined ? {} : { signingPreference }), }) } - -export async function changeActiveRpc(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, simulationMode: boolean, signerTabId: number | undefined, walletSwitchRequestId: string = crypto.randomUUID()) { - const currentRpc = (await getSettings()).activeRpcNetwork - const route = getRpcChangeRoute(currentRpc, rpcNetwork, simulationMode) - if (route === 'unchanged') { - await promoteRpcAsPrimary(rpcNetwork) - return simulationMode ? { type: 'completedLocally' as const } : { type: 'signerRequestNotNeeded' as const } - } - if (route === 'local') { - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { simulationMode, rpcNetwork }) - await promoteRpcAsPrimary(rpcNetwork) - return simulationMode ? { type: 'completedLocally' as const } : { type: 'signerRequestNotNeeded' as const } - } - const signerStateToken = signerTabId !== undefined - && sendCallbackToConfirmedSignerOwner(websiteTabConnections, signerTabId, { method: 'request_signer_to_wallet_switchEthereumChain', result: rpcNetwork.chainId, walletSwitchRequestId }) - const settings = await getSettings() - const popupRefreshGeneration = bumpPopupRefreshGeneration() - await sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: settings, popupRefreshGeneration }) - return signerStateToken === false - ? { type: 'signerUnavailable' as const } - : { type: 'signerRequestSent' as const, signerStateToken } -} diff --git a/app/ts/background/background-startup.ts b/app/ts/background/background-startup.ts index bf07b186b..43f175065 100644 --- a/app/ts/background/background-startup.ts +++ b/app/ts/background/background-startup.ts @@ -26,7 +26,7 @@ import { updateDeclarativeNetRequestBlocks } from './accessManagement.js' import { updatePopupVisualisationIfNeeded } from './popupVisualisationUpdater.js' import { POPUP_PERFORMANCE_MARKS, markPerformance } from '../utils/popupPerformance.js' import { removeWebsiteTabConnection } from './websiteTabConnections.js' -import { createSimulationServicesOwner, type SimulationServicesOwner, type ResetSimulationServices } from '../simulation/serviceLifecycle.js' +import { createSimulationServicesOwner, type SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import { addWindowTabListeners } from '../utils/popupOrTab.js' import { migrateAddressBook } from './addressBookMigration.js' import { migrateWebsiteAccess } from './websiteAccessMigration.js' @@ -132,7 +132,7 @@ if (isManifestV2) { const pendingRequestLimiter = new Semaphore(40) // only allow 40 requests pending globally -async function onContentScriptConnected(waitForStartup: () => Promise<{ resetActiveRpcNetwork: ResetSimulationServices }>, port: browser.runtime.Port, websiteTabConnections: WebsiteTabConnections) { +async function onContentScriptConnected(waitForStartup: () => Promise<{ simulationServicesOwner: SimulationServicesOwner }>, port: browser.runtime.Port, websiteTabConnections: WebsiteTabConnections) { const socket = getSocketFromPort(port) if (port?.sender?.url === undefined || socket === undefined) { printError(`Could not connect to a port: ${ port.name}`) @@ -180,7 +180,7 @@ async function onContentScriptConnected(waitForStartup: () => Promise<{ resetAct checkAndThrowRuntimeLastError() }) if (!shouldHandleRequest) return - const { resetActiveRpcNetwork } = await getConnectionInitializationPromise() + const { simulationServicesOwner } = await getConnectionInitializationPromise() await pendingRequestLimiter.execute(async () => { const request = { method: rawMessage.method, @@ -192,7 +192,7 @@ async function onContentScriptConnected(waitForStartup: () => Promise<{ resetAct } // A connected port outlives RPC switches; select services only when its queued request starts. const simulationServices = getSimulationServices() - return await handleInterceptedRequest(port, websiteOrigin, websitePromise, simulationServices.ethereum, simulationServices.tokenPriceService, resetActiveRpcNetwork, socket, request, websiteTabConnections, rpcConnectionStatusPublisher.publishRpcConnectionStatus) + return await handleInterceptedRequest(port, websiteOrigin, websitePromise, simulationServices.ethereum, simulationServices.tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, rpcConnectionStatusPublisher.publishRpcConnectionStatus) }) }) }, @@ -244,7 +244,7 @@ async function newBlockAttemptCallback(blockheader: EthereumBlockHeader, ethereu const settings = await getSettings() if (settings.simulationMode) { const { ethereum, tokenPriceService } = getSimulationServices() - const updatePopupVisualisationPromise = updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, false, false) + const updatePopupVisualisationPromise = updatePopupVisualisationIfNeeded(ethereum, tokenPriceService) silenceChromeUnCaughtPromise(updatePopupVisualisationPromise) return await sendSubscriptionMessagesForNewBlock(blockheader.number, ethereumClientService, settings.simulationMode, websiteTabConnections, simulateCurrentStack) } @@ -318,7 +318,7 @@ async function waitForBackgroundStartup() { const owner = simulationServicesOwner if (owner === undefined) throw new Error('Background startup reset handler is not initialized') return { - resetActiveRpcNetwork: owner.reset, + simulationServicesOwner: owner, } } @@ -352,10 +352,10 @@ browser.runtime.onConnect.addListener((port) => catchAllErrorsAndCall(async () = return await onContentScriptConnected(waitForBackgroundStartup, port, websiteTabConnections) })) browser.runtime.onMessage.addListener((message: unknown) => Promise.resolve(catchAllErrorsAndCall(async () => { - const { resetActiveRpcNetwork } = await waitForBackgroundStartup() + const { simulationServicesOwner } = await waitForBackgroundStartup() const settings = await getSettings() // A preceding popup RPC switch can replace services while settings are being read. const simulationServices = getSimulationServices() - return await popupMessageHandler(websiteTabConnections, simulationServices.ethereum, simulationServices.tokenPriceService, resetActiveRpcNetwork, message, settings, rpcConnectionStatusPublisher.publishRpcConnectionStatus) + return await popupMessageHandler(websiteTabConnections, simulationServices.ethereum, simulationServices.tokenPriceService, simulationServicesOwner, message, settings, rpcConnectionStatusPublisher.publishRpcConnectionStatus) }))) addWindowTabListeners(onCloseWindow, onCloseTab) diff --git a/app/ts/background/background.ts b/app/ts/background/background.ts index d181d5f74..203d9f340 100644 --- a/app/ts/background/background.ts +++ b/app/ts/background/background.ts @@ -25,7 +25,7 @@ import { makeSureInterceptorIsNotSleeping } from './sleeping.js' import type { PublishRpcConnectionStatus } from './rpcSlowRequestTracking.js' import { buildExecutionSimulationStateFromPreparedInput, getCurrentSimulationInput, getUpdatedSimulationStackSnapshot, prepareSimulationInputForRpc } from './simulationUpdating.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' -import type { ResetSimulationServices } from '../simulation/serviceLifecycle.js' +import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import { getWalletSelectedAccount, isActiveSigningSafe } from '../utils/activeAddressSelection.js' import { isAccountConnectionMethod, isAccountOnlyMethod } from './accountRequestMethods.js' import type { ErrorWithCodeAndOptionalData } from '../types/error.js' @@ -62,7 +62,7 @@ const isInternalProviderMethod = (method: string) => INTERNAL_PROVIDER_METHODS.s async function handleRPCRequest( ethereum: EthereumClientService, tokenPriceService: TokenPriceService, - resetSimulationServices: ResetSimulationServices, + simulationServicesOwner: SimulationServicesOwner, getSimulationInput: () => Promise, getExecutionSimulationState: () => Promise, websiteTabConnections: WebsiteTabConnections, @@ -164,7 +164,7 @@ async function handleRPCRequest( eth_signTypedData_v2: rpcRequestHandler('eth_signTypedData_v2', async (_context, rpcRequest) => await signMessage(rpcRequest)), eth_signTypedData_v3: rpcRequestHandler('eth_signTypedData_v3', async (_context, rpcRequest) => await signMessage(rpcRequest)), eth_signTypedData_v4: rpcRequestHandler('eth_signTypedData_v4', async (_context, rpcRequest) => await signMessage(rpcRequest)), - wallet_switchEthereumChain: rpcRequestHandler('wallet_switchEthereumChain', async (_context, rpcRequest) => await switchEthereumChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, rpcRequest, request, settings.simulationMode, website)), + wallet_switchEthereumChain: rpcRequestHandler('wallet_switchEthereumChain', async (_context, rpcRequest) => await switchEthereumChain(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, rpcRequest, request, settings.simulationMode, website)), wallet_watchAsset: rpcRequestHandler('wallet_watchAsset', async (_context, rpcRequest) => await handleWatchAssetRequest(ethereum, websiteTabConnections, request, website, rpcRequest, {}, activeAddress)), wallet_requestPermissions: rpcRequestHandler('wallet_requestPermissions', async () => await requestPermissions(activeAddress, website)), wallet_getPermissions: rpcRequestHandler('wallet_getPermissions', async () => await getPermissions(activeAddress, website)), @@ -280,7 +280,7 @@ function replayProviderStateForAccountRequest(websiteTabConnections: WebsiteTabC async function persistApprovedAccountsForAccountRequest( ethereum: EthereumClientService, tokenPriceService: TokenPriceService, - resetSimulationServices: ResetSimulationServices, + simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, request: InterceptedRequest, website: Website, @@ -299,7 +299,7 @@ async function persistApprovedAccountsForAccountRequest( await persistWebsiteAccessChange( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, website, true, @@ -312,7 +312,7 @@ async function persistApprovedAccountsForAccountRequest( async function revokeWebsitePermissions( ethereum: EthereumClientService, tokenPriceService: TokenPriceService, - resetSimulationServices: ResetSimulationServices, + simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, websiteOrigin: string, ) { @@ -326,7 +326,7 @@ async function revokeWebsitePermissions( } })) clearWebsiteConnectionIntent(websiteTabConnections, websiteOrigin) - await finalizeWebsiteAccessChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, await getSettings(), false) + await finalizeWebsiteAccessChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), false) return { type: 'result' as const, method: 'wallet_revokePermissions' as const, result: null } } @@ -388,12 +388,12 @@ function replyWithSignerAccountError(websiteTabConnections: WebsiteTabConnection }) } -export const handleInterceptedRequest = async (port: browser.runtime.Port | undefined, websiteOrigin: string, websitePromise: Promise | Website, ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, socket: WebsiteSocket, request: InterceptedRequest, websiteTabConnections: WebsiteTabConnections, publishRpcConnectionStatus: PublishRpcConnectionStatus): Promise => { +export const handleInterceptedRequest = async (port: browser.runtime.Port | undefined, websiteOrigin: string, websitePromise: Promise | Website, ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, socket: WebsiteSocket, request: InterceptedRequest, websiteTabConnections: WebsiteTabConnections, publishRpcConnectionStatus: PublishRpcConnectionStatus): Promise => { const initialSettings = await getSettings() if (request.method === 'wallet_revokePermissions') { const parsedRequest = parseWalletRevokePermissionsRequest(websiteTabConnections, request) if (parsedRequest === undefined) return - const result = await revokeWebsitePermissions(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, websiteOrigin) + const result = await revokeWebsitePermissions(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, websiteOrigin) return replyToInterceptedRequest(websiteTabConnections, { ...getRequestWithDefinedParams(request), ...result }) } const initialActiveAddress = await getActiveAddressForRequest(initialSettings, websiteTabConnections, socket.tabId) @@ -408,7 +408,7 @@ export const handleInterceptedRequest = async (port: browser.runtime.Port | unde const providerCallbackActiveAddress = initialActiveAddress !== undefined && getWebsiteAddressAccessApprovalState(initialSettings.websiteAccess, websiteOrigin, initialActiveAddress) === 'hasAccess' ? initialActiveAddress.address : undefined - const providerHandlerReturn = await providerHandler.func(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, port, request, providerCallbackApproval, providerCallbackActiveAddress) + const providerHandlerReturn = await providerHandler.func(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, port, request, providerCallbackApproval, providerCallbackActiveAddress) if (providerHandlerReturn.type === 'doNotReply') return const message: InpageScriptRequest = { uniqueRequestIdentifier: request.uniqueRequestIdentifier, ...providerHandlerReturn } return replyToInterceptedRequest(websiteTabConnections, message) @@ -440,7 +440,7 @@ export const handleInterceptedRequest = async (port: browser.runtime.Port | unde const signerAccountsResult = await askForSignerAccountsFromSignerIfNotAvailable(websiteTabConnections, socket, true) if (isTerminalSignerAccountConnectionError(signerAccountsResult.error)) return replyWithSignerAccountError(websiteTabConnections, request, signerAccountsResult.error) if (signerAccountsResult.accounts.length === 0) return refuseAccess(websiteTabConnections, request) - const result: unknown = await handleInterceptedRequest(port, websiteOrigin, websitePromise, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, publishRpcConnectionStatus) + const result: unknown = await handleInterceptedRequest(port, websiteOrigin, websitePromise, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, publishRpcConnectionStatus) return result } if (access === 'hasAccess' && activeAddress === undefined && (request.method === 'eth_accounts' || request.method === 'wallet_getPermissions' || request.method === 'wallet_getCapabilities') && (!settings.simulationMode || settings.useSignersAddressAsActiveAddress)) { @@ -465,7 +465,7 @@ export const handleInterceptedRequest = async (port: browser.runtime.Port | unde if (refreshedActiveAddress === undefined) return replyWithoutActiveAccount(websiteTabConnections, request) const refreshedAccess = verifyAccess(websiteTabConnections, socket, false, websiteOrigin, refreshedActiveAddress, refreshedSettings, { ignoreConnectionApproval: true }) if (refreshedAccess !== 'hasAccess') return replyWithoutActiveAccount(websiteTabConnections, request) - return await handleContentScriptMessage(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, request, await websitePromise, refreshedActiveAddress, publishRpcConnectionStatus) + return await handleContentScriptMessage(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, request, await websitePromise, refreshedActiveAddress, publishRpcConnectionStatus) } if (access === 'noAccess' || activeAddress === undefined) { @@ -480,18 +480,18 @@ export const handleInterceptedRequest = async (port: browser.runtime.Port | unde } switch (access) { - case 'askAccess': return await gateKeepRequestBehindAccessDialog(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, socket, request, await websitePromise, activeAddress, await getSettings(), publishRpcConnectionStatus) + case 'askAccess': return await gateKeepRequestBehindAccessDialog(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, request, await websitePromise, activeAddress, await getSettings(), publishRpcConnectionStatus) case 'noAccess': return refuseAccess(websiteTabConnections, request) case 'hasAccess': { if (activeAddress === undefined) return refuseAccess(websiteTabConnections, request) const website = await websitePromise - return await handleContentScriptMessage(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, request, website, activeAddress, publishRpcConnectionStatus) + return await handleContentScriptMessage(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, request, website, activeAddress, publishRpcConnectionStatus) } default: assertNever(access) } } -async function handleContentScriptMessage(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, request: InterceptedRequest, website: Website, activeAddress: AddressBookEntry, publishRpcConnectionStatus: PublishRpcConnectionStatus) { +async function handleContentScriptMessage(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, request: InterceptedRequest, website: Website, activeAddress: AddressBookEntry, publishRpcConnectionStatus: PublishRpcConnectionStatus) { try { const requestWithDefinedParams = getRequestWithDefinedParams(request) const settings = await getSettings() @@ -524,11 +524,11 @@ async function handleContentScriptMessage(ethereum: EthereumClientService, token })() return await executionSimulationStatePromise } - const resolved = await handleRPCRequest(ethereum, tokenPriceService, resetSimulationServices, getSimulationInput, getExecutionSimulationState, websiteTabConnections, request.uniqueRequestIdentifier.requestSocket, website, rpcContext, settings, activeAddress.address, publishRpcConnectionStatus, simulationOverlayEnabled, safeSigningMode, walletSelectedSafeSigner) + const resolved = await handleRPCRequest(ethereum, tokenPriceService, simulationServicesOwner, getSimulationInput, getExecutionSimulationState, websiteTabConnections, request.uniqueRequestIdentifier.requestSocket, website, rpcContext, settings, activeAddress.address, publishRpcConnectionStatus, simulationOverlayEnabled, safeSigningMode, walletSelectedSafeSigner) await persistApprovedAccountsForAccountRequest( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, request, website, @@ -567,6 +567,6 @@ export function refuseAccess(websiteTabConnections: WebsiteTabConnections, reque }) } -async function gateKeepRequestBehindAccessDialog(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, request: InterceptedRequest, website: Website, activeAddress: AddressBookEntry | undefined, settings: Settings, publishRpcConnectionStatus: PublishRpcConnectionStatus) { - return await requestAccessFromUser(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, socket, website, request, activeAddress, settings, activeAddress, publishRpcConnectionStatus) +async function gateKeepRequestBehindAccessDialog(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, request: InterceptedRequest, website: Website, activeAddress: AddressBookEntry | undefined, settings: Settings, publishRpcConnectionStatus: PublishRpcConnectionStatus) { + return await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, website, request, activeAddress, settings, activeAddress, publishRpcConnectionStatus) } diff --git a/app/ts/background/popupMessageDispatcher.ts b/app/ts/background/popupMessageDispatcher.ts index 85bfd66c3..b7aebd0ab 100644 --- a/app/ts/background/popupMessageDispatcher.ts +++ b/app/ts/background/popupMessageDispatcher.ts @@ -25,9 +25,9 @@ const popupMessageHandlers = { }), popup_refreshConfirmTransactionDialogSimulation: popupMessageHandler('popup_refreshConfirmTransactionDialogSimulation', async (context) => await refreshPopupConfirmTransactionSimulation(context.ethereum, context.tokenPriceService)), popup_refreshConfirmTransactionMetadata: popupMessageHandler('popup_refreshConfirmTransactionMetadata', async (context) => await refreshPopupConfirmTransactionMetadata(context.ethereum, context.tokenPriceService, context.confirmTransactionAbortController)), - popup_changeChainDialog: popupMessageHandler('popup_changeChainDialog', async (context, request) => await changeChainDialog(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), + popup_changeChainDialog: popupMessageHandler('popup_changeChainDialog', async (context, request) => await changeChainDialog(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), popup_watchAssetDialog: popupMessageHandler('popup_watchAssetDialog', async (context, request) => await watchAssetDialog(context.websiteTabConnections, request)), - popup_setSafeSimulationSigner: popupMessageHandler('popup_setSafeSimulationSigner', async (context, request) => await setSafeSimulationSigner(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), + popup_setSafeSimulationSigner: popupMessageHandler('popup_setSafeSimulationSigner', async (context, request) => await setSafeSimulationSigner(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), popup_requestNewHomeData: popupMessageHandler('popup_requestNewHomeData', async (context, request) => await requestNewHomeData(context.ethereum, context.websiteTabConnections, request.data.refreshSignerAccounts, request.data.includeWebsiteAccessAddressMetadata, context.simulationAbortController, bumpPopupRefreshGeneration())), popup_requestHomePageBootstrap: popupMessageHandler('popup_requestHomePageBootstrap', async (context) => await requestHomePageBootstrap(context.websiteTabConnections, bumpPopupRefreshGeneration())), popup_refreshHomeData: popupMessageHandler('popup_refreshHomeData', async (context) => await refreshHomeData(context.ethereum, context.tokenPriceService, context.websiteTabConnections, true, bumpPopupRefreshGeneration(), context.publishRpcConnectionStatus)), diff --git a/app/ts/background/popupMessageHandlerRegistries/addressBook.ts b/app/ts/background/popupMessageHandlerRegistries/addressBook.ts index c9584492c..6bb297789 100644 --- a/app/ts/background/popupMessageHandlerRegistries/addressBook.ts +++ b/app/ts/background/popupMessageHandlerRegistries/addressBook.ts @@ -2,9 +2,9 @@ import { popupMessageHandler, type PopupMessageHandlerMap } from '../popupMessag import { addOrModifyAddressBookEntry, changeAddOrModifyAddressWindowState, getAddressBookData, openNewTab, removeAddressBookEntry, requestAbiAndNameFromBlockExplorer, requestIdentifyAddress, setEnsNameForHash } from '../popupMessageHandlers.js' export const addressBookPopupMessageHandlers = { - popup_addOrModifyAddressBookEntry: popupMessageHandler('popup_addOrModifyAddressBookEntry', async (context, request) => await addOrModifyAddressBookEntry(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), + popup_addOrModifyAddressBookEntry: popupMessageHandler('popup_addOrModifyAddressBookEntry', async (context, request) => await addOrModifyAddressBookEntry(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), popup_getAddressBookData: popupMessageHandler('popup_getAddressBookData', async (_context, request) => await getAddressBookData(request)), - popup_removeAddressBookEntry: popupMessageHandler('popup_removeAddressBookEntry', async (context, request) => await removeAddressBookEntry(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), + popup_removeAddressBookEntry: popupMessageHandler('popup_removeAddressBookEntry', async (context, request) => await removeAddressBookEntry(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), popup_openAddressBook: popupMessageHandler('popup_openAddressBook', async () => await openNewTab('addressBook')), popup_changeAddOrModifyAddressWindowState: popupMessageHandler('popup_changeAddOrModifyAddressWindowState', async (context, request) => await changeAddOrModifyAddressWindowState(context.ethereum, request)), popup_requestAbiAndNameFromBlockExplorer: popupMessageHandler('popup_requestAbiAndNameFromBlockExplorer', async (_context, request) => await requestAbiAndNameFromBlockExplorer(request)), diff --git a/app/ts/background/popupMessageHandlerRegistries/settings.ts b/app/ts/background/popupMessageHandlerRegistries/settings.ts index 1b657668f..fb1fc49ef 100644 --- a/app/ts/background/popupMessageHandlerRegistries/settings.ts +++ b/app/ts/background/popupMessageHandlerRegistries/settings.ts @@ -6,16 +6,16 @@ import { getSettings } from '../settings.js' export const settingsPopupMessageHandlers = { popup_requestSettings: popupMessageHandler('popup_requestSettings', async () => await settingsOpened()), - popup_ChangeSettings: popupMessageHandler('popup_ChangeSettings', async (context, request) => await changeSettings(context.ethereum, context.tokenPriceService, context.resetSimulationServices, request, context.simulationAbortController)), + popup_ChangeSettings: popupMessageHandler('popup_ChangeSettings', async (context, request) => await changeSettings(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, request, context.simulationAbortController)), popup_openSettings: popupMessageHandler('popup_openSettings', async () => await openNewTab('settingsView')), popup_import_settings: popupMessageHandler('popup_import_settings', async (context, request) => { const importSettingsReply = await importSettings(request) await sendPopupMessageToOpenWindows(importSettingsReply) if (!importSettingsReply.data.success) return const importedSettings = await getSettings() - const popupRefreshGeneration = await updateWebsiteApprovalAccesses(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, importedSettings, true) + const popupRefreshGeneration = await updateWebsiteApprovalAccesses(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, importedSettings, true) await sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: importedSettings, popupRefreshGeneration }) }), popup_get_export_settings: popupMessageHandler('popup_get_export_settings', async () => await exportSettings()), - popup_set_rpc_list: popupMessageHandler('popup_set_rpc_list', async (context, request) => await setNewRpcList(context.resetSimulationServices, request, context.settings)), + popup_set_rpc_list: popupMessageHandler('popup_set_rpc_list', async (context, request) => await setNewRpcList(context.simulationServicesOwner, request, context.settings)), } satisfies Partial diff --git a/app/ts/background/popupMessageHandlerRegistries/websiteAccess.ts b/app/ts/background/popupMessageHandlerRegistries/websiteAccess.ts index b35d5a691..c37b6440f 100644 --- a/app/ts/background/popupMessageHandlerRegistries/websiteAccess.ts +++ b/app/ts/background/popupMessageHandlerRegistries/websiteAccess.ts @@ -3,16 +3,16 @@ import { popupMessageHandler, type PopupMessageHandlerMap } from '../popupMessag import { allowOrPreventAddressAccessForWebsite, blockOrAllowExternalRequests, changeInterceptorAccess, confirmRequestAccess, disableInterceptor, interceptorAccessChangeAddressOrRefresh, openNewTab, removeWebsiteAccess, removeWebsiteAddressAccess, retrieveWebsiteAccess } from '../popupMessageHandlers.js' export const websiteAccessPopupMessageHandlers = { - popup_interceptorAccess: popupMessageHandler('popup_interceptorAccess', async (context, request) => await confirmRequestAccess(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request, context.publishRpcConnectionStatus)), - popup_changeInterceptorAccess: popupMessageHandler('popup_changeInterceptorAccess', async (context, request) => await changeInterceptorAccess(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), + popup_interceptorAccess: popupMessageHandler('popup_interceptorAccess', async (context, request) => await confirmRequestAccess(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request, context.publishRpcConnectionStatus)), + popup_changeInterceptorAccess: popupMessageHandler('popup_changeInterceptorAccess', async (context, request) => await changeInterceptorAccess(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), popup_refreshInterceptorAccessMetadata: popupMessageHandler('popup_refreshInterceptorAccessMetadata', async () => await interceptorAccessMetadataRefresh()), popup_interceptorAccessChangeAddress: popupMessageHandler('popup_interceptorAccessChangeAddress', async (context, request) => await interceptorAccessChangeAddressOrRefresh(context.websiteTabConnections, request)), popup_interceptorAccessRefresh: popupMessageHandler('popup_interceptorAccessRefresh', async (context, request) => await interceptorAccessChangeAddressOrRefresh(context.websiteTabConnections, request)), - popup_setDisableInterceptor: popupMessageHandler('popup_setDisableInterceptor', async (context, request) => await disableInterceptor(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), + popup_setDisableInterceptor: popupMessageHandler('popup_setDisableInterceptor', async (context, request) => await disableInterceptor(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), popup_openWebsiteAccess: popupMessageHandler('popup_openWebsiteAccess', async () => await openNewTab('websiteAccess')), popup_retrieveWebsiteAccess: popupMessageHandler('popup_retrieveWebsiteAccess', async (_context, request) => await retrieveWebsiteAccess(request)), - popup_blockOrAllowExternalRequests: popupMessageHandler('popup_blockOrAllowExternalRequests', async (context, request) => await blockOrAllowExternalRequests(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), + popup_blockOrAllowExternalRequests: popupMessageHandler('popup_blockOrAllowExternalRequests', async (context, request) => await blockOrAllowExternalRequests(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), popup_allowOrPreventAddressAccessForWebsite: popupMessageHandler('popup_allowOrPreventAddressAccessForWebsite', async (context, request) => await allowOrPreventAddressAccessForWebsite(context.websiteTabConnections, request)), - popup_removeWebsiteAccess: popupMessageHandler('popup_removeWebsiteAccess', async (context, request) => await removeWebsiteAccess(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), - popup_removeWebsiteAddressAccess: popupMessageHandler('popup_removeWebsiteAddressAccess', async (context, request) => await removeWebsiteAddressAccess(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), + popup_removeWebsiteAccess: popupMessageHandler('popup_removeWebsiteAccess', async (context, request) => await removeWebsiteAccess(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), + popup_removeWebsiteAddressAccess: popupMessageHandler('popup_removeWebsiteAddressAccess', async (context, request) => await removeWebsiteAddressAccess(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), } satisfies Partial diff --git a/app/ts/background/popupMessageHandlerRegistry.ts b/app/ts/background/popupMessageHandlerRegistry.ts index 170d7e7a6..5aabae867 100644 --- a/app/ts/background/popupMessageHandlerRegistry.ts +++ b/app/ts/background/popupMessageHandlerRegistry.ts @@ -1,6 +1,6 @@ import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' -import type { ResetSimulationServices } from '../simulation/serviceLifecycle.js' +import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import type { PopupMessage, Settings } from '../types/interceptor-messages.js' import type { PopupReplyOption } from '../types/interceptor-reply-messages.js' import type { WebsiteTabConnections } from '../types/user-interface-types.js' @@ -11,7 +11,7 @@ export type PopupMessageDispatcherContext = { websiteTabConnections: WebsiteTabConnections ethereum: EthereumClientService tokenPriceService: TokenPriceService - resetSimulationServices: ResetSimulationServices + simulationServicesOwner: SimulationServicesOwner settings: Settings publishRpcConnectionStatus: PublishRpcConnectionStatus simulationAbortController: AbortController diff --git a/app/ts/background/popupMessageHandlers.ts b/app/ts/background/popupMessageHandlers.ts index 7d6460b75..2764c5801 100644 --- a/app/ts/background/popupMessageHandlers.ts +++ b/app/ts/background/popupMessageHandlers.ts @@ -1,6 +1,5 @@ -import { getRpcChangeRoute } from '../utils/rpcNetworkChange.js' import { refreshConfirmTransactionSimulation } from './confirmTransactionSimulation.js' -import { activateAddressSelection, changeActiveAddressAndChain, changeActiveRpc } from './activeSettings.js' +import { activateAddressSelection, changeActiveAddressAndChain } from './activeSettings.js' import { captureSimulationSnapshot, getUpdatedSimulationStackSnapshot, getUpdatedSimulationState } from './simulationUpdating.js' import { getSettings, setUseTabsInsteadOfPopup, setPage, updateWebsiteAccess, getMakeCurrentAddressRich, setMetamaskCompatibilityMode, setSafeAppsCompatibilityMode, getPage, setPreSimulationBlockTimeManipulation, getPreSimulationBlockTimeManipulation, getFixedAddressRichList, getWebsiteAccess, updateMakeCurrentAddressRich, updateFixedMakeMeRichList } from './settings.js' import { getPendingTransactionsAndMessages, getTabState, getRpcList, getPrimaryRpcForChain, getRpcConnectionStatus, updateUserAddressBookEntries, getPopupVisualisationState, setIdsOfOpenedTabs, getIdsOfOpenedTabs, updatePendingTransactionOrMessage, addEnsLabelHash, addEnsNodeHash, updateInterceptorTransactionStack, getLatestUnexpectedError, getInterceptorTransactionStack, getChainChangeConfirmationPromise, getFetchSimulationStackRequestPromise, getPendingAccessRequests, updateTransactionState, getUserAddressBookEntries, getUserAddressBookEntriesForChainIdMorePreciseFirst, getSafeTransactionStacks } from './storageVariables.js' @@ -9,7 +8,7 @@ import { type ChangeActiveAddress, type ModifyMakeMeRich, type ChangePage, type import { formEthSendTransaction, formSendRawTransaction, resolvePendingTransactionOrMessage, updateConfirmTransactionView, setGasLimitForTransaction, toPopupPendingTransactionOrSignableMessage } from './windows/confirmTransaction.js' import { askForSignerAccountsFromSignerIfNotAvailable, getAddressMetadataForAccess, refreshSignerAccountsForTab, refreshSignerAccountsFromApprovedWebsitePorts, requestAddressChange, resolveInterceptorAccess, type SignerAccountRefreshOptions } from './windows/interceptorAccess.js' import { resolveChainChange } from './windows/changeChain.js' -import { requestSignerChainChange } from './walletSwitch.js' +import { changeActiveRpc } from './walletSwitch.js' import { updateWebsiteApprovalAccesses } from './accessManagement.js' import { getActiveOrFirstSignerAddress, getHtmlFile, sendPopupMessageToOpenWindows } from './backgroundUtils.js' import { getActiveAddressForCurrentSignerState, sendCallbackToAllConfirmedSignerOwners, sendCallbackToConfirmedSignerOwner } from './signerStateOwnership.js' @@ -42,7 +41,7 @@ import { resolveFetchSimulationStackRequest } from './windows/fetchSimulationSta import { updateChainChangeViewWithPendingRequest } from './windows/changeChain.js' import { resolveWatchAsset, updateWatchAssetViewWithPendingRequest } from './windows/watchAsset.js' import { updateInterceptorAccessViewWithPendingRequests } from './windows/interceptorAccess.js' -import type { ResetSimulationServices } from '../simulation/serviceLifecycle.js' +import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import { updateFetchSimulationStackRequestWithPendingRequest } from './windows/fetchSimulationStack.js' import { estimateSerializedStateBytes, formatEstimatedBytes } from '../utils/largeStateStore.js' import { POPUP_PERFORMANCE_MARKS, markPerformance } from '../utils/popupPerformance.js' @@ -60,7 +59,7 @@ export { exportSettings, importSettings, setNewRpcList, settingsOpened } from '. export { allowOrPreventAddressAccessForWebsite, blockOrAllowExternalRequests, disableInterceptor, reloadConnectedTabs, removeWebsiteAccess, removeWebsiteAddressAccess, retrieveWebsiteAccess } from './popupMessageHandlers/websiteAccess.js' import { getLastKnownCurrentTabId } from './currentTab.js' import { disableInterceptorForPage } from './popupMessageHandlers/websiteAccess.js' -import { getConfiguredSigningSafe, getConfiguredSigningSafeForChain } from './signingAddressSelection.js' +import { getConfiguredSigningSafeForChain } from './signingAddressSelection.js' type TimestampedPopupVisualisation = { data: { @@ -130,8 +129,8 @@ export async function confirmDialog(ethereum: EthereumClientService, tokenPriceS await resolvePendingTransactionOrMessage(ethereum, tokenPriceService, websiteTabConnections, confirmation, refreshedSafeSignerSelection) } -export async function confirmRequestAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, confirmation: InterceptorAccess, publishRpcConnectionStatus: PublishRpcConnectionStatus) { - await resolveInterceptorAccess(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, confirmation.data, publishRpcConnectionStatus) +export async function confirmRequestAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, confirmation: InterceptorAccess, publishRpcConnectionStatus: PublishRpcConnectionStatus) { + await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, confirmation.data, publishRpcConnectionStatus) } export async function popupReadyAndListening(ethereum: EthereumClientService, websiteTabConnections: WebsiteTabConnections, page: PopupReadyAndListeningPage) { @@ -219,7 +218,7 @@ async function getSignerAccount() { return signerAccounts !== undefined && signerAccounts.length > 0 ? signerAccounts[0] : undefined } -export async function changeActiveAddress(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, addressChange: ChangeActiveAddress) { +export async function changeActiveAddress(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, addressChange: ChangeActiveAddress) { if (addressChange.data.activeAddress === 'signer') { await refreshSignerAccountsFromApprovedWebsitePorts(websiteTabConnections, false) sendCallbackToAllConfirmedSignerOwners(websiteTabConnections, { method: 'request_signer_chainId', result: [] }) @@ -232,7 +231,7 @@ export async function changeActiveAddress(ethereum: EthereumClientService, token if (selection === undefined) { if (!addressChange.data.simulationMode) { if (addressChange.data.activeAddress === 'signer') { - await activateAddressSelection(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, undefined, { + await activateAddressSelection(simulationServicesOwner, websiteTabConnections, undefined, { simulationMode: false, signerAddress: undefined, }) @@ -250,7 +249,7 @@ export async function changeActiveAddress(ethereum: EthereumClientService, token } return { type: 'ChangeActiveAddressReply', ok: false, message: 'The selected address is not available.' } as const } - await activateAddressSelection(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, selection, { + await activateAddressSelection(simulationServicesOwner, websiteTabConnections, selection, { simulationMode: addressChange.data.simulationMode, signerAddress: signerAccount, }) @@ -275,18 +274,18 @@ export async function modifyMakeMeRich(makeMeRichChange: ModifyMakeMeRich) { )) } -export async function removeAddressBookEntry(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, removeAddressBookEntry: RemoveAddressBookEntry) { +export async function removeAddressBookEntry(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, removeAddressBookEntry: RemoveAddressBookEntry) { await updateUserAddressBookEntries((previousContacts) => previousContacts.filter((contact) => !(contact.address === removeAddressBookEntry.data.address && (contact.chainId === removeAddressBookEntry.data.chainId || (contact.chainId === undefined && removeAddressBookEntry.data.chainId === 1n)))) ) if (removeAddressBookEntry.data.addressBookCategory === 'My Active Addresses' || removeAddressBookEntry.data.addressBookCategory === 'My Safes') { - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) } await sendPopupMessageToOpenWindows({ method: 'popup_addressBookEntriesChanged' }) } -export async function addOrModifyAddressBookEntry(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, entry: AddOrEditAddressBookEntry) { +export async function addOrModifyAddressBookEntry(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, entry: AddOrEditAddressBookEntry) { try { let entryToStore: AddressBookEntry = entry.data if (entry.data.type === 'safe') { @@ -328,7 +327,7 @@ export async function addOrModifyAddressBookEntry(ethereum: EthereumClientServic } return previousContacts.concat([entryToStore]) }) - if (entryToStore.useAsActiveAddress) await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, await getSettings(), true, true) + if (entryToStore.useAsActiveAddress) await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true, true) void sendPopupMessageToOpenWindows({ method: 'popup_addressBookEntriesChanged' }) return { type: 'AddOrModifyAddressBookEntryReply' as const, ok: true as const } } catch(error) { @@ -348,7 +347,7 @@ export async function addOrModifyAddressBookEntry(ethereum: EthereumClientServic export async function setSafeSimulationSigner( ethereum: EthereumClientService, tokenPriceService: TokenPriceService, - resetSimulationServices: ResetSimulationServices, + simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, request: SetSafeSimulationSigner, ) { @@ -407,13 +406,13 @@ export async function setSafeSimulationSigner( } } if (updatedEntry.useAsActiveAddress) { - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) } await sendPopupMessageToOpenWindows({ method: 'popup_addressBookEntriesChanged' }) return { type: 'SetSafeSimulationSignerReply' as const, ok: true as const } } -export async function changeInterceptorAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, accessChange: ChangeInterceptorAccess) { +export async function changeInterceptorAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, accessChange: ChangeInterceptorAccess) { await updateWebsiteAccess((previousAccess) => { const withEntriesRemoved = previousAccess.filter((acc) => accessChange.data.find((change) => change.newEntry.website.websiteOrigin === acc.website.websiteOrigin)?.removed !== true) return withEntriesRemoved.map((entry) => { @@ -429,7 +428,7 @@ export async function changeInterceptorAccess(ethereum: EthereumClientService, t return await disableInterceptorForPage(websiteTabConnections, disable.newEntry.website, disable.newEntry.interceptorDisabled) })) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) await sendPopupMessageToOpenWindows({ method: 'popup_interceptor_access_changed' }) } @@ -469,7 +468,7 @@ export async function removeTransactionOrSignedMessage(ethereum: EthereumClientS }, } }) - await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, true, false) + await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, { invalidateOldState: true }) return } } @@ -516,7 +515,7 @@ export async function removeTransactionOrSignedMessage(ethereum: EthereumClientS } }) - await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, true, false) + await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, { invalidateOldState: true }) } type ConfirmTransactionMetadataDependencies = { @@ -665,27 +664,18 @@ export async function refreshPopupConfirmTransactionSimulation(ethereum: Ethereu await updateConfirmTransactionView(ethereum, tokenPriceService, true) } -export async function popupChangeActiveRpc(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, params: ChangeActiveChain, settings: Settings) { - if (getRpcChangeRoute(settings.activeRpcNetwork, params.data, settings.simulationMode) === 'wallet') { - const tabId = await getLastKnownCurrentTabId() - if (tabId === undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: 'No wallet is connected to switch networks.' } as const - if (await getConfiguredSigningSafe(settings, (await getTabState(tabId)).signerAccounts) !== undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: 'This Safe is tied to its current network. Select your wallet account before switching networks.' } as const - const result = await requestSignerChainChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, params.data, tabId) - if ('error' in result && result.error !== undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: result.error.message } as const - } else { - await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, params.data, settings.simulationMode, await getLastKnownCurrentTabId()) - } +export async function popupChangeActiveRpc(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, params: ChangeActiveChain) { + const result = await changeActiveRpc(simulationServicesOwner, websiteTabConnections, params.data, { source: 'popup', signerTabId: await getLastKnownCurrentTabId() }) + if (result.error !== undefined) return { type: 'PopupSettingsChangeReply', ok: false, message: result.error.message } as const return { type: 'PopupSettingsChangeReply', ok: true } as const } -export async function changeChainDialog(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, chainChange: ChainChangeConfirmation) { - await resolveChainChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, chainChange) +export async function changeChainDialog(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, chainChange: ChainChangeConfirmation) { + await resolveChainChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, chainChange) } export async function enableSimulationMode( - ethereum: EthereumClientService, - tokenPriceService: TokenPriceService, - resetSimulationServices: ResetSimulationServices, + simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, params: EnableSimulationMode, signerAccountRefreshOptions: SignerAccountRefreshOptions = {}, @@ -711,21 +701,21 @@ export async function enableSimulationMode( const signingSelection: ActiveAddressSelection | undefined = configuredSigningSafe === undefined ? signerAccount === undefined ? undefined : getActiveAddressSelection('signer', activeChainEntries, false, targetChainId, [signerAccount]) : { type: 'addressBookEntry', entry: configuredSigningSafe } - await activateAddressSelection(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, signingSelection, { + await activateAddressSelection(simulationServicesOwner, websiteTabConnections, signingSelection, { simulationMode: false, signerAddress: signerAccount, ...(chainToSwitch === undefined || networkToSwitch === undefined ? {} : { rpcNetwork: networkToSwitch }), }) return } - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await changeActiveAddressAndChain(simulationServicesOwner, websiteTabConnections, { simulationMode: params.data, activeAddress: signerAccount, ...chainToSwitch === undefined ? {} : { rpcNetwork: networkToSwitch }, }) } else { const selectedNetworkToSwitch = settings.activeRpcNetwork.httpsRpc !== undefined ? settings.activeRpcNetwork : (await getRpcList())[0] - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await changeActiveAddressAndChain(simulationServicesOwner, websiteTabConnections, { simulationMode: params.data, ...settings.activeRpcNetwork === selectedNetworkToSwitch ? {} : { rpcNetwork: selectedNetworkToSwitch } }) @@ -858,7 +848,7 @@ export async function refreshHomeData( try { const currentSettings = await getSettings() if (currentSettings.simulationMode) await updateSimulationMetadata(ethereum, requestAbortController) - if (refreshSimulation) await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, false, false, true) + if (refreshSimulation) await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, { skipIfUnchanged: true }) const settings = await getSettings() if (settings.activeRpcNetwork.httpsRpc !== undefined) await makeSureInterceptorIsNotSleeping(ethereum, publishRpcConnectionStatus) const updatedPage = await buildHomePageUpdate(ethereum, websiteTabConnections, { @@ -878,7 +868,7 @@ export async function interceptorAccessChangeAddressOrRefresh(websiteTabConnecti await requestAddressChange(websiteTabConnections, params) } -export async function changeSettings(ethereum: EthereumClientService, _tokenPriceService: TokenPriceService, _resetSimulationServices: ResetSimulationServices, parsedRequest: ChangeSettings, requestAbortController: AbortController | undefined) { +export async function changeSettings(ethereum: EthereumClientService, _tokenPriceService: TokenPriceService, _simulationServicesOwner: SimulationServicesOwner, parsedRequest: ChangeSettings, requestAbortController: AbortController | undefined) { if (parsedRequest.data.useTabsInsteadOfPopup !== undefined) await setUseTabsInsteadOfPopup(parsedRequest.data.useTabsInsteadOfPopup) if (parsedRequest.data.metamaskCompatibilityMode !== undefined) await setMetamaskCompatibilityMode(parsedRequest.data.metamaskCompatibilityMode) if (parsedRequest.data.safeAppsCompatibilityMode !== undefined) { @@ -1009,13 +999,13 @@ export async function setEnsNameForHash(parsedRequest: SetEnsNameForHash) { export async function forceSetGasLimitForTransaction(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, parsedRequest: ForceSetGasLimitForTransaction) { await setGasLimitForTransaction(parsedRequest.data.transactionIdentifier, parsedRequest.data.gasLimit) - await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, true, false) + await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, { invalidateOldState: true }) await refreshPopupConfirmTransactionSimulation(ethereum, tokenPriceService) } export async function changePreSimulationBlockTimeManipulation(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, parsedRequest: ChangePreSimulationBlockTimeManipulation) { await setPreSimulationBlockTimeManipulation(parsedRequest.data.blockTimeManipulation) - await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, true, true) + await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, { invalidateOldState: true, onlyIfNotAlreadyUpdating: true }) } export async function setTransactionOrMessageBlockTimeManipulator(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, parsedRequest: SetTransactionOrMessageBlockTimeManipulator) { @@ -1047,13 +1037,13 @@ export async function setTransactionOrMessageBlockTimeManipulator(ethereum: Ethe }) const secondToLastOperation = newStack.operations[newStack.operations.length - 2] if (secondToLastOperation === undefined || secondToLastOperation.type === 'TimeManipulation') { - await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, true, true) + await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, { invalidateOldState: true, onlyIfNotAlreadyUpdating: true }) return } const appendIdentifier = parsedRequest.data.transactionOrMessageIdentifier.type === 'Transaction' ? parsedRequest.data.transactionOrMessageIdentifier.transactionIdentifier : parsedRequest.data.transactionOrMessageIdentifier.messageIdentifier const operationIdentifier = secondToLastOperation.type === 'Transaction' ? secondToLastOperation.preSimulationTransaction.transactionIdentifier : secondToLastOperation.signedMessageTransaction.messageIdentifier const appendedToEnd = appendIdentifier === operationIdentifier - await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, !appendedToEnd, true) + await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, { invalidateOldState: !appendedToEnd, onlyIfNotAlreadyUpdating: true }) } export async function requestMakeMeRichList(ethereumClientService: EthereumClientService, requestAbortController: AbortController | undefined) { @@ -1286,7 +1276,7 @@ export async function importSimulationStack(ethereum: EthereumClientService, tok } export async function requestCompleteVisualizedSimulation(ethereum: EthereumClientService, tokenPriceService: TokenPriceService) { - const visualizedSimulatorState = await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, false, false) + const visualizedSimulatorState = await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService) return { method: 'popup_requestCompleteVisualizedSimulation' as const, visualizedSimulatorState } } diff --git a/app/ts/background/popupMessageHandlers/settings.ts b/app/ts/background/popupMessageHandlers/settings.ts index f9e6f1b90..c9b4bf2c8 100644 --- a/app/ts/background/popupMessageHandlers/settings.ts +++ b/app/ts/background/popupMessageHandlers/settings.ts @@ -3,7 +3,7 @@ import { ExportedSettings } from '../../types/exportedSettingsTypes.js' import { serialize } from '../../types/wire-types.js' import { isJSON } from '../../utils/json.js' import { silenceChromeUnCaughtPromise } from '../../utils/requests.js' -import type { ResetSimulationServices } from '../../simulation/serviceLifecycle.js' +import type { SimulationServicesOwner } from '../../simulation/serviceLifecycle.js' import { getPrimaryRpcForChain, getRpcList, setRpcList } from '../storageVariables.js' import { exportSettingsAndAddressBook, getMetamaskCompatibilityMode, getSafeAppsCompatibilityMode, getSettings, getUseTabsInsteadOfPopup, importSettingsAndAddressBook } from '../settings.js' import { sendPopupMessageToOpenWindows } from '../backgroundUtils.js' @@ -47,9 +47,9 @@ export async function exportSettings() { }) } -export async function setNewRpcList(resetSimulationServices: ResetSimulationServices, request: SetRpcList, settings: Settings) { +export async function setNewRpcList(simulationServicesOwner: SimulationServicesOwner, request: SetRpcList, settings: Settings) { await setRpcList(request.data) await sendPopupMessageToOpenWindows({ method: 'popup_update_rpc_list', data: request.data }) const primary = await getPrimaryRpcForChain(settings.activeRpcNetwork.chainId) - if (primary !== undefined) resetSimulationServices(primary) + if (primary !== undefined) simulationServicesOwner.reset(primary) } diff --git a/app/ts/background/popupMessageHandlers/websiteAccess.ts b/app/ts/background/popupMessageHandlers/websiteAccess.ts index 137822220..97a095163 100644 --- a/app/ts/background/popupMessageHandlers/websiteAccess.ts +++ b/app/ts/background/popupMessageHandlers/websiteAccess.ts @@ -1,6 +1,6 @@ import type { EthereumClientService } from '../../simulation/services/EthereumClientService.js' import type { TokenPriceService } from '../../simulation/services/priceEstimator.js' -import type { ResetSimulationServices } from '../../simulation/serviceLifecycle.js' +import type { SimulationServicesOwner } from '../../simulation/serviceLifecycle.js' import type { AllowOrPreventAddressAccessForWebsite, BlockOrAllowExternalRequests, DisableInterceptor, RemoveWebsiteAccess, RemoveWebsiteAddressAccess, RetrieveWebsiteAccess } from '../../types/interceptor-messages.js' import type { EthereumAddress } from '../../types/wire-types.js' import type { Website } from '../../types/websiteAccessTypes.js' @@ -43,9 +43,9 @@ export const disableInterceptorForPage = async (websiteTabConnections: WebsiteTa await reloadConnectedTabs(websiteTabConnections) } -export async function disableInterceptor(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, parsedRequest: DisableInterceptor) { +export async function disableInterceptor(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, parsedRequest: DisableInterceptor) { await disableInterceptorForPage(websiteTabConnections, parsedRequest.data.website, parsedRequest.data.interceptorDisabled) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) await sendPopupMessageToOpenWindows({ method: 'popup_setDisableInterceptorReply' as const, data: parsedRequest.data }) } @@ -64,9 +64,9 @@ const blockOrAllowWebsiteExternalRequests = async (websiteTabConnections: Websit await reloadConnectedTabs(websiteTabConnections) } -export async function blockOrAllowExternalRequests(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, parsedRequest: BlockOrAllowExternalRequests) { +export async function blockOrAllowExternalRequests(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, parsedRequest: BlockOrAllowExternalRequests) { await blockOrAllowWebsiteExternalRequests(websiteTabConnections, parsedRequest.data.website, parsedRequest.data.shouldBlock) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) await sendPopupMessageToOpenWindows({ method: 'popup_websiteAccess_changed' }) } @@ -77,10 +77,10 @@ const removeAddressAccessByAddress = async (websiteOrigin: string, address: Ethe })) } -export async function removeWebsiteAddressAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, parsedRequest: RemoveWebsiteAddressAccess) { +export async function removeWebsiteAddressAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, parsedRequest: RemoveWebsiteAddressAccess) { await removeAddressAccessByAddress(parsedRequest.data.websiteOrigin, parsedRequest.data.address) await reloadConnectedTabs(websiteTabConnections) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) await sendPopupMessageToOpenWindows({ method: 'popup_websiteAccess_changed' }) } @@ -99,8 +99,8 @@ export async function allowOrPreventAddressAccessForWebsite(websiteTabConnection await sendPopupMessageToOpenWindows({ method: 'popup_websiteAccess_changed' }) } -export async function removeWebsiteAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, parsedRequest: RemoveWebsiteAccess) { +export async function removeWebsiteAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, parsedRequest: RemoveWebsiteAccess) { await updateWebsiteAccess((previousAccess) => previousAccess.filter((access) => access.website.websiteOrigin !== parsedRequest.data.websiteOrigin)) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) await sendPopupMessageToOpenWindows({ method: 'popup_websiteAccess_changed' }) } diff --git a/app/ts/background/popupMessageRouting.ts b/app/ts/background/popupMessageRouting.ts index de0f1f6ce..6a2694a11 100644 --- a/app/ts/background/popupMessageRouting.ts +++ b/app/ts/background/popupMessageRouting.ts @@ -3,7 +3,7 @@ import { PopupReplyOption } from '../types/interceptor-reply-messages.js' import type { WebsiteTabConnections } from '../types/user-interface-types.js' import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' -import type { ResetSimulationServices } from '../simulation/serviceLifecycle.js' +import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import { METAMASK_ERROR_FAILED_TO_PARSE_REQUEST } from '../utils/constants.js' import { isExpectedInfrastructureError } from '../utils/errors.js' import type { PublishRpcConnectionStatus } from './rpcSlowRequestTracking.js' @@ -17,7 +17,7 @@ export async function popupMessageHandler( websiteTabConnections: WebsiteTabConnections, ethereum: EthereumClientService, tokenPriceService: TokenPriceService, - resetSimulationServices: ResetSimulationServices, + simulationServicesOwner: SimulationServicesOwner, request: unknown, settings: Settings, publishRpcConnectionStatus: PublishRpcConnectionStatus, @@ -38,12 +38,12 @@ export async function popupMessageHandler( websiteTabConnections, ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, settings, publishRpcConnectionStatus, simulationAbortController, confirmTransactionAbortController: getConfirmTransactionAbortController(), - resetSimulationState: async () => await resetSimulationStateFromConfig(ethereum, tokenPriceService), + resetSimulationState: async () => await resetSimulationStateFromConfig(simulationServicesOwner), }, maybeParsedRequest.value) if (requestReply === undefined) return undefined return PopupReplyOption.serialize(requestReply) diff --git a/app/ts/background/popupSettingsCommands.ts b/app/ts/background/popupSettingsCommands.ts index eb1123e33..3d8acd314 100644 --- a/app/ts/background/popupSettingsCommands.ts +++ b/app/ts/background/popupSettingsCommands.ts @@ -26,15 +26,15 @@ function settingsCommand(method: // The protocol descriptor is the exhaustive operation/reply source; this boundary owns admission and command completion. export const popupSettingsCommandHandlers = { popup_requestSettingsChangeStatus: popupMessageHandler('popup_requestSettingsChangeStatus', async () => await settingsCoordinator.publish()), - popup_changeActiveAddress: settingsCommand('popup_changeActiveAddress', async (context, request) => await changeActiveAddress(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request)), - popup_changeActiveRpc: settingsCommand('popup_changeActiveRpc', async (context, request) => await popupChangeActiveRpc(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request, context.settings)), + popup_changeActiveAddress: settingsCommand('popup_changeActiveAddress', async (context, request) => await changeActiveAddress(context.simulationServicesOwner, context.websiteTabConnections, request)), + popup_changeActiveRpc: settingsCommand('popup_changeActiveRpc', async (context, request) => await popupChangeActiveRpc(context.simulationServicesOwner, context.websiteTabConnections, request)), popup_enableSimulationMode: settingsCommand('popup_enableSimulationMode', async (context, request) => { - await enableSimulationMode(context.ethereum, context.tokenPriceService, context.resetSimulationServices, context.websiteTabConnections, request) + await enableSimulationMode(context.simulationServicesOwner, context.websiteTabConnections, request) return { type: 'PopupSettingsChangeReply', ok: true } }), popup_modifyMakeMeRich: settingsCommand('popup_modifyMakeMeRich', async (context, request) => { if (await modifyMakeMeRich(request)) { - const outcome = await queuePopupSimulationRefresh({ ethereum: context.ethereum, tokenPriceService: context.tokenPriceService, invalidateOldState: true }) + const outcome = await queuePopupSimulationRefresh({ ...context.simulationServicesOwner.getCurrent(), invalidateOldState: true }) if (outcome.status === 'observed' && !outcome.available) { return { type: 'PopupSettingsChangeReply', ok: false, message: 'The rich setting was saved, but the latest simulation is unavailable. Please refresh the simulation to retry.' } } diff --git a/app/ts/background/popupSimulationRefreshQueue.ts b/app/ts/background/popupSimulationRefreshQueue.ts index 75e4a48ed..6572f70dc 100644 --- a/app/ts/background/popupSimulationRefreshQueue.ts +++ b/app/ts/background/popupSimulationRefreshQueue.ts @@ -57,7 +57,7 @@ export function createPopupSimulationRefresher(async ({ ethereum, tokenPriceService, invalidateOldState = false, snapshot }) => { - const result = await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, invalidateOldState, false, !invalidateOldState, snapshot) + const result = await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, { invalidateOldState, skipIfUnchanged: !invalidateOldState, snapshot }) return result.simulationUpdatingState !== 'failed' && result.simulationResultState !== 'invalid' }) diff --git a/app/ts/background/popupVisualisationUpdater.ts b/app/ts/background/popupVisualisationUpdater.ts index efe338d8c..e95bea777 100644 --- a/app/ts/background/popupVisualisationUpdater.ts +++ b/app/ts/background/popupVisualisationUpdater.ts @@ -54,8 +54,15 @@ const hasSimulationInputOperations = (simulationState: SimulationState) => ( simulationState.simulationStateInput.some((block) => block.transactions.length > 0 || block.signedMessages.length > 0) ) +export type PopupVisualisationOptions = { + readonly invalidateOldState?: boolean + readonly onlyIfNotAlreadyUpdating?: boolean + readonly skipIfUnchanged?: boolean + readonly snapshot?: SimulationSnapshot +} + // Visibility/throttle-aware execution: callers such as block updates can replace obsolete work without entering the interactive queue. -export const updatePopupVisualisationIfNeeded = async (ethereum: EthereumClientService, tokenPriceService: TokenPriceService, invalidateOldState = false, onlyIfNotAlreadyUpdating = false, skipIfUnchanged = false, snapshot?: SimulationSnapshot) => { +export const updatePopupVisualisationIfNeeded = async (ethereum: EthereumClientService, tokenPriceService: TokenPriceService, { invalidateOldState = false, onlyIfNotAlreadyUpdating = false, skipIfUnchanged = false, snapshot }: PopupVisualisationOptions = {}) => { try { const popupVisualisation = await getPopupVisualisationState() if (onlyIfNotAlreadyUpdating && updateSimulationVisualisationSemaphore.getPermits() === 0) return popupVisualisation diff --git a/app/ts/background/providerMessageHandlers.ts b/app/ts/background/providerMessageHandlers.ts index 4794addf3..ef4c8ded9 100644 --- a/app/ts/background/providerMessageHandlers.ts +++ b/app/ts/background/providerMessageHandlers.ts @@ -18,7 +18,7 @@ import { modifyObject } from '../utils/typescript.js' import { sendSubscriptionReplyOrCallBackToPort } from './messageSending.js' import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' -import type { ResetSimulationServices } from '../simulation/serviceLifecycle.js' +import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import { isSignerMissing } from '../utils/signerMetadata.js' import { beginSignerStateConfirmation, clearSignerDerivedTabState, confirmSignerState, doesSignerStateTokenMatchIdentity, getConfirmedSignerStateToken, isCurrentWebsiteConnection, isSignerStateTokenCurrent, runSignerStateOperation, signerConnectionReplacedError, tabHasApprovedWebsiteConnection, type SignerStateToken } from './signerStateOwnership.js' import { getConfiguredSigningSafe, getSigningAddressSelectionTransition } from './signingAddressSelection.js' @@ -62,7 +62,7 @@ function hasSignerCallbackAccess(websiteTabConnections: WebsiteTabConnections, t return approval === 'hasAccess' || tabHasApprovedWebsiteConnection(websiteTabConnections, tabId) } -export async function ethAccountsReply(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, _activeAddress: bigint | undefined) { +export async function ethAccountsReply(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, _activeAddress: bigint | undefined) { const returnValue = { type: 'result' as const, method: 'eth_accounts_reply' as const, result: '0x' as const } if (!('params' in request)) return returnValue if (port.sender?.tab?.id === undefined) return returnValue @@ -114,7 +114,7 @@ export async function ethAccountsReply(ethereum: EthereumClientService, tokenPri const transition = await getSigningAddressSelectionTransition(settings, tabStateChange.previousState, tabStateChange.newState) if (transition.shouldActivate) { const changeActiveAddress = async () => { - await activateAddressSelection(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, transition.selection, { + await activateAddressSelection(simulationServicesOwner, websiteTabConnections, transition.selection, { simulationMode: settings.simulationMode, signerAddress: transition.signerAddress, promptForAccessesIfNeeded: !signerAccountsReply.requestAccounts, @@ -148,7 +148,7 @@ export async function ethAccountsReply(ethereum: EthereumClientService, tokenPri }) } -async function changeSignerChain(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, signerStateToken: SignerStateToken, signerChain: bigint, approval: ApprovalState, requestedRpcNetwork?: RpcNetwork) { +async function changeSignerChain(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, signerStateToken: SignerStateToken, signerChain: bigint, approval: ApprovalState, requestedRpcNetwork?: RpcNetwork) { if (approval !== 'hasAccess') return const tabStateChange = await updateTabState(signerStateToken.socket.tabId, (previousState: TabState) => { return previousState.signerChain === signerChain ? previousState : modifyObject(previousState, { signerChain }) @@ -170,7 +170,7 @@ async function changeSignerChain(ethereum: EthereumClientService, tokenPriceServ const rpcNetwork = requestedRpcNetwork ?? (settings.activeRpcNetwork.chainId === signerChain ? settings.activeRpcNetwork : await getRpcNetworkForChain(signerChain)) if (getRpcNetworkChange(settings.activeRpcNetwork, rpcNetwork).selectionChanged) { const signerAddress = getWalletSelectedAccount(tabStateChange.newState) - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await changeActiveAddressAndChain(simulationServicesOwner, websiteTabConnections, { simulationMode: settings.simulationMode, rpcNetwork, activeAddress: signerAddress, @@ -182,7 +182,7 @@ async function changeSignerChain(ethereum: EthereumClientService, tokenPriceServ if (oldSignerChain !== signerChain) sendPopupMessageToOpenWindows({ method: 'popup_chain_update' }) } -export async function signerChainChanged(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, _activeAddress: bigint | undefined) { +export async function signerChainChanged(_ethereum: EthereumClientService, _tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, _activeAddress: bigint | undefined) { const returnValue = { type: 'result' as const, method: 'signer_chainChanged' as const, result: '0x' as const } if (!('params' in request)) return returnValue const [signerChain, signerProviderGeneration] = EthereumChainReply.parse(request.params) @@ -192,21 +192,21 @@ export async function signerChainChanged(ethereum: EthereumClientService, tokenP return await runSignerStateOperation(websiteTabConnections, socket.tabId, async () => { const signerStateToken = getSignerCallbackToken(websiteTabConnections, port, signerProviderGeneration) if (signerStateToken === undefined) return returnValue - await changeSignerChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, signerStateToken, signerChain, 'hasAccess') + await changeSignerChain(simulationServicesOwner, websiteTabConnections, signerStateToken, signerChain, 'hasAccess') return returnValue }) } -export async function walletSwitchEthereumChainReply(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, _approval: ApprovalState, _activeAddress: bigint | undefined) { +export async function walletSwitchEthereumChainReply(_ethereum: EthereumClientService, _tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, _approval: ApprovalState, _activeAddress: bigint | undefined) { const returnValue = { type: 'result' as const, method: 'wallet_switchEthereumChain_reply' as const, result: '0x' as const } const params = WalletSwitchEthereumChainReply.parse(request).params[0] await applyWalletSwitchReply(websiteTabConnections, port, params, async (token, chainId, rpc) => { - await changeSignerChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, token, chainId, 'hasAccess', rpc) + await changeSignerChain(simulationServicesOwner, websiteTabConnections, token, chainId, 'hasAccess', rpc) }) return returnValue } -export async function connectedToSigner(_ethereum: EthereumClientService, _tokenPriceService: TokenPriceService, _resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, activeAddress: bigint | undefined) { +export async function connectedToSigner(_ethereum: EthereumClientService, _tokenPriceService: TokenPriceService, _simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, activeAddress: bigint | undefined) { const [signerConnected, signerName, signerProviderGeneration] = ConnectedToSigner.parse(request).params const isTopFrame = isTopFramePort(port) const socket = getSocketFromPort(port) @@ -275,7 +275,7 @@ export async function connectedToSigner(_ethereum: EthereumClientService, _token return result } -export async function signerReply(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, _resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, _approval: ApprovalState, _activeAddress: bigint | undefined) { +export async function signerReply(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, _simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, _approval: ApprovalState, _activeAddress: bigint | undefined) { const signerReply = SignerReply.parse(request) const params = signerReply.params[0] const doNotReply = { type: 'doNotReply' as const } diff --git a/app/ts/background/safeConfirmationPersistence.ts b/app/ts/background/safeConfirmationPersistence.ts index fbcd239f4..0f9212b96 100644 --- a/app/ts/background/safeConfirmationPersistence.ts +++ b/app/ts/background/safeConfirmationPersistence.ts @@ -187,7 +187,7 @@ async function persistSafeTransaction( if (!isSafeContractValidationFailure(error)) throw error return signerError(`Gnosis Safe proposal could not be persisted: ${ getErrorMessage(error) ?? 'The local Gnosis Safe proposal stack changed.' }`) } - await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, true, false) + await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, { invalidateOldState: true }) await openPopupOrTab({ url: getHtmlFile('simulationStack') }) return { status: 'success', result: funtypes.String.parse(EthereumBytes32.serialize(safeSigningRequest.safeTxHash)) } } diff --git a/app/ts/background/safeStackHandlers.ts b/app/ts/background/safeStackHandlers.ts index 0cef05bd7..aba5d776a 100644 --- a/app/ts/background/safeStackHandlers.ts +++ b/app/ts/background/safeStackHandlers.ts @@ -121,7 +121,7 @@ export async function importSafeStack( ), } }) - await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, true, false) + await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, { invalidateOldState: true }) return { type: 'ImportSafeStackReply' as const, ok: true as const } } catch(error) { return { diff --git a/app/ts/background/simulationModeHandlers.ts b/app/ts/background/simulationModeHandlers.ts index 179b3ccb5..1aaa470a2 100644 --- a/app/ts/background/simulationModeHandlers.ts +++ b/app/ts/background/simulationModeHandlers.ts @@ -16,7 +16,7 @@ import { printError } from '../utils/errors.js' import { openFetchSimulationStackDialogOrGetCachedResult, type SimulationStackSnapshot } from './windows/fetchSimulationStack.js' import { POPUP_PERFORMANCE_MARKS, markPerformance } from '../utils/popupPerformance.js' import type { TokenPriceService } from '../simulation/services/priceEstimator.js' -import type { ResetSimulationServices } from '../simulation/serviceLifecycle.js' +import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import { addressString } from '../utils/bigint.js' export async function getBlockByHash(ethereumClientService: EthereumClientService, simulationInput: ResolvedSimulationInput, request: EthBlockByHashParams) { @@ -136,12 +136,12 @@ export async function personalSign( return { method: confirmation.parameters.method, ...action } } -export async function switchEthereumChain(ethereumClientService: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, params: SwitchEthereumChainParams, request: InterceptedRequest, simulationMode: boolean, website: Website) { +export async function switchEthereumChain(ethereumClientService: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, params: SwitchEthereumChainParams, request: InterceptedRequest, simulationMode: boolean, website: Website) { if (ethereumClientService.getChainId() === params.params[0].chainId) { // we are already on the right chain return { type: 'result' as const, method: params.method, result: null } } - const change = await openChangeChainDialog(ethereumClientService, tokenPriceService, resetSimulationServices, websiteTabConnections, request, simulationMode, website, params) + const change = await openChangeChainDialog(ethereumClientService, tokenPriceService, simulationServicesOwner, websiteTabConnections, request, simulationMode, website, params) return { type: 'result' as const, method: params.method, ...change } } diff --git a/app/ts/background/walletSwitch.ts b/app/ts/background/walletSwitch.ts index b8ee5185c..4ec9785d5 100644 --- a/app/ts/background/walletSwitch.ts +++ b/app/ts/background/walletSwitch.ts @@ -1,17 +1,17 @@ +import { getConfiguredSigningSafe } from './signingAddressSelection.js' +import { bumpPopupRefreshGeneration } from './popupRefreshGeneration.js' import { getSettings } from './settings.js' import { JSON_RPC_ERROR_CODE_INTERNAL_ERROR, METAMASK_ERROR_USER_REJECTED_REQUEST } from '../utils/constants.js' import { Future } from '../utils/future.js' import type { SignerChainChangeConfirmation, WalletSwitchEthereumChainReply } from '../types/interceptor-messages.js' import type { WebsiteTabConnections } from '../types/user-interface-types.js' -import { changeActiveRpc } from './activeSettings.js' -import { getSocketFromPort } from './backgroundUtils.js' -import { promoteRpcAsPrimary } from './storageVariables.js' -import { getRpcNetworkChange } from '../utils/rpcNetworkChange.js' +import { changeActiveAddressAndChain } from './activeSettings.js' +import { getSocketFromPort, sendPopupMessageToOpenWindows } from './backgroundUtils.js' +import { promoteRpcAsPrimary, getTabState } from './storageVariables.js' +import { getRpcNetworkChange, getRpcChangeRoute } from '../utils/rpcNetworkChange.js' import type { RpcNetwork } from '../types/rpc.js' -import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' -import type { TokenPriceService } from '../simulation/services/priceEstimator.js' -import type { ResetSimulationServices } from '../simulation/serviceLifecycle.js' -import { getConfirmedSignerStateToken, runSignerStateOperation, signerConnectionReplacedError, addSignerStateReplacementListener, doSignerStateTokensMatch, signerUnavailableError, type SignerStateToken } from './signerStateOwnership.js' +import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' +import { sendCallbackToConfirmedSignerOwner, getConfirmedSignerStateToken, runSignerStateOperation, signerConnectionReplacedError, addSignerStateReplacementListener, doSignerStateTokensMatch, signerUnavailableError, type SignerStateToken } from './signerStateOwnership.js' type PendingSignerChainChange = { readonly walletSwitchRequestId: string @@ -85,7 +85,32 @@ function resolveSignerChainChange(signerStateToken: SignerStateToken, confirmati return true } -export async function requestSignerChainChange(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, requestTabId: number, timeoutMs = WALLET_SWITCH_TIMEOUT_MS) { +export type RpcSwitchResult = { readonly result: null, readonly error?: undefined } | { readonly error: { readonly code: number, readonly message: string, readonly data?: string }, readonly result?: undefined } + +export type RpcSwitchRequest = + | { readonly source: 'popup', readonly signerTabId: number | undefined } + | { readonly source: 'dapp', readonly signerTabId: number | undefined, readonly simulationMode: boolean } + +// One command owns routing, origin-specific gates, local promotion and correlated wallet dispatch. +export async function changeActiveRpc(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, request: RpcSwitchRequest, timeoutMs = WALLET_SWITCH_TIMEOUT_MS): Promise { + const settings = await getSettings() + const simulationMode = request.source === 'popup' ? settings.simulationMode : request.simulationMode + const route = getRpcChangeRoute(settings.activeRpcNetwork, rpcNetwork, simulationMode) + if (route !== 'wallet') { + if (route === 'local') { + await changeActiveAddressAndChain(simulationServicesOwner, websiteTabConnections, { simulationMode, rpcNetwork }) + } + await promoteRpcAsPrimary(rpcNetwork) + return { result: null } + } + if (request.signerTabId === undefined) return { error: signerUnavailableError } + if (request.source === 'popup' && await getConfiguredSigningSafe(settings, (await getTabState(request.signerTabId)).signerAccounts) !== undefined) { + return { error: { code: METAMASK_ERROR_USER_REJECTED_REQUEST, message: 'This Safe is tied to its current network. Select your wallet account before switching networks.' } } + } + return await requestSignerChainChange(websiteTabConnections, rpcNetwork, request.signerTabId, timeoutMs) +} + +async function requestSignerChainChange(websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, requestTabId: number, timeoutMs: number) { if (pendingSignerChainChange !== undefined) return { error: { code: -32002, message: 'A network switch is already waiting for your wallet.' } } const pending: PendingSignerChainChange = { walletSwitchRequestId: crypto.randomUUID(), @@ -111,22 +136,19 @@ export async function requestSignerChainChange(ethereum: EthereumClientService, }) pendingSignerChainChange = pending try { - const changeActiveRpcResult = await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, rpcNetwork, false, requestTabId, pending.walletSwitchRequestId) - if (changeActiveRpcResult.type !== 'signerRequestSent') { - return changeActiveRpcResult.type === 'signerRequestNotNeeded' - ? { result: null } as const - : { error: signerUnavailableError } as const - } - pending.signerStateToken = changeActiveRpcResult.signerStateToken - if (!pending.receivedReplyTokens.some(token => doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, token))) pending.timeout = setTimeout(() => { + const dispatchedToken = sendCallbackToConfirmedSignerOwner(websiteTabConnections, requestTabId, { method: 'request_signer_to_wallet_switchEthereumChain', result: rpcNetwork.chainId, walletSwitchRequestId: pending.walletSwitchRequestId }) + if (dispatchedToken === false) return { error: signerUnavailableError } + await sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: await getSettings(), popupRefreshGeneration: bumpPopupRefreshGeneration() }) + pending.signerStateToken = dispatchedToken + if (!pending.receivedReplyTokens.some(token => doSignerStateTokensMatch(dispatchedToken, token))) pending.timeout = setTimeout(() => { pending.future.resolve({ type: 'timeout' }) }, timeoutMs) const precedingReply = pending.repliesBeforeToken.find(({ signerStateToken, confirmation }) => { - return doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, signerStateToken) + return doSignerStateTokensMatch(dispatchedToken, signerStateToken) && confirmation.data[0].chainId === pending.requestedRpcNetwork.chainId }) if (precedingReply !== undefined) pending.future.resolve({ type: 'reply', confirmation: precedingReply.confirmation }) - const precedingReplacement = pending.replacementsBeforeToken.find(({ signerStateToken }) => doSignerStateTokensMatch(changeActiveRpcResult.signerStateToken, signerStateToken)) + const precedingReplacement = pending.replacementsBeforeToken.find(({ signerStateToken }) => doSignerStateTokensMatch(dispatchedToken, signerStateToken)) if (precedingReplacement !== undefined) pending.future.resolve({ type: 'replacement', error: precedingReplacement.error }) const signerResult = await pending.future if (signerResult.type === 'timeout') return { error: { code: -32002, message: 'Your wallet did not answer the network request in time. You can retry or change other settings. Your wallet may still show the previous request.' } } diff --git a/app/ts/background/windows/changeChain.ts b/app/ts/background/windows/changeChain.ts index 9eae3bca9..567d8efde 100644 --- a/app/ts/background/windows/changeChain.ts +++ b/app/ts/background/windows/changeChain.ts @@ -1,9 +1,8 @@ -import { isSignerChainChangePending, requestSignerChainChange } from '../walletSwitch.js' +import { isSignerChainChangePending, changeActiveRpc } from '../walletSwitch.js' import { METAMASK_ERROR_USER_REJECTED_REQUEST } from '../../utils/constants.js' import { Future } from '../../utils/future.js' import type { ChainChangeConfirmation } from '../../types/interceptor-messages.js' import type { WebsiteTabConnections } from '../../types/user-interface-types.js' -import { changeActiveRpc } from '../activeSettings.js' import { getHtmlFile, sendPopupMessageToOpenWindows } from '../backgroundUtils.js' import { getChainChangeConfirmationPromise, getRpcNetworkForChain, setChainChangeConfirmationPromise } from '../storageVariables.js' import type { RpcNetwork } from '../../types/rpc.js' @@ -13,7 +12,7 @@ import type { SwitchEthereumChainParams } from '../../types/JsonRpc-types.js' import type { PopupOrTabId, Website } from '../../types/websiteAccessTypes.js' import type { EthereumClientService } from '../../simulation/services/EthereumClientService.js' import type { TokenPriceService } from '../../simulation/services/priceEstimator.js' -import type { ResetSimulationServices } from '../../simulation/serviceLifecycle.js' +import type { SimulationServicesOwner } from '../../simulation/serviceLifecycle.js' import { type PopupOrTab, addWindowTabListeners, closePopupOrTabById, getPopupOrTabById, openPopupOrTab, removeWindowTabListeners } from '../../utils/popupOrTab.js' let pendForUserReply: Future | undefined @@ -28,7 +27,7 @@ export async function updateChainChangeViewWithPendingRequest() { return } -export async function resolveChainChange(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, confirmation: ChainChangeConfirmation) { +export async function resolveChainChange(_ethereum: EthereumClientService, _tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, confirmation: ChainChangeConfirmation) { if (pendForUserReply !== undefined) { pendForUserReply.resolve(confirmation) return @@ -36,7 +35,7 @@ export async function resolveChainChange(ethereum: EthereumClientService, tokenP await runExclusiveChainChangeResolution(async () => { const data = await getChainChangeConfirmationPromise() if (data === undefined || !doesUniqueRequestIdentifiersMatch(confirmation.data.uniqueRequestIdentifier, data.request.uniqueRequestIdentifier)) throw new Error('Unique request identifier mismatch in change chain') - const resolved = await resolve(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, confirmation, data.simulationMode) + const resolved = await resolve(simulationServicesOwner, websiteTabConnections, confirmation, data.simulationMode) if (resolved.error !== undefined) { replyToInterceptedRequest(websiteTabConnections, { type: 'result', method: 'wallet_switchEthereumChain' as const, error: resolved.error, uniqueRequestIdentifier: data.request.uniqueRequestIdentifier }) } else { @@ -78,7 +77,7 @@ const userDeniedChange = { export const openChangeChainDialog = async ( ethereum: EthereumClientService, tokenPriceService: TokenPriceService, - resetSimulationServices: ResetSimulationServices, + simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, request: InterceptedRequest, simulationMode: boolean, @@ -93,7 +92,7 @@ export const openChangeChainDialog = async ( if (openedDialog === undefined || openedDialog.id !== popupOrTab.id || openedDialog.type !== popupOrTab.type) return openedDialog = undefined if (pendForUserReply === undefined) return - resolveChainChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, rejectMessage(await getRpcNetworkForChain(params.params[0].chainId), request.uniqueRequestIdentifier)) + resolveChainChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, rejectMessage(await getRpcNetworkForChain(params.params[0].chainId), request.uniqueRequestIdentifier)) } const onCloseWindow = async (id: number) => onCloseWindowOrTab({ type: 'popup' as const, id }) const onCloseTab = async (id: number) => onCloseWindowOrTab({ type: 'tab' as const, id }) @@ -125,7 +124,7 @@ export const openChangeChainDialog = async ( await resolveChainChange( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, rejectMessage(await getRpcNetworkForChain(params.params[0].chainId), request.uniqueRequestIdentifier), ) @@ -133,7 +132,7 @@ export const openChangeChainDialog = async ( const reply = await pendForUserReply // forward message to content script - const resolution = runExclusiveChainChangeResolution(async () => await resolve(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, reply, simulationMode)) + const resolution = runExclusiveChainChangeResolution(async () => await resolve(simulationServicesOwner, websiteTabConnections, reply, simulationMode)) return resolution.then((result) => result ?? userDeniedChange) } finally { removeWindowTabListeners(onCloseWindow, onCloseTab) @@ -143,14 +142,10 @@ export const openChangeChainDialog = async ( } } -async function resolve(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, reply: ChainChangeConfirmation, simulationMode: boolean) { +async function resolve(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, reply: ChainChangeConfirmation, simulationMode: boolean) { await setChainChangeConfirmationPromise(undefined) if (reply.data.accept) { - if (simulationMode) { - await changeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, reply.data.rpcNetwork, simulationMode, reply.data.uniqueRequestIdentifier.requestSocket.tabId) - return { result: null } - } - return await requestSignerChainChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, reply.data.rpcNetwork, reply.data.uniqueRequestIdentifier.requestSocket.tabId) + return await changeActiveRpc(simulationServicesOwner, websiteTabConnections, reply.data.rpcNetwork, { source: 'dapp', simulationMode, signerTabId: reply.data.uniqueRequestIdentifier.requestSocket.tabId }) } return userDeniedChange } diff --git a/app/ts/background/windows/confirmTransaction.ts b/app/ts/background/windows/confirmTransaction.ts index 2f94ae145..5dcacdc0c 100644 --- a/app/ts/background/windows/confirmTransaction.ts +++ b/app/ts/background/windows/confirmTransaction.ts @@ -196,7 +196,7 @@ export async function updateConfirmTransactionView(ethereum: EthereumClientServi if (pendingTransactionAndSignableMessages.length === 0) return false const settings = await settingsPromise const visualizedSimulatorState = settings.simulationMode - ? await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, false, onlyIfNotAlreadyUpdating) + ? await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, { onlyIfNotAlreadyUpdating }) : createPassthroughCompleteVisualizedSimulation() const message: UpdateConfirmTransactionDialog = { method: 'popup_update_confirm_transaction_dialog', data: { currentBlockNumber: await currentBlockNumberPromise, @@ -407,7 +407,7 @@ export async function resolvePendingTransactionOrMessage(ethereum: EthereumClien ...prevStack.operations, { type: 'Message' as const, signedMessageTransaction: pendingTransactionOrMessage.signedMessageTransaction } ] })) - await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, false) + await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService) return reply({ type: 'result', result: (await simulatePersonalSign(pendingTransactionOrMessage.originalRequestParameters, pendingTransactionOrMessage.signedMessageTransaction.fakeSignedFor)).signature }) } case 'Transaction': { @@ -417,7 +417,7 @@ export async function resolvePendingTransactionOrMessage(ethereum: EthereumClien ...prevStack.operations, { type: 'Transaction' as const, preSimulationTransaction: transaction} ] })) - await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService, false) + await updatePopupVisualisationIfNeeded(ethereum, tokenPriceService) markPerformance(POPUP_PERFORMANCE_MARKS.backgroundTransactionStackAppended) return reply({ type: 'result', result: EthereumBytes32.serialize(signedTransaction.hash) }) } diff --git a/app/ts/background/windows/interceptorAccess.ts b/app/ts/background/windows/interceptorAccess.ts index 066d25ce1..c8f444dc0 100644 --- a/app/ts/background/windows/interceptorAccess.ts +++ b/app/ts/background/windows/interceptorAccess.ts @@ -17,7 +17,7 @@ import type { PendingAccessRequest } from '../../types/accessRequest.js' import { doAddressBookChainIdsMatch, type AddressBookEntries, type AddressBookEntry } from '../../types/addressBookTypes.js' import type { EthereumClientService } from '../../simulation/services/EthereumClientService.js' import type { TokenPriceService } from '../../simulation/services/priceEstimator.js' -import type { ResetSimulationServices } from '../../simulation/serviceLifecycle.js' +import type { SimulationServicesOwner } from '../../simulation/serviceLifecycle.js' import type { PublishRpcConnectionStatus } from '../rpcSlowRequestTracking.js' import { type PopupOrTab, addWindowTabListeners, closePopupOrTabById, getPopupOrTabById, openPopupOrTab, removeWindowTabListeners, tryFocusingTabOrWindow } from '../../utils/popupOrTab.js' import { isAccountConnectionMethod } from '../accountRequestMethods.js' @@ -66,7 +66,7 @@ async function waitForSignerAccountReply(future: Future await pendingInterceptorAccessSemaphore.execute(async () => { // check if user has closed the window on their own, if so, reject signature +const onCloseWindowOrTab = async (ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, popupOrTabs: PopupOrTabId, websiteTabConnections: WebsiteTabConnections) => await pendingInterceptorAccessSemaphore.execute(async () => { // check if user has closed the window on their own, if so, reject signature if (openedDialog === undefined || openedDialog.popupOrTab.id !== popupOrTabs.id || openedDialog.popupOrTab.type !== popupOrTabs.type) return removeWindowTabListeners(openedDialog.onClosePopup, openedDialog.onCloseTab) @@ -82,7 +82,7 @@ const onCloseWindowOrTab = async (ethereum: EthereumClientService, tokenPriceSer await resolve( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, reply, pendingRequest.request, @@ -93,7 +93,7 @@ const onCloseWindowOrTab = async (ethereum: EthereumClientService, tokenPriceSer } }) -export async function resolveInterceptorAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, reply: InterceptorAccessReply, publishRpcConnectionStatus: PublishRpcConnectionStatus) { +export async function resolveInterceptorAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, reply: InterceptorAccessReply, publishRpcConnectionStatus: PublishRpcConnectionStatus) { const resolution = await pendingInterceptorAccessSemaphore.execute(async () => { const promises = await getPendingAccessRequests() const pendingRequest = promises.find((req) => req.accessRequestId === reply.accessRequestId) @@ -107,7 +107,7 @@ export async function resolveInterceptorAccess(ethereum: EthereumClientService, ...await resolve( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, replyWithPendingRequestAddresses, pendingRequest.request, @@ -124,7 +124,7 @@ export async function resolveInterceptorAccess(ethereum: EthereumClientService, await updateWebsiteApprovalAccesses( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, await getSettings(), true, @@ -136,7 +136,7 @@ export async function resolveInterceptorAccess(ethereum: EthereumClientService, pendingRequest.website, ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, pendingRequest.socket, pendingRequest.request, websiteTabConnections, @@ -177,12 +177,12 @@ async function withCurrentSignerStates(pendingAccessRequests: readonly PendingAc return await Promise.all(pendingAccessRequests.map(withCurrentSignerState)) } -async function changeAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, confirmation: InterceptorAccessReply, website: Website, promptForAccessesIfNeeded = true) { +async function changeAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, confirmation: InterceptorAccessReply, website: Website, promptForAccessesIfNeeded = true) { if (confirmation.userReply === 'noResponse') return await persistWebsiteAccessChange( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, website, confirmation.userReply === 'Approved', @@ -281,7 +281,7 @@ export async function refreshSignerAccountsForTab( export async function requestAccessFromUser( ethereum: EthereumClientService, tokenPriceService: TokenPriceService, - resetSimulationServices: ResetSimulationServices, + simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, website: Website, @@ -294,7 +294,7 @@ export async function requestAccessFromUser( export async function requestAccessFromUser( ethereum: EthereumClientService, tokenPriceService: TokenPriceService, - resetSimulationServices: ResetSimulationServices, + simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, website: Website, @@ -307,7 +307,7 @@ export async function requestAccessFromUser( export async function requestAccessFromUser( ethereum: EthereumClientService, tokenPriceService: TokenPriceService, - resetSimulationServices: ResetSimulationServices, + simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, website: Website, @@ -333,7 +333,7 @@ export async function requestAccessFromUser( if (request === undefined || !isAccountConnectionMethod(request.method)) return verify() return withSuppressedUnscopedConnectionEventsForSocket(request.uniqueRequestIdentifier.requestSocket, verify) } - const closeWindowOrTabCallback = (popupOrTabId: PopupOrTabId) => onCloseWindowOrTab(ethereum, tokenPriceService, resetSimulationServices, popupOrTabId, websiteTabConnections) + const closeWindowOrTabCallback = (popupOrTabId: PopupOrTabId) => onCloseWindowOrTab(ethereum, tokenPriceService, simulationServicesOwner, popupOrTabId, websiteTabConnections) const onCloseWindowCallback = async (id: number) => closeWindowOrTabCallback({ type: 'popup' as const, id }) const onCloseTabCallback = async (id: number) => closeWindowOrTabCallback({ type: 'tab' as const, id }) const pendingReplay = await pendingInterceptorAccessSemaphore.execute(async () => { @@ -460,7 +460,7 @@ export async function requestAccessFromUser( pendingReplay.website, ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, pendingReplay.socket, pendingReplay.request, websiteTabConnections, @@ -468,7 +468,7 @@ export async function requestAccessFromUser( ) } -async function resolve(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, resetSimulationServices: ResetSimulationServices, websiteTabConnections: WebsiteTabConnections, accessReply: InterceptorAccessReply, request: InterceptedRequest | undefined, website: Website, publishRpcConnectionStatus: PublishRpcConnectionStatus | undefined, pendingAccessRequest: PendingAccessRequest) { +async function resolve(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, accessReply: InterceptorAccessReply, request: InterceptedRequest | undefined, website: Website, publishRpcConnectionStatus: PublishRpcConnectionStatus | undefined, pendingAccessRequest: PendingAccessRequest) { let promptForFollowUpAccesses = false if (accessReply.userReply === 'noResponse') { if (request !== undefined) refuseAccess(websiteTabConnections, request) @@ -491,15 +491,15 @@ async function resolve(ethereum: EthereumClientService, tokenPriceService: Token approvedAddressSelection = await getAllowedAddressSelectionForAccessRequest(pendingAccessRequest, accessReply.requestAccessToAddress, 'pendingEntry') } if (!userRequestedAddressChange) { - await changeAccess(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, accessReply, website, false) + await changeAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, accessReply, website, false) return } if (accessReply.requestAccessToAddress === undefined) throw new Error('Changed request to page level') - await changeAccess(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, accessReply, website, false) + await changeAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, accessReply, website, false) const settings = await getSettings() const signerAddress = (await getTabState(pendingAccessRequest.socket.tabId)).signerAccounts[0] const selection = approvedAddressSelection ?? await getAllowedAddressSelectionForAccessRequest(pendingAccessRequest, accessReply.requestAccessToAddress, 'pendingEntry') - await activateAddressSelection(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, selection, { + await activateAddressSelection(simulationServicesOwner, websiteTabConnections, selection, { simulationMode: settings.simulationMode, signerAddress, promptForAccessesIfNeeded: false, diff --git a/app/ts/simulation/serviceLifecycle.ts b/app/ts/simulation/serviceLifecycle.ts index e9ca3621e..6314ba90f 100644 --- a/app/ts/simulation/serviceLifecycle.ts +++ b/app/ts/simulation/serviceLifecycle.ts @@ -6,8 +6,6 @@ import { TokenPriceService } from './services/priceEstimator.js' export type NewBlockAttemptCallback = (blockHeader: EthereumBlockHeader, ethereumClientService: EthereumClientService, isNewBlock: boolean) => Promise export type OnErrorBlockCallback = (ethereumClientService: EthereumClientService, error: unknown) => Promise -// Installs the selected RPC services and returns the pair that subsequent work must use. -export type ResetSimulationServices = (rpcNetwork: RpcEntry) => SimulationServices export type SimulationServices = { readonly ethereum: EthereumClientService @@ -64,7 +62,10 @@ export function resetSimulationServices( ) } -export type SimulationServicesOwner = ReturnType +export type SimulationServicesOwner = { + readonly getCurrent: () => SimulationServices + readonly reset: (rpcNetwork: RpcEntry) => SimulationServices +} // One owner publishes installed services. Returned pairs are snapshots for an operation; independent message handlers must read getCurrent() when their work starts. export function createSimulationServicesOwner( diff --git a/docs/popup-simulation-refresh.md b/docs/popup-simulation-refresh.md index 938282dad..ca2eedbb3 100644 --- a/docs/popup-simulation-refresh.md +++ b/docs/popup-simulation-refresh.md @@ -20,3 +20,7 @@ When adding a trigger, choose the required cancellation, visibility, error, and `captureSimulationSnapshot` reads the selected network, stack context, input and rich count at the storage boundary. Execution requires that snapshot; cache checks and execution share `getSimulationProviderForSnapshot`, which uses its network selection without re-reading global settings. Signer-only snapshots expose no simulation provider even though the service owner retains a supported provider for a later configured selection. The interactive queue carries the same snapshot through fingerprinting and execution. A missing RPC URL cannot be used to construct replacement RPC services. External-wallet signing transitions do not enqueue simulation refreshes: wallet acknowledgment depends on applying the selected network, not RPC simulation availability. Simulation-mode transitions and selected Safe signing stacks retain their visualization refreshes. + +`updatePopupVisualisationIfNeeded` takes named options for invalidation, throttling, unchanged-input skipping, and a captured snapshot. Omitted options keep the normal direct-refresh behavior. The interactive queue supplies its captured snapshot and owns coalescing; the executor owns serialization. + +Active settings commands receive `SimulationServicesOwner`, not a service pair captured before waiting for the transition semaphore. They read `getCurrent()` when preparing the refresh, so a preceding endpoint reset supplies the installed services. Both popup and dapp RPC requests enter `changeActiveRpc` in `walletSwitch.ts`, which owns routing, origin-specific Safe restrictions, local promotion, and correlated wallet dispatch. diff --git a/test/tests/activeSettingsConcurrency.test.ts b/test/tests/activeSettingsConcurrency.test.ts index bcc6b9636..5d17b6d40 100644 --- a/test/tests/activeSettingsConcurrency.test.ts +++ b/test/tests/activeSettingsConcurrency.test.ts @@ -2,10 +2,9 @@ import * as assert from 'node:assert' import { describe, expect, test } from 'bun:test' import type { ContactEntry, SafeEntry } from '../../app/ts/types/addressBookTypes.js' import type { TabConnection, WebsiteTabConnections } from '../../app/ts/types/user-interface-types.js' -import type { ResetSimulationServices } from '../../app/ts/simulation/serviceLifecycle.js' import { ICON_NOT_ACTIVE } from '../../app/ts/utils/constants.js' import type { RpcEntry } from '../../app/ts/types/rpc.js' -import { createDeferredSignal, createEthereumWithGetBlockCounter, createPort, installBrowserMock, loadModules, noopPublishRpcConnectionStatus } from './backgroundEthAccountsTestHarness.js' +import { createTestSimulationServicesOwner, createDeferredSignal, createEthereumWithGetBlockCounter, createPort, installBrowserMock, loadModules, noopPublishRpcConnectionStatus } from './backgroundEthAccountsTestHarness.js' const firstAddress: ContactEntry = { type: 'contact', name: 'First address', address: 1n, chainId: 'AllChains', entrySource: 'User', useAsActiveAddress: true, askForAddressAccess: false } const secondAddress: ContactEntry = { ...firstAddress, name: 'Second address', address: 2n } @@ -57,17 +56,17 @@ describe('active settings concurrency', () => { primary: false, } satisfies RpcEntry const resetNetworks: RpcEntry[] = [] - const resetSimulationServices: ResetSimulationServices = (network) => { resetNetworks.push(network); return { ethereum, tokenPriceService } } const { ethereum, tokenPriceService } = createEthereumWithGetBlockCounter({ count: 0 }) + const simulationServicesOwner = createTestSimulationServicesOwner({ ethereum, tokenPriceService }, network => { resetNetworks.push(network); return { ethereum, tokenPriceService } }) - const firstTransition = changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, connections, { + const firstTransition = changeActiveAddressAndChain(simulationServicesOwner, connections, { simulationMode: true, rpcNetwork: firstNetwork, activeAddress: firstAddress.address, promptForAccessesIfNeeded: false, }) await firstRpcWriteStarted - const secondTransition = changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, connections, { + const secondTransition = changeActiveAddressAndChain(simulationServicesOwner, connections, { simulationMode: true, rpcNetwork: secondNetwork, activeAddress: secondAddress.address, @@ -85,6 +84,45 @@ describe('active settings concurrency', () => { assert.equal((await getSettings()).activeRpcNetwork.chainId, secondNetwork.chainId) }) + test('a selection queued behind an endpoint reset uses the installed services', async () => { + installBrowserMock() + const { activateAddressSelection, changeActiveAddressAndChain, getSettings } = await loadModules() + const original = createEthereumWithGetBlockCounter({ count: 0 }) + const installed = createEthereumWithGetBlockCounter({ count: 0 }) + const owner = createTestSimulationServicesOwner(original, () => installed) + let oldReads = 0 + let installedReads = 0 + original.ethereum.getCachedBlock = () => { oldReads++; return undefined } + installed.ethereum.getCachedBlock = () => { installedReads++; return undefined } + const entered = createDeferredSignal() + const release = createDeferredSignal() + const originalSend = browser.runtime.sendMessage + let held = false + browser.runtime.sendMessage = async message => { + if (!held && typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_settingsUpdated') { + held = true + entered.resolve() + await release.promise + } + return await originalSend(message) + } + const rpcNetwork = { ...(await getSettings()).activeRpcNetwork, httpsRpc: 'https://installed.example' } + const safe: SafeEntry = { type: 'safe', name: 'Queued Safe', address: 3n, chainId: rpcNetwork.chainId, entrySource: 'User', useAsActiveAddress: true, safeSignerAddresses: [firstAddress.address] } + const first = changeActiveAddressAndChain(owner, new Map(), { simulationMode: true, rpcNetwork }) + try { + await entered.promise + const second = activateAddressSelection(owner, new Map(), { type: 'addressBookEntry', entry: safe }, { simulationMode: false, signerAddress: firstAddress.address, promptForAccessesIfNeeded: false }) + release.resolve() + await Promise.all([first, second]) + assert.equal(oldReads, 0) + assert.equal(installedReads, 2) + } finally { + release.resolve() + await first + browser.runtime.sendMessage = originalSend + } + }) + test.each([true, false])('keeps concurrent simulation selections consistent when selecting signer first: %j', async (signerFirst) => { installBrowserMock() const { activateAddressSelection, getSettings } = await loadModules() @@ -93,9 +131,9 @@ describe('active settings concurrency', () => { const addressSelection = { type: 'addressBookEntry', entry: secondAddress } as const const firstWriteStarted = pauseAfterFirstStorageWrite('useSignersAddressAsActiveAddress') const options = { simulationMode: true, signerAddress: firstAddress.address, promptForAccessesIfNeeded: false } - const first = activateAddressSelection(ethereum, tokenPriceService, () => ({ ethereum, tokenPriceService }), new Map(), signerFirst ? signerSelection : addressSelection, options) + const first = activateAddressSelection(createTestSimulationServicesOwner({ ethereum, tokenPriceService }, () => ({ ethereum, tokenPriceService })), new Map(), signerFirst ? signerSelection : addressSelection, options) await firstWriteStarted - const second = activateAddressSelection(ethereum, tokenPriceService, () => ({ ethereum, tokenPriceService }), new Map(), signerFirst ? addressSelection : signerSelection, options) + const second = activateAddressSelection(createTestSimulationServicesOwner({ ethereum, tokenPriceService }, () => ({ ethereum, tokenPriceService })), new Map(), signerFirst ? addressSelection : signerSelection, options) await Promise.all([first, second]) const settings = await getSettings() @@ -113,9 +151,9 @@ describe('active settings concurrency', () => { const safeSelection = { type: 'addressBookEntry', entry: safe } as const const firstWriteStarted = pauseAfterFirstStorageWrite('activeSigningSafeAddress') const options = { simulationMode: false, signerAddress: firstAddress.address, promptForAccessesIfNeeded: false } - const first = activateAddressSelection(ethereum, tokenPriceService, () => ({ ethereum, tokenPriceService }), new Map(), safeFirst ? safeSelection : signerSelection, options) + const first = activateAddressSelection(createTestSimulationServicesOwner({ ethereum, tokenPriceService }, () => ({ ethereum, tokenPriceService })), new Map(), safeFirst ? safeSelection : signerSelection, options) await firstWriteStarted - const second = activateAddressSelection(ethereum, tokenPriceService, () => ({ ethereum, tokenPriceService }), new Map(), safeFirst ? signerSelection : safeSelection, options) + const second = activateAddressSelection(createTestSimulationServicesOwner({ ethereum, tokenPriceService }, () => ({ ethereum, tokenPriceService })), new Map(), safeFirst ? signerSelection : safeSelection, options) await Promise.all([first, second]) assert.equal((await getSettings()).activeSigningSafeAddress, safeFirst ? undefined : safe.address) @@ -135,7 +173,7 @@ describe('active settings concurrency', () => { const services = createEthereumWithGetBlockCounter(counter) const rpcNetwork = { ...(await getSettings()).activeRpcNetwork, httpsRpc: 'https://failed-install.example' } const failure = new Error('Injected provider reset failure') - await assert.rejects(activateAddressSelection(services.ethereum, services.tokenPriceService, () => { throw failure }, new Map(), { type: 'addressBookEntry', entry: safe }, { + await assert.rejects(activateAddressSelection(createTestSimulationServicesOwner({ ethereum: services.ethereum, tokenPriceService: services.tokenPriceService }, () => { throw failure }), new Map(), { type: 'addressBookEntry', entry: safe }, { simulationMode: false, signerAddress: firstAddress.address, rpcNetwork, promptForAccessesIfNeeded: false, }), error => error === failure) assert.equal((await getSettings()).activeSigningSafeAddress, safe.address) @@ -162,8 +200,8 @@ describe('active settings concurrency', () => { const connections: WebsiteTabConnections = new Map([[socket.tabId, { connections: { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - await requestAccessFromUser(ethereum, tokenPriceService, resetSimulationServices, connections, socket, { websiteOrigin }, undefined, originalAddress, await getSettings(), originalAddress, undefined) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, connections, socket, { websiteOrigin }, undefined, originalAddress, await getSettings(), originalAddress, undefined) const pending = (await getPendingAccessRequests())[0] if (pending === undefined) throw new Error('Missing pending access request') @@ -184,7 +222,7 @@ describe('active settings concurrency', () => { return result }, }) - const approval = resolveInterceptorAccess(ethereum, tokenPriceService, resetSimulationServices, connections, { + const approval = resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, connections, { userReply: 'Approved', accessRequestId: pending.accessRequestId, originalRequestAccessToAddress: originalAddress.address, @@ -192,7 +230,7 @@ describe('active settings concurrency', () => { }, noopPublishRpcConnectionStatus) await approvalHasDialogLock.promise const transitionStarted = pauseAfterFirstStorageWrite('independentActiveSimulationAddress') - const transition = changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, connections, { simulationMode: true, activeAddress: originalAddress.address }) + const transition = changeActiveAddressAndChain(simulationServicesOwner, connections, { simulationMode: true, activeAddress: originalAddress.address }) await transitionStarted // Let the transition reach access prompting while the approval still owns the dialog lock. await new Promise((resolve) => setTimeout(resolve, 0)) @@ -229,15 +267,15 @@ describe('active settings concurrency', () => { configurable: true, value: async () => { throw new Error('Access popup failed to open') }, }) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) if (entryPoint === 'direct') { - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, connections, { simulationMode: true, activeAddress: selectedAddress.address }) + await changeActiveAddressAndChain(simulationServicesOwner, connections, { simulationMode: true, activeAddress: selectedAddress.address }) } else { - await activateAddressSelection(ethereum, tokenPriceService, resetSimulationServices, connections, { type: 'addressBookEntry', entry: selectedAddress }, { simulationMode: true, signerAddress: undefined }) + await activateAddressSelection(simulationServicesOwner, connections, { type: 'addressBookEntry', entry: selectedAddress }, { simulationMode: true, signerAddress: undefined }) } assert.equal((await getSettings()).activeSimulationAddress, selectedAddress.address) assert.equal((await getLatestUnexpectedError())?.data.message, 'Access popup failed to open') - await assert.rejects(updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, connections, await getSettings(), true, true), /Access popup failed to open/u) + await assert.rejects(updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, connections, await getSettings(), true, true), /Access popup failed to open/u) }) test.each([1, 2])('continues prompting after a failure when the next connection is in tab %j', async (secondTabId) => { @@ -263,8 +301,8 @@ describe('active settings concurrency', () => { return await originalCreate(...args) }, }) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, connections, { simulationMode: true, activeAddress: selectedAddress.address }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + await changeActiveAddressAndChain(simulationServicesOwner, connections, { simulationMode: true, activeAddress: selectedAddress.address }) const pending = await getPendingAccessRequests() try { assert.equal(promptAttempts, 2) @@ -273,7 +311,7 @@ describe('active settings concurrency', () => { } finally { // Close the successful prompt so the shared dialog state cannot leak into another test. for (const request of pending) { - await resolveInterceptorAccess(ethereum, tokenPriceService, resetSimulationServices, connections, { + await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, connections, { userReply: 'noResponse', accessRequestId: request.accessRequestId, originalRequestAccessToAddress: selectedAddress.address, requestAccessToAddress: selectedAddress.address, }, noopPublishRpcConnectionStatus) @@ -317,10 +355,10 @@ describe('active settings concurrency', () => { return await originalSetIcon(...args) }, }) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - const first = changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, connections, { simulationMode: true, activeAddress: firstAddress.address, promptForAccessesIfNeeded: false }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + const first = changeActiveAddressAndChain(simulationServicesOwner, connections, { simulationMode: true, activeAddress: firstAddress.address, promptForAccessesIfNeeded: false }) await iconStarted.promise - const second = changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, connections, { simulationMode: true, activeAddress: secondAddress.address, promptForAccessesIfNeeded: false }) + const second = changeActiveAddressAndChain(simulationServicesOwner, connections, { simulationMode: true, activeAddress: secondAddress.address, promptForAccessesIfNeeded: false }) let timeout: ReturnType | undefined try { await Promise.race([ @@ -354,21 +392,21 @@ describe('active settings concurrency', () => { const connections: WebsiteTabConnections = new Map([[1, { connections: { [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'example.test', approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) if (completion === 'staged') { const update = await reconcileWebsiteApprovalAccesses(connections, snapshot) await changeSimulationMode({ simulationMode: true, activeSimulationAddress: selectedAddress.address }) - await finishWebsiteAccessUpdate(ethereum, tokenPriceService, resetSimulationServices, connections, update, true) + await finishWebsiteAccessUpdate(ethereum, tokenPriceService, simulationServicesOwner, connections, update, true) } else { await changeSimulationMode({ simulationMode: true, activeSimulationAddress: selectedAddress.address }) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, connections, snapshot, true) + await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, connections, snapshot, true) } const pending = await getPendingAccessRequests() try { expect(pending.map((request) => request.requestAccessToAddress?.address)).toEqual([selectedAddress.address]) } finally { for (const request of pending) { - await resolveInterceptorAccess(ethereum, tokenPriceService, resetSimulationServices, connections, { + await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, connections, { userReply: 'noResponse', accessRequestId: request.accessRequestId, originalRequestAccessToAddress: selectedAddress.address, requestAccessToAddress: selectedAddress.address, }, noopPublishRpcConnectionStatus) @@ -380,8 +418,8 @@ describe('active settings concurrency', () => { installBrowserMock() const { activateAddressSelection } = await loadModules() const before = await browser.storage.local.get() - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - await assert.rejects(activateAddressSelection(ethereum, tokenPriceService, resetSimulationServices, new Map(), { type: 'addressBookEntry', entry: secondAddress }, { + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + await assert.rejects(activateAddressSelection(simulationServicesOwner, new Map(), { type: 'addressBookEntry', entry: secondAddress }, { simulationMode: false, signerAddress: firstAddress.address, }), /Signing mode can only activate the external signer or an owned Gnosis Safe/u) expect(await browser.storage.local.get()).toEqual(before) @@ -397,13 +435,13 @@ describe('active settings concurrency', () => { const connections: WebsiteTabConnections = new Map([[1, { connections: { [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'example.test', approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const rpcNetwork = { ...(await getSettings()).activeRpcNetwork, httpsRpc: 'https://replacement.invalid' } const failure = new Error('Service reset failed after settings persisted') - const failReset: ResetSimulationServices = () => { throw failure } + const failReset = createTestSimulationServicesOwner({ ethereum, tokenPriceService }, () => { throw failure }) const transition = entryPoint === 'direct' - ? changeActiveAddressAndChain(ethereum, tokenPriceService, failReset, connections, { simulationMode: true, activeAddress: selectedAddress.address, rpcNetwork }) - : activateAddressSelection(ethereum, tokenPriceService, failReset, connections, { type: 'addressBookEntry', entry: selectedAddress }, { simulationMode: true, signerAddress: undefined, rpcNetwork }) + ? changeActiveAddressAndChain(failReset, connections, { simulationMode: true, activeAddress: selectedAddress.address, rpcNetwork }) + : activateAddressSelection(failReset, connections, { type: 'addressBookEntry', entry: selectedAddress }, { simulationMode: true, signerAddress: undefined, rpcNetwork }) await assert.rejects(transition, (error: unknown) => error === failure) const pending = await getPendingAccessRequests() try { @@ -412,7 +450,7 @@ describe('active settings concurrency', () => { expect((await getTabState(1)).tabIconDetails).toEqual({ icon: ICON_NOT_ACTIVE, iconReason: 'example.test has PENDING access request for Second address!' }) } finally { for (const request of pending) { - await resolveInterceptorAccess(ethereum, tokenPriceService, resetSimulationServices, connections, { + await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, connections, { userReply: 'noResponse', accessRequestId: request.accessRequestId, originalRequestAccessToAddress: selectedAddress.address, requestAccessToAddress: selectedAddress.address, }, noopPublishRpcConnectionStatus) diff --git a/test/tests/backgroundAccountPermissions.test.ts b/test/tests/backgroundAccountPermissions.test.ts index b280b5479..5da4963fc 100644 --- a/test/tests/backgroundAccountPermissions.test.ts +++ b/test/tests/backgroundAccountPermissions.test.ts @@ -31,9 +31,9 @@ describe('background eth_accounts', () => { return [] }, }) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) let completed = false - const change = changeActiveAddress(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + const change = changeActiveAddress(simulationServicesOwner, new Map(), { method: 'popup_changeActiveAddress', data: { activeAddress: nextAddress, simulationMode: true }, }).then((reply) => { completed = true; return reply }) @@ -168,9 +168,9 @@ describe('background eth_accounts', () => { const firstSafe = 0x1010101010101010101010101010101010101010n const secondSafe = 0x2020202020202020202020202020202020202020n await changeSimulationMode({ simulationMode: false, activeSigningSafeAddress: firstSafe }) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await changeActiveAddressAndChain(simulationServicesOwner, new Map(), { simulationMode: false, activeAddress: secondSafe, signingAddressSelection: 'safe', @@ -207,9 +207,9 @@ describe('background eth_accounts', () => { httpsRpc: 'https://other-chain.example', primary: false, } - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await changeActiveAddressAndChain(simulationServicesOwner, new Map(), { simulationMode: false, rpcNetwork: nextNetwork, promptForAccessesIfNeeded: false, @@ -268,17 +268,17 @@ describe('background eth_accounts', () => { ]) await updateTabState(tabId, (previousState) => ({ ...previousState, signerAccounts: [signerAddress], activeSigningAddress: signerAddress })) await saveCurrentTabId(tabId) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await changeActiveAddress(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await changeActiveAddress(simulationServicesOwner, new Map(), { method: 'popup_changeActiveAddress', data: { activeAddress: arbitraryEoa, simulationMode: false }, }) - await changeActiveAddress(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await changeActiveAddress(simulationServicesOwner, new Map(), { method: 'popup_changeActiveAddress', data: { activeAddress: unownedSafe, simulationMode: false }, }) - await changeActiveAddress(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await changeActiveAddress(simulationServicesOwner, new Map(), { method: 'popup_changeActiveAddress', data: { activeAddress: unverifiedSafe, simulationMode: false }, }) @@ -308,10 +308,10 @@ describe('background eth_accounts', () => { useAsActiveAddress: true, safeSignerAddresses: [], }]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) assert.deepEqual( - await changeActiveAddress(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await changeActiveAddress(simulationServicesOwner, new Map(), { method: 'popup_changeActiveAddress', data: { activeAddress: wrongChainSafe, simulationMode: true }, }), @@ -345,9 +345,9 @@ describe('background eth_accounts', () => { useAsActiveAddress: true, safeSignerAddresses: [], }]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await changeActiveAddressAndChain(simulationServicesOwner, new Map(), { simulationMode: false, activeAddress: signerAddress, signingAddressSelection: 'signer', @@ -367,7 +367,7 @@ describe('background eth_accounts', () => { useAsActiveAddress: true, safeSignerAddresses: [signerAddress], }]) - await activateAddressSelection(ethereum, tokenPriceService, resetSimulationServices, new Map(), { type: 'signer', address: signerAddress }, { + await activateAddressSelection(simulationServicesOwner, new Map(), { type: 'signer', address: signerAddress }, { simulationMode: false, signerAddress, promptForAccessesIfNeeded: false, @@ -473,8 +473,8 @@ describe('background eth_accounts', () => { }) assert.deepEqual((await getPendingAccessRequests())[0]?.requestAccessToAddress, selfOwnedSafe) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - await resolveInterceptorAccess(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, new Map(), { userReply: 'Approved', requestAccessToAddress: address, originalRequestAccessToAddress: address, @@ -523,8 +523,8 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { connections: { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: true, uniqueRequestIdentifier: { requestId: 42, requestSocket: socket }, @@ -583,9 +583,9 @@ describe('background eth_accounts', () => { }]) await updateTabState(tabId, (previousState) => ({ ...previousState, signerAccounts: [], activeSigningAddress: undefined })) await saveCurrentTabId(tabId) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await changeActiveAddress(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await changeActiveAddress(simulationServicesOwner, new Map(), { method: 'popup_changeActiveAddress', data: { activeAddress: 'signer', simulationMode: false }, }) @@ -640,8 +640,8 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 12, requestSocket: socket }, @@ -676,15 +676,15 @@ describe('background eth_accounts', () => { }]) await updateTabState(tabId, (previousState) => ({ ...previousState, signerAccounts: [signerAddress], activeSigningAddress: signerAddress })) await saveCurrentTabId(tabId) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await changeActiveAddress(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await changeActiveAddress(simulationServicesOwner, new Map(), { method: 'popup_changeActiveAddress', data: { activeAddress: safeAddress, simulationMode: false }, }) assert.deepEqual(await getSigningAddressPreferences(), [{ signerAddress, selection: 'safe', safeAddress, chainId: 1n }]) - await changeActiveAddress(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await changeActiveAddress(simulationServicesOwner, new Map(), { method: 'popup_changeActiveAddress', data: { activeAddress: 'signer', simulationMode: false }, }) @@ -738,8 +738,8 @@ describe('background eth_accounts', () => { activeAddress: safeAddress, accessRequestId: 'safe-owner-changed-before-approval', }]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - const approve = async () => await resolveInterceptorAccess(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + const approve = async () => await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, new Map(), { userReply: 'Approved', requestAccessToAddress: safeAddress, originalRequestAccessToAddress: safeAddress, @@ -781,7 +781,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -789,7 +789,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.some((message) => message.method === 'request_signer_to_eth_requestAccounts'), false) assert.equal(messages.some((message) => message.method === 'connect'), false) @@ -838,7 +838,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -846,7 +846,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.some((message) => message.type === 'forwardToSigner'), false) assert.equal(messages.some((message) => message.method === 'request_signer_to_eth_requestAccounts'), false) @@ -886,7 +886,7 @@ describe('background eth_accounts', () => { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) await initializeSafeAppsCompatibility(websiteTabConnections) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, interceptorInternalRequest: true, @@ -896,7 +896,7 @@ describe('background eth_accounts', () => { params: [true, 'MetaMask', 2], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) await waitForPortMessageCount(messages, 'safe_apps_compatibility', 1) const connectedReplies = messages.filter((message) => message.method === 'connected_to_signer' && message.requestId === 12) @@ -921,10 +921,10 @@ describe('background eth_accounts', () => { await updateTabState(socket.tabId, (previous) => ({ ...previous, signerAccounts: [account], activeSigningAddress: account })) const connection = { port, socket, websiteOrigin, approved: false, wantsToConnect: false } const connections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [websiteSocketToString(socket)]: connection } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) assert.equal((await getSettings()).activeSigningSafeAddress, undefined) assert.equal('lifecycle' in connections, false) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 13, requestSocket: socket }, method: 'connected_to_signer', params: [true, 'MetaMask', 1], @@ -963,7 +963,7 @@ describe('background eth_accounts', () => { const connection = { port, socket, websiteOrigin, approved: false, wantsToConnect: false } const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: connection } }]]) await initializeSafeAppsCompatibility(websiteTabConnections) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, interceptorInternalRequest: true, @@ -973,7 +973,7 @@ describe('background eth_accounts', () => { params: [true, 'MetaMask', 1], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const connectedResult = messages.find((message) => message.method === 'connected_to_signer' && message.requestId === 13)?.result assert.equal(connection.approved, true) @@ -989,7 +989,7 @@ describe('background eth_accounts', () => { const childConnections = new Map([[childSocket.tabId, { ...confirmedSignerOwnership(childSocket), connections: { [websiteSocketToString(childSocket)]: childConnection } }]]) await initializeSafeAppsCompatibility(childConnections) await updateTabState(childSocket.tabId, (previousState) => ({ ...previousState, signerAccounts: [account], activeSigningAddress: account })) - await handleInterceptedRequest(childPort, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, childSocket, { + await handleInterceptedRequest(childPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, childSocket, { ...request, uniqueRequestIdentifier: { requestId: 14, requestSocket: childSocket }, }, childConnections, noopPublishRpcConnectionStatus) @@ -997,7 +997,7 @@ describe('background eth_accounts', () => { assert.equal(childConnection.approved, false) assert.equal(childResult?.metamaskCompatibilityMode, false) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, childConnections, await getSettings(), false) + await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, childConnections, await getSettings(), false) await waitForPortMessageCount(childMessages, 'safe_apps_compatibility', 1) assert.equal(childConnection.approved, true) assert.equal(childMessages.filter((message) => message.method === 'safe_apps_compatibility').every((message) => message.result?.enabled === false), true) @@ -1034,7 +1034,7 @@ describe('background eth_accounts', () => { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) await initializeSafeAppsCompatibility(websiteTabConnections) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const connectedRequest = { interceptorRequest: true, interceptorInternalRequest: true, @@ -1044,15 +1044,15 @@ describe('background eth_accounts', () => { params: [true, 'MetaMask', 1], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, connectedRequest, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, connectedRequest, websiteTabConnections, noopPublishRpcConnectionStatus) await waitForPortMessageCount(messages, 'safe_apps_compatibility', 1) assert.equal(messages.find((message) => message.method === 'connected_to_signer' && message.requestId === 15)?.result?.metamaskCompatibilityMode, false) assert.equal(messages.filter((message) => message.method === 'safe_apps_compatibility').every((message) => message.result?.enabled === false), true) await updateWebsiteAccess(() => [{ website, access: true, addressAccess: [{ address: account, access: true }] }]) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, await getSettings(), false) + await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), false) assert.equal(messages.filter((message) => message.method === 'safe_apps_compatibility').every((message) => message.result?.enabled === false), true) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { ...connectedRequest, uniqueRequestIdentifier: { requestId: 16, requestSocket: socket }, params: [false, 'NoSigner', 2], @@ -1170,7 +1170,7 @@ describe('background eth_accounts', () => { const { port, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_accounts') return replyToDiscovery = async () => { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1184,7 +1184,7 @@ describe('background eth_accounts', () => { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: !coldStart, wantsToConnect: !coldStart }, } }]]) await initializeSafeAppsCompatibility(websiteTabConnections) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) await updateTabState(socket.tabId, (previousState) => ({ ...previousState, signerName: 'MetaMask', @@ -1194,7 +1194,7 @@ describe('background eth_accounts', () => { })) if (coldStart) { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1313,7 +1313,7 @@ describe('background eth_accounts', () => { const socket = { tabId: 1, connectionName: 0n } const { port, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1326,7 +1326,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -1334,7 +1334,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_requestAccounts').length, 1) assert.equal(messages.some((message) => message.method === 'connect'), false) @@ -1346,7 +1346,7 @@ describe('background eth_accounts', () => { assert.deepEqual(pendingRequest.signerAccounts, [account]) assert.deepEqual((await getSettings()).websiteAccess[0]?.addressAccess, undefined) - await resolveInterceptorAccess(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', requestAccessToAddress: account, originalRequestAccessToAddress: account, @@ -1384,7 +1384,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -1392,7 +1392,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.some((message) => message.method === 'connect' || message.method === 'accountsChanged'), false) assert.equal(messages.filter((message) => message.method === 'eth_requestAccounts' && message.requestId === 22).at(-1)?.error?.code, 4100) @@ -1429,15 +1429,15 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: connection, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - const requestAccountsPromise = handleInterceptedRequest(port, websiteOrigin, pendingWebsite.promise, ethereum, tokenPriceService, resetSimulationServices, socket, { + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + const requestAccountsPromise = handleInterceptedRequest(port, websiteOrigin, pendingWebsite.promise, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 23, requestSocket: socket }, method: 'eth_requestAccounts', }, websiteTabConnections, noopPublishRpcConnectionStatus) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 24, requestSocket: socket }, @@ -1458,7 +1458,7 @@ describe('background eth_accounts', () => { assert.deepEqual(messages.filter((message) => message.method === 'eth_accounts' && message.requestId === 23), []) assert.equal((await getSettings()).websiteAccess[0]?.addressAccess, undefined) - await resolveInterceptorAccess(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', requestAccessToAddress: account, originalRequestAccessToAddress: account, @@ -1497,8 +1497,8 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: connection, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - const requestAccountsPromise = handleInterceptedRequest(port, websiteOrigin, pendingWebsite.promise, ethereum, tokenPriceService, resetSimulationServices, socket, { + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + const requestAccountsPromise = handleInterceptedRequest(port, websiteOrigin, pendingWebsite.promise, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 25, requestSocket: socket }, @@ -1556,7 +1556,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -1564,7 +1564,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.some((message) => message.method === 'request_signer_to_eth_requestAccounts'), false) assert.equal(messages.some((message) => message.method === 'connect'), false) @@ -1574,7 +1574,7 @@ describe('background eth_accounts', () => { assert.equal(pendingRequest.requestAccessToAddress?.address, account) assert.notEqual(pendingRequest.requestAccessToAddress?.type, 'safe') - await resolveInterceptorAccess(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', requestAccessToAddress: account, originalRequestAccessToAddress: account, @@ -1614,7 +1614,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -1627,7 +1627,7 @@ describe('background eth_accounts', () => { await firstWorkerAccess.requestAccessFromUser( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, socket, website, @@ -1640,7 +1640,7 @@ describe('background eth_accounts', () => { await restartedWorkerAccess.requestAccessFromUser( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, socket, website, @@ -1658,7 +1658,7 @@ describe('background eth_accounts', () => { await restartedWorkerAccess.resolveInterceptorAccess( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', @@ -1695,7 +1695,7 @@ describe('background eth_accounts', () => { if (message.method !== 'request_signer_to_eth_requestAccounts') return void (async () => { await updateWebsiteAccess(() => [{ website, access: false, addressAccess: undefined }]) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1709,7 +1709,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -1717,7 +1717,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_requestAccounts').length, 1) assert.equal(messages.some((message) => message.method === 'connect'), false) @@ -1746,7 +1746,7 @@ describe('background eth_accounts', () => { const socket = { tabId: 1, connectionName: 0n } const { port, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1759,7 +1759,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -1767,7 +1767,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_requestAccounts').length, 1) assert.equal(messages.some((message) => message.method === 'connect'), false) @@ -1795,7 +1795,7 @@ describe('background eth_accounts', () => { const socket = { tabId: 1, connectionName: 0n } const { port, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1808,7 +1808,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -1816,7 +1816,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_requestAccounts').length, 1) assert.equal(messages.some((message) => message.method === 'connect'), false) @@ -1847,7 +1847,7 @@ describe('background eth_accounts', () => { const { port: createdPort, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return void (async () => { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1862,7 +1862,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -1870,7 +1870,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_requestAccounts').length, 1) const requestAccountsReplies = messages.filter((message) => message.method === 'eth_requestAccounts' && message.requestId === 8) @@ -1915,7 +1915,7 @@ describe('background eth_accounts', () => { const accountRequest = accountRequests.find((candidate) => candidate.signerRequestMethod === message.method) if (accountRequest === undefined) return internalRequestId += 1 - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: true, @@ -1929,11 +1929,11 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) for (const [requestIndex, accountRequest] of accountRequests.entries()) { const requestId = 15 + requestIndex - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: true, uniqueRequestIdentifier: { requestId, requestSocket: socket }, @@ -1982,7 +1982,7 @@ describe('background eth_accounts', () => { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, [siblingConnectionKey]: { port: siblingPort, socket: siblingSocket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: true, @@ -1990,7 +1990,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - const requestPromise = handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + const requestPromise = handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) await waitForPortMessageCount(messages, 'request_signer_to_eth_requestAccounts', 1) sendInternalWindowMessage({ method: 'window_signer_accounts_changed', @@ -2004,7 +2004,7 @@ describe('background eth_accounts', () => { await new Promise((resolve) => setTimeout(resolve, 0)) assert.equal(messages.some((message) => message.requestId === 18), false) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -2051,7 +2051,7 @@ describe('background eth_accounts', () => { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, [siblingConnectionKey]: { port: siblingPort, socket: siblingSocket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -2059,7 +2059,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const pendingRequest = (await getPendingAccessRequests())[0] if (pendingRequest === undefined) throw new Error('Missing address access request') @@ -2067,7 +2067,7 @@ describe('background eth_accounts', () => { assert.deepEqual(messages.filter((message) => message.method === 'eth_accounts' && message.requestId === 18), []) assert.deepEqual(siblingMessages.filter((message) => message.method === 'connect' || message.method === 'accountsChanged' || message.method === 'chainChanged'), []) - await resolveInterceptorAccess(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', requestAccessToAddress: account, originalRequestAccessToAddress: account, @@ -2115,7 +2115,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -2124,14 +2124,14 @@ describe('background eth_accounts', () => { params: [{ eth_accounts: {} }], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const pendingRequest = (await getPendingAccessRequests())[0] if (pendingRequest === undefined) throw new Error('Missing pending request') const siteApprovalResolution = resolveInterceptorAccess( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', @@ -2176,7 +2176,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -2185,14 +2185,14 @@ describe('background eth_accounts', () => { params: [{ eth_accounts: {} }], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const pendingRequest = (await getPendingAccessRequests())[0] if (pendingRequest === undefined) throw new Error('Missing pending request') const siteApprovalResolution = resolveInterceptorAccess( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', @@ -2244,7 +2244,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -2253,7 +2253,7 @@ describe('background eth_accounts', () => { params: [{ eth_accounts: {} }], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const pendingRequest = (await getPendingAccessRequests())[0] if (pendingRequest === undefined) throw new Error('Missing address access request') @@ -2261,7 +2261,7 @@ describe('background eth_accounts', () => { assert.deepEqual(messages.filter((message) => message.method === 'accountsChanged'), []) assert.deepEqual(messages.filter((message) => message.method === 'wallet_requestPermissions' && message.requestId === 24), []) - await resolveInterceptorAccess(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', requestAccessToAddress: account, originalRequestAccessToAddress: account, @@ -2306,7 +2306,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: connection, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -2315,7 +2315,7 @@ describe('background eth_accounts', () => { params: [{ eth_accounts: {}, wallet_snap: {} }], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(connection.approved, false) assert.equal((await getPendingAccessRequests()).length, 1) @@ -2344,7 +2344,7 @@ describe('background eth_accounts', () => { let port: browser.runtime.Port const { port: createdPort, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -2358,7 +2358,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -2367,7 +2367,7 @@ describe('background eth_accounts', () => { params: [{ eth_accounts: {} }], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const siteLevelPendingRequest = (await getPendingAccessRequests())[0] if (siteLevelPendingRequest === undefined) throw new Error('Missing combined site and address access request') @@ -2375,7 +2375,7 @@ describe('background eth_accounts', () => { const siteApprovalResolution = resolveInterceptorAccess( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', @@ -2429,7 +2429,7 @@ describe('background eth_accounts', () => { let port: browser.runtime.Port const { port: createdPort, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -2443,7 +2443,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -2456,7 +2456,7 @@ describe('background eth_accounts', () => { requestAccessFromUser( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, socket, website, @@ -2476,7 +2476,7 @@ describe('background eth_accounts', () => { if (pendingRequest === undefined) throw new Error('Missing address access request') assert.equal(pendingRequest.requestAccessToAddress?.address, account) - await resolveInterceptorAccess(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', requestAccessToAddress: account, originalRequestAccessToAddress: account, @@ -2516,9 +2516,9 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await changeActiveAddressAndChain(simulationServicesOwner, websiteTabConnections, { simulationMode: true, activeAddress: nextAccount, }) @@ -2571,13 +2571,13 @@ describe('background eth_accounts', () => { signerChain: 1n, })) await saveCurrentTabId(socket.tabId) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) let websiteTabConnections: WebsiteTabConnections let accountReply: Promise | undefined const { port, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_accounts') return - accountReply = handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + accountReply = handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -2590,7 +2590,7 @@ describe('background eth_accounts', () => { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - await changeActiveAddress(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await changeActiveAddress(simulationServicesOwner, websiteTabConnections, { method: 'popup_changeActiveAddress', data: { activeAddress: 'signer', simulationMode: false }, }) @@ -2635,9 +2635,9 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await changeActiveAddressAndChain(simulationServicesOwner, websiteTabConnections, { simulationMode: true, activeAddress: nextAccount, }) @@ -2651,7 +2651,7 @@ describe('background eth_accounts', () => { await resolveInterceptorAccess( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, { userReply: 'Rejected', @@ -2680,9 +2680,9 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 10, requestSocket: socket }, @@ -2720,9 +2720,9 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 11, requestSocket: socket }, @@ -2738,7 +2738,7 @@ describe('background eth_accounts', () => { assert.equal(access?.access, false) assert.equal(access?.addressAccess, undefined) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 15, requestSocket: socket }, @@ -2765,9 +2765,9 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 12, requestSocket: socket }, @@ -2801,9 +2801,9 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 13, requestSocket: socket }, @@ -2813,10 +2813,10 @@ describe('background eth_accounts', () => { assert.equal(websiteTabConnections.get(socket.tabId)?.connections[connectionKey]?.approved, false) assert.equal(websiteTabConnections.get(socket.tabId)?.connections[connectionKey]?.wantsToConnect, false) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) assert.equal((await getPendingAccessRequests()).length, 0) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 14, requestSocket: socket }, @@ -2844,7 +2844,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const unsupportedParams: unknown[] = [ [], [{ wallet_switchEthereumChain: {} }], @@ -2854,7 +2854,7 @@ describe('background eth_accounts', () => { ] for (const [index, params] of unsupportedParams.entries()) { const requestId = 13 + index - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId, requestSocket: socket }, @@ -2905,9 +2905,9 @@ describe('background eth_accounts', () => { signerChain: 1n, })) await saveCurrentTabId(tabId) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await enableSimulationMode(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await enableSimulationMode(simulationServicesOwner, new Map(), { method: 'popup_enableSimulationMode', data: false, }) @@ -2916,7 +2916,7 @@ describe('background eth_accounts', () => { assert.equal(signingSettings.activeSimulationAddress, simulationAddress) assert.equal(signingSettings.activeSigningSafeAddress, undefined) assert.equal(signingSettings.useSignersAddressAsActiveAddress, false) - await enableSimulationMode(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await enableSimulationMode(simulationServicesOwner, new Map(), { method: 'popup_enableSimulationMode', data: true, }) @@ -2960,13 +2960,13 @@ describe('background eth_accounts', () => { signerChain: 1n, })) await saveCurrentTabId(tabId) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await enableSimulationMode(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await enableSimulationMode(simulationServicesOwner, new Map(), { method: 'popup_enableSimulationMode', data: false, }, { passiveReplyTimeoutMs: 10 }) - await changeActiveAddress(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await changeActiveAddress(simulationServicesOwner, new Map(), { method: 'popup_changeActiveAddress', data: { activeAddress: safeAddress, simulationMode: false }, }) @@ -2974,7 +2974,7 @@ describe('background eth_accounts', () => { assert.equal(settings.activeSigningSafeAddress, safeAddress) assert.equal(settings.activeSimulationAddress, signerAddress) - await enableSimulationMode(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await enableSimulationMode(simulationServicesOwner, new Map(), { method: 'popup_enableSimulationMode', data: true, }, { passiveReplyTimeoutMs: 10 }) @@ -3029,8 +3029,8 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - await enableSimulationMode(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + await enableSimulationMode(simulationServicesOwner, websiteTabConnections, { method: 'popup_enableSimulationMode', data: false, }, { passiveReplyTimeoutMs: 10 }) @@ -3045,7 +3045,7 @@ describe('background eth_accounts', () => { await updateUserAddressBookEntries((entries) => entries.map((entry) => entry.type === 'safe' ? { ...entry, safeSignerAddresses: [safeSignerAddress] } : entry)) await changeSimulationMode({ simulationMode: true, activeSimulationAddress: simulationAddress, activeSigningAddress: safeSignerAddress, activeSigningSafeAddress: safeAddress }) await setUseSignersAddressAsActiveAddress(false) - await enableSimulationMode(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await enableSimulationMode(simulationServicesOwner, websiteTabConnections, { method: 'popup_enableSimulationMode', data: false, }, { passiveReplyTimeoutMs: 10 }) @@ -3056,14 +3056,14 @@ describe('background eth_accounts', () => { assert.equal(ownedSafeSettings.activeSigningSafeAddress, safeAddress) assert.equal((await getActiveAddress(ownedSafeSettings, socket.tabId))?.address, safeAddress) - await enableSimulationMode(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await enableSimulationMode(simulationServicesOwner, websiteTabConnections, { method: 'popup_enableSimulationMode', data: true, }) const restoredSimulationSettings = await getSettings() assert.equal(restoredSimulationSettings.activeSimulationAddress, simulationAddress) assert.equal(restoredSimulationSettings.activeSigningSafeAddress, safeAddress) - await enableSimulationMode(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await enableSimulationMode(simulationServicesOwner, websiteTabConnections, { method: 'popup_enableSimulationMode', data: false, }) @@ -3072,7 +3072,7 @@ describe('background eth_accounts', () => { await updateTabState(socket.tabId, (previousState) => ({ ...previousState, signerAccounts: [], activeSigningAddress: undefined })) await changeSimulationMode({ simulationMode: true, activeSimulationAddress: simulationAddress, activeSigningAddress: undefined }) await setUseSignersAddressAsActiveAddress(false) - await enableSimulationMode(ethereum, tokenPriceService, resetSimulationServices, new Map(), { + await enableSimulationMode(simulationServicesOwner, new Map(), { method: 'popup_enableSimulationMode', data: false, }) @@ -3101,7 +3101,7 @@ describe('background eth_accounts', () => { const socket = { tabId: 1, connectionName: 0n } await changeSimulationMode({ simulationMode: true, activeSimulationAddress: undefined, activeSigningAddress: undefined }) await setUseSignersAddressAsActiveAddress(false) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) let websiteTabConnections: WebsiteTabConnections let accountReply: Promise | undefined @@ -3109,7 +3109,7 @@ describe('background eth_accounts', () => { if (message.method !== 'request_signer_to_eth_requestAccounts') return accountReply = new Promise((resolve) => { setTimeout(() => { - resolve(handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + resolve(handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -3176,12 +3176,12 @@ describe('background eth_accounts', () => { } await saveCurrentTabId(currentSocket.tabId) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) let websiteTabConnections: WebsiteTabConnections let accountReply: Promise | undefined const { port: currentPort, messages: currentMessages } = createPort(currentSocket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_accounts') return - accountReply = handleInterceptedRequest(currentPort, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, currentSocket, { + accountReply = handleInterceptedRequest(currentPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, currentSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -3200,7 +3200,7 @@ describe('background eth_accounts', () => { } }], ]) - await enableSimulationMode(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await enableSimulationMode(simulationServicesOwner, websiteTabConnections, { method: 'popup_enableSimulationMode', data: false, }) diff --git a/test/tests/backgroundEthAccountsTestHarness.ts b/test/tests/backgroundEthAccountsTestHarness.ts index db0c9424b..93aa62bef 100644 --- a/test/tests/backgroundEthAccountsTestHarness.ts +++ b/test/tests/backgroundEthAccountsTestHarness.ts @@ -1,5 +1,5 @@ import type { WebsiteTabConnections } from '../../app/ts/types/user-interface-types.js' -import type { ResetSimulationServices } from '../../app/ts/simulation/serviceLifecycle.js' +import type { SimulationServicesOwner } from '../../app/ts/simulation/serviceLifecycle.js' import { EthereumJSONRpcRequestHandler } from '../../app/ts/simulation/services/EthereumJSONRpcRequestHandler.js' import { EthereumClientService } from '../../app/ts/simulation/services/EthereumClientService.js' import { TokenPriceService } from '../../app/ts/simulation/services/priceEstimator.js' @@ -244,7 +244,7 @@ export function createEthereumWithGetBlockCounter( return { ethereum, tokenPriceService, - resetSimulationServices: (() => ({ ethereum, tokenPriceService })) satisfies ResetSimulationServices, + simulationServicesOwner: createTestSimulationServicesOwner({ ethereum, tokenPriceService }), } } @@ -255,3 +255,11 @@ export function getWalletSwitchRequestId(messages: readonly PortMessage[], index if (typeof id !== 'string') throw new Error('Missing wallet switch request ID') return id } + +export function createTestSimulationServicesOwner(initial: { ethereum: EthereumClientService, tokenPriceService: TokenPriceService }, reset?: SimulationServicesOwner['reset']): SimulationServicesOwner { + let current = initial + return { + getCurrent: () => current, + reset: network => { current = reset === undefined ? current : reset(network); return current }, + } +} diff --git a/test/tests/backgroundEthSimulateV1.test.ts b/test/tests/backgroundEthSimulateV1.test.ts index ffa89e7e9..9d496cd3a 100644 --- a/test/tests/backgroundEthSimulateV1.test.ts +++ b/test/tests/backgroundEthSimulateV1.test.ts @@ -1,6 +1,6 @@ +import { createTestSimulationServicesOwner } from './backgroundEthAccountsTestHarness.js' import * as assert from 'assert' import { describe, test } from 'bun:test' -import type { ResetSimulationServices } from '../../app/ts/simulation/serviceLifecycle.js' import { EthereumClientService } from '../../app/ts/simulation/services/EthereumClientService.js' import { TokenPriceService } from '../../app/ts/simulation/services/priceEstimator.js' import { EthereumJsonRpcRequest, JsonRpcResponse } from '../../app/ts/types/JsonRpc-types.js' @@ -137,7 +137,7 @@ function createEthereum(rpcEntry: RpcEntry, ethSimulateV1Result?: unknown) { ethereum, requestHandler, tokenPriceService, - resetSimulationServices: (() => ({ ethereum, tokenPriceService })) satisfies ResetSimulationServices, + simulationServicesOwner: createTestSimulationServicesOwner({ ethereum, tokenPriceService }, (() => ({ ethereum, tokenPriceService }))), } } @@ -158,16 +158,16 @@ async function createApprovedDappHarness(ethSimulateV1Result?: unknown) { const websiteTabConnections = new Map([[socket.tabId, { connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, requestHandler, tokenPriceService, resetSimulationServices } = createEthereum(rpcEntry, ethSimulateV1Result) - return { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, requestHandler, tokenPriceService, resetSimulationServices } + const { ethereum, requestHandler, tokenPriceService, simulationServicesOwner } = createEthereum(rpcEntry, ethSimulateV1Result) + return { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, requestHandler, tokenPriceService, simulationServicesOwner } } describe('background eth_simulateV1', () => { test('replies to approved dapp eth_simulateV1 requests', async () => { - const { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, requestHandler, tokenPriceService, resetSimulationServices } = await createApprovedDappHarness() + const { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, requestHandler, tokenPriceService, simulationServicesOwner } = await createApprovedDappHarness() const parentBlockHash = '0x000000000000000000000000000000000000000000000000000000000000abcd' - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 42, requestSocket: socket }, @@ -210,10 +210,10 @@ describe('background eth_simulateV1', () => { }) test('preserves blob transaction fields in dapp eth_simulateV1 requests', async () => { - const { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, requestHandler, tokenPriceService, resetSimulationServices } = await createApprovedDappHarness() + const { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, requestHandler, tokenPriceService, simulationServicesOwner } = await createApprovedDappHarness() const blobVersionedHash = '0x01'.padEnd(66, '0') - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 44, requestSocket: socket }, @@ -260,9 +260,9 @@ describe('background eth_simulateV1', () => { }) test('accepts one-parameter eth_simulateV1 requests and preserves blobBaseFee', async () => { - const { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, requestHandler, tokenPriceService, resetSimulationServices } = await createApprovedDappHarness() + const { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, requestHandler, tokenPriceService, simulationServicesOwner } = await createApprovedDappHarness() - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 43, requestSocket: socket }, @@ -331,9 +331,9 @@ describe('background eth_simulateV1', () => { }], }], }] - const { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, tokenPriceService, resetSimulationServices } = await createApprovedDappHarness(ethSimulateV1Result) + const { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, tokenPriceService, simulationServicesOwner } = await createApprovedDappHarness(ethSimulateV1Result) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 45, requestSocket: socket }, diff --git a/test/tests/backgroundProviderRouting.test.ts b/test/tests/backgroundProviderRouting.test.ts index ac7bffec5..58be5ef77 100644 --- a/test/tests/backgroundProviderRouting.test.ts +++ b/test/tests/backgroundProviderRouting.test.ts @@ -22,13 +22,13 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) for (const [requestId, queriedAccount] of [ [1, accountString], [2, '0x2222222222222222222222222222222222222222'], ] as const) { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId, requestSocket: socket }, @@ -57,7 +57,7 @@ describe('background eth_accounts', () => { await changeSimulationMode({ simulationMode: false, activeSimulationAddress: account, activeSigningAddress: account }) await setUseSignersAddressAsActiveAddress(true) await updateTabState(socket.tabId, (previousState) => ({ ...previousState, signerAccounts: [account], activeSigningAddress: account })) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 3, requestSocket: socket }, @@ -117,12 +117,12 @@ describe('background eth_accounts', () => { } }]]) const getBlockCalls = { count: 0 } const singletonAddress = 0x41675c099f32341bf84bfc5382af534df5c7461an - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter(getBlockCalls, { + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter(getBlockCalls, { getCodeResult: new Uint8Array([0x60]), getStorageAtResult: singletonAddress, }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, @@ -140,7 +140,7 @@ describe('background eth_accounts', () => { result: '0x60', }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 2, requestSocket: socket }, @@ -176,9 +176,9 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, @@ -251,9 +251,9 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, @@ -311,9 +311,9 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 2, requestSocket: socket }, @@ -346,7 +346,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) for (const [index, method] of [ 'connected_to_signer', @@ -356,7 +356,7 @@ describe('background eth_accounts', () => { 'signer_reply', 'wallet_switchEthereumChain_reply', ].entries()) { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: index + 1, requestSocket: socket }, @@ -388,9 +388,9 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -445,9 +445,9 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 [connectionKey]: connection, [childConnectionKey]: { port: childPort, socket: childSocket, websiteOrigin, approved: false, wantsToConnect: false }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: true, @@ -465,7 +465,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal(noSignerState.activeSigningAddress, undefined) assert.equal(messages.some((message) => message.method === 'request_signer_chainId'), false) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: true, @@ -482,7 +482,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal((await getTabState(socket.tabId)).signerAccountError, undefined) // Signer identity is trusted extension state and must be current before the website receives access. - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -495,7 +495,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal(identifiedSignerState.signerConnected, true) assert.equal(messages.some((message) => message.method === 'request_signer_chainId'), false) - await handleInterceptedRequest(childPort, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, childSocket, { + await handleInterceptedRequest(childPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, childSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: true, @@ -510,7 +510,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 await updateWebsiteAccess(() => [{ website, access: true, addressAccess: undefined }]) connection.approved = true - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -553,7 +553,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 if (message.method !== 'request_signer_to_eth_requestAccounts') return void (async () => { signerAccountSnapshots.push([...(await getTabState(socket.tabId)).signerAccounts]) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -568,7 +568,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) await updateTabState(socket.tabId, (previousState) => ({ ...previousState, signerName: 'Brave', @@ -579,7 +579,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 activeSigningAddress: braveAccount, })) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -596,7 +596,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal(stateAfterMetaMaskSelection.signerAccountError, undefined) assert.equal(stateAfterMetaMaskSelection.activeSigningAddress, undefined) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 201, requestSocket: socket }, @@ -618,7 +618,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 { port: nextPort, socket: nextSocket, websiteOrigin, approved: true, wantsToConnect: true }, true, ) - await handleInterceptedRequest(nextPort, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, nextSocket, { + await handleInterceptedRequest(nextPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, nextSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -652,7 +652,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 }) completionChannel.addEventListener('message', completionListener) try { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -660,7 +660,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 method: 'eth_accounts_reply', params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x4141414141414141414141414141414141414141'], requestAccounts: true }], }, websiteTabConnections, noopPublishRpcConnectionStatus) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -668,7 +668,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 method: 'eth_accounts_reply', params: [{ signerProviderGeneration: 1, type: 'error', requestAccounts: true, error: { code: 4001, message: 'Late Brave error' } }], }, websiteTabConnections, noopPublishRpcConnectionStatus) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -719,7 +719,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 let restoredPort: browser.runtime.Port const { port: createdRestoredPort, messages } = createPort(restoredSocket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_accounts') return - void handleInterceptedRequest(restoredPort, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, restoredSocket, { + void handleInterceptedRequest(restoredPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, restoredSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -740,7 +740,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 [websiteSocketToString(previousSocket)]: { port: previousPort, socket: previousSocket, websiteOrigin, approved: true, wantsToConnect: true }, }, }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) await updateTabState(restoredSocket.tabId, (previousState) => ({ ...previousState, signerName: 'MetaMask', @@ -756,7 +756,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 true, ) - const accountRequest = handleInterceptedRequest(restoredPort, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, restoredSocket, { + const accountRequest = handleInterceptedRequest(restoredPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, restoredSocket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 300, requestSocket: restoredSocket }, @@ -766,7 +766,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal(messages.some((message) => message.method === 'request_signer_to_eth_accounts'), false) assert.equal(messages.some((message) => message.method === 'eth_accounts' && message.requestId === 300), false) - await handleInterceptedRequest(restoredPort, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, restoredSocket, { + await handleInterceptedRequest(restoredPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, restoredSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -803,7 +803,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const createdPort = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return void (async () => { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -811,7 +811,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 method: 'connected_to_signer', params: [true, 'MetaMask', 2], }, websiteTabConnections, noopPublishRpcConnectionStatus) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -828,9 +828,9 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, }, }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: true, uniqueRequestIdentifier: { requestId: 307, requestSocket: socket }, @@ -874,7 +874,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, }, }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const currentError = { code: 4001, message: 'Current signer error' } await updateTabState(socket.tabId, (previousState) => ({ ...previousState, @@ -896,7 +896,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 [310, { signerProviderGeneration: 1, type: 'success', accounts: ['0x6262626262626262626262626262626262626262'], requestAccounts: true }], [311, { signerProviderGeneration: 1, type: 'error', requestAccounts: true, error: { code: 4900, message: 'Stale error' } }], ] as const) { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -905,7 +905,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 params: [params], }, websiteTabConnections, noopPublishRpcConnectionStatus) } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -975,9 +975,9 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -992,7 +992,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal((await getActiveAddress(settings, socket.tabId))?.address, safeAddress) assert.equal(messages.some((message) => message.method === 'chainChanged'), false) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1005,7 +1005,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal(settingsAfterDisconnect.activeSigningSafeAddress, undefined) assert.equal((await getActiveAddress(settingsAfterDisconnect, socket.tabId)), undefined) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1017,7 +1017,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const otherSignerAddress = 0x5353535353535353535353535353535353535353n assert.equal((await getSigningAddressPreferences()).some((preference) => preference.signerAddress === otherSignerAddress), false) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1077,8 +1077,8 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'https://remembered.example', approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - const selectSignerAccount = async (account: bigint, requestId: number) => await handleInterceptedRequest(port, 'https://remembered.example', { websiteOrigin: 'https://remembered.example', icon: undefined, title: undefined }, ethereum, tokenPriceService, resetSimulationServices, socket, { + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + const selectSignerAccount = async (account: bigint, requestId: number) => await handleInterceptedRequest(port, 'https://remembered.example', { websiteOrigin: 'https://remembered.example', icon: undefined, title: undefined }, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1163,7 +1163,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const typedData = JSON.stringify({ types: { EIP712Domain: [], @@ -1190,7 +1190,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 params: ['0x5555555555555555555555555555555555555555', typedData], }, ]) { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) } for (const requestId of [210, 211]) { @@ -1291,7 +1291,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const typedData = JSON.stringify({ types: { EIP712Domain: [], @@ -1336,7 +1336,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 }], }, ]) { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) } for (const requestId of [213, 214, 215]) { @@ -1395,15 +1395,15 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await changeActiveAddressAndChain(simulationServicesOwner, websiteTabConnections, { simulationMode: false, activeAddress: safeAddress, signingAddressSelection: 'safe', }) assert.notEqual((await getActiveAddress(await getSettings(), socket.tabId))?.address, safeAddress) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 212, requestSocket: socket }, @@ -1489,10 +1489,10 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) assert.equal((await getActiveAddress(await getSettings(), socket.tabId))?.address, safeSignerAddress) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 208, requestSocket: socket }, @@ -1502,13 +1502,13 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const ethAccountsReplies = messages.filter((message) => message.method === 'eth_accounts' && message.requestId === 208) assert.deepEqual(ethAccountsReplies.at(-1)?.result, [addressString(safeSignerAddress)]) - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await changeActiveAddressAndChain(simulationServicesOwner, websiteTabConnections, { simulationMode: false, activeAddress: safeAddress, signingAddressSelection: 'safe', }) assert.equal((await getActiveAddress(await getSettings(), socket.tabId))?.address, safeSignerAddress) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 209, requestSocket: socket }, @@ -1519,13 +1519,13 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 Array.isArray(message.result) && message.result.includes('0x5353535353535353535353535353535353535353') ), false) - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await changeActiveAddressAndChain(simulationServicesOwner, websiteTabConnections, { simulationMode: false, activeAddress: undefined, signingAddressSelection: 'signer', }) assert.equal((await getSettings()).activeSimulationAddress, safeAddress) - await changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await changeActiveAddressAndChain(simulationServicesOwner, websiteTabConnections, { simulationMode: true, }) assert.equal((await getSettings()).activeSimulationAddress, safeAddress) @@ -1560,9 +1560,9 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1613,10 +1613,10 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) assert.equal((await getActiveAddress(await getSettings(), socket.tabId))?.address, signerAddress) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1648,7 +1648,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) const getBlockCalls = { count: 0 } - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter(getBlockCalls) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter(getBlockCalls) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -1656,7 +1656,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 method: 'eth_accounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(getBlockCalls.count, 0) assert.equal(messages.some((message) => message.method === 'request_signer_to_eth_accounts'), false) @@ -1680,7 +1680,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -1688,7 +1688,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 method: 'eth_accounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const ethAccountsReplies = messages.filter((message) => message.method === 'eth_accounts' && message.requestId === 2) assert.deepEqual(ethAccountsReplies.at(-1)?.result, []) @@ -1710,7 +1710,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -1718,7 +1718,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 method: 'wallet_getPermissions', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const permissionsReplies = messages.filter((message) => message.method === 'wallet_getPermissions' && message.requestId === 3) assert.deepEqual(permissionsReplies.at(-1)?.result, []) @@ -1770,8 +1770,8 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 31, requestSocket: socket }, @@ -1810,7 +1810,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) await updateTabState(socket.tabId, (previousState) => ({ ...previousState, signerAccounts: [account], activeSigningAddress: undefined })) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -1819,7 +1819,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 } await Promise.race([ - handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus), + handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus), new Promise((_, reject) => setTimeout(() => reject(new Error('wallet_getPermissions did not resolve')), 100)), ]) @@ -1845,7 +1845,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) await updateTabState(socket.tabId, (previousState) => ({ ...previousState, signerAccounts: [account], activeSigningAddress: undefined })) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -1854,7 +1854,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 } await Promise.race([ - handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus), + handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus), new Promise((_, reject) => setTimeout(() => reject(new Error('wallet_getPermissions did not resolve')), 100)), ]) diff --git a/test/tests/backgroundSignerLifecycle.test.ts b/test/tests/backgroundSignerLifecycle.test.ts index a49318511..5612f86da 100644 --- a/test/tests/backgroundSignerLifecycle.test.ts +++ b/test/tests/backgroundSignerLifecycle.test.ts @@ -19,7 +19,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }, { initialBlockPolling: false }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }, { initialBlockPolling: false }) const rpcNetwork = ethereum.getRpcEntry() await setRpcConnectionStatus({ isConnected: false, @@ -41,7 +41,7 @@ describe('background eth_accounts', () => { method: 'eth_chainId', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, publishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, publishRpcConnectionStatus) assert.deepEqual(publishedRetryStates, [true]) assert.equal((await getRpcConnectionStatus())?.retrying, true) @@ -65,7 +65,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }, { initialBlockPolling: false }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }, { initialBlockPolling: false }) await setRpcConnectionStatus({ isConnected: false, lastConnnectionAttempt: new Date('2024-01-01T00:00:00.000Z'), @@ -85,7 +85,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, publishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, publishRpcConnectionStatus) assert.equal(publishCalls, 0) const requestAccountsReplies = messages.filter((message) => message.method === 'eth_accounts' && message.requestId === 15) @@ -125,7 +125,7 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -133,7 +133,7 @@ describe('background eth_accounts', () => { method: 'eth_accounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_accounts').length, 1) assert.equal(messages.some((message) => message.method === 'request_signer_to_eth_requestAccounts'), false) @@ -175,9 +175,9 @@ describe('background eth_accounts', () => { const websiteTabConnections = new Map([[socket.tabId, { ...confirmedSignerOwnership(socket), connections: { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 8, requestSocket: socket }, @@ -225,9 +225,9 @@ describe('background eth_accounts', () => { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, [childConnectionKey]: { port: childPort, socket: childSocket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const replyWithSignerAccounts = async (requestId: number, requestAccounts: boolean, accounts: readonly string[]) => { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -240,7 +240,7 @@ describe('background eth_accounts', () => { const passiveRequest = refreshSignerAccountsFromApprovedWebsitePorts(websiteTabConnections, false) await waitForPortMessageCount(messages, 'request_signer_to_eth_accounts', 1) - const interactiveRequest = handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + const interactiveRequest = handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 71, requestSocket: socket }, @@ -286,14 +286,14 @@ describe('background eth_accounts', () => { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: false, wantsToConnect: false }, [websiteSocketToString(childSocket)]: { port: childPort, socket: childSocket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const account = '0x2424242424242424242424242424242424242424' await changeSimulationMode({ simulationMode: true, activeSimulationAddress: undefined, activeSigningAddress: undefined }) await setUseSignersAddressAsActiveAddress(false) const refresh = refreshSignerAccountsFromApprovedWebsitePorts(websiteTabConnections, false) await waitForPortMessageCount(messages, 'request_signer_to_eth_accounts', 1) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -309,7 +309,7 @@ describe('background eth_accounts', () => { assert.notEqual(signerStateToken, false) assert.equal(messages.filter((message) => message.method === 'request_signer_to_wallet_switchEthereumChain').length, 1) assert.equal(childMessages.some((message) => message.method === 'request_signer_to_wallet_switchEthereumChain'), false) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -397,8 +397,8 @@ describe('background eth_accounts', () => { rpcNetwork: requestedRpcNetwork, simulationMode: false, }) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - const resolution = resolveChainChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + const resolution = resolveChainChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { method: 'popup_changeChainDialog', data: { rpcNetwork: requestedRpcNetwork, uniqueRequestIdentifier, accept: true }, }) @@ -469,8 +469,8 @@ describe('background eth_accounts', () => { rpcNetwork: requestedRpcNetwork, simulationMode: false, }) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) - const resolution = resolveChainChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + const resolution = resolveChainChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { method: 'popup_changeChainDialog', data: { rpcNetwork: requestedRpcNetwork, uniqueRequestIdentifier, accept: true }, }) @@ -478,7 +478,7 @@ describe('background eth_accounts', () => { await new Promise((resolve) => setTimeout(resolve, 0)) await removeWebsiteTabConnection(websiteTabConnections, approvingSocket, approvingPort) - await handleInterceptedRequest(ownerPort, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, ownerSocket, { + await handleInterceptedRequest(ownerPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, ownerSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -564,9 +564,9 @@ describe('background eth_accounts', () => { rpcNetwork: requestedRpcNetwork, simulationMode: false, }) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) let requestSettled = false - const resolution = resolveChainChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + const resolution = resolveChainChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { method: 'popup_changeChainDialog', data: { rpcNetwork: requestedRpcNetwork, uniqueRequestIdentifier, accept: true }, }).then(() => { requestSettled = true }) @@ -574,13 +574,13 @@ describe('background eth_accounts', () => { await new Promise((resolve) => setTimeout(resolve, 0)) await saveCurrentTabId(popupSocket.tabId) - const popupReply = await popupChangeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + const popupReply = await popupChangeActiveRpc(simulationServicesOwner, websiteTabConnections, { method: 'popup_changeActiveRpc', data: popupRpcNetwork, - }, await getSettings()) + }) assert.deepEqual(popupReply, { type: 'PopupSettingsChangeReply', ok: false, message: 'A network switch is already waiting for your wallet.' }) assert.equal(popupMessages.some((message) => message.method === 'request_signer_to_wallet_switchEthereumChain'), false) - await handleInterceptedRequest(popupPort, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, popupSocket, { + await handleInterceptedRequest(popupPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, popupSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -591,7 +591,7 @@ describe('background eth_accounts', () => { await new Promise((resolve) => setTimeout(resolve, 0)) assert.equal(requestSettled, false) - await handleInterceptedRequest(requestPort, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, requestSocket, { + await handleInterceptedRequest(requestPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, requestSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -667,11 +667,11 @@ describe('background eth_accounts', () => { params: [{ chainId: secondRpcNetwork.chainId }], } await changeSimulationMode({ simulationMode: false, rpcNetwork: currentRpcNetwork, activeSimulationAddress: undefined, activeSigningAddress: undefined }) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const firstResolution = openChangeChainDialog( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, firstRequest, false, @@ -685,7 +685,7 @@ describe('background eth_accounts', () => { pendingChainChange = await getChainChangeConfirmationPromise() } if (pendingChainChange === undefined) throw new Error('Missing production chain-change dialog state') - await resolveChainChange(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, { + await resolveChainChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { method: 'popup_changeChainDialog', data: { rpcNetwork: requestedRpcNetwork, uniqueRequestIdentifier: firstUniqueRequestIdentifier, accept: true }, }) @@ -699,7 +699,7 @@ describe('background eth_accounts', () => { openChangeChainDialog( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, secondRequest, false, @@ -712,7 +712,7 @@ describe('background eth_accounts', () => { releaseDeferredChainChangeRemoval() await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -750,7 +750,7 @@ describe('background eth_accounts', () => { const stateAtDappReply: Array = [] const { port: createdPort, messages } = createPort(socket.tabId, (message) => { if (message.method === 'request_signer_to_eth_requestAccounts') { - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -773,7 +773,7 @@ describe('background eth_accounts', () => { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, [siblingConnectionKey]: { port: siblingPort, socket: siblingSocket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -781,7 +781,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_requestAccounts').length, 1) await new Promise((resolve) => setTimeout(resolve, 0)) @@ -833,7 +833,7 @@ describe('background eth_accounts', () => { const siblingSocket = { tabId: 1, connectionName: 1n } const { port: createdPort, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -850,7 +850,7 @@ describe('background eth_accounts', () => { [connectionKey]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, [siblingConnectionKey]: { port: siblingPort, socket: siblingSocket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -858,7 +858,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.some((message) => message.method === 'connect'), false) assert.deepEqual(messages.filter((message) => message.method === 'accountsChanged').map((message) => message.requestId), [17]) @@ -890,7 +890,7 @@ describe('background eth_accounts', () => { const socket = { tabId: 1, connectionName: 0n } const { port: createdPort, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -905,7 +905,7 @@ describe('background eth_accounts', () => { [connectionKey]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) await updateDeclarativeNetRequestBlocks(websiteTabConnections) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -914,7 +914,7 @@ describe('background eth_accounts', () => { params: [{ eth_accounts: {} }], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, resetSimulationServices, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const permissionResult = [{ parentCapability: 'eth_accounts', diff --git a/test/tests/backgroundUtilsMessaging.test.ts b/test/tests/backgroundUtilsMessaging.test.ts index 35a7dabdc..e00e4238d 100644 --- a/test/tests/backgroundUtilsMessaging.test.ts +++ b/test/tests/backgroundUtilsMessaging.test.ts @@ -1,3 +1,4 @@ +import { createTestSimulationServicesOwner } from './backgroundEthAccountsTestHarness.js' import { createEthereumWithGetBlockCounter } from './backgroundEthAccountsTestHarness.js' import * as assert from 'assert' import { describe, test } from 'bun:test' @@ -204,12 +205,12 @@ describe('backgroundUtils messaging', () => { globalThis.browser.runtime.sendMessage = async () => undefined const { popupMessageHandler, PopupRequestsReplies } = await loadModules() - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const reply = await popupMessageHandler( new Map(), ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, { method: 'popup_requestCompleteVisualizedSimulation' }, { activeSimulationAddress: 0xd8da6bf26964af9d7eed9e03e53415d37aa96045n, @@ -248,7 +249,7 @@ describe('backgroundUtils messaging', () => { new Map(), ethereum, tokenPriceService, - () => undefined, + createTestSimulationServicesOwner({ ethereum, tokenPriceService }), { method: 'not_a_popup_method' }, { activeSimulationAddress: 0xd8da6bf26964af9d7eed9e03e53415d37aa96045n, diff --git a/test/tests/interceptorAccessCloseRace.test.ts b/test/tests/interceptorAccessCloseRace.test.ts index 57bd00a94..208a34355 100644 --- a/test/tests/interceptorAccessCloseRace.test.ts +++ b/test/tests/interceptorAccessCloseRace.test.ts @@ -177,10 +177,10 @@ describe('interceptor access close handling', () => { } const ethereum = {} as never const tokenPriceService = {} as never - const resetSimulationServices = (() => undefined) as never + const simulationServicesOwner = (() => undefined) as never const { getActiveAddressEntryForChain } = await import('../../app/ts/background/metadataUtils.js') - await requestAccessFromUser(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, socket, website, request, undefined, await getSettings(), await getActiveAddressEntryForChain(account, 1n), async () => undefined) + await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, website, request, undefined, await getSettings(), await getActiveAddressEntryForChain(account, 1n), async () => undefined) const postedMessages = browserMock.postedMessages as Array<{ method?: string, result?: unknown, requestId?: number }> const providerRequestMessages = postedMessages @@ -218,9 +218,9 @@ describe('interceptor access close handling', () => { } const ethereum = {} as never const tokenPriceService = {} as never - const resetSimulationServices = (() => undefined) as never + const simulationServicesOwner = (() => undefined) as never - await requestAccessFromUser(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, socket, website, undefined, undefined, settings, undefined, undefined) + await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, website, undefined, undefined, settings, undefined, undefined) const request: InterceptedRequest = { interceptorRequest: true, @@ -234,7 +234,7 @@ describe('interceptor access close handling', () => { concurrentRequest = requestAccessFromUser( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, socket, website, @@ -287,7 +287,7 @@ describe('interceptor access close handling', () => { } const ethereum = {} as never const tokenPriceService = {} as never - const resetSimulationServices = (() => undefined) as never + const simulationServicesOwner = (() => undefined) as never const request: InterceptedRequest = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -295,7 +295,7 @@ describe('interceptor access close handling', () => { method: 'eth_accounts', } - await requestAccessFromUser(ethereum, tokenPriceService, resetSimulationServices, websiteTabConnections, socket, website, request, undefined, settings, undefined, async () => undefined) + await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, website, request, undefined, settings, undefined, async () => undefined) let closeAccessDialog: Promise | undefined browserMock.onPendingAccessRead(() => { @@ -305,7 +305,7 @@ describe('interceptor access close handling', () => { await resolveInterceptorAccess( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, { originalRequestAccessToAddress: undefined, requestAccessToAddress: undefined, accessRequestId: 'undefined || https://example.test', userReply: 'Approved' }, async () => undefined, @@ -358,7 +358,7 @@ describe('interceptor access close handling', () => { ]) const ethereum = {} as never const tokenPriceService = {} as never - const resetSimulationServices = (() => undefined) as never + const simulationServicesOwner = (() => undefined) as never const publishRpcConnectionStatus = async () => undefined await changeSimulationMode({ simulationMode: true, activeSimulationAddress: account, activeSigningAddress: undefined }) const activeAddress = await getActiveAddressEntryForChain(account, 1n) @@ -383,7 +383,7 @@ describe('interceptor access close handling', () => { await requestAccessFromUser( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, firstSocket, firstWebsite, @@ -400,7 +400,7 @@ describe('interceptor access close handling', () => { resolveInterceptorAccess( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', @@ -418,7 +418,7 @@ describe('interceptor access close handling', () => { await resolveInterceptorAccess( ethereum, tokenPriceService, - resetSimulationServices, + simulationServicesOwner, websiteTabConnections, { userReply: 'Rejected', diff --git a/test/tests/popupClearReset.test.ts b/test/tests/popupClearReset.test.ts index 34717e71f..8eb460e4f 100644 --- a/test/tests/popupClearReset.test.ts +++ b/test/tests/popupClearReset.test.ts @@ -1,3 +1,4 @@ +import { createTestSimulationServicesOwner } from './backgroundEthAccountsTestHarness.js' import * as assert from 'assert' import * as funtypes from 'funtypes' import type { CompleteVisualizedSimulation } from '../../app/ts/types/visualizer-types.js' @@ -180,6 +181,7 @@ async function loadModules() { const settings = await import('../../app/ts/background/settings.js') const background = await import('../../app/ts/background/background.js') const activeSettings = await import('../../app/ts/background/activeSettings.js') + const walletSwitch = await import('../../app/ts/background/walletSwitch.js') const popupMessageRouting = await import('../../app/ts/background/popupMessageRouting.js') const storageVariables = await import('../../app/ts/background/storageVariables.js') const simulationUpdating = await import('../../app/ts/background/simulationUpdating.js') @@ -193,6 +195,7 @@ async function loadModules() { ...settings, ...background, ...activeSettings, + ...walletSwitch, ...popupMessageRouting, updateTransactionState: storageVariables.updateTransactionState, getSafeTransactionStacks: storageVariables.getSafeTransactionStacks, @@ -403,7 +406,7 @@ describe('popup clear reset', () => { fakeEthereum.getBlock = async (...args) => { providerReads++; return await originalBlock(...args) } fakeEthereum.getBlockNumber = async (...args) => { providerReads++; return await originalNumber(...args) } try { - const result = await updatePopupVisualisationIfNeeded(fakeEthereum, fakeTokenPriceService, false, false, true, snapshot) + const result = await updatePopupVisualisationIfNeeded(fakeEthereum, fakeTokenPriceService, { skipIfUnchanged: true, snapshot }) if (snapshot !== undefined) assert.equal((await getUpdatedSimulationState(fakeEthereum, snapshot)).kind, 'passthrough') assert.equal(providerReads, 0) assert.equal(result.simulationState.kind, 'passthrough') @@ -502,7 +505,7 @@ describe('popup clear reset', () => { modules.getPopupVisualisationFingerprint(currentSimulationInput, rpcNetwork, 123n), modules.getPopupVisualisationFingerprint(storedSimulationState.value.simulationStateInput, storedSimulationState.value.rpcNetwork, storedSimulationState.value.blockNumber), ) - const popupVisualisation = await updatePopupVisualisationIfNeeded(fakeEthereum, fakeTokenPriceService, false, false, true) + const popupVisualisation = await updatePopupVisualisationIfNeeded(fakeEthereum, fakeTokenPriceService, { skipIfUnchanged: true }) assert.equal(popupVisualisation.simulationId, matchingPopupVisualisation.simulationId) assert.equal(popupVisualisation.simulationState.kind, 'simulated') assert.equal(matchingPopupVisualisation.simulationState.kind, 'simulated') @@ -518,7 +521,7 @@ describe('popup clear reset', () => { const snapshot = await captureSimulationSnapshot() await browserStorageLocalSet({ makeCurrentAddressRich: true }) assert.notDeepEqual(await modules.getCurrentSimulationInput(), snapshot.simulationStateInput) - const result = await updatePopupVisualisationIfNeeded(fakeEthereum, fakeTokenPriceService, false, false, false, snapshot) + const result = await updatePopupVisualisationIfNeeded(fakeEthereum, fakeTokenPriceService, { snapshot }) assert.equal(result.numberOfAddressesMadeRich, 0) assert.equal(result.simulationState.kind, 'simulated') if (result.simulationState.kind !== 'simulated') throw new Error('Expected a simulated snapshot') @@ -582,7 +585,7 @@ describe('popup clear reset', () => { interceptorTransactionStack: { operations: [] }, }) - await updatePopupVisualisationIfNeeded(fakeEthereum, fakeTokenPriceService, false, false) + await updatePopupVisualisationIfNeeded(fakeEthereum, fakeTokenPriceService) const popupVisualisation = (await browserStorageLocalGet('popupVisualisation')).popupVisualisation assert.ok(popupVisualisation) @@ -612,7 +615,7 @@ describe('popup clear reset', () => { popupVisualisation: stalePopupVisualisation, }) - await resetSimulationStateFromConfig(fakeEthereum, fakeTokenPriceService) + await resetSimulationStateFromConfig(createTestSimulationServicesOwner({ ethereum: fakeEthereum, tokenPriceService: fakeTokenPriceService })) const interceptorTransactionStack = (await browserStorageLocalGet('interceptorTransactionStack')).interceptorTransactionStack const popupVisualisation = (await browserStorageLocalGet('popupVisualisation')).popupVisualisation @@ -659,7 +662,7 @@ describe('popup clear reset', () => { popupVisualisation: stalePopupVisualisation, }) - await resetSimulationStateFromConfig(fakeEthereum, fakeTokenPriceService) + await resetSimulationStateFromConfig(createTestSimulationServicesOwner({ ethereum: fakeEthereum, tokenPriceService: fakeTokenPriceService })) const storedStack = (await browserStorageLocalGet('interceptorTransactionStack')).interceptorTransactionStack assert.deepEqual(storedStack.operations.map((operation) => operation.preSimulationTransaction.transactionIdentifier), [1n, 3n, 4n]) @@ -673,10 +676,10 @@ describe('popup clear reset', () => { browserMock.reset() browserMock.setPopupOpen(false) const resets: RpcNetwork[] = [] - const resetSimulationServices = (nextRpcEntry: RpcNetwork) => { + const simulationServicesOwner = createTestSimulationServicesOwner({ ethereum: fakeEthereum, tokenPriceService: fakeTokenPriceService }, (nextRpcEntry: RpcNetwork) => { resets.push(nextRpcEntry) return { ethereum: fakeEthereum, tokenPriceService: fakeTokenPriceService } - } + }) const interceptorTransactionStack = { operations: [{ type: 'TimeManipulation', blockTimeManipulation: DEFAULT_BLOCK_MANIPULATION }] as const } await browserStorageLocalSet({ independentActiveSimulationAddress: activeAddress, @@ -686,7 +689,7 @@ describe('popup clear reset', () => { interceptorTransactionStack, }) - await changeActiveRpc(fakeEthereum, fakeTokenPriceService, resetSimulationServices, new Map(), sameChainRpcNetwork, true, undefined) + await changeActiveRpc(simulationServicesOwner, new Map(), sameChainRpcNetwork, { source: 'dapp', simulationMode: true, signerTabId: undefined }) const modules = await modulesPromise const updatedSettings = await modules.getSettings() @@ -702,10 +705,10 @@ describe('popup clear reset', () => { test('clears the interceptor stack when changing rpc to another chain', async () => { browserMock.reset() const resets: RpcNetwork[] = [] - const resetSimulationServices = (nextRpcEntry: RpcNetwork) => { + const simulationServicesOwner = createTestSimulationServicesOwner({ ethereum: fakeEthereum, tokenPriceService: fakeTokenPriceService }, (nextRpcEntry: RpcNetwork) => { resets.push(nextRpcEntry) return { ethereum: fakeEthereum, tokenPriceService: fakeTokenPriceService } - } + }) await browserStorageLocalSet({ independentActiveSimulationAddress: activeAddress, activeRpcNetwork: rpcNetwork, @@ -714,7 +717,7 @@ describe('popup clear reset', () => { interceptorTransactionStack: { operations: [{ type: 'TimeManipulation', blockTimeManipulation: DEFAULT_BLOCK_MANIPULATION }] }, }) - await changeActiveRpc(fakeEthereum, fakeTokenPriceService, resetSimulationServices, new Map(), otherChainRpcNetwork, true, undefined) + await changeActiveRpc(simulationServicesOwner, new Map(), otherChainRpcNetwork, { source: 'dapp', simulationMode: true, signerTabId: undefined }) const modules = await modulesPromise const updatedSettings = await modules.getSettings() diff --git a/test/tests/popupMessageDispatcher.test.ts b/test/tests/popupMessageDispatcher.test.ts index 896eb9d99..92792e1f4 100644 --- a/test/tests/popupMessageDispatcher.test.ts +++ b/test/tests/popupMessageDispatcher.test.ts @@ -1,3 +1,4 @@ +import { createTestSimulationServicesOwner } from './backgroundEthAccountsTestHarness.js' import * as assert from 'assert' import { beforeEach, describe, test } from 'bun:test' import type { PopupMessageDispatcherContext } from '../../app/ts/background/popupMessageDispatcher.js' @@ -120,7 +121,7 @@ function createDispatcherContext(resetSimulationState: () => Promise): Pop websiteTabConnections: new Map(), ethereum, tokenPriceService, - resetSimulationServices: () => ({ ethereum, tokenPriceService }), + simulationServicesOwner: createTestSimulationServicesOwner({ ethereum, tokenPriceService }, () => ({ ethereum, tokenPriceService })), settings, publishRpcConnectionStatus: async () => undefined, simulationAbortController: new AbortController(), diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index 92d00502c..5de179a80 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -1,3 +1,4 @@ +import { createTestSimulationServicesOwner } from './backgroundEthAccountsTestHarness.js' import * as assert from 'assert' import { describe, test } from 'bun:test' import { getWalletSwitchRequestId, confirmedSignerOwnership, createDeferredValue, createEthereumWithGetBlockCounter, createPort, installBrowserMock, loadModules, waitForPortMessageCount } from './backgroundEthAccountsTestHarness.js' @@ -169,20 +170,20 @@ describe('popup settings changes', () => { const { runtimeMessages } = installBrowserMock() const { changeSimulationMode, getSettings } = await loadModules() const { enableSimulationMode } = await import('../../app/ts/background/popupMessageHandlers.js') - const { changeActiveRpc } = await import('../../app/ts/background/activeSettings.js') + const { changeActiveRpc } = await import('../../app/ts/background/walletSwitch.js') await changeSimulationMode({ simulationMode: true }) const { ethereum, tokenPriceService } = createEthereumWithGetBlockCounter({ count: 0 }) - const reset = () => { throw new Error('Should not reset services') } + const reset = createTestSimulationServicesOwner({ ethereum, tokenPriceService }, () => { throw new Error('Should not reset services') }) const count = runtimeMessages.length - await enableSimulationMode(ethereum, tokenPriceService, reset, new Map(), { method: 'popup_enableSimulationMode', data: true }) - await changeActiveRpc(ethereum, tokenPriceService, reset, new Map(), (await getSettings()).activeRpcNetwork, true, undefined) + await enableSimulationMode(reset, new Map(), { method: 'popup_enableSimulationMode', data: true }) + await changeActiveRpc(reset, new Map(), (await getSettings()).activeRpcNetwork, { source: 'dapp', simulationMode: true, signerTabId: undefined }) assert.equal(runtimeMessages.length, count) }) for (const simulationMode of [true, false]) test(`saves active RPC metadata without resetting services in ${ simulationMode ? 'simulation' : 'signing' } mode`, async () => { installBrowserMock() const { changeSimulationMode, getSettings, saveCurrentTabId, websiteSocketToString } = await loadModules() - const { changeActiveRpc } = await import('../../app/ts/background/activeSettings.js') + const { changeActiveRpc } = await import('../../app/ts/background/walletSwitch.js') const { popupChangeActiveRpc } = await import('../../app/ts/background/popupMessageHandlers.js') await saveCurrentTabId(1) const socket = { tabId: 1, connectionName: 0n } @@ -195,11 +196,11 @@ describe('popup settings changes', () => { if (currentRpc.httpsRpc === undefined) throw new Error('Expected a configured RPC') const editedRpc = { ...currentRpc, name: 'Renamed network', currencyName: 'Updated currency', currencyTicker: 'NEW', currencyLogoUri: 'updated.svg', blockExplorer: { apiUrl: 'https://explorer.example/api', apiKey: 'updated-key' }, primary: !currentRpc.primary, minimized: !currentRpc.minimized } const { ethereum, tokenPriceService } = createEthereumWithGetBlockCounter({ count: 0 }) - const reset = () => { throw new Error('Metadata edits should not reset services') } - assert.deepEqual(await changeActiveRpc(ethereum, tokenPriceService, reset, connections, editedRpc, simulationMode, 1), { type: simulationMode ? 'completedLocally' : 'signerRequestNotNeeded' }) + const reset = createTestSimulationServicesOwner({ ethereum, tokenPriceService }, () => { throw new Error('Metadata edits should not reset services') }) + assert.deepEqual(await changeActiveRpc(reset, connections, editedRpc, { source: 'dapp', simulationMode: simulationMode, signerTabId: 1 }), { result: null }) assert.deepEqual((await getSettings()).activeRpcNetwork, editedRpc) const popupEdit = { ...editedRpc, name: 'Renamed through popup' } - assert.deepEqual(await popupChangeActiveRpc(ethereum, tokenPriceService, reset, connections, { method: 'popup_changeActiveRpc', data: popupEdit }, await getSettings()), { type: 'PopupSettingsChangeReply', ok: true }) + assert.deepEqual(await popupChangeActiveRpc(reset, connections, { method: 'popup_changeActiveRpc', data: popupEdit }), { type: 'PopupSettingsChangeReply', ok: true }) assert.deepEqual((await getSettings()).activeRpcNetwork, popupEdit) assert.equal(messages.some(message => message.method === 'request_signer_to_wallet_switchEthereumChain'), false, 'Metadata edits must not ask a connected wallet to switch chains') }) @@ -207,7 +208,7 @@ describe('popup settings changes', () => { for (const simulationMode of [true, false]) for (const reselect of [true, false]) test(`local RPC selection persists the chain preference (simulation=${ simulationMode }, reselect=${ reselect })`, async () => { installBrowserMock() const { changeSimulationMode, getSettings } = await loadModules() - const { changeActiveRpc } = await import('../../app/ts/background/activeSettings.js') + const { changeActiveRpc } = await import('../../app/ts/background/walletSwitch.js') const { setRpcList, getPrimaryRpcForChain } = await import('../../app/ts/background/storageVariables.js') const current = (await getSettings()).activeRpcNetwork if (current.httpsRpc === undefined) throw new Error('Expected a configured RPC') @@ -215,7 +216,7 @@ describe('popup settings changes', () => { await setRpcList([{ ...current, primary: true }, selected]) await changeSimulationMode({ simulationMode, rpcNetwork: reselect ? selected : current }) const services = createEthereumWithGetBlockCounter({ count: 0 }) - await changeActiveRpc(services.ethereum, services.tokenPriceService, () => services, new Map(), selected, simulationMode, undefined) + await changeActiveRpc(services.simulationServicesOwner, new Map(), selected, { source: 'dapp', simulationMode: simulationMode, signerTabId: undefined }) assert.equal((await getPrimaryRpcForChain(selected.chainId))?.httpsRpc, selected.httpsRpc) assert.equal((await getSettings()).activeRpcNetwork.httpsRpc, selected.httpsRpc) }) @@ -231,15 +232,15 @@ describe('popup settings changes', () => { const original = createEthereumWithGetBlockCounter({ count: 0 }) const installed = createEthereumWithGetBlockCounter({ count: 0 }) let resets = 0 - const reset = (rpc: typeof nextRpc) => { + const reset = createTestSimulationServicesOwner(original, (rpc: typeof nextRpc) => { assert.deepEqual(rpc, nextRpc) resets += 1 return installed - } + }) const options = { simulationMode: true, signerAddress: undefined, rpcNetwork: nextRpc } - const active = await activateAddressSelection(original.ethereum, original.tokenPriceService, reset, new Map(), undefined, options) + const active = await activateAddressSelection(reset, new Map(), undefined, options) assert.equal(active, undefined) - const unchanged = await activateAddressSelection(installed.ethereum, installed.tokenPriceService, reset, new Map(), undefined, options) + const unchanged = await activateAddressSelection(reset, new Map(), undefined, options) assert.equal(unchanged, undefined) assert.equal(resets, 1) }) @@ -257,9 +258,9 @@ describe('popup settings changes', () => { await release.promise return [] } }) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) let completed = false - const pending = changeActiveAddressAndChain(ethereum, tokenPriceService, resetSimulationServices, new Map(), { simulationMode: true }).then(() => { completed = true }) + const pending = changeActiveAddressAndChain(simulationServicesOwner, new Map(), { simulationMode: true }).then(() => { completed = true }) try { await started.promise assert.equal(completed, false) @@ -290,11 +291,11 @@ describe('popup settings changes', () => { } return undefined } }) - await changeActiveAddressAndChain(services.ethereum, services.tokenPriceService, (entry) => { + await changeActiveAddressAndChain(createTestSimulationServicesOwner({ ethereum: services.ethereum, tokenPriceService: services.tokenPriceService }, (entry) => { assert.equal(entry.httpsRpc, rpc.httpsRpc) installed = true return services - }, new Map(), { simulationMode: true, rpcNetwork: rpc }) + }), new Map(), { simulationMode: true, rpcNetwork: rpc }) assert.equal(announced, true) }) @@ -342,21 +343,21 @@ describe('popup settings changes', () => { const connections = new Map([[1, { ...confirmedSignerOwnership(socket), connections: { [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'https://example.test', approved: true, wantsToConnect: true }, } }]]) - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) let simulationReads = 0 if (outcome === 'unavailable simulation') Object.defineProperty(ethereum, 'getCachedBlock', { value: () => { simulationReads += 1 throw new Error('Simulation RPC is unavailable') } }) - const pending = popupChangeActiveRpc(ethereum, tokenPriceService, resetSimulationServices, connections, { method: 'popup_changeActiveRpc', data: requestedRpc }, await getSettings()) + const pending = popupChangeActiveRpc(simulationServicesOwner, connections, { method: 'popup_changeActiveRpc', data: requestedRpc }) if (outcome !== 'safe') { await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) assert.deepEqual(await getRpcList(), originalRpcList) if (outcome === 'metadata after chain event') { - await signerChainChanged(ethereum, tokenPriceService, resetSimulationServices, connections, port, { method: 'signer_chainChanged', params: ['0x2', 1] }, 'hasAccess', 1n) + await signerChainChanged(ethereum, tokenPriceService, simulationServicesOwner, connections, port, { method: 'signer_chainChanged', params: ['0x2', 1] }, 'hasAccess', 1n) assert.deepEqual((await getSettings()).activeRpcNetwork, primaryRpc) } - await walletSwitchEthereumChainReply(ethereum, tokenPriceService, resetSimulationServices, connections, port, { + await walletSwitchEthereumChainReply(ethereum, tokenPriceService, simulationServicesOwner, connections, port, { method: 'wallet_switchEthereumChain_reply', params: outcome !== 'reject' ? [{ accept: true, chainId: '0x2', walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: 1 }] : [{ accept: false, chainId: '0x2', walletSwitchRequestId: getWalletSwitchRequestId(messages), error: { code: 4001, message: 'Rejected' }, signerProviderGeneration: 1 }], }, 'hasAccess', 1n) @@ -386,7 +387,7 @@ describe('popup settings changes', () => { for (const matchesDispatchedToken of [true, false]) test(`early reply deadline ownership matches the dispatched signer token (${ matchesDispatchedToken })`, async () => { installBrowserMock() const { changeSimulationMode, getSettings, websiteSocketToString } = await loadModules() - const { requestSignerChainChange, applyWalletSwitchReply } = await import('../../app/ts/background/walletSwitch.js') + const { changeActiveRpc, applyWalletSwitchReply } = await import('../../app/ts/background/walletSwitch.js') await changeSimulationMode({ simulationMode: false }) const socket = { tabId: 1, connectionName: 0n } const { port, messages } = createPort(1) @@ -415,7 +416,7 @@ describe('popup settings changes', () => { await delivery return await originalSend(message) } }) - const result = await requestSignerChainChange(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, rpc, 1, 20) + const result = await changeActiveRpc(services.simulationServicesOwner, connections, rpc, { source: 'dapp', simulationMode: false, signerTabId: 1 }, 20) assert.match(result.error?.message ?? '', matchesDispatchedToken ? /Rejected early/ : /did not answer/) } finally { Object.defineProperty(browser.runtime, 'sendMessage', { configurable: true, value: originalSend }) } }) @@ -424,7 +425,7 @@ describe('popup settings changes', () => { test(`wallet deadline releases a silent request but does not expire a received reply (${ outcome })`, async () => { installBrowserMock() const { changeSimulationMode, getSettings, websiteSocketToString } = await loadModules() - const { requestSignerChainChange, applyWalletSwitchReply } = await import('../../app/ts/background/walletSwitch.js') + const { changeActiveRpc, applyWalletSwitchReply } = await import('../../app/ts/background/walletSwitch.js') const { getConfirmedSignerStateToken } = await import('../../app/ts/background/signerStateOwnership.js') await changeSimulationMode({ simulationMode: false }) const socket = { tabId: 1, connectionName: 0n } @@ -434,7 +435,7 @@ describe('popup settings changes', () => { } }]]) const rpc = { ...(await getSettings()).activeRpcNetwork, chainId: 2n, httpsRpc: 'https://timeout.example.test' } const services = createEthereumWithGetBlockCounter({ count: 0 }) - const request = (timeoutMs: number) => requestSignerChainChange(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, rpc, 1, timeoutMs) + const request = (timeoutMs: number) => changeActiveRpc(services.simulationServicesOwner, connections, rpc, { source: 'dapp', simulationMode: false, signerTabId: 1 }, timeoutMs) const token = getConfirmedSignerStateToken(connections, 1) if (token === undefined) throw new Error('Missing signer token') const application = createDeferredValue() @@ -454,7 +455,7 @@ describe('popup settings changes', () => { const originalSet = browser.storage.local.set try { Object.defineProperty(browser.storage.local, 'set', { configurable: true, value: async () => { throw new Error('Storage write failed') } }) - await assert.rejects(walletSwitchEthereumChainReply(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, port, { + await assert.rejects(walletSwitchEthereumChainReply(services.ethereum, services.tokenPriceService, services.simulationServicesOwner, connections, port, { method: 'wallet_switchEthereumChain_reply', params: [{ accept: true, chainId: '0x2', walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: token.signerProviderGeneration }], interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, }, 'hasAccess', undefined), /Storage write failed/) @@ -479,13 +480,13 @@ describe('popup settings changes', () => { request: { method: 'wallet_switchEthereumChain', params: [{ chainId: 2n }], interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier }, }) let completed = false - const dappSwitch = resolveChainChange(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, { + const dappSwitch = resolveChainChange(services.ethereum, services.tokenPriceService, services.simulationServicesOwner, connections, { method: 'popup_changeChainDialog', data: { rpcNetwork: dappRpc, uniqueRequestIdentifier, accept: true }, }).then(() => { completed = true }) await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 2) const dappId = getWalletSwitchRequestId(messages) assert.notEqual(dappId, expiredId) - const deliver = (walletSwitchRequestId: string) => walletSwitchEthereumChainReply(services.ethereum, services.tokenPriceService, services.resetSimulationServices, connections, port, { + const deliver = (walletSwitchRequestId: string) => walletSwitchEthereumChainReply(services.ethereum, services.tokenPriceService, services.simulationServicesOwner, connections, port, { method: 'wallet_switchEthereumChain_reply', params: [{ accept: true, chainId: '0x2', walletSwitchRequestId, signerProviderGeneration: token.signerProviderGeneration }], interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, }, 'hasAccess', undefined) @@ -508,7 +509,7 @@ describe('popup settings changes', () => { test(`waits for the matching wallet network ${ outcome }`, async () => { installBrowserMock() const { changeSimulationMode, getSettings, websiteSocketToString } = await loadModules() - const { requestSignerChainChange, applyWalletSwitchReply } = await import('../../app/ts/background/walletSwitch.js') + const { changeActiveRpc, applyWalletSwitchReply } = await import('../../app/ts/background/walletSwitch.js') await changeSimulationMode({ simulationMode: false }) const socket = { tabId: 1, connectionName: 0n } const ownership = confirmedSignerOwnership(socket) @@ -517,12 +518,12 @@ describe('popup settings changes', () => { [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'https://example.test', approved: true, wantsToConnect: true }, } }]]) const rpc = { ...(await getSettings()).activeRpcNetwork, chainId: 2n, httpsRpc: 'https://rpc.example.test' } - const { ethereum, tokenPriceService, resetSimulationServices } = createEthereumWithGetBlockCounter({ count: 0 }) + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) let completed = false - const pending = requestSignerChainChange(ethereum, tokenPriceService, resetSimulationServices, connections, rpc, 1).then((result) => { completed = true; return result }) + const pending = changeActiveRpc(simulationServicesOwner, connections, rpc, { source: 'dapp', simulationMode: false, signerTabId: 1 }).then((result) => { completed = true; return result }) await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) assert.equal(completed, false) - const concurrent = await requestSignerChainChange(ethereum, tokenPriceService, resetSimulationServices, connections, rpc, 1) + const concurrent = await changeActiveRpc(simulationServicesOwner, connections, rpc, { source: 'dapp', simulationMode: false, signerTabId: 1 }) assert.equal(concurrent.error?.code, -32002) const { getConfirmedSignerStateToken } = await import('../../app/ts/background/signerStateOwnership.js') const token = getConfirmedSignerStateToken(connections, 1) diff --git a/test/tests/safeSignerConfirmation.suite.ts b/test/tests/safeSignerConfirmation.suite.ts index 885512cb6..207ad541a 100644 --- a/test/tests/safeSignerConfirmation.suite.ts +++ b/test/tests/safeSignerConfirmation.suite.ts @@ -1,3 +1,4 @@ +import { createTestSimulationServicesOwner } from './backgroundEthAccountsTestHarness.js' import * as assert from 'assert' import { test } from 'bun:test' import { getLatestUnexpectedError } from '../../app/ts/background/storageVariables.js' @@ -684,7 +685,7 @@ test('refreshes the selected signer before forwarding a Safe transaction', async accountReply = modules.ethAccountsReply( simulator.ethereum, simulator.tokenPriceService, - () => undefined, + createTestSimulationServicesOwner({ ethereum: simulator.ethereum, tokenPriceService: simulator.tokenPriceService }), websiteTabConnections, port, { @@ -734,7 +735,7 @@ test('refreshes the selected signer before forwarding a Safe transaction', async await modules.ethAccountsReply( simulator.ethereum, simulator.tokenPriceService, - () => undefined, + createTestSimulationServicesOwner({ ethereum: simulator.ethereum, tokenPriceService: simulator.tokenPriceService }), websiteTabConnections, port, { diff --git a/test/tests/safeSignerRouting.suite.ts b/test/tests/safeSignerRouting.suite.ts index 5fa0e68f8..c3ac6072e 100644 --- a/test/tests/safeSignerRouting.suite.ts +++ b/test/tests/safeSignerRouting.suite.ts @@ -1,3 +1,4 @@ +import { createTestSimulationServicesOwner } from './backgroundEthAccountsTestHarness.js' import * as assert from 'assert' import { test } from 'bun:test' import { encodeFunctionCall } from '../../app/ts/utils/abiRuntime.js' @@ -44,7 +45,7 @@ test('accepts a signer reply from the current approved child-frame port', async }], }) - await modules.signerReply(simulator.ethereum, simulator.tokenPriceService, () => undefined, websiteTabConnections, childPort, { + await modules.signerReply(simulator.ethereum, simulator.tokenPriceService, createTestSimulationServicesOwner({ ethereum: simulator.ethereum, tokenPriceService: simulator.tokenPriceService }), websiteTabConnections, childPort, { method: 'signer_reply', params: [{ success: true, @@ -115,7 +116,7 @@ test('preserves a MetaMask keyring scan error on a retryable Safe signature', as }], }) - await modules.signerReply(simulator.ethereum, simulator.tokenPriceService, () => undefined, websiteTabConnections, port, { + await modules.signerReply(simulator.ethereum, simulator.tokenPriceService, createTestSimulationServicesOwner({ ethereum: simulator.ethereum, tokenPriceService: simulator.tokenPriceService }), websiteTabConnections, port, { method: 'signer_reply', params: [{ success: false, @@ -278,7 +279,7 @@ test('routes a Safe co-signing request through the wallet-selected owner', async accountReply = modules.ethAccountsReply( simulator.ethereum, simulator.tokenPriceService, - () => undefined, + createTestSimulationServicesOwner({ ethereum: simulator.ethereum, tokenPriceService: simulator.tokenPriceService }), websiteTabConnections, port, { @@ -968,7 +969,7 @@ test('changes the Safe simulation signer only after validating current on-chain const reply = await modules.setSafeSimulationSigner( ethereum, simulator.tokenPriceService, - () => undefined, + createTestSimulationServicesOwner({ ethereum: ethereum, tokenPriceService: simulator.tokenPriceService }), new Map(), { method: 'popup_setSafeSimulationSigner', @@ -991,7 +992,7 @@ test('changes the Safe simulation signer only after validating current on-chain const unsupportedVersionFailure = await withSilencedConsole(async () => modules.setSafeSimulationSigner( ethereum, simulator.tokenPriceService, - () => undefined, + createTestSimulationServicesOwner({ ethereum: ethereum, tokenPriceService: simulator.tokenPriceService }), new Map(), { method: 'popup_setSafeSimulationSigner', @@ -1012,7 +1013,7 @@ test('changes the Safe simulation signer only after validating current on-chain const unsupportedVersionSaveFailure = await withSilencedConsole(async () => addOrModifyAddressBookEntry( ethereum, simulator.tokenPriceService, - () => undefined, + createTestSimulationServicesOwner({ ethereum: ethereum, tokenPriceService: simulator.tokenPriceService }), new Map(), { method: 'popup_addOrModifyAddressBookEntry', @@ -1041,7 +1042,7 @@ test('refreshes Safe owner metadata and clears a stale simulation signer without const reply = await modules.setSafeSimulationSigner( ethereum, simulator.tokenPriceService, - () => undefined, + createTestSimulationServicesOwner({ ethereum: ethereum, tokenPriceService: simulator.tokenPriceService }), new Map(), { method: 'popup_setSafeSimulationSigner', From 95b0ef5b3f682aa0dd5db03b528d9fe4df8b09bf Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Thu, 10 Sep 2026 07:35:38 +0000 Subject: [PATCH 25/31] Reject dapp network switches while signing as a Safe --- app/ts/background/walletSwitch.ts | 5 ++-- docs/popup-simulation-refresh.md | 2 +- test/tests/popupSettingsChanges.test.ts | 35 +++++++++++++++++++++++++ 3 files changed, 39 insertions(+), 3 deletions(-) diff --git a/app/ts/background/walletSwitch.ts b/app/ts/background/walletSwitch.ts index 4ec9785d5..e42593e7d 100644 --- a/app/ts/background/walletSwitch.ts +++ b/app/ts/background/walletSwitch.ts @@ -91,7 +91,7 @@ export type RpcSwitchRequest = | { readonly source: 'popup', readonly signerTabId: number | undefined } | { readonly source: 'dapp', readonly signerTabId: number | undefined, readonly simulationMode: boolean } -// One command owns routing, origin-specific gates, local promotion and correlated wallet dispatch. +// One command owns routing, Safe network restrictions, local promotion and correlated wallet dispatch. export async function changeActiveRpc(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, rpcNetwork: RpcNetwork, request: RpcSwitchRequest, timeoutMs = WALLET_SWITCH_TIMEOUT_MS): Promise { const settings = await getSettings() const simulationMode = request.source === 'popup' ? settings.simulationMode : request.simulationMode @@ -104,7 +104,8 @@ export async function changeActiveRpc(simulationServicesOwner: SimulationService return { result: null } } if (request.signerTabId === undefined) return { error: signerUnavailableError } - if (request.source === 'popup' && await getConfiguredSigningSafe(settings, (await getTabState(request.signerTabId)).signerAccounts) !== undefined) { + // A selected Safe pins the active chain for both popup and dapp requests. Reject before the wallet can diverge. + if (await getConfiguredSigningSafe(settings, (await getTabState(request.signerTabId)).signerAccounts) !== undefined) { return { error: { code: METAMASK_ERROR_USER_REJECTED_REQUEST, message: 'This Safe is tied to its current network. Select your wallet account before switching networks.' } } } return await requestSignerChainChange(websiteTabConnections, rpcNetwork, request.signerTabId, timeoutMs) diff --git a/docs/popup-simulation-refresh.md b/docs/popup-simulation-refresh.md index ca2eedbb3..6fcfdc3d1 100644 --- a/docs/popup-simulation-refresh.md +++ b/docs/popup-simulation-refresh.md @@ -23,4 +23,4 @@ External-wallet signing transitions do not enqueue simulation refreshes: wallet `updatePopupVisualisationIfNeeded` takes named options for invalidation, throttling, unchanged-input skipping, and a captured snapshot. Omitted options keep the normal direct-refresh behavior. The interactive queue supplies its captured snapshot and owns coalescing; the executor owns serialization. -Active settings commands receive `SimulationServicesOwner`, not a service pair captured before waiting for the transition semaphore. They read `getCurrent()` when preparing the refresh, so a preceding endpoint reset supplies the installed services. Both popup and dapp RPC requests enter `changeActiveRpc` in `walletSwitch.ts`, which owns routing, origin-specific Safe restrictions, local promotion, and correlated wallet dispatch. +Active settings commands receive `SimulationServicesOwner`, not a service pair captured before waiting for the transition semaphore. They read `getCurrent()` when preparing the refresh, so a preceding endpoint reset supplies the installed services. Both popup and dapp RPC requests enter `changeActiveRpc` in `walletSwitch.ts`, which owns routing, shared Safe network restrictions, local promotion, and correlated wallet dispatch. diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index 5de179a80..7c341a665 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -384,6 +384,41 @@ describe('popup settings changes', () => { }) } + for (const crossChain of [true, false]) test(`dapp RPC changes preserve the selected Safe chain (crossChain=${ crossChain })`, async () => { + installBrowserMock() + const { changeSimulationMode, getSettings, websiteSocketToString, updateTabState, updateUserAddressBookEntries } = await loadModules() + const { changeActiveRpc, isSignerChainChangePending } = await import('../../app/ts/background/walletSwitch.js') + const { setRpcList, getRpcList } = await import('../../app/ts/background/storageVariables.js') + const currentRpc = (await getSettings()).activeRpcNetwork + const requestedRpc = { ...currentRpc, chainId: crossChain ? 2n : currentRpc.chainId, name: 'Alternative RPC', httpsRpc: 'https://alternative.example.test', primary: false } + const rpcList = [currentRpc, requestedRpc] + await setRpcList(rpcList) + await changeSimulationMode({ simulationMode: false, activeSigningAddress: 1n, activeSigningSafeAddress: 3n }) + await updateUserAddressBookEntries(() => [{ type: 'safe', name: 'Signing Safe', address: 3n, chainId: currentRpc.chainId, entrySource: 'User', useAsActiveAddress: true, safeSignerAddresses: [1n] }]) + await updateTabState(1, previous => ({ ...previous, signerAccounts: [1n], activeSigningAddress: 1n, signerChain: currentRpc.chainId })) + const socket = { tabId: 1, connectionName: 0n } + const { port, messages } = createPort(1) + const connections = new Map([[1, { ...confirmedSignerOwnership(socket), connections: { + [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'https://example.test', approved: true, wantsToConnect: true }, + } }]]) + const { simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) + const reply = await changeActiveRpc(simulationServicesOwner, connections, requestedRpc, { source: 'dapp', signerTabId: 1, simulationMode: false }, 10) + const settings = await getSettings() + assert.equal(settings.activeSigningSafeAddress, 3n) + assert.equal(messages.some(message => message.method === 'request_signer_to_wallet_switchEthereumChain'), false) + assert.equal(isSignerChainChangePending(), false) + if (crossChain) { + assert.equal(reply.error?.code, 4001) + assert.match(reply.error?.message ?? '', /Safe.*current network/u) + assert.deepEqual(settings.activeRpcNetwork, currentRpc) + assert.deepEqual(await getRpcList(), rpcList) + } else { + assert.deepEqual(reply, { result: null }) + assert.deepEqual(settings.activeRpcNetwork, requestedRpc) + assert.equal((await getRpcList()).find(rpc => rpc.name === requestedRpc.name)?.primary, true) + } + }) + for (const matchesDispatchedToken of [true, false]) test(`early reply deadline ownership matches the dispatched signer token (${ matchesDispatchedToken })`, async () => { installBrowserMock() const { changeSimulationMode, getSettings, websiteSocketToString } = await loadModules() From 7fabdfd940604d8267b22f75920fa385aed027ef Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Thu, 10 Sep 2026 07:53:35 +0000 Subject: [PATCH 26/31] Select request services through the lifecycle owner --- app/ts/background/background-startup.ts | 5 +- app/ts/background/background.ts | 63 +++++---- .../background/windows/interceptorAccess.ts | 4 - docs/popup-simulation-refresh.md | 2 + .../backgroundAccountPermissions.test.ts | 98 ++++++------- test/tests/backgroundEthSimulateV1.test.ts | 8 +- test/tests/backgroundProviderRouting.test.ts | 130 +++++++++++------- test/tests/backgroundSignerLifecycle.test.ts | 36 ++--- test/tests/interceptorAccessCloseRace.test.ts | 17 +-- 9 files changed, 197 insertions(+), 166 deletions(-) diff --git a/app/ts/background/background-startup.ts b/app/ts/background/background-startup.ts index 43f175065..3ea6145fd 100644 --- a/app/ts/background/background-startup.ts +++ b/app/ts/background/background-startup.ts @@ -190,9 +190,8 @@ async function onContentScriptConnected(waitForStartup: () => Promise<{ simulati uniqueRequestIdentifier: { requestId: rawMessage.requestId, requestSocket: socket }, ...(rawMessage.interceptorInternalRequest === true ? { interceptorInternalRequest: true as const } : {}), } - // A connected port outlives RPC switches; select services only when its queued request starts. - const simulationServices = getSimulationServices() - return await handleInterceptedRequest(port, websiteOrigin, websitePromise, simulationServices.ethereum, simulationServices.tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, rpcConnectionStatusPublisher.publishRpcConnectionStatus) + // A connected port outlives RPC switches; each request stage selects services from the owner. + return await handleInterceptedRequest(port, websiteOrigin, websitePromise, simulationServicesOwner, socket, request, websiteTabConnections, rpcConnectionStatusPublisher.publishRpcConnectionStatus) }) }) }, diff --git a/app/ts/background/background.ts b/app/ts/background/background.ts index 203d9f340..012d2ddae 100644 --- a/app/ts/background/background.ts +++ b/app/ts/background/background.ts @@ -60,11 +60,7 @@ const INTERNAL_PROVIDER_METHODS = [ const isInternalProviderMethod = (method: string) => INTERNAL_PROVIDER_METHODS.some((internalMethod) => internalMethod === method) async function handleRPCRequest( - ethereum: EthereumClientService, - tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, - getSimulationInput: () => Promise, - getExecutionSimulationState: () => Promise, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, website: Website, @@ -76,6 +72,24 @@ async function handleRPCRequest( safeSigningMode: boolean, activeSafeSigner: bigint | undefined, ): Promise { + // Select one execution pair after admission; lazy simulation preparation uses this same pair. + const { ethereum, tokenPriceService } = simulationServicesOwner.getCurrent() + let simulationInputPromise: Promise | undefined + let executionSimulationStatePromise: Promise | undefined + const getSimulationInput = async () => { + if (!simulationOverlayEnabled) return PASSTHROUGH_STATE + if (simulationInputPromise === undefined) simulationInputPromise = (async () => toResolvedSimulationInput(await prepareSimulationInputForRpc(await getCurrentSimulationInput(), ethereum)))() + return await simulationInputPromise + } + const getExecutionSimulationState = async () => { + if (!simulationOverlayEnabled) return PASSTHROUGH_STATE + if (executionSimulationStatePromise === undefined) executionSimulationStatePromise = (async () => { + const simulationInput = await getSimulationInput() + if (simulationInput.kind === 'passthrough') return PASSTHROUGH_STATE + return toResolvedExecutionSimulationState(await buildExecutionSimulationStateFromPreparedInput(simulationInput.value, ethereum)) + })() + return await executionSimulationStatePromise + } const { request, confirmation } = context const maybeParsedRequest = confirmation === undefined ? EthereumJsonRpcRequest.safeParse(request) @@ -388,11 +402,12 @@ function replyWithSignerAccountError(websiteTabConnections: WebsiteTabConnection }) } -export const handleInterceptedRequest = async (port: browser.runtime.Port | undefined, websiteOrigin: string, websitePromise: Promise | Website, ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, socket: WebsiteSocket, request: InterceptedRequest, websiteTabConnections: WebsiteTabConnections, publishRpcConnectionStatus: PublishRpcConnectionStatus): Promise => { +export const handleInterceptedRequest = async (port: browser.runtime.Port | undefined, websiteOrigin: string, websitePromise: Promise | Website, simulationServicesOwner: SimulationServicesOwner, socket: WebsiteSocket, request: InterceptedRequest, websiteTabConnections: WebsiteTabConnections, publishRpcConnectionStatus: PublishRpcConnectionStatus): Promise => { const initialSettings = await getSettings() if (request.method === 'wallet_revokePermissions') { const parsedRequest = parseWalletRevokePermissionsRequest(websiteTabConnections, request) if (parsedRequest === undefined) return + const { ethereum, tokenPriceService } = simulationServicesOwner.getCurrent() const result = await revokeWebsitePermissions(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, websiteOrigin) return replyToInterceptedRequest(websiteTabConnections, { ...getRequestWithDefinedParams(request), ...result }) } @@ -408,6 +423,7 @@ export const handleInterceptedRequest = async (port: browser.runtime.Port | unde const providerCallbackActiveAddress = initialActiveAddress !== undefined && getWebsiteAddressAccessApprovalState(initialSettings.websiteAccess, websiteOrigin, initialActiveAddress) === 'hasAccess' ? initialActiveAddress.address : undefined + const { ethereum, tokenPriceService } = simulationServicesOwner.getCurrent() const providerHandlerReturn = await providerHandler.func(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, port, request, providerCallbackApproval, providerCallbackActiveAddress) if (providerHandlerReturn.type === 'doNotReply') return const message: InpageScriptRequest = { uniqueRequestIdentifier: request.uniqueRequestIdentifier, ...providerHandlerReturn } @@ -440,7 +456,7 @@ export const handleInterceptedRequest = async (port: browser.runtime.Port | unde const signerAccountsResult = await askForSignerAccountsFromSignerIfNotAvailable(websiteTabConnections, socket, true) if (isTerminalSignerAccountConnectionError(signerAccountsResult.error)) return replyWithSignerAccountError(websiteTabConnections, request, signerAccountsResult.error) if (signerAccountsResult.accounts.length === 0) return refuseAccess(websiteTabConnections, request) - const result: unknown = await handleInterceptedRequest(port, websiteOrigin, websitePromise, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, publishRpcConnectionStatus) + const result: unknown = await handleInterceptedRequest(port, websiteOrigin, websitePromise, simulationServicesOwner, socket, request, websiteTabConnections, publishRpcConnectionStatus) return result } if (access === 'hasAccess' && activeAddress === undefined && (request.method === 'eth_accounts' || request.method === 'wallet_getPermissions' || request.method === 'wallet_getCapabilities') && (!settings.simulationMode || settings.useSignersAddressAsActiveAddress)) { @@ -465,7 +481,7 @@ export const handleInterceptedRequest = async (port: browser.runtime.Port | unde if (refreshedActiveAddress === undefined) return replyWithoutActiveAccount(websiteTabConnections, request) const refreshedAccess = verifyAccess(websiteTabConnections, socket, false, websiteOrigin, refreshedActiveAddress, refreshedSettings, { ignoreConnectionApproval: true }) if (refreshedAccess !== 'hasAccess') return replyWithoutActiveAccount(websiteTabConnections, request) - return await handleContentScriptMessage(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, request, await websitePromise, refreshedActiveAddress, publishRpcConnectionStatus) + return await handleContentScriptMessage(simulationServicesOwner, websiteTabConnections, request, await websitePromise, refreshedActiveAddress, publishRpcConnectionStatus) } if (access === 'noAccess' || activeAddress === undefined) { @@ -480,18 +496,23 @@ export const handleInterceptedRequest = async (port: browser.runtime.Port | unde } switch (access) { - case 'askAccess': return await gateKeepRequestBehindAccessDialog(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, request, await websitePromise, activeAddress, await getSettings(), publishRpcConnectionStatus) + case 'askAccess': { + const website = await websitePromise + const currentSettings = await getSettings() + const { ethereum, tokenPriceService } = simulationServicesOwner.getCurrent() + return await gateKeepRequestBehindAccessDialog(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, request, website, activeAddress, currentSettings, publishRpcConnectionStatus) + } case 'noAccess': return refuseAccess(websiteTabConnections, request) case 'hasAccess': { if (activeAddress === undefined) return refuseAccess(websiteTabConnections, request) const website = await websitePromise - return await handleContentScriptMessage(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, request, website, activeAddress, publishRpcConnectionStatus) + return await handleContentScriptMessage(simulationServicesOwner, websiteTabConnections, request, website, activeAddress, publishRpcConnectionStatus) } default: assertNever(access) } } -async function handleContentScriptMessage(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, request: InterceptedRequest, website: Website, activeAddress: AddressBookEntry, publishRpcConnectionStatus: PublishRpcConnectionStatus) { +async function handleContentScriptMessage(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, request: InterceptedRequest, website: Website, activeAddress: AddressBookEntry, publishRpcConnectionStatus: PublishRpcConnectionStatus) { try { const requestWithDefinedParams = getRequestWithDefinedParams(request) const settings = await getSettings() @@ -500,7 +521,7 @@ async function handleContentScriptMessage(ethereum: EthereumClientService, token const safeSigningMode = isActiveSigningSafe(activeAddress, settings.simulationMode, settings.activeSigningSafeAddress, settings.activeRpcNetwork.chainId, signerTabState.signerAccounts, currentChainEntries) let rpcContext: RpcRequestContext = { request } if (request.method === 'safe_apps_request') { - const admission = await prepareSafeAppsRequest(ethereum, websiteTabConnections, request, website, activeAddress, settings, safeSigningMode) + const admission = await prepareSafeAppsRequest(simulationServicesOwner.getCurrent().ethereum, websiteTabConnections, request, website, activeAddress, settings, safeSigningMode) if (admission.kind === 'reply') return replyToInterceptedRequest(websiteTabConnections, admission.reply) rpcContext = admission.context } @@ -508,23 +529,9 @@ async function handleContentScriptMessage(ethereum: EthereumClientService, token // The request's active entry is captured before async handling begins. Recheck Safe ownership without rerouting the request if the popup selects another account meanwhile. const simulationOverlayEnabled = settings.simulationMode || safeSigningMode const walletSelectedSafeSigner = safeSigningMode ? selectedWalletAccount : undefined - let simulationInputPromise: Promise | undefined - let executionSimulationStatePromise: Promise | undefined - const getSimulationInput = async () => { - if (!simulationOverlayEnabled) return PASSTHROUGH_STATE - if (simulationInputPromise === undefined) simulationInputPromise = (async () => toResolvedSimulationInput(await prepareSimulationInputForRpc(await getCurrentSimulationInput(), ethereum)))() - return await simulationInputPromise - } - const getExecutionSimulationState = async () => { - if (!simulationOverlayEnabled) return PASSTHROUGH_STATE - if (executionSimulationStatePromise === undefined) executionSimulationStatePromise = (async () => { - const simulationInput = await getSimulationInput() - if (simulationInput.kind === 'passthrough') return PASSTHROUGH_STATE - return toResolvedExecutionSimulationState(await buildExecutionSimulationStateFromPreparedInput(simulationInput.value, ethereum)) - })() - return await executionSimulationStatePromise - } - const resolved = await handleRPCRequest(ethereum, tokenPriceService, simulationServicesOwner, getSimulationInput, getExecutionSimulationState, websiteTabConnections, request.uniqueRequestIdentifier.requestSocket, website, rpcContext, settings, activeAddress.address, publishRpcConnectionStatus, simulationOverlayEnabled, safeSigningMode, walletSelectedSafeSigner) + const resolved = await handleRPCRequest(simulationServicesOwner, websiteTabConnections, request.uniqueRequestIdentifier.requestSocket, website, rpcContext, settings, activeAddress.address, publishRpcConnectionStatus, simulationOverlayEnabled, safeSigningMode, walletSelectedSafeSigner) + // Permission persistence is a subsequent stage and may follow a service reset during RPC execution. + const { ethereum, tokenPriceService } = simulationServicesOwner.getCurrent() await persistApprovedAccountsForAccountRequest( ethereum, tokenPriceService, diff --git a/app/ts/background/windows/interceptorAccess.ts b/app/ts/background/windows/interceptorAccess.ts index c8f444dc0..4d9c50579 100644 --- a/app/ts/background/windows/interceptorAccess.ts +++ b/app/ts/background/windows/interceptorAccess.ts @@ -134,8 +134,6 @@ export async function resolveInterceptorAccess(ethereum: EthereumClientService, undefined, pendingRequest.website.websiteOrigin, pendingRequest.website, - ethereum, - tokenPriceService, simulationServicesOwner, pendingRequest.socket, pendingRequest.request, @@ -458,8 +456,6 @@ export async function requestAccessFromUser( undefined, pendingReplay.website.websiteOrigin, pendingReplay.website, - ethereum, - tokenPriceService, simulationServicesOwner, pendingReplay.socket, pendingReplay.request, diff --git a/docs/popup-simulation-refresh.md b/docs/popup-simulation-refresh.md index 6fcfdc3d1..0b917bbf5 100644 --- a/docs/popup-simulation-refresh.md +++ b/docs/popup-simulation-refresh.md @@ -24,3 +24,5 @@ External-wallet signing transitions do not enqueue simulation refreshes: wallet `updatePopupVisualisationIfNeeded` takes named options for invalidation, throttling, unchanged-input skipping, and a captured snapshot. Omitted options keep the normal direct-refresh behavior. The interactive queue supplies its captured snapshot and owns coalescing; the executor owns serialization. Active settings commands receive `SimulationServicesOwner`, not a service pair captured before waiting for the transition semaphore. They read `getCurrent()` when preparing the refresh, so a preceding endpoint reset supplies the installed services. Both popup and dapp RPC requests enter `changeActiveRpc` in `walletSwitch.ts`, which owns routing, shared Safe network restrictions, local promotion, and correlated wallet dispatch. + +The intercepted-request pipeline also carries only the service owner. Provider callbacks and access admission obtain services when their work starts. RPC execution captures one pair after admission and uses it for both lazy simulation preparation and RPC handling; permission persistence begins a subsequent stage with the then-current pair. An in-flight RPC does not switch providers halfway through execution. diff --git a/test/tests/backgroundAccountPermissions.test.ts b/test/tests/backgroundAccountPermissions.test.ts index 5da4963fc..fc190526c 100644 --- a/test/tests/backgroundAccountPermissions.test.ts +++ b/test/tests/backgroundAccountPermissions.test.ts @@ -524,7 +524,7 @@ describe('background eth_accounts', () => { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: true, uniqueRequestIdentifier: { requestId: 42, requestSocket: socket }, @@ -641,7 +641,7 @@ describe('background eth_accounts', () => { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 12, requestSocket: socket }, @@ -789,7 +789,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.some((message) => message.method === 'request_signer_to_eth_requestAccounts'), false) assert.equal(messages.some((message) => message.method === 'connect'), false) @@ -846,7 +846,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.some((message) => message.type === 'forwardToSigner'), false) assert.equal(messages.some((message) => message.method === 'request_signer_to_eth_requestAccounts'), false) @@ -896,7 +896,7 @@ describe('background eth_accounts', () => { params: [true, 'MetaMask', 2], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) await waitForPortMessageCount(messages, 'safe_apps_compatibility', 1) const connectedReplies = messages.filter((message) => message.method === 'connected_to_signer' && message.requestId === 12) @@ -924,7 +924,7 @@ describe('background eth_accounts', () => { const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) assert.equal((await getSettings()).activeSigningSafeAddress, undefined) assert.equal('lifecycle' in connections, false) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 13, requestSocket: socket }, method: 'connected_to_signer', params: [true, 'MetaMask', 1], @@ -973,7 +973,7 @@ describe('background eth_accounts', () => { params: [true, 'MetaMask', 1], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const connectedResult = messages.find((message) => message.method === 'connected_to_signer' && message.requestId === 13)?.result assert.equal(connection.approved, true) @@ -989,7 +989,7 @@ describe('background eth_accounts', () => { const childConnections = new Map([[childSocket.tabId, { ...confirmedSignerOwnership(childSocket), connections: { [websiteSocketToString(childSocket)]: childConnection } }]]) await initializeSafeAppsCompatibility(childConnections) await updateTabState(childSocket.tabId, (previousState) => ({ ...previousState, signerAccounts: [account], activeSigningAddress: account })) - await handleInterceptedRequest(childPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, childSocket, { + await handleInterceptedRequest(childPort, websiteOrigin, website, simulationServicesOwner, childSocket, { ...request, uniqueRequestIdentifier: { requestId: 14, requestSocket: childSocket }, }, childConnections, noopPublishRpcConnectionStatus) @@ -1044,7 +1044,7 @@ describe('background eth_accounts', () => { params: [true, 'MetaMask', 1], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, connectedRequest, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, connectedRequest, websiteTabConnections, noopPublishRpcConnectionStatus) await waitForPortMessageCount(messages, 'safe_apps_compatibility', 1) assert.equal(messages.find((message) => message.method === 'connected_to_signer' && message.requestId === 15)?.result?.metamaskCompatibilityMode, false) assert.equal(messages.filter((message) => message.method === 'safe_apps_compatibility').every((message) => message.result?.enabled === false), true) @@ -1052,7 +1052,7 @@ describe('background eth_accounts', () => { await updateWebsiteAccess(() => [{ website, access: true, addressAccess: [{ address: account, access: true }] }]) await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), false) assert.equal(messages.filter((message) => message.method === 'safe_apps_compatibility').every((message) => message.result?.enabled === false), true) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { ...connectedRequest, uniqueRequestIdentifier: { requestId: 16, requestSocket: socket }, params: [false, 'NoSigner', 2], @@ -1170,7 +1170,7 @@ describe('background eth_accounts', () => { const { port, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_accounts') return replyToDiscovery = async () => { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1194,7 +1194,7 @@ describe('background eth_accounts', () => { })) if (coldStart) { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1313,7 +1313,7 @@ describe('background eth_accounts', () => { const socket = { tabId: 1, connectionName: 0n } const { port, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1334,7 +1334,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_requestAccounts').length, 1) assert.equal(messages.some((message) => message.method === 'connect'), false) @@ -1392,7 +1392,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.some((message) => message.method === 'connect' || message.method === 'accountsChanged'), false) assert.equal(messages.filter((message) => message.method === 'eth_requestAccounts' && message.requestId === 22).at(-1)?.error?.code, 4100) @@ -1430,14 +1430,14 @@ describe('background eth_accounts', () => { [connectionKey]: connection, } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - const requestAccountsPromise = handleInterceptedRequest(port, websiteOrigin, pendingWebsite.promise, ethereum, tokenPriceService, simulationServicesOwner, socket, { + const requestAccountsPromise = handleInterceptedRequest(port, websiteOrigin, pendingWebsite.promise, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 23, requestSocket: socket }, method: 'eth_requestAccounts', }, websiteTabConnections, noopPublishRpcConnectionStatus) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 24, requestSocket: socket }, @@ -1498,7 +1498,7 @@ describe('background eth_accounts', () => { [connectionKey]: connection, } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - const requestAccountsPromise = handleInterceptedRequest(port, websiteOrigin, pendingWebsite.promise, ethereum, tokenPriceService, simulationServicesOwner, socket, { + const requestAccountsPromise = handleInterceptedRequest(port, websiteOrigin, pendingWebsite.promise, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 25, requestSocket: socket }, @@ -1564,7 +1564,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.some((message) => message.method === 'request_signer_to_eth_requestAccounts'), false) assert.equal(messages.some((message) => message.method === 'connect'), false) @@ -1695,7 +1695,7 @@ describe('background eth_accounts', () => { if (message.method !== 'request_signer_to_eth_requestAccounts') return void (async () => { await updateWebsiteAccess(() => [{ website, access: false, addressAccess: undefined }]) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1717,7 +1717,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_requestAccounts').length, 1) assert.equal(messages.some((message) => message.method === 'connect'), false) @@ -1746,7 +1746,7 @@ describe('background eth_accounts', () => { const socket = { tabId: 1, connectionName: 0n } const { port, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1767,7 +1767,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_requestAccounts').length, 1) assert.equal(messages.some((message) => message.method === 'connect'), false) @@ -1795,7 +1795,7 @@ describe('background eth_accounts', () => { const socket = { tabId: 1, connectionName: 0n } const { port, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1816,7 +1816,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_requestAccounts').length, 1) assert.equal(messages.some((message) => message.method === 'connect'), false) @@ -1847,7 +1847,7 @@ describe('background eth_accounts', () => { const { port: createdPort, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return void (async () => { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1870,7 +1870,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_requestAccounts').length, 1) const requestAccountsReplies = messages.filter((message) => message.method === 'eth_requestAccounts' && message.requestId === 8) @@ -1915,7 +1915,7 @@ describe('background eth_accounts', () => { const accountRequest = accountRequests.find((candidate) => candidate.signerRequestMethod === message.method) if (accountRequest === undefined) return internalRequestId += 1 - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: true, @@ -1933,7 +1933,7 @@ describe('background eth_accounts', () => { for (const [requestIndex, accountRequest] of accountRequests.entries()) { const requestId = 15 + requestIndex - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: true, uniqueRequestIdentifier: { requestId, requestSocket: socket }, @@ -1990,7 +1990,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - const requestPromise = handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + const requestPromise = handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) await waitForPortMessageCount(messages, 'request_signer_to_eth_requestAccounts', 1) sendInternalWindowMessage({ method: 'window_signer_accounts_changed', @@ -2004,7 +2004,7 @@ describe('background eth_accounts', () => { await new Promise((resolve) => setTimeout(resolve, 0)) assert.equal(messages.some((message) => message.requestId === 18), false) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -2059,7 +2059,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const pendingRequest = (await getPendingAccessRequests())[0] if (pendingRequest === undefined) throw new Error('Missing address access request') @@ -2124,7 +2124,7 @@ describe('background eth_accounts', () => { params: [{ eth_accounts: {} }], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const pendingRequest = (await getPendingAccessRequests())[0] if (pendingRequest === undefined) throw new Error('Missing pending request') @@ -2185,7 +2185,7 @@ describe('background eth_accounts', () => { params: [{ eth_accounts: {} }], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const pendingRequest = (await getPendingAccessRequests())[0] if (pendingRequest === undefined) throw new Error('Missing pending request') @@ -2253,7 +2253,7 @@ describe('background eth_accounts', () => { params: [{ eth_accounts: {} }], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const pendingRequest = (await getPendingAccessRequests())[0] if (pendingRequest === undefined) throw new Error('Missing address access request') @@ -2315,7 +2315,7 @@ describe('background eth_accounts', () => { params: [{ eth_accounts: {}, wallet_snap: {} }], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(connection.approved, false) assert.equal((await getPendingAccessRequests()).length, 1) @@ -2344,7 +2344,7 @@ describe('background eth_accounts', () => { let port: browser.runtime.Port const { port: createdPort, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -2367,7 +2367,7 @@ describe('background eth_accounts', () => { params: [{ eth_accounts: {} }], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const siteLevelPendingRequest = (await getPendingAccessRequests())[0] if (siteLevelPendingRequest === undefined) throw new Error('Missing combined site and address access request') @@ -2429,7 +2429,7 @@ describe('background eth_accounts', () => { let port: browser.runtime.Port const { port: createdPort, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -2577,7 +2577,7 @@ describe('background eth_accounts', () => { let accountReply: Promise | undefined const { port, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_accounts') return - accountReply = handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + accountReply = handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -2682,7 +2682,7 @@ describe('background eth_accounts', () => { } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 10, requestSocket: socket }, @@ -2722,7 +2722,7 @@ describe('background eth_accounts', () => { } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 11, requestSocket: socket }, @@ -2738,7 +2738,7 @@ describe('background eth_accounts', () => { assert.equal(access?.access, false) assert.equal(access?.addressAccess, undefined) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 15, requestSocket: socket }, @@ -2767,7 +2767,7 @@ describe('background eth_accounts', () => { } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 12, requestSocket: socket }, @@ -2803,7 +2803,7 @@ describe('background eth_accounts', () => { } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 13, requestSocket: socket }, @@ -2816,7 +2816,7 @@ describe('background eth_accounts', () => { await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) assert.equal((await getPendingAccessRequests()).length, 0) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 14, requestSocket: socket }, @@ -2854,7 +2854,7 @@ describe('background eth_accounts', () => { ] for (const [index, params] of unsupportedParams.entries()) { const requestId = 13 + index - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId, requestSocket: socket }, @@ -3109,7 +3109,7 @@ describe('background eth_accounts', () => { if (message.method !== 'request_signer_to_eth_requestAccounts') return accountReply = new Promise((resolve) => { setTimeout(() => { - resolve(handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + resolve(handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -3181,7 +3181,7 @@ describe('background eth_accounts', () => { let accountReply: Promise | undefined const { port: currentPort, messages: currentMessages } = createPort(currentSocket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_accounts') return - accountReply = handleInterceptedRequest(currentPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, currentSocket, { + accountReply = handleInterceptedRequest(currentPort, websiteOrigin, website, simulationServicesOwner, currentSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, diff --git a/test/tests/backgroundEthSimulateV1.test.ts b/test/tests/backgroundEthSimulateV1.test.ts index 9d496cd3a..3210d30bd 100644 --- a/test/tests/backgroundEthSimulateV1.test.ts +++ b/test/tests/backgroundEthSimulateV1.test.ts @@ -167,7 +167,7 @@ describe('background eth_simulateV1', () => { const { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, requestHandler, tokenPriceService, simulationServicesOwner } = await createApprovedDappHarness() const parentBlockHash = '0x000000000000000000000000000000000000000000000000000000000000abcd' - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 42, requestSocket: socket }, @@ -213,7 +213,7 @@ describe('background eth_simulateV1', () => { const { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, requestHandler, tokenPriceService, simulationServicesOwner } = await createApprovedDappHarness() const blobVersionedHash = '0x01'.padEnd(66, '0') - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 44, requestSocket: socket }, @@ -262,7 +262,7 @@ describe('background eth_simulateV1', () => { test('accepts one-parameter eth_simulateV1 requests and preserves blobBaseFee', async () => { const { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, requestHandler, tokenPriceService, simulationServicesOwner } = await createApprovedDappHarness() - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 43, requestSocket: socket }, @@ -333,7 +333,7 @@ describe('background eth_simulateV1', () => { }] const { handleInterceptedRequest, websiteOrigin, website, socket, port, messages, websiteTabConnections, ethereum, tokenPriceService, simulationServicesOwner } = await createApprovedDappHarness(ethSimulateV1Result) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 45, requestSocket: socket }, diff --git a/test/tests/backgroundProviderRouting.test.ts b/test/tests/backgroundProviderRouting.test.ts index 58be5ef77..e017c1466 100644 --- a/test/tests/backgroundProviderRouting.test.ts +++ b/test/tests/backgroundProviderRouting.test.ts @@ -2,9 +2,43 @@ import * as assert from 'assert' import { describe, test } from 'bun:test' import type { SimulationStateInput } from '../../app/ts/types/visualizer-types.js' import { MessageToPopup } from '../../app/ts/types/interceptor-messages.js' -import { addressString, confirmedSignerOwnership, createEthereumWithGetBlockCounter, createPort, createSafeTx, EthereumJsonRpcRequest, installBrowserMock, loadModules, noopPublishRpcConnectionStatus, safeTxToTypedDataJson, } from './backgroundEthAccountsTestHarness.js' +import { createDeferredValue, createTestSimulationServicesOwner, addressString, confirmedSignerOwnership, createEthereumWithGetBlockCounter, createPort, createSafeTx, EthereumJsonRpcRequest, installBrowserMock, loadModules, noopPublishRpcConnectionStatus, safeTxToTypedDataJson, } from './backgroundEthAccountsTestHarness.js' describe('background eth_accounts', () => { + test('uses installed services after waiting for website metadata', async () => { + installBrowserMock() + const { handleInterceptedRequest, websiteSocketToString, updateWebsiteAccess, changeSimulationMode, setUseSignersAddressAsActiveAddress } = await loadModules() + const websiteOrigin = 'https://queued-rpc.example' + const website = { websiteOrigin, icon: undefined, title: undefined } + const account = 1n + await setUseSignersAddressAsActiveAddress(false) + await changeSimulationMode({ simulationMode: true, activeSimulationAddress: account }) + await updateWebsiteAccess(() => [{ website, access: true, addressAccess: [{ address: account, access: true }] }]) + const socket = { tabId: 1, connectionName: 0n } + const { port, messages } = createPort(1) + const connections = new Map([[1, { ...confirmedSignerOwnership(socket), connections: { + [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, + } }]]) + const original = createEthereumWithGetBlockCounter({ count: 0 }) + const installed = createEthereumWithGetBlockCounter({ count: 0 }) + let originalReads = 0 + let installedReads = 0 + original.ethereum.getChainId = () => { originalReads++; return 1n } + installed.ethereum.getChainId = () => { installedReads++; return 2n } + const owner = createTestSimulationServicesOwner(original, () => installed) + const metadata = createDeferredValue() + const pending = handleInterceptedRequest(port, websiteOrigin, metadata.promise, owner, socket, { + interceptorRequest: true, usingInterceptorWithoutSigner: true, + uniqueRequestIdentifier: { requestId: 991, requestSocket: socket }, method: 'eth_chainId', params: [], + }, connections, noopPublishRpcConnectionStatus) + owner.reset(installed.ethereum.getRpcEntry()) + metadata.resolve(website) + await pending + assert.equal(originalReads, 0) + assert.ok(installedReads > 0) + assert.equal(messages.find(message => message.requestId === 991)?.result, '0x2') + }) + test('handles wallet_getCapabilities locally and protects capabilities for other accounts', async () => { installBrowserMock() const { handleInterceptedRequest, websiteSocketToString, updateWebsiteAccess, changeSimulationMode, setUseSignersAddressAsActiveAddress, updateTabState } = await loadModules() @@ -28,7 +62,7 @@ describe('background eth_accounts', () => { [1, accountString], [2, '0x2222222222222222222222222222222222222222'], ] as const) { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId, requestSocket: socket }, @@ -57,7 +91,7 @@ describe('background eth_accounts', () => { await changeSimulationMode({ simulationMode: false, activeSimulationAddress: account, activeSigningAddress: account }) await setUseSignersAddressAsActiveAddress(true) await updateTabState(socket.tabId, (previousState) => ({ ...previousState, signerAccounts: [account], activeSigningAddress: account })) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 3, requestSocket: socket }, @@ -122,7 +156,7 @@ describe('background eth_accounts', () => { getStorageAtResult: singletonAddress, }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, @@ -140,7 +174,7 @@ describe('background eth_accounts', () => { result: '0x60', }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 2, requestSocket: socket }, @@ -178,7 +212,7 @@ describe('background eth_accounts', () => { } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, @@ -253,7 +287,7 @@ describe('background eth_accounts', () => { } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, @@ -313,7 +347,7 @@ describe('background eth_accounts', () => { } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 2, requestSocket: socket }, @@ -356,7 +390,7 @@ describe('background eth_accounts', () => { 'signer_reply', 'wallet_switchEthereumChain_reply', ].entries()) { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: index + 1, requestSocket: socket }, @@ -390,7 +424,7 @@ describe('background eth_accounts', () => { } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -447,7 +481,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: true, @@ -465,7 +499,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal(noSignerState.activeSigningAddress, undefined) assert.equal(messages.some((message) => message.method === 'request_signer_chainId'), false) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: true, @@ -482,7 +516,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal((await getTabState(socket.tabId)).signerAccountError, undefined) // Signer identity is trusted extension state and must be current before the website receives access. - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -495,7 +529,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal(identifiedSignerState.signerConnected, true) assert.equal(messages.some((message) => message.method === 'request_signer_chainId'), false) - await handleInterceptedRequest(childPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, childSocket, { + await handleInterceptedRequest(childPort, websiteOrigin, website, simulationServicesOwner, childSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: true, @@ -510,7 +544,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 await updateWebsiteAccess(() => [{ website, access: true, addressAccess: undefined }]) connection.approved = true - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -553,7 +587,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 if (message.method !== 'request_signer_to_eth_requestAccounts') return void (async () => { signerAccountSnapshots.push([...(await getTabState(socket.tabId)).signerAccounts]) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -579,7 +613,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 activeSigningAddress: braveAccount, })) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -596,7 +630,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal(stateAfterMetaMaskSelection.signerAccountError, undefined) assert.equal(stateAfterMetaMaskSelection.activeSigningAddress, undefined) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 201, requestSocket: socket }, @@ -618,7 +652,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 { port: nextPort, socket: nextSocket, websiteOrigin, approved: true, wantsToConnect: true }, true, ) - await handleInterceptedRequest(nextPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, nextSocket, { + await handleInterceptedRequest(nextPort, websiteOrigin, website, simulationServicesOwner, nextSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -652,7 +686,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 }) completionChannel.addEventListener('message', completionListener) try { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -660,7 +694,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 method: 'eth_accounts_reply', params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x4141414141414141414141414141414141414141'], requestAccounts: true }], }, websiteTabConnections, noopPublishRpcConnectionStatus) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -668,7 +702,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 method: 'eth_accounts_reply', params: [{ signerProviderGeneration: 1, type: 'error', requestAccounts: true, error: { code: 4001, message: 'Late Brave error' } }], }, websiteTabConnections, noopPublishRpcConnectionStatus) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -719,7 +753,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 let restoredPort: browser.runtime.Port const { port: createdRestoredPort, messages } = createPort(restoredSocket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_accounts') return - void handleInterceptedRequest(restoredPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, restoredSocket, { + void handleInterceptedRequest(restoredPort, websiteOrigin, website, simulationServicesOwner, restoredSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -756,7 +790,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 true, ) - const accountRequest = handleInterceptedRequest(restoredPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, restoredSocket, { + const accountRequest = handleInterceptedRequest(restoredPort, websiteOrigin, website, simulationServicesOwner, restoredSocket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 300, requestSocket: restoredSocket }, @@ -766,7 +800,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal(messages.some((message) => message.method === 'request_signer_to_eth_accounts'), false) assert.equal(messages.some((message) => message.method === 'eth_accounts' && message.requestId === 300), false) - await handleInterceptedRequest(restoredPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, restoredSocket, { + await handleInterceptedRequest(restoredPort, websiteOrigin, website, simulationServicesOwner, restoredSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -803,7 +837,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const createdPort = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return void (async () => { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -811,7 +845,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 method: 'connected_to_signer', params: [true, 'MetaMask', 2], }, websiteTabConnections, noopPublishRpcConnectionStatus) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -830,7 +864,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: true, uniqueRequestIdentifier: { requestId: 307, requestSocket: socket }, @@ -896,7 +930,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 [310, { signerProviderGeneration: 1, type: 'success', accounts: ['0x6262626262626262626262626262626262626262'], requestAccounts: true }], [311, { signerProviderGeneration: 1, type: 'error', requestAccounts: true, error: { code: 4900, message: 'Stale error' } }], ] as const) { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -905,7 +939,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 params: [params], }, websiteTabConnections, noopPublishRpcConnectionStatus) } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -977,7 +1011,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -992,7 +1026,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal((await getActiveAddress(settings, socket.tabId))?.address, safeAddress) assert.equal(messages.some((message) => message.method === 'chainChanged'), false) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1005,7 +1039,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 assert.equal(settingsAfterDisconnect.activeSigningSafeAddress, undefined) assert.equal((await getActiveAddress(settingsAfterDisconnect, socket.tabId)), undefined) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1017,7 +1051,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const otherSignerAddress = 0x5353535353535353535353535353535353535353n assert.equal((await getSigningAddressPreferences()).some((preference) => preference.signerAddress === otherSignerAddress), false) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1078,7 +1112,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 [websiteSocketToString(socket)]: { port, socket, websiteOrigin: 'https://remembered.example', approved: true, wantsToConnect: true }, } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - const selectSignerAccount = async (account: bigint, requestId: number) => await handleInterceptedRequest(port, 'https://remembered.example', { websiteOrigin: 'https://remembered.example', icon: undefined, title: undefined }, ethereum, tokenPriceService, simulationServicesOwner, socket, { + const selectSignerAccount = async (account: bigint, requestId: number) => await handleInterceptedRequest(port, 'https://remembered.example', { websiteOrigin: 'https://remembered.example', icon: undefined, title: undefined }, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1190,7 +1224,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 params: ['0x5555555555555555555555555555555555555555', typedData], }, ]) { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) } for (const requestId of [210, 211]) { @@ -1336,7 +1370,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 }], }, ]) { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) } for (const requestId of [213, 214, 215]) { @@ -1403,7 +1437,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 signingAddressSelection: 'safe', }) assert.notEqual((await getActiveAddress(await getSettings(), socket.tabId))?.address, safeAddress) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 212, requestSocket: socket }, @@ -1492,7 +1526,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) assert.equal((await getActiveAddress(await getSettings(), socket.tabId))?.address, safeSignerAddress) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 208, requestSocket: socket }, @@ -1508,7 +1542,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 signingAddressSelection: 'safe', }) assert.equal((await getActiveAddress(await getSettings(), socket.tabId))?.address, safeSignerAddress) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 209, requestSocket: socket }, @@ -1562,7 +1596,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1616,7 +1650,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) assert.equal((await getActiveAddress(await getSettings(), socket.tabId))?.address, signerAddress) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -1656,7 +1690,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 method: 'eth_accounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(getBlockCalls.count, 0) assert.equal(messages.some((message) => message.method === 'request_signer_to_eth_accounts'), false) @@ -1688,7 +1722,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 method: 'eth_accounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const ethAccountsReplies = messages.filter((message) => message.method === 'eth_accounts' && message.requestId === 2) assert.deepEqual(ethAccountsReplies.at(-1)?.result, []) @@ -1718,7 +1752,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 method: 'wallet_getPermissions', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const permissionsReplies = messages.filter((message) => message.method === 'wallet_getPermissions' && message.requestId === 3) assert.deepEqual(permissionsReplies.at(-1)?.result, []) @@ -1771,7 +1805,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: true, wantsToConnect: true }, } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 31, requestSocket: socket }, @@ -1819,7 +1853,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 } await Promise.race([ - handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus), + handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus), new Promise((_, reject) => setTimeout(() => reject(new Error('wallet_getPermissions did not resolve')), 100)), ]) @@ -1854,7 +1888,7 @@ params: [{ signerProviderGeneration: 1, type: 'success', accounts: ['0x333333333 } await Promise.race([ - handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus), + handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus), new Promise((_, reject) => setTimeout(() => reject(new Error('wallet_getPermissions did not resolve')), 100)), ]) diff --git a/test/tests/backgroundSignerLifecycle.test.ts b/test/tests/backgroundSignerLifecycle.test.ts index 5612f86da..189d24bf7 100644 --- a/test/tests/backgroundSignerLifecycle.test.ts +++ b/test/tests/backgroundSignerLifecycle.test.ts @@ -41,7 +41,7 @@ describe('background eth_accounts', () => { method: 'eth_chainId', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, publishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, publishRpcConnectionStatus) assert.deepEqual(publishedRetryStates, [true]) assert.equal((await getRpcConnectionStatus())?.retrying, true) @@ -85,7 +85,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, publishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, publishRpcConnectionStatus) assert.equal(publishCalls, 0) const requestAccountsReplies = messages.filter((message) => message.method === 'eth_accounts' && message.requestId === 15) @@ -133,7 +133,7 @@ describe('background eth_accounts', () => { method: 'eth_accounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_accounts').length, 1) assert.equal(messages.some((message) => message.method === 'request_signer_to_eth_requestAccounts'), false) @@ -177,7 +177,7 @@ describe('background eth_accounts', () => { } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 8, requestSocket: socket }, @@ -227,7 +227,7 @@ describe('background eth_accounts', () => { } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const replyWithSignerAccounts = async (requestId: number, requestAccounts: boolean, accounts: readonly string[]) => { - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -240,7 +240,7 @@ describe('background eth_accounts', () => { const passiveRequest = refreshSignerAccountsFromApprovedWebsitePorts(websiteTabConnections, false) await waitForPortMessageCount(messages, 'request_signer_to_eth_accounts', 1) - const interactiveRequest = handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + const interactiveRequest = handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 71, requestSocket: socket }, @@ -293,7 +293,7 @@ describe('background eth_accounts', () => { const refresh = refreshSignerAccountsFromApprovedWebsitePorts(websiteTabConnections, false) await waitForPortMessageCount(messages, 'request_signer_to_eth_accounts', 1) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -309,7 +309,7 @@ describe('background eth_accounts', () => { assert.notEqual(signerStateToken, false) assert.equal(messages.filter((message) => message.method === 'request_signer_to_wallet_switchEthereumChain').length, 1) assert.equal(childMessages.some((message) => message.method === 'request_signer_to_wallet_switchEthereumChain'), false) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -478,7 +478,7 @@ describe('background eth_accounts', () => { await new Promise((resolve) => setTimeout(resolve, 0)) await removeWebsiteTabConnection(websiteTabConnections, approvingSocket, approvingPort) - await handleInterceptedRequest(ownerPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, ownerSocket, { + await handleInterceptedRequest(ownerPort, websiteOrigin, website, simulationServicesOwner, ownerSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -580,7 +580,7 @@ describe('background eth_accounts', () => { }) assert.deepEqual(popupReply, { type: 'PopupSettingsChangeReply', ok: false, message: 'A network switch is already waiting for your wallet.' }) assert.equal(popupMessages.some((message) => message.method === 'request_signer_to_wallet_switchEthereumChain'), false) - await handleInterceptedRequest(popupPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, popupSocket, { + await handleInterceptedRequest(popupPort, websiteOrigin, website, simulationServicesOwner, popupSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -591,7 +591,7 @@ describe('background eth_accounts', () => { await new Promise((resolve) => setTimeout(resolve, 0)) assert.equal(requestSettled, false) - await handleInterceptedRequest(requestPort, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, requestSocket, { + await handleInterceptedRequest(requestPort, websiteOrigin, website, simulationServicesOwner, requestSocket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -712,7 +712,7 @@ describe('background eth_accounts', () => { releaseDeferredChainChangeRemoval() await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -750,7 +750,7 @@ describe('background eth_accounts', () => { const stateAtDappReply: Array = [] const { port: createdPort, messages } = createPort(socket.tabId, (message) => { if (message.method === 'request_signer_to_eth_requestAccounts') { - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -781,7 +781,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.filter((message) => message.method === 'request_signer_to_eth_requestAccounts').length, 1) await new Promise((resolve) => setTimeout(resolve, 0)) @@ -833,7 +833,7 @@ describe('background eth_accounts', () => { const siblingSocket = { tabId: 1, connectionName: 1n } const { port: createdPort, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -858,7 +858,7 @@ describe('background eth_accounts', () => { method: 'eth_requestAccounts', } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) assert.equal(messages.some((message) => message.method === 'connect'), false) assert.deepEqual(messages.filter((message) => message.method === 'accountsChanged').map((message) => message.requestId), [17]) @@ -890,7 +890,7 @@ describe('background eth_accounts', () => { const socket = { tabId: 1, connectionName: 0n } const { port: createdPort, messages } = createPort(socket.tabId, (message) => { if (message.method !== 'request_signer_to_eth_requestAccounts') return - void handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, { + void handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { interceptorRequest: true, interceptorInternalRequest: true, usingInterceptorWithoutSigner: false, @@ -914,7 +914,7 @@ describe('background eth_accounts', () => { params: [{ eth_accounts: {} }], } - await handleInterceptedRequest(port, websiteOrigin, website, ethereum, tokenPriceService, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) + await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, request, websiteTabConnections, noopPublishRpcConnectionStatus) const permissionResult = [{ parentCapability: 'eth_accounts', diff --git a/test/tests/interceptorAccessCloseRace.test.ts b/test/tests/interceptorAccessCloseRace.test.ts index 208a34355..ad183649c 100644 --- a/test/tests/interceptorAccessCloseRace.test.ts +++ b/test/tests/interceptorAccessCloseRace.test.ts @@ -1,3 +1,4 @@ +import { createEthereumWithGetBlockCounter } from './backgroundEthAccountsTestHarness.js' import * as assert from 'assert' import { describe, test } from 'bun:test' import type { Settings } from '../../app/ts/types/interceptor-messages.js' @@ -175,9 +176,7 @@ describe('interceptor access close handling', () => { uniqueRequestIdentifier: { requestId: 7, requestSocket: socket }, method: 'eth_requestAccounts', } - const ethereum = {} as never - const tokenPriceService = {} as never - const simulationServicesOwner = (() => undefined) as never + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const { getActiveAddressEntryForChain } = await import('../../app/ts/background/metadataUtils.js') await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, website, request, undefined, await getSettings(), await getActiveAddressEntryForChain(account, 1n), async () => undefined) @@ -216,9 +215,7 @@ describe('interceptor access close handling', () => { minimized: true, }, } - const ethereum = {} as never - const tokenPriceService = {} as never - const simulationServicesOwner = (() => undefined) as never + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, website, undefined, undefined, settings, undefined, undefined) @@ -285,9 +282,7 @@ describe('interceptor access close handling', () => { minimized: true, }, } - const ethereum = {} as never - const tokenPriceService = {} as never - const simulationServicesOwner = (() => undefined) as never + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const request: InterceptedRequest = { interceptorRequest: true, usingInterceptorWithoutSigner: false, @@ -356,9 +351,7 @@ describe('interceptor access close handling', () => { }, } }], ]) - const ethereum = {} as never - const tokenPriceService = {} as never - const simulationServicesOwner = (() => undefined) as never + const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const publishRpcConnectionStatus = async () => undefined await changeSimulationMode({ simulationMode: true, activeSimulationAddress: account, activeSigningAddress: undefined }) const activeAddress = await getActiveAddressEntryForChain(account, 1n) From c1d03df678446ae517f758ac654e42c3b1a4ec2f Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Thu, 10 Sep 2026 09:15:26 +0000 Subject: [PATCH 27/31] Carry service ownership through access and popup lifecycles --- app/ts/background/accessManagement.ts | 28 ++--- app/ts/background/activeSettings.ts | 3 +- app/ts/background/background-startup.ts | 4 +- app/ts/background/background.ts | 30 ++--- app/ts/background/popupMessageDispatcher.ts | 106 ++++++++++++++---- .../addressBook.ts | 14 ++- .../popupMessageHandlerRegistries/safe.ts | 5 +- .../popupMessageHandlerRegistries/settings.ts | 4 +- .../websiteAccess.ts | 12 +- .../background/popupMessageHandlerRegistry.ts | 4 - app/ts/background/popupMessageHandlers.ts | 30 ++--- .../popupMessageHandlers/websiteAccess.ts | 18 ++- app/ts/background/popupMessageRouting.ts | 6 - app/ts/background/providerMessageHandlers.ts | 14 +-- app/ts/background/simulationModeHandlers.ts | 6 +- app/ts/background/windows/changeChain.ts | 10 +- .../background/windows/interceptorAccess.ts | 30 ++--- docs/popup-simulation-refresh.md | 4 +- test/tests/activeSettingsConcurrency.test.ts | 16 +-- .../backgroundAccountPermissions.test.ts | 48 +++----- test/tests/backgroundProviderRouting.test.ts | 35 ++++++ test/tests/backgroundSignerLifecycle.test.ts | 12 +- test/tests/backgroundUtilsMessaging.test.ts | 4 - test/tests/extensionIconDeduping.test.ts | 6 - test/tests/interceptorAccessCloseRace.test.ts | 18 +-- test/tests/popupClearReset.test.ts | 4 +- test/tests/popupMessageDispatcher.test.ts | 4 +- test/tests/popupSettingsChanges.test.ts | 10 +- test/tests/refreshHomeDataRpcStatus.test.ts | 3 +- test/tests/safeSignerConfirmation.suite.ts | 4 - test/tests/safeSignerRouting.suite.ts | 14 +-- 31 files changed, 245 insertions(+), 261 deletions(-) diff --git a/app/ts/background/accessManagement.ts b/app/ts/background/accessManagement.ts index effa3bf38..c18e4836c 100644 --- a/app/ts/background/accessManagement.ts +++ b/app/ts/background/accessManagement.ts @@ -13,8 +13,6 @@ import { getUniqueItemsByProperties, replaceElementInReadonlyArray } from '../ut import { modifyObject } from '../utils/typescript.js' import type { AddressBookEntries, AddressBookEntry } from '../types/addressBookTypes.js' import { Semaphore } from '../utils/semaphore.js' -import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' -import type { TokenPriceService } from '../simulation/services/priceEstimator.js' import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import { mergeStoredWebsiteMetadata } from '../utils/websiteIcons.js' import { reportUnexpectedError } from '../utils/errors.js' @@ -232,12 +230,12 @@ export async function getAssociatedAddresses(settings: Settings, websiteOrigin: return getUniqueItemsByProperties(all, ['address']) } -async function askUserForAccessOnConnectionUpdate(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, websiteOrigin: string, activeAddress: AddressBookEntry | undefined, settings: Settings) { +async function askUserForAccessOnConnectionUpdate(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, websiteOrigin: string, activeAddress: AddressBookEntry | undefined, settings: Settings) { const details = getWebsiteSocketConnection(websiteTabConnections, socket) if (details === undefined) return const website = { websiteOrigin, ...await retrieveWebsiteDetails(socket.tabId, websiteOrigin) } - await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, website, undefined, activeAddress, settings, activeAddress, undefined) + await requestAccessFromUser(simulationServicesOwner, websiteTabConnections, socket, website, undefined, activeAddress, settings, activeAddress, undefined) } function addIconRefreshTarget(iconRefreshTargets: Map, tabId: number, websiteOrigin: string) { @@ -273,7 +271,7 @@ async function updateTabConnections( return iconRefreshTargets } -async function promptForWebsiteAccesses(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, throwOnError = false) { +async function promptForWebsiteAccesses(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, throwOnError = false) { for (const tabConnection of websiteTabConnections.values()) { for (const connection of Object.values(tabConnection.connections)) { if (!connection.wantsToConnect) continue @@ -282,7 +280,7 @@ async function promptForWebsiteAccesses(ethereum: EthereumClientService, tokenPr const settings = await getSettings() const { activeAddress, access } = await getConnectionAccess(websiteTabConnections, connection, settings) if (access !== 'askAccess') continue - await askUserForAccessOnConnectionUpdate(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, connection.socket, connection.websiteOrigin, activeAddress, settings) + await askUserForAccessOnConnectionUpdate(simulationServicesOwner, websiteTabConnections, connection.socket, connection.websiteOrigin, activeAddress, settings) } catch (error) { if (throwOnError) throw error await reportUnexpectedError(error) @@ -423,8 +421,6 @@ export async function reconcileWebsiteApprovalAccesses( // Call after releasing the settings lock: access dialogs can activate another address. export async function finishWebsiteAccessUpdate( - ethereum: EthereumClientService | undefined, - tokenPriceService: TokenPriceService | undefined, simulationServicesOwner: SimulationServicesOwner | undefined, websiteTabConnections: WebsiteTabConnections, update: WebsiteAccessUpdate, @@ -433,8 +429,8 @@ export async function finishWebsiteAccessUpdate( ) { const iconRefreshTargets = new Map() for (const target of update.iconRefreshTargets) addIconRefreshTarget(iconRefreshTargets, target.tabId, target.websiteOrigin) - if (promptForAccessesIfNeeded && ethereum !== undefined && tokenPriceService !== undefined && simulationServicesOwner !== undefined) { - await promptForWebsiteAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, throwOnError) + if (promptForAccessesIfNeeded && simulationServicesOwner !== undefined) { + await promptForWebsiteAccesses(simulationServicesOwner, websiteTabConnections, throwOnError) } try { for (const tabState of await getAllTabStates()) { @@ -452,8 +448,6 @@ export async function finishWebsiteAccessUpdate( } export async function updateWebsiteApprovalAccesses( - ethereum: EthereumClientService | undefined, - tokenPriceService: TokenPriceService | undefined, simulationServicesOwner: SimulationServicesOwner | undefined, websiteTabConnections: WebsiteTabConnections, settings: Settings, @@ -461,21 +455,17 @@ export async function updateWebsiteApprovalAccesses( throwOnError = false, ): Promise { const update = await reconcileWebsiteApprovalAccesses(websiteTabConnections, settings, throwOnError) - await finishWebsiteAccessUpdate(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, update, promptForAccessesIfNeeded, throwOnError) + await finishWebsiteAccessUpdate(simulationServicesOwner, websiteTabConnections, update, promptForAccessesIfNeeded, throwOnError) return update.popupRefreshGeneration } export async function finalizeWebsiteAccessChange( - ethereum: EthereumClientService | undefined, - tokenPriceService: TokenPriceService | undefined, simulationServicesOwner: SimulationServicesOwner | undefined, websiteTabConnections: WebsiteTabConnections, settings: Settings, promptForAccessesIfNeeded: boolean, ): Promise { await updateWebsiteApprovalAccesses( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, settings, @@ -486,8 +476,6 @@ export async function finalizeWebsiteAccessChange( } export async function persistWebsiteAccessChange( - ethereum: EthereumClientService | undefined, - tokenPriceService: TokenPriceService | undefined, simulationServicesOwner: SimulationServicesOwner | undefined, websiteTabConnections: WebsiteTabConnections, website: Website, @@ -497,8 +485,6 @@ export async function persistWebsiteAccessChange( ): Promise { await setAccess(website, access, address) return await finalizeWebsiteAccessChange( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), diff --git a/app/ts/background/activeSettings.ts b/app/ts/background/activeSettings.ts index aadff3e2f..be87299a8 100644 --- a/app/ts/background/activeSettings.ts +++ b/app/ts/background/activeSettings.ts @@ -139,8 +139,7 @@ async function runActiveSettingsChange( } finally { // Complete committed access updates after releasing the semaphore, even if a later reset or notification fails. if (accessUpdate !== undefined) { - const services = simulationServicesOwner.getCurrent() - await finishWebsiteAccessUpdate(services.ethereum, services.tokenPriceService, simulationServicesOwner, websiteTabConnections, accessUpdate, change.promptForAccessesIfNeeded ?? true) + await finishWebsiteAccessUpdate(simulationServicesOwner, websiteTabConnections, accessUpdate, change.promptForAccessesIfNeeded ?? true) } } } diff --git a/app/ts/background/background-startup.ts b/app/ts/background/background-startup.ts index 3ea6145fd..b7f453171 100644 --- a/app/ts/background/background-startup.ts +++ b/app/ts/background/background-startup.ts @@ -353,8 +353,6 @@ browser.runtime.onConnect.addListener((port) => catchAllErrorsAndCall(async () = browser.runtime.onMessage.addListener((message: unknown) => Promise.resolve(catchAllErrorsAndCall(async () => { const { simulationServicesOwner } = await waitForBackgroundStartup() const settings = await getSettings() - // A preceding popup RPC switch can replace services while settings are being read. - const simulationServices = getSimulationServices() - return await popupMessageHandler(websiteTabConnections, simulationServices.ethereum, simulationServices.tokenPriceService, simulationServicesOwner, message, settings, rpcConnectionStatusPublisher.publishRpcConnectionStatus) + return await popupMessageHandler(websiteTabConnections, simulationServicesOwner, message, settings, rpcConnectionStatusPublisher.publishRpcConnectionStatus) }))) addWindowTabListeners(onCloseWindow, onCloseTab) diff --git a/app/ts/background/background.ts b/app/ts/background/background.ts index 012d2ddae..f987f5d96 100644 --- a/app/ts/background/background.ts +++ b/app/ts/background/background.ts @@ -13,7 +13,6 @@ import { clearWebsiteConnectionIntent, finalizeWebsiteAccessChange, persistWebsi import { getActiveAddressEntryForChain, getWalletActiveAddressEntryForChain } from './metadataUtils.js' import { getActiveAddress } from './backgroundUtils.js' import { assertNever } from '../utils/typescript.js' -import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' import { JsonRpcResponseError, reportUnexpectedError, isFailedToFetchError } from '../utils/errors.js' import { InterceptedRequest, type WebsiteSocket } from '../utils/requests.js' import { replyToInterceptedRequest } from './messageSending.js' @@ -24,7 +23,6 @@ import { connectedToSigner, ethAccountsReply, signerChainChanged, signerReply, w import { makeSureInterceptorIsNotSleeping } from './sleeping.js' import type { PublishRpcConnectionStatus } from './rpcSlowRequestTracking.js' import { buildExecutionSimulationStateFromPreparedInput, getCurrentSimulationInput, getUpdatedSimulationStackSnapshot, prepareSimulationInputForRpc } from './simulationUpdating.js' -import type { TokenPriceService } from '../simulation/services/priceEstimator.js' import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import { getWalletSelectedAccount, isActiveSigningSafe } from '../utils/activeAddressSelection.js' import { isAccountConnectionMethod, isAccountOnlyMethod } from './accountRequestMethods.js' @@ -178,7 +176,7 @@ async function handleRPCRequest( eth_signTypedData_v2: rpcRequestHandler('eth_signTypedData_v2', async (_context, rpcRequest) => await signMessage(rpcRequest)), eth_signTypedData_v3: rpcRequestHandler('eth_signTypedData_v3', async (_context, rpcRequest) => await signMessage(rpcRequest)), eth_signTypedData_v4: rpcRequestHandler('eth_signTypedData_v4', async (_context, rpcRequest) => await signMessage(rpcRequest)), - wallet_switchEthereumChain: rpcRequestHandler('wallet_switchEthereumChain', async (_context, rpcRequest) => await switchEthereumChain(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, rpcRequest, request, settings.simulationMode, website)), + wallet_switchEthereumChain: rpcRequestHandler('wallet_switchEthereumChain', async (_context, rpcRequest) => await switchEthereumChain(simulationServicesOwner, websiteTabConnections, rpcRequest, request, settings.simulationMode, website)), wallet_watchAsset: rpcRequestHandler('wallet_watchAsset', async (_context, rpcRequest) => await handleWatchAssetRequest(ethereum, websiteTabConnections, request, website, rpcRequest, {}, activeAddress)), wallet_requestPermissions: rpcRequestHandler('wallet_requestPermissions', async () => await requestPermissions(activeAddress, website)), wallet_getPermissions: rpcRequestHandler('wallet_getPermissions', async () => await getPermissions(activeAddress, website)), @@ -292,8 +290,6 @@ function replayProviderStateForAccountRequest(websiteTabConnections: WebsiteTabC } async function persistApprovedAccountsForAccountRequest( - ethereum: EthereumClientService, - tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, request: InterceptedRequest, @@ -311,8 +307,6 @@ async function persistApprovedAccountsForAccountRequest( if (addressEntry.askForAddressAccess === false) continue if (existingApprovalState === 'hasAccess') continue await persistWebsiteAccessChange( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, website, @@ -324,8 +318,6 @@ async function persistApprovedAccountsForAccountRequest( } async function revokeWebsitePermissions( - ethereum: EthereumClientService, - tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, websiteOrigin: string, @@ -340,7 +332,7 @@ async function revokeWebsitePermissions( } })) clearWebsiteConnectionIntent(websiteTabConnections, websiteOrigin) - await finalizeWebsiteAccessChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), false) + await finalizeWebsiteAccessChange(simulationServicesOwner, websiteTabConnections, await getSettings(), false) return { type: 'result' as const, method: 'wallet_revokePermissions' as const, result: null } } @@ -407,8 +399,7 @@ export const handleInterceptedRequest = async (port: browser.runtime.Port | unde if (request.method === 'wallet_revokePermissions') { const parsedRequest = parseWalletRevokePermissionsRequest(websiteTabConnections, request) if (parsedRequest === undefined) return - const { ethereum, tokenPriceService } = simulationServicesOwner.getCurrent() - const result = await revokeWebsitePermissions(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, websiteOrigin) + const result = await revokeWebsitePermissions(simulationServicesOwner, websiteTabConnections, websiteOrigin) return replyToInterceptedRequest(websiteTabConnections, { ...getRequestWithDefinedParams(request), ...result }) } const initialActiveAddress = await getActiveAddressForRequest(initialSettings, websiteTabConnections, socket.tabId) @@ -423,8 +414,7 @@ export const handleInterceptedRequest = async (port: browser.runtime.Port | unde const providerCallbackActiveAddress = initialActiveAddress !== undefined && getWebsiteAddressAccessApprovalState(initialSettings.websiteAccess, websiteOrigin, initialActiveAddress) === 'hasAccess' ? initialActiveAddress.address : undefined - const { ethereum, tokenPriceService } = simulationServicesOwner.getCurrent() - const providerHandlerReturn = await providerHandler.func(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, port, request, providerCallbackApproval, providerCallbackActiveAddress) + const providerHandlerReturn = await providerHandler.func(simulationServicesOwner, websiteTabConnections, port, request, providerCallbackApproval, providerCallbackActiveAddress) if (providerHandlerReturn.type === 'doNotReply') return const message: InpageScriptRequest = { uniqueRequestIdentifier: request.uniqueRequestIdentifier, ...providerHandlerReturn } return replyToInterceptedRequest(websiteTabConnections, message) @@ -499,8 +489,7 @@ export const handleInterceptedRequest = async (port: browser.runtime.Port | unde case 'askAccess': { const website = await websitePromise const currentSettings = await getSettings() - const { ethereum, tokenPriceService } = simulationServicesOwner.getCurrent() - return await gateKeepRequestBehindAccessDialog(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, request, website, activeAddress, currentSettings, publishRpcConnectionStatus) + return await gateKeepRequestBehindAccessDialog(simulationServicesOwner, websiteTabConnections, socket, request, website, activeAddress, currentSettings, publishRpcConnectionStatus) } case 'noAccess': return refuseAccess(websiteTabConnections, request) case 'hasAccess': { @@ -530,11 +519,8 @@ async function handleContentScriptMessage(simulationServicesOwner: SimulationSer const simulationOverlayEnabled = settings.simulationMode || safeSigningMode const walletSelectedSafeSigner = safeSigningMode ? selectedWalletAccount : undefined const resolved = await handleRPCRequest(simulationServicesOwner, websiteTabConnections, request.uniqueRequestIdentifier.requestSocket, website, rpcContext, settings, activeAddress.address, publishRpcConnectionStatus, simulationOverlayEnabled, safeSigningMode, walletSelectedSafeSigner) - // Permission persistence is a subsequent stage and may follow a service reset during RPC execution. - const { ethereum, tokenPriceService } = simulationServicesOwner.getCurrent() + // Permission persistence carries the owner through any follow-up access prompts. await persistApprovedAccountsForAccountRequest( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, request, @@ -574,6 +560,6 @@ export function refuseAccess(websiteTabConnections: WebsiteTabConnections, reque }) } -async function gateKeepRequestBehindAccessDialog(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, request: InterceptedRequest, website: Website, activeAddress: AddressBookEntry | undefined, settings: Settings, publishRpcConnectionStatus: PublishRpcConnectionStatus) { - return await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, website, request, activeAddress, settings, activeAddress, publishRpcConnectionStatus) +async function gateKeepRequestBehindAccessDialog(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, request: InterceptedRequest, website: Website, activeAddress: AddressBookEntry | undefined, settings: Settings, publishRpcConnectionStatus: PublishRpcConnectionStatus) { + return await requestAccessFromUser(simulationServicesOwner, websiteTabConnections, socket, website, request, activeAddress, settings, activeAddress, publishRpcConnectionStatus) } diff --git a/app/ts/background/popupMessageDispatcher.ts b/app/ts/background/popupMessageDispatcher.ts index b7aebd0ab..cae26455b 100644 --- a/app/ts/background/popupMessageDispatcher.ts +++ b/app/ts/background/popupMessageDispatcher.ts @@ -15,43 +15,103 @@ import { websiteAccessPopupMessageHandlers } from './popupMessageHandlerRegistri export type { PopupMessageDispatcherContext } from './popupMessageHandlerRegistry.js' const popupMessageHandlers = { - popup_confirmDialog: popupMessageHandler('popup_confirmDialog', async (context, request) => await confirmDialog(context.ethereum, context.tokenPriceService, context.websiteTabConnections, request)), + popup_confirmDialog: popupMessageHandler('popup_confirmDialog', async (context, request) => { + const { ethereum, tokenPriceService } = context.simulationServicesOwner.getCurrent() + return await confirmDialog(ethereum, tokenPriceService, context.websiteTabConnections, request) + }), popup_changePage: popupMessageHandler('popup_changePage', async (_context, request) => await changePage(request)), popup_requestAccountsFromSigner: popupMessageHandler('popup_requestAccountsFromSigner', async (context, request) => await requestAccountsFromSigner(context.websiteTabConnections, request)), popup_resetSimulation: popupMessageHandler('popup_resetSimulation', async (context) => await context.resetSimulationState()), - popup_removeTransactionOrSignedMessage: popupMessageHandler('popup_removeTransactionOrSignedMessage', async (context, request) => await removeTransactionOrSignedMessage(context.ethereum, context.tokenPriceService, request)), + popup_removeTransactionOrSignedMessage: popupMessageHandler('popup_removeTransactionOrSignedMessage', async (context, request) => { + const { ethereum, tokenPriceService } = context.simulationServicesOwner.getCurrent() + return await removeTransactionOrSignedMessage(ethereum, tokenPriceService, request) + }), popup_refreshSimulation: popupMessageHandler('popup_refreshSimulation', async (context) => { - await queuePopupSimulationRefresh({ ...context, invalidateOldState: true }) + await queuePopupSimulationRefresh({ ...context.simulationServicesOwner.getCurrent(), invalidateOldState: true }) + }), + popup_refreshConfirmTransactionDialogSimulation: popupMessageHandler('popup_refreshConfirmTransactionDialogSimulation', async (context) => { + const { ethereum, tokenPriceService } = context.simulationServicesOwner.getCurrent() + return await refreshPopupConfirmTransactionSimulation(ethereum, tokenPriceService) }), - popup_refreshConfirmTransactionDialogSimulation: popupMessageHandler('popup_refreshConfirmTransactionDialogSimulation', async (context) => await refreshPopupConfirmTransactionSimulation(context.ethereum, context.tokenPriceService)), - popup_refreshConfirmTransactionMetadata: popupMessageHandler('popup_refreshConfirmTransactionMetadata', async (context) => await refreshPopupConfirmTransactionMetadata(context.ethereum, context.tokenPriceService, context.confirmTransactionAbortController)), - popup_changeChainDialog: popupMessageHandler('popup_changeChainDialog', async (context, request) => await changeChainDialog(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), + popup_refreshConfirmTransactionMetadata: popupMessageHandler('popup_refreshConfirmTransactionMetadata', async (context) => { + const { ethereum, tokenPriceService } = context.simulationServicesOwner.getCurrent() + return await refreshPopupConfirmTransactionMetadata(ethereum, tokenPriceService, context.confirmTransactionAbortController) + }), + popup_changeChainDialog: popupMessageHandler('popup_changeChainDialog', async (context, request) => await changeChainDialog(context.simulationServicesOwner, context.websiteTabConnections, request)), popup_watchAssetDialog: popupMessageHandler('popup_watchAssetDialog', async (context, request) => await watchAssetDialog(context.websiteTabConnections, request)), - popup_setSafeSimulationSigner: popupMessageHandler('popup_setSafeSimulationSigner', async (context, request) => await setSafeSimulationSigner(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), - popup_requestNewHomeData: popupMessageHandler('popup_requestNewHomeData', async (context, request) => await requestNewHomeData(context.ethereum, context.websiteTabConnections, request.data.refreshSignerAccounts, request.data.includeWebsiteAccessAddressMetadata, context.simulationAbortController, bumpPopupRefreshGeneration())), + popup_setSafeSimulationSigner: popupMessageHandler('popup_setSafeSimulationSigner', async (context, request) => await setSafeSimulationSigner(context.simulationServicesOwner, context.websiteTabConnections, request)), + popup_requestNewHomeData: popupMessageHandler('popup_requestNewHomeData', async (context, request) => { + const { ethereum } = context.simulationServicesOwner.getCurrent() + return await requestNewHomeData(ethereum, context.websiteTabConnections, request.data.refreshSignerAccounts, request.data.includeWebsiteAccessAddressMetadata, context.simulationAbortController, bumpPopupRefreshGeneration()) + }), popup_requestHomePageBootstrap: popupMessageHandler('popup_requestHomePageBootstrap', async (context) => await requestHomePageBootstrap(context.websiteTabConnections, bumpPopupRefreshGeneration())), - popup_refreshHomeData: popupMessageHandler('popup_refreshHomeData', async (context) => await refreshHomeData(context.ethereum, context.tokenPriceService, context.websiteTabConnections, true, bumpPopupRefreshGeneration(), context.publishRpcConnectionStatus)), - popup_simulateGovernanceContractExecution: popupMessageHandler('popup_simulateGovernanceContractExecution', async (context, request) => await simulateGovernanceContractExecutionOnPass(context.ethereum, context.tokenPriceService, request)), - popup_simulateGnosisSafeTransaction: popupMessageHandler('popup_simulateGnosisSafeTransaction', async (context, request) => await simulateGnosisSafeTransactionOnPass(context.ethereum, context.tokenPriceService, request.data.gnosisSafeMessage)), + popup_refreshHomeData: popupMessageHandler('popup_refreshHomeData', async (context) => { + const { ethereum, tokenPriceService } = context.simulationServicesOwner.getCurrent() + return await refreshHomeData(ethereum, tokenPriceService, context.websiteTabConnections, true, bumpPopupRefreshGeneration(), context.publishRpcConnectionStatus) + }), + popup_simulateGovernanceContractExecution: popupMessageHandler('popup_simulateGovernanceContractExecution', async (context, request) => { + const { ethereum, tokenPriceService } = context.simulationServicesOwner.getCurrent() + return await simulateGovernanceContractExecutionOnPass(ethereum, tokenPriceService, request) + }), + popup_simulateGnosisSafeTransaction: popupMessageHandler('popup_simulateGnosisSafeTransaction', async (context, request) => { + const { ethereum, tokenPriceService } = context.simulationServicesOwner.getCurrent() + return await simulateGnosisSafeTransactionOnPass(ethereum, tokenPriceService, request.data.gnosisSafeMessage) + }), popup_openWebPage: popupMessageHandler('popup_openWebPage', async (_context, request) => await openWebPage(request)), popup_clearUnexpectedError: popupMessageHandler('popup_clearUnexpectedError', async () => await setLatestUnexpectedError(undefined)), popup_openSimulationStack: popupMessageHandler('popup_openSimulationStack', async (_context, request) => await openNewTab('simulationStack', 'data' in request ? getSimulationStackTargetHash(request.data) : undefined)), - popup_forceSetGasLimitForTransaction: popupMessageHandler('popup_forceSetGasLimitForTransaction', async (context, request) => await forceSetGasLimitForTransaction(context.ethereum, context.tokenPriceService, request)), - popup_changePreSimulationBlockTimeManipulation: popupMessageHandler('popup_changePreSimulationBlockTimeManipulation', async (context, request) => await changePreSimulationBlockTimeManipulation(context.ethereum, context.tokenPriceService, request)), - popup_setTransactionOrMessageBlockTimeManipulator: popupMessageHandler('popup_setTransactionOrMessageBlockTimeManipulator', async (context, request) => await setTransactionOrMessageBlockTimeManipulator(context.ethereum, context.tokenPriceService, request)), - popup_requestMakeMeRichData: popupMessageHandler('popup_requestMakeMeRichData', async (context) => await requestMakeMeRichList(context.ethereum, context.simulationAbortController)), + popup_forceSetGasLimitForTransaction: popupMessageHandler('popup_forceSetGasLimitForTransaction', async (context, request) => { + const { ethereum, tokenPriceService } = context.simulationServicesOwner.getCurrent() + return await forceSetGasLimitForTransaction(ethereum, tokenPriceService, request) + }), + popup_changePreSimulationBlockTimeManipulation: popupMessageHandler('popup_changePreSimulationBlockTimeManipulation', async (context, request) => { + const { ethereum, tokenPriceService } = context.simulationServicesOwner.getCurrent() + return await changePreSimulationBlockTimeManipulation(ethereum, tokenPriceService, request) + }), + popup_setTransactionOrMessageBlockTimeManipulator: popupMessageHandler('popup_setTransactionOrMessageBlockTimeManipulator', async (context, request) => { + const { ethereum, tokenPriceService } = context.simulationServicesOwner.getCurrent() + return await setTransactionOrMessageBlockTimeManipulator(ethereum, tokenPriceService, request) + }), + popup_requestMakeMeRichData: popupMessageHandler('popup_requestMakeMeRichData', async (context) => { + const { ethereum } = context.simulationServicesOwner.getCurrent() + return await requestMakeMeRichList(ethereum, context.simulationAbortController) + }), popup_requestActiveAddresses: popupMessageHandler('popup_requestActiveAddresses', async () => await requestActiveAddresses()), popup_requestSimulationMode: popupMessageHandler('popup_requestSimulationMode', async () => await requestSimulationMode()), popup_requestLatestUnexpectedError: popupMessageHandler('popup_requestLatestUnexpectedError', async () => await requestLatestUnexpectedError()), - popup_fetchSimulationStackRequestConfirmation: popupMessageHandler('popup_fetchSimulationStackRequestConfirmation', async (context, request) => await fetchSimulationStackRequestConfirmation(context.ethereum, context.websiteTabConnections, request)), - popup_readyAndListening: popupMessageHandler('popup_readyAndListening', async (context, request) => await popupReadyAndListening(context.ethereum, context.websiteTabConnections, request.data.page)), + popup_fetchSimulationStackRequestConfirmation: popupMessageHandler('popup_fetchSimulationStackRequestConfirmation', async (context, request) => { + const { ethereum } = context.simulationServicesOwner.getCurrent() + return await fetchSimulationStackRequestConfirmation(ethereum, context.websiteTabConnections, request) + }), + popup_readyAndListening: popupMessageHandler('popup_readyAndListening', async (context, request) => { + const { ethereum } = context.simulationServicesOwner.getCurrent() + return await popupReadyAndListening(ethereum, context.websiteTabConnections, request.data.page) + }), popup_UnexpectedErrorOccured: popupMessageHandler('popup_UnexpectedErrorOccured', async (_context, request) => await reportUnexpectedErrorInWindow(request)), - popup_requestInterceptorSimulationInput: popupMessageHandler('popup_requestInterceptorSimulationInput', async (context) => await requestInterceptorSimulationInput(context.ethereum)), - popup_importSimulationStack: popupMessageHandler('popup_importSimulationStack', async (context, request) => await importSimulationStack(context.ethereum, context.tokenPriceService, request)), - popup_requestSafeStackExport: popupMessageHandler('popup_requestSafeStackExport', async (context) => await requestSafeStackExport(context.ethereum)), - popup_importSafeStack: popupMessageHandler('popup_importSafeStack', async (context, request) => await importSafeStack(context.ethereum, context.tokenPriceService, request)), - popup_requestCompleteVisualizedSimulation: popupMessageHandler('popup_requestCompleteVisualizedSimulation', async (context) => await requestCompleteVisualizedSimulation(context.ethereum, context.tokenPriceService)), - popup_requestSimulationMetadata: popupMessageHandler('popup_requestSimulationMetadata', async (context) => await requestSimulationMetadata(context.ethereum)), + popup_requestInterceptorSimulationInput: popupMessageHandler('popup_requestInterceptorSimulationInput', async (context) => { + const { ethereum } = context.simulationServicesOwner.getCurrent() + return await requestInterceptorSimulationInput(ethereum) + }), + popup_importSimulationStack: popupMessageHandler('popup_importSimulationStack', async (context, request) => { + const { ethereum, tokenPriceService } = context.simulationServicesOwner.getCurrent() + return await importSimulationStack(ethereum, tokenPriceService, request) + }), + popup_requestSafeStackExport: popupMessageHandler('popup_requestSafeStackExport', async (context) => { + const { ethereum } = context.simulationServicesOwner.getCurrent() + return await requestSafeStackExport(ethereum) + }), + popup_importSafeStack: popupMessageHandler('popup_importSafeStack', async (context, request) => { + const { ethereum, tokenPriceService } = context.simulationServicesOwner.getCurrent() + return await importSafeStack(ethereum, tokenPriceService, request) + }), + popup_requestCompleteVisualizedSimulation: popupMessageHandler('popup_requestCompleteVisualizedSimulation', async (context) => { + const { ethereum, tokenPriceService } = context.simulationServicesOwner.getCurrent() + return await requestCompleteVisualizedSimulation(ethereum, tokenPriceService) + }), + popup_requestSimulationMetadata: popupMessageHandler('popup_requestSimulationMetadata', async (context) => { + const { ethereum } = context.simulationServicesOwner.getCurrent() + return await requestSimulationMetadata(ethereum) + }), popup_isMainPopupWindowOpen: popupMessageHandler('popup_isMainPopupWindowOpen', async () => undefined), popup_isSimulationVisualizerOpen: popupMessageHandler('popup_isSimulationVisualizerOpen', async () => undefined), ...addressBookPopupMessageHandlers, diff --git a/app/ts/background/popupMessageHandlerRegistries/addressBook.ts b/app/ts/background/popupMessageHandlerRegistries/addressBook.ts index 6bb297789..53f92715b 100644 --- a/app/ts/background/popupMessageHandlerRegistries/addressBook.ts +++ b/app/ts/background/popupMessageHandlerRegistries/addressBook.ts @@ -2,12 +2,18 @@ import { popupMessageHandler, type PopupMessageHandlerMap } from '../popupMessag import { addOrModifyAddressBookEntry, changeAddOrModifyAddressWindowState, getAddressBookData, openNewTab, removeAddressBookEntry, requestAbiAndNameFromBlockExplorer, requestIdentifyAddress, setEnsNameForHash } from '../popupMessageHandlers.js' export const addressBookPopupMessageHandlers = { - popup_addOrModifyAddressBookEntry: popupMessageHandler('popup_addOrModifyAddressBookEntry', async (context, request) => await addOrModifyAddressBookEntry(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), + popup_addOrModifyAddressBookEntry: popupMessageHandler('popup_addOrModifyAddressBookEntry', async (context, request) => await addOrModifyAddressBookEntry(context.simulationServicesOwner, context.websiteTabConnections, request)), popup_getAddressBookData: popupMessageHandler('popup_getAddressBookData', async (_context, request) => await getAddressBookData(request)), - popup_removeAddressBookEntry: popupMessageHandler('popup_removeAddressBookEntry', async (context, request) => await removeAddressBookEntry(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), + popup_removeAddressBookEntry: popupMessageHandler('popup_removeAddressBookEntry', async (context, request) => await removeAddressBookEntry(context.simulationServicesOwner, context.websiteTabConnections, request)), popup_openAddressBook: popupMessageHandler('popup_openAddressBook', async () => await openNewTab('addressBook')), - popup_changeAddOrModifyAddressWindowState: popupMessageHandler('popup_changeAddOrModifyAddressWindowState', async (context, request) => await changeAddOrModifyAddressWindowState(context.ethereum, request)), + popup_changeAddOrModifyAddressWindowState: popupMessageHandler('popup_changeAddOrModifyAddressWindowState', async (context, request) => { + const { ethereum } = context.simulationServicesOwner.getCurrent() + return await changeAddOrModifyAddressWindowState(ethereum, request) + }), popup_requestAbiAndNameFromBlockExplorer: popupMessageHandler('popup_requestAbiAndNameFromBlockExplorer', async (_context, request) => await requestAbiAndNameFromBlockExplorer(request)), popup_setEnsNameForHash: popupMessageHandler('popup_setEnsNameForHash', async (_context, request) => await setEnsNameForHash(request)), - popup_requestIdentifyAddress: popupMessageHandler('popup_requestIdentifyAddress', async (context, request) => await requestIdentifyAddress(context.ethereum, request)), + popup_requestIdentifyAddress: popupMessageHandler('popup_requestIdentifyAddress', async (context, request) => { + const { ethereum } = context.simulationServicesOwner.getCurrent() + return await requestIdentifyAddress(ethereum, request) + }), } satisfies Partial diff --git a/app/ts/background/popupMessageHandlerRegistries/safe.ts b/app/ts/background/popupMessageHandlerRegistries/safe.ts index c152c9596..cfe79c1ac 100644 --- a/app/ts/background/popupMessageHandlerRegistries/safe.ts +++ b/app/ts/background/popupMessageHandlerRegistries/safe.ts @@ -2,5 +2,8 @@ import { requestSafeContractState } from '../safeContractState.js' import { popupMessageHandler, type PopupMessageHandlerMap } from '../popupMessageHandlerRegistry.js' export const safePopupMessageHandlers = { - popup_requestSafeContractState: popupMessageHandler('popup_requestSafeContractState', async (context, request) => await requestSafeContractState(context.ethereum, request)), + popup_requestSafeContractState: popupMessageHandler('popup_requestSafeContractState', async (context, request) => { + const { ethereum } = context.simulationServicesOwner.getCurrent() + return await requestSafeContractState(ethereum, request) + }), } satisfies Partial diff --git a/app/ts/background/popupMessageHandlerRegistries/settings.ts b/app/ts/background/popupMessageHandlerRegistries/settings.ts index fb1fc49ef..583e95450 100644 --- a/app/ts/background/popupMessageHandlerRegistries/settings.ts +++ b/app/ts/background/popupMessageHandlerRegistries/settings.ts @@ -6,14 +6,14 @@ import { getSettings } from '../settings.js' export const settingsPopupMessageHandlers = { popup_requestSettings: popupMessageHandler('popup_requestSettings', async () => await settingsOpened()), - popup_ChangeSettings: popupMessageHandler('popup_ChangeSettings', async (context, request) => await changeSettings(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, request, context.simulationAbortController)), + popup_ChangeSettings: popupMessageHandler('popup_ChangeSettings', async (context, request) => await changeSettings(context.simulationServicesOwner, request, context.simulationAbortController)), popup_openSettings: popupMessageHandler('popup_openSettings', async () => await openNewTab('settingsView')), popup_import_settings: popupMessageHandler('popup_import_settings', async (context, request) => { const importSettingsReply = await importSettings(request) await sendPopupMessageToOpenWindows(importSettingsReply) if (!importSettingsReply.data.success) return const importedSettings = await getSettings() - const popupRefreshGeneration = await updateWebsiteApprovalAccesses(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, importedSettings, true) + const popupRefreshGeneration = await updateWebsiteApprovalAccesses(context.simulationServicesOwner, context.websiteTabConnections, importedSettings, true) await sendPopupMessageToOpenWindows({ method: 'popup_settingsUpdated', data: importedSettings, popupRefreshGeneration }) }), popup_get_export_settings: popupMessageHandler('popup_get_export_settings', async () => await exportSettings()), diff --git a/app/ts/background/popupMessageHandlerRegistries/websiteAccess.ts b/app/ts/background/popupMessageHandlerRegistries/websiteAccess.ts index c37b6440f..ec8de6b68 100644 --- a/app/ts/background/popupMessageHandlerRegistries/websiteAccess.ts +++ b/app/ts/background/popupMessageHandlerRegistries/websiteAccess.ts @@ -3,16 +3,16 @@ import { popupMessageHandler, type PopupMessageHandlerMap } from '../popupMessag import { allowOrPreventAddressAccessForWebsite, blockOrAllowExternalRequests, changeInterceptorAccess, confirmRequestAccess, disableInterceptor, interceptorAccessChangeAddressOrRefresh, openNewTab, removeWebsiteAccess, removeWebsiteAddressAccess, retrieveWebsiteAccess } from '../popupMessageHandlers.js' export const websiteAccessPopupMessageHandlers = { - popup_interceptorAccess: popupMessageHandler('popup_interceptorAccess', async (context, request) => await confirmRequestAccess(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request, context.publishRpcConnectionStatus)), - popup_changeInterceptorAccess: popupMessageHandler('popup_changeInterceptorAccess', async (context, request) => await changeInterceptorAccess(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), + popup_interceptorAccess: popupMessageHandler('popup_interceptorAccess', async (context, request) => await confirmRequestAccess(context.simulationServicesOwner, context.websiteTabConnections, request, context.publishRpcConnectionStatus)), + popup_changeInterceptorAccess: popupMessageHandler('popup_changeInterceptorAccess', async (context, request) => await changeInterceptorAccess(context.simulationServicesOwner, context.websiteTabConnections, request)), popup_refreshInterceptorAccessMetadata: popupMessageHandler('popup_refreshInterceptorAccessMetadata', async () => await interceptorAccessMetadataRefresh()), popup_interceptorAccessChangeAddress: popupMessageHandler('popup_interceptorAccessChangeAddress', async (context, request) => await interceptorAccessChangeAddressOrRefresh(context.websiteTabConnections, request)), popup_interceptorAccessRefresh: popupMessageHandler('popup_interceptorAccessRefresh', async (context, request) => await interceptorAccessChangeAddressOrRefresh(context.websiteTabConnections, request)), - popup_setDisableInterceptor: popupMessageHandler('popup_setDisableInterceptor', async (context, request) => await disableInterceptor(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), + popup_setDisableInterceptor: popupMessageHandler('popup_setDisableInterceptor', async (context, request) => await disableInterceptor(context.simulationServicesOwner, context.websiteTabConnections, request)), popup_openWebsiteAccess: popupMessageHandler('popup_openWebsiteAccess', async () => await openNewTab('websiteAccess')), popup_retrieveWebsiteAccess: popupMessageHandler('popup_retrieveWebsiteAccess', async (_context, request) => await retrieveWebsiteAccess(request)), - popup_blockOrAllowExternalRequests: popupMessageHandler('popup_blockOrAllowExternalRequests', async (context, request) => await blockOrAllowExternalRequests(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), + popup_blockOrAllowExternalRequests: popupMessageHandler('popup_blockOrAllowExternalRequests', async (context, request) => await blockOrAllowExternalRequests(context.simulationServicesOwner, context.websiteTabConnections, request)), popup_allowOrPreventAddressAccessForWebsite: popupMessageHandler('popup_allowOrPreventAddressAccessForWebsite', async (context, request) => await allowOrPreventAddressAccessForWebsite(context.websiteTabConnections, request)), - popup_removeWebsiteAccess: popupMessageHandler('popup_removeWebsiteAccess', async (context, request) => await removeWebsiteAccess(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), - popup_removeWebsiteAddressAccess: popupMessageHandler('popup_removeWebsiteAddressAccess', async (context, request) => await removeWebsiteAddressAccess(context.ethereum, context.tokenPriceService, context.simulationServicesOwner, context.websiteTabConnections, request)), + popup_removeWebsiteAccess: popupMessageHandler('popup_removeWebsiteAccess', async (context, request) => await removeWebsiteAccess(context.simulationServicesOwner, context.websiteTabConnections, request)), + popup_removeWebsiteAddressAccess: popupMessageHandler('popup_removeWebsiteAddressAccess', async (context, request) => await removeWebsiteAddressAccess(context.simulationServicesOwner, context.websiteTabConnections, request)), } satisfies Partial diff --git a/app/ts/background/popupMessageHandlerRegistry.ts b/app/ts/background/popupMessageHandlerRegistry.ts index 5aabae867..3d024c1e6 100644 --- a/app/ts/background/popupMessageHandlerRegistry.ts +++ b/app/ts/background/popupMessageHandlerRegistry.ts @@ -1,5 +1,3 @@ -import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' -import type { TokenPriceService } from '../simulation/services/priceEstimator.js' import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import type { PopupMessage, Settings } from '../types/interceptor-messages.js' import type { PopupReplyOption } from '../types/interceptor-reply-messages.js' @@ -9,8 +7,6 @@ import type { PublishRpcConnectionStatus } from './rpcSlowRequestTracking.js' export type PopupMessageDispatcherContext = { websiteTabConnections: WebsiteTabConnections - ethereum: EthereumClientService - tokenPriceService: TokenPriceService simulationServicesOwner: SimulationServicesOwner settings: Settings publishRpcConnectionStatus: PublishRpcConnectionStatus diff --git a/app/ts/background/popupMessageHandlers.ts b/app/ts/background/popupMessageHandlers.ts index 2764c5801..03094df18 100644 --- a/app/ts/background/popupMessageHandlers.ts +++ b/app/ts/background/popupMessageHandlers.ts @@ -129,8 +129,8 @@ export async function confirmDialog(ethereum: EthereumClientService, tokenPriceS await resolvePendingTransactionOrMessage(ethereum, tokenPriceService, websiteTabConnections, confirmation, refreshedSafeSignerSelection) } -export async function confirmRequestAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, confirmation: InterceptorAccess, publishRpcConnectionStatus: PublishRpcConnectionStatus) { - await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, confirmation.data, publishRpcConnectionStatus) +export async function confirmRequestAccess(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, confirmation: InterceptorAccess, publishRpcConnectionStatus: PublishRpcConnectionStatus) { + await resolveInterceptorAccess(simulationServicesOwner, websiteTabConnections, confirmation.data, publishRpcConnectionStatus) } export async function popupReadyAndListening(ethereum: EthereumClientService, websiteTabConnections: WebsiteTabConnections, page: PopupReadyAndListeningPage) { @@ -274,18 +274,19 @@ export async function modifyMakeMeRich(makeMeRichChange: ModifyMakeMeRich) { )) } -export async function removeAddressBookEntry(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, removeAddressBookEntry: RemoveAddressBookEntry) { +export async function removeAddressBookEntry(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, removeAddressBookEntry: RemoveAddressBookEntry) { await updateUserAddressBookEntries((previousContacts) => previousContacts.filter((contact) => !(contact.address === removeAddressBookEntry.data.address && (contact.chainId === removeAddressBookEntry.data.chainId || (contact.chainId === undefined && removeAddressBookEntry.data.chainId === 1n)))) ) if (removeAddressBookEntry.data.addressBookCategory === 'My Active Addresses' || removeAddressBookEntry.data.addressBookCategory === 'My Safes') { - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(simulationServicesOwner, websiteTabConnections, await getSettings(), true) } await sendPopupMessageToOpenWindows({ method: 'popup_addressBookEntriesChanged' }) } -export async function addOrModifyAddressBookEntry(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, entry: AddOrEditAddressBookEntry) { +export async function addOrModifyAddressBookEntry(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, entry: AddOrEditAddressBookEntry) { + const { ethereum } = simulationServicesOwner.getCurrent() try { let entryToStore: AddressBookEntry = entry.data if (entry.data.type === 'safe') { @@ -327,7 +328,7 @@ export async function addOrModifyAddressBookEntry(ethereum: EthereumClientServic } return previousContacts.concat([entryToStore]) }) - if (entryToStore.useAsActiveAddress) await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true, true) + if (entryToStore.useAsActiveAddress) await updateWebsiteApprovalAccesses(simulationServicesOwner, websiteTabConnections, await getSettings(), true, true) void sendPopupMessageToOpenWindows({ method: 'popup_addressBookEntriesChanged' }) return { type: 'AddOrModifyAddressBookEntryReply' as const, ok: true as const } } catch(error) { @@ -345,12 +346,11 @@ export async function addOrModifyAddressBookEntry(ethereum: EthereumClientServic } export async function setSafeSimulationSigner( - ethereum: EthereumClientService, - tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, request: SetSafeSimulationSigner, ) { + const { ethereum } = simulationServicesOwner.getCurrent() if (request.data.chainId !== ethereum.getChainId()) { return { type: 'SetSafeSimulationSignerReply' as const, @@ -406,13 +406,13 @@ export async function setSafeSimulationSigner( } } if (updatedEntry.useAsActiveAddress) { - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(simulationServicesOwner, websiteTabConnections, await getSettings(), true) } await sendPopupMessageToOpenWindows({ method: 'popup_addressBookEntriesChanged' }) return { type: 'SetSafeSimulationSignerReply' as const, ok: true as const } } -export async function changeInterceptorAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, accessChange: ChangeInterceptorAccess) { +export async function changeInterceptorAccess(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, accessChange: ChangeInterceptorAccess) { await updateWebsiteAccess((previousAccess) => { const withEntriesRemoved = previousAccess.filter((acc) => accessChange.data.find((change) => change.newEntry.website.websiteOrigin === acc.website.websiteOrigin)?.removed !== true) return withEntriesRemoved.map((entry) => { @@ -428,7 +428,7 @@ export async function changeInterceptorAccess(ethereum: EthereumClientService, t return await disableInterceptorForPage(websiteTabConnections, disable.newEntry.website, disable.newEntry.interceptorDisabled) })) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(simulationServicesOwner, websiteTabConnections, await getSettings(), true) await sendPopupMessageToOpenWindows({ method: 'popup_interceptor_access_changed' }) } @@ -670,8 +670,8 @@ export async function popupChangeActiveRpc(simulationServicesOwner: SimulationSe return { type: 'PopupSettingsChangeReply', ok: true } as const } -export async function changeChainDialog(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, chainChange: ChainChangeConfirmation) { - await resolveChainChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, chainChange) +export async function changeChainDialog(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, chainChange: ChainChangeConfirmation) { + await resolveChainChange(simulationServicesOwner, websiteTabConnections, chainChange) } export async function enableSimulationMode( @@ -868,13 +868,13 @@ export async function interceptorAccessChangeAddressOrRefresh(websiteTabConnecti await requestAddressChange(websiteTabConnections, params) } -export async function changeSettings(ethereum: EthereumClientService, _tokenPriceService: TokenPriceService, _simulationServicesOwner: SimulationServicesOwner, parsedRequest: ChangeSettings, requestAbortController: AbortController | undefined) { +export async function changeSettings(simulationServicesOwner: SimulationServicesOwner, parsedRequest: ChangeSettings, requestAbortController: AbortController | undefined) { if (parsedRequest.data.useTabsInsteadOfPopup !== undefined) await setUseTabsInsteadOfPopup(parsedRequest.data.useTabsInsteadOfPopup) if (parsedRequest.data.metamaskCompatibilityMode !== undefined) await setMetamaskCompatibilityMode(parsedRequest.data.metamaskCompatibilityMode) if (parsedRequest.data.safeAppsCompatibilityMode !== undefined) { await setSafeAppsCompatibilityMode(parsedRequest.data.safeAppsCompatibilityMode) } - return await requestNewHomeData(ethereum, new Map(), false, true, requestAbortController, bumpPopupRefreshGeneration()) + return await requestNewHomeData(simulationServicesOwner.getCurrent().ethereum, new Map(), false, true, requestAbortController, bumpPopupRefreshGeneration()) } export async function simulateGovernanceContractExecutionOnPass(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, request: SimulateGovernanceContractExecution) { diff --git a/app/ts/background/popupMessageHandlers/websiteAccess.ts b/app/ts/background/popupMessageHandlers/websiteAccess.ts index 97a095163..92db34a09 100644 --- a/app/ts/background/popupMessageHandlers/websiteAccess.ts +++ b/app/ts/background/popupMessageHandlers/websiteAccess.ts @@ -1,5 +1,3 @@ -import type { EthereumClientService } from '../../simulation/services/EthereumClientService.js' -import type { TokenPriceService } from '../../simulation/services/priceEstimator.js' import type { SimulationServicesOwner } from '../../simulation/serviceLifecycle.js' import type { AllowOrPreventAddressAccessForWebsite, BlockOrAllowExternalRequests, DisableInterceptor, RemoveWebsiteAccess, RemoveWebsiteAddressAccess, RetrieveWebsiteAccess } from '../../types/interceptor-messages.js' import type { EthereumAddress } from '../../types/wire-types.js' @@ -43,9 +41,9 @@ export const disableInterceptorForPage = async (websiteTabConnections: WebsiteTa await reloadConnectedTabs(websiteTabConnections) } -export async function disableInterceptor(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, parsedRequest: DisableInterceptor) { +export async function disableInterceptor(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, parsedRequest: DisableInterceptor) { await disableInterceptorForPage(websiteTabConnections, parsedRequest.data.website, parsedRequest.data.interceptorDisabled) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(simulationServicesOwner, websiteTabConnections, await getSettings(), true) await sendPopupMessageToOpenWindows({ method: 'popup_setDisableInterceptorReply' as const, data: parsedRequest.data }) } @@ -64,9 +62,9 @@ const blockOrAllowWebsiteExternalRequests = async (websiteTabConnections: Websit await reloadConnectedTabs(websiteTabConnections) } -export async function blockOrAllowExternalRequests(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, parsedRequest: BlockOrAllowExternalRequests) { +export async function blockOrAllowExternalRequests(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, parsedRequest: BlockOrAllowExternalRequests) { await blockOrAllowWebsiteExternalRequests(websiteTabConnections, parsedRequest.data.website, parsedRequest.data.shouldBlock) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(simulationServicesOwner, websiteTabConnections, await getSettings(), true) await sendPopupMessageToOpenWindows({ method: 'popup_websiteAccess_changed' }) } @@ -77,10 +75,10 @@ const removeAddressAccessByAddress = async (websiteOrigin: string, address: Ethe })) } -export async function removeWebsiteAddressAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, parsedRequest: RemoveWebsiteAddressAccess) { +export async function removeWebsiteAddressAccess(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, parsedRequest: RemoveWebsiteAddressAccess) { await removeAddressAccessByAddress(parsedRequest.data.websiteOrigin, parsedRequest.data.address) await reloadConnectedTabs(websiteTabConnections) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(simulationServicesOwner, websiteTabConnections, await getSettings(), true) await sendPopupMessageToOpenWindows({ method: 'popup_websiteAccess_changed' }) } @@ -99,8 +97,8 @@ export async function allowOrPreventAddressAccessForWebsite(websiteTabConnection await sendPopupMessageToOpenWindows({ method: 'popup_websiteAccess_changed' }) } -export async function removeWebsiteAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, parsedRequest: RemoveWebsiteAccess) { +export async function removeWebsiteAccess(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, parsedRequest: RemoveWebsiteAccess) { await updateWebsiteAccess((previousAccess) => previousAccess.filter((access) => access.website.websiteOrigin !== parsedRequest.data.websiteOrigin)) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(simulationServicesOwner, websiteTabConnections, await getSettings(), true) await sendPopupMessageToOpenWindows({ method: 'popup_websiteAccess_changed' }) } diff --git a/app/ts/background/popupMessageRouting.ts b/app/ts/background/popupMessageRouting.ts index 6a2694a11..851e32372 100644 --- a/app/ts/background/popupMessageRouting.ts +++ b/app/ts/background/popupMessageRouting.ts @@ -1,8 +1,6 @@ import { PopupMessage, type Settings } from '../types/interceptor-messages.js' import { PopupReplyOption } from '../types/interceptor-reply-messages.js' import type { WebsiteTabConnections } from '../types/user-interface-types.js' -import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' -import type { TokenPriceService } from '../simulation/services/priceEstimator.js' import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import { METAMASK_ERROR_FAILED_TO_PARSE_REQUEST } from '../utils/constants.js' import { isExpectedInfrastructureError } from '../utils/errors.js' @@ -15,8 +13,6 @@ const simulationAbortController = new AbortController() export async function popupMessageHandler( websiteTabConnections: WebsiteTabConnections, - ethereum: EthereumClientService, - tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, request: unknown, settings: Settings, @@ -36,8 +32,6 @@ export async function popupMessageHandler( try { const requestReply = await dispatchPopupMessage({ websiteTabConnections, - ethereum, - tokenPriceService, simulationServicesOwner, settings, publishRpcConnectionStatus, diff --git a/app/ts/background/providerMessageHandlers.ts b/app/ts/background/providerMessageHandlers.ts index ef4c8ded9..f7a70c438 100644 --- a/app/ts/background/providerMessageHandlers.ts +++ b/app/ts/background/providerMessageHandlers.ts @@ -16,8 +16,6 @@ import { refreshPendingSafeSignerSelectionErrors, resolvePendingTransactionOrMes import { resolveWatchAssetSignerReply } from './windows/watchAsset.js' import { modifyObject } from '../utils/typescript.js' import { sendSubscriptionReplyOrCallBackToPort } from './messageSending.js' -import type { EthereumClientService } from '../simulation/services/EthereumClientService.js' -import type { TokenPriceService } from '../simulation/services/priceEstimator.js' import type { SimulationServicesOwner } from '../simulation/serviceLifecycle.js' import { isSignerMissing } from '../utils/signerMetadata.js' import { beginSignerStateConfirmation, clearSignerDerivedTabState, confirmSignerState, doesSignerStateTokenMatchIdentity, getConfirmedSignerStateToken, isCurrentWebsiteConnection, isSignerStateTokenCurrent, runSignerStateOperation, signerConnectionReplacedError, tabHasApprovedWebsiteConnection, type SignerStateToken } from './signerStateOwnership.js' @@ -62,7 +60,7 @@ function hasSignerCallbackAccess(websiteTabConnections: WebsiteTabConnections, t return approval === 'hasAccess' || tabHasApprovedWebsiteConnection(websiteTabConnections, tabId) } -export async function ethAccountsReply(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, _activeAddress: bigint | undefined) { +export async function ethAccountsReply(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, _activeAddress: bigint | undefined) { const returnValue = { type: 'result' as const, method: 'eth_accounts_reply' as const, result: '0x' as const } if (!('params' in request)) return returnValue if (port.sender?.tab?.id === undefined) return returnValue @@ -108,6 +106,7 @@ export async function ethAccountsReply(ethereum: EthereumClientService, tokenPri activeSigningAddress, })) if (!isSignerStateTokenCurrent(websiteTabConnections, signerStateToken)) return returnValue + const { ethereum, tokenPriceService } = simulationServicesOwner.getCurrent() await refreshPendingSafeSignerSelectionErrors(ethereum, tokenPriceService, tabId) // Restore this wallet account's most recent EOA-or-Safe selection. This remains inside the signer-state operation so a reconnect cannot interleave with downstream address and chain mutations. const settings = await getSettings() @@ -182,7 +181,7 @@ async function changeSignerChain(simulationServicesOwner: SimulationServicesOwne if (oldSignerChain !== signerChain) sendPopupMessageToOpenWindows({ method: 'popup_chain_update' }) } -export async function signerChainChanged(_ethereum: EthereumClientService, _tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, _activeAddress: bigint | undefined) { +export async function signerChainChanged(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, _activeAddress: bigint | undefined) { const returnValue = { type: 'result' as const, method: 'signer_chainChanged' as const, result: '0x' as const } if (!('params' in request)) return returnValue const [signerChain, signerProviderGeneration] = EthereumChainReply.parse(request.params) @@ -197,7 +196,7 @@ export async function signerChainChanged(_ethereum: EthereumClientService, _toke }) } -export async function walletSwitchEthereumChainReply(_ethereum: EthereumClientService, _tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, _approval: ApprovalState, _activeAddress: bigint | undefined) { +export async function walletSwitchEthereumChainReply(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, _approval: ApprovalState, _activeAddress: bigint | undefined) { const returnValue = { type: 'result' as const, method: 'wallet_switchEthereumChain_reply' as const, result: '0x' as const } const params = WalletSwitchEthereumChainReply.parse(request).params[0] await applyWalletSwitchReply(websiteTabConnections, port, params, async (token, chainId, rpc) => { @@ -206,7 +205,7 @@ export async function walletSwitchEthereumChainReply(_ethereum: EthereumClientSe return returnValue } -export async function connectedToSigner(_ethereum: EthereumClientService, _tokenPriceService: TokenPriceService, _simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, activeAddress: bigint | undefined) { +export async function connectedToSigner(_simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, approval: ApprovalState, activeAddress: bigint | undefined) { const [signerConnected, signerName, signerProviderGeneration] = ConnectedToSigner.parse(request).params const isTopFrame = isTopFramePort(port) const socket = getSocketFromPort(port) @@ -275,13 +274,14 @@ export async function connectedToSigner(_ethereum: EthereumClientService, _token return result } -export async function signerReply(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, _simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, _approval: ApprovalState, _activeAddress: bigint | undefined) { +export async function signerReply(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, port: browser.runtime.Port, request: ProviderMessage, _approval: ApprovalState, _activeAddress: bigint | undefined) { const signerReply = SignerReply.parse(request) const params = signerReply.params[0] const doNotReply = { type: 'doNotReply' as const } const socket = getSocketFromPort(port) if (socket === undefined) return doNotReply return await runSignerStateOperation(websiteTabConnections, socket.tabId, async () => { + const { ethereum, tokenPriceService } = simulationServicesOwner.getCurrent() if (params.forwardRequest.method === 'wallet_watchAsset') { const context = WatchAssetSignerRequest.parse(params.forwardRequest.params) if (context.uniqueRequestIdentifier.requestSocket.tabId !== socket.tabId || context.signerIdentity.tabId !== socket.tabId) return doNotReply diff --git a/app/ts/background/simulationModeHandlers.ts b/app/ts/background/simulationModeHandlers.ts index 1aaa470a2..dae72e2da 100644 --- a/app/ts/background/simulationModeHandlers.ts +++ b/app/ts/background/simulationModeHandlers.ts @@ -136,12 +136,12 @@ export async function personalSign( return { method: confirmation.parameters.method, ...action } } -export async function switchEthereumChain(ethereumClientService: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, params: SwitchEthereumChainParams, request: InterceptedRequest, simulationMode: boolean, website: Website) { - if (ethereumClientService.getChainId() === params.params[0].chainId) { +export async function switchEthereumChain(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, params: SwitchEthereumChainParams, request: InterceptedRequest, simulationMode: boolean, website: Website) { + if (simulationServicesOwner.getCurrent().ethereum.getChainId() === params.params[0].chainId) { // we are already on the right chain return { type: 'result' as const, method: params.method, result: null } } - const change = await openChangeChainDialog(ethereumClientService, tokenPriceService, simulationServicesOwner, websiteTabConnections, request, simulationMode, website, params) + const change = await openChangeChainDialog(simulationServicesOwner, websiteTabConnections, request, simulationMode, website, params) return { type: 'result' as const, method: params.method, ...change } } diff --git a/app/ts/background/windows/changeChain.ts b/app/ts/background/windows/changeChain.ts index 567d8efde..fe4c56f53 100644 --- a/app/ts/background/windows/changeChain.ts +++ b/app/ts/background/windows/changeChain.ts @@ -10,8 +10,6 @@ import { type InterceptedRequest, type UniqueRequestIdentifier, doesUniqueReques import { replyToInterceptedRequest } from '../messageSending.js' import type { SwitchEthereumChainParams } from '../../types/JsonRpc-types.js' import type { PopupOrTabId, Website } from '../../types/websiteAccessTypes.js' -import type { EthereumClientService } from '../../simulation/services/EthereumClientService.js' -import type { TokenPriceService } from '../../simulation/services/priceEstimator.js' import type { SimulationServicesOwner } from '../../simulation/serviceLifecycle.js' import { type PopupOrTab, addWindowTabListeners, closePopupOrTabById, getPopupOrTabById, openPopupOrTab, removeWindowTabListeners } from '../../utils/popupOrTab.js' @@ -27,7 +25,7 @@ export async function updateChainChangeViewWithPendingRequest() { return } -export async function resolveChainChange(_ethereum: EthereumClientService, _tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, confirmation: ChainChangeConfirmation) { +export async function resolveChainChange(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, confirmation: ChainChangeConfirmation) { if (pendForUserReply !== undefined) { pendForUserReply.resolve(confirmation) return @@ -75,8 +73,6 @@ const userDeniedChange = { } as const export const openChangeChainDialog = async ( - ethereum: EthereumClientService, - tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, request: InterceptedRequest, @@ -92,7 +88,7 @@ export const openChangeChainDialog = async ( if (openedDialog === undefined || openedDialog.id !== popupOrTab.id || openedDialog.type !== popupOrTab.type) return openedDialog = undefined if (pendForUserReply === undefined) return - resolveChainChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, rejectMessage(await getRpcNetworkForChain(params.params[0].chainId), request.uniqueRequestIdentifier)) + resolveChainChange(simulationServicesOwner, websiteTabConnections, rejectMessage(await getRpcNetworkForChain(params.params[0].chainId), request.uniqueRequestIdentifier)) } const onCloseWindow = async (id: number) => onCloseWindowOrTab({ type: 'popup' as const, id }) const onCloseTab = async (id: number) => onCloseWindowOrTab({ type: 'tab' as const, id }) @@ -122,8 +118,6 @@ export const openChangeChainDialog = async ( await updateChainChangeViewWithPendingRequest() } else { await resolveChainChange( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, rejectMessage(await getRpcNetworkForChain(params.params[0].chainId), request.uniqueRequestIdentifier), diff --git a/app/ts/background/windows/interceptorAccess.ts b/app/ts/background/windows/interceptorAccess.ts index 4d9c50579..4f9a1bbaa 100644 --- a/app/ts/background/windows/interceptorAccess.ts +++ b/app/ts/background/windows/interceptorAccess.ts @@ -15,8 +15,6 @@ import { replyToInterceptedRequest, sendSubscriptionReplyOrCallBackToPort } from import type { PopupOrTabId, Website, WebsiteAccessArray } from '../../types/websiteAccessTypes.js' import type { PendingAccessRequest } from '../../types/accessRequest.js' import { doAddressBookChainIdsMatch, type AddressBookEntries, type AddressBookEntry } from '../../types/addressBookTypes.js' -import type { EthereumClientService } from '../../simulation/services/EthereumClientService.js' -import type { TokenPriceService } from '../../simulation/services/priceEstimator.js' import type { SimulationServicesOwner } from '../../simulation/serviceLifecycle.js' import type { PublishRpcConnectionStatus } from '../rpcSlowRequestTracking.js' import { type PopupOrTab, addWindowTabListeners, closePopupOrTabById, getPopupOrTabById, openPopupOrTab, removeWindowTabListeners, tryFocusingTabOrWindow } from '../../utils/popupOrTab.js' @@ -66,7 +64,7 @@ async function waitForSignerAccountReply(future: Future await pendingInterceptorAccessSemaphore.execute(async () => { // check if user has closed the window on their own, if so, reject signature +const onCloseWindowOrTab = async (simulationServicesOwner: SimulationServicesOwner, popupOrTabs: PopupOrTabId, websiteTabConnections: WebsiteTabConnections) => await pendingInterceptorAccessSemaphore.execute(async () => { // check if user has closed the window on their own, if so, reject signature if (openedDialog === undefined || openedDialog.popupOrTab.id !== popupOrTabs.id || openedDialog.popupOrTab.type !== popupOrTabs.type) return removeWindowTabListeners(openedDialog.onClosePopup, openedDialog.onCloseTab) @@ -80,8 +78,6 @@ const onCloseWindowOrTab = async (ethereum: EthereumClientService, tokenPriceSer userReply: 'noResponse' as const } await resolve( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, reply, @@ -93,7 +89,7 @@ const onCloseWindowOrTab = async (ethereum: EthereumClientService, tokenPriceSer } }) -export async function resolveInterceptorAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, reply: InterceptorAccessReply, publishRpcConnectionStatus: PublishRpcConnectionStatus) { +export async function resolveInterceptorAccess(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, reply: InterceptorAccessReply, publishRpcConnectionStatus: PublishRpcConnectionStatus) { const resolution = await pendingInterceptorAccessSemaphore.execute(async () => { const promises = await getPendingAccessRequests() const pendingRequest = promises.find((req) => req.accessRequestId === reply.accessRequestId) @@ -105,8 +101,6 @@ export async function resolveInterceptorAccess(ethereum: EthereumClientService, } return { ...await resolve( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, replyWithPendingRequestAddresses, @@ -122,8 +116,6 @@ export async function resolveInterceptorAccess(ethereum: EthereumClientService, }) if (resolution.promptForFollowUpAccesses) { await updateWebsiteApprovalAccesses( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), @@ -175,11 +167,9 @@ async function withCurrentSignerStates(pendingAccessRequests: readonly PendingAc return await Promise.all(pendingAccessRequests.map(withCurrentSignerState)) } -async function changeAccess(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, confirmation: InterceptorAccessReply, website: Website, promptForAccessesIfNeeded = true) { +async function changeAccess(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, confirmation: InterceptorAccessReply, website: Website, promptForAccessesIfNeeded = true) { if (confirmation.userReply === 'noResponse') return await persistWebsiteAccessChange( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, website, @@ -277,8 +267,6 @@ export async function refreshSignerAccountsForTab( } export async function requestAccessFromUser( - ethereum: EthereumClientService, - tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, @@ -290,8 +278,6 @@ export async function requestAccessFromUser( publishRpcConnectionStatus: PublishRpcConnectionStatus, ): Promise export async function requestAccessFromUser( - ethereum: EthereumClientService, - tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, @@ -303,8 +289,6 @@ export async function requestAccessFromUser( publishRpcConnectionStatus: undefined, ): Promise export async function requestAccessFromUser( - ethereum: EthereumClientService, - tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, socket: WebsiteSocket, @@ -331,7 +315,7 @@ export async function requestAccessFromUser( if (request === undefined || !isAccountConnectionMethod(request.method)) return verify() return withSuppressedUnscopedConnectionEventsForSocket(request.uniqueRequestIdentifier.requestSocket, verify) } - const closeWindowOrTabCallback = (popupOrTabId: PopupOrTabId) => onCloseWindowOrTab(ethereum, tokenPriceService, simulationServicesOwner, popupOrTabId, websiteTabConnections) + const closeWindowOrTabCallback = (popupOrTabId: PopupOrTabId) => onCloseWindowOrTab(simulationServicesOwner, popupOrTabId, websiteTabConnections) const onCloseWindowCallback = async (id: number) => closeWindowOrTabCallback({ type: 'popup' as const, id }) const onCloseTabCallback = async (id: number) => closeWindowOrTabCallback({ type: 'tab' as const, id }) const pendingReplay = await pendingInterceptorAccessSemaphore.execute(async () => { @@ -464,7 +448,7 @@ export async function requestAccessFromUser( ) } -async function resolve(ethereum: EthereumClientService, tokenPriceService: TokenPriceService, simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, accessReply: InterceptorAccessReply, request: InterceptedRequest | undefined, website: Website, publishRpcConnectionStatus: PublishRpcConnectionStatus | undefined, pendingAccessRequest: PendingAccessRequest) { +async function resolve(simulationServicesOwner: SimulationServicesOwner, websiteTabConnections: WebsiteTabConnections, accessReply: InterceptorAccessReply, request: InterceptedRequest | undefined, website: Website, publishRpcConnectionStatus: PublishRpcConnectionStatus | undefined, pendingAccessRequest: PendingAccessRequest) { let promptForFollowUpAccesses = false if (accessReply.userReply === 'noResponse') { if (request !== undefined) refuseAccess(websiteTabConnections, request) @@ -487,11 +471,11 @@ async function resolve(ethereum: EthereumClientService, tokenPriceService: Token approvedAddressSelection = await getAllowedAddressSelectionForAccessRequest(pendingAccessRequest, accessReply.requestAccessToAddress, 'pendingEntry') } if (!userRequestedAddressChange) { - await changeAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, accessReply, website, false) + await changeAccess(simulationServicesOwner, websiteTabConnections, accessReply, website, false) return } if (accessReply.requestAccessToAddress === undefined) throw new Error('Changed request to page level') - await changeAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, accessReply, website, false) + await changeAccess(simulationServicesOwner, websiteTabConnections, accessReply, website, false) const settings = await getSettings() const signerAddress = (await getTabState(pendingAccessRequest.socket.tabId)).signerAccounts[0] const selection = approvedAddressSelection ?? await getAllowedAddressSelectionForAccessRequest(pendingAccessRequest, accessReply.requestAccessToAddress, 'pendingEntry') diff --git a/docs/popup-simulation-refresh.md b/docs/popup-simulation-refresh.md index 0b917bbf5..f5512e220 100644 --- a/docs/popup-simulation-refresh.md +++ b/docs/popup-simulation-refresh.md @@ -25,4 +25,6 @@ External-wallet signing transitions do not enqueue simulation refreshes: wallet Active settings commands receive `SimulationServicesOwner`, not a service pair captured before waiting for the transition semaphore. They read `getCurrent()` when preparing the refresh, so a preceding endpoint reset supplies the installed services. Both popup and dapp RPC requests enter `changeActiveRpc` in `walletSwitch.ts`, which owns routing, shared Safe network restrictions, local promotion, and correlated wallet dispatch. -The intercepted-request pipeline also carries only the service owner. Provider callbacks and access admission obtain services when their work starts. RPC execution captures one pair after admission and uses it for both lazy simulation preparation and RPC handling; permission persistence begins a subsequent stage with the then-current pair. An in-flight RPC does not switch providers halfway through execution. +The intercepted-request pipeline also carries only the service owner. Provider callbacks obtain services when their work starts. Access admission, dialog callbacks, resolution, and permission persistence carry only the owner across user waits; replayed requests select the current services after approval. RPC execution captures one pair after admission and uses it for both lazy simulation preparation and RPC handling; permission persistence carries the owner into any subsequent prompts. An in-flight RPC does not switch providers halfway through execution. + +`PopupMessageDispatcherContext` carries the owner without a service snapshot. Leaf popup handlers select a pair when invoked; handlers that can open or resolve prompts pass the owner instead. diff --git a/test/tests/activeSettingsConcurrency.test.ts b/test/tests/activeSettingsConcurrency.test.ts index 5d17b6d40..8232c3eb5 100644 --- a/test/tests/activeSettingsConcurrency.test.ts +++ b/test/tests/activeSettingsConcurrency.test.ts @@ -201,7 +201,7 @@ describe('active settings concurrency', () => { [websiteSocketToString(socket)]: { port, socket, websiteOrigin, approved: false, wantsToConnect: true }, } }]]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, connections, socket, { websiteOrigin }, undefined, originalAddress, await getSettings(), originalAddress, undefined) + await requestAccessFromUser(simulationServicesOwner, connections, socket, { websiteOrigin }, undefined, originalAddress, await getSettings(), originalAddress, undefined) const pending = (await getPendingAccessRequests())[0] if (pending === undefined) throw new Error('Missing pending access request') @@ -222,7 +222,7 @@ describe('active settings concurrency', () => { return result }, }) - const approval = resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, connections, { + const approval = resolveInterceptorAccess(simulationServicesOwner, connections, { userReply: 'Approved', accessRequestId: pending.accessRequestId, originalRequestAccessToAddress: originalAddress.address, @@ -275,7 +275,7 @@ describe('active settings concurrency', () => { } assert.equal((await getSettings()).activeSimulationAddress, selectedAddress.address) assert.equal((await getLatestUnexpectedError())?.data.message, 'Access popup failed to open') - await assert.rejects(updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, connections, await getSettings(), true, true), /Access popup failed to open/u) + await assert.rejects(updateWebsiteApprovalAccesses(simulationServicesOwner, connections, await getSettings(), true, true), /Access popup failed to open/u) }) test.each([1, 2])('continues prompting after a failure when the next connection is in tab %j', async (secondTabId) => { @@ -311,7 +311,7 @@ describe('active settings concurrency', () => { } finally { // Close the successful prompt so the shared dialog state cannot leak into another test. for (const request of pending) { - await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, connections, { + await resolveInterceptorAccess(simulationServicesOwner, connections, { userReply: 'noResponse', accessRequestId: request.accessRequestId, originalRequestAccessToAddress: selectedAddress.address, requestAccessToAddress: selectedAddress.address, }, noopPublishRpcConnectionStatus) @@ -396,17 +396,17 @@ describe('active settings concurrency', () => { if (completion === 'staged') { const update = await reconcileWebsiteApprovalAccesses(connections, snapshot) await changeSimulationMode({ simulationMode: true, activeSimulationAddress: selectedAddress.address }) - await finishWebsiteAccessUpdate(ethereum, tokenPriceService, simulationServicesOwner, connections, update, true) + await finishWebsiteAccessUpdate(simulationServicesOwner, connections, update, true) } else { await changeSimulationMode({ simulationMode: true, activeSimulationAddress: selectedAddress.address }) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, connections, snapshot, true) + await updateWebsiteApprovalAccesses(simulationServicesOwner, connections, snapshot, true) } const pending = await getPendingAccessRequests() try { expect(pending.map((request) => request.requestAccessToAddress?.address)).toEqual([selectedAddress.address]) } finally { for (const request of pending) { - await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, connections, { + await resolveInterceptorAccess(simulationServicesOwner, connections, { userReply: 'noResponse', accessRequestId: request.accessRequestId, originalRequestAccessToAddress: selectedAddress.address, requestAccessToAddress: selectedAddress.address, }, noopPublishRpcConnectionStatus) @@ -450,7 +450,7 @@ describe('active settings concurrency', () => { expect((await getTabState(1)).tabIconDetails).toEqual({ icon: ICON_NOT_ACTIVE, iconReason: 'example.test has PENDING access request for Second address!' }) } finally { for (const request of pending) { - await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, connections, { + await resolveInterceptorAccess(simulationServicesOwner, connections, { userReply: 'noResponse', accessRequestId: request.accessRequestId, originalRequestAccessToAddress: selectedAddress.address, requestAccessToAddress: selectedAddress.address, }, noopPublishRpcConnectionStatus) diff --git a/test/tests/backgroundAccountPermissions.test.ts b/test/tests/backgroundAccountPermissions.test.ts index fc190526c..41fef1808 100644 --- a/test/tests/backgroundAccountPermissions.test.ts +++ b/test/tests/backgroundAccountPermissions.test.ts @@ -117,7 +117,7 @@ describe('background eth_accounts', () => { const { runtimeMessages } = installBrowserMock() const { updateWebsiteApprovalAccesses, getSettings } = await loadModules() const connections = Object.assign(new Map(), { lifecycle: { accessReconciled: () => { throw new Error('Observer failed') } } }) - assert.equal(typeof await updateWebsiteApprovalAccesses(undefined, undefined, undefined, connections, await getSettings(), false, true), 'number') + assert.equal(typeof await updateWebsiteApprovalAccesses(undefined, connections, await getSettings(), false, true), 'number') await new Promise((resolve) => setTimeout(resolve, 0)) assert.equal(runtimeMessages.some((message) => typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_UnexpectedErrorOccured'), true) }) @@ -130,7 +130,7 @@ describe('background eth_accounts', () => { await releaseCallback.promise throw new Error('Async observer failed') } } }) - assert.equal(typeof await updateWebsiteApprovalAccesses(undefined, undefined, undefined, connections, await getSettings(), false, true), 'number') + assert.equal(typeof await updateWebsiteApprovalAccesses(undefined, connections, await getSettings(), false, true), 'number') releaseCallback.resolve(undefined) await new Promise((resolve) => setTimeout(resolve, 0)) assert.equal(runtimeMessages.some((message) => typeof message === 'object' && message !== null && 'method' in message && message.method === 'popup_UnexpectedErrorOccured'), true) @@ -143,11 +143,11 @@ describe('background eth_accounts', () => { const first = Object.assign(new Map(), { lifecycle: { accessReconciled: () => { calls.push('first') } } }) const second = Object.assign(new Map(), { lifecycle: { accessReconciled: () => { calls.push('second') } } }) const settings = await getSettings() - await updateWebsiteApprovalAccesses(undefined, undefined, undefined, first, settings, false, true) + await updateWebsiteApprovalAccesses(undefined, first, settings, false, true) assert.deepEqual(calls, ['first']) - await updateWebsiteApprovalAccesses(undefined, undefined, undefined, new Map(), settings, false, true) + await updateWebsiteApprovalAccesses(undefined, new Map(), settings, false, true) assert.deepEqual(calls, ['first']) - await updateWebsiteApprovalAccesses(undefined, undefined, undefined, second, settings, false, true) + await updateWebsiteApprovalAccesses(undefined, second, settings, false, true) assert.deepEqual(calls, ['first', 'second']) }) @@ -474,7 +474,7 @@ describe('background eth_accounts', () => { assert.deepEqual((await getPendingAccessRequests())[0]?.requestAccessToAddress, selfOwnedSafe) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, new Map(), { + await resolveInterceptorAccess(simulationServicesOwner, new Map(), { userReply: 'Approved', requestAccessToAddress: address, originalRequestAccessToAddress: address, @@ -739,7 +739,7 @@ describe('background eth_accounts', () => { accessRequestId: 'safe-owner-changed-before-approval', }]) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - const approve = async () => await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, new Map(), { + const approve = async () => await resolveInterceptorAccess(simulationServicesOwner, new Map(), { userReply: 'Approved', requestAccessToAddress: safeAddress, originalRequestAccessToAddress: safeAddress, @@ -997,7 +997,7 @@ describe('background eth_accounts', () => { assert.equal(childConnection.approved, false) assert.equal(childResult?.metamaskCompatibilityMode, false) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, childConnections, await getSettings(), false) + await updateWebsiteApprovalAccesses(simulationServicesOwner, childConnections, await getSettings(), false) await waitForPortMessageCount(childMessages, 'safe_apps_compatibility', 1) assert.equal(childConnection.approved, true) assert.equal(childMessages.filter((message) => message.method === 'safe_apps_compatibility').every((message) => message.result?.enabled === false), true) @@ -1050,7 +1050,7 @@ describe('background eth_accounts', () => { assert.equal(messages.filter((message) => message.method === 'safe_apps_compatibility').every((message) => message.result?.enabled === false), true) await updateWebsiteAccess(() => [{ website, access: true, addressAccess: [{ address: account, access: true }] }]) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), false) + await updateWebsiteApprovalAccesses(simulationServicesOwner, websiteTabConnections, await getSettings(), false) assert.equal(messages.filter((message) => message.method === 'safe_apps_compatibility').every((message) => message.result?.enabled === false), true) await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { ...connectedRequest, @@ -1346,7 +1346,7 @@ describe('background eth_accounts', () => { assert.deepEqual(pendingRequest.signerAccounts, [account]) assert.deepEqual((await getSettings()).websiteAccess[0]?.addressAccess, undefined) - await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { + await resolveInterceptorAccess(simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', requestAccessToAddress: account, originalRequestAccessToAddress: account, @@ -1458,7 +1458,7 @@ describe('background eth_accounts', () => { assert.deepEqual(messages.filter((message) => message.method === 'eth_accounts' && message.requestId === 23), []) assert.equal((await getSettings()).websiteAccess[0]?.addressAccess, undefined) - await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { + await resolveInterceptorAccess(simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', requestAccessToAddress: account, originalRequestAccessToAddress: account, @@ -1574,7 +1574,7 @@ describe('background eth_accounts', () => { assert.equal(pendingRequest.requestAccessToAddress?.address, account) assert.notEqual(pendingRequest.requestAccessToAddress?.type, 'safe') - await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { + await resolveInterceptorAccess(simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', requestAccessToAddress: account, originalRequestAccessToAddress: account, @@ -1625,8 +1625,6 @@ describe('background eth_accounts', () => { const settings = await getSettings() await firstWorkerAccess.requestAccessFromUser( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, @@ -1638,8 +1636,6 @@ describe('background eth_accounts', () => { noopPublishRpcConnectionStatus, ) await restartedWorkerAccess.requestAccessFromUser( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, @@ -1656,8 +1652,6 @@ describe('background eth_accounts', () => { const pendingRequest = (await getPendingAccessRequests())[0] if (pendingRequest === undefined) throw new Error('Missing pending request after worker restart') await restartedWorkerAccess.resolveInterceptorAccess( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, { @@ -2067,7 +2061,7 @@ describe('background eth_accounts', () => { assert.deepEqual(messages.filter((message) => message.method === 'eth_accounts' && message.requestId === 18), []) assert.deepEqual(siblingMessages.filter((message) => message.method === 'connect' || message.method === 'accountsChanged' || message.method === 'chainChanged'), []) - await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { + await resolveInterceptorAccess(simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', requestAccessToAddress: account, originalRequestAccessToAddress: account, @@ -2129,8 +2123,6 @@ describe('background eth_accounts', () => { const pendingRequest = (await getPendingAccessRequests())[0] if (pendingRequest === undefined) throw new Error('Missing pending request') const siteApprovalResolution = resolveInterceptorAccess( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, { @@ -2190,8 +2182,6 @@ describe('background eth_accounts', () => { const pendingRequest = (await getPendingAccessRequests())[0] if (pendingRequest === undefined) throw new Error('Missing pending request') const siteApprovalResolution = resolveInterceptorAccess( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, { @@ -2261,7 +2251,7 @@ describe('background eth_accounts', () => { assert.deepEqual(messages.filter((message) => message.method === 'accountsChanged'), []) assert.deepEqual(messages.filter((message) => message.method === 'wallet_requestPermissions' && message.requestId === 24), []) - await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { + await resolveInterceptorAccess(simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', requestAccessToAddress: account, originalRequestAccessToAddress: account, @@ -2373,8 +2363,6 @@ describe('background eth_accounts', () => { if (siteLevelPendingRequest === undefined) throw new Error('Missing combined site and address access request') assert.equal(siteLevelPendingRequest.requestAccessToAddress?.address, account) const siteApprovalResolution = resolveInterceptorAccess( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, { @@ -2454,8 +2442,6 @@ describe('background eth_accounts', () => { await Promise.race([ requestAccessFromUser( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, @@ -2476,7 +2462,7 @@ describe('background eth_accounts', () => { if (pendingRequest === undefined) throw new Error('Missing address access request') assert.equal(pendingRequest.requestAccessToAddress?.address, account) - await resolveInterceptorAccess(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { + await resolveInterceptorAccess(simulationServicesOwner, websiteTabConnections, { userReply: 'Approved', requestAccessToAddress: account, originalRequestAccessToAddress: account, @@ -2649,8 +2635,6 @@ describe('background eth_accounts', () => { if (pendingRequest === undefined) throw new Error('Missing address access request') assert.equal(pendingRequest.requestAccessToAddress?.address, nextAccount) await resolveInterceptorAccess( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, { @@ -2813,7 +2797,7 @@ describe('background eth_accounts', () => { assert.equal(websiteTabConnections.get(socket.tabId)?.connections[connectionKey]?.approved, false) assert.equal(websiteTabConnections.get(socket.tabId)?.connections[connectionKey]?.wantsToConnect, false) - await updateWebsiteApprovalAccesses(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, await getSettings(), true) + await updateWebsiteApprovalAccesses(simulationServicesOwner, websiteTabConnections, await getSettings(), true) assert.equal((await getPendingAccessRequests()).length, 0) await handleInterceptedRequest(port, websiteOrigin, website, simulationServicesOwner, socket, { diff --git a/test/tests/backgroundProviderRouting.test.ts b/test/tests/backgroundProviderRouting.test.ts index e017c1466..22fd6f1da 100644 --- a/test/tests/backgroundProviderRouting.test.ts +++ b/test/tests/backgroundProviderRouting.test.ts @@ -5,6 +5,41 @@ import { MessageToPopup } from '../../app/ts/types/interceptor-messages.js' import { createDeferredValue, createTestSimulationServicesOwner, addressString, confirmedSignerOwnership, createEthereumWithGetBlockCounter, createPort, createSafeTx, EthereumJsonRpcRequest, installBrowserMock, loadModules, noopPublishRpcConnectionStatus, safeTxToTypedDataJson, } from './backgroundEthAccountsTestHarness.js' describe('background eth_accounts', () => { + test('resolves an access prompt with the services installed after it opened', async () => { + installBrowserMock() + const { requestAccessFromUser, resolveInterceptorAccess, getPendingAccessRequests, getSettings, websiteSocketToString, changeSimulationMode, setUseSignersAddressAsActiveAddress } = await loadModules() + const { getActiveAddressEntryForChain } = await import('../../app/ts/background/metadataUtils.js') + const website = { websiteOrigin: 'https://access-reset.example', icon: undefined, title: undefined } + const account = 1n + await setUseSignersAddressAsActiveAddress(false) + await changeSimulationMode({ simulationMode: true, activeSimulationAddress: account }) + const socket = { tabId: 1, connectionName: 0n } + const { port, messages } = createPort(1) + const connections = new Map([[1, { ...confirmedSignerOwnership(socket), connections: { + [websiteSocketToString(socket)]: { port, socket, websiteOrigin: website.websiteOrigin, approved: false, wantsToConnect: true }, + } }]]) + const original = createEthereumWithGetBlockCounter({ count: 0 }) + const installed = createEthereumWithGetBlockCounter({ count: 0 }) + let oldReads = 0 + let newReads = 0 + original.ethereum.getChainId = () => { oldReads++; return 1n } + installed.ethereum.getChainId = () => { newReads++; return 1n } + const owner = createTestSimulationServicesOwner(original, () => installed) + const address = await getActiveAddressEntryForChain(account, 1n) + await requestAccessFromUser(owner, connections, socket, website, { + interceptorRequest: true, usingInterceptorWithoutSigner: true, + uniqueRequestIdentifier: { requestId: 992, requestSocket: socket }, method: 'eth_chainId', params: [], + }, address, await getSettings(), address, noopPublishRpcConnectionStatus) + const pending = (await getPendingAccessRequests())[0] + assert.ok(pending !== undefined) + owner.reset(installed.ethereum.getRpcEntry()) + await resolveInterceptorAccess(owner, connections, { userReply: 'Approved', requestAccessToAddress: account, originalRequestAccessToAddress: account, accessRequestId: pending.accessRequestId }, noopPublishRpcConnectionStatus) + assert.equal(oldReads, 0) + assert.ok(newReads > 0) + assert.equal(messages.find(message => message.requestId === 992)?.result, '0x1') + assert.equal((await getPendingAccessRequests()).length, 0) + }) + test('uses installed services after waiting for website metadata', async () => { installBrowserMock() const { handleInterceptedRequest, websiteSocketToString, updateWebsiteAccess, changeSimulationMode, setUseSignersAddressAsActiveAddress } = await loadModules() diff --git a/test/tests/backgroundSignerLifecycle.test.ts b/test/tests/backgroundSignerLifecycle.test.ts index 189d24bf7..3b2df8d7b 100644 --- a/test/tests/backgroundSignerLifecycle.test.ts +++ b/test/tests/backgroundSignerLifecycle.test.ts @@ -398,7 +398,7 @@ describe('background eth_accounts', () => { simulationMode: false, }) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - const resolution = resolveChainChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { + const resolution = resolveChainChange(simulationServicesOwner, websiteTabConnections, { method: 'popup_changeChainDialog', data: { rpcNetwork: requestedRpcNetwork, uniqueRequestIdentifier, accept: true }, }) @@ -470,7 +470,7 @@ describe('background eth_accounts', () => { simulationMode: false, }) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - const resolution = resolveChainChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { + const resolution = resolveChainChange(simulationServicesOwner, websiteTabConnections, { method: 'popup_changeChainDialog', data: { rpcNetwork: requestedRpcNetwork, uniqueRequestIdentifier, accept: true }, }) @@ -566,7 +566,7 @@ describe('background eth_accounts', () => { }) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) let requestSettled = false - const resolution = resolveChainChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { + const resolution = resolveChainChange(simulationServicesOwner, websiteTabConnections, { method: 'popup_changeChainDialog', data: { rpcNetwork: requestedRpcNetwork, uniqueRequestIdentifier, accept: true }, }).then(() => { requestSettled = true }) @@ -669,8 +669,6 @@ describe('background eth_accounts', () => { await changeSimulationMode({ simulationMode: false, rpcNetwork: currentRpcNetwork, activeSimulationAddress: undefined, activeSigningAddress: undefined }) const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const firstResolution = openChangeChainDialog( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, firstRequest, @@ -685,7 +683,7 @@ describe('background eth_accounts', () => { pendingChainChange = await getChainChangeConfirmationPromise() } if (pendingChainChange === undefined) throw new Error('Missing production chain-change dialog state') - await resolveChainChange(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, { + await resolveChainChange(simulationServicesOwner, websiteTabConnections, { method: 'popup_changeChainDialog', data: { rpcNetwork: requestedRpcNetwork, uniqueRequestIdentifier: firstUniqueRequestIdentifier, accept: true }, }) @@ -697,8 +695,6 @@ describe('background eth_accounts', () => { const secondResolution = await Promise.race([ openChangeChainDialog( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, secondRequest, diff --git a/test/tests/backgroundUtilsMessaging.test.ts b/test/tests/backgroundUtilsMessaging.test.ts index e00e4238d..eb22038ee 100644 --- a/test/tests/backgroundUtilsMessaging.test.ts +++ b/test/tests/backgroundUtilsMessaging.test.ts @@ -208,8 +208,6 @@ describe('backgroundUtils messaging', () => { const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const reply = await popupMessageHandler( new Map(), - ethereum, - tokenPriceService, simulationServicesOwner, { method: 'popup_requestCompleteVisualizedSimulation' }, { @@ -247,8 +245,6 @@ describe('backgroundUtils messaging', () => { const tokenPriceService: import('../../app/ts/simulation/services/priceEstimator.js').TokenPriceService = Object.create(TokenPriceService.prototype) const reply = await withSilencedConsole(async () => await popupMessageHandler( new Map(), - ethereum, - tokenPriceService, createTestSimulationServicesOwner({ ethereum, tokenPriceService }), { method: 'not_a_popup_method' }, { diff --git a/test/tests/extensionIconDeduping.test.ts b/test/tests/extensionIconDeduping.test.ts index 6846bf49e..d5e09d484 100644 --- a/test/tests/extensionIconDeduping.test.ts +++ b/test/tests/extensionIconDeduping.test.ts @@ -230,8 +230,6 @@ describe('extension icon deduping', () => { ]) await updateWebsiteApprovalAccesses( - undefined, - undefined, undefined, websiteTabConnections, await getSettings(), @@ -259,8 +257,6 @@ describe('extension icon deduping', () => { })) await updateWebsiteApprovalAccesses( - undefined, - undefined, undefined, new Map(), await getSettings(), @@ -316,8 +312,6 @@ describe('extension icon deduping', () => { const importSettingsReply = await importSettings({ method: 'popup_import_settings', data: { fileContents: importedSettingsReply } }) assert.equal(importSettingsReply.data.success, true) await updateWebsiteApprovalAccesses( - undefined, - undefined, undefined, new Map(), await getSettings(), diff --git a/test/tests/interceptorAccessCloseRace.test.ts b/test/tests/interceptorAccessCloseRace.test.ts index ad183649c..33caf58a3 100644 --- a/test/tests/interceptorAccessCloseRace.test.ts +++ b/test/tests/interceptorAccessCloseRace.test.ts @@ -179,7 +179,7 @@ describe('interceptor access close handling', () => { const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) const { getActiveAddressEntryForChain } = await import('../../app/ts/background/metadataUtils.js') - await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, website, request, undefined, await getSettings(), await getActiveAddressEntryForChain(account, 1n), async () => undefined) + await requestAccessFromUser(simulationServicesOwner, websiteTabConnections, socket, website, request, undefined, await getSettings(), await getActiveAddressEntryForChain(account, 1n), async () => undefined) const postedMessages = browserMock.postedMessages as Array<{ method?: string, result?: unknown, requestId?: number }> const providerRequestMessages = postedMessages @@ -217,7 +217,7 @@ describe('interceptor access close handling', () => { } const { ethereum, tokenPriceService, simulationServicesOwner } = createEthereumWithGetBlockCounter({ count: 0 }) - await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, website, undefined, undefined, settings, undefined, undefined) + await requestAccessFromUser(simulationServicesOwner, websiteTabConnections, socket, website, undefined, undefined, settings, undefined, undefined) const request: InterceptedRequest = { interceptorRequest: true, @@ -229,8 +229,6 @@ describe('interceptor access close handling', () => { let concurrentRequest: Promise | undefined browserMock.onPendingAccessClear(() => { concurrentRequest = requestAccessFromUser( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, @@ -290,7 +288,7 @@ describe('interceptor access close handling', () => { method: 'eth_accounts', } - await requestAccessFromUser(ethereum, tokenPriceService, simulationServicesOwner, websiteTabConnections, socket, website, request, undefined, settings, undefined, async () => undefined) + await requestAccessFromUser(simulationServicesOwner, websiteTabConnections, socket, website, request, undefined, settings, undefined, async () => undefined) let closeAccessDialog: Promise | undefined browserMock.onPendingAccessRead(() => { @@ -298,8 +296,6 @@ describe('interceptor access close handling', () => { }) await resolveInterceptorAccess( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, { originalRequestAccessToAddress: undefined, requestAccessToAddress: undefined, accessRequestId: 'undefined || https://example.test', userReply: 'Approved' }, @@ -374,8 +370,6 @@ describe('interceptor access close handling', () => { } await requestAccessFromUser( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, firstSocket, @@ -391,8 +385,6 @@ describe('interceptor access close handling', () => { await Promise.race([ resolveInterceptorAccess( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, { @@ -409,8 +401,6 @@ describe('interceptor access close handling', () => { const followUpRequest = (await getPendingAccessRequests()).find((request) => request.website.websiteOrigin === secondWebsite.websiteOrigin) if (followUpRequest === undefined) throw new Error('Missing follow-up access request') await resolveInterceptorAccess( - ethereum, - tokenPriceService, simulationServicesOwner, websiteTabConnections, { @@ -451,7 +441,7 @@ describe('interceptor access close handling', () => { } await setUseTabsInsteadOfPopup(true) try { - await requestAccessFromUser({} as never, {} as never, (() => undefined) as never, websiteTabConnections, socket, website, undefined, undefined, settings, undefined, undefined) + await requestAccessFromUser((() => undefined) as never, websiteTabConnections, socket, website, undefined, undefined, settings, undefined, undefined) const pendingRequests = await getPendingAccessRequests() assert.equal(pendingRequests.length, 1) assert.equal(pendingRequests[0]?.popupOrTabId.type, 'tab') diff --git a/test/tests/popupClearReset.test.ts b/test/tests/popupClearReset.test.ts index 8eb460e4f..0394d39e2 100644 --- a/test/tests/popupClearReset.test.ts +++ b/test/tests/popupClearReset.test.ts @@ -745,9 +745,7 @@ describe('popup clear reset', () => { const modules = await modulesPromise const reply = await modules.popupMessageHandler( new Map(), - fakeEthereum, - fakeTokenPriceService, - (() => undefined) as never, + createTestSimulationServicesOwner({ ethereum: fakeEthereum, tokenPriceService: fakeTokenPriceService }), { method: 'popup_requestCompleteVisualizedSimulation' }, await modules.getSettings(), async () => undefined, diff --git a/test/tests/popupMessageDispatcher.test.ts b/test/tests/popupMessageDispatcher.test.ts index 92792e1f4..50566e031 100644 --- a/test/tests/popupMessageDispatcher.test.ts +++ b/test/tests/popupMessageDispatcher.test.ts @@ -119,8 +119,6 @@ function createDispatcherContext(resetSimulationState: () => Promise): Pop const tokenPriceService: TokenPriceService = Object.create(TokenPriceServiceConstructor.prototype) return { websiteTabConnections: new Map(), - ethereum, - tokenPriceService, simulationServicesOwner: createTestSimulationServicesOwner({ ethereum, tokenPriceService }, () => ({ ethereum, tokenPriceService })), settings, publishRpcConnectionStatus: async () => undefined, @@ -278,7 +276,7 @@ describe('popup message dispatcher seams', () => { test('does not identify an address using a different active chain', async () => { const context = createDispatcherContext(async () => undefined) - Object.defineProperty(context.ethereum, 'getChainId', { value: () => 1n }) + Object.defineProperty(context.simulationServicesOwner.getCurrent().ethereum, 'getChainId', { value: () => 1n }) assert.deepEqual(await dispatchPopupMessage(context, { method: 'popup_requestIdentifyAddress', diff --git a/test/tests/popupSettingsChanges.test.ts b/test/tests/popupSettingsChanges.test.ts index 7c341a665..10c6b73b3 100644 --- a/test/tests/popupSettingsChanges.test.ts +++ b/test/tests/popupSettingsChanges.test.ts @@ -354,10 +354,10 @@ describe('popup settings changes', () => { await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 1) assert.deepEqual(await getRpcList(), originalRpcList) if (outcome === 'metadata after chain event') { - await signerChainChanged(ethereum, tokenPriceService, simulationServicesOwner, connections, port, { method: 'signer_chainChanged', params: ['0x2', 1] }, 'hasAccess', 1n) + await signerChainChanged(simulationServicesOwner, connections, port, { method: 'signer_chainChanged', params: ['0x2', 1] }, 'hasAccess', 1n) assert.deepEqual((await getSettings()).activeRpcNetwork, primaryRpc) } - await walletSwitchEthereumChainReply(ethereum, tokenPriceService, simulationServicesOwner, connections, port, { + await walletSwitchEthereumChainReply(simulationServicesOwner, connections, port, { method: 'wallet_switchEthereumChain_reply', params: outcome !== 'reject' ? [{ accept: true, chainId: '0x2', walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: 1 }] : [{ accept: false, chainId: '0x2', walletSwitchRequestId: getWalletSwitchRequestId(messages), error: { code: 4001, message: 'Rejected' }, signerProviderGeneration: 1 }], }, 'hasAccess', 1n) @@ -490,7 +490,7 @@ describe('popup settings changes', () => { const originalSet = browser.storage.local.set try { Object.defineProperty(browser.storage.local, 'set', { configurable: true, value: async () => { throw new Error('Storage write failed') } }) - await assert.rejects(walletSwitchEthereumChainReply(services.ethereum, services.tokenPriceService, services.simulationServicesOwner, connections, port, { + await assert.rejects(walletSwitchEthereumChainReply(services.simulationServicesOwner, connections, port, { method: 'wallet_switchEthereumChain_reply', params: [{ accept: true, chainId: '0x2', walletSwitchRequestId: getWalletSwitchRequestId(messages), signerProviderGeneration: token.signerProviderGeneration }], interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, }, 'hasAccess', undefined), /Storage write failed/) @@ -515,13 +515,13 @@ describe('popup settings changes', () => { request: { method: 'wallet_switchEthereumChain', params: [{ chainId: 2n }], interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier }, }) let completed = false - const dappSwitch = resolveChainChange(services.ethereum, services.tokenPriceService, services.simulationServicesOwner, connections, { + const dappSwitch = resolveChainChange(services.simulationServicesOwner, connections, { method: 'popup_changeChainDialog', data: { rpcNetwork: dappRpc, uniqueRequestIdentifier, accept: true }, }).then(() => { completed = true }) await waitForPortMessageCount(messages, 'request_signer_to_wallet_switchEthereumChain', 2) const dappId = getWalletSwitchRequestId(messages) assert.notEqual(dappId, expiredId) - const deliver = (walletSwitchRequestId: string) => walletSwitchEthereumChainReply(services.ethereum, services.tokenPriceService, services.simulationServicesOwner, connections, port, { + const deliver = (walletSwitchRequestId: string) => walletSwitchEthereumChainReply(services.simulationServicesOwner, connections, port, { method: 'wallet_switchEthereumChain_reply', params: [{ accept: true, chainId: '0x2', walletSwitchRequestId, signerProviderGeneration: token.signerProviderGeneration }], interceptorRequest: true, usingInterceptorWithoutSigner: false, uniqueRequestIdentifier: { requestId: 1, requestSocket: socket }, }, 'hasAccess', undefined) diff --git a/test/tests/refreshHomeDataRpcStatus.test.ts b/test/tests/refreshHomeDataRpcStatus.test.ts index 94a6433f6..9c4161c25 100644 --- a/test/tests/refreshHomeDataRpcStatus.test.ts +++ b/test/tests/refreshHomeDataRpcStatus.test.ts @@ -1,3 +1,4 @@ +import { createTestSimulationServicesOwner } from './backgroundEthAccountsTestHarness.js' import * as assert from 'assert' import { describe, test } from 'bun:test' import { createSafeTx } from '../../app/ts/safe/safeCore.js' @@ -769,7 +770,7 @@ describe('refreshHomeData', () => { const { messages } = createPort(1) try { - await changeSettings(ethereum, tokenPriceService, {} as never, { method: 'popup_ChangeSettings', data: { safeAppsCompatibilityMode: false } } as never, undefined) + await changeSettings(createTestSimulationServicesOwner({ ethereum, tokenPriceService }), { method: 'popup_ChangeSettings', data: { safeAppsCompatibilityMode: false } } as never, undefined) } finally { ethereum.cleanup() } diff --git a/test/tests/safeSignerConfirmation.suite.ts b/test/tests/safeSignerConfirmation.suite.ts index 207ad541a..098b8de11 100644 --- a/test/tests/safeSignerConfirmation.suite.ts +++ b/test/tests/safeSignerConfirmation.suite.ts @@ -683,8 +683,6 @@ test('refreshes the selected signer before forwarding a Safe transaction', async port = createWebsitePort(socket, 0, postedMessages, (message) => { if (!isRecord(message) || message.method !== 'request_signer_to_eth_accounts') return accountReply = modules.ethAccountsReply( - simulator.ethereum, - simulator.tokenPriceService, createTestSimulationServicesOwner({ ethereum: simulator.ethereum, tokenPriceService: simulator.tokenPriceService }), websiteTabConnections, port, @@ -733,8 +731,6 @@ test('refreshes the selected signer before forwarding a Safe transaction', async assert.match(refreshedMismatch.approvalStatus.message.toLowerCase(), new RegExp(addressString(freshlySelectedSigner).toLowerCase(), 'u')) await modules.ethAccountsReply( - simulator.ethereum, - simulator.tokenPriceService, createTestSimulationServicesOwner({ ethereum: simulator.ethereum, tokenPriceService: simulator.tokenPriceService }), websiteTabConnections, port, diff --git a/test/tests/safeSignerRouting.suite.ts b/test/tests/safeSignerRouting.suite.ts index c3ac6072e..02a598e67 100644 --- a/test/tests/safeSignerRouting.suite.ts +++ b/test/tests/safeSignerRouting.suite.ts @@ -45,7 +45,7 @@ test('accepts a signer reply from the current approved child-frame port', async }], }) - await modules.signerReply(simulator.ethereum, simulator.tokenPriceService, createTestSimulationServicesOwner({ ethereum: simulator.ethereum, tokenPriceService: simulator.tokenPriceService }), websiteTabConnections, childPort, { + await modules.signerReply(createTestSimulationServicesOwner({ ethereum: simulator.ethereum, tokenPriceService: simulator.tokenPriceService }), websiteTabConnections, childPort, { method: 'signer_reply', params: [{ success: true, @@ -116,7 +116,7 @@ test('preserves a MetaMask keyring scan error on a retryable Safe signature', as }], }) - await modules.signerReply(simulator.ethereum, simulator.tokenPriceService, createTestSimulationServicesOwner({ ethereum: simulator.ethereum, tokenPriceService: simulator.tokenPriceService }), websiteTabConnections, port, { + await modules.signerReply(createTestSimulationServicesOwner({ ethereum: simulator.ethereum, tokenPriceService: simulator.tokenPriceService }), websiteTabConnections, port, { method: 'signer_reply', params: [{ success: false, @@ -277,8 +277,6 @@ test('routes a Safe co-signing request through the wallet-selected owner', async port = createWebsitePort(socket, 0, postedMessages, (message) => { if (!isRecord(message) || message.method !== 'request_signer_to_eth_accounts') return accountReply = modules.ethAccountsReply( - simulator.ethereum, - simulator.tokenPriceService, createTestSimulationServicesOwner({ ethereum: simulator.ethereum, tokenPriceService: simulator.tokenPriceService }), websiteTabConnections, port, @@ -967,8 +965,6 @@ test('changes the Safe simulation signer only after validating current on-chain })]) const reply = await modules.setSafeSimulationSigner( - ethereum, - simulator.tokenPriceService, createTestSimulationServicesOwner({ ethereum: ethereum, tokenPriceService: simulator.tokenPriceService }), new Map(), { @@ -990,8 +986,6 @@ test('changes the Safe simulation signer only after validating current on-chain fakeSafeContract.version = 'invalid-version' const unsupportedVersionFailure = await withSilencedConsole(async () => modules.setSafeSimulationSigner( - ethereum, - simulator.tokenPriceService, createTestSimulationServicesOwner({ ethereum: ethereum, tokenPriceService: simulator.tokenPriceService }), new Map(), { @@ -1011,8 +1005,6 @@ test('changes the Safe simulation signer only after validating current on-chain fakeSafeContract.version = 'invalid-version' const { addOrModifyAddressBookEntry } = await import('../../app/ts/background/popupMessageHandlers.js') const unsupportedVersionSaveFailure = await withSilencedConsole(async () => addOrModifyAddressBookEntry( - ethereum, - simulator.tokenPriceService, createTestSimulationServicesOwner({ ethereum: ethereum, tokenPriceService: simulator.tokenPriceService }), new Map(), { @@ -1040,8 +1032,6 @@ test('refreshes Safe owner metadata and clears a stale simulation signer without })]) const reply = await modules.setSafeSimulationSigner( - ethereum, - simulator.tokenPriceService, createTestSimulationServicesOwner({ ethereum: ethereum, tokenPriceService: simulator.tokenPriceService }), new Map(), { From 0a4f4f1d24333564a1203094c672723a09f72e9d Mon Sep 17 00:00:00 2001 From: KillariDev <13102010+KillariDev@users.noreply.github.com> Date: Sat, 12 Sep 2026 11:16:46 +0000 Subject: [PATCH 28/31] Keep RPC switching spinner inside the selector --- app/css/interceptor-pages.css | 13 +++++++++++++ app/ts/components/pages/Home.tsx | 3 +-- .../components/subcomponents/ChainSelector.tsx | 3 ++- .../components/subcomponents/DropDownMenu.tsx | 18 +++++++++++------- test/benchmarks/popupSwitchingChrome.ts | 11 ++++++++--- test/tests/homeClearEmptyState.test.ts | 12 +++++++++++- 6 files changed, 46 insertions(+), 14 deletions(-) diff --git a/app/css/interceptor-pages.css b/app/css/interceptor-pages.css index 321d21baf..acee4cf2f 100644 --- a/app/css/interceptor-pages.css +++ b/app/css/interceptor-pages.css @@ -655,6 +655,19 @@ header:has(form[role='search']) h1 { --btn-brightness: 1; } +/* Keep live status outside the busy button without adding layout space. */ +.dropdown-status-text { + position: absolute; + width: 1px; + height: 1px; + padding: 0; + margin: -1px; + overflow: hidden; + clip: rect(0, 0, 0, 0); + white-space: nowrap; + border: 0; +} + .dropdown-chevron { margin-left: 0.2em; display: inline-flex; diff --git a/app/ts/components/pages/Home.tsx b/app/ts/components/pages/Home.tsx index 734c7426e..dfc9f442d 100644 --- a/app/ts/components/pages/Home.tsx +++ b/app/ts/components/pages/Home.tsx @@ -308,8 +308,7 @@ function FirstCardHeader(param: FirstCardParams) {
- - { rpcPending ? { !param.simulationMode.value && requestedRpc.value?.chainId !== param.rpcNetwork.value?.chainId ? 'Waiting for wallet to switch network...' : 'Updating network...' } : <> } +
{ setSimulatingState.value.state === 'rejected' ? : <> } diff --git a/app/ts/components/subcomponents/ChainSelector.tsx b/app/ts/components/subcomponents/ChainSelector.tsx index dd1255a98..cdb8137bb 100644 --- a/app/ts/components/subcomponents/ChainSelector.tsx +++ b/app/ts/components/subcomponents/ChainSelector.tsx @@ -10,6 +10,7 @@ interface RpcSelectorParams { rpcEntries: Signal changeRpc: (entry: RpcEntry) => void disabled?: boolean + pendingText?: string } export function findRpcEntryByIdentityKey(rpcEntries: RpcEntries, key: string) { @@ -47,7 +48,7 @@ export function RpcSelector(params: RpcSelectorParams) { if (newEntry === undefined) throw new Error('Tried to select an RPC entry that is no longer available.') params.changeRpc(newEntry) } - return + return } interface ChainSelectorParams { diff --git a/app/ts/components/subcomponents/DropDownMenu.tsx b/app/ts/components/subcomponents/DropDownMenu.tsx index 09b282a5b..2504aa6a9 100644 --- a/app/ts/components/subcomponents/DropDownMenu.tsx +++ b/app/ts/components/subcomponents/DropDownMenu.tsx @@ -1,6 +1,7 @@ import { type Signal, useSignal } from '@preact/signals' import { useId, useRef } from 'preact/hooks' import { clickOutsideAlerter } from '../ui-utils.js' +import { AsyncStatusIcon } from './AsyncAction.js' import { ChevronIcon } from './icons.js' import type { ComponentChildren } from 'preact' @@ -11,39 +12,42 @@ type DropDownMenuParams = { buttonClassses: string ariaLabel?: string disabled?: boolean + pendingText?: string getOptionLabel?: (option: OptionType) => string renderOption?: (option: OptionType) => ComponentChildren } -export function DropDownMenuButtonContent({ label }: { label: ComponentChildren }) { +export function DropDownMenuButtonContent({ label, pendingText }: { label: ComponentChildren, pendingText?: string }) { return <> { label } - + } -export const DropDownMenu = ({ selected, dropDownOptions, onChangedCallBack, buttonClassses, ariaLabel, disabled = false, getOptionLabel = (option) => option, renderOption = getOptionLabel }: DropDownMenuParams) => { +export const DropDownMenu = ({ selected, dropDownOptions, onChangedCallBack, buttonClassses, ariaLabel, disabled = false, pendingText, getOptionLabel = (option) => option, renderOption = getOptionLabel }: DropDownMenuParams) => { + const unavailable = disabled || pendingText !== undefined const isOpen = useSignal(false) const ref = useRef(null) const menuId = useId() clickOutsideAlerter(ref, () => { isOpen.value = false }) const toggle = () => { - if (disabled) return + if (unavailable) return isOpen.value = !isOpen.value } const onChanged = (newValue: OptionType) => { - if (disabled) return + if (unavailable) return isOpen.value = false onChangedCallBack(newValue) } return
- + { pendingText }