1+ syntax = "proto3" ;
2+
3+ package ark.v1 ;
4+
5+ import "google/api/annotations.proto" ;
6+
7+ service IndexerService {
8+ rpc GetCommitmentTx (GetCommitmentTxRequest ) returns (GetCommitmentTxResponse ) {
9+ option (google.api.http ) = {
10+ get : "/v1/commitmentTx/{txid}"
11+ };
12+ };
13+ rpc GetForfeitTxs (GetForfeitTxsRequest ) returns (GetForfeitTxsResponse ) {
14+ option (google.api.http ) = {
15+ get : "/v1/commitmentTx/{txid}/forfeitTxs"
16+ };
17+ };
18+ rpc GetConnectors (GetConnectorsRequest ) returns (GetConnectorsResponse ) {
19+ option (google.api.http ) = {
20+ get : "/v1/commitmentTx/{txid}/connectors"
21+ };
22+ };
23+ rpc GetCommitmentTxLeaves (GetCommitmentTxLeavesRequest ) returns (GetCommitmentTxLeavesResponse ) {
24+ option (google.api.http ) = {
25+ get : "/v1/commitmentTx/{txid}/leaves"
26+ };
27+ };
28+ rpc GetVtxoTree (GetVtxoTreeRequest ) returns (GetVtxoTreeResponse ) {
29+ option (google.api.http ) = {
30+ get : "/v1/batch/{batch_outpoint.txid}/{batch_outpoint.vout}/tree"
31+ };
32+ };
33+ rpc GetVtxoTreeLeaves (GetVtxoTreeLeavesRequest ) returns (GetVtxoTreeLeavesResponse ) {
34+ option (google.api.http ) = {
35+ get : "/v1/batch/{batch_outpoint.txid}/{batch_outpoint.vout}/tree/leaves"
36+ };
37+ };
38+ rpc GetVtxos (GetVtxosRequest ) returns (GetVtxosResponse ) {
39+ option (google.api.http ) = {
40+ get : "/v1/getVtxos/{addresses}"
41+ };
42+ };
43+ rpc GetTransactionHistory (GetTransactionHistoryRequest ) returns (GetTransactionHistoryResponse ) {
44+ option (google.api.http ) = {
45+ get : "/v1/history/{address}"
46+ };
47+ };
48+ rpc GetVtxoChain (GetVtxoChainRequest ) returns (GetVtxoChainResponse ) {
49+ option (google.api.http ) = {
50+ get : "/v1/vtxo/{outpoint.txid}/{outpoint.vout}/chain"
51+ };
52+ }
53+ rpc GetVirtualTxs (GetVirtualTxsRequest ) returns (GetVirtualTxsResponse ) {
54+ option (google.api.http ) = {
55+ get : "/v1/virtualTx/{txids}"
56+ };
57+ }
58+ rpc GetSweptCommitmentTx (GetSweptCommitmentTxRequest ) returns (GetSweptCommitmentTxResponse ) {
59+ option (google.api.http ) = {
60+ get : "/v1/commitmentTx/{txid}/swept"
61+ };
62+ }
63+ }
64+
65+ message GetCommitmentTxRequest {
66+ string txid = 1 ;
67+ }
68+ message GetCommitmentTxResponse {
69+ int64 started_at = 1 ;
70+ int64 ended_at = 2 ;
71+ map <uint32 , IndexerBatch > batches = 3 ;
72+ uint64 total_input_amount = 4 ;
73+ int32 total_input_vtxos = 5 ;
74+ uint64 total_output_amount = 6 ;
75+ int32 total_output_vtxos = 7 ;
76+ }
77+
78+ message GetForfeitTxsRequest {
79+ string txid = 1 ;
80+ IndexerPageRequest page = 2 ;
81+ }
82+ message GetForfeitTxsResponse {
83+ repeated string txids = 1 ;
84+ IndexerPageResponse page = 2 ;
85+ }
86+
87+ message GetConnectorsRequest {
88+ string txid = 1 ;
89+ IndexerPageRequest page = 2 ;
90+ }
91+ message GetConnectorsResponse {
92+ repeated IndexerNode connectors = 1 ;
93+ IndexerPageResponse page = 2 ;
94+ }
95+
96+ message GetCommitmentTxLeavesRequest {
97+ string txid = 1 ;
98+ IndexerPageRequest page = 2 ;
99+ }
100+ message GetCommitmentTxLeavesResponse {
101+ repeated IndexerOutpoint leaves = 1 ;
102+ IndexerPageResponse page = 2 ;
103+ }
104+
105+ message GetVtxoTreeRequest {
106+ IndexerOutpoint batch_outpoint = 1 ;
107+ IndexerPageRequest page = 2 ;
108+ }
109+ message GetVtxoTreeResponse {
110+ repeated IndexerNode vtxo_tree = 1 ;
111+ IndexerPageResponse page = 2 ;
112+ }
113+
114+ message GetVtxoTreeLeavesRequest {
115+ IndexerOutpoint batch_outpoint = 1 ;
116+ IndexerPageRequest page = 2 ;
117+ }
118+ message GetVtxoTreeLeavesResponse {
119+ repeated IndexerOutpoint leaves = 1 ;
120+ IndexerPageResponse page = 2 ;
121+ }
122+
123+ message GetVtxosRequest {
124+ repeated string addresses = 1 ;
125+ bool spendable_only = 2 ;
126+ bool spent_only = 3 ;
127+ IndexerPageRequest page = 4 ;
128+ }
129+ message GetVtxosResponse {
130+ repeated IndexerVtxo vtxos = 1 ;
131+ IndexerPageResponse page = 2 ;
132+ }
133+
134+ message GetTransactionHistoryRequest {
135+ string address = 1 ;
136+ int64 start_time = 2 ;
137+ int64 end_time = 3 ;
138+ IndexerPageRequest page = 4 ;
139+ }
140+ message GetTransactionHistoryResponse {
141+ repeated IndexerTxHistoryRecord history = 1 ;
142+ IndexerPageResponse page = 2 ;
143+ }
144+
145+ message GetVtxoChainRequest {
146+ IndexerOutpoint outpoint = 1 ;
147+ IndexerPageRequest page = 2 ;
148+ }
149+ message GetVtxoChainResponse {
150+ repeated IndexerChain chain = 1 ;
151+ int32 depth = 2 ;
152+ string root_commitment_txid = 3 ;
153+ IndexerPageResponse page = 4 ;
154+ }
155+
156+ message GetVirtualTxsRequest {
157+ repeated string txids = 1 ;
158+ IndexerPageRequest page = 2 ;
159+ }
160+ message GetVirtualTxsResponse {
161+ repeated string txs = 1 ;
162+ IndexerPageResponse page = 2 ;
163+ }
164+
165+ message GetSweptCommitmentTxRequest {
166+ string txid = 1 ;
167+ }
168+ message GetSweptCommitmentTxResponse {
169+ repeated string swept_by = 1 ;
170+ }
171+
172+ message SubscribeForAddressesRequest {
173+ repeated string addresses = 1 ;
174+ }
175+ message SubscribeForAddressesResponse {
176+ string address = 1 ;
177+ repeated IndexerVtxo new_vtxos = 2 ;
178+ repeated IndexerVtxo spent_vtxos = 3 ;
179+ }
180+
181+ message IndexerBatch {
182+ uint64 total_output_amount = 1 ;
183+ int32 total_output_vtxos = 2 ;
184+ int64 expires_at = 3 ;
185+ bool swept = 4 ;
186+ }
187+
188+ message IndexerOutpoint {
189+ string txid = 1 ;
190+ uint32 vout = 2 ;
191+ }
192+
193+ message IndexerNode {
194+ string txid = 1 ;
195+ string parent_txid = 3 ;
196+ int32 level = 4 ;
197+ int32 level_index = 5 ;
198+ }
199+
200+ message IndexerVtxo {
201+ IndexerOutpoint outpoint = 1 ;
202+ int64 created_at = 2 ;
203+ int64 expires_at = 3 ;
204+ uint64 amount = 4 ;
205+ string script = 5 ;
206+ bool is_leaf = 6 ;
207+ bool is_swept = 7 ;
208+ bool is_spent = 8 ;
209+ string spent_by = 9 ;
210+ string commitment_txid = 10 ;
211+ }
212+
213+ message IndexerChain {
214+ string txid = 1 ;
215+ repeated IndexerChainedTx spends = 2 ;
216+ int64 expires_at = 3 ;
217+ }
218+
219+ message IndexerChainedTx {
220+ string txid = 1 ;
221+ IndexerChainedTxType type = 2 ;
222+ }
223+
224+ message IndexerTxHistoryRecord {
225+ oneof key {
226+ string commitment_txid = 1 ;
227+ string virtual_txid = 2 ;
228+ }
229+ IndexerTxType type = 3 ;
230+ uint64 amount = 4 ;
231+ int64 created_at = 5 ;
232+ bool is_settled = 6 ;
233+ string settled_by = 7 ;
234+ }
235+
236+ enum IndexerTxType {
237+ INDEXER_TX_TYPE_UNSPECIFIED = 0 ;
238+ INDEXER_TX_TYPE_RECEIVED = 1 ;
239+ INDEXER_TX_TYPE_SENT = 2 ;
240+ }
241+
242+ enum IndexerChainedTxType {
243+ INDEXER_CHAINED_TX_TYPE_UNSPECIFIED = 0 ;
244+ INDEXER_CHAINED_TX_TYPE_VIRTUAL = 1 ;
245+ INDEXER_CHAINED_TX_TYPE_COMMITMENT = 2 ;
246+ }
247+
248+ message IndexerPageRequest {
249+ int32 size = 1 ;
250+ int32 index = 2 ;
251+ }
252+
253+ message IndexerPageResponse {
254+ int32 current = 1 ;
255+ int32 next = 2 ;
256+ int32 total = 3 ;
257+ }
0 commit comments