fix: Fixes response code when failing in HbarChangesStep with custom fees (#12586)

Signed-off-by: Neeharika-Sompalli <[email protected]>

Author: Neeharika-Sompalli

hedera-node/hedera-token-service-impl/src/main/java/com/hedera/node/app/service/token/impl/handlers/transfer/AdjustHbarChangesStep.java

@@ -18,21 +18,26 @@
 
 import static com.hedera.hapi.node.base.ResponseCodeEnum.AMOUNT_EXCEEDS_ALLOWANCE;
 import static com.hedera.hapi.node.base.ResponseCodeEnum.INSUFFICIENT_ACCOUNT_BALANCE;
+import static com.hedera.hapi.node.base.ResponseCodeEnum.INSUFFICIENT_SENDER_ACCOUNT_BALANCE_FOR_CUSTOM_FEE;
 import static com.hedera.hapi.node.base.ResponseCodeEnum.INVALID_ACCOUNT_ID;
 import static com.hedera.hapi.node.base.ResponseCodeEnum.SPENDER_DOES_NOT_HAVE_ALLOWANCE;
 import static com.hedera.node.app.service.token.impl.util.TokenHandlerHelper.getIfUsable;
 import static com.hedera.node.app.spi.workflows.HandleException.validateTrue;
+import static java.util.Collections.emptyList;
 import static java.util.Objects.requireNonNull;
 
 import com.hedera.hapi.node.base.AccountID;
 import com.hedera.hapi.node.base.TransferList;
 import com.hedera.hapi.node.token.CryptoTransferTransactionBody;
+import com.hedera.hapi.node.transaction.AssessedCustomFee;
 import com.hedera.node.app.service.token.impl.WritableAccountStore;
 import com.hedera.node.app.service.token.impl.handlers.BaseTokenHandler;
+import com.hedera.node.app.spi.workflows.HandleException;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.LinkedHashMap;
+import java.util.List;
 import java.util.Map;
 
 public class AdjustHbarChangesStep extends BaseTokenHandler implements TransferStep {
@@ -133,9 +138,35 @@ private void modifyAggregatedTransfers(
                     accountId, accountStore, transferContext.getHandleContext().expiryValidator(), INVALID_ACCOUNT_ID);
             final var currentBalance = account.tinybarBalance();
             final var newBalance = currentBalance + amount;
+            if (newBalance < 0) {
+                final var assessedCustomFees = transferContext.getAssessedCustomFees();
+                // Whenever mono-service assessed a fixed fee to an account, it would
+                // update the "metadata" of that pending balance change to use
+                // INSUFFICIENT_SENDER_ACCOUNT_BALANCE_FOR_CUSTOM_FEE instead of
+                // INSUFFICIENT_ACCOUNT_BALANCE in the case of an insufficient balance.
+                // We don't have an equivalent place to store such "metadata" in the
+                // mod-service implementation; so instead if INSUFFICIENT_ACCOUNT_BALANCE
+                // happens, we check if there were any custom fee payments that could
+                // have contributed to the insufficient balance, and translate the
+                // error to INSUFFICIENT_SENDER_ACCOUNT_BALANCE_FOR_CUSTOM_FEE if so.
+                if (effectivePaymentWasMade(accountId, assessedCustomFees)) {
+                    throw new HandleException(INSUFFICIENT_SENDER_ACCOUNT_BALANCE_FOR_CUSTOM_FEE);
+                }
+            }
             validateTrue(newBalance >= 0, INSUFFICIENT_ACCOUNT_BALANCE);
             final var copy = account.copyBuilder();
             accountStore.put(copy.tinybarBalance(newBalance).build());
         }
     }
+
+    private boolean effectivePaymentWasMade(
+            @NonNull final AccountID payer, @NonNull final List<AssessedCustomFee> assessedCustomFees) {
+        for (final var fee : assessedCustomFees) {
+            if (fee.tokenId() == null
+                    && fee.effectivePayerAccountIdOrElse(emptyList()).contains(payer)) {
+                return true;
+            }
+        }
+        return false;
+    }
 }

hedera-node/test-clients/src/main/java/com/hedera/services/bdd/suites/crypto/CryptoTransferSuite.java

@@ -248,14 +248,49 @@ public List<HapiSpec> getSpecsInSuite() {
                 canUseAliasAndAccountCombinations(),
                 testTransferToSystemAccounts(),
                 testTransferToSystemAccountsAndCheckSenderBalance(),
-                transferInvalidTokenIdWithDecimals());
+                transferInvalidTokenIdWithDecimals(),
+                insufficientBalanceForCustomFeeFails());
     }
 
     @Override
     public boolean canRunConcurrent() {
         return true;
     }
 
+    @HapiTest
+    public HapiSpec insufficientBalanceForCustomFeeFails() {
+        final var operatorKey = "operatorKey";
+        final var accountId1Key = "accountId1Key";
+        final var accountId2Key = "accountId2Key";
+        final var operator = "operator";
+        final var accountId1 = "accountId1";
+        final var accountId2 = "accountId2";
+        final var tokenId = "tokenId";
+        return defaultHapiSpec("insufficientBalanceForFee", FULLY_NONDETERMINISTIC)
+                .given(
+                        newKeyNamed(operatorKey),
+                        newKeyNamed(accountId1Key),
+                        newKeyNamed(accountId2Key),
+                        cryptoCreate(accountId1).balance(2 * ONE_HBAR).key(accountId1Key),
+                        cryptoCreate(accountId2).balance(2 * ONE_HBAR).key(accountId2Key),
+                        cryptoCreate(operator).balance(0L).key(operatorKey),
+                        tokenCreate(tokenId)
+                                .name("ffff")
+                                .treasury(operator)
+                                .adminKey(operatorKey)
+                                .feeScheduleKey(operatorKey)
+                                .symbol("F")
+                                .initialSupply(1)
+                                .withCustom(fixedHbarFee(5000_000_000L, "operator"))
+                                .initialSupply(1)
+                                .decimals(0),
+                        tokenAssociate(accountId1, tokenId),
+                        tokenAssociate(accountId2, tokenId))
+                .when(cryptoTransfer(moving(1L, tokenId).between(operator, accountId1)))
+                .then(cryptoTransfer(moving(1L, tokenId).between(accountId1, accountId2))
+                        .hasKnownStatus(INSUFFICIENT_SENDER_ACCOUNT_BALANCE_FOR_CUSTOM_FEE));
+    }
+
     @HapiTest
     final HapiSpec okToRepeatSerialNumbersInWipeList() {
         final var ownerWith4AutoAssoc = "ownerWith4AutoAssoc";