feat(web-extension): wallet id type changed to just string

Author: AngelCastilloB

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

@@ -1,11 +1,10 @@
 import { AddAccountProps, AddWalletProps, RemoveAccountProps, UpdateMetadataProps, WalletRepositoryApi } from './types';
 import { AnyWallet, ScriptWallet, WalletId, WalletType } from '../types';
-import { Bip32PublicKey, Hash28ByteBase16 } from '@cardano-sdk/crypto';
 import { Logger } from 'ts-log';
 import { Observable, defer, firstValueFrom, map, shareReplay, switchMap, take } from 'rxjs';
-import { Serialization } from '@cardano-sdk/core';
 import { WalletConflictError } from '../errors';
 import { contextLogger } from '@cardano-sdk/util';
+import { getWalletId } from '../util';
 import { storage } from '@cardano-sdk/wallet';
 
 export interface WalletRepositoryDependencies<AccountMetadata extends {}> {
@@ -58,10 +57,10 @@ export class WalletRepository<AccountMetadata extends {}> implements WalletRepos
 
   async addWallet(props: AddWalletProps<AccountMetadata>): Promise<WalletId> {
     this.#logger.debug('addWallet', props.type);
-    const walletId =
-      props.type === WalletType.Script
-        ? Serialization.Script.fromCore(props.script).hash()
-        : Hash28ByteBase16(await Bip32PublicKey.fromHex(props.extendedAccountPublicKey).hash());
+    const walletId = await getWalletId(
+      props.type === WalletType.Script ? props.script : props.extendedAccountPublicKey
+    );
+
     return firstValueFrom(
       this.#getWallets().pipe(
         switchMap((wallets) => {

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

@@ -1,4 +1,4 @@
-import { Bip32PublicKeyHex, Hash28ByteBase16 } from '@cardano-sdk/crypto';
+import { Bip32PublicKeyHex } from '@cardano-sdk/crypto';
 import { Cardano } from '@cardano-sdk/core';
 import { HexBlob } from '@cardano-sdk/util';
 
@@ -10,7 +10,7 @@ export enum WalletType {
 }
 
 /** For BIP-32 wallets: hash of extended account public key. For script wallets: script hash */
-export type WalletId = Hash28ByteBase16;
+export type WalletId = string;
 
 export type Bip32WalletAccount<Metadata extends {}> = {
   accountIndex: number;

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

@@ -1,6 +1,7 @@
 import * as Crypto from '@cardano-sdk/crypto';
 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';
 
@@ -15,14 +16,51 @@ export const walletManagerProperties: RemoteApiProperties<WalletManagerApi> = {
 };
 
 /**
- * Compute a unique walletId from the keyAgent chainId and the root public key hash.
- * `networkId-networkMagic-blake2bHashOfExtendedAccountPublicKey`
+ * Predicate that returns true if the given object is a script.
+ *
+ * @param object The object to check.
  */
-export const getWalletId = async (keyAgent: AsyncKeyAgent): Promise<string> => {
-  const { networkId, networkMagic } = await keyAgent.getChainId();
-  const extendedAccountPublicKey = await keyAgent.getExtendedAccountPublicKey();
-  const pubKey = Buffer.from(extendedAccountPublicKey, 'hex');
-  const pubKeyHash = Crypto.blake2b(Crypto.blake2b.BYTES_MIN).update(pubKey).digest('hex');
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const isScript = (object: any): object is Cardano.Script =>
+  object?.__type === Cardano.ScriptType.Plutus || object?.__type === Cardano.ScriptType.Native;
 
-  return `${networkId}-${networkMagic}-${pubKeyHash}`;
+/**
+ * Predicate that returns true if the given object is a public key.
+ *
+ * @param object The object to check.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const isBip32PublicKeyHex = (object: any): object is Crypto.Bip32PublicKeyHex =>
+  // eslint-disable-next-line wrap-regex
+  typeof object === 'string' && object.length === 128 && /^[\da-f]+$/i.test(object);
+
+/** Compute a unique walletId from the script */
+export const getScriptWalletId = async (script: Cardano.Script): Promise<string> =>
+  Serialization.Script.fromCore(script).hash().slice(0, 32);
+
+/**
+ * Compute a unique walletId from the extended account public key.
+ *
+ * @param pubKey The extended account public key.
+ */
+export const getExtendedAccountPublicKeyWalletId = async (pubKey: Crypto.Bip32PublicKeyHex): Promise<string> =>
+  Crypto.blake2b(Crypto.blake2b.BYTES_MIN).update(Buffer.from(pubKey, 'hex')).digest('hex');
+
+/**
+ * Compute a unique walletId from the keyAgent.
+ *
+ * @param keyAgent The key agent.
+ */
+export const getKeyAgentWalletId = async (keyAgent: AsyncKeyAgent): Promise<string> =>
+  getExtendedAccountPublicKeyWalletId(await keyAgent.getExtendedAccountPublicKey());
+
+/** Compute a unique walletId. */
+export const getWalletId = async (
+  walletIdParam: AsyncKeyAgent | Cardano.Script | Crypto.Bip32PublicKeyHex
+): Promise<string> => {
+  if (isScript(walletIdParam)) return getScriptWalletId(walletIdParam);
+
+  if (isBip32PublicKeyHex(walletIdParam)) return getExtendedAccountPublicKeyWalletId(walletIdParam);
+
+  return getKeyAgentWalletId(walletIdParam);
 };

packages/web-extension/test/walletManager/WalletRepository.test.ts

@@ -26,7 +26,7 @@ const storedLedgerWallet = {
     'ba4f80dea2632a17c99ae9d8b934abf02643db5426b889fef14709c85e294aa12ac1f1560a893ea7937c5bfbfdeab459b1a396f1174b9c5a673a640d01880c35'
   ),
   type: WalletType.Ledger as const,
-  walletId: Hash28ByteBase16('ad63f855e831d937457afc52a21a7f351137e4a9fff26c217817335a')
+  walletId: 'bc10b0e8fdff359b389822d98d4def22'
 };
 
 const createTrezorWalletProps = {
@@ -55,7 +55,7 @@ const createScriptWalletProps = {
 const storedScriptWallet = {
   ...createScriptWalletProps,
   metadata: { friendlyName: 'Shared' },
-  walletId: Serialization.Script.fromCore(createScriptWalletProps.script).hash()
+  walletId: Serialization.Script.fromCore(createScriptWalletProps.script).hash().slice(32)
 };
 
 describe('WalletRepository', () => {
@@ -133,11 +133,11 @@ describe('WalletRepository', () => {
     });
 
     it('computes and returns WalletId for bip32 wallets', async () => {
-      await expect(repository.addWallet(createTrezorWalletProps)).resolves.toHaveLength(56);
+      await expect(repository.addWallet(createTrezorWalletProps)).resolves.toHaveLength(32);
     });
 
     it('computes and returns WalletId for script wallets', async () => {
-      await expect(repository.addWallet(createScriptWalletProps)).resolves.toHaveLength(56);
+      await expect(repository.addWallet(createScriptWalletProps)).resolves.toHaveLength(32);
     });
   });
 

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

@@ -1,7 +1,8 @@
 import * as Crypto from '@cardano-sdk/crypto';
 import { AsyncKeyAgent } from '@cardano-sdk/key-management';
-import { Cardano } from '@cardano-sdk/core';
+import { Cardano, Serialization } from '@cardano-sdk/core';
 
+import { HexBlob } from '@cardano-sdk/util';
 import { getWalletId } from '../../src';
 
 describe('getWalletId', () => {
@@ -22,27 +23,48 @@ describe('getWalletId', () => {
     );
   });
 
-  it('creates unique id for different networkId', async () => {
+  it('can create unique id for key agents', async () => {
     const id1 = await getWalletId(mockKeyAgent);
-    chainId.networkId = Cardano.NetworkId.Mainnet;
+    pubKey = Crypto.Bip32PublicKeyHex(
+      // eslint-disable-next-line max-len
+      '4e33018e8293d319ef5b3ac72366dd28006bd315b715f7e7cfcbd3004129b80d3e33018e8293d319ef5b3ac72366dd28006bd315b715f7e7cfcbd3004129b80d'
+    );
     const id2 = await getWalletId(mockKeyAgent);
     expect(id1).not.toEqual(id2);
   });
 
-  it('creates unique id for different networkMagic', async () => {
-    const id1 = await getWalletId(mockKeyAgent);
-    chainId.networkMagic = Cardano.NetworkMagics.Mainnet;
-    const id2 = await getWalletId(mockKeyAgent);
+  it('can create unique id for public keys', async () => {
+    const id1 = await getWalletId(
+      Crypto.Bip32PublicKeyHex(
+        // eslint-disable-next-line max-len
+        '3e33018e8293d319ef5b3ac72366dd28006bd315b715f7e7cfcbd3004129b80d3e33018e8293d319ef5b3ac72366dd28006bd315b715f7e7cfcbd3004129b80d'
+      )
+    );
+    const id2 = await getWalletId(
+      Crypto.Bip32PublicKeyHex(
+        // eslint-disable-next-line max-len
+        '4e33018e8293d319ef5b3ac72366dd28006bd315b715f7e7cfcbd3004129b80d3e33018e8293d319ef5b3ac72366dd28006bd315b715f7e7cfcbd3004129b80d'
+      )
+    );
     expect(id1).not.toEqual(id2);
   });
 
-  it('create unique id for different public keys', async () => {
-    const id1 = await getWalletId(mockKeyAgent);
-    pubKey = Crypto.Bip32PublicKeyHex(
-      // eslint-disable-next-line max-len
-      '4e33018e8293d319ef5b3ac72366dd28006bd315b715f7e7cfcbd3004129b80d3e33018e8293d319ef5b3ac72366dd28006bd315b715f7e7cfcbd3004129b80d'
-    );
-    const id2 = await getWalletId(mockKeyAgent);
+  it('can create unique id for scripts', async () => {
+    const script = Serialization.Script.fromCbor(
+      HexBlob(
+        '82008202828200581cb275b08c999097247f7c17e77007c7010cd19f20cc086ad99d3985388201838205190bb88200581c966e394a544f242081e41d1965137b1bb412ac230d40ed5407821c378204190fa0'
+      )
+    ).toCore();
+
+    const nativeScript: Cardano.Script = {
+      __type: Cardano.ScriptType.Native,
+      keyHash: Crypto.Ed25519KeyHashHex('b275b08c999097247f7c17e77007c7010cd19f20cc086ad99d398538'),
+      kind: Cardano.NativeScriptKind.RequireSignature
+    };
+
+    const id1 = await getWalletId(script);
+    const id2 = await getWalletId(nativeScript);
+
     expect(id1).not.toEqual(id2);
   });
 });