peat-schema 0.9.0-rc.10

Wire format (Protobuf) definitions for the Peat Coordination Protocol
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

// Cell (squad) definitions for CAP Protocol
// Version: 1.0.0

syntax = "proto3";

package cap.cell.v1;

import "common.proto";
import "capability.proto";

// Cell configuration
message CellConfig {
  // Unique cell identifier
  string id = 1;

  // Maximum cell size (number of members)
  uint32 max_size = 2;

  // Minimum cell size (number of members)
  uint32 min_size = 3;

  // Timestamp when cell was configured
  common.v1.Timestamp created_at = 4;
}

// Cell state (dynamic)
message CellState {
  // Cell configuration
  CellConfig config = 1;

  // Current cell leader node ID (LWW-Register)
  optional string leader_id = 2;

  // Set of member node IDs (OR-Set)
  repeated string members = 3;

  // Aggregated cell capabilities (G-Set: grow-only)
  repeated capability.v1.Capability capabilities = 4;

  // Parent platoon/zone ID for hierarchy (LWW-Register)
  optional string platoon_id = 5;

  // Last update timestamp (for LWW conflict resolution)
  common.v1.Timestamp timestamp = 6;
}

// Complete cell representation
message Cell {
  // Cell configuration
  CellConfig config = 1;

  // Cell state
  CellState state = 2;
}

// Cell formation request
message CellFormationRequest {
  // Requesting node ID
  string node_id = 1;

  // Required capabilities for the cell
  repeated capability.v1.CapabilityType required_capabilities = 2;

  // Timestamp of request
  common.v1.Timestamp requested_at = 3;
}

// Cell formation response
message CellFormationResponse {
  // Formed cell (if successful)
  optional Cell cell = 1;

  // Success indicator
  bool success = 2;

  // Reason for failure (if any)
  optional string failure_reason = 3;
}

// Cell membership change
message CellMembershipChange {
  // Cell ID
  string cell_id = 1;

  // Change type
  enum ChangeType {
    CHANGE_TYPE_UNSPECIFIED = 0;
    CHANGE_TYPE_JOIN = 1;    // Node joined cell
    CHANGE_TYPE_LEAVE = 2;   // Node left cell
    CHANGE_TYPE_LEADER = 3;  // Leader changed
  }

  ChangeType change_type = 2;

  // Node ID involved in the change
  string node_id = 3;

  // Timestamp of change
  common.v1.Timestamp timestamp = 4;
}