Externalize the generation of child records for view calls

hedera-node/hedera-smart-contract-service-impl/src/main/java/com/hedera/node/app/service/contract/impl/exec/scope/HandleSystemContractOperations.java

@@ -16,7 +16,6 @@
 
 package com.hedera.node.app.service.contract.impl.exec.scope;
 
-import static com.hedera.hapi.node.base.ResponseCodeEnum.SUCCESS;
 import static java.util.Objects.requireNonNull;
 
 import com.hedera.hapi.node.base.AccountID;
@@ -32,7 +31,6 @@
 import com.hedera.hapi.node.transaction.TransactionBody;
 import com.hedera.node.app.service.contract.impl.annotations.TransactionScope;
 import com.hedera.node.app.service.contract.impl.records.ContractCallRecordBuilder;
-import com.hedera.node.app.service.contract.impl.utils.SystemContractUtils.ResultStatus;
 import com.hedera.node.app.spi.workflows.HandleContext;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
@@ -115,14 +113,12 @@ public HandleSystemContractOperations(@NonNull final HandleContext context) {
      */
     @Override
     public void externalizeResult(
-            @NonNull final ContractFunctionResult result,
-            @NonNull final ResultStatus status,
-            @NonNull final ResponseCodeEnum responseStatus) {
+            @NonNull final ContractFunctionResult result, @NonNull final ResponseCodeEnum responseStatus) {
         final var childRecordBuilder = context.addChildRecordBuilder(ContractCallRecordBuilder.class);
         childRecordBuilder
                 .transaction(Transaction.DEFAULT)
                 .contractID(result.contractID())
-                .status(status == ResultStatus.IS_ERROR ? responseStatus : SUCCESS)
+                .status(responseStatus)
                 .contractCallResult(result);
     }
 

hedera-node/hedera-smart-contract-service-impl/src/main/java/com/hedera/node/app/service/contract/impl/exec/scope/QuerySystemContractOperations.java

@@ -27,7 +27,6 @@
 import com.hedera.hapi.node.transaction.ExchangeRate;
 import com.hedera.hapi.node.transaction.TransactionBody;
 import com.hedera.node.app.service.contract.impl.annotations.QueryScope;
-import com.hedera.node.app.service.contract.impl.utils.SystemContractUtils.ResultStatus;
 import com.hedera.node.app.spi.workflows.QueryContext;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
@@ -106,9 +105,7 @@ public QuerySystemContractOperations(@NonNull final QueryContext queryContext) {
      */
     @Override
     public void externalizeResult(
-            @NonNull final ContractFunctionResult result,
-            @NonNull final ResultStatus status,
-            @NonNull final ResponseCodeEnum responseStatus) {
+            @NonNull final ContractFunctionResult result, @NonNull final ResponseCodeEnum responseStatus) {
         // no-op
     }
 

hedera-node/hedera-smart-contract-service-impl/src/main/java/com/hedera/node/app/service/contract/impl/exec/scope/SystemContractOperations.java

@@ -26,7 +26,6 @@
 import com.hedera.hapi.node.state.token.Token;
 import com.hedera.hapi.node.transaction.ExchangeRate;
 import com.hedera.hapi.node.transaction.TransactionBody;
-import com.hedera.node.app.service.contract.impl.utils.SystemContractUtils.ResultStatus;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
 import java.util.function.Predicate;
@@ -109,12 +108,9 @@ <T> T dispatch(
      * Attempts to create a child record of the current record, with the given {@code result}
      *
      * @param result    contract function result
-     * @param status    whether the result is success or an error
      */
     void externalizeResult(
-            @NonNull final ContractFunctionResult result,
-            @NonNull final ResultStatus status,
-            @NonNull final ResponseCodeEnum responseStatus);
+            @NonNull final ContractFunctionResult result, @NonNull final ResponseCodeEnum responseStatus);
 
     /**
      * Returns the {@Link ExchangeRate} for the current consensus time.  This will enable the translation from hbars

hedera-node/hedera-smart-contract-service-impl/src/main/java/com/hedera/node/app/service/contract/impl/exec/systemcontracts/HtsSystemContract.java

@@ -16,9 +16,14 @@
 
 package com.hedera.node.app.service.contract.impl.exec.systemcontracts;
 
+import static com.hedera.hapi.node.base.ResponseCodeEnum.SUCCESS;
 import static com.hedera.node.app.service.contract.impl.exec.systemcontracts.HederaSystemContract.FullResult.haltResult;
+import static com.hedera.node.app.service.contract.impl.utils.ConversionUtils.asEvmContractId;
+import static com.hedera.node.app.service.contract.impl.utils.SystemContractUtils.contractFunctionResultFailedFor;
+import static com.hedera.node.app.service.contract.impl.utils.SystemContractUtils.contractFunctionResultSuccessFor;
 import static java.util.Objects.requireNonNull;
 
+import com.hedera.hapi.node.base.ContractID;
 import com.hedera.node.app.service.contract.impl.exec.systemcontracts.hts.HtsCall;
 import com.hedera.node.app.service.contract.impl.exec.systemcontracts.hts.HtsCallFactory;
 import com.hedera.node.app.service.contract.impl.exec.utils.FrameUtils;
@@ -29,6 +34,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.apache.tuweni.bytes.Bytes;
+import org.hyperledger.besu.datatypes.Address;
 import org.hyperledger.besu.evm.frame.ExceptionalHaltReason;
 import org.hyperledger.besu.evm.frame.MessageFrame;
 import org.hyperledger.besu.evm.gascalculator.GasCalculator;
@@ -38,7 +44,7 @@ public class HtsSystemContract extends AbstractFullContract implements HederaSys
     private static final Logger log = LogManager.getLogger(HtsSystemContract.class);
     private static final String HTS_PRECOMPILE_NAME = "HTS";
     public static final String HTS_PRECOMPILE_ADDRESS = "0x167";
-
+    private static final ContractID contractID = asEvmContractId(Address.fromHexString(HTS_PRECOMPILE_ADDRESS));
     private final HtsCallFactory callFactory;
 
     @Inject
@@ -70,15 +76,30 @@ private static FullResult resultOfExecuting(
         final HtsCall.PricedResult pricedResult;
         try {
             pricedResult = call.execute(frame);
+            final var enhancement = FrameUtils.proxyUpdaterFor(frame).enhancement();
+            final var responseCode = pricedResult.responseCode();
+
+            if (responseCode == SUCCESS) {
+                final var output = pricedResult.fullResult().result().getOutput();
+                enhancement
+                        .systemOperations()
+                        .externalizeResult(
+                                contractFunctionResultSuccessFor(pricedResult.nonGasCost(), output, contractID),
+                                responseCode);
+            } else {
+                enhancement
+                        .systemOperations()
+                        .externalizeResult(
+                                contractFunctionResultFailedFor(
+                                        pricedResult.nonGasCost(), responseCode.toString(), contractID),
+                                responseCode);
+            }
         } catch (final HandleException handleException) {
             throw handleException;
         } catch (final Exception internal) {
             log.error("Unhandled failure for input {} to HTS system contract", input, internal);
             return haltResult(ExceptionalHaltReason.PRECOMPILE_ERROR, frame.getRemainingGas());
         }
-        if (pricedResult.nonGasCost() > 0) {
-            throw new AssertionError("Not implemented");
-        }
         return pricedResult.fullResult();
     }
 }

hedera-node/hedera-smart-contract-service-impl/src/main/java/com/hedera/node/app/service/contract/impl/exec/systemcontracts/PrngSystemContract.java

@@ -27,7 +27,6 @@
 
 import com.hedera.hapi.node.base.ContractID;
 import com.hedera.node.app.service.contract.impl.state.ProxyWorldUpdater;
-import com.hedera.node.app.service.contract.impl.utils.SystemContractUtils.ResultStatus;
 import com.hedera.node.app.service.evm.exceptions.InvalidTransactionException;
 import com.hederahashgraph.api.proto.java.ResponseCodeEnum;
 import edu.umd.cs.findbugs.annotations.NonNull;
@@ -108,9 +107,7 @@ void createSuccessfulRecord(
             requireNonNull(contractID);
             var updater = (ProxyWorldUpdater) frame.getWorldUpdater();
             updater.externalizeSystemContractResults(
-                    contractFunctionResultSuccessFor(gasRequirement, randomNum, contractID),
-                    ResultStatus.IS_SUCCESS,
-                    SUCCESS);
+                    contractFunctionResultSuccessFor(gasRequirement, randomNum, contractID), SUCCESS);
         }
     }
 
@@ -122,9 +119,7 @@ void createFailedRecord(
             contractFunctionResultFailedFor(gasRequirement, errorMsg, contractID);
             var updater = (ProxyWorldUpdater) frame.getWorldUpdater();
             updater.externalizeSystemContractResults(
-                    contractFunctionResultFailedFor(gasRequirement, errorMsg, contractID),
-                    ResultStatus.IS_ERROR,
-                    FAIL_INVALID);
+                    contractFunctionResultFailedFor(gasRequirement, errorMsg, contractID), FAIL_INVALID);
         }
     }
 

hedera-node/hedera-smart-contract-service-impl/src/main/java/com/hedera/node/app/service/contract/impl/exec/systemcontracts/hts/AbstractNonRevertibleTokenViewCall.java

@@ -16,77 +16,26 @@
 
 package com.hedera.node.app.service.contract.impl.exec.systemcontracts.hts;
 
-import static com.hedera.hapi.node.base.ResponseCodeEnum.INVALID_TOKEN_ID;
-import static com.hedera.hapi.node.base.ResponseCodeEnum.SUCCESS;
-import static com.hedera.node.app.service.contract.impl.exec.systemcontracts.HtsSystemContract.HTS_PRECOMPILE_ADDRESS;
-import static com.hedera.node.app.service.contract.impl.exec.systemcontracts.hts.HtsCall.PricedResult.gasOnly;
-import static com.hedera.node.app.service.contract.impl.utils.ConversionUtils.asEvmContractId;
-import static com.hedera.node.app.service.contract.impl.utils.SystemContractUtils.contractFunctionResultSuccessFor;
-
-import com.hedera.hapi.node.base.ResponseCodeEnum;
 import com.hedera.hapi.node.state.token.Token;
 import com.hedera.node.app.service.contract.impl.exec.gas.SystemContractGasCalculator;
-import com.hedera.node.app.service.contract.impl.exec.systemcontracts.HederaSystemContract.FullResult;
 import com.hedera.node.app.service.contract.impl.hevm.HederaWorldUpdater;
-import com.hedera.node.app.service.contract.impl.utils.SystemContractUtils;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
-import org.hyperledger.besu.datatypes.Address;
 
 /**
  * Implementation support for view calls that require an extant token.
  * Classic view function calls are generally non-revertible.
  */
-public abstract class AbstractNonRevertibleTokenViewCall extends AbstractHtsCall {
-    @Nullable
-    protected final Token token;
-
+public abstract class AbstractNonRevertibleTokenViewCall extends AbstractTokenViewCall {
     protected AbstractNonRevertibleTokenViewCall(
             @NonNull final SystemContractGasCalculator gasCalculator,
             @NonNull final HederaWorldUpdater.Enhancement enhancement,
             @Nullable final Token token) {
-        super(gasCalculator, enhancement);
-        this.token = token;
+        super(gasCalculator, enhancement, token);
     }
 
     @Override
     public @NonNull PricedResult execute() {
-        PricedResult result;
-        if (token == null) {
-            result = gasOnly(viewCallResultWith(INVALID_TOKEN_ID, gasCalculator.viewGasRequirement()));
-        } else {
-            result = gasOnly(resultOfViewingToken(token));
-        }
-
-        final var gasRequirement = result.fullResult().gasRequirement();
-        final var output = result.fullResult().result().getOutput();
-        final var contractID = asEvmContractId(Address.fromHexString(HTS_PRECOMPILE_ADDRESS));
-        enhancement
-                .systemOperations()
-                .externalizeResult(
-                        contractFunctionResultSuccessFor(gasRequirement, output, contractID),
-                        SystemContractUtils.ResultStatus.IS_SUCCESS,
-                        SUCCESS);
-
-        return result;
+        return super.execute();
     }
-
-    /**
-     * Returns the result of viewing the given {@code token}.
-     *
-     * @param token the token to view
-     * @return the result of viewing the given {@code token}
-     */
-    @NonNull
-    protected abstract FullResult resultOfViewingToken(@NonNull Token token);
-
-    /**
-     * Returns the result of viewing the given {@code token} given the {@code status}.
-     * Currently, the only usage for this method is to return an INVALID_TOKEN_ID status
-     * if the token is null.
-     * @param status - ResponseCodeEnum status
-     * @return the results to return to the caller
-     */
-    @NonNull
-    protected abstract FullResult viewCallResultWith(ResponseCodeEnum status, long gasRequirement);
 }

hedera-node/hedera-smart-contract-service-impl/src/main/java/com/hedera/node/app/service/contract/impl/exec/systemcontracts/hts/AbstractRevertibleTokenViewCall.java

@@ -16,67 +16,37 @@
 
 package com.hedera.node.app.service.contract.impl.exec.systemcontracts.hts;
 
-import static com.hedera.hapi.node.base.ResponseCodeEnum.INVALID_TOKEN_ID;
-import static com.hedera.hapi.node.base.ResponseCodeEnum.SUCCESS;
 import static com.hedera.node.app.service.contract.impl.exec.systemcontracts.HederaSystemContract.FullResult.revertResult;
-import static com.hedera.node.app.service.contract.impl.exec.systemcontracts.HtsSystemContract.HTS_PRECOMPILE_ADDRESS;
-import static com.hedera.node.app.service.contract.impl.exec.systemcontracts.hts.HtsCall.PricedResult.gasOnly;
-import static com.hedera.node.app.service.contract.impl.utils.ConversionUtils.asEvmContractId;
-import static com.hedera.node.app.service.contract.impl.utils.SystemContractUtils.contractFunctionResultSuccessFor;
 
+import com.hedera.hapi.node.base.ResponseCodeEnum;
 import com.hedera.hapi.node.state.token.Token;
 import com.hedera.node.app.service.contract.impl.exec.gas.SystemContractGasCalculator;
 import com.hedera.node.app.service.contract.impl.exec.systemcontracts.HederaSystemContract;
 import com.hedera.node.app.service.contract.impl.hevm.HederaWorldUpdater;
-import com.hedera.node.app.service.contract.impl.utils.SystemContractUtils;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
-import org.hyperledger.besu.datatypes.Address;
 
 /**
  * Implementation support for view calls that require an extant token.
  * ERC view function calls are generally revertible.
  */
-public abstract class AbstractRevertibleTokenViewCall extends AbstractHtsCall {
-    @Nullable
-    private final Token token;
-
+public abstract class AbstractRevertibleTokenViewCall extends AbstractTokenViewCall {
     protected AbstractRevertibleTokenViewCall(
             @NonNull final SystemContractGasCalculator gasCalculator,
             @NonNull final HederaWorldUpdater.Enhancement enhancement,
             @Nullable final Token token) {
-        super(gasCalculator, enhancement);
-        this.token = token;
+        super(gasCalculator, enhancement, token);
     }
 
     @Override
     public @NonNull PricedResult execute() {
-        PricedResult result;
-        if (token == null) {
-            result = gasOnly(revertResult(INVALID_TOKEN_ID, gasCalculator.viewGasRequirement()));
-        } else {
-            result = gasOnly(resultOfViewingToken(token));
-        }
-
-        final var gasRequirement = result.fullResult().gasRequirement();
-        final var output = result.fullResult().result().getOutput();
-        final var contractID = asEvmContractId(Address.fromHexString(HTS_PRECOMPILE_ADDRESS));
-        enhancement
-                .systemOperations()
-                .externalizeResult(
-                        contractFunctionResultSuccessFor(gasRequirement, output, contractID),
-                        SystemContractUtils.ResultStatus.IS_SUCCESS,
-                        SUCCESS);
-
-        return result;
+        return super.execute();
     }
 
-    /**
-     * Returns the result of viewing the given {@code token}.
-     *
-     * @param token the token to view
-     * @return the result of viewing the given {@code token}
-     */
     @NonNull
-    protected abstract HederaSystemContract.FullResult resultOfViewingToken(@NonNull Token token);
+    @Override
+    protected HederaSystemContract.FullResult viewCallResultWith(
+            @NonNull ResponseCodeEnum status, long gasRequirement) {
+        return revertResult(status, gasRequirement);
+    }
 }