Externalize the generation of child records for view calls

hedera-node/hedera-app-spi/src/main/java/com/hedera/node/app/spi/workflows/record/SingleTransactionRecordBuilder.java

@@ -17,6 +17,9 @@
 package com.hedera.node.app.spi.workflows.record;
 
 import com.hedera.hapi.node.base.ResponseCodeEnum;
+import com.hedera.hapi.node.base.Transaction;
+import com.hedera.hapi.node.transaction.SignedTransaction;
+import com.hedera.hapi.node.transaction.TransactionBody;
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 /**
@@ -39,4 +42,20 @@
      * @return the builder
      */
     SingleTransactionRecordBuilder status(@NonNull ResponseCodeEnum status);
+
+    /**
+     * Convenience method to package as {@link TransactionBody} as a {@link Transaction} .
+     *
+     * @param body the transaction body
+     * @return the transaction
+     */
+    static Transaction transactionWith(@NonNull TransactionBody body) {
+        final var bodyBytes = TransactionBody.PROTOBUF.toBytes(body);
+        final var signedTransaction =
+                SignedTransaction.newBuilder().bodyBytes(bodyBytes).build();
+        final var signedTransactionBytes = SignedTransaction.PROTOBUF.toBytes(signedTransaction);
+        return Transaction.newBuilder()
+                .signedTransactionBytes(signedTransactionBytes)
+                .build();
+    }
 }

hedera-node/hedera-app/src/main/java/com/hedera/node/app/workflows/handle/ChildFinalizeContextImpl.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright (C) 2023 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.workflows.handle;
+
+import static com.hedera.node.app.workflows.handle.TokenContextImpl.castRecordBuilder;
+import static java.util.Objects.requireNonNull;
+
+import com.hedera.node.app.service.token.records.ChildFinalizeContext;
+import com.hedera.node.app.workflows.dispatcher.ReadableStoreFactory;
+import com.hedera.node.app.workflows.dispatcher.WritableStoreFactory;
+import com.hedera.node.app.workflows.handle.record.SingleTransactionRecordBuilderImpl;
+import edu.umd.cs.findbugs.annotations.NonNull;
+
+/**
+ * Standard implementation of {@link ChildFinalizeContext}.
+ */
+public class ChildFinalizeContextImpl implements ChildFinalizeContext {
+    private final ReadableStoreFactory readableStoreFactory;
+    private final WritableStoreFactory writableStoreFactory;
+    private final SingleTransactionRecordBuilderImpl recordBuilder;
+
+    public ChildFinalizeContextImpl(
+            @NonNull final ReadableStoreFactory readableStoreFactory,
+            @NonNull final WritableStoreFactory writableStoreFactory,
+            @NonNull final SingleTransactionRecordBuilderImpl recordBuilder) {
+        this.readableStoreFactory = requireNonNull(readableStoreFactory);
+        this.writableStoreFactory = requireNonNull(writableStoreFactory);
+        this.recordBuilder = requireNonNull(recordBuilder);
+    }
+
+    @NonNull
+    @Override
+    public <T> T readableStore(@NonNull Class<T> storeInterface) {
+        requireNonNull(storeInterface, "storeInterface must not be null");
+        return readableStoreFactory.getStore(storeInterface);
+    }
+
+    @NonNull
+    @Override
+    public <T> T writableStore(@NonNull Class<T> storeInterface) {
+        requireNonNull(storeInterface, "storeInterface must not be null");
+        return writableStoreFactory.getStore(storeInterface);
+    }
+
+    @NonNull
+    @Override
+    public <T> T userTransactionRecordBuilder(@NonNull final Class<T> recordBuilderClass) {
+        requireNonNull(recordBuilderClass, "recordBuilderClass must not be null");
+        return castRecordBuilder(recordBuilder, recordBuilderClass);
+    }
+}

hedera-node/hedera-app/src/main/java/com/hedera/node/app/workflows/handle/HandleContextImpl.java

