feat: wallet manager can now handle multiple wallet accounts and types

Author: AngelCastilloB

packages/e2e/src/factories.ts

@@ -30,6 +30,7 @@ import {
   CommunicationType,
   InMemoryKeyAgent,
   KeyAgentDependencies,
+  Witnesser,
   util
 } from '@cardano-sdk/key-management';
 import {
@@ -282,6 +283,7 @@ export type GetWalletProps = {
   stores?: storage.WalletStores;
   customKeyParams?: KeyAgentFactoryProps;
   keyAgent?: AsyncKeyAgent;
+  witnesser?: Witnesser;
 };
 
 /** Delays initializing tx when nearing the epoch boundary. Relies on system clock being accurate. */
@@ -307,7 +309,7 @@ const patchInitializeTxToRespectEpochBoundary = <T extends ObservableWallet>(
  * @returns an object containing the wallet and providers passed to it
  */
 export const getWallet = async (props: GetWalletProps) => {
-  const { env, idx, logger, name, polling, stores, customKeyParams, keyAgent } = props;
+  const { env, idx, logger, name, polling, stores, customKeyParams, keyAgent, witnesser } = props;
   const providers = {
     addressDiscovery: await addressDiscoveryFactory.create(
       env.ADDRESS_DISCOVERY,
@@ -365,7 +367,7 @@ export const getWallet = async (props: GetWalletProps) => {
       bip32Account,
       logger,
       stores,
-      witnesser: util.createBip32Ed25519Witnesser(asyncKeyAgent)
+      witnesser: witnesser || util.createBip32Ed25519Witnesser(asyncKeyAgent)
     }
   );
 

packages/e2e/test/web-extension/extension/background/walletManager.ts

@@ -3,13 +3,14 @@ import {
   WalletFactory,
   WalletManagerActivateProps,
   WalletManagerWorker,
+  WalletRepository,
   exposeApi,
   walletManagerChannel,
   walletManagerProperties
 } from '@cardano-sdk/web-extension';
 
-import { AsyncKeyAgent } from '@cardano-sdk/key-management';
 import { storage as WebExtensionStorage, runtime } from 'webextension-polyfill';
+import { Witnesser } from '@cardano-sdk/key-management';
 import { env, logger } from '../util';
 import { from, merge, of } from 'rxjs';
 import { getWallet } from '../../../../src';
@@ -18,7 +19,7 @@ import { toEmpty } from '@cardano-sdk/util-rxjs';
 import { walletName } from '../const';
 
 export interface WalletFactoryDependencies {
-  keyAgent: AsyncKeyAgent;
+  witnesser: Witnesser;
   stores: storage.WalletStores;
 }
 
@@ -28,26 +29,31 @@ export interface WalletFactoryDependencies {
  * Please check its documentation for examples.
  */
 const walletFactory: WalletFactory = {
-  create: async (props: WalletManagerActivateProps, { keyAgent, stores }: WalletFactoryDependencies) =>
+  create: async (props: WalletManagerActivateProps, { witnesser, stores }: WalletFactoryDependencies) =>
     (
       await getWallet({
         env,
-        keyAgent,
         logger,
         name: props.observableWalletName,
-        stores
+        stores,
+        witnesser
       })
     ).wallet
 };
 
 const storesFactory: StoresFactory = {
-  create: ({ walletId }) => storage.createPouchDbWalletStores(walletId, { logger })
+  create: ({ name }) => storage.createPouchDbWalletStores(name, { logger })
 };
 
 export const wallet$ = (() => {
+  const walletRepository = new WalletRepository<any>({
+    logger,
+    store: new storage.InMemoryCollectionStore()
+  });
+
   const walletManager = new WalletManagerWorker(
     { walletName },
-    { logger, managerStorage: WebExtensionStorage.local, runtime, storesFactory, walletFactory }
+    { logger, managerStorage: WebExtensionStorage.local, runtime, storesFactory, walletFactory, walletRepository }
   );
   exposeApi(
     { api$: of(walletManager), baseChannel: walletManagerChannel(walletName), properties: walletManagerProperties },

packages/e2e/test/web-extension/extension/ui.ts

@@ -12,7 +12,8 @@ import {
   WalletManagerUi,
   consumeRemoteApi,
   consumeSupplyDistributionTracker,
-  exposeApi
+  exposeApi,
+  getWalletId
 } from '@cardano-sdk/web-extension';
 import {
   adaPriceServiceChannel,
@@ -234,8 +235,14 @@ const createWallet = async (accountIndex: number) => {
     )
   )({ bip32Ed25519: new SodiumBip32Ed25519(), logger });
 
+  const walletId = await getWalletId(keyAgent);
   await walletManager.destroy();
-  await walletManager.activate({ keyAgent, observableWalletName: getObservableWalletName(accountIndex) });
+  await walletManager.activate({
+    accountIndex,
+    chainId: env.KEY_MANAGEMENT_PARAMS.chainId,
+    observableWalletName: getObservableWalletName(accountIndex),
+    walletId
+  });
 
   // Same wallet object will return different names, based on which wallet is active
   // Calling this method before any wallet is active, will resolve only once a wallet becomes active

packages/key-management/src/types.ts

@@ -1,5 +1,5 @@
 import * as Crypto from '@cardano-sdk/crypto';
-import { Cardano } from '@cardano-sdk/core';
+import { Cardano, Serialization } from '@cardano-sdk/core';
 import { HexBlob, OpaqueString, Shutdown } from '@cardano-sdk/util';
 import { Logger } from 'ts-log';
 import type { Runtime } from 'webextension-polyfill';
@@ -222,12 +222,13 @@ export interface Witnesser {
   /**
    * Generates the witness data for a given transaction.
    *
-   * @param txInternals The transaction body along with its hash for which the witness data is to be generated.
+   * @param transaction The transaction along with its hash for which the witness data is to be generated.
+   * @param context The witness sign transaction context
    * @param options Optional additional parameters that may influence how the witness data is generated.
    * @returns A promise that resolves to the generated witness data for the transaction.
    */
   witness(
-    txInternals: Cardano.TxBodyWithHash,
+    transaction: Serialization.Transaction,
     context: SignTransactionContext,
     options?: WitnessOptions
   ): Promise<Cardano.Witness>;

packages/key-management/src/util/createWitnesser.ts

@@ -7,7 +7,7 @@ import {
   WitnessOptions,
   Witnesser
 } from '../types';
-import { Cardano } from '@cardano-sdk/core';
+import { Cardano, Serialization } from '@cardano-sdk/core';
 import { HexBlob } from '@cardano-sdk/util';
 
 /** A witnesser that uses a {@link KeyAgent} to generate witness data for a transaction. */
@@ -19,11 +19,20 @@ export class Bip32Ed25519Witnesser implements Witnesser {
   }
 
   async witness(
-    txInternals: Cardano.TxBodyWithHash,
+    tx: Serialization.Transaction,
     context: SignTransactionContext,
     options: WitnessOptions
   ): Promise<Cardano.Witness> {
-    return { signatures: await this.#keyAgent.signTransaction(txInternals, context, options) };
+    return {
+      signatures: await this.#keyAgent.signTransaction(
+        {
+          body: tx.body().toCore(),
+          hash: tx.getId()
+        },
+        context,
+        options
+      )
+    };
   }
 
   async signBlob(

packages/key-management/test/util/createWitnesser.test.ts

@@ -1,5 +1,5 @@
 import { AsyncKeyAgent, SignBlobResult, Witnesser, util } from '../../src';
-import { Cardano } from '@cardano-sdk/core';
+import { Cardano, Serialization } from '@cardano-sdk/core';
 import { HexBlob } from '@cardano-sdk/util';
 
 describe('createBip32Ed25519Witnesser', () => {
@@ -24,14 +24,20 @@ describe('createBip32Ed25519Witnesser', () => {
   });
 
   it('signTransaction is unchanged', async () => {
+    const transaction = new Serialization.Transaction(
+      Serialization.TransactionBody.fromCore({ fee: 20_000n, inputs: [], outputs: [], validityInterval: {} }),
+      new Serialization.TransactionWitnessSet()
+    );
+
     const txInternals = {
-      body: { fee: 20_000n, inputs: [], outputs: [], validityInterval: {} } as Cardano.HydratedTxBody,
-      hash: Cardano.TransactionId('8561258e210352fba2ac0488afed67b3427a27ccf1d41ec030c98a8199bc22ec')
+      body: transaction.body().toCore(),
+      hash: Cardano.TransactionId('3643bb5fe745ba0532977f82ecf54699963c97adef2626f7c780225d218e9ba6')
     };
+
     const options = { knownAddresses: [], txInKeyPathMap: {} };
     const result = {} as Cardano.Signatures;
     asyncKeyAgent.signTransaction.mockResolvedValueOnce(result);
-    await expect(witnesser.witness(txInternals, options)).resolves.toEqual({ signatures: result });
+    await expect(witnesser.witness(transaction, options)).resolves.toEqual({ signatures: result });
     expect(asyncKeyAgent.signTransaction).toBeCalledWith(txInternals, options, void 0);
   });
 });

packages/tx-construction/src/tx-builder/finalizeTx.ts

@@ -1,4 +1,4 @@
-import { Cardano, TxCBOR } from '@cardano-sdk/core';
+import { Cardano, Serialization, TxCBOR } from '@cardano-sdk/core';
 import { FinalizeTxDependencies, SignedTx, TxContext } from './types';
 import {
   SignTransactionContext,
@@ -15,7 +15,14 @@ const getSignatures = async (
   signingOptions?: SignTransactionOptions,
   extraSigners?: TransactionSigner[]
 ) => {
-  const { signatures } = await witnesser.witness(txInternals, signingContext, signingOptions);
+  const { signatures } = await witnesser.witness(
+    new Serialization.Transaction(
+      Serialization.TransactionBody.fromCore(txInternals.body),
+      new Serialization.TransactionWitnessSet()
+    ),
+    signingContext,
+    signingOptions
+  );
 
   if (extraSigners) {
     for (const extraSigner of extraSigners) {

packages/web-extension/package.json

@@ -56,9 +56,9 @@
     "@cardano-sdk/core": "workspace:~",
     "@cardano-sdk/crypto": "workspace:~",
     "@cardano-sdk/dapp-connector": "workspace:~",
-    "@cardano-sdk/key-management": "workspace:~",
     "@cardano-sdk/hardware-ledger": "workspace:~",
     "@cardano-sdk/hardware-trezor": "workspace:~",
+    "@cardano-sdk/key-management": "workspace:~",
     "@cardano-sdk/tx-construction": "workspace:~",
     "@cardano-sdk/util": "workspace:~",
     "@cardano-sdk/util-rxjs": "workspace:~",

packages/web-extension/src/observableWallet/util.ts

@@ -1,3 +1,4 @@
+import { AnyWallet, WalletRepository } from '../walletManager';
 import { ObservableWallet } from '@cardano-sdk/wallet';
 import { OutputBuilder, TxBuilder } from '@cardano-sdk/tx-construction';
 import { RemoteApiProperties, RemoteApiPropertyType } from '../messaging';
@@ -138,3 +139,12 @@ export const observableWalletProperties: RemoteApiProperties<ObservableWallet> =
     unspendable$: RemoteApiPropertyType.HotObservable
   }
 };
+
+export const walletRepositoryProperties: RemoteApiProperties<WalletRepository<AnyWallet<any>>> = {
+  addAccount: RemoteApiPropertyType.MethodReturningPromise,
+  addWallet: RemoteApiPropertyType.MethodReturningPromise,
+  removeAccount: RemoteApiPropertyType.MethodReturningPromise,
+  removeWallet: RemoteApiPropertyType.MethodReturningPromise,
+  updateMetadata: RemoteApiPropertyType.MethodReturningPromise,
+  wallets$: RemoteApiPropertyType.HotObservable
+};

packages/web-extension/src/walletManager/SignerManager/consumeSignerManagerApi.ts

@@ -0,0 +1,11 @@
+import { MessengerDependencies, consumeRemoteApi } from '../../messaging';
+import { signerManagerApiChannel, signerManagerApiProperties } from './util';
+
+export const consumeSignerManagerApi = (dependencies: MessengerDependencies) =>
+  consumeRemoteApi(
+    {
+      baseChannel: signerManagerApiChannel,
+      properties: signerManagerApiProperties
+    },
+    dependencies
+  );

packages/web-extension/src/walletManager/SignerManager/exposeSignerManagerApi.ts

@@ -0,0 +1,21 @@
+import { MessengerDependencies, exposeApi } from '../../messaging';
+import { SignerManagerSignApi } from './types';
+import { of } from 'rxjs';
+import { signerManagerApiChannel, signerManagerApiProperties } from './util';
+
+export interface ExposeSignerManagerProps {
+  signerManager: SignerManagerSignApi<any>;
+}
+
+export const exposeSignerManagerApi = (
+  { signerManager }: ExposeSignerManagerProps,
+  dependencies: MessengerDependencies
+) =>
+  exposeApi(
+    {
+      api$: of(signerManager),
+      baseChannel: signerManagerApiChannel,
+      properties: signerManagerApiProperties
+    },
+    dependencies
+  );

packages/web-extension/src/walletManager/SignerManager/index.ts

@@ -1,2 +1,4 @@
 export * from './types';
 export * from './SignerManager';
+export * from './util';
+export * from './exposeSignerManagerApi';

packages/web-extension/src/walletManager/SignerManager/util.ts

@@ -0,0 +1,9 @@
+import { RemoteApiProperties, RemoteApiPropertyType } from '../../messaging';
+import { SignerManagerSignApi } from './types';
+
+export const signerManagerApiChannel = 'signerManager';
+
+export const signerManagerApiProperties: RemoteApiProperties<SignerManagerSignApi<any>> = {
+  signData: RemoteApiPropertyType.MethodReturningPromise,
+  signTransaction: RemoteApiPropertyType.MethodReturningPromise
+};

packages/web-extension/src/walletManager/util.ts

@@ -3,16 +3,20 @@ import { AsyncKeyAgent } from '@cardano-sdk/key-management';
 
 import { Cardano, Serialization } from '@cardano-sdk/core';
 import { RemoteApiProperties, RemoteApiPropertyType } from '../messaging';
-import { WalletManagerApi, WalletManagerProps } from './walletManager.types';
+import { WalletManagerApi } from './walletManager.types';
 
-export const walletManagerChannel = (walletName: WalletManagerProps['walletName']) => `${walletName}-wallet-manager`;
-export const walletChannel = (walletName: WalletManagerProps['walletName']) =>
-  `${walletManagerChannel(walletName)}-wallet`;
+export const walletManagerChannel = (channelName: string) => `${channelName}-wallet-manager`;
+export const walletChannel = (channelName: string) => `${walletManagerChannel(channelName)}-wallet`;
+export const repositoryChannel = (channelName: string) => `${channelName}-wallet-repository`;
 
 export const walletManagerProperties: RemoteApiProperties<WalletManagerApi> = {
   activate: RemoteApiPropertyType.MethodReturningPromise,
+  activeWallet$: RemoteApiPropertyType.HotObservable,
+  chainId$: RemoteApiPropertyType.HotObservable,
   deactivate: RemoteApiPropertyType.MethodReturningPromise,
-  destroy: RemoteApiPropertyType.MethodReturningPromise
+  destroy: RemoteApiPropertyType.MethodReturningPromise,
+  isActive: RemoteApiPropertyType.MethodReturningPromise,
+  switchNetwork: RemoteApiPropertyType.MethodReturningPromise
 };
 
 /**
@@ -64,3 +68,5 @@ export const getWalletId = async (
 
   return getKeyAgentWalletId(walletIdParam);
 };
+
+// Add create ID and parse ID {account index and the key)