Activities/Wallet Refactor

packages/stack/src/wallet/base-wallet.ts

@@ -5,11 +5,22 @@ import {
   type WalletTransactions,
 } from './types.js';
 
-import { type BlockchainUTXOs } from '../blockchain';
-import { type EventMap, EventEmitter } from '../utils';
+import {
+  type BlockchainTransactions,
+  type BlockchainUTXOs,
+} from '../blockchain';
+import { type Activities } from '../storage';
+import { EventEmitter } from '../utils';
 
 import { type TokenBalances, type Address } from '@xocash/primitives';
 
+export type WalletEvents = {
+  shouldMonitorUpdated: boolean;
+  transactionsUpdated: BlockchainTransactions;
+  unspentsUpdated: BlockchainUTXOs;
+  stateUpdated: string | null;
+};
+
 /**
  * Common interface for all wallet types.
  *
@@ -20,8 +31,33 @@ import { type TokenBalances, type Address } from '@xocash/primitives';
  * Or we might have to support some other custodial "Apple Pay"-like OS-interface to get accepted onto their app store.
  */
 export abstract class BaseWallet<
-  WalletEvents extends EventMap,
-> extends EventEmitter<WalletEvents> {
+  WalletEventsType extends WalletEvents = WalletEvents,
+> extends EventEmitter<WalletEventsType> {
+  /**
+   * Get the ID for this wallet.
+   */
+  abstract getId(): Promise<string>;
+
+  /**
+   * Derive a key using secret data from this wallet.
+   */
+  abstract deriveKey(keyName: string): Promise<Uint8Array>;
+
+  /**
+   * Get the encryption key to use for this wallet.
+   */
+  abstract getEncryptionKey(): Promise<Uint8Array>;
+
+  /**
+   * Get the signing key to use for this wallet.
+   */
+  abstract getSigningKey(): Promise<Uint8Array>;
+
+  /**
+   * Get the activities implementation
+   */
+  abstract getActivities(): Promise<Activities>;
+
   /**
    * Start monitoring this wallet for any transaction activity.
    */
@@ -136,28 +172,4 @@ export abstract class BaseWallet<
   abstract sendTransaction(
     template: Partial<TransactionTemplate>,
   ): Promise<void>;
-
-  // TODO: This should be a push-only list.
-  //       Need to understand how Jason's pruning approach works.
-  //       It might make more sense to "key" activities by type:
-  //       This would allow us to filter more effectively each time a new activity is added.
-  //       As it stands, we would have to collate the entire list if it's done by timestamp.
-  abstract addActivity<T>(activity: T): Promise<void>;
-
-  abstract export(): Promise<string>;
-
-  /**
-   * Get the ID for this wallet.
-   */
-  abstract getId(): Promise<string>;
-
-  /**
-   * Get the encryption key to use for this wallet.
-   */
-  abstract getEncryptionKey(): Promise<Uint8Array>;
-
-  /**
-   * Get the signing key to use for this wallet.
-   */
-  abstract getSigningKey(): Promise<Uint8Array>;
 }