Mezoification: Add base state and UI elements

background/constants/networks.ts

@@ -104,7 +104,7 @@ export const ZK_SYNC: EVMNetwork = {
 }
 
 export const MEZO_TESTNET: EVMNetwork = {
-  name: "Matsnet",
+  name: "Mezo matsnet",
   baseAsset: MEZO_BTC,
   chainID: "31611",
   family: "EVM",
@@ -169,7 +169,7 @@ export const NETWORK_BY_CHAIN_ID = {
 }
 
 export const TEST_NETWORK_BY_CHAIN_ID = new Set(
-  [SEPOLIA, ARBITRUM_SEPOLIA].map((network) => network.chainID),
+  [MEZO_TESTNET, SEPOLIA, ARBITRUM_SEPOLIA].map((network) => network.chainID),
 )
 
 // Networks that are not added to this struct will

background/lib/mezo.ts

@@ -0,0 +1,28 @@
+import { Interface } from "ethers/lib/utils"
+import { AnyEVMTransaction, sameNetwork } from "../networks"
+import { MEZO_TESTNET } from "../constants"
+import { sameEVMAddress } from "./utils"
+
+const BORROWER_CONTRACT_ADDRESS = "0x20fAeA18B6a1D0FCDBCcFfFe3d164314744baF30"
+
+const BorrowerABI = new Interface([
+  "function openTrove(uint256 _maxFeePercentage, uint256 debtAmount, uint256 _assetAmount, address _upperHint, address _lowerHint)",
+])
+
+// eslint-disable-next-line import/prefer-default-export
+export const checkIsBorrowingTx = (tx: AnyEVMTransaction) => {
+  if (
+    !sameNetwork(tx.network, MEZO_TESTNET) ||
+    !tx.blockHash ||
+    !sameEVMAddress(tx.to, BORROWER_CONTRACT_ADDRESS)
+  ) {
+    return false
+  }
+
+  try {
+    const data = BorrowerABI.decodeFunctionData("openTrove", tx.input ?? "")
+    return data.debtAmount > 0n
+  } catch (error) {
+    return false
+  }
+}

background/redux-slices/selectors/networks.ts

@@ -28,3 +28,11 @@ export const selectCustomNetworks = createSelector(
       (network) => !DEFAULT_NETWORKS_BY_CHAIN_ID.has(network.chainID),
     ),
 )
+
+export const selectTestnetNetworks = createSelector(
+  selectEVMNetworks,
+  (evmNetworks) =>
+    evmNetworks.filter((network) =>
+      TEST_NETWORK_BY_CHAIN_ID.has(network.chainID),
+    ),
+)

background/redux-slices/selectors/uiSelectors.ts

@@ -36,6 +36,11 @@ export const selectShowingActivityDetail = createSelector(
   },
 )
 
