Skip to content

fix: Ignore Snap insight response if transaction/signature has already been signed #2825

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 10, 2024
Merged

fix: Ignore Snap insight response if transaction/signature has already been signed #2825

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/snaps-controllers/coverage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"branches": 92.62,
"branches": 92.63,
"functions": 96.65,
"lines": 97.97,
"statements": 97.67
Expand Down
199 changes: 199 additions & 0 deletions packages/snaps-controllers/src/insights/SnapInsightsController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
MOCK_LOCAL_SNAP_ID,
MOCK_SNAP_ID,
} from '@metamask/snaps-utils/test-utils';
import { createDeferredPromise } from '@metamask/utils';
import { nanoid } from 'nanoid';

import {
Expand Down Expand Up @@ -450,4 +451,202 @@ describe('SnapInsightsController', () => {

expect(rootMessenger.call).toHaveBeenCalledTimes(8);
});

it('ignores insight if transaction has already been signed', async () => {
const rootMessenger = getRootSnapInsightsControllerMessenger();

rootMessenger.registerActionHandler('SnapController:getAll', () => {
return [getTruncatedSnap(), getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID })];
});

const { resolve, promise } = createDeferredPromise();

rootMessenger.registerActionHandler(
'SnapController:handleRequest',
async ({ snapId }) => {
await promise;
if (snapId === MOCK_SNAP_ID) {
return { id: nanoid() };
}
throw new InternalError();
},
);

rootMessenger.registerActionHandler(
'PermissionController:getPermissions',
(origin) => {
return origin === MOCK_SNAP_ID
? MOCK_INSIGHTS_PERMISSIONS
: MOCK_INSIGHTS_PERMISSIONS_NO_ORIGINS;
},
);

const controllerMessenger =
getRestrictedSnapInsightsControllerMessenger(rootMessenger);

const controller = new SnapInsightsController({
messenger: controllerMessenger,
});

// Simulate transaction added, signed & confirmed
rootMessenger.publish(
'TransactionController:unapprovedTransactionAdded',
TRANSACTION_META_MOCK,
);

rootMessenger.publish('TransactionController:transactionStatusUpdated', {
transactionMeta: { ...TRANSACTION_META_MOCK, status: 'approved' },
});

rootMessenger.publish('TransactionController:transactionStatusUpdated', {
transactionMeta: { ...TRANSACTION_META_MOCK, status: 'confirmed' },
});

resolve();

// Wait for promises to resolve
await new Promise(process.nextTick);

expect(Object.values(controller.state.insights)).toHaveLength(0);

expect(rootMessenger.call).toHaveBeenCalledTimes(5);
expect(rootMessenger.call).toHaveBeenNthCalledWith(
4,
'SnapController:handleRequest',
{
snapId: MOCK_SNAP_ID,
origin: '',
handler: HandlerType.OnTransaction,
request: {
method: '',
params: {
chainId: `eip155:${parseInt(TRANSACTION_META_MOCK.chainId, 16)}`,
transaction: TRANSACTION_META_MOCK.txParams,
transactionOrigin: TRANSACTION_META_MOCK.origin,
},
},
},
);
expect(rootMessenger.call).toHaveBeenNthCalledWith(
5,
'SnapController:handleRequest',
{
snapId: MOCK_LOCAL_SNAP_ID,
origin: '',
handler: HandlerType.OnTransaction,
request: {
method: '',
params: {
chainId: `eip155:${parseInt(TRANSACTION_META_MOCK.chainId, 16)}`,
transaction: TRANSACTION_META_MOCK.txParams,
transactionOrigin: null,
},
},
},
);
});

it('ignores insight if signature has already been signed', async () => {
const rootMessenger = getRootSnapInsightsControllerMessenger();
const controllerMessenger =
getRestrictedSnapInsightsControllerMessenger(rootMessenger);

const controller = new SnapInsightsController({
messenger: controllerMessenger,
});

rootMessenger.registerActionHandler('SnapController:getAll', () => {
return [getTruncatedSnap(), getTruncatedSnap({ id: MOCK_LOCAL_SNAP_ID })];
});

const { resolve, promise } = createDeferredPromise();

rootMessenger.registerActionHandler(
'SnapController:handleRequest',
async () => {
await promise;
return { id: nanoid() };
},
);

rootMessenger.registerActionHandler(
'PermissionController:getPermissions',
(origin) => {
return origin === MOCK_SNAP_ID
? MOCK_INSIGHTS_PERMISSIONS
: MOCK_INSIGHTS_PERMISSIONS_NO_ORIGINS;
},
);

rootMessenger.publish(
'SignatureController:stateChange',
{
unapprovedPersonalMsgCount: 0,
unapprovedTypedMessagesCount: 1,
unapprovedTypedMessages: { '1': TYPED_SIGNATURE_MOCK },
unapprovedPersonalMsgs: {},
},
[],
);

rootMessenger.publish(
'SignatureController:stateChange',
{
unapprovedPersonalMsgCount: 0,
unapprovedTypedMessagesCount: 0,
unapprovedTypedMessages: {},
unapprovedPersonalMsgs: {},
},
[],
);

resolve();

// Wait for promises to resolve
await new Promise(process.nextTick);

expect(Object.values(controller.state.insights)).toHaveLength(0);

expect(rootMessenger.call).toHaveBeenCalledTimes(5);
expect(rootMessenger.call).toHaveBeenNthCalledWith(
4,
'SnapController:handleRequest',
{
snapId: MOCK_SNAP_ID,
origin: '',
handler: HandlerType.OnSignature,
request: {
method: '',
params: {
signature: {
from: TYPED_SIGNATURE_MOCK.msgParams.from,
data: JSON.parse(TYPED_SIGNATURE_MOCK.msgParams.data),
signatureMethod: TYPED_SIGNATURE_MOCK.msgParams.signatureMethod,
},
signatureOrigin: TYPED_SIGNATURE_MOCK.msgParams.origin,
},
},
},
);
expect(rootMessenger.call).toHaveBeenNthCalledWith(
5,
'SnapController:handleRequest',
{
snapId: MOCK_LOCAL_SNAP_ID,
origin: '',
handler: HandlerType.OnSignature,
request: {
method: '',
params: {
signature: {
from: TYPED_SIGNATURE_MOCK.msgParams.from,
data: JSON.parse(TYPED_SIGNATURE_MOCK.msgParams.data),
signatureMethod: TYPED_SIGNATURE_MOCK.msgParams.signatureMethod,
},
signatureOrigin: null,
},
},
},
);
});
});
6 changes: 6 additions & 0 deletions packages/snaps-controllers/src/insights/SnapInsightsController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,12 @@ export class SnapInsightsController extends BaseController<
response?: Record<string, Json>;
error?: Error;
}) {
// If the insight has been cleaned up already, we can skip setting the state.
// This may happen if a user accepts/rejects a transaction/signature faster than the Snap responds.
if (!this.#hasInsight(id)) {
return;
}

this.update((state) => {
state.insights[id][snapId].loading = false;
state.insights[id][snapId].interfaceId = response?.id as string;
Expand Down
Loading