generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 1
/
bidder-openapi-spec.json
401 lines (401 loc) · 12.2 KB
/
bidder-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
{
"openapi": "3.0.0",
"info": {
"title": "Bidder API",
"version": "1.0.0-alpha-oas3",
"license": {
"name": "Business Source License 1.1",
"url": "https://github.com/primev/mev-commit/blob/main/LICENSE"
}
},
"paths": {
"/v1/bidder/bid": {
"post": {
"summary": "SendBid",
"description": "Send a bid to the bidder mev-commit node.",
"operationId": "Bidder_SendBid",
"responses": {
"200": {
"description": "A successful response.(streaming responses)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"$ref": "#/components/schemas/v1Commitment"
},
"error": {
"$ref": "#/components/schemas/googlerpcStatus"
}
},
"title": "Stream result of v1Commitment"
}
}
}
},
"default": {
"description": "An unexpected error response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/bidderapiv1Bid"
}
}
},
"description": "Unsigned bid message from bidders to the bidder mev-commit node.",
"required": true
}
}
},
"/v1/bidder/deposit/{amount}": {
"post": {
"summary": "Deposit",
"description": "Deposit is called by the bidder node to add deposit in the bidder registry.",
"operationId": "Bidder_Deposit",
"responses": {
"200": {
"description": "A successful response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1DepositResponse"
}
}
}
},
"default": {
"description": "An unexpected error response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
}
}
},
"parameters": [
{
"name": "amount",
"description": "Amount of ETH to be deposited in wei.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "windowNumber",
"description": "Optional window number for querying deposit. If not specified, the current block number is used.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uint64"
}
},
{
"name": "blockNumber",
"description": "Optional block number for querying deposit. If specified, calculate window based on this block number.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uint64"
}
}
]
}
},
"/v1/bidder/get_deposit": {
"get": {
"summary": "GetDeposit",
"description": "GetDeposit is called by the bidder to get its deposit in the bidder registry.",
"operationId": "Bidder_GetDeposit",
"responses": {
"200": {
"description": "A successful response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1DepositResponse"
}
}
}
},
"default": {
"description": "An unexpected error response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
}
}
},
"parameters": [
{
"name": "windowNumber",
"description": "Optional window number for querying deposits. If not specified, the current block number is used.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uint64"
}
}
]
}
},
"/v1/bidder/get_min_deposit": {
"get": {
"summary": "GetMinDeposit",
"description": "GetMinDeposit is called by the bidder to get the minimum deposit required in the bidder registry to make bids.",
"operationId": "Bidder_GetMinDeposit",
"responses": {
"200": {
"description": "A successful response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1DepositResponse"
}
}
}
},
"default": {
"description": "An unexpected error response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
}
}
}
}
},
"/v1/bidder/withdraw": {
"post": {
"summary": "Withdraw",
"description": "Withdraw is called by the bidder to withdraw deposit from the bidder registry.",
"operationId": "Bidder_Withdraw",
"responses": {
"200": {
"description": "A successful response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/v1WithdrawResponse"
}
}
}
},
"default": {
"description": "An unexpected error response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/googlerpcStatus"
}
}
}
}
},
"parameters": [
{
"name": "windowNumber",
"description": "Optional window number for withdrawing deposits. If not specified, the last window number is used.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "uint64"
}
}
]
}
}
},
"components": {
"schemas": {
"bidderapiv1Bid": {
"type": "object",
"example": {
"amount": "1000000000000000000",
"block_number": 123456,
"tx_hashes": [
"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."
},
"amount": {
"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."
},
"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."
}
},
"description": "Unsigned bid message from bidders to the bidder mev-commit node.",
"title": "Bid message",
"required": ["txHashes", "amount", "blockNumber"]
},
"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": {}
},
"v1Commitment": {
"type": "object",
"properties": {
"txHashes": {
"type": "array",
"items": {
"type": "string",
"pattern": "[a-fA-F0-9]{64}"
},
"description": "Hex string encoding of the hash of the transaction that the bidder wants to include in the block."
},
"bidAmount": {
"type": "string",
"description": "Amount of ETH that the bidder has agreed to pay to the provider for including the transaction in the block."
},
"blockNumber": {
"type": "string",
"format": "int64",
"description": "Max block number that the bidder wants to include the transaction in."
},
"receivedBidDigest": {
"type": "string",
"description": "Hex string encoding of digest of the bid message signed by the bidder."
},
"receivedBidSignature": {
"type": "string",
"description": "Hex string encoding of signature of the bidder that sent this bid."
},
"commitmentDigest": {
"type": "string",
"description": "Hex string encoding of digest of the commitment."
},
"commitmentSignature": {
"type": "string",
"description": "Hex string encoding of signature of the commitment signed by the provider confirming this transaction."
},
"providerAddress": {
"type": "string",
"description": "Hex string encoding of the address of the provider that signed the commitment signature."
},
"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."
},
"dispatchTimestamp": {
"type": "string",
"format": "int64",
"description": "Timestamp at which the commitment is published."
}
}
},
"v1DepositResponse": {
"type": "object",
"example": {
"amount": "1000000000000000000",
"window_number": 1
},
"properties": {
"amount": {
"type": "string"
},
"windowNumber": {
"type": "string",
"format": "uint64"
}
},
"description": "Get deposit for bidder in the bidder registry.",
"title": "Deposit response"
},
"v1WithdrawResponse": {
"type": "object",
"example": {
"amount": "1000000000000000000",
"window_number": 1
},
"properties": {
"amount": {
"type": "string"
},
"windowNumber": {
"type": "string",
"format": "uint64"
}
},
"description": "Withdraw deposit from the bidder registry.",
"title": "Withdraw response"
}
}
}
}