logit_loom_core/
generation.rs1use serde::{Deserialize, Serialize};
6
7use crate::{CoreError, Digest, TokenId};
8
9#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
11#[serde(rename_all = "snake_case", tag = "kind")]
12pub enum GenerationFinish {
13 EndOfGeneration {
15 token: TokenId,
17 },
18 TokenLimit,
20 StopSequence {
22 index: u32,
24 },
25 ObserverStop,
27}
28
29#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
31pub struct GenerationReceipt {
32 pub plan: Digest,
34 pub initial_position: u64,
36 pub admitted_tokens: u32,
38 pub admitted_bytes: u64,
40 pub final_position: u64,
42 pub finish: GenerationFinish,
44 #[serde(default, skip_serializing_if = "Option::is_none")]
46 pub transform_receipt: Option<Digest>,
47 #[serde(default)]
49 pub observer_receipts: Vec<Digest>,
50}
51
52impl GenerationReceipt {
53 pub fn digest(&self) -> Result<Digest, CoreError> {
59 let expected_position = self
60 .initial_position
61 .checked_add(u64::from(self.admitted_tokens))
62 .ok_or_else(|| {
63 CoreError::invalid("generation receipt", "causal position overflowed")
64 })?;
65 if self.final_position != expected_position {
66 return Err(CoreError::invalid(
67 "generation receipt",
68 "position does not match admitted tokens",
69 ));
70 }
71 Digest::of_serializable("generation-receipt-v1", self)
72 }
73}
74
75#[cfg(test)]
76mod tests {
77 use super::*;
78
79 #[test]
80 fn generation_receipts_reject_position_overflow() {
81 let receipt = GenerationReceipt {
82 plan: Digest::of_bytes("test-plan", b"one"),
83 initial_position: u64::MAX,
84 admitted_tokens: 1,
85 admitted_bytes: 1,
86 final_position: u64::MAX,
87 finish: GenerationFinish::TokenLimit,
88 transform_receipt: None,
89 observer_receipts: Vec::new(),
90 };
91 assert!(receipt.digest().is_err());
92 }
93}