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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

// Zone (hierarchy) definitions for CAP Protocol
// Version: 1.0.0

syntax = "proto3";

package cap.zone.v1;

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

// Zone configuration (immutable properties)
message ZoneConfig {
  // Unique zone identifier
  string id = 1;

  // Maximum number of cells in this zone
  uint32 max_cells = 2;

  // Minimum number of cells required for valid zone
  uint32 min_cells = 3;

  // Timestamp when zone was created
  common.v1.Timestamp created_at = 4;
}

// Zone runtime state (CRDT-based)
message ZoneState {
  // Zone configuration
  ZoneConfig config = 1;

  // Zone coordinator node ID (LWW-Register)
  optional string coordinator_id = 2;

  // Cell membership (OR-Set)
  repeated string cells = 3;

  // Aggregated capabilities from all cells (G-Set)
  repeated capability.v1.Capability aggregated_capabilities = 4;

  // Timestamp for LWW conflict resolution
  common.v1.Timestamp timestamp = 5;
}

// Complete zone representation
message Zone {
  // Zone configuration
  ZoneConfig config = 1;

  // Zone state
  ZoneState state = 2;
}

// Zone statistics (derived from state)
message ZoneStats {
  // Zone ID
  string zone_id = 1;

  // Number of cells in zone
  uint32 cell_count = 2;

  // Total number of nodes across all cells
  uint32 total_nodes = 3;

  // Number of unique capability types
  uint32 unique_capability_count = 4;

  // Whether zone meets minimum cell requirement
  bool is_valid = 5;

  // Whether zone is at capacity
  bool is_full = 6;

  // Timestamp of statistics calculation
  common.v1.Timestamp calculated_at = 7;
}

// Zone formation request
message ZoneFormationRequest {
  // Requesting cell ID
  string cell_id = 1;

  // Required zone capabilities
  repeated capability.v1.CapabilityType required_capabilities = 2;

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

// Zone formation response
message ZoneFormationResponse {
  // Formed zone (if successful)
  optional Zone zone = 1;

  // Success indicator
  bool success = 2;

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

// Zone membership change
message ZoneMembershipChange {
  // Zone ID
  string zone_id = 1;

  // Change type
  enum ChangeType {
    CHANGE_TYPE_UNSPECIFIED = 0;
    CHANGE_TYPE_CELL_JOIN = 1;        // Cell joined zone
    CHANGE_TYPE_CELL_LEAVE = 2;       // Cell left zone
    CHANGE_TYPE_COORDINATOR_CHANGE = 3; // Zone coordinator changed
  }

  ChangeType change_type = 2;

  // Cell ID involved in the change
  string cell_id = 3;

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