Feat/ra 22 implement construction payload (#91)

* feat: initial implementation of construction preprocess

* refactor: refactoring this pullrequest

* refactor: renamed functions and added utility classes

* refactor: added cardano metadata objects to api.json and api.yaml. Removed all unused metadata classes. Reworked the code to be working again

* doc: added documentation of api extensions

* chore: added tests

* chore: merged main

* refactor: renamed domain classes

* feat: implemented construction Payload

* refactor: refactored and added postman tests

* refactor: renamed file

* chore: added Tests for encoder

* chore: added Tests for encoder

* chore: merged master

* chore: Merged master

* refactored and preparing the pull Request

* refactored and preparing the pull Request

* refactor: fixed a potential error regarding networkTypes

Author: Kammerlo

api/src/main/java/org/cardanofoundation/rosetta/api/construction/service/impl/ConstructionApiServiceImpl.java

@@ -5,20 +5,27 @@
 import co.nstant.in.cbor.model.UnicodeString;
 import com.bloxbean.cardano.client.exception.AddressExcepion;
 import com.bloxbean.cardano.client.exception.CborSerializationException;
+import java.util.List;
 import java.util.Optional;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.ObjectUtils;
 import org.cardanofoundation.rosetta.api.block.model.entity.ProtocolParams;
 import org.cardanofoundation.rosetta.common.enumeration.NetworkIdentifierType;
+import org.cardanofoundation.rosetta.common.enumeration.NetworkIdentifierType;
+import org.cardanofoundation.rosetta.common.exception.ExceptionFactory;
 import org.cardanofoundation.rosetta.common.mapper.DataMapper;
 import org.cardanofoundation.rosetta.common.enumeration.AddressType;
 
 import org.cardanofoundation.rosetta.common.enumeration.NetworkEnum;
+import org.cardanofoundation.rosetta.common.model.cardano.transaction.UnsignedTransaction;
 import org.cardanofoundation.rosetta.common.services.CardanoAddressService;
+import org.cardanofoundation.rosetta.common.services.CardanoConfigService;
 import org.cardanofoundation.rosetta.common.services.CardanoService;
 import org.cardanofoundation.rosetta.api.construction.service.ConstructionApiService;
 import org.cardanofoundation.rosetta.common.services.LedgerDataProviderService;
 import org.cardanofoundation.rosetta.common.util.Constants;
+import org.cardanofoundation.rosetta.common.util.CborEncodeUtil;
 import org.openapitools.client.model.*;
 import org.springframework.stereotype.Service;
 
@@ -33,6 +40,7 @@ public class ConstructionApiServiceImpl implements ConstructionApiService {
   private final CardanoAddressService cardanoAddressService;
   private final CardanoService cardanoService;
   private final LedgerDataProviderService ledgerService;
+  private final CardanoConfigService cardanoConfigService;
   private final DataMapper dataMapper;
 
   @Override
@@ -101,8 +109,50 @@ public ConstructionMetadataResponse constructionMetadataService(
 
   @Override
   public ConstructionPayloadsResponse constructionPayloadsService(
-      ConstructionPayloadsRequest constructionPayloadsRequest) {
-    return null;
+      ConstructionPayloadsRequest constructionPayloadsRequest)
+      throws CborException, AddressExcepion, IOException, CborSerializationException {
+    int ttl = constructionPayloadsRequest.getMetadata().getTtl();
+    List<Operation> operations = constructionPayloadsRequest.getOperations();
+
+    checkOperationsHaveIdentifier(operations);
+
+    NetworkIdentifierType networkIdentifier = NetworkIdentifierType.findByName(constructionPayloadsRequest.getNetworkIdentifier().getNetwork());
+    log.info(operations + "[constuctionPayloads] Operations about to be processed");
+
+    ProtocolParameters protocolParameters = constructionPayloadsRequest.getMetadata()
+        .getProtocolParameters();
+    String keyDeposit;
+    String poolDeposit;
+    // TODO need to convert OpenAPI ProcotolParameters to domain ProtocolParams. Then merge with the one from indexer/config
+    if(protocolParameters != null) {
+      keyDeposit = protocolParameters.getKeyDeposit();
+      poolDeposit = protocolParameters.getPoolDeposit();
+    } else {
+      ProtocolParams protocolParametersFromIndexerAndConfig = ledgerService.findProtocolParametersFromIndexerAndConfig();
+      keyDeposit = protocolParametersFromIndexerAndConfig.getKeyDeposit().toString();
+      poolDeposit = protocolParametersFromIndexerAndConfig.getPoolDeposit().toString();
+    }
+
+    UnsignedTransaction unsignedTransaction = cardanoService.createUnsignedTransaction(
+        networkIdentifier, operations, ttl,
+        new DepositParameters(keyDeposit,
+            poolDeposit));
+    List<SigningPayload> payloads = cardanoService.constructPayloadsForTransactionBody(
+        unsignedTransaction.hash(), unsignedTransaction.addresses());
+    String unsignedTransactionString = CborEncodeUtil.encodeExtraData(
+        unsignedTransaction.bytes(),
+        constructionPayloadsRequest.getOperations(),
+            unsignedTransaction.metadata());
+    return new ConstructionPayloadsResponse(unsignedTransactionString, payloads);
+  }
+
+  private static void checkOperationsHaveIdentifier(List<Operation> operations) {
+    for (int i = 0; i < operations.size(); i++) {
+      if (operations.get(i).getOperationIdentifier() == null) {
+        throw ExceptionFactory.unspecifiedError(
+            "body[" + i + "]" + " should have required property operation_identifier");
+      }
+    }
   }
 
   @Override

api/src/main/java/org/cardanofoundation/rosetta/common/enumeration/NetworkIdentifierType.java

@@ -5,7 +5,7 @@
 public enum NetworkIdentifierType {
   CARDANO_MAINNET_NETWORK("mainnet", 1, 764824073L),
   CARDANO_TESTNET_NETWORK("testnet", 0, 1097911063L),
-  CARDANO_PREPROD_NETWORK("preprod", 0, 1097911063L);
+  CARDANO_PREPROD_NETWORK("preprod", 0, 1);
 
   private String networkId;
   private int value;

api/src/main/java/org/cardanofoundation/rosetta/common/mapper/DataMapper.java

@@ -167,7 +167,7 @@ public static Amount mapAmount(String value) {
    * @return The Rosetta compatible Amount
    */
   public static Amount mapAmount(String value, String symbol, Integer decimals,
-                                 Map<String, Object> metadata) {
+                                 CurrencyMetadata metadata) {
     if (Objects.isNull(symbol)) {
       symbol = Constants.ADA;
     }
@@ -197,7 +197,8 @@ public static AccountBalanceResponse mapToAccountBalanceResponse(Block block, Li
     if (sum > 0) {
       amounts.add(mapAmount(String.valueOf(sum)));
     }
-    nonLovelaceBalances.forEach(balance -> amounts.add(mapAmount(balance.quantity().toString(), Hex.encodeHexString(balance.assetName().getBytes()), Constants.MULTI_ASSET_DECIMALS, Map.of("policyId", balance.policy()))));
+    nonLovelaceBalances.forEach(balance -> amounts.add(mapAmount(balance.quantity().toString(), Hex.encodeHexString(balance.assetName().getBytes()), Constants.MULTI_ASSET_DECIMALS, new CurrencyMetadata(
+        balance.policy()))));
     return AccountBalanceResponse.builder()
             .blockIdentifier(BlockIdentifier.builder()
                     .hash(block.getHash())

api/src/main/java/org/cardanofoundation/rosetta/common/model/cardano/OperationMetadata.java

@@ -7,13 +7,4 @@
 
 import java.util.Set;
 
-@Getter
-@Setter
-@AllArgsConstructor
-@NoArgsConstructor
-public class UnsignedTransaction {
-    private String hash;
-    private String bytes;
-    private Set<String> addresses;
-    private String metadata;
-}
+public record UnsignedTransaction (String hash, String bytes, Set<String> addresses, String metadata){}

api/src/main/java/org/cardanofoundation/rosetta/common/model/cardano/transaction/UnsignedTransaction.java

@@ -6,6 +6,9 @@
 import com.bloxbean.cardano.client.exception.AddressExcepion;
 import com.bloxbean.cardano.client.exception.CborSerializationException;
 import com.bloxbean.cardano.client.transaction.spec.TransactionWitnessSet;
+import java.util.Set;
+import org.cardanofoundation.rosetta.api.block.model.domain.ProcessOperations;
+import com.bloxbean.cardano.client.transaction.spec.TransactionWitnessSet;
 import java.math.BigInteger;
 import org.cardanofoundation.rosetta.api.block.model.domain.ProcessOperations;
 import org.cardanofoundation.rosetta.api.block.model.entity.ProtocolParams;
@@ -20,31 +23,40 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import org.cardanofoundation.rosetta.common.model.cardano.transaction.UnsignedTransaction;
+import org.openapitools.client.model.DepositParameters;
+import org.openapitools.client.model.Operation;
+import org.openapitools.client.model.SigningPayload;
 
 public interface CardanoService {
 
 
-    String getHashOfSignedTransaction(String signedTransaction);
-    Array decodeExtraData(String encoded);
-    Long calculateTtl(Long ttlOffset);
-    Double checkOrReturnDefaultTtl(Integer relativeTtl);
-    Long updateTxSize(Long previousTxSize, Long previousTtl, Long updatedTtl) throws CborSerializationException, CborException;
-    Long calculateTxMinimumFee(Long transactionSize, ProtocolParams protocolParameters);
+  String getHashOfSignedTransaction(String signedTransaction);
+  Array decodeExtraData(String encoded);
+  Long calculateTtl(Long ttlOffset);
+  Double checkOrReturnDefaultTtl(Integer relativeTtl);
+  Long updateTxSize(Long previousTxSize, Long previousTtl, Long updatedTtl) throws CborSerializationException, CborException;
+  Long calculateTxMinimumFee(Long transactionSize, ProtocolParams protocolParameters);
+
+  Signatures signatureProcessor(EraAddressType eraAddressType, AddressType addressType,
+      String address);
+
+  Double calculateTxSize(NetworkIdentifierType networkIdentifierType, List<Operation> operations, int ttl, DepositParameters depositParameters) throws IOException, CborException, AddressExcepion, CborSerializationException;
 
-    Signatures signatureProcessor(EraAddressType eraAddressType, AddressType addressType,
-                                  String address);
+  String buildTransaction(String unsignedTransaction,
+      List<Signatures> signaturesList, String transactionMetadata);
 
-    Double calculateTxSize(NetworkIdentifierType networkIdentifierType, List<Operation> operations, int ttl, DepositParameters depositParameters) throws IOException, CborException, AddressExcepion, CborSerializationException;
+  TransactionWitnessSet getWitnessesForTransaction(
+      List<Signatures> signaturesList);
 
-    String buildTransaction(String unsignedTransaction,
-                            List<Signatures> signaturesList, String transactionMetadata);
+  List<SigningPayload> constructPayloadsForTransactionBody(String transactionBodyHash,
+      Set<String> addresses);
 
-    TransactionWitnessSet getWitnessesForTransaction(
-            List<Signatures> signaturesList);
+  Long calculateFee(ArrayList<BigInteger> inputAmounts, ArrayList<BigInteger> outputAmounts,
+      ArrayList<BigInteger> withdrawalAmounts, Map<String, Double> depositsSumMap);
 
-    Long calculateFee(ArrayList<BigInteger> inputAmounts, ArrayList<BigInteger> outputAmounts,
-                      ArrayList<BigInteger> withdrawalAmounts, Map<String, Double> depositsSumMap);
+  ProcessOperations convertRosettaOperations(NetworkIdentifierType networkIdentifierType,
+      List<Operation> operations) throws IOException;
 
-    ProcessOperations convertRosettaOperations(NetworkIdentifierType networkIdentifierType,
-                                 List<Operation> operations) throws IOException;
+  UnsignedTransaction createUnsignedTransaction(NetworkIdentifierType networkIdentifier, List<Operation> operations, int ttl, DepositParameters depositParameters) throws IOException, CborSerializationException, AddressExcepion, CborException;
 }

api/src/main/java/org/cardanofoundation/rosetta/common/services/CardanoService.java

@@ -37,23 +37,21 @@
 import org.cardanofoundation.rosetta.common.util.Constants;
 import org.cardanofoundation.rosetta.common.util.OperationParseUtil;
 import org.cardanofoundation.rosetta.common.util.ValidateParseUtil;
-import org.jetbrains.annotations.NotNull;
+import org.openapitools.client.model.AccountIdentifier;
 import org.openapitools.client.model.DepositParameters;
 import org.openapitools.client.model.Operation;
+import org.openapitools.client.model.SignatureType;
+import org.openapitools.client.model.SigningPayload;
+import org.jetbrains.annotations.NotNull;
 import org.springframework.stereotype.Service;
 
 import java.io.IOException;
 import java.math.BigInteger;
-import java.security.InvalidKeyException;
-import java.security.NoSuchAlgorithmException;
-import java.security.SignatureException;
-import java.security.spec.InvalidKeySpecException;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
-import java.util.Objects;
 import java.util.Set;
 
 import static java.math.BigInteger.valueOf;
@@ -136,7 +134,7 @@ public Signatures signatureProcessor(EraAddressType eraAddressType, AddressType
     @Override
     public Double calculateTxSize(NetworkIdentifierType networkIdentifierType, List<Operation> operations, int ttl, DepositParameters depositParameters) throws IOException, CborException, AddressExcepion, CborSerializationException {
         UnsignedTransaction unsignedTransaction = createUnsignedTransaction(networkIdentifierType, operations, ttl, !ObjectUtils.isEmpty(depositParameters) ? depositParameters : new DepositParameters(Constants.DEFAULT_KEY_DEPOSIT.toString(), Constants.DEFAULT_POOL_DEPOSIT.toString()));
-        List<Signatures> signaturesList = (unsignedTransaction.getAddresses()).stream().map(address -> {
+        List<Signatures> signaturesList = (unsignedTransaction.addresses()).stream().map(address -> {
             EraAddressType eraAddressType = CardanoAddressUtil.getEraAddressType(address);
             if (eraAddressType != null) {
                 return signatureProcessor(eraAddressType, null, address);
@@ -148,7 +146,7 @@ public Double calculateTxSize(NetworkIdentifierType networkIdentifierType, List<
             throw ExceptionFactory.invalidAddressError(address);
         }).toList();
 
-        String transaction = buildTransaction(unsignedTransaction.getBytes(), signaturesList, unsignedTransaction.getMetadata());
+        String transaction = buildTransaction(unsignedTransaction.bytes(), signaturesList, unsignedTransaction.metadata());
         return ((double) transaction.length() / 2);
 
     }
@@ -241,7 +239,8 @@ public TransactionWitnessSet getWitnessesForTransaction(List<Signatures> signatu
         }
     }
 
-    private UnsignedTransaction createUnsignedTransaction(NetworkIdentifierType networkIdentifierType, List<Operation> operations, int ttl, DepositParameters depositParameters) throws IOException, CborSerializationException, AddressExcepion, CborException {
+    @Override
+    public UnsignedTransaction createUnsignedTransaction(NetworkIdentifierType networkIdentifierType, List<Operation> operations, int ttl, DepositParameters depositParameters) throws IOException, CborSerializationException, AddressExcepion, CborException {
         log.info("[createUnsignedTransaction] About to create an unsigned transaction with {} operations", operations.size());
         ProcessOperationsReturn processOperationsReturnDto = processOperations(networkIdentifierType, operations, depositParameters);
 
@@ -268,13 +267,21 @@ private UnsignedTransaction createUnsignedTransaction(NetworkIdentifierType netw
         String transactionBytes = HexUtil.encodeHexString(com.bloxbean.cardano.yaci.core.util.CborSerializationUtil.serialize(mapCbor));
         log.info("[createUnsignedTransaction] Hashing transaction body");
         String bodyHash = com.bloxbean.cardano.client.util.HexUtil.encodeHexString(Blake2bUtil.blake2bHash256(CborSerializationUtil.serialize(mapCbor)));
-        UnsignedTransaction toReturn = new UnsignedTransaction(HexUtil.encodeHexString(HexUtil.decodeHexString(bodyHash)), transactionBytes, processOperationsReturnDto.getAddresses(), null);
+        UnsignedTransaction toReturn = new UnsignedTransaction(
+            HexUtil.encodeHexString(HexUtil.decodeHexString(bodyHash)),
+            transactionBytes,
+            processOperationsReturnDto.getAddresses(),
+            getHexEncodedAuxiliaryMetadataArray(processOperationsReturnDto));
+        log.info(toReturn + "[createUnsignedTransaction] Returning unsigned transaction, hash to sign and addresses that will sign hash");
+        return toReturn;
+    }
+
+    private static String getHexEncodedAuxiliaryMetadataArray(ProcessOperationsReturn processOperationsReturnDto) throws CborSerializationException, CborException {
         if (!ObjectUtils.isEmpty(processOperationsReturnDto.getVoteRegistrationMetadata())) {
             Array array = getArrayOfAuxiliaryData(processOperationsReturnDto);
-            toReturn.setMetadata(HexUtil.encodeHexString(CborSerializationUtil.serialize(array)));
+            return HexUtil.encodeHexString(CborSerializationUtil.serialize(array));
         }
-        log.info(toReturn + "[createUnsignedTransaction] Returning unsigned transaction, hash to sign and addresses that will sign hash");
-        return toReturn;
+        return null;
     }
 
     @NotNull
@@ -287,6 +294,14 @@ private static Array getArrayOfAuxiliaryData(ProcessOperationsReturn processOper
         return array;
     }
 
+  @Override
+  public List<SigningPayload> constructPayloadsForTransactionBody(String transactionBodyHash,
+      Set<String> addresses) {
+    return addresses.stream().map(
+        address -> new SigningPayload(null, new AccountIdentifier(address, null, null), transactionBodyHash,
+            SignatureType.ED25519)).toList();
+  }
+
     private ProcessOperationsReturn processOperations(NetworkIdentifierType networkIdentifierType, List<Operation> operations, DepositParameters depositParameters) throws IOException {
         ProcessOperations result = convertRosettaOperations(networkIdentifierType, operations);
         double refundsSum = result.getStakeKeyDeRegistrationsCount() * Long.parseLong(depositParameters.getKeyDeposit());