Merge pull request #59 from unicitynetwork/issue-57

#57, #55 Update inclusion proof verification, add cbor tags

Author: b3y0urs3lf

src/main/java/org/unicitylabs/sdk/StateTransitionClient.java

@@ -1,12 +1,9 @@
 
 package org.unicitylabs.sdk;
 
+import org.unicitylabs.sdk.api.*;
+
 import java.util.concurrent.CompletableFuture;
-import org.unicitylabs.sdk.api.AggregatorClient;
-import org.unicitylabs.sdk.api.CertificationData;
-import org.unicitylabs.sdk.api.CertificationResponse;
-import org.unicitylabs.sdk.api.InclusionProofResponse;
-import org.unicitylabs.sdk.api.StateId;
 
 /**
  * Client for handling state transitions of tokens, including submitting commitments and finalizing transactions.

src/main/java/org/unicitylabs/sdk/api/BlockHeightResponse.java

@@ -4,11 +4,12 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
-import java.util.Objects;
 import org.unicitylabs.sdk.serializer.UnicityObjectMapper;
 import org.unicitylabs.sdk.serializer.json.JsonSerializationException;
 import org.unicitylabs.sdk.serializer.json.LongAsStringSerializer;
 
+import java.util.Objects;
+
 /**
  * Block height response.
  */
