penumbra_sdk_distributions/
component.rs

Help
1pub mod state_key;
2pub use view::{StateReadExt, StateWriteExt};
3
4mod view;
5
6use std::sync::Arc;
7
8use anyhow::{Context, Result};
9use async_trait::async_trait;
10use cnidarium::StateWrite;
11use cnidarium_component::Component;
12use penumbra_sdk_num::Amount;
13use tendermint::v0_37::abci;
14use tracing::instrument;
15
16use crate::genesis;
17
18pub struct Distributions {}
19
20#[async_trait]
21impl Component for Distributions {
22    type AppState = genesis::Content;
23
24    #[instrument(name = "distributions", skip(state, app_state))]
25    async fn init_chain<S: StateWrite>(mut state: S, app_state: Option<&Self::AppState>) {
26        match app_state {
27            None => { /* Checkpoint -- no-op */ }
28            Some(genesis) => {
29                state.put_distributions_params(genesis.distributions_params.clone());
30            }
31        };
32    }
33
34    #[instrument(name = "distributions", skip(_state, _begin_block))]
35    async fn begin_block<S: StateWrite + 'static>(
36        _state: &mut Arc<S>,
37        _begin_block: &abci::request::BeginBlock,
38    ) {
39    }
40
41    #[instrument(name = "distributions", skip(_state, _end_block))]
42    async fn end_block<S: StateWrite + 'static>(
43        _state: &mut Arc<S>,
44        _end_block: &abci::request::EndBlock,
45    ) {
46    }
47
48    #[instrument(name = "distributions", skip(state))]
49    async fn end_epoch<S: StateWrite + 'static>(state: &mut Arc<S>) -> Result<()> {
50        let state = Arc::get_mut(state).context("state should be unique")?;
51        let new_issuance = state.compute_new_issuance().await?;
52        tracing::debug!(?new_issuance, "computed new issuance for epoch");
53        Ok(state.distribute(new_issuance).await)
54    }
55}
56
57#[async_trait]
58trait DistributionManager: StateWriteExt {
59    /// Compute the total new issuance of staking tokens for this epoch.
60    async fn compute_new_issuance(&self) -> Result<Amount> {
61        use penumbra_sdk_sct::component::clock::EpochRead;
62
63        let current_block_height = self.get_block_height().await?;
64        let current_epoch = self.get_current_epoch().await?;
65        let num_blocks = current_block_height
66            .checked_sub(current_epoch.start_height)
67            .unwrap_or_else(|| panic!("epoch start height is less than or equal to current block height (epoch_start={}, current_height={}", current_epoch.start_height, current_block_height));
68
69        // TODO(erwan): Will make the distribution chain param an `Amount`
70        // in a subsequent PR. Want to avoid conflicts with other in-flight changes.
71        let staking_issuance_per_block = self
72            .get_distributions_params()
73            .await?
74            .staking_issuance_per_block as u128;
75
76        tracing::debug!(
77            number_of_blocks_in_epoch = num_blocks,
78            staking_issuance_per_block,
79            "calculating issuance per epoch"
80        );
81
82        let new_issuance_for_epoch = staking_issuance_per_block
83            .checked_mul(num_blocks as u128) /* Safe to cast a `u64` to `u128` */
84            .expect("infaillible unless issuance is pathological");
85
86        tracing::debug!(?new_issuance_for_epoch, "computed new issuance for epoch");
87
88        Ok(Amount::from(new_issuance_for_epoch))
89    }
90
91    /// Update the object store with the new issuance of staking tokens for this epoch.
92    async fn distribute(&mut self, new_issuance: Amount) {
93        self.set_staking_token_issuance_for_epoch(new_issuance)
94    }
95}
96
97impl<T: StateWrite + ?Sized> DistributionManager for T {}
penumbra_sdk_distributions/component.rs

penumbra_sdk_distributions/
component.rs
