test: Add message submit tests 129-145

hapi/hedera-protobufs/services/consensus_submit_message.proto

@@ -27,6 +27,7 @@ option java_package = "com.hederahashgraph.api.proto.java";
 option java_multiple_files = true;
 
 import "basic_types.proto";
+import "custom_fees.proto";
 
 /**
  * UNDOCUMENTED
@@ -66,4 +67,14 @@ message ConsensusSubmitMessageTransactionBody {
      * Optional information of the current chunk in a fragmented message.
      */
     ConsensusMessageChunkInfo chunkInfo = 3;
+
+    /**
+     * The maximum custom fee that the user is willing to pay for the message. This field will be ignored if `accept_all_custom_fees` is set to `true`.
+     */
+    repeated FixedFee max_custom_fees = 4;
+
+    /**
+     * If set to true, the transaction will accept all custom fees from the topic id
+     */
+    bool accept_all_custom_fees = 5;
 }

hapi/hedera-protobufs/services/response_code.proto

@@ -1613,29 +1613,34 @@ enum ResponseCodeEnum {
     MISSING_EXPIRY_TIME = 372;
 
     /**
-    * The provided fee exempt key list size exceeded the limit.
-    */
+     * The provided fee exempt key list size exceeded the limit.
+     */
     MAX_ENTRIES_FOR_FEE_EXEMPT_KEY_LIST_EXCEEDED = 373;
 
     /**
-    * The provided fee exempt key list contains duplicated keys.
-    */
+     * The provided fee exempt key list contains duplicated keys.
+     */
     FEE_EXEMPT_KEY_LIST_CONTAINS_DUPLICATED_KEYS = 374;
 
     /**
-    * The provided fee exempt key list contains an invalid key.
-    */
+     * The provided fee exempt key list contains an invalid key.
+     */
     INVALID_KEY_IN_FEE_EXEMPT_KEY_LIST = 375;
 
     /**
-    * The provided fee schedule key contains an invalid key.
-    */
+     * The provided fee schedule key contains an invalid key.
+     */
     INVALID_FEE_SCHEDULE_KEY = 376;
 
     /**
-    * If a fee schedule key is not set when we create a topic
-    * we cannot add it on update.
-    */
+     * If a fee schedule key is not set when we create a topic
+     * we cannot add it on update.
+     */
     FEE_SCHEDULE_KEY_CANNOT_BE_UPDATED = 377;
 
+    /**
+     * The fee amount is exceeding the amount that the payer
+     * is willing to pay.
+     */
+    CUSTOM_FEES_LIMIT_EXCEEDED = 378;
 }

hedera-node/hedera-consensus-service-impl/src/main/java/com/hedera/node/app/service/consensus/impl/handlers/ConsensusSubmitMessageHandler.java

@@ -23,29 +23,40 @@
 import static com.hedera.hapi.node.base.ResponseCodeEnum.INVALID_TOPIC_MESSAGE;
 import static com.hedera.hapi.node.base.ResponseCodeEnum.INVALID_TRANSACTION;
 import static com.hedera.hapi.node.base.ResponseCodeEnum.MESSAGE_SIZE_TOO_LARGE;
+import static com.hedera.hapi.node.base.ResponseCodeEnum.SUCCESS;
 import static com.hedera.node.app.hapi.utils.fee.FeeBuilder.BASIC_ENTITY_ID_SIZE;
 import static com.hedera.node.app.hapi.utils.fee.FeeBuilder.LONG_SIZE;
 import static com.hedera.node.app.hapi.utils.fee.FeeBuilder.RECEIPT_STORAGE_TIME_SEC;
 import static com.hedera.node.app.hapi.utils.fee.FeeBuilder.TX_HASH_SIZE;
 import static com.hedera.node.app.spi.validation.Validations.mustExist;
+import static com.hedera.node.app.spi.workflows.DispatchOptions.stepDispatch;
+import static com.hedera.node.app.spi.workflows.HandleException.validateTrue;
 import static com.hedera.node.app.spi.workflows.PreCheckException.validateFalsePreCheck;
 import static com.hedera.node.app.spi.workflows.PreCheckException.validateTruePreCheck;
