feat/Node: RewardsParameters to protocol (#1409)

* rewardsParams * spaces fix * u64 change * Update bindings/nodejs/lib/types/models/info/node-info-protocol.ts Co-authored-by: DaughterOfMars <[email protected]> * updated rust --------- Co-authored-by: DaughterOfMars <[email protected]>
iotaledger · Oct 16, 2023 · 38dd082 · 38dd082
1 parent de89ba4
commit 38dd082
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 3 deletions.
diff --git a/bindings/nodejs/lib/types/models/info/node-info-protocol.ts b/bindings/nodejs/lib/types/models/info/node-info-protocol.ts
@@ -103,6 +103,46 @@ export interface ProtocolParameters {
      * The parameters used by signaling protocol parameters upgrade.
      */
     versionSignaling: VersionSignalingParameters;
+    /**
+     * Rewards Parameters defines the parameters that are used to calculate Mana rewards.
+     */
+    rewardsParameters: RewardsParameters;
+}
+
+/**
+ * Rewards Parameters defines the parameters that are used to calculate Mana rewards.
+ */
+export interface RewardsParameters {
+    /**
+     * The number of validation blocks that should be issued by a selected validator
+     * per slot during its epoch duties.
+     */
+    validationBlocksPerSlot: number;
+    /**
+     * Profit Margin Exponent is used for shift operation for calculation of profit margin.
+     */
+    profitMarginExponent: number;
+    /**
+     * The length in epochs of the bootstrapping phase.
+     */
+    bootstrappingDuration: number;
+    /**
+     * Mana Share Coefficient is the coefficient used for calculation of initial rewards.
+     */
+    manaShareCoefficient: u64;
+    /**
+     * Decay Balancing Constant Exponent is the exponent used for calculation of the initial reward.
+     */
+    decayBalancingConstantExponent: number;
+    /**
+     * Decay Balancing Constant is an integer approximation calculated based on chosen Decay Balancing Constant Exponent.
+     */
+    decayBalancingConstant: u64;
+    /**
+     * Pool Coefficient Exponent is the exponent used for shifting operation
+     * in the pool rewards calculations.
+     */
+    poolCoefficientExponent: number;
 }
 
 /**

diff --git a/sdk/src/types/block/mana/rewards.rs b/sdk/src/types/block/mana/rewards.rs
@@ -16,7 +16,7 @@ use crate::types::block::{slot::EpochIndex, Error};
 #[getset(get_copy = "pub")]
 pub struct RewardsParameters {
     /// The number of validation blocks that should be issued by a selected validator per slot during its epoch duties.
-    validator_blocks_per_slot: u8,
+    validation_blocks_per_slot: u8,
     /// Used for shift operation during calculation of profit margin.
     profit_margin_exponent: u8,
     /// The length of the bootstrapping phase in epochs.
@@ -37,7 +37,7 @@ impl Default for RewardsParameters {
     fn default() -> Self {
         // TODO: use actual values
         Self {
-            validator_blocks_per_slot: Default::default(),
+            validation_blocks_per_slot: Default::default(),
             profit_margin_exponent: Default::default(),
             bootstrapping_duration: Default::default(),
             mana_share_coefficient: Default::default(),

diff --git a/sdk/tests/types/protocol.rs b/sdk/tests/types/protocol.rs
@@ -72,7 +72,7 @@
 //           "activationOffset":7
 //         },
 //         "rewardsParameters":{
-//           "validatorBlocksPerSlot":10,
+//           "validationBlocksPerSlot":10,
 //           "profitMarginExponent":8,
 //           "bootstrappingDuration":"1154",
 //           "manaShareCoefficient":"2",