ic-backup 0.5.0

Host-side snapshot backup and same-release recovery for Internet Computer canisters
Documentation 
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

//! Pure update acknowledgement association; never effect settlement or dispatch admission.

use crate::model::{
    attempt_journal::AttemptJournalRecord,
    fence_acquisition::{
        FenceAcquisitionAcknowledgement, FenceAcquisitionError, FenceAcquisitionRequest,
    },
};
use thiserror::Error;

/// Match a passive reply to the exact original still pending reservation.
///
/// This authenticates neither network/caller/reply nor whole-unit acquisition or
/// current fence custody. Success does not produce any mutation outcome, write a
/// receipt, invoke a provider, authorize retry or release obligations/references.
/// Actual integrations must separately qualify any direct effect settlement;
/// uncertain effects use the existing reserved reconciliation contract.
/// # Errors
/// Rejects changed/settled/recovering reservations, other authority or attempt.
pub fn validate_acknowledgement<'a>(
    request: &FenceAcquisitionRequest<'_>,
    journal: &AttemptJournalRecord,
    acknowledgement: &'a FenceAcquisitionAcknowledgement,
) -> Result<&'a FenceAcquisitionAcknowledgement, FenceAcquisitionAcknowledgementError> {
    request.validate_journal(journal)?;
    if acknowledgement.authority != request.authority().digest() {
        return Err(FenceAcquisitionAcknowledgementError::AuthorityMismatch);
    }
    if acknowledgement.mutation_attempt != request.mutation_attempt() {
        return Err(FenceAcquisitionAcknowledgementError::AttemptMismatch);
    }
    Ok(acknowledgement)
}

/// Typed passive association denial, without settlement or spending changes.
#[derive(Debug, Error)]
pub enum FenceAcquisitionAcknowledgementError {
    /// Current reservation does not match the original request.
    #[error(transparent)]
    Reservation(#[from] FenceAcquisitionError),
    /// Reply association names another full original authority.
    #[error("fence acquisition acknowledgement authority mismatch")]
    AuthorityMismatch,
    /// Reply association names another mutation attempt.
    #[error("fence acquisition acknowledgement attempt mismatch")]
    AttemptMismatch,
}

#[cfg(test)]
mod tests;