events as enum

aptos-labs · Jul 20, 2023 · 19d1543 · 19d1543
1 parent 8e2425a
commit 19d1543
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 18 deletions.
diff --git a/ecosystem/typescript/sdk/examples/typescript/transactions_management.ts b/ecosystem/typescript/sdk/examples/typescript/transactions_management.ts
@@ -17,7 +17,16 @@
  * Read more about it here {@link https://aptos.dev/guides/transaction-management}
  */
 
-import { AptosAccount, BCS, TxnBuilderTypes, TransactionWorker, FaucetClient, Provider, Types } from "aptos";
+import {
+  AptosAccount,
+  BCS,
+  TxnBuilderTypes,
+  TransactionWorker,
+  TransactionWorkerEvents,
+  FaucetClient,
+  Provider,
+  Types,
+} from "aptos";
 import { exit } from "process";
 import { NODE_URL, FAUCET_URL } from "./common";
 
@@ -111,14 +120,14 @@ async function main() {
      * on a success event, is the hash value of the processed transaction
      * on a failure event, is the reason for the failure
      */
-    transactionWorker.on("transactionSent", async (data) => {
+    transactionWorker.on(TransactionWorkerEvents.TransactionSent, async (data) => {
       // all expected transactions have been sent
       if (data[0] === totalTransactions) {
         console.log(`transactions sent in ${Date.now() / 1000 - last} seconds`);
       }
     });
 
-    transactionWorker.on("sentFailed", async (data) => {
+    transactionWorker.on(TransactionWorkerEvents.SentFailed, async (data) => {
       /**
        * transaction sent failed, up to the user to decide next steps.
        * whether to stop the worker by transactionWorker.stop() and handle
@@ -129,15 +138,15 @@ async function main() {
       console.log("sentFailed", data);
     });
 
-    transactionWorker.on("transactionExecuted", async (data) => {
+    transactionWorker.on(TransactionWorkerEvents.TransactionExecuted, async (data) => {
       // all expected transactions have been executed
       if (data[0] === totalTransactions) {
         console.log(`transactions executed in ${Date.now() / 1000 - last} seconds`);
         await checkAccounts();
       }
     });
 
-    transactionWorker.on("executionFailed", async (data) => {
+    transactionWorker.on(TransactionWorkerEvents.ExecutionFailed, async (data) => {
       /**
        * transaction execution failed, up to the user to decide next steps.
        * whether to stop the worker by transactionWorker.stop() and handle

diff --git a/ecosystem/typescript/sdk/package.json b/ecosystem/typescript/sdk/package.json
@@ -52,6 +52,7 @@
   ],
   "dependencies": {
     "@aptos-labs/aptos-client": "^0.0.2",
+    "eventemitter3": "^5.0.1",
     "@noble/hashes": "1.1.3",
     "@scure/bip39": "1.1.0",
     "form-data": "4.0.0",

diff --git a/ecosystem/typescript/sdk/pnpm-lock.yaml b/ecosystem/typescript/sdk/pnpm-lock.yaml
diff --git a/ecosystem/typescript/sdk/src/transactions/transaction_worker.ts b/ecosystem/typescript/sdk/src/transactions/transaction_worker.ts
@@ -23,13 +23,14 @@ import { AsyncQueue, AsyncQueueCancelledError } from "./async_queue";
 
 const promiseFulfilledStatus = "fulfilled";
 
-// Events
-const transactionSent = "transactionSent";
-const sentFailed = "sentFailed";
+export enum TransactionWorkerEvents {
+  TransactionSent = "transactionSent",
+  SentFailed = "sentFailed",
+  TransactionExecuted = "transactionExecuted",
+  ExecutionFailed = "executionFailed",
+}
 
-const transactionExecuted = "transactionExecuted";
-const executionFailed = "executionFailed";
-export class TransactionWorker extends EventEmitter {
+export class TransactionWorker extends EventEmitter<TransactionWorkerEvents> {
   readonly provider: Provider;
 
   readonly account: AptosAccount;
@@ -139,13 +140,16 @@ export class TransactionWorker extends EventEmitter {
           if (sentTransaction.status === promiseFulfilledStatus) {
             // transaction sent to chain
             this.sentTransactions.push([sentTransaction.value.hash, sequenceNumber, null]);
-            this.emit(transactionSent, [this.sentTransactions.length, sentTransaction.value.hash]);
+            this.emit(TransactionWorkerEvents.TransactionSent, [
+              this.sentTransactions.length,
+              sentTransaction.value.hash,
+            ]);
             // check sent transaction execution
             await this.checkTransaction(sentTransaction, sequenceNumber);
           } else {
             // send transaction failed
             this.sentTransactions.push([sentTransaction.status, sequenceNumber, sentTransaction.reason]);
-            this.emit(sentFailed, [this.sentTransactions.length, sentTransaction.reason]);
+            this.emit(TransactionWorkerEvents.SentFailed, [this.sentTransactions.length, sentTransaction.reason]);
           }
         }
       }
@@ -172,11 +176,17 @@ export class TransactionWorker extends EventEmitter {
       if (executedTransaction.status === promiseFulfilledStatus) {
         // transaction executed to chain
         this.executedTransactions.push([executedTransaction.value.hash, sequenceNumber, null]);
-        this.emit(transactionExecuted, [this.executedTransactions.length, executedTransaction.value.hash]);
+        this.emit(TransactionWorkerEvents.TransactionExecuted, [
+          this.executedTransactions.length,
+          executedTransaction.value.hash,
+        ]);
       } else {
         // transaction execution failed
         this.executedTransactions.push([executedTransaction.status, sequenceNumber, executedTransaction.reason]);
-        this.emit(executionFailed, [this.executedTransactions.length, executedTransaction.reason]);
+        this.emit(TransactionWorkerEvents.ExecutionFailed, [
+          this.executedTransactions.length,
+          executedTransaction.reason,
+        ]);
       }
     }
   }