refactor(wallet): hoist ObservableWallet getPubDRepKey under ObservableWallet.governance

BREAKING CHANGE: hoist ObservableWallet getPubDRepKey under ObservableWallet.governance

Author: vetalcore

packages/wallet/src/Wallets/BaseWallet.ts

@@ -259,6 +259,7 @@ export class BaseWallet implements ObservableWallet {
   readonly publicStakeKeys$: TrackerSubject<PubStakeKeyAndStatus[]>;
   readonly governance: {
     readonly isRegisteredAsDRep$: Observable<boolean>;
+    getPubDRepKey(): Promise<Ed25519PublicKeyHex | undefined>;
   };
   handles$: Observable<HandleInfo[]>;
 
@@ -557,10 +558,19 @@ export class BaseWallet implements ObservableWallet {
       utxo: this.utxo
     });
 
+    const getPubDRepKey = async (): Promise<Ed25519PublicKeyHex | undefined> => {
+      if (isBip32PublicCredentialsManager(this.#publicCredentialsManager)) {
+        return (await this.#publicCredentialsManager.bip32Account.derivePublicKey(util.DREP_KEY_DERIVATION_PATH)).hex();
+      }
+
+      return undefined;
+    };
+
     this.governance = {
+      getPubDRepKey,
       isRegisteredAsDRep$: createDRepRegistrationTracker({
         historyTransactions$: this.transactions.history$,
-        pubDRepKeyHash$: from(this.getPubDRepKey().then(getDRepKeyHash))
+        pubDRepKeyHash$: from(getPubDRepKey().then(getDRepKeyHash))
       })
     };
 
@@ -584,7 +594,7 @@ export class BaseWallet implements ObservableWallet {
     witness
   }: FinalizeTxProps): Promise<Cardano.Tx> {
     const knownAddresses = await firstValueFrom(this.addresses$);
-    const dRepPublicKey = await this.getPubDRepKey();
+    const dRepPublicKey = await this.governance.getPubDRepKey();
 
     const context = {
       ...signingContext,
@@ -792,14 +802,6 @@ export class BaseWallet implements ObservableWallet {
     throw new Error('getPubDRepKey is not supported by script wallets');
   }
 
-  async getPubDRepKey(): Promise<Ed25519PublicKeyHex | undefined> {
-    if (isBip32PublicCredentialsManager(this.#publicCredentialsManager)) {
-      return (await this.#publicCredentialsManager.bip32Account.derivePublicKey(util.DREP_KEY_DERIVATION_PATH)).hex();
-    }
-
-    return undefined;
-  }
-
   async discoverAddresses(): Promise<GroupedAddress[]> {
     if (isBip32PublicCredentialsManager(this.#publicCredentialsManager)) {
       const addresses = await this.#publicCredentialsManager.addressDiscovery.discover(

packages/wallet/src/cip30.ts

@@ -564,7 +564,7 @@ const extendedCip95WalletApi = (
     logger.debug('getting public DRep key');
     try {
       const wallet = await firstValueFrom(wallet$);
-      const dReKey = await wallet.getPubDRepKey();
+      const dReKey = await wallet.governance.getPubDRepKey();
 
       if (!dReKey) throw new Error('Shared wallet does not support DRep key');
 

packages/wallet/src/services/WalletUtil.ts

@@ -296,7 +296,7 @@ export const requiresForeignSignatures = async (tx: Cardano.Tx, wallet: Observab
     })
     .filter((acct): acct is KeyManagementUtil.StakeKeySignerData => acct.derivationPath !== null);
 
-  const dRepKey = await wallet.getPubDRepKey();
+  const dRepKey = await wallet.governance.getPubDRepKey();
   const dRepKeyHash = dRepKey ? (await Crypto.Ed25519PublicKey.fromHex(dRepKey).hash()).hex() : undefined;
 
   return (

packages/wallet/src/types.ts

@@ -87,6 +87,8 @@ export interface ObservableWallet {
   readonly governance: {
     /** true this wallet is registered as drep */
     readonly isRegisteredAsDRep$: Observable<boolean>;
+    /** Returns the wallet account's public DRep Key or undefined if the wallet doesn't control any DRep key */
+    getPubDRepKey(): Promise<Ed25519PublicKeyHex | undefined>;
   };
   /** All owned and historical assets */
   readonly assetInfo$: Observable<Assets>;
@@ -100,8 +102,6 @@ export interface ObservableWallet {
 
   getName(): Promise<string>;
 
-  /** Returns the wallet account's public DRep Key or undefined if the wallet doesn't control any DRep key */
-  getPubDRepKey(): Promise<Ed25519PublicKeyHex | undefined>;
   /**
    * @deprecated Use `createTxBuilder()` instead.
    * @throws InputSelectionError

packages/wallet/test/PersonalWallet/methods.test.ts

@@ -447,7 +447,7 @@ describe('BaseWallet methods', () => {
     });
 
     test('rejects if bech32 DRepID is not a type 6 address', async () => {
-      const dRepKey = await wallet.getPubDRepKey();
+      const dRepKey = await wallet.governance.getPubDRepKey();
       for (const type in Cardano.AddressType) {
         if (!Number.isNaN(Number(type)) && Number(type) !== Cardano.AddressType.EnterpriseKey) {
           const drepid = buildDRepIDFromDRepKey(dRepKey!, 0, type as unknown as Cardano.AddressType);
@@ -458,7 +458,7 @@ describe('BaseWallet methods', () => {
   });
 
   it('getPubDRepKey', async () => {
-    const response = await wallet.getPubDRepKey();
+    const response = await wallet.governance.getPubDRepKey();
     expect(typeof response).toBe('string');
   });
 
@@ -486,7 +486,7 @@ describe('BaseWallet methods', () => {
     );
     await waitForWalletStateSettle(wallet);
 
-    const response = await wallet.getPubDRepKey();
+    const response = await wallet.governance.getPubDRepKey();
     expect(response).toBe('string');
     expect(bip32Account.derivePublicKey).toHaveBeenCalledTimes(3);
   });

packages/wallet/test/integration/cip30mapping.test.ts

@@ -76,7 +76,7 @@ const createWalletAndApiWithStores = async (
     submitTx: createMockGenericCallback(),
     ...(!!getCollateralCallback && { getCollateral: getCollateralCallback })
   };
-  wallet.getPubDRepKey = jest.fn(wallet.getPubDRepKey);
+  wallet.governance.getPubDRepKey = jest.fn(wallet.governance.getPubDRepKey);
 
   const api = cip30.createWalletApi(of(wallet), confirmationCallback, { logger });
   if (settle) await waitForWalletStateSettle(wallet);
@@ -606,10 +606,10 @@ describe('cip30', () => {
       describe('api.getPubDRepKey', () => {
         test("returns the DRep key derived from the wallet's public key", async () => {
           const cip95PubDRepKey = await api.getPubDRepKey(context);
-          expect(cip95PubDRepKey).toEqual(await wallet.getPubDRepKey());
+          expect(cip95PubDRepKey).toEqual(await wallet.governance.getPubDRepKey());
         });
         test('throws an ApiError on unexpected error', async () => {
-          (wallet.getPubDRepKey as jest.Mock).mockRejectedValueOnce(new Error('unexpected error'));
+          (wallet.governance.getPubDRepKey as jest.Mock).mockRejectedValueOnce(new Error('unexpected error'));
           try {
             await api.getPubDRepKey(context);
           } catch (error) {

packages/wallet/test/services/WalletUtil.test.ts

@@ -554,7 +554,7 @@ describe('WalletUtil', () => {
         walletUtil: wallet.util
       });
 
-      dRepCredential = (await wallet.getPubDRepKey())!;
+      dRepCredential = (await wallet.governance.getPubDRepKey())!;
       dRepKeyHash = Crypto.Hash28ByteBase16.fromEd25519KeyHashHex(
         (await Crypto.Ed25519PublicKey.fromHex(dRepCredential).hash()).hex()
       );

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

@@ -116,8 +116,8 @@ export const observableWalletProperties: RemoteApiProperties<ObservableWallet> =
   finalizeTx: RemoteApiPropertyType.MethodReturningPromise,
   genesisParameters$: RemoteApiPropertyType.HotObservable,
   getName: RemoteApiPropertyType.MethodReturningPromise,
-  getPubDRepKey: RemoteApiPropertyType.MethodReturningPromise,
   governance: {
+    getPubDRepKey: RemoteApiPropertyType.MethodReturningPromise,
     isRegisteredAsDRep$: RemoteApiPropertyType.HotObservable
   },
   handles$: RemoteApiPropertyType.HotObservable,