Migrate to new controller packages

.circleci/config.yml

@@ -14,6 +14,9 @@ executors:
     docker:
       - image: koalaman/shellcheck-alpine@sha256:dfaf08fab58c158549d3be64fb101c626abc5f16f341b569092577ae207db199
 
+orbs:
+  gh: circleci/[email protected]
+
 workflows:
   test_and_release:
     jobs:
@@ -206,6 +209,27 @@ jobs:
       - checkout
       - restore_cache:
           key: dependency-cache-v1-{{ checksum "yarn.lock" }}
+      - gh/install
+      - run:
+          name: Set IS_DRAFT environment variable
+          command: |
+            PR_NUMBER="${CIRCLE_PULL_REQUEST##*/}"
+            if [ -n "$PR_NUMBER" ]
+            then
+              echo "IS_DRAFT=$(gh pr view --json isDraft --jq '.isDraft' "$PR_NUMBER")" >> "$BASH_ENV"
+              source "$BASH_ENV"
+            else
+              echo "Not a PR; skipping"
+            fi
+      - run:
+          name: Setup registry config for using package previews on draft PRs
+          command: |
+            if [[ $IS_DRAFT == 'true' ]]
+            then
+              printf '%s\n\n%s' '@metamask:registry=https://npm.pkg.github.com' "//npm.pkg.github.com/:_authToken=${GITHUB_PACKAGE_READ_TOKEN}" > .npmrc
+            else
+              echo "Not draft; skipping GitHub registry setup"
+            fi
       - run:
           name: Install deps
           command: |

.gitignore

@@ -55,4 +55,8 @@ notes.txt
 tsout/
 
 # Test results
-test-results/
+test-results/
+
+# This file is used to authenticate with the GitHub Package registry, to
+# enable the use of @metamask preview builds.
+.npmrc

app/scripts/controllers/detect-tokens.test.js

@@ -3,12 +3,12 @@ import sinon from 'sinon';
 import nock from 'nock';
 import { ObservableStore } from '@metamask/obs-store';
 import BigNumber from 'bignumber.js';
+import { ControllerMessenger } from '@metamask/base-controller';
 import {
-  ControllerMessenger,
   TokenListController,
   TokensController,
   AssetsContractController,
-} from '@metamask/controllers';
+} from '@metamask/assets-controllers';
 import { NETWORK_TYPES } from '../../../shared/constants/network';
 import { toChecksumHexAddress } from '../../../shared/modules/hexstring-utils';
 import DetectTokensController from './detect-tokens';

app/scripts/controllers/permissions/caveat-mutators.js

