@relayprotocol/relay-sdk 7.0.0 → 7.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/routes/index.js +3 -1
- package/_cjs/src/routes/index.js.map +1 -1
- package/_cjs/src/types/api.js.map +1 -1
- package/_cjs/src/version.js +1 -1
- package/_cjs/src/version.js.map +1 -1
- package/_cjs/tsconfig.build.tsbuildinfo +1 -1
- package/_esm/src/routes/index.js +3 -1
- package/_esm/src/routes/index.js.map +1 -1
- package/_esm/src/types/api.js.map +1 -1
- package/_esm/src/version.js +1 -1
- package/_esm/src/version.js.map +1 -1
- package/_esm/tsconfig.build.tsbuildinfo +1 -1
- package/_types/src/routes/index.d.ts.map +1 -1
- package/_types/src/types/api.d.ts +1000 -42
- 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
|
@@ -400,7 +400,7 @@ export interface paths {
|
|
|
400
400
|
baseChainId?: number | null;
|
|
401
401
|
/** @description If applicable, a status message for the chain */
|
|
402
402
|
statusMessage?: string | null;
|
|
403
|
-
/** @description An array of solver addresses in use on the chain
|
|
403
|
+
/** @description An array of solver addresses in use on the chain, including active multi-EOA and VM-specific service signer addresses. */
|
|
404
404
|
solverAddresses?: string[];
|
|
405
405
|
tags?: string[];
|
|
406
406
|
protocol?: {
|
|
@@ -528,7 +528,7 @@ export interface paths {
|
|
|
528
528
|
/** @description User address, when supplied returns user balance and max bridge amount */
|
|
529
529
|
user?: string;
|
|
530
530
|
/** @description Restricts the user balance and capacity to a particular currency when supplied with a currency id. Defaults to the native currency of the destination chain. */
|
|
531
|
-
currency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "
|
|
531
|
+
currency?: "anime" | "btc" | "cgt" | "dai" | "degen" | "eth" | "omi" | "pop" | "tg7" | "tia" | "usdc" | "usdc.e" | "usdt" | "sol" | "weth" | "ape" | "g7" | "pengu" | "plume" | "plumeusd" | "gun" | "somi" | "synd" | "xpl" | "usde" | "mon" | "usdh" | "musd" | "usdm" | "pyusd" | "cash" | "eusd" | "pusd" | "bnb" | "usdg" | "pathusd" | "usdc.e-cronos";
|
|
532
532
|
};
|
|
533
533
|
};
|
|
534
534
|
responses: {
|
|
@@ -569,6 +569,64 @@ export interface paths {
|
|
|
569
569
|
};
|
|
570
570
|
};
|
|
571
571
|
};
|
|
572
|
+
"/deposit-addresses/v1": {
|
|
573
|
+
get: {
|
|
574
|
+
parameters: {
|
|
575
|
+
query?: {
|
|
576
|
+
/** @description The deposit address to look up. Provide either `address` or `requestId`. */
|
|
577
|
+
address?: string;
|
|
578
|
+
/** @description The original requestId the deposit address was created for. Provide either `address` or `requestId`. */
|
|
579
|
+
requestId?: string;
|
|
580
|
+
};
|
|
581
|
+
header?: {
|
|
582
|
+
/** @description API key for authentication. */
|
|
583
|
+
"x-api-key"?: string;
|
|
584
|
+
};
|
|
585
|
+
};
|
|
586
|
+
responses: {
|
|
587
|
+
/** @description Default Response */
|
|
588
|
+
200: {
|
|
589
|
+
content: {
|
|
590
|
+
"application/json": {
|
|
591
|
+
/** @description The deposit address. */
|
|
592
|
+
depositAddress: string;
|
|
593
|
+
/**
|
|
594
|
+
* @description The deposit address type.
|
|
595
|
+
* @enum {string}
|
|
596
|
+
*/
|
|
597
|
+
type: "open" | "strict";
|
|
598
|
+
/** @description The original requestId the deposit address was created for. */
|
|
599
|
+
requestId: string;
|
|
600
|
+
/** @description The chain the deposit address was created on. */
|
|
601
|
+
chainId: number;
|
|
602
|
+
/** @description ISO 8601 timestamp of when the deposit address was created. */
|
|
603
|
+
createdAt: string;
|
|
604
|
+
/** @description Origin currency id from the originating quote request. Null when the quote request is unavailable. */
|
|
605
|
+
currency?: string | null;
|
|
606
|
+
/** @description Refund address from the originating quote request. Null when unset or the quote request is unavailable. */
|
|
607
|
+
refundTo?: string | null;
|
|
608
|
+
};
|
|
609
|
+
};
|
|
610
|
+
};
|
|
611
|
+
/** @description Default Response */
|
|
612
|
+
401: {
|
|
613
|
+
content: {
|
|
614
|
+
"application/json": {
|
|
615
|
+
message?: string;
|
|
616
|
+
};
|
|
617
|
+
};
|
|
618
|
+
};
|
|
619
|
+
/** @description Default Response */
|
|
620
|
+
404: {
|
|
621
|
+
content: {
|
|
622
|
+
"application/json": {
|
|
623
|
+
message?: string;
|
|
624
|
+
};
|
|
625
|
+
};
|
|
626
|
+
};
|
|
627
|
+
};
|
|
628
|
+
};
|
|
629
|
+
};
|
|
572
630
|
"/execute/permits": {
|
|
573
631
|
post: {
|
|
574
632
|
parameters: {
|
|
@@ -702,6 +760,8 @@ export interface paths {
|
|
|
702
760
|
referrerAddress?: string;
|
|
703
761
|
/** @description Address to send the refund to in the case of failure, if not specified then the recipient address or user address is used */
|
|
704
762
|
refundTo?: string;
|
|
763
|
+
/** @description Origin-chain address used for deposit-address fund recovery. Requires useDepositAddress=true. */
|
|
764
|
+
recoveryAddress?: string;
|
|
705
765
|
/**
|
|
706
766
|
* @deprecated
|
|
707
767
|
* @description Always refund on the origin chain in case of any issues
|
|
@@ -751,11 +811,14 @@ export interface paths {
|
|
|
751
811
|
forceSolverExecution?: boolean;
|
|
752
812
|
/** @description If the sponsor should pay for the fees associated with the request. Includes gas topup amounts. */
|
|
753
813
|
subsidizeFees?: boolean;
|
|
754
|
-
/** @description The fee components to sponsor for swap execution kinds. Requires subsidizeFees=true. Defaults to
|
|
755
|
-
sponsoredFeeComponents?: ("execution" | "swap" | "relay" | "app")[];
|
|
814
|
+
/** @description The fee components to sponsor for swap execution kinds. Requires subsidizeFees=true. Defaults to execution, swap, relay, and app when omitted; rent remains user-paid unless explicitly selected. */
|
|
815
|
+
sponsoredFeeComponents?: ("execution" | "swap" | "relay" | "app" | "rent")[];
|
|
756
816
|
/** @description The max subsidization amount in USDC decimal format, e.g 1000000 = $1. subsidizeFees must be enabled. The sponsor will cover fees up to this cap and the user pays any remainder. */
|
|
757
817
|
maxSubsidizationAmount?: string;
|
|
758
|
-
/**
|
|
818
|
+
/**
|
|
819
|
+
* @deprecated
|
|
820
|
+
* @description Deprecated compatibility alias that adds "rent" to sponsoredFeeComponents.
|
|
821
|
+
*/
|
|
759
822
|
subsidizeRent?: boolean;
|
|
760
823
|
/** @description Swap sources to include for swap routing. */
|
|
761
824
|
includedSwapSources?: string[];
|
|
@@ -777,6 +840,8 @@ export interface paths {
|
|
|
777
840
|
includeComputeUnitLimit?: boolean;
|
|
778
841
|
/** @description Whether to ignore price impact errors. */
|
|
779
842
|
overridePriceImpact?: boolean;
|
|
843
|
+
/** @description Whether to disable preferred swap provider selection. */
|
|
844
|
+
disableSwapProviderPreference?: boolean;
|
|
780
845
|
/** @description Whether to disable origin swaps. */
|
|
781
846
|
disableOriginSwaps?: boolean;
|
|
782
847
|
/** @description The rate to charge for fixed spread quotes. */
|
|
@@ -1092,12 +1157,12 @@ export interface paths {
|
|
|
1092
1157
|
/** @description The quote-time sponsorship expectation for the request. */
|
|
1093
1158
|
quoted?: {
|
|
1094
1159
|
/** @description The normalized sponsorship buckets selected for this request. */
|
|
1095
|
-
selectedComponents: ("execution" | "swap" | "relay" | "app")[];
|
|
1160
|
+
selectedComponents: ("execution" | "swap" | "relay" | "app" | "rent")[];
|
|
1096
1161
|
/** @description The requested sponsorship cap in USD micro-units, when one was configured for the request. */
|
|
1097
1162
|
maxSubsidizationAmount?: string;
|
|
1098
1163
|
/** @description Whether the configured sponsorship cap limited the selected fee buckets for this phase. */
|
|
1099
1164
|
capHit: boolean;
|
|
1100
|
-
/** @description Per-bucket sponsorship details for the
|
|
1165
|
+
/** @description Per-bucket sponsorship details for the sponsorable fee components. */
|
|
1101
1166
|
components: {
|
|
1102
1167
|
/** @description Execution fee sponsorship details. */
|
|
1103
1168
|
execution: {
|
|
@@ -1587,6 +1652,128 @@ export interface paths {
|
|
|
1587
1652
|
minimumAmount?: string;
|
|
1588
1653
|
};
|
|
1589
1654
|
};
|
|
1655
|
+
/** @description Solana ATA rent sponsorship details. */
|
|
1656
|
+
rent: {
|
|
1657
|
+
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
1658
|
+
selected: boolean;
|
|
1659
|
+
/**
|
|
1660
|
+
* @description The full amount charged for this fee bucket.
|
|
1661
|
+
* @example {
|
|
1662
|
+
* "currency": {
|
|
1663
|
+
* "chainId": 8453,
|
|
1664
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
1665
|
+
* "symbol": "USDC",
|
|
1666
|
+
* "name": "USD Coin",
|
|
1667
|
+
* "decimals": 6,
|
|
1668
|
+
* "metadata": {
|
|
1669
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
1670
|
+
* "verified": false,
|
|
1671
|
+
* "isNative": false
|
|
1672
|
+
* }
|
|
1673
|
+
* },
|
|
1674
|
+
* "amount": "30754920",
|
|
1675
|
+
* "amountFormatted": "30.75492",
|
|
1676
|
+
* "amountUsd": "30.901612",
|
|
1677
|
+
* "minimumAmount": "30454920"
|
|
1678
|
+
* }
|
|
1679
|
+
*/
|
|
1680
|
+
total: {
|
|
1681
|
+
currency?: {
|
|
1682
|
+
chainId?: number;
|
|
1683
|
+
address?: string;
|
|
1684
|
+
symbol?: string;
|
|
1685
|
+
name?: string;
|
|
1686
|
+
decimals?: number;
|
|
1687
|
+
metadata?: {
|
|
1688
|
+
logoURI?: string;
|
|
1689
|
+
verified?: boolean;
|
|
1690
|
+
isNative?: boolean;
|
|
1691
|
+
};
|
|
1692
|
+
};
|
|
1693
|
+
amount?: string;
|
|
1694
|
+
amountFormatted?: string;
|
|
1695
|
+
amountUsd?: string;
|
|
1696
|
+
minimumAmount?: string;
|
|
1697
|
+
};
|
|
1698
|
+
/**
|
|
1699
|
+
* @description The portion of this fee bucket covered by the sponsor.
|
|
1700
|
+
* @example {
|
|
1701
|
+
* "currency": {
|
|
1702
|
+
* "chainId": 8453,
|
|
1703
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
1704
|
+
* "symbol": "USDC",
|
|
1705
|
+
* "name": "USD Coin",
|
|
1706
|
+
* "decimals": 6,
|
|
1707
|
+
* "metadata": {
|
|
1708
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
1709
|
+
* "verified": false,
|
|
1710
|
+
* "isNative": false
|
|
1711
|
+
* }
|
|
1712
|
+
* },
|
|
1713
|
+
* "amount": "30754920",
|
|
1714
|
+
* "amountFormatted": "30.75492",
|
|
1715
|
+
* "amountUsd": "30.901612",
|
|
1716
|
+
* "minimumAmount": "30454920"
|
|
1717
|
+
* }
|
|
1718
|
+
*/
|
|
1719
|
+
sponsored: {
|
|
1720
|
+
currency?: {
|
|
1721
|
+
chainId?: number;
|
|
1722
|
+
address?: string;
|
|
1723
|
+
symbol?: string;
|
|
1724
|
+
name?: string;
|
|
1725
|
+
decimals?: number;
|
|
1726
|
+
metadata?: {
|
|
1727
|
+
logoURI?: string;
|
|
1728
|
+
verified?: boolean;
|
|
1729
|
+
isNative?: boolean;
|
|
1730
|
+
};
|
|
1731
|
+
};
|
|
1732
|
+
amount?: string;
|
|
1733
|
+
amountFormatted?: string;
|
|
1734
|
+
amountUsd?: string;
|
|
1735
|
+
minimumAmount?: string;
|
|
1736
|
+
};
|
|
1737
|
+
/**
|
|
1738
|
+
* @description The portion of this fee bucket that remained user-paid.
|
|
1739
|
+
* @example {
|
|
1740
|
+
* "currency": {
|
|
1741
|
+
* "chainId": 8453,
|
|
1742
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
1743
|
+
* "symbol": "USDC",
|
|
1744
|
+
* "name": "USD Coin",
|
|
1745
|
+
* "decimals": 6,
|
|
1746
|
+
* "metadata": {
|
|
1747
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
1748
|
+
* "verified": false,
|
|
1749
|
+
* "isNative": false
|
|
1750
|
+
* }
|
|
1751
|
+
* },
|
|
1752
|
+
* "amount": "30754920",
|
|
1753
|
+
* "amountFormatted": "30.75492",
|
|
1754
|
+
* "amountUsd": "30.901612",
|
|
1755
|
+
* "minimumAmount": "30454920"
|
|
1756
|
+
* }
|
|
1757
|
+
*/
|
|
1758
|
+
userPays: {
|
|
1759
|
+
currency?: {
|
|
1760
|
+
chainId?: number;
|
|
1761
|
+
address?: string;
|
|
1762
|
+
symbol?: string;
|
|
1763
|
+
name?: string;
|
|
1764
|
+
decimals?: number;
|
|
1765
|
+
metadata?: {
|
|
1766
|
+
logoURI?: string;
|
|
1767
|
+
verified?: boolean;
|
|
1768
|
+
isNative?: boolean;
|
|
1769
|
+
};
|
|
1770
|
+
};
|
|
1771
|
+
amount?: string;
|
|
1772
|
+
amountFormatted?: string;
|
|
1773
|
+
amountUsd?: string;
|
|
1774
|
+
minimumAmount?: string;
|
|
1775
|
+
};
|
|
1776
|
+
};
|
|
1590
1777
|
};
|
|
1591
1778
|
/**
|
|
1592
1779
|
* @description The total amount sponsored for this phase.
|
|
@@ -1670,12 +1857,12 @@ export interface paths {
|
|
|
1670
1857
|
/** @description The post-solve sponsorship outcome recorded for the request. */
|
|
1671
1858
|
actual?: {
|
|
1672
1859
|
/** @description The normalized sponsorship buckets selected for this request. */
|
|
1673
|
-
selectedComponents: ("execution" | "swap" | "relay" | "app")[];
|
|
1860
|
+
selectedComponents: ("execution" | "swap" | "relay" | "app" | "rent")[];
|
|
1674
1861
|
/** @description The requested sponsorship cap in USD micro-units, when one was configured for the request. */
|
|
1675
1862
|
maxSubsidizationAmount?: string;
|
|
1676
1863
|
/** @description Whether the configured sponsorship cap limited the selected fee buckets for this phase. */
|
|
1677
1864
|
capHit: boolean;
|
|
1678
|
-
/** @description Per-bucket sponsorship details for the
|
|
1865
|
+
/** @description Per-bucket sponsorship details for the sponsorable fee components. */
|
|
1679
1866
|
components: {
|
|
1680
1867
|
/** @description Execution fee sponsorship details. */
|
|
1681
1868
|
execution: {
|
|
@@ -2165,6 +2352,128 @@ export interface paths {
|
|
|
2165
2352
|
minimumAmount?: string;
|
|
2166
2353
|
};
|
|
2167
2354
|
};
|
|
2355
|
+
/** @description Solana ATA rent sponsorship details. */
|
|
2356
|
+
rent: {
|
|
2357
|
+
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
2358
|
+
selected: boolean;
|
|
2359
|
+
/**
|
|
2360
|
+
* @description The full amount charged for this fee bucket.
|
|
2361
|
+
* @example {
|
|
2362
|
+
* "currency": {
|
|
2363
|
+
* "chainId": 8453,
|
|
2364
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
2365
|
+
* "symbol": "USDC",
|
|
2366
|
+
* "name": "USD Coin",
|
|
2367
|
+
* "decimals": 6,
|
|
2368
|
+
* "metadata": {
|
|
2369
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
2370
|
+
* "verified": false,
|
|
2371
|
+
* "isNative": false
|
|
2372
|
+
* }
|
|
2373
|
+
* },
|
|
2374
|
+
* "amount": "30754920",
|
|
2375
|
+
* "amountFormatted": "30.75492",
|
|
2376
|
+
* "amountUsd": "30.901612",
|
|
2377
|
+
* "minimumAmount": "30454920"
|
|
2378
|
+
* }
|
|
2379
|
+
*/
|
|
2380
|
+
total: {
|
|
2381
|
+
currency?: {
|
|
2382
|
+
chainId?: number;
|
|
2383
|
+
address?: string;
|
|
2384
|
+
symbol?: string;
|
|
2385
|
+
name?: string;
|
|
2386
|
+
decimals?: number;
|
|
2387
|
+
metadata?: {
|
|
2388
|
+
logoURI?: string;
|
|
2389
|
+
verified?: boolean;
|
|
2390
|
+
isNative?: boolean;
|
|
2391
|
+
};
|
|
2392
|
+
};
|
|
2393
|
+
amount?: string;
|
|
2394
|
+
amountFormatted?: string;
|
|
2395
|
+
amountUsd?: string;
|
|
2396
|
+
minimumAmount?: string;
|
|
2397
|
+
};
|
|
2398
|
+
/**
|
|
2399
|
+
* @description The portion of this fee bucket covered by the sponsor.
|
|
2400
|
+
* @example {
|
|
2401
|
+
* "currency": {
|
|
2402
|
+
* "chainId": 8453,
|
|
2403
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
2404
|
+
* "symbol": "USDC",
|
|
2405
|
+
* "name": "USD Coin",
|
|
2406
|
+
* "decimals": 6,
|
|
2407
|
+
* "metadata": {
|
|
2408
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
2409
|
+
* "verified": false,
|
|
2410
|
+
* "isNative": false
|
|
2411
|
+
* }
|
|
2412
|
+
* },
|
|
2413
|
+
* "amount": "30754920",
|
|
2414
|
+
* "amountFormatted": "30.75492",
|
|
2415
|
+
* "amountUsd": "30.901612",
|
|
2416
|
+
* "minimumAmount": "30454920"
|
|
2417
|
+
* }
|
|
2418
|
+
*/
|
|
2419
|
+
sponsored: {
|
|
2420
|
+
currency?: {
|
|
2421
|
+
chainId?: number;
|
|
2422
|
+
address?: string;
|
|
2423
|
+
symbol?: string;
|
|
2424
|
+
name?: string;
|
|
2425
|
+
decimals?: number;
|
|
2426
|
+
metadata?: {
|
|
2427
|
+
logoURI?: string;
|
|
2428
|
+
verified?: boolean;
|
|
2429
|
+
isNative?: boolean;
|
|
2430
|
+
};
|
|
2431
|
+
};
|
|
2432
|
+
amount?: string;
|
|
2433
|
+
amountFormatted?: string;
|
|
2434
|
+
amountUsd?: string;
|
|
2435
|
+
minimumAmount?: string;
|
|
2436
|
+
};
|
|
2437
|
+
/**
|
|
2438
|
+
* @description The portion of this fee bucket that remained user-paid.
|
|
2439
|
+
* @example {
|
|
2440
|
+
* "currency": {
|
|
2441
|
+
* "chainId": 8453,
|
|
2442
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
2443
|
+
* "symbol": "USDC",
|
|
2444
|
+
* "name": "USD Coin",
|
|
2445
|
+
* "decimals": 6,
|
|
2446
|
+
* "metadata": {
|
|
2447
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
2448
|
+
* "verified": false,
|
|
2449
|
+
* "isNative": false
|
|
2450
|
+
* }
|
|
2451
|
+
* },
|
|
2452
|
+
* "amount": "30754920",
|
|
2453
|
+
* "amountFormatted": "30.75492",
|
|
2454
|
+
* "amountUsd": "30.901612",
|
|
2455
|
+
* "minimumAmount": "30454920"
|
|
2456
|
+
* }
|
|
2457
|
+
*/
|
|
2458
|
+
userPays: {
|
|
2459
|
+
currency?: {
|
|
2460
|
+
chainId?: number;
|
|
2461
|
+
address?: string;
|
|
2462
|
+
symbol?: string;
|
|
2463
|
+
name?: string;
|
|
2464
|
+
decimals?: number;
|
|
2465
|
+
metadata?: {
|
|
2466
|
+
logoURI?: string;
|
|
2467
|
+
verified?: boolean;
|
|
2468
|
+
isNative?: boolean;
|
|
2469
|
+
};
|
|
2470
|
+
};
|
|
2471
|
+
amount?: string;
|
|
2472
|
+
amountFormatted?: string;
|
|
2473
|
+
amountUsd?: string;
|
|
2474
|
+
minimumAmount?: string;
|
|
2475
|
+
};
|
|
2476
|
+
};
|
|
2168
2477
|
};
|
|
2169
2478
|
/**
|
|
2170
2479
|
* @description The total amount sponsored for this phase.
|
|
@@ -2450,6 +2759,8 @@ export interface paths {
|
|
|
2450
2759
|
/** @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. */
|
|
2451
2760
|
rate?: string;
|
|
2452
2761
|
slippageTolerance?: {
|
|
2762
|
+
/** @description The total slippage tolerance applied to the order, in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage. The origin and destination breakdowns are alternative allocations of this budget and are not additive. */
|
|
2763
|
+
total?: string;
|
|
2453
2764
|
/** @description The slippage tolerance on the origin chain swap */
|
|
2454
2765
|
origin?: {
|
|
2455
2766
|
usd?: string;
|
|
@@ -2781,6 +3092,8 @@ export interface paths {
|
|
|
2781
3092
|
referrerAddress?: string;
|
|
2782
3093
|
/** @description Address to send the refund to in the case of failure, if not specified then the recipient address or user address is used */
|
|
2783
3094
|
refundTo?: string;
|
|
3095
|
+
/** @description Origin-chain address used for deposit-address fund recovery. Requires useDepositAddress=true. */
|
|
3096
|
+
recoveryAddress?: string;
|
|
2784
3097
|
/**
|
|
2785
3098
|
* @deprecated
|
|
2786
3099
|
* @description Always refund on the origin chain in case of any issues
|
|
@@ -2830,11 +3143,14 @@ export interface paths {
|
|
|
2830
3143
|
forceSolverExecution?: boolean;
|
|
2831
3144
|
/** @description If the sponsor should pay for the fees associated with the request. Includes gas topup amounts. */
|
|
2832
3145
|
subsidizeFees?: boolean;
|
|
2833
|
-
/** @description The fee components to sponsor for swap execution kinds. Requires subsidizeFees=true. Defaults to
|
|
2834
|
-
sponsoredFeeComponents?: ("execution" | "swap" | "relay" | "app")[];
|
|
3146
|
+
/** @description The fee components to sponsor for swap execution kinds. Requires subsidizeFees=true. Defaults to execution, swap, relay, and app when omitted; rent remains user-paid unless explicitly selected. */
|
|
3147
|
+
sponsoredFeeComponents?: ("execution" | "swap" | "relay" | "app" | "rent")[];
|
|
2835
3148
|
/** @description The max subsidization amount in USDC decimal format, e.g 1000000 = $1. subsidizeFees must be enabled. The sponsor will cover fees up to this cap and the user pays any remainder. */
|
|
2836
3149
|
maxSubsidizationAmount?: string;
|
|
2837
|
-
/**
|
|
3150
|
+
/**
|
|
3151
|
+
* @deprecated
|
|
3152
|
+
* @description Deprecated compatibility alias that adds "rent" to sponsoredFeeComponents.
|
|
3153
|
+
*/
|
|
2838
3154
|
subsidizeRent?: boolean;
|
|
2839
3155
|
/** @description Swap sources to include for swap routing. */
|
|
2840
3156
|
includedSwapSources?: string[];
|
|
@@ -2856,6 +3172,8 @@ export interface paths {
|
|
|
2856
3172
|
includeComputeUnitLimit?: boolean;
|
|
2857
3173
|
/** @description Whether to ignore price impact errors. */
|
|
2858
3174
|
overridePriceImpact?: boolean;
|
|
3175
|
+
/** @description Whether to disable preferred swap provider selection. */
|
|
3176
|
+
disableSwapProviderPreference?: boolean;
|
|
2859
3177
|
/** @description Whether to disable origin swaps. */
|
|
2860
3178
|
disableOriginSwaps?: boolean;
|
|
2861
3179
|
/** @description The rate to charge for fixed spread quotes. */
|
|
@@ -3171,12 +3489,12 @@ export interface paths {
|
|
|
3171
3489
|
/** @description The quote-time sponsorship expectation for the request. */
|
|
3172
3490
|
quoted?: {
|
|
3173
3491
|
/** @description The normalized sponsorship buckets selected for this request. */
|
|
3174
|
-
selectedComponents: ("execution" | "swap" | "relay" | "app")[];
|
|
3492
|
+
selectedComponents: ("execution" | "swap" | "relay" | "app" | "rent")[];
|
|
3175
3493
|
/** @description The requested sponsorship cap in USD micro-units, when one was configured for the request. */
|
|
3176
3494
|
maxSubsidizationAmount?: string;
|
|
3177
3495
|
/** @description Whether the configured sponsorship cap limited the selected fee buckets for this phase. */
|
|
3178
3496
|
capHit: boolean;
|
|
3179
|
-
/** @description Per-bucket sponsorship details for the
|
|
3497
|
+
/** @description Per-bucket sponsorship details for the sponsorable fee components. */
|
|
3180
3498
|
components: {
|
|
3181
3499
|
/** @description Execution fee sponsorship details. */
|
|
3182
3500
|
execution: {
|
|
@@ -3300,8 +3618,130 @@ export interface paths {
|
|
|
3300
3618
|
minimumAmount?: string;
|
|
3301
3619
|
};
|
|
3302
3620
|
};
|
|
3303
|
-
/** @description Swap fee sponsorship details. */
|
|
3304
|
-
swap: {
|
|
3621
|
+
/** @description Swap fee sponsorship details. */
|
|
3622
|
+
swap: {
|
|
3623
|
+
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
3624
|
+
selected: boolean;
|
|
3625
|
+
/**
|
|
3626
|
+
* @description The full amount charged for this fee bucket.
|
|
3627
|
+
* @example {
|
|
3628
|
+
* "currency": {
|
|
3629
|
+
* "chainId": 8453,
|
|
3630
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3631
|
+
* "symbol": "USDC",
|
|
3632
|
+
* "name": "USD Coin",
|
|
3633
|
+
* "decimals": 6,
|
|
3634
|
+
* "metadata": {
|
|
3635
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3636
|
+
* "verified": false,
|
|
3637
|
+
* "isNative": false
|
|
3638
|
+
* }
|
|
3639
|
+
* },
|
|
3640
|
+
* "amount": "30754920",
|
|
3641
|
+
* "amountFormatted": "30.75492",
|
|
3642
|
+
* "amountUsd": "30.901612",
|
|
3643
|
+
* "minimumAmount": "30454920"
|
|
3644
|
+
* }
|
|
3645
|
+
*/
|
|
3646
|
+
total: {
|
|
3647
|
+
currency?: {
|
|
3648
|
+
chainId?: number;
|
|
3649
|
+
address?: string;
|
|
3650
|
+
symbol?: string;
|
|
3651
|
+
name?: string;
|
|
3652
|
+
decimals?: number;
|
|
3653
|
+
metadata?: {
|
|
3654
|
+
logoURI?: string;
|
|
3655
|
+
verified?: boolean;
|
|
3656
|
+
isNative?: boolean;
|
|
3657
|
+
};
|
|
3658
|
+
};
|
|
3659
|
+
amount?: string;
|
|
3660
|
+
amountFormatted?: string;
|
|
3661
|
+
amountUsd?: string;
|
|
3662
|
+
minimumAmount?: string;
|
|
3663
|
+
};
|
|
3664
|
+
/**
|
|
3665
|
+
* @description The portion of this fee bucket covered by the sponsor.
|
|
3666
|
+
* @example {
|
|
3667
|
+
* "currency": {
|
|
3668
|
+
* "chainId": 8453,
|
|
3669
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3670
|
+
* "symbol": "USDC",
|
|
3671
|
+
* "name": "USD Coin",
|
|
3672
|
+
* "decimals": 6,
|
|
3673
|
+
* "metadata": {
|
|
3674
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3675
|
+
* "verified": false,
|
|
3676
|
+
* "isNative": false
|
|
3677
|
+
* }
|
|
3678
|
+
* },
|
|
3679
|
+
* "amount": "30754920",
|
|
3680
|
+
* "amountFormatted": "30.75492",
|
|
3681
|
+
* "amountUsd": "30.901612",
|
|
3682
|
+
* "minimumAmount": "30454920"
|
|
3683
|
+
* }
|
|
3684
|
+
*/
|
|
3685
|
+
sponsored: {
|
|
3686
|
+
currency?: {
|
|
3687
|
+
chainId?: number;
|
|
3688
|
+
address?: string;
|
|
3689
|
+
symbol?: string;
|
|
3690
|
+
name?: string;
|
|
3691
|
+
decimals?: number;
|
|
3692
|
+
metadata?: {
|
|
3693
|
+
logoURI?: string;
|
|
3694
|
+
verified?: boolean;
|
|
3695
|
+
isNative?: boolean;
|
|
3696
|
+
};
|
|
3697
|
+
};
|
|
3698
|
+
amount?: string;
|
|
3699
|
+
amountFormatted?: string;
|
|
3700
|
+
amountUsd?: string;
|
|
3701
|
+
minimumAmount?: string;
|
|
3702
|
+
};
|
|
3703
|
+
/**
|
|
3704
|
+
* @description The portion of this fee bucket that remained user-paid.
|
|
3705
|
+
* @example {
|
|
3706
|
+
* "currency": {
|
|
3707
|
+
* "chainId": 8453,
|
|
3708
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
3709
|
+
* "symbol": "USDC",
|
|
3710
|
+
* "name": "USD Coin",
|
|
3711
|
+
* "decimals": 6,
|
|
3712
|
+
* "metadata": {
|
|
3713
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
3714
|
+
* "verified": false,
|
|
3715
|
+
* "isNative": false
|
|
3716
|
+
* }
|
|
3717
|
+
* },
|
|
3718
|
+
* "amount": "30754920",
|
|
3719
|
+
* "amountFormatted": "30.75492",
|
|
3720
|
+
* "amountUsd": "30.901612",
|
|
3721
|
+
* "minimumAmount": "30454920"
|
|
3722
|
+
* }
|
|
3723
|
+
*/
|
|
3724
|
+
userPays: {
|
|
3725
|
+
currency?: {
|
|
3726
|
+
chainId?: number;
|
|
3727
|
+
address?: string;
|
|
3728
|
+
symbol?: string;
|
|
3729
|
+
name?: string;
|
|
3730
|
+
decimals?: number;
|
|
3731
|
+
metadata?: {
|
|
3732
|
+
logoURI?: string;
|
|
3733
|
+
verified?: boolean;
|
|
3734
|
+
isNative?: boolean;
|
|
3735
|
+
};
|
|
3736
|
+
};
|
|
3737
|
+
amount?: string;
|
|
3738
|
+
amountFormatted?: string;
|
|
3739
|
+
amountUsd?: string;
|
|
3740
|
+
minimumAmount?: string;
|
|
3741
|
+
};
|
|
3742
|
+
};
|
|
3743
|
+
/** @description Relay protocol fee sponsorship details. */
|
|
3744
|
+
relay: {
|
|
3305
3745
|
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
3306
3746
|
selected: boolean;
|
|
3307
3747
|
/**
|
|
@@ -3422,8 +3862,8 @@ export interface paths {
|
|
|
3422
3862
|
minimumAmount?: string;
|
|
3423
3863
|
};
|
|
3424
3864
|
};
|
|
3425
|
-
/** @description
|
|
3426
|
-
|
|
3865
|
+
/** @description App fee sponsorship details. */
|
|
3866
|
+
app: {
|
|
3427
3867
|
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
3428
3868
|
selected: boolean;
|
|
3429
3869
|
/**
|
|
@@ -3544,8 +3984,8 @@ export interface paths {
|
|
|
3544
3984
|
minimumAmount?: string;
|
|
3545
3985
|
};
|
|
3546
3986
|
};
|
|
3547
|
-
/** @description
|
|
3548
|
-
|
|
3987
|
+
/** @description Solana ATA rent sponsorship details. */
|
|
3988
|
+
rent: {
|
|
3549
3989
|
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
3550
3990
|
selected: boolean;
|
|
3551
3991
|
/**
|
|
@@ -3749,12 +4189,12 @@ export interface paths {
|
|
|
3749
4189
|
/** @description The post-solve sponsorship outcome recorded for the request. */
|
|
3750
4190
|
actual?: {
|
|
3751
4191
|
/** @description The normalized sponsorship buckets selected for this request. */
|
|
3752
|
-
selectedComponents: ("execution" | "swap" | "relay" | "app")[];
|
|
4192
|
+
selectedComponents: ("execution" | "swap" | "relay" | "app" | "rent")[];
|
|
3753
4193
|
/** @description The requested sponsorship cap in USD micro-units, when one was configured for the request. */
|
|
3754
4194
|
maxSubsidizationAmount?: string;
|
|
3755
4195
|
/** @description Whether the configured sponsorship cap limited the selected fee buckets for this phase. */
|
|
3756
4196
|
capHit: boolean;
|
|
3757
|
-
/** @description Per-bucket sponsorship details for the
|
|
4197
|
+
/** @description Per-bucket sponsorship details for the sponsorable fee components. */
|
|
3758
4198
|
components: {
|
|
3759
4199
|
/** @description Execution fee sponsorship details. */
|
|
3760
4200
|
execution: {
|
|
@@ -4244,6 +4684,128 @@ export interface paths {
|
|
|
4244
4684
|
minimumAmount?: string;
|
|
4245
4685
|
};
|
|
4246
4686
|
};
|
|
4687
|
+
/** @description Solana ATA rent sponsorship details. */
|
|
4688
|
+
rent: {
|
|
4689
|
+
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
4690
|
+
selected: boolean;
|
|
4691
|
+
/**
|
|
4692
|
+
* @description The full amount charged for this fee bucket.
|
|
4693
|
+
* @example {
|
|
4694
|
+
* "currency": {
|
|
4695
|
+
* "chainId": 8453,
|
|
4696
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
4697
|
+
* "symbol": "USDC",
|
|
4698
|
+
* "name": "USD Coin",
|
|
4699
|
+
* "decimals": 6,
|
|
4700
|
+
* "metadata": {
|
|
4701
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
4702
|
+
* "verified": false,
|
|
4703
|
+
* "isNative": false
|
|
4704
|
+
* }
|
|
4705
|
+
* },
|
|
4706
|
+
* "amount": "30754920",
|
|
4707
|
+
* "amountFormatted": "30.75492",
|
|
4708
|
+
* "amountUsd": "30.901612",
|
|
4709
|
+
* "minimumAmount": "30454920"
|
|
4710
|
+
* }
|
|
4711
|
+
*/
|
|
4712
|
+
total: {
|
|
4713
|
+
currency?: {
|
|
4714
|
+
chainId?: number;
|
|
4715
|
+
address?: string;
|
|
4716
|
+
symbol?: string;
|
|
4717
|
+
name?: string;
|
|
4718
|
+
decimals?: number;
|
|
4719
|
+
metadata?: {
|
|
4720
|
+
logoURI?: string;
|
|
4721
|
+
verified?: boolean;
|
|
4722
|
+
isNative?: boolean;
|
|
4723
|
+
};
|
|
4724
|
+
};
|
|
4725
|
+
amount?: string;
|
|
4726
|
+
amountFormatted?: string;
|
|
4727
|
+
amountUsd?: string;
|
|
4728
|
+
minimumAmount?: string;
|
|
4729
|
+
};
|
|
4730
|
+
/**
|
|
4731
|
+
* @description The portion of this fee bucket covered by the sponsor.
|
|
4732
|
+
* @example {
|
|
4733
|
+
* "currency": {
|
|
4734
|
+
* "chainId": 8453,
|
|
4735
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
4736
|
+
* "symbol": "USDC",
|
|
4737
|
+
* "name": "USD Coin",
|
|
4738
|
+
* "decimals": 6,
|
|
4739
|
+
* "metadata": {
|
|
4740
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
4741
|
+
* "verified": false,
|
|
4742
|
+
* "isNative": false
|
|
4743
|
+
* }
|
|
4744
|
+
* },
|
|
4745
|
+
* "amount": "30754920",
|
|
4746
|
+
* "amountFormatted": "30.75492",
|
|
4747
|
+
* "amountUsd": "30.901612",
|
|
4748
|
+
* "minimumAmount": "30454920"
|
|
4749
|
+
* }
|
|
4750
|
+
*/
|
|
4751
|
+
sponsored: {
|
|
4752
|
+
currency?: {
|
|
4753
|
+
chainId?: number;
|
|
4754
|
+
address?: string;
|
|
4755
|
+
symbol?: string;
|
|
4756
|
+
name?: string;
|
|
4757
|
+
decimals?: number;
|
|
4758
|
+
metadata?: {
|
|
4759
|
+
logoURI?: string;
|
|
4760
|
+
verified?: boolean;
|
|
4761
|
+
isNative?: boolean;
|
|
4762
|
+
};
|
|
4763
|
+
};
|
|
4764
|
+
amount?: string;
|
|
4765
|
+
amountFormatted?: string;
|
|
4766
|
+
amountUsd?: string;
|
|
4767
|
+
minimumAmount?: string;
|
|
4768
|
+
};
|
|
4769
|
+
/**
|
|
4770
|
+
* @description The portion of this fee bucket that remained user-paid.
|
|
4771
|
+
* @example {
|
|
4772
|
+
* "currency": {
|
|
4773
|
+
* "chainId": 8453,
|
|
4774
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
4775
|
+
* "symbol": "USDC",
|
|
4776
|
+
* "name": "USD Coin",
|
|
4777
|
+
* "decimals": 6,
|
|
4778
|
+
* "metadata": {
|
|
4779
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
4780
|
+
* "verified": false,
|
|
4781
|
+
* "isNative": false
|
|
4782
|
+
* }
|
|
4783
|
+
* },
|
|
4784
|
+
* "amount": "30754920",
|
|
4785
|
+
* "amountFormatted": "30.75492",
|
|
4786
|
+
* "amountUsd": "30.901612",
|
|
4787
|
+
* "minimumAmount": "30454920"
|
|
4788
|
+
* }
|
|
4789
|
+
*/
|
|
4790
|
+
userPays: {
|
|
4791
|
+
currency?: {
|
|
4792
|
+
chainId?: number;
|
|
4793
|
+
address?: string;
|
|
4794
|
+
symbol?: string;
|
|
4795
|
+
name?: string;
|
|
4796
|
+
decimals?: number;
|
|
4797
|
+
metadata?: {
|
|
4798
|
+
logoURI?: string;
|
|
4799
|
+
verified?: boolean;
|
|
4800
|
+
isNative?: boolean;
|
|
4801
|
+
};
|
|
4802
|
+
};
|
|
4803
|
+
amount?: string;
|
|
4804
|
+
amountFormatted?: string;
|
|
4805
|
+
amountUsd?: string;
|
|
4806
|
+
minimumAmount?: string;
|
|
4807
|
+
};
|
|
4808
|
+
};
|
|
4247
4809
|
};
|
|
4248
4810
|
/**
|
|
4249
4811
|
* @description The total amount sponsored for this phase.
|
|
@@ -4529,6 +5091,8 @@ export interface paths {
|
|
|
4529
5091
|
/** @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. */
|
|
4530
5092
|
rate?: string;
|
|
4531
5093
|
slippageTolerance?: {
|
|
5094
|
+
/** @description The total slippage tolerance applied to the order, in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage. The origin and destination breakdowns are alternative allocations of this budget and are not additive. */
|
|
5095
|
+
total?: string;
|
|
4532
5096
|
/** @description The slippage tolerance on the origin chain swap */
|
|
4533
5097
|
origin?: {
|
|
4534
5098
|
usd?: string;
|
|
@@ -5187,6 +5751,8 @@ export interface paths {
|
|
|
5187
5751
|
/** @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. */
|
|
5188
5752
|
rate?: string;
|
|
5189
5753
|
slippageTolerance?: {
|
|
5754
|
+
/** @description The total slippage tolerance applied to the order, in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage. The origin and destination breakdowns are alternative allocations of this budget and are not additive. */
|
|
5755
|
+
total?: string;
|
|
5190
5756
|
/** @description The slippage tolerance on the origin chain swap */
|
|
5191
5757
|
origin?: {
|
|
5192
5758
|
usd?: string;
|
|
@@ -5698,6 +6264,8 @@ export interface paths {
|
|
|
5698
6264
|
/** @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. */
|
|
5699
6265
|
rate?: string;
|
|
5700
6266
|
slippageTolerance?: {
|
|
6267
|
+
/** @description The total slippage tolerance applied to the order, in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage. The origin and destination breakdowns are alternative allocations of this budget and are not additive. */
|
|
6268
|
+
total?: string;
|
|
5701
6269
|
/** @description The slippage tolerance on the origin chain swap */
|
|
5702
6270
|
origin?: {
|
|
5703
6271
|
usd?: string;
|
|
@@ -6478,7 +7046,7 @@ export interface paths {
|
|
|
6478
7046
|
id?: string;
|
|
6479
7047
|
/** @description Filter by `orderId` — the protocol-level deposit identifier passed as `bytes32 id` to the Relay Depository when funds are deposited, and emitted in the deposit event. */
|
|
6480
7048
|
orderId?: string;
|
|
6481
|
-
/** @description When true, include
|
|
7049
|
+
/** @description When true, include `orderData`; public pending requests omit its output subtree. */
|
|
6482
7050
|
includeOrderData?: boolean;
|
|
6483
7051
|
/** @description Filter requests created at or after this Unix timestamp (seconds). */
|
|
6484
7052
|
startTimestamp?: number;
|
|
@@ -6603,7 +7171,7 @@ export interface paths {
|
|
|
6603
7171
|
/** @description Slippage tolerance for the swap. This value is in basis points (1/100th of a percent), e.g. 50 for 0.5% slippage */
|
|
6604
7172
|
slippageTolerance?: string;
|
|
6605
7173
|
/** @enum {string} */
|
|
6606
|
-
failReason?: "UNKNOWN" | "SLIPPAGE" | "AMOUNT_TOO_LOW_TO_REFUND" | "DEPOSIT_ADDRESS_MISMATCH" | "DEPOSIT_CHAIN_MISMATCH" | "INCORRECT_DEPOSIT_CURRENCY" | "DOUBLE_SPEND" | "SOLVER_CAPACITY_EXCEEDED" | "SOLVER_BALANCE_TOO_LOW" | "DEPOSITED_AMOUNT_TOO_LOW_TO_FILL" | "NEGATIVE_NEW_AMOUNT_AFTER_FEES" | "NO_QUOTES" | "MISSING_REVERT_DATA" | "REVERSE_SWAP_FAILED" | "GENERATE_SWAP_FAILED" | "TOO_LITTLE_RECEIVED" | "EXECUTION_REVERTED" | "NEW_CALLDATA_INCLUDES_HIGHER_RENT_FEE" | "TRANSACTION_REVERTED" | "TRANSACTION_TOO_LARGE" | "ORIGIN_CURRENCY_MISMATCH" | "NO_INTERNAL_SWAP_ROUTES_FOUND" | "SWAP_USES_TOO_MUCH_GAS" | "INSUFFICIENT_FUNDS_FOR_RENT" | "SPONSOR_BALANCE_TOO_LOW" | "ORDER_EXPIRED" | "ORDER_IS_CANCELLED" | "TRANSFER_FROM_FAILED" | "TRANSFER_FAILED" | "SIGNATURE_EXPIRED" | "INVALID_SIGNATURE" | "INSUFFICIENT_NATIVE_TOKENS_SUPPLIED" | "TRANSFER_AMOUNT_EXCEEDS_ALLOWANCE" | "TRANSFER_AMOUNT_EXCEEDS_BALANCE" | "INVALID_SENDER" | "ACCOUNT_ABSTRACTION_INVALID_NONCE" | "ACCOUNT_ABSTRACTION_SIGNATURE_ERROR" | "SEAPORT_INEXACT_FRACTION" | "TOKEN_NOT_TRANSFERABLE" | "ZERO_SELL_AMOUNT" | "MINT_NOT_ACTIVE" | "ERC_1155_TOO_MANY_REQUESTED" | "INCORRECT_PAYMENT" | "INVALID_GAS_PRICE" | "FLUID_DEX_ERROR" | "ORDER_ALREADY_FILLED" | "SEAPORT_INVALID_FULFILLER" | "INVALID_SIGNER" | "MINT_QUANTITY_EXCEEDS_MAX_PER_WALLET" | "MINT_QUANTITY_EXCEEDS_MAX_SUPPLY" | "JUPITER_INVALID_TOKEN_ACCOUNT" | "INVALID_NONCE" | "ACCOUNT_ABSTRACTION_GAS_LIMIT" | "CONTRACT_PAUSED" | "SWAP_IMPACT_TOO_HIGH" | "INSUFFICIENT_POOL_LIQUIDITY" | "TTL_EXPIRED" | "DEPOSIT_CONFIRMATION_TIMEOUT" | "ORPHANED_DEPOSIT_REFUND" | "GASLESS_PERMIT_BALANCE_TOO_LOW" | "MANUAL_ADMIN_REFUND" | "QUOTED_GAS_LIMIT_EXCEEDED" | "DESTINATION_TOKEN_TRANSFER_REJECTED" | "DEPOSIT_REORGED" | "BLOCKED_WALLET" | "PROTOCOL_DEADLINE_EXPIRED" | "N/A";
|
|
7174
|
+
failReason?: "UNKNOWN" | "SLIPPAGE" | "AMOUNT_TOO_LOW_TO_REFUND" | "DEPOSIT_ADDRESS_MISMATCH" | "DEPOSIT_CHAIN_MISMATCH" | "INCORRECT_DEPOSIT_CURRENCY" | "DOUBLE_SPEND" | "SOLVER_CAPACITY_EXCEEDED" | "SOLVER_BALANCE_TOO_LOW" | "DEPOSITED_AMOUNT_TOO_LOW_TO_FILL" | "NEGATIVE_NEW_AMOUNT_AFTER_FEES" | "NO_QUOTES" | "MISSING_REVERT_DATA" | "REVERSE_SWAP_FAILED" | "GENERATE_SWAP_FAILED" | "TOO_LITTLE_RECEIVED" | "EXECUTION_REVERTED" | "NEW_CALLDATA_INCLUDES_HIGHER_RENT_FEE" | "TRANSACTION_REVERTED" | "TRANSACTION_TOO_LARGE" | "ORIGIN_CURRENCY_MISMATCH" | "NO_INTERNAL_SWAP_ROUTES_FOUND" | "SWAP_USES_TOO_MUCH_GAS" | "INSUFFICIENT_FUNDS_FOR_RENT" | "SPONSOR_BALANCE_TOO_LOW" | "ORDER_EXPIRED" | "ORDER_IS_CANCELLED" | "TRANSFER_FROM_FAILED" | "TRANSFER_FAILED" | "SIGNATURE_EXPIRED" | "INVALID_SIGNATURE" | "INSUFFICIENT_NATIVE_TOKENS_SUPPLIED" | "TRANSFER_AMOUNT_EXCEEDS_ALLOWANCE" | "TRANSFER_AMOUNT_EXCEEDS_BALANCE" | "INVALID_SENDER" | "ACCOUNT_ABSTRACTION_INVALID_NONCE" | "ACCOUNT_ABSTRACTION_SIGNATURE_ERROR" | "SEAPORT_INEXACT_FRACTION" | "TOKEN_NOT_TRANSFERABLE" | "ZERO_SELL_AMOUNT" | "MINT_NOT_ACTIVE" | "ERC_1155_TOO_MANY_REQUESTED" | "INCORRECT_PAYMENT" | "INVALID_GAS_PRICE" | "FLUID_DEX_ERROR" | "ORDER_ALREADY_FILLED" | "SEAPORT_INVALID_FULFILLER" | "INVALID_SIGNER" | "MINT_QUANTITY_EXCEEDS_MAX_PER_WALLET" | "MINT_QUANTITY_EXCEEDS_MAX_SUPPLY" | "JUPITER_INVALID_TOKEN_ACCOUNT" | "INVALID_NONCE" | "ACCOUNT_ABSTRACTION_GAS_LIMIT" | "CONTRACT_PAUSED" | "SWAP_IMPACT_TOO_HIGH" | "INSUFFICIENT_POOL_LIQUIDITY" | "TTL_EXPIRED" | "DEPOSIT_CONFIRMATION_TIMEOUT" | "ORPHANED_DEPOSIT_REFUND" | "GASLESS_PERMIT_BALANCE_TOO_LOW" | "MANUAL_ADMIN_REFUND" | "QUOTED_GAS_LIMIT_EXCEEDED" | "DESTINATION_TOKEN_TRANSFER_REJECTED" | "DEPOSIT_REORGED" | "BLOCKED_WALLET" | "PROTOCOL_DEADLINE_EXPIRED" | "TRANSACTION_NOT_INCLUDED" | "TRANSACTION_SUBMISSION_FAILED" | "N/A";
|
|
6607
7175
|
/** @enum {string} */
|
|
6608
7176
|
refundFailReason?: "AMOUNT_TOO_LOW_TO_REFUND" | "NEGATIVE_NEW_AMOUNT_AFTER_FEES" | "SWAP_CURRENCY_NOT_ON_ORIGIN" | "REFUND_RECIPIENT_IS_VASP";
|
|
6609
7177
|
/** @description Regenerated requestId that now owns the sweep/fill for a superseded deposit-address request. */
|
|
@@ -6749,12 +7317,12 @@ export interface paths {
|
|
|
6749
7317
|
/** @description The quote-time sponsorship expectation for the request. */
|
|
6750
7318
|
quoted?: {
|
|
6751
7319
|
/** @description The normalized sponsorship buckets selected for this request. */
|
|
6752
|
-
selectedComponents: ("execution" | "swap" | "relay" | "app")[];
|
|
7320
|
+
selectedComponents: ("execution" | "swap" | "relay" | "app" | "rent")[];
|
|
6753
7321
|
/** @description The requested sponsorship cap in USD micro-units, when one was configured for the request. */
|
|
6754
7322
|
maxSubsidizationAmount?: string;
|
|
6755
7323
|
/** @description Whether the configured sponsorship cap limited the selected fee buckets for this phase. */
|
|
6756
7324
|
capHit: boolean;
|
|
6757
|
-
/** @description Per-bucket sponsorship details for the
|
|
7325
|
+
/** @description Per-bucket sponsorship details for the sponsorable fee components. */
|
|
6758
7326
|
components: {
|
|
6759
7327
|
/** @description Execution fee sponsorship details. */
|
|
6760
7328
|
execution: {
|
|
@@ -6878,8 +7446,130 @@ export interface paths {
|
|
|
6878
7446
|
minimumAmount?: string;
|
|
6879
7447
|
};
|
|
6880
7448
|
};
|
|
6881
|
-
/** @description Swap fee sponsorship details. */
|
|
6882
|
-
swap: {
|
|
7449
|
+
/** @description Swap fee sponsorship details. */
|
|
7450
|
+
swap: {
|
|
7451
|
+
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
7452
|
+
selected: boolean;
|
|
7453
|
+
/**
|
|
7454
|
+
* @description The full amount charged for this fee bucket.
|
|
7455
|
+
* @example {
|
|
7456
|
+
* "currency": {
|
|
7457
|
+
* "chainId": 8453,
|
|
7458
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
7459
|
+
* "symbol": "USDC",
|
|
7460
|
+
* "name": "USD Coin",
|
|
7461
|
+
* "decimals": 6,
|
|
7462
|
+
* "metadata": {
|
|
7463
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
7464
|
+
* "verified": false,
|
|
7465
|
+
* "isNative": false
|
|
7466
|
+
* }
|
|
7467
|
+
* },
|
|
7468
|
+
* "amount": "30754920",
|
|
7469
|
+
* "amountFormatted": "30.75492",
|
|
7470
|
+
* "amountUsd": "30.901612",
|
|
7471
|
+
* "minimumAmount": "30454920"
|
|
7472
|
+
* }
|
|
7473
|
+
*/
|
|
7474
|
+
total: {
|
|
7475
|
+
currency?: {
|
|
7476
|
+
chainId?: number;
|
|
7477
|
+
address?: string;
|
|
7478
|
+
symbol?: string;
|
|
7479
|
+
name?: string;
|
|
7480
|
+
decimals?: number;
|
|
7481
|
+
metadata?: {
|
|
7482
|
+
logoURI?: string;
|
|
7483
|
+
verified?: boolean;
|
|
7484
|
+
isNative?: boolean;
|
|
7485
|
+
};
|
|
7486
|
+
};
|
|
7487
|
+
amount?: string;
|
|
7488
|
+
amountFormatted?: string;
|
|
7489
|
+
amountUsd?: string;
|
|
7490
|
+
minimumAmount?: string;
|
|
7491
|
+
};
|
|
7492
|
+
/**
|
|
7493
|
+
* @description The portion of this fee bucket covered by the sponsor.
|
|
7494
|
+
* @example {
|
|
7495
|
+
* "currency": {
|
|
7496
|
+
* "chainId": 8453,
|
|
7497
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
7498
|
+
* "symbol": "USDC",
|
|
7499
|
+
* "name": "USD Coin",
|
|
7500
|
+
* "decimals": 6,
|
|
7501
|
+
* "metadata": {
|
|
7502
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
7503
|
+
* "verified": false,
|
|
7504
|
+
* "isNative": false
|
|
7505
|
+
* }
|
|
7506
|
+
* },
|
|
7507
|
+
* "amount": "30754920",
|
|
7508
|
+
* "amountFormatted": "30.75492",
|
|
7509
|
+
* "amountUsd": "30.901612",
|
|
7510
|
+
* "minimumAmount": "30454920"
|
|
7511
|
+
* }
|
|
7512
|
+
*/
|
|
7513
|
+
sponsored: {
|
|
7514
|
+
currency?: {
|
|
7515
|
+
chainId?: number;
|
|
7516
|
+
address?: string;
|
|
7517
|
+
symbol?: string;
|
|
7518
|
+
name?: string;
|
|
7519
|
+
decimals?: number;
|
|
7520
|
+
metadata?: {
|
|
7521
|
+
logoURI?: string;
|
|
7522
|
+
verified?: boolean;
|
|
7523
|
+
isNative?: boolean;
|
|
7524
|
+
};
|
|
7525
|
+
};
|
|
7526
|
+
amount?: string;
|
|
7527
|
+
amountFormatted?: string;
|
|
7528
|
+
amountUsd?: string;
|
|
7529
|
+
minimumAmount?: string;
|
|
7530
|
+
};
|
|
7531
|
+
/**
|
|
7532
|
+
* @description The portion of this fee bucket that remained user-paid.
|
|
7533
|
+
* @example {
|
|
7534
|
+
* "currency": {
|
|
7535
|
+
* "chainId": 8453,
|
|
7536
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
7537
|
+
* "symbol": "USDC",
|
|
7538
|
+
* "name": "USD Coin",
|
|
7539
|
+
* "decimals": 6,
|
|
7540
|
+
* "metadata": {
|
|
7541
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
7542
|
+
* "verified": false,
|
|
7543
|
+
* "isNative": false
|
|
7544
|
+
* }
|
|
7545
|
+
* },
|
|
7546
|
+
* "amount": "30754920",
|
|
7547
|
+
* "amountFormatted": "30.75492",
|
|
7548
|
+
* "amountUsd": "30.901612",
|
|
7549
|
+
* "minimumAmount": "30454920"
|
|
7550
|
+
* }
|
|
7551
|
+
*/
|
|
7552
|
+
userPays: {
|
|
7553
|
+
currency?: {
|
|
7554
|
+
chainId?: number;
|
|
7555
|
+
address?: string;
|
|
7556
|
+
symbol?: string;
|
|
7557
|
+
name?: string;
|
|
7558
|
+
decimals?: number;
|
|
7559
|
+
metadata?: {
|
|
7560
|
+
logoURI?: string;
|
|
7561
|
+
verified?: boolean;
|
|
7562
|
+
isNative?: boolean;
|
|
7563
|
+
};
|
|
7564
|
+
};
|
|
7565
|
+
amount?: string;
|
|
7566
|
+
amountFormatted?: string;
|
|
7567
|
+
amountUsd?: string;
|
|
7568
|
+
minimumAmount?: string;
|
|
7569
|
+
};
|
|
7570
|
+
};
|
|
7571
|
+
/** @description Relay protocol fee sponsorship details. */
|
|
7572
|
+
relay: {
|
|
6883
7573
|
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
6884
7574
|
selected: boolean;
|
|
6885
7575
|
/**
|
|
@@ -7000,8 +7690,8 @@ export interface paths {
|
|
|
7000
7690
|
minimumAmount?: string;
|
|
7001
7691
|
};
|
|
7002
7692
|
};
|
|
7003
|
-
/** @description
|
|
7004
|
-
|
|
7693
|
+
/** @description App fee sponsorship details. */
|
|
7694
|
+
app: {
|
|
7005
7695
|
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
7006
7696
|
selected: boolean;
|
|
7007
7697
|
/**
|
|
@@ -7122,8 +7812,8 @@ export interface paths {
|
|
|
7122
7812
|
minimumAmount?: string;
|
|
7123
7813
|
};
|
|
7124
7814
|
};
|
|
7125
|
-
/** @description
|
|
7126
|
-
|
|
7815
|
+
/** @description Solana ATA rent sponsorship details. */
|
|
7816
|
+
rent: {
|
|
7127
7817
|
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
7128
7818
|
selected: boolean;
|
|
7129
7819
|
/**
|
|
@@ -7327,12 +8017,12 @@ export interface paths {
|
|
|
7327
8017
|
/** @description The post-solve sponsorship outcome recorded for the request. */
|
|
7328
8018
|
actual?: {
|
|
7329
8019
|
/** @description The normalized sponsorship buckets selected for this request. */
|
|
7330
|
-
selectedComponents: ("execution" | "swap" | "relay" | "app")[];
|
|
8020
|
+
selectedComponents: ("execution" | "swap" | "relay" | "app" | "rent")[];
|
|
7331
8021
|
/** @description The requested sponsorship cap in USD micro-units, when one was configured for the request. */
|
|
7332
8022
|
maxSubsidizationAmount?: string;
|
|
7333
8023
|
/** @description Whether the configured sponsorship cap limited the selected fee buckets for this phase. */
|
|
7334
8024
|
capHit: boolean;
|
|
7335
|
-
/** @description Per-bucket sponsorship details for the
|
|
8025
|
+
/** @description Per-bucket sponsorship details for the sponsorable fee components. */
|
|
7336
8026
|
components: {
|
|
7337
8027
|
/** @description Execution fee sponsorship details. */
|
|
7338
8028
|
execution: {
|
|
@@ -7822,6 +8512,128 @@ export interface paths {
|
|
|
7822
8512
|
minimumAmount?: string;
|
|
7823
8513
|
};
|
|
7824
8514
|
};
|
|
8515
|
+
/** @description Solana ATA rent sponsorship details. */
|
|
8516
|
+
rent: {
|
|
8517
|
+
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
8518
|
+
selected: boolean;
|
|
8519
|
+
/**
|
|
8520
|
+
* @description The full amount charged for this fee bucket.
|
|
8521
|
+
* @example {
|
|
8522
|
+
* "currency": {
|
|
8523
|
+
* "chainId": 8453,
|
|
8524
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
8525
|
+
* "symbol": "USDC",
|
|
8526
|
+
* "name": "USD Coin",
|
|
8527
|
+
* "decimals": 6,
|
|
8528
|
+
* "metadata": {
|
|
8529
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
8530
|
+
* "verified": false,
|
|
8531
|
+
* "isNative": false
|
|
8532
|
+
* }
|
|
8533
|
+
* },
|
|
8534
|
+
* "amount": "30754920",
|
|
8535
|
+
* "amountFormatted": "30.75492",
|
|
8536
|
+
* "amountUsd": "30.901612",
|
|
8537
|
+
* "minimumAmount": "30454920"
|
|
8538
|
+
* }
|
|
8539
|
+
*/
|
|
8540
|
+
total: {
|
|
8541
|
+
currency?: {
|
|
8542
|
+
chainId?: number;
|
|
8543
|
+
address?: string;
|
|
8544
|
+
symbol?: string;
|
|
8545
|
+
name?: string;
|
|
8546
|
+
decimals?: number;
|
|
8547
|
+
metadata?: {
|
|
8548
|
+
logoURI?: string;
|
|
8549
|
+
verified?: boolean;
|
|
8550
|
+
isNative?: boolean;
|
|
8551
|
+
};
|
|
8552
|
+
};
|
|
8553
|
+
amount?: string;
|
|
8554
|
+
amountFormatted?: string;
|
|
8555
|
+
amountUsd?: string;
|
|
8556
|
+
minimumAmount?: string;
|
|
8557
|
+
};
|
|
8558
|
+
/**
|
|
8559
|
+
* @description The portion of this fee bucket covered by the sponsor.
|
|
8560
|
+
* @example {
|
|
8561
|
+
* "currency": {
|
|
8562
|
+
* "chainId": 8453,
|
|
8563
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
8564
|
+
* "symbol": "USDC",
|
|
8565
|
+
* "name": "USD Coin",
|
|
8566
|
+
* "decimals": 6,
|
|
8567
|
+
* "metadata": {
|
|
8568
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
8569
|
+
* "verified": false,
|
|
8570
|
+
* "isNative": false
|
|
8571
|
+
* }
|
|
8572
|
+
* },
|
|
8573
|
+
* "amount": "30754920",
|
|
8574
|
+
* "amountFormatted": "30.75492",
|
|
8575
|
+
* "amountUsd": "30.901612",
|
|
8576
|
+
* "minimumAmount": "30454920"
|
|
8577
|
+
* }
|
|
8578
|
+
*/
|
|
8579
|
+
sponsored: {
|
|
8580
|
+
currency?: {
|
|
8581
|
+
chainId?: number;
|
|
8582
|
+
address?: string;
|
|
8583
|
+
symbol?: string;
|
|
8584
|
+
name?: string;
|
|
8585
|
+
decimals?: number;
|
|
8586
|
+
metadata?: {
|
|
8587
|
+
logoURI?: string;
|
|
8588
|
+
verified?: boolean;
|
|
8589
|
+
isNative?: boolean;
|
|
8590
|
+
};
|
|
8591
|
+
};
|
|
8592
|
+
amount?: string;
|
|
8593
|
+
amountFormatted?: string;
|
|
8594
|
+
amountUsd?: string;
|
|
8595
|
+
minimumAmount?: string;
|
|
8596
|
+
};
|
|
8597
|
+
/**
|
|
8598
|
+
* @description The portion of this fee bucket that remained user-paid.
|
|
8599
|
+
* @example {
|
|
8600
|
+
* "currency": {
|
|
8601
|
+
* "chainId": 8453,
|
|
8602
|
+
* "address": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
|
|
8603
|
+
* "symbol": "USDC",
|
|
8604
|
+
* "name": "USD Coin",
|
|
8605
|
+
* "decimals": 6,
|
|
8606
|
+
* "metadata": {
|
|
8607
|
+
* "logoURI": "https://ethereum-optimism.github.io/data/USDC/logo.png",
|
|
8608
|
+
* "verified": false,
|
|
8609
|
+
* "isNative": false
|
|
8610
|
+
* }
|
|
8611
|
+
* },
|
|
8612
|
+
* "amount": "30754920",
|
|
8613
|
+
* "amountFormatted": "30.75492",
|
|
8614
|
+
* "amountUsd": "30.901612",
|
|
8615
|
+
* "minimumAmount": "30454920"
|
|
8616
|
+
* }
|
|
8617
|
+
*/
|
|
8618
|
+
userPays: {
|
|
8619
|
+
currency?: {
|
|
8620
|
+
chainId?: number;
|
|
8621
|
+
address?: string;
|
|
8622
|
+
symbol?: string;
|
|
8623
|
+
name?: string;
|
|
8624
|
+
decimals?: number;
|
|
8625
|
+
metadata?: {
|
|
8626
|
+
logoURI?: string;
|
|
8627
|
+
verified?: boolean;
|
|
8628
|
+
isNative?: boolean;
|
|
8629
|
+
};
|
|
8630
|
+
};
|
|
8631
|
+
amount?: string;
|
|
8632
|
+
amountFormatted?: string;
|
|
8633
|
+
amountUsd?: string;
|
|
8634
|
+
minimumAmount?: string;
|
|
8635
|
+
};
|
|
8636
|
+
};
|
|
7825
8637
|
};
|
|
7826
8638
|
/**
|
|
7827
8639
|
* @description The total amount sponsored for this phase.
|
|
@@ -8522,6 +9334,8 @@ export interface paths {
|
|
|
8522
9334
|
limit?: number;
|
|
8523
9335
|
/** @description Pagination cursor returned by a previous response. Pass it back to fetch the next page. */
|
|
8524
9336
|
continuation?: string;
|
|
9337
|
+
/** @description When true, also compute and return the total count of requests matching these filters (ignores limit/continuation). Adds latency — omit unless the total is needed. */
|
|
9338
|
+
includeTotal?: boolean;
|
|
8525
9339
|
/** @description Filter requests by wallet address — matches requests where this address is the sender or the deposit-address depositor. */
|
|
8526
9340
|
user?: string;
|
|
8527
9341
|
/** @description Broad term search across request ID, wallet, deposit address, and all transaction hashes (deposit, fill, refund, failed, and chain entry transaction IDs). Use `id`, `depositTxHash`, `fillTxHash`, or `refundTxHash` for targeted single-field lookups. */
|
|
@@ -8551,7 +9365,7 @@ export interface paths {
|
|
|
8551
9365
|
/** @description Filter requests by status. */
|
|
8552
9366
|
status?: "success" | "failure" | "refund" | "pending" | "depositing";
|
|
8553
9367
|
/** @description Filter requests by failure reason. Only returns requests that failed with this specific reason. */
|
|
8554
|
-
failReason?: "UNKNOWN" | "SLIPPAGE" | "AMOUNT_TOO_LOW_TO_REFUND" | "DEPOSIT_ADDRESS_MISMATCH" | "DEPOSIT_CHAIN_MISMATCH" | "INCORRECT_DEPOSIT_CURRENCY" | "DOUBLE_SPEND" | "SOLVER_CAPACITY_EXCEEDED" | "SOLVER_BALANCE_TOO_LOW" | "DEPOSITED_AMOUNT_TOO_LOW_TO_FILL" | "NEGATIVE_NEW_AMOUNT_AFTER_FEES" | "NO_QUOTES" | "MISSING_REVERT_DATA" | "REVERSE_SWAP_FAILED" | "GENERATE_SWAP_FAILED" | "TOO_LITTLE_RECEIVED" | "EXECUTION_REVERTED" | "NEW_CALLDATA_INCLUDES_HIGHER_RENT_FEE" | "TRANSACTION_REVERTED" | "TRANSACTION_TOO_LARGE" | "ORIGIN_CURRENCY_MISMATCH" | "NO_INTERNAL_SWAP_ROUTES_FOUND" | "SWAP_USES_TOO_MUCH_GAS" | "INSUFFICIENT_FUNDS_FOR_RENT" | "SPONSOR_BALANCE_TOO_LOW" | "ORDER_EXPIRED" | "ORDER_IS_CANCELLED" | "TRANSFER_FROM_FAILED" | "TRANSFER_FAILED" | "SIGNATURE_EXPIRED" | "INVALID_SIGNATURE" | "INSUFFICIENT_NATIVE_TOKENS_SUPPLIED" | "TRANSFER_AMOUNT_EXCEEDS_ALLOWANCE" | "TRANSFER_AMOUNT_EXCEEDS_BALANCE" | "INVALID_SENDER" | "ACCOUNT_ABSTRACTION_INVALID_NONCE" | "ACCOUNT_ABSTRACTION_SIGNATURE_ERROR" | "SEAPORT_INEXACT_FRACTION" | "TOKEN_NOT_TRANSFERABLE" | "ZERO_SELL_AMOUNT" | "MINT_NOT_ACTIVE" | "ERC_1155_TOO_MANY_REQUESTED" | "INCORRECT_PAYMENT" | "INVALID_GAS_PRICE" | "FLUID_DEX_ERROR" | "ORDER_ALREADY_FILLED" | "SEAPORT_INVALID_FULFILLER" | "INVALID_SIGNER" | "MINT_QUANTITY_EXCEEDS_MAX_PER_WALLET" | "MINT_QUANTITY_EXCEEDS_MAX_SUPPLY" | "JUPITER_INVALID_TOKEN_ACCOUNT" | "INVALID_NONCE" | "ACCOUNT_ABSTRACTION_GAS_LIMIT" | "CONTRACT_PAUSED" | "SWAP_IMPACT_TOO_HIGH" | "INSUFFICIENT_POOL_LIQUIDITY" | "TTL_EXPIRED" | "DEPOSIT_CONFIRMATION_TIMEOUT" | "ORPHANED_DEPOSIT_REFUND" | "GASLESS_PERMIT_BALANCE_TOO_LOW" | "MANUAL_ADMIN_REFUND" | "QUOTED_GAS_LIMIT_EXCEEDED" | "DESTINATION_TOKEN_TRANSFER_REJECTED" | "DEPOSIT_REORGED" | "BLOCKED_WALLET" | "PROTOCOL_DEADLINE_EXPIRED" | "N/A";
|
|
9368
|
+
failReason?: "UNKNOWN" | "SLIPPAGE" | "AMOUNT_TOO_LOW_TO_REFUND" | "DEPOSIT_ADDRESS_MISMATCH" | "DEPOSIT_CHAIN_MISMATCH" | "INCORRECT_DEPOSIT_CURRENCY" | "DOUBLE_SPEND" | "SOLVER_CAPACITY_EXCEEDED" | "SOLVER_BALANCE_TOO_LOW" | "DEPOSITED_AMOUNT_TOO_LOW_TO_FILL" | "NEGATIVE_NEW_AMOUNT_AFTER_FEES" | "NO_QUOTES" | "MISSING_REVERT_DATA" | "REVERSE_SWAP_FAILED" | "GENERATE_SWAP_FAILED" | "TOO_LITTLE_RECEIVED" | "EXECUTION_REVERTED" | "NEW_CALLDATA_INCLUDES_HIGHER_RENT_FEE" | "TRANSACTION_REVERTED" | "TRANSACTION_TOO_LARGE" | "ORIGIN_CURRENCY_MISMATCH" | "NO_INTERNAL_SWAP_ROUTES_FOUND" | "SWAP_USES_TOO_MUCH_GAS" | "INSUFFICIENT_FUNDS_FOR_RENT" | "SPONSOR_BALANCE_TOO_LOW" | "ORDER_EXPIRED" | "ORDER_IS_CANCELLED" | "TRANSFER_FROM_FAILED" | "TRANSFER_FAILED" | "SIGNATURE_EXPIRED" | "INVALID_SIGNATURE" | "INSUFFICIENT_NATIVE_TOKENS_SUPPLIED" | "TRANSFER_AMOUNT_EXCEEDS_ALLOWANCE" | "TRANSFER_AMOUNT_EXCEEDS_BALANCE" | "INVALID_SENDER" | "ACCOUNT_ABSTRACTION_INVALID_NONCE" | "ACCOUNT_ABSTRACTION_SIGNATURE_ERROR" | "SEAPORT_INEXACT_FRACTION" | "TOKEN_NOT_TRANSFERABLE" | "ZERO_SELL_AMOUNT" | "MINT_NOT_ACTIVE" | "ERC_1155_TOO_MANY_REQUESTED" | "INCORRECT_PAYMENT" | "INVALID_GAS_PRICE" | "FLUID_DEX_ERROR" | "ORDER_ALREADY_FILLED" | "SEAPORT_INVALID_FULFILLER" | "INVALID_SIGNER" | "MINT_QUANTITY_EXCEEDS_MAX_PER_WALLET" | "MINT_QUANTITY_EXCEEDS_MAX_SUPPLY" | "JUPITER_INVALID_TOKEN_ACCOUNT" | "INVALID_NONCE" | "ACCOUNT_ABSTRACTION_GAS_LIMIT" | "CONTRACT_PAUSED" | "SWAP_IMPACT_TOO_HIGH" | "INSUFFICIENT_POOL_LIQUIDITY" | "TTL_EXPIRED" | "DEPOSIT_CONFIRMATION_TIMEOUT" | "ORPHANED_DEPOSIT_REFUND" | "GASLESS_PERMIT_BALANCE_TOO_LOW" | "MANUAL_ADMIN_REFUND" | "QUOTED_GAS_LIMIT_EXCEEDED" | "DESTINATION_TOKEN_TRANSFER_REJECTED" | "DEPOSIT_REORGED" | "BLOCKED_WALLET" | "PROTOCOL_DEADLINE_EXPIRED" | "TRANSACTION_NOT_INCLUDED" | "TRANSACTION_SUBMISSION_FAILED" | "N/A";
|
|
8555
9369
|
/** @description Filter requests by refund failure reason. */
|
|
8556
9370
|
refundFailReason?: "AMOUNT_TOO_LOW_TO_REFUND" | "NEGATIVE_NEW_AMOUNT_AFTER_FEES" | "SWAP_CURRENCY_NOT_ON_ORIGIN" | "REFUND_RECIPIENT_IS_VASP";
|
|
8557
9371
|
/** @description Filter requests by API key. Accepts a single value or a comma-separated list (e.g. key1,key2) — results include requests matching any of the supplied keys. */
|
|
@@ -8606,8 +9420,6 @@ export interface paths {
|
|
|
8606
9420
|
header: {
|
|
8607
9421
|
/** @description API key for authentication. */
|
|
8608
9422
|
"x-api-key": string;
|
|
8609
|
-
/** @description Dev portal key — when present, overrides integrator identity for authenticated data. */
|
|
8610
|
-
"x-dev-portal-key"?: string;
|
|
8611
9423
|
};
|
|
8612
9424
|
};
|
|
8613
9425
|
responses: {
|
|
@@ -8624,17 +9436,21 @@ export interface paths {
|
|
|
8624
9436
|
sender?: string | null;
|
|
8625
9437
|
/** @description The address refunds are sent to for deposit-address transactions. Null when not specified. */
|
|
8626
9438
|
refundTo?: string | null;
|
|
9439
|
+
/** @description Regenerated requestId that now owns the sweep/fill for a superseded deposit-address request. Currently only set for Bitcoin (BVM) deposit-address requests. */
|
|
9440
|
+
supersededByRequestId?: string | null;
|
|
8627
9441
|
depositAddress?: ({
|
|
8628
9442
|
address?: string;
|
|
8629
9443
|
/** @enum {string} */
|
|
8630
9444
|
type?: "strict" | "open";
|
|
8631
9445
|
depositor?: string | null;
|
|
8632
9446
|
depositTxHash?: string | null;
|
|
9447
|
+
/** @description Origin-chain address that can recover deposit-address funds if the recipient wallet is later blocked. Null when not specified. */
|
|
9448
|
+
recoveryAddress?: string | null;
|
|
8633
9449
|
}) | null;
|
|
8634
9450
|
data?: {
|
|
8635
9451
|
slippageTolerance?: string;
|
|
8636
9452
|
/** @enum {string|null} */
|
|
8637
|
-
failReason?: "UNKNOWN" | "SLIPPAGE" | "AMOUNT_TOO_LOW_TO_REFUND" | "DEPOSIT_ADDRESS_MISMATCH" | "DEPOSIT_CHAIN_MISMATCH" | "INCORRECT_DEPOSIT_CURRENCY" | "DOUBLE_SPEND" | "SOLVER_CAPACITY_EXCEEDED" | "SOLVER_BALANCE_TOO_LOW" | "DEPOSITED_AMOUNT_TOO_LOW_TO_FILL" | "NEGATIVE_NEW_AMOUNT_AFTER_FEES" | "NO_QUOTES" | "MISSING_REVERT_DATA" | "REVERSE_SWAP_FAILED" | "GENERATE_SWAP_FAILED" | "TOO_LITTLE_RECEIVED" | "EXECUTION_REVERTED" | "NEW_CALLDATA_INCLUDES_HIGHER_RENT_FEE" | "TRANSACTION_REVERTED" | "TRANSACTION_TOO_LARGE" | "ORIGIN_CURRENCY_MISMATCH" | "NO_INTERNAL_SWAP_ROUTES_FOUND" | "SWAP_USES_TOO_MUCH_GAS" | "INSUFFICIENT_FUNDS_FOR_RENT" | "SPONSOR_BALANCE_TOO_LOW" | "ORDER_EXPIRED" | "ORDER_IS_CANCELLED" | "TRANSFER_FROM_FAILED" | "TRANSFER_FAILED" | "SIGNATURE_EXPIRED" | "INVALID_SIGNATURE" | "INSUFFICIENT_NATIVE_TOKENS_SUPPLIED" | "TRANSFER_AMOUNT_EXCEEDS_ALLOWANCE" | "TRANSFER_AMOUNT_EXCEEDS_BALANCE" | "INVALID_SENDER" | "ACCOUNT_ABSTRACTION_INVALID_NONCE" | "ACCOUNT_ABSTRACTION_SIGNATURE_ERROR" | "SEAPORT_INEXACT_FRACTION" | "TOKEN_NOT_TRANSFERABLE" | "ZERO_SELL_AMOUNT" | "MINT_NOT_ACTIVE" | "ERC_1155_TOO_MANY_REQUESTED" | "INCORRECT_PAYMENT" | "INVALID_GAS_PRICE" | "FLUID_DEX_ERROR" | "ORDER_ALREADY_FILLED" | "SEAPORT_INVALID_FULFILLER" | "INVALID_SIGNER" | "MINT_QUANTITY_EXCEEDS_MAX_PER_WALLET" | "MINT_QUANTITY_EXCEEDS_MAX_SUPPLY" | "JUPITER_INVALID_TOKEN_ACCOUNT" | "INVALID_NONCE" | "ACCOUNT_ABSTRACTION_GAS_LIMIT" | "CONTRACT_PAUSED" | "SWAP_IMPACT_TOO_HIGH" | "INSUFFICIENT_POOL_LIQUIDITY" | "TTL_EXPIRED" | "DEPOSIT_CONFIRMATION_TIMEOUT" | "ORPHANED_DEPOSIT_REFUND" | "GASLESS_PERMIT_BALANCE_TOO_LOW" | "MANUAL_ADMIN_REFUND" | "QUOTED_GAS_LIMIT_EXCEEDED" | "DESTINATION_TOKEN_TRANSFER_REJECTED" | "DEPOSIT_REORGED" | "BLOCKED_WALLET" | "PROTOCOL_DEADLINE_EXPIRED" | "N/A" | null;
|
|
9453
|
+
failReason?: "UNKNOWN" | "SLIPPAGE" | "AMOUNT_TOO_LOW_TO_REFUND" | "DEPOSIT_ADDRESS_MISMATCH" | "DEPOSIT_CHAIN_MISMATCH" | "INCORRECT_DEPOSIT_CURRENCY" | "DOUBLE_SPEND" | "SOLVER_CAPACITY_EXCEEDED" | "SOLVER_BALANCE_TOO_LOW" | "DEPOSITED_AMOUNT_TOO_LOW_TO_FILL" | "NEGATIVE_NEW_AMOUNT_AFTER_FEES" | "NO_QUOTES" | "MISSING_REVERT_DATA" | "REVERSE_SWAP_FAILED" | "GENERATE_SWAP_FAILED" | "TOO_LITTLE_RECEIVED" | "EXECUTION_REVERTED" | "NEW_CALLDATA_INCLUDES_HIGHER_RENT_FEE" | "TRANSACTION_REVERTED" | "TRANSACTION_TOO_LARGE" | "ORIGIN_CURRENCY_MISMATCH" | "NO_INTERNAL_SWAP_ROUTES_FOUND" | "SWAP_USES_TOO_MUCH_GAS" | "INSUFFICIENT_FUNDS_FOR_RENT" | "SPONSOR_BALANCE_TOO_LOW" | "ORDER_EXPIRED" | "ORDER_IS_CANCELLED" | "TRANSFER_FROM_FAILED" | "TRANSFER_FAILED" | "SIGNATURE_EXPIRED" | "INVALID_SIGNATURE" | "INSUFFICIENT_NATIVE_TOKENS_SUPPLIED" | "TRANSFER_AMOUNT_EXCEEDS_ALLOWANCE" | "TRANSFER_AMOUNT_EXCEEDS_BALANCE" | "INVALID_SENDER" | "ACCOUNT_ABSTRACTION_INVALID_NONCE" | "ACCOUNT_ABSTRACTION_SIGNATURE_ERROR" | "SEAPORT_INEXACT_FRACTION" | "TOKEN_NOT_TRANSFERABLE" | "ZERO_SELL_AMOUNT" | "MINT_NOT_ACTIVE" | "ERC_1155_TOO_MANY_REQUESTED" | "INCORRECT_PAYMENT" | "INVALID_GAS_PRICE" | "FLUID_DEX_ERROR" | "ORDER_ALREADY_FILLED" | "SEAPORT_INVALID_FULFILLER" | "INVALID_SIGNER" | "MINT_QUANTITY_EXCEEDS_MAX_PER_WALLET" | "MINT_QUANTITY_EXCEEDS_MAX_SUPPLY" | "JUPITER_INVALID_TOKEN_ACCOUNT" | "INVALID_NONCE" | "ACCOUNT_ABSTRACTION_GAS_LIMIT" | "CONTRACT_PAUSED" | "SWAP_IMPACT_TOO_HIGH" | "INSUFFICIENT_POOL_LIQUIDITY" | "TTL_EXPIRED" | "DEPOSIT_CONFIRMATION_TIMEOUT" | "ORPHANED_DEPOSIT_REFUND" | "GASLESS_PERMIT_BALANCE_TOO_LOW" | "MANUAL_ADMIN_REFUND" | "QUOTED_GAS_LIMIT_EXCEEDED" | "DESTINATION_TOKEN_TRANSFER_REJECTED" | "DEPOSIT_REORGED" | "BLOCKED_WALLET" | "PROTOCOL_DEADLINE_EXPIRED" | "TRANSACTION_NOT_INCLUDED" | "TRANSACTION_SUBMISSION_FAILED" | "N/A" | null;
|
|
8638
9454
|
/** @enum {string|null} */
|
|
8639
9455
|
refundFailReason?: "AMOUNT_TOO_LOW_TO_REFUND" | "NEGATIVE_NEW_AMOUNT_AFTER_FEES" | "SWAP_CURRENCY_NOT_ON_ORIGIN" | "REFUND_RECIPIENT_IS_VASP" | null;
|
|
8640
9456
|
failedTxHash?: string;
|
|
@@ -8706,12 +9522,12 @@ export interface paths {
|
|
|
8706
9522
|
/** @description The quote-time sponsorship expectation for the request. */
|
|
8707
9523
|
quoted?: {
|
|
8708
9524
|
/** @description The normalized sponsorship buckets selected for this request. */
|
|
8709
|
-
selectedComponents: ("execution" | "swap" | "platform" | "app")[];
|
|
9525
|
+
selectedComponents: ("execution" | "swap" | "platform" | "app" | "rent")[];
|
|
8710
9526
|
/** @description The requested sponsorship cap in USD micro-units, when one was configured for the request. */
|
|
8711
9527
|
maxSubsidizationAmount?: string;
|
|
8712
9528
|
/** @description Whether the configured sponsorship cap limited the selected fee buckets for this phase. */
|
|
8713
9529
|
capHit: boolean;
|
|
8714
|
-
/** @description Per-bucket sponsorship details for the
|
|
9530
|
+
/** @description Per-bucket sponsorship details for the five sponsorable fee components. */
|
|
8715
9531
|
components: {
|
|
8716
9532
|
/** @description Execution fee sponsorship details. */
|
|
8717
9533
|
execution: {
|
|
@@ -8817,6 +9633,32 @@ export interface paths {
|
|
|
8817
9633
|
minimumAmount?: string;
|
|
8818
9634
|
};
|
|
8819
9635
|
};
|
|
9636
|
+
/** @description Solana ATA rent sponsorship details. */
|
|
9637
|
+
rent: {
|
|
9638
|
+
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
9639
|
+
selected: boolean;
|
|
9640
|
+
/** @description The full amount charged for this fee bucket. */
|
|
9641
|
+
total: {
|
|
9642
|
+
amount?: string;
|
|
9643
|
+
amountFormatted?: string;
|
|
9644
|
+
amountUsd?: string;
|
|
9645
|
+
minimumAmount?: string;
|
|
9646
|
+
};
|
|
9647
|
+
/** @description The portion of this fee bucket covered by the sponsor. */
|
|
9648
|
+
sponsored: {
|
|
9649
|
+
amount?: string;
|
|
9650
|
+
amountFormatted?: string;
|
|
9651
|
+
amountUsd?: string;
|
|
9652
|
+
minimumAmount?: string;
|
|
9653
|
+
};
|
|
9654
|
+
/** @description The portion of this fee bucket that remained user-paid. */
|
|
9655
|
+
userPays: {
|
|
9656
|
+
amount?: string;
|
|
9657
|
+
amountFormatted?: string;
|
|
9658
|
+
amountUsd?: string;
|
|
9659
|
+
minimumAmount?: string;
|
|
9660
|
+
};
|
|
9661
|
+
};
|
|
8820
9662
|
};
|
|
8821
9663
|
/** @description The total amount sponsored for this phase. */
|
|
8822
9664
|
sponsoredTotal: {
|
|
@@ -8836,12 +9678,12 @@ export interface paths {
|
|
|
8836
9678
|
/** @description The post-solve sponsorship outcome recorded for the request. */
|
|
8837
9679
|
actual?: {
|
|
8838
9680
|
/** @description The normalized sponsorship buckets selected for this request. */
|
|
8839
|
-
selectedComponents: ("execution" | "swap" | "platform" | "app")[];
|
|
9681
|
+
selectedComponents: ("execution" | "swap" | "platform" | "app" | "rent")[];
|
|
8840
9682
|
/** @description The requested sponsorship cap in USD micro-units, when one was configured for the request. */
|
|
8841
9683
|
maxSubsidizationAmount?: string;
|
|
8842
9684
|
/** @description Whether the configured sponsorship cap limited the selected fee buckets for this phase. */
|
|
8843
9685
|
capHit: boolean;
|
|
8844
|
-
/** @description Per-bucket sponsorship details for the
|
|
9686
|
+
/** @description Per-bucket sponsorship details for the five sponsorable fee components. */
|
|
8845
9687
|
components: {
|
|
8846
9688
|
/** @description Execution fee sponsorship details. */
|
|
8847
9689
|
execution: {
|
|
@@ -8947,6 +9789,32 @@ export interface paths {
|
|
|
8947
9789
|
minimumAmount?: string;
|
|
8948
9790
|
};
|
|
8949
9791
|
};
|
|
9792
|
+
/** @description Solana ATA rent sponsorship details. */
|
|
9793
|
+
rent: {
|
|
9794
|
+
/** @description Whether this fee bucket was selected for sponsorship. */
|
|
9795
|
+
selected: boolean;
|
|
9796
|
+
/** @description The full amount charged for this fee bucket. */
|
|
9797
|
+
total: {
|
|
9798
|
+
amount?: string;
|
|
9799
|
+
amountFormatted?: string;
|
|
9800
|
+
amountUsd?: string;
|
|
9801
|
+
minimumAmount?: string;
|
|
9802
|
+
};
|
|
9803
|
+
/** @description The portion of this fee bucket covered by the sponsor. */
|
|
9804
|
+
sponsored: {
|
|
9805
|
+
amount?: string;
|
|
9806
|
+
amountFormatted?: string;
|
|
9807
|
+
amountUsd?: string;
|
|
9808
|
+
minimumAmount?: string;
|
|
9809
|
+
};
|
|
9810
|
+
/** @description The portion of this fee bucket that remained user-paid. */
|
|
9811
|
+
userPays: {
|
|
9812
|
+
amount?: string;
|
|
9813
|
+
amountFormatted?: string;
|
|
9814
|
+
amountUsd?: string;
|
|
9815
|
+
minimumAmount?: string;
|
|
9816
|
+
};
|
|
9817
|
+
};
|
|
8950
9818
|
};
|
|
8951
9819
|
/** @description The total amount sponsored for this phase. */
|
|
8952
9820
|
sponsoredTotal: {
|
|
@@ -9255,6 +10123,47 @@ export interface paths {
|
|
|
9255
10123
|
rate?: string;
|
|
9256
10124
|
}) | null;
|
|
9257
10125
|
}) | null;
|
|
10126
|
+
/** @description Oracle price snapshot at quote time, only returned for fixed-BPS oracle integrators. */
|
|
10127
|
+
quoteOraclePrice?: {
|
|
10128
|
+
rate?: string;
|
|
10129
|
+
observedAt?: string;
|
|
10130
|
+
inputCurrency?: {
|
|
10131
|
+
currency?: {
|
|
10132
|
+
chainId?: number;
|
|
10133
|
+
address?: string;
|
|
10134
|
+
symbol?: string;
|
|
10135
|
+
name?: string;
|
|
10136
|
+
decimals?: number;
|
|
10137
|
+
metadata?: {
|
|
10138
|
+
logoURI?: string;
|
|
10139
|
+
verified?: boolean;
|
|
10140
|
+
isNative?: boolean;
|
|
10141
|
+
};
|
|
10142
|
+
};
|
|
10143
|
+
amount?: string;
|
|
10144
|
+
amountFormatted?: string;
|
|
10145
|
+
amountUsd?: string;
|
|
10146
|
+
minimumAmount?: string;
|
|
10147
|
+
};
|
|
10148
|
+
outputCurrency?: {
|
|
10149
|
+
currency?: {
|
|
10150
|
+
chainId?: number;
|
|
10151
|
+
address?: string;
|
|
10152
|
+
symbol?: string;
|
|
10153
|
+
name?: string;
|
|
10154
|
+
decimals?: number;
|
|
10155
|
+
metadata?: {
|
|
10156
|
+
logoURI?: string;
|
|
10157
|
+
verified?: boolean;
|
|
10158
|
+
isNative?: boolean;
|
|
10159
|
+
};
|
|
10160
|
+
};
|
|
10161
|
+
amount?: string;
|
|
10162
|
+
amountFormatted?: string;
|
|
10163
|
+
amountUsd?: string;
|
|
10164
|
+
minimumAmount?: string;
|
|
10165
|
+
};
|
|
10166
|
+
} | null;
|
|
9258
10167
|
refundCurrencyData?: {
|
|
9259
10168
|
currency?: {
|
|
9260
10169
|
chainId?: number;
|
|
@@ -9369,6 +10278,8 @@ export interface paths {
|
|
|
9369
10278
|
updatedAt?: string;
|
|
9370
10279
|
})[];
|
|
9371
10280
|
continuation?: string;
|
|
10281
|
+
/** @description Total count of requests matching the given filters. Only present when `includeTotal` was true. */
|
|
10282
|
+
total?: number;
|
|
9372
10283
|
};
|
|
9373
10284
|
};
|
|
9374
10285
|
};
|
|
@@ -10285,6 +11196,7 @@ export interface paths {
|
|
|
10285
11196
|
message?: string;
|
|
10286
11197
|
isBlocked?: boolean;
|
|
10287
11198
|
isTrmBlocked?: boolean | null;
|
|
11199
|
+
isVasp?: boolean | null;
|
|
10288
11200
|
trmBlockReasons?: ({
|
|
10289
11201
|
category?: string;
|
|
10290
11202
|
/** @enum {string} */
|
|
@@ -10294,6 +11206,13 @@ export interface paths {
|
|
|
10294
11206
|
})[];
|
|
10295
11207
|
isHackBountyBlocked?: boolean;
|
|
10296
11208
|
isChainalysisBlocked?: boolean;
|
|
11209
|
+
isOstiumBlocked?: boolean;
|
|
11210
|
+
hermod?: {
|
|
11211
|
+
isBlocked?: boolean;
|
|
11212
|
+
threatLevel?: number | null;
|
|
11213
|
+
hitUuid?: string | null;
|
|
11214
|
+
sanctioned?: string | null;
|
|
11215
|
+
};
|
|
10297
11216
|
override?: string;
|
|
10298
11217
|
reason?: string | null;
|
|
10299
11218
|
};
|
|
@@ -10379,6 +11298,45 @@ export interface paths {
|
|
|
10379
11298
|
};
|
|
10380
11299
|
};
|
|
10381
11300
|
};
|
|
11301
|
+
"/metrics/usage": {
|
|
11302
|
+
/** @description Get API call counts for the authenticated API key, grouped by endpoint, status code, and error code. */
|
|
11303
|
+
get: {
|
|
11304
|
+
parameters: {
|
|
11305
|
+
query?: {
|
|
11306
|
+
/** @description Time bucket granularity. minutely defaults to last 24h, hourly to last 7d, daily to last 14d. */
|
|
11307
|
+
granularity?: "minutely" | "hourly" | "daily";
|
|
11308
|
+
/** @description Start of the query window as a Unix timestamp (seconds). Defaults based on granularity. */
|
|
11309
|
+
startTimestamp?: number;
|
|
11310
|
+
/** @description End of the query window as a Unix timestamp (seconds). Defaults to now. */
|
|
11311
|
+
endTimestamp?: number;
|
|
11312
|
+
/** @description Filter metrics by API key. Accepts a single value or a comma-separated list (e.g. key1,key2) — results include metrics matching any of the supplied keys. Maximum 50 keys. */
|
|
11313
|
+
apiKey?: string;
|
|
11314
|
+
};
|
|
11315
|
+
header?: {
|
|
11316
|
+
/** @description Integrator API key. */
|
|
11317
|
+
"x-api-key"?: string;
|
|
11318
|
+
};
|
|
11319
|
+
};
|
|
11320
|
+
responses: {
|
|
11321
|
+
/** @description Default Response */
|
|
11322
|
+
200: {
|
|
11323
|
+
content: {
|
|
11324
|
+
"application/json": {
|
|
11325
|
+
metrics?: {
|
|
11326
|
+
apiKey?: string;
|
|
11327
|
+
timestamp?: string;
|
|
11328
|
+
endpoint?: string;
|
|
11329
|
+
statusCode?: number;
|
|
11330
|
+
/** @description Only present on rows where statusCode is 400. Contains the machine-readable error code (e.g. AMOUNT_TOO_LOW). */
|
|
11331
|
+
errorCode?: string;
|
|
11332
|
+
count?: number;
|
|
11333
|
+
}[];
|
|
11334
|
+
};
|
|
11335
|
+
};
|
|
11336
|
+
};
|
|
11337
|
+
};
|
|
11338
|
+
};
|
|
11339
|
+
};
|
|
10382
11340
|
}
|
|
10383
11341
|
export type webhooks = Record<string, never>;
|
|
10384
11342
|
export interface components {
|