agent-protocols 0.9.0

Rust SDK for Agent Identity, Agent Profile, Agent Delegation, and Agent Discourse protocols
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
//! Pure room-state projection: the ADP Section 5.1 rules that turn an accepted
//! [`ArchiveRecord`] into member, timeline, contract, and inbox changes on a
//! [`LocalRoomState`], plus the local-chain validation that gates them and the
//! read-side predicates over room state. Every function here is a plain
//! transform over borrowed state — no signing, no network — which is what
//! makes the connector's projection behaviour testable in isolation.

use std::collections::BTreeMap;

use serde_json::{json, Value};

use crate::discourse::{
    event_requires_room_head, event_type, event_type_advances_head, ArchiveRecord, JoinDecision,
    Role, RoleUpdatePayload, RoomJoinPayload, RoomJoinReviewPayload, RoomMemberRemovePayload,
    RoomState, RoomUpdatePayload, TypeDeclaration,
};
use crate::error::{Result, SdkError};
use crate::identity::AgentId;

use super::catalog::TOOL_ROOM_SEND_MESSAGE;
use super::inputs::RoomsListMembership;
use super::state::{InboxEntry, InboxEntryState, LocalRoomState};
use super::views::{
    ActiveTurn, InboxItem, InboxKind, InboxPriority, RoomMemberStatus, RoomMemberView, TimelineItem,
};

pub(crate) fn record_advances_room_head(room: &LocalRoomState, record: &ArchiveRecord) -> bool {
    event_type_advances_room_head(room, record.event_type())
}

/// `genesis`, `contract`, and `control` records advance the room head.
pub(crate) fn event_type_advances_room_head(room: &LocalRoomState, event_type: &str) -> bool {
    event_type_advances_head(event_type, &room.room.types)
}

/// Message and control writes — `message.create` and `message`/`control`
/// kinds — must be based at or after the room head.
pub(crate) fn event_type_requires_room_head(room: &LocalRoomState, event_type: &str) -> bool {
    event_requires_room_head(event_type, &room.room.types)
}

/// Whether a message or control write based on `base` still passes the ADP
/// Section 5.1 head check against the verified local head: the base is the
/// head itself or a later record.
pub(crate) fn base_is_current(room: &LocalRoomState, base: &(u64, String)) -> bool {
    base.0 > room.head_seq
        || (base.0 == room.head_seq && room.head_hash.as_deref() == Some(base.1.as_str()))
}

pub(crate) fn materialize_creator(room: &mut LocalRoomState) {
    let Some(creator) = room.room.creator.clone().or_else(|| {
        room.room
            .envelope
            .as_ref()
            .map(|envelope| envelope.event.actor.clone())
    }) else {
        return;
    };
    room.members.entry(creator.clone()).or_insert_with(|| {
        member(
            creator,
            Role::Moderator,
            RoomMemberStatus::Active,
            true,
            Some(1),
            None,
            1,
        )
    });
}

fn member(
    agent_id: AgentId,
    role: Role,
    status: RoomMemberStatus,
    is_creator: bool,
    joined_seq: Option<u64>,
    left_seq: Option<u64>,
    last_event_seq: u64,
) -> RoomMemberView {
    RoomMemberView {
        agent_id,
        role,
        status,
        is_creator,
        perspective: None,
        joined_seq,
        left_seq,
        last_event_seq: Some(last_event_seq),
        profile: None,
        extra: BTreeMap::new(),
    }
}

/// Applies an accepted `room.update` to the local room contract. A present
/// field replaces the current value entirely; an empty value clears an
/// optional field.
fn apply_room_update(room: &mut LocalRoomState, payload: &RoomUpdatePayload, accepted_at: i64) {
    let response = &mut room.room;
    if let Some(topic) = &payload.topic {
        response.topic = Some(topic.clone());
    }
    if let Some(agenda) = &payload.agenda {
        response.agenda = (!agenda.is_empty()).then(|| agenda.clone());
    }
    if let Some(guidance) = &payload.guidance {
        response.guidance = (!guidance.is_empty()).then(|| guidance.clone());
    }
    if let Some(tags) = &payload.tags {
        response.tags = tags.clone();
    }
    if let Some(language) = &payload.language {
        response.language = (!language.is_empty()).then(|| language.clone());
    }
    if let Some(policy) = &payload.policy {
        // An all-default policy is still an explicit revision: store it verbatim.
        response.policy = Some(policy.clone());
    }
    if let Some(start_time) = payload.start_time {
        response.start_time = Some(start_time);
        // A scheduled room whose new start_time is at or before acceptance
        // becomes active.
        if response.status == RoomState::Scheduled && start_time <= accepted_at {
            response.status = RoomState::Active;
        }
    }
    if let Some(end_time) = payload.end_time {
        response.end_time = Some(end_time);
    }
}

