zync-core 0.6.0

Trust-minimized Zcash light client primitives: verification, scanning, proving
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

// lightwalletd gRPC service protocol
// https://github.com/zcash/lightwalletd/blob/master/walletrpc/service.proto

syntax = "proto3";
package cash.z.wallet.sdk.rpc;

// CompactTx contains the index and hash of a transaction, along with its compact outputs
message CompactTx {
    uint64 index = 1;
    bytes hash = 2;
    uint32 fee = 3;
    repeated CompactSaplingSpend spends = 4;
    repeated CompactSaplingOutput outputs = 5;
    repeated CompactOrchardAction actions = 6;
}

message CompactSaplingSpend {
    bytes nf = 1;
}

message CompactSaplingOutput {
    bytes cmu = 1;
    bytes ephemeralKey = 2;
    bytes ciphertext = 3;
}

message CompactOrchardAction {
    bytes nullifier = 1;
    bytes cmx = 2;
    bytes ephemeralKey = 3;
    bytes ciphertext = 4;
}

// CompactBlock is a compact representation of a block
message CompactBlock {
    uint32 protoVersion = 1;
    uint64 height = 2;
    bytes hash = 3;
    bytes prevHash = 4;
    uint32 time = 5;
    bytes header = 6;
    repeated CompactTx vtx = 7;
    ChainMetadata chainMetadata = 8;
}

message ChainMetadata {
    uint32 saplingCommitmentTreeSize = 1;
    uint32 orchardCommitmentTreeSize = 2;
}

// Block ID message
message BlockID {
    uint64 height = 1;
    bytes hash = 2;
}

// Block range for queries
message BlockRange {
    BlockID start = 1;
    BlockID end = 2;
}

// Raw transaction for sending
message RawTransaction {
    bytes data = 1;
    uint64 height = 2;
}

// Transaction send response
message SendResponse {
    int32 errorCode = 1;
    string errorMessage = 2;
}

// Get address UTXOs
message GetAddressUtxosArg {
    repeated string addresses = 1;
    uint64 startHeight = 2;
    uint32 maxEntries = 3;
}

message GetAddressUtxosReply {
    string address = 1;
    bytes txid = 2;
    int32 index = 3;
    bytes script = 4;
    int64 valueZat = 5;
    uint64 height = 6;
}

message GetAddressUtxosReplyList {
    repeated GetAddressUtxosReply addressUtxos = 1;
}

// Transparent address block filter
message TransparentAddressBlockFilter {
    string address = 1;
    BlockRange range = 2;
}

// Light wallet info
message LightdInfo {
    string version = 1;
    string vendor = 2;
    bool taddrSupport = 3;
    string chainName = 4;
    uint64 saplingActivationHeight = 5;
    string consensusBranchId = 6;
    uint64 blockHeight = 7;
    string gitCommit = 8;
    string branch = 9;
    string buildDate = 10;
    string buildUser = 11;
    uint64 estimatedHeight = 12;
    string zcashdBuild = 13;
    string zcashdSubversion = 14;
}

// Tree state
message TreeState {
    string network = 1;
    uint64 height = 2;
    string hash = 3;
    uint32 time = 4;
    string saplingTree = 5;
    string orchardTree = 6;
}

// Empty message
message Empty {}

// Lightwalletd service definition
service CompactTxStreamer {
    // Get latest block
    rpc GetLatestBlock(ChainSpec) returns (BlockID);

    // Get block by ID
    rpc GetBlock(BlockID) returns (CompactBlock);

    // Get block range (streaming)
    rpc GetBlockRange(BlockRange) returns (stream CompactBlock);

    // Get transaction by txid
    rpc GetTransaction(TxFilter) returns (RawTransaction);

    // Send raw transaction
    rpc SendTransaction(RawTransaction) returns (SendResponse);

    // Get tree state at height
    rpc GetTreeState(BlockID) returns (TreeState);

    // Get address UTXOs
    rpc GetAddressUtxos(GetAddressUtxosArg) returns (GetAddressUtxosReplyList);

    // Stream address UTXOs
    rpc GetAddressUtxosStream(GetAddressUtxosArg) returns (stream GetAddressUtxosReply);

    // Get lightwalletd info
    rpc GetLightdInfo(Empty) returns (LightdInfo);
}

// Chain specification
message ChainSpec {}

// Transaction filter
message TxFilter {
    BlockID block = 1;
    uint64 index = 2;
    bytes hash = 3;
}