@relayprotocol/relay-sdk 3.2.0 → 4.0.1
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/actions/claimAppFees.js +2 -2
- package/_cjs/src/actions/claimAppFees.js.map +1 -1
- package/_cjs/src/actions/getQuote.js +1 -1
- package/_cjs/src/actions/getQuote.js.map +1 -1
- package/_cjs/src/routes/index.js +4 -4
- package/_cjs/src/routes/index.js.map +1 -1
- package/_cjs/src/version.js +1 -1
- package/_cjs/tsconfig.build.tsbuildinfo +1 -1
- package/_esm/src/actions/claimAppFees.js +2 -2
- package/_esm/src/actions/claimAppFees.js.map +1 -1
- package/_esm/src/actions/getQuote.js +1 -1
- package/_esm/src/actions/getQuote.js.map +1 -1
- package/_esm/src/routes/index.js +4 -4
- package/_esm/src/routes/index.js.map +1 -1
- package/_esm/src/version.js +1 -1
- package/_esm/tsconfig.build.tsbuildinfo +1 -1
- package/_types/src/actions/claimAppFees.d.ts +1 -0
- package/_types/src/actions/claimAppFees.d.ts.map +1 -1
- package/_types/src/actions/getQuote.d.ts +1 -1
- package/_types/src/actions/getQuote.d.ts.map +1 -1
- package/_types/src/client.d.ts +1 -1
- package/_types/src/types/Execute.d.ts +3 -3
- package/_types/src/types/Execute.d.ts.map +1 -1
- package/_types/src/types/RelayChain.d.ts +1 -1
- package/_types/src/types/RelayChain.d.ts.map +1 -1
- package/_types/src/types/api.d.ts +1097 -232
- package/_types/src/types/api.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
|
@@ -212,7 +212,7 @@ export interface paths {
|
|
|
212
212
|
* @description The type of VM the chain runs on
|
|
213
213
|
* @enum {string}
|
|
214
214
|
*/
|
|
215
|
-
vmType?: "bvm" | "evm" | "svm";
|
|
215
|
+
vmType?: "bvm" | "evm" | "svm" | "tvm" | "tonvm" | "suivm" | "hypevm" | "lvm";
|
|
216
216
|
explorerQueryParams?: {
|
|
217
217
|
[key: string]: unknown;
|
|
218
218
|
} | null;
|
|
@@ -313,7 +313,7 @@ export interface paths {
|
|
|
313
313
|
/** @description User address, when supplied returns user balance and max bridge amount */
|
|
314
314
|
user?: string;
|
|
315
315
|
/** @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. */
|
|
316
|
-
currency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl";
|
|
316
|
+
currency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh";
|
|
317
317
|
};
|
|
318
318
|
};
|
|
319
319
|
responses: {
|
|
@@ -366,7 +366,7 @@ export interface paths {
|
|
|
366
366
|
originChainId: number;
|
|
367
367
|
destinationChainId: number;
|
|
368
368
|
/** @enum {string} */
|
|
369
|
-
currency: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl";
|
|
369
|
+
currency: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh";
|
|
370
370
|
/** @description Amount to bridge as the base amount (can be switched to exact input using the dedicated flag), denoted in wei */
|
|
371
371
|
amount: string;
|
|
372
372
|
/** @description App fees to be charged for execution */
|
|
@@ -470,7 +470,7 @@ export interface paths {
|
|
|
470
470
|
* @description Origin chain gas currency
|
|
471
471
|
* @enum {string}
|
|
472
472
|
*/
|
|
473
|
-
gasCurrency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl" | "avax" | "bnb" | "dai" | "matic" | "sei" | "mnt" | "trx" | "bera" | "ip" | "s" | "lrds" | "celo" | "flow" | "ron" | "metis" | "btcn" | "core" | "sui" | "ton" | "cronos" | "hype" | "mcade";
|
|
473
|
+
gasCurrency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "avax" | "bnb" | "dai" | "matic" | "sei" | "mnt" | "trx" | "bera" | "ip" | "s" | "lrds" | "celo" | "flow" | "ron" | "metis" | "btcn" | "core" | "sui" | "ton" | "cronos" | "hype" | "mcade" | "gusdt";
|
|
474
474
|
/** @description Combination of the relayerGas and relayerService to give you the full relayer fee in wei */
|
|
475
475
|
relayer?: string;
|
|
476
476
|
/** @description Destination chain gas fee in wei */
|
|
@@ -481,10 +481,10 @@ export interface paths {
|
|
|
481
481
|
* @description The currency for all relayer fees (gas and service)
|
|
482
482
|
* @enum {string}
|
|
483
483
|
*/
|
|
484
|
-
relayerCurrency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl";
|
|
484
|
+
relayerCurrency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh";
|
|
485
485
|
app?: string;
|
|
486
486
|
/** @enum {string} */
|
|
487
|
-
appCurrency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl";
|
|
487
|
+
appCurrency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh";
|
|
488
488
|
};
|
|
489
489
|
breakdown?: {
|
|
490
490
|
/** @description Amount that will be bridged in the estimated time */
|
|
@@ -546,7 +546,7 @@ export interface paths {
|
|
|
546
546
|
originChainId: number;
|
|
547
547
|
destinationChainId: number;
|
|
548
548
|
/** @enum {string} */
|
|
549
|
-
currency: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl";
|
|
549
|
+
currency: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh";
|
|
550
550
|
/** @description Amount to bridge as the base amount (can be switched to exact input using the dedicated flag), denoted in wei */
|
|
551
551
|
amount: string;
|
|
552
552
|
/** @description App fees to be charged for execution */
|
|
@@ -1027,7 +1027,7 @@ export interface paths {
|
|
|
1027
1027
|
* @description Origin chain gas currency
|
|
1028
1028
|
* @enum {string}
|
|
1029
1029
|
*/
|
|
1030
|
-
gasCurrency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl" | "avax" | "bnb" | "dai" | "matic" | "sei" | "mnt" | "trx" | "bera" | "ip" | "s" | "lrds" | "celo" | "flow" | "ron" | "metis" | "btcn" | "core" | "sui" | "ton" | "cronos" | "hype" | "mcade";
|
|
1030
|
+
gasCurrency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "avax" | "bnb" | "dai" | "matic" | "sei" | "mnt" | "trx" | "bera" | "ip" | "s" | "lrds" | "celo" | "flow" | "ron" | "metis" | "btcn" | "core" | "sui" | "ton" | "cronos" | "hype" | "mcade" | "gusdt";
|
|
1031
1031
|
/** @description Combination of the relayerGas and relayerService to give you the full relayer fee in wei */
|
|
1032
1032
|
relayer?: string;
|
|
1033
1033
|
/** @description Destination chain gas fee in wei */
|
|
@@ -1038,10 +1038,10 @@ export interface paths {
|
|
|
1038
1038
|
* @description The currency for all relayer fees (gas and service)
|
|
1039
1039
|
* @enum {string}
|
|
1040
1040
|
*/
|
|
1041
|
-
relayerCurrency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl";
|
|
1041
|
+
relayerCurrency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh";
|
|
1042
1042
|
app?: string;
|
|
1043
1043
|
/** @enum {string} */
|
|
1044
|
-
appCurrency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl";
|
|
1044
|
+
appCurrency?: "anime" | "btc" | "cgt" | "degen" | "eth" | "omi" | "pop" | "power" | "sipher" | "tg7" | "tia" | "topia" | "usdc" | "usdc.e" | "usdt" | "sol" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh";
|
|
1045
1045
|
};
|
|
1046
1046
|
/**
|
|
1047
1047
|
* @example {
|
|
@@ -2039,6 +2039,8 @@ export interface paths {
|
|
|
2039
2039
|
referrer?: string;
|
|
2040
2040
|
gasLimitForDepositSpecifiedTxs?: number;
|
|
2041
2041
|
originGasOverhead?: number;
|
|
2042
|
+
/** @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 */
|
|
2043
|
+
slippageTolerance?: string;
|
|
2042
2044
|
};
|
|
2043
2045
|
};
|
|
2044
2046
|
};
|
|
@@ -2492,82 +2494,983 @@ export interface paths {
|
|
|
2492
2494
|
};
|
|
2493
2495
|
};
|
|
2494
2496
|
};
|
|
2495
|
-
};
|
|
2496
|
-
};
|
|
2497
|
-
};
|
|
2498
|
-
"/execute/permits": {
|
|
2499
|
-
post: {
|
|
2500
|
-
parameters: {
|
|
2501
|
-
query: {
|
|
2502
|
-
signature
|
|
2503
|
-
|
|
2504
|
-
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
|
-
|
|
2510
|
-
|
|
2511
|
-
|
|
2512
|
-
|
|
2513
|
-
|
|
2514
|
-
|
|
2515
|
-
|
|
2497
|
+
};
|
|
2498
|
+
};
|
|
2499
|
+
};
|
|
2500
|
+
"/execute/permits": {
|
|
2501
|
+
post: {
|
|
2502
|
+
parameters: {
|
|
2503
|
+
query: {
|
|
2504
|
+
/** @description The permit signature. */
|
|
2505
|
+
signature: string;
|
|
2506
|
+
};
|
|
2507
|
+
};
|
|
2508
|
+
requestBody: {
|
|
2509
|
+
content: {
|
|
2510
|
+
"application/json": {
|
|
2511
|
+
/** @description The kind of signature. This value is returned in the quote API steps body field. e.g eip3009 */
|
|
2512
|
+
kind: string;
|
|
2513
|
+
/** @description The requestId of the quote this permit signature applies to. Returned in the quote API steps body field. */
|
|
2514
|
+
requestId: string;
|
|
2515
|
+
/**
|
|
2516
|
+
* @description The API value returned from the quote API steps body field.
|
|
2517
|
+
* @enum {string}
|
|
2518
|
+
*/
|
|
2519
|
+
api?: "bridge" | "swap" | "user-swap";
|
|
2520
|
+
};
|
|
2521
|
+
};
|
|
2522
|
+
};
|
|
2523
|
+
responses: {
|
|
2524
|
+
/** @description Default Response */
|
|
2525
|
+
200: {
|
|
2526
|
+
content: {
|
|
2527
|
+
"application/json": {
|
|
2528
|
+
message?: string;
|
|
2529
|
+
steps?: {
|
|
2530
|
+
id?: string;
|
|
2531
|
+
action?: string;
|
|
2532
|
+
description?: string;
|
|
2533
|
+
kind?: string;
|
|
2534
|
+
items?: {
|
|
2535
|
+
status?: string;
|
|
2536
|
+
data?: {
|
|
2537
|
+
to?: string;
|
|
2538
|
+
data?: string;
|
|
2539
|
+
value?: string;
|
|
2540
|
+
chainId?: number;
|
|
2541
|
+
};
|
|
2542
|
+
check?: {
|
|
2543
|
+
endpoint?: string;
|
|
2544
|
+
method?: string;
|
|
2545
|
+
};
|
|
2546
|
+
}[];
|
|
2547
|
+
}[];
|
|
2548
|
+
};
|
|
2549
|
+
};
|
|
2550
|
+
};
|
|
2551
|
+
/** @description Default Response */
|
|
2552
|
+
400: {
|
|
2553
|
+
content: {
|
|
2554
|
+
"application/json": {
|
|
2555
|
+
message?: string;
|
|
2556
|
+
};
|
|
2557
|
+
};
|
|
2558
|
+
};
|
|
2559
|
+
};
|
|
2560
|
+
};
|
|
2561
|
+
};
|
|
2562
|
+
"/quote": {
|
|
2563
|
+
post: {
|
|
2564
|
+
requestBody: {
|
|
2565
|
+
content: {
|
|
2566
|
+
"application/json": {
|
|
2567
|
+
/**
|
|
2568
|
+
* @description Address that is depositing funds on the origin chain and submitting transactions or signatures
|
|
2569
|
+
* @default 0x03508bb71268bba25ecacc8f620e01866650532c
|
|
2570
|
+
*/
|
|
2571
|
+
user: string;
|
|
2572
|
+
/** @description Address that is receiving the funds on the destination chain, if not specified then this will default to the user address */
|
|
2573
|
+
recipient?: string;
|
|
2574
|
+
/** @default 8453 */
|
|
2575
|
+
originChainId: number;
|
|
2576
|
+
/** @default 10 */
|
|
2577
|
+
destinationChainId: number;
|
|
2578
|
+
/** @default 0x0000000000000000000000000000000000000000 */
|
|
2579
|
+
originCurrency: string;
|
|
2580
|
+
/** @default 0x0000000000000000000000000000000000000000 */
|
|
2581
|
+
destinationCurrency: string;
|
|
2582
|
+
/**
|
|
2583
|
+
* @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)
|
|
2584
|
+
* @default 1000000000000000000
|
|
2585
|
+
*/
|
|
2586
|
+
amount: string;
|
|
2587
|
+
/**
|
|
2588
|
+
* @description Whether to use the amount as the output or the input for the basis of the swap
|
|
2589
|
+
* @default EXACT_INPUT
|
|
2590
|
+
* @enum {string}
|
|
2591
|
+
*/
|
|
2592
|
+
tradeType: "EXACT_INPUT" | "EXACT_OUTPUT" | "EXPECTED_OUTPUT";
|
|
2593
|
+
txs?: {
|
|
2594
|
+
to?: string;
|
|
2595
|
+
value?: string;
|
|
2596
|
+
data?: string;
|
|
2597
|
+
originalTxValue?: string;
|
|
2598
|
+
}[];
|
|
2599
|
+
/** @description Total gas limit for the destination chain call transactions */
|
|
2600
|
+
txsGasLimit?: number;
|
|
2601
|
+
/** @description Authorization list for EIP-7702 transactions to be executed on destination chain */
|
|
2602
|
+
authorizationList?: {
|
|
2603
|
+
chainId: number;
|
|
2604
|
+
address: string;
|
|
2605
|
+
nonce: number;
|
|
2606
|
+
yParity: number;
|
|
2607
|
+
r: string;
|
|
2608
|
+
s: string;
|
|
2609
|
+
}[];
|
|
2610
|
+
/** @description Additional data needed for specific routes */
|
|
2611
|
+
additionalData?: {
|
|
2612
|
+
/** @description If the request originates from Bitcoin and the user is a P2SH address, the public key is needed to be able to generate the transaction data */
|
|
2613
|
+
userPublicKey?: string;
|
|
2614
|
+
};
|
|
2615
|
+
referrer?: string;
|
|
2616
|
+
referrerAddress?: string;
|
|
2617
|
+
/** @description Address to send the refund to in the case of failure, if not specified then the recipient address or user address is used */
|
|
2618
|
+
refundTo?: string;
|
|
2619
|
+
/**
|
|
2620
|
+
* @deprecated
|
|
2621
|
+
* @description Always refund on the origin chain in case of any issues
|
|
2622
|
+
*/
|
|
2623
|
+
refundOnOrigin?: boolean;
|
|
2624
|
+
/** @description If set, the destination fill will include a gas topup to the recipient (only supported for EVM chains if the requested currency is not the gas currency on the destination chain) */
|
|
2625
|
+
topupGas?: boolean;
|
|
2626
|
+
/** @description The destination gas topup amount in USD decimal format, e.g 100000 = $1. topupGas is required to be enabled. Defaults to 2000000 ($2) */
|
|
2627
|
+
topupGasAmount?: string;
|
|
2628
|
+
/**
|
|
2629
|
+
* @description Enable this to route payments via a receiver 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.
|
|
2630
|
+
* @default true
|
|
2631
|
+
*/
|
|
2632
|
+
useReceiver?: boolean;
|
|
2633
|
+
/**
|
|
2634
|
+
* @description Enabling will send any swap surplus when doing exact output operations to the solver EOA, otherwise it will be swept to the recipient
|
|
2635
|
+
* @default false
|
|
2636
|
+
*/
|
|
2637
|
+
enableTrueExactOutput?: boolean;
|
|
2638
|
+
/**
|
|
2639
|
+
* @description Enable this to avoid direct transfers to the depository (only relevant for EVM and v2 protocol flow)
|
|
2640
|
+
* @default true
|
|
2641
|
+
*/
|
|
2642
|
+
explicitDeposit?: boolean;
|
|
2643
|
+
/** @description Enable this to use canonical+ bridging, trading speed for more liquidity */
|
|
2644
|
+
useExternalLiquidity?: boolean;
|
|
2645
|
+
/** @description Enable this for specific fallback routes */
|
|
2646
|
+
useFallbacks?: boolean;
|
|
2647
|
+
/** @description Enable this to use permit (eip3009) when bridging, only works on supported currency such as usdc */
|
|
2648
|
+
usePermit?: boolean;
|
|
2649
|
+
/** @description How long the permit remains valid, in seconds. Defaults to 10 minutes. */
|
|
2650
|
+
permitExpiry?: number;
|
|
2651
|
+
/** @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. */
|
|
2652
|
+
useDepositAddress?: boolean;
|
|
2653
|
+
/** @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 */
|
|
2654
|
+
slippageTolerance?: string;
|
|
2655
|
+
/** @description Slippage tolerance for destination gas in the event that the deposit occurs after the order deadline, and more gas is required for the solver to execute the destination transaction. */
|
|
2656
|
+
latePaymentSlippageTolerance?: string;
|
|
2657
|
+
appFees?: {
|
|
2658
|
+
/** @description Address that will receive the app fee, if not specified then the user address is used */
|
|
2659
|
+
recipient?: string;
|
|
2660
|
+
/** @description App fees to be charged for execution in basis points, e.g. 100 = 1% */
|
|
2661
|
+
fee?: string;
|
|
2662
|
+
}[];
|
|
2663
|
+
/** @description If the request involves specifying transactions to be executed during the deposit transaction, an explicit gas limit must be set when requesting the quote */
|
|
2664
|
+
gasLimitForDepositSpecifiedTxs?: number;
|
|
2665
|
+
/** @description Force executing swap requests via the solver (by default, same-chain swap requests are self-executed) */
|
|
2666
|
+
forceSolverExecution?: boolean;
|
|
2667
|
+
/** @description If the sponsor should pay for the fees associated with the request. Includes gas topup amounts. */
|
|
2668
|
+
subsidizeFees?: boolean;
|
|
2669
|
+
/** @description The max subsidization amount in USDC decimal format, e.g 1000000 = $1. subsidizeFees must be enabled. This amount is the threshhold where if its surpassed the entire request will not be subsidized at all. */
|
|
2670
|
+
maxSubsidizationAmount?: string;
|
|
2671
|
+
/** @description Swap sources to include for swap routing. */
|
|
2672
|
+
includedSwapSources?: string[];
|
|
2673
|
+
/** @description Swap sources to exclude for swap routing. */
|
|
2674
|
+
excludedSwapSources?: string[];
|
|
2675
|
+
/** @description Swap sources to include for swap routing on origin. */
|
|
2676
|
+
includedOriginSwapSources?: string[];
|
|
2677
|
+
/** @description Swap sources to include for swap routing on destination. */
|
|
2678
|
+
includedDestinationSwapSources?: string[];
|
|
2679
|
+
/** @description The gas overhead for the origin chain, this is used to calculate the gas fee for the origin chain when the solver is executing a gasless transaction on the origin chain */
|
|
2680
|
+
originGasOverhead?: number;
|
|
2681
|
+
/** @description The payer to be set for deposit transactions on solana. This account must have enough for fees and rent. */
|
|
2682
|
+
depositFeePayer?: string;
|
|
2683
|
+
/** @description Whether to include compute unit limit instruction for solana origin requests. */
|
|
2684
|
+
includeComputeUnitLimit?: boolean;
|
|
2685
|
+
/** @description Whether to ignore price impact errors. */
|
|
2686
|
+
overridePriceImpact?: boolean;
|
|
2687
|
+
/** @description Whether to disable origin swaps. */
|
|
2688
|
+
disableOriginSwaps?: boolean;
|
|
2689
|
+
/**
|
|
2690
|
+
* @description The protocol version to use for the quote (currently experimental, do not use in production)
|
|
2691
|
+
* @enum {string}
|
|
2692
|
+
*/
|
|
2693
|
+
protocolVersion?: "v1" | "v2" | "preferV2";
|
|
2694
|
+
};
|
|
2695
|
+
};
|
|
2696
|
+
};
|
|
2697
|
+
responses: {
|
|
2698
|
+
/** @description Default Response */
|
|
2699
|
+
200: {
|
|
2700
|
+
content: {
|
|
2701
|
+
"application/json": {
|
|
2702
|
+
/**
|
|
2703
|
+
* @description An array of steps detailing what needs to be done to bridge, steps includes multiple items of the same kind (signature, transaction, etc)
|
|
2704
|
+
* @example [
|
|
2705
|
+
* {
|
|
2706
|
+
* "id": "deposit",
|
|
2707
|
+
* "action": "Confirm transaction in your wallet",
|
|
2708
|
+
* "description": "Depositing funds to the relayer to execute the swap for USDC",
|
|
2709
|
+
* "kind": "transaction",
|
|
2710
|
+
* "requestId": "0x92b99e6e1ee1deeb9531b5ad7f87091b3d71254b3176de9e8b5f6c6d0bd3a331",
|
|
2711
|
+
* "items": [
|
|
2712
|
+
* {
|
|
2713
|
+
* "status": "incomplete",
|
|
2714
|
+
* "data": {
|
|
2715
|
+
* "from": "0x0CccD55A5Ac261Ea29136831eeaA93bfE07f5Db6",
|
|
2716
|
+
* "to": "0xf70da97812cb96acdf810712aa562db8dfa3dbef",
|
|
2717
|
+
* "data": "0x00fad611",
|
|
2718
|
+
* "value": "1000000000000000000",
|
|
2719
|
+
* "maxFeePerGas": "12205661344",
|
|
2720
|
+
* "maxPriorityFeePerGas": "2037863396",
|
|
2721
|
+
* "chainId": 1
|
|
2722
|
+
* },
|
|
2723
|
+
* "check": {
|
|
2724
|
+
* "endpoint": "/intents/status?requestId=0x92b99e6e1ee1deeb9531b5ad7f87091b3d71254b3176de9e8b5f6c6d0bd3a331",
|
|
2725
|
+
* "method": "GET"
|
|
2726
|
+
* }
|
|
2727
|
+
* }
|
|
2728
|
+
* ]
|
|
2729
|
+
* }
|
|
2730
|
+
* ]
|
|
2731
|
+
*/
|
|
2732
|
+
steps?: ({
|
|
2733
|
+
/**
|
|
2734
|
+
* @description Unique identifier tied to the step
|
|
2735
|
+
* @enum {string}
|
|
2736
|
+
*/
|
|
2737
|
+
id: "deposit" | "approve" | "authorize" | "authorize1" | "authorize2" | "swap" | "send";
|
|
2738
|
+
/** @description A call to action for the step */
|
|
2739
|
+
action: string;
|
|
2740
|
+
/** @description A short description of the step and what it entails */
|
|
2741
|
+
description: string;
|
|
2742
|
+
/** @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 */
|
|
2743
|
+
kind: string;
|
|
2744
|
+
/** @description A unique identifier for this step, tying all related transactions together */
|
|
2745
|
+
requestId?: string;
|
|
2746
|
+
/** @description The deposit address for the bridge request */
|
|
2747
|
+
depositAddress?: string;
|
|
2748
|
+
/** @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. */
|
|
2749
|
+
items: {
|
|
2750
|
+
/** @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 */
|
|
2751
|
+
status?: string;
|
|
2752
|
+
data?: unknown;
|
|
2753
|
+
/** @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 */
|
|
2754
|
+
check?: {
|
|
2755
|
+
/** @description The endpoint to confirm that the step item was successfully completed */
|
|
2756
|
+
endpoint?: string;
|
|
2757
|
+
/** @description The REST method to access the endpoint */
|
|
2758
|
+
method?: string;
|
|
2759
|
+
};
|
|
2760
|
+
}[];
|
|
2761
|
+
})[];
|
|
2762
|
+
fees?: {
|
|
2763
|
+
/**
|
|
2764
|
+
* @description Origin chain gas fee
|
|
2765
|
+
* @example {
|
|
2766
|
+
* "currency": {
|
|
2767
|
+
* "chainId": 8453,
|
|
2768
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
2769
|
+
* "symbol": "USDC",
|
|
2770
|
+
* "name": "USD Coin",
|
|
2771
|
+
* "decimals": 6,
|
|
2772
|
+
* "metadata": {
|
|
2773
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
2774
|
+
* "verified": false,
|
|
2775
|
+
* "isNative": false
|
|
2776
|
+
* }
|
|
2777
|
+
* },
|
|
2778
|
+
* "amount": "30754920",
|
|
2779
|
+
* "amountFormatted": "30.75492",
|
|
2780
|
+
* "amountUsd": "30.901612",
|
|
2781
|
+
* "minimumAmount": "30454920"
|
|
2782
|
+
* }
|
|
2783
|
+
*/
|
|
2784
|
+
gas?: {
|
|
2785
|
+
currency?: {
|
|
2786
|
+
chainId?: number;
|
|
2787
|
+
address?: string;
|
|
2788
|
+
symbol?: string;
|
|
2789
|
+
name?: string;
|
|
2790
|
+
decimals?: number;
|
|
2791
|
+
metadata?: {
|
|
2792
|
+
logoURI?: string;
|
|
2793
|
+
verified?: boolean;
|
|
2794
|
+
isNative?: boolean;
|
|
2795
|
+
};
|
|
2796
|
+
};
|
|
2797
|
+
amount?: string;
|
|
2798
|
+
amountFormatted?: string;
|
|
2799
|
+
amountUsd?: string;
|
|
2800
|
+
minimumAmount?: string;
|
|
2801
|
+
};
|
|
2802
|
+
/**
|
|
2803
|
+
* @description Combination of the relayerGas and relayerService to give you the full relayer fee
|
|
2804
|
+
* @example {
|
|
2805
|
+
* "currency": {
|
|
2806
|
+
* "chainId": 8453,
|
|
2807
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
2808
|
+
* "symbol": "USDC",
|
|
2809
|
+
* "name": "USD Coin",
|
|
2810
|
+
* "decimals": 6,
|
|
2811
|
+
* "metadata": {
|
|
2812
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
2813
|
+
* "verified": false,
|
|
2814
|
+
* "isNative": false
|
|
2815
|
+
* }
|
|
2816
|
+
* },
|
|
2817
|
+
* "amount": "30754920",
|
|
2818
|
+
* "amountFormatted": "30.75492",
|
|
2819
|
+
* "amountUsd": "30.901612",
|
|
2820
|
+
* "minimumAmount": "30454920"
|
|
2821
|
+
* }
|
|
2822
|
+
*/
|
|
2823
|
+
relayer?: {
|
|
2824
|
+
currency?: {
|
|
2825
|
+
chainId?: number;
|
|
2826
|
+
address?: string;
|
|
2827
|
+
symbol?: string;
|
|
2828
|
+
name?: string;
|
|
2829
|
+
decimals?: number;
|
|
2830
|
+
metadata?: {
|
|
2831
|
+
logoURI?: string;
|
|
2832
|
+
verified?: boolean;
|
|
2833
|
+
isNative?: boolean;
|
|
2834
|
+
};
|
|
2835
|
+
};
|
|
2836
|
+
amount?: string;
|
|
2837
|
+
amountFormatted?: string;
|
|
2838
|
+
amountUsd?: string;
|
|
2839
|
+
minimumAmount?: string;
|
|
2840
|
+
};
|
|
2841
|
+
/**
|
|
2842
|
+
* @description Destination chain gas fee
|
|
2843
|
+
* @example {
|
|
2844
|
+
* "currency": {
|
|
2845
|
+
* "chainId": 8453,
|
|
2846
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
2847
|
+
* "symbol": "USDC",
|
|
2848
|
+
* "name": "USD Coin",
|
|
2849
|
+
* "decimals": 6,
|
|
2850
|
+
* "metadata": {
|
|
2851
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
2852
|
+
* "verified": false,
|
|
2853
|
+
* "isNative": false
|
|
2854
|
+
* }
|
|
2855
|
+
* },
|
|
2856
|
+
* "amount": "30754920",
|
|
2857
|
+
* "amountFormatted": "30.75492",
|
|
2858
|
+
* "amountUsd": "30.901612",
|
|
2859
|
+
* "minimumAmount": "30454920"
|
|
2860
|
+
* }
|
|
2861
|
+
*/
|
|
2862
|
+
relayerGas?: {
|
|
2863
|
+
currency?: {
|
|
2864
|
+
chainId?: number;
|
|
2865
|
+
address?: string;
|
|
2866
|
+
symbol?: string;
|
|
2867
|
+
name?: string;
|
|
2868
|
+
decimals?: number;
|
|
2869
|
+
metadata?: {
|
|
2870
|
+
logoURI?: string;
|
|
2871
|
+
verified?: boolean;
|
|
2872
|
+
isNative?: boolean;
|
|
2873
|
+
};
|
|
2874
|
+
};
|
|
2875
|
+
amount?: string;
|
|
2876
|
+
amountFormatted?: string;
|
|
2877
|
+
amountUsd?: string;
|
|
2878
|
+
minimumAmount?: string;
|
|
2879
|
+
};
|
|
2880
|
+
/**
|
|
2881
|
+
* @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)
|
|
2882
|
+
* @example {
|
|
2883
|
+
* "currency": {
|
|
2884
|
+
* "chainId": 8453,
|
|
2885
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
2886
|
+
* "symbol": "USDC",
|
|
2887
|
+
* "name": "USD Coin",
|
|
2888
|
+
* "decimals": 6,
|
|
2889
|
+
* "metadata": {
|
|
2890
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
2891
|
+
* "verified": false,
|
|
2892
|
+
* "isNative": false
|
|
2893
|
+
* }
|
|
2894
|
+
* },
|
|
2895
|
+
* "amount": "30754920",
|
|
2896
|
+
* "amountFormatted": "30.75492",
|
|
2897
|
+
* "amountUsd": "30.901612",
|
|
2898
|
+
* "minimumAmount": "30454920"
|
|
2899
|
+
* }
|
|
2900
|
+
*/
|
|
2901
|
+
relayerService?: {
|
|
2902
|
+
currency?: {
|
|
2903
|
+
chainId?: number;
|
|
2904
|
+
address?: string;
|
|
2905
|
+
symbol?: string;
|
|
2906
|
+
name?: string;
|
|
2907
|
+
decimals?: number;
|
|
2908
|
+
metadata?: {
|
|
2909
|
+
logoURI?: string;
|
|
2910
|
+
verified?: boolean;
|
|
2911
|
+
isNative?: boolean;
|
|
2912
|
+
};
|
|
2913
|
+
};
|
|
2914
|
+
amount?: string;
|
|
2915
|
+
amountFormatted?: string;
|
|
2916
|
+
amountUsd?: string;
|
|
2917
|
+
minimumAmount?: string;
|
|
2918
|
+
};
|
|
2919
|
+
/**
|
|
2920
|
+
* @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
|
|
2921
|
+
* @example {
|
|
2922
|
+
* "currency": {
|
|
2923
|
+
* "chainId": 8453,
|
|
2924
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
2925
|
+
* "symbol": "USDC",
|
|
2926
|
+
* "name": "USD Coin",
|
|
2927
|
+
* "decimals": 6,
|
|
2928
|
+
* "metadata": {
|
|
2929
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
2930
|
+
* "verified": false,
|
|
2931
|
+
* "isNative": false
|
|
2932
|
+
* }
|
|
2933
|
+
* },
|
|
2934
|
+
* "amount": "30754920",
|
|
2935
|
+
* "amountFormatted": "30.75492",
|
|
2936
|
+
* "amountUsd": "30.901612",
|
|
2937
|
+
* "minimumAmount": "30454920"
|
|
2938
|
+
* }
|
|
2939
|
+
*/
|
|
2940
|
+
app?: {
|
|
2941
|
+
currency?: {
|
|
2942
|
+
chainId?: number;
|
|
2943
|
+
address?: string;
|
|
2944
|
+
symbol?: string;
|
|
2945
|
+
name?: string;
|
|
2946
|
+
decimals?: number;
|
|
2947
|
+
metadata?: {
|
|
2948
|
+
logoURI?: string;
|
|
2949
|
+
verified?: boolean;
|
|
2950
|
+
isNative?: boolean;
|
|
2951
|
+
};
|
|
2952
|
+
};
|
|
2953
|
+
amount?: string;
|
|
2954
|
+
amountFormatted?: string;
|
|
2955
|
+
amountUsd?: string;
|
|
2956
|
+
minimumAmount?: string;
|
|
2957
|
+
};
|
|
2958
|
+
/**
|
|
2959
|
+
* @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.
|
|
2960
|
+
* @example {
|
|
2961
|
+
* "currency": {
|
|
2962
|
+
* "chainId": 8453,
|
|
2963
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
2964
|
+
* "symbol": "USDC",
|
|
2965
|
+
* "name": "USD Coin",
|
|
2966
|
+
* "decimals": 6,
|
|
2967
|
+
* "metadata": {
|
|
2968
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
2969
|
+
* "verified": false,
|
|
2970
|
+
* "isNative": false
|
|
2971
|
+
* }
|
|
2972
|
+
* },
|
|
2973
|
+
* "amount": "30754920",
|
|
2974
|
+
* "amountFormatted": "30.75492",
|
|
2975
|
+
* "amountUsd": "30.901612",
|
|
2976
|
+
* "minimumAmount": "30454920"
|
|
2977
|
+
* }
|
|
2978
|
+
*/
|
|
2979
|
+
subsidized?: {
|
|
2980
|
+
currency?: {
|
|
2981
|
+
chainId?: number;
|
|
2982
|
+
address?: string;
|
|
2983
|
+
symbol?: string;
|
|
2984
|
+
name?: string;
|
|
2985
|
+
decimals?: number;
|
|
2986
|
+
metadata?: {
|
|
2987
|
+
logoURI?: string;
|
|
2988
|
+
verified?: boolean;
|
|
2989
|
+
isNative?: boolean;
|
|
2990
|
+
};
|
|
2991
|
+
};
|
|
2992
|
+
amount?: string;
|
|
2993
|
+
amountFormatted?: string;
|
|
2994
|
+
amountUsd?: string;
|
|
2995
|
+
minimumAmount?: string;
|
|
2996
|
+
};
|
|
2997
|
+
};
|
|
2998
|
+
/** @description A summary of the swap and what the user should expect to happen given an input */
|
|
2999
|
+
details?: {
|
|
3000
|
+
/** @description The operation that will be performed, possible options are send, swap, wrap, unwrap, bridge */
|
|
3001
|
+
operation?: string;
|
|
3002
|
+
/** @description The address that deposited the funds */
|
|
3003
|
+
sender?: string;
|
|
3004
|
+
/** @description The address that will be receiving the swap output */
|
|
3005
|
+
recipient?: string;
|
|
3006
|
+
/**
|
|
3007
|
+
* @example {
|
|
3008
|
+
* "currency": {
|
|
3009
|
+
* "chainId": 8453,
|
|
3010
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3011
|
+
* "symbol": "USDC",
|
|
3012
|
+
* "name": "USD Coin",
|
|
3013
|
+
* "decimals": 6,
|
|
3014
|
+
* "metadata": {
|
|
3015
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3016
|
+
* "verified": false,
|
|
3017
|
+
* "isNative": false
|
|
3018
|
+
* }
|
|
3019
|
+
* },
|
|
3020
|
+
* "amount": "30754920",
|
|
3021
|
+
* "amountFormatted": "30.75492",
|
|
3022
|
+
* "amountUsd": "30.901612",
|
|
3023
|
+
* "minimumAmount": "30454920"
|
|
3024
|
+
* }
|
|
3025
|
+
*/
|
|
3026
|
+
currencyIn?: {
|
|
3027
|
+
currency?: {
|
|
3028
|
+
chainId?: number;
|
|
3029
|
+
address?: string;
|
|
3030
|
+
symbol?: string;
|
|
3031
|
+
name?: string;
|
|
3032
|
+
decimals?: number;
|
|
3033
|
+
metadata?: {
|
|
3034
|
+
logoURI?: string;
|
|
3035
|
+
verified?: boolean;
|
|
3036
|
+
isNative?: boolean;
|
|
3037
|
+
};
|
|
3038
|
+
};
|
|
3039
|
+
amount?: string;
|
|
3040
|
+
amountFormatted?: string;
|
|
3041
|
+
amountUsd?: string;
|
|
3042
|
+
minimumAmount?: string;
|
|
3043
|
+
};
|
|
3044
|
+
/**
|
|
3045
|
+
* @example {
|
|
3046
|
+
* "currency": {
|
|
3047
|
+
* "chainId": 8453,
|
|
3048
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3049
|
+
* "symbol": "USDC",
|
|
3050
|
+
* "name": "USD Coin",
|
|
3051
|
+
* "decimals": 6,
|
|
3052
|
+
* "metadata": {
|
|
3053
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3054
|
+
* "verified": false,
|
|
3055
|
+
* "isNative": false
|
|
3056
|
+
* }
|
|
3057
|
+
* },
|
|
3058
|
+
* "amount": "30754920",
|
|
3059
|
+
* "amountFormatted": "30.75492",
|
|
3060
|
+
* "amountUsd": "30.901612",
|
|
3061
|
+
* "minimumAmount": "30454920"
|
|
3062
|
+
* }
|
|
3063
|
+
*/
|
|
3064
|
+
currencyOut?: {
|
|
3065
|
+
currency?: {
|
|
3066
|
+
chainId?: number;
|
|
3067
|
+
address?: string;
|
|
3068
|
+
symbol?: string;
|
|
3069
|
+
name?: string;
|
|
3070
|
+
decimals?: number;
|
|
3071
|
+
metadata?: {
|
|
3072
|
+
logoURI?: string;
|
|
3073
|
+
verified?: boolean;
|
|
3074
|
+
isNative?: boolean;
|
|
3075
|
+
};
|
|
3076
|
+
};
|
|
3077
|
+
amount?: string;
|
|
3078
|
+
amountFormatted?: string;
|
|
3079
|
+
amountUsd?: string;
|
|
3080
|
+
minimumAmount?: string;
|
|
3081
|
+
};
|
|
3082
|
+
/**
|
|
3083
|
+
* @example {
|
|
3084
|
+
* "currency": {
|
|
3085
|
+
* "chainId": 8453,
|
|
3086
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3087
|
+
* "symbol": "USDC",
|
|
3088
|
+
* "name": "USD Coin",
|
|
3089
|
+
* "decimals": 6,
|
|
3090
|
+
* "metadata": {
|
|
3091
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3092
|
+
* "verified": false,
|
|
3093
|
+
* "isNative": false
|
|
3094
|
+
* }
|
|
3095
|
+
* },
|
|
3096
|
+
* "amount": "30754920",
|
|
3097
|
+
* "amountFormatted": "30.75492",
|
|
3098
|
+
* "amountUsd": "30.901612",
|
|
3099
|
+
* "minimumAmount": "30454920"
|
|
3100
|
+
* }
|
|
3101
|
+
*/
|
|
3102
|
+
refundCurrency?: {
|
|
3103
|
+
currency?: {
|
|
3104
|
+
chainId?: number;
|
|
3105
|
+
address?: string;
|
|
3106
|
+
symbol?: string;
|
|
3107
|
+
name?: string;
|
|
3108
|
+
decimals?: number;
|
|
3109
|
+
metadata?: {
|
|
3110
|
+
logoURI?: string;
|
|
3111
|
+
verified?: boolean;
|
|
3112
|
+
isNative?: boolean;
|
|
3113
|
+
};
|
|
3114
|
+
};
|
|
3115
|
+
amount?: string;
|
|
3116
|
+
amountFormatted?: string;
|
|
3117
|
+
amountUsd?: string;
|
|
3118
|
+
minimumAmount?: string;
|
|
3119
|
+
};
|
|
3120
|
+
/**
|
|
3121
|
+
* @example {
|
|
3122
|
+
* "currency": {
|
|
3123
|
+
* "chainId": 8453,
|
|
3124
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3125
|
+
* "symbol": "USDC",
|
|
3126
|
+
* "name": "USD Coin",
|
|
3127
|
+
* "decimals": 6,
|
|
3128
|
+
* "metadata": {
|
|
3129
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3130
|
+
* "verified": false,
|
|
3131
|
+
* "isNative": false
|
|
3132
|
+
* }
|
|
3133
|
+
* },
|
|
3134
|
+
* "amount": "30754920",
|
|
3135
|
+
* "amountFormatted": "30.75492",
|
|
3136
|
+
* "amountUsd": "30.901612",
|
|
3137
|
+
* "minimumAmount": "30454920"
|
|
3138
|
+
* }
|
|
3139
|
+
*/
|
|
3140
|
+
currencyGasTopup?: {
|
|
3141
|
+
currency?: {
|
|
3142
|
+
chainId?: number;
|
|
3143
|
+
address?: string;
|
|
3144
|
+
symbol?: string;
|
|
3145
|
+
name?: string;
|
|
3146
|
+
decimals?: number;
|
|
3147
|
+
metadata?: {
|
|
3148
|
+
logoURI?: string;
|
|
3149
|
+
verified?: boolean;
|
|
3150
|
+
isNative?: boolean;
|
|
3151
|
+
};
|
|
3152
|
+
};
|
|
3153
|
+
amount?: string;
|
|
3154
|
+
amountFormatted?: string;
|
|
3155
|
+
amountUsd?: string;
|
|
3156
|
+
minimumAmount?: string;
|
|
3157
|
+
};
|
|
3158
|
+
/** @description The difference between the input and output values, including fees */
|
|
3159
|
+
totalImpact?: {
|
|
3160
|
+
usd?: string;
|
|
3161
|
+
percent?: string;
|
|
3162
|
+
};
|
|
3163
|
+
/** @description The impact of the swap, not factoring in fees */
|
|
3164
|
+
swapImpact?: {
|
|
3165
|
+
usd?: string;
|
|
3166
|
+
percent?: string;
|
|
3167
|
+
};
|
|
3168
|
+
expandedPriceImpact?: {
|
|
3169
|
+
/** @description Cost to execute swap or bridge depending on available liquidity. This value can be negative (representing network rewards for improving liquidity distribution) */
|
|
3170
|
+
swap?: {
|
|
3171
|
+
usd?: string;
|
|
3172
|
+
};
|
|
3173
|
+
/** @description Fees paid to cover transaction execution costs */
|
|
3174
|
+
execution?: {
|
|
3175
|
+
usd?: string;
|
|
3176
|
+
};
|
|
3177
|
+
/** @description Fees paid to the protocol */
|
|
3178
|
+
relay?: {
|
|
3179
|
+
usd?: string;
|
|
3180
|
+
};
|
|
3181
|
+
/** @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 */
|
|
3182
|
+
app?: {
|
|
3183
|
+
usd?: string;
|
|
3184
|
+
};
|
|
3185
|
+
};
|
|
3186
|
+
/** @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. */
|
|
3187
|
+
rate?: string;
|
|
3188
|
+
slippageTolerance?: {
|
|
3189
|
+
/** @description The slippage tolerance on the origin chain swap */
|
|
3190
|
+
origin?: {
|
|
3191
|
+
usd?: string;
|
|
3192
|
+
value?: string;
|
|
3193
|
+
percent?: string;
|
|
3194
|
+
};
|
|
3195
|
+
/** @description The slippage tolerance on the destination chain swap */
|
|
3196
|
+
destination?: {
|
|
3197
|
+
usd?: string;
|
|
3198
|
+
value?: string;
|
|
3199
|
+
percent?: string;
|
|
3200
|
+
};
|
|
3201
|
+
};
|
|
3202
|
+
/** @description Estimated swap time in seconds */
|
|
3203
|
+
timeEstimate?: number;
|
|
3204
|
+
/** @description The user's balance in the given currency on the origin chain */
|
|
3205
|
+
userBalance?: string;
|
|
3206
|
+
/** @description The type of fallback route the request uses, if any */
|
|
3207
|
+
fallbackType?: string;
|
|
3208
|
+
/** @description Whether the rate for the quote is fixed or dynamic (swap on origin/destination) */
|
|
3209
|
+
isFixedRate?: boolean;
|
|
3210
|
+
route?: {
|
|
3211
|
+
/** @description The route taken for the origin chain swap */
|
|
3212
|
+
origin?: {
|
|
3213
|
+
/**
|
|
3214
|
+
* @example {
|
|
3215
|
+
* "currency": {
|
|
3216
|
+
* "chainId": 8453,
|
|
3217
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3218
|
+
* "symbol": "USDC",
|
|
3219
|
+
* "name": "USD Coin",
|
|
3220
|
+
* "decimals": 6,
|
|
3221
|
+
* "metadata": {
|
|
3222
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3223
|
+
* "verified": false,
|
|
3224
|
+
* "isNative": false
|
|
3225
|
+
* }
|
|
3226
|
+
* },
|
|
3227
|
+
* "amount": "30754920",
|
|
3228
|
+
* "amountFormatted": "30.75492",
|
|
3229
|
+
* "amountUsd": "30.901612",
|
|
3230
|
+
* "minimumAmount": "30454920"
|
|
3231
|
+
* }
|
|
3232
|
+
*/
|
|
3233
|
+
inputCurrency?: {
|
|
3234
|
+
currency?: {
|
|
3235
|
+
chainId?: number;
|
|
3236
|
+
address?: string;
|
|
3237
|
+
symbol?: string;
|
|
3238
|
+
name?: string;
|
|
3239
|
+
decimals?: number;
|
|
3240
|
+
metadata?: {
|
|
3241
|
+
logoURI?: string;
|
|
3242
|
+
verified?: boolean;
|
|
3243
|
+
isNative?: boolean;
|
|
3244
|
+
};
|
|
3245
|
+
};
|
|
3246
|
+
amount?: string;
|
|
3247
|
+
amountFormatted?: string;
|
|
3248
|
+
amountUsd?: string;
|
|
3249
|
+
minimumAmount?: string;
|
|
3250
|
+
};
|
|
3251
|
+
/**
|
|
3252
|
+
* @example {
|
|
3253
|
+
* "currency": {
|
|
3254
|
+
* "chainId": 8453,
|
|
3255
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3256
|
+
* "symbol": "USDC",
|
|
3257
|
+
* "name": "USD Coin",
|
|
3258
|
+
* "decimals": 6,
|
|
3259
|
+
* "metadata": {
|
|
3260
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3261
|
+
* "verified": false,
|
|
3262
|
+
* "isNative": false
|
|
3263
|
+
* }
|
|
3264
|
+
* },
|
|
3265
|
+
* "amount": "30754920",
|
|
3266
|
+
* "amountFormatted": "30.75492",
|
|
3267
|
+
* "amountUsd": "30.901612",
|
|
3268
|
+
* "minimumAmount": "30454920"
|
|
3269
|
+
* }
|
|
3270
|
+
*/
|
|
3271
|
+
outputCurrency?: {
|
|
3272
|
+
currency?: {
|
|
3273
|
+
chainId?: number;
|
|
3274
|
+
address?: string;
|
|
3275
|
+
symbol?: string;
|
|
3276
|
+
name?: string;
|
|
3277
|
+
decimals?: number;
|
|
3278
|
+
metadata?: {
|
|
3279
|
+
logoURI?: string;
|
|
3280
|
+
verified?: boolean;
|
|
3281
|
+
isNative?: boolean;
|
|
3282
|
+
};
|
|
3283
|
+
};
|
|
3284
|
+
amount?: string;
|
|
3285
|
+
amountFormatted?: string;
|
|
3286
|
+
amountUsd?: string;
|
|
3287
|
+
minimumAmount?: string;
|
|
3288
|
+
};
|
|
3289
|
+
router?: string;
|
|
3290
|
+
includedSwapSources?: string[];
|
|
3291
|
+
};
|
|
3292
|
+
/** @description The route taken for the origin chain swap */
|
|
3293
|
+
destination?: {
|
|
3294
|
+
/**
|
|
3295
|
+
* @example {
|
|
3296
|
+
* "currency": {
|
|
3297
|
+
* "chainId": 8453,
|
|
3298
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3299
|
+
* "symbol": "USDC",
|
|
3300
|
+
* "name": "USD Coin",
|
|
3301
|
+
* "decimals": 6,
|
|
3302
|
+
* "metadata": {
|
|
3303
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3304
|
+
* "verified": false,
|
|
3305
|
+
* "isNative": false
|
|
3306
|
+
* }
|
|
3307
|
+
* },
|
|
3308
|
+
* "amount": "30754920",
|
|
3309
|
+
* "amountFormatted": "30.75492",
|
|
3310
|
+
* "amountUsd": "30.901612",
|
|
3311
|
+
* "minimumAmount": "30454920"
|
|
3312
|
+
* }
|
|
3313
|
+
*/
|
|
3314
|
+
inputCurrency?: {
|
|
3315
|
+
currency?: {
|
|
3316
|
+
chainId?: number;
|
|
3317
|
+
address?: string;
|
|
3318
|
+
symbol?: string;
|
|
3319
|
+
name?: string;
|
|
3320
|
+
decimals?: number;
|
|
3321
|
+
metadata?: {
|
|
3322
|
+
logoURI?: string;
|
|
3323
|
+
verified?: boolean;
|
|
3324
|
+
isNative?: boolean;
|
|
3325
|
+
};
|
|
3326
|
+
};
|
|
3327
|
+
amount?: string;
|
|
3328
|
+
amountFormatted?: string;
|
|
3329
|
+
amountUsd?: string;
|
|
3330
|
+
minimumAmount?: string;
|
|
3331
|
+
};
|
|
3332
|
+
/**
|
|
3333
|
+
* @example {
|
|
3334
|
+
* "currency": {
|
|
3335
|
+
* "chainId": 8453,
|
|
3336
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3337
|
+
* "symbol": "USDC",
|
|
3338
|
+
* "name": "USD Coin",
|
|
3339
|
+
* "decimals": 6,
|
|
3340
|
+
* "metadata": {
|
|
3341
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3342
|
+
* "verified": false,
|
|
3343
|
+
* "isNative": false
|
|
3344
|
+
* }
|
|
3345
|
+
* },
|
|
3346
|
+
* "amount": "30754920",
|
|
3347
|
+
* "amountFormatted": "30.75492",
|
|
3348
|
+
* "amountUsd": "30.901612",
|
|
3349
|
+
* "minimumAmount": "30454920"
|
|
3350
|
+
* }
|
|
3351
|
+
*/
|
|
3352
|
+
outputCurrency?: {
|
|
3353
|
+
currency?: {
|
|
3354
|
+
chainId?: number;
|
|
3355
|
+
address?: string;
|
|
3356
|
+
symbol?: string;
|
|
3357
|
+
name?: string;
|
|
3358
|
+
decimals?: number;
|
|
3359
|
+
metadata?: {
|
|
3360
|
+
logoURI?: string;
|
|
3361
|
+
verified?: boolean;
|
|
3362
|
+
isNative?: boolean;
|
|
3363
|
+
};
|
|
3364
|
+
};
|
|
3365
|
+
amount?: string;
|
|
3366
|
+
amountFormatted?: string;
|
|
3367
|
+
amountUsd?: string;
|
|
3368
|
+
minimumAmount?: string;
|
|
3369
|
+
};
|
|
3370
|
+
router?: string;
|
|
3371
|
+
includedSwapSources?: string[];
|
|
3372
|
+
};
|
|
3373
|
+
};
|
|
3374
|
+
};
|
|
3375
|
+
/** @description Protocol information for the quote */
|
|
3376
|
+
protocol?: {
|
|
3377
|
+
v2?: {
|
|
3378
|
+
/** @description The underlying protocol order id */
|
|
3379
|
+
orderId?: string;
|
|
3380
|
+
/** @description The underlying protocol order data */
|
|
3381
|
+
orderData?: unknown;
|
|
3382
|
+
/** @description The details for the depository payment */
|
|
3383
|
+
paymentDetails?: {
|
|
3384
|
+
/** @description The protocol chain id for the payment */
|
|
3385
|
+
chainId?: string;
|
|
3386
|
+
/** @description The depository address */
|
|
3387
|
+
depository?: string;
|
|
3388
|
+
/** @description The currency of the payment */
|
|
3389
|
+
currency?: string;
|
|
3390
|
+
/** @description The amount of the payment */
|
|
3391
|
+
amount?: string;
|
|
3392
|
+
};
|
|
3393
|
+
};
|
|
3394
|
+
};
|
|
3395
|
+
};
|
|
3396
|
+
};
|
|
3397
|
+
};
|
|
3398
|
+
/** @description Default Response */
|
|
3399
|
+
400: {
|
|
3400
|
+
content: {
|
|
3401
|
+
"application/json": {
|
|
3402
|
+
message?: string;
|
|
3403
|
+
errorCode?: string;
|
|
3404
|
+
errorData?: string;
|
|
3405
|
+
requestId?: string;
|
|
3406
|
+
approxSimulatedBlock?: number;
|
|
3407
|
+
failedCallData?: {
|
|
3408
|
+
from?: string;
|
|
3409
|
+
to?: string;
|
|
3410
|
+
data?: string;
|
|
3411
|
+
value?: string;
|
|
3412
|
+
};
|
|
3413
|
+
};
|
|
3414
|
+
};
|
|
3415
|
+
};
|
|
3416
|
+
/** @description Default Response */
|
|
3417
|
+
401: {
|
|
3418
|
+
content: {
|
|
3419
|
+
"application/json": {
|
|
3420
|
+
message?: string;
|
|
3421
|
+
errorCode?: string;
|
|
3422
|
+
};
|
|
3423
|
+
};
|
|
3424
|
+
};
|
|
2516
3425
|
/** @description Default Response */
|
|
2517
|
-
|
|
3426
|
+
429: {
|
|
2518
3427
|
content: {
|
|
2519
3428
|
"application/json": {
|
|
2520
3429
|
message?: string;
|
|
2521
|
-
steps?: {
|
|
2522
|
-
id?: string;
|
|
2523
|
-
action?: string;
|
|
2524
|
-
description?: string;
|
|
2525
|
-
kind?: string;
|
|
2526
|
-
items?: {
|
|
2527
|
-
status?: string;
|
|
2528
|
-
data?: {
|
|
2529
|
-
to?: string;
|
|
2530
|
-
data?: string;
|
|
2531
|
-
value?: string;
|
|
2532
|
-
chainId?: number;
|
|
2533
|
-
};
|
|
2534
|
-
check?: {
|
|
2535
|
-
endpoint?: string;
|
|
2536
|
-
method?: string;
|
|
2537
|
-
};
|
|
2538
|
-
}[];
|
|
2539
|
-
}[];
|
|
2540
3430
|
};
|
|
2541
3431
|
};
|
|
2542
3432
|
};
|
|
2543
3433
|
/** @description Default Response */
|
|
2544
|
-
|
|
3434
|
+
500: {
|
|
2545
3435
|
content: {
|
|
2546
3436
|
"application/json": {
|
|
2547
3437
|
message?: string;
|
|
3438
|
+
errorCode?: string;
|
|
3439
|
+
requestId?: string;
|
|
2548
3440
|
};
|
|
2549
3441
|
};
|
|
2550
3442
|
};
|
|
2551
3443
|
};
|
|
2552
3444
|
};
|
|
2553
3445
|
};
|
|
2554
|
-
"/quote": {
|
|
3446
|
+
"/quote/v2": {
|
|
2555
3447
|
post: {
|
|
2556
3448
|
requestBody: {
|
|
2557
3449
|
content: {
|
|
2558
3450
|
"application/json": {
|
|
2559
|
-
/**
|
|
3451
|
+
/**
|
|
3452
|
+
* @description Address that is depositing funds on the origin chain and submitting transactions or signatures
|
|
3453
|
+
* @default 0x03508bb71268bba25ecacc8f620e01866650532c
|
|
3454
|
+
*/
|
|
2560
3455
|
user: string;
|
|
2561
3456
|
/** @description Address that is receiving the funds on the destination chain, if not specified then this will default to the user address */
|
|
2562
3457
|
recipient?: string;
|
|
3458
|
+
/** @default 8453 */
|
|
2563
3459
|
originChainId: number;
|
|
3460
|
+
/** @default 10 */
|
|
2564
3461
|
destinationChainId: number;
|
|
3462
|
+
/** @default 0x0000000000000000000000000000000000000000 */
|
|
2565
3463
|
originCurrency: string;
|
|
3464
|
+
/** @default 0x0000000000000000000000000000000000000000 */
|
|
2566
3465
|
destinationCurrency: string;
|
|
2567
|
-
/**
|
|
3466
|
+
/**
|
|
3467
|
+
* @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)
|
|
3468
|
+
* @default 1000000000000000000
|
|
3469
|
+
*/
|
|
2568
3470
|
amount: string;
|
|
2569
3471
|
/**
|
|
2570
3472
|
* @description Whether to use the amount as the output or the input for the basis of the swap
|
|
3473
|
+
* @default EXACT_INPUT
|
|
2571
3474
|
* @enum {string}
|
|
2572
3475
|
*/
|
|
2573
3476
|
tradeType: "EXACT_INPUT" | "EXACT_OUTPUT" | "EXPECTED_OUTPUT";
|
|
@@ -2575,6 +3478,7 @@ export interface paths {
|
|
|
2575
3478
|
to?: string;
|
|
2576
3479
|
value?: string;
|
|
2577
3480
|
data?: string;
|
|
3481
|
+
originalTxValue?: string;
|
|
2578
3482
|
}[];
|
|
2579
3483
|
/** @description Total gas limit for the destination chain call transactions */
|
|
2580
3484
|
txsGasLimit?: number;
|
|
@@ -2615,11 +3519,6 @@ export interface paths {
|
|
|
2615
3519
|
* @default false
|
|
2616
3520
|
*/
|
|
2617
3521
|
enableTrueExactOutput?: boolean;
|
|
2618
|
-
/**
|
|
2619
|
-
* @description The protocol version to use for the quote (currently experimental, do not use in production)
|
|
2620
|
-
* @enum {string}
|
|
2621
|
-
*/
|
|
2622
|
-
protocolVersion?: "v1" | "v2" | "preferV2";
|
|
2623
3522
|
/**
|
|
2624
3523
|
* @description Enable this to avoid direct transfers to the depository (only relevant for EVM and v2 protocol flow)
|
|
2625
3524
|
* @default true
|
|
@@ -2631,6 +3530,8 @@ export interface paths {
|
|
|
2631
3530
|
useFallbacks?: boolean;
|
|
2632
3531
|
/** @description Enable this to use permit (eip3009) when bridging, only works on supported currency such as usdc */
|
|
2633
3532
|
usePermit?: boolean;
|
|
3533
|
+
/** @description How long the permit remains valid, in seconds. Defaults to 10 minutes. */
|
|
3534
|
+
permitExpiry?: number;
|
|
2634
3535
|
/** @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. */
|
|
2635
3536
|
useDepositAddress?: boolean;
|
|
2636
3537
|
/** @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 */
|
|
@@ -2649,7 +3550,7 @@ export interface paths {
|
|
|
2649
3550
|
forceSolverExecution?: boolean;
|
|
2650
3551
|
/** @description If the sponsor should pay for the fees associated with the request. Includes gas topup amounts. */
|
|
2651
3552
|
subsidizeFees?: boolean;
|
|
2652
|
-
/** @description The max subsidization amount in
|
|
3553
|
+
/** @description The max subsidization amount in USDC decimal format, e.g 1000000 = $1. subsidizeFees must be enabled. This amount is the threshhold where if its surpassed the entire request will not be subsidized at all. */
|
|
2653
3554
|
maxSubsidizationAmount?: string;
|
|
2654
3555
|
/** @description Swap sources to include for swap routing. */
|
|
2655
3556
|
includedSwapSources?: string[];
|
|
@@ -2663,6 +3564,12 @@ export interface paths {
|
|
|
2663
3564
|
originGasOverhead?: number;
|
|
2664
3565
|
/** @description The payer to be set for deposit transactions on solana. This account must have enough for fees and rent. */
|
|
2665
3566
|
depositFeePayer?: string;
|
|
3567
|
+
/** @description Whether to include compute unit limit instruction for solana origin requests. */
|
|
3568
|
+
includeComputeUnitLimit?: boolean;
|
|
3569
|
+
/** @description Whether to ignore price impact errors. */
|
|
3570
|
+
overridePriceImpact?: boolean;
|
|
3571
|
+
/** @description Whether to disable origin swaps. */
|
|
3572
|
+
disableOriginSwaps?: boolean;
|
|
2666
3573
|
};
|
|
2667
3574
|
};
|
|
2668
3575
|
};
|
|
@@ -3349,6 +4256,8 @@ export interface paths {
|
|
|
3349
4256
|
v2?: {
|
|
3350
4257
|
/** @description The underlying protocol order id */
|
|
3351
4258
|
orderId?: string;
|
|
4259
|
+
/** @description The underlying protocol order data */
|
|
4260
|
+
orderData?: unknown;
|
|
3352
4261
|
/** @description The details for the depository payment */
|
|
3353
4262
|
paymentDetails?: {
|
|
3354
4263
|
/** @description The protocol chain id for the payment */
|
|
@@ -3373,6 +4282,13 @@ export interface paths {
|
|
|
3373
4282
|
errorCode?: string;
|
|
3374
4283
|
errorData?: string;
|
|
3375
4284
|
requestId?: string;
|
|
4285
|
+
approxSimulatedBlock?: number;
|
|
4286
|
+
failedCallData?: {
|
|
4287
|
+
from?: string;
|
|
4288
|
+
to?: string;
|
|
4289
|
+
data?: string;
|
|
4290
|
+
value?: string;
|
|
4291
|
+
};
|
|
3376
4292
|
};
|
|
3377
4293
|
};
|
|
3378
4294
|
};
|
|
@@ -3889,12 +4805,30 @@ export interface paths {
|
|
|
3889
4805
|
s: string;
|
|
3890
4806
|
}[];
|
|
3891
4807
|
};
|
|
3892
|
-
/** @description Options related to gas fee sponsorship
|
|
4808
|
+
/** @description Options related to gas fee sponsorship, app referrer and destination calls */
|
|
3893
4809
|
executionOptions: {
|
|
3894
4810
|
/** @description The referrer of the app which is executing the gasless transaction */
|
|
3895
4811
|
referrer: string;
|
|
3896
4812
|
/** @description If the app should pay for the fees associated with the request */
|
|
3897
4813
|
subsidizeFees: boolean;
|
|
4814
|
+
/** @description Destination execution data for the gasless transaction */
|
|
4815
|
+
destinationChainExecutionData?: {
|
|
4816
|
+
/** @description Calls to be executed on the destination chain */
|
|
4817
|
+
calls: {
|
|
4818
|
+
to?: string;
|
|
4819
|
+
value?: string;
|
|
4820
|
+
data?: string;
|
|
4821
|
+
}[];
|
|
4822
|
+
/** @description Authorization list for EIP-7702 transactions to be executed on destination chain */
|
|
4823
|
+
authorizationList?: {
|
|
4824
|
+
chainId: number;
|
|
4825
|
+
address: string;
|
|
4826
|
+
nonce: number;
|
|
4827
|
+
yParity: number;
|
|
4828
|
+
r: string;
|
|
4829
|
+
s: string;
|
|
4830
|
+
}[];
|
|
4831
|
+
};
|
|
3898
4832
|
};
|
|
3899
4833
|
/** @description The request ID of the gasless transaction to execute */
|
|
3900
4834
|
requestId?: string;
|
|
@@ -3973,6 +4907,8 @@ export interface paths {
|
|
|
3973
4907
|
"application/json": {
|
|
3974
4908
|
/** @description The request ID of the request that needs to be fast filled */
|
|
3975
4909
|
requestId: string;
|
|
4910
|
+
/** @description The input currency amount that the solver receives on origin */
|
|
4911
|
+
solverInputCurrencyAmount?: string;
|
|
3976
4912
|
};
|
|
3977
4913
|
};
|
|
3978
4914
|
};
|
|
@@ -4054,12 +4990,39 @@ export interface paths {
|
|
|
4054
4990
|
};
|
|
4055
4991
|
"/lives": {
|
|
4056
4992
|
get: {
|
|
4993
|
+
parameters: {
|
|
4994
|
+
query?: {
|
|
4995
|
+
withReport?: string | null;
|
|
4996
|
+
skipPostgres?: string | null;
|
|
4997
|
+
skipRedis?: string | null;
|
|
4998
|
+
};
|
|
4999
|
+
};
|
|
4057
5000
|
responses: {
|
|
4058
5001
|
/** @description Default Response */
|
|
4059
5002
|
200: {
|
|
4060
5003
|
content: {
|
|
4061
5004
|
"application/json": {
|
|
4062
|
-
|
|
5005
|
+
status?: string;
|
|
5006
|
+
report?: {
|
|
5007
|
+
[key: string]: {
|
|
5008
|
+
status?: string;
|
|
5009
|
+
reason?: string | null;
|
|
5010
|
+
};
|
|
5011
|
+
};
|
|
5012
|
+
};
|
|
5013
|
+
};
|
|
5014
|
+
};
|
|
5015
|
+
/** @description Default Response */
|
|
5016
|
+
503: {
|
|
5017
|
+
content: {
|
|
5018
|
+
"application/json": {
|
|
5019
|
+
status?: string;
|
|
5020
|
+
report?: {
|
|
5021
|
+
[key: string]: {
|
|
5022
|
+
status?: string;
|
|
5023
|
+
reason?: string | null;
|
|
5024
|
+
};
|
|
5025
|
+
};
|
|
4063
5026
|
};
|
|
4064
5027
|
};
|
|
4065
5028
|
};
|
|
@@ -4159,163 +5122,6 @@ export interface paths {
|
|
|
4159
5122
|
};
|
|
4160
5123
|
};
|
|
4161
5124
|
};
|
|
4162
|
-
"/intents/quote": {
|
|
4163
|
-
post: {
|
|
4164
|
-
requestBody: {
|
|
4165
|
-
content: {
|
|
4166
|
-
"application/json": {
|
|
4167
|
-
request: Record<string, never>;
|
|
4168
|
-
source?: string;
|
|
4169
|
-
};
|
|
4170
|
-
};
|
|
4171
|
-
};
|
|
4172
|
-
responses: {
|
|
4173
|
-
/** @description Default Response */
|
|
4174
|
-
200: {
|
|
4175
|
-
content: {
|
|
4176
|
-
"application/json": {
|
|
4177
|
-
txData?: {
|
|
4178
|
-
to?: string;
|
|
4179
|
-
data?: string;
|
|
4180
|
-
value?: string;
|
|
4181
|
-
};
|
|
4182
|
-
requestId?: string;
|
|
4183
|
-
currency?: string;
|
|
4184
|
-
price?: string;
|
|
4185
|
-
relayerFee?: string;
|
|
4186
|
-
depositGasFee?: string;
|
|
4187
|
-
};
|
|
4188
|
-
};
|
|
4189
|
-
};
|
|
4190
|
-
/** @description Default Response */
|
|
4191
|
-
400: {
|
|
4192
|
-
content: {
|
|
4193
|
-
"application/json": {
|
|
4194
|
-
message?: string;
|
|
4195
|
-
};
|
|
4196
|
-
};
|
|
4197
|
-
};
|
|
4198
|
-
};
|
|
4199
|
-
};
|
|
4200
|
-
};
|
|
4201
|
-
"/intents/quote/v2": {
|
|
4202
|
-
post: {
|
|
4203
|
-
requestBody: {
|
|
4204
|
-
content: {
|
|
4205
|
-
"application/json": {
|
|
4206
|
-
request: Record<string, never>;
|
|
4207
|
-
source?: string;
|
|
4208
|
-
};
|
|
4209
|
-
};
|
|
4210
|
-
};
|
|
4211
|
-
responses: {
|
|
4212
|
-
/** @description Default Response */
|
|
4213
|
-
200: {
|
|
4214
|
-
content: {
|
|
4215
|
-
"application/json": {
|
|
4216
|
-
requestId?: string;
|
|
4217
|
-
approvalTxData?: {
|
|
4218
|
-
to?: string;
|
|
4219
|
-
data?: string;
|
|
4220
|
-
value?: string;
|
|
4221
|
-
};
|
|
4222
|
-
depositTxData?: {
|
|
4223
|
-
to?: string;
|
|
4224
|
-
data?: string;
|
|
4225
|
-
value?: string;
|
|
4226
|
-
};
|
|
4227
|
-
/**
|
|
4228
|
-
* @example {
|
|
4229
|
-
* "currency": {
|
|
4230
|
-
* "chainId": 8453,
|
|
4231
|
-
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
4232
|
-
* "symbol": "USDC",
|
|
4233
|
-
* "name": "USD Coin",
|
|
4234
|
-
* "decimals": 6,
|
|
4235
|
-
* "metadata": {
|
|
4236
|
-
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
4237
|
-
* "verified": false,
|
|
4238
|
-
* "isNative": false
|
|
4239
|
-
* }
|
|
4240
|
-
* },
|
|
4241
|
-
* "amount": "30754920",
|
|
4242
|
-
* "amountFormatted": "30.75492",
|
|
4243
|
-
* "amountUsd": "30.901612",
|
|
4244
|
-
* "minimumAmount": "30454920"
|
|
4245
|
-
* }
|
|
4246
|
-
*/
|
|
4247
|
-
currencyIn?: {
|
|
4248
|
-
currency?: {
|
|
4249
|
-
chainId?: number;
|
|
4250
|
-
address?: string;
|
|
4251
|
-
symbol?: string;
|
|
4252
|
-
name?: string;
|
|
4253
|
-
decimals?: number;
|
|
4254
|
-
metadata?: {
|
|
4255
|
-
logoURI?: string;
|
|
4256
|
-
verified?: boolean;
|
|
4257
|
-
isNative?: boolean;
|
|
4258
|
-
};
|
|
4259
|
-
};
|
|
4260
|
-
amount?: string;
|
|
4261
|
-
amountFormatted?: string;
|
|
4262
|
-
amountUsd?: string;
|
|
4263
|
-
minimumAmount?: string;
|
|
4264
|
-
};
|
|
4265
|
-
/**
|
|
4266
|
-
* @example {
|
|
4267
|
-
* "currency": {
|
|
4268
|
-
* "chainId": 8453,
|
|
4269
|
-
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
4270
|
-
* "symbol": "USDC",
|
|
4271
|
-
* "name": "USD Coin",
|
|
4272
|
-
* "decimals": 6,
|
|
4273
|
-
* "metadata": {
|
|
4274
|
-
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
4275
|
-
* "verified": false,
|
|
4276
|
-
* "isNative": false
|
|
4277
|
-
* }
|
|
4278
|
-
* },
|
|
4279
|
-
* "amount": "30754920",
|
|
4280
|
-
* "amountFormatted": "30.75492",
|
|
4281
|
-
* "amountUsd": "30.901612",
|
|
4282
|
-
* "minimumAmount": "30454920"
|
|
4283
|
-
* }
|
|
4284
|
-
*/
|
|
4285
|
-
currencyOut?: {
|
|
4286
|
-
currency?: {
|
|
4287
|
-
chainId?: number;
|
|
4288
|
-
address?: string;
|
|
4289
|
-
symbol?: string;
|
|
4290
|
-
name?: string;
|
|
4291
|
-
decimals?: number;
|
|
4292
|
-
metadata?: {
|
|
4293
|
-
logoURI?: string;
|
|
4294
|
-
verified?: boolean;
|
|
4295
|
-
isNative?: boolean;
|
|
4296
|
-
};
|
|
4297
|
-
};
|
|
4298
|
-
amount?: string;
|
|
4299
|
-
amountFormatted?: string;
|
|
4300
|
-
amountUsd?: string;
|
|
4301
|
-
minimumAmount?: string;
|
|
4302
|
-
};
|
|
4303
|
-
relayerFee?: string;
|
|
4304
|
-
depositGasFee?: string;
|
|
4305
|
-
};
|
|
4306
|
-
};
|
|
4307
|
-
};
|
|
4308
|
-
/** @description Default Response */
|
|
4309
|
-
400: {
|
|
4310
|
-
content: {
|
|
4311
|
-
"application/json": {
|
|
4312
|
-
message?: string;
|
|
4313
|
-
};
|
|
4314
|
-
};
|
|
4315
|
-
};
|
|
4316
|
-
};
|
|
4317
|
-
};
|
|
4318
|
-
};
|
|
4319
5125
|
"/requests/{requestId}/signature": {
|
|
4320
5126
|
get: {
|
|
4321
5127
|
parameters: {
|
|
@@ -4624,6 +5430,7 @@ export interface paths {
|
|
|
4624
5430
|
privateChainsToInclude?: string;
|
|
4625
5431
|
id?: string;
|
|
4626
5432
|
orderId?: string;
|
|
5433
|
+
includeOrderData?: boolean;
|
|
4627
5434
|
startTimestamp?: number;
|
|
4628
5435
|
endTimestamp?: number;
|
|
4629
5436
|
startBlock?: number;
|
|
@@ -4646,8 +5453,8 @@ export interface paths {
|
|
|
4646
5453
|
* "status": "success",
|
|
4647
5454
|
* "user": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
|
|
4648
5455
|
* "recipient": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
|
|
4649
|
-
* "subsidizedRequest": false,
|
|
4650
5456
|
* "data": {
|
|
5457
|
+
* "subsidizedRequest": false,
|
|
4651
5458
|
* "fees": {
|
|
4652
5459
|
* "gas": "2622672522398",
|
|
4653
5460
|
* "fixed": "10000000000000",
|
|
@@ -4706,7 +5513,6 @@ export interface paths {
|
|
|
4706
5513
|
status?: "refund" | "waiting" | "failure" | "pending" | "success";
|
|
4707
5514
|
user?: string;
|
|
4708
5515
|
recipient?: string;
|
|
4709
|
-
subsidizedRequest?: boolean;
|
|
4710
5516
|
data?: {
|
|
4711
5517
|
/** @description Slippage tolerance for the swap. This value is in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage */
|
|
4712
5518
|
slippageTolerance?: string;
|
|
@@ -4715,12 +5521,14 @@ export interface paths {
|
|
|
4715
5521
|
/** @enum {string} */
|
|
4716
5522
|
refundFailReason?: "AMOUNT_TOO_LOW_TO_REFUND";
|
|
4717
5523
|
failedTxHash?: string;
|
|
5524
|
+
failedTxBlockNumber?: number;
|
|
4718
5525
|
failedCallData?: {
|
|
4719
5526
|
from?: string;
|
|
4720
5527
|
to?: string;
|
|
4721
5528
|
data?: string;
|
|
4722
5529
|
value?: string;
|
|
4723
5530
|
};
|
|
5531
|
+
subsidizedRequest?: boolean;
|
|
4724
5532
|
fees?: {
|
|
4725
5533
|
/** @description Estimated gas cost required for execution, in wei */
|
|
4726
5534
|
gas?: string;
|
|
@@ -4832,6 +5640,13 @@ export interface paths {
|
|
|
4832
5640
|
amountUsd?: string;
|
|
4833
5641
|
amountUsdCurrent?: string;
|
|
4834
5642
|
}[];
|
|
5643
|
+
paidAppFees?: {
|
|
5644
|
+
recipient?: string;
|
|
5645
|
+
bps?: string;
|
|
5646
|
+
amount?: string;
|
|
5647
|
+
amountUsd?: string;
|
|
5648
|
+
amountUsdCurrent?: string;
|
|
5649
|
+
}[];
|
|
4835
5650
|
metadata?: {
|
|
4836
5651
|
sender?: string;
|
|
4837
5652
|
recipient?: string;
|
|
@@ -5137,6 +5952,7 @@ export interface paths {
|
|
|
5137
5952
|
timestamp?: number;
|
|
5138
5953
|
}[];
|
|
5139
5954
|
};
|
|
5955
|
+
orderData?: unknown;
|
|
5140
5956
|
referrer?: string;
|
|
5141
5957
|
moonpayId?: string;
|
|
5142
5958
|
createdAt?: string;
|
|
@@ -5218,12 +6034,12 @@ export interface paths {
|
|
|
5218
6034
|
};
|
|
5219
6035
|
};
|
|
5220
6036
|
};
|
|
5221
|
-
"/
|
|
6037
|
+
"/swap-sources": {
|
|
5222
6038
|
get: {
|
|
5223
6039
|
parameters: {
|
|
5224
6040
|
query?: {
|
|
5225
|
-
|
|
5226
|
-
|
|
6041
|
+
/** @description Chain ID to get swap sources for */
|
|
6042
|
+
chainId?: number;
|
|
5227
6043
|
};
|
|
5228
6044
|
};
|
|
5229
6045
|
responses: {
|
|
@@ -5231,15 +6047,17 @@ export interface paths {
|
|
|
5231
6047
|
200: {
|
|
5232
6048
|
content: {
|
|
5233
6049
|
"application/json": {
|
|
5234
|
-
|
|
6050
|
+
/** @description An array of swap sources */
|
|
6051
|
+
sources?: string[];
|
|
5235
6052
|
};
|
|
5236
6053
|
};
|
|
5237
6054
|
};
|
|
5238
6055
|
/** @description Default Response */
|
|
5239
|
-
|
|
6056
|
+
400: {
|
|
5240
6057
|
content: {
|
|
5241
6058
|
"application/json": {
|
|
5242
|
-
|
|
6059
|
+
/** @description Descriptive error message */
|
|
6060
|
+
message?: string;
|
|
5243
6061
|
};
|
|
5244
6062
|
};
|
|
5245
6063
|
};
|
|
@@ -5417,7 +6235,7 @@ export interface paths {
|
|
|
5417
6235
|
name?: string;
|
|
5418
6236
|
decimals?: number;
|
|
5419
6237
|
/** @enum {string} */
|
|
5420
|
-
vmType?: "bvm" | "evm" | "svm" | "tvm" | "tonvm" | "suivm" | "hypevm";
|
|
6238
|
+
vmType?: "bvm" | "evm" | "svm" | "tvm" | "tonvm" | "suivm" | "hypevm" | "lvm";
|
|
5421
6239
|
metadata?: {
|
|
5422
6240
|
logoURI?: string;
|
|
5423
6241
|
verified?: boolean;
|
|
@@ -5473,7 +6291,7 @@ export interface paths {
|
|
|
5473
6291
|
name?: string;
|
|
5474
6292
|
decimals?: number;
|
|
5475
6293
|
/** @enum {string} */
|
|
5476
|
-
vmType?: "bvm" | "evm" | "svm" | "tvm" | "tonvm" | "suivm" | "hypevm";
|
|
6294
|
+
vmType?: "bvm" | "evm" | "svm" | "tvm" | "tonvm" | "suivm" | "hypevm" | "lvm";
|
|
5477
6295
|
metadata?: {
|
|
5478
6296
|
logoURI?: string;
|
|
5479
6297
|
verified?: boolean;
|
|
@@ -5537,7 +6355,7 @@ export interface paths {
|
|
|
5537
6355
|
name?: string;
|
|
5538
6356
|
decimals?: number;
|
|
5539
6357
|
/** @enum {string} */
|
|
5540
|
-
vmType?: "bvm" | "evm" | "svm" | "tvm" | "tonvm" | "suivm" | "hypevm";
|
|
6358
|
+
vmType?: "bvm" | "evm" | "svm" | "tvm" | "tonvm" | "suivm" | "hypevm" | "lvm";
|
|
5541
6359
|
metadata?: {
|
|
5542
6360
|
logoURI?: string;
|
|
5543
6361
|
verified?: boolean;
|
|
@@ -5568,7 +6386,7 @@ export interface paths {
|
|
|
5568
6386
|
name?: string;
|
|
5569
6387
|
decimals?: number;
|
|
5570
6388
|
/** @enum {string} */
|
|
5571
|
-
vmType?: "bvm" | "evm" | "svm" | "tvm" | "tonvm" | "suivm" | "hypevm";
|
|
6389
|
+
vmType?: "bvm" | "evm" | "svm" | "tvm" | "tonvm" | "suivm" | "hypevm" | "lvm";
|
|
5572
6390
|
metadata?: {
|
|
5573
6391
|
logoURI?: string;
|
|
5574
6392
|
verified?: boolean;
|
|
@@ -5780,6 +6598,53 @@ export interface paths {
|
|
|
5780
6598
|
};
|
|
5781
6599
|
};
|
|
5782
6600
|
};
|
|
6601
|
+
"/wallets/screen": {
|
|
6602
|
+
post: {
|
|
6603
|
+
parameters: {
|
|
6604
|
+
header: {
|
|
6605
|
+
/** @description Required API key for authentication. Contact the team for getting an API Key */
|
|
6606
|
+
"x-api-key": string;
|
|
6607
|
+
};
|
|
6608
|
+
};
|
|
6609
|
+
requestBody: {
|
|
6610
|
+
content: {
|
|
6611
|
+
"application/json": {
|
|
6612
|
+
wallets: {
|
|
6613
|
+
address?: string;
|
|
6614
|
+
chainId?: number;
|
|
6615
|
+
}[];
|
|
6616
|
+
};
|
|
6617
|
+
};
|
|
6618
|
+
};
|
|
6619
|
+
responses: {
|
|
6620
|
+
/** @description Default Response */
|
|
6621
|
+
200: {
|
|
6622
|
+
content: {
|
|
6623
|
+
"application/json": {
|
|
6624
|
+
message?: string;
|
|
6625
|
+
wallets?: unknown[];
|
|
6626
|
+
};
|
|
6627
|
+
};
|
|
6628
|
+
};
|
|
6629
|
+
/** @description Default Response */
|
|
6630
|
+
400: {
|
|
6631
|
+
content: {
|
|
6632
|
+
"application/json": {
|
|
6633
|
+
message?: string;
|
|
6634
|
+
};
|
|
6635
|
+
};
|
|
6636
|
+
};
|
|
6637
|
+
/** @description Default Response */
|
|
6638
|
+
401: {
|
|
6639
|
+
content: {
|
|
6640
|
+
"application/json": {
|
|
6641
|
+
message?: string;
|
|
6642
|
+
};
|
|
6643
|
+
};
|
|
6644
|
+
};
|
|
6645
|
+
};
|
|
6646
|
+
};
|
|
6647
|
+
};
|
|
5783
6648
|
}
|
|
5784
6649
|
export type webhooks = Record<string, never>;
|
|
5785
6650
|
export interface components {
|