@relayprotocol/relay-sdk 6.0.1 → 6.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.
- package/_cjs/src/errors/TransactionConfirmationError.js.map +1 -1
- package/_cjs/src/routes/index.js +1 -1
- package/_cjs/src/routes/index.js.map +1 -1
- package/_cjs/src/utils/transaction.js.map +1 -1
- package/_cjs/src/version.js +1 -1
- package/_cjs/tsconfig.build.tsbuildinfo +1 -1
- package/_esm/src/errors/TransactionConfirmationError.js.map +1 -1
- package/_esm/src/routes/index.js +1 -1
- package/_esm/src/routes/index.js.map +1 -1
- package/_esm/src/utils/transaction.js.map +1 -1
- package/_esm/src/version.js +1 -1
- package/_esm/tsconfig.build.tsbuildinfo +1 -1
- package/_types/src/client.d.ts +3 -3
- package/_types/src/errors/TransactionConfirmationError.d.ts +3 -3
- package/_types/src/errors/TransactionConfirmationError.d.ts.map +1 -1
- package/_types/src/types/AdaptedWallet.d.ts +5 -1
- package/_types/src/types/AdaptedWallet.d.ts.map +1 -1
- package/_types/src/types/Execute.d.ts +2 -2
- package/_types/src/types/Execute.d.ts.map +1 -1
- package/_types/src/types/TransactionStepItem.d.ts +9 -0
- package/_types/src/types/TransactionStepItem.d.ts.map +1 -1
- package/_types/src/types/api.d.ts +511 -616
- package/_types/src/types/api.d.ts.map +1 -1
- package/_types/src/utils/getCurrentStepData.d.ts +2 -2
- package/_types/src/utils/prepareBatchTransaction.d.ts +1 -1
- package/_types/src/utils/transaction.d.ts +2 -2
- package/_types/src/utils/transaction.d.ts.map +1 -1
- package/_types/src/version.d.ts +1 -1
- package/_types/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +1 -1
|
@@ -6,6 +6,10 @@ export interface paths {
|
|
|
6
6
|
"/app-fees/{wallet}/balances": {
|
|
7
7
|
get: {
|
|
8
8
|
parameters: {
|
|
9
|
+
header?: {
|
|
10
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
11
|
+
"x-api-key"?: string;
|
|
12
|
+
};
|
|
9
13
|
path: {
|
|
10
14
|
/** @description Wallet to get the app fees for */
|
|
11
15
|
wallet: string;
|
|
@@ -59,6 +63,10 @@ export interface paths {
|
|
|
59
63
|
"/app-fees/{wallet}/claim": {
|
|
60
64
|
post: {
|
|
61
65
|
parameters: {
|
|
66
|
+
header?: {
|
|
67
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
68
|
+
"x-api-key"?: string;
|
|
69
|
+
};
|
|
62
70
|
path: {
|
|
63
71
|
wallet: string;
|
|
64
72
|
};
|
|
@@ -196,12 +204,88 @@ export interface paths {
|
|
|
196
204
|
};
|
|
197
205
|
};
|
|
198
206
|
};
|
|
207
|
+
"/balance-events/{wallet}": {
|
|
208
|
+
get: {
|
|
209
|
+
parameters: {
|
|
210
|
+
query: {
|
|
211
|
+
/** @description Temporary shared secret required to access this endpoint */
|
|
212
|
+
id: string;
|
|
213
|
+
/** @description Restrict to one chain */
|
|
214
|
+
chainId?: number | null;
|
|
215
|
+
/** @description Restrict to one currency (use chainId for non-EVM) */
|
|
216
|
+
currency?: string | null;
|
|
217
|
+
/** @description Restrict to one balance update context */
|
|
218
|
+
context?: "set-pending-amount" | "unset-pending-amount" | "reset-pending-amount" | "pay-fees" | "claim" | "fast-fill-reduce-balance" | "fast-fill-increase-balance" | "balance-topup" | "execute-transaction-request" | "fixed-rate-accounting" | "integrator-fixed-bps-accounting" | null;
|
|
219
|
+
/** @description Restrict to a specific request id */
|
|
220
|
+
requestId?: string | null;
|
|
221
|
+
/** @description Page size for events (max 250, default 50) */
|
|
222
|
+
limit?: number | null;
|
|
223
|
+
/** @description Pagination cursor: the `id` of the last event from the previous page */
|
|
224
|
+
cursor?: string | null;
|
|
225
|
+
/** @description Include rows where the current balance is <= 0 (default true) */
|
|
226
|
+
includeNegativeBalances?: boolean | null;
|
|
227
|
+
};
|
|
228
|
+
path: {
|
|
229
|
+
/** @description Wallet address (EVM/SVM/BVM auto-detected) */
|
|
230
|
+
wallet: string;
|
|
231
|
+
};
|
|
232
|
+
};
|
|
233
|
+
responses: {
|
|
234
|
+
/** @description Default Response */
|
|
235
|
+
200: {
|
|
236
|
+
content: {
|
|
237
|
+
"application/json": {
|
|
238
|
+
wallet?: string;
|
|
239
|
+
balances?: {
|
|
240
|
+
chainId?: number;
|
|
241
|
+
currency?: string;
|
|
242
|
+
amount?: string;
|
|
243
|
+
}[];
|
|
244
|
+
events?: ({
|
|
245
|
+
id?: number;
|
|
246
|
+
chainId?: number;
|
|
247
|
+
wallet?: string;
|
|
248
|
+
currency?: string;
|
|
249
|
+
delta?: string;
|
|
250
|
+
balanceAfter?: string;
|
|
251
|
+
context?: string;
|
|
252
|
+
requestId?: string | null;
|
|
253
|
+
contextData?: unknown;
|
|
254
|
+
createdAt?: string;
|
|
255
|
+
})[];
|
|
256
|
+
continuation?: string | null;
|
|
257
|
+
};
|
|
258
|
+
};
|
|
259
|
+
};
|
|
260
|
+
/** @description Default Response */
|
|
261
|
+
400: {
|
|
262
|
+
content: {
|
|
263
|
+
"application/json": {
|
|
264
|
+
message?: string;
|
|
265
|
+
};
|
|
266
|
+
};
|
|
267
|
+
};
|
|
268
|
+
/** @description Default Response */
|
|
269
|
+
401: {
|
|
270
|
+
content: {
|
|
271
|
+
"application/json": {
|
|
272
|
+
message?: string;
|
|
273
|
+
};
|
|
274
|
+
};
|
|
275
|
+
};
|
|
276
|
+
};
|
|
277
|
+
};
|
|
278
|
+
};
|
|
199
279
|
"/chains": {
|
|
200
280
|
get: {
|
|
201
281
|
parameters: {
|
|
202
282
|
query?: {
|
|
203
283
|
includeChains?: string | null;
|
|
204
284
|
};
|
|
285
|
+
header?: {
|
|
286
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
287
|
+
"x-api-key"?: string;
|
|
288
|
+
};
|
|
205
289
|
};
|
|
206
290
|
responses: {
|
|
207
291
|
/** @description Default Response */
|
|
@@ -220,6 +304,7 @@ export interface paths {
|
|
|
220
304
|
explorerPaths?: {
|
|
221
305
|
transaction?: string;
|
|
222
306
|
address?: string;
|
|
307
|
+
token?: string;
|
|
223
308
|
} | null;
|
|
224
309
|
/** @description If the network supports depositing to this chain, e.g. allows this chain to be set as the destination chain */
|
|
225
310
|
depositEnabled?: boolean;
|
|
@@ -338,6 +423,10 @@ export interface paths {
|
|
|
338
423
|
query: {
|
|
339
424
|
chainId: number;
|
|
340
425
|
};
|
|
426
|
+
header?: {
|
|
427
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
428
|
+
"x-api-key"?: string;
|
|
429
|
+
};
|
|
341
430
|
};
|
|
342
431
|
responses: {
|
|
343
432
|
/** @description Default Response */
|
|
@@ -439,7 +528,7 @@ export interface paths {
|
|
|
439
528
|
/** @description User address, when supplied returns user balance and max bridge amount */
|
|
440
529
|
user?: string;
|
|
441
530
|
/** @description Restricts the user balance and capacity to a particular currency when supplied with a currency id. Defaults to the native currency of the destination chain. */
|
|
442
|
-
currency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "
|
|
531
|
+
currency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd" | "pusd" | "bnb" | "usdg";
|
|
443
532
|
};
|
|
444
533
|
};
|
|
445
534
|
responses: {
|
|
@@ -492,7 +581,7 @@ export interface paths {
|
|
|
492
581
|
originChainId: number;
|
|
493
582
|
destinationChainId: number;
|
|
494
583
|
/** @enum {string} */
|
|
495
|
-
currency: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "
|
|
584
|
+
currency: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd" | "pusd" | "bnb" | "usdg";
|
|
496
585
|
/** @description Amount to bridge as the base amount (can be switched to exact input using the dedicated flag), denoted in wei */
|
|
497
586
|
amount: string;
|
|
498
587
|
/** @description App fees to be charged for execution */
|
|
@@ -511,11 +600,6 @@ export interface paths {
|
|
|
511
600
|
useExternalLiquidity?: boolean;
|
|
512
601
|
/** @description Enable this for specific fallback routes */
|
|
513
602
|
useFallbacks?: boolean;
|
|
514
|
-
/**
|
|
515
|
-
* @description Enable this to route payments via a forwarder contract. This contract will emit an event when receiving payments before forwarding to the solver. This is needed when depositing from a smart contract as the payment will be an internal transaction and detecting such a transaction requires obtaining the transaction traces.
|
|
516
|
-
* @default true
|
|
517
|
-
*/
|
|
518
|
-
useForwarder?: boolean;
|
|
519
603
|
/** @description Enable this to use permit (eip3009), only works on supported currency such as usdc */
|
|
520
604
|
usePermit?: boolean;
|
|
521
605
|
};
|
|
@@ -596,7 +680,7 @@ export interface paths {
|
|
|
596
680
|
* @description Origin chain gas currency
|
|
597
681
|
* @enum {string}
|
|
598
682
|
*/
|
|
599
|
-
gasCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "
|
|
683
|
+
gasCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd" | "pusd" | "bnb" | "usdg" | "avax" | "matic" | "sei" | "mnt" | "trx" | "bera" | "ip" | "s" | "lrds" | "celo" | "flow" | "ron" | "metis" | "btcn" | "core" | "ton" | "cronos" | "hype" | "mcade" | "usd" | "wbtc" | "usdc-arc";
|
|
600
684
|
/** @description Combination of the relayerGas and relayerService to give you the full relayer fee in wei */
|
|
601
685
|
relayer?: string;
|
|
602
686
|
/** @description Destination chain gas fee in wei */
|
|
@@ -607,10 +691,10 @@ export interface paths {
|
|
|
607
691
|
* @description The currency for all relayer fees (gas and service)
|
|
608
692
|
* @enum {string}
|
|
609
693
|
*/
|
|
610
|
-
relayerCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "
|
|
694
|
+
relayerCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd" | "pusd" | "bnb" | "usdg";
|
|
611
695
|
app?: string;
|
|
612
696
|
/** @enum {string} */
|
|
613
|
-
appCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "
|
|
697
|
+
appCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd" | "pusd" | "bnb" | "usdg";
|
|
614
698
|
};
|
|
615
699
|
breakdown?: {
|
|
616
700
|
/** @description Amount that will be bridged in the estimated time */
|
|
@@ -672,7 +756,7 @@ export interface paths {
|
|
|
672
756
|
originChainId: number;
|
|
673
757
|
destinationChainId: number;
|
|
674
758
|
/** @enum {string} */
|
|
675
|
-
currency: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "
|
|
759
|
+
currency: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd" | "pusd" | "bnb" | "usdg";
|
|
676
760
|
/** @description Amount to bridge as the base amount (can be switched to exact input using the dedicated flag), denoted in wei */
|
|
677
761
|
amount: string;
|
|
678
762
|
/** @description App fees to be charged for execution */
|
|
@@ -691,11 +775,6 @@ export interface paths {
|
|
|
691
775
|
useExternalLiquidity?: boolean;
|
|
692
776
|
/** @description Enable this for specific fallback routes */
|
|
693
777
|
useFallbacks?: boolean;
|
|
694
|
-
/**
|
|
695
|
-
* @description Enable this to route payments via a forwarder contract. This contract will emit an event when receiving payments before forwarding to the solver. This is needed when depositing from a smart contract as the payment will be an internal transaction and detecting such a transaction requires obtaining the transaction traces.
|
|
696
|
-
* @default true
|
|
697
|
-
*/
|
|
698
|
-
useForwarder?: boolean;
|
|
699
778
|
/** @description Enable this to use permit (eip3009), only works on supported currency such as usdc */
|
|
700
779
|
usePermit?: boolean;
|
|
701
780
|
};
|
|
@@ -1070,11 +1149,6 @@ export interface paths {
|
|
|
1070
1149
|
*/
|
|
1071
1150
|
refundOnOrigin?: boolean;
|
|
1072
1151
|
source?: string;
|
|
1073
|
-
/**
|
|
1074
|
-
* @description Enable this to route payments via a forwarder contract. This contract will emit an event when receiving payments before forwarding to the solver. This is needed when depositing from a smart contract as the payment will be an internal transaction and detecting such a transaction requires obtaining the transaction traces.
|
|
1075
|
-
* @default true
|
|
1076
|
-
*/
|
|
1077
|
-
useForwarder?: boolean;
|
|
1078
1152
|
};
|
|
1079
1153
|
};
|
|
1080
1154
|
};
|
|
@@ -1153,7 +1227,7 @@ export interface paths {
|
|
|
1153
1227
|
* @description Origin chain gas currency
|
|
1154
1228
|
* @enum {string}
|
|
1155
1229
|
*/
|
|
1156
|
-
gasCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "
|
|
1230
|
+
gasCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd" | "pusd" | "bnb" | "usdg" | "avax" | "matic" | "sei" | "mnt" | "trx" | "bera" | "ip" | "s" | "lrds" | "celo" | "flow" | "ron" | "metis" | "btcn" | "core" | "ton" | "cronos" | "hype" | "mcade" | "usd" | "wbtc" | "usdc-arc";
|
|
1157
1231
|
/** @description Combination of the relayerGas and relayerService to give you the full relayer fee in wei */
|
|
1158
1232
|
relayer?: string;
|
|
1159
1233
|
/** @description Destination chain gas fee in wei */
|
|
@@ -1164,10 +1238,10 @@ export interface paths {
|
|
|
1164
1238
|
* @description The currency for all relayer fees (gas and service)
|
|
1165
1239
|
* @enum {string}
|
|
1166
1240
|
*/
|
|
1167
|
-
relayerCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "
|
|
1241
|
+
relayerCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd" | "pusd" | "bnb" | "usdg";
|
|
1168
1242
|
app?: string;
|
|
1169
1243
|
/** @enum {string} */
|
|
1170
|
-
appCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "
|
|
1244
|
+
appCurrency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "apeeth" | "ape" | "g7" | "pengu" | "plume" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd" | "pusd" | "bnb" | "usdg";
|
|
1171
1245
|
};
|
|
1172
1246
|
/**
|
|
1173
1247
|
* @example {
|
|
@@ -1257,11 +1331,6 @@ export interface paths {
|
|
|
1257
1331
|
*/
|
|
1258
1332
|
refundOnOrigin?: boolean;
|
|
1259
1333
|
source?: string;
|
|
1260
|
-
/**
|
|
1261
|
-
* @description Enable this to route payments via a forwarder contract. This contract will emit an event when receiving payments before forwarding to the solver. This is needed when depositing from a smart contract as the payment will be an internal transaction and detecting such a transaction requires obtaining the transaction traces.
|
|
1262
|
-
* @default true
|
|
1263
|
-
*/
|
|
1264
|
-
useForwarder?: boolean;
|
|
1265
1334
|
};
|
|
1266
1335
|
};
|
|
1267
1336
|
};
|
|
@@ -1555,555 +1624,34 @@ export interface paths {
|
|
|
1555
1624
|
};
|
|
1556
1625
|
amount?: string;
|
|
1557
1626
|
amountFormatted?: string;
|
|
1558
|
-
amountUsd?: string;
|
|
1559
|
-
minimumAmount?: string;
|
|
1560
|
-
};
|
|
1561
|
-
};
|
|
1562
|
-
/**
|
|
1563
|
-
* @example {
|
|
1564
|
-
* "value": "1000000000000000000",
|
|
1565
|
-
* "timeEstimate": 10
|
|
1566
|
-
* }
|
|
1567
|
-
*/
|
|
1568
|
-
breakdown?: {
|
|
1569
|
-
/** @description Amount that will be executed in the estimated time */
|
|
1570
|
-
value?: string;
|
|
1571
|
-
/** @description Estimated execution time in seconds */
|
|
1572
|
-
timeEstimate?: number;
|
|
1573
|
-
}[];
|
|
1574
|
-
/**
|
|
1575
|
-
* @example {
|
|
1576
|
-
* "userBalance": "54764083517303347",
|
|
1577
|
-
* "requiredToSolve": "995010521157287036"
|
|
1578
|
-
* }
|
|
1579
|
-
*/
|
|
1580
|
-
balances?: {
|
|
1581
|
-
/** @description The user's balance in the given currency on the origin chain */
|
|
1582
|
-
userBalance?: string;
|
|
1583
|
-
/** @description The minimum balance the user needs to have to bridge */
|
|
1584
|
-
requiredToSolve?: string;
|
|
1585
|
-
};
|
|
1586
|
-
};
|
|
1587
|
-
};
|
|
1588
|
-
};
|
|
1589
|
-
/** @description Default Response */
|
|
1590
|
-
400: {
|
|
1591
|
-
content: {
|
|
1592
|
-
"application/json": {
|
|
1593
|
-
message?: string;
|
|
1594
|
-
code?: string;
|
|
1595
|
-
tx?: {
|
|
1596
|
-
to?: string;
|
|
1597
|
-
value?: string;
|
|
1598
|
-
data?: string;
|
|
1599
|
-
};
|
|
1600
|
-
};
|
|
1601
|
-
};
|
|
1602
|
-
};
|
|
1603
|
-
/** @description Default Response */
|
|
1604
|
-
401: {
|
|
1605
|
-
content: {
|
|
1606
|
-
"application/json": {
|
|
1607
|
-
message?: string;
|
|
1608
|
-
code?: string;
|
|
1609
|
-
};
|
|
1610
|
-
};
|
|
1611
|
-
};
|
|
1612
|
-
/** @description Default Response */
|
|
1613
|
-
500: {
|
|
1614
|
-
content: {
|
|
1615
|
-
"application/json": {
|
|
1616
|
-
message?: string;
|
|
1617
|
-
code?: string;
|
|
1618
|
-
tx?: {
|
|
1619
|
-
to?: string;
|
|
1620
|
-
value?: string;
|
|
1621
|
-
data?: string;
|
|
1622
|
-
};
|
|
1623
|
-
};
|
|
1624
|
-
};
|
|
1625
|
-
};
|
|
1626
|
-
};
|
|
1627
|
-
};
|
|
1628
|
-
};
|
|
1629
|
-
"/execute/swap": {
|
|
1630
|
-
post: {
|
|
1631
|
-
requestBody: {
|
|
1632
|
-
content: {
|
|
1633
|
-
"application/json": {
|
|
1634
|
-
/** @description Address that is depositing funds on the origin chain and submitting transactions or signatures */
|
|
1635
|
-
user: string;
|
|
1636
|
-
/** @description Address that is receiving the funds on the destination chain, if not specified then this will default to the user address */
|
|
1637
|
-
recipient?: string;
|
|
1638
|
-
originChainId: number;
|
|
1639
|
-
destinationChainId: number;
|
|
1640
|
-
originCurrency: string;
|
|
1641
|
-
destinationCurrency: string;
|
|
1642
|
-
/** @description Amount to swap as the base amount (can be switched to exact input/output using the dedicated flag), denoted in the smallest unit of the specified currency (e.g., wei for ETH) */
|
|
1643
|
-
amount: string;
|
|
1644
|
-
/**
|
|
1645
|
-
* @description Whether to use the amount as the output or the input for the basis of the swap
|
|
1646
|
-
* @enum {string}
|
|
1647
|
-
*/
|
|
1648
|
-
tradeType: "EXACT_INPUT" | "EXACT_OUTPUT" | "EXPECTED_OUTPUT";
|
|
1649
|
-
txs?: {
|
|
1650
|
-
to?: string;
|
|
1651
|
-
value?: string;
|
|
1652
|
-
data?: string;
|
|
1653
|
-
}[];
|
|
1654
|
-
source?: string;
|
|
1655
|
-
/** @description Address to send the refund to in the case of failure, if not specified then the recipient address or user address is used */
|
|
1656
|
-
refundTo?: string;
|
|
1657
|
-
/**
|
|
1658
|
-
* @deprecated
|
|
1659
|
-
* @description Always refund on the origin chain in case of any issues
|
|
1660
|
-
*/
|
|
1661
|
-
refundOnOrigin?: boolean;
|
|
1662
|
-
/**
|
|
1663
|
-
* @description Enable this to route payments via a forwarder contract. This contract will emit an event when receiving payments before forwarding to the solver. This is needed when depositing from a smart contract as the payment will be an internal transaction and detecting such a transaction requires obtaining the transaction traces.
|
|
1664
|
-
* @default true
|
|
1665
|
-
*/
|
|
1666
|
-
useForwarder?: boolean;
|
|
1667
|
-
/** @description Enable this to use canonical+ bridging, trading speed for more liquidity */
|
|
1668
|
-
useExternalLiquidity?: boolean;
|
|
1669
|
-
/** @description Enable this for specific fallback routes */
|
|
1670
|
-
useFallbacks?: boolean;
|
|
1671
|
-
/** @description Enable this to use permit (eip3009) when bridging, only works on supported currency such as usdc */
|
|
1672
|
-
usePermit?: boolean;
|
|
1673
|
-
/** @description Slippage tolerance for the swap, if not specified then the slippage tolerance is automatically calculated to avoid front-running. This value is in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage */
|
|
1674
|
-
slippageTolerance?: string;
|
|
1675
|
-
appFees?: {
|
|
1676
|
-
/** @description Address that will receive the app fee */
|
|
1677
|
-
recipient?: string;
|
|
1678
|
-
/** @description App fees to be charged for execution in basis points, e.g. 100 = 1% */
|
|
1679
|
-
fee?: string;
|
|
1680
|
-
}[];
|
|
1681
|
-
};
|
|
1682
|
-
};
|
|
1683
|
-
};
|
|
1684
|
-
responses: {
|
|
1685
|
-
/** @description Default Response */
|
|
1686
|
-
200: {
|
|
1687
|
-
content: {
|
|
1688
|
-
"application/json": {
|
|
1689
|
-
/**
|
|
1690
|
-
* @description An array of steps detailing what needs to be done to bridge, steps includes multiple items of the same kind (signature, transaction, etc)
|
|
1691
|
-
* @example [
|
|
1692
|
-
* {
|
|
1693
|
-
* "id": "deposit",
|
|
1694
|
-
* "action": "Confirm transaction in your wallet",
|
|
1695
|
-
* "description": "Depositing funds to the relayer to execute the swap for USDC",
|
|
1696
|
-
* "kind": "transaction",
|
|
1697
|
-
* "requestId": "0x92b99e6e1ee1deeb9531b5ad7f87091b3d71254b3176de9e8b5f6c6d0bd3a331",
|
|
1698
|
-
* "items": [
|
|
1699
|
-
* {
|
|
1700
|
-
* "status": "incomplete",
|
|
1701
|
-
* "data": {
|
|
1702
|
-
* "from": "0x0CccD55A5Ac261Ea29136831eeaA93bfE07f5Db6",
|
|
1703
|
-
* "to": "0xf70da97812cb96acdf810712aa562db8dfa3dbef",
|
|
1704
|
-
* "data": "0x00fad611",
|
|
1705
|
-
* "value": "1000000000000000000",
|
|
1706
|
-
* "maxFeePerGas": "12205661344",
|
|
1707
|
-
* "maxPriorityFeePerGas": "2037863396",
|
|
1708
|
-
* "chainId": 1
|
|
1709
|
-
* },
|
|
1710
|
-
* "check": {
|
|
1711
|
-
* "endpoint": "/intents/status?requestId=0x92b99e6e1ee1deeb9531b5ad7f87091b3d71254b3176de9e8b5f6c6d0bd3a331",
|
|
1712
|
-
* "method": "GET"
|
|
1713
|
-
* }
|
|
1714
|
-
* }
|
|
1715
|
-
* ]
|
|
1716
|
-
* }
|
|
1717
|
-
* ]
|
|
1718
|
-
*/
|
|
1719
|
-
steps?: {
|
|
1720
|
-
/** @description Unique identifier tied to the step */
|
|
1721
|
-
id?: string;
|
|
1722
|
-
/** @description A call to action for the step */
|
|
1723
|
-
action?: string;
|
|
1724
|
-
/** @description A short description of the step and what it entails */
|
|
1725
|
-
description?: string;
|
|
1726
|
-
/** @description The kind of step, can either be a transaction or a signature. Transaction steps require submitting a transaction while signature steps require submitting a signature */
|
|
1727
|
-
kind?: string;
|
|
1728
|
-
/** @description A unique identifier for this step, tying all related transactions together */
|
|
1729
|
-
requestId?: string;
|
|
1730
|
-
/** @description While uncommon it is possible for steps to contain multiple items of the same kind (transaction/signature) grouped together that can be executed simultaneously. */
|
|
1731
|
-
items?: {
|
|
1732
|
-
/** @description Can either be complete or incomplete, this can be locally controlled once the step item is completed (depending on the kind) and the check object (if returned) has been verified. Once all step items are complete, the bridge is complete */
|
|
1733
|
-
status?: string;
|
|
1734
|
-
data?: unknown;
|
|
1735
|
-
/** @description Details an endpoint and a method you should poll to get confirmation, the endpoint should return a boolean success flag which can be used to determine if the step item is complete */
|
|
1736
|
-
check?: {
|
|
1737
|
-
/** @description The endpoint to confirm that the step item was successfully completed */
|
|
1738
|
-
endpoint?: string;
|
|
1739
|
-
/** @description The REST method to access the endpoint */
|
|
1740
|
-
method?: string;
|
|
1741
|
-
};
|
|
1742
|
-
}[];
|
|
1743
|
-
}[];
|
|
1744
|
-
fees?: {
|
|
1745
|
-
/**
|
|
1746
|
-
* @description Origin chain gas fee
|
|
1747
|
-
* @example {
|
|
1748
|
-
* "currency": {
|
|
1749
|
-
* "chainId": 8453,
|
|
1750
|
-
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
1751
|
-
* "symbol": "USDC",
|
|
1752
|
-
* "name": "USD Coin",
|
|
1753
|
-
* "decimals": 6,
|
|
1754
|
-
* "metadata": {
|
|
1755
|
-
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
1756
|
-
* "verified": false,
|
|
1757
|
-
* "isNative": false
|
|
1758
|
-
* }
|
|
1759
|
-
* },
|
|
1760
|
-
* "amount": "30754920",
|
|
1761
|
-
* "amountFormatted": "30.75492",
|
|
1762
|
-
* "amountUsd": "30.901612",
|
|
1763
|
-
* "minimumAmount": "30454920"
|
|
1764
|
-
* }
|
|
1765
|
-
*/
|
|
1766
|
-
gas?: {
|
|
1767
|
-
currency?: {
|
|
1768
|
-
chainId?: number;
|
|
1769
|
-
address?: string;
|
|
1770
|
-
symbol?: string;
|
|
1771
|
-
name?: string;
|
|
1772
|
-
decimals?: number;
|
|
1773
|
-
metadata?: {
|
|
1774
|
-
logoURI?: string;
|
|
1775
|
-
verified?: boolean;
|
|
1776
|
-
isNative?: boolean;
|
|
1777
|
-
};
|
|
1778
|
-
};
|
|
1779
|
-
amount?: string;
|
|
1780
|
-
amountFormatted?: string;
|
|
1781
|
-
amountUsd?: string;
|
|
1782
|
-
minimumAmount?: string;
|
|
1783
|
-
};
|
|
1784
|
-
/**
|
|
1785
|
-
* @description Combination of the relayerGas and relayerService to give you the full relayer fee
|
|
1786
|
-
* @example {
|
|
1787
|
-
* "currency": {
|
|
1788
|
-
* "chainId": 8453,
|
|
1789
|
-
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
1790
|
-
* "symbol": "USDC",
|
|
1791
|
-
* "name": "USD Coin",
|
|
1792
|
-
* "decimals": 6,
|
|
1793
|
-
* "metadata": {
|
|
1794
|
-
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
1795
|
-
* "verified": false,
|
|
1796
|
-
* "isNative": false
|
|
1797
|
-
* }
|
|
1798
|
-
* },
|
|
1799
|
-
* "amount": "30754920",
|
|
1800
|
-
* "amountFormatted": "30.75492",
|
|
1801
|
-
* "amountUsd": "30.901612",
|
|
1802
|
-
* "minimumAmount": "30454920"
|
|
1803
|
-
* }
|
|
1804
|
-
*/
|
|
1805
|
-
relayer?: {
|
|
1806
|
-
currency?: {
|
|
1807
|
-
chainId?: number;
|
|
1808
|
-
address?: string;
|
|
1809
|
-
symbol?: string;
|
|
1810
|
-
name?: string;
|
|
1811
|
-
decimals?: number;
|
|
1812
|
-
metadata?: {
|
|
1813
|
-
logoURI?: string;
|
|
1814
|
-
verified?: boolean;
|
|
1815
|
-
isNative?: boolean;
|
|
1816
|
-
};
|
|
1817
|
-
};
|
|
1818
|
-
amount?: string;
|
|
1819
|
-
amountFormatted?: string;
|
|
1820
|
-
amountUsd?: string;
|
|
1821
|
-
minimumAmount?: string;
|
|
1822
|
-
};
|
|
1823
|
-
/**
|
|
1824
|
-
* @description Destination chain gas fee
|
|
1825
|
-
* @example {
|
|
1826
|
-
* "currency": {
|
|
1827
|
-
* "chainId": 8453,
|
|
1828
|
-
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
1829
|
-
* "symbol": "USDC",
|
|
1830
|
-
* "name": "USD Coin",
|
|
1831
|
-
* "decimals": 6,
|
|
1832
|
-
* "metadata": {
|
|
1833
|
-
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
1834
|
-
* "verified": false,
|
|
1835
|
-
* "isNative": false
|
|
1836
|
-
* }
|
|
1837
|
-
* },
|
|
1838
|
-
* "amount": "30754920",
|
|
1839
|
-
* "amountFormatted": "30.75492",
|
|
1840
|
-
* "amountUsd": "30.901612",
|
|
1841
|
-
* "minimumAmount": "30454920"
|
|
1842
|
-
* }
|
|
1843
|
-
*/
|
|
1844
|
-
relayerGas?: {
|
|
1845
|
-
currency?: {
|
|
1846
|
-
chainId?: number;
|
|
1847
|
-
address?: string;
|
|
1848
|
-
symbol?: string;
|
|
1849
|
-
name?: string;
|
|
1850
|
-
decimals?: number;
|
|
1851
|
-
metadata?: {
|
|
1852
|
-
logoURI?: string;
|
|
1853
|
-
verified?: boolean;
|
|
1854
|
-
isNative?: boolean;
|
|
1855
|
-
};
|
|
1856
|
-
};
|
|
1857
|
-
amount?: string;
|
|
1858
|
-
amountFormatted?: string;
|
|
1859
|
-
amountUsd?: string;
|
|
1860
|
-
minimumAmount?: string;
|
|
1861
|
-
};
|
|
1862
|
-
/**
|
|
1863
|
-
* @description Fees paid to the relay solver, note that this value can be negative (which represents network rewards for moving in a direction that optimizes liquidity distribution)
|
|
1864
|
-
* @example {
|
|
1865
|
-
* "currency": {
|
|
1866
|
-
* "chainId": 8453,
|
|
1867
|
-
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
1868
|
-
* "symbol": "USDC",
|
|
1869
|
-
* "name": "USD Coin",
|
|
1870
|
-
* "decimals": 6,
|
|
1871
|
-
* "metadata": {
|
|
1872
|
-
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
1873
|
-
* "verified": false,
|
|
1874
|
-
* "isNative": false
|
|
1875
|
-
* }
|
|
1876
|
-
* },
|
|
1877
|
-
* "amount": "30754920",
|
|
1878
|
-
* "amountFormatted": "30.75492",
|
|
1879
|
-
* "amountUsd": "30.901612",
|
|
1880
|
-
* "minimumAmount": "30454920"
|
|
1881
|
-
* }
|
|
1882
|
-
*/
|
|
1883
|
-
relayerService?: {
|
|
1884
|
-
currency?: {
|
|
1885
|
-
chainId?: number;
|
|
1886
|
-
address?: string;
|
|
1887
|
-
symbol?: string;
|
|
1888
|
-
name?: string;
|
|
1889
|
-
decimals?: number;
|
|
1890
|
-
metadata?: {
|
|
1891
|
-
logoURI?: string;
|
|
1892
|
-
verified?: boolean;
|
|
1893
|
-
isNative?: boolean;
|
|
1894
|
-
};
|
|
1895
|
-
};
|
|
1896
|
-
amount?: string;
|
|
1897
|
-
amountFormatted?: string;
|
|
1898
|
-
amountUsd?: string;
|
|
1899
|
-
minimumAmount?: string;
|
|
1900
|
-
};
|
|
1901
|
-
/**
|
|
1902
|
-
* @description Fees paid to the app. Currency will be the same as the relayer fee currency. This needs to be claimed later by the app owner and is not immediately distributed to the app
|
|
1903
|
-
* @example {
|
|
1904
|
-
* "currency": {
|
|
1905
|
-
* "chainId": 8453,
|
|
1906
|
-
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
1907
|
-
* "symbol": "USDC",
|
|
1908
|
-
* "name": "USD Coin",
|
|
1909
|
-
* "decimals": 6,
|
|
1910
|
-
* "metadata": {
|
|
1911
|
-
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
1912
|
-
* "verified": false,
|
|
1913
|
-
* "isNative": false
|
|
1914
|
-
* }
|
|
1915
|
-
* },
|
|
1916
|
-
* "amount": "30754920",
|
|
1917
|
-
* "amountFormatted": "30.75492",
|
|
1918
|
-
* "amountUsd": "30.901612",
|
|
1919
|
-
* "minimumAmount": "30454920"
|
|
1920
|
-
* }
|
|
1921
|
-
*/
|
|
1922
|
-
app?: {
|
|
1923
|
-
currency?: {
|
|
1924
|
-
chainId?: number;
|
|
1925
|
-
address?: string;
|
|
1926
|
-
symbol?: string;
|
|
1927
|
-
name?: string;
|
|
1928
|
-
decimals?: number;
|
|
1929
|
-
metadata?: {
|
|
1930
|
-
logoURI?: string;
|
|
1931
|
-
verified?: boolean;
|
|
1932
|
-
isNative?: boolean;
|
|
1933
|
-
};
|
|
1934
|
-
};
|
|
1935
|
-
amount?: string;
|
|
1936
|
-
amountFormatted?: string;
|
|
1937
|
-
amountUsd?: string;
|
|
1938
|
-
minimumAmount?: string;
|
|
1939
|
-
};
|
|
1940
|
-
/**
|
|
1941
|
-
* @description The amount of fees for the request that are subsidized by the request sponsor. Does not include deposit origin gas unless it is a permit based deposit.
|
|
1942
|
-
* @example {
|
|
1943
|
-
* "currency": {
|
|
1944
|
-
* "chainId": 8453,
|
|
1945
|
-
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
1946
|
-
* "symbol": "USDC",
|
|
1947
|
-
* "name": "USD Coin",
|
|
1948
|
-
* "decimals": 6,
|
|
1949
|
-
* "metadata": {
|
|
1950
|
-
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
1951
|
-
* "verified": false,
|
|
1952
|
-
* "isNative": false
|
|
1953
|
-
* }
|
|
1954
|
-
* },
|
|
1955
|
-
* "amount": "30754920",
|
|
1956
|
-
* "amountFormatted": "30.75492",
|
|
1957
|
-
* "amountUsd": "30.901612",
|
|
1958
|
-
* "minimumAmount": "30454920"
|
|
1959
|
-
* }
|
|
1960
|
-
*/
|
|
1961
|
-
subsidized?: {
|
|
1962
|
-
currency?: {
|
|
1963
|
-
chainId?: number;
|
|
1964
|
-
address?: string;
|
|
1965
|
-
symbol?: string;
|
|
1966
|
-
name?: string;
|
|
1967
|
-
decimals?: number;
|
|
1968
|
-
metadata?: {
|
|
1969
|
-
logoURI?: string;
|
|
1970
|
-
verified?: boolean;
|
|
1971
|
-
isNative?: boolean;
|
|
1972
|
-
};
|
|
1973
|
-
};
|
|
1974
|
-
amount?: string;
|
|
1975
|
-
amountFormatted?: string;
|
|
1976
|
-
amountUsd?: string;
|
|
1977
|
-
minimumAmount?: string;
|
|
1978
|
-
};
|
|
1979
|
-
};
|
|
1980
|
-
breakdown?: {
|
|
1981
|
-
/** @description Amount that will be swapped in the estimated time */
|
|
1982
|
-
value?: string;
|
|
1983
|
-
/** @description Estimated swap time in seconds */
|
|
1984
|
-
timeEstimate?: number;
|
|
1985
|
-
}[];
|
|
1986
|
-
balances?: {
|
|
1987
|
-
/** @description The user's balance in the given currency on the origin chain */
|
|
1988
|
-
userBalance?: string;
|
|
1989
|
-
/** @description The minimum balance the user needs to have to swap */
|
|
1990
|
-
requiredToSolve?: string;
|
|
1991
|
-
};
|
|
1992
|
-
/** @description A summary of the swap and what the user should expect to happen given an input */
|
|
1993
|
-
details?: {
|
|
1994
|
-
/** @description The operation that will be performed, possible options are send, swap, wrap, unwrap, bridge */
|
|
1995
|
-
operation?: string;
|
|
1996
|
-
/** @description Estimated swap time in seconds */
|
|
1997
|
-
timeEstimate?: number;
|
|
1998
|
-
/** @description The user's balance in the given currency on the origin chain */
|
|
1999
|
-
userBalance?: string;
|
|
2000
|
-
/** @description The address that deposited the funds */
|
|
2001
|
-
sender?: string;
|
|
2002
|
-
/** @description The address that will be receiving the swap output */
|
|
2003
|
-
recipient?: string;
|
|
2004
|
-
/**
|
|
2005
|
-
* @example {
|
|
2006
|
-
* "currency": {
|
|
2007
|
-
* "chainId": 8453,
|
|
2008
|
-
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
2009
|
-
* "symbol": "USDC",
|
|
2010
|
-
* "name": "USD Coin",
|
|
2011
|
-
* "decimals": 6,
|
|
2012
|
-
* "metadata": {
|
|
2013
|
-
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
2014
|
-
* "verified": false,
|
|
2015
|
-
* "isNative": false
|
|
2016
|
-
* }
|
|
2017
|
-
* },
|
|
2018
|
-
* "amount": "30754920",
|
|
2019
|
-
* "amountFormatted": "30.75492",
|
|
2020
|
-
* "amountUsd": "30.901612",
|
|
2021
|
-
* "minimumAmount": "30454920"
|
|
2022
|
-
* }
|
|
2023
|
-
*/
|
|
2024
|
-
currencyIn?: {
|
|
2025
|
-
currency?: {
|
|
2026
|
-
chainId?: number;
|
|
2027
|
-
address?: string;
|
|
2028
|
-
symbol?: string;
|
|
2029
|
-
name?: string;
|
|
2030
|
-
decimals?: number;
|
|
2031
|
-
metadata?: {
|
|
2032
|
-
logoURI?: string;
|
|
2033
|
-
verified?: boolean;
|
|
2034
|
-
isNative?: boolean;
|
|
2035
|
-
};
|
|
2036
|
-
};
|
|
2037
|
-
amount?: string;
|
|
2038
|
-
amountFormatted?: string;
|
|
2039
|
-
amountUsd?: string;
|
|
2040
|
-
minimumAmount?: string;
|
|
2041
|
-
};
|
|
2042
|
-
/**
|
|
2043
|
-
* @example {
|
|
2044
|
-
* "currency": {
|
|
2045
|
-
* "chainId": 8453,
|
|
2046
|
-
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
2047
|
-
* "symbol": "USDC",
|
|
2048
|
-
* "name": "USD Coin",
|
|
2049
|
-
* "decimals": 6,
|
|
2050
|
-
* "metadata": {
|
|
2051
|
-
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
2052
|
-
* "verified": false,
|
|
2053
|
-
* "isNative": false
|
|
2054
|
-
* }
|
|
2055
|
-
* },
|
|
2056
|
-
* "amount": "30754920",
|
|
2057
|
-
* "amountFormatted": "30.75492",
|
|
2058
|
-
* "amountUsd": "30.901612",
|
|
2059
|
-
* "minimumAmount": "30454920"
|
|
2060
|
-
* }
|
|
2061
|
-
*/
|
|
2062
|
-
currencyOut?: {
|
|
2063
|
-
currency?: {
|
|
2064
|
-
chainId?: number;
|
|
2065
|
-
address?: string;
|
|
2066
|
-
symbol?: string;
|
|
2067
|
-
name?: string;
|
|
2068
|
-
decimals?: number;
|
|
2069
|
-
metadata?: {
|
|
2070
|
-
logoURI?: string;
|
|
2071
|
-
verified?: boolean;
|
|
2072
|
-
isNative?: boolean;
|
|
2073
|
-
};
|
|
2074
|
-
};
|
|
2075
|
-
amount?: string;
|
|
2076
|
-
amountFormatted?: string;
|
|
2077
|
-
amountUsd?: string;
|
|
2078
|
-
minimumAmount?: string;
|
|
2079
|
-
};
|
|
2080
|
-
/** @description The difference between the input and output values, including fees */
|
|
2081
|
-
totalImpact?: {
|
|
2082
|
-
usd?: string;
|
|
2083
|
-
percent?: string;
|
|
2084
|
-
};
|
|
2085
|
-
/** @description The impact of the swap, not factoring in fees */
|
|
2086
|
-
swapImpact?: {
|
|
2087
|
-
usd?: string;
|
|
2088
|
-
percent?: string;
|
|
2089
|
-
};
|
|
2090
|
-
/** @description The swap rate which is equal to 1 input unit in the output unit, e.g. 1 USDC -> x ETH. This value can fluctuate based on gas and fees. */
|
|
2091
|
-
rate?: string;
|
|
2092
|
-
slippageTolerance?: {
|
|
2093
|
-
/** @description The slippage tolerance on the origin chain swap */
|
|
2094
|
-
origin?: {
|
|
2095
|
-
usd?: string;
|
|
2096
|
-
value?: string;
|
|
2097
|
-
percent?: string;
|
|
2098
|
-
};
|
|
2099
|
-
/** @description The slippage tolerance on the destination chain swap */
|
|
2100
|
-
destination?: {
|
|
2101
|
-
usd?: string;
|
|
2102
|
-
value?: string;
|
|
2103
|
-
percent?: string;
|
|
2104
|
-
};
|
|
1627
|
+
amountUsd?: string;
|
|
1628
|
+
minimumAmount?: string;
|
|
2105
1629
|
};
|
|
2106
1630
|
};
|
|
1631
|
+
/**
|
|
1632
|
+
* @example {
|
|
1633
|
+
* "value": "1000000000000000000",
|
|
1634
|
+
* "timeEstimate": 10
|
|
1635
|
+
* }
|
|
1636
|
+
*/
|
|
1637
|
+
breakdown?: {
|
|
1638
|
+
/** @description Amount that will be executed in the estimated time */
|
|
1639
|
+
value?: string;
|
|
1640
|
+
/** @description Estimated execution time in seconds */
|
|
1641
|
+
timeEstimate?: number;
|
|
1642
|
+
}[];
|
|
1643
|
+
/**
|
|
1644
|
+
* @example {
|
|
1645
|
+
* "userBalance": "54764083517303347",
|
|
1646
|
+
* "requiredToSolve": "995010521157287036"
|
|
1647
|
+
* }
|
|
1648
|
+
*/
|
|
1649
|
+
balances?: {
|
|
1650
|
+
/** @description The user's balance in the given currency on the origin chain */
|
|
1651
|
+
userBalance?: string;
|
|
1652
|
+
/** @description The minimum balance the user needs to have to bridge */
|
|
1653
|
+
requiredToSolve?: string;
|
|
1654
|
+
};
|
|
2107
1655
|
};
|
|
2108
1656
|
};
|
|
2109
1657
|
};
|
|
@@ -2112,6 +1660,12 @@ export interface paths {
|
|
|
2112
1660
|
content: {
|
|
2113
1661
|
"application/json": {
|
|
2114
1662
|
message?: string;
|
|
1663
|
+
code?: string;
|
|
1664
|
+
tx?: {
|
|
1665
|
+
to?: string;
|
|
1666
|
+
value?: string;
|
|
1667
|
+
data?: string;
|
|
1668
|
+
};
|
|
2115
1669
|
};
|
|
2116
1670
|
};
|
|
2117
1671
|
};
|
|
@@ -2120,6 +1674,7 @@ export interface paths {
|
|
|
2120
1674
|
content: {
|
|
2121
1675
|
"application/json": {
|
|
2122
1676
|
message?: string;
|
|
1677
|
+
code?: string;
|
|
2123
1678
|
};
|
|
2124
1679
|
};
|
|
2125
1680
|
};
|
|
@@ -2128,45 +1683,65 @@ export interface paths {
|
|
|
2128
1683
|
content: {
|
|
2129
1684
|
"application/json": {
|
|
2130
1685
|
message?: string;
|
|
1686
|
+
code?: string;
|
|
1687
|
+
tx?: {
|
|
1688
|
+
to?: string;
|
|
1689
|
+
value?: string;
|
|
1690
|
+
data?: string;
|
|
1691
|
+
};
|
|
2131
1692
|
};
|
|
2132
1693
|
};
|
|
2133
1694
|
};
|
|
2134
1695
|
};
|
|
2135
1696
|
};
|
|
2136
1697
|
};
|
|
2137
|
-
"/execute/swap
|
|
1698
|
+
"/execute/swap": {
|
|
2138
1699
|
post: {
|
|
2139
1700
|
requestBody: {
|
|
2140
1701
|
content: {
|
|
2141
1702
|
"application/json": {
|
|
2142
|
-
/** @description
|
|
1703
|
+
/** @description Address that is depositing funds on the origin chain and submitting transactions or signatures */
|
|
2143
1704
|
user: string;
|
|
1705
|
+
/** @description Address that is receiving the funds on the destination chain, if not specified then this will default to the user address */
|
|
2144
1706
|
recipient?: string;
|
|
2145
|
-
|
|
2146
|
-
origins: {
|
|
2147
|
-
chainId: number;
|
|
2148
|
-
currency: string;
|
|
2149
|
-
amount: string;
|
|
2150
|
-
/** @description User address that will make the deposit on a given origin chain */
|
|
2151
|
-
user?: string;
|
|
2152
|
-
}[];
|
|
2153
|
-
destinationCurrency: string;
|
|
1707
|
+
originChainId: number;
|
|
2154
1708
|
destinationChainId: number;
|
|
2155
|
-
|
|
1709
|
+
originCurrency: string;
|
|
1710
|
+
destinationCurrency: string;
|
|
1711
|
+
/** @description Amount to swap as the base amount (can be switched to exact input/output using the dedicated flag), denoted in the smallest unit of the specified currency (e.g., wei for ETH) */
|
|
1712
|
+
amount: string;
|
|
1713
|
+
/**
|
|
1714
|
+
* @description Whether to use the amount as the output or the input for the basis of the swap
|
|
1715
|
+
* @enum {string}
|
|
1716
|
+
*/
|
|
1717
|
+
tradeType: "EXACT_INPUT" | "EXACT_OUTPUT" | "EXPECTED_OUTPUT";
|
|
2156
1718
|
txs?: {
|
|
2157
1719
|
to?: string;
|
|
2158
1720
|
value?: string;
|
|
2159
1721
|
data?: string;
|
|
2160
1722
|
}[];
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
|
-
|
|
1723
|
+
source?: string;
|
|
1724
|
+
/** @description Address to send the refund to in the case of failure, if not specified then the recipient address or user address is used */
|
|
1725
|
+
refundTo?: string;
|
|
1726
|
+
/**
|
|
1727
|
+
* @deprecated
|
|
1728
|
+
* @description Always refund on the origin chain in case of any issues
|
|
1729
|
+
*/
|
|
1730
|
+
refundOnOrigin?: boolean;
|
|
1731
|
+
/** @description Enable this to use canonical+ bridging, trading speed for more liquidity */
|
|
1732
|
+
useExternalLiquidity?: boolean;
|
|
1733
|
+
/** @description Enable this for specific fallback routes */
|
|
1734
|
+
useFallbacks?: boolean;
|
|
1735
|
+
/** @description Enable this to use permit (eip3009) when bridging, only works on supported currency such as usdc */
|
|
1736
|
+
usePermit?: boolean;
|
|
2168
1737
|
/** @description Slippage tolerance for the swap, if not specified then the slippage tolerance is automatically calculated to avoid front-running. This value is in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage */
|
|
2169
1738
|
slippageTolerance?: string;
|
|
1739
|
+
appFees?: {
|
|
1740
|
+
/** @description Address that will receive the app fee */
|
|
1741
|
+
recipient?: string;
|
|
1742
|
+
/** @description App fees to be charged for execution in basis points, e.g. 100 = 1% */
|
|
1743
|
+
fee?: string;
|
|
1744
|
+
}[];
|
|
2170
1745
|
};
|
|
2171
1746
|
};
|
|
2172
1747
|
};
|
|
@@ -2630,6 +2205,10 @@ export interface paths {
|
|
|
2630
2205
|
/** @description The permit signature. */
|
|
2631
2206
|
signature: string;
|
|
2632
2207
|
};
|
|
2208
|
+
header?: {
|
|
2209
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
2210
|
+
"x-api-key"?: string;
|
|
2211
|
+
};
|
|
2633
2212
|
};
|
|
2634
2213
|
requestBody: {
|
|
2635
2214
|
content: {
|
|
@@ -2691,6 +2270,12 @@ export interface paths {
|
|
|
2691
2270
|
* @description This endpoint is deprecated. Use /quote/v2 instead.
|
|
2692
2271
|
*/
|
|
2693
2272
|
post: {
|
|
2273
|
+
parameters: {
|
|
2274
|
+
header?: {
|
|
2275
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
2276
|
+
"x-api-key"?: string;
|
|
2277
|
+
};
|
|
2278
|
+
};
|
|
2694
2279
|
requestBody: {
|
|
2695
2280
|
content: {
|
|
2696
2281
|
"application/json": {
|
|
@@ -2775,7 +2360,7 @@ export interface paths {
|
|
|
2775
2360
|
permitExpiry?: number;
|
|
2776
2361
|
/** @description Enable this to use a deposit address when bridging, in scenarios where calldata cannot be sent alongside the transaction. only works on native currency bridges. For new requests, EXACT_OUTPUT is only supported when strict is also enabled. */
|
|
2777
2362
|
useDepositAddress?: boolean;
|
|
2778
|
-
/** @description When used with useDepositAddress, enables a strict deposit address that is tied to a specific order. Underpayments fail and refund,
|
|
2363
|
+
/** @description When used with useDepositAddress, enables a strict deposit address that is tied to a specific order. Underpayments fail and refund, exact payments fill, and overpayments fill the quoted amount while refunding the excess in a separate refund leg. EXACT_OUTPUT deposit-address requests are only supported in strict mode. Open-ended deposit addresses remain the flexible path for variable deposited amounts. Requires a refundTo address. */
|
|
2779
2364
|
strict?: boolean;
|
|
2780
2365
|
/** @description Slippage tolerance for the swap, if not specified then the slippage tolerance is automatically calculated to avoid front-running. This value is in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage */
|
|
2781
2366
|
slippageTolerance?: string;
|
|
@@ -4753,6 +4338,12 @@ export interface paths {
|
|
|
4753
4338
|
};
|
|
4754
4339
|
"/quote/v2": {
|
|
4755
4340
|
post: {
|
|
4341
|
+
parameters: {
|
|
4342
|
+
header?: {
|
|
4343
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
4344
|
+
"x-api-key"?: string;
|
|
4345
|
+
};
|
|
4346
|
+
};
|
|
4756
4347
|
requestBody: {
|
|
4757
4348
|
content: {
|
|
4758
4349
|
"application/json": {
|
|
@@ -4837,7 +4428,7 @@ export interface paths {
|
|
|
4837
4428
|
permitExpiry?: number;
|
|
4838
4429
|
/** @description Enable this to use a deposit address when bridging, in scenarios where calldata cannot be sent alongside the transaction. only works on native currency bridges. For new requests, EXACT_OUTPUT is only supported when strict is also enabled. */
|
|
4839
4430
|
useDepositAddress?: boolean;
|
|
4840
|
-
/** @description When used with useDepositAddress, enables a strict deposit address that is tied to a specific order. Underpayments fail and refund,
|
|
4431
|
+
/** @description When used with useDepositAddress, enables a strict deposit address that is tied to a specific order. Underpayments fail and refund, exact payments fill, and overpayments fill the quoted amount while refunding the excess in a separate refund leg. EXACT_OUTPUT deposit-address requests are only supported in strict mode. Open-ended deposit addresses remain the flexible path for variable deposited amounts. Requires a refundTo address. */
|
|
4841
4432
|
strict?: boolean;
|
|
4842
4433
|
/** @description Slippage tolerance for the swap, if not specified then the slippage tolerance is automatically calculated to avoid front-running. This value is in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage */
|
|
4843
4434
|
slippageTolerance?: string;
|
|
@@ -7338,25 +6929,75 @@ export interface paths {
|
|
|
7338
6929
|
content: {
|
|
7339
6930
|
"application/json": {
|
|
7340
6931
|
/** @example to is required */
|
|
7341
|
-
error
|
|
6932
|
+
error: string;
|
|
7342
6933
|
} | {
|
|
7343
6934
|
/** @example data is required */
|
|
7344
|
-
error
|
|
6935
|
+
error: string;
|
|
7345
6936
|
} | {
|
|
7346
6937
|
/** @example value is required */
|
|
7347
|
-
error
|
|
6938
|
+
error: string;
|
|
7348
6939
|
} | {
|
|
7349
6940
|
/** @example chainId is required */
|
|
7350
|
-
error
|
|
6941
|
+
error: string;
|
|
7351
6942
|
} | {
|
|
7352
6943
|
/** @example authorizationList cannot be empty */
|
|
7353
|
-
error
|
|
7354
|
-
} | {
|
|
7355
|
-
/** @example
|
|
7356
|
-
error
|
|
7357
|
-
/** @example
|
|
7358
|
-
message
|
|
7359
|
-
|
|
6944
|
+
error: string;
|
|
6945
|
+
} | ({
|
|
6946
|
+
/** @example DELEGATION_REDEEM_FAILED */
|
|
6947
|
+
error: string;
|
|
6948
|
+
/** @example Delegation redemption reverted without data. Verify the signed delegation is unredeemed and matches the current chain, mode, and account. */
|
|
6949
|
+
message: string;
|
|
6950
|
+
/** @example 0xabc123... */
|
|
6951
|
+
requestId: string;
|
|
6952
|
+
details?: {
|
|
6953
|
+
topLevel: {
|
|
6954
|
+
type: string;
|
|
6955
|
+
address?: string;
|
|
6956
|
+
contract?: string;
|
|
6957
|
+
function?: string;
|
|
6958
|
+
selector?: string;
|
|
6959
|
+
error?: string;
|
|
6960
|
+
revertReason?: string;
|
|
6961
|
+
gasUsed?: string;
|
|
6962
|
+
};
|
|
6963
|
+
innermost: {
|
|
6964
|
+
type: string;
|
|
6965
|
+
address?: string;
|
|
6966
|
+
contract?: string;
|
|
6967
|
+
function?: string;
|
|
6968
|
+
selector?: string;
|
|
6969
|
+
error?: string;
|
|
6970
|
+
revertReason?: string;
|
|
6971
|
+
gasUsed?: string;
|
|
6972
|
+
};
|
|
6973
|
+
path: {
|
|
6974
|
+
type: string;
|
|
6975
|
+
address?: string;
|
|
6976
|
+
contract?: string;
|
|
6977
|
+
function?: string;
|
|
6978
|
+
selector?: string;
|
|
6979
|
+
error?: string;
|
|
6980
|
+
revertReason?: string;
|
|
6981
|
+
gasUsed?: string;
|
|
6982
|
+
}[];
|
|
6983
|
+
revert: {
|
|
6984
|
+
/** @enum {string} */
|
|
6985
|
+
type: "errorString" | "panic" | "customError" | "unknownCustomError" | "empty";
|
|
6986
|
+
/** @example DELEGATION_REDEEM_FAILED */
|
|
6987
|
+
label: string;
|
|
6988
|
+
/** @example Delegation redemption reverted without data. Verify the signed delegation is unredeemed and matches the current chain, mode, and account. */
|
|
6989
|
+
message: string;
|
|
6990
|
+
/** @example 0x08c379a0 */
|
|
6991
|
+
selector?: string;
|
|
6992
|
+
/** @example Error */
|
|
6993
|
+
name?: string;
|
|
6994
|
+
args?: {
|
|
6995
|
+
[key: string]: string;
|
|
6996
|
+
};
|
|
6997
|
+
rawArgsHex?: string;
|
|
6998
|
+
};
|
|
6999
|
+
};
|
|
7000
|
+
});
|
|
7360
7001
|
};
|
|
7361
7002
|
};
|
|
7362
7003
|
/** @description Unauthorized - Missing or invalid API key or referrer */
|
|
@@ -7484,10 +7125,10 @@ export interface paths {
|
|
|
7484
7125
|
status?: string;
|
|
7485
7126
|
report?: {
|
|
7486
7127
|
version?: string;
|
|
7487
|
-
[key: string]:
|
|
7128
|
+
[key: string]: ({
|
|
7488
7129
|
status?: string;
|
|
7489
7130
|
reason?: string | null;
|
|
7490
|
-
}) | undefined;
|
|
7131
|
+
}) | string | undefined;
|
|
7491
7132
|
};
|
|
7492
7133
|
};
|
|
7493
7134
|
};
|
|
@@ -7499,10 +7140,10 @@ export interface paths {
|
|
|
7499
7140
|
status?: string;
|
|
7500
7141
|
report?: {
|
|
7501
7142
|
version?: string;
|
|
7502
|
-
[key: string]:
|
|
7143
|
+
[key: string]: ({
|
|
7503
7144
|
status?: string;
|
|
7504
7145
|
reason?: string | null;
|
|
7505
|
-
}) | undefined;
|
|
7146
|
+
}) | string | undefined;
|
|
7506
7147
|
};
|
|
7507
7148
|
};
|
|
7508
7149
|
};
|
|
@@ -7517,6 +7158,10 @@ export interface paths {
|
|
|
7517
7158
|
/** @description A unique id representing the execution in the Relay system. You can obtain this id from the requests api or the check object within the step items. */
|
|
7518
7159
|
requestId?: string;
|
|
7519
7160
|
};
|
|
7161
|
+
header?: {
|
|
7162
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
7163
|
+
"x-api-key"?: string;
|
|
7164
|
+
};
|
|
7520
7165
|
};
|
|
7521
7166
|
responses: {
|
|
7522
7167
|
/** @description Default Response */
|
|
@@ -7550,6 +7195,10 @@ export interface paths {
|
|
|
7550
7195
|
/** @description A unique id representing the execution in the Relay system. You can obtain this id from the requests api or the check object within the step items. */
|
|
7551
7196
|
requestId?: string;
|
|
7552
7197
|
};
|
|
7198
|
+
header?: {
|
|
7199
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
7200
|
+
"x-api-key"?: string;
|
|
7201
|
+
};
|
|
7553
7202
|
};
|
|
7554
7203
|
responses: {
|
|
7555
7204
|
/** @description Default Response */
|
|
@@ -7582,6 +7231,10 @@ export interface paths {
|
|
|
7582
7231
|
/** @description A unique id representing the execution in the Relay system. You can obtain this id from the requests api or the check object within the step items. */
|
|
7583
7232
|
requestId?: string;
|
|
7584
7233
|
};
|
|
7234
|
+
header?: {
|
|
7235
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
7236
|
+
"x-api-key"?: string;
|
|
7237
|
+
};
|
|
7585
7238
|
};
|
|
7586
7239
|
responses: {
|
|
7587
7240
|
/** @description Default Response */
|
|
@@ -7695,6 +7348,10 @@ export interface paths {
|
|
|
7695
7348
|
startTimestamp?: number;
|
|
7696
7349
|
endTimestamp?: number;
|
|
7697
7350
|
};
|
|
7351
|
+
header?: {
|
|
7352
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
7353
|
+
"x-api-key"?: string;
|
|
7354
|
+
};
|
|
7698
7355
|
};
|
|
7699
7356
|
responses: {
|
|
7700
7357
|
/** @description Default Response */
|
|
@@ -7906,34 +7563,57 @@ export interface paths {
|
|
|
7906
7563
|
get: {
|
|
7907
7564
|
parameters: {
|
|
7908
7565
|
query?: {
|
|
7566
|
+
/** @description Maximum number of requests to return per page. */
|
|
7909
7567
|
limit?: number;
|
|
7568
|
+
/** @description Pagination cursor returned by a previous response. Pass it back to fetch the next page. */
|
|
7910
7569
|
continuation?: string;
|
|
7570
|
+
/** @description Filter requests where this address is the sender or recipient. */
|
|
7911
7571
|
user?: string;
|
|
7572
|
+
/** @description Filter requests by an origin or destination transaction hash. */
|
|
7912
7573
|
hash?: string;
|
|
7574
|
+
/** @description Filter requests where this is the origin chain. */
|
|
7913
7575
|
originChainId?: number;
|
|
7576
|
+
/** @description Filter requests where this is the destination chain. */
|
|
7914
7577
|
destinationChainId?: number;
|
|
7578
|
+
/** @description Comma-separated list of private chain UUIDs to include in the results. */
|
|
7915
7579
|
privateChainsToInclude?: string;
|
|
7580
|
+
/** @description Filter by `requestId` — the Relay-level intent identifier returned by the quote api. Used for status polling, webhooks, and most other API endpoints. */
|
|
7916
7581
|
id?: string;
|
|
7582
|
+
/** @description Filter by `orderId` — the protocol-level deposit identifier passed as `bytes32 id` to the Relay Depository when funds are deposited, and emitted in the deposit event. */
|
|
7917
7583
|
orderId?: string;
|
|
7584
|
+
/** @description When true, include the raw `orderData` blob in each request. */
|
|
7918
7585
|
includeOrderData?: boolean;
|
|
7586
|
+
/** @description Filter requests created at or after this Unix timestamp (seconds). */
|
|
7919
7587
|
startTimestamp?: number;
|
|
7588
|
+
/** @description Filter requests created at or before this Unix timestamp (seconds). */
|
|
7920
7589
|
endTimestamp?: number;
|
|
7590
|
+
/** @description Filter requests by origin-chain block number (inclusive lower bound). */
|
|
7921
7591
|
startBlock?: number;
|
|
7592
|
+
/** @description Filter requests by origin-chain block number (inclusive upper bound). */
|
|
7922
7593
|
endBlock?: number;
|
|
7923
7594
|
/** @description Get all requests for a single chain in either direction. Setting originChainId and/or destinationChainId will override this parameter. */
|
|
7924
7595
|
chainId?: string;
|
|
7596
|
+
/** @description Filter requests by the `referrer` value supplied at quote time. */
|
|
7925
7597
|
referrer?: string;
|
|
7926
7598
|
/** @description Filter requests by deposit address. Returns all requests associated with this deposit address. */
|
|
7927
7599
|
depositAddress?: string;
|
|
7928
7600
|
/** @description When filtering by id or depositAddress, also return child transactions (e.g. duplicates, retries, refunds) linked to the original request. */
|
|
7929
7601
|
includeChildRequests?: boolean;
|
|
7602
|
+
/** @description When true, include fields available only to the authenticating integrator for their own requests. */
|
|
7603
|
+
includeAuthenticatedData?: boolean;
|
|
7930
7604
|
/** @description Filter requests by status. */
|
|
7931
7605
|
status?: "success" | "failure" | "refund" | "pending" | "depositing";
|
|
7932
7606
|
/** @description Filter requests by the API key that created them. */
|
|
7933
7607
|
apiKey?: string;
|
|
7608
|
+
/** @description Field to sort by. */
|
|
7934
7609
|
sortBy?: "createdAt" | "updatedAt";
|
|
7610
|
+
/** @description Sort direction. */
|
|
7935
7611
|
sortDirection?: "asc" | "desc";
|
|
7936
7612
|
};
|
|
7613
|
+
header?: {
|
|
7614
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
7615
|
+
"x-api-key"?: string;
|
|
7616
|
+
};
|
|
7937
7617
|
};
|
|
7938
7618
|
responses: {
|
|
7939
7619
|
/** @description Default Response */
|
|
@@ -7949,7 +7629,8 @@ export interface paths {
|
|
|
7949
7629
|
* "depositAddress": {
|
|
7950
7630
|
* "address": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
|
|
7951
7631
|
* "depositAddressType": "open",
|
|
7952
|
-
* "depositor": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea"
|
|
7632
|
+
* "depositor": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
|
|
7633
|
+
* "depositTxHash": "0x34d78ccb41099f0546be1c35541b28ab4c92b498aeb4cae6e849c51c05fe1f1b"
|
|
7953
7634
|
* },
|
|
7954
7635
|
* "data": {
|
|
7955
7636
|
* "subsidizedRequest": false,
|
|
@@ -8003,27 +7684,33 @@ export interface paths {
|
|
|
8003
7684
|
* }
|
|
8004
7685
|
*/
|
|
8005
7686
|
requests?: ({
|
|
7687
|
+
/** @description The `requestId` — the Relay-level intent identifier used across the API for status polling, webhooks, and most other endpoints. Distinct from `protocol.orderId`, which is the protocol-level deposit identifier extractable from on-chain data. */
|
|
8006
7688
|
id?: string;
|
|
8007
7689
|
/**
|
|
8008
7690
|
* @description Note that fallback is returned in the case of a refund
|
|
8009
7691
|
* @enum {string}
|
|
8010
7692
|
*/
|
|
8011
7693
|
status?: "refund" | "waiting" | "depositing" | "failure" | "pending" | "success";
|
|
7694
|
+
/** @description The address that initiated the request. */
|
|
8012
7695
|
user?: string;
|
|
7696
|
+
/** @description The address that receives the destination output. */
|
|
8013
7697
|
recipient?: string;
|
|
8014
7698
|
depositAddress?: ({
|
|
8015
7699
|
address?: string;
|
|
8016
7700
|
/** @enum {string} */
|
|
8017
7701
|
depositAddressType?: "strict" | "open";
|
|
8018
7702
|
depositor?: string | null;
|
|
7703
|
+
depositTxHash?: string | null;
|
|
8019
7704
|
}) | null;
|
|
8020
7705
|
data?: {
|
|
8021
7706
|
/** @description Slippage tolerance for the swap. This value is in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage */
|
|
8022
7707
|
slippageTolerance?: string;
|
|
8023
7708
|
/** @enum {string} */
|
|
8024
|
-
failReason?: "UNKNOWN" | "SLIPPAGE" | "AMOUNT_TOO_LOW_TO_REFUND" | "DEPOSIT_ADDRESS_MISMATCH" | "DEPOSIT_CHAIN_MISMATCH" | "INCORRECT_DEPOSIT_CURRENCY" | "DOUBLE_SPEND" | "SOLVER_CAPACITY_EXCEEDED" | "DEPOSITED_AMOUNT_TOO_LOW_TO_FILL" | "NEGATIVE_NEW_AMOUNT_AFTER_FEES" | "NO_QUOTES" | "MISSING_REVERT_DATA" | "REVERSE_SWAP_FAILED" | "GENERATE_SWAP_FAILED" | "TOO_LITTLE_RECEIVED" | "EXECUTION_REVERTED" | "NEW_CALLDATA_INCLUDES_HIGHER_RENT_FEE" | "TRANSACTION_REVERTED" | "ORIGIN_CURRENCY_MISMATCH" | "NO_INTERNAL_SWAP_ROUTES_FOUND" | "SWAP_USES_TOO_MUCH_GAS" | "INSUFFICIENT_FUNDS_FOR_RENT" | "SPONSOR_BALANCE_TOO_LOW" | "ORDER_EXPIRED" | "ORDER_IS_CANCELLED" | "TRANSFER_FROM_FAILED" | "TRANSFER_FAILED" | "SIGNATURE_EXPIRED" | "INVALID_SIGNATURE" | "INSUFFICIENT_NATIVE_TOKENS_SUPPLIED" | "TRANSFER_AMOUNT_EXCEEDS_ALLOWANCE" | "TRANSFER_AMOUNT_EXCEEDS_BALANCE" | "INVALID_SENDER" | "ACCOUNT_ABSTRACTION_INVALID_NONCE" | "ACCOUNT_ABSTRACTION_SIGNATURE_ERROR" | "SEAPORT_INEXACT_FRACTION" | "TOKEN_NOT_TRANSFERABLE" | "ZERO_SELL_AMOUNT" | "MINT_NOT_ACTIVE" | "ERC_1155_TOO_MANY_REQUESTED" | "INCORRECT_PAYMENT" | "INVALID_GAS_PRICE" | "FLUID_DEX_ERROR" | "ORDER_ALREADY_FILLED" | "SEAPORT_INVALID_FULFILLER" | "INVALID_SIGNER" | "MINT_QUANTITY_EXCEEDS_MAX_PER_WALLET" | "MINT_QUANTITY_EXCEEDS_MAX_SUPPLY" | "JUPITER_INVALID_TOKEN_ACCOUNT" | "INVALID_NONCE" | "ACCOUNT_ABSTRACTION_GAS_LIMIT" | "CONTRACT_PAUSED" | "SWAP_IMPACT_TOO_HIGH" | "INSUFFICIENT_POOL_LIQUIDITY" | "TTL_EXPIRED" | "N/A";
|
|
7709
|
+
failReason?: "UNKNOWN" | "SLIPPAGE" | "AMOUNT_TOO_LOW_TO_REFUND" | "DEPOSIT_ADDRESS_MISMATCH" | "DEPOSIT_CHAIN_MISMATCH" | "INCORRECT_DEPOSIT_CURRENCY" | "DOUBLE_SPEND" | "SOLVER_CAPACITY_EXCEEDED" | "SOLVER_BALANCE_TOO_LOW" | "DEPOSITED_AMOUNT_TOO_LOW_TO_FILL" | "NEGATIVE_NEW_AMOUNT_AFTER_FEES" | "NO_QUOTES" | "MISSING_REVERT_DATA" | "REVERSE_SWAP_FAILED" | "GENERATE_SWAP_FAILED" | "TOO_LITTLE_RECEIVED" | "EXECUTION_REVERTED" | "NEW_CALLDATA_INCLUDES_HIGHER_RENT_FEE" | "TRANSACTION_REVERTED" | "TRANSACTION_TOO_LARGE" | "ORIGIN_CURRENCY_MISMATCH" | "NO_INTERNAL_SWAP_ROUTES_FOUND" | "SWAP_USES_TOO_MUCH_GAS" | "INSUFFICIENT_FUNDS_FOR_RENT" | "SPONSOR_BALANCE_TOO_LOW" | "ORDER_EXPIRED" | "ORDER_IS_CANCELLED" | "TRANSFER_FROM_FAILED" | "TRANSFER_FAILED" | "SIGNATURE_EXPIRED" | "INVALID_SIGNATURE" | "INSUFFICIENT_NATIVE_TOKENS_SUPPLIED" | "TRANSFER_AMOUNT_EXCEEDS_ALLOWANCE" | "TRANSFER_AMOUNT_EXCEEDS_BALANCE" | "INVALID_SENDER" | "ACCOUNT_ABSTRACTION_INVALID_NONCE" | "ACCOUNT_ABSTRACTION_SIGNATURE_ERROR" | "SEAPORT_INEXACT_FRACTION" | "TOKEN_NOT_TRANSFERABLE" | "ZERO_SELL_AMOUNT" | "MINT_NOT_ACTIVE" | "ERC_1155_TOO_MANY_REQUESTED" | "INCORRECT_PAYMENT" | "INVALID_GAS_PRICE" | "FLUID_DEX_ERROR" | "ORDER_ALREADY_FILLED" | "SEAPORT_INVALID_FULFILLER" | "INVALID_SIGNER" | "MINT_QUANTITY_EXCEEDS_MAX_PER_WALLET" | "MINT_QUANTITY_EXCEEDS_MAX_SUPPLY" | "JUPITER_INVALID_TOKEN_ACCOUNT" | "INVALID_NONCE" | "ACCOUNT_ABSTRACTION_GAS_LIMIT" | "CONTRACT_PAUSED" | "SWAP_IMPACT_TOO_HIGH" | "INSUFFICIENT_POOL_LIQUIDITY" | "TTL_EXPIRED" | "N/A";
|
|
8025
7710
|
/** @enum {string} */
|
|
8026
|
-
refundFailReason?: "AMOUNT_TOO_LOW_TO_REFUND" | "NEGATIVE_NEW_AMOUNT_AFTER_FEES" | "SWAP_CURRENCY_NOT_ON_ORIGIN";
|
|
7711
|
+
refundFailReason?: "AMOUNT_TOO_LOW_TO_REFUND" | "NEGATIVE_NEW_AMOUNT_AFTER_FEES" | "SWAP_CURRENCY_NOT_ON_ORIGIN" | "REFUND_RECIPIENT_IS_VASP";
|
|
7712
|
+
/** @description Regenerated requestId that now owns the sweep/fill for a superseded deposit-address request. */
|
|
7713
|
+
supersededByRequestId?: string | null;
|
|
8027
7714
|
failedTxHash?: string;
|
|
8028
7715
|
failedTxBlockNumber?: number;
|
|
8029
7716
|
failedCallData?: {
|
|
@@ -9384,6 +9071,128 @@ export interface paths {
|
|
|
9384
9071
|
amountUsd?: string;
|
|
9385
9072
|
amountUsdCurrent?: string;
|
|
9386
9073
|
}[];
|
|
9074
|
+
platformFee?: ({
|
|
9075
|
+
bucket?: string;
|
|
9076
|
+
ruleId?: string;
|
|
9077
|
+
relayFeeBps?: number;
|
|
9078
|
+
integratorFeeBps?: number;
|
|
9079
|
+
totalFeeBps?: number;
|
|
9080
|
+
/**
|
|
9081
|
+
* @example {
|
|
9082
|
+
* "currency": {
|
|
9083
|
+
* "chainId": 8453,
|
|
9084
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
9085
|
+
* "symbol": "USDC",
|
|
9086
|
+
* "name": "USD Coin",
|
|
9087
|
+
* "decimals": 6,
|
|
9088
|
+
* "metadata": {
|
|
9089
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
9090
|
+
* "verified": false,
|
|
9091
|
+
* "isNative": false
|
|
9092
|
+
* }
|
|
9093
|
+
* },
|
|
9094
|
+
* "amount": "30754920",
|
|
9095
|
+
* "amountFormatted": "30.75492",
|
|
9096
|
+
* "amountUsd": "30.901612",
|
|
9097
|
+
* "minimumAmount": "30454920"
|
|
9098
|
+
* }
|
|
9099
|
+
*/
|
|
9100
|
+
relayFee?: {
|
|
9101
|
+
currency?: {
|
|
9102
|
+
chainId?: number;
|
|
9103
|
+
address?: string;
|
|
9104
|
+
symbol?: string;
|
|
9105
|
+
name?: string;
|
|
9106
|
+
decimals?: number;
|
|
9107
|
+
metadata?: {
|
|
9108
|
+
logoURI?: string;
|
|
9109
|
+
verified?: boolean;
|
|
9110
|
+
isNative?: boolean;
|
|
9111
|
+
};
|
|
9112
|
+
};
|
|
9113
|
+
amount?: string;
|
|
9114
|
+
amountFormatted?: string;
|
|
9115
|
+
amountUsd?: string;
|
|
9116
|
+
minimumAmount?: string;
|
|
9117
|
+
};
|
|
9118
|
+
/**
|
|
9119
|
+
* @example {
|
|
9120
|
+
* "currency": {
|
|
9121
|
+
* "chainId": 8453,
|
|
9122
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
9123
|
+
* "symbol": "USDC",
|
|
9124
|
+
* "name": "USD Coin",
|
|
9125
|
+
* "decimals": 6,
|
|
9126
|
+
* "metadata": {
|
|
9127
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
9128
|
+
* "verified": false,
|
|
9129
|
+
* "isNative": false
|
|
9130
|
+
* }
|
|
9131
|
+
* },
|
|
9132
|
+
* "amount": "30754920",
|
|
9133
|
+
* "amountFormatted": "30.75492",
|
|
9134
|
+
* "amountUsd": "30.901612",
|
|
9135
|
+
* "minimumAmount": "30454920"
|
|
9136
|
+
* }
|
|
9137
|
+
*/
|
|
9138
|
+
integratorFee?: {
|
|
9139
|
+
currency?: {
|
|
9140
|
+
chainId?: number;
|
|
9141
|
+
address?: string;
|
|
9142
|
+
symbol?: string;
|
|
9143
|
+
name?: string;
|
|
9144
|
+
decimals?: number;
|
|
9145
|
+
metadata?: {
|
|
9146
|
+
logoURI?: string;
|
|
9147
|
+
verified?: boolean;
|
|
9148
|
+
isNative?: boolean;
|
|
9149
|
+
};
|
|
9150
|
+
};
|
|
9151
|
+
amount?: string;
|
|
9152
|
+
amountFormatted?: string;
|
|
9153
|
+
amountUsd?: string;
|
|
9154
|
+
minimumAmount?: string;
|
|
9155
|
+
};
|
|
9156
|
+
/**
|
|
9157
|
+
* @example {
|
|
9158
|
+
* "currency": {
|
|
9159
|
+
* "chainId": 8453,
|
|
9160
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
9161
|
+
* "symbol": "USDC",
|
|
9162
|
+
* "name": "USD Coin",
|
|
9163
|
+
* "decimals": 6,
|
|
9164
|
+
* "metadata": {
|
|
9165
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
9166
|
+
* "verified": false,
|
|
9167
|
+
* "isNative": false
|
|
9168
|
+
* }
|
|
9169
|
+
* },
|
|
9170
|
+
* "amount": "30754920",
|
|
9171
|
+
* "amountFormatted": "30.75492",
|
|
9172
|
+
* "amountUsd": "30.901612",
|
|
9173
|
+
* "minimumAmount": "30454920"
|
|
9174
|
+
* }
|
|
9175
|
+
*/
|
|
9176
|
+
totalPlatformFee?: {
|
|
9177
|
+
currency?: {
|
|
9178
|
+
chainId?: number;
|
|
9179
|
+
address?: string;
|
|
9180
|
+
symbol?: string;
|
|
9181
|
+
name?: string;
|
|
9182
|
+
decimals?: number;
|
|
9183
|
+
metadata?: {
|
|
9184
|
+
logoURI?: string;
|
|
9185
|
+
verified?: boolean;
|
|
9186
|
+
isNative?: boolean;
|
|
9187
|
+
};
|
|
9188
|
+
};
|
|
9189
|
+
amount?: string;
|
|
9190
|
+
amountFormatted?: string;
|
|
9191
|
+
amountUsd?: string;
|
|
9192
|
+
minimumAmount?: string;
|
|
9193
|
+
};
|
|
9194
|
+
integratorFeeRecipient?: string | null;
|
|
9195
|
+
}) | null;
|
|
9387
9196
|
metadata?: {
|
|
9388
9197
|
sender?: string;
|
|
9389
9198
|
recipient?: string;
|
|
@@ -9506,6 +9315,24 @@ export interface paths {
|
|
|
9506
9315
|
minimumAmount?: string;
|
|
9507
9316
|
};
|
|
9508
9317
|
rate?: string;
|
|
9318
|
+
quoteOraclePrice?: {
|
|
9319
|
+
rate?: string;
|
|
9320
|
+
inputAmount?: string;
|
|
9321
|
+
outputAmount?: string;
|
|
9322
|
+
observedAt?: string;
|
|
9323
|
+
from?: {
|
|
9324
|
+
chainId?: number;
|
|
9325
|
+
address?: string;
|
|
9326
|
+
currencyId?: string;
|
|
9327
|
+
decimals?: number;
|
|
9328
|
+
};
|
|
9329
|
+
to?: {
|
|
9330
|
+
chainId?: number;
|
|
9331
|
+
address?: string;
|
|
9332
|
+
currencyId?: string;
|
|
9333
|
+
decimals?: number;
|
|
9334
|
+
};
|
|
9335
|
+
};
|
|
9509
9336
|
route?: {
|
|
9510
9337
|
/** @description The route taken for the origin chain swap */
|
|
9511
9338
|
origin?: {
|
|
@@ -9674,7 +9501,6 @@ export interface paths {
|
|
|
9674
9501
|
price?: string;
|
|
9675
9502
|
usesExternalLiquidity?: boolean;
|
|
9676
9503
|
timeEstimate?: number;
|
|
9677
|
-
triggeredByCcm?: boolean;
|
|
9678
9504
|
triggeredByFastFill?: boolean;
|
|
9679
9505
|
outTxs?: ({
|
|
9680
9506
|
/** @description Total fees in wei */
|
|
@@ -9692,6 +9518,7 @@ export interface paths {
|
|
|
9692
9518
|
})[];
|
|
9693
9519
|
};
|
|
9694
9520
|
protocol?: {
|
|
9521
|
+
/** @description The protocol-level deposit identifier passed as `bytes32 id` to the Relay Depository when funds are deposited, and emitted in the deposit event. Use this to correlate on-chain deposit data to a Relay request. Distinct from the `requestId`, which is the Relay-level intent identifier used across the API. */
|
|
9695
9522
|
orderId?: string;
|
|
9696
9523
|
/** @enum {string} */
|
|
9697
9524
|
hubType?: "onchain";
|
|
@@ -9816,6 +9643,12 @@ export interface paths {
|
|
|
9816
9643
|
};
|
|
9817
9644
|
"/transactions/index": {
|
|
9818
9645
|
post: {
|
|
9646
|
+
parameters: {
|
|
9647
|
+
header?: {
|
|
9648
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
9649
|
+
"x-api-key"?: string;
|
|
9650
|
+
};
|
|
9651
|
+
};
|
|
9819
9652
|
requestBody: {
|
|
9820
9653
|
content: {
|
|
9821
9654
|
"application/json": {
|
|
@@ -9855,6 +9688,12 @@ export interface paths {
|
|
|
9855
9688
|
};
|
|
9856
9689
|
"/transactions/single": {
|
|
9857
9690
|
post: {
|
|
9691
|
+
parameters: {
|
|
9692
|
+
header?: {
|
|
9693
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
9694
|
+
"x-api-key"?: string;
|
|
9695
|
+
};
|
|
9696
|
+
};
|
|
9858
9697
|
requestBody: {
|
|
9859
9698
|
content: {
|
|
9860
9699
|
"application/json": {
|
|
@@ -9877,14 +9716,26 @@ export interface paths {
|
|
|
9877
9716
|
};
|
|
9878
9717
|
};
|
|
9879
9718
|
"/transactions/deposit-address/reindex": {
|
|
9719
|
+
/** @description Re-checks the balances of a previously-registered deposit address and queues a withdrawal for any currency with a non-zero balance. Useful when funds were sent to a deposit address but the normal indexer flow did not pick them up. */
|
|
9880
9720
|
post: {
|
|
9721
|
+
parameters: {
|
|
9722
|
+
header?: {
|
|
9723
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
9724
|
+
"x-api-key"?: string;
|
|
9725
|
+
};
|
|
9726
|
+
};
|
|
9881
9727
|
requestBody: {
|
|
9882
9728
|
content: {
|
|
9883
9729
|
"application/json": {
|
|
9730
|
+
/** @description Chain ID the deposit address was originally registered on. */
|
|
9884
9731
|
chainId: number;
|
|
9732
|
+
/** @description The deposit address to reindex. */
|
|
9885
9733
|
depositAddress: string;
|
|
9734
|
+
/** @description Deprecated. No longer supported on this endpoint. */
|
|
9886
9735
|
sweep?: boolean;
|
|
9736
|
+
/** @description Chain ID to reindex on, when different from `chainId`. Use this if funds landed on a chain other than the one the deposit address was registered on. Defaults to `chainId`. */
|
|
9887
9737
|
targetChainId?: number;
|
|
9738
|
+
/** @description Address of a specific currency to reindex. Defaults to checking every depositable currency on the chain. */
|
|
9888
9739
|
currency?: string;
|
|
9889
9740
|
};
|
|
9890
9741
|
};
|
|
@@ -9894,13 +9745,20 @@ export interface paths {
|
|
|
9894
9745
|
200: {
|
|
9895
9746
|
content: {
|
|
9896
9747
|
"application/json": {
|
|
9748
|
+
/** @description Human-readable summary of the reindex outcome. */
|
|
9897
9749
|
message?: string;
|
|
9750
|
+
/** @description Currencies for which a withdrawal was queued. */
|
|
9898
9751
|
triggeredCurrencies?: {
|
|
9752
|
+
/** @description Currency address. */
|
|
9899
9753
|
currency?: string;
|
|
9754
|
+
/** @description Currency symbol. */
|
|
9900
9755
|
symbol?: string;
|
|
9756
|
+
/** @description Balance found at the deposit address, in the currency's smallest unit. */
|
|
9901
9757
|
balance?: string;
|
|
9902
9758
|
}[];
|
|
9759
|
+
/** @description Total number of currencies whose balance was checked. */
|
|
9903
9760
|
checkedCurrencies?: number;
|
|
9761
|
+
/** @description Number of currencies whose balance check failed. */
|
|
9904
9762
|
failedCurrencies?: number;
|
|
9905
9763
|
};
|
|
9906
9764
|
};
|
|
@@ -9909,6 +9767,7 @@ export interface paths {
|
|
|
9909
9767
|
400: {
|
|
9910
9768
|
content: {
|
|
9911
9769
|
"application/json": {
|
|
9770
|
+
/** @description Reason the request was rejected. */
|
|
9912
9771
|
message?: string;
|
|
9913
9772
|
};
|
|
9914
9773
|
};
|
|
@@ -9917,6 +9776,7 @@ export interface paths {
|
|
|
9917
9776
|
403: {
|
|
9918
9777
|
content: {
|
|
9919
9778
|
"application/json": {
|
|
9779
|
+
/** @description The caller is not permitted to reindex this deposit address. */
|
|
9920
9780
|
message?: string;
|
|
9921
9781
|
};
|
|
9922
9782
|
};
|
|
@@ -9925,6 +9785,7 @@ export interface paths {
|
|
|
9925
9785
|
404: {
|
|
9926
9786
|
content: {
|
|
9927
9787
|
"application/json": {
|
|
9788
|
+
/** @description No deposit address was found for the given `chainId` and `depositAddress`. */
|
|
9928
9789
|
message?: string;
|
|
9929
9790
|
};
|
|
9930
9791
|
};
|
|
@@ -9933,6 +9794,7 @@ export interface paths {
|
|
|
9933
9794
|
429: {
|
|
9934
9795
|
content: {
|
|
9935
9796
|
"application/json": {
|
|
9797
|
+
/** @description The deposit address was reindexed too recently. */
|
|
9936
9798
|
message?: string;
|
|
9937
9799
|
};
|
|
9938
9800
|
};
|
|
@@ -9941,6 +9803,7 @@ export interface paths {
|
|
|
9941
9803
|
503: {
|
|
9942
9804
|
content: {
|
|
9943
9805
|
"application/json": {
|
|
9806
|
+
/** @description Transient failure. */
|
|
9944
9807
|
message?: string;
|
|
9945
9808
|
};
|
|
9946
9809
|
};
|
|
@@ -9955,6 +9818,10 @@ export interface paths {
|
|
|
9955
9818
|
/** @description Chain ID to get swap sources for */
|
|
9956
9819
|
chainId?: number;
|
|
9957
9820
|
};
|
|
9821
|
+
header?: {
|
|
9822
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
9823
|
+
"x-api-key"?: string;
|
|
9824
|
+
};
|
|
9958
9825
|
};
|
|
9959
9826
|
responses: {
|
|
9960
9827
|
/** @description Default Response */
|
|
@@ -10107,6 +9974,12 @@ export interface paths {
|
|
|
10107
9974
|
};
|
|
10108
9975
|
"/currencies/v1": {
|
|
10109
9976
|
post: {
|
|
9977
|
+
parameters: {
|
|
9978
|
+
header?: {
|
|
9979
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
9980
|
+
"x-api-key"?: string;
|
|
9981
|
+
};
|
|
9982
|
+
};
|
|
10110
9983
|
requestBody?: {
|
|
10111
9984
|
content: {
|
|
10112
9985
|
"application/json": {
|
|
@@ -10161,6 +10034,12 @@ export interface paths {
|
|
|
10161
10034
|
};
|
|
10162
10035
|
"/currencies/v2": {
|
|
10163
10036
|
post: {
|
|
10037
|
+
parameters: {
|
|
10038
|
+
header?: {
|
|
10039
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
10040
|
+
"x-api-key"?: string;
|
|
10041
|
+
};
|
|
10042
|
+
};
|
|
10164
10043
|
requestBody?: {
|
|
10165
10044
|
content: {
|
|
10166
10045
|
"application/json": {
|
|
@@ -10224,6 +10103,10 @@ export interface paths {
|
|
|
10224
10103
|
/** @description Chain ID of the token */
|
|
10225
10104
|
chainId: number;
|
|
10226
10105
|
};
|
|
10106
|
+
header?: {
|
|
10107
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
10108
|
+
"x-api-key"?: string;
|
|
10109
|
+
};
|
|
10227
10110
|
};
|
|
10228
10111
|
responses: {
|
|
10229
10112
|
/** @description Default Response */
|
|
@@ -10256,6 +10139,10 @@ export interface paths {
|
|
|
10256
10139
|
/** @description Chain ID of the token */
|
|
10257
10140
|
chainId: number;
|
|
10258
10141
|
};
|
|
10142
|
+
header?: {
|
|
10143
|
+
/** @description Optional API key for authentication and higher rate limits. */
|
|
10144
|
+
"x-api-key"?: string;
|
|
10145
|
+
};
|
|
10259
10146
|
};
|
|
10260
10147
|
responses: {
|
|
10261
10148
|
/** @description Default Response */
|
|
@@ -10629,6 +10516,7 @@ export interface paths {
|
|
|
10629
10516
|
wallet: string;
|
|
10630
10517
|
chainId?: string;
|
|
10631
10518
|
source?: string;
|
|
10519
|
+
forceScreen?: boolean;
|
|
10632
10520
|
};
|
|
10633
10521
|
};
|
|
10634
10522
|
responses: {
|
|
@@ -10639,6 +10527,13 @@ export interface paths {
|
|
|
10639
10527
|
message?: string;
|
|
10640
10528
|
isBlocked?: boolean;
|
|
10641
10529
|
isTrmBlocked?: boolean | null;
|
|
10530
|
+
trmBlockReasons?: ({
|
|
10531
|
+
category?: string;
|
|
10532
|
+
/** @enum {string} */
|
|
10533
|
+
severity?: "unknown" | "low" | "medium" | "high" | "severe";
|
|
10534
|
+
/** @enum {string|null} */
|
|
10535
|
+
riskType?: "OWNERSHIP" | "COUNTERPARTY" | "INDIRECT" | null;
|
|
10536
|
+
})[];
|
|
10642
10537
|
isHackBountyBlocked?: boolean;
|
|
10643
10538
|
isChainalysisBlocked?: boolean;
|
|
10644
10539
|
override?: string;
|