refactor(wallet): create enums for event names

Author: mkazlauskas

packages/wallet/src/InMemoryTransactionTracker.ts

@@ -5,6 +5,7 @@ import { CardanoProvider, ProviderError, CardanoSerializationLib, CSL, ProviderF
 import { TransactionError, TransactionFailure } from './TransactionError';
 import { dummyLogger, Logger } from 'ts-log';
 import delay from 'delay';
+import { TransactionTrackerEvent } from '.';
 
 export type Milliseconds = number;
 
@@ -47,7 +48,7 @@ export class InMemoryTransactionTracker extends Emittery<TransactionTrackerEvent
 
     const promise = this.#trackTransaction(hash, invalidHereafter);
     this.#pendingTransactions.set(hash, promise);
-    this.emit('transaction', { transaction, confirmed: promise }).catch(this.#logger.error);
+    this.emit(TransactionTrackerEvent.Transaction, { transaction, confirmed: promise }).catch(this.#logger.error);
     void promise.catch(() => void 0).then(() => this.#pendingTransactions.delete(hash));
 
     return promise;

packages/wallet/src/InMemoryUtxoRepository.ts

@@ -5,7 +5,13 @@ import { CardanoProvider, Ogmios, CardanoSerializationLib, CSL } from '@cardano-
 import { dummyLogger, Logger } from 'ts-log';
 import { ImplicitCoin, InputSelector, SelectionConstraints, SelectionResult } from '@cardano-sdk/cip2';
 import { KeyManager } from './KeyManagement';
-import { OnTransactionArgs, TransactionTracker, UtxoRepositoryEvents } from '.';
+import {
+  OnTransactionArgs,
+  TransactionTracker,
+  TransactionTrackerEvent,
+  UtxoRepositoryEvent,
+  UtxoRepositoryEvents
+} from '.';
 import { cslToOgmios } from '@cardano-sdk/core/src/Ogmios';
 import Emittery from 'emittery';
 import { TransactionError, TransactionFailure } from './TransactionError';
@@ -47,7 +53,7 @@ export class InMemoryUtxoRepository extends Emittery<UtxoRepositoryEvents> imple
     this.#delegationAndRewards = { rewards: undefined, delegate: undefined };
     this.#inputSelector = inputSelector;
     this.#keyManager = keyManager;
-    txTracker.on('transaction', (args) => {
+    txTracker.on(TransactionTrackerEvent.Transaction, (args) => {
       // not blocking to make it testable easier
       this.#onTransaction(args).catch(this.#logger.error);
     });
@@ -136,7 +142,7 @@ export class InMemoryUtxoRepository extends Emittery<UtxoRepositoryEvents> imple
     } catch (error) {
       unlock(false);
       if (!(error instanceof TransactionError) || error.reason !== TransactionFailure.Timeout) {
-        await this.emit('transactionUntracked', transaction).catch(this.#logger.error);
+        await this.emit(UtxoRepositoryEvent.TransactionUntracked, transaction).catch(this.#logger.error);
       }
     }
   }

packages/wallet/src/types.ts

@@ -3,6 +3,10 @@ import { ImplicitCoin, SelectionConstraints, SelectionResult } from '@cardano-sd
 import { CSL } from '@cardano-sdk/core';
 import Emittery from 'emittery';
 
+export enum UtxoRepositoryEvent {
+  TransactionUntracked = 'transactionUntracked'
+}
+
 export type UtxoRepositoryEvents = { transactionUntracked: CSL.Transaction };
 export interface UtxoRepository extends Emittery<UtxoRepositoryEvents> {
   allUtxos: Schema.Utxo;
@@ -25,6 +29,11 @@ export interface OnTransactionArgs {
    */
   confirmed: Promise<void>;
 }
+
+export enum TransactionTrackerEvent {
+  Transaction = 'transaction'
+}
+
 export type TransactionTrackerEvents = { transaction: OnTransactionArgs };
 export interface TransactionTracker extends Emittery<TransactionTrackerEvents> {
   /**

packages/wallet/test/InMemoryTransactionTracker.test.ts

@@ -4,6 +4,7 @@ import { InMemoryTransactionTracker } from '../src/InMemoryTransactionTracker';
 import { TransactionFailure } from '../src/TransactionError';
 import { ledgerTip, providerStub, ProviderStub, queryTransactionsResult } from './ProviderStub';
 import mockDelay from 'delay';
+import { TransactionTrackerEvent } from '../src';
 
 jest.mock('delay', () => jest.fn().mockResolvedValue(void 0));
 
@@ -42,7 +43,7 @@ describe('InMemoryTransactionTracker', () => {
 
     beforeEach(() => {
       onTransaction = jest.fn();
-      txTracker.on('transaction', onTransaction);
+      txTracker.on(TransactionTrackerEvent.Transaction, onTransaction);
     });
 
     it('invalid transaction (no ttl)', async () => {

packages/wallet/test/InMemoryUtxoRepository.test.ts

@@ -3,7 +3,13 @@ import { roundRobinRandomImprove, InputSelector } from '@cardano-sdk/cip2';
 import { loadCardanoSerializationLib, CardanoSerializationLib, CSL, Ogmios } from '@cardano-sdk/core';
 import { flushPromises, SelectionConstraints } from '@cardano-sdk/util-dev';
 import { providerStub, delegate, rewards, ProviderStub, utxo, delegationAndRewards } from './ProviderStub';
-import { InMemoryUtxoRepository, KeyManagement, UtxoRepository } from '../src';
+import {
+  InMemoryUtxoRepository,
+  KeyManagement,
+  TransactionTrackerEvent,
+  UtxoRepository,
+  UtxoRepositoryEvent
+} from '../src';
 import { MockTransactionTracker } from './mockTransactionTracker';
 import { ogmiosToCsl } from '@cardano-sdk/core/src/Ogmios';
 import { TxIn, TxOut } from '@cardano-ogmios/schema';
@@ -87,7 +93,7 @@ describe('InMemoryUtxoRepository', () => {
     let onTransactionUntracked: jest.Mock;
 
     const trackTransaction = async (confirmed: Promise<void>) => {
-      await txTracker.emit('transaction', {
+      await txTracker.emit(TransactionTrackerEvent.Transaction, {
         transaction,
         confirmed
       });
@@ -109,7 +115,7 @@ describe('InMemoryUtxoRepository', () => {
       await utxoRepository.sync();
       numUtxoPreTransaction = utxoRepository.allUtxos.length;
       onTransactionUntracked = jest.fn();
-      utxoRepository.on('transactionUntracked', onTransactionUntracked);
+      utxoRepository.on(UtxoRepositoryEvent.TransactionUntracked, onTransactionUntracked);
     });
 
     it('preconditions', () => {

packages/wallet/test/integration/withdrawal.test.ts

@@ -11,7 +11,8 @@ import {
   TransactionError,
   TransactionFailure,
   TransactionTracker,
-  UtxoRepository
+  UtxoRepository,
+  UtxoRepositoryEvent
 } from '@cardano-sdk/wallet';
 import { providerStub } from '../ProviderStub';
 // Not testing with a real provider
@@ -50,7 +51,7 @@ describe('integration/withdrawal', () => {
 
   it('does not throw', async () => {
     // This is not testing anything, just a usage example
-    utxoRepository.on('transactionUntracked', (tx) => {
+    utxoRepository.on(UtxoRepositoryEvent.TransactionUntracked, (tx) => {
       // UtxoRepository is not sure whether it's UTxO can be spent due to failing to track transaction confirmation.
       // SubmitTxResult.confirmed has rejected. Calling trackTransaction will lock UTxO again:
       txTracker.trackTransaction(tx).catch((error) => {