fix: Always use gas throttle for HSS (#21890)

Signed-off-by: Lukasz Gasior <[email protected]>

Author: lukasz-hashgraph

hedera-node/hedera-app-spi/src/main/java/com/hedera/node/app/spi/AppContext.java

@@ -13,7 +13,7 @@
 import com.hedera.node.app.spi.fees.FeeCharging;
 import com.hedera.node.app.spi.info.NodeInfo;
 import com.hedera.node.app.spi.signatures.SignatureVerifier;
-import com.hedera.node.app.spi.throttle.Throttle;
+import com.hedera.node.app.spi.throttle.ScheduleThrottle;
 import com.swirlds.config.api.Configuration;
 import com.swirlds.metrics.api.Metrics;
 import com.swirlds.state.lifecycle.Service;
@@ -215,10 +215,10 @@ default CompletableFuture<Void> submitFuture(
     Supplier<Metrics> metricsSupplier();
 
     /**
-     * The application's strategy for creating {@link Throttle} instances.
+     * The application's strategy for creating {@link ScheduleThrottle} instances.
      * @return the throttle factory
      */
-    Throttle.Factory throttleFactory();
+    ScheduleThrottle.Factory throttleFactory();
 
     /**
      * Supplier of the application's strategy for charging fees.

hedera-node/hedera-app-spi/src/main/java/com/hedera/node/app/spi/throttle/Throttle.java renamed to hedera-node/hedera-app-spi/src/main/java/com/hedera/node/app/spi/throttle/ScheduleThrottle.java

@@ -5,27 +5,25 @@
 import com.hedera.hapi.node.base.HederaFunctionality;
 import com.hedera.hapi.node.state.throttles.ThrottleUsageSnapshots;
 import com.hedera.hapi.node.transaction.TransactionBody;
-import com.hedera.node.app.spi.AppContext;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
 import java.time.Instant;
 
 /**
- * A throttle that can be used to limit the rate of transactions. Provided in the {@link AppContext} so that services
- * can align to the application's strategy for throttling transactions.
+ * A throttle that is used by HSS to limit the rate of transactions scheduled for future execution.
  */
-public interface Throttle {
+public interface ScheduleThrottle {
     /**
-     * A factory for creating {@link Throttle} instances.
+     * A factory for creating {@link ScheduleThrottle} instances.
      */
     interface Factory {
         /**
-         * Creates a new throttle based on the capacity split and usage snapshots.
+         * Creates a new schedule throttle based on the capacity split and usage snapshots.
          * @param capacitySplit the split of the capacity
          * @param initialUsageSnapshots if not null, the usage snapshots the throttle should start with
          * @return the new throttle
          */
-        Throttle newThrottle(int capacitySplit, @Nullable ThrottleUsageSnapshots initialUsageSnapshots);
+        ScheduleThrottle newScheduleThrottle(int capacitySplit, @Nullable ThrottleUsageSnapshots initialUsageSnapshots);
     }
 
     /**

hedera-node/hedera-app/src/main/java/com/hedera/node/app/HederaInjectionComponent.java

@@ -39,7 +39,7 @@
 import com.hedera.node.app.spi.info.NodeInfo;
 import com.hedera.node.app.spi.migrate.StartupNetworks;
 import com.hedera.node.app.spi.records.RecordCache;
-import com.hedera.node.app.spi.throttle.Throttle;
+import com.hedera.node.app.spi.throttle.ScheduleThrottle;
 import com.hedera.node.app.state.HederaStateInjectionModule;
 import com.hedera.node.app.state.WorkingStateAccessor;
 import com.hedera.node.app.throttle.ThrottleServiceManager;
@@ -204,7 +204,7 @@ interface Builder {
         Builder instantSource(InstantSource instantSource);
 
         @BindsInstance
-        Builder throttleFactory(Throttle.Factory throttleFactory);
+        Builder throttleFactory(ScheduleThrottle.Factory throttleFactory);
 
         @BindsInstance
         Builder softwareVersion(SemanticVersion softwareVersion);

hedera-node/hedera-app/src/main/java/com/hedera/node/app/services/AppContextImpl.java

@@ -8,7 +8,7 @@
 import com.hedera.node.app.spi.fees.FeeCharging;
 import com.hedera.node.app.spi.info.NodeInfo;
 import com.hedera.node.app.spi.signatures.SignatureVerifier;
-import com.hedera.node.app.spi.throttle.Throttle;
+import com.hedera.node.app.spi.throttle.ScheduleThrottle;
 import com.swirlds.config.api.Configuration;
 import com.swirlds.metrics.api.Metrics;
 import edu.umd.cs.findbugs.annotations.NonNull;
@@ -35,7 +35,7 @@ public record AppContextImpl(
         @NonNull Supplier<Configuration> configSupplier,
         @NonNull Supplier<NodeInfo> selfNodeInfoSupplier,
         @NonNull Supplier<Metrics> metricsSupplier,
-        @NonNull Throttle.Factory throttleFactory,
+        @NonNull ScheduleThrottle.Factory throttleFactory,
         @NonNull Supplier<FeeCharging> feeChargingSupplier,
         @NonNull EntityIdFactory idFactory)
         implements AppContext {

hedera-node/hedera-app/src/main/java/com/hedera/node/app/throttle/AppThrottleFactory.java

@@ -12,7 +12,7 @@
 import com.hedera.hapi.node.transaction.ThrottleDefinitions;
 import com.hedera.hapi.node.transaction.TransactionBody;
 import com.hedera.node.app.hapi.utils.throttles.DeterministicThrottle;
-import com.hedera.node.app.spi.throttle.Throttle;
+import com.hedera.node.app.spi.throttle.ScheduleThrottle;
 import com.hedera.node.app.workflows.TransactionInfo;
 import com.hedera.pbj.runtime.io.buffer.Bytes;
 import com.swirlds.config.api.Configuration;
@@ -24,9 +24,9 @@
 import java.util.function.Supplier;
 
 /**
- * The application's strategy for creating a {@link Throttle} to use at consensus.
+ * The application's strategy for creating a {@link ScheduleThrottle} to use at consensus.
  */
-public class AppThrottleFactory implements Throttle.Factory {
+public class AppThrottleFactory implements ScheduleThrottle.Factory {
     private final Supplier<State> stateSupplier;
     private final Supplier<Configuration> configSupplier;
     private final Supplier<ThrottleDefinitions> definitionsSupplier;
@@ -51,7 +51,8 @@ public AppThrottleFactory(
     }
 
     @Override
-    public Throttle newThrottle(final int capacitySplit, @Nullable final ThrottleUsageSnapshots initialUsageSnapshots) {
+    public ScheduleThrottle newScheduleThrottle(
+            final int capacitySplit, @Nullable final ThrottleUsageSnapshots initialUsageSnapshots) {
         final var throttleAccumulator = throttleAccumulatorFactory.newThrottleAccumulator(
                 configSupplier, () -> capacitySplit, ThrottleAccumulator.ThrottleType.BACKEND_THROTTLE);
         throttleAccumulator.applyGasConfig();
@@ -67,7 +68,7 @@ public Throttle newThrottle(final int capacitySplit, @Nullable final ThrottleUsa
             throttleAccumulator.gasLimitThrottle().resetUsageTo(initialUsageSnapshots.gasThrottleOrThrow());
         }
         // Throttle.allow() has the opposite polarity of ThrottleAccumulator.checkAndEnforceThrottle()
-        return new Throttle() {
+        return new ScheduleThrottle() {
             @Override
             public boolean allow(
                     @NonNull final AccountID payerId,
@@ -86,7 +87,8 @@ public boolean allow(
                                 null),
                         now,
                         stateSupplier.get(),
-                        null);
+                        null,
+                        true);
             }
 
             @Override

hedera-node/hedera-app/src/main/java/com/hedera/node/app/throttle/NetworkUtilizationManagerImpl.java

@@ -40,7 +40,7 @@ public NetworkUtilizationManagerImpl(
     @Override
     public boolean trackTxn(
             @NonNull final TransactionInfo txnInfo, @NonNull final Instant consensusTime, @NonNull final State state) {
-        final var shouldThrottle = backendThrottle.checkAndEnforceThrottle(txnInfo, consensusTime, state, null);
+        final var shouldThrottle = backendThrottle.checkAndEnforceThrottle(txnInfo, consensusTime, state, null, false);
         congestionMultipliers.updateMultiplier(consensusTime);
         return shouldThrottle;
     }

hedera-node/hedera-app/src/main/java/com/hedera/node/app/throttle/SynchronizedThrottleAccumulator.java

@@ -56,7 +56,7 @@ public synchronized boolean shouldThrottle(
         requireNonNull(state);
         requireNonNull(throttleUsages);
         setDecisionTime(instantSource.instant());
-        return frontendThrottle.checkAndEnforceThrottle(txnInfo, lastDecisionTime, state, throttleUsages);
+        return frontendThrottle.checkAndEnforceThrottle(txnInfo, lastDecisionTime, state, throttleUsages, false);
     }
 
     /**

hedera-node/hedera-app/src/main/java/com/hedera/node/app/throttle/ThrottleAccumulator.java

@@ -178,19 +178,23 @@ public ThrottleAccumulator(
      * @param now the instant of time the transaction throttling should be checked for
      * @param state the current state of the node
      * @param throttleUsages if not null, a list to accumulate throttle usages into
+     * @param gasThrottleAlwaysEnabled if set, gas throttle is always enforced within this call,
+     *                                 even if the throttleByGas configuration flag is off
      * @return whether the transaction should be throttled
      */
     public boolean checkAndEnforceThrottle(
             @NonNull final TransactionInfo txnInfo,
             @NonNull final Instant now,
             @NonNull final State state,
-            @Nullable final List<ThrottleUsage> throttleUsages) {
+            @Nullable final List<ThrottleUsage> throttleUsages,
+            final boolean gasThrottleAlwaysEnabled) {
         if (throttleType == NOOP_THROTTLE) {
             return false;
         }
         resetLastAllowedUse();
         lastTxnWasGasThrottled = false;
-        if (shouldThrottleTxn(false, txnInfo, now, state, throttleUsages)) {
+
+        if (shouldThrottleTxn(txnInfo, now, state, throttleUsages, gasThrottleAlwaysEnabled)) {
             reclaimLastAllowedUse();
             return true;
         }
@@ -249,6 +253,7 @@ public boolean checkAndEnforceThrottle(
         if (isGasThrottled(queryFunction)) {
             final var enforceGasThrottle =
                     configuration.getConfigData(ContractsConfig.class).throttleThrottleByGas();
+
             return enforceGasThrottle
                     && !gasThrottle.allow(
                             now,
@@ -412,11 +417,11 @@ public void updateAllMetrics() {
     }
 
     private boolean shouldThrottleTxn(
-            final boolean isScheduled,
             @NonNull final TransactionInfo txnInfo,
             @NonNull final Instant now,
             @NonNull final State state,
-            List<ThrottleUsage> throttleUsages) {
+            List<ThrottleUsage> throttleUsages,
+            final boolean gasThrottleAlwaysEnabled) {
         final var function = txnInfo.functionality();
         final var configuration = configSupplier.get();
         final boolean isJumboTransactionsEnabled =
@@ -434,7 +439,10 @@ private boolean shouldThrottleTxn(
             return false;
         }
 
-        if (isGasExhausted(txnInfo, now, configuration, throttleUsages)) {
+        final boolean throttleByGasFlag =
+                configuration.getConfigData(ContractsConfig.class).throttleThrottleByGas();
+        final boolean shouldThrottleByGas = throttleByGasFlag || gasThrottleAlwaysEnabled;
+        if (shouldThrottleByGas && isGasExhausted(txnInfo, now, throttleUsages)) {
             lastTxnWasGasThrottled = true;
             return true;
         }
@@ -460,12 +468,7 @@ private boolean shouldThrottleTxn(
         }
 
         return switch (function) {
-            case SCHEDULE_CREATE -> {
-                if (isScheduled) {
-                    throw new IllegalStateException("ScheduleCreate cannot be a child!");
-                }
-                yield shouldThrottleScheduleCreate(manager, txnInfo, now, state, throttleUsages);
-            }
+            case SCHEDULE_CREATE -> shouldThrottleScheduleCreate(manager, txnInfo, now, state, throttleUsages);
             case TOKEN_MINT ->
                 shouldThrottleMint(manager, txnInfo.txBody().tokenMint(), now, configuration, throttleUsages);
             case CRYPTO_TRANSFER -> {
@@ -617,11 +620,8 @@ private long getGasLimitForContractTx(
     private boolean isGasExhausted(
             @NonNull final TransactionInfo txnInfo,
             @NonNull final Instant now,
-            @NonNull final Configuration configuration,
             @Nullable final List<ThrottleUsage> throttleUsages) {
-        final boolean shouldThrottleByGas =
-                configuration.getConfigData(ContractsConfig.class).throttleThrottleByGas();
-        if (shouldThrottleByGas && isGasThrottled(txnInfo.functionality())) {
+        if (isGasThrottled(txnInfo.functionality())) {
             final long amount = getGasLimitForContractTx(txnInfo.txBody(), txnInfo.functionality());
             final boolean answer = !gasThrottle.allow(now, amount);
             if (!answer && throttleUsages != null) {

hedera-node/hedera-app/src/main/java/com/hedera/node/app/workflows/standalone/ExecutorComponent.java

@@ -14,7 +14,7 @@
 import com.hedera.node.app.service.util.impl.UtilServiceImpl;
 import com.hedera.node.app.services.ServicesInjectionModule;
 import com.hedera.node.app.spi.AppContext;
-import com.hedera.node.app.spi.throttle.Throttle;
+import com.hedera.node.app.spi.throttle.ScheduleThrottle;
 import com.hedera.node.app.state.HederaStateInjectionModule;
 import com.hedera.node.app.throttle.ThrottleServiceManager;
 import com.hedera.node.app.throttle.ThrottleServiceModule;
@@ -82,7 +82,7 @@ interface Builder {
         Builder metrics(Metrics metrics);
 
         @BindsInstance
-        Builder throttleFactory(Throttle.Factory throttleFactory);
+        Builder throttleFactory(ScheduleThrottle.Factory throttleFactory);
 
         @BindsInstance
         Builder appContext(AppContext appContext);

hedera-node/hedera-app/src/test/java/com/hedera/node/app/components/IngestComponentTest.java

@@ -42,7 +42,7 @@
 import com.hedera.node.app.spi.info.NetworkInfo;
 import com.hedera.node.app.spi.info.NodeInfo;
 import com.hedera.node.app.spi.migrate.StartupNetworks;
-import com.hedera.node.app.spi.throttle.Throttle;
+import com.hedera.node.app.spi.throttle.ScheduleThrottle;
 import com.hedera.node.app.state.recordcache.RecordCacheService;
 import com.hedera.node.config.data.BlockStreamConfig;
 import com.hedera.node.config.data.HederaConfig;
@@ -78,7 +78,7 @@ class IngestComponentTest {
     private TransactionPoolNexus transactionPool;
 
     @Mock
-    private Throttle.Factory throttleFactory;
+    private ScheduleThrottle.Factory throttleFactory;
 
     @Mock
     private StartupNetworks startupNetworks;