feat: add cip142 support to dapp-connector (#1607)

greatertomi · web-flow · commit d134dd8f3bfb · 2025-03-03T15:40:51.000+01:00
diff --git a/packages/dapp-connector/src/WalletApi/Cip30Wallet.ts b/packages/dapp-connector/src/WalletApi/Cip30Wallet.ts
@@ -2,7 +2,9 @@ import { APIErrorCode, ApiError } from '../errors';
 import {
   Bytes,
   Cbor,
+  Cip142WalletApi,
   Cip30WalletApiWithPossibleExtensions,
+  Cip95WalletApi,
   CipExtensionApis,
   Paginate,
   WalletApi,
@@ -28,7 +30,8 @@ export const CipMethodsMapping: Record<number, WalletMethod[]> = {
     'signData',
     'submitTx'
   ],
-  95: ['getRegisteredPubStakeKeys', 'getUnregisteredPubStakeKeys', 'getPubDRepKey', 'signData']
+  95: ['getRegisteredPubStakeKeys', 'getUnregisteredPubStakeKeys', 'getPubDRepKey', 'signData'],
+  142: ['getNetworkMagic']
 };
 export const WalletApiMethodNames: WalletMethod[] = Object.values(CipMethodsMapping).flat();
 
@@ -79,7 +82,7 @@ export class Cip30Wallet {
   readonly name: WalletName;
   readonly icon: WalletIcon;
   /** Support the full api by default */
-  readonly supportedExtensions: WalletApiExtension[] = [{ cip: 95 }];
+  readonly supportedExtensions: WalletApiExtension[] = [{ cip: 95 }, { cip: 142 }];
 
   readonly #logger: Logger;
   readonly #api: WalletApi;
@@ -195,14 +198,17 @@ export class Cip30Wallet {
         getUnregisteredPubStakeKeys: () => walletApi.getUnregisteredPubStakeKeys(),
         signData: (addr: Cardano.PaymentAddress | Cardano.RewardAccount | Bytes, payload: Bytes) =>
           walletApi.signData(addr, payload)
+      },
+      cip142: {
+        getNetworkMagic: () => walletApi.getNetworkMagic()
       }
     };
 
     if (enabledExtensions) {
       for (const extension of enabledExtensions) {
         const cipName = `cip${extension.cip}` as keyof CipExtensionApis;
         if (additionalCipApis[cipName]) {
-          baseApi[cipName] = additionalCipApis[cipName];
+          baseApi[cipName] = additionalCipApis[cipName] as Cip95WalletApi & Cip142WalletApi;
         }
       }
     }
diff --git a/packages/dapp-connector/src/WalletApi/types.ts b/packages/dapp-connector/src/WalletApi/types.ts
@@ -206,11 +206,16 @@ export interface Cip95WalletApi {
   signData: SignData;
 }
 
-export type WalletApi = Cip30WalletApi & Cip95WalletApi;
+export interface Cip142WalletApi {
+  getNetworkMagic: () => Promise<Cardano.NetworkMagics>;
+}
+
+export type WalletApi = Cip30WalletApi & Cip95WalletApi & Cip142WalletApi;
 export type WalletMethod = keyof WalletApi;
 
 export interface CipExtensionApis {
   cip95: Cip95WalletApi;
+  cip142: Cip142WalletApi;
 }
 
 export type Cip30WalletApiWithPossibleExtensions = Cip30WalletApi & Partial<CipExtensionApis>;
diff --git a/packages/dapp-connector/test/WalletApi/Cip30Wallet.test.ts b/packages/dapp-connector/test/WalletApi/Cip30Wallet.test.ts
@@ -53,7 +53,7 @@ describe('Wallet', () => {
     expect(wallet.apiVersion).toBe('0.1.0');
     expect(typeof wallet.name).toBe('string');
     expect(wallet.name).toBe(testWallet.properties.walletName);
-    expect(wallet.supportedExtensions).toEqual<WalletApiExtension[]>([{ cip: 95 }]);
+    expect(wallet.supportedExtensions).toEqual<WalletApiExtension[]>([{ cip: 95 }, { cip: 142 }]);
     expect(typeof wallet.isEnabled).toBe('function');
     const isEnabled = await wallet.isEnabled();
     expect(typeof isEnabled).toBe('boolean');
@@ -98,6 +98,30 @@ describe('Wallet', () => {
       expect(await api.getExtensions()).toEqual([{ cip: 95 }]);
     });
 
+    test('with cip142 extension', async () => {
+      const api = await wallet.enable({ extensions: [{ cip: 142 }] });
+      expect(typeof api).toBe('object');
+      const methods = new Set(Object.keys(api));
+      expect(methods).toEqual(new Set([...CipMethodsMapping[30], 'cip142', 'experimental']));
+      const cip142Methods = new Set(Object.keys(api.cip142!));
+      expect(cip142Methods).toEqual(new Set(CipMethodsMapping[142]));
+      expect(await wallet.isEnabled()).toBe(true);
+      expect(await api.getExtensions()).toEqual([{ cip: 142 }]);
+    });
+
+    test('with cip95 and cip142 extensions', async () => {
+      const api = await wallet.enable({ extensions: [{ cip: 95 }, { cip: 142 }] });
+      expect(typeof api).toBe('object');
+      const methods = new Set(Object.keys(api));
+      expect(methods).toEqual(new Set([...CipMethodsMapping[30], 'cip95', 'cip142', 'experimental']));
+      const cip95Methods = new Set(Object.keys(api.cip95!));
+      expect(cip95Methods).toEqual(new Set(CipMethodsMapping[95]));
+      const cip142Methods = new Set(Object.keys(api.cip142!));
+      expect(cip142Methods).toEqual(new Set(CipMethodsMapping[142]));
+      expect(await wallet.isEnabled()).toBe(true);
+      expect(await api.getExtensions()).toEqual([{ cip: 95 }, { cip: 142 }]);
+    });
+
     test('no extensions wallet cannot enable cip95 extension', async () => {
       const api = await walletNoExtensions.enable({ extensions: [{ cip: 95 }] });
       expect(await walletNoExtensions.isEnabled()).toBe(true);
@@ -112,13 +136,15 @@ describe('Wallet', () => {
       expect(await wallet.isEnabled()).toBe(true);
       expect(await cip30api.getExtensions()).toEqual([]);
 
-      const cip95api = await wallet.enable({ extensions: [{ cip: 95 }] });
-      const cip95methods = new Set(Object.keys(cip95api));
-      expect(cip95methods).toEqual(new Set([...CipMethodsMapping[30], 'cip95', 'experimental']));
-      const cip95InnerMethods = new Set(Object.keys(cip95api.cip95!));
+      const apiWithExtension = await wallet.enable({ extensions: [{ cip: 95 }, { cip: 142 }] });
+      const cip95methods = new Set(Object.keys(apiWithExtension));
+      expect(cip95methods).toEqual(new Set([...CipMethodsMapping[30], 'cip95', 'cip142', 'experimental']));
+      const cip95InnerMethods = new Set(Object.keys(apiWithExtension.cip95!));
       expect(cip95InnerMethods).toEqual(new Set(CipMethodsMapping[95]));
+      const cip142Methods = new Set(Object.keys(apiWithExtension.cip142!));
+      expect(cip142Methods).toEqual(new Set(CipMethodsMapping[142]));
       expect(await wallet.isEnabled()).toBe(true);
-      expect(await cip95api.getExtensions()).toEqual([{ cip: 95 }]);
+      expect(await apiWithExtension.getExtensions()).toEqual([{ cip: 95 }, { cip: 142 }]);
     });
 
     test('unsupported extensions does not reject and returns cip30 methods', async () => {
diff --git a/packages/dapp-connector/test/testWallet.ts b/packages/dapp-connector/test/testWallet.ts
@@ -1,14 +1,14 @@
 import { Cardano, Serialization } from '@cardano-sdk/core';
-import { Cip30DataSignature, WalletApi, WalletProperties } from '../src/WalletApi';
+import { Cip30DataSignature, RemoteAuthenticator, WalletApi, WalletProperties } from '../src';
 import { Ed25519PublicKeyHex } from '@cardano-sdk/crypto';
-import { RemoteAuthenticator } from '../src';
 
 export const api = <WalletApi>{
   getBalance: async () => '100',
   getChangeAddress: async () => 'change-address',
   getCollateral: async () => null,
   getExtensions: async () => [{ cip: 95 }],
   getNetworkId: async () => 0,
+  getNetworkMagic: async () => Cardano.NetworkMagics.Preprod,
   getPubDRepKey: async () => 'getPubDRepKey' as Ed25519PublicKeyHex,
   getRegisteredPubStakeKeys: async () =>
     ['registeredPubStakeKey-1', 'registeredPubStakeKey-2'] as Ed25519PublicKeyHex[],
diff --git a/packages/e2e/test/web-extension/extension/stubWalletApi.ts b/packages/e2e/test/web-extension/extension/stubWalletApi.ts
@@ -26,8 +26,9 @@ export const stubWalletApi: WalletApi = {
         }
       ]
     ]),
-  getExtensions: async () => [{ cip: 95 }],
+  getExtensions: async () => [{ cip: 95 }, { cip: 142 }],
   getNetworkId: async () => 0,
+  getNetworkMagic: async () => Cardano.NetworkMagics.Mainnet,
   getPubDRepKey: async () => Ed25519PublicKeyHex('deeb8f82f2af5836ebbc1b450b6dbf0b03c93afe5696f10d49e8a8304ebfac01'),
   getRegisteredPubStakeKeys: async () => [
     Ed25519PublicKeyHex('deeb8f82f2af5836ebbc1b450b6dbf0b03c93afe5696f10d49e8a8304ebfac01')
diff --git a/packages/wallet/src/cip30.ts b/packages/wallet/src/cip30.ts
@@ -3,6 +3,7 @@ import {
   ApiError,
   Bytes,
   Cbor,
+  Cip142WalletApi,
   Cip30DataSignature,
   Cip95WalletApi,
   DataSignError,
@@ -573,11 +574,28 @@ const extendedCip95WalletApi = (
   }
 });
 
+const extendedCip142WalletApi = (
+  wallet$: Observable<ObservableWallet>,
+  { logger }: Cip30WalletDependencies
+): Cip142WalletApi => ({
+  getNetworkMagic: async () => {
+    try {
+      const wallet = await firstValueFrom(wallet$);
+      const genesisParameters = await firstValueFrom(wallet.genesisParameters$);
+      return genesisParameters.networkMagic;
+    } catch (error) {
+      logger.error(error);
+      throw new ApiError(APIErrorCode.InternalError, formatUnknownError(error));
+    }
+  }
+});
+
 export const createWalletApi = (
   wallet$: Observable<ObservableWallet>,
   confirmationCallback: CallbackConfirmation,
   { logger }: Cip30WalletDependencies
 ): WithSenderContext<WalletApi> => ({
   ...baseCip30WalletApi(wallet$, confirmationCallback, { logger }),
-  ...extendedCip95WalletApi(wallet$, { logger })
+  ...extendedCip95WalletApi(wallet$, { logger }),
+  ...extendedCip142WalletApi(wallet$, { logger })
 });
diff --git a/packages/wallet/test/integration/cip30mapping.test.ts b/packages/wallet/test/integration/cip30mapping.test.ts
@@ -753,6 +753,13 @@ describe('cip30', () => {
         const extensions = await api.getExtensions(context);
         expect(extensions).toEqual([{ cip: 95 }]);
       });
+
+      describe('api.getNetworkMagic', () => {
+        it('returns the network magic', async () => {
+          const networkMagic = await api.getNetworkMagic(context);
+          expect(networkMagic).toEqual(Cardano.NetworkMagics.Mainnet);
+        });
+      });
     });
 
     describe('confirmation callbacks', () => {

Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,9 @@ export const stubWalletApi: WalletApi = {`
`26`	`26`	`}`
`27`	`27`	`]`
`28`	`28`	`]),`
`29`		`- getExtensions: async () => [{ cip: 95 }],`
	`29`	`+ getExtensions: async () => [{ cip: 95 }, { cip: 142 }],`
`30`	`30`	`getNetworkId: async () => 0,`
	`31`	`+ getNetworkMagic: async () => Cardano.NetworkMagics.Mainnet,`
`31`	`32`	`getPubDRepKey: async () => Ed25519PublicKeyHex('deeb8f82f2af5836ebbc1b450b6dbf0b03c93afe5696f10d49e8a8304ebfac01'),`
`32`	`33`	`getRegisteredPubStakeKeys: async () => [`
`33`	`34`	`Ed25519PublicKeyHex('deeb8f82f2af5836ebbc1b450b6dbf0b03c93afe5696f10d49e8a8304ebfac01')`