ic_query/sns/report/model/reports/neurons/
reward.rs

1//! Module: sns::report::model::reports::neurons::reward
2//!
3//! Responsibility: SNS reward-event and API-exhausted maturity checkpoint DTOs.
4//! Does not own: live Governance calls, strict pagination, or filesystem loading.
5//! Boundary: retains raw bracketing evidence, variable neuron evidence, and recomputed summaries.
6
7use super::{
8    SnsMaturityDisbursementRow, SnsNeuronPermissionRow,
9    detail::{
10        SnsPolicyObservationStatus, neuron_policy_observations, permission_code_is_assessable,
11        permission_code_policy_observations, validate_canonical_principal,
12        validate_maturity_disbursements, validate_neuron_permissions,
13    },
14};
15use crate::{
16    hex::is_lowercase_hex_32_bytes,
17    report::ReportDataSource,
18    sns::report::{
19        MAINNET_SNS_WASM_CANISTER_ID, SNS_REWARD_CHECKPOINT_MAX_NEURONS,
20        SNS_REWARD_CHECKPOINT_PAGE_SIZE, SNS_REWARD_CHECKPOINT_REPORT_SCHEMA_VERSION,
21        model::reports::{SnsGovernanceParameters, SnsRunningVersionResponse},
22    },
23    subnet_catalog::MAINNET_NETWORK,
24};
25use ic_host_text::timestamp::format_utc_timestamp_secs;
26use ic_platform::candid::contract::{CandidType, serde::Deserialize};
27use serde::Serialize;
28use std::collections::HashSet;
29use thiserror::Error as ThisError;
30
31///
32/// SnsRewardProposalId
33///
34/// Native proposal identifier retained in one Governance reward event.
35///
36
37#[derive(Clone, Debug, Eq, PartialEq, CandidType, Deserialize, Serialize)]
38#[candid_path("ic_platform::candid::contract")]
39#[serde(deny_unknown_fields)]
40pub struct SnsRewardProposalId {
41    /// Native SNS Governance proposal identifier.
42    pub id: u64,
43}
44
45///
46/// SnsRewardEvent
47///
48/// Complete native SNS Governance reward-event response.
49///
50
51#[derive(Clone, Debug, Eq, PartialEq, CandidType, Deserialize, Serialize)]
52#[candid_path("ic_platform::candid::contract")]
53#[serde(deny_unknown_fields)]
54pub struct SnsRewardEvent {
55    /// Number of reward rounds represented by this event when supplied.
56    pub rounds_since_last_distribution: Option<u64>,
57    /// Native timestamp at which distribution actually ran.
58    pub actual_timestamp_seconds: u64,
59    /// Canonical reward-event position when supplied.
60    pub end_timestamp_seconds: Option<u64>,
61    /// Total maturity available for distribution when supplied.
62    pub total_available_e8s_equivalent: Option<u64>,
63    /// Exact maturity amount distributed by this event.
64    pub distributed_e8s_equivalent: u64,
65    /// Deprecated native reward round retained as continuity evidence.
66    pub round: u64,
67    /// Complete settled-proposal identifiers retained from Governance.
68    pub settled_proposals: Vec<SnsRewardProposalId>,
69}
70
71///
72/// SnsRewardCollectionStatus
73///
74/// Authority level of one completed SNS reward checkpoint collection.
75///
76
77#[derive(Clone, Copy, Debug, Eq, PartialEq, Deserialize, Serialize)]
78#[serde(rename_all = "snake_case")]
79pub enum SnsRewardCollectionStatus {
80    /// The native neuron API was exhausted with stable bracket responses.
81    ApiExhaustedObserved,
82}
83
84impl SnsRewardCollectionStatus {
85    /// Return the stable report label for this collection status.
86    #[must_use]
87    pub const fn as_str(self) -> &'static str {
88        match self {
89            Self::ApiExhaustedObserved => "api_exhausted_observed",
90        }
91    }
92}
93
94///
95/// SnsRewardCheckpointRow
96///
97/// Variable-size maturity and permission evidence for one observed SNS neuron.
98///
99
100#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
101#[serde(deny_unknown_fields)]
102pub struct SnsRewardCheckpointRow {
103    /// Exact 32-byte neuron identifier as lowercase hexadecimal text.
104    pub neuron_id: String,
105    /// Unix timestamp at which Governance reports the neuron was created.
106    pub created_timestamp_seconds: u64,
107    /// Raw unstaked maturity in e8s-equivalent units.
108    pub maturity_e8s_equivalent: u64,
109    /// Raw staked maturity in e8s-equivalent units when present.
110    pub staked_maturity_e8s_equivalent: Option<u64>,
111    /// Checked sum of unstaked and staked maturity.
112    pub combined_maturity_e8s_equivalent: u64,
113    /// Native automatic maturity-staking state when supplied.
114    pub auto_stake_maturity: Option<bool>,
115    /// Every current principal permission entry returned by Governance.
116    pub permissions: Vec<SnsNeuronPermissionRow>,
117    /// Every pending maturity disbursement returned by Governance.
118    pub disburse_maturity_in_progress: Vec<SnsMaturityDisbursementRow>,
119    /// Neuron-local observation for permissions 7 and 8 plus pending disbursements.
120    pub maturity_mint_conversion_observed_disabled: SnsPolicyObservationStatus,
121    /// Neuron-local observation for manual maturity-staking permission 9.
122    pub manual_maturity_staking_observed_disabled: SnsPolicyObservationStatus,
123}
124
125impl SnsRewardCheckpointRow {
126    /// Recompute combined maturity from the two raw maturity components.
127    #[must_use]
128    pub fn checked_combined_maturity(&self) -> Option<u64> {
129        self.maturity_e8s_equivalent
130            .checked_add(self.staked_maturity_e8s_equivalent.unwrap_or(0))
131    }
132
133    /// Recompute both row-local maturity policy observations from raw evidence.
134    #[must_use]
135    pub fn derived_policy_observations(
136        &self,
137    ) -> (SnsPolicyObservationStatus, SnsPolicyObservationStatus) {
138        neuron_policy_observations(
139            &self.permissions,
140            !self.disburse_maturity_in_progress.is_empty(),
141        )
142    }
143}
144
145///
146/// SnsRewardCheckpointReport
147///
148/// Versioned API-exhausted observed SNS maturity checkpoint.
149///
150
151#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
152#[serde(deny_unknown_fields)]
153pub struct SnsRewardCheckpointReport {
154    /// Report schema version.
155    pub schema_version: u32,
156    /// Requested IC network identity.
157    pub network: String,
158    /// Stable mainnet SNS-W discovery canister identity.
159    pub sns_wasm_canister_id: String,
160    /// Explicit IC API endpoint used for every live call.
161    pub source_endpoint: String,
162    /// Collector identity recorded in report provenance.
163    pub fetched_by: String,
164    /// Current SNS-W list position retained only as display metadata.
165    pub id: usize,
166    /// Current SNS name retained only as display metadata.
167    pub name: String,
168    /// Stable SNS Root canister identity.
169    pub root_canister_id: String,
170    /// Stable SNS Governance canister identity.
171    pub governance_canister_id: String,
172    /// Stable SNS ledger canister identity.
173    pub ledger_canister_id: String,
174    /// Stable SNS decentralization-swap canister identity.
175    pub swap_canister_id: String,
176    /// Stable SNS ledger-index canister identity.
177    pub index_canister_id: String,
178    /// Explicit source classification; checkpoint reports are live-only.
179    pub data_source: ReportDataSource,
180    /// Unix timestamp captured immediately before targeted discovery.
181    pub collection_started_at_unix_secs: u64,
182    /// UTC rendering of `collection_started_at_unix_secs`.
183    pub collection_started_at: String,
184    /// Unix timestamp captured after the final running-version bracket.
185    pub collection_completed_at_unix_secs: u64,
186    /// UTC rendering of `collection_completed_at_unix_secs`.
187    pub collection_completed_at: String,
188    /// Fixed native page size used for every Governance neuron query.
189    pub page_size: u32,
190    /// Number of neuron pages fetched, including the final exhaustion page.
191    pub page_count: u32,
192    /// Number of neuron rows retained.
193    pub row_count: usize,
194    /// Recomputed number of unique full neuron identifiers.
195    pub unique_neuron_id_count: usize,
196    /// Mandatory row ceiling derived from Governance parameters.
197    pub collection_row_ceiling: u64,
198    /// Total targeted-discovery, bracket, and neuron-page client queries.
199    pub client_query_count: u32,
200    /// Explicit authority classification for the completed collection.
201    pub collection_status: SnsRewardCollectionStatus,
202    /// Always false because Governance exposes no point-in-time neuron snapshot version.
203    pub point_in_time_guaranteed: bool,
204    /// Complete nervous-system parameters read before neuron pagination.
205    pub parameters_before: SnsGovernanceParameters,
206    /// Complete nervous-system parameters read after neuron pagination.
207    pub parameters_after: SnsGovernanceParameters,
208    /// Complete reward event read before neuron pagination.
209    pub reward_event_before: SnsRewardEvent,
210    /// Complete reward event read after neuron pagination.
211    pub reward_event_after: SnsRewardEvent,
212    /// Complete running-version response read before neuron pagination.
213    pub running_version_before: SnsRunningVersionResponse,
214    /// Complete running-version response read after neuron pagination.
215    pub running_version_after: SnsRunningVersionResponse,
216    /// Checked aggregate unstaked maturity across every row.
217    pub aggregate_maturity_e8s_equivalent: u64,
218    /// Checked aggregate staked maturity across every row.
219    pub aggregate_staked_maturity_e8s_equivalent: u64,
220    /// Checked aggregate combined maturity across every row.
221    pub aggregate_combined_maturity_e8s_equivalent: u64,
222    /// Number of principal permission entries observed across every row.
223    pub permission_entry_count: usize,
224    /// Number of raw unknown or anomalous permission codes observed globally and per-neuron.
225    pub unassessable_permission_code_count: usize,
226    /// Number of pending maturity disbursements observed across every row.
227    pub pending_maturity_disbursement_count: usize,
228    /// Number of neurons with automatic maturity staking enabled.
229    pub auto_stake_maturity_enabled_count: usize,
230    /// Number of neurons with automatic maturity staking explicitly disabled.
231    pub auto_stake_maturity_disabled_count: usize,
232    /// Number of neurons without an automatic maturity-staking value.
233    pub auto_stake_maturity_unspecified_count: usize,
234    /// Whether permission 2 is currently grantable, or unknown when the list is missing.
235    pub manage_principals_grantable: Option<bool>,
236    /// Global observation for disabling permissions 7 and 8 and pending disbursements.
237    pub maturity_mint_conversion_observed_disabled: SnsPolicyObservationStatus,
238    /// Global observation for disabling manual maturity-staking permission 9.
239    pub manual_maturity_staking_observed_disabled: SnsPolicyObservationStatus,
240    /// Combined observed maturity-conversion policy status.
241    pub maturity_conversion_policy_observed_status: SnsPolicyObservationStatus,
242    /// Strictly increasing full neuron rows retained as raw checkpoint evidence.
243    pub rows: Vec<SnsRewardCheckpointRow>,
244}
245
246///
247/// SnsRewardCheckpointValidationError
248///
249/// Pure validation failure for untrusted serialized or in-memory checkpoint evidence.
250///
251
252#[derive(Debug, Eq, PartialEq, ThisError)]
253#[error("invalid SNS reward checkpoint: {reason}")]
254pub struct SnsRewardCheckpointValidationError {
255    /// Deterministic invariant failure.
256    pub reason: String,
257}
258
259/// Recompute and validate every checkpoint invariant available without live host calls.
260pub fn validate_sns_reward_checkpoint_report(
261    report: &SnsRewardCheckpointReport,
262) -> Result<(), SnsRewardCheckpointValidationError> {
263    validate_checkpoint_evidence(report)?;
264    assess_checkpoint_summary(report).0
265}
266
267/// Retain recomputed evidence even when checkpoint validation fails during reconciliation.
268pub(in crate::sns::report) fn assess_reward_checkpoint(
269    report: &SnsRewardCheckpointReport,
270) -> (
271    Result<(), SnsRewardCheckpointValidationError>,
272    Option<SnsRewardCheckpointSummary>,
273) {
274    let evidence = validate_checkpoint_evidence(report);
275    let (summary_validation, summary) = assess_checkpoint_summary(report);
276    (evidence.and(summary_validation), summary)
277}
278
279fn assess_checkpoint_summary(
280    report: &SnsRewardCheckpointReport,
281) -> (
282    Result<(), SnsRewardCheckpointValidationError>,
283    Option<SnsRewardCheckpointSummary>,
284) {
285    match recompute_reward_checkpoint_summary(&report.parameters_before, &report.rows) {
286        Ok(summary) => (validate_checkpoint_summary(report, &summary), Some(summary)),
287        Err(reason) => (Err(invalid_validation(reason)), None),
288    }
289}
290
291impl SnsRewardCheckpointReport {
292    /// Validate an internally assembled checkpoint using its already recomputed summary.
293    #[cfg(feature = "sns-host")]
294    pub(in crate::sns::report) fn validate_collected_summary(
295        &self,
296        summary: &SnsRewardCheckpointSummary,
297    ) -> Result<(), SnsRewardCheckpointValidationError> {
298        validate_checkpoint_evidence(self)?;
299        validate_checkpoint_summary(self, summary)
300    }
301}
302
303fn validate_checkpoint_evidence(
304    report: &SnsRewardCheckpointReport,
305) -> Result<(), SnsRewardCheckpointValidationError> {
306    validate_checkpoint_header(report)?;
307    validate_checkpoint_brackets(report)?;
308    validate_checkpoint_rows(&report.rows, report.collection_completed_at_unix_secs)
309}
310
311fn validate_checkpoint_header(
312    report: &SnsRewardCheckpointReport,
313) -> Result<(), SnsRewardCheckpointValidationError> {
314    if report.schema_version != SNS_REWARD_CHECKPOINT_REPORT_SCHEMA_VERSION {
315        return Err(invalid_validation(format!(
316            "schema version {} does not equal {}",
317            report.schema_version, SNS_REWARD_CHECKPOINT_REPORT_SCHEMA_VERSION
318        )));
319    }
320    for (field, principal) in [
321        ("sns_wasm_canister_id", report.sns_wasm_canister_id.as_str()),
322        ("root_canister_id", report.root_canister_id.as_str()),
323        (
324            "governance_canister_id",
325            report.governance_canister_id.as_str(),
326        ),
327        ("ledger_canister_id", report.ledger_canister_id.as_str()),
328        ("swap_canister_id", report.swap_canister_id.as_str()),
329        ("index_canister_id", report.index_canister_id.as_str()),
330    ] {
331        validate_canonical_principal(principal, field).map_err(invalid_validation)?;
332    }
333    let canister_ids = [
334        report.sns_wasm_canister_id.as_str(),
335        report.root_canister_id.as_str(),
336        report.governance_canister_id.as_str(),
337        report.ledger_canister_id.as_str(),
338        report.swap_canister_id.as_str(),
339        report.index_canister_id.as_str(),
340    ];
341    if canister_ids.into_iter().collect::<HashSet<_>>().len() != canister_ids.len() {
342        return Err(invalid_validation(
343            "checkpoint canister roles do not contain unique principals",
344        ));
345    }
346    if report.sns_wasm_canister_id != MAINNET_SNS_WASM_CANISTER_ID {
347        return Err(invalid_validation("unexpected SNS-W canister identity"));
348    }
349    if report.network != MAINNET_NETWORK {
350        return Err(invalid_validation("checkpoint network must be ic"));
351    }
352    if report.source_endpoint.is_empty() || report.fetched_by.is_empty() {
353        return Err(invalid_validation(
354            "checkpoint source_endpoint and fetched_by must be non-empty",
355        ));
356    }
357    if report.id == 0 || report.name.is_empty() {
358        return Err(invalid_validation(
359            "checkpoint SNS list id and display name must be non-empty",
360        ));
361    }
362    if report.data_source != ReportDataSource::Live {
363        return Err(invalid_validation("checkpoint data_source must be live"));
364    }
365    if report.collection_status != SnsRewardCollectionStatus::ApiExhaustedObserved {
366        return Err(invalid_validation(
367            "checkpoint collection is not API-exhausted",
368        ));
369    }
370    if report.point_in_time_guaranteed {
371        return Err(invalid_validation(
372            "checkpoint cannot claim a point-in-time neuron snapshot",
373        ));
374    }
375    validate_checkpoint_collection_metadata(report)
376}
377
378fn validate_checkpoint_collection_metadata(
379    report: &SnsRewardCheckpointReport,
380) -> Result<(), SnsRewardCheckpointValidationError> {
381    if report.collection_completed_at_unix_secs < report.collection_started_at_unix_secs {
382        return Err(invalid_validation(
383            "collection completion precedes collection start",
384        ));
385    }
386    if report.collection_started_at
387        != format_utc_timestamp_secs(report.collection_started_at_unix_secs)
388        || report.collection_completed_at
389            != format_utc_timestamp_secs(report.collection_completed_at_unix_secs)
390    {
391        return Err(invalid_validation(
392            "collection UTC timestamps do not match raw Unix timestamps",
393        ));
394    }
395    if report.page_size != SNS_REWARD_CHECKPOINT_PAGE_SIZE || report.page_count == 0 {
396        return Err(invalid_validation(
397            "checkpoint must contain at least one fixed-size-100 page",
398        ));
399    }
400    let expected_query_count = report
401        .page_count
402        .checked_add(8)
403        .ok_or_else(|| invalid_validation("page_count + 8 exceeds the native u32 contract"))?;
404    if report.client_query_count != expected_query_count {
405        return Err(invalid_validation(
406            "client_query_count does not equal page_count + 8",
407        ));
408    }
409    if report.row_count != report.rows.len() || report.unique_neuron_id_count != report.rows.len() {
410        return Err(invalid_validation(
411            "serialized row counts do not match raw checkpoint rows",
412        ));
413    }
414    let max_neurons = report.parameters_before.max_number_of_neurons;
415    if max_neurons != Some(report.collection_row_ceiling)
416        || !(1..=SNS_REWARD_CHECKPOINT_MAX_NEURONS).contains(&report.collection_row_ceiling)
417    {
418        return Err(invalid_validation(
419            "collection_row_ceiling does not match a valid max_number_of_neurons",
420        ));
421    }
422    if u64::try_from(report.rows.len())
423        .ok()
424        .is_none_or(|rows| rows > report.collection_row_ceiling)
425    {
426        return Err(invalid_validation(
427            "raw row count exceeds the mandatory collection ceiling",
428        ));
429    }
430    Ok(())
431}
432
433fn validate_checkpoint_brackets(
434    report: &SnsRewardCheckpointReport,
435) -> Result<(), SnsRewardCheckpointValidationError> {
436    if report.parameters_before != report.parameters_after {
437        return Err(invalid_validation(
438            "nervous-system parameter brackets differ",
439        ));
440    }
441    if report.reward_event_before != report.reward_event_after {
442        return Err(invalid_validation("reward-event brackets differ"));
443    }
444    if report.running_version_before != report.running_version_after {
445        return Err(invalid_validation("running-version brackets differ"));
446    }
447    validate_sns_reward_event_evidence(&report.reward_event_after).map_err(invalid_validation)?;
448    validate_reward_event_position(report)?;
449    validate_sns_reward_running_version_evidence(&report.running_version_after)
450        .map_err(invalid_validation)?;
451    validate_sns_reward_checkpoint_parameter_evidence(&report.parameters_after)
452        .map_err(invalid_validation)
453}
454
455fn validate_reward_event_position(
456    report: &SnsRewardCheckpointReport,
457) -> Result<(), SnsRewardCheckpointValidationError> {
458    let event = &report.reward_event_after;
459    if event.actual_timestamp_seconds > report.collection_completed_at_unix_secs
460        || event
461            .end_timestamp_seconds
462            .is_none_or(|end| end > report.collection_completed_at_unix_secs)
463    {
464        return Err(invalid_validation(
465            "reward event timestamps exceed checkpoint collection completion",
466        ));
467    }
468    Ok(())
469}
470
471fn validate_checkpoint_rows(
472    rows: &[SnsRewardCheckpointRow],
473    collection_completed_at_unix_secs: u64,
474) -> Result<(), SnsRewardCheckpointValidationError> {
475    let mut previous_id: Option<&str> = None;
476    for row in rows {
477        if !is_lowercase_hex_32_bytes(&row.neuron_id) {
478            return Err(invalid_validation(format!(
479                "neuron id {} is not 32-byte lowercase hexadecimal text",
480                row.neuron_id
481            )));
482        }
483        if previous_id.is_some_and(|previous| previous >= row.neuron_id.as_str()) {
484            return Err(invalid_validation(
485                "checkpoint neuron ids are not strictly increasing",
486            ));
487        }
488        previous_id = Some(&row.neuron_id);
489        if row.created_timestamp_seconds > collection_completed_at_unix_secs {
490            return Err(invalid_validation(format!(
491                "neuron {} creation timestamp exceeds collection completion",
492                row.neuron_id
493            )));
494        }
495        validate_neuron_permissions(&row.permissions, false)
496            .map_err(|reason| invalid_validation(format!("neuron {}: {reason}", row.neuron_id)))?;
497        validate_maturity_disbursements(&row.disburse_maturity_in_progress)
498            .map_err(invalid_validation)?;
499    }
500    Ok(())
501}
502
503fn validate_checkpoint_summary(
504    report: &SnsRewardCheckpointReport,
505    summary: &SnsRewardCheckpointSummary,
506) -> Result<(), SnsRewardCheckpointValidationError> {
507    let valid = report.aggregate_maturity_e8s_equivalent
508        == summary.aggregate_maturity_e8s_equivalent
509        && report.aggregate_staked_maturity_e8s_equivalent
510            == summary.aggregate_staked_maturity_e8s_equivalent
511        && report.aggregate_combined_maturity_e8s_equivalent
512            == summary.aggregate_combined_maturity_e8s_equivalent
513        && report.permission_entry_count == summary.permission_entry_count
514        && report.unassessable_permission_code_count == summary.unassessable_permission_code_count
515        && report.pending_maturity_disbursement_count
516            == summary.pending_maturity_disbursement_count
517        && report.auto_stake_maturity_enabled_count == summary.auto_stake_maturity_enabled_count
518        && report.auto_stake_maturity_disabled_count == summary.auto_stake_maturity_disabled_count
519        && report.auto_stake_maturity_unspecified_count
520            == summary.auto_stake_maturity_unspecified_count
521        && report.manage_principals_grantable == summary.manage_principals_grantable
522        && report.maturity_mint_conversion_observed_disabled
523            == summary.maturity_mint_conversion_observed_disabled
524        && report.manual_maturity_staking_observed_disabled
525            == summary.manual_maturity_staking_observed_disabled
526        && report.maturity_conversion_policy_observed_status
527            == summary.maturity_conversion_policy_observed_status;
528    if valid {
529        Ok(())
530    } else {
531        Err(invalid_validation(
532            "serialized checkpoint summary does not match raw evidence",
533        ))
534    }
535}
536
537pub(in crate::sns::report) fn validate_sns_reward_running_version_evidence(
538    response: &SnsRunningVersionResponse,
539) -> Result<(), String> {
540    let deployed = response
541        .deployed_version
542        .as_ref()
543        .ok_or_else(|| "running version has no deployed_version".to_string())?;
544    deployed.validate_hashes("deployed_version", Some(32))?;
545    if let Some(target) = response
546        .pending_version
547        .as_ref()
548        .and_then(|pending| pending.target_version.as_ref())
549    {
550        target.validate_hashes("pending_version.target_version", Some(32))?;
551    }
552    Ok(())
553}
554
555pub(in crate::sns::report) fn validate_sns_reward_checkpoint_parameter_evidence(
556    parameters: &SnsGovernanceParameters,
557) -> Result<(), String> {
558    validate_default_followees(parameters)?;
559    validate_parameter_permissions(parameters)
560}
561
562fn validate_default_followees(parameters: &SnsGovernanceParameters) -> Result<(), String> {
563    let Some(defaults) = parameters.default_followees.as_ref() else {
564        return Ok(());
565    };
566    let mut function_ids = HashSet::new();
567    for row in &defaults.followees {
568        if !function_ids.insert(row.function_id) {
569            return Err("default followees contain a duplicate function id".to_string());
570        }
571        let mut neuron_ids = HashSet::new();
572        for id in &row.followee_neuron_ids {
573            if !is_lowercase_hex_32_bytes(id) {
574                return Err("default followees contain a non-canonical neuron id".to_string());
575            }
576            if !neuron_ids.insert(id) {
577                return Err("default followees contain a duplicate neuron id".to_string());
578            }
579        }
580    }
581    Ok(())
582}
583
584fn validate_parameter_permissions(parameters: &SnsGovernanceParameters) -> Result<(), String> {
585    for (field, permissions) in [
586        (
587            "neuron_claimer_permissions",
588            parameters.neuron_claimer_permissions.as_ref(),
589        ),
590        (
591            "neuron_grantable_permissions",
592            parameters.neuron_grantable_permissions.as_ref(),
593        ),
594    ] {
595        let Some(permissions) = permissions else {
596            continue;
597        };
598        let mut codes = HashSet::new();
599        if permissions
600            .permissions
601            .iter()
602            .any(|code| !codes.insert(*code))
603        {
604            return Err(format!("{field} contains a duplicate permission code"));
605        }
606    }
607    Ok(())
608}
609
610pub(in crate::sns::report) fn validate_sns_reward_event_evidence(
611    event: &SnsRewardEvent,
612) -> Result<(), String> {
613    if event.end_timestamp_seconds.is_none() {
614        return Err("reward event is missing canonical end_timestamp_seconds".to_string());
615    }
616    let mut proposal_ids = HashSet::new();
617    if event
618        .settled_proposals
619        .iter()
620        .any(|proposal| !proposal_ids.insert(proposal.id))
621    {
622        return Err("reward event contains duplicate settled proposal ids".to_string());
623    }
624    Ok(())
625}
626
627fn invalid_validation(reason: impl Into<String>) -> SnsRewardCheckpointValidationError {
628    SnsRewardCheckpointValidationError {
629        reason: reason.into(),
630    }
631}
632
633///
634/// SnsRewardCheckpointSummary
635///
636/// Pure recomputation result derived from raw checkpoint parameters and rows.
637///
638
639#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
640#[serde(deny_unknown_fields)]
641pub struct SnsRewardCheckpointSummary {
642    /// Checked aggregate unstaked maturity across every row.
643    pub aggregate_maturity_e8s_equivalent: u64,
644    /// Checked aggregate staked maturity across every row.
645    pub aggregate_staked_maturity_e8s_equivalent: u64,
646    /// Checked aggregate combined maturity across every row.
647    pub aggregate_combined_maturity_e8s_equivalent: u64,
648    /// Number of principal permission entries observed across every row.
649    pub permission_entry_count: usize,
650    /// Number of raw unknown or anomalous permission codes observed globally and per-neuron.
651    pub unassessable_permission_code_count: usize,
652    /// Number of pending maturity disbursements observed across every row.
653    pub pending_maturity_disbursement_count: usize,
654    /// Number of neurons with automatic maturity staking enabled.
655    pub auto_stake_maturity_enabled_count: usize,
656    /// Number of neurons with automatic maturity staking explicitly disabled.
657    pub auto_stake_maturity_disabled_count: usize,
658    /// Number of neurons without an automatic maturity-staking value.
659    pub auto_stake_maturity_unspecified_count: usize,
660    /// Whether permission 2 is currently grantable, or unknown when the list is missing.
661    pub manage_principals_grantable: Option<bool>,
662    /// Global observation for disabling permissions 7 and 8 and pending disbursements.
663    pub maturity_mint_conversion_observed_disabled: SnsPolicyObservationStatus,
664    /// Global observation for disabling manual maturity-staking permission 9.
665    pub manual_maturity_staking_observed_disabled: SnsPolicyObservationStatus,
666    /// Combined observed maturity-conversion policy status.
667    pub maturity_conversion_policy_observed_status: SnsPolicyObservationStatus,
668}
669
670pub(in crate::sns::report) fn recompute_reward_checkpoint_summary(
671    parameters: &SnsGovernanceParameters,
672    rows: &[SnsRewardCheckpointRow],
673) -> Result<SnsRewardCheckpointSummary, String> {
674    let mut summary = SnsRewardCheckpointSummary {
675        aggregate_maturity_e8s_equivalent: 0,
676        aggregate_staked_maturity_e8s_equivalent: 0,
677        aggregate_combined_maturity_e8s_equivalent: 0,
678        permission_entry_count: 0,
679        unassessable_permission_code_count: 0,
680        pending_maturity_disbursement_count: 0,
681        auto_stake_maturity_enabled_count: 0,
682        auto_stake_maturity_disabled_count: 0,
683        auto_stake_maturity_unspecified_count: 0,
684        manage_principals_grantable: parameters
685            .neuron_grantable_permissions
686            .as_ref()
687            .map(|permissions| permissions.permissions.contains(&2)),
688        maturity_mint_conversion_observed_disabled: SnsPolicyObservationStatus::ObservedSatisfied,
689        manual_maturity_staking_observed_disabled: SnsPolicyObservationStatus::ObservedSatisfied,
690        maturity_conversion_policy_observed_status: SnsPolicyObservationStatus::ObservedSatisfied,
691    };
692    let (parameter_mint, parameter_staking, parameter_unknown_count) =
693        parameter_policy_observations(parameters);
694    summary.maturity_mint_conversion_observed_disabled = parameter_mint;
695    summary.manual_maturity_staking_observed_disabled = parameter_staking;
696    summary.unassessable_permission_code_count = parameter_unknown_count;
697
698    for row in rows {
699        accumulate_reward_row(&mut summary, row)?;
700    }
701    summary.maturity_conversion_policy_observed_status = summary
702        .maturity_mint_conversion_observed_disabled
703        .combine(summary.manual_maturity_staking_observed_disabled);
704    Ok(summary)
705}
706
707fn accumulate_reward_row(
708    summary: &mut SnsRewardCheckpointSummary,
709    row: &SnsRewardCheckpointRow,
710) -> Result<(), String> {
711    let combined = row.checked_combined_maturity().ok_or_else(|| {
712        format!(
713            "neuron {} combined maturity exceeds the native u64 contract",
714            row.neuron_id
715        )
716    })?;
717    if row.combined_maturity_e8s_equivalent != combined {
718        return Err(format!(
719            "neuron {} combined maturity does not match raw components",
720            row.neuron_id
721        ));
722    }
723    let (row_mint, row_staking) = row.derived_policy_observations();
724    if row.maturity_mint_conversion_observed_disabled != row_mint
725        || row.manual_maturity_staking_observed_disabled != row_staking
726    {
727        return Err(format!(
728            "neuron {} policy observations do not match raw evidence",
729            row.neuron_id
730        ));
731    }
732    summary.aggregate_maturity_e8s_equivalent = checked_sum(
733        summary.aggregate_maturity_e8s_equivalent,
734        row.maturity_e8s_equivalent,
735        "aggregate maturity",
736    )?;
737    summary.aggregate_staked_maturity_e8s_equivalent = checked_sum(
738        summary.aggregate_staked_maturity_e8s_equivalent,
739        row.staked_maturity_e8s_equivalent.unwrap_or(0),
740        "aggregate staked maturity",
741    )?;
742    summary.aggregate_combined_maturity_e8s_equivalent = checked_sum(
743        summary.aggregate_combined_maturity_e8s_equivalent,
744        combined,
745        "aggregate combined maturity",
746    )?;
747    accumulate_reward_row_counts(summary, row)?;
748    summary.maturity_mint_conversion_observed_disabled = summary
749        .maturity_mint_conversion_observed_disabled
750        .combine(row_mint);
751    summary.manual_maturity_staking_observed_disabled = summary
752        .manual_maturity_staking_observed_disabled
753        .combine(row_staking);
754    Ok(())
755}
756
757fn accumulate_reward_row_counts(
758    summary: &mut SnsRewardCheckpointSummary,
759    row: &SnsRewardCheckpointRow,
760) -> Result<(), String> {
761    summary.permission_entry_count = summary
762        .permission_entry_count
763        .checked_add(row.permissions.len())
764        .ok_or_else(|| "permission entry count overflow".to_string())?;
765    summary.pending_maturity_disbursement_count = summary
766        .pending_maturity_disbursement_count
767        .checked_add(row.disburse_maturity_in_progress.len())
768        .ok_or_else(|| "pending maturity disbursement count overflow".to_string())?;
769    summary.unassessable_permission_code_count = summary
770        .unassessable_permission_code_count
771        .checked_add(
772            row.permissions
773                .iter()
774                .flat_map(|permission| permission.permission_types.iter())
775                .filter(|value| !permission_code_is_assessable(value.code))
776                .count(),
777        )
778        .ok_or_else(|| "unassessable permission code count overflow".to_string())?;
779    match row.auto_stake_maturity {
780        Some(true) => increment(&mut summary.auto_stake_maturity_enabled_count)?,
781        Some(false) => increment(&mut summary.auto_stake_maturity_disabled_count)?,
782        None => increment(&mut summary.auto_stake_maturity_unspecified_count)?,
783    }
784    Ok(())
785}
786
787fn parameter_policy_observations(
788    parameters: &SnsGovernanceParameters,
789) -> (
790    SnsPolicyObservationStatus,
791    SnsPolicyObservationStatus,
792    usize,
793) {
794    let mut mint = SnsPolicyObservationStatus::ObservedSatisfied;
795    let mut staking = SnsPolicyObservationStatus::ObservedSatisfied;
796    let mut unknown_count = 0;
797    for permissions in [
798        parameters.neuron_claimer_permissions.as_ref(),
799        parameters.neuron_grantable_permissions.as_ref(),
800    ] {
801        let Some(permissions) = permissions else {
802            mint = mint.combine(SnsPolicyObservationStatus::Unassessable);
803            staking = staking.combine(SnsPolicyObservationStatus::Unassessable);
804            continue;
805        };
806        if permissions.permissions.is_empty() {
807            mint = mint.combine(SnsPolicyObservationStatus::Unassessable);
808            staking = staking.combine(SnsPolicyObservationStatus::Unassessable);
809        }
810        for code in &permissions.permissions {
811            let (code_mint, code_staking) = permission_code_policy_observations(*code);
812            mint = mint.combine(code_mint);
813            staking = staking.combine(code_staking);
814            if !permission_code_is_assessable(*code) {
815                unknown_count += 1;
816            }
817        }
818    }
819    (mint, staking, unknown_count)
820}
821
822fn checked_sum(left: u64, right: u64, field: &str) -> Result<u64, String> {
823    left.checked_add(right)
824        .ok_or_else(|| format!("{field} exceeds the native u64 contract"))
825}
826
827fn increment(value: &mut usize) -> Result<(), String> {
828    *value = value
829        .checked_add(1)
830        .ok_or_else(|| "checkpoint count overflow".to_string())?;
831    Ok(())
832}
ic_query/sns/report/model/reports/neurons/reward.rs

ic_query/sns/report/model/reports/neurons/
reward.rs