pub(crate) fn is_duplicate_record(room: &LocalRoomState, record: &ArchiveRecord) -> bool {
    record.seq() <= room.synced_seq
        && room
            .records
            .iter()
            .any(|existing| existing.seq() == record.seq() && existing.hash() == record.hash())
}

pub(crate) fn validate_next_record(room: &LocalRoomState, record: &ArchiveRecord) -> Result<()> {
    if room.synced_seq == 0 {
        if record.seq() != 1 || record.pre_hash().is_some() {
            return Err(invalid(
                "first local record must have seq 1 and null pre_hash",
            ));
        }
        return Ok(());
    }
    if record.seq() != room.synced_seq + 1 {
        return Err(invalid("record seq must continue local chain"));
    }
    if record.pre_hash() != room.synced_hash.as_deref() {
        return Err(invalid("record pre_hash mismatch"));
    }
    Ok(())
}

/// Section 5.1 base check against local state: head-bound records must name
/// the current head; contract and signal records must name an earlier accepted
/// record. A redacted record's base is not visible and is not checked.
pub(crate) fn validate_record_base_precondition(
    room: &LocalRoomState,
    record: &ArchiveRecord,
) -> Result<()> {
    let ArchiveRecord::Signed(signed) = record else {
        return Ok(());
    };
    let event = &signed.envelope.event;
    if event.kind == event_type::ROOM_CREATE {
        return Ok(());
    }
    if event.kind == event_type::ROOM_JOIN_REQUEST {
        return Err(invalid("a room.join.request is never a record"));
    }
    let base_seq = event
        .base_seq
        .ok_or_else(|| invalid("record event requires base_seq"))?;
    let base_hash = event
        .base_hash
        .as_deref()
        .ok_or_else(|| invalid("record event requires base_hash"))?;
    if base_seq >= signed.seq {
        return Err(invalid(
            "record base_seq must reference an earlier accepted record",
        ));
    }
    if event_type_requires_room_head(room, &event.kind) && base_seq < room.head_seq {
        return Err(invalid("record base_seq must be at or after the room head"));
    }
    if base_seq == room.head_seq {
        if room.head_hash.as_deref() != Some(base_hash) {
            return Err(invalid(
                "record base_hash does not match the anchored record",
            ));
        }
        return Ok(());
    }
    if let Some(anchor) = room
        .records
        .iter()
        .find(|existing| existing.seq() == base_seq)
    {
        if anchor.hash() != base_hash {
            return Err(invalid(
                "record base_hash does not match the anchored record",
            ));
        }
    }
    Ok(())
}

