refactor(transactions): inject EventDispatcher (#636)

* Remove emitter in parameter * Fix tests
ArkEcosystem · Jun 21, 2024 · 12523da · 12523da
1 parent a383756
commit 12523da
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 29 deletions.
diff --git a/packages/contracts/source/contracts/transactions.ts b/packages/contracts/source/contracts/transactions.ts
@@ -1,5 +1,4 @@
 import { MultiSignatureAsset, Transaction, TransactionConstructor, TransactionData } from "./crypto/index.js";
-import { EventDispatcher } from "./kernel/events.js";
 import { AttributeType, Wallet, WalletRepository } from "./state/index.js";
 
 export type TransactionHandlerConstructor = new () => TransactionHandler;
@@ -13,7 +12,7 @@ export interface TransactionHandler {
 
 	applyToSender(walletRepository: WalletRepository, transaction: Transaction): Promise<void>;
 
-	emitEvents(transaction: Transaction, emitter: EventDispatcher): void;
+	emitEvents(transaction: Transaction): void;
 
 	throwIfCannotEnterPool(walletRepository: WalletRepository, transaction: Transaction): Promise<void>;
 

diff --git a/packages/crypto-transaction-validator-registration/source/handlers/validator-registration.ts b/packages/crypto-transaction-validator-registration/source/handlers/validator-registration.ts
@@ -47,8 +47,8 @@ export class ValidatorRegistrationTransactionHandler extends Handlers.Transactio
 		return super.throwIfCannotBeApplied(walletRepository, transaction, wallet);
 	}
 
-	public emitEvents(transaction: Contracts.Crypto.Transaction, emitter: Contracts.Kernel.EventDispatcher): void {
-		void emitter.dispatch(Events.ValidatorEvent.Registered, transaction.data);
+	public emitEvents(transaction: Contracts.Crypto.Transaction): void {
+		void this.eventDispatcher.dispatch(Events.ValidatorEvent.Registered, transaction.data);
 	}
 
 	public async throwIfCannotEnterPool(

diff --git a/packages/crypto-transaction-validator-resignation/source/handlers/validator-resignation.ts b/packages/crypto-transaction-validator-resignation/source/handlers/validator-resignation.ts
@@ -50,8 +50,8 @@ export class ValidatorResignationTransactionHandler extends Handlers.Transaction
 		return super.throwIfCannotBeApplied(walletRepository, transaction, wallet);
 	}
 
-	public emitEvents(transaction: Contracts.Crypto.Transaction, emitter: Contracts.Kernel.EventDispatcher): void {
-		void emitter.dispatch(Events.ValidatorEvent.Resigned, transaction.data);
+	public emitEvents(transaction: Contracts.Crypto.Transaction): void {
+		void this.eventDispatcher.dispatch(Events.ValidatorEvent.Resigned, transaction.data);
 	}
 
 	public async throwIfCannotEnterPool(

diff --git a/packages/crypto-transaction-vote/source/handlers/vote.test.ts b/packages/crypto-transaction-vote/source/handlers/vote.test.ts
@@ -11,6 +11,7 @@ describe<{
 	walletRepository: any;
 	poolQuery: any;
 	handler: VoteTransactionHandler;
+	emitter: any;
 }>("VoteHandler", ({ beforeEach, it, assert, stub }) => {
 	const wallet: Partial<Contracts.State.Wallet> = {
 		forgetAttribute: () => false,
@@ -65,12 +66,17 @@ describe<{
 			whereKind: () => context.poolQuery,
 		};
 
+		context.emitter = {
+			dispatch: async () => {},
+		};
+
 		context.sandbox = new Sandbox();
 
 		context.sandbox.app.bind(Identifiers.State.Service).toConstantValue({});
 		context.sandbox.app.bind(Identifiers.Services.Log.Service).toConstantValue({});
 		context.sandbox.app.bind(Identifiers.Cryptography.Configuration).toConstantValue({});
 		context.sandbox.app.bind(Identifiers.Cryptography.Transaction.Verifier).toConstantValue({});
+		context.sandbox.app.bind(Identifiers.Services.EventDispatcher.Service).toConstantValue(context.emitter);
 		context.sandbox.app.bind(Identifiers.TransactionPool.Query).toConstantValue(context.poolQuery);
 
 		context.handler = context.sandbox.app.resolve(VoteTransactionHandler);
@@ -373,18 +379,14 @@ describe<{
 		spySuper.neverCalled();
 	});
 
-	it("emitEvents - should dispatch", ({ handler }) => {
-		const emitter: Partial<Contracts.Kernel.EventDispatcher> = {
-			dispatch: async () => {},
-		};
+	it("emitEvents - should dispatch", ({ handler, sandbox, emitter }) => {
 		const spyDispatch = stub(emitter, "dispatch");
 
+		sandbox.app.rebind(Identifiers.Services.EventDispatcher.Service).toConstantValue(emitter);
+
 		const voteTransaction = getTransaction(["validatorPublicKey"], []);
 
-		handler.emitEvents(
-			voteTransaction as Contracts.Crypto.Transaction,
-			emitter as Contracts.Kernel.EventDispatcher,
-		);
+		handler.emitEvents(voteTransaction as Contracts.Crypto.Transaction);
 
 		spyDispatch.calledOnce();
 		spyDispatch.calledWith(Events.VoteEvent.Vote, {
@@ -394,10 +396,7 @@ describe<{
 
 		spyDispatch.reset();
 		const unvoteTransaction = getTransaction([], ["validatorPublicKey"]);
-		handler.emitEvents(
-			unvoteTransaction as Contracts.Crypto.Transaction,
-			emitter as Contracts.Kernel.EventDispatcher,
-		);
+		handler.emitEvents(unvoteTransaction as Contracts.Crypto.Transaction);
 
 		spyDispatch.calledOnce();
 		spyDispatch.calledWith(Events.VoteEvent.Unvote, {
@@ -407,10 +406,7 @@ describe<{
 
 		spyDispatch.reset();
 		const unvoteVoteTransaction = getTransaction(["voteValidatorPublicKey"], ["unvoteValidatorPublicKey"]);
-		handler.emitEvents(
-			unvoteVoteTransaction as Contracts.Crypto.Transaction,
-			emitter as Contracts.Kernel.EventDispatcher,
-		);
+		handler.emitEvents(unvoteVoteTransaction as Contracts.Crypto.Transaction);
 
 		spyDispatch.calledTimes(2);
 		spyDispatch.calledWith(Events.VoteEvent.Unvote, {

diff --git a/packages/crypto-transaction-vote/source/handlers/vote.ts b/packages/crypto-transaction-vote/source/handlers/vote.ts
@@ -79,19 +79,19 @@ export class VoteTransactionHandler extends Handlers.TransactionHandler {
 		return super.throwIfCannotBeApplied(walletRepository, transaction, wallet);
 	}
 
-	public emitEvents(transaction: Contracts.Crypto.Transaction, emitter: Contracts.Kernel.EventDispatcher): void {
+	public emitEvents(transaction: Contracts.Crypto.Transaction): void {
 		Utils.assert.defined<string[]>(transaction.data.asset?.votes);
 		Utils.assert.defined<string[]>(transaction.data.asset?.unvotes);
 
 		for (const unvote of transaction.data.asset.unvotes) {
-			void emitter.dispatch(Events.VoteEvent.Unvote, {
+			void this.eventDispatcher.dispatch(Events.VoteEvent.Unvote, {
 				transaction: transaction.data,
 				validator: unvote,
 			});
 		}
 
 		for (const vote of transaction.data.asset.votes) {
-			void emitter.dispatch(Events.VoteEvent.Vote, {
+			void this.eventDispatcher.dispatch(Events.VoteEvent.Vote, {
 				transaction: transaction.data,
 				validator: vote,
 			});

diff --git a/packages/processor/source/block-processor.ts b/packages/processor/source/block-processor.ts
@@ -145,8 +145,7 @@ export class BlockProcessor implements Contracts.Processor.BlockProcessor {
 
 		void this.#emit(Events.TransactionEvent.Applied, transaction.data);
 		const handler = await this.handlerRegistry.getActivatedHandlerForData(transaction.data);
-		// TODO: ! no reason to pass this.emitter
-		handler.emitEvents(transaction, this.events);
+		handler.emitEvents(transaction);
 	}
 
 	async #applyBlockToForger(unit: Contracts.Processor.ProcessableUnit) {

diff --git a/packages/transactions/source/handlers/handler-registry.test.ts b/packages/transactions/source/handlers/handler-registry.test.ts
@@ -221,6 +221,7 @@ describe<{
 		app.bind(Identifiers.Database.Service).toConstantValue({});
 
 		app.bind(Identifiers.Cryptography.Configuration).to(Configuration).inSingletonScope();
+		app.bind(Identifiers.Services.EventDispatcher.Service).toConstantValue({});
 
 		context.app = app;
 	});

diff --git a/packages/transactions/source/handlers/transaction.ts b/packages/transactions/source/handlers/transaction.ts
@@ -3,7 +3,6 @@ import { Contracts, Exceptions, Identifiers } from "@mainsail/contracts";
 import { Utils as AppUtils } from "@mainsail/kernel";
 import { BigNumber } from "@mainsail/utils";
 
-// @TODO revisit the implementation, container usage and arguments after database rework
 @injectable()
 export abstract class TransactionHandler implements Contracts.Transactions.TransactionHandler {
 	@inject(Identifiers.Application.Instance)
@@ -18,6 +17,9 @@ export abstract class TransactionHandler implements Contracts.Transactions.Trans
 	@inject(Identifiers.Cryptography.Transaction.Verifier)
 	protected readonly verifier!: Contracts.Crypto.TransactionVerifier;
 
+	@inject(Identifiers.Services.EventDispatcher.Service)
+	protected readonly eventDispatcher!: Contracts.Kernel.EventDispatcher;
+
 	public async verify(
 		walletRepository: Contracts.State.WalletRepository,
 		transaction: Contracts.Crypto.Transaction,
@@ -128,7 +130,7 @@ export abstract class TransactionHandler implements Contracts.Transactions.Trans
 		sender.setBalance(newBalance);
 	}
 
-	public emitEvents(transaction: Contracts.Crypto.Transaction, emitter: Contracts.Kernel.EventDispatcher): void {}
+	public emitEvents(transaction: Contracts.Crypto.Transaction): void {}
 
 	public walletAttributes(): ReadonlyArray<{ name: string; type: Contracts.State.AttributeType }> {
 		return [];