-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathopenapi.yml
More file actions
1767 lines (1735 loc) · 62.5 KB
/
openapi.yml
File metadata and controls
1767 lines (1735 loc) · 62.5 KB
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: Relayer API
description: |2
# Relayer API
Relayer provides an interface to request input proofs and decryptions for ciphertexts on the Zama
Gateway Chain.
## Overview
### Reading FHE Public Key URLs
| Endpoint | Method | Description |
|-----------|--------|----------------------------------|
| Key URL | `GET` | Returns FHE public key URLs immediately |
### Ciphertext Operations (POST/GET polling)
| Endpoint | POST to submit | GET to poll |
|--------------------------|----------------|--------------------------|
| Input Proof | `/v2/input-proof` | `/v2/input-proof/{jobId}` |
| User Decrypt | `/v2/user-decrypt` | `/v2/user-decrypt/{jobId}` |
| Delegated User Decrypt | `/v2/delegated-user-decrypt` | `/v2/delegated-user-decrypt/{jobId}` |
| Public Decrypt | `/v2/public-decrypt` | `/v2/public-decrypt/{jobId}` |
**Polling flow:**
1. `POST /v2/{endpoint}` — returns `202` with a `jobId`.
2. `GET /v2/{endpoint}/{jobId}` — returns `202` + `Retry-After` while processing.
3. Final `GET` — returns `200` with the result, or `4xx`/`5xx` with an `error.label`.
## Authentication
Pass the `X-API-Key` header with every request. Optional on testnet, required on mainnet.
## Response Format
All responses share a common envelope:
```json
{
"status": "queued" | "succeeded" | "failed",
"requestId": "uuid",
"result": { ... },
"error": { "label": "...", "message": "...", "details": [...] }
}
```
| Field | Present when |
|-----------|-------------------------------------------------------|
| `status` | Always |
| `result` | Success (`200`) |
| `error` | Failure — match on `error.label` (see Error Handling) |
| `details` | Validation errors (`400`) with per-field issues |
The `Retry-After` header appears in two contexts:
| Context | Status | Meaning |
|------------|--------|--------------------------------------|
| Polling | 202 | Suggested interval before next GET |
| Rate limit | 429 | Minimum wait before retrying POST |
Always respect this header to avoid unnecessary requests.
## Error Handling
All error responses include a machine-readable `label` field. Each error response also has one or more named examples you can expand below.
### Fix and retry (client errors)
| Label | HTTP | What to fix |
|-------|------|-------------|
| `malformed_json` | 400 | Fix JSON syntax |
| `missing_fields` | 400 | Add required fields (see `details[]`) |
| `validation_failed` | 400 | Fix field values (see `details[]`) |
| `request_error` | 400 | Fix request body |
| `host_chain_id_not_supported` | 400 | Use supported chain ID |
| `not_allowed_on_host_acl` | 400 | Contact operator to allowlist contract |
| `not_found` | 404 | Check job ID validity |
### Retry with backoff (transient errors)
| Label | HTTP | Guidance |
|-------|------|----------|
| `rate_limited` | 429 | Wait `Retry-After` seconds |
| `host_acl_failed` | 500 | Retry; if persistent, contact operator |
| `readiness_check_timed_out` | 503 | Retry with backoff |
| `response_timed_out` | 503 | Retry with backoff |
| `protocol_paused` | 503 | Wait for unpause |
| `gateway_not_reachable` | 503 | Retry with backoff |
### Contact operator (infrastructure)
| Label | HTTP | Guidance |
|-------|------|----------|
| `internal_server_error` | 500 | Contact operator with `requestId` |
| `insufficient_balance` | 503 | Contact operator |
| `insufficient_allowance` | 503 | Contact operator |
## Conventions
| Value | Format |
|----------------------|---------------------------------------|
| Ethereum addresses | `0x` + 40 hex chars |
| Ciphertext handles | `0x` + 64 hex chars |
| Extra data | Always `"0x00"` |
| Signatures (request) | Raw hex, 130 chars, no `0x` prefix |
| Public keys | Raw hex, min 2 chars, no `0x` prefix |
contact:
name: Zama
url: https://www.zama.ai
license:
name: BSD-3-Clause-Clear
url: https://opensource.org/licenses/BSD-3-Clause-Clear
version: 0.9.0-rc.3
servers:
- url: /
description: Current server
- url: http://localhost:3000
description: Local development
paths:
/v2/keyurl:
get:
tags:
- Key URL
summary: Retrieve FHE key material URLs.
operationId: keyurl_v2
responses:
'200':
description: FHE public key URLs.
content:
application/json:
schema:
$ref: '#/components/schemas/KeyUrlResponseJson'
'500':
description: 'Internal server error. Error label: `internal_server_error`'
content:
application/json:
schema:
$ref: '#/components/schemas/RelayerV2ResponseFailed'
examples:
InternalServerError:
summary: Key URL not yet initialized
value:
error:
label: internal_server_error
message: Key URL not yet initialized
status: failed
/v2/input-proof:
post:
tags:
- Input Proof
summary: Submit input proof verification.
operationId: input_proof_post_v2
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InputProofRequestJson'
required: true
responses:
'202':
description: Request accepted for processing.
content:
application/json:
schema:
$ref: '#/components/schemas/InputProofPostResponseJson'
'400':
description: 'Invalid request. Error label is one of: `malformed_json`, `missing_fields`, `validation_failed`, `request_error`'
content:
application/json:
schema:
$ref: '#/components/schemas/RelayerV2ResponseFailed'
examples:
MalformedJson:
summary: Could not parse request body as JSON
value:
error:
label: malformed_json
message: Could not parse request body as JSON
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
MissingFields:
summary: Required fields are missing
value:
error:
details:
- field: fieldName
issue: Validation issue description
label: missing_fields
message: Required fields are missing
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
RequestError:
summary: Invalid request
value:
error:
label: request_error
message: Invalid request
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ValidationFailed:
summary: Request validation failed
value:
error:
details:
- field: fieldName
issue: Validation issue description
label: validation_failed
message: Request validation failed
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
'429':
description: 'Rate limited. Error label: `rate_limited`'
content:
application/json:
schema:
$ref: '#/components/schemas/RelayerV2ResponseFailed'
examples:
RateLimited:
summary: Too many requests — retry after the Retry-After interval
value:
error:
label: rate_limited
message: Too many requests — retry after the Retry-After interval
status: failed
'500':
description: 'Internal server error. Error label: `internal_server_error`'
content:
application/json:
schema:
$ref: '#/components/schemas/RelayerV2ResponseFailed'
examples:
InternalServerError:
summary: Internal server error
value:
error:
label: internal_server_error
message: Internal server error
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
/v2/input-proof/{job_id}:
get:
tags:
- Input Proof
summary: Check input proof status.
operationId: input_proof_get_v2
parameters:
- name: job_id
in: path
description: Job ID returned from POST request
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Completed.
content:
application/json:
schema:
$ref: '#/components/schemas/InputProofSucceededStatusResponse'
'202':
description: Still processing. Poll again after Retry-After.
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusQueued'
example:
requestId: 550e8400-e29b-41d4-a716-446655440000
status: queued
'400':
description: 'Request failed. Error label: `validation_failed`'
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusFailed'
examples:
ValidationFailed:
summary: Signature is invalid
value:
error:
details:
- field: fieldName
issue: Validation issue description
label: validation_failed
message: Signature is invalid
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
'404':
description: 'Not found. Error label: `not_found`'
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusFailed'
examples:
NotFound:
summary: Request not found
value:
error:
label: not_found
message: Request not found
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
'500':
description: 'Internal server error. Error label: `internal_server_error`'
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusFailed'
examples:
InternalServerError:
summary: Internal server error
value:
error:
label: internal_server_error
message: Internal server error
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
'503':
description: 'Service unavailable. Error label is one of: `response_timed_out`, `protocol_paused`, `insufficient_balance`, `insufficient_allowance`'
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusFailed'
examples:
InsufficientAllowance:
summary: Insufficient allowance for transaction
value:
error:
label: insufficient_allowance
message: Insufficient allowance for transaction
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
InsufficientBalance:
summary: Insufficient balance for transaction
value:
error:
label: insufficient_balance
message: Insufficient balance for transaction
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ProtocolPaused:
summary: Protocol is paused
value:
error:
label: protocol_paused
message: Protocol is paused
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ResponseTimedOut:
summary: Request processing timed out
value:
error:
label: response_timed_out
message: Request processing timed out
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
/v2/user-decrypt:
post:
tags:
- User Decrypt
summary: Submit user decryption.
operationId: user_decrypt_post_v2
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserDecryptRequestJson'
required: true
responses:
'202':
description: Request accepted for processing.
content:
application/json:
schema:
$ref: '#/components/schemas/UserDecryptPostResponseJson'
'400':
description: 'Invalid request. Error label is one of: `malformed_json`, `missing_fields`, `validation_failed`, `request_error`, `host_chain_id_not_supported`'
content:
application/json:
schema:
$ref: '#/components/schemas/RelayerV2ResponseFailed'
examples:
HostChainIdNotSupported:
summary: Chain ID is not supported by this relayer
value:
error:
label: host_chain_id_not_supported
message: Chain ID is not supported by this relayer
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
MalformedJson:
summary: Could not parse request body as JSON
value:
error:
label: malformed_json
message: Could not parse request body as JSON
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
MissingFields:
summary: Required fields are missing
value:
error:
details:
- field: fieldName
issue: Validation issue description
label: missing_fields
message: Required fields are missing
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
RequestError:
summary: Invalid request
value:
error:
label: request_error
message: Invalid request
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ValidationFailed:
summary: Request validation failed
value:
error:
details:
- field: fieldName
issue: Validation issue description
label: validation_failed
message: Request validation failed
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
'429':
description: 'Rate limited. Error label: `rate_limited`'
content:
application/json:
schema:
$ref: '#/components/schemas/RelayerV2ResponseFailed'
examples:
RateLimited:
summary: Too many requests — retry after the Retry-After interval
value:
error:
label: rate_limited
message: Too many requests — retry after the Retry-After interval
status: failed
'500':
description: 'Internal server error. Error label: `internal_server_error`'
content:
application/json:
schema:
$ref: '#/components/schemas/RelayerV2ResponseFailed'
examples:
InternalServerError:
summary: Internal server error
value:
error:
label: internal_server_error
message: Internal server error
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
/v2/user-decrypt/{job_id}:
get:
tags:
- User Decrypt
summary: Check user decryption status.
operationId: user_decrypt_get_v2
parameters:
- name: job_id
in: path
description: Job ID returned from POST request
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Completed.
content:
application/json:
schema:
$ref: '#/components/schemas/UserDecryptSucceededStatusResponse'
'202':
description: Still processing. Poll again after Retry-After.
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusQueued'
example:
requestId: 550e8400-e29b-41d4-a716-446655440000
status: queued
'400':
description: 'Request failed. Error label is one of: `validation_failed`, `not_allowed_on_host_acl`'
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusFailed'
examples:
NotAllowedOnHostAcl:
summary: Contract is not on the host ACL
value:
error:
label: not_allowed_on_host_acl
message: Contract is not on the host ACL
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ValidationFailed:
summary: Signature is invalid
value:
error:
details:
- field: fieldName
issue: Validation issue description
label: validation_failed
message: Signature is invalid
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
'404':
description: 'Not found. Error label: `not_found`'
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusFailed'
examples:
NotFound:
summary: Request not found
value:
error:
label: not_found
message: Request not found
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
'500':
description: 'Internal server error. Error label is one of: `internal_server_error`, `host_acl_failed`'
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusFailed'
examples:
HostAclFailed:
summary: Failed to check host ACL
value:
error:
label: host_acl_failed
message: Failed to check host ACL
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
InternalServerError:
summary: Internal server error
value:
error:
label: internal_server_error
message: Internal server error
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
'503':
description: 'Service unavailable. Error label is one of: `response_timed_out`, `readiness_check_timed_out`, `protocol_paused`, `insufficient_balance`, `insufficient_allowance`'
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusFailed'
examples:
InsufficientAllowance:
summary: Insufficient allowance for transaction
value:
error:
label: insufficient_allowance
message: Insufficient allowance for transaction
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
InsufficientBalance:
summary: Insufficient balance for transaction
value:
error:
label: insufficient_balance
message: Insufficient balance for transaction
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ProtocolPaused:
summary: Protocol is paused
value:
error:
label: protocol_paused
message: Protocol is paused
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ReadinessCheckTimedOut:
summary: Readiness check timed out
value:
error:
label: readiness_check_timed_out
message: Readiness check timed out
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ResponseTimedOut:
summary: Request processing timed out
value:
error:
label: response_timed_out
message: Request processing timed out
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
/v2/delegated-user-decrypt:
post:
tags:
- Delegated User Decrypt
summary: Submit delegated user decryption.
operationId: delegated_user_decrypt_post_v2
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DelegatedUserDecryptRequestJson'
required: true
responses:
'202':
description: Request accepted for processing.
content:
application/json:
schema:
$ref: '#/components/schemas/UserDecryptPostResponseJson'
'400':
description: 'Invalid request. Error label is one of: `malformed_json`, `missing_fields`, `validation_failed`, `request_error`, `host_chain_id_not_supported`'
content:
application/json:
schema:
$ref: '#/components/schemas/RelayerV2ResponseFailed'
examples:
HostChainIdNotSupported:
summary: Chain ID is not supported by this relayer
value:
error:
label: host_chain_id_not_supported
message: Chain ID is not supported by this relayer
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
MalformedJson:
summary: Could not parse request body as JSON
value:
error:
label: malformed_json
message: Could not parse request body as JSON
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
MissingFields:
summary: Required fields are missing
value:
error:
details:
- field: fieldName
issue: Validation issue description
label: missing_fields
message: Required fields are missing
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
RequestError:
summary: Invalid request
value:
error:
label: request_error
message: Invalid request
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ValidationFailed:
summary: Request validation failed
value:
error:
details:
- field: fieldName
issue: Validation issue description
label: validation_failed
message: Request validation failed
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
'429':
description: 'Rate limited. Error label: `rate_limited`'
content:
application/json:
schema:
$ref: '#/components/schemas/RelayerV2ResponseFailed'
examples:
RateLimited:
summary: Too many requests — retry after the Retry-After interval
value:
error:
label: rate_limited
message: Too many requests — retry after the Retry-After interval
status: failed
'500':
description: 'Internal server error. Error label: `internal_server_error`'
content:
application/json:
schema:
$ref: '#/components/schemas/RelayerV2ResponseFailed'
examples:
InternalServerError:
summary: Internal server error
value:
error:
label: internal_server_error
message: Internal server error
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
/v2/delegated-user-decrypt/{job_id}:
get:
tags:
- Delegated User Decrypt
summary: Check delegated user decryption status.
operationId: delegated_user_decrypt_get_v2
parameters:
- name: job_id
in: path
description: Job ID returned from POST request
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Completed.
content:
application/json:
schema:
$ref: '#/components/schemas/UserDecryptSucceededStatusResponse'
'202':
description: Still processing. Poll again after Retry-After.
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusQueued'
example:
requestId: 550e8400-e29b-41d4-a716-446655440000
status: queued
'400':
description: 'Request failed. Error label is one of: `validation_failed`, `not_allowed_on_host_acl`'
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusFailed'
examples:
NotAllowedOnHostAcl:
summary: Contract is not on the host ACL
value:
error:
label: not_allowed_on_host_acl
message: Contract is not on the host ACL
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ValidationFailed:
summary: Signature is invalid
value:
error:
details:
- field: fieldName
issue: Validation issue description
label: validation_failed
message: Signature is invalid
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
'404':
description: 'Not found. Error label: `not_found`'
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusFailed'
examples:
NotFound:
summary: Request not found
value:
error:
label: not_found
message: Request not found
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
'500':
description: 'Internal server error. Error label is one of: `internal_server_error`, `host_acl_failed`'
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusFailed'
examples:
HostAclFailed:
summary: Failed to check host ACL
value:
error:
label: host_acl_failed
message: Failed to check host ACL
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
InternalServerError:
summary: Internal server error
value:
error:
label: internal_server_error
message: Internal server error
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
'503':
description: 'Service unavailable. Error label is one of: `response_timed_out`, `readiness_check_timed_out`, `protocol_paused`, `insufficient_balance`, `insufficient_allowance`'
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusFailed'
examples:
InsufficientAllowance:
summary: Insufficient allowance for transaction
value:
error:
label: insufficient_allowance
message: Insufficient allowance for transaction
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
InsufficientBalance:
summary: Insufficient balance for transaction
value:
error:
label: insufficient_balance
message: Insufficient balance for transaction
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ProtocolPaused:
summary: Protocol is paused
value:
error:
label: protocol_paused
message: Protocol is paused
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ReadinessCheckTimedOut:
summary: Readiness check timed out
value:
error:
label: readiness_check_timed_out
message: Readiness check timed out
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ResponseTimedOut:
summary: Request processing timed out
value:
error:
label: response_timed_out
message: Request processing timed out
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
/v2/public-decrypt:
post:
tags:
- Public Decrypt
summary: Submit public decryption.
operationId: public_decrypt_post_v2
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PublicDecryptRequestJson'
required: true
responses:
'202':
description: Request accepted for processing.
content:
application/json:
schema:
$ref: '#/components/schemas/PublicDecryptPostResponseJson'
'400':
description: 'Invalid request. Error label is one of: `malformed_json`, `missing_fields`, `validation_failed`, `request_error`, `host_chain_id_not_supported`'
content:
application/json:
schema:
$ref: '#/components/schemas/RelayerV2ResponseFailed'
examples:
HostChainIdNotSupported:
summary: Chain ID is not supported by this relayer
value:
error:
label: host_chain_id_not_supported
message: Chain ID is not supported by this relayer
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
MalformedJson:
summary: Could not parse request body as JSON
value:
error:
label: malformed_json
message: Could not parse request body as JSON
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
MissingFields:
summary: Required fields are missing
value:
error:
details:
- field: fieldName
issue: Validation issue description
label: missing_fields
message: Required fields are missing
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
RequestError:
summary: Invalid request
value:
error:
label: request_error
message: Invalid request
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ValidationFailed:
summary: Request validation failed
value:
error:
details:
- field: fieldName
issue: Validation issue description
label: validation_failed
message: Request validation failed
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
'429':
description: 'Rate limited. Error label: `rate_limited`'
content:
application/json:
schema:
$ref: '#/components/schemas/RelayerV2ResponseFailed'
examples:
RateLimited:
summary: Too many requests — retry after the Retry-After interval
value:
error:
label: rate_limited
message: Too many requests — retry after the Retry-After interval
status: failed
'500':
description: 'Internal server error. Error label: `internal_server_error`'
content:
application/json:
schema:
$ref: '#/components/schemas/RelayerV2ResponseFailed'
examples:
InternalServerError:
summary: Internal server error
value:
error:
label: internal_server_error
message: Internal server error
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
/v2/public-decrypt/{job_id}:
get:
tags:
- Public Decrypt
summary: Check public decryption status.
operationId: public_decrypt_get_v2
parameters:
- name: job_id
in: path
description: Job ID returned from POST request
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Completed.
content:
application/json:
schema:
$ref: '#/components/schemas/PublicDecryptSucceededStatusResponse'
'202':
description: Still processing. Poll again after Retry-After.
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusQueued'
example:
requestId: 550e8400-e29b-41d4-a716-446655440000
status: queued
'400':
description: 'Request failed. Error label is one of: `validation_failed`, `not_allowed_on_host_acl`'
content:
application/json:
schema:
$ref: '#/components/schemas/V2StatusFailed'
examples:
NotAllowedOnHostAcl:
summary: Contract is not on the host ACL
value:
error:
label: not_allowed_on_host_acl
message: Contract is not on the host ACL
requestId: 550e8400-e29b-41d4-a716-446655440000
status: failed
ValidationFailed:
summary: Signature is invalid
value:
error:
details:
- field: fieldName
issue: Validation issue description
label: validation_failed
message: Signature is invalid