+export const selectActiveCampaigns = createSelector(
+  (state: RootState) => state.ui.activeCampaigns,
+  (campaigns) => campaigns,
+)
+
 export const selectCurrentAddressNetwork = createSelector(
   (state: RootState) => state.ui.selectedAccount,
   (selectedAccount) => selectedAccount,

background/redux-slices/ui.ts

@@ -1,7 +1,7 @@
 import { createSlice, createSelector } from "@reduxjs/toolkit"
 import Emittery from "emittery"
 import { AddressOnNetwork } from "../accounts"
-import { ETHEREUM } from "../constants"
+import { ETHEREUM, TEST_NETWORK_BY_CHAIN_ID } from "../constants"
 import { AnalyticsEvent, OneTimeAnalyticsEvent } from "../lib/posthog"
 import { EVMNetwork } from "../networks"
 import { AnalyticsPreferences, DismissableItem } from "../services/preferences"
@@ -11,11 +11,12 @@ import { AccountState, addAddressNetwork } from "./accounts"
 import { createBackgroundAsyncThunk } from "./utils"
 import { UNIXTime } from "../types"
 import { DEFAULT_AUTOLOCK_INTERVAL } from "../services/preferences/defaults"
+import type { RootState } from "."
 
 export const defaultSettings = {
   hideDust: false,
   defaultWallet: false,
-  showTestNetworks: false,
+  showTestNetworks: true,
   showNotifications: undefined,
   collectAnalytics: false,
   showAnalyticsNotification: false,
@@ -25,6 +26,13 @@ export const defaultSettings = {
   autoLockInterval: DEFAULT_AUTOLOCK_INTERVAL,
 }
 
+export type MezoClaimStatus =
+  | "not-eligible"
+  | "eligible"
+  | "claimed-sats"
+  | "borrowed"
+  | "campaign-complete"
+
 export type UIState = {
   selectedAccount: AddressOnNetwork
   showingActivityDetailID: string | null
@@ -47,6 +55,13 @@ export type UIState = {
   routeHistoryEntries?: Partial<Location>[]
   slippageTolerance: number
   accountSignerSettings: AccountSignerSettings[]
+  activeCampaigns: {
+    "mezo-claim"?: {
+      dateFrom: string
+      dateTo: string
+      state: MezoClaimStatus
+    }
+  }
 }
 
 export type Events = {
@@ -63,6 +78,7 @@ export type Events = {
   updateAnalyticsPreferences: Partial<AnalyticsPreferences>
   addCustomNetworkResponse: [string, boolean]
   updateAutoLockInterval: number
+  toggleShowTestNetworks: boolean
 }
 
 export const emitter = new Emittery<Events>()
@@ -78,6 +94,7 @@ export const initialState: UIState = {
   snackbarMessage: "",
   slippageTolerance: 0.01,
   accountSignerSettings: [],
+  activeCampaigns: {},
 }
 
 const uiSlice = createSlice({
@@ -222,6 +239,22 @@ const uiSlice = createSlice({
       ...state,
       settings: { ...state.settings, autoLockInterval: payload },
     }),
+    updateCampaignState: <T extends keyof UIState["activeCampaigns"]>(
+      immerState: UIState,
+      {
+        payload,
+      }: {
+        payload: [T, Partial<UIState["activeCampaigns"][T]>]
+      },
+    ) => {
+      const [campaignId, update] = payload
+
+      immerState.activeCampaigns ??= {}
+      immerState.activeCampaigns[campaignId] = {
+        ...immerState.activeCampaigns[campaignId],
+        ...update,
+      }
+    },
   },
 })
 
@@ -246,6 +279,7 @@ export const {
   setSlippageTolerance,
   setAccountsSignerSettings,
   setAutoLockInterval,
+  updateCampaignState,
 } = uiSlice.actions
 
 export default uiSlice.reducer
@@ -360,6 +394,22 @@ export const setSelectedNetwork = createBackgroundAsyncThunk(
   },
 )
 
+export const toggleShowTestNetworks = createBackgroundAsyncThunk(
+  "ui/toggleShowTestNetworks",
+  async (value: boolean, { dispatch, getState }) => {
+    const state = getState() as RootState
+
+    const currentNetwork = state.ui.selectedAccount.network
+
+    // If user is on one of the built-in test networks, don't leave them stranded
+    if (TEST_NETWORK_BY_CHAIN_ID.has(currentNetwork.chainID)) {
+      dispatch(setSelectedNetwork(ETHEREUM))
+    }
+
+    await emitter.emit("toggleShowTestNetworks", value)
+  },
+)
+
 export const refreshBackgroundPage = createBackgroundAsyncThunk(
   "ui/refreshBackgroundPage",
   async () => {

background/services/analytics/index.ts

@@ -31,6 +31,8 @@ interface Events extends ServiceLifecycleEvents {
  * handling sending and persistance concerns.
  */
 export default class AnalyticsService extends BaseService<Events> {
+  #analyticsUUID: string | undefined = undefined
+
   /*
    * Create a new AnalyticsService. The service isn't initialized until
    * startService() is called and resolved.
@@ -93,6 +95,7 @@ export default class AnalyticsService extends BaseService<Events> {
 
   protected override async internalStartService(): Promise<void> {
     await super.internalStartService()
+    const { uuid, isNew } = await this.getOrCreateAnalyticsUUID()
 
     let { isEnabled, hasDefaultOnBeenTurnedOn } =
       await this.preferenceService.getAnalyticsPreferences()
@@ -114,8 +117,6 @@ export default class AnalyticsService extends BaseService<Events> {
     }
 
     if (isEnabled) {
-      const { uuid, isNew } = await this.getOrCreateAnalyticsUUID()
-
       browser.runtime.setUninstallURL(
         process.env.NODE_ENV === "development"
           ? "about:blank"
@@ -126,6 +127,8 @@ export default class AnalyticsService extends BaseService<Events> {
         await this.sendAnalyticsEvent(AnalyticsEvent.NEW_INSTALL)
       }
     }
+
+    this.#analyticsUUID = uuid
   }
 
   protected override async internalStopService(): Promise<void> {
@@ -134,6 +137,15 @@ export default class AnalyticsService extends BaseService<Events> {
     await super.internalStopService()
   }
 
+  get analyticsUUID() {
+    if (!this.#analyticsUUID) {
+      throw new Error(
+        "Attempted to access analytics UUID before service started",
+      )
+    }
+    return this.#analyticsUUID
+  }
+
   async sendAnalyticsEvent(
     eventName: AnalyticsEvent,
     payload?: Record<string, unknown>,

background/services/notifications/index.ts

@@ -68,12 +68,8 @@ export default class NotificationsService extends BaseService<Events> {
     // does guard this, but if that ends up not being true, browser.notifications
     // will be undefined and all of this will explode.
 
-    this.preferenceService.emitter.on(
-      "initializeNotificationsPreferences",
-      async (isPermissionGranted) => {
-        this.isPermissionGranted = isPermissionGranted
-      },
-    )
+    this.isPermissionGranted =
+      await this.preferenceService.getShouldShowNotificationsPreferences()
 
     this.preferenceService.emitter.on(
       "setNotificationsPermission",
@@ -130,6 +126,7 @@ export default class NotificationsService extends BaseService<Events> {
       message: string
       contextMessage?: string
       type?: browser.Notifications.TemplateType
+      onDismiss?: () => void
     }
     callback?: () => void
   }) {
@@ -138,17 +135,25 @@ export default class NotificationsService extends BaseService<Events> {
     }
     const notificationId = uniqueId("notification-")
 
+    const { onDismiss = () => {}, ...createNotificationOptions } = options
+
     const notificationOptions = {
       type: "basic" as browser.Notifications.TemplateType,
       iconUrl: TAHO_ICON_URL,
-      ...options,
+      ...createNotificationOptions,
     }
 
     if (typeof callback === "function") {
       this.clickHandlers[notificationId] = callback
     }
 
     browser.notifications.create(notificationId, notificationOptions)
+
+    browser.notifications.onClosed.addListener((id, byUser) => {
+      if (id === notificationId && byUser) {
+        onDismiss()
+      }
+    })
   }
 
   public notifyXPDrop(callback?: () => void): void {

background/services/preferences/db.ts

@@ -65,6 +65,7 @@ export type Preferences = {
   analytics: AnalyticsPreferences
   autoLockInterval: UNIXTime
   shouldShowNotifications: boolean
+  showTestNetworks: boolean
 }
 
 /**
@@ -76,12 +77,17 @@ export type ManuallyDismissableItem =
   | "analytics-enabled-banner"
   | "copy-sensitive-material-warning"
   | "testnet-portal-is-open-banner"
+
 /**
  * Items that the user will see once and will not be auto-displayed again. Can
  * be used for tours, or for popups that can be retriggered but will not
  * auto-display more than once.
  */
-export type SingleShotItem = "default-connection-popover"
+export type SingleShotItem =
+  | "default-connection-popover"
+  | "mezo-eligible-notification"
+  | "mezo-borrow-notification"
+  | "mezo-nft-notification"
 
 /**
  * Items that the user will view one time and either manually dismiss or that
@@ -434,6 +440,19 @@ export class PreferenceDatabase extends Dexie {
         }),
     )
 
+    this.version(22).upgrade((tx) =>
+      tx
+        .table("preferences")
+        .toCollection()
+        .modify((storedPreferences: Omit<Preferences, "showTestNetworks">) => {
+          const update: Partial<Preferences> = {
+            showTestNetworks: true,
+          }
+
+          Object.assign(storedPreferences, update)
+        }),
+    )
+
     // This is the old version for populate
     // https://dexie.org/docs/Dexie/Dexie.on.populate-(old-version)
     // The this does not behave according the new docs, but works
@@ -463,6 +482,16 @@ export class PreferenceDatabase extends Dexie {
       })
   }
 
+  async setShowTestNetworks(newValue: boolean): Promise<void> {
+    await this.preferences
+      .toCollection()
+      .modify((storedPreferences: Preferences) => {
+        const update: Partial<Preferences> = { showTestNetworks: newValue }
+
+        Object.assign(storedPreferences, update)
+      })
+  }
+
   async setShouldShowNotifications(newValue: boolean): Promise<void> {
     await this.preferences
       .toCollection()

background/services/preferences/defaults.ts

@@ -35,6 +35,7 @@ const defaultPreferences = {
   },
   autoLockInterval: DEFAULT_AUTOLOCK_INTERVAL,
   shouldShowNotifications: false,
+  showTestNetworks: true,
 }
 
 export default defaultPreferences