+import static com.hedera.node.app.spi.workflows.record.StreamBuilder.TransactionCustomizer.NOOP_TRANSACTION_CUSTOMIZER;
 import static java.util.Objects.requireNonNull;
 
 import com.hedera.hapi.node.base.AccountID;
 import com.hedera.hapi.node.base.HederaFunctionality;
+import com.hedera.hapi.node.base.Key;
+import com.hedera.hapi.node.base.ResponseCodeEnum;
 import com.hedera.hapi.node.base.SubType;
 import com.hedera.hapi.node.base.TopicID;
 import com.hedera.hapi.node.base.TransactionID;
 import com.hedera.hapi.node.consensus.ConsensusSubmitMessageTransactionBody;
 import com.hedera.hapi.node.state.consensus.Topic;
+import com.hedera.hapi.node.transaction.ConsensusCustomFee;
+import com.hedera.hapi.node.transaction.FixedFee;
 import com.hedera.hapi.node.transaction.TransactionBody;
 import com.hedera.node.app.hapi.utils.CommonPbjConverters;
 import com.hedera.node.app.service.consensus.ReadableTopicStore;
 import com.hedera.node.app.service.consensus.impl.WritableTopicStore;
+import com.hedera.node.app.service.consensus.impl.handlers.customfee.ConsensusCustomFeeAssessor;
 import com.hedera.node.app.service.consensus.impl.records.ConsensusSubmitMessageStreamBuilder;
+import com.hedera.node.app.service.token.records.CryptoTransferStreamBuilder;
 import com.hedera.node.app.spi.fees.FeeContext;
 import com.hedera.node.app.spi.fees.Fees;
+import com.hedera.node.app.spi.key.KeyVerifier;
 import com.hedera.node.app.spi.workflows.HandleContext;
 import com.hedera.node.app.spi.workflows.HandleException;
 import com.hedera.node.app.spi.workflows.PreCheckException;
@@ -61,6 +72,8 @@
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
 import java.time.Instant;
+import java.util.HashSet;
+import java.util.List;
 import javax.inject.Inject;
 import javax.inject.Singleton;
 
