Skip to content

refactor: migrate SignatureController to @metamask/messenger #6496

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −16
Open

refactor: migrate SignatureController to @metamask/messenger #6496

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: 2 additions & 0 deletions packages/signature-controller/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

- **BREAKING:** Use new `Messenger` from `@metamask/messenger` ([#6496](https://github.com/MetaMask/core/pull/6496))
- Previously, `SignatureController` accepted a `RestrictedMessenger` instance from `@metamask/base-controller`.
- Bump `@metamask/base-controller` from `^8.1.0` to `^8.3.0` ([#6355](https://github.com/MetaMask/core/pull/6355), [#6465](https://github.com/MetaMask/core/pull/6465))

## [33.0.0]
Expand Down
1 change: 1 addition & 0 deletions packages/signature-controller/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
"@metamask/base-controller": "^8.3.0",
"@metamask/controller-utils": "^11.12.0",
"@metamask/eth-sig-util": "^8.2.0",
"@metamask/messenger": "^0.2.0",
"@metamask/utils": "^11.4.2",
"jsonschema": "^1.4.1",
"lodash": "^4.17.21",
Expand Down
30 changes: 14 additions & 16 deletions packages/signature-controller/src/SignatureController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@ import type {
AcceptResultCallbacks,
AddResult,
} from '@metamask/approval-controller';
import type {
ControllerGetStateAction,
ControllerStateChangeEvent,
RestrictedMessenger,
} from '@metamask/base-controller';
import { BaseController } from '@metamask/base-controller';
import {
BaseController,
type ControllerGetStateAction,
type ControllerStateChangeEvent,
} from '@metamask/base-controller/next';
import type { TraceCallback, TraceContext } from '@metamask/controller-utils';
import {
ApprovalType,
Expand All @@ -28,6 +27,7 @@ import {
SigningStage,
type AddLog,
} from '@metamask/logging-controller';
import type { Messenger } from '@metamask/messenger';
import type { NetworkControllerGetNetworkClientByIdAction } from '@metamask/network-controller';
import type { Hex, Json } from '@metamask/utils';
// This package purposefully relies on Node's EventEmitter module.
Expand Down Expand Up @@ -140,12 +140,10 @@ export type SignatureControllerActions = GetSignatureState;

export type SignatureControllerEvents = SignatureStateChange;

export type SignatureControllerMessenger = RestrictedMessenger<
export type SignatureControllerMessenger = Messenger<
typeof controllerName,
SignatureControllerActions | AllowedActions,
SignatureControllerEvents,
AllowedActions['type'],
never
SignatureControllerEvents
>;

export type SignatureControllerOptions = {
Expand Down Expand Up @@ -675,7 +673,7 @@ export class SignatureController extends BaseController<

switch (type) {
case SignatureRequestType.PersonalSign:
signature = await this.messagingSystem.call(
signature = await this.messenger.call(
'KeyringController:signPersonalMessage',
// Keyring controller temporarily using message manager types.
// eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand All @@ -688,7 +686,7 @@ export class SignatureController extends BaseController<
? this.#parseTypedData(messageParams, metadata.version)
: messageParams;

signature = await this.messagingSystem.call(
signature = await this.messenger.call(
'KeyringController:signTypedMessage',
finalRequest,
metadata.version as SignTypedDataVersion,
Expand Down Expand Up @@ -767,7 +765,7 @@ export class SignatureController extends BaseController<
parentContext: traceContext,
});

return (await this.messagingSystem.call(
return (await this.messenger.call(
'ApprovalController:addRequest',
{
id,
Expand Down Expand Up @@ -870,7 +868,7 @@ export class SignatureController extends BaseController<
version,
);

this.messagingSystem.call('LoggingController:add', {
this.messenger.call('LoggingController:add', {
type: LogType.EthSignLog,
data: {
signingMethod,
Expand Down Expand Up @@ -912,7 +910,7 @@ export class SignatureController extends BaseController<
throw new Error('Network client ID not found in request');
}

const networkClient = this.messagingSystem.call(
const networkClient = this.messenger.call(
'NetworkController:getNetworkClientById',
networkClientId,
);
Expand Down Expand Up @@ -953,7 +951,7 @@ export class SignatureController extends BaseController<
}

#getInternalAccounts(): Hex[] {
const state = this.messagingSystem.call('AccountsController:getState');
const state = this.messenger.call('AccountsController:getState');

/* istanbul ignore next */
return Object.values(state.internalAccounts?.accounts ?? {})
Expand Down
1 change: 1 addition & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4497,6 +4497,7 @@ __metadata:
"@metamask/eth-sig-util": "npm:^8.2.0"
"@metamask/keyring-controller": "npm:^23.0.0"
"@metamask/logging-controller": "npm:^6.0.4"
"@metamask/messenger": "npm:^0.2.0"
"@metamask/network-controller": "npm:^24.1.0"
"@metamask/utils": "npm:^11.4.2"
"@types/jest": "npm:^27.4.1"
Expand Down
Loading