refactor: RA-52: Change mapper to work with an assets metadata.

BerezinD · Kammerlo · web-flow · commit 5db564e0483a · 2024-04-17T16:13:47.000+03:00
* refactor: transaction names to enum

* fix: changed how to get the symbol name to match TS variant.

* feat: RA-52: Added tests for the account API

---------

Co-authored-by: Kammerlo &lt;thomas.kammerlocher@cardanofoundation.org&gt;
diff --git a/api/src/main/java/org/cardanofoundation/rosetta/api/account/model/domain/Utxo.java b/api/src/main/java/org/cardanofoundation/rosetta/api/account/model/domain/Utxo.java
@@ -1,16 +1,12 @@
 package org.cardanofoundation.rosetta.api.account.model.domain;
 
-import java.math.BigInteger;
 import java.util.List;
 
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
-import org.cardanofoundation.rosetta.api.account.model.entity.AddressUtxoEntity;
-import org.cardanofoundation.rosetta.api.block.model.entity.UtxoKey;
-
 @Data
 @AllArgsConstructor
 @NoArgsConstructor
@@ -26,15 +22,4 @@ public Utxo(String txHash, Integer outputIndex) {
     this.txHash = txHash;
     this.outputIndex = outputIndex;
   }
-
-  public static Utxo fromUtxoKey(UtxoKey utxoKey) {
-    return new Utxo(utxoKey.getTxHash(), utxoKey.getOutputIndex());
-  }
-
-  public void populateFromUtxoEntity(AddressUtxoEntity entity) {
-    this.txHash = entity.getTxHash();
-    this.outputIndex = entity.getOutputIndex();
-    this.ownerAddr = entity.getOwnerAddr();
-    this.amounts = entity.getAmounts();
-  }
 }