@@ -1,4 +1,4 @@
-import { CaveatMutatorOperation } from '@metamask/controllers';
+import { CaveatMutatorOperation } from '@metamask/permission-controller';
 import { CaveatTypes } from '../../../../shared/constants/permissions';
 
 /**

app/scripts/controllers/permissions/caveat-mutators.test.js

@@ -1,4 +1,4 @@
-import { CaveatMutatorOperation } from '@metamask/controllers';
+import { CaveatMutatorOperation } from '@metamask/permission-controller';
 import { CaveatTypes } from '../../../../shared/constants/permissions';
 import { CaveatMutatorFactories } from './caveat-mutators';
 

app/scripts/controllers/permissions/specifications.js

@@ -1,4 +1,7 @@
-import { constructPermission, PermissionType } from '@metamask/controllers';
+import {
+  constructPermission,
+  PermissionType,
+} from '@metamask/permission-controller';
 ///: BEGIN:ONLY_INCLUDE_IN(flask)
 import { endowmentCaveatSpecifications as snapsEndowmentCaveatSpecifications } from '@metamask/snaps-controllers';
 import { caveatSpecifications as snapsCaveatsSpecifications } from '@metamask/rpc-methods';

app/scripts/controllers/preferences.test.js

@@ -1,9 +1,7 @@
 import { strict as assert } from 'assert';
 import sinon from 'sinon';
-import {
-  ControllerMessenger,
-  TokenListController,
-} from '@metamask/controllers';
+import { ControllerMessenger } from '@metamask/base-controller';
+import { TokenListController } from '@metamask/assets-controllers';
 import { CHAIN_IDS } from '../../../shared/constants/network';
 import PreferencesController from './preferences';
 import NetworkController from './network';

app/scripts/lib/ComposableObservableStore.js

@@ -1,8 +1,8 @@
 import { ObservableStore } from '@metamask/obs-store';
-import { getPersistentState } from '@metamask/controllers';
+import { getPersistentState } from '@metamask/base-controller';
 
 /**
- * @typedef {import('@metamask/controllers').ControllerMessenger} ControllerMessenger
+ * @typedef {import('@metamask/base-controller').ControllerMessenger} ControllerMessenger
  */
 
 /**
@@ -13,7 +13,7 @@ export default class ComposableObservableStore extends ObservableStore {
   /**
    * Describes which stores are being composed. The key is the name of the
    * store, and the value is either an ObserableStore, or a controller that
-   * extends one of the two base controllers in the `@metamask/controllers`
+   * extends one of the two base controllers in the `@metamask/base-controller`
    * package.
    *
    * @type {Record<string, object>}
@@ -46,7 +46,7 @@ export default class ComposableObservableStore extends ObservableStore {
    * @param {Record<string, object>} config - Describes which stores are being
    *   composed. The key is the name of the store, and the value is either an
    *   ObserableStore, or a controller that extends one of the two base
-   *   controllers in the `@metamask/controllers` package.
+   *   controllers in the `@metamask/base-controller` package.
    */
   updateStructure(config) {
     this.config = config;

app/scripts/lib/ComposableObservableStore.test.js

@@ -3,7 +3,7 @@ import {
   BaseController,
   BaseControllerV2,
   ControllerMessenger,
-} from '@metamask/controllers';
+} from '@metamask/base-controller';
 import ComposableObservableStore from './ComposableObservableStore';
 
 class OldExampleController extends BaseController {

app/scripts/lib/rpc-method-middleware/createMethodMiddleware.js

@@ -1,7 +1,7 @@
 ///: BEGIN:ONLY_INCLUDE_IN(flask)
 import { handlers as permittedSnapMethods } from '@metamask/rpc-methods/dist/permitted';
 ///: END:ONLY_INCLUDE_IN
-import { permissionRpcMethods } from '@metamask/controllers';
+import { permissionRpcMethods } from '@metamask/permission-controller';
 import { selectHooks } from '@metamask/rpc-methods/dist/utils';
 import { ethErrors } from 'eth-rpc-errors';
 import { flatten } from 'lodash';

app/scripts/metamask-controller.actions.test.js

@@ -2,10 +2,8 @@ import { strict as assert } from 'assert';
 import sinon from 'sinon';
 import proxyquire from 'proxyquire';
 
-import {
-  ApprovalRequestNotFoundError,
-  PermissionsRequestNotFoundError,
-} from '@metamask/controllers';
+import { ApprovalRequestNotFoundError } from '@metamask/approval-controller';
+import { PermissionsRequestNotFoundError } from '@metamask/permission-controller';
 import { ORIGIN_METAMASK } from '../../shared/constants/app';
 
 const Ganache = require('../../test/e2e/ganache');

app/scripts/metamask-controller.js

@@ -23,29 +23,33 @@ import { MetaMaskKeyring as QRHardwareKeyring } from '@keystonehq/metamask-airga
 import EthQuery from 'eth-query';
 import nanoid from 'nanoid';
 import { captureException } from '@sentry/browser';
+import { AddressBookController } from '@metamask/address-book-controller';
 import {
-  AddressBookController,
   ApprovalController,
-  ControllerMessenger,
+  ApprovalRequestNotFoundError,
+} from '@metamask/approval-controller';
+import { ControllerMessenger } from '@metamask/base-controller';
+import {
   CurrencyRateController,
-  PhishingController,
-  AnnouncementController,
-  GasFeeController,
   TokenListController,
   TokensController,
   TokenRatesController,
   NftController,
   AssetsContractController,
   NftDetectionController,
+} from '@metamask/assets-controllers';
+import { PhishingController } from '@metamask/phishing-controller';
+import { AnnouncementController } from '@metamask/announcement-controller';
+import { GasFeeController } from '@metamask/gas-fee-controller';
+import {
   PermissionController,
-  SubjectMetadataController,
   PermissionsRequestNotFoundError,
-  ApprovalRequestNotFoundError,
-  ///: BEGIN:ONLY_INCLUDE_IN(flask)
-  RateLimitController,
-  NotificationController,
-  ///: END:ONLY_INCLUDE_IN
-} from '@metamask/controllers';
+} from '@metamask/permission-controller';
+import { SubjectMetadataController } from '@metamask/subject-metadata-controller';
+///: BEGIN:ONLY_INCLUDE_IN(flask)
+import { RateLimitController } from '@metamask/rate-limit-controller';
+import { NotificationController } from '@metamask/notification-controller';
+///: END:ONLY_INCLUDE_IN
 import SmartTransactionsController from '@metamask/smart-transactions-controller';
 ///: BEGIN:ONLY_INCLUDE_IN(flask)
 import {
@@ -167,7 +171,7 @@ export const METAMASK_CONTROLLER_EVENTS = {
   // Fired after state changes that impact the extension badge (unapproved msg count)
   // The process of updating the badge happens in app/scripts/background.js.
   UPDATE_BADGE: 'updateBadge',
-  // TODO: Add this and similar enums to @metamask/controllers and export them
+  // TODO: Add this and similar enums to the `controllers` repo and export them
   APPROVAL_STATE_CHANGE: 'ApprovalController:stateChange',
 };
 
@@ -1276,8 +1280,8 @@ export default class MetamaskController extends EventEmitter {
    * changes.
    *
    * Some of the subscriptions in this method are ControllerMessenger selector
-   * event subscriptions. See the relevant @metamask/controllers documentation
-   * for more information.
+   * event subscriptions. See the relevant documentation for
+   * `@metamask/base-controller` for more information.
    *
    * Note that account-related notifications emitted when the extension
    * becomes unlocked are handled in MetaMaskController._onUnlock.

app/scripts/migrations/037.js

@@ -1,5 +1,5 @@
 import { cloneDeep } from 'lodash';
-import { util } from '@metamask/controllers';
+import { normalizeEnsName } from '@metamask/controller-utils';
 
 const version = 37;
 
@@ -38,7 +38,7 @@ function transformState(state) {
       for (const address in ab) {
         if (ab[address].chainId === id) {
           ab[address].isEns = false;
-          if (util.normalizeEnsName(ab[address].name)) {
+          if (normalizeEnsName(ab[address].name)) {
             ab[address].isEns = true;
           }
           newAddressBook[id][address] = ab[address];