feat: Implement HookEvmFrameState (#21329)

Signed-off-by: Neeharika-Sompalli <[email protected]>
Signed-off-by: Michael Tinker <[email protected]>
Co-authored-by: Michael Tinker <[email protected]>

Author: Neeharika-Sompalli

hedera-node/hedera-app/src/main/java/com/hedera/node/app/blocks/impl/BlockStreamBuilder.java

@@ -1308,6 +1308,11 @@ public long getNextHookId() {
         return nextHookId;
     }
 
+    @Override
+    public Bytes getEvmCallResult() {
+        return requireNonNull(evmTransactionResult).resultData();
+    }
+
     @Override
     public void nullOutSideEffectFields() {
         serialNumbers.clear();

hedera-node/hedera-app/src/main/java/com/hedera/node/app/blocks/impl/PairedStreamBuilder.java

@@ -693,4 +693,9 @@ public void nextHookId(final long nextHookId) {
     public long getNextHookId() {
         return blockStreamBuilder.getNextHookId();
     }
+
+    @Override
+    public Bytes getEvmCallResult() {
+        return blockStreamBuilder.getEvmCallResult();
+    }
 }

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

@@ -1123,6 +1123,11 @@ public ContractOperationStreamBuilder testForIdenticalKeys(@NonNull final Predic
         return this;
     }
 
+    @Override
+    public Bytes getEvmCallResult() {
+        return requireNonNull(contractFunctionResult).contractCallResult();
+    }
+
     /**
      * Sets the contractStateChanges which are part of sidecar records.
      *

hedera-node/hedera-config/src/main/java/com/hedera/node/config/data/HooksConfig.java

@@ -8,4 +8,6 @@
 @ConfigData("hooks")
 public record HooksConfig(
         @ConfigProperty(defaultValue = "10") @NetworkProperty int maxLambdaSStoreUpdates,
-        @ConfigProperty(defaultValue = "false") @NetworkProperty boolean hooksEnabled) {}
+        @ConfigProperty(defaultValue = "false") @NetworkProperty boolean hooksEnabled,
+        @ConfigProperty(value = "evm.lambdaIntrinsicGasCost", defaultValue = "1000") @NetworkProperty
+                int lambdaIntrinsicGasCost) {}

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

@@ -21,15 +21,16 @@
 import com.hedera.node.app.service.contract.impl.hevm.HederaWorldUpdater;
 import com.hedera.node.app.service.contract.impl.hevm.QueryContextHevmBlocks;
 import com.hedera.node.app.service.contract.impl.state.EvmFrameStateFactory;
+import com.hedera.node.app.service.contract.impl.state.EvmFrameStates;
 import com.hedera.node.app.service.contract.impl.state.ProxyWorldUpdater;
-import com.hedera.node.app.service.contract.impl.state.ScopedEvmFrameStateFactory;
 import com.hedera.node.app.spi.workflows.QueryContext;
 import com.hedera.node.config.data.HederaConfig;
 import dagger.Binds;
 import dagger.Module;
 import dagger.Provides;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.time.Instant;
+import org.hyperledger.besu.evm.code.CodeFactory;
 
 @Module
 public interface QueryModule {
@@ -102,10 +103,6 @@ static HederaEvmContext provideHederaEvmContext(
                 null);
     }
 
-    @Binds
-    @QueryScope
-    EvmFrameStateFactory bindEvmFrameStateFactory(ScopedEvmFrameStateFactory factory);
-
     @Binds
     @QueryScope
     HederaOperations bindHederaOperations(QueryHederaOperations queryExtWorldScope);
@@ -121,4 +118,13 @@ static HederaEvmContext provideHederaEvmContext(
     @Binds
     @QueryScope
     SystemContractOperations bindSystemContractOperations(QuerySystemContractOperations querySystemContractOperations);
+
+    @Provides
+    @QueryScope
+    static EvmFrameStateFactory provideEvmFrameStateFactory(
+            @NonNull final CodeFactory codeFactory,
+            @NonNull final HederaOperations operations,
+            @NonNull final HederaNativeOperations nativeOperations) {
+        return EvmFrameStates.DEFAULT.from(operations, nativeOperations, codeFactory);
+    }
 }

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

@@ -5,6 +5,7 @@
 import com.hedera.node.app.service.contract.impl.annotations.TransactionScope;
 import com.hedera.node.app.service.contract.impl.exec.scope.HederaOperations;
 import com.hedera.node.app.service.contract.impl.hevm.HydratedEthTxData;
+import com.hedera.node.app.service.contract.impl.state.EvmFrameStates;
 import com.hedera.node.app.spi.workflows.HandleContext;
 import dagger.BindsInstance;
 import dagger.Subcomponent;
@@ -16,7 +17,9 @@ public interface TransactionComponent {
     @Subcomponent.Factory
     interface Factory {
         TransactionComponent create(
-                @BindsInstance HandleContext context, @BindsInstance HederaFunctionality functionality);
+                @BindsInstance HandleContext context,
+                @BindsInstance HederaFunctionality functionality,
+                @BindsInstance EvmFrameStates evmFrameStates);
     }
 
     ContextTransactionProcessor contextTransactionProcessor();

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

@@ -9,6 +9,7 @@
 import com.hedera.node.config.data.ContractsConfig;
 import com.hedera.node.config.data.EntitiesConfig;
 import com.hedera.node.config.data.HederaConfig;
+import com.hedera.node.config.data.HooksConfig;
 import com.hedera.node.config.data.LedgerConfig;
 import com.hedera.node.config.data.StakingConfig;
 import com.swirlds.config.api.Configuration;
@@ -42,6 +43,12 @@ static LedgerConfig provideLedgerConfig(@NonNull final Configuration configurati
         return requireNonNull(configuration).getConfigData(LedgerConfig.class);
     }
 
+    @Provides
+    @TransactionScope
+    static HooksConfig provideHooksConfig(@NonNull final Configuration configuration) {
+        return requireNonNull(configuration).getConfigData(HooksConfig.class);
+    }
+
     @Provides
     @TransactionScope
     static StakingConfig provideStakingConfig(@NonNull final Configuration configuration) {

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

@@ -34,7 +34,7 @@
 import com.hedera.node.app.service.contract.impl.infra.EthereumCallDataHydration;
 import com.hedera.node.app.service.contract.impl.records.ContractOperationStreamBuilder;
 import com.hedera.node.app.service.contract.impl.state.EvmFrameStateFactory;
-import com.hedera.node.app.service.contract.impl.state.ScopedEvmFrameStateFactory;
+import com.hedera.node.app.service.contract.impl.state.EvmFrameStates;
 import com.hedera.node.app.service.file.ReadableFileStore;
 import com.hedera.node.app.spi.info.NetworkInfo;
 import com.hedera.node.app.spi.validation.AttributeValidator;
@@ -52,6 +52,7 @@
 import edu.umd.cs.findbugs.annotations.Nullable;
 import java.time.Instant;
 import java.util.Map;
+import org.hyperledger.besu.evm.code.CodeFactory;
 
 @Module(includes = {TransactionConfigModule.class, TransactionInitialStateModule.class})
 public interface TransactionModule {
@@ -209,10 +210,6 @@ static HederaWorldUpdater.Enhancement provideEnhancement(
         return new HederaWorldUpdater.Enhancement(operations.begin(), nativeOperations, systemContractOperations);
     }
 
-    @Binds
-    @TransactionScope
-    EvmFrameStateFactory bindEvmFrameStateFactory(ScopedEvmFrameStateFactory factory);
-
     @Binds
     @TransactionScope
     HederaOperations bindHederaOperations(HandleHederaOperations handleExtWorldScope);
@@ -229,4 +226,17 @@ SystemContractOperations bindSystemContractOperations(
     @Binds
     @TransactionScope
     HederaEvmBlocks bindHederaEvmBlocks(HandleContextHevmBlocks handleContextHevmBlocks);
+
+    @Provides
+    @TransactionScope
+    static EvmFrameStateFactory provideEvmFrameStateFactory(
+            @NonNull final EvmFrameStates evmFrameStates,
+            @NonNull final CodeFactory codeFactory,
+            @NonNull final HederaOperations operations,
+            @NonNull final HederaNativeOperations nativeOperations) {
+        // If this EVM tx is for a hook, the factory returned here will
+        // create "hook-aware" EvmFrameState's that e.g. return the executing
+        // hook contract's bytecode from address 0x16d
+        return evmFrameStates.from(operations, nativeOperations, codeFactory);
+    }
 }

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

@@ -18,6 +18,7 @@
 import com.hedera.hapi.node.base.AccountID;
 import com.hedera.hapi.node.contract.ContractCreateTransactionBody;
 import com.hedera.node.app.service.contract.impl.exec.gas.CustomGasCharging;
+import com.hedera.node.app.service.contract.impl.exec.gas.GasCharges;
 import com.hedera.node.app.service.contract.impl.exec.processors.CustomMessageCallProcessor;
 import com.hedera.node.app.service.contract.impl.exec.utils.FrameBuilder;
 import com.hedera.node.app.service.contract.impl.exec.utils.OpsDurationCounter;
@@ -124,8 +125,10 @@ private HederaEvmTransactionResult processTransactionWithParties(
             @NonNull final Configuration config,
             @NonNull final OpsDurationCounter opsDurationCounter,
             @NonNull final InvolvedParties parties) {
-        final var gasCharges =
-                gasCharging.chargeForGas(parties.sender(), parties.relayer(), context, updater, transaction);
+        // If it is hook dispatch, skip gas charging because gas is pre-paid in cryptoTransfer already
+        final var gasCharges = transaction.isHookDispatch()
+                ? GasCharges.NONE
+                : gasCharging.chargeForGas(parties.sender(), parties.relayer(), context, updater, transaction);
         final var initialFrame = frameBuilder.buildInitialFrameWith(
                 transaction,
                 updater,
@@ -142,14 +145,18 @@ private HederaEvmTransactionResult processTransactionWithParties(
         final var result = frameRunner.runToCompletion(
                 transaction.gasLimit(), parties.senderId(), initialFrame, tracer, messageCall, contractCreation);
 
-        // Maybe refund some of the charged fees before committing
-        gasCharging.maybeRefundGiven(
-                transaction.unusedGas(result.gasUsed()),
-                gasCharges.relayerAllowanceUsed(),
-                parties.sender(),
-                parties.relayer(),
-                context,
-                updater);
+        // Maybe refund some of the charged fees before committing if not a hook dispatch
+        // Note that for hook dispatch, gas is charged during cryptoTransfer and will not be refunded once
+        // hook is executed
+        if (!transaction.isHookDispatch()) {
+            gasCharging.maybeRefundGiven(
+                    transaction.unusedGas(result.gasUsed()),
+                    gasCharges.relayerAllowanceUsed(),
+                    parties.sender(),
+                    parties.relayer(),
+                    context,
+                    updater);
+        }
         initialFrame.getSelfDestructs().forEach(updater::deleteAccount);
 
         // Tries to commit and return the original result; returns a fees-only result on resource exhaustion

hedera-node/hedera-smart-contract-service-impl/src/main/java/com/hedera/node/app/service/contract/impl/exec/gas/GasCharges.java

@@ -5,4 +5,8 @@
  * @param intrinsicGas the intrinsic gas cost of a transaction
  * @param relayerAllowanceUsed the gas for the relayer
  */
-public record GasCharges(long intrinsicGas, long relayerAllowanceUsed) {}
+public record GasCharges(long intrinsicGas, long relayerAllowanceUsed) {
+    // A constant representing no gas charges.
+    // A hook dispatch has no gas charges, because all gas is charged prior in crypto transfer.
+    public static final GasCharges NONE = new GasCharges(0L, 0L);
+}