chore: (Cherry-pick) Add executed_hook_id to EvmTransactionResult (#22017)

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

Author: Neeharika-Sompalli

hapi/hedera-protobuf-java-api/src/main/proto/services/contract_types.proto

@@ -80,6 +80,11 @@ message EvmTransactionResult {
      * internal call producing this result.
      */
     InternalCallContext internal_call_context = 6;
+
+    /**
+     * If set, the id of the executed hook.
+     */
+    proto.HookId executed_hook_id = 7;
 }
 
 /**

hapi/hedera-protobuf-java-api/src/main/proto/services/response_code.proto

@@ -1771,6 +1771,11 @@ enum ResponseCodeEnum {
      */
     INVALID_SERIALIZED_TX_MESSAGE_HASH_ALGORITHM = 401;
 
+    /**
+     * A LambdaSStore referenced an entity number but with the wrong entity type.
+     */
+    WRONG_HOOK_ENTITY_TYPE = 499;
+
     /**
      * An EVM hook execution was throttled due to high network gas utilization.
      */

hedera-node/hapi-utils/src/main/java/com/hedera/node/app/hapi/utils/contracts/HookUtils.java

@@ -109,7 +109,7 @@ public static boolean hasHookExecutions(final @NonNull CryptoTransferTransaction
      * @param hookEntityId the HookEntityId
      * @return the owner AccountID
      */
-    public static AccountID getHookOwnerId(final @NonNull HookEntityId hookEntityId) {
+    public static AccountID getHookOwnerId(@NonNull final HookEntityId hookEntityId) {
         return requireNonNull(hookEntityId).hasAccountId()
                 ? hookEntityId.accountIdOrThrow()
                 : asAccountId(hookEntityId.contractIdOrThrow());
@@ -120,7 +120,8 @@ public static AccountID getHookOwnerId(final @NonNull HookEntityId hookEntityId)
      * @param contractID the ContractID to convert
      * @return the corresponding AccountID
      */
-    private static AccountID asAccountId(final ContractID contractID) {
+    public static AccountID asAccountId(@NonNull final ContractID contractID) {
+        requireNonNull(contractID);
         return AccountID.newBuilder()
                 .shardNum(contractID.shardNum())
                 .realmNum(contractID.realmNum())

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

@@ -7,6 +7,7 @@
 import com.hedera.hapi.node.base.AccountID;
 import com.hedera.hapi.node.base.ContractID;
 import com.hedera.hapi.node.base.TransactionID;
+import com.hedera.hapi.node.hooks.HookDispatchTransactionBody;
 import com.hedera.hapi.streams.ContractBytecode;
 import com.hedera.node.app.hapi.utils.ethereum.EthTxData;
 import com.hedera.node.app.service.contract.impl.annotations.TransactionScope;
@@ -116,17 +117,18 @@ public CallOutcome call() {
         // the error.
         final var creation = safeCreateHevmTransaction();
         final var hevmTransaction = requireNonNull(creation.hevmTransaction());
-        final var isHookDispatch = creation.isHookDispatch();
+        final var isHookDispatch = creation.hookDispatch() != null;
         if (hevmTransaction.isException()) {
             CallOutcome outcome;
             if (isHookDispatch) {
                 var result = HederaEvmTransactionResult.fromAborted(
                         hevmTransaction.senderId(),
                         hevmTransaction.contractId(),
                         requireNonNull(hevmTransaction.exception()).getStatus());
+                final var hookId = hevmTransaction.maybeHookId();
                 outcome = CallOutcome.fromResultsWithoutSidecars(
                         result.asProtoResultOf(null, rootProxyWorldUpdater, null),
-                        result.asEvmTxResultOf(null, null),
+                        result.asEvmTxResultOf(null, null, hookId),
                         null,
                         null,
                         null,
@@ -206,12 +208,13 @@ public CallOutcome call() {
                 requireNonNull(hederaEvmContext.streamBuilder()).addContractBytecode(contractBytecode, false);
             }
 
+            final var hookId = hevmTransaction.maybeHookId();
             final var callData = (hydratedEthTxData != null && hydratedEthTxData.ethTxData() != null)
                     ? Bytes.wrap(hydratedEthTxData.ethTxData().callData())
                     : null;
             final var outcome = CallOutcome.fromResultsWithMaybeSidecars(
                     result.asProtoResultOf(ethTxDataIfApplicable(), rootProxyWorldUpdater, callData),
-                    result.asEvmTxResultOf(ethTxDataIfApplicable(), callData),
+                    result.asEvmTxResultOf(ethTxDataIfApplicable(), callData, hookId),
                     result.isSuccess() ? rootProxyWorldUpdater.getUpdatedContractNonces() : null,
                     result.isSuccess() ? rootProxyWorldUpdater.getCreatedContractIds() : null,
                     result.isSuccess() ? result.evmAddressIfCreatedIn(rootProxyWorldUpdater) : null,
@@ -264,16 +267,17 @@ private HevmTransactionCreationResult safeCreateHevmTransaction() {
         try {
             final var hevmTransaction = hevmTransactionFactory.fromHapiTransaction(context.body(), context.payer());
             validatePayloadLength(hevmTransaction);
-            return new HevmTransactionCreationResult(hevmTransaction, hevmTransaction.hookOwnerAddress() != null);
+            return new HevmTransactionCreationResult(hevmTransaction, hevmTransaction.hookDispatch());
         } catch (HandleException e) {
             final var evmTxn = hevmTransactionFactory.fromContractTxException(context.body(), e);
             // Return a HederaEvmTransaction that represents the error in order to charge fees to the sender
-            return new HevmTransactionCreationResult(evmTxn, context.body().hasHookDispatch());
+            return new HevmTransactionCreationResult(
+                    evmTxn, context.body().hasHookDispatch() ? context.body().hookDispatchOrThrow() : null);
         }
     }
 
     private record HevmTransactionCreationResult(
-            @Nullable HederaEvmTransaction hevmTransaction, boolean isHookDispatch) {}
+            @Nullable HederaEvmTransaction hevmTransaction, @Nullable HookDispatchTransactionBody hookDispatch) {}
 
     private void validatePayloadLength(HederaEvmTransaction hevmTransaction) {
         final var maxJumboEthereumCallDataSize =
@@ -306,13 +310,13 @@ private CallOutcome maybeChargeFeesAndReturnOutcome(
         if (context.body().hasEthereumTransaction() && sender != null) {
             result = result.withSignerNonce(sender.getNonce());
         }
-
+        final var hookId = hevmTransaction.maybeHookId();
         final var ethCallData = (hydratedEthTxData != null && hydratedEthTxData.ethTxData() != null)
                 ? Bytes.wrap(hydratedEthTxData.ethTxData().callData())
                 : null;
         return CallOutcome.fromResultsWithoutSidecars(
                 result.asProtoResultOf(ethTxDataIfApplicable(), rootProxyWorldUpdater, ethCallData),
-                result.asEvmTxResultOf(ethTxDataIfApplicable(), ethCallData),
+                result.asEvmTxResultOf(ethTxDataIfApplicable(), ethCallData, hookId),
                 null,
                 null,
                 null,

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

@@ -304,10 +304,11 @@ public void updateStorageMetadata(
      * {@inheritDoc}
      */
     @Override
-    public void updateLambdaStorageSlots(@NonNull final AccountID accountId, int netChangeInSlotsUsed) {
+    public void updateLambdaStorageSlots(
+            @NonNull final AccountID accountId, final int netChangeInSlotsUsed, final boolean requiresContract) {
         requireNonNull(accountId);
         final var tokenServiceApi = context.storeFactory().serviceApi(TokenServiceApi.class);
-        tokenServiceApi.updateLambdaStorageSlots(accountId, netChangeInSlotsUsed);
+        tokenServiceApi.updateLambdaStorageSlots(accountId, netChangeInSlotsUsed, false);
     }
 
     /**

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

@@ -186,13 +186,15 @@ public interface HederaOperations {
      * @param netChangeInSlotsUsed      the net change in the number of storage slots used by the contract
      */
     void updateStorageMetadata(ContractID contractID, @NonNull Bytes firstKey, int netChangeInSlotsUsed);
+
     /**
      * Updates the storage slots used for the given account.
      *
-     * @param accountId          the id of the account
+     * @param accountId the id of the account
      * @param netChangeInSlotsUsed the net change in the number of storage slots used by the account
+     * @param requiresContract if true, the account must be a contract
      */
-    void updateLambdaStorageSlots(@NonNull AccountID accountId, int netChangeInSlotsUsed);
+    void updateLambdaStorageSlots(@NonNull AccountID accountId, int netChangeInSlotsUsed, boolean requiresContract);
 
     /**
      * Creates a new contract with the given entity number and EVM address; and also "links" the alias

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

@@ -191,7 +191,8 @@ public void updateStorageMetadata(
     }
 
     @Override
-    public void updateLambdaStorageSlots(@NonNull final AccountID accountId, final int netChangeInSlotsUsed) {
+    public void updateLambdaStorageSlots(
+            @NonNull final AccountID accountId, final int netChangeInSlotsUsed, boolean requiresContract) {
         throw new UnsupportedOperationException("Queries cannot update storage slots");
     }
 

hedera-node/hedera-smart-contract-service-impl/src/main/java/com/hedera/node/app/service/contract/impl/handlers/ContractCreateHandler.java

@@ -4,6 +4,7 @@
 import static com.hedera.hapi.node.base.HederaFunctionality.CONTRACT_CREATE;
 import static com.hedera.hapi.node.base.ResponseCodeEnum.INSUFFICIENT_GAS;
 import static com.hedera.hapi.node.base.ResponseCodeEnum.INVALID_AUTORENEW_ACCOUNT;
+import static com.hedera.node.app.hapi.utils.contracts.HookUtils.asAccountId;
 import static com.hedera.node.app.service.contract.impl.utils.ConversionUtils.throwIfUnsuccessfulCreate;
 import static com.hedera.node.app.service.token.HookDispatchUtils.dispatchHookCreations;
 import static com.hedera.node.app.service.token.HookDispatchUtils.validateHookDuplicates;
@@ -13,6 +14,7 @@
 import com.hedera.hapi.node.base.AccountID;
 import com.hedera.hapi.node.base.ContractID;
 import com.hedera.hapi.node.base.HederaFunctionality;
+import com.hedera.hapi.node.base.HookEntityId;
 import com.hedera.node.app.hapi.utils.fee.SigValueObj;
 import com.hedera.node.app.hapi.utils.fee.SmartContractFeeBuilder;
 import com.hedera.node.app.service.contract.impl.ContractServiceComponent;
@@ -126,16 +128,16 @@ public void preHandle(@NonNull final PreHandleContext context) throws PreCheckEx
     /**
      * If there are any hooks to create, creates them and updates the created contract to point to the first hook.
      * @param context the handle context
-     * @param owner the created contract ID
+     * @param ownerId the created contract ID
      */
-    private void createHooksIfAny(final @NonNull HandleContext context, final ContractID owner) {
+    private void createHooksIfAny(@NonNull final HandleContext context, @NonNull final ContractID ownerId) {
         final var op = context.body().contractCreateInstanceOrThrow();
         if (!op.hookCreationDetails().isEmpty()) {
             final var accountStore = context.storeFactory().readableStore(ReadableAccountStore.class);
-            final var created = requireNonNull(accountStore.getContractById(owner));
-
-            final var deltaSlots = dispatchHookCreations(context, op.hookCreationDetails(), null, created.accountId());
-
+            final var hookEntityId =
+                    HookEntityId.newBuilder().accountId(asAccountId(ownerId)).build();
+            final var deltaSlots = dispatchHookCreations(context, op.hookCreationDetails(), null, hookEntityId);
+            final var created = requireNonNull(accountStore.getContractById(ownerId));
             final var updated = created.copyBuilder()
                     .firstHookId(op.hookCreationDetails().getFirst().hookId())
                     .numberHooksInUse(op.hookCreationDetails().size())

hedera-node/hedera-smart-contract-service-impl/src/main/java/com/hedera/node/app/service/contract/impl/handlers/ContractUpdateHandler.java

@@ -24,6 +24,7 @@
 import com.hedera.hapi.node.base.AccountID;
 import com.hedera.hapi.node.base.ContractID;
 import com.hedera.hapi.node.base.HederaFunctionality;
+import com.hedera.hapi.node.base.HookEntityId;
 import com.hedera.hapi.node.base.Key;
 import com.hedera.hapi.node.base.SubType;
 import com.hedera.hapi.node.contract.ContractUpdateTransactionBody;
@@ -157,20 +158,24 @@ public void updateHooks(
             @NonNull final ContractUpdateTransactionBody op,
             @NonNull final Account.Builder builder,
             @NonNull final Account originalAccount) {
-        long headAfterDeletes = originalAccount.firstHookId();
-        // Dispatch all the hooks to delete
+        // We persist both account and storage hooks with AccountID entity type internally
+        final var hookEntityId = HookEntityId.newBuilder()
+                .accountId(originalAccount.accountIdOrThrow())
+                .build();
+        Long headAfterDeletes = originalAccount.numberHooksInUse() == 0 ? null : originalAccount.firstHookId();
         if (!op.hookIdsToDelete().isEmpty()) {
-            HookDispatchUtils.dispatchHookDeletions(
-                    context, op.hookIdsToDelete(), headAfterDeletes, originalAccount.accountIdOrThrow());
+            headAfterDeletes = HookDispatchUtils.dispatchHookDeletions(
+                    context, op.hookIdsToDelete(), headAfterDeletes, hookEntityId);
         }
         if (!op.hookCreationDetails().isEmpty()) {
             final var numSlotsUpdated = HookDispatchUtils.dispatchHookCreations(
-                    context, op.hookCreationDetails(), headAfterDeletes, originalAccount.accountId());
+                    context, op.hookCreationDetails(), headAfterDeletes, hookEntityId);
             builder.firstHookId(op.hookCreationDetails().getFirst().hookId());
             final var currentSlots = originalAccount.numberLambdaStorageSlots() + numSlotsUpdated;
             builder.numberLambdaStorageSlots(currentSlots);
         } else if (!op.hookIdsToDelete().isEmpty()) {
-            builder.firstHookId(headAfterDeletes);
+            // If numberLambdaStorageSlots == 0 after deletions, then first hook id is meaningless but set to 0
+            builder.firstHookId(headAfterDeletes == null ? 0 : headAfterDeletes);
         }
         if (!op.hookCreationDetails().isEmpty() || !op.hookIdsToDelete().isEmpty()) {
             final var current = originalAccount.numberHooksInUse();

hedera-node/hedera-smart-contract-service-impl/src/main/java/com/hedera/node/app/service/contract/impl/handlers/HookDispatchHandler.java

@@ -24,7 +24,6 @@
 import com.hedera.node.app.service.contract.impl.state.WritableEvmHookStore;
 import com.hedera.node.app.service.contract.impl.state.hooks.HookEvmFrameStateFactory;
 import com.hedera.node.app.service.entityid.EntityIdFactory;
-import com.hedera.node.app.service.token.api.TokenServiceApi;
 import com.hedera.node.app.service.token.records.HookDispatchStreamBuilder;
 import com.hedera.node.app.spi.fees.FeeContext;
 import com.hedera.node.app.spi.fees.Fees;
@@ -112,7 +111,6 @@ public void handle(@NonNull final HandleContext context) throws HandleException
                 final var hook = evmHookStore.getEvmHook(hookKey);
                 validateTrue(hook != null, HOOK_NOT_FOUND);
 
-                final var tokenServiceApi = context.storeFactory().serviceApi(TokenServiceApi.class);
                 // Build the strategy that will produce a HookEvmFrameStateFactory for this transaction
                 final EvmFrameStates evmFrameStates = (ops, nativeOps, codeFactory) ->
                         new HookEvmFrameStateFactory(ops, nativeOps, codeFactory, hook);