@eco-foundation/api-schemas 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. package/README.md +160 -0
  2. package/dist/build-digest.d.ts +2 -0
  3. package/dist/build-digest.js +10 -0
  4. package/dist/build-digest.js.map +1 -0
  5. package/dist/fixtures/index.d.ts +14 -0
  6. package/dist/fixtures/index.js +71 -0
  7. package/dist/fixtures/index.js.map +1 -0
  8. package/dist/fixtures/v1/chains-list.response.default.json +37 -0
  9. package/dist/fixtures/v1/deposit-addresses-create.request.gateway-erc20.json +16 -0
  10. package/dist/fixtures/v1/deposit-addresses-create.response.gateway-erc20.json +20 -0
  11. package/dist/fixtures/v1/deposit-addresses-lookup.response.default.json +24 -0
  12. package/dist/fixtures/v1/deposit-addresses-submit-erc-2612.request.deposit-address-target.json +23 -0
  13. package/dist/fixtures/v1/deposit-addresses-submit-erc-3009.request.deposit-address-target.json +24 -0
  14. package/dist/fixtures/v1/intents-status.response.gasless-handoff.json +30 -0
  15. package/dist/fixtures/v1/intents-status.response.intent-filled.json +21 -0
  16. package/dist/fixtures/v1/intents-status.response.unknown.json +20 -0
  17. package/dist/fixtures/v1/intents-status.response.wallet-page.json +27 -0
  18. package/dist/fixtures/v1/intents-submit-erc-3009.response.job.json +25 -0
  19. package/dist/fixtures/v1/intents-submit-permit2.request.quote-target.json +25 -0
  20. package/dist/fixtures/v1/intents-submit-permit3.request.quote-target.json +27 -0
  21. package/dist/fixtures/v1/quotes-create.request.public-swap.json +25 -0
  22. package/dist/fixtures/v1/quotes-create.response.all-quotes.json +455 -0
  23. package/dist/fixtures/v1/quotes-create.response.private-swap.json +152 -0
  24. package/dist/fixtures/v1/quotes-create.response.public-swap.json +158 -0
  25. package/dist/fixtures/v1/routes-list.response.default.json +26 -0
  26. package/dist/fixtures/v1/tokens-list.response.default.json +24 -0
  27. package/dist/generated/build-digest.json +7 -0
  28. package/dist/index.d.ts +6 -0
  29. package/dist/index.js +47 -0
  30. package/dist/index.js.map +1 -0
  31. package/dist/openapi.d.ts +2 -0
  32. package/dist/openapi.js +81 -0
  33. package/dist/openapi.js.map +1 -0
  34. package/dist/scripts/generate-build-digest.d.ts +1 -0
  35. package/dist/scripts/generate-build-digest.js +25 -0
  36. package/dist/scripts/generate-build-digest.js.map +1 -0
  37. package/dist/scripts/generate-openapi.d.ts +1 -0
  38. package/dist/scripts/generate-openapi.js +21 -0
  39. package/dist/scripts/generate-openapi.js.map +1 -0
  40. package/dist/testing/index.d.ts +7 -0
  41. package/dist/testing/index.js +27 -0
  42. package/dist/testing/index.js.map +1 -0
  43. package/dist/v1/endpoints/chains.d.ts +52 -0
  44. package/dist/v1/endpoints/chains.js +23 -0
  45. package/dist/v1/endpoints/chains.js.map +1 -0
  46. package/dist/v1/endpoints/deposit-addresses.d.ts +100 -0
  47. package/dist/v1/endpoints/deposit-addresses.js +61 -0
  48. package/dist/v1/endpoints/deposit-addresses.js.map +1 -0
  49. package/dist/v1/endpoints/quotes.d.ts +861 -0
  50. package/dist/v1/endpoints/quotes.js +297 -0
  51. package/dist/v1/endpoints/quotes.js.map +1 -0
  52. package/dist/v1/endpoints/registry.d.ts +641 -0
  53. package/dist/v1/endpoints/registry.js +108 -0
  54. package/dist/v1/endpoints/registry.js.map +1 -0
  55. package/dist/v1/endpoints/routes.d.ts +35 -0
  56. package/dist/v1/endpoints/routes.js +21 -0
  57. package/dist/v1/endpoints/routes.js.map +1 -0
  58. package/dist/v1/endpoints/status.d.ts +149 -0
  59. package/dist/v1/endpoints/status.js +110 -0
  60. package/dist/v1/endpoints/status.js.map +1 -0
  61. package/dist/v1/endpoints/submit.d.ts +271 -0
  62. package/dist/v1/endpoints/submit.js +127 -0
  63. package/dist/v1/endpoints/submit.js.map +1 -0
  64. package/dist/v1/endpoints/tokens.d.ts +59 -0
  65. package/dist/v1/endpoints/tokens.js +22 -0
  66. package/dist/v1/endpoints/tokens.js.map +1 -0
  67. package/dist/v1/enums.d.ts +133 -0
  68. package/dist/v1/enums.js +62 -0
  69. package/dist/v1/enums.js.map +1 -0
  70. package/dist/v1/errors/catalog.d.ts +247 -0
  71. package/dist/v1/errors/catalog.js +124 -0
  72. package/dist/v1/errors/catalog.js.map +1 -0
  73. package/dist/v1/errors/lock.d.ts +10 -0
  74. package/dist/v1/errors/lock.js +45 -0
  75. package/dist/v1/errors/lock.js.map +1 -0
  76. package/dist/v1/errors/problem.d.ts +50 -0
  77. package/dist/v1/errors/problem.js +82 -0
  78. package/dist/v1/errors/problem.js.map +1 -0
  79. package/dist/v1/index.d.ts +14 -0
  80. package/dist/v1/index.js +32 -0
  81. package/dist/v1/index.js.map +1 -0
  82. package/dist/v1/primitives.d.ts +33 -0
  83. package/dist/v1/primitives.js +63 -0
  84. package/dist/v1/primitives.js.map +1 -0
  85. package/dist/v1/signature.d.ts +10 -0
  86. package/dist/v1/signature.js +72 -0
  87. package/dist/v1/signature.js.map +1 -0
  88. package/dist/v1/tolerant.d.ts +4 -0
  89. package/dist/v1/tolerant.js +11 -0
  90. package/dist/v1/tolerant.js.map +1 -0
  91. package/dist/v1/types.d.ts +277 -0
  92. package/dist/v1/types.js +3 -0
  93. package/dist/v1/types.js.map +1 -0
  94. package/errors/catalog.lock.json +232 -0
  95. package/fixtures/quote-signature/vector-1.json +9 -0
  96. package/fixtures/quote-signature/vector-2.json +13 -0
  97. package/fixtures/quote-signature/vector-3.json +9 -0
  98. package/fixtures/signature-hash/vectors.json +58 -0
  99. package/openapi/v1.json +5225 -0
  100. package/package.json +71 -0
  101. package/v1/types.d.ts +7 -0
  102. package/v1/types.js +5 -0
