1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
//! Rewards module.
use std::convert::{TryFrom, TryInto};

use num_traits::Zero;
use once_cell::sync::Lazy;
use thiserror::Error;

use crate::{
    context::Context,
    core::consensus::beacon,
    migration,
    module::{self, Module as _, Parameters as _},
    modules::{self, accounts::API as _, core::API as _},
    runtime::Runtime,
    sdk_derive,
    state::CurrentState,
    storage::{self, Store},
    types::address::{Address, SignatureAddressSpec},
};

#[cfg(test)]
mod test;
pub mod types;

/// Unique module name.
const MODULE_NAME: &str = "rewards";

/// Errors emitted by the rewards module.
#[derive(Error, Debug, oasis_runtime_sdk_macros::Error)]
pub enum Error {
    #[error("invalid argument")]
    #[sdk_error(code = 1)]
    InvalidArgument,
}

/// Parameters for the rewards module.
#[derive(Clone, Debug, Default, cbor::Encode, cbor::Decode)]
pub struct Parameters {
    pub schedule: types::RewardSchedule,

    pub participation_threshold_numerator: u64,
    pub participation_threshold_denominator: u64,
}

/// Errors emitted during rewards parameter validation.
#[derive(Error, Debug)]
pub enum ParameterValidationError {
    #[error("invalid participation threshold (numerator > denominator)")]
    InvalidParticipationThreshold,

    #[error("invalid schedule")]
    InvalidSchedule(#[from] types::RewardScheduleError),
}

impl module::Parameters for Parameters {
    type Error = ParameterValidationError;

    fn validate_basic(&self) -> Result<(), Self::Error> {
        self.schedule.validate_basic()?;

        if self.participation_threshold_numerator > self.participation_threshold_denominator {
            return Err(ParameterValidationError::InvalidParticipationThreshold);
        }
        if self.participation_threshold_denominator.is_zero() {
            return Err(ParameterValidationError::InvalidParticipationThreshold);
        }

        Ok(())
    }
}

/// Genesis state for the rewards module.
#[derive(Clone, Debug, Default, cbor::Encode, cbor::Decode)]
pub struct Genesis {
    pub parameters: Parameters,
}

/// State schema constants.
pub mod state {
    // 0x01 is reserved.

    /// Map of epochs to rewards pending distribution.
    pub const REWARDS: &[u8] = &[0x02];
}

/// Rewards module.
pub struct Module;

/// Module's address that has the reward pool.
///
/// oasis1qp7x0q9qahahhjas0xde8w0v04ctp4pqzu5mhjav
pub static ADDRESS_REWARD_POOL: Lazy<Address> =
    Lazy::new(|| Address::from_module(MODULE_NAME, "reward-pool"));

#[sdk_derive(Module)]
impl Module {
    const NAME: &'static str = MODULE_NAME;
    const VERSION: u32 = 2;
    type Error = Error;
    type Event = ();
    type Parameters = Parameters;
    type Genesis = Genesis;

    #[migration(init)]
    fn init(genesis: Genesis) {
        genesis
            .parameters
            .validate_basic()
            .expect("invalid genesis parameters");

        // Set genesis parameters.
        Self::set_params(genesis.parameters);
    }

    #[migration(from = 1)]
    fn migrate_v1_to_v2() {
        CurrentState::with_store(|store| {
            // Version 2 removes the LAST_EPOCH storage state which was at 0x01.
            let mut store = storage::PrefixStore::new(store, &MODULE_NAME);
            store.remove(&[0x01]);
        });
    }
}

impl module::TransactionHandler for Module {}

impl module::BlockHandler for Module {
    fn end_block<C: Context>(ctx: &C) {
        let epoch = ctx.epoch();

        // Load rewards accumulator for the current epoch.
        let mut rewards: types::EpochRewards = CurrentState::with_store(|store| {
            let store = storage::PrefixStore::new(store, &MODULE_NAME);
            let epochs =
                storage::TypedStore::new(storage::PrefixStore::new(store, &state::REWARDS));
            epochs.get(epoch.to_storage_key()).unwrap_or_default()
        });

        // Reward each good entity.
        for entity_id in &ctx.runtime_round_results().good_compute_entities {
            let address = Address::from_sigspec(&SignatureAddressSpec::Ed25519(entity_id.into()));
            rewards.pending.entry(address).or_default().increment();
        }

        // Punish each bad entity by forbidding rewards for this epoch.
        for entity_id in &ctx.runtime_round_results().bad_compute_entities {
            let address = Address::from_sigspec(&SignatureAddressSpec::Ed25519(entity_id.into()));
            rewards.pending.entry(address).or_default().forbid();
        }

        // Disburse any rewards for previous epochs when the epoch changes.
        if <C::Runtime as Runtime>::Core::has_epoch_changed() {
            let epoch_rewards = CurrentState::with_store(|store| {
                let store = storage::PrefixStore::new(store, &MODULE_NAME);
                let mut epochs =
                    storage::TypedStore::new(storage::PrefixStore::new(store, &state::REWARDS));
                let epoch_rewards: Vec<(DecodableEpochTime, types::EpochRewards)> =
                    epochs.iter().collect();

                // Remove all epochs that we will process.
                for (epoch, _) in &epoch_rewards {
                    epochs.remove(epoch.0.to_storage_key());
                }

                epoch_rewards
            });

            // Process accumulated rewards for previous epochs.
            let params = Self::params();
            'epochs: for (epoch, rewards) in epoch_rewards {
                let epoch = epoch.0;

                // Fetch reward schedule for the given epoch.
                let reward = params.schedule.for_epoch(epoch);
                if reward.amount().is_zero() {
                    continue;
                }

                // Disburse rewards.
                for address in rewards.for_disbursement(
                    params.participation_threshold_numerator,
                    params.participation_threshold_denominator,
                ) {
                    match <C::Runtime as Runtime>::Accounts::transfer(
                        *ADDRESS_REWARD_POOL,
                        address,
                        &reward,
                    ) {
                        Ok(_) => {}
                        Err(modules::accounts::Error::InsufficientBalance) => {
                            // Since rewards are the same for the whole epoch, if there is not
                            // enough in the pool, just continue with the next epoch which may
                            // specify a lower amount or a different denomination.
                            continue 'epochs;
                        }
                        Err(err) => panic!("failed to disburse rewards: {err:?}"),
                    }
                }
            }
        }

        // Update rewards for current epoch.
        CurrentState::with_store(|store| {
            let store = storage::PrefixStore::new(store, &MODULE_NAME);
            let mut epochs =
                storage::TypedStore::new(storage::PrefixStore::new(store, &state::REWARDS));
            epochs.insert(epoch.to_storage_key(), rewards);
        });
    }
}

impl module::InvariantHandler for Module {}

/// A trait that exists solely to convert `beacon::EpochTime` to bytes for use as a storage key.
trait ToStorageKey {
    fn to_storage_key(&self) -> [u8; 8];
}

impl ToStorageKey for beacon::EpochTime {
    fn to_storage_key(&self) -> [u8; 8] {
        self.to_be_bytes()
    }
}

/// A struct that exists solely to decode `beacon::EpochTime` previously encoded via `ToStorageKey`.
struct DecodableEpochTime(beacon::EpochTime);

impl TryFrom<&[u8]> for DecodableEpochTime {
    type Error = std::array::TryFromSliceError;

    fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
        Ok(DecodableEpochTime(beacon::EpochTime::from_be_bytes(
            value.try_into()?,
        )))
    }
}