Merge branch 'main' into bump-dependencies-13-03-2024

Author: montelaidev

docs/contributing.md

@@ -72,17 +72,11 @@ If you're developing your project locally and want to test changes to a package,
 
       > **Example:**
       >
-      > - If you're a member of MetaMask, your project uses Yarn, `@metamask/controller-utils` is listed in dependencies at `^1.1.4`, and your clone of the `core` repo is at the same level as your project, add the following to `resolutions`:
+      > - If your project uses Yarn, `@metamask/controller-utils` is listed in dependencies at `^1.1.4`, and your clone of the `core` repo is at the same level as your project, add the following to `resolutions`:
       >
       >   ```
       >   "@metamask/controller-utils@^1.1.4": "file:../core/packages/controller-utils"
       >   ```
-      >
-      > - If you are an individual contributor, your project uses NPM, `@metamask/assets-controllers` is listed in dependencies at `^3.4.7`, and your fork of the `core` repo is at the same level as your project, add the following to `overrides`:
-      >
-      >   ```
-      >   "@metamask/assets-controllers@^3.4.7": "file:../core/packages/assets-controllers"
-      >   ```
 
    4. Run `yarn install`.
 
@@ -145,17 +139,11 @@ To use a preview build for a package within a project, you need to override the
 
    > **Example:**
    >
-   > - If you're a member of MetaMask, your project uses Yarn, `@metamask/controller-utils` is listed in dependencies at `^1.1.4`, and you want to use the preview version `1.2.3-preview-e2df9b4`, add the following to `resolutions`:
+   > - If your project uses Yarn, `@metamask/controller-utils` is listed in dependencies at `^1.1.4`, and you want to use the preview version `1.2.3-preview-e2df9b4`, add the following to `resolutions`:
    >
    >   ```
    >   "@metamask/controller-utils@^1.1.4": "npm:@metamask-previews/controller-utils@1.2.3-preview-e2df9b4"
    >   ```
-   >
-   > - If you are an individual contributor, your project uses NPM, `@metamask/assets-controllers` is listed in dependencies at `^3.4.7`, and you want to use the preview version `4.5.6-preview-bc2a997` published under `@foo`, add the following to `overrides`:
-   >
-   >   ```
-   >   "@metamask/assets-controllers@^3.4.7": "npm:@foo/assets-controllers@4.5.6-preview-bc2a997"
-   >   ```
 
 4. Run `yarn install`.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/core-monorepo",
-  "version": "125.0.0",
+  "version": "134.0.0",
   "private": true,
   "description": "Monorepo for packages shared between MetaMask clients",
   "repository": {
@@ -85,7 +85,7 @@
     "simple-git-hooks": "^2.8.0",
     "ts-node": "^10.9.1",
     "tsup": "^8.0.2",
-    "typescript": "~4.8.4",
+    "typescript": "~4.9.5",
     "yargs": "^17.7.2"
   },
   "packageManager": "yarn@3.3.0",

packages/accounts-controller/package.json

@@ -63,7 +63,7 @@
     "ts-jest": "^27.1.4",
     "typedoc": "^0.24.8",
     "typedoc-plugin-missing-exports": "^2.0.0",
-    "typescript": "~4.8.4"
+    "typescript": "~4.9.5"
   },
   "peerDependencies": {
     "@metamask/keyring-controller": "^14.0.1",

packages/address-book-controller/package.json

@@ -42,7 +42,7 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^5.0.1",
-    "@metamask/controller-utils": "^9.0.1",
+    "@metamask/controller-utils": "^9.0.2",
     "@metamask/utils": "^8.3.0"
   },
   "devDependencies": {
@@ -53,7 +53,7 @@
     "ts-jest": "^27.1.4",
     "typedoc": "^0.24.8",
     "typedoc-plugin-missing-exports": "^2.0.0",
-    "typescript": "~4.8.4"
+    "typescript": "~4.9.5"
   },
   "engines": {
     "node": ">=16.0.0"

packages/address-book-controller/src/AddressBookController.test.ts

@@ -294,6 +294,13 @@ describe('AddressBookController', () => {
     ).toBe(true);
   });
 
