Skip to content

Remove fn references to TransactionController in favor of messenger #534

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 5 commits into from
Sep 17, 2025
Merged

Remove fn references to TransactionController in favor of messenger #534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
775a386
Remove fn references to TransactionController in favor of messenger
mcmire Sep 17, 2025
6e99652
Move changelog entries to Changed; consolidate
mcmire Sep 17, 2025
6250974
Don't have markRegularTransactionsAsFailed take a messenger
mcmire Sep 17, 2025
d804f8b
Bump peer dep again
mcmire Sep 17, 2025
55aee3c
Update lockfile
mcmire Sep 17, 2025
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
8 changes: 7 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed

- **BREAKING:** Disallow subpath exports ([#469](https://github.com/MetaMask/smart-transactions-controller/pull/469))
- **BREAKING:** Upgrade peer dependency `@metamask/transaction-controller` from `^58.0.0` to `^60.3.0`
- **BREAKING:** Upgrade peer dependency `@metamask/transaction-controller` from `^58.0.0` to `^60.4.0` ([#532](https://github.com/MetaMask/smart-transactions-controller/pull/532), [#534](https://github.com/MetaMask/smart-transactions-controller/pull/534))
- **BREAKING:** Remove `getNonceLock`, `confirmExternalTransaction`, `getTransactions`, and `updateTransaction` constructor option in favor of messenger actions ([#534](https://github.com/MetaMask/smart-transactions-controller/pull/534))
- The messenger is now used to access TransactionController; you must add these actions to the SmartTransactionController messenger allowlist:
- `TransactionController:getNonceLock`
- `TransactionController:confirmExternalTransaction`
- `TransactionController:getTransactions`
- `TransactionController:updateTransaction`
- Upgrade `@metamask/base-controller` from `^7.0.1` to `^8.3.0` ([#529](https://github.com/MetaMask/smart-transactions-controller/pull/529))
- Upgrade `@metamask/polling-controller` from `^12.0.0` to `^14.0.0` ([#529](https://github.com/MetaMask/smart-transactions-controller/pull/529))

Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
"@metamask/gas-fee-controller": "^22.0.0",
"@metamask/json-rpc-engine": "^10.0.1",
"@metamask/network-controller": "^24.0.0",
"@metamask/transaction-controller": "^60.3.0",
"@metamask/transaction-controller": "^60.4.0",
"@ts-bridge/cli": "^0.6.3",
"@types/jest": "^26.0.24",
"@types/lodash": "^4.14.194",
Expand All @@ -93,7 +93,7 @@
},
"peerDependencies": {
"@metamask/network-controller": "^24.0.0",
"@metamask/transaction-controller": "^60.0.0"
"@metamask/transaction-controller": "^60.4.0"
},
"peerDependenciesMeta": {
"@metamask/accounts-controller": {
Expand Down
170 changes: 100 additions & 70 deletions src/SmartTransactionsController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@
RpcEndpointType,
type NetworkState,
} from '@metamask/network-controller';
import type {
TransactionControllerConfirmExternalTransactionAction,
TransactionControllerGetNonceLockAction,
TransactionControllerGetTransactionsAction,
TransactionControllerUpdateTransactionAction,
} from '@metamask/transaction-controller';
import {
type TransactionParams,
TransactionStatus,
Expand Down Expand Up @@ -446,7 +452,7 @@

controller.timeoutHandle = setTimeout(() => ({}));

controller.poll(1000);

Check warning on line 455 in src/SmartTransactionsController.test.ts

View workflow job for this annotation

GitHub Actions / Build, lint, and test / Lint (20.x) 

Promises must be awaited, end with a call to .catch, end with a call to .then with a rejection handler or be explicitly marked as ignored with the `void` operator

Check warning on line 455 in src/SmartTransactionsController.test.ts

View workflow job for this annotation

GitHub Actions / Build, lint, and test / Lint (18.x) 

Promises must be awaited, end with a call to .catch, end with a call to .then with a rejection handler or be explicitly marked as ignored with the `void` operator

expect(updateSmartTransactionsSpy).toHaveBeenCalled();
});
Expand Down Expand Up @@ -732,9 +738,7 @@

await withController(
{
options: {
getNonceLock: mockGetNonceLock,
},
getNonceLock: mockGetNonceLock,
},
async ({ controller }) => {
const signedTransaction = createSignedTransaction();
Expand Down Expand Up @@ -801,9 +805,7 @@

await withController(
{
options: {
getNonceLock: mockGetNonceLock,
},
getNonceLock: mockGetNonceLock,
},
async ({ controller }) => {
const signedTransaction = createSignedTransaction();
Expand Down Expand Up @@ -858,9 +860,7 @@

await withController(
{
options: {
getNonceLock: mockGetNonceLock,
},
getNonceLock: mockGetNonceLock,
},
async ({ controller }) => {
const signedTransaction = createSignedTransaction();
Expand Down Expand Up @@ -1239,9 +1239,9 @@
},
},
},
confirmExternalTransaction: confirmExternalTransactionSpy,
getTransactions: getRegularTransactionsSpy,
},
confirmExternalTransaction: confirmExternalTransactionSpy,
getTransactions: getRegularTransactionsSpy,
},
async ({ controller }) => {
const updateTransaction = {
Expand Down Expand Up @@ -1298,9 +1298,9 @@
},
},
},
confirmExternalTransaction: confirmExternalTransactionSpy,
getTransactions: getRegularTransactionsSpy,
},
confirmExternalTransaction: confirmExternalTransactionSpy,
getTransactions: getRegularTransactionsSpy,
},
async ({ controller }) => {
const updateTransaction = {
Expand Down Expand Up @@ -1357,9 +1357,9 @@
},
},
},
confirmExternalTransaction: confirmExternalTransactionSpy,
getTransactions: getRegularTransactionsSpy,
},
confirmExternalTransaction: confirmExternalTransactionSpy,
getTransactions: getRegularTransactionsSpy,
},
async ({ controller }) => {
const updateTransaction = {
Expand Down Expand Up @@ -1416,9 +1416,9 @@
},
},
},
confirmExternalTransaction: confirmExternalTransactionSpy,
getTransactions: getRegularTransactionsSpy,
},
confirmExternalTransaction: confirmExternalTransactionSpy,
getTransactions: getRegularTransactionsSpy,
},
async ({ controller }) => {
const updateTransaction = {
Expand Down Expand Up @@ -1475,9 +1475,9 @@
},
},
},
confirmExternalTransaction: confirmExternalTransactionSpy,
getTransactions: getRegularTransactionsSpy,
},
confirmExternalTransaction: confirmExternalTransactionSpy,
getTransactions: getRegularTransactionsSpy,
},
async ({ controller }) => {
const updateTransaction = {
Expand Down Expand Up @@ -1519,24 +1519,11 @@
await withController(
{
options: {
updateTransaction: mockUpdateTransaction,
getFeatureFlags: () => ({
smartTransactions: {
mobileReturnTxHashAsap: true,
},
}),
getTransactions: () => [
{
id: 'test-tx-id',
status: TransactionStatus.submitted,
chainId: '0x1',
time: 123,
txParams: {
from: '0x123',
},
networkClientId: NetworkType.mainnet,
},
],
state: {
smartTransactionsState: {
...defaultState.smartTransactionsState,
Expand All @@ -1546,6 +1533,19 @@
},
},
},
updateTransaction: mockUpdateTransaction,
getTransactions: () => [
{
id: 'test-tx-id',
status: TransactionStatus.submitted,
chainId: '0x1',
time: 123,
txParams: {
from: '0x123',
},
networkClientId: NetworkType.mainnet,
},
],
},
async ({ controller }) => {
const smartTransaction = {
Expand Down Expand Up @@ -1582,25 +1582,25 @@
await withController(
{
options: {
updateTransaction: mockUpdateTransaction,
getFeatureFlags: () => ({
smartTransactions: {
mobileReturnTxHashAsap: false,
},
}),
getTransactions: () => [
{
id: 'test-tx-id',
status: TransactionStatus.submitted,
chainId: '0x1',
time: 123,
txParams: {
from: '0x123',
},
networkClientId: NetworkType.mainnet,
},
],
},
updateTransaction: mockUpdateTransaction,
getTransactions: () => [
{
id: 'test-tx-id',
status: TransactionStatus.submitted,
chainId: '0x1',
time: 123,
txParams: {
from: '0x123',
},
networkClientId: NetworkType.mainnet,
},
],
},
async ({ controller }) => {
const smartTransaction = {
Expand All @@ -1622,14 +1622,14 @@
await withController(
{
options: {
updateTransaction: mockUpdateTransaction,
getFeatureFlags: () => ({
smartTransactions: {
mobileReturnTxHashAsap: true,
},
}),
getTransactions: () => [],
},
updateTransaction: mockUpdateTransaction,
getTransactions: () => [],
},
async ({ controller }) => {
const smartTransaction = {
Expand All @@ -1650,25 +1650,25 @@
await withController(
{
options: {
updateTransaction: mockUpdateTransaction,
getFeatureFlags: () => ({
smartTransactions: {
mobileReturnTxHashAsap: true,
},
}),
getTransactions: () => [
{
id: 'test-tx-id',
status: TransactionStatus.submitted,
chainId: '0x1',
time: 123,
txParams: {
from: '0x123',
},
networkClientId: NetworkType.mainnet,
},
],
},
updateTransaction: mockUpdateTransaction,
getTransactions: () => [
{
id: 'test-tx-id',
status: TransactionStatus.submitted,
chainId: '0x1',
time: 123,
txParams: {
from: '0x123',
},
networkClientId: NetworkType.mainnet,
},
],
},
async ({ controller }) => {
const smartTransaction = {
Expand Down Expand Up @@ -2682,6 +2682,10 @@
options?: Partial<
ConstructorParameters<typeof SmartTransactionsController>[0]
>;
getNonceLock?: TransactionControllerGetNonceLockAction['handler'];
confirmExternalTransaction?: TransactionControllerConfirmExternalTransactionAction['handler'];
getTransactions?: TransactionControllerGetTransactionsAction['handler'];
updateTransaction?: TransactionControllerUpdateTransactionAction['handler'];
};

type WithControllerArgs<ReturnValue> =
Expand All @@ -2701,11 +2705,25 @@
...args: WithControllerArgs<ReturnValue>
): Promise<ReturnValue> {
const [{ ...rest }, fn] = args.length === 2 ? args : [{}, args[0]];
const { options } = rest;
const {
options,
getNonceLock = jest.fn().mockResolvedValue({
nextNonce: 42,
releaseLock: jest.fn(),
}),
confirmExternalTransaction = jest.fn(),
getTransactions = jest.fn(),
updateTransaction = jest.fn(),
} = rest;

const controllerMessenger = new Messenger<
| SmartTransactionsControllerActions
| NetworkControllerGetNetworkClientByIdAction
| NetworkControllerGetStateAction,
| NetworkControllerGetStateAction
| TransactionControllerGetNonceLockAction
| TransactionControllerConfirmExternalTransactionAction
| TransactionControllerGetTransactionsAction
| TransactionControllerUpdateTransactionAction,
SmartTransactionsControllerEvents | NetworkControllerStateChangeEvent
>();
controllerMessenger.registerActionHandler(
Expand All @@ -2731,7 +2749,6 @@
}
}),
);

controllerMessenger.registerActionHandler(
'NetworkController:getState',
jest.fn().mockReturnValue({
Expand Down Expand Up @@ -2770,25 +2787,39 @@
},
}),
);
controllerMessenger.registerActionHandler(
'TransactionController:getNonceLock',
getNonceLock,
);
controllerMessenger.registerActionHandler(
'TransactionController:confirmExternalTransaction',
confirmExternalTransaction,
);
controllerMessenger.registerActionHandler(
'TransactionController:getTransactions',
getTransactions,
);
controllerMessenger.registerActionHandler(
'TransactionController:updateTransaction',
updateTransaction,
);

const messenger = controllerMessenger.getRestricted({
name: 'SmartTransactionsController',
allowedActions: [
'NetworkController:getNetworkClientById',
'NetworkController:getState',
'TransactionController:getNonceLock',
'TransactionController:confirmExternalTransaction',
'TransactionController:getTransactions',
'TransactionController:updateTransaction',
],
allowedEvents: ['NetworkController:stateChange'],
});

const controller = new SmartTransactionsController({
messenger,
clientId: ClientId.Mobile,
getNonceLock: jest.fn().mockResolvedValue({
nextNonce: 42,
releaseLock: jest.fn(),
}),
confirmExternalTransaction: jest.fn(),
getTransactions: jest.fn(),
trackMetaMetricsEvent: trackMetaMetricsEventSpy,
getMetaMetricsProps: jest.fn(async () => {
return Promise.resolve({
Expand All @@ -2798,7 +2829,6 @@
});
}),
getFeatureFlags: jest.fn(),
updateTransaction: jest.fn(),
...options,
});

Expand Down Expand Up @@ -2840,7 +2870,7 @@
triggerNetworStateChange,
});
} finally {
controller.stop();

Check warning on line 2873 in src/SmartTransactionsController.test.ts

View workflow job for this annotation

GitHub Actions / Build, lint, and test / Lint (20.x) 

Promises must be awaited, end with a call to .catch, end with a call to .then with a rejection handler or be explicitly marked as ignored with the `void` operator

Check warning on line 2873 in src/SmartTransactionsController.test.ts

View workflow job for this annotation

GitHub Actions / Build, lint, and test / Lint (18.x) 

Promises must be awaited, end with a call to .catch, end with a call to .then with a rejection handler or be explicitly marked as ignored with the `void` operator
controller.stopAllPolling();
}
}
Loading
Loading