f1r3fly-models 0.1.0

Common data model types for the F1r3fly blockchain, including protobuf definitions and Rust implementations
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

syntax = "proto3";
package routing;

// If you are building for other languages "scalapb.proto"
// can be manually obtained here:
// https://raw.githubusercontent.com/scalapb/ScalaPB/master/protobuf/scalapb/scalapb.proto
// make a scalapb directory in this file's location and place it inside

import "scalapb/scalapb.proto";

option (scalapb.options) = {
  package_name: "coop.rchain.comm.protocol.routing"
  flat_package: true
  preserve_unknown_fields: false
};

message Node {
    bytes  id       = 1;
    bytes  host     = 2;
    uint32 tcp_port = 3;
    uint32 udp_port = 4;
}

message Header {
  Node   sender         = 1 [(scalapb.field).no_box = true];
  string networkId      = 2;
}

message Heartbeat {
}

message HeartbeatResponse {
}

message ProtocolHandshake {
  bytes nonce       = 1;
}

message ProtocolHandshakeResponse {
  bytes nonce       = 1;
}

message Packet {
  string typeId  = 1;
  bytes  content = 2;
}

message Disconnect {
}

message Protocol {
    Header header                                                 = 1 [(scalapb.field).no_box = true];
    oneof message {
        Heartbeat                   heartbeat                     = 2;
        ProtocolHandshake           protocol_handshake            = 3;
        ProtocolHandshakeResponse   protocol_handshake_response   = 4;
        Packet                      packet                        = 5;
        Disconnect                  disconnect                    = 6;
    }
}

service TransportLayer {
  rpc Send (TLRequest) returns (TLResponse) {}
  rpc Stream (stream Chunk) returns (TLResponse) {}
}

message TLRequest {
  Protocol protocol = 1 [(scalapb.field).no_box = true];
}

message InternalServerError {
  bytes error = 1;
}

message Ack {
    Header header = 1 [(scalapb.field).no_box = true];
}

message TLResponse {
  oneof payload {
    Ack ack                                 = 1;
    InternalServerError internalServerError = 2;
  }
}

message ChunkHeader {
  Node   sender             = 1 [(scalapb.field).no_box = true];
  string typeId             = 2;
  bool   compressed         = 3;
  int32  contentLength      = 4;
  string networkId          = 5;
}

message ChunkData {
  bytes contentData = 1;
}

message Chunk {
  oneof content {
    ChunkHeader header = 1;
    ChunkData   data   = 2;
  }
}