chore: added wrong casing exception and check for address validation (#…

…240) * chore: added wrong casing exception and check for address validation * chore: added wrong casing exception and check for address validation
cardano-foundation · Aug 21, 2024 · e224a74 · e224a74
1 parent c3592f8
commit e224a74
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 11 deletions.
diff --git a/api/src/main/java/org/cardanofoundation/rosetta/api/account/service/AccountServiceImpl.java b/api/src/main/java/org/cardanofoundation/rosetta/api/account/service/AccountServiceImpl.java
@@ -48,13 +48,13 @@ public class AccountServiceImpl implements AccountService {
 
   @Override
   public AccountBalanceResponse getAccountBalance(AccountBalanceRequest accountBalanceRequest) {
+
+
     Long index = null;
     String hash = null;
     String accountAddress = accountBalanceRequest.getAccountIdentifier().getAddress();
-    if (Objects.isNull(CardanoAddressUtils.getEraAddressType(accountAddress))) {
-      log.error("[findBalanceDataByAddressAndBlock] Provided address is invalid {}", accountAddress);
-      throw ExceptionFactory.invalidAddressError(accountAddress);
-    }
+    CardanoAddressUtils.verifyAddress(accountAddress);
+
     PartialBlockIdentifier blockIdentifier = accountBalanceRequest.getBlockIdentifier();
     log.info("[accountBalance] Looking for block: {} || latest}", blockIdentifier);
 
@@ -69,15 +69,15 @@ public AccountBalanceResponse getAccountBalance(AccountBalanceRequest accountBal
 
   @Override
   public AccountCoinsResponse getAccountCoins(AccountCoinsRequest accountCoinsRequest) {
+    CardanoAddressUtils.verifyAddress(accountCoinsRequest.getAccountIdentifier().getAddress());
+
     String accountAddress = accountCoinsRequest.getAccountIdentifier().getAddress();
+    CardanoAddressUtils.verifyAddress(accountAddress);
+
     List<Currency> currencies = accountCoinsRequest.getCurrencies();
 //    accountCoinsRequest.getIncludeMempool(); // TODO
-
     log.debug("[accountCoins] Request received {}", accountCoinsRequest);
-    if (Objects.isNull(CardanoAddressUtils.getEraAddressType(accountAddress))) {
-      log.debug("[findBalanceDataByAddressAndBlock] Provided address is invalid {}", accountAddress);
-      throw ExceptionFactory.invalidAddressError(accountAddress);
-    }
+
     if (Objects.nonNull(currencies)) {
       validateCurrencies(currencies);
     }

diff --git a/api/src/main/java/org/cardanofoundation/rosetta/common/exception/ExceptionFactory.java b/api/src/main/java/org/cardanofoundation/rosetta/common/exception/ExceptionFactory.java
@@ -32,6 +32,11 @@ public static ApiException invalidAddressError(String address) {
         Details.builder().message(address).build()));
   }
 
+  public static ApiException invalidAddressCasingError(String address) {
+    return new ApiException(RosettaErrorType.INVALID_ADDRESS_CASING.toRosettaError(true,
+        Details.builder().message(address).build()));
+  }
+
   public static ApiException missingStakingKeyError() {
     return new ApiException(RosettaErrorType.STAKING_KEY_MISSING.toRosettaError(false));
   }

diff --git a/api/src/main/java/org/cardanofoundation/rosetta/common/util/CardanoAddressUtils.java b/api/src/main/java/org/cardanofoundation/rosetta/common/util/CardanoAddressUtils.java
@@ -1,6 +1,7 @@
 package org.cardanofoundation.rosetta.common.util;
 
 import java.util.Objects;
+import java.util.Optional;
 
 import lombok.extern.slf4j.Slf4j;
 
@@ -255,4 +256,21 @@ public static byte[] hexStringToBuffer(String input) {
     boolean checkEmptyHexString = CardanoAddressUtils.isEmptyHexString(input);
     return checkEmptyHexString ? HexUtil.decodeHexString(StringUtils.EMPTY) : HexUtil.decodeHexString(input);
   }
+
+  public static void verifyAddress(String address) {
+    try {
+      if (address == null || !AddressUtil.isValidAddress(address)) {
+        throw ExceptionFactory.invalidAddressError(address);
+      }
+    } catch (RuntimeException e) {
+      log.debug("[verifyAddress] Provided address is invalid {}", address);
+      throw ExceptionFactory.invalidAddressError(Optional.ofNullable(address).orElse(Constants.EMPTY_SYMBOL));
+    }
+    // Shelley era checking for lower case, upper case characters can lead to problems with other tools
+    // if Shelley Era and contains upper case characters
+    if (Objects.equals(getEraAddressType(address), EraAddressType.SHELLEY) && address.chars().anyMatch(Character::isUpperCase)) {
+        log.debug("[verifyAddress] Provided address is invalid {}", address);
+        throw ExceptionFactory.invalidAddressCasingError(address);
+    }
+  }
 }
diff --git a/api/src/main/java/org/cardanofoundation/rosetta/common/util/RosettaConstants.java b/api/src/main/java/org/cardanofoundation/rosetta/common/util/RosettaConstants.java
@@ -150,6 +150,7 @@ public enum RosettaErrorType {
     OUTSIDE_VALIDITY_INTERVAL_UTXO(
         "Error when sending the transaction - OutsideValidityIntervalUTxO", 4037),
     CONFIG_NOT_FOUND("Environment configurations needed to run server were not found", 4038),
+    INVALID_ADDRESS_CASING("Provided address has wrong casing, this might lead to problems with other tools", 4039),
     UNSPECIFIED_ERROR("An error occurred", 5000),
     NOT_IMPLEMENTED("Not implemented", 5001),
     ADDRESS_GENERATION_ERROR("Address generation error", 5002),

diff --git a/...c/test/java/org/cardanofoundation/rosetta/api/account/service/AccountServiceImplTest.java b/...c/test/java/org/cardanofoundation/rosetta/api/account/service/AccountServiceImplTest.java
@@ -325,7 +325,6 @@ void getAccountCoinsInvalidAddressThrowTest() {
     assertEquals(RosettaErrorType.INVALID_ADDRESS.getMessage(),
         actualException.getError().getMessage());
     verify(accountCoinsRequest).getAccountIdentifier();
-    verify(accountCoinsRequest).getCurrencies();
     verifyNoMoreInteractions(accountCoinsRequest);
     verifyNoMoreInteractions(accountIdentifier);
   }
@@ -372,7 +371,6 @@ private void verifyPositiveAccountCoinsCase(AccountCoinsResponse actual, Utxo ut
     verify(ledgerBlockService).findLatestBlockIdentifier();
     verify(ledgerAccountService).findUtxoByAddressAndCurrency(accountAddress,
         Collections.emptyList());
-    verify(accountCoinsRequest).getAccountIdentifier();
     verify(accountCoinsRequest).getCurrencies();
     verifyNoMoreInteractions(ledgerAccountService);
     verifyNoMoreInteractions(accountCoinsRequest);

diff --git a/api/src/test/java/org/cardanofoundation/rosetta/common/util/CardanoAddressUtilTest.java b/api/src/test/java/org/cardanofoundation/rosetta/common/util/CardanoAddressUtilTest.java
@@ -248,4 +248,19 @@ void publicKeyToHdPublicKeyInvalidPublicKeyTest() {
     assertEquals(RosettaErrorType.INVALID_STAKING_KEY_FORMAT.getMessage(),
         actualException.getError().getMessage());
   }
+
+  @Test
+  void isAddressValidTest() {
+    String validAddress = "addr1qyj9der2u29gcuwcxum7ylyfqrcg86d0l76khlazmn9cnxgqk2v9xpzd89c93yaszz2zgczqshqvf424cmpmswlr2lnqt6j3lu";
+    // not expecting an exception
+    CardanoAddressUtils.verifyAddress(validAddress);
+    // checking null
+    assertThrows(ApiException.class, () -> CardanoAddressUtils.verifyAddress(null));
+    String invalidAddress = "addr1qyj9der2u29gcuwcxum7ylyfqrcg86d0l76khlazmn9cnxgqk2v9xpzd89c93yaszz2zgczqshqvf424cmpmswlr2lnqt6j3lb";
+    assertThrows(RuntimeException.class, () -> CardanoAddressUtils.verifyAddress(invalidAddress));
+    // wrong Casing
+    String wrongCasingAddress = "addr1qyj9der2u29gcuwcxum7ylyfqrcg86d0l76khlazmn9cnxgqk2v9xpzd89c93yaszz2zgczqshqvf424cmpmswlr2lnqt6j3lU";
+    assertThrows(ApiException.class, () -> CardanoAddressUtils.verifyAddress(wrongCasingAddress));
+
+  }
 }