hermez-node/api/swagger.yml
api/swagger.ymlRaw
1openapi: 3.0.0
2info:
3 description: |
4 This API server is the layer that allows 3rd party apps and services interfacing with the coordinator to explore, monitor and use the Hermez rollup.
5 Example of these apps are:
6 * Wallet: send L2 transactions, check balance, ...
7 * Explorer: List transactions, slots, batches, ...
8 * Exchange integrations
9
10 ### Pagination
11
12 #### Usage
13
14 All the endpoints that return a list of undefined size use pagination. Unless the opposite is explicitly said.
15 In order to use pagination, three query parameters are used:
16 * `fromItem`: indicates the first item to be returned. In general, this parameter shouldn't be provided in the first call to the endpoint, and use the `itemId` of the last returned item (+/-) 1, if the order is (ascending/descending).
17 * `order`: all pginated items are ordered chronologicaly. However the specific fields to guarantee this order depend on each endpoint. For this purpose, `itemId` is used (itemId follows ascending chronological order except for unforged L1 user transactions). If the parameter is not provided, ascending order will be used by default.
18 * `limit`: maximum amount of items to include in each response. Default is 20, maximum 2049.
19
20 Responses for those endpoint will always include a `pagination` object. This object includes the total amount of items that the endpoint will return at a given time with the given filters. Apart from that, it also includes the `itemId` of the last and first items that will be returned (not in a single response but within the total items). These two properties can be used to know when to stop querying.
21
22 #### Reorgs and safetyness
23
24 Since all the items are ordered chronologicaly, there are no safety problems when fetching items in ascending order, except for reorgs (more on this later).
25 On the other hand, when iterating in descending order, new items will be added at the beginning. This doesn't cause any safety problem, but to get those new items, it's necessary to start queryng without the `fromItem` set to `pagination.lastItem`.
26 To handle reorgs, the `itemId` can be used since it will change. This is important since other identifiers may be the same but with different content. As an example, if the batch 424 get's reorged, it will be deleted, but eventualy, a new batch 424 will appear with potentialy different content.
27
28 ### Signatures
29
30 The POST endpoint require to be signed using BabyJubJub or Ethereum keys. TODO: add references to libraries / examples / ...
31
32 version: "0.0.1"
33 title: Hermez Network API
34# termsOfService: 'http://swagger.io/terms/'
35# contact:
36# email: apiteam@swagger.io
37# license:
38# name: Apache 2.0
39# url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
40externalDocs:
41 description: Find out more about Hermez.
42 url: 'https://hermez.io'
43servers:
44 - description: Hosted mock up
45 url: http://167.71.59.190:4010
46 - description: Localhost mock Up
47 url: http://localhost:4010
48tags:
49 - name: Account
50 description: Hermez account and the tokens it holds.
51 externalDocs:
52 description: Find out more.
53 url: 'https://idocs.hermez.io/#/spec/zkrollup/README?id=account-types'
54 - name: Transaction
55 description: Send tokens off chain and track transactions.
56 externalDocs:
57 description: Find out more
58 url: 'https://idocs.hermez.io/#/spec/zkrollup/README?id=transaction-types'
59 - name: Hermez status
60 description: Info about operators, tokens, auctions and more.
61 externalDocs:
62 description: Find out more.
63 url: 'https://idocs.hermez.io/#/spec/zkrollup/README'
64paths:
65 '/account-creation-authorization':
66 post:
67 tags:
68 - Account
69 summary: Send an authorization that will allow the coordinator to register accounts associated to an Ethereum address on behalf of the user.
70 description: >-
71 Send an authorization to create rollup accounts associated to an Ethereum address. Each account creation (an account can only hold a specific token) is effective once the coordinator forges the corresponding L1CoordinatorTx (which are always of type *account creation*).
72 operationId: postRegister
73 requestBody:
74 description: Account creation authorization.
75 required: true
76 content:
77 application/json:
78 schema:
79 $ref: '#/components/schemas/AccountCreationAuthorizationPost'
80 responses:
81 '200':
82 description: Successful operation.
83 '400':
84 description: Bad request.
85 content:
86 application/json:
87 schema:
88 $ref: '#/components/schemas/Error400'
89 '500':
90 description: Internal server error.
91 content:
92 application/json:
93 schema:
94 $ref: '#/components/schemas/Error500'
95 '/account-creation-authorization/{hezEthereumAddress}':
96 get:
97 tags:
98 - Account
99 summary: Get to know if the coordinator has the ability to create accounts associated to an Ethereum address.
100 description: >-
101 True if the coordinator has the required authorization to perform an account creation with the given Ethereum address on behalf of the Ethereum address holder.
102 operationId: getAccountCreationAuthorization
103 parameters:
104 - name: hezEthereumAddress
105 in: path
106 description: Ethereum address.
107 required: true
108 schema:
109 $ref: '#/components/schemas/HezEthereumAddress'
110 responses:
111 '200':
112 description: Successful operation.
113 content:
114 application/json:
115 schema:
116 $ref: '#/components/schemas/AccountCreationAuthorization'
117 '400':
118 description: Bad request.
119 content:
120 application/json:
121 schema:
122 $ref: '#/components/schemas/Error400'
123 '404':
124 description: Not found.
125 content:
126 application/json:
127 schema:
128 $ref: '#/components/schemas/Error404'
129 '500':
130 description: Internal server error.
131 content:
132 application/json:
133 schema:
134 $ref: '#/components/schemas/Error500'
135 '/accounts':
136 get:
137 tags:
138 - Account
139 summary: Get accounts balances and other associated information.
140 description: Get accounts balances and other associated information.
141 operationId: getAccounts
142 parameters:
143 - name: hezEthereumAddress
144 in: query
145 description: Only get accounts associated to an Ethereum address. Incompatible with the query `BJJ`.
146 required: false
147 schema:
148 $ref: '#/components/schemas/HezEthereumAddress'
149 - name: BJJ
150 in: query
151 description: Only get accounts associated to a BabyJubJub public key. Incompatible with the query `hezEthereumAddress`.
152 required: false
153 schema:
154 $ref: '#/components/schemas/BJJ'
155 - name: tokenIds
156 in: query
157 required: false
158 description: Only get accounts of specific tokens.
159 schema:
160 type: string
161 description: Comma separated list of token identifiers.
162 example: "3,87,91"
163 - name: fromItem
164 in: query
165 required: false
166 description: Indicates the desired first item (using the itemId property) to be included in the response.
167 schema:
168 type: number
169 - name: order
170 in: query
171 required: false
172 description: Order of the returned items. Accounts will be ordered by increasing account index.
173 schema:
174 type: string
175 default: ASC
176 enum:
177 - ASC
178 - DESC
179 - name: limit
180 in: query
181 required: false
182 description: Maximum number of items to be returned.
183 schema:
184 type: integer
185 minimum: 1
186 maximum: 2049
187 responses:
188 '200':
189 description: Successful operation.
190 content:
191 application/json:
192 schema:
193 $ref: '#/components/schemas/Accounts'
194 '400':
195 description: Bad request.
196 content:
197 application/json:
198 schema:
199 $ref: '#/components/schemas/Error400'
200 '404':
201 description: Not found.
202 content:
203 application/json:
204 schema:
205 $ref: '#/components/schemas/Error404'
206 '500':
207 description: Internal server error.
208 content:
209 application/json:
210 schema:
211 $ref: '#/components/schemas/Error500'
212 '/accounts/{accountIndex}':
213 get:
214 tags:
215 - Account
216 summary: Get an account by its index.
217 description: Get an account by its index.
218 operationId: getAccount
219 parameters:
220 - name: accountIndex
221 in: path
222 description: Identifier of an account.
223 required: true
224 schema:
225 $ref: '#/components/schemas/AccountIndex'
226 responses:
227 '200':
228 description: Successful operation.
229 content:
230 application/json:
231 schema:
232 $ref: '#/components/schemas/Account'
233 '400':
234 description: Bad request.
235 content:
236 application/json:
237 schema:
238 $ref: '#/components/schemas/Error400'
239 '404':
240 description: Not found.
241 content:
242 application/json:
243 schema:
244 $ref: '#/components/schemas/Error404'
245 '500':
246 description: Internal server error.
247 content:
248 application/json:
249 schema:
250 $ref: '#/components/schemas/Error500'
251 '/exits':
252 get:
253 tags:
254 - Account
255 summary: Get exit information. This information is required to perform a withdraw.
256 description: Get exit information. This information is required to perform a withdraw.
257 operationId: getExits
258 parameters:
259 - name: tokenId
260 in: query
261 required: false
262 description: Only get exits of specific token
263 schema:
264 $ref: '#/components/schemas/TokenId'
265 - name: hezEthereumAddress
266 in: query
267 description: Get exits associated to a Ethereum address. Incompatible with query `BJJ` and `accountIndex`.
268 required: false
269 schema:
270 $ref: '#/components/schemas/HezEthereumAddress'
271 - name: BJJ
272 in: query
273 description: Get exits associated to a BabyJubJub public key. Incompatible with query `hezEthereumAddress` and `accountIndex`.
274 required: false
275 schema:
276 $ref: '#/components/schemas/BJJ'
277 - name: accountIndex
278 in: query
279 description: Get exits associated to a specific account. Incompatible with queries `tokenId`, `hezEthereumAddress` and `BJJ`.
280 required: false
281 schema:
282 $ref: '#/components/schemas/AccountIndex'
283 - name: batchNum
284 in: query
285 description: Get exits from the exit tree of a specific batch.
286 required: false
287 schema:
288 $ref: '#/components/schemas/BatchNum'
289 - name: fromItem
290 in: query
291 required: false
292 description: Indicates the desired first item (using the itemId property) to be included in the response.
293 schema:
294 type: number
295 - name: order
296 in: query
297 required: false
298 description: Order of the returned items. Exits will be ordered by increasing (batchNum, accountIndex).
299 schema:
300 type: string
301 default: ASC
302 enum:
303 - ASC
304 - DESC
305 - name: limit
306 in: query
307 required: false
308 description: Maximum number of items to be returned.
309 schema:
310 type: integer
311 minimum: 1
312 maximum: 2049
313 responses:
314 '200':
315 description: Successful operation.
316 content:
317 application/json:
318 schema:
319 $ref: '#/components/schemas/Exits'
320 '400':
321 description: Bad request.
322 content:
323 application/json:
324 schema:
325 $ref: '#/components/schemas/Error400'
326 '404':
327 description: Not found.
328 content:
329 application/json:
330 schema:
331 $ref: '#/components/schemas/Error404'
332 '500':
333 description: Internal server error.
334 content:
335 application/json:
336 schema:
337 $ref: '#/components/schemas/Error500'
338 '/exits/{batchNum}/{accountIndex}':
339 get:
340 tags:
341 - Account
342 summary: Get specific exit information.
343 description: Get exit information form a specific exit tree and account. This information is required to perform a withdraw. Exits are identified with accounIndex and batchNum since every batch that has exits has a different exit tree.
344 operationId: getExit
345 parameters:
346 - name: batchNum
347 in: path
348 description: Batch of the exit tree.
349 required: true
350 schema:
351 $ref: '#/components/schemas/BatchNum'
352 - name: accountIndex
353 in: path
354 description: Account identifier.
355 required: true
356 schema:
357 $ref: '#/components/schemas/AccountIndex'
358 responses:
359 '200':
360 description: Successful operation.
361 content:
362 application/json:
363 schema:
364 $ref: '#/components/schemas/Exit'
365 '400':
366 description: Bad request.
367 content:
368 application/json:
369 schema:
370 $ref: '#/components/schemas/Error400'
371 '404':
372 description: Not found.
373 content:
374 application/json:
375 schema:
376 $ref: '#/components/schemas/Error404'
377 '500':
378 description: Internal server error.
379 content:
380 application/json:
381 schema:
382 $ref: '#/components/schemas/Error500'
383 '/transactions-pool':
384 post:
385 tags:
386 - Transaction
387 summary: Add an L2 transaction to the coordinator's pool
388 description: >-
389 Send L2 transaction. The transaction will be stored in the transaction pool of the coordinator and eventually forged.
390 operationId: postTx
391 requestBody:
392 description: Signed transaction.
393 required: true
394 content:
395 application/json:
396 schema:
397 $ref: '#/components/schemas/PostPoolL2Transaction'
398 responses:
399 '200':
400 description: Successful operation.
401 content:
402 application/json:
403 schema:
404 $ref: '#/components/schemas/TransactionId'
405 '400':
406 description: Bad request.
407 content:
408 application/json:
409 schema:
410 $ref: '#/components/schemas/Error400'
411 '500':
412 description: Internal server error.
413 content:
414 application/json:
415 schema:
416 $ref: '#/components/schemas/Error500'
417 '/transactions-pool/{id}':
418 get:
419 tags:
420 - Transaction
421 summary: Get details and status of a transaction that is in the pool.
422 description: >-
423 Get transaction from the pool by its id. This endpoint is specially useful for tracking the status of a transaction that may not be forged yet.
424 Only transactions from the pool will be returned.
425 Note that the transaction pool is different for each coordinator and therefore only a coordinator that has received a specific transaction
426 will be able to provide information about that transaction.
427 operationId: getPoolTx
428 parameters:
429 - name: id
430 in: path
431 description: Transaction identifier.
432 required: true
433 schema:
434 $ref: '#/components/schemas/TransactionId'
435 responses:
436 '200':
437 description: Successful operation.
438 content:
439 application/json:
440 schema:
441 $ref: '#/components/schemas/PoolL2Transaction'
442 '400':
443 description: Bad request.
444 content:
445 application/json:
446 schema:
447 $ref: '#/components/schemas/Error400'
448 '404':
449 description: Not found.
450 content:
451 application/json:
452 schema:
453 $ref: '#/components/schemas/Error404'
454 '500':
455 description: Internal server error.
456 content:
457 application/json:
458 schema:
459 $ref: '#/components/schemas/Error500'
460 '/transactions-history':
461 get:
462 tags:
463 - Transaction
464 summary: Get details and status of transactions that have been forged.
465 description: >-
466 Get historical transactions. This endpoint will return all the different types of transactions except for:
467 - Transactions that are still in the transaction pool of any coordinator. These transactions can be fetched using `GET /transactions-pool/{id}`.
468 - L1 transactions sent by users that have not been forged yet. These transactions can be fetched using `GET /transactions-history/{id}`.
469 operationId: getHistoryTxs
470 parameters:
471 - name: tokenId
472 in: query
473 required: false
474 description: Only get transactions of specific token
475 schema:
476 $ref: '#/components/schemas/TokenId'
477 - name: hezEthereumAddress
478 in: query
479 required: false
480 description: Only get transactions sent from or to an account associated to an Ethereum address Incompatible with the queries `BJJ` and `accountIndex`.
481 schema:
482 $ref: '#/components/schemas/HezEthereumAddress'
483 - name: BJJ
484 in: query
485 description: Only get transactions associated to a BabyJubJub public key. Incompatible with the queries `hezEthereumAddress` and `accountIndex`.
486 required: false
487 schema:
488 $ref: '#/components/schemas/BJJ'
489 - name: accountIndex
490 in: query
491 required: false
492 description: Only get transactions sent from or to a specific account. Incompatible with the queries `tokenId`, `hezEthereumAddress` and `BJJ`.
493 schema:
494 $ref: '#/components/schemas/AccountIndex'
495 - name: batchNum
496 in: query
497 required: false
498 description: Only get transactions forged in a specific batch.
499 schema:
500 $ref: '#/components/schemas/BatchNum'
501 - name: type
502 in: query
503 required: false
504 description: Only get transactions of a specific type.
505 schema:
506 $ref: '#/components/schemas/TransactionType'
507 - name: fromItem
508 in: query
509 required: false
510 description: Indicates the desired first item (using the itemId property) to be included in the response.
511 schema:
512 type: number
513 - name: order
514 in: query
515 required: false
516 description: Order of the returned items. History transactions will be ordered by (batchNum, position).
517 schema:
518 type: string
519 default: ASC
520 enum:
521 - ASC
522 - DESC
523 - name: limit
524 in: query
525 required: false
526 description: Maximum number of items to be returned.
527 schema:
528 type: integer
529 minimum: 1
530 maximum: 2049
531 responses:
532 '200':
533 description: Successful operation.
534 content:
535 application/json:
536 schema:
537 $ref: '#/components/schemas/HistoryTransactions'
538 '400':
539 description: Bad request.
540 content:
541 application/json:
542 schema:
543 $ref: '#/components/schemas/Error400'
544 '404':
545 description: Not found.
546 content:
547 application/json:
548 schema:
549 $ref: '#/components/schemas/Error404'
550 '500':
551 description: Internal server error.
552 content:
553 application/json:
554 schema:
555 $ref: '#/components/schemas/Error500'
556 '/transactions-history/{id}':
557 get:
558 tags:
559 - Transaction
560 summary: Get details and status of a historical transaction.
561 description: >-
562 Get transaction from the history by its id. This endpoint will return all the different types of transactions except those that are still in the pool of any coordinator.
563 operationId: getHistoryTx
564 parameters:
565 - name: id
566 in: path
567 description: Transaction identifier.
568 required: true
569 schema:
570 $ref: '#/components/schemas/TransactionId'
571 responses:
572 '200':
573 description: Successful operation.
574 content:
575 application/json:
576 schema:
577 $ref: '#/components/schemas/HistoryTransaction'
578 '400':
579 description: Bad request.
580 content:
581 application/json:
582 schema:
583 $ref: '#/components/schemas/Error400'
584 '404':
585 description: Not found.
586 content:
587 application/json:
588 schema:
589 $ref: '#/components/schemas/Error404'
590 '500':
591 description: Internal server error.
592 content:
593 application/json:
594 schema:
595 $ref: '#/components/schemas/Error500'
596 '/batches':
597 get:
598 tags:
599 - Hermez status
600 summary: Get information about forged batches.
601 description: >-
602 Get information about forged batches.
603 operationId: getBatches
604 parameters:
605 - name: minBatchNum
606 in: query
607 required: false
608 description: Include only `batchNum < minBatchNum` batches.
609 schema:
610 $ref: '#/components/schemas/BatchNum'
611 - name: maxBatchNum
612 in: query
613 required: false
614 description: Include only `batchNum > maxBatchNum` batches.
615 schema:
616 type: number
617 - name: slotNum
618 in: query
619 required: false
620 description: Include only batches that were forged within the specified slot.
621 schema:
622 $ref: '#/components/schemas/SlotNum'
623 - name: forgerAddr
624 in: query
625 required: false
626 description: Include only batches forged by `forgerAddr`
627 schema:
628 $ref: '#/components/schemas/EthereumAddress'
629 - name: fromItem
630 in: query
631 required: false
632 description: Indicates the desired first item (using the itemId property) to be included in the response.
633 schema:
634 type: number
635 - name: order
636 in: query
637 required: false
638 description: Order of the returned items. Batches will be ordered by increasing `batchNum`.
639 schema:
640 type: string
641 default: ASC
642 enum:
643 - ASC
644 - DESC
645 - name: limit
646 in: query
647 required: false
648 description: Maximum number of items to be returned.
649 schema:
650 type: integer
651 minimum: 1
652 maximum: 2049
653 responses:
654 '200':
655 description: Successful operation.
656 content:
657 application/json:
658 schema:
659 $ref: '#/components/schemas/Batches'
660 '400':
661 description: Bad request.
662 content:
663 application/json:
664 schema:
665 $ref: '#/components/schemas/Error400'
666 '404':
667 description: Not found.
668 content:
669 application/json:
670 schema:
671 $ref: '#/components/schemas/Error404'
672 '500':
673 description: Internal server error.
674 content:
675 application/json:
676 schema:
677 $ref: '#/components/schemas/Error500'
678 '/batches/{batchNum}':
679 get:
680 tags:
681 - Hermez status
682 summary: Get a specific batch.
683 description: >-
684 Get a specific batch.
685 operationId: getBatch
686 parameters:
687 - name: batchNum
688 in: path
689 description: Batch identifier.
690 required: true
691 schema:
692 $ref: '#/components/schemas/BatchNum'
693 responses:
694 '200':
695 description: Successful operation
696 content:
697 application/json:
698 schema:
699 $ref: '#/components/schemas/Batch'
700 '400':
701 description: Bad request.
702 content:
703 application/json:
704 schema:
705 $ref: '#/components/schemas/Error400'
706 '404':
707 description: Not found.
708 content:
709 application/json:
710 schema:
711 $ref: '#/components/schemas/Error404'
712 '500':
713 description: Internal server error.
714 content:
715 application/json:
716 schema:
717 $ref: '#/components/schemas/Error500'
718 '/full-batches/{batchNum}':
719 get:
720 tags:
721 - Hermez status
722 summary: Get a full batch
723 description: >-
724 Get a specific batch, including the associated transactions. The object returned in this method can be a bit heavy.
725 If you're devloping a front end, you may consider using a combinaton of `GET /batches/{batchnum}` and `GET /history-transactions?batchNum={batchNum}`.
726 operationId: getFullBatch
727 parameters:
728 - name: batchNum
729 in: path
730 description: Batch identifier
731 required: true
732 schema:
733 $ref: '#/components/schemas/BatchNum'
734 responses:
735 '200':
736 description: successful operation
737 content:
738 application/json:
739 schema:
740 $ref: '#/components/schemas/FullBatch'
741 '400':
742 description: Bad request.
743 content:
744 application/json:
745 schema:
746 $ref: '#/components/schemas/Error400'
747 '404':
748 description: Not found.
749 content:
750 application/json:
751 schema:
752 $ref: '#/components/schemas/Error404'
753 '500':
754 description: Internal server error.
755 content:
756 application/json:
757 schema:
758 $ref: '#/components/schemas/Error500'
759 '/slots':
760 get:
761 tags:
762 - Hermez status
763 summary: Get information about slots.
764 description: >-
765 Get information about slots.
766 operationId: getSlots
767 parameters:
768 - name: minSlotNum
769 in: query
770 required: false
771 description: Only include batches with `slotNum < minSlotNum`.
772 schema:
773 $ref: '#/components/schemas/SlotNum'
774 - name: maxSlothNum
775 in: query
776 required: false
777 description: Only include batches with `slotNum > maxSlotNum`.
778 schema:
779 $ref: '#/components/schemas/SlotNum'
780 - name: wonByEthereumAddress
781 in: query
782 required: false
783 description: Only include slots won by a coordinator whose `forgerAddr == wonByEthereumAddress`.
784 schema:
785 $ref: '#/components/schemas/EthereumAddress'
786 - name: finishedAuction
787 in: query
788 required: false
789 description: If set to true, only include slots whose auction has finished.
790 schema:
791 type: boolean
792 - name: fromItem
793 in: query
794 required: false
795 description: Indicates the desired first item (using the itemId property) to be included in the response.
796 schema:
797 type: number
798 - name: order
799 in: query
800 required: false
801 description: Order of the returned items. Slots will be ordered by increasing `slotNum`.
802 schema:
803 type: string
804 default: ASC
805 enum:
806 - ASC
807 - DESC
808 - name: limit
809 in: query
810 required: false
811 description: Maximum number of items to be returned.
812 schema:
813 type: integer
814 minimum: 1
815 maximum: 2049
816 responses:
817 '200':
818 description: Successful operation.
819 content:
820 application/json:
821 schema:
822 $ref: '#/components/schemas/Slots'
823 '400':
824 description: Bad request.
825 content:
826 application/json:
827 schema:
828 $ref: '#/components/schemas/Error400'
829 '404':
830 description: Not found.
831 content:
832 application/json:
833 schema:
834 $ref: '#/components/schemas/Error404'
835 '500':
836 description: Internal server error.
837 content:
838 application/json:
839 schema:
840 $ref: '#/components/schemas/Error500'
841 '/slots/{slotNum}':
842 get:
843 tags:
844 - Hermez status
845 summary: Get information about a specific slot.
846 description: >-
847 Get information about a specific slot.
848 operationId: getSlot
849 parameters:
850 - name: slotNum
851 in: path
852 required: true
853 description: Identifier of the slot.
854 schema:
855 $ref: '#/components/schemas/SlotNum'
856 responses:
857 '200':
858 description: Successful operation.
859 content:
860 application/json:
861 schema:
862 $ref: '#/components/schemas/Slot'
863 '400':
864 description: Bad request.
865 content:
866 application/json:
867 schema:
868 $ref: '#/components/schemas/Error400'
869 '404':
870 description: Not found.
871 content:
872 application/json:
873 schema:
874 $ref: '#/components/schemas/Error404'
875 '500':
876 description: Internal server error.
877 content:
878 application/json:
879 schema:
880 $ref: '#/components/schemas/Error500'
881 '/bids':
882 get:
883 tags:
884 - Hermez status
885 summary: Get a list of bids made for a specific slot auction.
886 description: Get a list of bids made for a specific slot auction.
887 operationId: getSlotBids
888 parameters:
889 - name: slotNum
890 in: query
891 description: Slot identifier. Specify the auction where the returned bids were made.
892 required: false
893 schema:
894 $ref: '#/components/schemas/SlotNum'
895 - name: forgerAddr
896 in: query
897 description: Get only bids made by a coordinator identified by its forger address.
898 required: false
899 schema:
900 $ref: '#/components/schemas/EthereumAddress'
901 - name: fromItem
902 in: query
903 required: false
904 description: Indicates the desired first item (using the itemId property) to be included in the response.
905 schema:
906 type: number
907 - name: order
908 in: query
909 required: false
910 description: Order of the returned items. Bids will be ordered by increasing (slotNum, bidValue)`.
911 schema:
912 type: string
913 default: ASC
914 enum:
915 - ASC
916 - DESC
917 - name: limit
918 in: query
919 required: false
920 description: Maximum number of items to be returned.
921 schema:
922 type: integer
923 minimum: 1
924 maximum: 2049
925 responses:
926 '200':
927 description: Successful operation
928 content:
929 application/json:
930 schema:
931 $ref: '#/components/schemas/Bids'
932 '400':
933 description: Bad request.
934 content:
935 application/json:
936 schema:
937 $ref: '#/components/schemas/Error400'
938 '404':
939 description: Not found.
940 content:
941 application/json:
942 schema:
943 $ref: '#/components/schemas/Error404'
944 '500':
945 description: Internal server error.
946 content:
947 application/json:
948 schema:
949 $ref: '#/components/schemas/Error500'
950 '/state':
951 get:
952 tags:
953 - Hermez status
954 summary: Return information that represents the current state of the network.
955 description: Return information that represents the current state of the network. It also includes metrics and statistics.
956 operationId: getState
957 responses:
958 '200':
959 description: Successful operation.
960 content:
961 application/json:
962 schema:
963 $ref: '#/components/schemas/State'
964 '400':
965 description: Bad request.
966 content:
967 application/json:
968 schema:
969 $ref: '#/components/schemas/Error400'
970 '500':
971 description: Internal server error.
972 content:
973 application/json:
974 schema:
975 $ref: '#/components/schemas/Error500'
976 '/config':
977 get:
978 tags:
979 - Hermez status
980 summary: Return constant configuration of the network.
981 description: Return constant configuration of the network.
982 operationId: getConfig
983 responses:
984 '200':
985 description: Successful operation.
986 content:
987 application/json:
988 schema:
989 $ref: '#/components/schemas/Config'
990 '500':
991 description: Internal server error.
992 content:
993 application/json:
994 schema:
995 $ref: '#/components/schemas/Error500'
996 '/tokens':
997 get:
998 tags:
999 - Hermez status
1000 summary: Get information of the supported tokens in the Hermez network.
1001 description: Get information of the supported tokens in the Hermez network.
1002 operationId: getTokens
1003 parameters:
1004 - name: ids
1005 in: query
1006 required: false
1007 description: Include only specific tokens by their Hermez identifiers.
1008 schema:
1009 type: string
1010 description: Comma separated list of token identifiers
1011 example: "2,44,689"
1012 - name: symbols
1013 in: query
1014 required: false
1015 description: Include only specific tokens by their symbols.
1016 schema:
1017 type: string
1018 description: Comma separated list of token symbols.
1019 example: "DAI,NEC,UMA"
1020 - name: name
1021 in: query
1022 required: false
1023 description: Include token(s) by their names (or a substring of the name).
1024 schema:
1025 type: string
1026 - name: fromItem
1027 in: query
1028 required: false
1029 description: Indicates the desired first item (using the itemId property) to be included in the response.
1030 schema:
1031 type: number
1032 - name: order
1033 in: query
1034 required: false
1035 description: Order of the returned items. Tokens will be ordered by increasing tokenID.
1036 schema:
1037 type: string
1038 default: ASC
1039 enum:
1040 - ASC
1041 - DESC
1042 - name: limit
1043 in: query
1044 required: false
1045 description: Maximum number of items to be returned.
1046 schema:
1047 type: integer
1048 minimum: 1
1049 maximum: 2049
1050 responses:
1051 '200':
1052 description: Successful operation.
1053 content:
1054 application/json:
1055 schema:
1056 $ref: '#/components/schemas/Tokens'
1057 '400':
1058 description: Bad request.
1059 content:
1060 application/json:
1061 schema:
1062 $ref: '#/components/schemas/Error400'
1063 '404':
1064 description: Not found.
1065 content:
1066 application/json:
1067 schema:
1068 $ref: '#/components/schemas/Error404'
1069 '500':
1070 description: Internal server error.
1071 content:
1072 application/json:
1073 schema:
1074 $ref: '#/components/schemas/Error500'
1075 '/tokens/{id}':
1076 get:
1077 tags:
1078 - Hermez status
1079 summary: Get information of a token supported by Hermez network.
1080 description: Get information of a token supported by Hermez network.
1081 operationId: getToken
1082 parameters:
1083 - name: id
1084 in: path
1085 description: Token identifier
1086 required: true
1087 schema:
1088 $ref: '#/components/schemas/TokenId'
1089 responses:
1090 '200':
1091 description: Successful operation.
1092 content:
1093 application/json:
1094 schema:
1095 $ref: '#/components/schemas/Token'
1096 '400':
1097 description: Bad request.
1098 content:
1099 application/json:
1100 schema:
1101 $ref: '#/components/schemas/Error400'
1102 '404':
1103 description: Not found.
1104 content:
1105 application/json:
1106 schema:
1107 $ref: '#/components/schemas/Error404'
1108 '500':
1109 description: Internal server error.
1110 content:
1111 application/json:
1112 schema:
1113 $ref: '#/components/schemas/Error500'
1114 '/coordinators':
1115 get:
1116 tags:
1117 - Hermez status
1118 summary: Get information about coordinators.
1119 description: Get information about coordinators.
1120 operationId: getCoordinators
1121 parameters:
1122 - name: fromItem
1123 in: query
1124 required: false
1125 description: Indicates the desired first item (using the itemId property) to be included in the response.
1126 schema:
1127 type: number
1128 - name: order
1129 in: query
1130 required: false
1131 description: Order of the returned items. Coordinators will be ordered by increasing (ethereumBlock, forgerAddr).
1132 schema:
1133 type: string
1134 default: ASC
1135 enum:
1136 - ASC
1137 - DESC
1138 - name: limit
1139 in: query
1140 required: false
1141 description: Maximum number of items to be returned.
1142 schema:
1143 type: integer
1144 minimum: 1
1145 maximum: 2049
1146 responses:
1147 '200':
1148 description: Successful operation.
1149 content:
1150 application/json:
1151 schema:
1152 $ref: '#/components/schemas/Coordinators'
1153 '400':
1154 description: Bad request.
1155 content:
1156 application/json:
1157 schema:
1158 $ref: '#/components/schemas/Error400'
1159 '500':
1160 description: Internal server error.
1161 content:
1162 application/json:
1163 schema:
1164 $ref: '#/components/schemas/Error500'
1165 '/coordinators/{bidderAddr}':
1166 get:
1167 tags:
1168 - Hermez status
1169 summary: Get the information of a coordinator.
1170 description: Get the information of a coordinator.
1171 operationId: getCoordinator
1172 parameters:
1173 - name: bidderAddr
1174 in: path
1175 description: Coordinator identifier
1176 required: true
1177 schema:
1178 $ref: '#/components/schemas/EthereumAddress'
1179 responses:
1180 '200':
1181 description: Successful operation.
1182 content:
1183 application/json:
1184 schema:
1185 $ref: '#/components/schemas/Coordinator'
1186 '400':
1187 description: Bad request.
1188 content:
1189 application/json:
1190 schema:
1191 $ref: '#/components/schemas/Error400'
1192 '404':
1193 description: Not found.
1194 content:
1195 application/json:
1196 schema:
1197 $ref: '#/components/schemas/Error404'
1198 '500':
1199 description: Internal server error.
1200 content:
1201 application/json:
1202 schema:
1203 $ref: '#/components/schemas/Error500'
1204components:
1205 schemas:
1206 ItemId:
1207 type: integer
1208 description: Position of the item in the DB. This is useful for pagination, but has nothing to do with the protocol.
1209 PostPoolL2Transaction:
1210 type: object
1211 description: L2 transaction to be posted.
1212 properties:
1213 id:
1214 $ref: '#/components/schemas/TransactionId'
1215 type:
1216 $ref: '#/components/schemas/TransactionTypeL2'
1217 tokenId:
1218 $ref: '#/components/schemas/TokenId'
1219 fromAccountIndex:
1220 $ref: '#/components/schemas/AccountIndex'
1221 toAccountIndex:
1222 type: string
1223 description: >-
1224 Identifier of the destination account. It references the position where the account is inside the state Merkle tree.
1225 The identifier is built using: `hez:` + `token symbol:` + `index`. If this is provided, toHezEthereumAddress and toBjj
1226 must be null. To perform an exit the value hez:EXIT:1 must be used.
1227 example: null
1228 nullable: true
1229 toHezEthereumAddress:
1230 type: string
1231 description: "Address of an Etherum account linked to the Hermez network. If this is provided, toAccountIndex and toBjj must be null."
1232 pattern: "^hez:0x[a-fA-F0-9]{40}$"
1233 example: "hez:0xaa942cfcd25ad4d90a62358b0dd84f33b398262a"
1234 nullable: true
1235 toBjj:
1236 type: string
1237 description: >-
1238 BabyJubJub public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes.
1239 If this is prvided, toAccountIndex must be null and toHezEthereumAddress must be hez:0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF.
1240 pattern: "^hez:[A-Za-z0-9_-]{44}$"
1241 example: null
1242 nullable: true
1243 amount:
1244 allOf:
1245 - $ref: '#/components/schemas/BigInt'
1246 - description: Amount of tokens to be sent.
1247 example: "6300000000000000000"
1248 fee:
1249 $ref: '#/components/schemas/FeeSelector'
1250 nonce:
1251 $ref: '#/components/schemas/Nonce'
1252 signature:
1253 allOf:
1254 - $ref: '#/components/schemas/BJJSignature'
1255 - description: Signature of the transaction. More info [here](https://idocs.hermez.io/#/spec/zkrollup/README?id=l2a-idl2).
1256 - example: "72024a43f546b0e1d9d5d7c4c30c259102a9726363adcc4ec7b6aea686bcb5116f485c5542d27c4092ae0ceaf38e3bb44417639bd2070a58ba1aa1aab9d92c03"
1257 requestFromAccountIndex:
1258 type: string
1259 description: References the `fromAccountIndex` of the requested transaction.
1260 example: null
1261 nullable: true
1262 requestToAccountIndex:
1263 type: string
1264 description: References the `toAccountIndex` of the requested transaction.
1265 example: null
1266 nullable: true
1267 requestToHezEthereumAddress:
1268 type: string
1269 description: References the `toHezEthereumAddress` of the requested transaction.
1270 pattern: "^hez:0x[a-fA-F0-9]{40}$"
1271 example: null
1272 nullable: true
1273 requestToBjj:
1274 type: string
1275 description: References the `toBjj` of the requested transaction.
1276 pattern: "^hez:[A-Za-z0-9_-]{44}$"
1277 example: null
1278 nullable: true
1279 requestTokenId:
1280 type: integer
1281 description: References the `tokenId` of the requested transaction.
1282 example: null
1283 nullable: true
1284 requestAmount:
1285 type: string
1286 description: References the `amount` of the requested transaction.
1287 example: null
1288 nullable: true
1289 requestFee:
1290 type: integer
1291 description: References the `fee` of the requested transaction.
1292 example: null
1293 nullable: true
1294 requestNonce:
1295 type: integer
1296 description: References the `nonce` of the requested transaction.
1297 example: null
1298 nullable: true
1299 required:
1300 - id
1301 - type
1302 - tokenId
1303 - fromAccountIndex
1304 - amount
1305 - fee
1306 - nonce
1307 - signature
1308 PoolL2Transaction:
1309 type: object
1310 properties:
1311 id:
1312 $ref: '#/components/schemas/TransactionId'
1313 type:
1314 $ref: '#/components/schemas/TransactionTypeL2'
1315 fromAccountIndex:
1316 $ref: '#/components/schemas/AccountIndex'
1317 toAccountIndex:
1318 type: string
1319 description: >-
1320 Identifier of the destination account. It references the position where the account is inside the state Merkle tree.
1321 The identifier is built using: `hez:` + `token symbol:` + `index`
1322 example: "hez:DAI:309"
1323 nullable: true
1324 toHezEthereumAddress:
1325 type: string
1326 description: "Address of an Etherum account linked to the Hermez network."
1327 pattern: "^hez:0x[a-fA-F0-9]{40}$"
1328 example: null
1329 nullable: true
1330 toBjj:
1331 type: string
1332 description: "BabyJubJub public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
1333 pattern: "^hez:[A-Za-z0-9_-]{44}$"
1334 example: null
1335 nullable: true
1336 amount:
1337 allOf:
1338 - $ref: '#/components/schemas/BigInt'
1339 - description: Amount of tokens to be sent.
1340 example: "6303020000000000000"
1341 fee:
1342 $ref: '#/components/schemas/FeeSelector'
1343 nonce:
1344 $ref: '#/components/schemas/Nonce'
1345 state:
1346 $ref: '#/components/schemas/PoolL2TransactionState'
1347 signature:
1348 allOf:
1349 - $ref: '#/components/schemas/BJJSignature'
1350 - description: Signature of the transaction. More info [here](https://idocs.hermez.io/#/spec/zkrollup/README?id=l2a-idl2).
1351 - example: "72024a43f546b0e1d9d5d7c4c30c259102a9726363adcc4ec7b6aea686bcb5116f485c5542d27c4092ae0ceaf38e3bb44417639bd2070a58ba1aa1aab9d92c03"
1352 timestamp:
1353 type: string
1354 description: Moment in which the transaction was added to the pool.
1355 format: date-time
1356 batchNum:
1357 type: integer
1358 description: Identifier of a batch. Every new forged batch increments by one the batchNum, starting at 0.
1359 minimum: 0
1360 maximum: 4294967295
1361 nullable: true
1362 example: null
1363 requestFromAccountIndex:
1364 type: string
1365 description: >-
1366 Identifier of an account. It references the position where the account is inside the state Merkle tree.
1367 The identifier is built using: `hez:` + `token symbol:` + `index`
1368 nullable: true
1369 example: null
1370 requestToAccountIndex:
1371 type: string
1372 description: >-
1373 Identifier of an account. It references the position where the account is inside the state Merkle tree.
1374 The identifier is built using: `hez:` + `token symbol:` + `index`
1375 nullable: true
1376 example: null
1377 requestToHezEthereumAddress:
1378 type: string
1379 description: "Address of an Etherum account linked to the Hermez network."
1380 pattern: "^hez:0x[a-fA-F0-9]{40}$"
1381 nullable: true
1382 example: null
1383 requestToBJJ:
1384 type: string
1385 description: "BabyJubJub public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
1386 pattern: "^hez:[A-Za-z0-9_-]{44}$"
1387 nullable: true
1388 example: null
1389 requestTokenId:
1390 type: integer
1391 description: References the `tokenId` of the requested transaction.
1392 example: null
1393 nullable: true
1394 requestAmount:
1395 type: string
1396 description: BigInt is an integer encoded as a string for numbers that are very large.
1397 nullable: true
1398 example: null
1399 requestFee:
1400 type: integer
1401 description: Index of the fee type to select, more info [here](https://idocs.hermez.io/#/spec/zkrollup/fee-table?id=transaction-fee-table).
1402 minimum: 0
1403 maximum: 256
1404 nullable: true
1405 example: null
1406 requestNonce:
1407 type: integer
1408 description: Number that can only be used once per account. Increments by one with each transaction.
1409 minimum: 0
1410 maximum: 1.84467440737096e+19
1411 nullable: true
1412 example: null
1413 token:
1414 $ref: '#/components/schemas/Token'
1415 required:
1416 - id
1417 - type
1418 - fromAccountIndex
1419 - toAccountIndex
1420 - toHezEthereumAddress
1421 - toBjj
1422 - amount
1423 - fee
1424 - nonce
1425 - state
1426 - signature
1427 - timestamp
1428 - batchNum
1429 - requestFromAccountIndex
1430 - requestToAccountIndex
1431 - requestToHezEthereumAddress
1432 - requestToBJJ
1433 - requestTokenId
1434 - requestAmount
1435 - requestFee
1436 - requestNonce
1437 - token
1438 TransactionId:
1439 type: string
1440 description: Identifier for transactions. Used for any kind of transaction (both L1 and L2). More info on how the identifiers are built [here](https://idocs.hermez.io/#/spec/architecture/db/README?id=txid)
1441 example: "0x00000000000001e240004700"
1442 EthereumAddress:
1443 type: string
1444 description: "Address of an Etherum account."
1445 pattern: "^0x[a-fA-F0-9]{40}$"
1446 example: "0xaa942cfcd25ad4d90a62358b0dd84f33b398262a"
1447 HezEthereumAddress:
1448 type: string
1449 description: "Address of an Etherum account linked to the Hermez network."
1450 pattern: "^hez:0x[a-fA-F0-9]{40}$"
1451 example: "hez:0xaa942cfcd25ad4d90a62358b0dd84f33b398262a"
1452 BJJ:
1453 type: string
1454 description: "BabyJubJub public key, encoded as base64 URL (RFC 4648), which result in 33 bytes. The padding byte is replaced by a sum of the encoded bytes."
1455 pattern: "^hez:[A-Za-z0-9_-]{44}$"
1456 example: "hez:rR7LXKal-av7I56Y0dEBCVmwc9zpoLY5ERhy5w7G-xwe"
1457 AccountIndex:
1458 type: string
1459 description: >-
1460 Identifier of an account. It references the position where the account is inside the state Merkle tree.
1461 The identifier is built using: `hez:` + `token symbol:` + `index`
1462 example: "hez:DAI:4444"
1463 TransactionType:
1464 type: string
1465 description: Type of transaction.
1466 enum:
1467 - Exit
1468 - Transfer
1469 - Deposit
1470 - CreateAccountDeposit
1471 - CreateAccountDepositTransfer
1472 - DepositTransfer
1473 - ForceTransfer
1474 - ForceExit
1475 - TransferToEthAddr
1476 - TransferToBJJ
1477 TransactionTypeL2:
1478 type: string
1479 description: Type of transaction.
1480 enum:
1481 - Exit
1482 - Transfer
1483 - TransferToEthAddr
1484 - TransferToBJJ
1485 TokenId:
1486 type: integer
1487 description: Identifier of a token registered in the network.
1488 minimum: 0
1489 maximum: 4294967295
1490 example: 98765
1491 BigInt:
1492 type: string
1493 description: BigInt is an integer encoded as a string for numbers that are very large.
1494 example: "8708856933496328593"
1495 FeeSelector:
1496 type: integer
1497 description: Index of the fee type to select, more info [here](https://idocs.hermez.io/#/spec/zkrollup/fee-table?id=transaction-fee-table).
1498 minimum: 0
1499 maximum: 256
1500 example: 36
1501 Nonce:
1502 type: integer
1503 description: Number that can only be used once per account, increments by one at each transaction.
1504 minimum: 0
1505 maximum: 1.84467440737096e+19
1506 example: 121
1507 PoolL2TransactionState:
1508 type: string
1509 description: >
1510 State of a L2 transaction from the coordinator pool.
1511 * pend: Pending
1512 * fing: Forging
1513 * fged: Forged
1514 * invl: Invalid
1515 enum:
1516 - pend
1517 - fing
1518 - fged
1519 - invl
1520 ETHSignature:
1521 type: string
1522 description: Ethereum signature.
1523 pattern: "^0x[a-fA-F0-9]{130}$"
1524 example: "0xf9161cd688394772d93aa3e7b3f8f9553ca4f94f65b7cece93ed4a239d5c0b4677dca6d1d459e3a5c271a34de735d4664a43e5a8960a9a6e027d12c562dd448e1c"
1525 BJJSignature:
1526 type: string
1527 description: BabyJubJub compressed signature.
1528 pattern: "^[a-fA-F0-9]{128}$"
1529 example: "72024a43f546b0e1d9d5d7c4c30c259102a9726363adcc4ec7b6aea686bcb5116f485c5542d27c4092ae0ceaf38e3bb44417639bd2070a58ba1aa1aab9d92c03"
1530 BatchNum:
1531 type: integer
1532 description: Identifier of a batch. Every new forged batch increments by one the batchNum, starting at 0.
1533 minimum: 0
1534 maximum: 4294967295
1535 example: 5432
1536 AccountCreationAuthorizationPost:
1537 type: object
1538 properties:
1539 hezEthereumAddress:
1540 $ref: '#/components/schemas/HezEthereumAddress'
1541 bjj:
1542 $ref: '#/components/schemas/BJJ'
1543 signature:
1544 $ref: '#/components/schemas/ETHSignature'
1545 required:
1546 - hezEthereumAddress
1547 - bjj
1548 - signature
1549 AccountCreationAuthorization:
1550 type: object
1551 properties:
1552 timestamp:
1553 type: string
1554 format: date-time
1555 hezEthereumAddress:
1556 $ref: '#/components/schemas/HezEthereumAddress'
1557 bjj:
1558 $ref: '#/components/schemas/BJJ'
1559 signature:
1560 $ref: '#/components/schemas/ETHSignature'
1561 required:
1562 - timestamp
1563 - hezEthereumAddress
1564 - bjj
1565 - signature
1566 HistoryTransaction:
1567 type: object
1568 description: Transaction of the Hermez network
1569 properties:
1570 L1orL2:
1571 type: string
1572 enum:
1573 - L1
1574 - L2
1575 id:
1576 $ref: '#/components/schemas/TransactionId'
1577 itemId:
1578 $ref: '#/components/schemas/ItemId'
1579 type:
1580 $ref: '#/components/schemas/TransactionType'
1581 position:
1582 $ref: '#/components/schemas/TransactionPosition'
1583 fromAccountIndex:
1584 type: string
1585 description: >-
1586 Identifier of an account. It references the position where the account is inside the state Merkle tree.
1587 The identifier is built using: `hez:` + `token symbol:` + `index`
1588 example: "hez:DAI:4444"
1589 nullable: true
1590 toAccountIndex:
1591 allOf:
1592 - $ref: '#/components/schemas/AccountIndex'
1593 - example: "hez:DAI:672"
1594 amount:
1595 allOf:
1596 - $ref: '#/components/schemas/BigInt'
1597 - description: Amount of tokens to be sent.
1598 - example: "4903020000000000000"
1599 batchNum:
1600 type: integer
1601 description: Batch in which the transaction was forged. Null indicates not forged yet.
1602 minimum: 0
1603 maximum: 4294967295
1604 example: 5432
1605 nullable: true
1606 historicUSD:
1607 type: number
1608 description: Value in USD at the moment the transaction was forged.
1609 example: 49.7
1610 nullable: true
1611 timestamp:
1612 type: string
1613 format: date-time
1614 description: In the case of L1 indicates the moment where the transaction was added in the smart contract. For L2 indicates when the transaction was forged.
1615 token:
1616 $ref: '#/components/schemas/Token'
1617 L1Info:
1618 type: object
1619 description: Additional information that only applies to L1 transactions.
1620 nullable: true
1621 properties:
1622 toForgeL1TransactionsNum:
1623 $ref: '#/components/schemas/ToForgeL1TransactionsNum'
1624 userOrigin:
1625 type: boolean
1626 description: True if the transaction was sent by a user. False if it was sent by a coordinator.
1627 fromHezEthereumAddress:
1628 $ref: '#/components/schemas/HezEthereumAddress'
1629 fromBJJ:
1630 $ref: '#/components/schemas/BJJ'
1631 loadAmount:
1632 allOf:
1633 - $ref: '#/components/schemas/BigInt'
1634 - description: Tokens transfered from L1 to L2.
1635 - example: "4900000000000000000"
1636 historicLoadAmountUSD:
1637 type: number
1638 description: Load amount in USD, at the moment the transaction was made.
1639 example: 3.897
1640 nullable: true
1641 ethereumBlockNum:
1642 allOf:
1643 - $ref: '#/components/schemas/EthBlockNum'
1644 - description: Ethereum block in which the transaction was added to the smart contract forge queue.
1645 - example: 258723049
1646 required:
1647 - toForgeL1TransactionsNum
1648 - userOrigin
1649 - fromHezEthereumAddress
1650 - fromBJJ
1651 - loadAmount
1652 - historicLoadAmountUSD
1653 - ethereumBlockNum
1654 additionalProperties: false
1655 L2Info:
1656 type: object
1657 description: Additional information that only applies to L2 transactions.
1658 nullable: true
1659 properties:
1660 fee:
1661 $ref: '#/components/schemas/FeeSelector'
1662 historicFeeUSD:
1663 type: number
1664 description: Fee in USD, at the moment the transaction was forged.
1665 example: 263.89
1666 nullable: true
1667 nonce:
1668 $ref: '#/components/schemas/Nonce'
1669 example: null
1670 required:
1671 - fee
1672 - historicFeeUSD
1673 - nonce
1674 additionalProperties: false
1675 required:
1676 - L1orL2
1677 - id
1678 - itemId
1679 - type
1680 - position
1681 - fromAccountIndex
1682 - toAccountIndex
1683 - amount
1684 - batchNum
1685 - historicUSD
1686 - timestamp
1687 - token
1688 - L1Info
1689 - L2Info
1690 additionalProperties: false
1691 HistoryTransactions:
1692 type: object
1693 properties:
1694 transactions:
1695 type: array
1696 description: List of history transactions.
1697 items:
1698 $ref: '#/components/schemas/HistoryTransaction'
1699 pagination:
1700 $ref: '#/components/schemas/PaginationInfo'
1701 required:
1702 - transactions
1703 - pagination
1704 additionalProperties: false
1705 EthBlockNum:
1706 type: integer
1707 description: Ethereum block number
1708 minimum: 0
1709 maximum: 1.84467440737096e+19
1710 example: 762375478
1711 ToForgeL1TransactionsNum:
1712 type: integer
1713 description: Reference to know in which batch a L1 transaction was forged / will be forged.
1714 minimum: 0
1715 maximum: 4294967295
1716 example: 784
1717 nullable: true
1718 TransactionPosition:
1719 type: integer
1720 description: Position that a transaction occupies in a batch.
1721 minimum: 0
1722 example: 5
1723 URL:
1724 type: string
1725 description: HTTP URL
1726 example: "https://hermez.io"
1727 TokenSymbol:
1728 type: string
1729 description: Abreviation of the token name.
1730 example: "DAI"
1731 TokenName:
1732 type: string
1733 description: Token name.
1734 example: "Dai"
1735 CollectedFees:
1736 type: array
1737 description: Collected fees by the forger of the batch. A maximum of 64 different tokens can be used.
1738 items:
1739 type: object
1740 properties:
1741 tokenId:
1742 $ref: '#/components/schemas/TokenId'
1743 amount:
1744 allOf:
1745 - $ref: '#/components/schemas/BigInt'
1746 - description: Ammount of collected tokens
1747 - example: "53"
1748 Batch:
1749 type: object
1750 description: Group of transactions forged in a coordinator and sent and validated in Ethereum.
1751 properties:
1752 batchNum:
1753 $ref: '#/components/schemas/BatchNum'
1754 ethereumBlockNum:
1755 $ref: '#/components/schemas/EthBlockNum'
1756 ethereumBlockHash:
1757 type: string
1758 description: hash of the Ethereum block in which the batch was forged
1759 example: "0xfe88c94d860f01a17f961bf4bdfb6e0c6cd10d3fda5cc861e805ca1240c58553"
1760 timestamp:
1761 type: string
1762 format: date-time
1763 description: Time in which the batch was forged.
1764 forgerAddr:
1765 $ref: '#/components/schemas/EthereumAddress'
1766 collectedFees:
1767 $ref: '#/components/schemas/CollectedFees'
1768 historicTotalCollectedFeesUSD:
1769 type: number
1770 description: Sum of the all the fees collected, in USD, at the moment the batch was forged.
1771 example: 23.3
1772 stateRoot:
1773 allOf:
1774 - $ref: '#/components/schemas/Hash'
1775 - description: Root of the accounts Merkle Tree.
1776 - example: "2734657026572a8708d883"
1777 numAccounts:
1778 type: integer
1779 description: Number of registered accounts in this batch.
1780 exitRoot:
1781 allOf:
1782 - $ref: '#/components/schemas/Hash'
1783 - description: Root of the exit Merkle Tree associated to this batch.
1784 - example: "2734657026572a8708d883"
1785 forgeL1TransactionsNum:
1786 allOf:
1787 - $ref: '#/components/schemas/ToForgeL1TransactionsNum'
1788 - description: Identifier that corresponds to the group of L1 transactions forged in the current batch.
1789 - example: 5
1790 slotNum:
1791 $ref: '#/components/schemas/SlotNum'
1792 FullBatch:
1793 type: object
1794 description: Group of transactions forged in a coordinator and sent and validated in Ethereum.
1795 properties:
1796 batch:
1797 $ref: '#/components/schemas/Batch'
1798 transactions:
1799 type: array
1800 description: List of forged transactions in the batch
1801 items:
1802 $ref: '#/components/schemas/HistoryTransaction'
1803 Hash:
1804 type: string
1805 description: hashed data
1806 example: "2734657026572a8708d883"
1807 SlotNum:
1808 type: integer
1809 description: Identifier of a slot.
1810 minimum: 0
1811 maximum: 4294967295
1812 example: 784
1813 Batches:
1814 type: object
1815 properties:
1816 batches:
1817 type: array
1818 description: List of batches.
1819 items:
1820 $ref: '#/components/schemas/Batch'
1821 pagination:
1822 $ref: '#/components/schemas/PaginationInfo'
1823 Coordinator:
1824 type: object
1825 properties:
1826 itemId:
1827 $ref: '#/components/schemas/ItemId'
1828 forgerAddr:
1829 $ref: '#/components/schemas/EthereumAddress'
1830 bidderAddr:
1831 $ref: '#/components/schemas/EthereumAddress'
1832 URL:
1833 $ref: '#/components/schemas/URL'
1834 ethereumBlock:
1835 allOf:
1836 - $ref: '#/components/schemas/EthBlockNum'
1837 - description: Ethereum block in which the coordinator registered into the network.
1838 - example: 5735943738
1839 additionalProperties: false
1840 required:
1841 - itemId
1842 - forgerAddr
1843 - bidderAddr
1844 - URL
1845 - ethereumBlock
1846 Coordinators:
1847 type: object
1848 properties:
1849 coordinators:
1850 type: array
1851 description: List of coordinators.
1852 items:
1853 $ref: '#/components/schemas/Coordinator'
1854 pagination:
1855 $ref: '#/components/schemas/PaginationInfo'
1856 additionalProperties: false
1857 required:
1858 - coordinators
1859 - pagination
1860 Bid:
1861 type: object
1862 description: Tokens placed in an auction by a coordinator to gain the right to forge batches during a specific slot.
1863 properties:
1864 forgerAddr:
1865 $ref: '#/components/schemas/EthereumAddress'
1866 slotNum:
1867 $ref: '#/components/schemas/SlotNum'
1868 withdrawAddr:
1869 $ref: '#/components/schemas/EthereumAddress'
1870 URL:
1871 $ref: '#/components/schemas/URL'
1872 bidValue:
1873 $ref: '#/components/schemas/BigInt'
1874 ethereumBlockNum:
1875 $ref: '#/components/schemas/EthBlockNum'
1876 timestamp:
1877 type: string
1878 format: date-time
1879 Bids:
1880 type: object
1881 properties:
1882 bids:
1883 type: array
1884 description: List of bids.
1885 items:
1886 $ref: '#/components/schemas/Bid'
1887 pagination:
1888 $ref: '#/components/schemas/PaginationInfo'
1889 RecommendedFee:
1890 type: object
1891 description: Fee that the coordinator recommends per transaction in USD.
1892 properties:
1893 existingAccount:
1894 type: number
1895 description: Recommended fee if the destination account of the transaction already exists.
1896 minimum: 0
1897 example: 0.1
1898 createAccount:
1899 type: number
1900 description: Recommended fee if the destination account of the transaction doesn't exist, but the coordinator has an authorization to create a valid account associated to an Ethereum address and a BJJ public key controlled by the receiver.
1901 minimum: 0
1902 example: 1.3
1903 createAccountInternal:
1904 type: number
1905 description: Recommended fee if the destination account of the transaction doesn't exist, but the coordinator has the ability to create a valid account associated to a BJJ public key controlled by the receiver. Note that these kind of accounts are not associated to an Ethereum address and therefore can only operate in L2.
1906 minimum: 0
1907 example: 0.5
1908 Token:
1909 type: object
1910 description: Hermez network compatible and registered token.
1911 properties:
1912 id:
1913 $ref: '#/components/schemas/TokenId'
1914 ethereumAddress:
1915 allOf:
1916 - $ref: '#/components/schemas/EthereumAddress'
1917 - description: Ethereum address in which the token is deployed.
1918 - example: "0xaa942cfcd25ad4d90a62358b0dd84f33b398262a"
1919 itemId:
1920 $ref: '#/components/schemas/ItemId'
1921 name:
1922 type: string
1923 description: full name of the token
1924 example: Maker Dai
1925 symbol:
1926 allOf:
1927 - $ref: '#/components/schemas/TokenSymbol'
1928 - example: DAI
1929 decimals:
1930 type: integer
1931 description: Number of decimals of the token.
1932 example: 18
1933 ethereumBlockNum:
1934 allOf:
1935 - $ref: '#/components/schemas/EthBlockNum'
1936 - description: Ethereum block number in which the token was added to the Hermez network.
1937 - example: 539847538
1938 USD:
1939 type: number
1940 description: Value of the token in USD.
1941 example: 1.01
1942 nullable: true
1943 fiatUpdate:
1944 type: string
1945 format: date-time
1946 description: Timestamp of the moment the `USD` value was updated.
1947 nullable: true
1948 required:
1949 - id
1950 - ethereumAddress
1951 - itemId
1952 - name
1953 - symbol
1954 - decimals
1955 - ethereumBlockNum
1956 - USD
1957 - fiatUpdate
1958 additionalProperties: false
1959 Tokens:
1960 type: object
1961 properties:
1962 tokens:
1963 type: array
1964 description: List of tokens.
1965 items:
1966 $ref: '#/components/schemas/Token'
1967 pagination:
1968 $ref: '#/components/schemas/PaginationInfo'
1969 Exit:
1970 type: object
1971 description: Exit tree leaf. It Contains the necessary information to perform a withdrawal.
1972 properties:
1973 batchNum:
1974 allOf:
1975 - $ref: '#/components/schemas/BatchNum'
1976 - description: Batch in which the exit was forged.
1977 - example: 7394
1978 accountIndex:
1979 $ref: '#/components/schemas/AccountIndex'
1980 itemId:
1981 $ref: '#/components/schemas/ItemId'
1982 merkleProof:
1983 type: object
1984 description: Existence proof of a leaf in a given Merkle Root. Encoded as hexadecimal string.
1985 properties:
1986 Root:
1987 $ref: '#/components/schemas/BigInt'
1988 Siblings:
1989 type: array
1990 items:
1991 $ref: '#/components/schemas/BigInt'
1992 OldKey:
1993 $ref: '#/components/schemas/BigInt'
1994 OldValue:
1995 $ref: '#/components/schemas/BigInt'
1996 IsOld0:
1997 type: boolean
1998 Key:
1999 $ref: '#/components/schemas/BigInt'
2000 Value:
2001 $ref: '#/components/schemas/BigInt'
2002 Fnc:
2003 type: integer
2004 maximum: 3
2005 minimum: 0
2006 required:
2007 - Root
2008 - Siblings
2009 - OldKey
2010 - OldValue
2011 - IsOld0
2012 - Key
2013 - Value
2014 - Fnc
2015 additionalProperties: false
2016 balance:
2017 $ref: '#/components/schemas/BigInt'
2018 instantWithdrawn:
2019 type: integer
2020 description: Block in which the exit balance was instantly withdrawn. Null indicates that an instant withdrawn hasn't been performed.
2021 minimum: 0
2022 maximum: 1.84467440737096e+19
2023 example: 74747363
2024 nullable: true
2025 delayedWithdrawRequest:
2026 type: integer
2027 description: Block in which the exit balance was requested to delay withdraw. Null indicates that a delay withdraw hasn't been performed.
2028 minimum: 0
2029 maximum: 1.84467440737096e+19
2030 example: null
2031 nullable: true
2032 delayedWithdrawn:
2033 type: integer
2034 description: Block in which the exit balance was delayed withdrawn after a delay withdraw request. Null indicates that a delay withdraw hasn't been performed.
2035 minimum: 0
2036 maximum: 1.84467440737096e+19
2037 example: null
2038 nullable: true
2039 token:
2040 $ref: '#/components/schemas/Token'
2041 required:
2042 - batchNum
2043 - accountIndex
2044 - itemId
2045 - merkleProof
2046 - balance
2047 - instantWithdrawn
2048 - delayedWithdrawRequest
2049 - delayedWithdrawn
2050 - token
2051 additionalProperties: false
2052 Exits:
2053 type: object
2054 properties:
2055 exits:
2056 type: array
2057 description: List of exits.
2058 items:
2059 $ref: '#/components/schemas/Exit'
2060 pagination:
2061 $ref: '#/components/schemas/PaginationInfo'
2062 required:
2063 - exits
2064 - pagination
2065 additionalProperties: false
2066 Account:
2067 type: object
2068 description: State tree leaf. It contains balance and nonce of an account.
2069 properties:
2070 accountIndex:
2071 $ref: '#/components/schemas/AccountIndex'
2072 nonce:
2073 $ref: '#/components/schemas/Nonce'
2074 balance:
2075 $ref: '#/components/schemas/BigInt'
2076 bjj:
2077 $ref: '#/components/schemas/BJJ'
2078 hezEthereumAddress:
2079 $ref: '#/components/schemas/HezEthereumAddress'
2080 token:
2081 $ref: '#/components/schemas/Token'
2082 Accounts:
2083 type: object
2084 properties:
2085 accounts:
2086 type: array
2087 description: List of accounts.
2088 items:
2089 $ref: '#/components/schemas/Account'
2090 pagination:
2091 $ref: '#/components/schemas/PaginationInfo'
2092 Slot:
2093 type: object
2094 description: Slot information.
2095 properties:
2096 slotNum:
2097 $ref: '#/components/schemas/SlotNum'
2098 firstBlock:
2099 allOf:
2100 - $ref: '#/components/schemas/EthBlockNum'
2101 - description: Block in which the slot began or will begin
2102 - example: 76238647846
2103 lastBlock:
2104 allOf:
2105 - $ref: '#/components/schemas/EthBlockNum'
2106 - description: Block in which the slot ended or will end
2107 - example: 4475934
2108 closedAuction:
2109 type: boolean
2110 description: Whether the auction of the slot has finished or not.
2111 winner:
2112 allOf:
2113 - $ref: '#/components/schemas/Coordinator'
2114 - description: Coordinator who won the auction. Only applicable if the auction is closed.
2115 - nullable: true
2116 - example: null
2117 Slots:
2118 type: object
2119 properties:
2120 nextForgers:
2121 type: array
2122 description: List of slots.
2123 items:
2124 $ref: '#/components/schemas/Slot'
2125 pagination:
2126 $ref: '#/components/schemas/PaginationInfo'
2127 NextForger:
2128 type: object
2129 description: Coordinator information along with the scheduled forging period
2130 properties:
2131 coordinator:
2132 $ref: '#/components/schemas/Coordinator'
2133 period:
2134 type: object
2135 description: Time period in which the coordinator will have the ability to forge. Specified both in Ethereum blocks and timestamp
2136 properties:
2137 fromBlock:
2138 $ref: '#/components/schemas/EthBlockNum'
2139 toBlock:
2140 $ref: '#/components/schemas/EthBlockNum'
2141 fromTimestamp:
2142 type: string
2143 format: date-time
2144 toTimestamp:
2145 type: string
2146 format: date-time
2147 NextForgers:
2148 type: object
2149 properties:
2150 nextForgers:
2151 type: array
2152 description: List of next coordinators to forge.
2153 items:
2154 $ref: '#/components/schemas/NextForger'
2155 pagination:
2156 $ref: '#/components/schemas/PaginationInfo'
2157 State:
2158 type: object
2159 description: Gobal statistics of the network.
2160 properties:
2161 lastBlock:
2162 allOf:
2163 - $ref: '#/components/schemas/EthBlockNum'
2164 - description: Last synchronized Etherum block.
2165 - example: 3457437
2166 lastBatch:
2167 allOf:
2168 - $ref: '#/components/schemas/BatchNum'
2169 - description: Last batch that has been forged.
2170 - example: 76523
2171 currentSlot:
2172 allOf:
2173 - $ref: '#/components/schemas/SlotNum'
2174 - description: Slot where batches are currently being forged.
2175 - example: 2334
2176 transactionsPerBatch:
2177 type: number
2178 description: Average transactions per batch in the last 24 hours.
2179 example: 2002.7
2180 batchFrequency:
2181 type: number
2182 description: Average elapsed time between batches in the last 24 hours, in seconds.
2183 example: 8.9
2184 transactionsPerSecond:
2185 type: number
2186 description: Average transactions per second in the last 24 hours.
2187 example: 302.3
2188 totalAccounts:
2189 type: integer
2190 description: Number of created accounts.
2191 example: 90473
2192 totalBJJs:
2193 type: integer
2194 description: Number of different registered BJJs.
2195 example: 23067
2196 avgTransactionFee:
2197 type: number
2198 description: Average fee percentage paid for L2 transactions in the last 24 hours.
2199 example: 1.54
2200 nextForgers:
2201 $ref: '#/components/schemas/NextForgers'
2202 recommendedFee:
2203 $ref: '#/components/schemas/RecommendedFee'
2204 governance:
2205 type: object
2206 description: Network setings that are updatable by the governance.
2207 properties:
2208 rollup:
2209 type: object
2210 description: Rollup parameters.
2211 properties:
2212 forgeTimeout:
2213 type: integer
2214 description: Time delay between the beggining of a slot and the beggining of the period in which anyone can forge if the auction winner of the slot hasn't forged any batch yet. Time is measured in Ethereum blocks.
2215 example: 5
2216 feeAddToken:
2217 type: integer
2218 description: fee to pay when registering tokens into the network.
2219 example: 5698
2220 auction:
2221 type: object
2222 description: Auction parameters.
2223 properties:
2224 bootCoordinator:
2225 allOf:
2226 - $ref: '#/components/schemas/EthereumAddress'
2227 - description: Ethereum address of the boot coordinator.
2228 - example: "0x997dc4262BCDbf85190C01c996b4C06a461d2430"
2229 slotDeadline:
2230 type: integer
2231 description: Number of blocks at the end of a slot in which any coordinator can forge if the winner has not forged one before.
2232 example: 3
2233 closedAuctionSlots:
2234 type: integer
2235 description: Amount of slots between the current slot and the slot auction that is closed. Example if the value is 2, when slot 10 begins, the auction of the slot 12 gets closed.
2236 example: 2
2237 openAuctionSlots:
2238 type: integer
2239 description: How many days in advance are auctions opened.
2240 defaultSlotSetBid:
2241 type: array
2242 description: "Initial minimal bid for each auction. Expressed as an array of 6 values. To calculate which value corresponds to each slot: `initialMinimalBidding[slotNum%6]`."
2243 items:
2244 type: integer
2245 example: [32,0,68,21,55,99]
2246 outbidding:
2247 type: number
2248 description: Minimum outbid over the previous one to consider it valid.
2249 example: 3.64
2250 donationAddress:
2251 allOf:
2252 - $ref: '#/components/schemas/EthereumAddress'
2253 - description: Ethereum address where the donations will go to.
2254 - example: "0x887dc4262BCDbf85190C01c996b4C06a461d2430"
2255 allocationRatio:
2256 type: array
2257 description: Percentage in which fees will be splitted between donations, governance and burning. The sum of the tree values should be 100.
2258 items:
2259 type: integer
2260 example: [80,10,10]
2261 withdrawalDelayer:
2262 type: object
2263 description: Withdrawal delayer parameters.
2264 properties:
2265 rollupAddress:
2266 allOf:
2267 - $ref: '#/components/schemas/EthereumAddress'
2268 - description: Ethereum address of the rollup smart contract.
2269 - example: "0x777dc4262BCDbf85190C01c996b4C06a461d2430"
2270 governanceAddress:
2271 allOf:
2272 - $ref: '#/components/schemas/EthereumAddress'
2273 - description: Ethereum address of the governance mechanism.
2274 - example: "0x667dc4262BCDbf85190C01c996b4C06a461d2430"
2275 whitheHackerGroupAddress:
2276 allOf:
2277 - $ref: '#/components/schemas/EthereumAddress'
2278 - description: Ethereum Address that can claim the funds in an emergency when the maximum emergency mode time is exceeded.
2279 - example: "0x557dc4262BCDbf85190C01c996b4C06a461d2430"
2280 keeperAddress:
2281 allOf:
2282 - $ref: '#/components/schemas/EthereumAddress'
2283 - description: Ethereum Address that can enable emergency mode and modify the delay to make a withdrawal.
2284 - example: "0x557dc4262BCDbf85190C01c996b4C06a461d2430"
2285 withdrawalDelay:
2286 allOf:
2287 - $ref: '#/components/schemas/EthBlockNum'
2288 - description: The time that anyone needs to wait until a withdrawal of the funds is allowed, in Ethereum blocks.
2289 - example: 539573849
2290 emergencyModeStartingTime:
2291 type: integer
2292 description: Ethereum block in which the emergency mode will be activated.
2293 example: 10
2294 emergencyMode:
2295 type: boolean
2296 description: Indicates if emergency mode has been activated.
2297
2298 PaginationInfo:
2299 type: object
2300 description: Give pagination information
2301 properties:
2302 totalItems:
2303 type: integer
2304 description: Amount of items that the endpoint can return given the filters and the current state of the database.
2305 example: 2048
2306 firstItem:
2307 type: integer
2308 description: The smallest itemId that the endpoint will return with the given filters.
2309 example: 50
2310 lastItem:
2311 type: integer
2312 description: The greatest itemId that the endpoint will return with the given filters.
2313 example: 2130
2314 Config:
2315 type: object
2316 description: Configuration parameters of the different smart contracts that power the Hermez network.
2317 properties:
2318 hermez:
2319 type: object
2320 description: Constant configuration of the Hermez smart contract.
2321 properties:
2322 publicConstants:
2323 type: object
2324 description: Public Hermez smart contract constants
2325 properties:
2326 tokenHEZ:
2327 allOf:
2328 - $ref: '#/components/schemas/EthereumAddress'
2329 - description: Ethereum address of the HEZ token.
2330 - example: "0x444dc4262BCDbf85190C01c996b4C06a461d2430"
2331 absoluteMaxL1L2BatchTimeout:
2332 type: integer
2333 description: L1L2 Batch Timeout
2334 example: 240
2335 verifiers:
2336 type: array
2337 description: List of verifiers struct
2338 items:
2339 type: object
2340 properties:
2341 maxTx:
2342 type: integer
2343 description: Maximum rollup transactions in a batch
2344 example: 512
2345 nlevels:
2346 type: integer
2347 description: Number of levels of the circuit
2348 example: 32
2349 required:
2350 - maxTx
2351 - nlevels
2352 additionalProperties: false
2353 hermezAuctionContract:
2354 allOf:
2355 - $ref: '#/components/schemas/EthereumAddress'
2356 - description: Ethereum address of the auction smart contract.
2357 - example: "0x111dc4262BCDbf85190C01c996b4C06a461d2430"
2358 hermezGovernanceDAOAddress:
2359 allOf:
2360 - $ref: '#/components/schemas/EthereumAddress'
2361 - description: Ethereum address of the governanceDAO.
2362 - example: "0x222dc4262BCDbf85190C01c996b4C06a461d2430"
2363 safetyAddress:
2364 allOf:
2365 - $ref: '#/components/schemas/EthereumAddress'
2366 - description: Ethereum address of the safety.
2367 - example: "0x333dc4262BCDbf85190C01c996b4C06a461d2430"
2368 withdrawDelayerContract:
2369 allOf:
2370 - $ref: '#/components/schemas/EthereumAddress'
2371 - description: Ethereum address of the withdraw delayer contracts.
2372 - example: "0x444dc4262BCDbf85190C01c996b4C06a461d2430"
2373 required:
2374 - tokenHEZ
2375 - absoluteMaxL1L2BatchTimeout
2376 - verifiers
2377 - hermezAuctionContract
2378 - hermezGovernanceDAOAddress
2379 - safetyAddress
2380 - withdrawDelayerContract
2381 additionalProperties: false
2382 maxFeeIdxCoordinator:
2383 type: integer
2384 description: is the maximum number of tokens the coordinator can use to collect fees.
2385 example: 64
2386 reservedIdx:
2387 type: integer
2388 description: First 256 indexes reserved, first user index will be the 256.
2389 example: 255
2390 exitIdx:
2391 type: integer
2392 description: Account index used to indicate that a transaction is an `exit` or `force exit`.
2393 example: 1
2394 limitLoadAmount:
2395 type: integer
2396 description: Maximum load amount (L1 to L2) allowed.
2397 example: 321
2398 limitL2TransferAmount:
2399 type: integer
2400 description: Maximum amount (L2 to L2) allowed.
2401 example: 837
2402 limitTokens:
2403 type: integer
2404 description: Maximum number of different tokens that can be registered in the network.
2405 example: 4294967295
2406 l1CoordinatorTotalBytes:
2407 type: integer
2408 description: Number of bytes that a L1 coordinator transaction has ([4 bytes] token + [32 bytes] babyjub + [65 bytes] compressedSignature).
2409 example: 101
2410 l1UserTotalBytes:
2411 type: integer
2412 description: Number of bytes that a L1 user transaction has ([20 bytes] fromEthAddr + [32 bytes] fromBjj-compressed + [6 bytes] fromIdx + [2 bytes] loadAmountFloat16 + [2 bytes] amountFloat16 + [4 bytes] tokenId + [6 bytes] toIdx).
2413 example: 72
2414 maxL1UserTx:
2415 type: integer
2416 description: Maximum L1-user transactions allowed to be queued in a batch.
2417 example: 128
2418 maxL1Tx:
2419 type: integer
2420 description: Maximum L1 transactions allowed to be queued in a batch.
2421 example: 256
2422 inputSHAConstantBytes:
2423 type: integer
2424 description: Input SHA constant bytes
2425 example: 18542
2426 numBuckets:
2427 type: integer
2428 description: Number of buckets
2429 example: 5
2430 maxWithdrawalDelay:
2431 type: integer
2432 description: Maximum delay to withdraw tokens. Time is measured in seconds.
2433 example: 2 * 7 * 24 * 60 * 60
2434 exchangeMultiplier:
2435 type: integer
2436 description: exchange multiplier
2437 example: 1e14
2438 required:
2439 - publicConstants
2440 - reservedIdx
2441 - exitIdx
2442 - limitLoadAmount
2443 - limitL2TransferAmount
2444 - limitTokens
2445 - l1CoordinatorTotalBytes
2446 - l1UserTotalBytes
2447 - maxL1UserTx
2448 - maxL1Tx
2449 - inputSHAConstantBytes
2450 - numBuckets
2451 - maxWithdrawalDelay
2452 - exchangeMultiplier
2453 additionalProperties: false
2454 auction:
2455 type: object
2456 description: Constant configuration of the auction smart contract.
2457 properties:
2458 blocksPerSlot:
2459 type: integer
2460 description: Blocks per slot.
2461 initialMinimalBidding:
2462 type: integer
2463 description: Minimum bid when no one has bid yet.
2464 genesisBlockNum:
2465 allOf:
2466 - $ref: '#/components/schemas/EthBlockNum'
2467 - description: Ethereum block number in which the smart contract starts operating.
2468 tokenHEZ:
2469 allOf:
2470 - $ref: '#/components/schemas/EthereumAddress'
2471 - description: Ethereum address of the HEZ token.
2472 - example: "0x333dc4262BCDbf85190C01c996b4C06a461d2430"
2473 hermezRollup:
2474 allOf:
2475 - $ref: '#/components/schemas/EthereumAddress'
2476 - description: Ethereum address of the rollup smart contract.
2477 - example: "0x222dc4262BCDbf85190C01c996b4C06a461d2430"
2478 governanceAddress:
2479 allOf:
2480 - $ref: '#/components/schemas/EthereumAddress'
2481 - description: Ethereum address of the governance.
2482 - example: "0x444dc4262BCDbf85190C01c996b4C06a461d2430"
2483 required:
2484 - blocksPerSlot
2485 - initialMinimalBidding
2486 - genesisBlockNum
2487 - tokenHEZ
2488 - hermezRollup
2489 - governanceAddress
2490 additionalProperties: false
2491 withdrawalDelayer:
2492 type: object
2493 description: Constant configuration of the withdrawal delayer smart contract.
2494 properties:
2495 maxWithdrawalDelay:
2496 type: integer
2497 description: Maximum time delay in which the tokens can be locked in the contract. Time is measured in Ethereum blocks.
2498 example: 200
2499 maxEmergencyModeTime:
2500 type: integer
2501 description: Maximum amount of time in which the contract can be in emergency mode. Time is measured in Ethereum blocks.
2502 example: 2000
2503 hermezRollup:
2504 allOf:
2505 - $ref: '#/components/schemas/EthereumAddress'
2506 - description: Ethereum address of the rollup smart contract.
2507 - example: "0x222dc4262BCDbf85190C01c996b4C06a461d2430"
2508 required:
2509 - maxWithdrawalDelay
2510 - maxEmergencyModeTime
2511 - hermezRollup
2512 additionalProperties: false
2513 required:
2514 - hermez
2515 - auction
2516 - withdrawalDelayer
2517 additionalProperties: false
2518 Error:
2519 type: object
2520 description: Error response.
2521 properties:
2522 message:
2523 type: string
2524 Error400:
2525 allOf:
2526 - $ref: '#/components/schemas/Error'
2527 - example:
2528 message: Invalid signature.
2529 Error404:
2530 allOf:
2531 - $ref: '#/components/schemas/Error'
2532 - example:
2533 message: Item(s) not found.
2534 Error500:
2535 allOf:
2536 - $ref: '#/components/schemas/Error'
2537 - example:
2538 message: Database error.