@@ -75,12 +88,14 @@ public class ConsensusSubmitMessageHandler implements TransactionHandler {
      */
     public static final long RUNNING_HASH_VERSION = 3L;
 
+    private final ConsensusCustomFeeAssessor customFeeAssessor;
+
     /**
      * Default constructor for injection.
      */
     @Inject
-    public ConsensusSubmitMessageHandler() {
-        // Exists for injection
+    public ConsensusSubmitMessageHandler(@NonNull ConsensusCustomFeeAssessor customFeeAssessor) {
+        this.customFeeAssessor = requireNonNull(customFeeAssessor);
     }
 
     @Override
@@ -105,6 +120,12 @@ public void preHandle(@NonNull final PreHandleContext context) throws PreCheckEx
         if (topic.hasSubmitKey()) {
             context.requireKeyOrThrow(topic.submitKeyOrThrow(), INVALID_SUBMIT_KEY);
         }
+        // add optional fee exempt keys in to the key verifieer
+        // later it will be used to validate if transaction was signed by
+        // any of these keys and based on that, custom fees will be charged or not
+        if (!topic.feeExemptKeyList().isEmpty()) {
+            context.optionalKeys(new HashSet<>(topic.feeExemptKeyList()));
+        }
     }
 
     /**
@@ -128,6 +149,26 @@ public void handle(@NonNull final HandleContext handleContext) {
         final var config = handleContext.configuration().getConfigData(ConsensusConfig.class);
         validateTransaction(txn, config, topic);
 
+        /* handle custom fees */
+        if (!topic.customFees().isEmpty() && !isFeeExempted(topic.feeExemptKeyList(), handleContext.keyVerifier())) {
+            // check payer limits or throw
+            if (!op.acceptAllCustomFees()) {
+                validateFeeLimits(topic.customFees(), op.maxCustomFees());
+            }
+            // create synthetic body and dispatch crypto transfer
+            final var syntheticBodies = customFeeAssessor.assessCustomFee(topic, handleContext);
+            for (final var syntheticBody : syntheticBodies) {
+                final var record = handleContext.dispatch(stepDispatch(
+                        handleContext.payer(),
+                        TransactionBody.newBuilder()
+                                .cryptoTransfer(syntheticBody)
+                                .build(),
+                        CryptoTransferStreamBuilder.class,
+                        NOOP_TRANSACTION_CUSTOMIZER));
+                validateTrue(record.status().equals(SUCCESS), record.status());
+            }
+        }
+
         try {
             final var updatedTopic = updateRunningHashAndSequenceNumber(txn, topic, handleContext.consensusNow());
 
@@ -280,6 +321,60 @@ public static byte[] noThrowSha384HashOf(final byte[] byteArray) {
         }
     }
 
+    /**
+     * Check if the submit message transaction is fee exempt
+     *
+     * @param feeExemptKeyList The list of keys that are exempt from fees
+     * @param keyVerifier The key verifier of this transaction
+     * @return if the transaction is fee exempt
+     */
+    private boolean isFeeExempted(@NonNull final List<Key> feeExemptKeyList, @NonNull final KeyVerifier keyVerifier) {
+        if (!feeExemptKeyList.isEmpty()) {
+            for (final var key : feeExemptKeyList) {
+                final var keyVerificationResult = keyVerifier.verificationFor(key);
+                if (keyVerificationResult.passed()) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Validate that each topic custom fee has equal or lower value than the payer's limit
+     *
+     * @param topicCustomFees The topic's custom fee list
+     * @param payerCustomFeeLimits List with limits of fees that the payer is willing to pay
+     */
+    private void validateFeeLimits(
+            @NonNull final List<ConsensusCustomFee> topicCustomFees,
+            @NonNull final List<FixedFee> payerCustomFeeLimits) {
+        for (final ConsensusCustomFee fee : topicCustomFees) {
+            // validate limits
+            boolean passed = false;
+            final var fixedFee = fee.fixedFeeOrThrow();
+            if (fixedFee.hasDenominatingTokenId()) {
+                for (FixedFee feeLimit : payerCustomFeeLimits) {
+                    if (feeLimit.hasDenominatingTokenId()
+                            && feeLimit.denominatingTokenId().equals(fixedFee.denominatingTokenId())
+                            && fixedFee.amount() <= feeLimit.amount()) {
+                        passed = true;
+                        break;
+                    }
+                }
+            } else {
+                for (FixedFee feeLimit : payerCustomFeeLimits) {
+                    if (!feeLimit.hasDenominatingTokenId() && feeLimit.amount() <= fixedFee.amount()) {
+                        passed = true;
+                        break;
+                    }
+                }
+            }
+            // if any fee amount is larger than the corresponding limit, validation should fail
+            validateTrue(passed, ResponseCodeEnum.CUSTOM_FEES_LIMIT_EXCEEDED);
+        }
+    }
+
     @NonNull
     @Override
     public Fees calculateFees(@NonNull final FeeContext feeContext) {

hedera-node/hedera-consensus-service-impl/src/main/java/com/hedera/node/app/service/consensus/impl/handlers/customfee/ConsensusCustomFeeAssessor.java

@@ -0,0 +1,132 @@
+/*
+ * Copyright (C) 2024 Hedera Hashgraph, LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.hedera.node.app.service.consensus.impl.handlers.customfee;
+
+import static com.hedera.node.app.spi.workflows.HandleException.validateTrue;
+
+import com.hedera.hapi.node.base.AccountAmount;
+import com.hedera.hapi.node.base.AccountID;
+import com.hedera.hapi.node.base.ResponseCodeEnum;
+import com.hedera.hapi.node.base.TokenID;
+import com.hedera.hapi.node.base.TokenTransferList;
+import com.hedera.hapi.node.base.TransferList;
+import com.hedera.hapi.node.state.consensus.Topic;
+import com.hedera.hapi.node.token.CryptoTransferTransactionBody;
+import com.hedera.hapi.node.transaction.ConsensusCustomFee;
+import com.hedera.hapi.node.transaction.FixedFee;
+import com.hedera.node.app.service.token.ReadableTokenStore;
+import com.hedera.node.app.spi.workflows.HandleContext;
+import edu.umd.cs.findbugs.annotations.NonNull;
+import java.util.ArrayList;
+import java.util.List;
+import javax.inject.Inject;
+import javax.inject.Singleton;
+
+@Singleton
+public class ConsensusCustomFeeAssessor {
+
+    /**
+     * Constructs a {@link ConsensusCustomFeeAssessor} instance.
+     */
+    @Inject
+    public ConsensusCustomFeeAssessor() {
+        // Needed for Dagger injection
+    }
+
+    /**
+     * Build and return a list of synthetic crypto transfer transaction bodies, that represents custom fees payments.
+     * It will return one body per topic custom fee.
+     *
+     * @param topic The topic
+     * @param context The transaction handle context
+     * @return List of synthetic crypto transfer transaction bodies
+     */
+    public List<CryptoTransferTransactionBody> assessCustomFee(
+            @NonNull final Topic topic, @NonNull final HandleContext context) {
+        final List<CryptoTransferTransactionBody> transactionBodies = new ArrayList<>();
+        final var payer = context.payer();
+        final var tokenStore = context.storeFactory().readableStore(ReadableTokenStore.class);
+
+        // build crypto transfer bodies for the first layer of custom fees,
+        // if there is a second or third layer it will be assessed in crypto transfer handler
+        for (ConsensusCustomFee fee : topic.customFees()) {
+
+            // check if payer is collector
+            if (context.payer().equals(fee.feeCollectorAccountId())) {
+                continue;
+            }
+
+            final var tokenTransfers = new ArrayList<TokenTransferList>();
+            List<AccountAmount> hbarTransfers = new ArrayList<>();
+
+            final var fixedFee = fee.fixedFeeOrThrow();
+            if (fixedFee.hasDenominatingTokenId()) {
+                final var tokenId = fixedFee.denominatingTokenIdOrThrow();
+                final var tokenTreasury = getTokenTreasury(tokenId, tokenStore);
+                // check if payer is treasury
+                if (context.payer().equals(tokenTreasury)) {
+                    continue;
+                }
+                tokenTransfers.add(buildCustomFeeTokenTransferList(payer, fee.feeCollectorAccountId(), fixedFee));
+            } else {
+                hbarTransfers = buildCustomFeeHbarTransferList(payer, fee.feeCollectorAccountId(), fixedFee);
+            }
+
+            // build the synthetic body
+            final var syntheticBodyBuilder =
+                    CryptoTransferTransactionBody.newBuilder().tokenTransfers(tokenTransfers);
+            transactionBodies.add(syntheticBodyBuilder
+                    .transfers(TransferList.newBuilder().accountAmounts(hbarTransfers.toArray(AccountAmount[]::new)))
+                    .build());
+        }
+
+        return transactionBodies;
+    }
+
+    private List<AccountAmount> buildCustomFeeHbarTransferList(AccountID payer, AccountID collector, FixedFee fee) {
+        return List.of(
+                AccountAmount.newBuilder()
+                        .accountID(payer)
+                        .amount(-fee.amount())
+                        .build(),
+                AccountAmount.newBuilder()
+                        .accountID(collector)
+                        .amount(fee.amount())
+                        .build());
+    }
+
+    private TokenTransferList buildCustomFeeTokenTransferList(AccountID payer, AccountID collector, FixedFee fee) {
+        return TokenTransferList.newBuilder()
+                .token(fee.denominatingTokenId())
+                .transfers(
+                        AccountAmount.newBuilder()
+                                .accountID(payer)
+                                .amount(-fee.amount())
+                                .build(),
+                        AccountAmount.newBuilder()
+                                .accountID(collector)
+                                .amount(fee.amount())
+                                .build())
+                .build();
+    }
+
+    private AccountID getTokenTreasury(TokenID tokenId, ReadableTokenStore tokenStore) {
+        final var token = tokenStore.get(tokenId);
+        validateTrue(token != null, ResponseCodeEnum.INVALID_TOKEN_ID_IN_CUSTOM_FEES);
+        return token.treasuryAccountIdOrThrow();
+    }
+}

hedera-node/hedera-consensus-service-impl/src/main/java/module-info.java

@@ -27,6 +27,7 @@
             com.hedera.node.app,
             com.hedera.node.test.clients;
     exports com.hedera.node.app.service.consensus.impl.handlers;
+    exports com.hedera.node.app.service.consensus.impl.handlers.customfee;
     exports com.hedera.node.app.service.consensus.impl.records;
     exports com.hedera.node.app.service.consensus.impl.schemas;
     exports com.hedera.node.app.service.consensus.impl.validators;