feat: HIP-1313 (#2572)

Signed-off-by: emiliyank <e.kadiyski@gmail.com>
Signed-off-by: Mustafa Uzun <mustafa.uzun@limechain.tech>
Co-authored-by: Hendrik Ebbers <hendrik.ebbers@web.de>
Co-authored-by: Mustafa Uzun <mustafa.uzun@limechain.tech>

Author: 3 people

.github/workflows/build.yml

@@ -176,11 +176,12 @@ jobs:
 
       - name: Prepare Hiero Solo
         id: solo
-        uses: hiero-ledger/hiero-solo-action@4d42a74e8e644a2753f3bb7a2afa429305375b14 # v0.16
+        uses: hiero-ledger/hiero-solo-action@4d42a74e8e644a2753f3bb7a2afa429305375b14 # v0.17
         with:
           installMirrorNode: true
-          mirrorNodeVersion: v0.145.2
-          hieroVersion: v0.70.0-rc.2
+          soloVersion: v0.65.0
+          mirrorNodeVersion: v0.153.0
+          hieroVersion: v0.73.0
 
       - name: Build SDK
         run: ./gradlew assemble
@@ -249,9 +250,10 @@ jobs:
 
       - name: Prepare Hiero Solo (DUAL MODE)
         id: solo
-        uses: hiero-ledger/hiero-solo-action@4d42a74e8e644a2753f3bb7a2afa429305375b14 # v0.16
+        uses: hiero-ledger/hiero-solo-action@4d42a74e8e644a2753f3bb7a2afa429305375b14 # v0.17
         with:
           installMirrorNode: true
+          soloVersion: v0.65.0
           dualMode: true
           hieroVersion: v0.68.0
           mirrorNodeVersion: v0.142.0
@@ -306,11 +308,12 @@ jobs:
 
       - name: Prepare Hiero Solo
         id: solo
-        uses: hiero-ledger/hiero-solo-action@4d42a74e8e644a2753f3bb7a2afa429305375b14 # v0.16
+        uses: hiero-ledger/hiero-solo-action@4d42a74e8e644a2753f3bb7a2afa429305375b14 # v0.17
         with:
           installMirrorNode: true
-          mirrorNodeVersion: v0.145.2
-          hieroVersion: v0.70.0-rc.2
+          soloVersion: v0.65.0
+          mirrorNodeVersion: v0.153.0
+          hieroVersion: v0.73.0
 
       - name: Build SDK
         run: ./gradlew assemble

examples/build.gradle.kts

@@ -81,6 +81,10 @@ abstract class RunAllExample : DefaultTask() {
                 .filter {
                     it != "MirrorNodeContractQueriesExample"
                 } // disabled due to consensus node issue
+                .filter { it != "HookStoreExample" }
+                .filter { it != "AccountHooksExample" }
+                .filter { it != "ContractHooksExample" }
+                .filter { it != "TransferTransactionHooksExample" }
                 .toList()
 
         exampleClasses.forEach { className ->

examples/src/main/java/com/hedera/hashgraph/sdk/examples/HighVolumeAccountCreateExample.java

@@ -0,0 +1,104 @@
+// SPDX-License-Identifier: Apache-2.0
+package com.hedera.hashgraph.sdk.examples;
+
+import com.hedera.hashgraph.sdk.*;
+import com.hedera.hashgraph.sdk.logger.LogLevel;
+import com.hedera.hashgraph.sdk.logger.Logger;
+import io.github.cdimascio.dotenv.Dotenv;
+import java.util.Objects;
+
+/**
+ * Create a Hedera account using high-volume throttles.
+ */
+class HighVolumeAccountCreateExample {
+
+    /*
+     * See .env.sample in the examples folder root for how to specify values below
+     * or set environment variables with the same names.
+     */
+
+    /**
+     * Operator's account ID.
+     * Used to sign and pay for operations on Hedera.
+     */
+    private static final AccountId OPERATOR_ID =
+            AccountId.fromString(Objects.requireNonNull(Dotenv.load().get("OPERATOR_ID")));
+
+    /**
+     * Operator's private key.
+     */
+    private static final PrivateKey OPERATOR_KEY =
+            PrivateKey.fromString(Objects.requireNonNull(Dotenv.load().get("OPERATOR_KEY")));
+
+    /**
+     * HEDERA_NETWORK defaults to testnet if not specified in dotenv file.
+     * Network can be: localhost, testnet, previewnet or mainnet.
+     */
+    private static final String HEDERA_NETWORK = Dotenv.load().get("HEDERA_NETWORK", "testnet");
+
+    /**
+     * SDK_LOG_LEVEL defaults to SILENT if not specified in dotenv file.
+     * Log levels can be: TRACE, DEBUG, INFO, WARN, ERROR, SILENT.
+     * <p>
+     * Important pre-requisite: set simple logger log level to same level as the SDK_LOG_LEVEL,
+     * for example via VM options: -Dorg.slf4j.simpleLogger.log.org.hiero=trace
+     */
+    private static final String SDK_LOG_LEVEL = Dotenv.load().get("SDK_LOG_LEVEL", "SILENT");
+
+    public static void main(String[] args) throws Exception {
+        System.out.println("High-Volume Account Create Example Start!");
+
+        /*
+         * Step 0:
+         * Create and configure the SDK Client.
+         */
+        Client client = ClientHelper.forName(HEDERA_NETWORK);
+        // All generated transactions will be paid by this account and signed by this key.
+        client.setOperator(OPERATOR_ID, OPERATOR_KEY);
+        // Attach logger to the SDK Client.
+        client.setLogger(new Logger(LogLevel.valueOf(SDK_LOG_LEVEL)));
+
+        /*
+         * Step 1:
+         * Generate ED25519 private and public key pair for the account.
+         */
+        PrivateKey privateKey = PrivateKey.generateED25519();
+        PublicKey publicKey = privateKey.getPublicKey();
+        System.out.println("Future account private key: " + privateKey);
+        System.out.println("Future account public key: " + publicKey);
+
+        /*
+         * Step 2:
+         * Create a new account using high-volume throttles and set a fee limit.
+         */
+        System.out.println("Creating new account with high-volume throttles...");
+        TransactionResponse accountCreateTxResponse = new AccountCreateTransaction()
+                .setKeyWithoutAlias(publicKey)
+                .setInitialBalance(Hbar.from(1))
+                .setHighVolume(true)
+                .setMaxTransactionFee(Hbar.from(5))
+                .execute(client);
+
+        // This will wait for the receipt to become available.
+        TransactionReceipt accountCreateTxReceipt = accountCreateTxResponse.getReceipt(client);
+        AccountId newAccountId = accountCreateTxReceipt.accountId;
+        Objects.requireNonNull(newAccountId);
+        System.out.println("Created account with ID: " + newAccountId);
+
+        /*
+         * Clean up:
+         * Delete created account.
+         */
+        new AccountDeleteTransaction()
+                .setTransferAccountId(OPERATOR_ID)
+                .setAccountId(newAccountId)
+                .freezeWith(client)
+                .sign(privateKey)
+                .execute(client)
+                .getReceipt(client);
+
+        client.close();
+
+        System.out.println("High-Volume Account Create Example Complete!");
+    }
+}

sdk/build.gradle.kts

@@ -58,7 +58,7 @@ tasks.withType<Test>().configureEach {
 }
 
 tasks.testIntegration {
-    maxParallelForks = (Runtime.getRuntime().availableProcessors()).coerceAtLeast(1)
+    maxParallelForks = 1
     failFast = true
 }
 

sdk/src/main/java/com/hedera/hashgraph/sdk/Transaction.java

@@ -132,6 +132,8 @@ public abstract class Transaction<T extends Transaction<T>>
 
     private String memo = "";
 
+    private boolean highVolume = false;
+
     List<CustomFeeLimit> customFeeLimits = new ArrayList<>();
 
     private Key batchKey = null;
@@ -156,6 +158,7 @@ public abstract class Transaction<T extends Transaction<T>>
         setTransactionValidDuration(DEFAULT_TRANSACTION_VALID_DURATION);
         setMaxTransactionFee(Hbar.fromTinybars(txBody.getTransactionFee()));
         setTransactionMemo(txBody.getMemo());
+        setHighVolume(txBody.getHighVolume());
 
         sourceTransactionBody = txBody;
     }
@@ -245,6 +248,7 @@ public abstract class Transaction<T extends Transaction<T>>
                 DurationConverter.fromProtobuf(sourceTransactionBody.getTransactionValidDuration()));
         setMaxTransactionFee(Hbar.fromTinybars(sourceTransactionBody.getTransactionFee()));
         setTransactionMemo(sourceTransactionBody.getMemo());
+        setHighVolume(sourceTransactionBody.getHighVolume());
 
         this.customFeeLimits = sourceTransactionBody.getMaxCustomFeesList().stream()
                 .map(CustomFeeLimit::fromProtobuf)
@@ -859,6 +863,30 @@ public final T setTransactionMemo(String memo) {
         return (T) this;
     }
 
+    /**
+     * Extract the high-volume flag.
+     *
+     * @return true if high-volume throttles are enabled, false otherwise
+     */
+    public final boolean getHighVolume() {
+        return highVolume;
+    }
+
+    /**
+     * If set to true, this transaction uses high-volume throttles and pricing
+     * for entity creation. It only affects supported transaction types; otherwise,
+     * it is ignored.
+     *
+     * @param highVolume true to enable high-volume throttles, false otherwise
+     * @return {@code this}
+     */
+    public final T setHighVolume(boolean highVolume) {
+        requireNotFrozen();
+        this.highVolume = highVolume;
+        // noinspection unchecked
+        return (T) this;
+    }
+
     /**
      * batchify method is used to mark a transaction as part of a batch transaction or make it so-called inner transaction.
      * The Transaction will be frozen and signed by the operator of the client.
@@ -1236,7 +1264,8 @@ protected TransactionBody.Builder spawnBodyBuilder(@Nullable Client client) {
                 .setTransactionValidDuration(DurationConverter.toProtobuf(transactionValidDuration).toBuilder())
                 .addAllMaxCustomFees(
                         customFeeLimits.stream().map(CustomFeeLimit::toProtobuf).collect(Collectors.toList()))
-                .setMemo(memo);
+                .setMemo(memo)
+                .setHighVolume(highVolume);
         if (batchKey != null) {
             builder.setBatchKey(batchKey.toProtobufKey());
         }

sdk/src/main/java/com/hedera/hashgraph/sdk/TransactionRecord.java

@@ -192,6 +192,17 @@ public final class TransactionRecord {
      */
     public final List<PendingAirdropRecord> pendingAirdropRecords;
 
+    /**
+     * A pricing multiplier for high-volume entity creation.
+     * <p>
+     * If the transaction that produced this record was flagged as
+     * high-volume, this field SHALL contain the pricing multiplier
+     * applied to the transaction fee.<br/>
+     * If the transaction was not flagged as high-volume, this field
+     * SHALL be zero.
+     */
+    public final long highVolumePricingMultiplier;
+
     TransactionRecord(
             TransactionReceipt transactionReceipt,
             ByteString transactionHash,
@@ -216,7 +227,8 @@ public final class TransactionRecord {
             @Nullable ByteString prngBytes,
             @Nullable Integer prngNumber,
             ByteString evmAddress,
-            List<PendingAirdropRecord> pendingAirdropRecords) {
+            List<PendingAirdropRecord> pendingAirdropRecords,
+            long highVolumePricingMultiplier) {
         this.receipt = transactionReceipt;
         this.transactionHash = transactionHash;
         this.consensusTimestamp = consensusTimestamp;
@@ -244,6 +256,7 @@ public final class TransactionRecord {
         this.prngBytes = prngBytes;
         this.prngNumber = prngNumber;
         this.evmAddress = evmAddress;
+        this.highVolumePricingMultiplier = highVolumePricingMultiplier;
     }
 
     /**
@@ -345,7 +358,8 @@ static TransactionRecord fromProtobuf(
                 transactionRecord.hasPrngBytes() ? transactionRecord.getPrngBytes() : null,
                 transactionRecord.hasPrngNumber() ? transactionRecord.getPrngNumber() : null,
                 transactionRecord.getEvmAddress(),
-                pendingAirdropRecords);
+                pendingAirdropRecords,
+                transactionRecord.getHighVolumePricingMultiplier());
     }
 
     /**
@@ -475,6 +489,8 @@ com.hedera.hashgraph.sdk.proto.TransactionRecord toProtobuf() {
             }
         }
 
+        transactionRecord.setHighVolumePricingMultiplier(highVolumePricingMultiplier);
+
         return transactionRecord.build();
     }
 
@@ -504,6 +520,7 @@ public String toString() {
                 .add("prngNumber", prngNumber)
                 .add("evmAddress", Hex.toHexString(evmAddress.toByteArray()))
                 .add("pendingAirdropRecords", pendingAirdropRecords.toString())
+                .add("highVolumePricingMultiplier", highVolumePricingMultiplier)
                 .toString();
     }
 

sdk/src/main/proto/hints_key_publication.proto

@@ -13,8 +13,6 @@ syntax = "proto3";
 package com.hedera.hapi.services.auxiliary.hints;
 
 // SPDX-License-Identifier: Apache-2.0
-import "hints_types.proto";
-
 option java_package = "com.hedera.hapi.services.auxiliary.hints.legacy";
 // <<<pbj.java_package = "com.hedera.hapi.services.auxiliary.hints">>> This comment is special code for setting PBJ Compiler java package
 

sdk/src/test/java/com/hedera/hashgraph/sdk/TransactionRecordTest.java

@@ -88,7 +88,8 @@ private static TransactionRecord spawnRecordExample(@Nullable ByteString prngByt
                                         AccountId.fromString("0.0.123"),
                                         AccountId.fromString("0.0.124"),
                                         TokenId.fromString("0.0.12345")),
-                                123)));
+                                123)),
+                1000L);
     }
 
     @Test