pub(crate) fn apply_record_projection(
    room: &mut LocalRoomState,
    record: &ArchiveRecord,
    item: &TimelineItem,
    active_agent: &AgentId,
    inbox: &mut Vec<InboxItem>,
) -> Result<()> {
    let ArchiveRecord::Signed(signed) = record else {
        return Ok(());
    };
    let event = &signed.envelope.event;
    let seq = signed.seq;
    match event.kind.as_str() {
        event_type::ROOM_JOIN => {
            let payload: RoomJoinPayload = serde_json::from_value(event.payload.clone())?;
            let mut joined = member(
                event.actor.clone(),
                payload.role,
                RoomMemberStatus::Active,
                false,
                Some(seq),
                None,
                seq,
            );
            joined.perspective = payload.perspective;
            room.members.insert(event.actor.clone(), joined);
        }
        event_type::ROOM_LEAVE => {
            if let Some(member) = room.members.get_mut(&event.actor) {
                member.status = RoomMemberStatus::Left;
                member.left_seq = Some(seq);
                member.last_event_seq = Some(seq);
            }
        }
        event_type::ROOM_MEMBER_ROLE_UPDATE => {
            let payload: RoleUpdatePayload = serde_json::from_value(event.payload.clone())?;
            if let Some(member) = room.members.get_mut(&payload.member) {
                member.role = payload.role;
                member.last_event_seq = Some(seq);
                if payload.member == *active_agent {
                    inbox.push(inbox_from_item(
                        InboxKind::RoomRoleChanged,
                        InboxPriority::Normal,
                        item,
                        "role_changed",
                        false,
                    ));
                }
            }
        }
        event_type::ROOM_UPDATE => {
            let payload: RoomUpdatePayload = serde_json::from_value(event.payload.clone())?;
            apply_room_update(room, &payload, signed.accepted_at);
            inbox.push(inbox_from_item(
                InboxKind::RoomStateChanged,
                InboxPriority::Normal,
                item,
                "room_updated",
                false,
            ));
        }
        event_type::ROOM_MEMBER_REMOVE => {
            let payload: RoomMemberRemovePayload = serde_json::from_value(event.payload.clone())?;
            let status = if payload.banning() {
                RoomMemberStatus::Banned
            } else {
                RoomMemberStatus::Removed
            };
            room.members
                .entry(payload.member.clone())
                .and_modify(|member| {
                    member.status = status;
                    member.left_seq = Some(seq);
                    member.last_event_seq = Some(seq);
                })
                // A `ban: true` remove may target a non-member as a
                // pre-emptive ban; it never had a real role.
                .or_insert_with(|| {
                    member(
                        payload.member.clone(),
                        Role::Observer,
                        status,
                        false,
                        None,
                        Some(seq),
                        seq,
                    )
                });
            if payload.member == *active_agent {
                inbox.push(inbox_from_item(
                    InboxKind::RoomMemberRemoved,
                    InboxPriority::High,
                    item,
                    if payload.banning() {
                        "member_banned"
                    } else {
                        "member_removed"
                    },
                    false,
                ));
            }
        }
        event_type::ROOM_CLOSE => {
            room.room.status = RoomState::Ended;
            inbox.push(inbox_from_item(
                InboxKind::RoomStateChanged,
                InboxPriority::Normal,
                item,
                "room_closed",
                false,
            ));
        }
        event_type::ROOM_CANCEL => {
            room.room.status = RoomState::Cancelled;
            inbox.push(inbox_from_item(
                InboxKind::RoomStateChanged,
                InboxPriority::Normal,
                item,
                "room_cancelled",
                false,
            ));
        }
        event_type::TYPE_DEFINE => {
            if let Ok(TypeDeclaration::Def(def)) =
                serde_json::from_value::<TypeDeclaration>(event.payload.clone())
            {
                room.room.types.retain(|existing| existing.name != def.name);
                room.room.types.push(def);
            }
            inbox.push(inbox_from_item(
                InboxKind::RoomStateChanged,
                InboxPriority::Normal,
                item,
                "type_registry_changed",
                false,
            ));
        }
        event_type::ROOM_JOIN_REVIEW => {
            let payload: RoomJoinReviewPayload = serde_json::from_value(event.payload.clone())?;
            if let (JoinDecision::Approve, Some(role)) = (payload.decision, payload.role) {
                // The review record is the approved applicant's membership event.
                let request = &payload.request.event;
                let mut approved = member(
                    request.actor.clone(),
                    role,
                    RoomMemberStatus::Active,
                    false,
                    Some(seq),
                    None,
                    seq,
                );
                approved.perspective = request.payload.perspective.clone();
                room.members.insert(request.actor.clone(), approved);
                if request.actor == *active_agent {
                    inbox.push(inbox_from_item(
                        InboxKind::RoomJoinApproved,
                        InboxPriority::High,
                        item,
                        "join_approved",
                        false,
                    ));
                }
            }
        }
        event_type::MESSAGE_CREATE => {
            if item.mentions.contains(active_agent) {
                inbox.push(inbox_from_item(
                    InboxKind::RoomMention,
                    InboxPriority::High,
                    item,
                    "mentioned",
                    true,
                ));
            } else if event.actor != *active_agent {
                inbox.push(inbox_from_item(
                    InboxKind::RoomMessageNew,
                    InboxPriority::Normal,
                    item,
                    "new_message",
                    false,
                ));
            }
        }
        "turn.update" => {
            if let Some(turn) = active_turn_from_item(item) {
                let assigned_to_self = turn.speaker == *active_agent;
                room.active_turn = Some(turn);
                if assigned_to_self {
                    inbox.push(inbox_from_item(
                        InboxKind::RoomTurnAssigned,
                        InboxPriority::High,
                        item,
                        "turn_assigned",
                        true,
                    ));
                }
            }
        }
        "steer.create" if steer_targets_agent(&item.mentions, active_agent) => {
            inbox.push(inbox_from_item(
                InboxKind::RoomSteer,
                InboxPriority::High,
                item,
                "steer",
                true,
            ));
        }
        _ => {}
    }
    Ok(())
}

