Skip to main content

subc_protocol/
scope.rs

1//! Scope records: owned identity records the daemon holds for sessions.
2//!
3//! A scope is identified by `(owner, ref)`. The owner is the module whose own
4//! registered connection synced it, never a value in the request, and the
5//! `ref` is an opaque string unique within that owner only. The design is
6//! `docs/designs/daemon-scopes.md`; the wire shapes here are the owner-facing
7//! half of it (`scope.sync`, `scope.apply`, `scope.describe`).
8//!
9//! Every record type refuses unknown fields. A field this daemon does not know
10//! may be one that narrows authority in a later version (a carrier's target
11//! list, say), and silently dropping it would widen what the scope grants, so
12//! an owner sending one is told its body is malformed instead.
13
14use serde::{Deserialize, Serialize};
15
16use crate::Principal;
17
18// Scope principals are authority-bearing input: an unrecognized constraint must
19// not silently widen a grant. Principal elsewhere is a forward-compatible caller
20// fact, so keep its general decoder lenient and enforce this only on scope input.
21#[derive(Deserialize)]
22#[serde(tag = "kind", rename_all = "snake_case", deny_unknown_fields)]
23enum ScopePrincipal {
24    Reserved { module_id: String },
25    Direct {},
26    Unverified {},
27}
28
29impl From<ScopePrincipal> for Principal {
30    fn from(value: ScopePrincipal) -> Self {
31        match value {
32            ScopePrincipal::Reserved { module_id } => Self::Reserved { module_id },
33            ScopePrincipal::Direct {} => Self::Direct,
34            ScopePrincipal::Unverified {} => Self::Unverified,
35        }
36    }
37}
38
39fn deserialize_scope_principal<'de, D: serde::Deserializer<'de>>(
40    deserializer: D,
41) -> Result<Principal, D::Error> {
42    ScopePrincipal::deserialize(deserializer).map(Into::into)
43}
44
45fn deserialize_scope_principals<'de, D: serde::Deserializer<'de>>(
46    deserializer: D,
47) -> Result<Vec<Principal>, D::Error> {
48    Vec::<ScopePrincipal>::deserialize(deserializer)
49        .map(|principals| principals.into_iter().map(Into::into).collect())
50}
51
52/// A scope bind-proof hash is the lowercase hexadecimal SHA-256 digest.
53pub fn validate_bind_proof_sha256(hash: &str) -> Result<(), &'static str> {
54    if hash.len() == 64
55        && hash
56            .bytes()
57            .all(|b| b.is_ascii_digit() || (b'a'..=b'f').contains(&b))
58    {
59        Ok(())
60    } else {
61        Err("bind_proof_sha256 must be exactly 64 lowercase hexadecimal characters")
62    }
63}
64
65fn deserialize_bind_proof_sha256<'de, D: serde::Deserializer<'de>>(
66    deserializer: D,
67) -> Result<Option<String>, D::Error> {
68    let hash = Option::<String>::deserialize(deserializer)?;
69    if let Some(hash) = &hash {
70        validate_bind_proof_sha256(hash).map_err(serde::de::Error::custom)?;
71    }
72    Ok(hash)
73}
74
75/// The `server.describe` capability a daemon advertises when it admits routes
76/// under scopes. A carrier that needs a scoped route and does not see it fails
77/// the call (`scope_unsupported`) instead of opening an unscoped route.
78pub const CAP_SCOPES_V1: &str = "scopes/v1";
79
80/// The `server.describe` capability a daemon advertises when it checks a
81/// `route.open`'s `role_versions` and forwards them on the module's bind. A
82/// daemon without it drops the field silently, so a consumer that relies on
83/// the provider seeing its role versions checks for this first.
84pub const CAP_ROUTE_ROLE_VERSIONS_V1: &str = "route-role-versions/v1";
85
86/// Module-to-subc op that registers an owner's full scope set.
87pub const SCOPE_SYNC_OP: &str = "scope.sync";
88/// Module-to-subc op that upserts or ends scopes without replacing the owner's
89/// full scope set.
90pub const SCOPE_APPLY_OP: &str = "scope.apply";
91/// Module-to-subc op that reads one scope's current state.
92pub const SCOPE_DESCRIBE_OP: &str = "scope.describe";
93
94/// Most live scopes one owner may hold. A sync naming more is refused whole.
95pub const MAX_LIVE_SCOPES_PER_OWNER: usize = 10_000;
96/// Most bytes one scope's `attributes` may take, measured as compact JSON. A
97/// sync carrying a larger record is refused whole.
98pub const MAX_SCOPE_ATTRIBUTE_BYTES: usize = 4 * 1024;
99/// Most ended scopes the daemon remembers per owner. The oldest is forgotten
100/// first, and reaching the bound never refuses a sync.
101pub const MAX_SCOPE_TOMBSTONES_PER_OWNER: usize = 1_000;
102/// Most modules one targeted carrier entry may list.
103pub const MAX_CARRIER_TARGETS: usize = 16;
104/// Most milliseconds a new scope epoch's deadline may be ahead of the daemon's
105/// current Unix wall clock: 24 hours.
106pub const MAX_SCOPE_EXPIRY_AHEAD_MS: u64 = 86_400_000;
107
108/// What a scope stands for. Closed, and fixed for the life of one
109/// `scope_epoch`: a different kind needs a new epoch, which ends the old scope.
110#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Hash)]
111#[serde(rename_all = "snake_case")]
112pub enum ScopeKind {
113    Head,
114    Worker,
115    Ephemeral,
116}
117
118/// A link from a scope to another scope, pinned to that scope's session by its
119/// epoch.
120#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
121#[serde(deny_unknown_fields)]
122#[non_exhaustive]
123pub struct ScopeParent {
124    #[serde(deserialize_with = "deserialize_scope_principal")]
125    pub owner: Principal,
126    #[serde(rename = "ref")]
127    pub scope_ref: String,
128    pub scope_epoch: u64,
129}
130
131impl ScopeParent {
132    pub fn new(owner: Principal, scope_ref: impl Into<String>, scope_epoch: u64) -> Self {
133        Self {
134            owner,
135            scope_ref: scope_ref.into(),
136            scope_epoch,
137        }
138    }
139}
140
141/// Who, besides the owner, may open routes under a scope.
142///
143/// `targets` absent means the carrier may open to any module. Present, it
144/// names the only module ids the carrier may open to, and must hold between 1
145/// and [`MAX_CARRIER_TARGETS`] entries: an empty list is refused rather than
146/// read as either "none" or "all".
147#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
148#[serde(deny_unknown_fields)]
149#[non_exhaustive]
150pub struct ScopeCarrier {
151    #[serde(deserialize_with = "deserialize_scope_principal")]
152    pub principal: Principal,
153    #[serde(default, skip_serializing_if = "Option::is_none")]
154    pub targets: Option<Vec<String>>,
155}
156
157impl ScopeCarrier {
158    pub fn new(principal: Principal) -> Self {
159        Self {
160            principal,
161            targets: None,
162        }
163    }
164
165    #[must_use]
166    pub fn with_targets(mut self, targets: Option<Vec<String>>) -> Self {
167        self.targets = targets;
168        self
169    }
170}
171
172/// Declaring this in a manifest's `capabilities.provides` promises that the
173/// module recognises a scope carrying `flow_id` and applies flow behaviour:
174/// it never treats the flow as its owner agent.
175/// During migration, either this capability or
176/// [`crate::call_mode::CALL_MODES_CAPABILITY`] admits flow scopes.
177pub const FLOW_SCOPES_CAPABILITY: &str = "flow-scopes/v1";
178
179/// Declaring this in a manifest's `capabilities.provides` promises that the
180/// module recognises `run_id` as one agent run and does not exercise the agent's
181/// delegated authority under that scope.
182/// During migration it admits non-delegating run scopes; delegating runs require
183/// [`crate::call_mode::CALL_MODES_CAPABILITY`] instead.
184pub const AGENT_RUN_SCOPES_CAPABILITY: &str = "agent-run-scopes/v1";
185
186/// Declaring this in a manifest's `capabilities.provides` promises that the
187/// module recognises `on_behalf_of_agent` as attribution only, never authority.
188/// The daemon also advertises this capability to scope-authority owners.
189pub const SCOPE_ON_BEHALF_OF_CAPABILITY: &str = "scope-on-behalf-of/v1";
190
191/// The daemon can answer whether a module acknowledged a bind under an owned scope epoch.
192pub const SCOPE_SERVED_BY_CAPABILITY: &str = "scope-served-by/v1";
193
194/// The authority-controlled attributes the daemon copies into scope stamps,
195/// subject to each field's target capability gate.
196/// Only an owner module named in the daemon config's `scope_authority_owners`
197/// list (by default the module that owns agent sessions) may set them; a scope
198/// owned by any other module must leave them empty.
199#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq, Eq)]
200#[serde(deny_unknown_fields)]
201#[non_exhaustive]
202pub struct ScopeAttributes {
203    /// The agent the scope's session belongs to. Identity, never permission.
204    #[serde(default, skip_serializing_if = "Option::is_none")]
205    pub agent_id: Option<String>,
206    /// Attribution only, never authority. A provider may use this to choose
207    /// identity-scoped presentation (bot choice, read budgets, bound
208    /// repositories) and for logging. It must never treat this as authority to
209    /// act as that agent, hand out the agent's per-agent handles or consent on
210    /// its strength, or treat it as `agent_id`.
211    ///
212    /// Set only by a scope-authority owner and validated with `agent_id`'s
213    /// token rule. Mutually exclusive with `agent_id`, `delegates` and `flow_id`;
214    /// `run_id` requires `agent_id` and is therefore excluded too. Adding,
215    /// changing or removing this within an epoch increments the content version
216    /// and closes routes with `scope_delegation_changed`. Bind stamps include
217    /// it only for targets providing [`SCOPE_ON_BEHALF_OF_CAPABILITY`]; describe
218    /// replies include it only for callers providing that capability.
219    #[serde(default, skip_serializing_if = "Option::is_none")]
220    pub on_behalf_of_agent: Option<String>,
221    /// Whether a provider may act as `agent_id`. Refused without `agent_id`.
222    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
223    pub delegates: bool,
224    /// This scope belongs to the named flow, an automated workflow run on an
225    /// agent's behalf. Set only by an authority owner (see above), validated
226    /// with [`validate_flow_id`], and stamped verbatim. It needs neither
227    /// `agent_id` nor `delegates`. Providers treat a module other than the
228    /// owner that opens a route under a flow scope as the flow's carrier.
229    ///
230    /// Like an `agent_id` change, changing this within the same scope epoch is
231    /// accepted: the scope's content version increases (the number providers
232    /// compare to notice a change), and every route under the scope is closed
233    /// with the reason `scope_delegation_changed`, so no live route keeps the
234    /// old identity.
235    /// A target must provide [`FLOW_SCOPES_CAPABILITY`] or
236    /// [`crate::call_mode::CALL_MODES_CAPABILITY`] before the daemon may send a
237    /// bind stamped with this field. Decoding it alone is not enough:
238    /// the target must also apply flow behaviour instead of agent behaviour.
239    #[serde(default, skip_serializing_if = "Option::is_none")]
240    pub flow_id: Option<String>,
241    /// Identifies one run carried out on behalf of `agent_id`. Requires
242    /// `agent_id`, forbids `flow_id`, and uses
243    /// [`validate_run_id`]'s token rule.
244    /// Adding, changing or removing it within an epoch increments the scope's
245    /// content version and closes routes under the scope with
246    /// `scope_delegation_changed`. The daemon sends this field in a bind only to
247    /// a target module providing [`AGENT_RUN_SCOPES_CAPABILITY`] or
248    /// [`crate::call_mode::CALL_MODES_CAPABILITY`]. A delegating run scope is
249    /// accepted as a record, but binds only to a target providing the latter.
250    #[serde(default, skip_serializing_if = "Option::is_none")]
251    pub run_id: Option<String>,
252}
253
254impl ScopeAttributes {
255    pub fn new() -> Self {
256        Self::default()
257    }
258
259    #[must_use]
260    pub fn with_agent_id(mut self, agent_id: Option<String>) -> Self {
261        self.agent_id = agent_id;
262        self
263    }
264
265    #[must_use]
266    pub fn with_on_behalf_of_agent(mut self, on_behalf_of_agent: Option<String>) -> Self {
267        self.on_behalf_of_agent = on_behalf_of_agent;
268        self
269    }
270
271    #[must_use]
272    pub fn with_delegates(mut self, delegates: bool) -> Self {
273        self.delegates = delegates;
274        self
275    }
276
277    #[must_use]
278    pub fn with_flow_id(mut self, flow_id: Option<String>) -> Self {
279        self.flow_id = flow_id;
280        self
281    }
282
283    #[must_use]
284    pub fn with_run_id(mut self, run_id: Option<String>) -> Self {
285        self.run_id = run_id;
286        self
287    }
288
289    pub fn is_empty(&self) -> bool {
290        self.agent_id.is_none()
291            && self.on_behalf_of_agent.is_none()
292            && !self.delegates
293            && self.flow_id.is_none()
294            && self.run_id.is_none()
295    }
296}
297
298/// Check a flow id using the shared opaque-token rule: 1–256 printable,
299/// non-space ASCII bytes. Errors name `flow_id`. Scope refs remain opaque and
300/// are not subject to this token rule.
301pub fn validate_flow_id(flow_id: &str) -> Result<(), crate::tool_call::OpaqueFieldError> {
302    crate::tool_call::validate_opaque_field("flow_id", flow_id)
303}
304
305/// Check a run id using the shared opaque-token rule: 1–256 ASCII bytes in
306/// `0x21`–`0x7E`. Errors name `run_id`.
307pub fn validate_run_id(run_id: &str) -> Result<(), crate::tool_call::OpaqueFieldError> {
308    crate::tool_call::validate_opaque_field("run_id", run_id)
309}
310
311/// Check attribution using the agent token rule: 1–256 printable, non-space
312/// ASCII bytes. Errors name `on_behalf_of_agent`.
313pub fn validate_on_behalf_of_agent(agent: &str) -> Result<(), crate::tool_call::OpaqueFieldError> {
314    crate::tool_call::validate_opaque_field("on_behalf_of_agent", agent)
315}
316
317/// One scope as its owner registers it in `scope.sync` or `scope.apply`.
318#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
319#[serde(deny_unknown_fields)]
320#[non_exhaustive]
321pub struct ScopeRecord {
322    #[serde(rename = "ref")]
323    pub scope_ref: String,
324    /// Owner-supplied session number. The owner keeps it with its own record of
325    /// the session, re-sends the same value for the same session after any
326    /// restart, and uses a higher one when it reuses the ref for a new session.
327    pub scope_epoch: u64,
328    pub kind: ScopeKind,
329    /// Only the holder of the scope's bind proof can bind it when this hash is
330    /// present. Without a hash, admission is unchanged and proofs are ignored.
331    #[serde(
332        default,
333        skip_serializing_if = "Option::is_none",
334        deserialize_with = "deserialize_bind_proof_sha256"
335    )]
336    pub bind_proof_sha256: Option<String>,
337    /// Refuse an epoch replacement or bind-proof change while routes are bound
338    /// to the live epoch, including binds admitted but not yet committed, or
339    /// connected presence holders remain. Send only after capability discovery.
340    /// This is a request condition, not a stored scope attribute.
341    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
342    pub replace_only_if_idle: bool,
343    /// Absolute Unix wall-clock deadline in milliseconds. It cannot be added,
344    /// changed or removed within this scope epoch; absent means no deadline.
345    /// This is not an authority attribute.
346    #[serde(default, skip_serializing_if = "Option::is_none")]
347    pub expires_at_ms: Option<u64>,
348    #[serde(default, skip_serializing_if = "Option::is_none")]
349    pub parent: Option<ScopeParent>,
350    /// Principals, other than the owner, allowed to register child scopes under
351    /// this one. Listing a principal here grants it nothing else.
352    #[serde(
353        default,
354        skip_serializing_if = "Vec::is_empty",
355        deserialize_with = "deserialize_scope_principals"
356    )]
357    pub child_owners: Vec<Principal>,
358    #[serde(default, skip_serializing_if = "Vec::is_empty")]
359    pub carriers: Vec<ScopeCarrier>,
360    #[serde(default, skip_serializing_if = "ScopeAttributes::is_empty")]
361    pub attributes: ScopeAttributes,
362}
363
364impl ScopeRecord {
365    pub fn new(scope_ref: impl Into<String>, scope_epoch: u64, kind: ScopeKind) -> Self {
366        Self {
367            scope_ref: scope_ref.into(),
368            scope_epoch,
369            kind,
370            bind_proof_sha256: None,
371            replace_only_if_idle: false,
372            expires_at_ms: None,
373            parent: None,
374            child_owners: Vec::new(),
375            carriers: Vec::new(),
376            attributes: ScopeAttributes::default(),
377        }
378    }
379
380    #[must_use]
381    pub fn with_bind_proof_sha256(mut self, hash: Option<String>) -> Self {
382        self.bind_proof_sha256 = hash;
383        self
384    }
385
386    #[must_use]
387    pub fn with_replace_only_if_idle(mut self, replace_only_if_idle: bool) -> Self {
388        self.replace_only_if_idle = replace_only_if_idle;
389        self
390    }
391
392    #[must_use]
393    pub fn with_expires_at_ms(mut self, expires_at_ms: Option<u64>) -> Self {
394        self.expires_at_ms = expires_at_ms;
395        self
396    }
397
398    #[must_use]
399    pub fn with_parent(mut self, parent: Option<ScopeParent>) -> Self {
400        self.parent = parent;
401        self
402    }
403
404    #[must_use]
405    pub fn with_child_owners(mut self, child_owners: Vec<Principal>) -> Self {
406        self.child_owners = child_owners;
407        self
408    }
409
410    #[must_use]
411    pub fn with_carriers(mut self, carriers: Vec<ScopeCarrier>) -> Self {
412        self.carriers = carriers;
413        self
414    }
415
416    #[must_use]
417    pub fn with_attributes(mut self, attributes: ScopeAttributes) -> Self {
418        self.attributes = attributes;
419        self
420    }
421}
422
423/// A request to end one scope session in `scope.apply`.
424#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
425#[serde(deny_unknown_fields)]
426#[non_exhaustive]
427pub struct ScopeEnd {
428    #[serde(rename = "ref")]
429    pub scope_ref: String,
430    pub scope_epoch: u64,
431}
432
433impl ScopeEnd {
434    pub fn new(scope_ref: impl Into<String>, scope_epoch: u64) -> Self {
435        Self {
436            scope_ref: scope_ref.into(),
437            scope_epoch,
438        }
439    }
440}
441
442/// What `scope.apply` did with one requested end.
443#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
444#[serde(rename_all = "snake_case")]
445pub enum ScopeEndOutcome {
446    /// The named scope ref was live at this epoch and was ended.
447    Ended,
448    /// The named scope ref was not live at this epoch; this end request changed
449    /// nothing.
450    NotLive,
451}
452
453/// The per-end result in a `scope.apply` reply, in request order.
454#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
455#[serde(deny_unknown_fields)]
456#[non_exhaustive]
457pub struct ScopeEndResult {
458    #[serde(rename = "ref")]
459    pub scope_ref: String,
460    pub scope_epoch: u64,
461    pub outcome: ScopeEndOutcome,
462}
463
464impl ScopeEndResult {
465    pub fn new(scope_ref: impl Into<String>, scope_epoch: u64, outcome: ScopeEndOutcome) -> Self {
466        Self {
467            scope_ref: scope_ref.into(),
468            scope_epoch,
469            outcome,
470        }
471    }
472}
473
474/// The scope a `route.open` asks to be admitted under.
475///
476/// `scope_epoch` is optional on the wire only so that leaving it out is
477/// refused by name (`scope_epoch_required`) rather than as a malformed body:
478/// every opener must name it, the owner included.
479#[derive(Clone, Serialize, Deserialize, PartialEq, Eq)]
480#[serde(deny_unknown_fields)]
481#[non_exhaustive]
482pub struct ScopeSelector {
483    #[serde(deserialize_with = "deserialize_scope_principal")]
484    pub owner: Principal,
485    #[serde(rename = "ref")]
486    pub scope_ref: String,
487    #[serde(default, skip_serializing_if = "Option::is_none")]
488    pub scope_epoch: Option<u64>,
489    /// Base64url-encoded 32-byte secret, without padding. Ignored for records
490    /// without a bind-proof hash, so holders may always send their proof.
491    #[serde(default, skip_serializing_if = "Option::is_none")]
492    pub bind_proof: Option<String>,
493    /// Keep connection-held presence after an admitted open, even if its route
494    /// closes. Send only to daemons advertising `scope-replace-if-idle/v1`.
495    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
496    pub hold_presence: bool,
497}
498
499impl ScopeSelector {
500    pub fn new(owner: Principal, scope_ref: impl Into<String>, scope_epoch: Option<u64>) -> Self {
501        Self {
502            owner,
503            scope_ref: scope_ref.into(),
504            scope_epoch,
505            bind_proof: None,
506            hold_presence: false,
507        }
508    }
509
510    #[must_use]
511    pub fn with_bind_proof(mut self, proof: Option<String>) -> Self {
512        self.bind_proof = proof;
513        self
514    }
515
516    #[must_use]
517    pub fn with_hold_presence(mut self, hold_presence: bool) -> Self {
518        self.hold_presence = hold_presence;
519        self
520    }
521}
522
523impl std::fmt::Debug for ScopeSelector {
524    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
525        f.debug_struct("ScopeSelector")
526            .field("owner", &self.owner)
527            .field("scope_ref", &self.scope_ref)
528            .field("scope_epoch", &self.scope_epoch)
529            .field(
530                "bind_proof",
531                &self.bind_proof.as_ref().map(|_| "<redacted>"),
532            )
533            .finish()
534    }
535}
536
537impl std::fmt::Display for ScopeSelector {
538    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
539        std::fmt::Debug::fmt(self, f)
540    }
541}
542
543/// The state of a scope's parent link.
544#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, Hash)]
545#[serde(rename_all = "snake_case")]
546pub enum ParentState {
547    /// The parent is live at the named epoch and the link was permitted.
548    Linked,
549    /// The parent's owner has not synced in this daemon incarnation, so the
550    /// link is unverified and grants nothing yet.
551    Pending,
552    /// The parent is gone or live at another epoch, or the link was refused
553    /// when the parent's owner synced. Final for this link.
554    Ended,
555}
556
557/// What a `scope.sync` or `scope.apply` did with one record.
558#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
559#[serde(rename_all = "snake_case")]
560pub enum ScopeRecordOutcome {
561    /// The ref was not live before; the scope was created.
562    Created,
563    /// The ref was live at a lower epoch; that scope ended and this one began.
564    Replaced,
565    /// The ref was live at this epoch and its content changed.
566    Updated,
567    /// The ref was live at this epoch with identical content; its `version`
568    /// did not move.
569    Unchanged,
570    /// The record was refused on its own merits (`code` says why). The refusal
571    /// itself does not change the ref or undo any expiry processing.
572    Refused,
573}
574
575/// The per-record result in a `scope.sync` or `scope.apply` reply, in request order.
576#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
577pub struct ScopeRecordResult {
578    #[serde(rename = "ref")]
579    pub scope_ref: String,
580    /// The epoch the record named, which for a refusal may differ from the
581    /// epoch still held.
582    pub scope_epoch: u64,
583    pub outcome: ScopeRecordOutcome,
584    /// The refusal code when `outcome` is `refused`.
585    #[serde(default, skip_serializing_if = "Option::is_none")]
586    pub code: Option<String>,
587    #[serde(default, skip_serializing_if = "Option::is_none")]
588    pub message: Option<String>,
589    /// The daemon's content counter for the scope held under this ref after
590    /// the sync; absent when no scope is live under it.
591    #[serde(default, skip_serializing_if = "Option::is_none")]
592    pub version: Option<u64>,
593    /// The parent link's state after the sync, for a scope with a parent.
594    #[serde(default, skip_serializing_if = "Option::is_none")]
595    pub parent_state: Option<ParentState>,
596}
597
598/// A scope session of the calling owner that ended through omission from
599/// `scope.sync`, an explicit `scope.apply` end, replacement by a higher epoch
600/// for the same ref or expiry.
601#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
602pub struct ScopeEnded {
603    #[serde(rename = "ref")]
604    pub scope_ref: String,
605    pub scope_epoch: u64,
606}
607
608/// `scope.describe`'s answer about one `(owner, ref)`.
609#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
610#[serde(rename_all = "snake_case")]
611pub enum ScopeStatus {
612    Live,
613    /// Ended in this daemon incarnation, and still remembered.
614    Ended,
615    /// Neither live nor remembered as ended. With `owner_synced` true the scope
616    /// is gone: an owner's first sync of an incarnation is its full set. With
617    /// `owner_synced` false and `owner_configured` true the owner has not
618    /// re-synced since a daemon restart, so a reader waits. With
619    /// `owner_configured` false the owner will never sync.
620    NotLive,
621}
622
623/// The fields the daemon stamps for a live scope.
624/// Build with [`ScopeStamp::new`] and the setters so future fields are additive.
625#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
626#[non_exhaustive]
627pub struct ScopeStamp {
628    pub owner: Principal,
629    #[serde(rename = "ref")]
630    pub scope_ref: String,
631    pub scope_epoch: u64,
632    pub kind: ScopeKind,
633    #[serde(default, skip_serializing_if = "Option::is_none")]
634    pub parent: Option<ScopeParent>,
635    #[serde(default, skip_serializing_if = "Option::is_none")]
636    pub parent_state: Option<ParentState>,
637    #[serde(default, skip_serializing_if = "ScopeAttributes::is_empty")]
638    pub attributes: ScopeAttributes,
639    /// Whether the owner is listed in the daemon's `scope_authority_owners`.
640    /// Providers decide on this flag and keep no copy of the list.
641    pub owner_authorized: bool,
642    /// Absolute Unix wall-clock deadline in milliseconds, fixed for this epoch.
643    /// On route binds the daemon sends this deadline only to targets declaring
644    /// [`crate::call_mode::CALL_MODES_CAPABILITY`], because older providers may
645    /// reject unfamiliar scope-stamp fields.
646    #[serde(default, skip_serializing_if = "Option::is_none")]
647    pub expires_at_ms: Option<u64>,
648}
649
650impl ScopeStamp {
651    /// A stamp with no parent, attributes or deadline, and no owner authority.
652    pub fn new(
653        owner: Principal,
654        scope_ref: impl Into<String>,
655        scope_epoch: u64,
656        kind: ScopeKind,
657    ) -> Self {
658        Self {
659            owner,
660            scope_ref: scope_ref.into(),
661            scope_epoch,
662            kind,
663            parent: None,
664            parent_state: None,
665            attributes: ScopeAttributes::new(),
666            owner_authorized: false,
667            expires_at_ms: None,
668        }
669    }
670
671    #[must_use]
672    pub fn with_parent(mut self, parent: Option<ScopeParent>) -> Self {
673        self.parent = parent;
674        self
675    }
676
677    #[must_use]
678    pub fn with_parent_state(mut self, parent_state: Option<ParentState>) -> Self {
679        self.parent_state = parent_state;
680        self
681    }
682
683    #[must_use]
684    pub fn with_attributes(mut self, attributes: ScopeAttributes) -> Self {
685        self.attributes = attributes;
686        self
687    }
688
689    #[must_use]
690    pub fn with_owner_authorized(mut self, owner_authorized: bool) -> Self {
691        self.owner_authorized = owner_authorized;
692        self
693    }
694
695    #[must_use]
696    pub fn with_expires_at_ms(mut self, expires_at_ms: Option<u64>) -> Self {
697        self.expires_at_ms = expires_at_ms;
698        self
699    }
700}
701
702#[cfg(test)]
703mod tests {
704    use super::*;
705    use crate::tool_call::OpaqueFieldError;
706
707    #[test]
708    fn flow_id_uses_the_shared_opaque_token_bounds_and_names_its_field() {
709        let field = "flow_id";
710        assert_eq!(validate_flow_id(""), Err(OpaqueFieldError::Empty { field }));
711        assert_eq!(validate_flow_id("f"), Ok(()));
712        assert_eq!(validate_flow_id(&"f".repeat(256)), Ok(()));
713        assert_eq!(
714            validate_flow_id(&"f".repeat(257)),
715            Err(OpaqueFieldError::TooLong { field, length: 257 })
716        );
717        assert_eq!(validate_flow_id("!~Flow:7/step"), Ok(()));
718        for bad in ["f é", "f\t", "fé", "f\u{7f}"] {
719            let error = validate_flow_id(bad).unwrap_err();
720            assert_eq!(
721                error,
722                OpaqueFieldError::InvalidCharacter { field, index: 1 }
723            );
724            assert_eq!(error.field(), "flow_id");
725        }
726    }
727
728    #[test]
729    fn flow_only_attributes_round_trip_and_absence_keeps_the_bytes() {
730        let attributes = ScopeAttributes::default();
731        assert!(attributes.is_empty());
732        assert_eq!(serde_json::to_string(&attributes).unwrap(), "{}");
733        assert_eq!(
734            serde_json::from_str::<ScopeAttributes>("{}").unwrap(),
735            attributes
736        );
737        let attributes = ScopeAttributes {
738            flow_id: Some("flow:7".to_string()),
739            ..ScopeAttributes::default()
740        };
741        assert!(!attributes.is_empty());
742        let encoded = serde_json::to_string(&attributes).unwrap();
743        assert_eq!(encoded, r#"{"flow_id":"flow:7"}"#);
744        assert_eq!(
745            serde_json::from_str::<ScopeAttributes>(&encoded).unwrap(),
746            attributes
747        );
748        assert!(
749            serde_json::from_str::<ScopeAttributes>(r#"{"flow_id":"flow:7","unknown":true}"#)
750                .is_err()
751        );
752    }
753}