d-engine-proto 0.2.4

gRPC protocol definitions - for building non-Rust d-engine clients
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

syntax = "proto3";
package d_engine.server.storage;

import "proto/common.proto";

option go_package = "github.com/deventlab/d-engine/proto/server/storage";

message SnapshotChunk {
  // Leader's current term (for leadership validation)
  uint64 leader_term = 1;

  // Leader's node ID (for identification)
  uint32 leader_id = 2;

  // Chunk sequence number (0-based)
  uint32 seq = 3;

  // Total number of chunks in this snapshot
  uint32 total_chunks = 4;

  // Chunk-specific checksum (CRC32)
  bytes chunk_checksum = 5;

  // Snapshot metadata (only present in first chunk)
  optional SnapshotMetadata metadata = 6;

  // Payload data (recommended 4MB chunks)
  bytes data = 7;
}

message SnapshotMetadata {
  d_engine.common.LogId last_included = 1; // The last log index included in the snapshot
  bytes checksum = 2; // SHA-256 checksum// Total number of chunks in this snapshot
}

message SnapshotResponse {
  uint64 term = 1; // Peer's current term (for Leader degradation detection)
  bool success = 2; // Whether the reception is successful
  uint32 next_chunk = 3; // If failed, specify the chunk index to be retransmitted
}

message SnapshotAck {
  // Received chunk sequence number
  uint32 seq = 1;

  // Status of this chunk
  ChunkStatus status = 2;

  // Next requested chunk (for flow control)
  uint32 next_requested = 3;

  enum ChunkStatus {
    ACCEPTED = 0;
    CHECKSUM_MISMATCH = 1;
    OUT_OF_ORDER = 2;
    REQUESTED = 3;
    FAILED = 4;
  }
}

service SnapshotService {
  // Leader-driven snapshot streaming
  rpc InstallSnapshot(stream SnapshotChunk) returns (SnapshotResponse);

  // Learner-driven snapshot streaming
  rpc StreamSnapshot(stream SnapshotAck) returns (stream SnapshotChunk);
}