@relayprotocol/relay-sdk 2.4.4 → 2.4.5
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/routes/index.js +1 -0
- 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/routes/index.js +1 -0
- 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/client.d.ts +3 -3
- package/_types/src/routes/index.d.ts.map +1 -1
- package/_types/src/types/AdaptedWallet.d.ts +4 -0
- package/_types/src/types/AdaptedWallet.d.ts.map +1 -1
- package/_types/src/types/api.d.ts +507 -12
- 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/version.d.ts +1 -1
- package/_types/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +1 -1
|
@@ -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" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun";
|
|
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";
|
|
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" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun";
|
|
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";
|
|
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" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "
|
|
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";
|
|
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" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun";
|
|
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";
|
|
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" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun";
|
|
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";
|
|
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" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun";
|
|
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";
|
|
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" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun" | "
|
|
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";
|
|
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" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun";
|
|
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";
|
|
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" | "xai" | "weth" | "apeeth" | "ape" | "g" | "dmt" | "g7" | "god" | "pengu" | "plume" | "wbtc" | "pusd" | "gun";
|
|
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";
|
|
1045
1045
|
};
|
|
1046
1046
|
/**
|
|
1047
1047
|
* @example {
|
|
@@ -3051,6 +3051,44 @@ export interface paths {
|
|
|
3051
3051
|
amountUsd?: string;
|
|
3052
3052
|
minimumAmount?: string;
|
|
3053
3053
|
};
|
|
3054
|
+
/**
|
|
3055
|
+
* @example {
|
|
3056
|
+
* "currency": {
|
|
3057
|
+
* "chainId": 8453,
|
|
3058
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3059
|
+
* "symbol": "USDC",
|
|
3060
|
+
* "name": "USD Coin",
|
|
3061
|
+
* "decimals": 6,
|
|
3062
|
+
* "metadata": {
|
|
3063
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3064
|
+
* "verified": false,
|
|
3065
|
+
* "isNative": false
|
|
3066
|
+
* }
|
|
3067
|
+
* },
|
|
3068
|
+
* "amount": "30754920",
|
|
3069
|
+
* "amountFormatted": "30.75492",
|
|
3070
|
+
* "amountUsd": "30.901612",
|
|
3071
|
+
* "minimumAmount": "30454920"
|
|
3072
|
+
* }
|
|
3073
|
+
*/
|
|
3074
|
+
refundCurrency?: {
|
|
3075
|
+
currency?: {
|
|
3076
|
+
chainId?: number;
|
|
3077
|
+
address?: string;
|
|
3078
|
+
symbol?: string;
|
|
3079
|
+
name?: string;
|
|
3080
|
+
decimals?: number;
|
|
3081
|
+
metadata?: {
|
|
3082
|
+
logoURI?: string;
|
|
3083
|
+
verified?: boolean;
|
|
3084
|
+
isNative?: boolean;
|
|
3085
|
+
};
|
|
3086
|
+
};
|
|
3087
|
+
amount?: string;
|
|
3088
|
+
amountFormatted?: string;
|
|
3089
|
+
amountUsd?: string;
|
|
3090
|
+
minimumAmount?: string;
|
|
3091
|
+
};
|
|
3054
3092
|
/**
|
|
3055
3093
|
* @example {
|
|
3056
3094
|
* "currency": {
|
|
@@ -3139,6 +3177,172 @@ export interface paths {
|
|
|
3139
3177
|
userBalance?: string;
|
|
3140
3178
|
/** @description The type of fallback route the request uses, if any */
|
|
3141
3179
|
fallbackType?: string;
|
|
3180
|
+
/** @description Whether the rate for the quote is fixed or dynamic (swap on origin/destination) */
|
|
3181
|
+
isFixedRate?: boolean;
|
|
3182
|
+
route?: {
|
|
3183
|
+
/** @description The route taken for the origin chain swap */
|
|
3184
|
+
origin?: {
|
|
3185
|
+
/**
|
|
3186
|
+
* @example {
|
|
3187
|
+
* "currency": {
|
|
3188
|
+
* "chainId": 8453,
|
|
3189
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3190
|
+
* "symbol": "USDC",
|
|
3191
|
+
* "name": "USD Coin",
|
|
3192
|
+
* "decimals": 6,
|
|
3193
|
+
* "metadata": {
|
|
3194
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3195
|
+
* "verified": false,
|
|
3196
|
+
* "isNative": false
|
|
3197
|
+
* }
|
|
3198
|
+
* },
|
|
3199
|
+
* "amount": "30754920",
|
|
3200
|
+
* "amountFormatted": "30.75492",
|
|
3201
|
+
* "amountUsd": "30.901612",
|
|
3202
|
+
* "minimumAmount": "30454920"
|
|
3203
|
+
* }
|
|
3204
|
+
*/
|
|
3205
|
+
inputCurrency?: {
|
|
3206
|
+
currency?: {
|
|
3207
|
+
chainId?: number;
|
|
3208
|
+
address?: string;
|
|
3209
|
+
symbol?: string;
|
|
3210
|
+
name?: string;
|
|
3211
|
+
decimals?: number;
|
|
3212
|
+
metadata?: {
|
|
3213
|
+
logoURI?: string;
|
|
3214
|
+
verified?: boolean;
|
|
3215
|
+
isNative?: boolean;
|
|
3216
|
+
};
|
|
3217
|
+
};
|
|
3218
|
+
amount?: string;
|
|
3219
|
+
amountFormatted?: string;
|
|
3220
|
+
amountUsd?: string;
|
|
3221
|
+
minimumAmount?: string;
|
|
3222
|
+
};
|
|
3223
|
+
/**
|
|
3224
|
+
* @example {
|
|
3225
|
+
* "currency": {
|
|
3226
|
+
* "chainId": 8453,
|
|
3227
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3228
|
+
* "symbol": "USDC",
|
|
3229
|
+
* "name": "USD Coin",
|
|
3230
|
+
* "decimals": 6,
|
|
3231
|
+
* "metadata": {
|
|
3232
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3233
|
+
* "verified": false,
|
|
3234
|
+
* "isNative": false
|
|
3235
|
+
* }
|
|
3236
|
+
* },
|
|
3237
|
+
* "amount": "30754920",
|
|
3238
|
+
* "amountFormatted": "30.75492",
|
|
3239
|
+
* "amountUsd": "30.901612",
|
|
3240
|
+
* "minimumAmount": "30454920"
|
|
3241
|
+
* }
|
|
3242
|
+
*/
|
|
3243
|
+
outputCurrency?: {
|
|
3244
|
+
currency?: {
|
|
3245
|
+
chainId?: number;
|
|
3246
|
+
address?: string;
|
|
3247
|
+
symbol?: string;
|
|
3248
|
+
name?: string;
|
|
3249
|
+
decimals?: number;
|
|
3250
|
+
metadata?: {
|
|
3251
|
+
logoURI?: string;
|
|
3252
|
+
verified?: boolean;
|
|
3253
|
+
isNative?: boolean;
|
|
3254
|
+
};
|
|
3255
|
+
};
|
|
3256
|
+
amount?: string;
|
|
3257
|
+
amountFormatted?: string;
|
|
3258
|
+
amountUsd?: string;
|
|
3259
|
+
minimumAmount?: string;
|
|
3260
|
+
};
|
|
3261
|
+
router?: string;
|
|
3262
|
+
includedSwapSources?: string[];
|
|
3263
|
+
};
|
|
3264
|
+
/** @description The route taken for the origin chain swap */
|
|
3265
|
+
destination?: {
|
|
3266
|
+
/**
|
|
3267
|
+
* @example {
|
|
3268
|
+
* "currency": {
|
|
3269
|
+
* "chainId": 8453,
|
|
3270
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3271
|
+
* "symbol": "USDC",
|
|
3272
|
+
* "name": "USD Coin",
|
|
3273
|
+
* "decimals": 6,
|
|
3274
|
+
* "metadata": {
|
|
3275
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3276
|
+
* "verified": false,
|
|
3277
|
+
* "isNative": false
|
|
3278
|
+
* }
|
|
3279
|
+
* },
|
|
3280
|
+
* "amount": "30754920",
|
|
3281
|
+
* "amountFormatted": "30.75492",
|
|
3282
|
+
* "amountUsd": "30.901612",
|
|
3283
|
+
* "minimumAmount": "30454920"
|
|
3284
|
+
* }
|
|
3285
|
+
*/
|
|
3286
|
+
inputCurrency?: {
|
|
3287
|
+
currency?: {
|
|
3288
|
+
chainId?: number;
|
|
3289
|
+
address?: string;
|
|
3290
|
+
symbol?: string;
|
|
3291
|
+
name?: string;
|
|
3292
|
+
decimals?: number;
|
|
3293
|
+
metadata?: {
|
|
3294
|
+
logoURI?: string;
|
|
3295
|
+
verified?: boolean;
|
|
3296
|
+
isNative?: boolean;
|
|
3297
|
+
};
|
|
3298
|
+
};
|
|
3299
|
+
amount?: string;
|
|
3300
|
+
amountFormatted?: string;
|
|
3301
|
+
amountUsd?: string;
|
|
3302
|
+
minimumAmount?: string;
|
|
3303
|
+
};
|
|
3304
|
+
/**
|
|
3305
|
+
* @example {
|
|
3306
|
+
* "currency": {
|
|
3307
|
+
* "chainId": 8453,
|
|
3308
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3309
|
+
* "symbol": "USDC",
|
|
3310
|
+
* "name": "USD Coin",
|
|
3311
|
+
* "decimals": 6,
|
|
3312
|
+
* "metadata": {
|
|
3313
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3314
|
+
* "verified": false,
|
|
3315
|
+
* "isNative": false
|
|
3316
|
+
* }
|
|
3317
|
+
* },
|
|
3318
|
+
* "amount": "30754920",
|
|
3319
|
+
* "amountFormatted": "30.75492",
|
|
3320
|
+
* "amountUsd": "30.901612",
|
|
3321
|
+
* "minimumAmount": "30454920"
|
|
3322
|
+
* }
|
|
3323
|
+
*/
|
|
3324
|
+
outputCurrency?: {
|
|
3325
|
+
currency?: {
|
|
3326
|
+
chainId?: number;
|
|
3327
|
+
address?: string;
|
|
3328
|
+
symbol?: string;
|
|
3329
|
+
name?: string;
|
|
3330
|
+
decimals?: number;
|
|
3331
|
+
metadata?: {
|
|
3332
|
+
logoURI?: string;
|
|
3333
|
+
verified?: boolean;
|
|
3334
|
+
isNative?: boolean;
|
|
3335
|
+
};
|
|
3336
|
+
};
|
|
3337
|
+
amount?: string;
|
|
3338
|
+
amountFormatted?: string;
|
|
3339
|
+
amountUsd?: string;
|
|
3340
|
+
minimumAmount?: string;
|
|
3341
|
+
};
|
|
3342
|
+
router?: string;
|
|
3343
|
+
includedSwapSources?: string[];
|
|
3344
|
+
};
|
|
3345
|
+
};
|
|
3142
3346
|
};
|
|
3143
3347
|
/** @description Protocol information for the quote */
|
|
3144
3348
|
protocol?: {
|
|
@@ -3168,6 +3372,7 @@ export interface paths {
|
|
|
3168
3372
|
message?: string;
|
|
3169
3373
|
errorCode?: string;
|
|
3170
3374
|
errorData?: string;
|
|
3375
|
+
requestId?: string;
|
|
3171
3376
|
};
|
|
3172
3377
|
};
|
|
3173
3378
|
};
|
|
@@ -3181,11 +3386,20 @@ export interface paths {
|
|
|
3181
3386
|
};
|
|
3182
3387
|
};
|
|
3183
3388
|
/** @description Default Response */
|
|
3389
|
+
429: {
|
|
3390
|
+
content: {
|
|
3391
|
+
"application/json": {
|
|
3392
|
+
message?: string;
|
|
3393
|
+
};
|
|
3394
|
+
};
|
|
3395
|
+
};
|
|
3396
|
+
/** @description Default Response */
|
|
3184
3397
|
500: {
|
|
3185
3398
|
content: {
|
|
3186
3399
|
"application/json": {
|
|
3187
3400
|
message?: string;
|
|
3188
3401
|
errorCode?: string;
|
|
3402
|
+
requestId?: string;
|
|
3189
3403
|
};
|
|
3190
3404
|
};
|
|
3191
3405
|
};
|
|
@@ -3641,6 +3855,12 @@ export interface paths {
|
|
|
3641
3855
|
};
|
|
3642
3856
|
"/execute": {
|
|
3643
3857
|
post: {
|
|
3858
|
+
parameters: {
|
|
3859
|
+
header: {
|
|
3860
|
+
/** @description Required API key for authentication. Contact the team for getting an API Key */
|
|
3861
|
+
"x-api-key": string;
|
|
3862
|
+
};
|
|
3863
|
+
};
|
|
3644
3864
|
requestBody: {
|
|
3645
3865
|
content: {
|
|
3646
3866
|
"application/json": {
|
|
@@ -3676,6 +3896,8 @@ export interface paths {
|
|
|
3676
3896
|
/** @description If the app should pay for the fees associated with the request */
|
|
3677
3897
|
subsidizeFees: boolean;
|
|
3678
3898
|
};
|
|
3899
|
+
/** @description The request ID of the gasless transaction to execute */
|
|
3900
|
+
requestId?: string;
|
|
3679
3901
|
};
|
|
3680
3902
|
};
|
|
3681
3903
|
};
|
|
@@ -3738,6 +3960,98 @@ export interface paths {
|
|
|
3738
3960
|
};
|
|
3739
3961
|
};
|
|
3740
3962
|
};
|
|
3963
|
+
"/fast-fill": {
|
|
3964
|
+
post: {
|
|
3965
|
+
parameters: {
|
|
3966
|
+
header: {
|
|
3967
|
+
/** @description Required API key for authentication. Contact the team for getting an API Key */
|
|
3968
|
+
"x-api-key": string;
|
|
3969
|
+
};
|
|
3970
|
+
};
|
|
3971
|
+
requestBody: {
|
|
3972
|
+
content: {
|
|
3973
|
+
"application/json": {
|
|
3974
|
+
/** @description The request ID of the request that needs to be fast filled */
|
|
3975
|
+
requestId: string;
|
|
3976
|
+
};
|
|
3977
|
+
};
|
|
3978
|
+
};
|
|
3979
|
+
responses: {
|
|
3980
|
+
/** @description Request was successful. It was either queued or found to be already executed. */
|
|
3981
|
+
200: {
|
|
3982
|
+
content: {
|
|
3983
|
+
"application/json": {
|
|
3984
|
+
/** @example Request successfully queued for fast fill. */
|
|
3985
|
+
message?: string;
|
|
3986
|
+
};
|
|
3987
|
+
};
|
|
3988
|
+
};
|
|
3989
|
+
/** @description Bad Request - The request body contains invalid data. */
|
|
3990
|
+
400: {
|
|
3991
|
+
content: {
|
|
3992
|
+
"application/json": {
|
|
3993
|
+
/** @example Currency is required and could not be determined. */
|
|
3994
|
+
error?: string;
|
|
3995
|
+
};
|
|
3996
|
+
};
|
|
3997
|
+
};
|
|
3998
|
+
/** @description Unauthorized - Missing or invalid API key. */
|
|
3999
|
+
401: {
|
|
4000
|
+
content: {
|
|
4001
|
+
"application/json": {
|
|
4002
|
+
/** @example Unauthorized: Check API Key */
|
|
4003
|
+
error?: string;
|
|
4004
|
+
};
|
|
4005
|
+
};
|
|
4006
|
+
};
|
|
4007
|
+
/** @description Forbidden - Fast fill is not enabled for this API key. */
|
|
4008
|
+
403: {
|
|
4009
|
+
content: {
|
|
4010
|
+
"application/json": {
|
|
4011
|
+
/** @example Forbidden: Fast fill is not enabled for this API key. */
|
|
4012
|
+
error?: string;
|
|
4013
|
+
};
|
|
4014
|
+
};
|
|
4015
|
+
};
|
|
4016
|
+
/** @description The requested requestId could not be found. */
|
|
4017
|
+
404: {
|
|
4018
|
+
content: {
|
|
4019
|
+
"application/json": {
|
|
4020
|
+
/** @example Request not found */
|
|
4021
|
+
error?: string;
|
|
4022
|
+
};
|
|
4023
|
+
};
|
|
4024
|
+
};
|
|
4025
|
+
/** @description Conflict - This request is already being processed. */
|
|
4026
|
+
409: {
|
|
4027
|
+
content: {
|
|
4028
|
+
"application/json": {
|
|
4029
|
+
/** @example Conflict: This request is already being processed. */
|
|
4030
|
+
error?: string;
|
|
4031
|
+
};
|
|
4032
|
+
};
|
|
4033
|
+
};
|
|
4034
|
+
/** @description Too Many Requests - Fast Fill Threshold Reached. */
|
|
4035
|
+
429: {
|
|
4036
|
+
content: {
|
|
4037
|
+
"application/json": {
|
|
4038
|
+
/** @example Too Many Requests: Fast Fill Threshold Reached. Make a deposit to proceed. */
|
|
4039
|
+
error?: string;
|
|
4040
|
+
};
|
|
4041
|
+
};
|
|
4042
|
+
};
|
|
4043
|
+
/** @description Internal Server Error. */
|
|
4044
|
+
500: {
|
|
4045
|
+
content: {
|
|
4046
|
+
"application/json": {
|
|
4047
|
+
/** @example An internal server error occurred. */
|
|
4048
|
+
error?: string;
|
|
4049
|
+
};
|
|
4050
|
+
};
|
|
4051
|
+
};
|
|
4052
|
+
};
|
|
4053
|
+
};
|
|
4054
|
+
};
|
|
3741
4055
|
"/lives": {
|
|
3742
4056
|
get: {
|
|
3743
4057
|
responses: {
|
|
@@ -3799,7 +4113,7 @@ export interface paths {
|
|
|
3799
4113
|
content: {
|
|
3800
4114
|
"application/json": {
|
|
3801
4115
|
/** @enum {string} */
|
|
3802
|
-
status?: "refund" | "
|
|
4116
|
+
status?: "refund" | "waiting" | "failure" | "pending" | "success" | "delayed";
|
|
3803
4117
|
details?: string;
|
|
3804
4118
|
/** @description Incoming transaction hashes */
|
|
3805
4119
|
inTxHashes?: string[];
|
|
@@ -3829,7 +4143,7 @@ export interface paths {
|
|
|
3829
4143
|
content: {
|
|
3830
4144
|
"application/json": {
|
|
3831
4145
|
/** @enum {string} */
|
|
3832
|
-
status?: "refund" | "
|
|
4146
|
+
status?: "refund" | "waiting" | "failure" | "pending" | "submitted" | "success";
|
|
3833
4147
|
details?: string;
|
|
3834
4148
|
/** @description Incoming transaction hashes */
|
|
3835
4149
|
inTxHashes?: string[];
|
|
@@ -4309,6 +4623,7 @@ export interface paths {
|
|
|
4309
4623
|
destinationChainId?: number;
|
|
4310
4624
|
privateChainsToInclude?: string;
|
|
4311
4625
|
id?: string;
|
|
4626
|
+
orderId?: string;
|
|
4312
4627
|
startTimestamp?: number;
|
|
4313
4628
|
endTimestamp?: number;
|
|
4314
4629
|
startBlock?: number;
|
|
@@ -4331,6 +4646,7 @@ export interface paths {
|
|
|
4331
4646
|
* "status": "success",
|
|
4332
4647
|
* "user": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
|
|
4333
4648
|
* "recipient": "0x456bccd1eaa77d5cc5ace1723b5dcca00d67cdea",
|
|
4649
|
+
* "subsidizedRequest": false,
|
|
4334
4650
|
* "data": {
|
|
4335
4651
|
* "fees": {
|
|
4336
4652
|
* "gas": "2622672522398",
|
|
@@ -4387,9 +4703,10 @@ export interface paths {
|
|
|
4387
4703
|
* @description Note that fallback is returned in the case of a refund
|
|
4388
4704
|
* @enum {string}
|
|
4389
4705
|
*/
|
|
4390
|
-
status?: "refund" | "
|
|
4706
|
+
status?: "refund" | "waiting" | "failure" | "pending" | "success" | "delayed";
|
|
4391
4707
|
user?: string;
|
|
4392
4708
|
recipient?: string;
|
|
4709
|
+
subsidizedRequest?: boolean;
|
|
4393
4710
|
data?: {
|
|
4394
4711
|
/** @description Slippage tolerance for the swap. This value is in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage */
|
|
4395
4712
|
slippageTolerance?: string;
|
|
@@ -4397,6 +4714,13 @@ export interface paths {
|
|
|
4397
4714
|
failReason?: "UNKNOWN" | "AMOUNT_TOO_LOW_TO_REFUND" | "DEPOSIT_ADDRESS_MISMATCH" | "DEPOSIT_CHAIN_MISMATCH" | "SLIPPAGE" | "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" | "N/A";
|
|
4398
4715
|
/** @enum {string} */
|
|
4399
4716
|
refundFailReason?: "AMOUNT_TOO_LOW_TO_REFUND";
|
|
4717
|
+
failedTxHash?: string;
|
|
4718
|
+
failedCallData?: {
|
|
4719
|
+
from?: string;
|
|
4720
|
+
to?: string;
|
|
4721
|
+
data?: string;
|
|
4722
|
+
value?: string;
|
|
4723
|
+
};
|
|
4400
4724
|
fees?: {
|
|
4401
4725
|
/** @description Estimated gas cost required for execution, in wei */
|
|
4402
4726
|
gas?: string;
|
|
@@ -4404,11 +4728,14 @@ export interface paths {
|
|
|
4404
4728
|
fixed?: string;
|
|
4405
4729
|
/** @description The dynamic fee which is a result of the chain and the amount, in wei */
|
|
4406
4730
|
price?: string;
|
|
4731
|
+
/** @description The fee taken by the API gateway, in wei */
|
|
4732
|
+
gateway?: string;
|
|
4407
4733
|
};
|
|
4408
4734
|
feesUsd?: {
|
|
4409
4735
|
gas?: string;
|
|
4410
4736
|
fixed?: string;
|
|
4411
4737
|
price?: string;
|
|
4738
|
+
gateway?: string;
|
|
4412
4739
|
};
|
|
4413
4740
|
inTxs?: {
|
|
4414
4741
|
/** @description Total fees in wei */
|
|
@@ -4500,8 +4827,10 @@ export interface paths {
|
|
|
4500
4827
|
};
|
|
4501
4828
|
appFees?: {
|
|
4502
4829
|
recipient?: string;
|
|
4830
|
+
bps?: string;
|
|
4503
4831
|
amount?: string;
|
|
4504
4832
|
amountUsd?: string;
|
|
4833
|
+
amountUsdCurrent?: string;
|
|
4505
4834
|
}[];
|
|
4506
4835
|
metadata?: {
|
|
4507
4836
|
sender?: string;
|
|
@@ -4625,11 +4954,176 @@ export interface paths {
|
|
|
4625
4954
|
minimumAmount?: string;
|
|
4626
4955
|
};
|
|
4627
4956
|
rate?: string;
|
|
4957
|
+
route?: {
|
|
4958
|
+
/** @description The route taken for the origin chain swap */
|
|
4959
|
+
origin?: {
|
|
4960
|
+
/**
|
|
4961
|
+
* @example {
|
|
4962
|
+
* "currency": {
|
|
4963
|
+
* "chainId": 8453,
|
|
4964
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
4965
|
+
* "symbol": "USDC",
|
|
4966
|
+
* "name": "USD Coin",
|
|
4967
|
+
* "decimals": 6,
|
|
4968
|
+
* "metadata": {
|
|
4969
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
4970
|
+
* "verified": false,
|
|
4971
|
+
* "isNative": false
|
|
4972
|
+
* }
|
|
4973
|
+
* },
|
|
4974
|
+
* "amount": "30754920",
|
|
4975
|
+
* "amountFormatted": "30.75492",
|
|
4976
|
+
* "amountUsd": "30.901612",
|
|
4977
|
+
* "minimumAmount": "30454920"
|
|
4978
|
+
* }
|
|
4979
|
+
*/
|
|
4980
|
+
inputCurrency?: {
|
|
4981
|
+
currency?: {
|
|
4982
|
+
chainId?: number;
|
|
4983
|
+
address?: string;
|
|
4984
|
+
symbol?: string;
|
|
4985
|
+
name?: string;
|
|
4986
|
+
decimals?: number;
|
|
4987
|
+
metadata?: {
|
|
4988
|
+
logoURI?: string;
|
|
4989
|
+
verified?: boolean;
|
|
4990
|
+
isNative?: boolean;
|
|
4991
|
+
};
|
|
4992
|
+
};
|
|
4993
|
+
amount?: string;
|
|
4994
|
+
amountFormatted?: string;
|
|
4995
|
+
amountUsd?: string;
|
|
4996
|
+
minimumAmount?: string;
|
|
4997
|
+
};
|
|
4998
|
+
/**
|
|
4999
|
+
* @example {
|
|
5000
|
+
* "currency": {
|
|
5001
|
+
* "chainId": 8453,
|
|
5002
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
5003
|
+
* "symbol": "USDC",
|
|
5004
|
+
* "name": "USD Coin",
|
|
5005
|
+
* "decimals": 6,
|
|
5006
|
+
* "metadata": {
|
|
5007
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
5008
|
+
* "verified": false,
|
|
5009
|
+
* "isNative": false
|
|
5010
|
+
* }
|
|
5011
|
+
* },
|
|
5012
|
+
* "amount": "30754920",
|
|
5013
|
+
* "amountFormatted": "30.75492",
|
|
5014
|
+
* "amountUsd": "30.901612",
|
|
5015
|
+
* "minimumAmount": "30454920"
|
|
5016
|
+
* }
|
|
5017
|
+
*/
|
|
5018
|
+
outputCurrency?: {
|
|
5019
|
+
currency?: {
|
|
5020
|
+
chainId?: number;
|
|
5021
|
+
address?: string;
|
|
5022
|
+
symbol?: string;
|
|
5023
|
+
name?: string;
|
|
5024
|
+
decimals?: number;
|
|
5025
|
+
metadata?: {
|
|
5026
|
+
logoURI?: string;
|
|
5027
|
+
verified?: boolean;
|
|
5028
|
+
isNative?: boolean;
|
|
5029
|
+
};
|
|
5030
|
+
};
|
|
5031
|
+
amount?: string;
|
|
5032
|
+
amountFormatted?: string;
|
|
5033
|
+
amountUsd?: string;
|
|
5034
|
+
minimumAmount?: string;
|
|
5035
|
+
};
|
|
5036
|
+
router?: string;
|
|
5037
|
+
includedSwapSources?: string[];
|
|
5038
|
+
};
|
|
5039
|
+
/** @description The route taken for the origin chain swap */
|
|
5040
|
+
destination?: {
|
|
5041
|
+
/**
|
|
5042
|
+
* @example {
|
|
5043
|
+
* "currency": {
|
|
5044
|
+
* "chainId": 8453,
|
|
5045
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
5046
|
+
* "symbol": "USDC",
|
|
5047
|
+
* "name": "USD Coin",
|
|
5048
|
+
* "decimals": 6,
|
|
5049
|
+
* "metadata": {
|
|
5050
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
5051
|
+
* "verified": false,
|
|
5052
|
+
* "isNative": false
|
|
5053
|
+
* }
|
|
5054
|
+
* },
|
|
5055
|
+
* "amount": "30754920",
|
|
5056
|
+
* "amountFormatted": "30.75492",
|
|
5057
|
+
* "amountUsd": "30.901612",
|
|
5058
|
+
* "minimumAmount": "30454920"
|
|
5059
|
+
* }
|
|
5060
|
+
*/
|
|
5061
|
+
inputCurrency?: {
|
|
5062
|
+
currency?: {
|
|
5063
|
+
chainId?: number;
|
|
5064
|
+
address?: string;
|
|
5065
|
+
symbol?: string;
|
|
5066
|
+
name?: string;
|
|
5067
|
+
decimals?: number;
|
|
5068
|
+
metadata?: {
|
|
5069
|
+
logoURI?: string;
|
|
5070
|
+
verified?: boolean;
|
|
5071
|
+
isNative?: boolean;
|
|
5072
|
+
};
|
|
5073
|
+
};
|
|
5074
|
+
amount?: string;
|
|
5075
|
+
amountFormatted?: string;
|
|
5076
|
+
amountUsd?: string;
|
|
5077
|
+
minimumAmount?: string;
|
|
5078
|
+
};
|
|
5079
|
+
/**
|
|
5080
|
+
* @example {
|
|
5081
|
+
* "currency": {
|
|
5082
|
+
* "chainId": 8453,
|
|
5083
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
5084
|
+
* "symbol": "USDC",
|
|
5085
|
+
* "name": "USD Coin",
|
|
5086
|
+
* "decimals": 6,
|
|
5087
|
+
* "metadata": {
|
|
5088
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
5089
|
+
* "verified": false,
|
|
5090
|
+
* "isNative": false
|
|
5091
|
+
* }
|
|
5092
|
+
* },
|
|
5093
|
+
* "amount": "30754920",
|
|
5094
|
+
* "amountFormatted": "30.75492",
|
|
5095
|
+
* "amountUsd": "30.901612",
|
|
5096
|
+
* "minimumAmount": "30454920"
|
|
5097
|
+
* }
|
|
5098
|
+
*/
|
|
5099
|
+
outputCurrency?: {
|
|
5100
|
+
currency?: {
|
|
5101
|
+
chainId?: number;
|
|
5102
|
+
address?: string;
|
|
5103
|
+
symbol?: string;
|
|
5104
|
+
name?: string;
|
|
5105
|
+
decimals?: number;
|
|
5106
|
+
metadata?: {
|
|
5107
|
+
logoURI?: string;
|
|
5108
|
+
verified?: boolean;
|
|
5109
|
+
isNative?: boolean;
|
|
5110
|
+
};
|
|
5111
|
+
};
|
|
5112
|
+
amount?: string;
|
|
5113
|
+
amountFormatted?: string;
|
|
5114
|
+
amountUsd?: string;
|
|
5115
|
+
minimumAmount?: string;
|
|
5116
|
+
};
|
|
5117
|
+
router?: string;
|
|
5118
|
+
includedSwapSources?: string[];
|
|
5119
|
+
};
|
|
5120
|
+
};
|
|
4628
5121
|
};
|
|
4629
5122
|
price?: string;
|
|
4630
5123
|
usesExternalLiquidity?: boolean;
|
|
4631
5124
|
timeEstimate?: number;
|
|
4632
5125
|
triggeredByCcm?: boolean;
|
|
5126
|
+
triggeredByFastFill?: boolean;
|
|
4633
5127
|
outTxs?: {
|
|
4634
5128
|
/** @description Total fees in wei */
|
|
4635
5129
|
fee?: string;
|
|
@@ -4874,6 +5368,7 @@ export interface paths {
|
|
|
4874
5368
|
DMT?: number;
|
|
4875
5369
|
G7?: number;
|
|
4876
5370
|
POWER?: number;
|
|
5371
|
+
SYND?: number;
|
|
4877
5372
|
};
|
|
4878
5373
|
};
|
|
4879
5374
|
};
|