@@ -44,7 +44,9 @@
 import com.hedera.node.app.fees.NoOpFeeCalculator;
 import com.hedera.node.app.ids.EntityIdService;
 import com.hedera.node.app.ids.WritableEntityIdStore;
+import com.hedera.node.app.service.token.TokenService;
 import com.hedera.node.app.service.token.api.TokenServiceApi;
+import com.hedera.node.app.service.token.records.ChildRecordFinalizer;
 import com.hedera.node.app.services.ServiceScopeLookup;
 import com.hedera.node.app.signature.DelegateKeyVerifier;
 import com.hedera.node.app.signature.KeyVerifier;
@@ -126,6 +128,7 @@ public class HandleContextImpl implements HandleContext, FeeContext {
     private final ExchangeRateManager exchangeRateManager;
     private final Authorizer authorizer;
     private final SolvencyPreCheck solvencyPreCheck;
+    private final ChildRecordFinalizer childRecordFinalizer;
 
     private ReadableStoreFactory readableStoreFactory;
     private AttributeValidator attributeValidator;
@@ -135,26 +138,27 @@ public class HandleContextImpl implements HandleContext, FeeContext {
     /**
      * Constructs a {@link HandleContextImpl}.
      *
-     * @param txBody                The {@link TransactionBody} of the transaction
-     * @param functionality         The {@link HederaFunctionality} of the transaction
-     * @param signatureMapSize      The size of the {@link com.hedera.hapi.node.base.SignatureMap} of the transaction
-     * @param payer                 The {@link AccountID} of the payer
-     * @param payerKey              The {@link Key} of the payer
-     * @param networkInfo           The {@link NetworkInfo} of the network
-     * @param category              The {@link TransactionCategory} of the transaction (either user, preceding, or child)
-     * @param recordBuilder         The main {@link SingleTransactionRecordBuilderImpl}
-     * @param stack                 The {@link SavepointStackImpl} used to manage savepoints
-     * @param configuration         The current {@link Configuration}
-     * @param verifier              The {@link KeyVerifier} used to verify signatures and hollow accounts
-     * @param recordListBuilder     The {@link RecordListBuilder} used to build the record stream
-     * @param checker               The {@link TransactionChecker} used to check dispatched transaction
-     * @param dispatcher            The {@link TransactionDispatcher} used to dispatch child transactions
-     * @param serviceScopeLookup    The {@link ServiceScopeLookup} used to look up the scope of a service
-     * @param feeManager            The {@link FeeManager} used to convert usage into fees
-     * @param exchangeRateManager   The {@link ExchangeRateManager} used to obtain exchange rate information
+     * @param txBody The {@link TransactionBody} of the transaction
+     * @param functionality The {@link HederaFunctionality} of the transaction
+     * @param signatureMapSize The size of the {@link com.hedera.hapi.node.base.SignatureMap} of the transaction
+     * @param payer The {@link AccountID} of the payer
+     * @param payerKey The {@link Key} of the payer
+     * @param networkInfo The {@link NetworkInfo} of the network
+     * @param category The {@link TransactionCategory} of the transaction (either user, preceding, or child)
+     * @param recordBuilder The main {@link SingleTransactionRecordBuilderImpl}
+     * @param stack The {@link SavepointStackImpl} used to manage savepoints
+     * @param configuration The current {@link Configuration}
+     * @param verifier The {@link KeyVerifier} used to verify signatures and hollow accounts
+     * @param recordListBuilder The {@link RecordListBuilder} used to build the record stream
+     * @param checker The {@link TransactionChecker} used to check dispatched transaction
+     * @param dispatcher The {@link TransactionDispatcher} used to dispatch child transactions
+     * @param serviceScopeLookup The {@link ServiceScopeLookup} used to look up the scope of a service
+     * @param feeManager The {@link FeeManager} used to convert usage into fees
+     * @param exchangeRateManager The {@link ExchangeRateManager} used to obtain exchange rate information
      * @param userTransactionConsensusTime The consensus time of the user transaction, not any child transactions
-     * @param authorizer            The {@link Authorizer} used to authorize the transaction
-     * @param solvencyPreCheck      The {@link SolvencyPreCheck} used to validate if the account is able to pay the fees
+     * @param authorizer The {@link Authorizer} used to authorize the transaction
+     * @param solvencyPreCheck The {@link SolvencyPreCheck} used to validate if the account is able to pay the fees
+     * @param childRecordFinalizer The {@link ChildRecordFinalizer} used to finalize child records
      */
     public HandleContextImpl(
             @NonNull final TransactionBody txBody,
@@ -178,7 +182,8 @@ public HandleContextImpl(
             @NonNull final ExchangeRateManager exchangeRateManager,
             @NonNull final Instant userTransactionConsensusTime,
             @NonNull final Authorizer authorizer,
-            @NonNull final SolvencyPreCheck solvencyPreCheck) {
+            @NonNull final SolvencyPreCheck solvencyPreCheck,
+            @NonNull final ChildRecordFinalizer childRecordFinalizer) {
         this.txBody = requireNonNull(txBody, "txBody must not be null");
         this.functionality = requireNonNull(functionality, "functionality must not be null");
         this.payer = requireNonNull(payer, "payer must not be null");
@@ -199,6 +204,7 @@ public HandleContextImpl(
         this.userTransactionConsensusTime =
                 requireNonNull(userTransactionConsensusTime, "userTransactionConsensusTime must not be null");
         this.authorizer = requireNonNull(authorizer, "authorizer must not be null");
+        this.childRecordFinalizer = requireNonNull(childRecordFinalizer, "childRecordFinalizer must not be null");
 
         final var serviceScope = serviceScopeLookup.getServiceName(txBody);
         this.writableStoreFactory = new WritableStoreFactory(stack, serviceScope);
@@ -689,11 +695,15 @@ private void dispatchSyntheticTxn(
                 exchangeRateManager,
                 userTransactionConsensusTime,
                 authorizer,
-                solvencyPreCheck);
+                solvencyPreCheck,
+                childRecordFinalizer);
 
         try {
             dispatcher.dispatchHandle(childContext);
             childRecordBuilder.status(ResponseCodeEnum.SUCCESS);
+            final var finalizeContext = new ChildFinalizeContextImpl(
+                    readableStoreFactory, new WritableStoreFactory(childStack, TokenService.NAME), childRecordBuilder);
+            childRecordFinalizer.finalizeChildRecord(finalizeContext);
             childStack.commitFullStack();
         } catch (final HandleException e) {
             childRecordBuilder.status(e.getStatus());

hedera-node/hedera-app/src/main/java/com/hedera/node/app/workflows/handle/HandleWorkflow.java

@@ -57,6 +57,7 @@
 import com.hedera.node.app.records.BlockRecordManager;
 import com.hedera.node.app.service.token.ReadableAccountStore;
 import com.hedera.node.app.service.token.api.TokenServiceApi;
+import com.hedera.node.app.service.token.records.ChildRecordFinalizer;
 import com.hedera.node.app.service.token.records.CryptoUpdateRecordBuilder;
 import com.hedera.node.app.service.token.records.ParentRecordFinalizer;
 import com.hedera.node.app.services.ServiceScopeLookup;
@@ -137,6 +138,7 @@ public class HandleWorkflow {
     private final StakingPeriodTimeHook stakingPeriodTimeHook;
     private final FeeManager feeManager;
     private final ExchangeRateManager exchangeRateManager;
+    private final ChildRecordFinalizer childRecordFinalizer;
     private final ParentRecordFinalizer transactionFinalizer;
     private final SystemFileUpdateFacility systemFileUpdateFacility;
     private final DualStateUpdateFacility dualStateUpdateFacility;
@@ -160,6 +162,7 @@ public HandleWorkflow(
             @NonNull final StakingPeriodTimeHook stakingPeriodTimeHook,
             @NonNull final FeeManager feeManager,
             @NonNull final ExchangeRateManager exchangeRateManager,
+            @NonNull final ChildRecordFinalizer childRecordFinalizer,
             @NonNull final ParentRecordFinalizer transactionFinalizer,
             @NonNull final SystemFileUpdateFacility systemFileUpdateFacility,
             @NonNull final DualStateUpdateFacility dualStateUpdateFacility,
@@ -180,6 +183,7 @@ public HandleWorkflow(
         this.stakingPeriodTimeHook = requireNonNull(stakingPeriodTimeHook, "stakingPeriodTimeHook must not be null");
         this.feeManager = requireNonNull(feeManager, "feeManager must not be null");
         this.exchangeRateManager = requireNonNull(exchangeRateManager, "exchangeRateManager must not be null");
+        this.childRecordFinalizer = childRecordFinalizer;
         this.transactionFinalizer = requireNonNull(transactionFinalizer, "transactionFinalizer must not be null");
         this.systemFileUpdateFacility =
                 requireNonNull(systemFileUpdateFacility, "systemFileUpdateFacility must not be null");
@@ -376,7 +380,8 @@ private void handleUserTransaction(
                     exchangeRateManager,
                     consensusNow,
                     authorizer,
-                    solvencyPreCheck);
+                    solvencyPreCheck,
+                    childRecordFinalizer);
 
             // Calculate the fee
             fees = dispatcher.dispatchComputeFees(context);
@@ -487,7 +492,8 @@ private void handleUserTransaction(
                 } catch (final HandleException e) {
                     // In case of a ContractCall when it reverts, the gas charged should not be rolled back
                     rollback(e.shouldRollbackStack(), e.getStatus(), stack, recordListBuilder);
-                    if (!hasWaivedFees) {
+                    if (!hasWaivedFees && e.shouldRollbackStack()) {
+                        // Only re-charge fees if we rolled back the stack
                         feeAccumulator.chargeFees(payer, creator.accountId(), fees);
                     }
                 }

hedera-node/hedera-app/src/main/java/com/hedera/node/app/workflows/handle/TokenContextImpl.java

@@ -84,6 +84,11 @@ public <T> T userTransactionRecordBuilder(@NonNull Class<T> recordBuilderClass)
         return castRecordBuilder(recordListBuilder.userTransactionRecordBuilder(), recordBuilderClass);
     }
 
+    @Override
+    public boolean hasChildRecords() {
+        return !recordListBuilder.childRecordBuilders().isEmpty();
+    }
+
     @Override
     public <T> void forEachChildRecord(@NonNull Class<T> recordBuilderClass, @NonNull Consumer<T> consumer) {
         requireNonNull(consumer, "consumer must not be null");
@@ -105,7 +110,7 @@ public <T> T addUncheckedPrecedingChildRecordBuilder(@NonNull Class<T> recordBui
         return castRecordBuilder(result, recordBuilderClass);
     }
 
-    private static <T> T castRecordBuilder(
+    static <T> T castRecordBuilder(
             @NonNull final SingleTransactionRecordBuilderImpl recordBuilder,
             @NonNull final Class<T> recordBuilderClass) {
         if (!recordBuilderClass.isInstance(recordBuilder)) {

hedera-node/hedera-app/src/main/java/com/hedera/node/app/workflows/handle/record/RecordListBuilder.java

@@ -264,9 +264,9 @@ private SingleTransactionRecordBuilderImpl doAddChild(
                 ? userTxnRecordBuilder.consensusNow()
                 : childRecordBuilders.get(childRecordBuilders.size() - 1).consensusNow();
         final var consensusNow = prevConsensusNow.plusNanos(1L);
+        // Note we do not repeat exchange rates for child transactions
         final var recordBuilder = new SingleTransactionRecordBuilderImpl(consensusNow, reversingBehavior, customizer)
-                .parentConsensus(parentConsensusTimestamp)
-                .exchangeRate(userTxnRecordBuilder.exchangeRate());
+                .parentConsensus(parentConsensusTimestamp);
         if (!customizer.shouldSuppressRecord()) {
             childRecordBuilders.add(recordBuilder);
         }

hedera-node/hedera-app/src/main/java/com/hedera/node/app/workflows/handle/record/SingleTransactionRecordBuilderImpl.java

@@ -368,6 +368,7 @@
 
     /**
      * When we update nonce on the record, we need to update the body as well with the same transactionID.
+     *
      * @return the builder
      */
     @NonNull
@@ -382,13 +383,7 @@
                     .copyBuilder()
                     .transactionID(newTransactionID)
                     .build();
-            final var newBodyBytes = TransactionBody.PROTOBUF.toBytes(body);
-            final var newSignedTransaction =
-                    SignedTransaction.newBuilder().bodyBytes(newBodyBytes).build();
-            final var signedTransactionBytes = SignedTransaction.PROTOBUF.toBytes(newSignedTransaction);
-            this.transaction = Transaction.newBuilder()
-                    .signedTransactionBytes(signedTransactionBytes)
-                    .build();
+            this.transaction = SingleTransactionRecordBuilder.transactionWith(body);
             return this;
         } catch (Exception e) {
             throw new RuntimeException(e);
@@ -515,6 +510,11 @@
         return this;
     }
 
+    @Override
+    public List<TokenTransferList> tokenTransferLists() {
+        return tokenTransferLists;
+    }
+
     /**
      * Adds a tokenTransferList.
      *
@@ -925,6 +925,11 @@
         return this;
     }
 
+    @Override
+    public List<Long> serialNumbers() {
+        return serialNumbers;
+    }
+
     /**
      * Adds a serialNumber to the receipt.
      *

hedera-node/hedera-app/src/test/java/com/hedera/node/app/workflows/handle/HandleContextImplTest.java

@@ -60,6 +60,7 @@
 import com.hedera.node.app.service.token.ReadableAccountStore;
 import com.hedera.node.app.service.token.TokenService;
 import com.hedera.node.app.service.token.impl.WritableAccountStore;
+import com.hedera.node.app.service.token.records.ChildRecordFinalizer;
 import com.hedera.node.app.service.token.records.CryptoCreateRecordBuilder;
 import com.hedera.node.app.services.ServiceScopeLookup;
 import com.hedera.node.app.signature.KeyVerifier;
@@ -173,6 +174,9 @@ class HandleContextImplTest extends StateTestBase implements Scenarios {
     @Mock
     private SolvencyPreCheck solvencyPreCheck;
 
+    @Mock
+    private ChildRecordFinalizer childRecordFinalizer;
+
     @Mock
     private SelfNodeInfo selfNodeInfo;
 
@@ -218,7 +222,8 @@ private HandleContextImpl createContext(final TransactionBody txBody) {
                 exchangeRateManager,
                 DEFAULT_CONSENSUS_NOW,
                 authorizer,
-                solvencyPreCheck);
+                solvencyPreCheck,
+                childRecordFinalizer);
     }
 
     @SuppressWarnings("ConstantConditions")
@@ -246,7 +251,8 @@ void testConstructorWithInvalidArguments() {
             exchangeRateManager,
             DEFAULT_CONSENSUS_NOW,
             authorizer,
-            solvencyPreCheck
+            solvencyPreCheck,
+            childRecordFinalizer
         };
 
         final var constructor = HandleContextImpl.class.getConstructors()[0];
@@ -311,7 +317,8 @@ void setUp() {
                     exchangeRateManager,
                     DEFAULT_CONSENSUS_NOW,
                     authorizer,
-                    solvencyPreCheck);
+                    solvencyPreCheck,
+                    childRecordFinalizer);
         }
 
         @Test
@@ -827,7 +834,8 @@ private HandleContextImpl createContext(final TransactionBody txBody, final Tran
                     exchangeRateManager,
                     DEFAULT_CONSENSUS_NOW,
                     authorizer,
-                    solvencyPreCheck);
+                    solvencyPreCheck,
+                    childRecordFinalizer);
         }
 
         @SuppressWarnings("ConstantConditions")