feat: add transaction serialize method (#185)

alfonsobries · web-flow · commit 520735f9c3fc · 2024-08-23T15:23:21.000+02:00
diff --git a/src/main/java/org/arkecosystem/crypto/transactions/Deserializer.java b/src/main/java/org/arkecosystem/crypto/transactions/Deserializer.java
@@ -61,7 +61,7 @@ public Transaction deserialize() {
         deserializeCommon();
         deserializeVendorField();
 
-        this.transaction.deserialize(this.buffer);
+        this.transaction.deserializeData(this.buffer);
 
         deserializeSignatures();
 
diff --git a/src/main/java/org/arkecosystem/crypto/transactions/Serializer.java b/src/main/java/org/arkecosystem/crypto/transactions/Serializer.java
@@ -33,7 +33,7 @@ public byte[] serialize(
         byte[] common = serializeCommon();
         byte[] vendorField = serializeVendorField();
 
-        byte[] typeBuffer = this.transaction.serialize();
+        byte[] typeBuffer = this.transaction.serializeData();
 
         byte[] signatures =
                 serializeSignatures(skipSignature, skipSecondSignature, skipMultiSignature);
diff --git a/src/main/java/org/arkecosystem/crypto/transactions/types/MultiPayment.java b/src/main/java/org/arkecosystem/crypto/transactions/types/MultiPayment.java
@@ -43,7 +43,7 @@ public HashMap<String, Object> assetToHashMap() {
     }
 
     @Override
-    public byte[] serialize() {
+    public byte[] serializeData() {
         ByteBuffer buffer = ByteBuffer.allocate(2 + this.asset.multiPayment.payments.size() * 28);
         buffer.order(ByteOrder.LITTLE_ENDIAN);
         buffer.putShort((short) this.asset.multiPayment.payments.size());
@@ -56,7 +56,7 @@ public byte[] serialize() {
     }
 
     @Override
-    public void deserialize(ByteBuffer buffer) {
+    public void deserializeData(ByteBuffer buffer) {
         int paymentLength = buffer.getShort() & 0xff;
 
         for (int i = 0; i < paymentLength; i++) {
diff --git a/src/main/java/org/arkecosystem/crypto/transactions/types/MultiSignatureRegistration.java b/src/main/java/org/arkecosystem/crypto/transactions/types/MultiSignatureRegistration.java
@@ -32,7 +32,7 @@ public HashMap<String, Object> assetToHashMap() {
     }
 
     @Override
-    public byte[] serialize() {
+    public byte[] serializeData() {
         ByteBuffer buffer =
                 ByteBuffer.allocate(2 + this.asset.multiSignature.publicKeys.size() * 33);
         buffer.order(ByteOrder.LITTLE_ENDIAN);
@@ -48,7 +48,7 @@ public byte[] serialize() {
     }
 
     @Override
-    public void deserialize(ByteBuffer buffer) {
+    public void deserializeData(ByteBuffer buffer) {
         this.asset.multiSignature.min = buffer.get();
 
         int publicKeyLength = buffer.get();
diff --git a/src/main/java/org/arkecosystem/crypto/transactions/types/SecondSignatureRegistration.java b/src/main/java/org/arkecosystem/crypto/transactions/types/SecondSignatureRegistration.java
@@ -30,15 +30,15 @@ public HashMap<String, Object> assetToHashMap() {
     }
 
     @Override
-    public byte[] serialize() {
+    public byte[] serializeData() {
         ByteBuffer buffer = ByteBuffer.allocate(33);
         buffer.order(ByteOrder.LITTLE_ENDIAN);
         buffer.put(Hex.decode(this.asset.signature.publicKey));
         return buffer.array();
     }
 
     @Override
-    public void deserialize(ByteBuffer buffer) {
+    public void deserializeData(ByteBuffer buffer) {
         byte[] publicKeyBuffer = new byte[33];
         buffer.get(publicKeyBuffer);
         this.asset.signature.publicKey = Hex.encode(publicKeyBuffer);
diff --git a/src/main/java/org/arkecosystem/crypto/transactions/types/Transaction.java b/src/main/java/org/arkecosystem/crypto/transactions/types/Transaction.java
@@ -41,14 +41,14 @@ public void computeId() {
     }
 
     public String getId() {
-        return Hex.encode(Sha256Hash.hash(Serializer.serialize(this)));
+        return Hex.encode(Sha256Hash.hash(this.serialize()));
     }
 
     public Transaction sign(String passphrase) {
         ECKey privateKey = PrivateKey.fromPassphrase(passphrase);
 
         this.senderPublicKey = privateKey.getPublicKeyAsHex();
-        Sha256Hash hash = Sha256Hash.of(Serializer.serialize(this, true, true, false));
+        Sha256Hash hash = Sha256Hash.of(this.serialize(true, true, false));
 
         this.signature = Hex.encode(signer().sign(hash.getBytes(), privateKey));
 
@@ -58,7 +58,7 @@ public Transaction sign(String passphrase) {
     public Transaction secondSign(String passphrase) {
         ECKey privateKey = PrivateKey.fromPassphrase(passphrase);
 
-        Sha256Hash hash = Sha256Hash.of(Serializer.serialize(this, false, true, false));
+        Sha256Hash hash = Sha256Hash.of(this.serialize(false, true));
 
         this.secondSignature = Hex.encode(signer().sign(hash.getBytes(), privateKey));
 
@@ -89,7 +89,7 @@ public boolean verify() {
         ECKey keys = ECKey.fromPublicOnly(Hex.decode(this.senderPublicKey));
 
         byte[] signature = Hex.decode(this.signature);
-        byte[] hash = Sha256Hash.hash(Serializer.serialize(this, true, true, false));
+        byte[] hash = Sha256Hash.hash(this.serialize(true, true, false));
 
         return verifier().verify(hash, keys, signature);
     }
@@ -98,7 +98,7 @@ public boolean secondVerify(String secondPublicKey) {
         ECKey keys = ECKey.fromPublicOnly(Hex.decode(secondPublicKey));
 
         byte[] signature = Hex.decode(this.secondSignature);
-        byte[] hash = Sha256Hash.hash(Serializer.serialize(this, false, true, false));
+        byte[] hash = Sha256Hash.hash(this.serialize(false, true, false));
 
         return verifier().verify(hash, keys, signature);
     }
@@ -145,9 +145,26 @@ public HashMap toHashMap() {
         return map;
     }
 
-    public abstract byte[] serialize();
+    public byte[] serialize(
+            boolean skipSignature, boolean skipSecondSignature, boolean skipMultiSignature) {
+        return Serializer.serialize(this, skipSignature, skipSecondSignature, skipMultiSignature);
+    }
+
+    public byte[] serialize(boolean skipSignature, boolean skipSecondSignature) {
+        return serialize(skipSignature, skipSecondSignature, false);
+    }
+
+    public byte[] serialize(boolean skipSignature) {
+        return serialize(skipSignature, false, false);
+    }
+
+    public byte[] serialize() {
+        return serialize(false, false, false);
+    }
+
+    public abstract byte[] serializeData();
 
-    public abstract void deserialize(ByteBuffer buffer);
+    public abstract void deserializeData(ByteBuffer buffer);
 
     public abstract int getTransactionType();
 
diff --git a/src/main/java/org/arkecosystem/crypto/transactions/types/Transfer.java b/src/main/java/org/arkecosystem/crypto/transactions/types/Transfer.java
@@ -31,7 +31,7 @@ public HashMap<String, Object> assetToHashMap() {
     }
 
     @Override
-    public byte[] serialize() {
+    public byte[] serializeData() {
         ByteBuffer buffer = ByteBuffer.allocate(32);
         buffer.order(ByteOrder.LITTLE_ENDIAN);
         buffer.putLong(this.amount);
@@ -45,7 +45,7 @@ public byte[] serialize() {
     }
 
     @Override
-    public void deserialize(ByteBuffer buffer) {
+    public void deserializeData(ByteBuffer buffer) {
         buffer.order(ByteOrder.LITTLE_ENDIAN);
 
         this.amount = buffer.getLong();
diff --git a/src/main/java/org/arkecosystem/crypto/transactions/types/UsernameRegistration.java b/src/main/java/org/arkecosystem/crypto/transactions/types/UsernameRegistration.java
@@ -27,7 +27,7 @@ public HashMap<String, Object> assetToHashMap() {
     }
 
     @Override
-    public byte[] serialize() {
+    public byte[] serializeData() {
         byte[] username = this.asset.username.getBytes();
 
         ByteBuffer buffer = ByteBuffer.allocate(username.length + 1);
@@ -41,7 +41,7 @@ public byte[] serialize() {
     }
 
     @Override
-    public void deserialize(ByteBuffer buffer) {
+    public void deserializeData(ByteBuffer buffer) {
         int usernameLength = buffer.get() & 0xff;
 
         byte[] username = new byte[usernameLength];
diff --git a/src/main/java/org/arkecosystem/crypto/transactions/types/UsernameResignation.java b/src/main/java/org/arkecosystem/crypto/transactions/types/UsernameResignation.java
@@ -22,10 +22,10 @@ public HashMap<String, Object> assetToHashMap() {
     }
 
     @Override
-    public byte[] serialize() {
+    public byte[] serializeData() {
         return new byte[0];
     }
 
     @Override
-    public void deserialize(ByteBuffer buffer) {}
+    public void deserializeData(ByteBuffer buffer) {}
 }
diff --git a/src/main/java/org/arkecosystem/crypto/transactions/types/ValidatorRegistration.java b/src/main/java/org/arkecosystem/crypto/transactions/types/ValidatorRegistration.java
@@ -28,7 +28,7 @@ public HashMap<String, Object> assetToHashMap() {
     }
 
     @Override
-    public byte[] serialize() {
+    public byte[] serializeData() {
         ByteBuffer buffer = ByteBuffer.allocate(48);
         buffer.order(ByteOrder.LITTLE_ENDIAN);
         buffer.put(Hex.decode(this.asset.validatorPublicKey));
@@ -37,7 +37,7 @@ public byte[] serialize() {
     }
 
     @Override
-    public void deserialize(ByteBuffer buffer) {
+    public void deserializeData(ByteBuffer buffer) {
         byte[] validatorPublicKey = new byte[48];
         buffer.get(validatorPublicKey);
         this.asset.validatorPublicKey = Hex.encode(validatorPublicKey);
diff --git a/src/main/java/org/arkecosystem/crypto/transactions/types/ValidatorResignation.java b/src/main/java/org/arkecosystem/crypto/transactions/types/ValidatorResignation.java
@@ -22,10 +22,10 @@ public HashMap<String, Object> assetToHashMap() {
     }
 
     @Override
-    public byte[] serialize() {
+    public byte[] serializeData() {
         return new byte[0];
     }
 
     @Override
-    public void deserialize(ByteBuffer buffer) {}
+    public void deserializeData(ByteBuffer buffer) {}
 }
diff --git a/src/main/java/org/arkecosystem/crypto/transactions/types/Vote.java b/src/main/java/org/arkecosystem/crypto/transactions/types/Vote.java
@@ -29,7 +29,7 @@ public HashMap<String, Object> assetToHashMap() {
     }
 
     @Override
-    public byte[] serialize() {
+    public byte[] serializeData() {
         ByteBuffer buffer =
                 ByteBuffer.allocate(
                         (1 + this.asset.votes.size() * 33) + (1 + this.asset.unvotes.size() * 33));
@@ -49,7 +49,7 @@ public byte[] serialize() {
     }
 
     @Override
-    public void deserialize(ByteBuffer buffer) {
+    public void deserializeData(ByteBuffer buffer) {
         int voteLength = buffer.get();
 
         for (int i = 0; i < voteLength; i++) {
diff --git a/src/test/java/org/arkecosystem/crypto/transactions/deserializers/DeserializerTest.java b/src/test/java/org/arkecosystem/crypto/transactions/deserializers/DeserializerTest.java
@@ -21,12 +21,12 @@ void checkNewTransactionType() {
         deserializer.setNewTransactionType(
                 new Transaction() {
                     @Override
-                    public byte[] serialize() {
+                    public byte[] serializeData() {
                         return new byte[0];
                     }
 
                     @Override
-                    public void deserialize(ByteBuffer buffer) {}
+                    public void deserializeData(ByteBuffer buffer) {}
 
                     @Override
                     public int getTransactionType() {
@@ -58,12 +58,12 @@ void checkNewTransactionToCoreGroup() {
         deserializer.setNewTransactionType(
                 new Transaction() {
                     @Override
-                    public byte[] serialize() {
+                    public byte[] serializeData() {
                         return new byte[0];
                     }
 
                     @Override
-                    public void deserialize(ByteBuffer buffer) {}
+                    public void deserializeData(ByteBuffer buffer) {}
 
                     @Override
                     public int getTransactionType() {

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public HashMap<String, Object> assetToHashMap() {`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`@Override`
`46`		`- public byte[] serialize() {`
	`46`	`+ public byte[] serializeData() {`
`47`	`47`	`ByteBuffer buffer = ByteBuffer.allocate(2 + this.asset.multiPayment.payments.size() * 28);`
`48`	`48`	`buffer.order(ByteOrder.LITTLE_ENDIAN);`
`49`	`49`	`buffer.putShort((short) this.asset.multiPayment.payments.size());`
`@@ -56,7 +56,7 @@ public byte[] serialize() {`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`@Override`
`59`		`- public void deserialize(ByteBuffer buffer) {`
	`59`	`+ public void deserializeData(ByteBuffer buffer) {`
`60`	`60`	`int paymentLength = buffer.getShort() & 0xff;`
`61`	`61`
`62`	`62`	`for (int i = 0; i < paymentLength; i++) {`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public HashMap<String, Object> assetToHashMap() {`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`@Override`
`35`		`- public byte[] serialize() {`
	`35`	`+ public byte[] serializeData() {`
`36`	`36`	`ByteBuffer buffer =`
`37`	`37`	`ByteBuffer.allocate(2 + this.asset.multiSignature.publicKeys.size() * 33);`
`38`	`38`	`buffer.order(ByteOrder.LITTLE_ENDIAN);`
`@@ -48,7 +48,7 @@ public byte[] serialize() {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`@Override`
`51`		`- public void deserialize(ByteBuffer buffer) {`
	`51`	`+ public void deserializeData(ByteBuffer buffer) {`
`52`	`52`	`this.asset.multiSignature.min = buffer.get();`
`53`	`53`
`54`	`54`	`int publicKeyLength = buffer.get();`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public HashMap<String, Object> assetToHashMap() {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`@Override`
`34`		`- public byte[] serialize() {`
	`34`	`+ public byte[] serializeData() {`
`35`	`35`	`ByteBuffer buffer = ByteBuffer.allocate(32);`
`36`	`36`	`buffer.order(ByteOrder.LITTLE_ENDIAN);`
`37`	`37`	`buffer.putLong(this.amount);`
`@@ -45,7 +45,7 @@ public byte[] serialize() {`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`@Override`
`48`		`- public void deserialize(ByteBuffer buffer) {`
	`48`	`+ public void deserializeData(ByteBuffer buffer) {`
`49`	`49`	`buffer.order(ByteOrder.LITTLE_ENDIAN);`
`50`	`50`
`51`	`51`	`this.amount = buffer.getLong();`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public HashMap<String, Object> assetToHashMap() {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`@Override`
`30`		`- public byte[] serialize() {`
	`30`	`+ public byte[] serializeData() {`
`31`	`31`	`byte[] username = this.asset.username.getBytes();`
`32`	`32`
`33`	`33`	`ByteBuffer buffer = ByteBuffer.allocate(username.length + 1);`
`@@ -41,7 +41,7 @@ public byte[] serialize() {`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`@Override`
`44`		`- public void deserialize(ByteBuffer buffer) {`
	`44`	`+ public void deserializeData(ByteBuffer buffer) {`
`45`	`45`	`int usernameLength = buffer.get() & 0xff;`
`46`	`46`
`47`	`47`	`byte[] username = new byte[usernameLength];`
Original file line number	Diff line number	Diff line change
`@@ -22,10 +22,10 @@ public HashMap<String, Object> assetToHashMap() {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`@Override`
`25`		`- public byte[] serialize() {`
	`25`	`+ public byte[] serializeData() {`
`26`	`26`	`return new byte[0];`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`@Override`
`30`		`- public void deserialize(ByteBuffer buffer) {}`
	`30`	`+ public void deserializeData(ByteBuffer buffer) {}`
`31`	`31`	`}`