feat: implement on/off event methods in cip30.experimental

mirceahasegan · mirceahasegan · commit fb953277e6ce · 2024-10-03T12:39:04.000+02:00
diff --git a/packages/dapp-connector/package.json b/packages/dapp-connector/package.json
@@ -53,6 +53,7 @@
     "@cardano-sdk/core": "workspace:~",
     "@cardano-sdk/crypto": "workspace:~",
     "@cardano-sdk/util": "workspace:~",
+    "rxjs": "^7.4.0",
     "ts-custom-error": "^3.2.0",
     "ts-log": "^2.2.4",
     "webextension-polyfill": "^0.8.0"
diff --git a/packages/dapp-connector/src/WalletApi/Cip30EventRegistry.ts b/packages/dapp-connector/src/WalletApi/Cip30EventRegistry.ts
@@ -0,0 +1,89 @@
+import { Cardano } from '@cardano-sdk/core';
+import { Observable, Subscription } from 'rxjs';
+
+export type AccountChangeCb = (addresses: Cardano.BaseAddress[]) => unknown;
+export type NetworkChangeCb = (network: Cardano.NetworkId) => unknown;
+export enum Cip30EventName {
+  'accountChange' = 'accountChange',
+  'networkChange' = 'networkChange'
+}
+export type Cip30EventMethod = (eventName: Cip30EventName, callback: AccountChangeCb | NetworkChangeCb) => void;
+export type Cip30Event = { eventName: Cip30EventName; data: Cardano.NetworkId | Cardano.BaseAddress[] };
+type Cip30NetworkChangeEvent = { eventName: Cip30EventName.networkChange; data: Cardano.NetworkId };
+type Cip30AccountChangeEvent = { eventName: Cip30EventName.accountChange; data: Cardano.BaseAddress[] };
+type Cip30EventRegistryMap = {
+  accountChange: AccountChangeCb[];
+  networkChange: NetworkChangeCb[];
+};
+
+const isNetworkChangeEvent = (event: Cip30Event): event is Cip30NetworkChangeEvent =>
+  event.eventName === Cip30EventName.networkChange;
+
+const isAccountChangeEvent = (event: Cip30Event): event is Cip30AccountChangeEvent =>
+  event.eventName === Cip30EventName.accountChange;
+
+/**
+ * This class is responsible for registering and deregistering callbacks for specific events.
+ * It also handles calling the registered callbacks.
+ */
+export class Cip30EventRegistry {
+  #cip30Event$: Observable<Cip30Event>;
+  #registry: Cip30EventRegistryMap;
+  #subscription: Subscription;
+
+  constructor(cip30Event$: Observable<Cip30Event>) {
+    this.#cip30Event$ = cip30Event$;
+    this.#registry = {
+      accountChange: [],
+      networkChange: []
+    };
+
+    this.#subscription = this.#cip30Event$.subscribe((event) => {
+      if (isNetworkChangeEvent(event)) {
+        const { data } = event;
+        for (const callback of this.#registry.networkChange) callback(data);
+      } else if (isAccountChangeEvent(event)) {
+        const { data } = event;
+        for (const callback of this.#registry.accountChange) callback(data);
+      }
+    });
+  }
+
+  /**
+   * Register a callback for a specific event name.
+   *
+   * @param eventName - The event name to register the callback for.
+   * @param callback - The callback to be called when the event is triggered.
+   */
+  register(eventName: Cip30EventName, callback: AccountChangeCb | NetworkChangeCb) {
+    if (this.#subscription.closed) return;
+
+    if (eventName === Cip30EventName.accountChange) {
+      this.#registry.accountChange.push(callback as AccountChangeCb);
+    } else if (eventName === Cip30EventName.networkChange) {
+      this.#registry.networkChange.push(callback as NetworkChangeCb);
+    }
+  }
+
+  /**
+   * Deregister a callback for a specific event name. The callback must be the same reference used on registration.
+   *
+   * @param eventName - The event name to deregister the callback from.
+   * @param callback - The callback to be deregistered.
+   */
+  deregister(eventName: Cip30EventName, callback: AccountChangeCb | NetworkChangeCb) {
+    if (this.#subscription.closed) return;
+
+    if (eventName === Cip30EventName.accountChange) {
+      this.#registry.accountChange = this.#registry.accountChange.filter((cb) => cb !== callback);
+    } else if (eventName === Cip30EventName.networkChange) {
+      this.#registry.networkChange = this.#registry.networkChange.filter((cb) => cb !== callback);
+    }
+  }
+
+  /** Unsubscribe from the event stream. Once called, the registry can no longer be used. */
+  shutdown() {
+    if (this.#subscription.closed) return;
+    this.#subscription.unsubscribe();
+  }
+}
diff --git a/packages/dapp-connector/src/WalletApi/Cip30Wallet.ts b/packages/dapp-connector/src/WalletApi/Cip30Wallet.ts
@@ -1,4 +1,5 @@
 import { APIErrorCode, ApiError } from '../errors';
+import { AccountChangeCb, Cip30EventName, Cip30EventRegistry, NetworkChangeCb } from './Cip30EventRegistry';
 import {
   Bytes,
   Cbor,
@@ -12,6 +13,7 @@ import {
 import { Cardano } from '@cardano-sdk/core';
 import { Logger } from 'ts-log';
 import { RemoteAuthenticator } from '../AuthenticatorApi';
+import { map, merge } from 'rxjs';
 
 export const CipMethodsMapping: Record<number, WalletMethod[]> = {
   30: [
@@ -79,6 +81,7 @@ export class Cip30Wallet {
   readonly #api: WalletApi;
   readonly #authenticator: RemoteAuthenticator;
   readonly #deviations: WalletProperties['cip30ApiDeviations'];
+  #eventRegistry: Cip30EventRegistry;
 
   constructor(properties: WalletProperties, { api, authenticator, logger }: WalletDependencies) {
     this.icon = properties.icon;
@@ -92,6 +95,12 @@ export class Cip30Wallet {
     if (properties.supportedExtensions) {
       this.supportedExtensions = properties.supportedExtensions;
     }
+    this.#eventRegistry = new Cip30EventRegistry(
+      merge(
+        api.network$.pipe(map((data) => ({ data, eventName: Cip30EventName.networkChange }))),
+        api.baseAddresses$.pipe(map((data) => ({ data, eventName: Cip30EventName.accountChange })))
+      )
+    );
   }
 
   #validateExtensions(extensions: WalletApiExtension[] = []): void {
@@ -164,7 +173,25 @@ export class Cip30Wallet {
     const baseApi: Cip30WalletApiWithPossibleExtensions = {
       // Add experimental.getCollateral to CIP-30 API
       experimental: {
-        getCollateral: async (params?: { amount?: Cbor }) => this.#wrapGetCollateral(params)
+        getCollateral: async (params?: { amount?: Cbor }) => this.#wrapGetCollateral(params),
+
+        /**
+         * Deregister the callback from the event.
+         *
+         * @param {EventName} eventName The event to deregister from. Accepted values are 'accountChange' | 'networkChange'
+         * @param {AccountChangeCb | NetworkChangeCb} callback  Must be the same cb reference used on registration.
+         */
+        off: (eventName: Cip30EventName, callback: AccountChangeCb | NetworkChangeCb) =>
+          this.#eventRegistry.deregister(eventName, callback),
+
+        /**
+         * Register to events coming from the wallet. Registrations are stored by callback reference.
+         *
+         * @param {EventName} eventName The event to register to. Accepted values are 'accountChange' | 'networkChange'
+         * @param {AccountChangeCb | NetworkChangeCb} callback The callback to be called when the event is triggered.
+         */
+        on: (eventName: Cip30EventName, callback: AccountChangeCb | NetworkChangeCb) =>
+          this.#eventRegistry.register(eventName, callback)
       },
       getBalance: () => walletApi.getBalance(),
       getChangeAddress: () => walletApi.getChangeAddress(),
diff --git a/packages/dapp-connector/src/WalletApi/types.ts b/packages/dapp-connector/src/WalletApi/types.ts
@@ -1,6 +1,7 @@
 import { Cardano } from '@cardano-sdk/core';
 import { Ed25519PublicKeyHex } from '@cardano-sdk/crypto';
 import { HexBlob } from '@cardano-sdk/util';
+import { Observable } from 'rxjs';
 import { Runtime } from 'webextension-polyfill';
 
 /** A hex-encoded string of the corresponding bytes. */
@@ -199,13 +200,18 @@ export interface Cip30WalletApi {
   experimental?: any;
 }
 
+export interface Cip30ExperimentalApi {
+  network$: Observable<Cardano.NetworkId>;
+  baseAddresses$: Observable<Cardano.BaseAddress[]>;
+}
+
 export interface Cip95WalletApi {
   getRegisteredPubStakeKeys: () => Promise<Ed25519PublicKeyHex[]>;
   getUnregisteredPubStakeKeys: () => Promise<Ed25519PublicKeyHex[]>;
   getPubDRepKey: () => Promise<Ed25519PublicKeyHex>;
 }
 
-export type WalletApi = Cip30WalletApi & Cip95WalletApi;
+export type WalletApi = Cip30WalletApi & Cip30ExperimentalApi & Cip95WalletApi;
 export type WalletMethod = keyof WalletApi;
 
 export interface CipExtensionApis {
diff --git a/packages/dapp-connector/test/WalletApi/CIp30EventRegistry.test.ts b/packages/dapp-connector/test/WalletApi/CIp30EventRegistry.test.ts
@@ -0,0 +1,96 @@
+import { Cardano } from '@cardano-sdk/core';
+import { Cip30Event, Cip30EventName, Cip30EventRegistry } from '../../src/WalletApi/Cip30EventRegistry';
+import { Subject } from 'rxjs';
+
+describe('Cip30EventRegistry', () => {
+  let cip30Event$: Subject<Cip30Event>;
+  let registry: Cip30EventRegistry;
+
+  beforeEach(() => {
+    cip30Event$ = new Subject();
+    registry = new Cip30EventRegistry(cip30Event$);
+  });
+
+  afterEach(() => {
+    registry.shutdown();
+  });
+
+  it('should register and trigger networkChange callback', () => {
+    const callback = jest.fn();
+    registry.register(Cip30EventName.networkChange, callback);
+
+    const networkId: Cardano.NetworkId = 1;
+    cip30Event$.next({ data: networkId, eventName: Cip30EventName.networkChange });
+
+    expect(callback).toHaveBeenCalledWith(networkId);
+  });
+
+  it('should register and trigger accountChange callback', () => {
+    const callback = jest.fn();
+    registry.register(Cip30EventName.accountChange, callback);
+
+    const addresses: Cardano.BaseAddress[] = [{} as unknown as Cardano.BaseAddress];
+    cip30Event$.next({ data: addresses, eventName: Cip30EventName.accountChange });
+
+    expect(callback).toHaveBeenCalledWith(addresses);
+  });
+
+  it('should deregister networkChange callback', () => {
+    const callback = jest.fn();
+    registry.register(Cip30EventName.networkChange, callback);
+    registry.deregister(Cip30EventName.networkChange, callback);
+
+    const networkId: Cardano.NetworkId = 1;
+    cip30Event$.next({ data: networkId, eventName: Cip30EventName.networkChange });
+
+    expect(callback).not.toHaveBeenCalled();
+  });
+
+  it('should deregister accountChange callback', () => {
+    const callback = jest.fn();
+    registry.register(Cip30EventName.accountChange, callback);
+    registry.deregister(Cip30EventName.accountChange, callback);
+
+    const addresses: Cardano.BaseAddress[] = [{} as unknown as Cardano.BaseAddress];
+    cip30Event$.next({ data: addresses, eventName: Cip30EventName.accountChange });
+
+    expect(callback).not.toHaveBeenCalled();
+  });
+
+  it('should handle multiple callbacks for the same event', () => {
+    const callback1 = jest.fn();
+    const callback2 = jest.fn();
+    registry.register(Cip30EventName.networkChange, callback1);
+    registry.register(Cip30EventName.networkChange, callback2);
+
+    const networkId: Cardano.NetworkId = 1;
+    cip30Event$.next({ data: networkId, eventName: Cip30EventName.networkChange });
+
+    expect(callback1).toHaveBeenCalledWith(networkId);
+    expect(callback2).toHaveBeenCalledWith(networkId);
+  });
+
+  it('should not trigger callbacks after shutdown', () => {
+    const callback = jest.fn();
+    registry.register(Cip30EventName.networkChange, callback);
+
+    registry.shutdown();
+
+    const networkId: Cardano.NetworkId = 1;
+    cip30Event$.next({ data: networkId, eventName: Cip30EventName.networkChange });
+
+    expect(callback).not.toHaveBeenCalled();
+    expect(cip30Event$.observed).toBeFalsy();
+  });
+
+  it('should not register callbacks after shutdown', () => {
+    const callback = jest.fn();
+    registry.shutdown();
+    registry.register(Cip30EventName.networkChange, callback);
+
+    const networkId: Cardano.NetworkId = 1;
+    cip30Event$.next({ data: networkId, eventName: Cip30EventName.networkChange });
+
+    expect(callback).not.toHaveBeenCalled();
+  });
+});
diff --git a/packages/dapp-connector/test/testWallet.ts b/packages/dapp-connector/test/testWallet.ts
@@ -1,3 +1,4 @@
+import { BehaviorSubject } from 'rxjs';
 import { Cardano, Serialization } from '@cardano-sdk/core';
 import { Cip30DataSignature, WalletApi, WalletProperties } from '../src/WalletApi';
 import { Ed25519PublicKeyHex } from '@cardano-sdk/crypto';
@@ -32,6 +33,7 @@ export const api = <WalletApi>{
       }
     ]).toCbor()
   ],
+  network$: new BehaviorSubject(Cardano.NetworkId.Mainnet),
   signData: async (_addr, _payload) => ({} as Cip30DataSignature),
   signTx: async (_tx) => 'signedTransaction',
   submitTx: async (_tx) => 'transactionId'
diff --git a/packages/wallet/src/cip30.ts b/packages/wallet/src/cip30.ts
@@ -4,6 +4,7 @@ import {
   Bytes,
   Cbor,
   Cip30DataSignature,
+  Cip30ExperimentalApi,
   Cip95WalletApi,
   DataSignError,
   DataSignErrorCode,
@@ -18,11 +19,22 @@ import {
   WithSenderContext
 } from '@cardano-sdk/dapp-connector';
 import { Cardano, Serialization, coalesceValueQuantities } from '@cardano-sdk/core';
-import { HexBlob, ManagedFreeableScope } from '@cardano-sdk/util';
+import { HexBlob, ManagedFreeableScope, isNotNil } from '@cardano-sdk/util';
 import { InputSelectionError, InputSelectionFailure } from '@cardano-sdk/input-selection';
 import { Logger } from 'ts-log';
 import { MessageSender } from '@cardano-sdk/key-management';
-import { Observable, firstValueFrom, from, map, mergeMap, race, throwError } from 'rxjs';
+import {
+  Observable,
+  distinctUntilChanged,
+  firstValueFrom,
+  from,
+  map,
+  mergeMap,
+  race,
+  switchMap,
+  take,
+  throwError
+} from 'rxjs';
 import { ObservableWallet } from './types';
 import { requiresForeignSignatures } from './services';
 import uniq from 'lodash/uniq.js';
@@ -555,6 +567,22 @@ const baseCip30WalletApi = (
   }
 });
 
+const cip30ExperimentalWalletApi = (wallet$: Observable<ObservableWallet>): Cip30ExperimentalApi => ({
+  baseAddresses$: wallet$.pipe(
+    /**
+     * Using take(1) to emit baseAddresses only when the wallet changes,
+     * which is equivalent to account change, instead of every time the addresses change.
+     */
+    switchMap((wallet) => wallet.addresses$.pipe(take(1))),
+    map((addresses) => addresses.map(({ address }) => Cardano.Address.fromBech32(address).asBase()).filter(isNotNil))
+  ),
+  network$: wallet$.pipe(
+    switchMap((wallet) => wallet.genesisParameters$),
+    map((params) => params.networkId),
+    distinctUntilChanged()
+  )
+});
+
 const getPubStakeKeys = async (
   wallet$: Observable<ObservableWallet>,
   filter: Cardano.StakeCredentialStatus.Registered | Cardano.StakeCredentialStatus.Unregistered
@@ -621,5 +649,6 @@ export const createWalletApi = (
   { logger }: Cip30WalletDependencies
 ): WithSenderContext<WalletApi> => ({
   ...baseCip30WalletApi(wallet$, confirmationCallback, { logger }),
+  ...cip30ExperimentalWalletApi(wallet$),
   ...extendedCip95WalletApi(wallet$, { logger })
 });
diff --git a/packages/wallet/test/integration/cip30mapping.test.ts b/packages/wallet/test/integration/cip30mapping.test.ts
@@ -757,6 +757,16 @@ describe('cip30', () => {
         const extensions = await api.getExtensions(context);
         expect(extensions).toEqual([{ cip: 95 }]);
       });
+
+      test('api.baseAddresses', async () => {
+        const baseAddresses = await firstValueFrom(api.baseAddresses$);
+        expect(baseAddresses.length).toBe(2);
+      });
+
+      test('api.network', async () => {
+        const network = await firstValueFrom(api.network$);
+        expect(network).toEqual(Cardano.NetworkId.Testnet);
+      });
     });
 
     describe('confirmation callbacks', () => {
diff --git a/yarn-project.nix b/yarn-project.nix
@@ -441,7 +441,7 @@ cacheEntries = {
 "@emurgo/cip14-js@npm:3.0.1" = { filename = "@emurgo-cip14-js-npm-3.0.1-6011030ea2-9eaf312410.zip"; sha512 = "9eaf3124108e8c252a745de9ef1f334ab26a32271077b00fe0ea2a06e40838dd435165dac523ebd4d851ae7a94d8c56766dabc372aabffedd36551c798c607c5"; };
 "@endemolshinegroup/cosmiconfig-typescript-loader@npm:3.0.2" = { filename = "@endemolshinegroup-cosmiconfig-typescript-loader-npm-3.0.2-97436e68fc-7fe0198622.zip"; sha512 = "7fe0198622b1063c40572034df7e8ba867865a1b4815afe230795929abcf785758b34d7806a8e2100ba8ab4e92c5a1c3e11a980c466c4406df6e7ec6e50df8b6"; };
 "@es-joy/jsdoccomment@npm:0.10.8" = { filename = "@es-joy-jsdoccomment-npm-0.10.8-d03c65b162-3e144ef393.zip"; sha512 = "3e144ef393459a541b64f6c9c8e62fb6d9b47e1a2c626410487ede12c472064f6ce6e0911df60b42ccf126d5a66102707eef59ca14767cb7aeb5e608b227558d"; };
-"@esbuild/linux-x64@npm:0.21.5" = { filename = "@esbuild-linux-x64-npm-0.21.5-88079726c4-8.zip"; sha512 = "91c202dca064909b2c56522f98e3a3b24bc5d43405506b4e67923ecb5d0cc2b78dcee8d815f705d71395402f8532670a391777a3cf6a08894049e453becf07a0"; };
+"@esbuild/darwin-arm64@npm:0.21.5" = { filename = "@esbuild-darwin-arm64-npm-0.21.5-62349c1520-8.zip"; sha512 = "50d5d633be3d0fe0fce54c4740171ae6d2e8f5220280a6f6996f234c718de25535e50a31cee1745b5b80f2cc9e336c42c7fc2b49f3ea38b5f3ff5d8c97ef4123"; };
 "@eslint/eslintrc@npm:0.4.3" = { filename = "@eslint-eslintrc-npm-0.4.3-ee1bbcab87-03a7704150.zip"; sha512 = "03a7704150b868c318aab6a94d87a33d30dc2ec579d27374575014f06237ba1370ae11178db772f985ef680d469dc237e7b16a1c5d8edaaeb8c3733e7a95a6d3"; };
 "@ethereumjs/common@npm:4.4.0" = { filename = "@ethereumjs-common-npm-4.4.0-ee991f5124-6b8cbfcfb5.zip"; sha512 = "6b8cbfcfb5bdde839545c89dce3665706733260e26455d0eb3bcbc3c09e371ae629d51032b95d86f2aeeb15325244a6622171f9005165266fefd923eaa99f1c5"; };
 "@ethereumjs/rlp@npm:5.0.2" = { filename = "@ethereumjs-rlp-npm-5.0.2-72fb389b37-b569061ddb.zip"; sha512 = "b569061ddb1f4cf56a82f7a677c735ba37f9e94e2bbaf567404beb9e2da7aa1f595e72fc12a17c61f7aec67fd5448443efe542967c685a2fe0ffc435793dcbab"; };
@@ -1462,6 +1462,8 @@ cacheEntries = {
 "fs.realpath@npm:1.0.0" = { filename = "fs.realpath-npm-1.0.0-c8f05d8126-99ddea01a7.zip"; sha512 = "99ddea01a7e75aa276c250a04eedeffe5662bce66c65c07164ad6264f9de18fb21be9433ead460e54cff20e31721c811f4fb5d70591799df5f85dce6d6746fd0"; };
 "fsevents@npm:2.3.2" = { filename = "fsevents-npm-2.3.2-a881d6ac9f-97ade64e75.zip"; sha512 = "97ade64e75091afee5265e6956cb72ba34db7819b4c3e94c431d4be2b19b8bb7a2d4116da417950c3425f17c8fe693d25e20212cac583ac1521ad066b77ae31f"; };
 "fsevents@npm:2.3.3" = { filename = "fsevents-npm-2.3.3-ce9fb0ffae-11e6ea6fea.zip"; sha512 = "11e6ea6fea15e42461fc55b4b0e4a0a3c654faa567f1877dbd353f39156f69def97a69936d1746619d656c4b93de2238bf731f6085a03a50cabf287c9d024317"; };
+"fsevents@patch:fsevents@npm%3A2.3.2#~builtin<compat/fsevents>::version=2.3.2&hash=18f3a7" = { filename = "fsevents-patch-3340e2eb10-8.zip"; sha512 = "edbd0fd80be379c14409605f77e52fdc78a119e17f875e8b90a220c3e5b29e54a1477c21d91fd30b957ea4866406dc3ff87b61432d2840ff8866b309e5866140"; };
+"fsevents@patch:fsevents@npm%3A2.3.3#~builtin<compat/fsevents>::version=2.3.3&hash=18f3a7" = { filename = "fsevents-patch-7934e3c202-8.zip"; sha512 = "4639e24e2774cbd3669bd08521e0eeeb9d05bbabffdfdee418cc75a237660bc2fb30520a266ad5379199e2d657f430dd4236ad3642674ef32f20cc7258506725"; };
 "ftp@npm:0.3.10" = { filename = "ftp-npm-0.3.10-348fb9ac23-ddd313c1d4.zip"; sha512 = "ddd313c1d44eb7429f3a7d77a0155dc8fe86a4c64dca58f395632333ce4b4e74c61413c6e0ef66ea3f3d32d905952fbb6d028c7117d522f793eb1fa282e17357"; };
 "function-bind@npm:1.1.1" = { filename = "function-bind-npm-1.1.1-b56b322ae9-b32fbaebb3.zip"; sha512 = "b32fbaebb3f8ec4969f033073b43f5c8befbb58f1a79e12f1d7490358150359ebd92f49e72ff0144f65f2c48ea2a605bff2d07965f548f6474fd8efd95bf361a"; };
 "function.prototype.name@npm:1.1.5" = { filename = "function.prototype.name-npm-1.1.5-e776a642bb-acd21d733a.zip"; sha512 = "acd21d733a9b649c2c442f067567743214af5fa248dbeee69d8278ce7df3329ea5abac572be9f7470b4ec1cd4d8f1040e3c5caccf98ebf2bf861a0deab735c27"; };
diff --git a/yarn.lock b/yarn.lock
