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

ArkEcosystem · Nov 22, 2019 · c5b5301 · c5b5301
1 parent 7d7a4a8
commit c5b5301
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 43 deletions.
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
@@ -16,7 +16,7 @@ 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";
 
@@ -51,7 +51,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);
 
@@ -108,7 +108,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);
 
@@ -125,7 +125,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);
 
@@ -143,7 +143,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);
 
@@ -241,7 +241,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);
 
@@ -266,7 +266,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);
         });
@@ -302,7 +302,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);
         });
@@ -378,7 +378,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);
 
@@ -422,7 +422,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);
 
@@ -463,7 +463,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);
 
@@ -518,7 +518,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 {
@@ -54,7 +54,7 @@ export class Block implements IBlock {
     }
 
     public static deserialize(hexString: string, headerOnly = 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
@@ -6,8 +6,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 } = {},
@@ -47,7 +47,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();
@@ -86,7 +86,7 @@ class Deserializer {
         block.blockSignature = buf.readBytes(signatureLength()).toString("hex");
     }
 
-    private deserializeTransactions(
+    private static deserializeTransactions(
         block: IBlockData,
         buf: ByteBuffer,
         deserializeTransactionsUnchecked: boolean = false,
@@ -111,5 +111,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
@@ -52,7 +52,7 @@ export class BlockFactory {
         if (block) {
             const serialized: string = Block.serializeWithTransactions(data).toString("hex");
             const block: IBlock = new Block({
-                ...deserializer.deserialize(serialized, false, options),
+                ...Deserializer.deserialize(serialized, false, options),
                 id: data.id,
             });
             block.serialized = serialized;
@@ -64,7 +64,7 @@ export class BlockFactory {
     }
 
     private static fromSerialized(serialized: string): IBlock {
-        const deserialized: { data: IBlockData; transactions: ITransaction[] } = deserializer.deserialize(serialized);
+        const deserialized: { data: IBlockData; transactions: ITransaction[] } = Deserializer.deserialize(serialized);
 
         const validated: IBlockData | undefined = Block.applySchema(deserialized.data);
 

diff --git a/packages/crypto/src/transactions/deserializer.ts b/packages/crypto/src/transactions/deserializer.ts
@@ -12,8 +12,8 @@ import { BigNumber, isSupportedTansactionVersion } from "../utils";
 import { TransactionTypeFactory } from "./types";
 
 // Reference: https://github.com/ArkEcosystem/AIPs/blob/master/AIPS/aip-11.md
-class Deserializer {
-    public deserialize(serialized: string | Buffer, options: IDeserializeOptions = {}): ITransaction {
+export class Deserializer {
+    public static deserialize(serialized: string | Buffer, options: IDeserializeOptions = {}): ITransaction {
         const data = {} as ITransactionData;
 
         const buffer: ByteBuffer = this.getByteBuffer(serialized);
@@ -42,7 +42,7 @@ class Deserializer {
         return instance;
     }
 
-    private deserializeCommon(transaction: ITransactionData, buf: ByteBuffer): void {
+    private static deserializeCommon(transaction: ITransactionData, buf: ByteBuffer): void {
         buf.skip(1); // Skip 0xFF marker
         transaction.version = buf.readUint8();
         transaction.network = buf.readUint8();
@@ -61,7 +61,7 @@ class Deserializer {
         transaction.amount = BigNumber.ZERO;
     }
 
-    private deserializeVendorField(transaction: ITransaction, buf: ByteBuffer): void {
+    private static deserializeVendorField(transaction: ITransaction, buf: ByteBuffer): void {
         const vendorFieldLength: number = buf.readUint8();
         if (vendorFieldLength > 0) {
             if (transaction.hasVendorField()) {
@@ -73,23 +73,23 @@ class Deserializer {
         }
     }
 
-    private deserializeSignatures(transaction: ITransactionData, buf: ByteBuffer): void {
+    private static deserializeSignatures(transaction: ITransactionData, buf: ByteBuffer): void {
         if (transaction.version === 1) {
             this.deserializeECDSA(transaction, buf);
         } else {
             this.deserializeSchnorrOrECDSA(transaction, buf);
         }
     }
 
-    private deserializeSchnorrOrECDSA(transaction: ITransactionData, buf: ByteBuffer): void {
+    private static deserializeSchnorrOrECDSA(transaction: ITransactionData, buf: ByteBuffer): void {
         if (this.detectSchnorr(buf)) {
             this.deserializeSchnorr(transaction, buf);
         } else {
             this.deserializeECDSA(transaction, buf);
         }
     }
 
-    private deserializeECDSA(transaction: ITransactionData, buf: ByteBuffer): void {
+    private static deserializeECDSA(transaction: ITransactionData, buf: ByteBuffer): void {
         const currentSignatureLength = (): number => {
             buf.mark();
 
@@ -136,7 +136,7 @@ class Deserializer {
         }
     }
 
-    private deserializeSchnorr(transaction: ITransactionData, buf: ByteBuffer): void {
+    private static deserializeSchnorr(transaction: ITransactionData, buf: ByteBuffer): void {
         const canReadNonMultiSignature = () => {
             return buf.remaining() && (buf.remaining() % 64 === 0 || buf.remaining() % 65 !== 0);
         };
@@ -173,7 +173,7 @@ class Deserializer {
         }
     }
 
-    private detectSchnorr(buf: ByteBuffer): boolean {
+    private static detectSchnorr(buf: ByteBuffer): boolean {
         const remaining: number = buf.remaining();
 
         // `signature` / `secondSignature`
@@ -195,7 +195,7 @@ class Deserializer {
     }
 
     // tslint:disable-next-line:member-ordering
-    public applyV1Compatibility(transaction: ITransactionData): void {
+    public static applyV1Compatibility(transaction: ITransactionData): void {
         transaction.secondSignature = transaction.secondSignature || transaction.signSignature;
         transaction.typeGroup = TransactionTypeGroup.Core;
 
@@ -212,7 +212,7 @@ class Deserializer {
         }
     }
 
-    private getByteBuffer(serialized: Buffer | string): ByteBuffer {
+    private static getByteBuffer(serialized: Buffer | string): ByteBuffer {
         if (!(serialized instanceof Buffer)) {
             serialized = Buffer.from(serialized, "hex");
         }
@@ -225,4 +225,3 @@ class Deserializer {
     }
 }
 
-export const deserializer = new Deserializer();
diff --git a/packages/crypto/src/transactions/factory.ts b/packages/crypto/src/transactions/factory.ts
@@ -13,7 +13,7 @@ import {
     ITransactionJson,
 } from "../interfaces";
 import { BigNumber, isException } from "../utils";
-import { deserializer } from "./deserializer";
+import { Deserializer } from "./deserializer";
 import { Serializer } from "./serializer";
 import { TransactionTypeFactory } from "./types";
 import { Utils } from "./utils";
@@ -38,7 +38,7 @@ export class TransactionFactory {
     public static fromBytesUnsafe(buffer: Buffer, id?: string): ITransaction {
         try {
             const options: IDeserializeOptions | ISerializeOptions = { acceptLegacyVersion: true };
-            const transaction = deserializer.deserialize(buffer, options);
+            const transaction = Deserializer.deserialize(buffer, options);
             transaction.data.id = id || Utils.getId(transaction.data, options);
             transaction.isVerified = true;
 
@@ -67,7 +67,7 @@ export class TransactionFactory {
 
         const { version } = transaction.data;
         if (version === 1) {
-            deserializer.applyV1Compatibility(transaction.data);
+            Deserializer.applyV1Compatibility(transaction.data);
         }
 
         Serializer.serialize(transaction);
@@ -77,7 +77,7 @@ export class TransactionFactory {
 
     private static fromSerialized(serialized: string, strict = true): ITransaction {
         try {
-            const transaction = deserializer.deserialize(serialized);
+            const transaction = Deserializer.deserialize(serialized);
             transaction.data.id = Utils.getId(transaction.data);
 
             const { value, error } = Verifier.verifySchema(transaction.data, strict);