@rhinestone/sdk 2.8.0 → 2.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/api/account.d.ts +2 -2
- package/dist/src/api/account.d.ts.map +1 -1
- package/dist/src/api/account.js +11 -2
- package/dist/src/api/compose.d.ts.map +1 -1
- package/dist/src/api/compose.js +3 -4
- package/dist/src/api/sdk.d.ts +1 -0
- package/dist/src/api/sdk.d.ts.map +1 -1
- package/dist/src/api/sdk.js +2 -0
- package/dist/src/clients/orchestrator/client.js +1 -1
- package/dist/src/clients/orchestrator/mappers.d.ts.map +1 -1
- package/dist/src/clients/orchestrator/mappers.js +54 -22
- package/dist/src/clients/orchestrator/public.d.ts +154 -2
- package/dist/src/clients/orchestrator/public.d.ts.map +1 -1
- package/dist/src/clients/orchestrator/types.d.ts +5 -1
- package/dist/src/clients/orchestrator/types.d.ts.map +1 -1
- package/dist/src/clients/orchestrator/wire.d.ts +10 -1
- package/dist/src/clients/orchestrator/wire.d.ts.map +1 -1
- package/dist/src/clients/orchestrator/wire.gen.d.ts +416 -44
- package/dist/src/clients/orchestrator/wire.gen.d.ts.map +1 -1
- package/dist/src/config/account.d.ts +19 -1
- package/dist/src/config/account.d.ts.map +1 -1
- package/dist/src/config/input.d.ts +2 -0
- package/dist/src/config/input.d.ts.map +1 -1
- package/dist/src/config/legacy.d.ts +2 -0
- package/dist/src/config/legacy.d.ts.map +1 -1
- package/dist/src/config/legacy.js +2 -0
- package/dist/src/config/resolve.d.ts.map +1 -1
- package/dist/src/config/resolve.js +4 -0
- package/dist/src/config/resolved.d.ts +2 -0
- package/dist/src/config/resolved.d.ts.map +1 -1
- package/dist/src/errors/index.d.ts +2 -1
- package/dist/src/errors/index.d.ts.map +1 -1
- package/dist/src/errors/index.js +4 -1
- package/dist/src/hypercore/errors.d.ts +37 -0
- package/dist/src/hypercore/errors.d.ts.map +1 -0
- package/dist/src/hypercore/errors.js +54 -0
- package/dist/src/hypercore/index.d.ts +4 -0
- package/dist/src/hypercore/index.d.ts.map +1 -0
- package/dist/src/hypercore/index.js +2 -0
- package/dist/src/hypercore/market.d.ts +110 -0
- package/dist/src/hypercore/market.d.ts.map +1 -0
- package/dist/src/hypercore/market.js +120 -0
- package/dist/src/hypercore/orders.d.ts +26 -0
- package/dist/src/hypercore/orders.d.ts.map +1 -0
- package/dist/src/hypercore/orders.js +148 -0
- package/dist/src/hypercore/resolve.d.ts +10 -0
- package/dist/src/hypercore/resolve.d.ts.map +1 -0
- package/dist/src/hypercore/resolve.js +30 -0
- package/dist/src/hypercore/types.d.ts +80 -0
- package/dist/src/hypercore/types.d.ts.map +1 -0
- package/dist/src/hypercore/types.js +8 -0
- package/dist/src/index.d.ts +2 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/signing/typed-data.d.ts +6 -0
- package/dist/src/signing/typed-data.d.ts.map +1 -1
- package/dist/src/signing/typed-data.js +13 -0
- package/dist/src/transactions/intents/origin-chain.d.ts +35 -0
- package/dist/src/transactions/intents/origin-chain.d.ts.map +1 -0
- package/dist/src/transactions/intents/origin-chain.js +89 -0
- package/dist/src/transactions/intents/prepare.d.ts.map +1 -1
- package/dist/src/transactions/intents/prepare.js +2 -1
- package/dist/src/transactions/intents/session-signing.d.ts.map +1 -1
- package/dist/src/transactions/intents/session-signing.js +8 -0
- package/dist/src/transactions/intents/sign-transaction.d.ts.map +1 -1
- package/dist/src/transactions/intents/sign-transaction.js +9 -1
- package/package.json +5 -1
|
@@ -848,8 +848,32 @@ export interface operations {
|
|
|
848
848
|
* @example 1633493192
|
|
849
849
|
*/
|
|
850
850
|
timestamp?: number;
|
|
851
|
+
/**
|
|
852
|
+
* @description Why the operation failed (present only when FAILED)
|
|
853
|
+
* @example BRIDGE_TIMEOUT
|
|
854
|
+
*/
|
|
855
|
+
failureReason?: string;
|
|
856
|
+
/**
|
|
857
|
+
* @description This operation's transaction spends the account's own tokens. Absent means it moves none of them (a destination fill, or a tokenless intent). Read it together with the operation status: a FAILED intent none of whose debiting operations reached COMPLETED never took the account's funds. Per-operation rather than per-intent because a multi-origin intent has several claims and they can differ.
|
|
858
|
+
* @example true
|
|
859
|
+
* @enum {boolean}
|
|
860
|
+
*/
|
|
861
|
+
debitsAccount?: true;
|
|
851
862
|
}[];
|
|
852
863
|
}[];
|
|
864
|
+
/** @description Bridge refunds observed for this intent — a settlement layer returned the funds to the account instead of delivering them. Not operations: Rhinestone neither built nor broadcast these transactions, and a refund never makes the intent succeed. Omitted when none are known, which is every delivered intent and also a failed one whose refund we have not (or not yet) observed — so its absence is not evidence that funds were kept. */
|
|
865
|
+
refunds?: {
|
|
866
|
+
/**
|
|
867
|
+
* @description Chain the refund landed on
|
|
868
|
+
* @example 42161
|
|
869
|
+
*/
|
|
870
|
+
chain: number;
|
|
871
|
+
/**
|
|
872
|
+
* @description Refund transaction hash, in the chain-native form (EVM hex, Solana base58, Tron hex) — interpret it against `chain`.
|
|
873
|
+
* @example 0x00ab46cc4d1e4b5d5f6a9a2b1c0d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d
|
|
874
|
+
*/
|
|
875
|
+
txHash: string;
|
|
876
|
+
}[];
|
|
853
877
|
/** @description Extended intent details, returned only when `full=true` */
|
|
854
878
|
details?: {
|
|
855
879
|
/**
|
|
@@ -882,7 +906,7 @@ export interface operations {
|
|
|
882
906
|
* @example ACROSS
|
|
883
907
|
* @enum {string|null}
|
|
884
908
|
*/
|
|
885
|
-
settlementLayer: 'INTENT_EXECUTOR' | 'SAME_CHAIN' | 'ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP' | null;
|
|
909
|
+
settlementLayer: 'INTENT_EXECUTOR' | 'SAME_CHAIN' | 'ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP' | 'LZ' | null;
|
|
886
910
|
/** @description Source (claim) legs */
|
|
887
911
|
source: {
|
|
888
912
|
/**
|
|
@@ -893,7 +917,7 @@ export interface operations {
|
|
|
893
917
|
/** @description All tokens moved on this leg */
|
|
894
918
|
tokens: {
|
|
895
919
|
/**
|
|
896
|
-
* @description Token address
|
|
920
|
+
* @description Token address, in the format its chain uses (EVM hex, non-EVM base58)
|
|
897
921
|
* @example 0x0b2c639c533813f4aa9d7837caf62653d097ff85
|
|
898
922
|
*/
|
|
899
923
|
token: string;
|
|
@@ -940,7 +964,7 @@ export interface operations {
|
|
|
940
964
|
/** @description All tokens moved on this leg */
|
|
941
965
|
tokens: {
|
|
942
966
|
/**
|
|
943
|
-
* @description Token address
|
|
967
|
+
* @description Token address, in the format its chain uses (EVM hex, non-EVM base58)
|
|
944
968
|
* @example 0x0b2c639c533813f4aa9d7837caf62653d097ff85
|
|
945
969
|
*/
|
|
946
970
|
token: string;
|
|
@@ -1006,7 +1030,7 @@ export interface operations {
|
|
|
1006
1030
|
*/
|
|
1007
1031
|
data: string;
|
|
1008
1032
|
}[];
|
|
1009
|
-
/** @description Cost summary from the recorded fee sponsorship. Amounts are
|
|
1033
|
+
/** @description Cost summary from the recorded fee sponsorship. Amounts are integer micro-USD; omitted when no sponsorship row exists. */
|
|
1010
1034
|
cost: {
|
|
1011
1035
|
/**
|
|
1012
1036
|
* @description Whether gas/fees were sponsored for this intent
|
|
@@ -1014,15 +1038,20 @@ export interface operations {
|
|
|
1014
1038
|
*/
|
|
1015
1039
|
sponsored: boolean;
|
|
1016
1040
|
/**
|
|
1017
|
-
* @description Sponsored value in
|
|
1041
|
+
* @description Sponsored value actually charged, in integer micro-USD (1 USD = 1,000,000 units). Once the intent executes this is reconciled from the receipt (planned gas replaced by executed), so it matches the sponsorship balance and the usage/billing reads rather than the amount reserved at quote time.
|
|
1018
1042
|
* @example 210000
|
|
1019
1043
|
*/
|
|
1020
1044
|
sponsoredValue?: string;
|
|
1021
1045
|
/**
|
|
1022
|
-
* @description
|
|
1046
|
+
* @description Rhinestone-owed slice of the sponsor charge, in integer micro-USD (1 USD = 1,000,000 units): the sponsor surcharge plus a sponsored protocol fee (`sponsorSettings.protocolFees`) where one applies.
|
|
1023
1047
|
* @example 10000
|
|
1024
1048
|
*/
|
|
1025
1049
|
protocolFee?: string;
|
|
1050
|
+
/**
|
|
1051
|
+
* @description Rhinestone's surcharge on the sponsored relayer coverage, in integer micro-USD — the pure surcharge slice of `protocolFee` and reconciled with it, as `sponsorSurcharge` on a quote. Omitted where the charge was recorded without the split, which is never inferred by subtraction.
|
|
1052
|
+
* @example 10000
|
|
1053
|
+
*/
|
|
1054
|
+
sponsorSurcharge?: string;
|
|
1026
1055
|
};
|
|
1027
1056
|
};
|
|
1028
1057
|
};
|
|
@@ -2222,10 +2251,10 @@ export interface operations {
|
|
|
2222
2251
|
notarizedClaimSig: string;
|
|
2223
2252
|
})[];
|
|
2224
2253
|
/**
|
|
2225
|
-
* @description Destination (target chain) signature
|
|
2254
|
+
* @description Destination (target chain) signature. Omit only when the route carried no `signData.destination`.
|
|
2226
2255
|
* @example 0x...
|
|
2227
2256
|
*/
|
|
2228
|
-
destination
|
|
2257
|
+
destination?: string;
|
|
2229
2258
|
/**
|
|
2230
2259
|
* @description Target execution signature (smart sessions only; omit for EOA)
|
|
2231
2260
|
* @example 0x...
|
|
@@ -2746,10 +2775,10 @@ export interface operations {
|
|
|
2746
2775
|
* ]
|
|
2747
2776
|
* }
|
|
2748
2777
|
*/
|
|
2749
|
-
settlementLayers?: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP')[] | {
|
|
2750
|
-
include: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP')[];
|
|
2778
|
+
settlementLayers?: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP' | 'LZ')[] | {
|
|
2779
|
+
include: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP' | 'LZ')[];
|
|
2751
2780
|
} | {
|
|
2752
|
-
exclude: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP')[];
|
|
2781
|
+
exclude: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP' | 'LZ')[];
|
|
2753
2782
|
};
|
|
2754
2783
|
};
|
|
2755
2784
|
};
|
|
@@ -3246,7 +3275,7 @@ export interface operations {
|
|
|
3246
3275
|
/** @description Account access list specifying which CAIP-2 chains and tokens an account may access */
|
|
3247
3276
|
accountAccessList?: {
|
|
3248
3277
|
chainIds?: string[];
|
|
3249
|
-
tokens?: (string | ('ETH' | 'USDC' | 'WETH' | 'USDT' | 'USDT0' | 'BNB' | 'WBNB' | 'XDAI' | 'WXDAI' | 'POL' | 'WPOL' | 'MON' | 'WMON' | 'S' | 'WS' | 'HYPE' | 'WHYPE' | 'USDG' | 'XPL' | 'WXPL' | 'AVAX' | 'WAVAX' | 'MockUSD' | 'ensUSDC' | 'TRX' | 'WTRX' | 'SOL' | 'WSOL'))[];
|
|
3278
|
+
tokens?: (string | ('ETH' | 'USDC' | 'WETH' | 'USDT' | 'USDT0' | 'BNB' | 'WBNB' | 'XDAI' | 'WXDAI' | 'POL' | 'WPOL' | 'MON' | 'WMON' | 'S' | 'WS' | 'OKB' | 'WOKB' | 'HYPE' | 'WHYPE' | 'USDG' | 'XPL' | 'WXPL' | 'AVAX' | 'WAVAX' | 'MockUSD' | 'XLM' | 'ensUSDC' | 'TRX' | 'WTRX' | 'SOL' | 'WSOL'))[];
|
|
3250
3279
|
/**
|
|
3251
3280
|
* @description Tokens keyed by CAIP-2 chain ID.
|
|
3252
3281
|
* @example {
|
|
@@ -3256,7 +3285,7 @@ export interface operations {
|
|
|
3256
3285
|
* }
|
|
3257
3286
|
*/
|
|
3258
3287
|
chainTokens?: {
|
|
3259
|
-
[key: string]: (string | ('ETH' | 'USDC' | 'WETH' | 'USDT' | 'USDT0' | 'BNB' | 'WBNB' | 'XDAI' | 'WXDAI' | 'POL' | 'WPOL' | 'MON' | 'WMON' | 'S' | 'WS' | 'HYPE' | 'WHYPE' | 'USDG' | 'XPL' | 'WXPL' | 'AVAX' | 'WAVAX' | 'MockUSD' | 'ensUSDC' | 'TRX' | 'WTRX' | 'SOL' | 'WSOL'))[];
|
|
3288
|
+
[key: string]: (string | ('ETH' | 'USDC' | 'WETH' | 'USDT' | 'USDT0' | 'BNB' | 'WBNB' | 'XDAI' | 'WXDAI' | 'POL' | 'WPOL' | 'MON' | 'WMON' | 'S' | 'WS' | 'OKB' | 'WOKB' | 'HYPE' | 'WHYPE' | 'USDG' | 'XPL' | 'WXPL' | 'AVAX' | 'WAVAX' | 'MockUSD' | 'XLM' | 'ensUSDC' | 'TRX' | 'WTRX' | 'SOL' | 'WSOL'))[];
|
|
3260
3289
|
};
|
|
3261
3290
|
/**
|
|
3262
3291
|
* @description Per-token maximum input amounts keyed by CAIP-2 chain ID.
|
|
@@ -3273,7 +3302,7 @@ export interface operations {
|
|
|
3273
3302
|
};
|
|
3274
3303
|
exclude?: {
|
|
3275
3304
|
chainIds?: string[];
|
|
3276
|
-
tokens?: (string | ('ETH' | 'USDC' | 'WETH' | 'USDT' | 'USDT0' | 'BNB' | 'WBNB' | 'XDAI' | 'WXDAI' | 'POL' | 'WPOL' | 'MON' | 'WMON' | 'S' | 'WS' | 'HYPE' | 'WHYPE' | 'USDG' | 'XPL' | 'WXPL' | 'AVAX' | 'WAVAX' | 'MockUSD' | 'ensUSDC' | 'TRX' | 'WTRX' | 'SOL' | 'WSOL'))[];
|
|
3305
|
+
tokens?: (string | ('ETH' | 'USDC' | 'WETH' | 'USDT' | 'USDT0' | 'BNB' | 'WBNB' | 'XDAI' | 'WXDAI' | 'POL' | 'WPOL' | 'MON' | 'WMON' | 'S' | 'WS' | 'OKB' | 'WOKB' | 'HYPE' | 'WHYPE' | 'USDG' | 'XPL' | 'WXPL' | 'AVAX' | 'WAVAX' | 'MockUSD' | 'XLM' | 'ensUSDC' | 'TRX' | 'WTRX' | 'SOL' | 'WSOL'))[];
|
|
3277
3306
|
/**
|
|
3278
3307
|
* @description Tokens keyed by CAIP-2 chain ID.
|
|
3279
3308
|
* @example {
|
|
@@ -3283,7 +3312,7 @@ export interface operations {
|
|
|
3283
3312
|
* }
|
|
3284
3313
|
*/
|
|
3285
3314
|
chainTokens?: {
|
|
3286
|
-
[key: string]: (string | ('ETH' | 'USDC' | 'WETH' | 'USDT' | 'USDT0' | 'BNB' | 'WBNB' | 'XDAI' | 'WXDAI' | 'POL' | 'WPOL' | 'MON' | 'WMON' | 'S' | 'WS' | 'HYPE' | 'WHYPE' | 'USDG' | 'XPL' | 'WXPL' | 'AVAX' | 'WAVAX' | 'MockUSD' | 'ensUSDC' | 'TRX' | 'WTRX' | 'SOL' | 'WSOL'))[];
|
|
3315
|
+
[key: string]: (string | ('ETH' | 'USDC' | 'WETH' | 'USDT' | 'USDT0' | 'BNB' | 'WBNB' | 'XDAI' | 'WXDAI' | 'POL' | 'WPOL' | 'MON' | 'WMON' | 'S' | 'WS' | 'OKB' | 'WOKB' | 'HYPE' | 'WHYPE' | 'USDG' | 'XPL' | 'WXPL' | 'AVAX' | 'WAVAX' | 'MockUSD' | 'XLM' | 'ensUSDC' | 'TRX' | 'WTRX' | 'SOL' | 'WSOL'))[];
|
|
3287
3316
|
};
|
|
3288
3317
|
};
|
|
3289
3318
|
};
|
|
@@ -3349,10 +3378,23 @@ export interface operations {
|
|
|
3349
3378
|
* ]
|
|
3350
3379
|
* }
|
|
3351
3380
|
*/
|
|
3352
|
-
settlementLayers?: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP')[] | {
|
|
3353
|
-
include: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP')[];
|
|
3381
|
+
settlementLayers?: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP' | 'LZ')[] | {
|
|
3382
|
+
include: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP' | 'LZ')[];
|
|
3383
|
+
} | {
|
|
3384
|
+
exclude: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP' | 'LZ')[];
|
|
3385
|
+
};
|
|
3386
|
+
/**
|
|
3387
|
+
* @description Which swap quoters the orchestrator may source swap routes from. `{ include: [...] }` (allow-list) or `{ exclude: [...] }` (deny-list, inverted against the full quoter set); a bare array means `include`. Use this to keep a swap on the venue a smart-session policy is scoped to. Default unset = every quoter the chain supports.
|
|
3388
|
+
* @example {
|
|
3389
|
+
* "include": [
|
|
3390
|
+
* "0x"
|
|
3391
|
+
* ]
|
|
3392
|
+
* }
|
|
3393
|
+
*/
|
|
3394
|
+
quoters?: ('1inch' | '0x' | 'velora' | 'kyberswap' | 'fynd' | 'fynd-hosted' | 'bebop' | 'relay')[] | {
|
|
3395
|
+
include: ('1inch' | '0x' | 'velora' | 'kyberswap' | 'fynd' | 'fynd-hosted' | 'bebop' | 'relay')[];
|
|
3354
3396
|
} | {
|
|
3355
|
-
exclude: ('
|
|
3397
|
+
exclude: ('1inch' | '0x' | 'velora' | 'kyberswap' | 'fynd' | 'fynd-hosted' | 'bebop' | 'relay')[];
|
|
3356
3398
|
};
|
|
3357
3399
|
/**
|
|
3358
3400
|
* @description Sponsor settings for the intent
|
|
@@ -3436,6 +3478,273 @@ export interface operations {
|
|
|
3436
3478
|
* @example 1893456000
|
|
3437
3479
|
*/
|
|
3438
3480
|
customDeadline?: number;
|
|
3481
|
+
hyperCore?: {
|
|
3482
|
+
/**
|
|
3483
|
+
* @description The Hyperliquid action to authorise. An action that needs collateral (opening a position) must be paired with `tokenRequests` that deliver it; one that does not (a reduce-only close, a cancel, a leverage change) rides a tokenless intent.
|
|
3484
|
+
*
|
|
3485
|
+
* One action per intent: an agent authorises exactly one, and registering a second evicts the first, so an intent submitted while another is in flight for the same account is refused.
|
|
3486
|
+
*/
|
|
3487
|
+
action: {
|
|
3488
|
+
/** @enum {string} */
|
|
3489
|
+
type: 'order';
|
|
3490
|
+
orders: {
|
|
3491
|
+
/**
|
|
3492
|
+
* @description Asset index. Perps use the index in the `meta` universe; spot uses `10000 + index` from `spotMeta`. This is an INDEX, not a ticker — resolve it from the info endpoint, and note that an index built against the wrong universe places a valid order in the wrong market.
|
|
3493
|
+
* @example 0
|
|
3494
|
+
*/
|
|
3495
|
+
a: number;
|
|
3496
|
+
/**
|
|
3497
|
+
* @description Buy (`true`) or sell (`false`).
|
|
3498
|
+
* @example true
|
|
3499
|
+
*/
|
|
3500
|
+
b: boolean;
|
|
3501
|
+
/**
|
|
3502
|
+
* @description Limit price. Must satisfy Hyperliquid's tick rules — at most 5 significant figures and at most `6 - szDecimals` decimals for a perp — and is refused there, not here.
|
|
3503
|
+
*
|
|
3504
|
+
* This price is fixed when you sign, and an intent that bridges to HyperCore takes ~30s to deliver. Price it to still cross after that move, or the order is refused with your funds already delivered.
|
|
3505
|
+
* @example 64250.5
|
|
3506
|
+
*/
|
|
3507
|
+
p: string;
|
|
3508
|
+
/**
|
|
3509
|
+
* @description Size in units of the asset, to at most the asset's `szDecimals`. Hyperliquid refuses an order worth under ~$10.
|
|
3510
|
+
* @example 0.0002
|
|
3511
|
+
*/
|
|
3512
|
+
s: string;
|
|
3513
|
+
/**
|
|
3514
|
+
* @description Reduce-only. `true` is how a position is CLOSED — pair it with a tokenless intent, since closing needs no delivered collateral.
|
|
3515
|
+
* @example false
|
|
3516
|
+
*/
|
|
3517
|
+
r: boolean;
|
|
3518
|
+
/** @description Either `{ limit: { tif } }` or `{ trigger: { isMarket, triggerPx, tpsl } }`. */
|
|
3519
|
+
t: {
|
|
3520
|
+
limit: {
|
|
3521
|
+
/**
|
|
3522
|
+
* @description Time in force. `Ioc` fills what it can and cancels the rest, which is how a market order is expressed here — there is no market order type. `Alo` is post-only. `Gtc` rests on the book.
|
|
3523
|
+
*
|
|
3524
|
+
* Prefer `Ioc` for anything an intent delivers funds for: a resting order leaves the account holding USDC and no position, and the agent that could have cancelled it is already spent.
|
|
3525
|
+
* @example Ioc
|
|
3526
|
+
* @enum {string}
|
|
3527
|
+
*/
|
|
3528
|
+
tif: 'Alo' | 'Ioc' | 'Gtc';
|
|
3529
|
+
};
|
|
3530
|
+
} | {
|
|
3531
|
+
trigger: {
|
|
3532
|
+
isMarket: boolean;
|
|
3533
|
+
triggerPx: string;
|
|
3534
|
+
/**
|
|
3535
|
+
* @description Take-profit or stop-loss.
|
|
3536
|
+
* @example sl
|
|
3537
|
+
* @enum {string}
|
|
3538
|
+
*/
|
|
3539
|
+
tpsl: 'tp' | 'sl';
|
|
3540
|
+
};
|
|
3541
|
+
};
|
|
3542
|
+
/**
|
|
3543
|
+
* @description Optional client order id — 128-bit hex. Your handle on the order afterwards: the exchange echoes it back, so it is the only way to correlate a fill with the intent that placed it without polling by asset.
|
|
3544
|
+
* @example 0x1234567890abcdef1234567890abcdef
|
|
3545
|
+
*/
|
|
3546
|
+
c?: string;
|
|
3547
|
+
}[];
|
|
3548
|
+
/**
|
|
3549
|
+
* @description `na` for a plain order. The TP/SL groupings attach the orders as a bracket around a position.
|
|
3550
|
+
* @example na
|
|
3551
|
+
* @enum {string}
|
|
3552
|
+
*/
|
|
3553
|
+
grouping: 'na' | 'normalTpsl' | 'positionTpsl';
|
|
3554
|
+
builder?: {
|
|
3555
|
+
/** @description Address receiving the builder fee. */
|
|
3556
|
+
b: string;
|
|
3557
|
+
/**
|
|
3558
|
+
* @description Builder fee in TENTHS of a basis point — `10` is 1bp of order notional.
|
|
3559
|
+
* @example 10
|
|
3560
|
+
*/
|
|
3561
|
+
f: number;
|
|
3562
|
+
};
|
|
3563
|
+
} | {
|
|
3564
|
+
/** @enum {string} */
|
|
3565
|
+
type: 'cancel';
|
|
3566
|
+
cancels: {
|
|
3567
|
+
/** @description Asset index. */
|
|
3568
|
+
a: number;
|
|
3569
|
+
/** @description Order id. */
|
|
3570
|
+
o: number;
|
|
3571
|
+
}[];
|
|
3572
|
+
/** @description Fast cancel. */
|
|
3573
|
+
f?: boolean;
|
|
3574
|
+
} | {
|
|
3575
|
+
/** @enum {string} */
|
|
3576
|
+
type: 'cancelByCloid';
|
|
3577
|
+
cancels: {
|
|
3578
|
+
asset: number;
|
|
3579
|
+
/**
|
|
3580
|
+
* @description Optional client order id — 128-bit hex. Your handle on the order afterwards: the exchange echoes it back, so it is the only way to correlate a fill with the intent that placed it without polling by asset.
|
|
3581
|
+
* @example 0x1234567890abcdef1234567890abcdef
|
|
3582
|
+
*/
|
|
3583
|
+
cloid: string;
|
|
3584
|
+
}[];
|
|
3585
|
+
f?: boolean;
|
|
3586
|
+
} | {
|
|
3587
|
+
/** @enum {string} */
|
|
3588
|
+
type: 'modify';
|
|
3589
|
+
oid: number | string;
|
|
3590
|
+
order: {
|
|
3591
|
+
/**
|
|
3592
|
+
* @description Asset index. Perps use the index in the `meta` universe; spot uses `10000 + index` from `spotMeta`. This is an INDEX, not a ticker — resolve it from the info endpoint, and note that an index built against the wrong universe places a valid order in the wrong market.
|
|
3593
|
+
* @example 0
|
|
3594
|
+
*/
|
|
3595
|
+
a: number;
|
|
3596
|
+
/**
|
|
3597
|
+
* @description Buy (`true`) or sell (`false`).
|
|
3598
|
+
* @example true
|
|
3599
|
+
*/
|
|
3600
|
+
b: boolean;
|
|
3601
|
+
/**
|
|
3602
|
+
* @description Limit price. Must satisfy Hyperliquid's tick rules — at most 5 significant figures and at most `6 - szDecimals` decimals for a perp — and is refused there, not here.
|
|
3603
|
+
*
|
|
3604
|
+
* This price is fixed when you sign, and an intent that bridges to HyperCore takes ~30s to deliver. Price it to still cross after that move, or the order is refused with your funds already delivered.
|
|
3605
|
+
* @example 64250.5
|
|
3606
|
+
*/
|
|
3607
|
+
p: string;
|
|
3608
|
+
/**
|
|
3609
|
+
* @description Size in units of the asset, to at most the asset's `szDecimals`. Hyperliquid refuses an order worth under ~$10.
|
|
3610
|
+
* @example 0.0002
|
|
3611
|
+
*/
|
|
3612
|
+
s: string;
|
|
3613
|
+
/**
|
|
3614
|
+
* @description Reduce-only. `true` is how a position is CLOSED — pair it with a tokenless intent, since closing needs no delivered collateral.
|
|
3615
|
+
* @example false
|
|
3616
|
+
*/
|
|
3617
|
+
r: boolean;
|
|
3618
|
+
/** @description Either `{ limit: { tif } }` or `{ trigger: { isMarket, triggerPx, tpsl } }`. */
|
|
3619
|
+
t: {
|
|
3620
|
+
limit: {
|
|
3621
|
+
/**
|
|
3622
|
+
* @description Time in force. `Ioc` fills what it can and cancels the rest, which is how a market order is expressed here — there is no market order type. `Alo` is post-only. `Gtc` rests on the book.
|
|
3623
|
+
*
|
|
3624
|
+
* Prefer `Ioc` for anything an intent delivers funds for: a resting order leaves the account holding USDC and no position, and the agent that could have cancelled it is already spent.
|
|
3625
|
+
* @example Ioc
|
|
3626
|
+
* @enum {string}
|
|
3627
|
+
*/
|
|
3628
|
+
tif: 'Alo' | 'Ioc' | 'Gtc';
|
|
3629
|
+
};
|
|
3630
|
+
} | {
|
|
3631
|
+
trigger: {
|
|
3632
|
+
isMarket: boolean;
|
|
3633
|
+
triggerPx: string;
|
|
3634
|
+
/**
|
|
3635
|
+
* @description Take-profit or stop-loss.
|
|
3636
|
+
* @example sl
|
|
3637
|
+
* @enum {string}
|
|
3638
|
+
*/
|
|
3639
|
+
tpsl: 'tp' | 'sl';
|
|
3640
|
+
};
|
|
3641
|
+
};
|
|
3642
|
+
/**
|
|
3643
|
+
* @description Optional client order id — 128-bit hex. Your handle on the order afterwards: the exchange echoes it back, so it is the only way to correlate a fill with the intent that placed it without polling by asset.
|
|
3644
|
+
* @example 0x1234567890abcdef1234567890abcdef
|
|
3645
|
+
*/
|
|
3646
|
+
c?: string;
|
|
3647
|
+
};
|
|
3648
|
+
/**
|
|
3649
|
+
* @description Place the replacement even if the cancel failed. Omit it entirely for the default — Hyperliquid rejects an action hashed with `a: false`, so `false` is not a legal value.
|
|
3650
|
+
* @enum {boolean}
|
|
3651
|
+
*/
|
|
3652
|
+
a?: true;
|
|
3653
|
+
} | {
|
|
3654
|
+
/** @enum {string} */
|
|
3655
|
+
type: 'batchModify';
|
|
3656
|
+
modifies: {
|
|
3657
|
+
oid: number | string;
|
|
3658
|
+
order: {
|
|
3659
|
+
/**
|
|
3660
|
+
* @description Asset index. Perps use the index in the `meta` universe; spot uses `10000 + index` from `spotMeta`. This is an INDEX, not a ticker — resolve it from the info endpoint, and note that an index built against the wrong universe places a valid order in the wrong market.
|
|
3661
|
+
* @example 0
|
|
3662
|
+
*/
|
|
3663
|
+
a: number;
|
|
3664
|
+
/**
|
|
3665
|
+
* @description Buy (`true`) or sell (`false`).
|
|
3666
|
+
* @example true
|
|
3667
|
+
*/
|
|
3668
|
+
b: boolean;
|
|
3669
|
+
/**
|
|
3670
|
+
* @description Limit price. Must satisfy Hyperliquid's tick rules — at most 5 significant figures and at most `6 - szDecimals` decimals for a perp — and is refused there, not here.
|
|
3671
|
+
*
|
|
3672
|
+
* This price is fixed when you sign, and an intent that bridges to HyperCore takes ~30s to deliver. Price it to still cross after that move, or the order is refused with your funds already delivered.
|
|
3673
|
+
* @example 64250.5
|
|
3674
|
+
*/
|
|
3675
|
+
p: string;
|
|
3676
|
+
/**
|
|
3677
|
+
* @description Size in units of the asset, to at most the asset's `szDecimals`. Hyperliquid refuses an order worth under ~$10.
|
|
3678
|
+
* @example 0.0002
|
|
3679
|
+
*/
|
|
3680
|
+
s: string;
|
|
3681
|
+
/**
|
|
3682
|
+
* @description Reduce-only. `true` is how a position is CLOSED — pair it with a tokenless intent, since closing needs no delivered collateral.
|
|
3683
|
+
* @example false
|
|
3684
|
+
*/
|
|
3685
|
+
r: boolean;
|
|
3686
|
+
/** @description Either `{ limit: { tif } }` or `{ trigger: { isMarket, triggerPx, tpsl } }`. */
|
|
3687
|
+
t: {
|
|
3688
|
+
limit: {
|
|
3689
|
+
/**
|
|
3690
|
+
* @description Time in force. `Ioc` fills what it can and cancels the rest, which is how a market order is expressed here — there is no market order type. `Alo` is post-only. `Gtc` rests on the book.
|
|
3691
|
+
*
|
|
3692
|
+
* Prefer `Ioc` for anything an intent delivers funds for: a resting order leaves the account holding USDC and no position, and the agent that could have cancelled it is already spent.
|
|
3693
|
+
* @example Ioc
|
|
3694
|
+
* @enum {string}
|
|
3695
|
+
*/
|
|
3696
|
+
tif: 'Alo' | 'Ioc' | 'Gtc';
|
|
3697
|
+
};
|
|
3698
|
+
} | {
|
|
3699
|
+
trigger: {
|
|
3700
|
+
isMarket: boolean;
|
|
3701
|
+
triggerPx: string;
|
|
3702
|
+
/**
|
|
3703
|
+
* @description Take-profit or stop-loss.
|
|
3704
|
+
* @example sl
|
|
3705
|
+
* @enum {string}
|
|
3706
|
+
*/
|
|
3707
|
+
tpsl: 'tp' | 'sl';
|
|
3708
|
+
};
|
|
3709
|
+
};
|
|
3710
|
+
/**
|
|
3711
|
+
* @description Optional client order id — 128-bit hex. Your handle on the order afterwards: the exchange echoes it back, so it is the only way to correlate a fill with the intent that placed it without polling by asset.
|
|
3712
|
+
* @example 0x1234567890abcdef1234567890abcdef
|
|
3713
|
+
*/
|
|
3714
|
+
c?: string;
|
|
3715
|
+
};
|
|
3716
|
+
}[];
|
|
3717
|
+
/**
|
|
3718
|
+
* @description Place the replacement even if the cancel failed. Omit it entirely for the default — Hyperliquid rejects an action hashed with `a: false`, so `false` is not a legal value.
|
|
3719
|
+
* @enum {boolean}
|
|
3720
|
+
*/
|
|
3721
|
+
a?: true;
|
|
3722
|
+
} | {
|
|
3723
|
+
/** @enum {string} */
|
|
3724
|
+
type: 'updateLeverage';
|
|
3725
|
+
asset: number;
|
|
3726
|
+
/**
|
|
3727
|
+
* @description Cross margin (`true`) or isolated (`false`).
|
|
3728
|
+
* @example true
|
|
3729
|
+
*/
|
|
3730
|
+
isCross: boolean;
|
|
3731
|
+
/**
|
|
3732
|
+
* @description New leverage, capped by the asset's own maximum. Set it BEFORE the intent that opens the position: leverage applied afterwards does not resize an existing one.
|
|
3733
|
+
* @example 5
|
|
3734
|
+
*/
|
|
3735
|
+
leverage: number;
|
|
3736
|
+
} | {
|
|
3737
|
+
/** @enum {string} */
|
|
3738
|
+
type: 'updateIsolatedMargin';
|
|
3739
|
+
asset: number;
|
|
3740
|
+
isBuy: boolean;
|
|
3741
|
+
/**
|
|
3742
|
+
* @description Margin to add (positive) or remove (negative), in USDC with 6 decimals — `1000000` is 1 USD.
|
|
3743
|
+
* @example 1000000
|
|
3744
|
+
*/
|
|
3745
|
+
ntli: number;
|
|
3746
|
+
};
|
|
3747
|
+
};
|
|
3439
3748
|
};
|
|
3440
3749
|
};
|
|
3441
3750
|
};
|
|
@@ -3470,11 +3779,11 @@ export interface operations {
|
|
|
3470
3779
|
* @example RELAY
|
|
3471
3780
|
* @enum {string}
|
|
3472
3781
|
*/
|
|
3473
|
-
settlementLayer: 'INTENT_EXECUTOR' | 'SAME_CHAIN' | 'ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP';
|
|
3782
|
+
settlementLayer: 'INTENT_EXECUTOR' | 'SAME_CHAIN' | 'ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP' | 'LZ';
|
|
3474
3783
|
/** @description EIP-712 sign payloads the client submits back on `POST /intents` */
|
|
3475
3784
|
signData: {
|
|
3476
|
-
/** @description
|
|
3477
|
-
origin: {
|
|
3785
|
+
/** @description Payloads for the origin legs, in submission order. Sign each entry and submit the signatures in matching order via `signatures.origin`. Discriminate on `kind`: `eip712` is signed as typed data, `personalSign` as a message. */
|
|
3786
|
+
origin: ({
|
|
3478
3787
|
/** @description EIP-712 domain separator fields */
|
|
3479
3788
|
domain: {
|
|
3480
3789
|
name?: string;
|
|
@@ -3499,9 +3808,24 @@ export interface operations {
|
|
|
3499
3808
|
message: {
|
|
3500
3809
|
[key: string]: unknown;
|
|
3501
3810
|
};
|
|
3502
|
-
|
|
3503
|
-
|
|
3504
|
-
|
|
3811
|
+
/** @enum {string} */
|
|
3812
|
+
kind: 'eip712';
|
|
3813
|
+
} | {
|
|
3814
|
+
/** @enum {string} */
|
|
3815
|
+
kind: 'personalSign';
|
|
3816
|
+
/**
|
|
3817
|
+
* @description Sign these characters as UTF-8 TEXT — viem `signMessage({ message })`, never `{ raw }`. Signing the decoded bytes yields a well-formed signature that the chain rejects.
|
|
3818
|
+
* @example a3f2c1d4e5b6a7980f1e2d3c4b5a69788796a5b4c3d2e1f0a1b2c3d4e5f60718
|
|
3819
|
+
*/
|
|
3820
|
+
message: string;
|
|
3821
|
+
/**
|
|
3822
|
+
* @description Solana slot after which this payload is dead. Much shorter than the route `expiresAt` — about 24 seconds — and it is the binding one. Re-quote when it passes.
|
|
3823
|
+
* @example 370123456
|
|
3824
|
+
*/
|
|
3825
|
+
expiresAtSlot: string;
|
|
3826
|
+
})[];
|
|
3827
|
+
/** @description Typed data for the destination leg. Absent when a third-party bridge performs the delivery and there is nothing for the user to sign there. */
|
|
3828
|
+
destination?: {
|
|
3505
3829
|
/** @description EIP-712 domain separator fields */
|
|
3506
3830
|
domain: {
|
|
3507
3831
|
name?: string;
|
|
@@ -3560,26 +3884,26 @@ export interface operations {
|
|
|
3560
3884
|
/** @description Tokens debited from the user, coalesced by (chainId, tokenAddress) */
|
|
3561
3885
|
input: {
|
|
3562
3886
|
/**
|
|
3563
|
-
* @description Chain where this token leg settles
|
|
3887
|
+
* @description Chain where this token leg settles (CAIP-2, any namespace)
|
|
3564
3888
|
* @example eip155:8453
|
|
3565
3889
|
*/
|
|
3566
3890
|
chainId: string;
|
|
3567
3891
|
/**
|
|
3568
|
-
* @description
|
|
3892
|
+
* @description Contract address of the debited token (EVM 0x or non-EVM base58)
|
|
3569
3893
|
* @example 0xaf88d065e77c8cc2239327c5edb3a432268e5831
|
|
3570
3894
|
*/
|
|
3571
3895
|
tokenAddress: string;
|
|
3572
3896
|
/**
|
|
3573
|
-
* @description Token symbol
|
|
3897
|
+
* @description Token symbol, from the internal token registry or, for a token it has no entry for, read on-chain while planning. `null` when neither resolved one.
|
|
3574
3898
|
* @example USDC
|
|
3575
3899
|
*/
|
|
3576
3900
|
symbol: string | null;
|
|
3577
3901
|
/**
|
|
3578
|
-
* @description Token decimals
|
|
3902
|
+
* @description Token decimals, from the internal token registry or, for a token it has no entry for, read on-chain while planning. `null` when neither resolved one.
|
|
3579
3903
|
* @example 6
|
|
3580
3904
|
*/
|
|
3581
3905
|
decimals: number | null;
|
|
3582
|
-
/** @description Unit price in USD. `null` when the price oracle
|
|
3906
|
+
/** @description Unit price in USD. `null` when neither the price oracle nor this quote priced the token. */
|
|
3583
3907
|
price: {
|
|
3584
3908
|
/**
|
|
3585
3909
|
* @description Unit price in USD
|
|
@@ -3607,16 +3931,16 @@ export interface operations {
|
|
|
3607
3931
|
*/
|
|
3608
3932
|
tokenAddress: string;
|
|
3609
3933
|
/**
|
|
3610
|
-
* @description Token symbol
|
|
3934
|
+
* @description Token symbol, from the internal token registry or, for a token it has no entry for, read on-chain while planning. `null` when neither resolved one.
|
|
3611
3935
|
* @example USDC
|
|
3612
3936
|
*/
|
|
3613
3937
|
symbol: string | null;
|
|
3614
3938
|
/**
|
|
3615
|
-
* @description Token decimals
|
|
3939
|
+
* @description Token decimals, from the internal token registry or, for a token it has no entry for, read on-chain while planning. `null` when neither resolved one.
|
|
3616
3940
|
* @example 6
|
|
3617
3941
|
*/
|
|
3618
3942
|
decimals: number | null;
|
|
3619
|
-
/** @description Unit price in USD. `null` when the price oracle
|
|
3943
|
+
/** @description Unit price in USD. `null` when neither the price oracle nor this quote priced the token. */
|
|
3620
3944
|
price: {
|
|
3621
3945
|
/**
|
|
3622
3946
|
* @description Unit price in USD
|
|
@@ -3765,7 +4089,7 @@ export interface operations {
|
|
|
3765
4089
|
};
|
|
3766
4090
|
};
|
|
3767
4091
|
};
|
|
3768
|
-
/** @description Provider handle for resolving the destination-chain delivery transaction when settlement hands off to a third-party bridge (RHINO, RELAY, NEAR, CCTP, OFT). Absent when the orchestrator settles end-to-end (e.g. ACROSS
|
|
4092
|
+
/** @description Provider handle for resolving the destination-chain delivery transaction when settlement hands off to a third-party bridge (ECO, RHINO, RELAY, NEAR, CCTP, OFT). Absent when the orchestrator settles end-to-end (e.g. ACROSS). */
|
|
3769
4093
|
bridgeFill?: {
|
|
3770
4094
|
/** @description Destination chain ID for the bridge fill */
|
|
3771
4095
|
destinationChainId: number;
|
|
@@ -3778,6 +4102,36 @@ export interface operations {
|
|
|
3778
4102
|
* @enum {string}
|
|
3779
4103
|
*/
|
|
3780
4104
|
type: 'OFT';
|
|
4105
|
+
} | {
|
|
4106
|
+
/** @description Destination chain ID for the bridge fill */
|
|
4107
|
+
destinationChainId: number;
|
|
4108
|
+
/** @description Optional bridge-specific fill deadline duration, in seconds. Preserved on stored quote reload so checksum validation uses the same bridgeFill payload that was signed at quote time. */
|
|
4109
|
+
fillExpirationPeriod?: number;
|
|
4110
|
+
/** @description Fill-tracker watch window, in seconds. The orchestrator owns this timeout; the fill-tracker reads it here to decide when a bridge fill has timed out. */
|
|
4111
|
+
fillStatusTimeout: number;
|
|
4112
|
+
/**
|
|
4113
|
+
* @description Across spoke-pool deposit. Names a deposit to watch for a refund, not a delivery — an ACROSS intent is filled by our own relayer and tracked as an ordinary fill.
|
|
4114
|
+
* @enum {string}
|
|
4115
|
+
*/
|
|
4116
|
+
type: 'ACROSS';
|
|
4117
|
+
/** @description The Across deposit id our claim opens on the origin chain, as a decimal uint256. Derived as keccak(arbiter | sponsor | nonce). */
|
|
4118
|
+
depositId: string;
|
|
4119
|
+
} | {
|
|
4120
|
+
/** @description Destination chain ID for the bridge fill */
|
|
4121
|
+
destinationChainId: number;
|
|
4122
|
+
/** @description Optional bridge-specific fill deadline duration, in seconds. Preserved on stored quote reload so checksum validation uses the same bridgeFill payload that was signed at quote time. */
|
|
4123
|
+
fillExpirationPeriod?: number;
|
|
4124
|
+
/** @description Fill-tracker watch window, in seconds. The orchestrator owns this timeout; the fill-tracker reads it here to decide when a bridge fill has timed out. */
|
|
4125
|
+
fillStatusTimeout: number;
|
|
4126
|
+
/**
|
|
4127
|
+
* @description Eco solver-network delivery
|
|
4128
|
+
* @enum {string}
|
|
4129
|
+
*/
|
|
4130
|
+
type: 'ECO';
|
|
4131
|
+
/** @description Eco Portal intent hash. Use against Eco's intent status API to resolve the destination delivery transaction. */
|
|
4132
|
+
intentHash: string;
|
|
4133
|
+
/** @description Eco's own id for the delivery chain, present only where it differs from `destinationChainId` (non-EVM destinations). Eco's status API reports fulfilment against this id. */
|
|
4134
|
+
providerDestinationChainId?: number;
|
|
3781
4135
|
} | {
|
|
3782
4136
|
/** @description Destination chain ID for the bridge fill */
|
|
3783
4137
|
destinationChainId: number;
|
|
@@ -3836,6 +4190,24 @@ export interface operations {
|
|
|
3836
4190
|
sourceDomainId: number;
|
|
3837
4191
|
/** @description Circle CCTP destination domain ID. */
|
|
3838
4192
|
destinationDomainId: number;
|
|
4193
|
+
} | {
|
|
4194
|
+
/** @description Destination chain ID for the bridge fill */
|
|
4195
|
+
destinationChainId: number;
|
|
4196
|
+
/** @description Optional bridge-specific fill deadline duration, in seconds. Preserved on stored quote reload so checksum validation uses the same bridgeFill payload that was signed at quote time. */
|
|
4197
|
+
fillExpirationPeriod?: number;
|
|
4198
|
+
/** @description Fill-tracker watch window, in seconds. The orchestrator owns this timeout; the fill-tracker reads it here to decide when a bridge fill has timed out. */
|
|
4199
|
+
fillStatusTimeout: number;
|
|
4200
|
+
/**
|
|
4201
|
+
* @description LayerZero Value Transfer
|
|
4202
|
+
* @enum {string}
|
|
4203
|
+
*/
|
|
4204
|
+
type: 'LZ';
|
|
4205
|
+
/** @description LayerZero quote ID. Use against LayerZero's transfer status API to track the destination-chain fill. */
|
|
4206
|
+
quoteId: string;
|
|
4207
|
+
/** @description LayerZero's own chain key for the destination (e.g. `base`). Its status response names chains by key rather than id. */
|
|
4208
|
+
dstChainKey: string;
|
|
4209
|
+
/** @description Protocols the quote routed through (e.g. STARGATE_V2_TAXI, CCTP_V2). One transfer can span several. */
|
|
4210
|
+
routeTypes: string[];
|
|
3839
4211
|
};
|
|
3840
4212
|
}[];
|
|
3841
4213
|
};
|
|
@@ -4218,9 +4590,9 @@ export interface operations {
|
|
|
4218
4590
|
* }
|
|
4219
4591
|
*/
|
|
4220
4592
|
settlementLayers?: {
|
|
4221
|
-
include: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP')[];
|
|
4593
|
+
include: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP' | 'LZ')[];
|
|
4222
4594
|
} | {
|
|
4223
|
-
exclude: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP')[];
|
|
4595
|
+
exclude: ('ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP' | 'LZ')[];
|
|
4224
4596
|
};
|
|
4225
4597
|
/**
|
|
4226
4598
|
* @description Which fee categories to treat as sponsored. Sponsored categories are absorbed by the sponsor and do not reduce the delivered amount.
|
|
@@ -4295,7 +4667,7 @@ export interface operations {
|
|
|
4295
4667
|
* @example ACROSS
|
|
4296
4668
|
* @enum {string}
|
|
4297
4669
|
*/
|
|
4298
|
-
settlementLayer: 'INTENT_EXECUTOR' | 'SAME_CHAIN' | 'ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP';
|
|
4670
|
+
settlementLayer: 'INTENT_EXECUTOR' | 'SAME_CHAIN' | 'ACROSS' | 'ECO' | 'RELAY' | 'OFT' | 'NEAR' | 'RHINO' | 'CCTP' | 'LZ';
|
|
4299
4671
|
/**
|
|
4300
4672
|
* @description `exact` for formula-priced layers; `approximated` for solver-market layers estimated from a typical-fee table.
|
|
4301
4673
|
* @example exact
|
|
@@ -4311,26 +4683,26 @@ export interface operations {
|
|
|
4311
4683
|
/** @description A single (chain, token) leg with amount, price, and metadata */
|
|
4312
4684
|
input: {
|
|
4313
4685
|
/**
|
|
4314
|
-
* @description Chain where this token leg settles
|
|
4686
|
+
* @description Chain where this token leg settles (CAIP-2, any namespace)
|
|
4315
4687
|
* @example eip155:8453
|
|
4316
4688
|
*/
|
|
4317
4689
|
chainId: string;
|
|
4318
4690
|
/**
|
|
4319
|
-
* @description
|
|
4691
|
+
* @description Contract address of the debited token (EVM 0x or non-EVM base58)
|
|
4320
4692
|
* @example 0xaf88d065e77c8cc2239327c5edb3a432268e5831
|
|
4321
4693
|
*/
|
|
4322
4694
|
tokenAddress: string;
|
|
4323
4695
|
/**
|
|
4324
|
-
* @description Token symbol
|
|
4696
|
+
* @description Token symbol, from the internal token registry or, for a token it has no entry for, read on-chain while planning. `null` when neither resolved one.
|
|
4325
4697
|
* @example USDC
|
|
4326
4698
|
*/
|
|
4327
4699
|
symbol: string | null;
|
|
4328
4700
|
/**
|
|
4329
|
-
* @description Token decimals
|
|
4701
|
+
* @description Token decimals, from the internal token registry or, for a token it has no entry for, read on-chain while planning. `null` when neither resolved one.
|
|
4330
4702
|
* @example 6
|
|
4331
4703
|
*/
|
|
4332
4704
|
decimals: number | null;
|
|
4333
|
-
/** @description Unit price in USD. `null` when the price oracle
|
|
4705
|
+
/** @description Unit price in USD. `null` when neither the price oracle nor this quote priced the token. */
|
|
4334
4706
|
price: {
|
|
4335
4707
|
/**
|
|
4336
4708
|
* @description Unit price in USD
|
|
@@ -4358,16 +4730,16 @@ export interface operations {
|
|
|
4358
4730
|
*/
|
|
4359
4731
|
tokenAddress: string;
|
|
4360
4732
|
/**
|
|
4361
|
-
* @description Token symbol
|
|
4733
|
+
* @description Token symbol, from the internal token registry or, for a token it has no entry for, read on-chain while planning. `null` when neither resolved one.
|
|
4362
4734
|
* @example USDC
|
|
4363
4735
|
*/
|
|
4364
4736
|
symbol: string | null;
|
|
4365
4737
|
/**
|
|
4366
|
-
* @description Token decimals
|
|
4738
|
+
* @description Token decimals, from the internal token registry or, for a token it has no entry for, read on-chain while planning. `null` when neither resolved one.
|
|
4367
4739
|
* @example 6
|
|
4368
4740
|
*/
|
|
4369
4741
|
decimals: number | null;
|
|
4370
|
-
/** @description Unit price in USD. `null` when the price oracle
|
|
4742
|
+
/** @description Unit price in USD. `null` when neither the price oracle nor this quote priced the token. */
|
|
4371
4743
|
price: {
|
|
4372
4744
|
/**
|
|
4373
4745
|
* @description Unit price in USD
|