refactor: rename "popup" transient state to transient state (#1319)

Author: sidvishnoi

src/background/services/background.ts

@@ -147,7 +147,7 @@ export class Background {
       consentTelemetry,
       connected,
       publicKey,
-      transientState: this.storage.getPopupTransientState(),
+      transientState: this.storage.getTransientState(),
     };
   }
 
@@ -459,7 +459,7 @@ export class Background {
       void this.tabEvents.updateVisualIndicators(tab);
     });
 
-    this.events.on('storage.popup_transient_state_update', (state) => {
+    this.events.on('storage.transient_state_update', (state) => {
       this.sendToPopup.send('SET_TRANSIENT_STATE', state);
       this.sendToApp.send('SET_TRANSIENT_STATE', state);
     });

src/background/services/events.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'node:events';
 import type {
   AmountValue,
-  PopupTransientState,
+  TransientState,
   Storage,
   TabId,
 } from '@/shared/types';
@@ -16,7 +16,7 @@ interface BackgroundEvents {
     state: Storage['state'];
     prevState: Storage['state'];
   };
-  'storage.popup_transient_state_update': PopupTransientState;
+  'storage.transient_state_update': TransientState;
   'storage.balance_update': Record<
     'recurring' | 'oneTime' | 'total',
     AmountValue

src/background/services/keyAutoAdd.ts

@@ -189,14 +189,14 @@ export class KeyAutoAddService {
   }
 
   private setConnectState(currentStep: string) {
-    this.storage.setPopupTransientState('connect', () => ({
+    this.storage.setTransientState('connect', () => ({
       status: 'connecting:key',
       currentStep,
     }));
   }
 
   private setConnectStateError(err: ErrorWithKeyLike | { message: string }) {
-    this.storage.setPopupTransientState('connect', () => ({
+    this.storage.setTransientState('connect', () => ({
       status: 'error:key',
       error: isErrorWithKey(err) ? errorWithKeyToJSON(err) : err.message,
     }));

src/background/services/monetization.ts

@@ -436,7 +436,7 @@ export class MonetizationService {
       ...dataFromStorage,
       balance: balance.total.toString(),
       tab: this.tabState.getPopupTabData(tab),
-      transientState: this.storage.getPopupTransientState(),
+      transientState: this.storage.getTransientState(),
       grants: {
         oneTime: oneTimeGrant?.amount,
         recurring: recurringGrant?.amount,

src/background/services/storage.ts

@@ -2,7 +2,7 @@ import type {
   AmountValue,
   ExtensionState,
   GrantDetails,
-  PopupTransientState,
+  TransientState,
   Storage,
   StorageKey,
   WalletAmount,
@@ -48,7 +48,7 @@ export class StorageService {
   // used as an optimization/cache
   private currentState: Storage['state'] | null = null;
 
-  private popupTransientState: PopupTransientState = {};
+  private transientState: TransientState = {};
 
   constructor({ browser, events }: Cradle) {
     Object.assign(this, { browser, events });
@@ -211,19 +211,19 @@ export class StorageService {
     this.events.emit('storage.rate_of_pay_update', { rate });
   }
 
-  setPopupTransientState<T extends keyof PopupTransientState>(
+  setTransientState<T extends keyof TransientState>(
     id: T,
-    update: (prev?: PopupTransientState[T]) => PopupTransientState[T],
+    update: (prev?: TransientState[T]) => TransientState[T],
   ) {
-    const newState = update(this.popupTransientState[id]);
-    this.popupTransientState[id] = newState;
+    const newState = update(this.transientState[id]);
+    this.transientState[id] = newState;
 
-    const state = this.getPopupTransientState();
-    this.events.emit('storage.popup_transient_state_update', state);
+    const state = this.getTransientState();
+    this.events.emit('storage.transient_state_update', state);
   }
 
-  getPopupTransientState(): PopupTransientState {
-    return this.popupTransientState;
+  getTransientState(): TransientState {
+    return this.transientState;
   }
 }
 

src/background/services/wallet.ts

@@ -529,18 +529,18 @@ export class WalletService {
   }
 
   public resetConnectState() {
-    this.storage.setPopupTransientState('connect', () => null);
+    this.storage.setTransientState('connect', () => null);
   }
 
   private setConnectState(currentStep: string) {
-    this.storage.setPopupTransientState('connect', () => ({
+    this.storage.setTransientState('connect', () => ({
       status: 'connecting',
       currentStep,
     }));
   }
 
   private setConnectStateError(err: ErrorWithKeyLike | { message: string }) {
-    this.storage.setPopupTransientState('connect', (state) => {
+    this.storage.setTransientState('connect', (state) => {
       if (state?.status === 'error:key') {
         return state;
       }

src/pages/app/lib/store.ts

@@ -1,14 +1,10 @@
-import type {
-  AppStore,
-  DeepNonNullable,
-  PopupTransientState,
-} from '@/shared/types';
+import type { AppStore, DeepNonNullable, TransientState } from '@/shared/types';
 import { proxy, useSnapshot } from 'valtio';
 
 export type AppState = Required<DeepNonNullable<AppStore>>;
 
 export const store = proxy<AppState>({
-  transientState: {} as PopupTransientState,
+  transientState: {} as TransientState,
 } as AppState);
 
 // easier access to the store via this hook
@@ -36,7 +32,7 @@ export const dispatch = ({ type, data }: Actions) => {
 };
 
 type Actions =
-  | { type: 'SET_TRANSIENT_STATE'; data: PopupTransientState }
+  | { type: 'SET_TRANSIENT_STATE'; data: TransientState }
   | {
       type: 'SET_CONSENT';
       data: {

src/pages/popup/components/ConnectWalletForm.tsx

@@ -30,7 +30,7 @@ import type {
   ConnectWalletAddressInfo,
   Response,
 } from '@/shared/messages';
-import type { DeepReadonly, PopupTransientState } from '@/shared/types';
+import type { DeepReadonly, TransientState } from '@/shared/types';
 
 interface Inputs {
   walletAddressUrl: string;
@@ -39,7 +39,7 @@ interface Inputs {
   autoKeyAddConsent: boolean;
 }
 
-type ConnectTransientState = DeepReadonly<PopupTransientState['connect']>;
+type ConnectTransientState = DeepReadonly<TransientState['connect']>;
 type ErrorsParams = 'walletAddressUrl' | 'amount' | 'keyPair' | 'connect';
 type Errors = Record<ErrorsParams, ErrorInfo | null>;
 

src/shared/messages.ts

@@ -5,7 +5,7 @@ import type {
 import type { Browser } from 'webextension-polyfill';
 import type {
   AmountValue,
-  PopupTransientState,
+  TransientState,
   Storage,
   WalletInfo,
 } from '@/shared/types';
@@ -334,7 +334,7 @@ export interface BackgroundToPopupMessagesMap {
   SET_BALANCE: Record<'recurring' | 'oneTime' | 'total', AmountValue>;
   SET_TAB_DATA: PopupState['tab'];
   SET_STATE: { state: Storage['state']; prevState: Storage['state'] };
-  SET_TRANSIENT_STATE: PopupTransientState;
+  SET_TRANSIENT_STATE: TransientState;
   CLOSE_POPUP: undefined;
 }
 
@@ -350,7 +350,7 @@ export type BackgroundToPopupMessage = {
 export const BACKGROUND_TO_APP_CONNECTION_NAME = 'app';
 
 export interface BackgroundToAppMessagesMap {
-  SET_TRANSIENT_STATE: PopupTransientState;
+  SET_TRANSIENT_STATE: TransientState;
 }
 
 export type BackgroundToAppMessage = {

src/shared/types.ts

@@ -145,7 +145,7 @@ export type PopupTabInfo = {
     | never; // just added for code formatting
 };
 
-export type PopupTransientState = Partial<{
+export type TransientState = Partial<{
   connect:
     | null
     | { status: 'connecting' | 'connecting:key'; currentStep: string }
@@ -163,7 +163,7 @@ export type PopupStore = Omit<
 > & {
   balance: AmountValue;
   tab: PopupTabInfo;
-  transientState: PopupTransientState;
+  transientState: TransientState;
   grants?: Partial<{
     oneTime: OneTimeGrant['amount'];
     recurring: RecurringGrant['amount'];
@@ -174,7 +174,7 @@ export type AppStore = Pick<
   Storage,
   'publicKey' | 'connected' | 'uid' | 'consent' | 'consentTelemetry'
 > & {
-  transientState: PopupTransientState;
+  transientState: TransientState;
 };
 
 export type DeepNonNullable<T> = {