proto(stake): add doc to RateData.validator_exchange_rate (#4134)

penumbra-zone · Mar 28, 2024 · 3155af1 · 3155af1
1 parent cba996f
commit 3155af1
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/crates/proto/src/gen/penumbra.core.component.stake.v1.rs b/crates/proto/src/gen/penumbra.core.component.stake.v1.rs
@@ -150,6 +150,10 @@ pub struct RateData {
     pub validator_reward_rate: ::core::option::Option<
         super::super::super::num::v1::Amount,
     >,
+    /// The validator exchange rate between delegation tokens and staking tokens.
+    /// The rate is expressed in fixed-point representation with a scaling factor
+    /// of 10^8. For example, a decimal rate of `1.234` will be represented as
+    /// `123400000`
     #[prost(message, optional, tag = "5")]
     pub validator_exchange_rate: ::core::option::Option<
         super::super::super::num::v1::Amount,

diff --git a/crates/proto/src/gen/proto_descriptor.bin.no_lfs b/crates/proto/src/gen/proto_descriptor.bin.no_lfs
diff --git a/proto/penumbra/penumbra/core/component/stake/v1/stake.proto b/proto/penumbra/penumbra/core/component/stake/v1/stake.proto
@@ -70,6 +70,10 @@ message RateData {
   keys.v1.IdentityKey identity_key = 1;
   uint64 epoch_index = 2 [deprecated = true];
   num.v1.Amount validator_reward_rate = 4;
+  // The validator exchange rate between delegation tokens and staking tokens.
+  // The rate is expressed in fixed-point representation with a scaling factor
+  // of 10^8. For example, a decimal rate of `1.234` will be represented as
+  // `123400000`
   num.v1.Amount validator_exchange_rate = 5;
 }