Skip to main content

ratify_protocol/v2/
stream_sequence.rs

1//! Stream sequence (SPEC-v2 §7.4). Mirrors Go `stream_sequence_v2.go`.
2//!
3//! Every rejection has the class `stream_sequence_mismatch`; the message
4//! distinguishes gap, duplicate and reorder for diagnostics only. A
5//! presentation that carries `stream_id` and `stream_seq` advances the state
6//! of the key (verifier_namespace, agent_id, stream_id) in the same atomic
7//! transaction as the challenge claim.
8
9use super::errors::{err, V2ErrorClass, V2Result};
10use super::wire::MAX_SAFE;
11
12/// Go `CheckV2StreamSequence`: the normative stream-sequence rule. `has_last`
13/// reports whether the stream key already has accepted state. `Ok` means the
14/// store must record `seq` as the new last value in the claim transaction.
15pub fn check_v2_stream_sequence(has_last: bool, last: i64, seq: i64) -> V2Result<()> {
16    if !(1..=MAX_SAFE).contains(&seq) || has_last && !(1..=MAX_SAFE).contains(&last) {
17        return err(V2ErrorClass::Malformed, "v2 stream sequence is outside 1..2^53-1");
18    }
19    let mut expected = 1i64;
20    if has_last {
21        if last == MAX_SAFE {
22            return err(V2ErrorClass::StreamSequenceMismatch, "v2 stream sequence is exhausted");
23        }
24        expected = last + 1;
25    }
26    if seq == expected {
27        Ok(())
28    } else if seq > expected {
29        err(
30            V2ErrorClass::StreamSequenceMismatch,
31            format!("v2 stream sequence {seq} skips expected {expected}"),
32        )
33    } else if seq == last {
34        err(
35            V2ErrorClass::StreamSequenceMismatch,
36            format!("v2 stream sequence {seq} was already accepted"),
37        )
38    } else {
39        err(
40            V2ErrorClass::StreamSequenceMismatch,
41            format!("v2 stream sequence {seq} precedes accepted {last}"),
42        )
43    }
44}