Move active campaign concerns to campaign service (#3794)

This moves campaign related logic out of the main service into a
dedicated service. It also causes dismissing campaign banners to clear
and stop triggering notifications about the same topic.

Campaign state is kept within the service db and updates are pushed to
state in redux.


Latest build:
[extension-builds-3794](https://github.com/tahowallet/extension/suites/35331061341/artifacts/2708368343)
(as of Fri, 07 Mar 2025 03:08:56 GMT).

Author: Shadowfiend

background/networks.ts

@@ -422,3 +422,7 @@ export const isEnrichedEVMTransactionRequest = (
   transactionRequest: TransactionRequest,
 ): transactionRequest is EnrichedEVMTransactionRequest =>
   "annotation" in transactionRequest
+
+export const isTransactionWithReceipt = (
+  transaction: AnyEVMTransaction,
+): transaction is ConfirmedEVMTransaction => "status" in transaction

background/redux-slices/selectors/uiSelectors.ts

@@ -37,7 +37,7 @@ export const selectShowingActivityDetail = createSelector(
 )
 
 export const selectActiveCampaigns = createSelector(
-  (state: RootState) => state.ui.activeCampaigns,
+  (state: RootState) => state.ui.campaigns,
   (campaigns) => campaigns,
 )
 

background/redux-slices/ui.ts

@@ -12,6 +12,11 @@ import { createBackgroundAsyncThunk } from "./utils"
 import { UNIXTime } from "../types"
 import { DEFAULT_AUTOLOCK_INTERVAL } from "../services/preferences/defaults"
 import type { RootState } from "."
+import {
+  CampaignIds,
+  Campaigns,
+  FilterCampaignsById,
+} from "../services/campaign/types"
 
 export const defaultSettings = {
   hideDust: false,
@@ -24,15 +29,9 @@ export const defaultSettings = {
   hideBanners: false,
   useFlashbots: false,
   autoLockInterval: DEFAULT_AUTOLOCK_INTERVAL,
+  campaigns: {},
 }
 
-export type MezoClaimStatus =
-  | "not-eligible"
-  | "eligible"
-  | "claimed-sats"
-  | "borrowed"
-  | "campaign-complete"
-
 export type UIState = {
   selectedAccount: AddressOnNetwork
   showingActivityDetailID: string | null
@@ -55,12 +54,15 @@ export type UIState = {
   routeHistoryEntries?: Partial<Location>[]
   slippageTolerance: number
   accountSignerSettings: AccountSignerSettings[]
-  activeCampaigns: {
-    "mezo-claim"?: {
-      dateFrom: string
-      dateTo: string
-      state: MezoClaimStatus
-    }
+  // Active user campaigns
+  campaigns: {
+    /**
+     * Some hash used to invalidate cached data and update UI
+     */
+    [campaignId in CampaignIds]?: FilterCampaignsById<
+      Campaigns,
+      campaignId
+    >["data"]
   }
 }
 
@@ -79,6 +81,7 @@ export type Events = {
   addCustomNetworkResponse: [string, boolean]
   updateAutoLockInterval: number
   toggleShowTestNetworks: boolean
+  clearNotification: string
 }
 
 export const emitter = new Emittery<Events>()
@@ -94,7 +97,7 @@ export const initialState: UIState = {
   snackbarMessage: "",
   slippageTolerance: 0.01,
   accountSignerSettings: [],
-  activeCampaigns: {},
+  campaigns: {},
 }
 
 const uiSlice = createSlice({
@@ -239,21 +242,15 @@ const uiSlice = createSlice({
       ...state,
       settings: { ...state.settings, autoLockInterval: payload },
     }),
-    updateCampaignState: <T extends keyof UIState["activeCampaigns"]>(
+    updateCampaignsState: (
       immerState: UIState,
       {
         payload,
       }: {
-        payload: [T, Partial<UIState["activeCampaigns"][T]>]
+        payload: UIState["campaigns"]
       },
     ) => {
-      const [campaignId, update] = payload
-
-      immerState.activeCampaigns ??= {}
-      immerState.activeCampaigns[campaignId] = {
-        ...immerState.activeCampaigns[campaignId],
-        ...update,
-      }
+      immerState.campaigns = payload
     },
   },
 })
@@ -279,7 +276,7 @@ export const {
   setSlippageTolerance,
   setAccountsSignerSettings,
   setAutoLockInterval,
-  updateCampaignState,
+  updateCampaignsState,
 } = uiSlice.actions
 
 export default uiSlice.reducer
@@ -307,6 +304,13 @@ export const deleteAnalyticsData = createBackgroundAsyncThunk(
   },
 )
 
+export const clearNotification = createBackgroundAsyncThunk(
+  "ui/clearNotification",
+  async (id: string) => {
+    await emitter.emit("clearNotification", id)
+  },
+)
+
 // Async thunk to bubble the setNewDefaultWalletValue action from  store to emitter.
 export const setNewDefaultWalletValue = createBackgroundAsyncThunk(
   "ui/setNewDefaultWalletValue",

background/services/campaign/db.ts

@@ -0,0 +1,48 @@
+import Dexie from "dexie"
+import { CampaignIds, Campaigns, FilterCampaignsById } from "./types"
+
+export class CampaignDatabase extends Dexie {
+  private campaigns!: Dexie.Table<Campaigns, CampaignIds>
+
+  constructor() {
+    super("taho/campaigns")
+
+    this.version(1).stores({
+      campaigns: "&id",
+    })
+  }
+
+  async getActiveCampaigns() {
+    return this.campaigns
+      .toCollection()
+      .filter((campaign) => campaign.enabled)
+      .toArray()
+  }
+
+  async getCampaignData<K extends CampaignIds>(
+    id: K,
+  ): Promise<FilterCampaignsById<Campaigns, K> | undefined> {
+    return this.campaigns.get(id) as Promise<
+      FilterCampaignsById<Campaigns, K> | undefined
+    >
+  }
+
+  async upsertCampaign(campaign: Campaigns): Promise<void> {
+    await this.campaigns.put(campaign)
+  }
+
+  async updateCampaignData<K extends CampaignIds>(
+    id: K,
+    data: Partial<FilterCampaignsById<Campaigns, K>["data"]>,
+  ): Promise<void> {
+    await this.campaigns.toCollection().modify((campaign) => {
+      if (campaign.id === id) {
+        Object.assign(campaign, { data })
+      }
+    })
+  }
+}
+
+export async function getOrCreateDB(): Promise<CampaignDatabase> {
+  return new CampaignDatabase()
+}