generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 2
/
provider-openapi-spec.json
419 lines (419 loc) · 13.7 KB
/
provider-openapi-spec.json
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
{
"openapi" : "3.0.0",
"info" : {
"title" : "Provider API",
"version" : "1.0.0-oas3",
"license" : {
"name" : "Business Source License 1.1",
"url" : "https://github.com/primev/mev-commit/blob/main/LICENSE"
}
},
"paths" : {
"/v1/provider/get_min_stake" : {
"get" : {
"summary" : "GetMinStake",
"description" : "GetMinStake is called by the provider to get the minimum stake required to be in the provider registry.",
"operationId" : "Provider_GetMinStake",
"responses" : {
"200" : {
"description" : "A successful response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/v1StakeResponse"
}
}
}
},
"default" : {
"description" : "An unexpected error response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/googlerpcStatus"
}
}
}
}
}
}
},
"/v1/provider/get_stake" : {
"get" : {
"summary" : "GetStake",
"description" : "GetStake is called by the provider to get its stake in the provider registry.",
"operationId" : "Provider_GetStake",
"responses" : {
"200" : {
"description" : "A successful response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/v1StakeResponse"
}
}
}
},
"default" : {
"description" : "An unexpected error response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/googlerpcStatus"
}
}
}
}
}
}
},
"/v1/provider/receive_bids" : {
"get" : {
"summary" : "ReceiveBids",
"description" : "ReceiveBids is called by the provider to receive bids from the mev-commit node.\nThe mev-commit node will stream bids to the provider as the response. The bid can optionally\nhave the raw transaction payload in it. The order of the transaction hashes will be the same\nas the raw transaction payloads if included.",
"operationId" : "Provider_ReceiveBids",
"responses" : {
"200" : {
"description" : "A successful response.(streaming responses)",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"result" : {
"$ref" : "#/components/schemas/providerapiv1Bid"
},
"error" : {
"$ref" : "#/components/schemas/googlerpcStatus"
}
},
"title" : "Stream result of providerapiv1Bid"
}
}
}
},
"default" : {
"description" : "An unexpected error response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/googlerpcStatus"
}
}
}
}
}
}
},
"/v1/provider/send_processed_bids" : {
"post" : {
"summary" : "SendProcessedBids",
"description" : "SendProcessedBids is called by the provider to send processed bids to the mev-commit node.\nThe provider will stream processed bids to the mev-commit node.",
"operationId" : "Provider_SendProcessedBids",
"responses" : {
"200" : {
"description" : "A successful response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/providerapiv1EmptyMessage"
}
}
}
},
"default" : {
"description" : "An unexpected error response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/googlerpcStatus"
}
}
}
}
},
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/v1BidResponse"
}
}
},
"description" : "Response sent by the provider with the decision on the bid received. (streaming inputs)",
"required" : true
}
}
},
"/v1/provider/stake/{amount}" : {
"post" : {
"summary" : "Stake",
"description" : "Stake is called by the provider to register or add to its stake in the provider registry.",
"operationId" : "Provider_Stake",
"responses" : {
"200" : {
"description" : "A successful response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/v1StakeResponse"
}
}
}
},
"default" : {
"description" : "An unexpected error response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/googlerpcStatus"
}
}
}
}
},
"parameters" : [ {
"name" : "amount",
"description" : "Amount of ETH to stake in the provider registry.",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "blsPublicKeys",
"description" : "BLS public keys of the provider.",
"in" : "query",
"required" : false,
"explode" : true,
"schema" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "^(0x)?[a-fA-F0-9]{96}$"
}
}
} ]
}
},
"/v1/provider/unstake" : {
"post" : {
"summary" : "Unstake",
"description" : "Unstake is called by the provider to request a unstake from the provider registry.",
"operationId" : "Provider_Unstake",
"responses" : {
"200" : {
"description" : "A successful response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/providerapiv1EmptyMessage"
}
}
}
},
"default" : {
"description" : "An unexpected error response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/googlerpcStatus"
}
}
}
}
}
}
},
"/v1/provider/withdraw_stake" : {
"post" : {
"summary" : "WithdrawStake",
"description" : "WithdrawStake is called by the provider to withdraw its stake from the provider registry.",
"operationId" : "Provider_WithdrawStake",
"responses" : {
"200" : {
"description" : "A successful response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/v1WithdrawalResponse"
}
}
}
},
"default" : {
"description" : "An unexpected error response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/googlerpcStatus"
}
}
}
}
}
}
}
},
"components" : {
"schemas" : {
"googlerpcStatus" : {
"type" : "object",
"properties" : {
"code" : {
"type" : "integer",
"format" : "int32"
},
"message" : {
"type" : "string"
},
"details" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/protobufAny"
}
}
}
},
"protobufAny" : {
"type" : "object",
"properties" : {
"@type" : {
"type" : "string"
}
},
"additionalProperties" : { }
},
"providerapiv1Bid" : {
"type" : "object",
"example" : {
"amount" : "1000000000000000000",
"bidDigest" : "9dJinwL+FZ6B1xsIQQo8t8B0ZXJubJwY86l/Yu7yAH159QrPHU0qj2P+YFj+llbuI1ZygdxGsX8+P3byMEA5ig==",
"blockNumber" : 123456,
"decayEndTimestamp" : 1725365302000,
"decayStartTimestamp" : 1725365301000,
"revertingTxHashes" : [ "fe4cb47db3630551beedfbd02a71ecc69fd59758e2ba699606e2d5c74284ffa7" ],
"txHashes" : [ "fe4cb47db3630551beedfbd02a71ecc69fd59758e2ba699606e2d5c74284ffa7", "71c1348f2d7ff7e814f9c3617983703435ea7446de420aeac488bf1de35737e8" ]
},
"properties" : {
"txHashes" : {
"type" : "array",
"items" : {
"type" : "string",
"pattern" : "[a-fA-F0-9]{64}"
},
"description" : "Hex string encoding of the hashes of the transactions that the bidder wants to include in the block."
},
"bidAmount" : {
"type" : "string",
"description" : "Amount of ETH that the bidder is willing to pay to the provider for including the transaction in the block.",
"pattern" : "[0-9]+"
},
"blockNumber" : {
"type" : "string",
"format" : "int64",
"description" : "Max block number that the bidder wants to include the transaction in."
},
"bidDigest" : {
"type" : "string",
"format" : "byte",
"description" : "Digest of the bid message signed by the bidder."
},
"decayStartTimestamp" : {
"type" : "string",
"format" : "int64",
"description" : "Timestamp at which the bid starts decaying."
},
"decayEndTimestamp" : {
"type" : "string",
"format" : "int64",
"description" : "Timestamp at which the bid ends decaying."
},
"revertingTxHashes" : {
"type" : "array",
"items" : {
"type" : "string"
},
"description" : "Optional array of tx hashes that are allowed to revert or be discarded."
},
"rawTransactions" : {
"type" : "array",
"items" : {
"type" : "string"
},
"description" : "Optional array of RLP encoded raw signed transaction payloads that the bidder wants to include in the block."
}
},
"description" : "Signed bid message from bidders to the provider.",
"title" : "Bid message",
"required" : [ "txHashes", "bidAmount", "blockNumber", "bidDigest" ]
},
"providerapiv1EmptyMessage" : {
"type" : "object"
},
"v1BidResponse" : {
"type" : "object",
"example" : {
"bidDigest" : "9dJinwL+FZ6B1xsIQQo8t8B0ZXJubJwY86l/Yu7yAH159QrPHU0qj2P+YFj+llbuI1ZygdxGsX8+P3byMEA5ig==",
"decayDispatchTimestamp" : 1234567890,
"status" : "STATUS_ACCEPTED"
},
"properties" : {
"bidDigest" : {
"type" : "string",
"format" : "byte",
"description" : "Digest of the bid message signed by the bidder."
},
"status" : {
"$ref" : "#/components/schemas/v1BidResponseStatus"
},
"dispatchTimestamp" : {
"type" : "string",
"format" : "int64",
"description" : "Timestamp at which the commitment is accepted by provider and is used to compute the expected revenue from the preconfirmation"
}
},
"description" : "Response sent by the provider with the decision on the bid received.",
"title" : "Bid response",
"required" : [ "bidDigest", "status", "decayDispatchTimestamp" ]
},
"v1BidResponseStatus" : {
"type" : "string",
"enum" : [ "STATUS_ACCEPTED", "STATUS_REJECTED" ]
},
"v1StakeResponse" : {
"type" : "object",
"example" : {
"amount" : "2000000000000000000",
"bls_public_keys" : [ "90000cddeec66a80e00b0ccbb62f12298073603f5209e812abbac7e870482e488dd1bbe533a9d4497ba8b756e1e82b", "80000cddeec66a80e00b0ccbb62f12298073603f5209e812abbac7e870482e488dd1bbe533a9d4497ba8b756e1e82b" ]
},
"properties" : {
"amount" : {
"type" : "string"
},
"blsPublicKeys" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"description" : "Get staked amount for provider in the provider registry.",
"title" : "Stake response"
},
"v1WithdrawalResponse" : {
"type" : "object",
"example" : {
"amount" : "1000000000000000000"
},
"properties" : {
"amount" : {
"type" : "string"
}
},
"description" : "Withdrawal amount for provider in the provider registry.",
"title" : "Withdrawal response"
}
}
}
}