Merge branch 'v2' into refactor/performance-optimizations-mobile

Author: sonytooo

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.90.4",
+  "version": "2.91.0",
   "name": "ambire-common",
   "description": "Common ground for the Ambire apps",
   "scripts": {

src/consts/gasTankFeeTokens.ts

@@ -337,6 +337,13 @@ export default [
     icon: 'https://assets.coingecko.com/coins/images/17266/small/amWETH_2x.png',
     hiddenOnError: true
   },
+  {
+    address: '0x6440f144b7e50D6a8439336510312d2F54beB01D',
+    symbol: 'BOLD',
+    chainId: 1n,
+    decimals: 18,
+    icon: 'https://assets.coingecko.com/coins/images/56069/standard/BOLD_logo.png?1748265087'
+  },
   {
     address: '0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270',
     symbol: 'wmatic',

src/consts/safe.ts

@@ -1,6 +1,6 @@
 /**
- * A non-exclusive list of networks that safe accounts are supported on.
- * We will use this list to know where to search for safe accounts
+ * A non-exclusive list of networks that Safe accounts are supported on.
+ * We will use this list to know where to search for Safe accounts
  * and in accordance with the enabled user networks
  */
 export const SAFE_NETWORKS = [
@@ -9,7 +9,7 @@ export const SAFE_NETWORKS = [
 ]
 
 /**
- * Information about safe contract addresses by their versions
+ * Information about Safe contract addresses by their versions
  */
 const vOneThree = {
   singleton: '0xd9Db270c1B5E3Bd161E8c8503c55cEABeE709552'
@@ -25,14 +25,14 @@ export const execTransactionAbi = [
   'function execTransaction(address to,uint256 value,bytes calldata data,uint8 operation,uint256 safeTxGas,uint256 baseGas,uint256 gasPrice,address gasToken,address payable refundReceiver,bytes memory signatures)'
 ]
 /**
- * In order to do batching, safe needs an extra contract helper called multisend
- * This is the latest contract and it's safe to use across versions
+ * In order to do batching, Safe needs an extra contract helper called multisend
+ * This is the latest contract and it's Safe to use across versions
  */
 export const multiSendAddr = '0x9641d764fc13c8B624c04430C7356C1C7C8102e2'
 
 /**
- * In order to do batching, safe needs an extra contract helper called multisend
- * This is the latest contract and it's safe to use across versions
+ * In order to do batching, Safe needs an extra contract helper called multisend
+ * This is the latest contract and it's Safe to use across versions
  */
 export const safeNullOwner = '0x0000000000000000000000000000000000000002'
 

src/controllers/activity/activity.ts

@@ -489,7 +489,7 @@ export class ActivityController extends EventEmitter implements IActivityControl
     const portfoliosToUpdate: PortfoliosToUpdate = {}
     const updatedAccountsOps: SubmittedAccountOp[] = []
 
-    // we should fetch safe txns again upon failure
+    // we should fetch Safe txns again upon failure
     let shouldFetchSafeTxns = false
 
     // Use this flag to make the auto-refresh slower with the passege of time.
@@ -632,7 +632,7 @@ export class ActivityController extends EventEmitter implements IActivityControl
                       this.#portfolio.addTokensToBeLearned(foundTokens, accountOp.chainId)
                     }
                   } else {
-                    // if the txn resulted in a failure, unresolve all safe txns
+                    // if the txn resulted in a failure, unresolve all Safe txns
                     // with the same nonce so that the user can retry
                     const acc = this.#accounts.accounts.find(
                       (a) => a.addr === accountOp.accountAddr

src/controllers/autoLogin/autoLogin.ts

@@ -296,7 +296,7 @@ export class AutoLoginController extends EventEmitter implements IAutoLoginContr
     accountKeys: Key[],
     account: Account
   ): 'no-policy' | 'expired' | 'valid-policy' | 'unsupported' {
-    // disable the auto login for safe accounts
+    // disable the auto login for Safe accounts
     if (account.safeCreation) return 'unsupported'
 
     const accountPolicies = this.getAccountPolicies(parsedSiwe.address)

src/controllers/continuousUpdates/continuousUpdates.ts

@@ -361,7 +361,7 @@ export class ContinuousUpdatesController extends EventEmitter {
     if (!this.#main.selectedAccount.account || !this.#main.selectedAccount.account.safeCreation)
       return
 
-    // do not make safe requests if the extension is locked
+    // do not make Safe requests if the extension is locked
     if (!this.#main.keystore.isUnlocked) return
 
     const pendingSafeTxns = this.#main.requests.userRequests
@@ -383,7 +383,7 @@ export class ContinuousUpdatesController extends EventEmitter {
     if (!pendingSafeTxns.length) return
 
     const confirmed = await this.#main.safe.fetchExecuted(pendingSafeTxns).catch((e) => {
-      console.log('failed to retrieve executed safe txns')
+      console.log('failed to retrieve executed Safe txns')
       return []
     })
     if (!confirmed.length) return
@@ -419,14 +419,14 @@ export class ContinuousUpdatesController extends EventEmitter {
             fromRequestId: userR.id
           })
           .catch((e: Error) => {
-            console.log('could not resolve safe global request')
+            console.log('could not resolve Safe Global request')
             console.log(e)
             return e
           })
         if (commonSuccessHandler instanceof Error) continue
 
         await this.#main.resolveAccountOpRequest(submittedAccountOp, userR.id, false).catch((e) => {
-          console.log('could not resolve safe global request')
+          console.log('could not resolve Safe Global request')
           console.log(e)
         })
 

src/controllers/main/main.ts

@@ -1008,7 +1008,7 @@ export class MainController extends EventEmitter implements IMainController {
     // Error handling on the prev step will notify the user, it's fine to return here
     if (!signedMessage) return
 
-    // some accounts may not resolve immediately, like a safe acc
+    // some accounts may not resolve immediately, like a Safe acc
     if (this.signMessage.status === SignMessageStatus.Done) {
       await this.#resolveSignMessage(signedMessage)
     } else if (this.signMessage.status === SignMessageStatus.Partial) {
@@ -1339,7 +1339,7 @@ export class MainController extends EventEmitter implements IMainController {
   }
 
   /**
-   * Fetch safe txns from safe global and make them user requests
+   * Fetch Safe txns from Safe Global and make them user requests
    * if the selected account is a safe
    */
   async fetchSafeTxns(chainIds: bigint[] = [], forceRefetch = false) {
@@ -1379,7 +1379,7 @@ export class MainController extends EventEmitter implements IMainController {
         .fetchPending(safeAddr, [firstBatch])
         .catch((e) => {
           console.log(e)
-          console.log('failed to retrieve pending safe txns')
+          console.log('failed to retrieve pending Safe txns')
           return null
         })
 
@@ -1568,7 +1568,7 @@ export class MainController extends EventEmitter implements IMainController {
       })
     }
 
-    // upon resolving an account op, check all same nonce safe requests and remove them
+    // upon resolving an account op, check all same nonce Safe requests and remove them
     const safeRequests = this.requests.getSameNonceSafeRequests(requestId).map((r) => r.id)
 
     if (safeRequests.length) {

src/controllers/requests/requests.test.ts

@@ -1,8 +1,6 @@
 import { describe, expect, test } from '@jest/globals'
 
-import { relayerUrl } from '../../../test/config'
 import { makeMainController } from '../../../test/helpers/mainController'
-import { mockUiManager } from '../../../test/helpers/ui'
 import { Session } from '../../classes/session'
 import {
   BenzinUserRequest,
@@ -11,9 +9,7 @@ import {
   UserRequest
 } from '../../interfaces/userRequest'
 import { generateUuid } from '../../utils/uuid'
-import { EventEmitterRegistryController } from '../eventEmitterRegistry/eventEmitterRegistry'
 import { SignAccountOpController } from '../signAccountOp/signAccountOp'
-import { RequestsController } from './requests'
 
 const MOCK_SESSION = new Session({ tabId: 1, url: 'https://test-dApp.com' })
 
@@ -66,12 +62,12 @@ const accounts = [
 ]
 
 const prepareTest = async () => {
-  const { uiManager, getWindowId, eventEmitter: event } = mockUiManager()
-
-  const { mainCtrl } = await makeMainController(async (storageCtrl) => {
-    await storageCtrl.set('accounts', accounts)
-    await storageCtrl.set('selectedAccount', '0x77777777789A8BBEE6C64381e5E89E501fb0e4c8')
-  })
+  const { mainCtrl, eventEmitterRegistry, getWindowId, eventEmitter } = await makeMainController(
+    async (storageCtrl) => {
+      await storageCtrl.set('accounts', accounts)
+      await storageCtrl.set('selectedAccount', '0x77777777789A8BBEE6C64381e5E89E501fb0e4c8')
+    }
+  )
 
   // Mock account states for all accounts
   for (const account of mainCtrl.accounts.accounts) {
@@ -100,8 +96,6 @@ const prepareTest = async () => {
     }
   }
 
-  const eventEmitterRegistry = new EventEmitterRegistryController(() => null)
-
   const getSignAccountOp = async ({
     addr,
     chainId,
@@ -185,40 +179,14 @@ const prepareTest = async () => {
     } as CallsUserRequest
   }
 
-  const requestsController = new RequestsController({
-    relayerUrl,
-    callRelayer: mainCtrl.callRelayer,
-    portfolio: mainCtrl.portfolio,
-    externalSignerControllers: {},
-    activity: mainCtrl.activity,
-    phishing: mainCtrl.phishing,
-    accounts: mainCtrl.accounts,
-    networks: mainCtrl.networks,
-    providers: mainCtrl.providers,
-    selectedAccount: mainCtrl.selectedAccount,
-    keystore: mainCtrl.keystore,
-    transfer: mainCtrl.transfer,
-    swapAndBridge: mainCtrl.swapAndBridge,
-    ui: uiManager as any, // eslint-disable-line @typescript-eslint/no-explicit-any
-    safe: mainCtrl.safe,
-    autoLogin: mainCtrl.autoLogin,
-    getDapp: async () => undefined,
-    updateSelectedAccountPortfolio: () => Promise.resolve(),
-    addTokensToBeLearned: () => {},
-    onSetCurrentUserRequest: () => {},
-    onBroadcastSuccess: async () => {},
-    onBroadcastFailed: () => {},
-    eventEmitterRegistry,
-    shouldSimulateAccountOps: false
-  })
-
   return {
     selectedAccountCtrl: mainCtrl.selectedAccount,
-    controller: requestsController,
+    controller: mainCtrl.requests,
     getSignAccountOp,
     getCallsRequest,
-    event,
-    getWindowId
+    event: eventEmitter,
+    getWindowId,
+    uiCtrl: mainCtrl.ui
   }
 }
 
@@ -241,11 +209,6 @@ describe('RequestsController ', () => {
   beforeEach(() => {
     jest.restoreAllMocks()
   })
-  test('Init controller', async () => {
-    const { controller } = await prepareTest()
-    expect(controller.initialLoadPromise).toBeInstanceOf(Promise)
-    await expect(controller.initialLoadPromise).resolves.toBeUndefined()
-  })
 
   test('Add and then remove a user request', async () => {
     const { controller, getCallsRequest } = await prepareTest()

src/controllers/requests/requests.ts

@@ -181,7 +181,7 @@ export class RequestsController extends EventEmitter implements IRequestsControl
 
   #currentUserRequest: UserRequest | null = null
 
-  #shouldSimulateAccountOps = true
+  private shouldSimulateAccountOps = true
 
   get currentUserRequest() {
     return this.#currentUserRequest
@@ -281,7 +281,7 @@ export class RequestsController extends EventEmitter implements IRequestsControl
     this.#onSetCurrentUserRequest = onSetCurrentUserRequest
     this.#onBroadcastSuccess = onBroadcastSuccess
     this.#onBroadcastFailed = onBroadcastFailed
-    this.#shouldSimulateAccountOps = shouldSimulateAccountOps
+    this.shouldSimulateAccountOps = shouldSimulateAccountOps
 
     this.#ui.window.event.on('windowRemoved', async (winId: number) => {
       // When windowManager.focus is called, it may close and reopen the request window as part of its fallback logic.
@@ -461,14 +461,15 @@ export class RequestsController extends EventEmitter implements IRequestsControl
 
         // Even without an initialized SignAccountOpController or Screen, we should still update the portfolio and run the simulation.
         // It's necessary to continue operating with the token `amountPostSimulation` amount.
-        // eslint-disable-next-line @typescript-eslint/no-floating-promises
-        this.#portfolio.simulateAccountOp(req.signAccountOp.accountOp)
+        if (this.shouldSimulateAccountOps)
+          // eslint-disable-next-line @typescript-eslint/no-floating-promises
+          this.#portfolio.simulateAccountOp(req.signAccountOp.accountOp)
       } else if (req.kind === 'typedMessage' || req.kind === 'message' || req.kind === 'siwe') {
         const existingMessageRequest = this.userRequests.find(
           (r) => r.kind === req.kind && r.meta.accountAddr === req.meta.accountAddr
         ) as PlainTextMessageUserRequest | TypedMessageUserRequest | undefined
 
-        // remove the request only if it's not a safe req
+        // remove the request only if it's not a Safe req
         if (existingMessageRequest && !this.#selectedAccount.account?.safeCreation) {
           existingMessageRequest.meta.accountAddr
           await this.rejectUserRequests('User rejected the message request', [
@@ -861,7 +862,7 @@ export class RequestsController extends EventEmitter implements IRequestsControl
           })
         }
 
-        // if it's a safe txn:
+        // if it's a Safe txn:
         // - reject it upon a normal reject req;
         // - resolve it on accountOp resolve
 
@@ -907,7 +908,7 @@ export class RequestsController extends EventEmitter implements IRequestsControl
       }
     })
 
-    // reject all safe txns so they do not appear by accident again
+    // reject all Safe txns so they do not appear by accident again
     if (safeRejectIds.length) await this.#safe.rejectTxnId(safeRejectIds)
     if (safeResolveIds.length) await this.#safe.resolveTxnId(safeResolveIds)
 
@@ -1450,7 +1451,7 @@ export class RequestsController extends EventEmitter implements IRequestsControl
       dappPromises: [],
       meta: {
         // basically, it's the same eip-712 message but one is coming
-        // from safe with the safe typehints, and other is ethers
+        // from Safe with the Safe typehints, and other is ethers
         params: typedData as {
           domain: TypedDataDomain
           types: Record<string, Array<TypedDataField>>
@@ -1749,7 +1750,7 @@ export class RequestsController extends EventEmitter implements IRequestsControl
     if (existingUserRequest) {
       // Prevent updating the signAccountOp if a signing or broadcasting process is already in progress for the same account and chain.
       if (existingUserRequest.signAccountOp.signAndBroadcastPromise) {
-        // if the update is coming from safe global, just ignore it
+        // if the update is coming from Safe Global, just ignore it
         if (meta.safeTxnProps) return
 
         const errorMessage =
@@ -1841,7 +1842,7 @@ export class RequestsController extends EventEmitter implements IRequestsControl
           : new Promise(() => {}) // Explicitly never-resolving promise
       ])) as any
 
-      // do not build requests for expired safe txns
+      // do not build requests for expired Safe txns
       if (meta.safeTxnProps?.nonce && meta.safeTxnProps?.nonce < accountState.nonce) return
 
       const network = this.#networks.networks.find((n) => n.chainId === meta.chainId)!
@@ -1888,7 +1889,7 @@ export class RequestsController extends EventEmitter implements IRequestsControl
             safeTx: meta.safeTx,
             meta
           },
-          shouldSimulate: this.#shouldSimulateAccountOps,
+          shouldSimulate: this.shouldSimulateAccountOps,
           onUpdateAfterTraceCallSuccess: async () => {
             await this.#portfolio.updateSelectedAccount(account.addr, [network])
           },