refactor(crypro): make deserializers static (#3234)

ArkEcosystem · Nov 9, 2019 · 6250c0c · 6250c0c
1 parent 98522ea
commit 6250c0c
Show file tree

Hide file tree

Showing 14 changed files with 53 additions and 57 deletions.
diff --git a/__tests__/unit/core-magistrate/transactions/bridgechain-registration.test.ts b/__tests__/unit/core-magistrate/transactions/bridgechain-registration.test.ts
@@ -27,7 +27,7 @@ describe("Bridgechain registration transaction", () => {
             const serialized = Transactions.TransactionFactory.fromData(bridgechainRegistration).serialized.toString(
                 "hex",
             );
-            const deserialized = Transactions.deserializer.deserialize(serialized);
+            const deserialized = Transactions.Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, bridgechainRegistration);
 
@@ -46,7 +46,7 @@ describe("Bridgechain registration transaction", () => {
             const serialized = Transactions.TransactionFactory.fromData(bridgechainRegistration).serialized.toString(
                 "hex",
             );
-            const deserialized = Transactions.deserializer.deserialize(serialized);
+            const deserialized = Transactions.Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, bridgechainRegistration);
 

diff --git a/__tests__/unit/core-magistrate/transactions/bridgechain-resignation.test.ts b/__tests__/unit/core-magistrate/transactions/bridgechain-resignation.test.ts
@@ -26,7 +26,7 @@ describe("Bridgechain registration transaction", () => {
             const serialized = Transactions.TransactionFactory.fromData(bridgechainResignation).serialized.toString(
                 "hex",
             );
-            const deserialized = Transactions.deserializer.deserialize(serialized);
+            const deserialized = Transactions.Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, bridgechainResignation);
         });

diff --git a/__tests__/unit/core-magistrate/transactions/bridgechain-update.test.ts b/__tests__/unit/core-magistrate/transactions/bridgechain-update.test.ts
@@ -27,7 +27,7 @@ describe("Bridgechain update ser/deser", () => {
             .getStruct();
 
         const serialized = Transactions.TransactionFactory.fromData(businessResignation).serialized.toString("hex");
-        const deserialized = Transactions.deserializer.deserialize(serialized);
+        const deserialized = Transactions.Deserializer.deserialize(serialized);
 
         checkCommonFields(deserialized, businessResignation);
     });

diff --git a/__tests__/unit/core-magistrate/transactions/business-registration.test.ts b/__tests__/unit/core-magistrate/transactions/business-registration.test.ts
@@ -32,7 +32,7 @@ describe("Business registration transaction", () => {
             const serialized = Transactions.TransactionFactory.fromData(businessRegistration).serialized.toString(
                 "hex",
             );
-            const deserialized = Transactions.deserializer.deserialize(serialized);
+            const deserialized = Transactions.Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, businessRegistration);
 
@@ -48,7 +48,7 @@ describe("Business registration transaction", () => {
             const serialized = Transactions.TransactionFactory.fromData(businessRegistration).serialized.toString(
                 "hex",
             );
-            const deserialized = Transactions.deserializer.deserialize(serialized);
+            const deserialized = Transactions.Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, businessRegistration);
 
@@ -64,7 +64,7 @@ describe("Business registration transaction", () => {
             const serialized = Transactions.TransactionFactory.fromData(businessRegistration).serialized.toString(
                 "hex",
             );
-            const deserialized = Transactions.deserializer.deserialize(serialized);
+            const deserialized = Transactions.Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, businessRegistration);
 
@@ -80,7 +80,7 @@ describe("Business registration transaction", () => {
             const serialized = Transactions.TransactionFactory.fromData(businessRegistration).serialized.toString(
                 "hex",
             );
-            const deserialized = Transactions.deserializer.deserialize(serialized);
+            const deserialized = Transactions.Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, businessRegistration);
 

diff --git a/__tests__/unit/core-magistrate/transactions/business-resgination.test.ts b/__tests__/unit/core-magistrate/transactions/business-resgination.test.ts
@@ -22,7 +22,7 @@ describe("Business resignation ser/deser", () => {
             .getStruct();
 
         const serialized = Transactions.TransactionFactory.fromData(businessResignation).serialized.toString("hex");
-        const deserialized = Transactions.deserializer.deserialize(serialized);
+        const deserialized = Transactions.Deserializer.deserialize(serialized);
 
         checkCommonFields(deserialized, businessResignation);
     });

diff --git a/__tests__/unit/core-magistrate/transactions/business-update.test.ts b/__tests__/unit/core-magistrate/transactions/business-update.test.ts
@@ -24,7 +24,7 @@ describe("Business update transaction", () => {
                 .getStruct();
 
             const serialized = Transactions.TransactionFactory.fromData(businessResignation).serialized.toString("hex");
-            const deserialized = Transactions.deserializer.deserialize(serialized);
+            const deserialized = Transactions.Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, businessResignation);
         });
@@ -36,7 +36,7 @@ describe("Business update transaction", () => {
                 .getStruct();
 
             const serialized = Transactions.TransactionFactory.fromData(businessResignation).serialized.toString("hex");
-            const deserialized = Transactions.deserializer.deserialize(serialized);
+            const deserialized = Transactions.Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, businessResignation);
         });
@@ -48,7 +48,7 @@ describe("Business update transaction", () => {
                 .getStruct();
 
             const serialized = Transactions.TransactionFactory.fromData(businessResignation).serialized.toString("hex");
-            const deserialized = Transactions.deserializer.deserialize(serialized);
+            const deserialized = Transactions.Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, businessResignation);
         });

diff --git a/__tests__/unit/crypto/blocks/deserializer.test.ts b/__tests__/unit/crypto/blocks/deserializer.test.ts
@@ -1,4 +1,4 @@
-import { deserializer } from "../../../../packages/crypto/src/blocks/deserializer";
+import { Deserializer } from "../../../../packages/crypto/src/blocks/deserializer";
 import { Serializer } from "../../../../packages/crypto/src/blocks/serializer";
 import { configManager } from "../../../../packages/crypto/src/managers";
 import { dummyBlock2, dummyBlock3 } from "../fixtures/block";
@@ -9,15 +9,15 @@ describe("block deserializer", () => {
             const outlookTableBlockId = "123456";
             configManager.set("exceptions.outlookTable", { [dummyBlock3.id]: outlookTableBlockId });
 
-            const deserialized = deserializer.deserialize(Serializer.serialize(dummyBlock3).toString("hex"), true).data;
+            const deserialized = Deserializer.deserialize(Serializer.serialize(dummyBlock3).toString("hex"), true).data;
 
             expect(deserialized.id).toEqual(outlookTableBlockId);
 
             configManager.set("exceptions.outlookTable", {});
         });
 
         it("should correctly deserialize a block", () => {
-            const deserialized = deserializer.deserialize(dummyBlock2.serializedFull).data;
+            const deserialized = Deserializer.deserialize(dummyBlock2.serializedFull).data;
 
             const blockFields = [
                 "id",

diff --git a/__tests__/unit/crypto/transactions/deserializer.test.ts b/__tests__/unit/crypto/transactions/deserializer.test.ts
@@ -15,11 +15,11 @@ import { IKeyPair, ITransaction, ITransactionData } from "../../../../packages/c
 import { configManager } from "../../../../packages/crypto/src/managers";
 import { TransactionFactory, Utils as TransactionUtils, Verifier } from "../../../../packages/crypto/src/transactions";
 import { BuilderFactory } from "../../../../packages/crypto/src/transactions/builders";
-import { deserializer } from "../../../../packages/crypto/src/transactions/deserializer";
+import { Deserializer } from "../../../../packages/crypto/src/transactions/deserializer";
 import { Serializer } from "../../../../packages/crypto/src/transactions/serializer";
 import { legacyMultiSignatureRegistration } from "./__fixtures__/transaction";
 
-describe("Transaction serializer / deserializer", () => {
+describe("Transaction serializer / Deserializer", () => {
     const checkCommonFields = (deserialized: ITransaction, expected) => {
         const fieldsToCheck = ["version", "network", "type", "senderPublicKey", "fee", "amount"];
         if (deserialized.data.version === 1) {
@@ -48,7 +48,7 @@ describe("Transaction serializer / deserializer", () => {
 
         it("should ser/deserialize giving back original fields", () => {
             const serialized = TransactionFactory.fromData(transfer).serialized.toString("hex");
-            const deserialized = deserializer.deserialize(serialized);
+            const deserialized = Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, transfer);
 
@@ -105,7 +105,7 @@ describe("Transaction serializer / deserializer", () => {
                 .getStruct();
 
             const serialized = TransactionFactory.fromData(secondSignature).serialized.toString("hex");
-            const deserialized = deserializer.deserialize(serialized);
+            const deserialized = Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, secondSignature);
 
@@ -122,7 +122,7 @@ describe("Transaction serializer / deserializer", () => {
                 .getStruct();
 
             const serialized = TransactionFactory.fromData(delegateRegistration).serialized.toString("hex");
-            const deserialized = deserializer.deserialize(serialized);
+            const deserialized = Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, delegateRegistration);
 
@@ -140,7 +140,7 @@ describe("Transaction serializer / deserializer", () => {
                 .getStruct();
 
             const serialized = TransactionFactory.fromData(vote).serialized.toString("hex");
-            const deserialized = deserializer.deserialize(serialized);
+            const deserialized = Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, vote);
 
@@ -236,7 +236,7 @@ describe("Transaction serializer / deserializer", () => {
 
         it("should ser/deserialize giving back original fields", () => {
             const serialized = TransactionFactory.fromData(ipfsTransaction).serialized.toString("hex");
-            const deserialized = deserializer.deserialize(serialized);
+            const deserialized = Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, ipfsTransaction);
 
@@ -261,7 +261,7 @@ describe("Transaction serializer / deserializer", () => {
                 .getStruct();
 
             const serialized = TransactionFactory.fromData(delegateResignation).serialized.toString("hex");
-            const deserialized = deserializer.deserialize(serialized);
+            const deserialized = Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, delegateResignation);
         });
@@ -296,7 +296,7 @@ describe("Transaction serializer / deserializer", () => {
                 .getStruct();
 
             const serialized = TransactionFactory.fromData(multiPayment).serialized.toString("hex");
-            const deserialized = deserializer.deserialize(serialized);
+            const deserialized = Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, multiPayment);
         });
@@ -371,7 +371,7 @@ describe("Transaction serializer / deserializer", () => {
                 .getStruct();
 
             const serialized = TransactionFactory.fromData(htlcLock).serialized.toString("hex");
-            const deserialized = deserializer.deserialize(serialized);
+            const deserialized = Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, htlcLock);
 
@@ -414,7 +414,7 @@ describe("Transaction serializer / deserializer", () => {
                 .getStruct();
 
             const serialized = TransactionFactory.fromData(htlcClaim).serialized.toString("hex");
-            const deserialized = deserializer.deserialize(serialized);
+            const deserialized = Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, htlcClaim);
 
@@ -454,7 +454,7 @@ describe("Transaction serializer / deserializer", () => {
                 .getStruct();
 
             const serialized = TransactionFactory.fromData(htlcRefund).serialized.toString("hex");
-            const deserialized = deserializer.deserialize(serialized);
+            const deserialized = Deserializer.deserialize(serialized);
 
             checkCommonFields(deserialized, htlcRefund);
 
@@ -508,7 +508,7 @@ describe("Transaction serializer / deserializer", () => {
             transactionWrongType.type = 55;
 
             const serialized = serializeWrongType(transactionWrongType).toString("hex");
-            expect(() => deserializer.deserialize(serialized)).toThrow(UnkownTransactionError);
+            expect(() => Deserializer.deserialize(serialized)).toThrow(UnkownTransactionError);
         });
     });
 

diff --git a/benchmark/transaction/deserialize/methods.js b/benchmark/transaction/deserialize/methods.js
@@ -3,5 +3,5 @@ const {
 } = require('@arkecosystem/crypto')
 
 exports.deserialize = data => {
-    return Transactions.deserializer.deserialize(data)
+    return Transactions.Deserializer.deserialize(data)
 }
diff --git a/packages/crypto/src/blocks/block.ts b/packages/crypto/src/blocks/block.ts
@@ -4,7 +4,7 @@ import { IBlock, IBlockData, IBlockJson, IBlockVerification, ITransaction, ITran
 import { configManager } from "../managers/config";
 import { BigNumber, isException } from "../utils";
 import { validator } from "../validation";
-import { deserializer } from "./deserializer";
+import { Deserializer } from "./deserializer";
 import { Serializer } from "./serializer";
 
 export class Block implements IBlock {
@@ -46,7 +46,7 @@ export class Block implements IBlock {
     }
 
     public static deserialize(hexString: string, headerOnly: boolean = false): IBlockData {
-        return deserializer.deserialize(hexString, headerOnly).data;
+        return Deserializer.deserialize(hexString, headerOnly).data;
     }
 
     public static serializeWithTransactions(block: IBlockData) {

diff --git a/packages/crypto/src/blocks/deserializer.ts b/packages/crypto/src/blocks/deserializer.ts
@@ -5,8 +5,8 @@ import { TransactionFactory } from "../transactions";
 import { BigNumber } from "../utils";
 import { Block } from "./block";
 
-class Deserializer {
-    public deserialize(
+export class Deserializer {
+    public static deserialize(
         serializedHex: string,
         headerOnly: boolean = false,
         options: { deserializeTransactionsUnchecked?: boolean } = {},
@@ -46,7 +46,7 @@ class Deserializer {
         return { data: block, transactions };
     }
 
-    private deserializeHeader(block: IBlockData, buf: ByteBuffer): void {
+    private static deserializeHeader(block: IBlockData, buf: ByteBuffer): void {
         block.version = buf.readUint32();
         block.timestamp = buf.readUint32();
         block.height = buf.readUint32();
@@ -85,7 +85,7 @@ class Deserializer {
         block.blockSignature = buf.readBytes(signatureLength()).toString("hex");
     }
 
-    private deserializeTransactions(
+    private static deserializeTransactions(
         block: IBlockData,
         buf: ByteBuffer,
         deserializeTransactionsUnchecked: boolean = false,
@@ -110,5 +110,3 @@ class Deserializer {
         return transactions;
     }
 }
-
-export const deserializer = new Deserializer();
diff --git a/packages/crypto/src/blocks/factory.ts b/packages/crypto/src/blocks/factory.ts
@@ -2,7 +2,7 @@ import { Hash, HashAlgorithms } from "../crypto";
 import { IBlock, IBlockData, IBlockJson, IKeyPair, ITransaction } from "../interfaces";
 import { BigNumber } from "../utils";
 import { Block } from "./block";
-import { deserializer } from "./deserializer";
+import { Deserializer } from "./deserializer";
 
 export class BlockFactory {
     // @TODO: add a proper type hint for data
@@ -45,14 +45,14 @@ export class BlockFactory {
         data = Block.applySchema(data);
 
         const serialized: string = Block.serializeWithTransactions(data).toString("hex");
-        const block: IBlock = new Block({ ...deserializer.deserialize(serialized, false, options), id: data.id });
+        const block: IBlock = new Block({ ...Deserializer.deserialize(serialized, false, options), id: data.id });
         block.serialized = serialized;
 
         return block;
     }
 
     private static fromSerialized(serialized: string): IBlock {
-        const deserialized: { data: IBlockData; transactions: ITransaction[] } = deserializer.deserialize(serialized);
+        const deserialized: { data: IBlockData; transactions: ITransaction[] } = Deserializer.deserialize(serialized);
         deserialized.data = Block.applySchema(deserialized.data);
 
         const block: IBlock = new Block(deserialized);