feat: add declineReward option to NodeCreate and NodeUpdate transactions (#2333)

SimiHunjan · naydenovn · web-flow · commit 2601eff6deec · 2025-05-14T12:53:05.000+03:00
Signed-off-by: Simi Hunjan &lt;simi.hunjan.k@gmail.com&gt;
Signed-off-by: Naydenov &lt;nikola.naydenov@limechain.tech&gt;
Co-authored-by: Naydenov &lt;nikola.naydenov@limechain.tech&gt;
diff --git a/sdk/src/main/java/com/hedera/hashgraph/sdk/NodeCreateTransaction.java b/sdk/src/main/java/com/hedera/hashgraph/sdk/NodeCreateTransaction.java
@@ -59,6 +59,9 @@ public class NodeCreateTransaction extends Transaction<NodeCreateTransaction> {
     @Nullable
     private Key adminKey = null;
 
+    @Nullable
+    private Boolean declineReward = null;
+
     /**
      * Constructor.
      */
@@ -307,6 +310,29 @@ public NodeCreateTransaction setAdminKey(Key adminKey) {
         return this;
     }
 
+    /**
+     * Gets whether this node declines rewards.
+     * If null, the default behavior is to decline rewards.
+     *
+     * @return true if rewards are declined; false if accepted; null if unset.
+     */
+    @Nullable
+    public Boolean getDeclineReward() {
+        return declineReward;
+    }
+
+    /**
+     * Sets whether this node should decline rewards.
+     *
+     * @param decline true to decline rewards, false to accept.
+     * @return {@code this}
+     */
+    public NodeCreateTransaction setDeclineReward(boolean decline) {
+        requireNotFrozen();
+        this.declineReward = decline;
+        return this;
+    }
+
     /**
      * Build the transaction body.
      *
@@ -341,6 +367,10 @@ NodeCreateTransactionBody.Builder build() {
             builder.setAdminKey(adminKey.toProtobufKey());
         }
 
+        if (declineReward != null) {
+            builder.setDeclineReward(declineReward);
+        }
+
         return builder;
     }
 
@@ -373,6 +403,8 @@ void initFromTransactionBody() {
         if (body.hasAdminKey()) {
             adminKey = Key.fromProtobufKey(body.getAdminKey());
         }
+
+        declineReward = body.getDeclineReward();
     }
 
     @Override
diff --git a/sdk/src/main/java/com/hedera/hashgraph/sdk/NodeUpdateTransaction.java b/sdk/src/main/java/com/hedera/hashgraph/sdk/NodeUpdateTransaction.java
@@ -1,10 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 package com.hedera.hashgraph.sdk;
 
-import com.google.protobuf.ByteString;
-import com.google.protobuf.BytesValue;
-import com.google.protobuf.InvalidProtocolBufferException;
-import com.google.protobuf.StringValue;
+import com.google.protobuf.*;
 import com.hedera.hashgraph.sdk.proto.AddressBookServiceGrpc;
 import com.hedera.hashgraph.sdk.proto.NodeUpdateTransactionBody;
 import com.hedera.hashgraph.sdk.proto.SchedulableTransactionBody;
@@ -60,6 +57,9 @@ public class NodeUpdateTransaction extends Transaction<NodeUpdateTransaction> {
     @Nullable
     private Key adminKey = null;
 
+    @Nullable
+    private Boolean declineReward = null;
+
     /**
      * Constructor.
      */
@@ -362,6 +362,26 @@ public NodeUpdateTransaction setAdminKey(Key adminKey) {
         return this;
     }
 
+    /**
+     * Gets whether this node declines rewards.
+     * @return true if the node declines rewards; false if it accepts rewards.
+     */
+    @Nullable
+    public Boolean getDeclineReward() {
+        return declineReward;
+    }
+
+    /**
+     * Sets whether this node should decline rewards.
+     * @param decline true to decline rewards; false to accept them.
+     * @return {@code this}
+     */
+    public NodeUpdateTransaction setDeclineReward(boolean decline) {
+        requireNotFrozen();
+        this.declineReward = decline;
+        return this;
+    }
+
     /**
      * Build the transaction body.
      *
@@ -400,6 +420,10 @@ NodeUpdateTransactionBody.Builder build() {
             builder.setAdminKey(adminKey.toProtobufKey());
         }
 
+        if (declineReward != null) {
+            builder.setDeclineReward(BoolValue.of(declineReward));
+        }
+
         return builder;
     }
 
@@ -438,6 +462,10 @@ void initFromTransactionBody() {
         if (body.hasAdminKey()) {
             adminKey = Key.fromProtobufKey(body.getAdminKey());
         }
+
+        if (body.hasDeclineReward()) {
+            declineReward = body.getDeclineReward().getValue();
+        }
     }
 
     @Override
diff --git a/sdk/src/test/java/com/hedera/hashgraph/sdk/NodeCreateTransactionTest.java b/sdk/src/test/java/com/hedera/hashgraph/sdk/NodeCreateTransactionTest.java
@@ -78,6 +78,7 @@ private NodeCreateTransaction spawnTestTransaction() {
                 .setGrpcCertificateHash(TEST_GRPC_CERTIFICATE_HASH)
                 .setAdminKey(TEST_ADMIN_KEY)
                 .setMaxTransactionFee(new Hbar(1))
+                .setDeclineReward(false) // accepts the reward
                 .freeze()
                 .sign(TEST_PRIVATE_KEY);
     }
@@ -147,6 +148,8 @@ void constructNodeCreateTransactionFromTransactionBodyProtobuf() {
         transactionBodyBuilder.setGrpcCertificateHash(ByteString.copyFrom(TEST_GRPC_CERTIFICATE_HASH));
         transactionBodyBuilder.setAdminKey(TEST_ADMIN_KEY.toProtobufKey());
 
+        transactionBodyBuilder.setDeclineReward(true);
+
         var tx = TransactionBody.newBuilder()
                 .setNodeCreate(transactionBodyBuilder.build())
                 .build();
@@ -244,4 +247,16 @@ void getSetAdminKeyFrozen() {
         var tx = spawnTestTransaction();
         assertThrows(IllegalStateException.class, () -> tx.setAdminKey(TEST_ADMIN_KEY));
     }
+
+    @Test
+    void getSetDeclineReward() {
+        var nodeCreateTransaction = new NodeCreateTransaction().setDeclineReward(true);
+        assertThat(nodeCreateTransaction.getDeclineReward()).isTrue();
+    }
+
+    @Test
+    void getSetDeclineRewardFrozen() {
+        var tx = spawnTestTransaction();
+        assertThrows(IllegalStateException.class, () -> tx.setDeclineReward(false));
+    }
 }
diff --git a/sdk/src/test/java/com/hedera/hashgraph/sdk/NodeCreateTransactionTest.snap b/sdk/src/test/java/com/hedera/hashgraph/sdk/NodeCreateTransactionTest.snap
@@ -1,3 +1,3 @@
 com.hedera.hashgraph.sdk.NodeCreateTransactionTest.shouldSerialize=[
   "# com.hedera.hashgraph.sdk.proto.TransactionBody\nnode_account_i_d {\n  account_num: 5005\n  realm_num: 0\n  shard_num: 0\n}\nnode_create {\n  account_id {\n    account_num: 9\n    realm_num: 6\n    shard_num: 0\n  }\n  admin_key {\n    ed25519: \"\\030\\214\\252`\\231\\024#O\\b\\370\\342\\232\\321g\\274\\273\\346\\221}\\211m\\244R\\306\\017\\230\\017j,\\246\\206\\001\"\n  }\n  description: \"Test description\"\n  gossip_ca_certificate: \"\\000\\001\\002\\003\\004\"\n  gossip_endpoint {\n    domain_name: \"0unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 42\n  }\n  gossip_endpoint {\n    domain_name: \"1unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 43\n  }\n  gossip_endpoint {\n    domain_name: \"2unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 44\n  }\n  grpc_certificate_hash: \"\\005\\006\\a\\b\\t\"\n  service_endpoint {\n    domain_name: \"3unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 45\n  }\n  service_endpoint {\n    domain_name: \"4unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 46\n  }\n  service_endpoint {\n    domain_name: \"5unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 47\n  }\n  service_endpoint {\n    domain_name: \"6unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 48\n  }\n}\ntransaction_fee: 100000000\ntransaction_i_d {\n  account_i_d {\n    account_num: 5006\n    realm_num: 0\n    shard_num: 0\n  }\n  transaction_valid_start {\n    seconds: 1554158542\n  }\n}\ntransaction_valid_duration {\n  seconds: 120\n}"
-]
+]
diff --git a/sdk/src/test/java/com/hedera/hashgraph/sdk/NodeUpdateTransactionTest.java b/sdk/src/test/java/com/hedera/hashgraph/sdk/NodeUpdateTransactionTest.java
@@ -4,6 +4,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
+import com.google.protobuf.BoolValue;
 import com.google.protobuf.ByteString;
 import com.google.protobuf.BytesValue;
 import com.google.protobuf.StringValue;
@@ -83,6 +84,7 @@ private NodeUpdateTransaction spawnTestTransaction() {
                 .setGrpcCertificateHash(TEST_GRPC_CERTIFICATE_HASH)
                 .setAdminKey(TEST_ADMIN_KEY)
                 .setMaxTransactionFee(new Hbar(1))
+                .setDeclineReward(true)
                 .freeze()
                 .sign(TEST_PRIVATE_KEY);
     }
@@ -163,6 +165,7 @@ void constructNodeUpdateTransactionFromTransactionBodyProtobuf() {
         transactionBodyBuilder.setGossipCaCertificate(BytesValue.of(ByteString.copyFrom(TEST_GOSSIP_CA_CERTIFICATE)));
         transactionBodyBuilder.setGrpcCertificateHash(BytesValue.of(ByteString.copyFrom(TEST_GRPC_CERTIFICATE_HASH)));
         transactionBodyBuilder.setAdminKey(TEST_ADMIN_KEY.toProtobufKey());
+        transactionBodyBuilder.setDeclineReward(BoolValue.of(true));
 
         var tx = TransactionBody.newBuilder()
                 .setNodeUpdate(transactionBodyBuilder.build())
@@ -177,6 +180,7 @@ void constructNodeUpdateTransactionFromTransactionBodyProtobuf() {
         assertThat(nodeUpdateTransaction.getGossipCaCertificate()).isEqualTo(TEST_GOSSIP_CA_CERTIFICATE);
         assertThat(nodeUpdateTransaction.getGrpcCertificateHash()).isEqualTo(TEST_GRPC_CERTIFICATE_HASH);
         assertThat(nodeUpdateTransaction.getAdminKey()).isEqualTo(TEST_ADMIN_KEY);
+        assertThat(nodeUpdateTransaction.getDeclineReward()).isEqualTo(true);
     }
 
     @Test
@@ -274,4 +278,16 @@ void getSetAdminKeyFrozen() {
         var tx = spawnTestTransaction();
         assertThrows(IllegalStateException.class, () -> tx.setAdminKey(TEST_ADMIN_KEY));
     }
+
+    @Test
+    void getSetDeclineReward() {
+        var tx = new NodeUpdateTransaction().setDeclineReward(true);
+        assertThat(tx.getDeclineReward()).isEqualTo(true);
+    }
+
+    @Test
+    void getSetDeclineRewardFrozen() {
+        var tx = spawnTestTransaction();
+        assertThrows(IllegalStateException.class, () -> tx.setDeclineReward(false));
+    }
 }
diff --git a/sdk/src/test/java/com/hedera/hashgraph/sdk/NodeUpdateTransactionTest.snap b/sdk/src/test/java/com/hedera/hashgraph/sdk/NodeUpdateTransactionTest.snap
@@ -1,3 +1,3 @@
 com.hedera.hashgraph.sdk.NodeUpdateTransactionTest.shouldSerialize=[
-  "# com.hedera.hashgraph.sdk.proto.TransactionBody\nnode_account_i_d {\n  account_num: 5005\n  realm_num: 0\n  shard_num: 0\n}\nnode_update {\n  account_id {\n    account_num: 9\n    realm_num: 6\n    shard_num: 0\n  }\n  admin_key {\n    ed25519: \"\\030\\214\\252`\\231\\024#O\\b\\370\\342\\232\\321g\\274\\273\\346\\221}\\211m\\244R\\306\\017\\230\\017j,\\246\\206\\001\"\n  }\n  description {\n    value: \"Test description\"\n  }\n  gossip_ca_certificate {\n    value: \"\\000\\001\\002\\003\\004\"\n  }\n  gossip_endpoint {\n    domain_name: \"0unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 42\n  }\n  gossip_endpoint {\n    domain_name: \"1unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 43\n  }\n  gossip_endpoint {\n    domain_name: \"2unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 44\n  }\n  grpc_certificate_hash {\n    value: \"\\005\\006\\a\\b\\t\"\n  }\n  node_id: 420\n  service_endpoint {\n    domain_name: \"3unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 45\n  }\n  service_endpoint {\n    domain_name: \"4unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 46\n  }\n  service_endpoint {\n    domain_name: \"5unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 47\n  }\n  service_endpoint {\n    domain_name: \"6unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 48\n  }\n}\ntransaction_fee: 100000000\ntransaction_i_d {\n  account_i_d {\n    account_num: 5006\n    realm_num: 0\n    shard_num: 0\n  }\n  transaction_valid_start {\n    seconds: 1554158542\n  }\n}\ntransaction_valid_duration {\n  seconds: 120\n}"
-]
+  "# com.hedera.hashgraph.sdk.proto.TransactionBody\nnode_account_i_d {\n  account_num: 5005\n  realm_num: 0\n  shard_num: 0\n}\nnode_update {\n  account_id {\n    account_num: 9\n    realm_num: 6\n    shard_num: 0\n  }\n  admin_key {\n    ed25519: \"\\030\\214\\252`\\231\\024#O\\b\\370\\342\\232\\321g\\274\\273\\346\\221}\\211m\\244R\\306\\017\\230\\017j,\\246\\206\\001\"\n  }\n  decline_reward {\n    value: true\n  }\n  description {\n    value: \"Test description\"\n  }\n  gossip_ca_certificate {\n    value: \"\\000\\001\\002\\003\\004\"\n  }\n  gossip_endpoint {\n    domain_name: \"0unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 42\n  }\n  gossip_endpoint {\n    domain_name: \"1unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 43\n  }\n  gossip_endpoint {\n    domain_name: \"2unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 44\n  }\n  grpc_certificate_hash {\n    value: \"\\005\\006\\a\\b\\t\"\n  }\n  node_id: 420\n  service_endpoint {\n    domain_name: \"3unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 45\n  }\n  service_endpoint {\n    domain_name: \"4unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 46\n  }\n  service_endpoint {\n    domain_name: \"5unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 47\n  }\n  service_endpoint {\n    domain_name: \"6unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 48\n  }\n}\ntransaction_fee: 100000000\ntransaction_i_d {\n  account_i_d {\n    account_num: 5006\n    realm_num: 0\n    shard_num: 0\n  }\n  transaction_valid_start {\n    seconds: 1554158542\n  }\n}\ntransaction_valid_duration {\n  seconds: 120\n}"
+]

-Original file line number
+Diff line change
@@ @@ -1,3 +1,3 @@ @@
 com.hedera.hashgraph.sdk.NodeCreateTransactionTest.shouldSerialize=[
   "# com.hedera.hashgraph.sdk.proto.TransactionBody\nnode_account_i_d {\n  account_num: 5005\n  realm_num: 0\n  shard_num: 0\n}\nnode_create {\n  account_id {\n    account_num: 9\n    realm_num: 6\n    shard_num: 0\n  }\n  admin_key {\n    ed25519: \"\\030\\214\\252`\\231\\024#O\\b\\370\\342\\232\\321g\\274\\273\\346\\221}\\211m\\244R\\306\\017\\230\\017j,\\246\\206\\001\"\n  }\n  description: \"Test description\"\n  gossip_ca_certificate: \"\\000\\001\\002\\003\\004\"\n  gossip_endpoint {\n    domain_name: \"0unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 42\n  }\n  gossip_endpoint {\n    domain_name: \"1unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 43\n  }\n  gossip_endpoint {\n    domain_name: \"2unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 44\n  }\n  grpc_certificate_hash: \"\\005\\006\\a\\b\\t\"\n  service_endpoint {\n    domain_name: \"3unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 45\n  }\n  service_endpoint {\n    domain_name: \"4unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 46\n  }\n  service_endpoint {\n    domain_name: \"5unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 47\n  }\n  service_endpoint {\n    domain_name: \"6unit.test.com\"\n    ip_address_v4: \"\\000\\001\\002\\003\"\n    port: 48\n  }\n}\ntransaction_fee: 100000000\ntransaction_i_d {\n  account_i_d {\n    account_num: 5006\n    realm_num: 0\n    shard_num: 0\n  }\n  transaction_valid_start {\n    seconds: 1554158542\n  }\n}\ntransaction_valid_duration {\n  seconds: 120\n}"
 -]
 +]