+  it('should return false to indicate an address book entry has NOT been deleted due to unsafe input', () => {
+    const controller = new AddressBookController();
+    // @ts-expect-error Suppressing error to test runtime behavior
+    expect(controller.delete('__proto__', '0x01')).toBe(false);
+    expect(controller.delete(toHex(1), 'constructor')).toBe(false);
+  });
+
   it('should return false to indicate an address book entry has NOT been deleted', () => {
     const controller = new AddressBookController();
     controller.set('0x32Be343B94f860124dC4fEe278FDCBD38C102D88', '0x00');

packages/address-book-controller/src/AddressBookController.ts

@@ -3,6 +3,7 @@ import { BaseControllerV1 } from '@metamask/base-controller';
 import {
   normalizeEnsName,
   isValidHexAddress,
+  isSafeDynamicKey,
   toChecksumHexAddress,
   toHex,
 } from '@metamask/controller-utils';
@@ -110,6 +111,7 @@ export class AddressBookController extends BaseControllerV1<
   delete(chainId: Hex, address: string) {
     address = toChecksumHexAddress(address);
     if (
+      ![chainId, address].every((key) => isSafeDynamicKey(key)) ||
       !isValidHexAddress(address) ||
       !this.state.addressBook[chainId] ||
       !this.state.addressBook[chainId][address]

packages/announcement-controller/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.1.0]
+
+### Added
+
+- Add `resetViewed` method to `AnnouncementController` to reset the `isShown` status for all announcements ([#4088](https://github.com/MetaMask/core/pull/4088))
+
 ## [6.0.1]
 
 ### Fixed
@@ -123,7 +129,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
     All changes listed after this point were applied to this package following the monorepo conversion.
 
-[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/announcement-controller@6.0.1...HEAD
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/announcement-controller@6.1.0...HEAD
+[6.1.0]: https://github.com/MetaMask/core/compare/@metamask/announcement-controller@6.0.1...@metamask/announcement-controller@6.1.0
 [6.0.1]: https://github.com/MetaMask/core/compare/@metamask/announcement-controller@6.0.0...@metamask/announcement-controller@6.0.1
 [6.0.0]: https://github.com/MetaMask/core/compare/@metamask/announcement-controller@5.0.2...@metamask/announcement-controller@6.0.0
 [5.0.2]: https://github.com/MetaMask/core/compare/@metamask/announcement-controller@5.0.1...@metamask/announcement-controller@5.0.2

packages/announcement-controller/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/announcement-controller",
-  "version": "6.0.1",
+  "version": "6.1.0",
   "description": "Manages in-app announcements",
   "keywords": [
     "MetaMask",
@@ -51,7 +51,7 @@
     "ts-jest": "^27.1.4",
     "typedoc": "^0.24.8",
     "typedoc-plugin-missing-exports": "^2.0.0",
-    "typescript": "~4.8.4"
+    "typescript": "~4.9.5"
   },
   "engines": {
     "node": ">=16.0.0"

packages/announcement-controller/src/AnnouncementController.test.ts

@@ -120,6 +120,25 @@ describe('announcement controller', () => {
     expect(controller.state.announcements[3].isShown).toBe(false);
   });
 
+  describe('resetViewed', () => {
+    it('resets all announcement isShown states to false', () => {
+      const controller = new AnnouncementController({
+        messenger: getRestrictedMessenger(),
+        state: state2,
+        allAnnouncements: allAnnouncements2,
+      });
+
+      controller.updateViewed({ 1: true, 3: true });
+      expect(controller.state.announcements[1].isShown).toBe(true);
+      expect(controller.state.announcements[3].isShown).toBe(true);
+
+      controller.resetViewed();
+      Object.values(controller.state.announcements).forEach((announcement) => {
+        expect(announcement.isShown).toBe(false);
+      });
+    });
+  });
+
   describe('update viewed announcements', () => {
     it('should update isShown status', () => {
       const controller = new AnnouncementController({

packages/announcement-controller/src/AnnouncementController.ts

@@ -122,6 +122,17 @@ export class AnnouncementController extends BaseController<
     });
   }
 
+  /**
+   * Resets the isShown status for all announcements
+   */
+  resetViewed(): void {
+    this.update(({ announcements }) => {
+      for (const announcement of Object.values(announcements)) {
+        announcement.isShown = false;
+      }
+    });
+  }
+
   /**
    * Updates the status of the status of the specified announcements
    * once it is read by the user.