refactor(crypto): throw error if multi payment has less than two payments (#3345)

Author: dated

__tests__/unit/crypto/transactions/builders/transactions/multi-payment.test.ts

@@ -1,7 +1,10 @@
 import "jest-extended";
 
 import { TransactionType } from "../../../../../../packages/crypto/src/enums";
-import { MaximumPaymentCountExceededError } from "../../../../../../packages/crypto/src/errors";
+import {
+    MaximumPaymentCountExceededError,
+    MinimumPaymentCountSubceededError,
+} from "../../../../../../packages/crypto/src/errors";
 import { BuilderFactory, MultiPaymentTransaction } from "../../../../../../packages/crypto/src/transactions";
 import { MultiPaymentBuilder } from "../../../../../../packages/crypto/src/transactions/builders/transactions/multi-payment";
 import { BigNumber } from "../../../../../../packages/crypto/src/utils";
@@ -59,4 +62,18 @@ describe("Multi Payment Transaction", () => {
             expect(() => builder.addPayment("address", "2")).toThrow(MaximumPaymentCountExceededError);
         });
     });
+
+    describe("getStruct", () => {
+        it("should throw if payments is undefined", () => {
+            builder.data.asset.payments = undefined;
+
+            expect(() => builder.getStruct()).toThrow(MinimumPaymentCountSubceededError);
+        });
+
+        it("should throw if payments count is less than min required", () => {
+            builder.addPayment("address", "1");
+
+            expect(() => builder.getStruct()).toThrow(MinimumPaymentCountSubceededError);
+        });
+    });
 });

__tests__/unit/crypto/transactions/schemas.test.ts

@@ -748,17 +748,6 @@ describe("Multi Payment Transaction", () => {
         expect(error).toBeUndefined();
     });
 
-    it("should be invalid with 0 or 1 payment", () => {
-        multiPayment.sign("passphrase");
-        const { error: errorZeroPayment } = Ajv.validate(transactionSchema.$id, multiPayment.getStruct());
-        expect(errorZeroPayment).not.toBeUndefined();
-
-        multiPayment.addPayment(address, "100").sign("passphrase");
-
-        const { error: errorOnePayment } = Ajv.validate(transactionSchema.$id, multiPayment.getStruct());
-        expect(errorOnePayment).not.toBeUndefined();
-    });
-
     it("should not accept more than `multiPaymentLimit` payments", () => {
         const limit = configManager.getMilestone().multiPaymentLimit;
 

packages/crypto/src/errors.ts

@@ -132,6 +132,12 @@ export class MaximumPaymentCountExceededError extends CryptoError {
     }
 }
 
+export class MinimumPaymentCountSubceededError extends CryptoError {
+    constructor() {
+        super(`Number of payments subceeded the required minimum of 2.`);
+    }
+}
+
 export class VendorFieldLengthExceededError extends CryptoError {
     constructor(limit: number) {
         super(`Length of vendor field exceeded the allowed maximum ${limit}.`);

packages/crypto/src/transactions/builders/transactions/multi-payment.ts

@@ -1,4 +1,4 @@
-import { MaximumPaymentCountExceededError } from "../../../errors";
+import { MaximumPaymentCountExceededError, MinimumPaymentCountSubceededError } from "../../../errors";
 import { ITransactionData } from "../../../interfaces";
 import { configManager } from "../../../managers";
 import { BigNumber } from "../../../utils";
@@ -35,6 +35,14 @@ export class MultiPaymentBuilder extends TransactionBuilder<MultiPaymentBuilder>
     }
 
     public getStruct(): ITransactionData {
+        if (
+            !this.data.asset.payments ||
+            !Array.isArray(this.data.asset.payments) ||
+            this.data.asset.payments.length <= 1
+        ) {
+            throw new MinimumPaymentCountSubceededError();
+        }
+
         const struct: ITransactionData = super.getStruct();
         struct.senderPublicKey = this.data.senderPublicKey;
         struct.vendorField = this.data.vendorField;