Feature/tx local state logs

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/controllers",
-  "version": "6.2.1",
+  "version": "6.2.2",
   "description": "Collection of platform-agnostic modules for creating secure data models for cryptocurrency wallets",
   "license": "MIT",
   "files": [

src/assets/AccountTrackerController.test.ts

@@ -25,6 +25,7 @@ describe('AccountTrackerController', () => {
     controller.context = { PreferencesController: { state: { identities: { [address]: {} } } } } as any;
     await controller.refresh();
     expect(controller.state.accounts[address].balance).toBeDefined();
+    expect(controller.state.accounts[address].importTime).toBeDefined();
   });
 
   it('should sync addresses', () => {
@@ -39,7 +40,9 @@ describe('AccountTrackerController', () => {
     );
     controller.context = { PreferencesController: { state: { identities: { baz: {} } } } } as any;
     controller.refresh();
-    expect(controller.state.accounts).toEqual({ baz: { balance: '0x0' } });
+    expect(controller.state.accounts.baz.balance).toEqual('0x0');
+    expect(controller.state.accounts.baz.importTime).toBeDefined();
+    expect(controller.state.accounts.baz.importTime).toBeLessThanOrEqual(Date.now());
   });
 
   it('should subscribe to new sibling preference controllers', async () => {

src/assets/AccountTrackerController.ts

@@ -10,9 +10,11 @@ import { BNToHex, query, safelyExecuteWithTimeout } from '../util';
  * Account information object
  *
  * @property balance - Hex string of an account balancec in wei
+ * @property importTime - Data time when an account as created/imported
  */
 export interface AccountInformation {
   balance: string;
+  importTime?: number;
 }
 
 /**
@@ -58,7 +60,7 @@ export class AccountTrackerController extends BaseController<AccountTrackerConfi
     const newAddresses = addresses.filter((address) => existing.indexOf(address) === -1);
     const oldAddresses = existing.filter((address) => addresses.indexOf(address) === -1);
     newAddresses.forEach((address) => {
-      accounts[address] = { balance: '0x0' };
+      accounts[address] = { balance: '0x0', importTime: Date.now() };
     });
     oldAddresses.forEach((address) => {
       delete accounts[address];
@@ -142,7 +144,8 @@ export class AccountTrackerController extends BaseController<AccountTrackerConfi
     for (const address in accounts) {
       await safelyExecuteWithTimeout(async () => {
         const balance = await query(this.ethQuery, 'getBalance', [address]);
-        accounts[address] = { balance: BNToHex(balance) };
+        const { importTime } = accounts[address];
+        accounts[address] = { balance: BNToHex(balance), importTime };
         this.update({ accounts: { ...accounts } });
       });
     }

src/transaction/TransactionController.ts

@@ -84,6 +84,15 @@ export enum TransactionStatus {
   unapproved = 'unapproved',
 }
 
+/**
+ * The device that confirmed a transaction.
+ */
+export enum ConfirmedDeviceTransaction {
+  MM_MOBILE = 'meta_mask_mobile',
+  MM_EXTENSION = 'meta_mask_extension',
+  OTHER = 'other_device'
+}
+
 type TransactionMetaBase = {
   isTransfer?: boolean;
   transferInformation?: {
@@ -101,6 +110,7 @@ type TransactionMetaBase = {
   transaction: Transaction;
   transactionHash?: string;
   blockNumber?: string;
+  confirmedLocal?: ConfirmedDeviceTransaction;
 };
 
 /**
@@ -112,6 +122,7 @@ type TransactionMetaBase = {
  * @property id - Generated UUID associated with this transaction
  * @property networkID - Network code as per EIP-155 for this transaction
  * @property origin - Origin this transaction was sent from
+ * @property confirmedLocal - Boolean to indicate if the transaction was confirmed on local device
  * @property rawTransaction - Hex representation of the underlying transaction
  * @property status - String status of this transaction
  * @property time - Timestamp associated with this transaction
@@ -411,9 +422,10 @@ export class TransactionController extends BaseController<TransactionConfig, Tra
    *
    * @param transaction - Transaction object to add
    * @param origin - Domain origin to append to the generated TransactionMeta
+   * @param confirmedDevice - enum to indicate where device the transaction was confirmed to append to the generated TransactionMeta
    * @returns - Object containing a promise resolving to the transaction hash if approved
    */
-  async addTransaction(transaction: Transaction, origin?: string): Promise<Result> {
+  async addTransaction(transaction: Transaction, origin?: string, confirmedLocalDevice?: ConfirmedDeviceTransaction): Promise<Result> {
     const network = this.context.NetworkController as NetworkController;
     const { transactions } = this.state;
     transaction = normalizeTransaction(transaction);
@@ -434,6 +446,7 @@ export class TransactionController extends BaseController<TransactionConfig, Tra
       status: TransactionStatus.unapproved as TransactionStatus.unapproved,
       time: Date.now(),
       transaction,
+      confirmedLocal: confirmedLocalDevice,
     };
 
     try {