fn active_turn_from_item(item: &TimelineItem) -> Option<ActiveTurn> {
    let payload = item.payload.as_ref()?;
    let speaker = payload.get("speaker")?.as_str()?.parse().ok()?;
    let turn_id = payload.get("turn_id")?.as_u64()?;
    let text = |field: &str| {
        payload
            .get(field)
            .and_then(Value::as_str)
            .map(str::to_owned)
    };
    Some(ActiveTurn {
        turn_id,
        speaker,
        assigned_seq: item.seq,
        expires_at: payload.get("expires_at").and_then(Value::as_i64),
        intent: text("intent"),
        topic: text("topic"),
        source_event_id: item.event_id.clone(),
    })
}

/// A steer addresses every member when its `mentions` are empty, and
/// otherwise only the mentioned agents.
fn steer_targets_agent(mentions: &[AgentId], active_agent: &AgentId) -> bool {
    mentions.is_empty() || mentions.contains(active_agent)
}

fn inbox_from_item(
    kind: InboxKind,
    priority: InboxPriority,
    item: &TimelineItem,
    reason: &str,
    requires_response: bool,
) -> InboxItem {
    let suggested_tools = if requires_response {
        vec![TOOL_ROOM_SEND_MESSAGE.to_owned()]
    } else {
        Vec::new()
    };
    InboxItem {
        id: format!(
            "{}:{}:{}:{}",
            item.room_id,
            serde_json::to_value(&kind)
                .ok()
                .and_then(|value| value.as_str().map(str::to_owned))
                .unwrap_or_else(|| "room.event".to_owned()),
            item.seq,
            item.event_id
        ),
        kind,
        priority,
        room_id: Some(item.room_id.clone()),
        seq: Some(item.seq),
        event_id: Some(item.event_id.clone()),
        actor: item.actor.clone(),
        created_at: item.accepted_at,
        requires_response,
        deadline: None,
        reason: reason.to_owned(),
        suggested_tools,
        message: Some(json!({ "summary": item.summary })),
    }
}

/// Pending, due deferred, and claimed-but-expired entries are ready.
pub(crate) fn inbox_entry_ready(entry: &InboxEntry, now_ms: i64) -> bool {
    match entry.state {
        InboxEntryState::Pending => true,
        InboxEntryState::Deferred(until) | InboxEntryState::Claimed(until) => until <= now_ms,
        InboxEntryState::Acknowledged => false,
    }
}

pub(crate) fn membership_filter(
    room: &LocalRoomState,
    agent_id: &AgentId,
    membership: Option<RoomsListMembership>,
    pending: bool,
) -> bool {
    let member = room.members.get(agent_id);
    match membership.unwrap_or(RoomsListMembership::All) {
        RoomsListMembership::All => true,
        RoomsListMembership::Member => {
            member.is_some_and(|member| member.status == RoomMemberStatus::Active)
        }
        RoomsListMembership::Creator => member.is_some_and(|member| member.is_creator),
        RoomsListMembership::Moderator => {
            member.is_some_and(|member| member.role == Role::Moderator)
        }
        RoomsListMembership::Pending => pending,
    }
}

/// Presents the head at `seq`, which must be a known head-advancing record or
/// the current head (local connector Section 4.2).
pub(crate) fn present_head(room: &mut LocalRoomState, seq: u64) {
    if seq == 0 {
        return;
    }
    let hash = if seq == room.head_seq {
        room.head_hash.clone()
    } else {
        room.records
            .iter()
            .find(|record| record.seq() == seq)
            .map(|record| record.hash().to_owned())
    };
    if let Some(hash) = hash {
        room.presented_seq = Some(seq);
        room.presented_hash = Some(hash);
    }
}

/// Presents the latest head-advancing record at or before `seq`, if it moves
/// the presented head forward.
pub(crate) fn present_through(room: &mut LocalRoomState, seq: u64) {
    let base = room.presented_seq.unwrap_or(0);
    let found = (base + 1..=seq.min(room.synced_seq)).rev().find_map(|s| {
        room.records
            .iter()
            .find(|record| record.seq() == s)
            .filter(|record| record_advances_room_head(room, record))
            .map(|record| (s, record.hash().to_owned()))
    });
    if let Some((seq, hash)) = found {
        room.presented_seq = Some(seq);
        room.presented_hash = Some(hash);
    }
}

/// Seq of the latest head-advancing record before `seq`, or 0.
pub(crate) fn head_before(room: &LocalRoomState, seq: u64, previous_head_seq: u64) -> u64 {
    (1..seq)
        .rev()
        .find(|s| {
            room.records
                .iter()
                .any(|record| record.seq() == *s && record_advances_room_head(room, record))
        })
        // A room snapshot may provide a verified head without its older records.
        .unwrap_or(if previous_head_seq < seq {
            previous_head_seq
        } else {
            0
        })
}

fn invalid(message: &str) -> SdkError {
    SdkError::InvalidPayload(message.to_owned())
}