package/errors/catalog.lock.json ADDED
@@ -0,0 +1,232 @@
1
+ [
2
+ {
3
+ "code": "invalid-request",
4
+ "status": 400,
5
+ "legacyCodes": [
6
+ "eco-quotes:1003"
7
+ ]
8
+ },
9
+ {
10
+ "code": "missing-parameter",
11
+ "status": 400,
12
+ "legacyCodes": [
13
+ "eco-quotes:1026"
14
+ ]
15
+ },
16
+ {
17
+ "code": "invalid-parameter",
18
+ "status": 400,
19
+ "legacyCodes": [
20
+ "eco-quotes:1032",
21
+ "eco-quotes:1033",
22
+ "eco-quotes:1034",
23
+ "deposit-addresses:1017"
24
+ ]
25
+ },
26
+ {
27
+ "code": "slippage-out-of-bounds",
28
+ "status": 400,
29
+ "legacyCodes": []
30
+ },
31
+ {
32
+ "code": "deposit-address-mismatch",
33
+ "status": 400,
34
+ "legacyCodes": []
35
+ },
36
+ {
37
+ "code": "invalid-signature",
38
+ "status": 401,
39
+ "legacyCodes": [
40
+ "eco-quotes:1007",
41
+ "eco-quotes:1008",
42
+ "eco-quotes:1009",
43
+ "eco-quotes:1010",
44
+ "eco-quotes:1011",
45
+ "deposit-addresses:1000",
46
+ "deposit-addresses:1002"
47
+ ]
48
+ },
49
+ {
50
+ "code": "authorization-expired",
51
+ "status": 401,
52
+ "legacyCodes": [
53
+ "eco-quotes:1006",
54
+ "deposit-addresses:1001",
55
+ "deposit-addresses:1018"
56
+ ]
57
+ },
58
+ {
59
+ "code": "invalid-api-key",
60
+ "status": 401,
61
+ "legacyCodes": []
62
+ },
63
+ {
64
+ "code": "api-key-expired",
65
+ "status": 401,
66
+ "legacyCodes": []
67
+ },
68
+ {
69
+ "code": "permission-denied",
70
+ "status": 403,
71
+ "legacyCodes": [
72
+ "eco-quotes:1035"
73
+ ]
74
+ },
75
+ {
76
+ "code": "funder-mismatch",
77
+ "status": 403,
78
+ "legacyCodes": []
79
+ },
80
+ {
81
+ "code": "token-not-found",
82
+ "status": 404,
83
+ "legacyCodes": [
84
+ "eco-quotes:1030"
85
+ ]
86
+ },
87
+ {
88
+ "code": "signature-already-bound",
89
+ "status": 409,
90
+ "legacyCodes": []
91
+ },
92
+ {
93
+ "code": "nonce-used",
94
+ "status": 409,
95
+ "legacyCodes": []
96
+ },
97
+ {
98
+ "code": "quote-expired",
99
+ "status": 410,
100
+ "legacyCodes": [
101
+ "eco-quotes:1027"
102
+ ]
103
+ },
104
+ {
105
+ "code": "no-route-found",
106
+ "status": 422,
107
+ "legacyCodes": [
108
+ "eco-quotes:1016",
109
+ "eco-quotes:1017",
110
+ "eco-quotes:1018"
111
+ ]
112
+ },
113
+ {
114
+ "code": "token-not-supported",
115
+ "status": 422,
116
+ "legacyCodes": [
117
+ "eco-quotes:1029",
118
+ "deposit-addresses:1007"
119
+ ]
120
+ },
121
+ {
122
+ "code": "simulation-failed",
123
+ "status": 422,
124
+ "legacyCodes": []
125
+ },
126
+ {
127
+ "code": "insufficient-funds",
128
+ "status": 422,
129
+ "legacyCodes": [
130
+ "deposit-addresses:1019"
131
+ ]
132
+ },
133
+ {
134
+ "code": "chain-not-supported",
135
+ "status": 422,
136
+ "legacyCodes": [
137
+ "deposit-addresses:1015",
138
+ "deposit-addresses:1016"
139
+ ]
140
+ },
141
+ {
142
+ "code": "chain-pair-unsupported",
143
+ "status": 422,
144
+ "legacyCodes": []
145
+ },
146
+ {
147
+ "code": "amount-too-low",
148
+ "status": 422,
149
+ "legacyCodes": []
150
+ },
151
+ {
152
+ "code": "amount-too-high",
153
+ "status": 422,
154
+ "legacyCodes": []
155
+ },
156
+ {
157
+ "code": "insufficient-liquidity",
158
+ "status": 422,
159
+ "legacyCodes": []
160
+ },
161
+ {
162
+ "code": "insufficient-balance",
163
+ "status": 422,
164
+ "legacyCodes": []
165
+ },
166
+ {
167
+ "code": "insufficient-allowance",
168
+ "status": 422,
169
+ "legacyCodes": []
170
+ },
171
+ {
172
+ "code": "insufficient-gas",
173
+ "status": 422,
174
+ "legacyCodes": []
175
+ },
176
+ {
177
+ "code": "unsupported-authorization",
178
+ "status": 422,
179
+ "legacyCodes": []
180
+ },
181
+ {
182
+ "code": "permit2-approval-missing",
183
+ "status": 422,
184
+ "legacyCodes": []
185
+ },
186
+ {
187
+ "code": "rate-limit-exceeded",
188
+ "status": 429,
189
+ "legacyCodes": []
190
+ },
191
+ {
192
+ "code": "internal-error",
193
+ "status": 500,
194
+ "legacyCodes": [
195
+ "eco-quotes:1000",
196
+ "eco-quotes:1001",
197
+ "eco-quotes:1002",
198
+ "eco-quotes:1004",
199
+ "eco-quotes:1005",
200
+ "eco-quotes:1012",
201
+ "eco-quotes:1013",
202
+ "eco-quotes:1014",
203
+ "eco-quotes:1022",
204
+ "eco-quotes:1023",
205
+ "eco-quotes:1031",
206
+ "deposit-addresses:1003",
207
+ "deposit-addresses:1004",
208
+ "deposit-addresses:1005",
209
+ "deposit-addresses:1006",
210
+ "deposit-addresses:1008",
211
+ "deposit-addresses:1009",
212
+ "deposit-addresses:1010",
213
+ "deposit-addresses:1011",
214
+ "deposit-addresses:1012",
215
+ "deposit-addresses:1013",
216
+ "deposit-addresses:1020"
217
+ ]
218
+ },
219
+ {
220
+ "code": "solver-timeout",
221
+ "status": 502,
222
+ "legacyCodes": [
223
+ "eco-quotes:1024",
224
+ "eco-quotes:1025"
225
+ ]
226
+ },
227
+ {
228
+ "code": "service-unavailable",
229
+ "status": 503,
230
+ "legacyCodes": []
231
+ }
232
+ ]
package/fixtures/quote-signature/vector-1.json ADDED
@@ -0,0 +1,9 @@
1
+ {
2
+ "id": "quote:8f14e45f-ea3c-4c2d-9b6e-1a2b3c4d5e6f",
3
+ "intentHashes": ["0xabababababababababababababababababababababababababababababababab"],
4
+ "expiresAt": 1767225600,
5
+ "sourceChainId": 8453,
6
+ "digest": "0x9a9a5daebf5db14aa39a19a5238ce13adf284c569f5094e4dfef13b3223d3857",
7
+ "signature": "0x7dbe08b01654dc6460f8e76db8d8792e6ccffa591af07e3c21a1442deb65af04128ce8099dde479df56c3ba9b159cfbb65bac01e9d58a26336b173d4f2219f3f1b",
8
+ "signer": "0x1D4b570Cd156b0C0B4778350fE6277750E23e0a6"
9
+ }
package/fixtures/quote-signature/vector-2.json ADDED
@@ -0,0 +1,13 @@
1
+ {
2
+ "id": "quote:2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
3
+ "intentHashes": [
4
+ "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5
+ "0xbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
6
+ "0xcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc"
7
+ ],
8
+ "expiresAt": 1767225600,
9
+ "sourceChainId": 8453,
10
+ "digest": "0x9fed7f60a8256f7b46ee58990facbf67ee9fbce42bc61d7f67226d908d3b857c",
11
+ "signature": "0xa2b3cbf8812a9ee3e6c139f1adfc01ea3ad3fb012f4b00ef968de81a116436f247e6c135a9d6691999025730eb0a792c6e0260740c150d83a80b7ac95f0cf1b41c",
12
+ "signer": "0x1D4b570Cd156b0C0B4778350fE6277750E23e0a6"
13
+ }
package/fixtures/quote-signature/vector-3.json ADDED
@@ -0,0 +1,9 @@
1
+ {
2
+ "id": "quote:8f14e45f-ea3c-4c2d-9b6e-1a2b3c4d5e6f",
3
+ "intentHashes": ["0xabababababababababababababababababababababababababababababababab"],
4
+ "expiresAt": 1767229200,
5
+ "sourceChainId": 10,
6
+ "digest": "0x918291a64807080e2e8c67c0553f6dae6dbd34d7c155f0129a8e2c95da8bc212",
7
+ "signature": "0xe7e95a37b8a2a6b57130df9c8c8048554f579f1173089f91ecf55f3bb43276eb4f53be7280b18b54ba9f0ff86437be95d29126c711cd19bf6e33df09e593f2361b",
8
+ "signer": "0x1D4b570Cd156b0C0B4778350fE6277750E23e0a6"
9
+ }
package/fixtures/signature-hash/vectors.json ADDED
@@ -0,0 +1,58 @@
1
+ [
2
+ {
3
+ "family": "yParity-1",
4
+ "description": "canonical 65-byte low-s, v in {27,28}",
5
+ "input": "0xcbf198ff9f3aead0b7162bf07d9da094cf659659d2ecfae01f59aeff4a6dfb345c809c892623e8a560e2f9a3211a8590f358c1e5dadedbbc3d904346c81af9be1c",
6
+ "canonicalSerialized": "0xcbf198ff9f3aead0b7162bf07d9da094cf659659d2ecfae01f59aeff4a6dfb345c809c892623e8a560e2f9a3211a8590f358c1e5dadedbbc3d904346c81af9be1c",
7
+ "hash": "0x588c4b85532ad7fd47eb5cf966769401ea08f45829697c8811e618546e8366f3"
8
+ },
9
+ {
10
+ "family": "yParity-1",
11
+ "description": "high-s malleable twin (v flipped)",
12
+ "input": "0xcbf198ff9f3aead0b7162bf07d9da094cf659659d2ecfae01f59aeff4a6dfb34a37f6376d9dc175a9f1d065cdee57a6dc7561b00d469c47f82421b46081b47831b",
13
+ "canonicalSerialized": "0xcbf198ff9f3aead0b7162bf07d9da094cf659659d2ecfae01f59aeff4a6dfb345c809c892623e8a560e2f9a3211a8590f358c1e5dadedbbc3d904346c81af9be1c",
14
+ "hash": "0x588c4b85532ad7fd47eb5cf966769401ea08f45829697c8811e618546e8366f3"
15
+ },
16
+ {
17
+ "family": "yParity-1",
18
+ "description": "EIP-2098 compact 64-byte form",
19
+ "input": "0xcbf198ff9f3aead0b7162bf07d9da094cf659659d2ecfae01f59aeff4a6dfb34dc809c892623e8a560e2f9a3211a8590f358c1e5dadedbbc3d904346c81af9be",
20
+ "canonicalSerialized": "0xcbf198ff9f3aead0b7162bf07d9da094cf659659d2ecfae01f59aeff4a6dfb345c809c892623e8a560e2f9a3211a8590f358c1e5dadedbbc3d904346c81af9be1c",
21
+ "hash": "0x588c4b85532ad7fd47eb5cf966769401ea08f45829697c8811e618546e8366f3"
22
+ },
23
+ {
24
+ "family": "yParity-1",
25
+ "description": "v encoded as recovery id 0/1",
26
+ "input": "0xcbf198ff9f3aead0b7162bf07d9da094cf659659d2ecfae01f59aeff4a6dfb345c809c892623e8a560e2f9a3211a8590f358c1e5dadedbbc3d904346c81af9be01",
27
+ "canonicalSerialized": "0xcbf198ff9f3aead0b7162bf07d9da094cf659659d2ecfae01f59aeff4a6dfb345c809c892623e8a560e2f9a3211a8590f358c1e5dadedbbc3d904346c81af9be1c",
28
+ "hash": "0x588c4b85532ad7fd47eb5cf966769401ea08f45829697c8811e618546e8366f3"
29
+ },
30
+ {
31
+ "family": "yParity-0",
32
+ "description": "canonical 65-byte low-s, v in {27,28}",
33
+ "input": "0xc334a2f086a64a820d6e9f2a9ea455e1d97723e4d626612281624f551ef411c978698f989a52918f6f398199a4419a693eaa8ca9558a236f5b134dab872dd9f11b",
34
+ "canonicalSerialized": "0xc334a2f086a64a820d6e9f2a9ea455e1d97723e4d626612281624f551ef411c978698f989a52918f6f398199a4419a693eaa8ca9558a236f5b134dab872dd9f11b",
35
+ "hash": "0x15537c2199a404dd19347773ecf705640ac858e488f43340eddeeb0e75d21b44"
36
+ },
37
+ {
38
+ "family": "yParity-0",
39
+ "description": "high-s malleable twin (v flipped)",
40
+ "input": "0xc334a2f086a64a820d6e9f2a9ea455e1d97723e4d626612281624f551ef411c98796706765ad6e7090c67e665bbe65957c04503d59be7ccc64bf10e1490867501c",
41
+ "canonicalSerialized": "0xc334a2f086a64a820d6e9f2a9ea455e1d97723e4d626612281624f551ef411c978698f989a52918f6f398199a4419a693eaa8ca9558a236f5b134dab872dd9f11b",
42
+ "hash": "0x15537c2199a404dd19347773ecf705640ac858e488f43340eddeeb0e75d21b44"
43
+ },
44
+ {
45
+ "family": "yParity-0",
46
+ "description": "EIP-2098 compact 64-byte form",
47
+ "input": "0xc334a2f086a64a820d6e9f2a9ea455e1d97723e4d626612281624f551ef411c978698f989a52918f6f398199a4419a693eaa8ca9558a236f5b134dab872dd9f1",
48
+ "canonicalSerialized": "0xc334a2f086a64a820d6e9f2a9ea455e1d97723e4d626612281624f551ef411c978698f989a52918f6f398199a4419a693eaa8ca9558a236f5b134dab872dd9f11b",
49
+ "hash": "0x15537c2199a404dd19347773ecf705640ac858e488f43340eddeeb0e75d21b44"
50
+ },
51
+ {
52
+ "family": "yParity-0",
53
+ "description": "v encoded as recovery id 0/1",
54
+ "input": "0xc334a2f086a64a820d6e9f2a9ea455e1d97723e4d626612281624f551ef411c978698f989a52918f6f398199a4419a693eaa8ca9558a236f5b134dab872dd9f100",
55
+ "canonicalSerialized": "0xc334a2f086a64a820d6e9f2a9ea455e1d97723e4d626612281624f551ef411c978698f989a52918f6f398199a4419a693eaa8ca9558a236f5b134dab872dd9f11b",
56
+ "hash": "0x15537c2199a404dd19347773ecf705640ac858e488f43340eddeeb0e75d21b44"
57
+ }
58
+ ]