diff --git a/api/src/main/java/org/cardanofoundation/rosetta/api/block/mapper/BlockTxToEntity.java b/api/src/main/java/org/cardanofoundation/rosetta/api/block/mapper/BlockTxToEntity.java
@@ -35,8 +35,10 @@ public BlockTx fromEntity(TxnEntity model) {
         .setPostConverter(ctx -> {
           TxnEntity source = ctx.getSource();
           BlockTx dest = ctx.getDestination();
-          dest.setInputs(source.getInputKeys().stream().map(Utxo::fromUtxoKey).toList());
-          dest.setOutputs(source.getOutputKeys().stream().map(Utxo::fromUtxoKey).toList());
+          dest.setInputs(source.getInputKeys().stream()
+              .map(utxoKey -> modelMapper.map(utxoKey, Utxo.class)).toList());
+          dest.setOutputs(source.getOutputKeys().stream()
+              .map(utxoKey -> modelMapper.map(utxoKey, Utxo.class)).toList());
           dest.setFee(Optional
               .ofNullable(source.getFee())
               .map(BigInteger::toString)
diff --git a/api/src/main/java/org/cardanofoundation/rosetta/common/mapper/DataMapper.java b/api/src/main/java/org/cardanofoundation/rosetta/common/mapper/DataMapper.java
@@ -1,24 +1,50 @@
 package org.cardanofoundation.rosetta.common.mapper;
 
-import com.bloxbean.cardano.client.common.model.Network;
 import java.math.BigDecimal;
+import java.math.BigInteger;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import javax.annotation.Nullable;
+
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
-import org.apache.commons.codec.binary.Hex;
+
+import com.bloxbean.cardano.client.common.model.Network;
 import org.apache.commons.lang3.ObjectUtils;
+import org.openapitools.client.model.AccountBalanceResponse;
+import org.openapitools.client.model.AccountCoinsResponse;
+import org.openapitools.client.model.AccountIdentifier;
+import org.openapitools.client.model.Amount;
+import org.openapitools.client.model.BlockIdentifier;
+import org.openapitools.client.model.Coin;
+import org.openapitools.client.model.CoinAction;
+import org.openapitools.client.model.CoinChange;
+import org.openapitools.client.model.CoinIdentifier;
+import org.openapitools.client.model.CoinTokens;
+import org.openapitools.client.model.ConstructionMetadataResponse;
+import org.openapitools.client.model.ConstructionMetadataResponseMetadata;
+import org.openapitools.client.model.Currency;
+import org.openapitools.client.model.CurrencyMetadata;
+import org.openapitools.client.model.NetworkIdentifier;
+import org.openapitools.client.model.NetworkListResponse;
+import org.openapitools.client.model.NetworkStatusResponse;
+import org.openapitools.client.model.Peer;
+import org.openapitools.client.model.Signature;
+
 import org.cardanofoundation.rosetta.api.account.model.domain.AddressBalance;
+import org.cardanofoundation.rosetta.api.account.model.domain.Amt;
 import org.cardanofoundation.rosetta.api.account.model.domain.Utxo;
-import org.cardanofoundation.rosetta.api.block.model.domain.*;
 import org.cardanofoundation.rosetta.api.block.model.domain.Block;
+import org.cardanofoundation.rosetta.api.block.model.domain.GenesisBlock;
+import org.cardanofoundation.rosetta.api.block.model.domain.NetworkStatus;
+import org.cardanofoundation.rosetta.api.block.model.domain.ProtocolParams;
+import org.cardanofoundation.rosetta.api.block.model.domain.StakeAddressBalance;
 import org.cardanofoundation.rosetta.common.annotation.PersistenceMapper;
+import org.cardanofoundation.rosetta.common.enumeration.NetworkEnum;
 import org.cardanofoundation.rosetta.common.model.cardano.crypto.Signatures;
 import org.cardanofoundation.rosetta.common.util.Constants;
-import org.cardanofoundation.rosetta.api.block.model.domain.ProtocolParams;
-import org.cardanofoundation.rosetta.common.enumeration.NetworkEnum;
-import org.openapitools.client.model.*;
-import org.openapitools.client.model.Currency;
-import org.springframework.stereotype.Component;
-import java.util.*;
 
 
 @Slf4j
@@ -156,29 +182,57 @@ public static AccountBalanceResponse mapToStakeAddressBalanceResponse(Block bloc
             .build();
   }
 
-  public static AccountCoinsResponse mapToAccountCoinsResponse(Block block,
-      List<Utxo> utxos) {
+  public static AccountCoinsResponse mapToAccountCoinsResponse(Block block, List<Utxo> utxos) {
     return AccountCoinsResponse.builder()
         .blockIdentifier(BlockIdentifier.builder()
             .hash(block.getHash())
             .index(block.getNumber())
             .build())
-        .coins(utxos.stream().map(utxo -> Coin.builder()
-                .coinIdentifier(CoinIdentifier.builder()
-                    .identifier(utxo.getTxHash() + ":" + utxo.getOutputIndex())
-                    .build())
-                .amount(Amount.builder()
-                    .value(utxo.getAmounts().getFirst().getQuantity().toString()) // TODO stream through amount list
-                    .currency(Currency.builder()
-                        .symbol(utxo.getAmounts().getFirst().getUnit())  // TODO stream through amount list
-                        .decimals(Constants.MULTI_ASSET_DECIMALS)
-                        .build())
-                    .build())
-                .build())
+        .coins(utxos.stream().map(utxo -> {
+              Amt adaAsset = utxo.getAmounts().stream()
+                  .filter(amt -> Constants.LOVELACE.equals(amt.getAssetName()))
+                  .findFirst()
+                  .orElseGet(() -> new Amt(null, null, Constants.ADA, BigInteger.ZERO));
+              return Coin.builder()
+                  .coinIdentifier(CoinIdentifier.builder()
+                      .identifier(utxo.getTxHash() + ":" + utxo.getOutputIndex())
+                      .build())
+                  .amount(Amount.builder()
+                      .value(adaAsset.getQuantity().toString()) // In the DB only Lovelace are persisted.
+                      .currency(Currency.builder()
+                          .symbol(Constants.ADA)
+                          .decimals(Constants.ADA_DECIMALS)
+                          .build())
+                      .build())
+                  .metadata(mapCoinMetadata(utxo))
+                  .build();
+            })
             .toList())
         .build();
   }
 
+  @Nullable
+  private static Map<String, List<CoinTokens>> mapCoinMetadata(Utxo utxo) {
+    String key = utxo.getTxHash() + ":" + utxo.getOutputIndex();
+    List<CoinTokens> coinTokens =
+        utxo.getAmounts().stream()
+            .filter(Objects::nonNull)
+            .filter(amount -> amount.getPolicyId() != null
+                && amount.getAssetName() != null
+                && amount.getQuantity() != null)
+            .map(amount -> {
+              CoinTokens tokens = new CoinTokens();
+              tokens.setPolicyId(amount.getPolicyId());
+              tokens.setTokens(List.of(mapAmount(amount.getQuantity().toString(),
+                  // unit = assetName + policyId. To get the symbol policy ID must be removed from Unit. According to CIP67
+                  amount.getUnit().replace(amount.getPolicyId(), ""),
+                  Constants.MULTI_ASSET_DECIMALS, new CurrencyMetadata(amount.getPolicyId()))));
+              return tokens;
+            })
+            .toList();
+    return coinTokens.isEmpty() ? null : Map.of(key, coinTokens);
+  }
+
   public ConstructionMetadataResponse mapToMetadataResponse(ProtocolParams protocolParams, Long ttl, Long suggestedFee) {
     return ConstructionMetadataResponse.builder()
             .metadata(ConstructionMetadataResponseMetadata.builder()
diff --git a/api/src/main/java/org/cardanofoundation/rosetta/common/services/impl/PostgresLedgerDataProviderService.java b/api/src/main/java/org/cardanofoundation/rosetta/common/services/impl/PostgresLedgerDataProviderService.java
@@ -9,10 +9,9 @@
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 
-import org.cardanofoundation.rosetta.api.block.mapper.WithdrawalEntityToWithdrawal;
-import org.cardanofoundation.rosetta.api.block.model.repository.WithdrawalRepository;
 import org.springframework.stereotype.Component;
 import org.apache.commons.lang3.ObjectUtils;
+import org.modelmapper.ModelMapper;
 import org.openapitools.client.model.Currency;
 
 import org.cardanofoundation.rosetta.api.account.model.domain.AddressBalance;
@@ -24,6 +23,7 @@
 import org.cardanofoundation.rosetta.api.account.model.repository.AddressUtxoRepository;
 import org.cardanofoundation.rosetta.api.block.mapper.BlockToEntity;
 import org.cardanofoundation.rosetta.api.block.mapper.BlockTxToEntity;
+import org.cardanofoundation.rosetta.api.block.mapper.WithdrawalEntityToWithdrawal;
 import org.cardanofoundation.rosetta.api.block.model.domain.Block;
 import org.cardanofoundation.rosetta.api.block.model.domain.BlockTx;
 import org.cardanofoundation.rosetta.api.block.model.domain.Delegation;
@@ -46,10 +46,11 @@
 import org.cardanofoundation.rosetta.api.block.model.repository.StakeAddressRepository;
 import org.cardanofoundation.rosetta.api.block.model.repository.StakeRegistrationRepository;
 import org.cardanofoundation.rosetta.api.block.model.repository.TxRepository;
+import org.cardanofoundation.rosetta.api.block.model.repository.WithdrawalRepository;
 import org.cardanofoundation.rosetta.common.exception.ExceptionFactory;
 import org.cardanofoundation.rosetta.common.mapper.ProtocolParamsToEntity;
-import org.cardanofoundation.rosetta.common.services.ProtocolParamService;
 import org.cardanofoundation.rosetta.common.services.LedgerDataProviderService;
+import org.cardanofoundation.rosetta.common.services.ProtocolParamService;
 import org.cardanofoundation.rosetta.common.util.Formatters;
 
 @Slf4j
@@ -71,6 +72,7 @@ public class PostgresLedgerDataProviderService implements LedgerDataProviderServ
 
   private final ProtocolParamService protocolParamService;
 
+  private final ModelMapper mapper;
   private final BlockToEntity mapperBlock;
   private final BlockTxToEntity mapperTran;
   private final ProtocolParamsToEntity mapperProtocolParams;
@@ -146,7 +148,8 @@ private void populateUtxos(List<Utxo> inputs) {
       AddressUtxoEntity first = addressUtxoRepository.findAddressUtxoEntitiesByOutputIndexAndTxHash(
           utxo.getOutputIndex(), utxo.getTxHash()).getFirst();
       if (first != null) {
-        utxo.populateFromUtxoEntity(first);
+        // Populating the values from entity to model
+        mapper.map(first, utxo);
       }
     }
   }
@@ -174,10 +177,9 @@ public Long findLatestBlockNumber() {
   @Override
   public List<Utxo> findUtxoByAddressAndCurrency(String address, List<Currency> currencies) {
     List<AddressUtxoEntity> addressUtxoEntities = addressUtxoRepository.findUtxosByAddress(address);
-    List<Utxo> list = addressUtxoEntities.stream()
+    return addressUtxoEntities.stream()
         .map(entity -> createUtxoModel(currencies, entity))
         .toList();
-    return list;
   }
 
   @Override
@@ -227,10 +229,10 @@ public ProtocolParams findProtocolParametersFromIndexerAndConfig() {
     return mapperProtocolParams.merge(protocolParamService.getProtocolParameters(), protocolParams);
   }
 
-  private static Utxo createUtxoModel(List<Currency> currencies, AddressUtxoEntity entity) {
-    Utxo utxoModel = Utxo.fromUtxoKey(
-        UtxoKey.builder().outputIndex(entity.getOutputIndex()).txHash(entity.getTxHash())
-            .build());
+  private Utxo createUtxoModel(List<Currency> currencies, AddressUtxoEntity entity) {
+    Utxo utxoModel = mapper.map(
+        UtxoKey.builder().outputIndex(entity.getOutputIndex()).txHash(entity.getTxHash()).build(),
+        Utxo.class);
     utxoModel.setAmounts(getAmts(currencies, entity));
     return utxoModel;
   }
diff --git a/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml b/api/src/main/resources/rosetta-specifications-1.4.15/api.yaml
@@ -981,6 +981,8 @@ components:
           $ref: '#/components/schemas/CoinIdentifier'
         amount:
           $ref: '#/components/schemas/Amount'
+        metadata:
+          $ref: '#/components/schemas/CoinMetadata'
     BalanceExemption:
       description: BalanceExemption indicates that the balance for an exempt account could change without a corresponding Operation. This typically occurs with staking rewards, vesting balances, and Currencies with a dynamic supply. Currently, it is possible to exempt an account from strict reconciliation by SubAccountIdentifier.Address or by Currency. This means that any account with SubAccountIdentifier.Address would be exempt or any balance of a particular Currency would be exempt, respectively. BalanceExemptions should be used sparingly as they may introduce significant complexity for integrators that attempt to reconcile all account balance changes. If your implementation relies on any BalanceExemptions, you MUST implement historical balance lookup (the ability to query an account balance at any BlockIdentifier).
       type: object
@@ -1951,3 +1953,25 @@ components:
           type: number
         protocol_parameters:
           $ref: '#/components/schemas/ProtocolParameters'
+    CoinMetadata:
+      description: CoinMetadata is used to provide additional data for a Coin object. It is often used to store human-readable information that a client can use to display information to a user.
+      type: object
+      additionalProperties:
+        type: array
+        items:
+          $ref: '#/components/schemas/CoinTokens'
+    CoinTokens:
+      description: |
+        CoinTokens contains the policyId and the tokens
+        it represents.
+      type: object
+      required:
+        - policyId
+        - tokens
+      properties:
+        policyId:
+          type: string
+        tokens:
+          type: array
+          items:
+            $ref: '#/components/schemas/Amount'
diff --git a/api/src/main/resources/rosetta-specifications-1.4.15/models/CoinMetadata.yaml b/api/src/main/resources/rosetta-specifications-1.4.15/models/CoinMetadata.yaml
@@ -0,0 +1,10 @@
+description: |
+  CoinMetadata is used to provide additional data for a Coin object. It is often used to store 
+  human-readable information that a client can use to display information to a user.
+type: object
+properties:
+  type: object
+  additionalProperties:
+    type: array
+    items:
+      $ref: 'CoinTokens.yaml'
diff --git a/api/src/main/resources/rosetta-specifications-1.4.15/models/CoinTokens.yaml b/api/src/main/resources/rosetta-specifications-1.4.15/models/CoinTokens.yaml
@@ -0,0 +1,14 @@
+description: |
+  CoinTokens contains the policyId and the tokens
+  it represents.
+type: object
+required:
+  - policyId
+  - tokens
+properties:
+  policyId:
+    type: string
+  tokens:
+    type: array
+    items:
+      $ref: 'Amount.yaml'
diff --git a/api/src/test/java/org/cardanofoundation/rosetta/api/SpringMappersTestConfig.java b/api/src/test/java/org/cardanofoundation/rosetta/api/SpringMappersTestConfig.java
@@ -7,6 +7,7 @@
 
 @TestConfiguration
 @ComponentScan(basePackages = {
+    "org.cardanofoundation.rosetta.api.account.mapper",
     "org.cardanofoundation.rosetta.api.block.mapper",
     "org.cardanofoundation.rosetta.common.mapper"})
 public class SpringMappersTestConfig {
diff --git a/api/src/test/java/org/cardanofoundation/rosetta/api/account/model/domain/UtxoTest.java b/api/src/test/java/org/cardanofoundation/rosetta/api/account/model/domain/UtxoTest.java
@@ -2,28 +2,35 @@
 
 import java.math.BigInteger;
 import java.util.Collections;
+import jakarta.inject.Inject;
+
+import org.modelmapper.ModelMapper;
 
 import org.junit.jupiter.api.Test;
 
+import org.cardanofoundation.rosetta.api.BaseMapperTest;
 import org.cardanofoundation.rosetta.api.account.model.entity.AddressUtxoEntity;
 import org.cardanofoundation.rosetta.api.block.model.entity.UtxoKey;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
-class UtxoTest {
+class UtxoTest extends BaseMapperTest {
+
+  @Inject
+  ModelMapper mapper;
 
   @Test
   void fromUtxoKeyPositiveTest() {
-    Utxo utxo = Utxo.fromUtxoKey(new UtxoKey("txHash", 1));
+    Utxo utxo = mapper.map(new UtxoKey("txHash", 1), Utxo.class);
     assertEquals("txHash", utxo.getTxHash());
     assertEquals(1, utxo.getOutputIndex());
   }
 
   @Test
   void fromUtxoKeyNullTest() {
-    assertThrows(NullPointerException.class, () -> Utxo.fromUtxoKey(null));
+    assertThrows(IllegalArgumentException.class, () -> mapper.map(null, Utxo.class));
   }
 
   @Test
@@ -33,7 +40,7 @@ void populateFromUtxoEntityPositiveTest() {
     entity.setAmounts(Collections.emptyList());
     Utxo utxo = new Utxo("txHash", 1);
 
-    utxo.populateFromUtxoEntity(entity);
+    mapper.map(entity, utxo);
 
     assertEquals("ownerAddr", utxo.getOwnerAddr());
     assertEquals(Collections.emptyList(), utxo.getAmounts());
@@ -42,6 +49,6 @@ void populateFromUtxoEntityPositiveTest() {
   @Test
   void populateFromUtxoEntityNullTest() {
     Utxo utxo = new Utxo("txHash", 1);
-    assertThrows(NullPointerException.class, () -> utxo.populateFromUtxoEntity(null));
+    assertThrows(IllegalArgumentException.class, () -> mapper.map(null, utxo));
   }
 }
diff --git a/api/src/test/java/org/cardanofoundation/rosetta/api/account/service/impl/AccountServiceImplTest.java b/api/src/test/java/org/cardanofoundation/rosetta/api/account/service/impl/AccountServiceImplTest.java
diff --git a/api/src/test/java/org/cardanofoundation/rosetta/api/block/service/BlockServiceImplIntTest.java b/api/src/test/java/org/cardanofoundation/rosetta/api/block/service/BlockServiceImplIntTest.java
diff --git a/api/src/test/java/org/cardanofoundation/rosetta/api/data/account/AccountCoinsApiTest.java b/api/src/test/java/org/cardanofoundation/rosetta/api/data/account/AccountCoinsApiTest.java