@@ -18,7 +19,7 @@ public class BlockHeightResponse {
 
   @JsonCreator
   private BlockHeightResponse(
-      @JsonProperty("blockNumber") long blockNumber
+          @JsonProperty("blockNumber") long blockNumber
   ) {
     this.blockNumber = blockNumber;
   }

src/main/java/org/unicitylabs/sdk/api/CertificationData.java

@@ -1,51 +1,57 @@
 package org.unicitylabs.sdk.api;
 
-import java.util.Arrays;
-import java.util.List;
-import java.util.Objects;
 import org.unicitylabs.sdk.crypto.MintSigningService;
 import org.unicitylabs.sdk.crypto.hash.DataHash;
-import org.unicitylabs.sdk.crypto.hash.DataHasher;
 import org.unicitylabs.sdk.crypto.hash.HashAlgorithm;
 import org.unicitylabs.sdk.crypto.secp256k1.SigningService;
 import org.unicitylabs.sdk.predicate.EncodedPredicate;
-import org.unicitylabs.sdk.predicate.Predicate;
 import org.unicitylabs.sdk.predicate.UnlockScript;
-import org.unicitylabs.sdk.predicate.builtin.PayToPublicKeyPredicateUnlockScript;
+import org.unicitylabs.sdk.predicate.builtin.SignaturePredicateUnlockScript;
 import org.unicitylabs.sdk.serializer.cbor.CborDeserializer;
+import org.unicitylabs.sdk.serializer.cbor.CborSerializationException;
 import org.unicitylabs.sdk.serializer.cbor.CborSerializer;
 import org.unicitylabs.sdk.transaction.MintTransaction;
 import org.unicitylabs.sdk.transaction.Transaction;
 import org.unicitylabs.sdk.util.HexConverter;
 
+import java.util.Arrays;
+import java.util.List;
+import java.util.Objects;
+
 /**
  * Certification data.
  */
 public class CertificationData {
+  public static final long CBOR_TAG = 39031;
+  private static final int VERSION = 1;
 
-  private final Predicate lockScript;
+  private final EncodedPredicate lockScript;
   private final DataHash sourceStateHash;
   private final DataHash transactionHash;
   private final byte[] unlockScript;
 
   CertificationData(
-      Predicate lockScript,
-      DataHash sourceStateHash,
-      DataHash transactionHash,
-      byte[] unlockScript
+          EncodedPredicate lockScript,
+          DataHash sourceStateHash,
+          DataHash transactionHash,
+          byte[] unlockScript
   ) {
     this.lockScript = lockScript;
     this.sourceStateHash = sourceStateHash;
     this.transactionHash = transactionHash;
     this.unlockScript = Arrays.copyOf(unlockScript, unlockScript.length);
   }
 
+  public int getVersion() {
+    return CertificationData.VERSION;
+  }
+
   /**
    * Get lock script of certified transaction output.
    *
    * @return lock script
    */
-  public Predicate getLockScript() {
+  public EncodedPredicate getLockScript() {
     return this.lockScript;
   }
 
@@ -83,13 +89,22 @@ public byte[] getUnlockScript() {
    * @return CertificationData
    */
   public static CertificationData fromCbor(byte[] bytes) {
-    List<byte[]> data = CborDeserializer.decodeArray(bytes);
+    CborDeserializer.CborTag tag = CborDeserializer.decodeTag(bytes);
+    if (tag.getTag() != CertificationData.CBOR_TAG) {
+      throw new CborSerializationException(String.format("Invalid CBOR tag: %s", tag.getTag()));
+    }
+    List<byte[]> data = CborDeserializer.decodeArray(tag.getData(), 5);
+
+    int version = CborDeserializer.decodeUnsignedInteger(data.get(0)).asInt();
+    if (version != CertificationData.VERSION) {
+      throw new CborSerializationException(String.format("Unsupported version: %s", version));
+    }
 
     return new CertificationData(
-        EncodedPredicate.fromCbor(data.get(0)),
-        new DataHash(HashAlgorithm.SHA256, CborDeserializer.decodeByteString(data.get(1))),
-        new DataHash(HashAlgorithm.SHA256, CborDeserializer.decodeByteString(data.get(2))),
-        CborDeserializer.decodeByteString(data.get(3))
+            EncodedPredicate.fromCbor(data.get(1)),
+            new DataHash(HashAlgorithm.SHA256, CborDeserializer.decodeByteString(data.get(2))),
+            new DataHash(HashAlgorithm.SHA256, CborDeserializer.decodeByteString(data.get(3))),
+            CborDeserializer.decodeByteString(data.get(4))
     );
   }
 
@@ -101,12 +116,14 @@ public static CertificationData fromCbor(byte[] bytes) {
    * @return certification data
    */
   public static CertificationData fromMintTransaction(MintTransaction transaction) {
+    Objects.requireNonNull(transaction, "transaction cannot be null");
+
     SigningService signingService = MintSigningService.create(transaction.getTokenId());
 
     return CertificationData.fromTransaction(
-        transaction,
-        PayToPublicKeyPredicateUnlockScript.create(transaction, signingService).getSignature()
-            .encode()
+            transaction,
+            SignaturePredicateUnlockScript.create(transaction, signingService).getSignature()
+                    .encode()
     );
   }
 
@@ -119,6 +136,8 @@ public static CertificationData fromMintTransaction(MintTransaction transaction)
    * @return certification data
    */
   public static CertificationData fromTransaction(Transaction transaction, UnlockScript unlockScript) {
+    Objects.requireNonNull(unlockScript, "unlockScript cannot be null");
+
     return CertificationData.fromTransaction(transaction, unlockScript.encode());
   }
 
@@ -131,36 +150,32 @@ public static CertificationData fromTransaction(Transaction transaction, UnlockS
    * @return certification data
    */
   public static CertificationData fromTransaction(Transaction transaction, byte[] unlockScript) {
+    Objects.requireNonNull(transaction, "transaction cannot be null");
+    Objects.requireNonNull(unlockScript, "unlockScript cannot be null");
+
     return new CertificationData(
-        transaction.getLockScript(),
-        transaction.getSourceStateHash(),
-        transaction.calculateTransactionHash(),
-        unlockScript
+            transaction.getLockScript(),
+            transaction.getSourceStateHash(),
+            transaction.calculateTransactionHash(),
+            unlockScript
     );
   }
 
-  /**
-   * Calculate leaf value for Merkle tree.
-   *
-   * @return leaf value
-   */
-  public DataHash calculateLeafValue() {
-    return new DataHasher(HashAlgorithm.SHA256)
-        .update(this.toCbor())
-        .digest();
-  }
-
   /**
    * Serialize certification data to CBOR bytes.
    *
    * @return CBOR bytes
    */
   public byte[] toCbor() {
-    return CborSerializer.encodeArray(
-        EncodedPredicate.fromPredicate(this.getLockScript()).toCbor(),
-        CborSerializer.encodeByteString(this.sourceStateHash.getData()),
-        CborSerializer.encodeByteString(this.transactionHash.getData()),
-        CborSerializer.encodeByteString(this.unlockScript)
+    return CborSerializer.encodeTag(
+            CertificationData.CBOR_TAG,
+            CborSerializer.encodeArray(
+                    CborSerializer.encodeUnsignedInteger(CertificationData.VERSION),
+                    this.lockScript.toCbor(),
+                    CborSerializer.encodeByteString(this.sourceStateHash.getData()),
+                    CborSerializer.encodeByteString(this.transactionHash.getData()),
+                    CborSerializer.encodeByteString(this.unlockScript)
+            )
     );
   }
 
@@ -170,17 +185,22 @@ public boolean equals(Object o) {
       return false;
     }
     CertificationData that = (CertificationData) o;
-    return this.lockScript.isEqualTo(that.lockScript)
-        && Objects.equals(this.sourceStateHash, that.sourceStateHash)
-        && Objects.equals(this.transactionHash, that.transactionHash)
-        && Arrays.equals(this.unlockScript, that.unlockScript);
+    return Objects.equals(this.lockScript, that.lockScript)
+            && Objects.equals(this.sourceStateHash, that.sourceStateHash)
+            && Objects.equals(this.transactionHash, that.transactionHash)
+            && Arrays.equals(this.unlockScript, that.unlockScript);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(this.lockScript, this.sourceStateHash, this.transactionHash, Arrays.hashCode(this.unlockScript));
   }
 
   @Override
   public String toString() {
     return String.format(
-        "CertificationData{lockScript=%s, sourceStateHash=%s, transactionHash=%s, unlockScript=%s}",
-        this.lockScript, this.sourceStateHash, this.transactionHash,
-        HexConverter.encode(this.unlockScript));
+            "CertificationData{lockScript=%s, sourceStateHash=%s, transactionHash=%s, unlockScript=%s}",
+            this.lockScript, this.sourceStateHash, this.transactionHash,
+            HexConverter.encode(this.unlockScript));
   }
 }

src/main/java/org/unicitylabs/sdk/api/CertificationRequest.java

@@ -6,6 +6,8 @@
  * Submit certification request.
  */
 public class CertificationRequest {
+  public static final long CBOR_TAG = 39030;
+  private static final int VERSION = 1;
 
   private final StateId stateId;
   private final CertificationData certificationData;
@@ -17,13 +19,17 @@ public class CertificationRequest {
    * @param certificationData transaction hash
    */
   private CertificationRequest(
-      StateId stateId,
-      CertificationData certificationData
+          StateId stateId,
+          CertificationData certificationData
   ) {
     this.stateId = stateId;
     this.certificationData = certificationData;
   }
 
+  public int getVersion() {
+    return CertificationRequest.VERSION;
+  }
+
   /**
    * Get state id.
    *
@@ -50,7 +56,7 @@ public CertificationData getCertificationData() {
    */
   public static CertificationRequest create(CertificationData certificationData) {
     return new CertificationRequest(StateId.fromCertificationData(certificationData),
-        certificationData);
+            certificationData);
   }
 
   /**
@@ -59,10 +65,14 @@ public static CertificationRequest create(CertificationData certificationData) {
    * @return CBOR bytes
    */
   public byte[] toCbor() {
-    return CborSerializer.encodeArray(
-        this.stateId.toCbor(),
-        this.certificationData.toCbor(),
-        CborSerializer.encodeUnsignedInteger(0)
+    return CborSerializer.encodeTag(
+            CertificationRequest.CBOR_TAG,
+            CborSerializer.encodeArray(
+                    CborSerializer.encodeUnsignedInteger(CertificationRequest.VERSION),
+                    this.stateId.toCbor(),
+                    this.certificationData.toCbor(),
+                    CborSerializer.encodeUnsignedInteger(0)
+            )
     );
   }
 }

src/main/java/org/unicitylabs/sdk/api/CertificationResponse.java

@@ -3,7 +3,6 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.core.JsonProcessingException;
-import java.util.Objects;
 import org.unicitylabs.sdk.serializer.UnicityObjectMapper;
 import org.unicitylabs.sdk.serializer.json.JsonSerializationException;
 
@@ -21,7 +20,7 @@ public class CertificationResponse {
    */
   @JsonCreator
   CertificationResponse(
-      @JsonProperty("status") CertificationStatus status
+          @JsonProperty("status") CertificationStatus status
   ) {
     this.status = status;
   }