Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(crypro): make deserializers static #3234

Merged
merged 1 commit into from
Nov 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand All @@ -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);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand All @@ -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);

Expand All @@ -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);

Expand All @@ -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);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
});
Expand All @@ -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);
});
Expand All @@ -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);
});
Expand Down
6 changes: 3 additions & 3 deletions __tests__/unit/crypto/blocks/deserializer.test.ts
Original file line number Diff line number Diff line change
@@ -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";
Expand All @@ -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",
Expand Down
26 changes: 13 additions & 13 deletions __tests__/unit/crypto/transactions/deserializer.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down Expand Up @@ -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);

Expand Down Expand Up @@ -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);

Expand All @@ -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);

Expand All @@ -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);

Expand Down Expand Up @@ -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);

Expand All @@ -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);
});
Expand Down Expand Up @@ -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);
});
Expand Down Expand Up @@ -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);

Expand Down Expand Up @@ -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);

Expand Down Expand Up @@ -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);

Expand Down Expand Up @@ -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);
});
});

Expand Down
2 changes: 1 addition & 1 deletion benchmark/transaction/deserialize/methods.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ const {
} = require('@arkecosystem/crypto')

exports.deserialize = data => {
return Transactions.deserializer.deserialize(data)
return Transactions.Deserializer.deserialize(data)
}
4 changes: 2 additions & 2 deletions packages/crypto/src/blocks/block.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -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) {
Expand Down
10 changes: 4 additions & 6 deletions packages/crypto/src/blocks/deserializer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 } = {},
Expand Down Expand Up @@ -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();
Expand Down Expand Up @@ -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,
Expand All @@ -110,5 +110,3 @@ class Deserializer {
return transactions;
}
}

export const deserializer = new Deserializer();
6 changes: 3 additions & 3 deletions packages/crypto/src/blocks/factory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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);
Expand Down
Loading