feat: Add new metadata properties (#531)

* add metadata properties to `SmartTransactionsController`

* update CHANGELOG

Author: GuillaumeRx

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - This package can now be used in ESM environments as well as CommonJS ([#469](https://github.com/MetaMask/smart-transactions-controller/pull/469))
+- Add two new controller state metadata properties: `includeInStateLogs` and `usedInUi` ([#531](https://github.com/MetaMask/smart-transactions-controller/pull/531))
 
 ### Changed
 

src/SmartTransactionsController.test.ts

@@ -1,4 +1,4 @@
-import { Messenger } from '@metamask/base-controller';
+import { deriveStateFromMetadata, Messenger } from '@metamask/base-controller';
 import {
   NetworkType,
   convertHexToDecimal,
@@ -2531,6 +2531,143 @@ describe('SmartTransactionsController', () => {
       );
     });
   });
+
+  describe('metadata', () => {
+    it('includes expected state in debug snapshots', async () => {
+      await withController(({ controller }) => {
+        expect(
+          deriveStateFromMetadata(
+            controller.state,
+            controller.metadata,
+            'anonymous',
+          ),
+        ).toMatchInlineSnapshot(`
+          {
+            "smartTransactionsState": {
+              "fees": {
+                "approvalTxFees": null,
+                "tradeTxFees": null,
+              },
+              "feesByChainId": {
+                "0x1": {
+                  "approvalTxFees": null,
+                  "tradeTxFees": null,
+                },
+                "0xaa36a7": {
+                  "approvalTxFees": null,
+                  "tradeTxFees": null,
+                },
+              },
+              "liveness": true,
+              "livenessByChainId": {
+                "0x1": true,
+                "0xaa36a7": true,
+              },
+              "smartTransactions": {
+                "0x1": [],
+              },
+              "userOptIn": null,
+              "userOptInV2": null,
+            },
+          }
+        `);
+      });
+    });
+
+    it('includes expected state in state logs', async () => {
+      await withController(({ controller }) => {
+        expect(
+          deriveStateFromMetadata(
+            controller.state,
+            controller.metadata,
+            'includeInStateLogs',
+          ),
+        ).toMatchInlineSnapshot(`
+          {
+            "smartTransactionsState": {
+              "fees": {
+                "approvalTxFees": null,
+                "tradeTxFees": null,
+              },
+              "feesByChainId": {
+                "0x1": {
+                  "approvalTxFees": null,
+                  "tradeTxFees": null,
+                },
+                "0xaa36a7": {
+                  "approvalTxFees": null,
+                  "tradeTxFees": null,
+                },
+              },
+              "liveness": true,
+              "livenessByChainId": {
+                "0x1": true,
+                "0xaa36a7": true,
+              },
+              "smartTransactions": {
+                "0x1": [],
+              },
+              "userOptIn": null,
+              "userOptInV2": null,
+            },
+          }
+        `);
+      });
+    });
+
+    it('persists expected state', async () => {
+      await withController(({ controller }) => {
+        expect(
+          deriveStateFromMetadata(
+            controller.state,
+            controller.metadata,
+            'persist',
+          ),
+        ).toMatchInlineSnapshot(`{}`);
+      });
+    });
+
+    it('includes expected state in UI', async () => {
+      await withController(({ controller }) => {
+        expect(
+          deriveStateFromMetadata(
+            controller.state,
+            controller.metadata,
+            'usedInUi',
+          ),
+        ).toMatchInlineSnapshot(`
+          {
+            "smartTransactionsState": {
+              "fees": {
+                "approvalTxFees": null,
+                "tradeTxFees": null,
+              },
+              "feesByChainId": {
+                "0x1": {
+                  "approvalTxFees": null,
+                  "tradeTxFees": null,
+                },
+                "0xaa36a7": {
+                  "approvalTxFees": null,
+                  "tradeTxFees": null,
+                },
+              },
+              "liveness": true,
+              "livenessByChainId": {
+                "0x1": true,
+                "0xaa36a7": true,
+              },
+              "smartTransactions": {
+                "0x1": [],
+              },
+              "userOptIn": null,
+              "userOptInV2": null,
+            },
+          }
+        `);
+      });
+    });
+  });
 });
 
 type WithControllerCallback<ReturnValue> = ({

src/SmartTransactionsController.ts

@@ -3,6 +3,7 @@ import type {
   ControllerGetStateAction,
   ControllerStateChangeEvent,
   RestrictedMessenger,
+  StateMetadata,
 } from '@metamask/base-controller';
 import {
   query,
@@ -75,10 +76,12 @@ const ETH_QUERY_ERROR_MSG =
  */
 const controllerName = 'SmartTransactionsController';
 
-const controllerMetadata = {
+const controllerMetadata: StateMetadata<SmartTransactionsControllerState> = {
   smartTransactionsState: {
+    includeInStateLogs: true,
     persist: false,
     anonymous: true,
+    usedInUi: true,
   },
 };