@circle-fin/app-kit 1.12.1 → 1.13.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/CHANGELOG.md +59 -0
- package/README.md +31 -12
- package/bridge.cjs +2214 -186
- package/bridge.d.cts +86 -17
- package/bridge.d.mts +86 -17
- package/bridge.d.ts +86 -17
- package/bridge.mjs +2216 -188
- package/chains.cjs +134 -0
- package/chains.d.cts +126 -1
- package/chains.d.mts +126 -1
- package/chains.d.ts +126 -1
- package/chains.mjs +133 -1
- package/context.d.cts +86 -17
- package/context.d.mts +86 -17
- package/context.d.ts +86 -17
- package/earn.cjs +467 -48
- package/earn.d.cts +86 -17
- package/earn.d.mts +86 -17
- package/earn.d.ts +86 -17
- package/earn.mjs +467 -48
- package/estimateBridge.cjs +2214 -186
- package/estimateBridge.d.cts +196 -18
- package/estimateBridge.d.mts +196 -18
- package/estimateBridge.d.ts +196 -18
- package/estimateBridge.mjs +2216 -188
- package/estimateSwap.cjs +571 -131
- package/estimateSwap.d.cts +86 -17
- package/estimateSwap.d.mts +86 -17
- package/estimateSwap.d.ts +86 -17
- package/estimateSwap.mjs +571 -131
- package/index.cjs +2101 -434
- package/index.d.cts +949 -147
- package/index.d.mts +949 -147
- package/index.d.ts +949 -147
- package/index.mjs +2103 -436
- package/package.json +6 -6
- package/swap.cjs +571 -131
- package/swap.d.cts +93 -18
- package/swap.d.mts +93 -18
- package/swap.d.ts +93 -18
- package/swap.mjs +571 -131
- package/unifiedBalance.cjs +384 -67
- package/unifiedBalance.d.cts +76 -2
- package/unifiedBalance.d.mts +76 -2
- package/unifiedBalance.d.ts +76 -2
- package/unifiedBalance.mjs +384 -67
package/index.d.cts
CHANGED
|
@@ -718,6 +718,8 @@ declare enum Blockchain {
|
|
|
718
718
|
Optimism_Sepolia = "Optimism_Sepolia",
|
|
719
719
|
Pharos = "Pharos",
|
|
720
720
|
Pharos_Testnet = "Pharos_Testnet",
|
|
721
|
+
Plasma = "Plasma",
|
|
722
|
+
Plasma_Testnet = "Plasma_Testnet",
|
|
721
723
|
Polkadot_Asset_Hub = "Polkadot_Asset_Hub",
|
|
722
724
|
Polkadot_Westmint = "Polkadot_Westmint",
|
|
723
725
|
Plume = "Plume",
|
|
@@ -946,6 +948,7 @@ declare enum BridgeChain {
|
|
|
946
948
|
Morph = "Morph",
|
|
947
949
|
Optimism = "Optimism",
|
|
948
950
|
Pharos = "Pharos",
|
|
951
|
+
Plasma = "Plasma",
|
|
949
952
|
Plume = "Plume",
|
|
950
953
|
Polygon = "Polygon",
|
|
951
954
|
Sei = "Sei",
|
|
@@ -971,6 +974,7 @@ declare enum BridgeChain {
|
|
|
971
974
|
Morph_Testnet = "Morph_Testnet",
|
|
972
975
|
Optimism_Sepolia = "Optimism_Sepolia",
|
|
973
976
|
Pharos_Testnet = "Pharos_Testnet",
|
|
977
|
+
Plasma_Testnet = "Plasma_Testnet",
|
|
974
978
|
Plume_Testnet = "Plume_Testnet",
|
|
975
979
|
Polygon_Amoy_Testnet = "Polygon_Amoy_Testnet",
|
|
976
980
|
Sei_Testnet = "Sei_Testnet",
|
|
@@ -1377,6 +1381,7 @@ declare const ArcTestnet: {
|
|
|
1377
1381
|
readonly v2: {
|
|
1378
1382
|
readonly type: "split";
|
|
1379
1383
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
1384
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
1380
1385
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
1381
1386
|
readonly confirmations: 1;
|
|
1382
1387
|
readonly fastConfirmations: 1;
|
|
@@ -1441,6 +1446,7 @@ declare const Arbitrum: {
|
|
|
1441
1446
|
readonly v2: {
|
|
1442
1447
|
readonly type: "split";
|
|
1443
1448
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
1449
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
1444
1450
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
1445
1451
|
readonly confirmations: 65;
|
|
1446
1452
|
readonly fastConfirmations: 1;
|
|
@@ -1504,6 +1510,7 @@ declare const ArbitrumSepolia: {
|
|
|
1504
1510
|
readonly v2: {
|
|
1505
1511
|
readonly type: "split";
|
|
1506
1512
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
1513
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
1507
1514
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
1508
1515
|
readonly confirmations: 65;
|
|
1509
1516
|
readonly fastConfirmations: 1;
|
|
@@ -1567,6 +1574,7 @@ declare const Avalanche: {
|
|
|
1567
1574
|
readonly v2: {
|
|
1568
1575
|
readonly type: "split";
|
|
1569
1576
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
1577
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
1570
1578
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
1571
1579
|
readonly confirmations: 1;
|
|
1572
1580
|
readonly fastConfirmations: 1;
|
|
@@ -1629,6 +1637,7 @@ declare const AvalancheFuji: {
|
|
|
1629
1637
|
readonly v2: {
|
|
1630
1638
|
readonly type: "split";
|
|
1631
1639
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
1640
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
1632
1641
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
1633
1642
|
readonly confirmations: 1;
|
|
1634
1643
|
readonly fastConfirmations: 1;
|
|
@@ -1692,6 +1701,7 @@ declare const Base: {
|
|
|
1692
1701
|
readonly v2: {
|
|
1693
1702
|
readonly type: "split";
|
|
1694
1703
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
1704
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
1695
1705
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
1696
1706
|
readonly confirmations: 65;
|
|
1697
1707
|
readonly fastConfirmations: 1;
|
|
@@ -1755,6 +1765,7 @@ declare const BaseSepolia: {
|
|
|
1755
1765
|
readonly v2: {
|
|
1756
1766
|
readonly type: "split";
|
|
1757
1767
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
1768
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
1758
1769
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
1759
1770
|
readonly confirmations: 65;
|
|
1760
1771
|
readonly fastConfirmations: 1;
|
|
@@ -1862,6 +1873,7 @@ declare const Codex: {
|
|
|
1862
1873
|
readonly v2: {
|
|
1863
1874
|
readonly type: "split";
|
|
1864
1875
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
1876
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
1865
1877
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
1866
1878
|
readonly confirmations: 65;
|
|
1867
1879
|
readonly fastConfirmations: 1;
|
|
@@ -1905,6 +1917,7 @@ declare const CodexTestnet: {
|
|
|
1905
1917
|
readonly v2: {
|
|
1906
1918
|
readonly type: "split";
|
|
1907
1919
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
1920
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
1908
1921
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
1909
1922
|
readonly confirmations: 65;
|
|
1910
1923
|
readonly fastConfirmations: 1;
|
|
@@ -2130,6 +2143,7 @@ declare const Ethereum: {
|
|
|
2130
2143
|
readonly v2: {
|
|
2131
2144
|
readonly type: "split";
|
|
2132
2145
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
2146
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2133
2147
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2134
2148
|
readonly confirmations: 65;
|
|
2135
2149
|
readonly fastConfirmations: 2;
|
|
@@ -2193,6 +2207,7 @@ declare const EthereumSepolia: {
|
|
|
2193
2207
|
readonly v2: {
|
|
2194
2208
|
readonly type: "split";
|
|
2195
2209
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
2210
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
2196
2211
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
2197
2212
|
readonly confirmations: 65;
|
|
2198
2213
|
readonly fastConfirmations: 2;
|
|
@@ -2300,6 +2315,7 @@ declare const HyperEVM: {
|
|
|
2300
2315
|
readonly v2: {
|
|
2301
2316
|
readonly type: "split";
|
|
2302
2317
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
2318
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2303
2319
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2304
2320
|
readonly confirmations: 1;
|
|
2305
2321
|
readonly fastConfirmations: 1;
|
|
@@ -2358,6 +2374,7 @@ declare const HyperEVMTestnet: {
|
|
|
2358
2374
|
readonly v2: {
|
|
2359
2375
|
readonly type: "split";
|
|
2360
2376
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
2377
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
2361
2378
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
2362
2379
|
readonly confirmations: 1;
|
|
2363
2380
|
readonly fastConfirmations: 1;
|
|
@@ -2508,6 +2525,7 @@ declare const Ink: {
|
|
|
2508
2525
|
readonly v2: {
|
|
2509
2526
|
readonly type: "split";
|
|
2510
2527
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
2528
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2511
2529
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2512
2530
|
readonly confirmations: 65;
|
|
2513
2531
|
readonly fastConfirmations: 1;
|
|
@@ -2553,6 +2571,7 @@ declare const InkTestnet: {
|
|
|
2553
2571
|
readonly v2: {
|
|
2554
2572
|
readonly type: "split";
|
|
2555
2573
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
2574
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
2556
2575
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
2557
2576
|
readonly confirmations: 65;
|
|
2558
2577
|
readonly fastConfirmations: 1;
|
|
@@ -2596,6 +2615,7 @@ declare const Linea: {
|
|
|
2596
2615
|
readonly v2: {
|
|
2597
2616
|
readonly type: "split";
|
|
2598
2617
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
2618
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2599
2619
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2600
2620
|
readonly confirmations: 1;
|
|
2601
2621
|
readonly fastConfirmations: 1;
|
|
@@ -2640,6 +2660,7 @@ declare const LineaSepolia: {
|
|
|
2640
2660
|
readonly v2: {
|
|
2641
2661
|
readonly type: "split";
|
|
2642
2662
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
2663
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
2643
2664
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
2644
2665
|
readonly confirmations: 1;
|
|
2645
2666
|
readonly fastConfirmations: 1;
|
|
@@ -2685,6 +2706,7 @@ declare const Monad: {
|
|
|
2685
2706
|
readonly v2: {
|
|
2686
2707
|
readonly type: "split";
|
|
2687
2708
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
2709
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2688
2710
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2689
2711
|
readonly confirmations: 1;
|
|
2690
2712
|
readonly fastConfirmations: 1;
|
|
@@ -2990,6 +3012,7 @@ declare const Optimism: {
|
|
|
2990
3012
|
readonly v2: {
|
|
2991
3013
|
readonly type: "split";
|
|
2992
3014
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
3015
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2993
3016
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2994
3017
|
readonly confirmations: 65;
|
|
2995
3018
|
readonly fastConfirmations: 1;
|
|
@@ -3053,6 +3076,7 @@ declare const OptimismSepolia: {
|
|
|
3053
3076
|
readonly v2: {
|
|
3054
3077
|
readonly type: "split";
|
|
3055
3078
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
3079
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
3056
3080
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
3057
3081
|
readonly confirmations: 65;
|
|
3058
3082
|
readonly fastConfirmations: 1;
|
|
@@ -3171,6 +3195,96 @@ declare const PharosTestnet: {
|
|
|
3171
3195
|
};
|
|
3172
3196
|
};
|
|
3173
3197
|
|
|
3198
|
+
/**
|
|
3199
|
+
* Plasma Mainnet chain definition
|
|
3200
|
+
* @remarks
|
|
3201
|
+
* This represents the official production network for the Plasma blockchain.
|
|
3202
|
+
* Plasma is an EVM-equivalent Layer 1 blockchain purpose-built for global
|
|
3203
|
+
* stablecoin payments, with deterministic BFT finality (PlasmaBFT/Fast-HotStuff).
|
|
3204
|
+
*/
|
|
3205
|
+
declare const Plasma: {
|
|
3206
|
+
readonly type: "evm";
|
|
3207
|
+
readonly chain: Blockchain.Plasma;
|
|
3208
|
+
readonly name: "Plasma";
|
|
3209
|
+
readonly title: "Plasma Mainnet";
|
|
3210
|
+
readonly nativeCurrency: {
|
|
3211
|
+
readonly name: "Plasma";
|
|
3212
|
+
readonly symbol: "XPL";
|
|
3213
|
+
readonly decimals: 18;
|
|
3214
|
+
};
|
|
3215
|
+
readonly chainId: 9745;
|
|
3216
|
+
readonly isTestnet: false;
|
|
3217
|
+
readonly explorerUrl: "https://plasmascan.to/tx/{hash}";
|
|
3218
|
+
readonly rpcEndpoints: readonly ["https://rpc.plasma.to"];
|
|
3219
|
+
readonly eurcAddress: "0x3EE196E78d4d4248b849B8E1C7F44C5457FAFD2C";
|
|
3220
|
+
readonly usdcAddress: "0x2d661C89D812261039AF9764eceaAee884f5F67F";
|
|
3221
|
+
readonly usdtAddress: null;
|
|
3222
|
+
readonly cctp: {
|
|
3223
|
+
readonly domain: 33;
|
|
3224
|
+
readonly contracts: {
|
|
3225
|
+
readonly v2: {
|
|
3226
|
+
readonly type: "split";
|
|
3227
|
+
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
3228
|
+
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
3229
|
+
readonly confirmations: 3;
|
|
3230
|
+
readonly fastConfirmations: 1;
|
|
3231
|
+
};
|
|
3232
|
+
};
|
|
3233
|
+
readonly forwarderSupported: {
|
|
3234
|
+
readonly source: false;
|
|
3235
|
+
readonly destination: false;
|
|
3236
|
+
};
|
|
3237
|
+
};
|
|
3238
|
+
readonly kitContracts: {
|
|
3239
|
+
readonly bridge: "0xB3FA262d0fB521cc93bE83d87b322b8A23DAf3F0";
|
|
3240
|
+
};
|
|
3241
|
+
};
|
|
3242
|
+
|
|
3243
|
+
/**
|
|
3244
|
+
* Plasma Testnet chain definition
|
|
3245
|
+
* @remarks
|
|
3246
|
+
* This represents the official test network for the Plasma blockchain.
|
|
3247
|
+
* Plasma is an EVM-equivalent Layer 1 blockchain purpose-built for global
|
|
3248
|
+
* stablecoin payments, with deterministic BFT finality (PlasmaBFT/Fast-HotStuff).
|
|
3249
|
+
*/
|
|
3250
|
+
declare const PlasmaTestnet: {
|
|
3251
|
+
readonly type: "evm";
|
|
3252
|
+
readonly chain: Blockchain.Plasma_Testnet;
|
|
3253
|
+
readonly name: "Plasma Testnet";
|
|
3254
|
+
readonly title: "Plasma Testnet";
|
|
3255
|
+
readonly nativeCurrency: {
|
|
3256
|
+
readonly name: "Plasma";
|
|
3257
|
+
readonly symbol: "XPL";
|
|
3258
|
+
readonly decimals: 18;
|
|
3259
|
+
};
|
|
3260
|
+
readonly chainId: 9746;
|
|
3261
|
+
readonly isTestnet: true;
|
|
3262
|
+
readonly explorerUrl: "https://testnet.plasmascan.to/tx/{hash}";
|
|
3263
|
+
readonly rpcEndpoints: readonly ["https://testnet-rpc.plasma.to"];
|
|
3264
|
+
readonly eurcAddress: "0x98AfA0F93Dd993B736399f9074eDcEBD1985A330";
|
|
3265
|
+
readonly usdcAddress: "0xE67Fb267022cBA8064Dd388CC2FED724F3120D9D";
|
|
3266
|
+
readonly usdtAddress: null;
|
|
3267
|
+
readonly cctp: {
|
|
3268
|
+
readonly domain: 33;
|
|
3269
|
+
readonly contracts: {
|
|
3270
|
+
readonly v2: {
|
|
3271
|
+
readonly type: "split";
|
|
3272
|
+
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
3273
|
+
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
3274
|
+
readonly confirmations: 3;
|
|
3275
|
+
readonly fastConfirmations: 1;
|
|
3276
|
+
};
|
|
3277
|
+
};
|
|
3278
|
+
readonly forwarderSupported: {
|
|
3279
|
+
readonly source: false;
|
|
3280
|
+
readonly destination: false;
|
|
3281
|
+
};
|
|
3282
|
+
};
|
|
3283
|
+
readonly kitContracts: {
|
|
3284
|
+
readonly bridge: "0xC5567a5E3370d4DBfB0540025078e283e36A363d";
|
|
3285
|
+
};
|
|
3286
|
+
};
|
|
3287
|
+
|
|
3174
3288
|
/**
|
|
3175
3289
|
* Plume Mainnet chain definition
|
|
3176
3290
|
* @remarks
|
|
@@ -3201,6 +3315,7 @@ declare const Plume: {
|
|
|
3201
3315
|
readonly v2: {
|
|
3202
3316
|
readonly type: "split";
|
|
3203
3317
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
3318
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
3204
3319
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
3205
3320
|
readonly confirmations: 65;
|
|
3206
3321
|
readonly fastConfirmations: 1;
|
|
@@ -3246,6 +3361,7 @@ declare const PlumeTestnet: {
|
|
|
3246
3361
|
readonly v2: {
|
|
3247
3362
|
readonly type: "split";
|
|
3248
3363
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
3364
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
3249
3365
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
3250
3366
|
readonly confirmations: 65;
|
|
3251
3367
|
readonly fastConfirmations: 1;
|
|
@@ -3343,6 +3459,7 @@ declare const Polygon: {
|
|
|
3343
3459
|
readonly v2: {
|
|
3344
3460
|
readonly type: "split";
|
|
3345
3461
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
3462
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
3346
3463
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
3347
3464
|
readonly confirmations: 33;
|
|
3348
3465
|
readonly fastConfirmations: 13;
|
|
@@ -3406,6 +3523,7 @@ declare const PolygonAmoy: {
|
|
|
3406
3523
|
readonly v2: {
|
|
3407
3524
|
readonly type: "split";
|
|
3408
3525
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
3526
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
3409
3527
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
3410
3528
|
readonly confirmations: 33;
|
|
3411
3529
|
readonly fastConfirmations: 13;
|
|
@@ -3464,6 +3582,7 @@ declare const Sei: {
|
|
|
3464
3582
|
readonly v2: {
|
|
3465
3583
|
readonly type: "split";
|
|
3466
3584
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
3585
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
3467
3586
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
3468
3587
|
readonly confirmations: 1;
|
|
3469
3588
|
readonly fastConfirmations: 1;
|
|
@@ -3522,6 +3641,7 @@ declare const SeiTestnet: {
|
|
|
3522
3641
|
readonly v2: {
|
|
3523
3642
|
readonly type: "split";
|
|
3524
3643
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
3644
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
3525
3645
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
3526
3646
|
readonly confirmations: 1;
|
|
3527
3647
|
readonly fastConfirmations: 1;
|
|
@@ -3578,6 +3698,7 @@ declare const Sonic: {
|
|
|
3578
3698
|
readonly v2: {
|
|
3579
3699
|
readonly type: "split";
|
|
3580
3700
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
3701
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
3581
3702
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
3582
3703
|
readonly confirmations: 1;
|
|
3583
3704
|
readonly fastConfirmations: 1;
|
|
@@ -3635,6 +3756,7 @@ declare const SonicTestnet: {
|
|
|
3635
3756
|
readonly v2: {
|
|
3636
3757
|
readonly type: "split";
|
|
3637
3758
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
3759
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
3638
3760
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
3639
3761
|
readonly confirmations: 1;
|
|
3640
3762
|
readonly fastConfirmations: 1;
|
|
@@ -3943,6 +4065,7 @@ declare const Unichain: {
|
|
|
3943
4065
|
readonly v2: {
|
|
3944
4066
|
readonly type: "split";
|
|
3945
4067
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
4068
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
3946
4069
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
3947
4070
|
readonly confirmations: 65;
|
|
3948
4071
|
readonly fastConfirmations: 1;
|
|
@@ -4006,6 +4129,7 @@ declare const UnichainSepolia: {
|
|
|
4006
4129
|
readonly v2: {
|
|
4007
4130
|
readonly type: "split";
|
|
4008
4131
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
4132
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
4009
4133
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
4010
4134
|
readonly confirmations: 65;
|
|
4011
4135
|
readonly fastConfirmations: 1;
|
|
@@ -4062,6 +4186,7 @@ declare const WorldChain: {
|
|
|
4062
4186
|
readonly v2: {
|
|
4063
4187
|
readonly type: "split";
|
|
4064
4188
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cF5d";
|
|
4189
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
4065
4190
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
4066
4191
|
readonly confirmations: 65;
|
|
4067
4192
|
readonly fastConfirmations: 1;
|
|
@@ -4119,6 +4244,7 @@ declare const WorldChainSepolia: {
|
|
|
4119
4244
|
readonly v2: {
|
|
4120
4245
|
readonly type: "split";
|
|
4121
4246
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
4247
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
4122
4248
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
4123
4249
|
readonly confirmations: 65;
|
|
4124
4250
|
readonly fastConfirmations: 1;
|
|
@@ -4177,6 +4303,7 @@ declare const XDC: {
|
|
|
4177
4303
|
readonly v2: {
|
|
4178
4304
|
readonly type: "split";
|
|
4179
4305
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
4306
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
4180
4307
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
4181
4308
|
readonly confirmations: 3;
|
|
4182
4309
|
readonly fastConfirmations: 3;
|
|
@@ -4221,6 +4348,7 @@ declare const XDCApothem: {
|
|
|
4221
4348
|
readonly v2: {
|
|
4222
4349
|
readonly type: "split";
|
|
4223
4350
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
4351
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
4224
4352
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
4225
4353
|
readonly confirmations: 3;
|
|
4226
4354
|
readonly fastConfirmations: 1;
|
|
@@ -4421,6 +4549,8 @@ declare const Chains_Optimism: typeof Optimism;
|
|
|
4421
4549
|
declare const Chains_OptimismSepolia: typeof OptimismSepolia;
|
|
4422
4550
|
declare const Chains_Pharos: typeof Pharos;
|
|
4423
4551
|
declare const Chains_PharosTestnet: typeof PharosTestnet;
|
|
4552
|
+
declare const Chains_Plasma: typeof Plasma;
|
|
4553
|
+
declare const Chains_PlasmaTestnet: typeof PlasmaTestnet;
|
|
4424
4554
|
declare const Chains_Plume: typeof Plume;
|
|
4425
4555
|
declare const Chains_PlumeTestnet: typeof PlumeTestnet;
|
|
4426
4556
|
declare const Chains_PolkadotAssetHub: typeof PolkadotAssetHub;
|
|
@@ -4492,6 +4622,8 @@ declare namespace Chains {
|
|
|
4492
4622
|
Chains_OptimismSepolia as OptimismSepolia,
|
|
4493
4623
|
Chains_Pharos as Pharos,
|
|
4494
4624
|
Chains_PharosTestnet as PharosTestnet,
|
|
4625
|
+
Chains_Plasma as Plasma,
|
|
4626
|
+
Chains_PlasmaTestnet as PlasmaTestnet,
|
|
4495
4627
|
Chains_Plume as Plume,
|
|
4496
4628
|
Chains_PlumeTestnet as PlumeTestnet,
|
|
4497
4629
|
Chains_PolkadotAssetHub as PolkadotAssetHub,
|
|
@@ -6044,7 +6176,7 @@ interface ExecuteParams {
|
|
|
6044
6176
|
* fromAddress: '0x...',
|
|
6045
6177
|
* toAddress: '0x...',
|
|
6046
6178
|
* amount: '1000000',
|
|
6047
|
-
* apiKey: '
|
|
6179
|
+
* apiKey: 'TEST_API_KEY:...',
|
|
6048
6180
|
* })
|
|
6049
6181
|
*
|
|
6050
6182
|
* // Build token inputs with permit
|
|
@@ -6188,7 +6320,7 @@ interface ExecuteSwapEVMParams extends ActionParameters {
|
|
|
6188
6320
|
* fromAddress: 'YubQzu18FDqJRyNfG8JqHmsdbxhnoQqcKUHBdUkN6tP',
|
|
6189
6321
|
* toAddress: 'YubQzu18FDqJRyNfG8JqHmsdbxhnoQqcKUHBdUkN6tP',
|
|
6190
6322
|
* amount: '1000000',
|
|
6191
|
-
* apiKey: '
|
|
6323
|
+
* apiKey: 'TEST_API_KEY:...',
|
|
6192
6324
|
* })
|
|
6193
6325
|
*
|
|
6194
6326
|
* // Prepare action parameters
|
|
@@ -10102,6 +10234,63 @@ interface InvocationMeta {
|
|
|
10102
10234
|
*/
|
|
10103
10235
|
readonly signal?: AbortSignal | undefined;
|
|
10104
10236
|
}
|
|
10237
|
+
/**
|
|
10238
|
+
* Resolved invocation context with guaranteed values.
|
|
10239
|
+
*
|
|
10240
|
+
* @remarks
|
|
10241
|
+
* Defines **WHO** called and **HOW** to observe. Contains the complete runtime
|
|
10242
|
+
* and guaranteed trace ID.
|
|
10243
|
+
*
|
|
10244
|
+
* Created by `resolveInvocationContext()` from `InvocationMeta`.
|
|
10245
|
+
*
|
|
10246
|
+
* @example
|
|
10247
|
+
* ```typescript
|
|
10248
|
+
* import type { InvocationContext } from '@core/runtime'
|
|
10249
|
+
*
|
|
10250
|
+
* const ctx: InvocationContext = {
|
|
10251
|
+
* traceId: 'abc-123',
|
|
10252
|
+
* runtime: completeRuntime,
|
|
10253
|
+
* callers: [{ type: 'app', name: 'MyDApp' }],
|
|
10254
|
+
* }
|
|
10255
|
+
* ```
|
|
10256
|
+
*/
|
|
10257
|
+
interface InvocationContext {
|
|
10258
|
+
/**
|
|
10259
|
+
* Trace ID for distributed tracing correlation.
|
|
10260
|
+
*
|
|
10261
|
+
* @remarks
|
|
10262
|
+
* Guaranteed to be present (generated if not provided in input).
|
|
10263
|
+
*/
|
|
10264
|
+
readonly traceId: string;
|
|
10265
|
+
/**
|
|
10266
|
+
* Complete runtime with all services.
|
|
10267
|
+
*
|
|
10268
|
+
* @remarks
|
|
10269
|
+
* All services (clock, logger, events, metrics) are guaranteed present.
|
|
10270
|
+
*/
|
|
10271
|
+
readonly runtime: Runtime;
|
|
10272
|
+
/**
|
|
10273
|
+
* Token registry for resolving token information.
|
|
10274
|
+
*
|
|
10275
|
+
* @remarks
|
|
10276
|
+
* Guaranteed to be present. Uses provided registry or falls back to default.
|
|
10277
|
+
*/
|
|
10278
|
+
readonly tokens: TokenRegistry;
|
|
10279
|
+
/**
|
|
10280
|
+
* Call chain (empty array if not provided).
|
|
10281
|
+
*/
|
|
10282
|
+
readonly callers: readonly Caller[];
|
|
10283
|
+
/**
|
|
10284
|
+
* Cooperative cancellation signal for the invocation.
|
|
10285
|
+
*
|
|
10286
|
+
* @remarks
|
|
10287
|
+
* Mirrors {@link InvocationMeta.signal}. Present only when the caller
|
|
10288
|
+
* supplied one — the runtime never fabricates a signal. Operations may
|
|
10289
|
+
* forward it to cancellable work; aborting remains the caller's
|
|
10290
|
+
* responsibility.
|
|
10291
|
+
*/
|
|
10292
|
+
readonly signal?: AbortSignal | undefined;
|
|
10293
|
+
}
|
|
10105
10294
|
|
|
10106
10295
|
/**
|
|
10107
10296
|
* Transfer speed options for cross-chain operations.
|
|
@@ -11761,6 +11950,139 @@ declare abstract class BridgingProvider<TProviderActions = Record<string, unknow
|
|
|
11761
11950
|
analyzeStepsForRetry(steps: BridgeStep[]): StepAnalysisResult;
|
|
11762
11951
|
}
|
|
11763
11952
|
|
|
11953
|
+
/**
|
|
11954
|
+
* The expiry window of a signed quote.
|
|
11955
|
+
*
|
|
11956
|
+
* A signed quote is short-lived; refresh it immediately before submitting
|
|
11957
|
+
* on-chain rather than caching it.
|
|
11958
|
+
*/
|
|
11959
|
+
type FeeQuoteExpiry = {
|
|
11960
|
+
/** Identify an exact Unix timestamp expiry. */
|
|
11961
|
+
readonly mode: 'TIMESTAMP';
|
|
11962
|
+
/** Unix timestamp in seconds at which the quote expires. */
|
|
11963
|
+
readonly expiresAt: number;
|
|
11964
|
+
} | {
|
|
11965
|
+
/** Identify a source-chain block-number expiry. */
|
|
11966
|
+
readonly mode: 'BLOCK_NUMBER';
|
|
11967
|
+
/** Authoritative source-chain block at which the quote expires. */
|
|
11968
|
+
readonly expiresAtBlock: number;
|
|
11969
|
+
/** Optional advisory Unix timestamp estimate for the expiry block. */
|
|
11970
|
+
readonly blockEstimatedAt?: number;
|
|
11971
|
+
};
|
|
11972
|
+
|
|
11973
|
+
/**
|
|
11974
|
+
* Configure how CCTP and forwarding fees are collected for a bridge.
|
|
11975
|
+
*
|
|
11976
|
+
* @remarks
|
|
11977
|
+
* Use `'source'` with `to.useForwarder: true` to treat `amount` as the exact
|
|
11978
|
+
* destination amount. Bridge Kit obtains a signed fee quote, collects the fee
|
|
11979
|
+
* in source-chain USDC, and leaves the destination mint unreduced. Omit the
|
|
11980
|
+
* option (or use `'destination'`) to preserve the existing max-fee behavior.
|
|
11981
|
+
*
|
|
11982
|
+
* @example
|
|
11983
|
+
* ```typescript
|
|
11984
|
+
* import type { BridgeExecutionConfig } from '@circle-fin/bridge-kit'
|
|
11985
|
+
*
|
|
11986
|
+
* const config: BridgeExecutionConfig = {
|
|
11987
|
+
* transferSpeed: 'FAST',
|
|
11988
|
+
* feePayment: 'source',
|
|
11989
|
+
* }
|
|
11990
|
+
* ```
|
|
11991
|
+
* @since 1.14.0
|
|
11992
|
+
*/
|
|
11993
|
+
interface BridgeExecutionConfig extends BridgeConfig {
|
|
11994
|
+
/** Select source-side signed fees or the legacy destination-side fee path. */
|
|
11995
|
+
feePayment?: 'source' | 'destination';
|
|
11996
|
+
}
|
|
11997
|
+
/**
|
|
11998
|
+
* Describe one signed Fee Service line item in human-readable USDC.
|
|
11999
|
+
*
|
|
12000
|
+
* @example
|
|
12001
|
+
* ```typescript
|
|
12002
|
+
* import type { ReceiveExactFeeItem } from '@circle-fin/bridge-kit'
|
|
12003
|
+
*
|
|
12004
|
+
* const item: ReceiveExactFeeItem = {
|
|
12005
|
+
* type: 'FORWARD',
|
|
12006
|
+
* amount: '0.25',
|
|
12007
|
+
* args: [],
|
|
12008
|
+
* argsHash: `0x${'00'.repeat(32)}`,
|
|
12009
|
+
* }
|
|
12010
|
+
* ```
|
|
12011
|
+
* @since 1.14.0
|
|
12012
|
+
*/
|
|
12013
|
+
interface ReceiveExactFeeItem {
|
|
12014
|
+
/** The Fee Service item type, such as `FORWARD` or `PRE_FINALITY`. */
|
|
12015
|
+
readonly type: string;
|
|
12016
|
+
/** The fee amount in human-readable USDC. */
|
|
12017
|
+
readonly amount: string;
|
|
12018
|
+
/** The ABI arguments covered by the signed quote. */
|
|
12019
|
+
readonly args: readonly string[];
|
|
12020
|
+
/** The hash of the ABI arguments covered by the signed quote. */
|
|
12021
|
+
readonly argsHash: string;
|
|
12022
|
+
}
|
|
12023
|
+
/**
|
|
12024
|
+
* Return a receive-exact bridge estimate backed by a short-lived signed quote.
|
|
12025
|
+
*
|
|
12026
|
+
* @remarks
|
|
12027
|
+
* Treat `quote` as opaque and sensitive. Pass it back to
|
|
12028
|
+
* {@link BridgeKit.bridge}; do not log or decode it. Bridge Kit validates a
|
|
12029
|
+
* supplied quote against the exact transfer parameters and rejects it when it
|
|
12030
|
+
* is invalid, mismatched, expired, or too close to expiry.
|
|
12031
|
+
*
|
|
12032
|
+
* @example
|
|
12033
|
+
* ```typescript
|
|
12034
|
+
* import { BridgeKit, type BridgeParams } from '@circle-fin/bridge-kit'
|
|
12035
|
+
*
|
|
12036
|
+
* declare const adapter: BridgeParams['from']['adapter']
|
|
12037
|
+
* const kit = new BridgeKit()
|
|
12038
|
+
*
|
|
12039
|
+
* const estimate = await kit.estimate({
|
|
12040
|
+
* from: { adapter, chain: 'Ethereum' },
|
|
12041
|
+
* to: {
|
|
12042
|
+
* chain: 'Base',
|
|
12043
|
+
* recipientAddress: '0x1234567890123456789012345678901234567890',
|
|
12044
|
+
* useForwarder: true,
|
|
12045
|
+
* },
|
|
12046
|
+
* amount: '100',
|
|
12047
|
+
* config: { feePayment: 'source' },
|
|
12048
|
+
* })
|
|
12049
|
+
* console.log(estimate.amountReceived, estimate.totalDebit)
|
|
12050
|
+
* ```
|
|
12051
|
+
* @since 1.14.0
|
|
12052
|
+
*/
|
|
12053
|
+
interface ReceiveExactEstimateResult extends EstimateResult$1 {
|
|
12054
|
+
/** The exact amount the destination recipient receives, in USDC. */
|
|
12055
|
+
readonly amountReceived: string;
|
|
12056
|
+
/** The total signed fee collected on the source chain, in USDC. */
|
|
12057
|
+
readonly feeTotal: string;
|
|
12058
|
+
/** The itemized signed fee quote, with amounts in human-readable USDC. */
|
|
12059
|
+
readonly feeItems: readonly ReceiveExactFeeItem[];
|
|
12060
|
+
/** The total source-wallet debit (`amountReceived + feeTotal`), in USDC. */
|
|
12061
|
+
readonly totalDebit: string;
|
|
12062
|
+
/** The authoritative expiry returned by the Fee Service. */
|
|
12063
|
+
readonly quoteExpiry: FeeQuoteExpiry;
|
|
12064
|
+
/** Opaque signed quote bytes to pass to {@link BridgeKit.bridge}. */
|
|
12065
|
+
readonly quote: string;
|
|
12066
|
+
}
|
|
12067
|
+
/**
|
|
12068
|
+
* Result returned by {@link BridgeKit.estimate} for legacy and source-fee modes.
|
|
12069
|
+
*
|
|
12070
|
+
* @example
|
|
12071
|
+
* ```typescript
|
|
12072
|
+
* import {
|
|
12073
|
+
* BridgeKit,
|
|
12074
|
+
* type BridgeEstimateResult,
|
|
12075
|
+
* type BridgeParams,
|
|
12076
|
+
* } from '@circle-fin/bridge-kit'
|
|
12077
|
+
*
|
|
12078
|
+
* declare const params: BridgeParams
|
|
12079
|
+
* const kit = new BridgeKit()
|
|
12080
|
+
* const result: BridgeEstimateResult = await kit.estimate(params)
|
|
12081
|
+
* if ('amountReceived' in result) console.log(result.totalDebit)
|
|
12082
|
+
* ```
|
|
12083
|
+
* @since 1.14.0
|
|
12084
|
+
*/
|
|
12085
|
+
type BridgeEstimateResult = EstimateResult$1 | ReceiveExactEstimateResult;
|
|
11764
12086
|
type FeeFunction<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities> = (params: BridgeParams$1<TFromAdapterCapabilities, TToAdapterCapabilities>) => Promise<string> | string;
|
|
11765
12087
|
type FeeRecipientFunction<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities> = (feePayoutChain: ChainDefinition, params: BridgeParams$1<TFromAdapterCapabilities, TToAdapterCapabilities>) => Promise<string> | string;
|
|
11766
12088
|
/**
|
|
@@ -11921,7 +12243,7 @@ interface BridgeParams<TFromAdapterCapabilities extends AdapterCapabilities = Ad
|
|
|
11921
12243
|
* Optional bridge configuration (e.g., transfer speed).
|
|
11922
12244
|
* If omitted, defaults will be used
|
|
11923
12245
|
*/
|
|
11924
|
-
config?:
|
|
12246
|
+
config?: BridgeExecutionConfig;
|
|
11925
12247
|
/**
|
|
11926
12248
|
* The token to transfer. Defaults to 'USDC'.
|
|
11927
12249
|
* If omitted, the provider will use 'USDC' by default.
|
|
@@ -11948,6 +12270,16 @@ interface BridgeParams<TFromAdapterCapabilities extends AdapterCapabilities = Ad
|
|
|
11948
12270
|
* ```
|
|
11949
12271
|
*/
|
|
11950
12272
|
invocationMeta?: InvocationMeta;
|
|
12273
|
+
/**
|
|
12274
|
+
* Reuse the opaque signed quote returned by a receive-exact estimate.
|
|
12275
|
+
*
|
|
12276
|
+
* @remarks
|
|
12277
|
+
* Bridge Kit validates a supplied quote against the exact transfer and fails
|
|
12278
|
+
* when it is invalid, mismatched, expired, or too close to expiry. Omit this
|
|
12279
|
+
* value to let Bridge Kit fetch a fresh quote automatically. Never log or
|
|
12280
|
+
* decode it.
|
|
12281
|
+
*/
|
|
12282
|
+
quote?: string;
|
|
11951
12283
|
}
|
|
11952
12284
|
/**
|
|
11953
12285
|
* Union of all chain definition types.
|
|
@@ -12010,6 +12342,9 @@ type CCTPV2SupportedChainType = FilterCCTPV2<AllChainDefinitions>['type'];
|
|
|
12010
12342
|
*
|
|
12011
12343
|
* // Get only chains that support forwarding
|
|
12012
12344
|
* const forwarderChains = kit.getSupportedChains({ forwarderSupported: true })
|
|
12345
|
+
*
|
|
12346
|
+
* // Get only chains that can pay fees on the source chain (receive-exact)
|
|
12347
|
+
* const sourceFeeChains = kit.getSupportedChains({ sourceFeeSupported: true })
|
|
12013
12348
|
* ```
|
|
12014
12349
|
*/
|
|
12015
12350
|
type GetSupportedChainsOptions$1 = {
|
|
@@ -12051,14 +12386,30 @@ type GetSupportedChainsOptions$1 = {
|
|
|
12051
12386
|
* - `undefined`: all chains (default)
|
|
12052
12387
|
*/
|
|
12053
12388
|
forwarderSupported?: boolean;
|
|
12389
|
+
/**
|
|
12390
|
+
* Filter chains by source-paid ("receive-exact") fee support.
|
|
12391
|
+
* A chain qualifies when it configures a `TokenMessengerWithFees` wrapper,
|
|
12392
|
+
* making it usable as a source for `config.feePayment: 'source'` transfers.
|
|
12393
|
+
* - `true`: only chains that support source-paid fees
|
|
12394
|
+
* - `false`: only chains that do not support source-paid fees
|
|
12395
|
+
* - `undefined`: all chains (default)
|
|
12396
|
+
*/
|
|
12397
|
+
sourceFeeSupported?: boolean;
|
|
12054
12398
|
} | {
|
|
12055
12399
|
chainType?: CCTPV2SupportedChainType | CCTPV2SupportedChainType[];
|
|
12056
12400
|
isTestnet: boolean;
|
|
12057
12401
|
forwarderSupported?: boolean;
|
|
12402
|
+
sourceFeeSupported?: boolean;
|
|
12058
12403
|
} | {
|
|
12059
12404
|
chainType?: CCTPV2SupportedChainType | CCTPV2SupportedChainType[];
|
|
12060
12405
|
isTestnet?: boolean;
|
|
12061
12406
|
forwarderSupported: boolean;
|
|
12407
|
+
sourceFeeSupported?: boolean;
|
|
12408
|
+
} | {
|
|
12409
|
+
chainType?: CCTPV2SupportedChainType | CCTPV2SupportedChainType[];
|
|
12410
|
+
isTestnet?: boolean;
|
|
12411
|
+
forwarderSupported?: boolean;
|
|
12412
|
+
sourceFeeSupported: boolean;
|
|
12062
12413
|
};
|
|
12063
12414
|
|
|
12064
12415
|
/**
|
|
@@ -12430,6 +12781,20 @@ interface CCTPV2Actions {
|
|
|
12430
12781
|
values: BridgeFetchAttestationStep;
|
|
12431
12782
|
};
|
|
12432
12783
|
}
|
|
12784
|
+
/**
|
|
12785
|
+
* Valid step names for CCTP v2 bridge operations.
|
|
12786
|
+
*
|
|
12787
|
+
* @remarks
|
|
12788
|
+
* Extracted from {@link CCTPV2Actions} to provide type-safe step name validation.
|
|
12789
|
+
* This ensures consistency across event dispatching, step analysis, and orchestration.
|
|
12790
|
+
*
|
|
12791
|
+
* @example
|
|
12792
|
+
* ```typescript
|
|
12793
|
+
* const stepName: CCTPV2StepName = 'approve' // Valid
|
|
12794
|
+
* const invalidStep: CCTPV2StepName = 'transfer' // TypeScript error
|
|
12795
|
+
* ```
|
|
12796
|
+
*/
|
|
12797
|
+
type CCTPV2StepName = keyof CCTPV2Actions;
|
|
12433
12798
|
/**
|
|
12434
12799
|
* CCTPv2 bridging provider interface.
|
|
12435
12800
|
*
|
|
@@ -12612,11 +12977,12 @@ interface CCTPV2Config {
|
|
|
12612
12977
|
headers?: Record<string, string>;
|
|
12613
12978
|
}
|
|
12614
12979
|
/**
|
|
12615
|
-
*
|
|
12980
|
+
* Common parameters for a prepaid-FORWARD burn via
|
|
12981
|
+
* {@link CCTPV2BridgingProvider.burnWithFees}.
|
|
12616
12982
|
*
|
|
12617
12983
|
* @typeParam TFromAdapterCapabilities - The source adapter's capabilities.
|
|
12618
12984
|
*/
|
|
12619
|
-
interface
|
|
12985
|
+
interface BurnWithFeesBaseParams<TFromAdapterCapabilities extends AdapterCapabilities = AdapterCapabilities> {
|
|
12620
12986
|
/**
|
|
12621
12987
|
* Source wallet context (adapter + CCTP v2 source chain).
|
|
12622
12988
|
*/
|
|
@@ -12629,14 +12995,6 @@ interface BurnWithFeesParams<TFromAdapterCapabilities extends AdapterCapabilitie
|
|
|
12629
12995
|
* Amount of USDC to burn, in minor units.
|
|
12630
12996
|
*/
|
|
12631
12997
|
amount: string | bigint;
|
|
12632
|
-
/**
|
|
12633
|
-
* The GenericExecutor address on the destination chain.
|
|
12634
|
-
*
|
|
12635
|
-
* Used for BOTH `mintRecipient` and `destinationCaller` (padded to bytes32 by
|
|
12636
|
-
* the underlying action): the executor mints to itself and is the only account
|
|
12637
|
-
* allowed to complete the transfer.
|
|
12638
|
-
*/
|
|
12639
|
-
executor: string;
|
|
12640
12998
|
/**
|
|
12641
12999
|
* The `cctp-forward`-wrapped GenericExecutor hookData blob.
|
|
12642
13000
|
*
|
|
@@ -12663,6 +13021,75 @@ interface BurnWithFeesParams<TFromAdapterCapabilities extends AdapterCapabilitie
|
|
|
12663
13021
|
*/
|
|
12664
13022
|
feeTotalAmount: string | bigint;
|
|
12665
13023
|
}
|
|
13024
|
+
/**
|
|
13025
|
+
* Route a prepaid burn through a destination GenericExecutor.
|
|
13026
|
+
*
|
|
13027
|
+
* @example
|
|
13028
|
+
* ```typescript
|
|
13029
|
+
* const destination = { executor: '0x1234567890123456789012345678901234567890' }
|
|
13030
|
+
* ```
|
|
13031
|
+
*/
|
|
13032
|
+
interface ExecutorBurnDestination {
|
|
13033
|
+
/** Use this address for both the mint recipient and destination caller. */
|
|
13034
|
+
executor: string;
|
|
13035
|
+
/** Exclude a direct mint recipient when an executor is supplied. */
|
|
13036
|
+
mintRecipient?: never;
|
|
13037
|
+
/** Exclude a direct destination caller when an executor is supplied. */
|
|
13038
|
+
destinationCaller?: never;
|
|
13039
|
+
}
|
|
13040
|
+
/**
|
|
13041
|
+
* Route a prepaid forwarding burn directly to its final mint recipient.
|
|
13042
|
+
*
|
|
13043
|
+
* @example
|
|
13044
|
+
* ```typescript
|
|
13045
|
+
* const destination = {
|
|
13046
|
+
* mintRecipient: '0x1234567890123456789012345678901234567890',
|
|
13047
|
+
* destinationCaller: '0x0000000000000000000000000000000000000000',
|
|
13048
|
+
* }
|
|
13049
|
+
* ```
|
|
13050
|
+
*/
|
|
13051
|
+
interface DirectBurnDestination {
|
|
13052
|
+
/** The final destination account that receives the CCTP mint. */
|
|
13053
|
+
mintRecipient: string;
|
|
13054
|
+
/** The caller authorized to submit the mint; use the zero address for forwarding. */
|
|
13055
|
+
destinationCaller: string;
|
|
13056
|
+
/** Exclude the GenericExecutor shorthand for a direct mint. */
|
|
13057
|
+
executor?: never;
|
|
13058
|
+
}
|
|
13059
|
+
/**
|
|
13060
|
+
* Parameters for a source-paid signed-fee CCTP burn.
|
|
13061
|
+
*
|
|
13062
|
+
* @remarks
|
|
13063
|
+
* Supply `executor` for a GenericExecutor flow, or supply both
|
|
13064
|
+
* `mintRecipient` and `destinationCaller` for direct forwarding.
|
|
13065
|
+
*
|
|
13066
|
+
* @typeParam TFromAdapterCapabilities - The source adapter's capabilities.
|
|
13067
|
+
*
|
|
13068
|
+
* @example
|
|
13069
|
+
* ```typescript
|
|
13070
|
+
* import type { BurnWithFeesParams } from '@circle-fin/provider-cctp-v2'
|
|
13071
|
+
*
|
|
13072
|
+
* declare const source: BurnWithFeesParams['source']
|
|
13073
|
+
* declare const destinationChain: BurnWithFeesParams['destinationChain']
|
|
13074
|
+
* declare const recipient: string
|
|
13075
|
+
* declare const hookData: string
|
|
13076
|
+
* declare const claim: BurnWithFeesParams['claim']
|
|
13077
|
+
*
|
|
13078
|
+
* const params: BurnWithFeesParams = {
|
|
13079
|
+
* source,
|
|
13080
|
+
* destinationChain,
|
|
13081
|
+
* amount: 1_000_000n,
|
|
13082
|
+
* mintRecipient: recipient,
|
|
13083
|
+
* destinationCaller: '0x0000000000000000000000000000000000000000',
|
|
13084
|
+
* hookData,
|
|
13085
|
+
* claim,
|
|
13086
|
+
* feeToken: source.chain.usdcAddress,
|
|
13087
|
+
* feeTotalAmount: 10_000n,
|
|
13088
|
+
* }
|
|
13089
|
+
* ```
|
|
13090
|
+
* @since 1.11.0
|
|
13091
|
+
*/
|
|
13092
|
+
type BurnWithFeesParams<TFromAdapterCapabilities extends AdapterCapabilities = AdapterCapabilities> = BurnWithFeesBaseParams<TFromAdapterCapabilities> & (ExecutorBurnDestination | DirectBurnDestination);
|
|
12666
13093
|
/**
|
|
12667
13094
|
* Result of {@link CCTPV2BridgingProvider.burnWithFees}.
|
|
12668
13095
|
*
|
|
@@ -12750,6 +13177,33 @@ declare class CCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> imp
|
|
|
12750
13177
|
* @param config - Optional configuration overrides for the provider
|
|
12751
13178
|
*/
|
|
12752
13179
|
constructor(config?: CCTPV2Config);
|
|
13180
|
+
/**
|
|
13181
|
+
* Emit a bridge step event through the provider's registered action
|
|
13182
|
+
* dispatcher.
|
|
13183
|
+
*
|
|
13184
|
+
* Kit-level orchestration that drives the burn primitives directly instead
|
|
13185
|
+
* of {@link CCTPV2BridgingProvider.bridge} (for example the receive-exact
|
|
13186
|
+
* source-fee flow) uses this to surface the same `approve`/`burn`/`mint`
|
|
13187
|
+
* events as the standard bridge path. It is a no-op when no dispatcher is
|
|
13188
|
+
* registered.
|
|
13189
|
+
*
|
|
13190
|
+
* @param name - The step name (`approve`, `burn`, `mint`, ...).
|
|
13191
|
+
* @param step - The completed bridge step to broadcast.
|
|
13192
|
+
* @param invocation - Optional invocation context carrying a `traceId` for
|
|
13193
|
+
* end-to-end correlation.
|
|
13194
|
+
* @returns Nothing.
|
|
13195
|
+
*
|
|
13196
|
+
* @example
|
|
13197
|
+
* ```typescript
|
|
13198
|
+
* const provider = new CCTPV2BridgingProvider()
|
|
13199
|
+
* provider.emitBridgeStep('burn', {
|
|
13200
|
+
* name: 'burn',
|
|
13201
|
+
* state: 'success',
|
|
13202
|
+
* txHash: '0xabc...',
|
|
13203
|
+
* })
|
|
13204
|
+
* ```
|
|
13205
|
+
*/
|
|
13206
|
+
emitBridgeStep(name: CCTPV2StepName, step: BridgeStep, invocation?: InvocationContext): void;
|
|
12753
13207
|
/**
|
|
12754
13208
|
* Resolves the effective polling configuration for an attestation request.
|
|
12755
13209
|
*
|
|
@@ -13197,13 +13651,14 @@ declare class CCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> imp
|
|
|
13197
13651
|
/**
|
|
13198
13652
|
* Prepare a prepaid-FORWARD burn through the `TokenMessengerWithFees` wrapper.
|
|
13199
13653
|
*
|
|
13200
|
-
*
|
|
13201
|
-
*
|
|
13202
|
-
*
|
|
13203
|
-
*
|
|
13654
|
+
* Build the source-chain `depositForBurnWithHookAndFees` call. Fees are
|
|
13655
|
+
* collected up front on the source chain against a signed quote. The
|
|
13656
|
+
* destination may use the GenericExecutor shorthand, or an explicit mint
|
|
13657
|
+
* recipient and destination caller for direct forwarding.
|
|
13204
13658
|
*
|
|
13205
|
-
* This is the low-level on-chain primitive behind the
|
|
13206
|
-
*
|
|
13659
|
+
* This is the low-level on-chain primitive behind the Unified Balance Kit
|
|
13660
|
+
* `fastCrossChainDeposit` and the Bridge Kit source-fee
|
|
13661
|
+
* (`feePayment: 'source'`) flow. The `hookData` and signed-quote
|
|
13207
13662
|
* `claim` are produced elsewhere and passed in here:
|
|
13208
13663
|
* - `hookData`: `buildForwardingHookDataWithPayload(version,
|
|
13209
13664
|
* buildDepositForGenericExecutorPayload(...).hookData)` from `@core/utils`.
|
|
@@ -13220,25 +13675,38 @@ declare class CCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> imp
|
|
|
13220
13675
|
* approval covers both; the redundant second approval is skipped.
|
|
13221
13676
|
*
|
|
13222
13677
|
* @typeParam TFromAdapterCapabilities - The source adapter's capabilities.
|
|
13223
|
-
* @param params - The burn amount,
|
|
13678
|
+
* @param params - The burn amount, destination, hook data, signed quote, and fee.
|
|
13224
13679
|
* @returns The prepared approvals, the prepared burn, and the resolved fee plan.
|
|
13225
13680
|
* @throws {KitError} If the wallet context is invalid, `destinationChain` does not
|
|
13226
|
-
* support CCTP v2, the
|
|
13227
|
-
* a bigint or a numeric string coercible to bigint,
|
|
13228
|
-
* `cctp-forward` frame (guaranteed
|
|
13229
|
-
* context cannot be resolved.
|
|
13681
|
+
* support CCTP v2, the destination fields are missing, `amount` or
|
|
13682
|
+
* `feeTotalAmount` is not a bigint or a numeric string coercible to bigint,
|
|
13683
|
+
* the hook data lacks a `cctp-forward` frame (guaranteed
|
|
13684
|
+
* `ForwardFeeWithoutHook`), or the operation context cannot be resolved.
|
|
13230
13685
|
*
|
|
13231
13686
|
* @example
|
|
13232
13687
|
* ```typescript
|
|
13688
|
+
* import {
|
|
13689
|
+
* CCTPV2BridgingProvider,
|
|
13690
|
+
* type BurnWithFeesParams,
|
|
13691
|
+
* } from '@circle-fin/provider-cctp-v2'
|
|
13692
|
+
*
|
|
13693
|
+
* declare const source: BurnWithFeesParams['source']
|
|
13694
|
+
* declare const destinationChain: BurnWithFeesParams['destinationChain']
|
|
13695
|
+
* declare const recipient: string
|
|
13696
|
+
* declare const hookData: string
|
|
13697
|
+
* declare const claim: BurnWithFeesParams['claim']
|
|
13698
|
+
*
|
|
13699
|
+
* const provider = new CCTPV2BridgingProvider()
|
|
13233
13700
|
* const { approvals, burn } = await provider.burnWithFees({
|
|
13234
13701
|
* source,
|
|
13235
|
-
* destinationChain
|
|
13702
|
+
* destinationChain,
|
|
13236
13703
|
* amount: 1_000_000n,
|
|
13237
|
-
*
|
|
13238
|
-
*
|
|
13239
|
-
*
|
|
13240
|
-
*
|
|
13241
|
-
*
|
|
13704
|
+
* mintRecipient: recipient,
|
|
13705
|
+
* destinationCaller: '0x0000000000000000000000000000000000000000',
|
|
13706
|
+
* hookData,
|
|
13707
|
+
* claim,
|
|
13708
|
+
* feeToken: source.chain.usdcAddress,
|
|
13709
|
+
* feeTotalAmount: 10_000n,
|
|
13242
13710
|
* })
|
|
13243
13711
|
* for (const approval of approvals) await approval.execute()
|
|
13244
13712
|
* const txHash = await burn.execute()
|
|
@@ -13762,6 +14230,11 @@ declare class BridgeKit<TExtraProviders extends FlexibleBridgingProvider[] = []>
|
|
|
13762
14230
|
* })
|
|
13763
14231
|
* ```
|
|
13764
14232
|
*/
|
|
14233
|
+
estimate<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities>(params: BridgeParams<TFromAdapterCapabilities, TToAdapterCapabilities> & {
|
|
14234
|
+
config: {
|
|
14235
|
+
feePayment: 'source';
|
|
14236
|
+
};
|
|
14237
|
+
}): Promise<ReceiveExactEstimateResult>;
|
|
13765
14238
|
estimate<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities>(params: BridgeParams<TFromAdapterCapabilities, TToAdapterCapabilities>): Promise<EstimateResult$1>;
|
|
13766
14239
|
/**
|
|
13767
14240
|
* Get all chains supported by any provider in the kit, with optional filtering.
|
|
@@ -13801,6 +14274,9 @@ declare class BridgeKit<TExtraProviders extends FlexibleBridgingProvider[] = []>
|
|
|
13801
14274
|
* // Get only chains that support forwarding
|
|
13802
14275
|
* const forwarderChains = kit.getSupportedChains({ forwarderSupported: true })
|
|
13803
14276
|
*
|
|
14277
|
+
* // Get only chains that can pay fees on the source chain (receive-exact)
|
|
14278
|
+
* const sourceFeeChains = kit.getSupportedChains({ sourceFeeSupported: true })
|
|
14279
|
+
*
|
|
13804
14280
|
* console.log('Supported chains:')
|
|
13805
14281
|
* allChains.forEach(chain => {
|
|
13806
14282
|
* console.log(`- ${chain.name} (${chain.type})`)
|
|
@@ -13831,6 +14307,15 @@ declare class BridgeKit<TExtraProviders extends FlexibleBridgingProvider[] = []>
|
|
|
13831
14307
|
* @throws Will throw an error if no provider supports the route
|
|
13832
14308
|
*/
|
|
13833
14309
|
private findProviderForRoute;
|
|
14310
|
+
/**
|
|
14311
|
+
* Find the default CCTP v2 provider for a source-fee forwarding route.
|
|
14312
|
+
*
|
|
14313
|
+
* @param params - The resolved provider parameters.
|
|
14314
|
+
* @returns The CCTP v2 provider that supports the forwarded route.
|
|
14315
|
+
* @throws {UnsupportedRouteError} When no source-fee provider supports the route.
|
|
14316
|
+
* @internal
|
|
14317
|
+
*/
|
|
14318
|
+
private findSourceFeeProvider;
|
|
13834
14319
|
/**
|
|
13835
14320
|
* Merge custom fee configuration into provider parameters.
|
|
13836
14321
|
*
|
|
@@ -14074,12 +14559,21 @@ interface ServiceSwapConfig {
|
|
|
14074
14559
|
recipientAddress?: string;
|
|
14075
14560
|
};
|
|
14076
14561
|
/**
|
|
14077
|
-
*
|
|
14078
|
-
*
|
|
14562
|
+
* Circle API key used to authenticate service-backed swap requests.
|
|
14563
|
+
*
|
|
14564
|
+
* Format: `<ENV>_API_KEY:<keyId>:<keySecret>`. A legacy
|
|
14565
|
+
* `KIT_KEY:<keyId>:<keySecret>` value is also accepted.
|
|
14079
14566
|
*
|
|
14080
14567
|
* Treat this value as a credential. Do not log it, embed it in client-side
|
|
14081
14568
|
* source, or expose it in telemetry.
|
|
14082
14569
|
*/
|
|
14570
|
+
apiKey?: string | undefined;
|
|
14571
|
+
/**
|
|
14572
|
+
* Circle API key used to authenticate service-backed swap requests.
|
|
14573
|
+
*
|
|
14574
|
+
* @deprecated Use {@link ServiceSwapConfig.apiKey} instead. Still honored
|
|
14575
|
+
* when `apiKey` is omitted, and `apiKey` takes precedence when both are set.
|
|
14576
|
+
*/
|
|
14083
14577
|
kitKey?: string;
|
|
14084
14578
|
/**
|
|
14085
14579
|
* DEX aggregator identifier used to source the swap route.
|
|
@@ -15077,12 +15571,21 @@ interface SwapConfig {
|
|
|
15077
15571
|
recipientAddress: string;
|
|
15078
15572
|
};
|
|
15079
15573
|
/**
|
|
15080
|
-
*
|
|
15081
|
-
*
|
|
15574
|
+
* Circle API key used to authenticate service-backed swap requests.
|
|
15575
|
+
*
|
|
15576
|
+
* Format: `<ENV>_API_KEY:<keyId>:<keySecret>`. A legacy
|
|
15577
|
+
* `KIT_KEY:<keyId>:<keySecret>` value is also accepted.
|
|
15082
15578
|
*
|
|
15083
15579
|
* Treat this value as a credential. Do not log it, embed it in client-side
|
|
15084
15580
|
* source, or expose it in telemetry.
|
|
15085
15581
|
*/
|
|
15582
|
+
apiKey?: string | undefined;
|
|
15583
|
+
/**
|
|
15584
|
+
* Circle API key used to authenticate service-backed swap requests.
|
|
15585
|
+
*
|
|
15586
|
+
* @deprecated Use {@link SwapConfig.apiKey} instead. Still honored when
|
|
15587
|
+
* `apiKey` is omitted, and `apiKey` takes precedence when both are set.
|
|
15588
|
+
*/
|
|
15086
15589
|
kitKey?: string;
|
|
15087
15590
|
}
|
|
15088
15591
|
/**
|
|
@@ -15234,7 +15737,13 @@ interface ResolvedSwapConfig extends Omit<SwapConfig, 'customFee'> {
|
|
|
15234
15737
|
recipientAddress?: string;
|
|
15235
15738
|
};
|
|
15236
15739
|
}
|
|
15237
|
-
|
|
15740
|
+
/**
|
|
15741
|
+
* Swap config as echoed back on a result, with credentials removed.
|
|
15742
|
+
*
|
|
15743
|
+
* Both credential fields are omitted so a returned {@link SwapResult} can be
|
|
15744
|
+
* logged or serialized without leaking the secret used to authenticate it.
|
|
15745
|
+
*/
|
|
15746
|
+
type SwapResultConfig = Omit<ResolvedSwapConfig, 'apiKey' | 'kitKey'>;
|
|
15238
15747
|
/**
|
|
15239
15748
|
* Result of an executed swap operation.
|
|
15240
15749
|
*
|
|
@@ -15555,9 +16064,9 @@ interface SwapDestinationLeg {
|
|
|
15555
16064
|
* Parameters for {@link SwapKit.getSwapStatus}.
|
|
15556
16065
|
*
|
|
15557
16066
|
* @remarks
|
|
15558
|
-
* Only `txHash` and `chainIn` are required; `chainOut` and `
|
|
16067
|
+
* Only `txHash` and `chainIn` are required; `chainOut` and `apiKey` are
|
|
15559
16068
|
* optional. Supply `chainOut` when the original swap was cross-chain
|
|
15560
|
-
* (source chain ≠ destination chain); omit `
|
|
16069
|
+
* (source chain ≠ destination chain); omit `apiKey` to call in
|
|
15561
16070
|
* permissionless mode.
|
|
15562
16071
|
*
|
|
15563
16072
|
* The field names mirror {@link SwapResult.chainIn} / {@link
|
|
@@ -15573,7 +16082,7 @@ interface SwapDestinationLeg {
|
|
|
15573
16082
|
* ```typescript
|
|
15574
16083
|
* const result = await kit.swap(params)
|
|
15575
16084
|
*
|
|
15576
|
-
* // Permissionless — no
|
|
16085
|
+
* // Permissionless — no credential needed. Pass `apiKey` to authenticate.
|
|
15577
16086
|
* let status = await kit.getSwapStatus({
|
|
15578
16087
|
* txHash: result.txHash,
|
|
15579
16088
|
* chainIn: result.chainIn,
|
|
@@ -15610,12 +16119,19 @@ interface GetSwapStatusParams {
|
|
|
15610
16119
|
*/
|
|
15611
16120
|
chainOut?: SwapChainIdentifier | Blockchain;
|
|
15612
16121
|
/**
|
|
15613
|
-
*
|
|
15614
|
-
*
|
|
16122
|
+
* Circle API key used as a bearer credential for the status request. Treat
|
|
16123
|
+
* this value as a secret and do not log it.
|
|
15615
16124
|
*
|
|
15616
16125
|
* Optional — when omitted, the request is made without an `Authorization`
|
|
15617
16126
|
* header (permissionless mode).
|
|
15618
16127
|
*/
|
|
16128
|
+
apiKey?: string | undefined;
|
|
16129
|
+
/**
|
|
16130
|
+
* Circle API key used as a bearer credential for the status request.
|
|
16131
|
+
*
|
|
16132
|
+
* @deprecated Use {@link GetSwapStatusParams.apiKey} instead. Still honored
|
|
16133
|
+
* when `apiKey` is omitted, and `apiKey` takes precedence when both are set.
|
|
16134
|
+
*/
|
|
15619
16135
|
kitKey?: string;
|
|
15620
16136
|
}
|
|
15621
16137
|
/**
|
|
@@ -15662,12 +16178,19 @@ interface SwapStatusResult {
|
|
|
15662
16178
|
*/
|
|
15663
16179
|
interface WaitForSwapCommonParams {
|
|
15664
16180
|
/**
|
|
15665
|
-
*
|
|
15666
|
-
*
|
|
16181
|
+
* Circle API key used as a bearer credential. Treat as a secret and do not
|
|
16182
|
+
* log it.
|
|
15667
16183
|
*
|
|
15668
16184
|
* Optional — when omitted, the request is made without an `Authorization`
|
|
15669
16185
|
* header (permissionless mode).
|
|
15670
16186
|
*/
|
|
16187
|
+
readonly apiKey?: string | undefined;
|
|
16188
|
+
/**
|
|
16189
|
+
* Circle API key used as a bearer credential.
|
|
16190
|
+
*
|
|
16191
|
+
* @deprecated Use `apiKey` instead. Still honored when `apiKey` is omitted,
|
|
16192
|
+
* and `apiKey` takes precedence when both are set.
|
|
16193
|
+
*/
|
|
15671
16194
|
readonly kitKey?: string;
|
|
15672
16195
|
/**
|
|
15673
16196
|
* Overall wait budget, in milliseconds. The promise rejects with a
|
|
@@ -15693,7 +16216,7 @@ interface WaitForSwapCommonParams {
|
|
|
15693
16216
|
* @example
|
|
15694
16217
|
* ```typescript
|
|
15695
16218
|
* const result = await kit.swap(params)
|
|
15696
|
-
* const final = await kit.waitForSwap({ result,
|
|
16219
|
+
* const final = await kit.waitForSwap({ result, apiKey })
|
|
15697
16220
|
* ```
|
|
15698
16221
|
*/
|
|
15699
16222
|
interface WaitForSwapResultParams extends WaitForSwapCommonParams {
|
|
@@ -15715,7 +16238,7 @@ interface WaitForSwapResultParams extends WaitForSwapCommonParams {
|
|
|
15715
16238
|
* txHash: '0x…',
|
|
15716
16239
|
* chainIn: 'Ethereum',
|
|
15717
16240
|
* chainOut: 'Base',
|
|
15718
|
-
*
|
|
16241
|
+
* apiKey,
|
|
15719
16242
|
* })
|
|
15720
16243
|
* ```
|
|
15721
16244
|
*/
|
|
@@ -15760,7 +16283,7 @@ interface WaitForSwapDiscreteParams extends WaitForSwapCommonParams {
|
|
|
15760
16283
|
*
|
|
15761
16284
|
* const final = await kit.waitForSwap({
|
|
15762
16285
|
* result,
|
|
15763
|
-
*
|
|
16286
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
15764
16287
|
* onProgress: (snapshot) => console.log(snapshot.progress.status),
|
|
15765
16288
|
* })
|
|
15766
16289
|
*
|
|
@@ -15776,7 +16299,7 @@ interface WaitForSwapDiscreteParams extends WaitForSwapCommonParams {
|
|
|
15776
16299
|
* txHash: persisted.txHash,
|
|
15777
16300
|
* chainIn: persisted.chainIn,
|
|
15778
16301
|
* chainOut: persisted.chainOut,
|
|
15779
|
-
*
|
|
16302
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
15780
16303
|
* })
|
|
15781
16304
|
* ```
|
|
15782
16305
|
*/
|
|
@@ -15795,7 +16318,7 @@ type WaitForSwapParams = WaitForSwapResultParams | WaitForSwapDiscreteParams;
|
|
|
15795
16318
|
* const params: GetTokenRatesParams = {
|
|
15796
16319
|
* chain: 'Ethereum',
|
|
15797
16320
|
* tokens: ['USDC', 'EURC'],
|
|
15798
|
-
*
|
|
16321
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
15799
16322
|
* }
|
|
15800
16323
|
* ```
|
|
15801
16324
|
*/
|
|
@@ -15827,12 +16350,19 @@ interface GetTokenRatesParams {
|
|
|
15827
16350
|
*/
|
|
15828
16351
|
tokens?: readonly TokenSymbol[];
|
|
15829
16352
|
/**
|
|
15830
|
-
*
|
|
15831
|
-
*
|
|
16353
|
+
* Circle API key used as a bearer credential for the rates request. Treat
|
|
16354
|
+
* this value as a secret and do not log it.
|
|
15832
16355
|
*
|
|
15833
16356
|
* Optional — when omitted, the request is made without an `Authorization`
|
|
15834
16357
|
* header (permissionless mode).
|
|
15835
16358
|
*/
|
|
16359
|
+
apiKey?: string | undefined;
|
|
16360
|
+
/**
|
|
16361
|
+
* Circle API key used as a bearer credential for the rates request.
|
|
16362
|
+
*
|
|
16363
|
+
* @deprecated Use {@link GetTokenRatesParams.apiKey} instead. Still honored
|
|
16364
|
+
* when `apiKey` is omitted, and `apiKey` takes precedence when both are set.
|
|
16365
|
+
*/
|
|
15836
16366
|
kitKey?: string;
|
|
15837
16367
|
}
|
|
15838
16368
|
/**
|
|
@@ -15848,7 +16378,7 @@ interface GetTokenRatesParams {
|
|
|
15848
16378
|
* const { rates } = await kit.getTokenRates({
|
|
15849
16379
|
* chain: 'Ethereum',
|
|
15850
16380
|
* tokens: ['USDC'],
|
|
15851
|
-
*
|
|
16381
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
15852
16382
|
* })
|
|
15853
16383
|
*
|
|
15854
16384
|
* const usdc = rates['Ethereum']?.['0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48']
|
|
@@ -16051,16 +16581,24 @@ declare const bridgeQuoteExpirySchema: z.ZodCatch<z.ZodOptional<z.ZodDiscriminat
|
|
|
16051
16581
|
* @example
|
|
16052
16582
|
* ```typescript
|
|
16053
16583
|
* const config: EarnServiceConfig = {
|
|
16054
|
-
*
|
|
16584
|
+
* apiKey: 'TEST_API_KEY:abc123:secret456',
|
|
16055
16585
|
* baseUrl: 'https://api.circle.com',
|
|
16056
16586
|
* }
|
|
16057
16587
|
* ```
|
|
16058
16588
|
*/
|
|
16059
16589
|
interface EarnServiceConfig {
|
|
16060
16590
|
/**
|
|
16061
|
-
* Optional
|
|
16591
|
+
* Optional Circle API key for permissioned access.
|
|
16592
|
+
*
|
|
16593
|
+
* When present, must match `<ENV>_API_KEY:<keyId>:<keySecret>`, or the legacy
|
|
16594
|
+
* `KIT_KEY:<keyId>:<keySecret>`.
|
|
16595
|
+
*/
|
|
16596
|
+
readonly apiKey?: string | undefined;
|
|
16597
|
+
/**
|
|
16598
|
+
* Optional Circle API key for permissioned access.
|
|
16062
16599
|
*
|
|
16063
|
-
*
|
|
16600
|
+
* @deprecated Use {@link EarnServiceConfig.apiKey} instead. Still honored
|
|
16601
|
+
* when `apiKey` is omitted, and `apiKey` takes precedence when both are set.
|
|
16064
16602
|
*/
|
|
16065
16603
|
readonly kitKey?: string | undefined;
|
|
16066
16604
|
/**
|
|
@@ -18213,9 +18751,9 @@ declare function isTerminalCrossChainDepositStatus(status: EarnCrossChainDeposit
|
|
|
18213
18751
|
* // Permissionless mode
|
|
18214
18752
|
* const provider = new EarnServiceProvider()
|
|
18215
18753
|
*
|
|
18216
|
-
* // Permissioned mode with
|
|
18754
|
+
* // Permissioned mode with an API key
|
|
18217
18755
|
* const provider = new EarnServiceProvider({
|
|
18218
|
-
*
|
|
18756
|
+
* apiKey: 'TEST_API_KEY:keyId:keySecret',
|
|
18219
18757
|
* })
|
|
18220
18758
|
*
|
|
18221
18759
|
* // Custom base URL for testing
|
|
@@ -18404,29 +18942,37 @@ type EarnAdapterContext<TAdapterCapabilities extends AdapterCapabilities = Adapt
|
|
|
18404
18942
|
* Configuration options for earn operations.
|
|
18405
18943
|
*
|
|
18406
18944
|
* EarnKit supports dual-mode authentication: operations work both with
|
|
18407
|
-
* and without
|
|
18945
|
+
* and without an API key. When present, the API key enables permissioned
|
|
18408
18946
|
* features like integrator attribution tracking.
|
|
18409
18947
|
*
|
|
18410
18948
|
* @example
|
|
18411
18949
|
* ```typescript
|
|
18412
|
-
* // Permissionless (no
|
|
18950
|
+
* // Permissionless (no API key)
|
|
18413
18951
|
* const config: EarnConfig = {}
|
|
18414
18952
|
*
|
|
18415
|
-
* // Permissioned (with
|
|
18953
|
+
* // Permissioned (with API key)
|
|
18416
18954
|
* const config: EarnConfig = {
|
|
18417
|
-
*
|
|
18955
|
+
* apiKey: 'TEST_API_KEY:keyId:keySecret',
|
|
18418
18956
|
* }
|
|
18419
18957
|
* ```
|
|
18420
18958
|
*/
|
|
18421
18959
|
interface EarnConfig {
|
|
18422
18960
|
/**
|
|
18423
|
-
* Optional
|
|
18961
|
+
* Optional Circle API key for permissioned access.
|
|
18424
18962
|
*
|
|
18425
18963
|
* When provided, enables integrator attribution tracking and
|
|
18426
18964
|
* higher rate limits. When omitted, the SDK operates in
|
|
18427
18965
|
* permissionless mode.
|
|
18428
18966
|
*
|
|
18429
|
-
* Format:
|
|
18967
|
+
* Format: `<ENV>_API_KEY:<keyId>:<keySecret>`. A legacy
|
|
18968
|
+
* `KIT_KEY:<keyId>:<keySecret>` value is also accepted.
|
|
18969
|
+
*/
|
|
18970
|
+
readonly apiKey?: string | undefined;
|
|
18971
|
+
/**
|
|
18972
|
+
* Optional Circle API key for permissioned access.
|
|
18973
|
+
*
|
|
18974
|
+
* @deprecated Use {@link EarnConfig.apiKey} instead. Still honored when
|
|
18975
|
+
* `apiKey` is omitted, and `apiKey` takes precedence when both are set.
|
|
18430
18976
|
*/
|
|
18431
18977
|
readonly kitKey?: string | undefined;
|
|
18432
18978
|
/**
|
|
@@ -20268,8 +20814,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20268
20814
|
type: z.ZodLiteral<"evm">;
|
|
20269
20815
|
chainId: z.ZodNumber;
|
|
20270
20816
|
}, "strict", z.ZodTypeAny, {
|
|
20271
|
-
name: string;
|
|
20272
20817
|
type: "evm";
|
|
20818
|
+
name: string;
|
|
20273
20819
|
chain: Blockchain;
|
|
20274
20820
|
nativeCurrency: {
|
|
20275
20821
|
symbol: string;
|
|
@@ -20304,8 +20850,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20304
20850
|
adapter?: string | undefined;
|
|
20305
20851
|
} | undefined;
|
|
20306
20852
|
}, {
|
|
20307
|
-
name: string;
|
|
20308
20853
|
type: "evm";
|
|
20854
|
+
name: string;
|
|
20309
20855
|
chain: Blockchain;
|
|
20310
20856
|
nativeCurrency: {
|
|
20311
20857
|
symbol: string;
|
|
@@ -20442,8 +20988,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20442
20988
|
} & {
|
|
20443
20989
|
type: z.ZodEnum<["algorand", "avalanche", "solana", "aptos", "near", "stellar", "sui", "hedera", "noble", "polkadot"]>;
|
|
20444
20990
|
}, "strict", z.ZodTypeAny, {
|
|
20445
|
-
name: string;
|
|
20446
20991
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
20992
|
+
name: string;
|
|
20447
20993
|
chain: Blockchain;
|
|
20448
20994
|
nativeCurrency: {
|
|
20449
20995
|
symbol: string;
|
|
@@ -20477,8 +21023,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20477
21023
|
adapter?: string | undefined;
|
|
20478
21024
|
} | undefined;
|
|
20479
21025
|
}, {
|
|
20480
|
-
name: string;
|
|
20481
21026
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
21027
|
+
name: string;
|
|
20482
21028
|
chain: Blockchain;
|
|
20483
21029
|
nativeCurrency: {
|
|
20484
21030
|
symbol: string;
|
|
@@ -20512,8 +21058,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20512
21058
|
adapter?: string | undefined;
|
|
20513
21059
|
} | undefined;
|
|
20514
21060
|
}>]>, {
|
|
20515
|
-
name: string;
|
|
20516
21061
|
type: "evm";
|
|
21062
|
+
name: string;
|
|
20517
21063
|
chain: Blockchain;
|
|
20518
21064
|
nativeCurrency: {
|
|
20519
21065
|
symbol: string;
|
|
@@ -20548,8 +21094,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20548
21094
|
adapter?: string | undefined;
|
|
20549
21095
|
} | undefined;
|
|
20550
21096
|
} | {
|
|
20551
|
-
name: string;
|
|
20552
21097
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
21098
|
+
name: string;
|
|
20553
21099
|
chain: Blockchain;
|
|
20554
21100
|
nativeCurrency: {
|
|
20555
21101
|
symbol: string;
|
|
@@ -20583,8 +21129,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20583
21129
|
adapter?: string | undefined;
|
|
20584
21130
|
} | undefined;
|
|
20585
21131
|
}, {
|
|
20586
|
-
name: string;
|
|
20587
21132
|
type: "evm";
|
|
21133
|
+
name: string;
|
|
20588
21134
|
chain: Blockchain;
|
|
20589
21135
|
nativeCurrency: {
|
|
20590
21136
|
symbol: string;
|
|
@@ -20619,8 +21165,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20619
21165
|
adapter?: string | undefined;
|
|
20620
21166
|
} | undefined;
|
|
20621
21167
|
} | {
|
|
20622
|
-
name: string;
|
|
20623
21168
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
21169
|
+
name: string;
|
|
20624
21170
|
chain: Blockchain;
|
|
20625
21171
|
nativeCurrency: {
|
|
20626
21172
|
symbol: string;
|
|
@@ -20657,8 +21203,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20657
21203
|
vaultAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, string, string>, `0x${string}`, string>, `0x${string}`, string>;
|
|
20658
21204
|
}, "strip", z.ZodTypeAny, {
|
|
20659
21205
|
chain: string | {
|
|
20660
|
-
name: string;
|
|
20661
21206
|
type: "evm";
|
|
21207
|
+
name: string;
|
|
20662
21208
|
chain: Blockchain;
|
|
20663
21209
|
nativeCurrency: {
|
|
20664
21210
|
symbol: string;
|
|
@@ -20693,8 +21239,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20693
21239
|
adapter?: string | undefined;
|
|
20694
21240
|
} | undefined;
|
|
20695
21241
|
} | {
|
|
20696
|
-
name: string;
|
|
20697
21242
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
21243
|
+
name: string;
|
|
20698
21244
|
chain: Blockchain;
|
|
20699
21245
|
nativeCurrency: {
|
|
20700
21246
|
symbol: string;
|
|
@@ -20731,8 +21277,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20731
21277
|
vaultAddress: `0x${string}`;
|
|
20732
21278
|
}, {
|
|
20733
21279
|
chain: string | {
|
|
20734
|
-
name: string;
|
|
20735
21280
|
type: "evm";
|
|
21281
|
+
name: string;
|
|
20736
21282
|
chain: Blockchain;
|
|
20737
21283
|
nativeCurrency: {
|
|
20738
21284
|
symbol: string;
|
|
@@ -20767,8 +21313,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20767
21313
|
adapter?: string | undefined;
|
|
20768
21314
|
} | undefined;
|
|
20769
21315
|
} | {
|
|
20770
|
-
name: string;
|
|
20771
21316
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
21317
|
+
name: string;
|
|
20772
21318
|
chain: Blockchain;
|
|
20773
21319
|
nativeCurrency: {
|
|
20774
21320
|
symbol: string;
|
|
@@ -20804,15 +21350,28 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20804
21350
|
};
|
|
20805
21351
|
vaultAddress: string;
|
|
20806
21352
|
}>, "many">;
|
|
20807
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
21353
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
21354
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
20808
21355
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
20809
21356
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
20810
21357
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
20811
21358
|
}, "strict", z.ZodTypeAny, {
|
|
21359
|
+
apiKey?: string | undefined;
|
|
20812
21360
|
kitKey?: string | undefined;
|
|
20813
21361
|
baseUrl?: string | undefined;
|
|
20814
21362
|
batchTransactions?: boolean | undefined;
|
|
20815
21363
|
}, {
|
|
21364
|
+
apiKey?: string | undefined;
|
|
21365
|
+
kitKey?: string | undefined;
|
|
21366
|
+
baseUrl?: string | undefined;
|
|
21367
|
+
batchTransactions?: boolean | undefined;
|
|
21368
|
+
}>, {
|
|
21369
|
+
apiKey?: string | undefined;
|
|
21370
|
+
kitKey?: string | undefined;
|
|
21371
|
+
baseUrl?: string | undefined;
|
|
21372
|
+
batchTransactions?: boolean | undefined;
|
|
21373
|
+
}, {
|
|
21374
|
+
apiKey?: string | undefined;
|
|
20816
21375
|
kitKey?: string | undefined;
|
|
20817
21376
|
baseUrl?: string | undefined;
|
|
20818
21377
|
batchTransactions?: boolean | undefined;
|
|
@@ -20820,8 +21379,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20820
21379
|
}, "strip", z.ZodTypeAny, {
|
|
20821
21380
|
vaults: {
|
|
20822
21381
|
chain: string | {
|
|
20823
|
-
name: string;
|
|
20824
21382
|
type: "evm";
|
|
21383
|
+
name: string;
|
|
20825
21384
|
chain: Blockchain;
|
|
20826
21385
|
nativeCurrency: {
|
|
20827
21386
|
symbol: string;
|
|
@@ -20856,8 +21415,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20856
21415
|
adapter?: string | undefined;
|
|
20857
21416
|
} | undefined;
|
|
20858
21417
|
} | {
|
|
20859
|
-
name: string;
|
|
20860
21418
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
21419
|
+
name: string;
|
|
20861
21420
|
chain: Blockchain;
|
|
20862
21421
|
nativeCurrency: {
|
|
20863
21422
|
symbol: string;
|
|
@@ -20894,6 +21453,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20894
21453
|
vaultAddress: `0x${string}`;
|
|
20895
21454
|
}[];
|
|
20896
21455
|
config?: {
|
|
21456
|
+
apiKey?: string | undefined;
|
|
20897
21457
|
kitKey?: string | undefined;
|
|
20898
21458
|
baseUrl?: string | undefined;
|
|
20899
21459
|
batchTransactions?: boolean | undefined;
|
|
@@ -20901,8 +21461,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20901
21461
|
}, {
|
|
20902
21462
|
vaults: {
|
|
20903
21463
|
chain: string | {
|
|
20904
|
-
name: string;
|
|
20905
21464
|
type: "evm";
|
|
21465
|
+
name: string;
|
|
20906
21466
|
chain: Blockchain;
|
|
20907
21467
|
nativeCurrency: {
|
|
20908
21468
|
symbol: string;
|
|
@@ -20937,8 +21497,8 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20937
21497
|
adapter?: string | undefined;
|
|
20938
21498
|
} | undefined;
|
|
20939
21499
|
} | {
|
|
20940
|
-
name: string;
|
|
20941
21500
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
21501
|
+
name: string;
|
|
20942
21502
|
chain: Blockchain;
|
|
20943
21503
|
nativeCurrency: {
|
|
20944
21504
|
symbol: string;
|
|
@@ -20975,6 +21535,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20975
21535
|
vaultAddress: string;
|
|
20976
21536
|
}[];
|
|
20977
21537
|
config?: {
|
|
21538
|
+
apiKey?: string | undefined;
|
|
20978
21539
|
kitKey?: string | undefined;
|
|
20979
21540
|
baseUrl?: string | undefined;
|
|
20980
21541
|
batchTransactions?: boolean | undefined;
|
|
@@ -21099,8 +21660,8 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21099
21660
|
type: z.ZodLiteral<"evm">;
|
|
21100
21661
|
chainId: z.ZodNumber;
|
|
21101
21662
|
}, "strict", z.ZodTypeAny, {
|
|
21102
|
-
name: string;
|
|
21103
21663
|
type: "evm";
|
|
21664
|
+
name: string;
|
|
21104
21665
|
chain: Blockchain;
|
|
21105
21666
|
nativeCurrency: {
|
|
21106
21667
|
symbol: string;
|
|
@@ -21135,8 +21696,8 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21135
21696
|
adapter?: string | undefined;
|
|
21136
21697
|
} | undefined;
|
|
21137
21698
|
}, {
|
|
21138
|
-
name: string;
|
|
21139
21699
|
type: "evm";
|
|
21700
|
+
name: string;
|
|
21140
21701
|
chain: Blockchain;
|
|
21141
21702
|
nativeCurrency: {
|
|
21142
21703
|
symbol: string;
|
|
@@ -21273,8 +21834,8 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21273
21834
|
} & {
|
|
21274
21835
|
type: z.ZodEnum<["algorand", "avalanche", "solana", "aptos", "near", "stellar", "sui", "hedera", "noble", "polkadot"]>;
|
|
21275
21836
|
}, "strict", z.ZodTypeAny, {
|
|
21276
|
-
name: string;
|
|
21277
21837
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
21838
|
+
name: string;
|
|
21278
21839
|
chain: Blockchain;
|
|
21279
21840
|
nativeCurrency: {
|
|
21280
21841
|
symbol: string;
|
|
@@ -21308,8 +21869,8 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21308
21869
|
adapter?: string | undefined;
|
|
21309
21870
|
} | undefined;
|
|
21310
21871
|
}, {
|
|
21311
|
-
name: string;
|
|
21312
21872
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
21873
|
+
name: string;
|
|
21313
21874
|
chain: Blockchain;
|
|
21314
21875
|
nativeCurrency: {
|
|
21315
21876
|
symbol: string;
|
|
@@ -21343,8 +21904,8 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21343
21904
|
adapter?: string | undefined;
|
|
21344
21905
|
} | undefined;
|
|
21345
21906
|
}>]>, {
|
|
21346
|
-
name: string;
|
|
21347
21907
|
type: "evm";
|
|
21908
|
+
name: string;
|
|
21348
21909
|
chain: Blockchain;
|
|
21349
21910
|
nativeCurrency: {
|
|
21350
21911
|
symbol: string;
|
|
@@ -21379,8 +21940,8 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21379
21940
|
adapter?: string | undefined;
|
|
21380
21941
|
} | undefined;
|
|
21381
21942
|
} | {
|
|
21382
|
-
name: string;
|
|
21383
21943
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
21944
|
+
name: string;
|
|
21384
21945
|
chain: Blockchain;
|
|
21385
21946
|
nativeCurrency: {
|
|
21386
21947
|
symbol: string;
|
|
@@ -21414,8 +21975,8 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21414
21975
|
adapter?: string | undefined;
|
|
21415
21976
|
} | undefined;
|
|
21416
21977
|
}, {
|
|
21417
|
-
name: string;
|
|
21418
21978
|
type: "evm";
|
|
21979
|
+
name: string;
|
|
21419
21980
|
chain: Blockchain;
|
|
21420
21981
|
nativeCurrency: {
|
|
21421
21982
|
symbol: string;
|
|
@@ -21450,8 +22011,8 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21450
22011
|
adapter?: string | undefined;
|
|
21451
22012
|
} | undefined;
|
|
21452
22013
|
} | {
|
|
21453
|
-
name: string;
|
|
21454
22014
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
22015
|
+
name: string;
|
|
21455
22016
|
chain: Blockchain;
|
|
21456
22017
|
nativeCurrency: {
|
|
21457
22018
|
symbol: string;
|
|
@@ -21492,23 +22053,36 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21492
22053
|
sortBy: z.ZodOptional<z.ZodEnum<["apy", "tvl", "name"]>>;
|
|
21493
22054
|
page: z.ZodOptional<z.ZodNumber>;
|
|
21494
22055
|
pageSize: z.ZodOptional<z.ZodNumber>;
|
|
21495
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
22056
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
22057
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
21496
22058
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
21497
22059
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
21498
22060
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
21499
22061
|
}, "strict", z.ZodTypeAny, {
|
|
22062
|
+
apiKey?: string | undefined;
|
|
21500
22063
|
kitKey?: string | undefined;
|
|
21501
22064
|
baseUrl?: string | undefined;
|
|
21502
22065
|
batchTransactions?: boolean | undefined;
|
|
21503
22066
|
}, {
|
|
22067
|
+
apiKey?: string | undefined;
|
|
22068
|
+
kitKey?: string | undefined;
|
|
22069
|
+
baseUrl?: string | undefined;
|
|
22070
|
+
batchTransactions?: boolean | undefined;
|
|
22071
|
+
}>, {
|
|
22072
|
+
apiKey?: string | undefined;
|
|
22073
|
+
kitKey?: string | undefined;
|
|
22074
|
+
baseUrl?: string | undefined;
|
|
22075
|
+
batchTransactions?: boolean | undefined;
|
|
22076
|
+
}, {
|
|
22077
|
+
apiKey?: string | undefined;
|
|
21504
22078
|
kitKey?: string | undefined;
|
|
21505
22079
|
baseUrl?: string | undefined;
|
|
21506
22080
|
batchTransactions?: boolean | undefined;
|
|
21507
22081
|
}>>;
|
|
21508
22082
|
}, "strip", z.ZodTypeAny, {
|
|
21509
22083
|
chain: string | {
|
|
21510
|
-
name: string;
|
|
21511
22084
|
type: "evm";
|
|
22085
|
+
name: string;
|
|
21512
22086
|
chain: Blockchain;
|
|
21513
22087
|
nativeCurrency: {
|
|
21514
22088
|
symbol: string;
|
|
@@ -21543,8 +22117,8 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21543
22117
|
adapter?: string | undefined;
|
|
21544
22118
|
} | undefined;
|
|
21545
22119
|
} | {
|
|
21546
|
-
name: string;
|
|
21547
22120
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
22121
|
+
name: string;
|
|
21548
22122
|
chain: Blockchain;
|
|
21549
22123
|
nativeCurrency: {
|
|
21550
22124
|
symbol: string;
|
|
@@ -21579,6 +22153,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21579
22153
|
} | undefined;
|
|
21580
22154
|
};
|
|
21581
22155
|
config?: {
|
|
22156
|
+
apiKey?: string | undefined;
|
|
21582
22157
|
kitKey?: string | undefined;
|
|
21583
22158
|
baseUrl?: string | undefined;
|
|
21584
22159
|
batchTransactions?: boolean | undefined;
|
|
@@ -21592,8 +22167,8 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21592
22167
|
pageSize?: number | undefined;
|
|
21593
22168
|
}, {
|
|
21594
22169
|
chain: string | {
|
|
21595
|
-
name: string;
|
|
21596
22170
|
type: "evm";
|
|
22171
|
+
name: string;
|
|
21597
22172
|
chain: Blockchain;
|
|
21598
22173
|
nativeCurrency: {
|
|
21599
22174
|
symbol: string;
|
|
@@ -21628,8 +22203,8 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21628
22203
|
adapter?: string | undefined;
|
|
21629
22204
|
} | undefined;
|
|
21630
22205
|
} | {
|
|
21631
|
-
name: string;
|
|
21632
22206
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
22207
|
+
name: string;
|
|
21633
22208
|
chain: Blockchain;
|
|
21634
22209
|
nativeCurrency: {
|
|
21635
22210
|
symbol: string;
|
|
@@ -21664,6 +22239,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21664
22239
|
} | undefined;
|
|
21665
22240
|
};
|
|
21666
22241
|
config?: {
|
|
22242
|
+
apiKey?: string | undefined;
|
|
21667
22243
|
kitKey?: string | undefined;
|
|
21668
22244
|
baseUrl?: string | undefined;
|
|
21669
22245
|
batchTransactions?: boolean | undefined;
|
|
@@ -21797,8 +22373,8 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
21797
22373
|
type: z.ZodLiteral<"evm">;
|
|
21798
22374
|
chainId: z.ZodNumber;
|
|
21799
22375
|
}, "strict", z.ZodTypeAny, {
|
|
21800
|
-
name: string;
|
|
21801
22376
|
type: "evm";
|
|
22377
|
+
name: string;
|
|
21802
22378
|
chain: Blockchain;
|
|
21803
22379
|
nativeCurrency: {
|
|
21804
22380
|
symbol: string;
|
|
@@ -21833,8 +22409,8 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
21833
22409
|
adapter?: string | undefined;
|
|
21834
22410
|
} | undefined;
|
|
21835
22411
|
}, {
|
|
21836
|
-
name: string;
|
|
21837
22412
|
type: "evm";
|
|
22413
|
+
name: string;
|
|
21838
22414
|
chain: Blockchain;
|
|
21839
22415
|
nativeCurrency: {
|
|
21840
22416
|
symbol: string;
|
|
@@ -21971,8 +22547,8 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
21971
22547
|
} & {
|
|
21972
22548
|
type: z.ZodEnum<["algorand", "avalanche", "solana", "aptos", "near", "stellar", "sui", "hedera", "noble", "polkadot"]>;
|
|
21973
22549
|
}, "strict", z.ZodTypeAny, {
|
|
21974
|
-
name: string;
|
|
21975
22550
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
22551
|
+
name: string;
|
|
21976
22552
|
chain: Blockchain;
|
|
21977
22553
|
nativeCurrency: {
|
|
21978
22554
|
symbol: string;
|
|
@@ -22006,8 +22582,8 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22006
22582
|
adapter?: string | undefined;
|
|
22007
22583
|
} | undefined;
|
|
22008
22584
|
}, {
|
|
22009
|
-
name: string;
|
|
22010
22585
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
22586
|
+
name: string;
|
|
22011
22587
|
chain: Blockchain;
|
|
22012
22588
|
nativeCurrency: {
|
|
22013
22589
|
symbol: string;
|
|
@@ -22041,8 +22617,8 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22041
22617
|
adapter?: string | undefined;
|
|
22042
22618
|
} | undefined;
|
|
22043
22619
|
}>]>, {
|
|
22044
|
-
name: string;
|
|
22045
22620
|
type: "evm";
|
|
22621
|
+
name: string;
|
|
22046
22622
|
chain: Blockchain;
|
|
22047
22623
|
nativeCurrency: {
|
|
22048
22624
|
symbol: string;
|
|
@@ -22077,8 +22653,8 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22077
22653
|
adapter?: string | undefined;
|
|
22078
22654
|
} | undefined;
|
|
22079
22655
|
} | {
|
|
22080
|
-
name: string;
|
|
22081
22656
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
22657
|
+
name: string;
|
|
22082
22658
|
chain: Blockchain;
|
|
22083
22659
|
nativeCurrency: {
|
|
22084
22660
|
symbol: string;
|
|
@@ -22112,8 +22688,8 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22112
22688
|
adapter?: string | undefined;
|
|
22113
22689
|
} | undefined;
|
|
22114
22690
|
}, {
|
|
22115
|
-
name: string;
|
|
22116
22691
|
type: "evm";
|
|
22692
|
+
name: string;
|
|
22117
22693
|
chain: Blockchain;
|
|
22118
22694
|
nativeCurrency: {
|
|
22119
22695
|
symbol: string;
|
|
@@ -22148,8 +22724,8 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22148
22724
|
adapter?: string | undefined;
|
|
22149
22725
|
} | undefined;
|
|
22150
22726
|
} | {
|
|
22151
|
-
name: string;
|
|
22152
22727
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
22728
|
+
name: string;
|
|
22153
22729
|
chain: Blockchain;
|
|
22154
22730
|
nativeCurrency: {
|
|
22155
22731
|
symbol: string;
|
|
@@ -22190,23 +22766,36 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22190
22766
|
sortBy: z.ZodOptional<z.ZodEnum<["apy", "tvl", "name"]>>;
|
|
22191
22767
|
page: z.ZodOptional<z.ZodNumber>;
|
|
22192
22768
|
pageSize: z.ZodOptional<z.ZodNumber>;
|
|
22193
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
22769
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
22770
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
22194
22771
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
22195
22772
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
22196
22773
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
22197
22774
|
}, "strict", z.ZodTypeAny, {
|
|
22775
|
+
apiKey?: string | undefined;
|
|
22198
22776
|
kitKey?: string | undefined;
|
|
22199
22777
|
baseUrl?: string | undefined;
|
|
22200
22778
|
batchTransactions?: boolean | undefined;
|
|
22201
22779
|
}, {
|
|
22780
|
+
apiKey?: string | undefined;
|
|
22781
|
+
kitKey?: string | undefined;
|
|
22782
|
+
baseUrl?: string | undefined;
|
|
22783
|
+
batchTransactions?: boolean | undefined;
|
|
22784
|
+
}>, {
|
|
22785
|
+
apiKey?: string | undefined;
|
|
22786
|
+
kitKey?: string | undefined;
|
|
22787
|
+
baseUrl?: string | undefined;
|
|
22788
|
+
batchTransactions?: boolean | undefined;
|
|
22789
|
+
}, {
|
|
22790
|
+
apiKey?: string | undefined;
|
|
22202
22791
|
kitKey?: string | undefined;
|
|
22203
22792
|
baseUrl?: string | undefined;
|
|
22204
22793
|
batchTransactions?: boolean | undefined;
|
|
22205
22794
|
}>>;
|
|
22206
22795
|
}, "page">, "strip", z.ZodTypeAny, {
|
|
22207
22796
|
chain: string | {
|
|
22208
|
-
name: string;
|
|
22209
22797
|
type: "evm";
|
|
22798
|
+
name: string;
|
|
22210
22799
|
chain: Blockchain;
|
|
22211
22800
|
nativeCurrency: {
|
|
22212
22801
|
symbol: string;
|
|
@@ -22241,8 +22830,8 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22241
22830
|
adapter?: string | undefined;
|
|
22242
22831
|
} | undefined;
|
|
22243
22832
|
} | {
|
|
22244
|
-
name: string;
|
|
22245
22833
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
22834
|
+
name: string;
|
|
22246
22835
|
chain: Blockchain;
|
|
22247
22836
|
nativeCurrency: {
|
|
22248
22837
|
symbol: string;
|
|
@@ -22277,6 +22866,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22277
22866
|
} | undefined;
|
|
22278
22867
|
};
|
|
22279
22868
|
config?: {
|
|
22869
|
+
apiKey?: string | undefined;
|
|
22280
22870
|
kitKey?: string | undefined;
|
|
22281
22871
|
baseUrl?: string | undefined;
|
|
22282
22872
|
batchTransactions?: boolean | undefined;
|
|
@@ -22289,8 +22879,8 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22289
22879
|
pageSize?: number | undefined;
|
|
22290
22880
|
}, {
|
|
22291
22881
|
chain: string | {
|
|
22292
|
-
name: string;
|
|
22293
22882
|
type: "evm";
|
|
22883
|
+
name: string;
|
|
22294
22884
|
chain: Blockchain;
|
|
22295
22885
|
nativeCurrency: {
|
|
22296
22886
|
symbol: string;
|
|
@@ -22325,8 +22915,8 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22325
22915
|
adapter?: string | undefined;
|
|
22326
22916
|
} | undefined;
|
|
22327
22917
|
} | {
|
|
22328
|
-
name: string;
|
|
22329
22918
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
22919
|
+
name: string;
|
|
22330
22920
|
chain: Blockchain;
|
|
22331
22921
|
nativeCurrency: {
|
|
22332
22922
|
symbol: string;
|
|
@@ -22361,6 +22951,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22361
22951
|
} | undefined;
|
|
22362
22952
|
};
|
|
22363
22953
|
config?: {
|
|
22954
|
+
apiKey?: string | undefined;
|
|
22364
22955
|
kitKey?: string | undefined;
|
|
22365
22956
|
baseUrl?: string | undefined;
|
|
22366
22957
|
batchTransactions?: boolean | undefined;
|
|
@@ -22388,15 +22979,28 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22388
22979
|
declare const getPositionParamsSchema: z.ZodObject<{
|
|
22389
22980
|
from: z.ZodType<any, z.ZodTypeDef, any>;
|
|
22390
22981
|
vaultAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, string, string>, `0x${string}`, string>, `0x${string}`, string>;
|
|
22391
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
22982
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
22983
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
22392
22984
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
22393
22985
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
22394
22986
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
22395
22987
|
}, "strict", z.ZodTypeAny, {
|
|
22988
|
+
apiKey?: string | undefined;
|
|
22396
22989
|
kitKey?: string | undefined;
|
|
22397
22990
|
baseUrl?: string | undefined;
|
|
22398
22991
|
batchTransactions?: boolean | undefined;
|
|
22399
22992
|
}, {
|
|
22993
|
+
apiKey?: string | undefined;
|
|
22994
|
+
kitKey?: string | undefined;
|
|
22995
|
+
baseUrl?: string | undefined;
|
|
22996
|
+
batchTransactions?: boolean | undefined;
|
|
22997
|
+
}>, {
|
|
22998
|
+
apiKey?: string | undefined;
|
|
22999
|
+
kitKey?: string | undefined;
|
|
23000
|
+
baseUrl?: string | undefined;
|
|
23001
|
+
batchTransactions?: boolean | undefined;
|
|
23002
|
+
}, {
|
|
23003
|
+
apiKey?: string | undefined;
|
|
22400
23004
|
kitKey?: string | undefined;
|
|
22401
23005
|
baseUrl?: string | undefined;
|
|
22402
23006
|
batchTransactions?: boolean | undefined;
|
|
@@ -22405,6 +23009,7 @@ declare const getPositionParamsSchema: z.ZodObject<{
|
|
|
22405
23009
|
vaultAddress: `0x${string}`;
|
|
22406
23010
|
from?: any;
|
|
22407
23011
|
config?: {
|
|
23012
|
+
apiKey?: string | undefined;
|
|
22408
23013
|
kitKey?: string | undefined;
|
|
22409
23014
|
baseUrl?: string | undefined;
|
|
22410
23015
|
batchTransactions?: boolean | undefined;
|
|
@@ -22413,6 +23018,7 @@ declare const getPositionParamsSchema: z.ZodObject<{
|
|
|
22413
23018
|
vaultAddress: string;
|
|
22414
23019
|
from?: any;
|
|
22415
23020
|
config?: {
|
|
23021
|
+
apiKey?: string | undefined;
|
|
22416
23022
|
kitKey?: string | undefined;
|
|
22417
23023
|
baseUrl?: string | undefined;
|
|
22418
23024
|
batchTransactions?: boolean | undefined;
|
|
@@ -22549,8 +23155,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22549
23155
|
type: z.ZodLiteral<"evm">;
|
|
22550
23156
|
chainId: z.ZodNumber;
|
|
22551
23157
|
}, "strict", z.ZodTypeAny, {
|
|
22552
|
-
name: string;
|
|
22553
23158
|
type: "evm";
|
|
23159
|
+
name: string;
|
|
22554
23160
|
chain: Blockchain;
|
|
22555
23161
|
nativeCurrency: {
|
|
22556
23162
|
symbol: string;
|
|
@@ -22585,8 +23191,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22585
23191
|
adapter?: string | undefined;
|
|
22586
23192
|
} | undefined;
|
|
22587
23193
|
}, {
|
|
22588
|
-
name: string;
|
|
22589
23194
|
type: "evm";
|
|
23195
|
+
name: string;
|
|
22590
23196
|
chain: Blockchain;
|
|
22591
23197
|
nativeCurrency: {
|
|
22592
23198
|
symbol: string;
|
|
@@ -22723,8 +23329,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22723
23329
|
} & {
|
|
22724
23330
|
type: z.ZodEnum<["algorand", "avalanche", "solana", "aptos", "near", "stellar", "sui", "hedera", "noble", "polkadot"]>;
|
|
22725
23331
|
}, "strict", z.ZodTypeAny, {
|
|
22726
|
-
name: string;
|
|
22727
23332
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
23333
|
+
name: string;
|
|
22728
23334
|
chain: Blockchain;
|
|
22729
23335
|
nativeCurrency: {
|
|
22730
23336
|
symbol: string;
|
|
@@ -22758,8 +23364,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22758
23364
|
adapter?: string | undefined;
|
|
22759
23365
|
} | undefined;
|
|
22760
23366
|
}, {
|
|
22761
|
-
name: string;
|
|
22762
23367
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
23368
|
+
name: string;
|
|
22763
23369
|
chain: Blockchain;
|
|
22764
23370
|
nativeCurrency: {
|
|
22765
23371
|
symbol: string;
|
|
@@ -22793,8 +23399,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22793
23399
|
adapter?: string | undefined;
|
|
22794
23400
|
} | undefined;
|
|
22795
23401
|
}>]>, {
|
|
22796
|
-
name: string;
|
|
22797
23402
|
type: "evm";
|
|
23403
|
+
name: string;
|
|
22798
23404
|
chain: Blockchain;
|
|
22799
23405
|
nativeCurrency: {
|
|
22800
23406
|
symbol: string;
|
|
@@ -22829,8 +23435,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22829
23435
|
adapter?: string | undefined;
|
|
22830
23436
|
} | undefined;
|
|
22831
23437
|
} | {
|
|
22832
|
-
name: string;
|
|
22833
23438
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
23439
|
+
name: string;
|
|
22834
23440
|
chain: Blockchain;
|
|
22835
23441
|
nativeCurrency: {
|
|
22836
23442
|
symbol: string;
|
|
@@ -22864,8 +23470,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22864
23470
|
adapter?: string | undefined;
|
|
22865
23471
|
} | undefined;
|
|
22866
23472
|
}, {
|
|
22867
|
-
name: string;
|
|
22868
23473
|
type: "evm";
|
|
23474
|
+
name: string;
|
|
22869
23475
|
chain: Blockchain;
|
|
22870
23476
|
nativeCurrency: {
|
|
22871
23477
|
symbol: string;
|
|
@@ -22900,8 +23506,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22900
23506
|
adapter?: string | undefined;
|
|
22901
23507
|
} | undefined;
|
|
22902
23508
|
} | {
|
|
22903
|
-
name: string;
|
|
22904
23509
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
23510
|
+
name: string;
|
|
22905
23511
|
chain: Blockchain;
|
|
22906
23512
|
nativeCurrency: {
|
|
22907
23513
|
symbol: string;
|
|
@@ -22938,8 +23544,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22938
23544
|
recipientAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, string, string>, `0x${string}`, string>, `0x${string}`, string>, `0x${string}`, string>;
|
|
22939
23545
|
}, "strict", z.ZodTypeAny, {
|
|
22940
23546
|
chain: string | {
|
|
22941
|
-
name: string;
|
|
22942
23547
|
type: "evm";
|
|
23548
|
+
name: string;
|
|
22943
23549
|
chain: Blockchain;
|
|
22944
23550
|
nativeCurrency: {
|
|
22945
23551
|
symbol: string;
|
|
@@ -22974,8 +23580,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22974
23580
|
adapter?: string | undefined;
|
|
22975
23581
|
} | undefined;
|
|
22976
23582
|
} | {
|
|
22977
|
-
name: string;
|
|
22978
23583
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
23584
|
+
name: string;
|
|
22979
23585
|
chain: Blockchain;
|
|
22980
23586
|
nativeCurrency: {
|
|
22981
23587
|
symbol: string;
|
|
@@ -23012,8 +23618,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23012
23618
|
recipientAddress: `0x${string}`;
|
|
23013
23619
|
}, {
|
|
23014
23620
|
chain: string | {
|
|
23015
|
-
name: string;
|
|
23016
23621
|
type: "evm";
|
|
23622
|
+
name: string;
|
|
23017
23623
|
chain: Blockchain;
|
|
23018
23624
|
nativeCurrency: {
|
|
23019
23625
|
symbol: string;
|
|
@@ -23048,8 +23654,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23048
23654
|
adapter?: string | undefined;
|
|
23049
23655
|
} | undefined;
|
|
23050
23656
|
} | {
|
|
23051
|
-
name: string;
|
|
23052
23657
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
23658
|
+
name: string;
|
|
23053
23659
|
chain: Blockchain;
|
|
23054
23660
|
nativeCurrency: {
|
|
23055
23661
|
symbol: string;
|
|
@@ -23089,15 +23695,28 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23089
23695
|
amount: z.ZodEffects<z.ZodPipeline<z.ZodString, z.ZodType<string, z.ZodTypeDef, string>>, string, string>;
|
|
23090
23696
|
maxFee: z.ZodEffects<z.ZodPipeline<z.ZodString, z.ZodType<string, z.ZodTypeDef, string>>, string, string>;
|
|
23091
23697
|
transferSpeed: z.ZodOptional<z.ZodEnum<["FAST", "SLOW"]>>;
|
|
23092
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
23698
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
23699
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23093
23700
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23094
23701
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23095
23702
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23096
23703
|
}, "strict", z.ZodTypeAny, {
|
|
23704
|
+
apiKey?: string | undefined;
|
|
23097
23705
|
kitKey?: string | undefined;
|
|
23098
23706
|
baseUrl?: string | undefined;
|
|
23099
23707
|
batchTransactions?: boolean | undefined;
|
|
23100
23708
|
}, {
|
|
23709
|
+
apiKey?: string | undefined;
|
|
23710
|
+
kitKey?: string | undefined;
|
|
23711
|
+
baseUrl?: string | undefined;
|
|
23712
|
+
batchTransactions?: boolean | undefined;
|
|
23713
|
+
}>, {
|
|
23714
|
+
apiKey?: string | undefined;
|
|
23715
|
+
kitKey?: string | undefined;
|
|
23716
|
+
baseUrl?: string | undefined;
|
|
23717
|
+
batchTransactions?: boolean | undefined;
|
|
23718
|
+
}, {
|
|
23719
|
+
apiKey?: string | undefined;
|
|
23101
23720
|
kitKey?: string | undefined;
|
|
23102
23721
|
baseUrl?: string | undefined;
|
|
23103
23722
|
batchTransactions?: boolean | undefined;
|
|
@@ -23107,8 +23726,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23107
23726
|
amount: string;
|
|
23108
23727
|
to: {
|
|
23109
23728
|
chain: string | {
|
|
23110
|
-
name: string;
|
|
23111
23729
|
type: "evm";
|
|
23730
|
+
name: string;
|
|
23112
23731
|
chain: Blockchain;
|
|
23113
23732
|
nativeCurrency: {
|
|
23114
23733
|
symbol: string;
|
|
@@ -23143,8 +23762,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23143
23762
|
adapter?: string | undefined;
|
|
23144
23763
|
} | undefined;
|
|
23145
23764
|
} | {
|
|
23146
|
-
name: string;
|
|
23147
23765
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
23766
|
+
name: string;
|
|
23148
23767
|
chain: Blockchain;
|
|
23149
23768
|
nativeCurrency: {
|
|
23150
23769
|
symbol: string;
|
|
@@ -23183,6 +23802,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23183
23802
|
vaultAddress: `0x${string}`;
|
|
23184
23803
|
from?: any;
|
|
23185
23804
|
config?: {
|
|
23805
|
+
apiKey?: string | undefined;
|
|
23186
23806
|
kitKey?: string | undefined;
|
|
23187
23807
|
baseUrl?: string | undefined;
|
|
23188
23808
|
batchTransactions?: boolean | undefined;
|
|
@@ -23193,8 +23813,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23193
23813
|
amount: string;
|
|
23194
23814
|
to: {
|
|
23195
23815
|
chain: string | {
|
|
23196
|
-
name: string;
|
|
23197
23816
|
type: "evm";
|
|
23817
|
+
name: string;
|
|
23198
23818
|
chain: Blockchain;
|
|
23199
23819
|
nativeCurrency: {
|
|
23200
23820
|
symbol: string;
|
|
@@ -23229,8 +23849,8 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23229
23849
|
adapter?: string | undefined;
|
|
23230
23850
|
} | undefined;
|
|
23231
23851
|
} | {
|
|
23232
|
-
name: string;
|
|
23233
23852
|
type: "algorand" | "avalanche" | "solana" | "aptos" | "near" | "stellar" | "sui" | "hedera" | "noble" | "polkadot";
|
|
23853
|
+
name: string;
|
|
23234
23854
|
chain: Blockchain;
|
|
23235
23855
|
nativeCurrency: {
|
|
23236
23856
|
symbol: string;
|
|
@@ -23269,6 +23889,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23269
23889
|
vaultAddress: string;
|
|
23270
23890
|
from?: any;
|
|
23271
23891
|
config?: {
|
|
23892
|
+
apiKey?: string | undefined;
|
|
23272
23893
|
kitKey?: string | undefined;
|
|
23273
23894
|
baseUrl?: string | undefined;
|
|
23274
23895
|
batchTransactions?: boolean | undefined;
|
|
@@ -23279,15 +23900,28 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23279
23900
|
to: z.ZodOptional<z.ZodUndefined>;
|
|
23280
23901
|
vaultAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, string, string>, `0x${string}`, string>, `0x${string}`, string>;
|
|
23281
23902
|
amount: z.ZodEffects<z.ZodPipeline<z.ZodString, z.ZodType<string, z.ZodTypeDef, string>>, string, string>;
|
|
23282
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
23903
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
23904
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23283
23905
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23284
23906
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23285
23907
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23286
23908
|
}, "strict", z.ZodTypeAny, {
|
|
23909
|
+
apiKey?: string | undefined;
|
|
23287
23910
|
kitKey?: string | undefined;
|
|
23288
23911
|
baseUrl?: string | undefined;
|
|
23289
23912
|
batchTransactions?: boolean | undefined;
|
|
23290
23913
|
}, {
|
|
23914
|
+
apiKey?: string | undefined;
|
|
23915
|
+
kitKey?: string | undefined;
|
|
23916
|
+
baseUrl?: string | undefined;
|
|
23917
|
+
batchTransactions?: boolean | undefined;
|
|
23918
|
+
}>, {
|
|
23919
|
+
apiKey?: string | undefined;
|
|
23920
|
+
kitKey?: string | undefined;
|
|
23921
|
+
baseUrl?: string | undefined;
|
|
23922
|
+
batchTransactions?: boolean | undefined;
|
|
23923
|
+
}, {
|
|
23924
|
+
apiKey?: string | undefined;
|
|
23291
23925
|
kitKey?: string | undefined;
|
|
23292
23926
|
baseUrl?: string | undefined;
|
|
23293
23927
|
batchTransactions?: boolean | undefined;
|
|
@@ -23298,6 +23932,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23298
23932
|
to?: undefined;
|
|
23299
23933
|
from?: any;
|
|
23300
23934
|
config?: {
|
|
23935
|
+
apiKey?: string | undefined;
|
|
23301
23936
|
kitKey?: string | undefined;
|
|
23302
23937
|
baseUrl?: string | undefined;
|
|
23303
23938
|
batchTransactions?: boolean | undefined;
|
|
@@ -23308,6 +23943,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23308
23943
|
to?: undefined;
|
|
23309
23944
|
from?: any;
|
|
23310
23945
|
config?: {
|
|
23946
|
+
apiKey?: string | undefined;
|
|
23311
23947
|
kitKey?: string | undefined;
|
|
23312
23948
|
baseUrl?: string | undefined;
|
|
23313
23949
|
batchTransactions?: boolean | undefined;
|
|
@@ -23334,15 +23970,28 @@ declare const depositParamsSchema: z.ZodObject<{
|
|
|
23334
23970
|
from: z.ZodType<any, z.ZodTypeDef, any>;
|
|
23335
23971
|
vaultAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, string, string>, `0x${string}`, string>, `0x${string}`, string>;
|
|
23336
23972
|
amount: z.ZodEffects<z.ZodPipeline<z.ZodString, z.ZodType<string, z.ZodTypeDef, string>>, string, string>;
|
|
23337
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
23973
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
23974
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23338
23975
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23339
23976
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23340
23977
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23341
23978
|
}, "strict", z.ZodTypeAny, {
|
|
23979
|
+
apiKey?: string | undefined;
|
|
23980
|
+
kitKey?: string | undefined;
|
|
23981
|
+
baseUrl?: string | undefined;
|
|
23982
|
+
batchTransactions?: boolean | undefined;
|
|
23983
|
+
}, {
|
|
23984
|
+
apiKey?: string | undefined;
|
|
23985
|
+
kitKey?: string | undefined;
|
|
23986
|
+
baseUrl?: string | undefined;
|
|
23987
|
+
batchTransactions?: boolean | undefined;
|
|
23988
|
+
}>, {
|
|
23989
|
+
apiKey?: string | undefined;
|
|
23342
23990
|
kitKey?: string | undefined;
|
|
23343
23991
|
baseUrl?: string | undefined;
|
|
23344
23992
|
batchTransactions?: boolean | undefined;
|
|
23345
23993
|
}, {
|
|
23994
|
+
apiKey?: string | undefined;
|
|
23346
23995
|
kitKey?: string | undefined;
|
|
23347
23996
|
baseUrl?: string | undefined;
|
|
23348
23997
|
batchTransactions?: boolean | undefined;
|
|
@@ -23352,6 +24001,7 @@ declare const depositParamsSchema: z.ZodObject<{
|
|
|
23352
24001
|
vaultAddress: `0x${string}`;
|
|
23353
24002
|
from?: any;
|
|
23354
24003
|
config?: {
|
|
24004
|
+
apiKey?: string | undefined;
|
|
23355
24005
|
kitKey?: string | undefined;
|
|
23356
24006
|
baseUrl?: string | undefined;
|
|
23357
24007
|
batchTransactions?: boolean | undefined;
|
|
@@ -23361,6 +24011,7 @@ declare const depositParamsSchema: z.ZodObject<{
|
|
|
23361
24011
|
vaultAddress: string;
|
|
23362
24012
|
from?: any;
|
|
23363
24013
|
config?: {
|
|
24014
|
+
apiKey?: string | undefined;
|
|
23364
24015
|
kitKey?: string | undefined;
|
|
23365
24016
|
baseUrl?: string | undefined;
|
|
23366
24017
|
batchTransactions?: boolean | undefined;
|
|
@@ -23380,15 +24031,28 @@ declare const depositParamsSchema: z.ZodObject<{
|
|
|
23380
24031
|
*/
|
|
23381
24032
|
declare const getCrossChainDepositStatusParamsSchema: z.ZodObject<{
|
|
23382
24033
|
execId: z.ZodString;
|
|
23383
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
24034
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24035
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23384
24036
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23385
24037
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23386
24038
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23387
24039
|
}, "strict", z.ZodTypeAny, {
|
|
24040
|
+
apiKey?: string | undefined;
|
|
23388
24041
|
kitKey?: string | undefined;
|
|
23389
24042
|
baseUrl?: string | undefined;
|
|
23390
24043
|
batchTransactions?: boolean | undefined;
|
|
23391
24044
|
}, {
|
|
24045
|
+
apiKey?: string | undefined;
|
|
24046
|
+
kitKey?: string | undefined;
|
|
24047
|
+
baseUrl?: string | undefined;
|
|
24048
|
+
batchTransactions?: boolean | undefined;
|
|
24049
|
+
}>, {
|
|
24050
|
+
apiKey?: string | undefined;
|
|
24051
|
+
kitKey?: string | undefined;
|
|
24052
|
+
baseUrl?: string | undefined;
|
|
24053
|
+
batchTransactions?: boolean | undefined;
|
|
24054
|
+
}, {
|
|
24055
|
+
apiKey?: string | undefined;
|
|
23392
24056
|
kitKey?: string | undefined;
|
|
23393
24057
|
baseUrl?: string | undefined;
|
|
23394
24058
|
batchTransactions?: boolean | undefined;
|
|
@@ -23396,6 +24060,7 @@ declare const getCrossChainDepositStatusParamsSchema: z.ZodObject<{
|
|
|
23396
24060
|
}, "strip", z.ZodTypeAny, {
|
|
23397
24061
|
execId: string;
|
|
23398
24062
|
config?: {
|
|
24063
|
+
apiKey?: string | undefined;
|
|
23399
24064
|
kitKey?: string | undefined;
|
|
23400
24065
|
baseUrl?: string | undefined;
|
|
23401
24066
|
batchTransactions?: boolean | undefined;
|
|
@@ -23403,6 +24068,7 @@ declare const getCrossChainDepositStatusParamsSchema: z.ZodObject<{
|
|
|
23403
24068
|
}, {
|
|
23404
24069
|
execId: string;
|
|
23405
24070
|
config?: {
|
|
24071
|
+
apiKey?: string | undefined;
|
|
23406
24072
|
kitKey?: string | undefined;
|
|
23407
24073
|
baseUrl?: string | undefined;
|
|
23408
24074
|
batchTransactions?: boolean | undefined;
|
|
@@ -23424,15 +24090,28 @@ declare const getCrossChainDepositStatusParamsSchema: z.ZodObject<{
|
|
|
23424
24090
|
*/
|
|
23425
24091
|
declare const waitForCrossChainDepositParamsSchema: z.ZodObject<{
|
|
23426
24092
|
execId: z.ZodString;
|
|
23427
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
24093
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24094
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23428
24095
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23429
24096
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23430
24097
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23431
24098
|
}, "strict", z.ZodTypeAny, {
|
|
24099
|
+
apiKey?: string | undefined;
|
|
23432
24100
|
kitKey?: string | undefined;
|
|
23433
24101
|
baseUrl?: string | undefined;
|
|
23434
24102
|
batchTransactions?: boolean | undefined;
|
|
23435
24103
|
}, {
|
|
24104
|
+
apiKey?: string | undefined;
|
|
24105
|
+
kitKey?: string | undefined;
|
|
24106
|
+
baseUrl?: string | undefined;
|
|
24107
|
+
batchTransactions?: boolean | undefined;
|
|
24108
|
+
}>, {
|
|
24109
|
+
apiKey?: string | undefined;
|
|
24110
|
+
kitKey?: string | undefined;
|
|
24111
|
+
baseUrl?: string | undefined;
|
|
24112
|
+
batchTransactions?: boolean | undefined;
|
|
24113
|
+
}, {
|
|
24114
|
+
apiKey?: string | undefined;
|
|
23436
24115
|
kitKey?: string | undefined;
|
|
23437
24116
|
baseUrl?: string | undefined;
|
|
23438
24117
|
batchTransactions?: boolean | undefined;
|
|
@@ -23443,6 +24122,7 @@ declare const waitForCrossChainDepositParamsSchema: z.ZodObject<{
|
|
|
23443
24122
|
}, "strip", z.ZodTypeAny, {
|
|
23444
24123
|
execId: string;
|
|
23445
24124
|
config?: {
|
|
24125
|
+
apiKey?: string | undefined;
|
|
23446
24126
|
kitKey?: string | undefined;
|
|
23447
24127
|
baseUrl?: string | undefined;
|
|
23448
24128
|
batchTransactions?: boolean | undefined;
|
|
@@ -23453,6 +24133,7 @@ declare const waitForCrossChainDepositParamsSchema: z.ZodObject<{
|
|
|
23453
24133
|
}, {
|
|
23454
24134
|
execId: string;
|
|
23455
24135
|
config?: {
|
|
24136
|
+
apiKey?: string | undefined;
|
|
23456
24137
|
kitKey?: string | undefined;
|
|
23457
24138
|
baseUrl?: string | undefined;
|
|
23458
24139
|
batchTransactions?: boolean | undefined;
|
|
@@ -23479,15 +24160,28 @@ declare const withdrawParamsSchema: z.ZodObject<{
|
|
|
23479
24160
|
from: z.ZodType<any, z.ZodTypeDef, any>;
|
|
23480
24161
|
vaultAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, string, string>, `0x${string}`, string>, `0x${string}`, string>;
|
|
23481
24162
|
amount: z.ZodEffects<z.ZodPipeline<z.ZodString, z.ZodType<string, z.ZodTypeDef, string>>, string, string>;
|
|
23482
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
24163
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24164
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23483
24165
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23484
24166
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23485
24167
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23486
24168
|
}, "strict", z.ZodTypeAny, {
|
|
24169
|
+
apiKey?: string | undefined;
|
|
23487
24170
|
kitKey?: string | undefined;
|
|
23488
24171
|
baseUrl?: string | undefined;
|
|
23489
24172
|
batchTransactions?: boolean | undefined;
|
|
23490
24173
|
}, {
|
|
24174
|
+
apiKey?: string | undefined;
|
|
24175
|
+
kitKey?: string | undefined;
|
|
24176
|
+
baseUrl?: string | undefined;
|
|
24177
|
+
batchTransactions?: boolean | undefined;
|
|
24178
|
+
}>, {
|
|
24179
|
+
apiKey?: string | undefined;
|
|
24180
|
+
kitKey?: string | undefined;
|
|
24181
|
+
baseUrl?: string | undefined;
|
|
24182
|
+
batchTransactions?: boolean | undefined;
|
|
24183
|
+
}, {
|
|
24184
|
+
apiKey?: string | undefined;
|
|
23491
24185
|
kitKey?: string | undefined;
|
|
23492
24186
|
baseUrl?: string | undefined;
|
|
23493
24187
|
batchTransactions?: boolean | undefined;
|
|
@@ -23497,6 +24191,7 @@ declare const withdrawParamsSchema: z.ZodObject<{
|
|
|
23497
24191
|
vaultAddress: `0x${string}`;
|
|
23498
24192
|
from?: any;
|
|
23499
24193
|
config?: {
|
|
24194
|
+
apiKey?: string | undefined;
|
|
23500
24195
|
kitKey?: string | undefined;
|
|
23501
24196
|
baseUrl?: string | undefined;
|
|
23502
24197
|
batchTransactions?: boolean | undefined;
|
|
@@ -23506,6 +24201,7 @@ declare const withdrawParamsSchema: z.ZodObject<{
|
|
|
23506
24201
|
vaultAddress: string;
|
|
23507
24202
|
from?: any;
|
|
23508
24203
|
config?: {
|
|
24204
|
+
apiKey?: string | undefined;
|
|
23509
24205
|
kitKey?: string | undefined;
|
|
23510
24206
|
baseUrl?: string | undefined;
|
|
23511
24207
|
batchTransactions?: boolean | undefined;
|
|
@@ -23529,15 +24225,28 @@ declare const withdrawParamsSchema: z.ZodObject<{
|
|
|
23529
24225
|
declare const claimRewardsParamsSchema: z.ZodObject<{
|
|
23530
24226
|
from: z.ZodType<any, z.ZodTypeDef, any>;
|
|
23531
24227
|
vaultAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, string, string>, `0x${string}`, string>, `0x${string}`, string>;
|
|
23532
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
24228
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24229
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23533
24230
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23534
24231
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23535
24232
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23536
24233
|
}, "strict", z.ZodTypeAny, {
|
|
24234
|
+
apiKey?: string | undefined;
|
|
24235
|
+
kitKey?: string | undefined;
|
|
24236
|
+
baseUrl?: string | undefined;
|
|
24237
|
+
batchTransactions?: boolean | undefined;
|
|
24238
|
+
}, {
|
|
24239
|
+
apiKey?: string | undefined;
|
|
24240
|
+
kitKey?: string | undefined;
|
|
24241
|
+
baseUrl?: string | undefined;
|
|
24242
|
+
batchTransactions?: boolean | undefined;
|
|
24243
|
+
}>, {
|
|
24244
|
+
apiKey?: string | undefined;
|
|
23537
24245
|
kitKey?: string | undefined;
|
|
23538
24246
|
baseUrl?: string | undefined;
|
|
23539
24247
|
batchTransactions?: boolean | undefined;
|
|
23540
24248
|
}, {
|
|
24249
|
+
apiKey?: string | undefined;
|
|
23541
24250
|
kitKey?: string | undefined;
|
|
23542
24251
|
baseUrl?: string | undefined;
|
|
23543
24252
|
batchTransactions?: boolean | undefined;
|
|
@@ -23546,6 +24255,7 @@ declare const claimRewardsParamsSchema: z.ZodObject<{
|
|
|
23546
24255
|
vaultAddress: `0x${string}`;
|
|
23547
24256
|
from?: any;
|
|
23548
24257
|
config?: {
|
|
24258
|
+
apiKey?: string | undefined;
|
|
23549
24259
|
kitKey?: string | undefined;
|
|
23550
24260
|
baseUrl?: string | undefined;
|
|
23551
24261
|
batchTransactions?: boolean | undefined;
|
|
@@ -23554,6 +24264,7 @@ declare const claimRewardsParamsSchema: z.ZodObject<{
|
|
|
23554
24264
|
vaultAddress: string;
|
|
23555
24265
|
from?: any;
|
|
23556
24266
|
config?: {
|
|
24267
|
+
apiKey?: string | undefined;
|
|
23557
24268
|
kitKey?: string | undefined;
|
|
23558
24269
|
baseUrl?: string | undefined;
|
|
23559
24270
|
batchTransactions?: boolean | undefined;
|
|
@@ -23603,15 +24314,28 @@ declare const getWithdrawalQuoteParamsSchema: z.ZodObject<{
|
|
|
23603
24314
|
from: z.ZodType<any, z.ZodTypeDef, any>;
|
|
23604
24315
|
vaultAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, string, string>, `0x${string}`, string>, `0x${string}`, string>;
|
|
23605
24316
|
amount: z.ZodEffects<z.ZodPipeline<z.ZodString, z.ZodType<string, z.ZodTypeDef, string>>, string, string>;
|
|
23606
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
24317
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24318
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23607
24319
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23608
24320
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23609
24321
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23610
24322
|
}, "strict", z.ZodTypeAny, {
|
|
24323
|
+
apiKey?: string | undefined;
|
|
24324
|
+
kitKey?: string | undefined;
|
|
24325
|
+
baseUrl?: string | undefined;
|
|
24326
|
+
batchTransactions?: boolean | undefined;
|
|
24327
|
+
}, {
|
|
24328
|
+
apiKey?: string | undefined;
|
|
24329
|
+
kitKey?: string | undefined;
|
|
24330
|
+
baseUrl?: string | undefined;
|
|
24331
|
+
batchTransactions?: boolean | undefined;
|
|
24332
|
+
}>, {
|
|
24333
|
+
apiKey?: string | undefined;
|
|
23611
24334
|
kitKey?: string | undefined;
|
|
23612
24335
|
baseUrl?: string | undefined;
|
|
23613
24336
|
batchTransactions?: boolean | undefined;
|
|
23614
24337
|
}, {
|
|
24338
|
+
apiKey?: string | undefined;
|
|
23615
24339
|
kitKey?: string | undefined;
|
|
23616
24340
|
baseUrl?: string | undefined;
|
|
23617
24341
|
batchTransactions?: boolean | undefined;
|
|
@@ -23621,6 +24345,7 @@ declare const getWithdrawalQuoteParamsSchema: z.ZodObject<{
|
|
|
23621
24345
|
vaultAddress: `0x${string}`;
|
|
23622
24346
|
from?: any;
|
|
23623
24347
|
config?: {
|
|
24348
|
+
apiKey?: string | undefined;
|
|
23624
24349
|
kitKey?: string | undefined;
|
|
23625
24350
|
baseUrl?: string | undefined;
|
|
23626
24351
|
batchTransactions?: boolean | undefined;
|
|
@@ -23630,6 +24355,7 @@ declare const getWithdrawalQuoteParamsSchema: z.ZodObject<{
|
|
|
23630
24355
|
vaultAddress: string;
|
|
23631
24356
|
from?: any;
|
|
23632
24357
|
config?: {
|
|
24358
|
+
apiKey?: string | undefined;
|
|
23633
24359
|
kitKey?: string | undefined;
|
|
23634
24360
|
baseUrl?: string | undefined;
|
|
23635
24361
|
batchTransactions?: boolean | undefined;
|
|
@@ -23653,15 +24379,28 @@ declare const getWithdrawalQuoteParamsSchema: z.ZodObject<{
|
|
|
23653
24379
|
declare const getClaimRewardsQuoteParamsSchema: z.ZodObject<{
|
|
23654
24380
|
from: z.ZodType<any, z.ZodTypeDef, any>;
|
|
23655
24381
|
vaultAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, string, string>, `0x${string}`, string>, `0x${string}`, string>;
|
|
23656
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
24382
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24383
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23657
24384
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23658
24385
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23659
24386
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23660
24387
|
}, "strict", z.ZodTypeAny, {
|
|
24388
|
+
apiKey?: string | undefined;
|
|
24389
|
+
kitKey?: string | undefined;
|
|
24390
|
+
baseUrl?: string | undefined;
|
|
24391
|
+
batchTransactions?: boolean | undefined;
|
|
24392
|
+
}, {
|
|
24393
|
+
apiKey?: string | undefined;
|
|
24394
|
+
kitKey?: string | undefined;
|
|
24395
|
+
baseUrl?: string | undefined;
|
|
24396
|
+
batchTransactions?: boolean | undefined;
|
|
24397
|
+
}>, {
|
|
24398
|
+
apiKey?: string | undefined;
|
|
23661
24399
|
kitKey?: string | undefined;
|
|
23662
24400
|
baseUrl?: string | undefined;
|
|
23663
24401
|
batchTransactions?: boolean | undefined;
|
|
23664
24402
|
}, {
|
|
24403
|
+
apiKey?: string | undefined;
|
|
23665
24404
|
kitKey?: string | undefined;
|
|
23666
24405
|
baseUrl?: string | undefined;
|
|
23667
24406
|
batchTransactions?: boolean | undefined;
|
|
@@ -23670,6 +24409,7 @@ declare const getClaimRewardsQuoteParamsSchema: z.ZodObject<{
|
|
|
23670
24409
|
vaultAddress: `0x${string}`;
|
|
23671
24410
|
from?: any;
|
|
23672
24411
|
config?: {
|
|
24412
|
+
apiKey?: string | undefined;
|
|
23673
24413
|
kitKey?: string | undefined;
|
|
23674
24414
|
baseUrl?: string | undefined;
|
|
23675
24415
|
batchTransactions?: boolean | undefined;
|
|
@@ -23678,6 +24418,7 @@ declare const getClaimRewardsQuoteParamsSchema: z.ZodObject<{
|
|
|
23678
24418
|
vaultAddress: string;
|
|
23679
24419
|
from?: any;
|
|
23680
24420
|
config?: {
|
|
24421
|
+
apiKey?: string | undefined;
|
|
23681
24422
|
kitKey?: string | undefined;
|
|
23682
24423
|
baseUrl?: string | undefined;
|
|
23683
24424
|
batchTransactions?: boolean | undefined;
|
|
@@ -24148,6 +24889,15 @@ interface SpendOptions {
|
|
|
24148
24889
|
* @internal
|
|
24149
24890
|
*/
|
|
24150
24891
|
onBroadcast?: (txHash: string) => void;
|
|
24892
|
+
/**
|
|
24893
|
+
* Partial polling config forwarded to every Gateway API request the spend
|
|
24894
|
+
* makes (estimate, transfer, forwarder status, and the balance lookups on
|
|
24895
|
+
* the auto-allocation path). The provider factory populates this from its
|
|
24896
|
+
* `headers` config so a configured header reaches all spend-path calls.
|
|
24897
|
+
*
|
|
24898
|
+
* @internal
|
|
24899
|
+
*/
|
|
24900
|
+
requestConfig?: Partial<ApiPollingConfig>;
|
|
24151
24901
|
}
|
|
24152
24902
|
/**
|
|
24153
24903
|
* Result returned after a successful spend (mint) operation.
|
|
@@ -25979,6 +26729,26 @@ interface UnifiedBalanceKitConfig<TExtraProviders extends FlexibleGatewayProvide
|
|
|
25979
26729
|
* @defaultValue false
|
|
25980
26730
|
*/
|
|
25981
26731
|
excludeDefaultProviders?: boolean;
|
|
26732
|
+
/**
|
|
26733
|
+
* Custom HTTP headers forwarded with every Circle Gateway API request the
|
|
26734
|
+
* default Gateway v1 provider makes (balances, deposits, spend estimate,
|
|
26735
|
+
* transfer, forwarder status, and `/v1/info`).
|
|
26736
|
+
*
|
|
26737
|
+
* @remarks
|
|
26738
|
+
* Headers are merged on top of the SDK defaults (such as `Content-Type`)
|
|
26739
|
+
* rather than replacing them. Each header is forwarded as-is to Circle's
|
|
26740
|
+
* API; the SDK does not interpret it. Only applies to the default provider —
|
|
26741
|
+
* has no effect when `excludeDefaultProviders` is `true` or on custom
|
|
26742
|
+
* providers supplied via `providers`.
|
|
26743
|
+
*
|
|
26744
|
+
* @example
|
|
26745
|
+
* ```typescript
|
|
26746
|
+
* const kit = new UnifiedBalanceKit({
|
|
26747
|
+
* headers: { 'X-Access-Key': process.env.GATEWAY_ACCESS_KEY! },
|
|
26748
|
+
* })
|
|
26749
|
+
* ```
|
|
26750
|
+
*/
|
|
26751
|
+
headers?: Record<string, string>;
|
|
25982
26752
|
}
|
|
25983
26753
|
|
|
25984
26754
|
/**
|
|
@@ -26778,6 +27548,17 @@ type FeeOperationType = 'bridge' | 'swap';
|
|
|
26778
27548
|
* proper parameter validation based on the selected operation.
|
|
26779
27549
|
*/
|
|
26780
27550
|
type OperationType = FeeOperationType | 'earn' | 'unifiedBalance';
|
|
27551
|
+
/**
|
|
27552
|
+
* Options for filtering chains supported by AppKit bridge operations.
|
|
27553
|
+
*
|
|
27554
|
+
* @example
|
|
27555
|
+
* ```typescript
|
|
27556
|
+
* const sourceFeeChains = kit.getSupportedChains('bridge', {
|
|
27557
|
+
* sourceFeeSupported: true,
|
|
27558
|
+
* })
|
|
27559
|
+
* ```
|
|
27560
|
+
*/
|
|
27561
|
+
type BridgeSupportedChainsOptions = GetSupportedChainsOptions$1;
|
|
26781
27562
|
/**
|
|
26782
27563
|
* Maps operation types to their corresponding parameter interfaces.
|
|
26783
27564
|
*
|
|
@@ -26981,13 +27762,18 @@ interface AppKitContext {
|
|
|
26981
27762
|
*/
|
|
26982
27763
|
disableErrorReporting?: boolean;
|
|
26983
27764
|
/**
|
|
26984
|
-
* Custom HTTP headers forwarded with
|
|
26985
|
-
* attestation (Iris)
|
|
27765
|
+
* Custom HTTP headers forwarded with Circle API requests made by the
|
|
27766
|
+
* underlying kits: the CCTP provider's attestation (Iris) requests for
|
|
27767
|
+
* bridge operations, and the Gateway API requests for unified-balance
|
|
27768
|
+
* operations.
|
|
26986
27769
|
*
|
|
26987
27770
|
* @remarks
|
|
26988
27771
|
* Headers are merged on top of the SDK defaults (such as `Content-Type`)
|
|
26989
|
-
* rather than replacing them.
|
|
26990
|
-
* the SDK does not interpret it.
|
|
27772
|
+
* rather than replacing them. Each header is forwarded as-is to Circle's API;
|
|
27773
|
+
* the SDK does not interpret it. The same map is forwarded to every relevant
|
|
27774
|
+
* kit, so a header a given API ignores is simply a no-op there. A
|
|
27775
|
+
* `unifiedBalance.headers` value, if provided, takes precedence for the
|
|
27776
|
+
* unified-balance kit.
|
|
26991
27777
|
*/
|
|
26992
27778
|
headers?: Record<string, string>;
|
|
26993
27779
|
}
|
|
@@ -28068,6 +28854,11 @@ declare class AppKit {
|
|
|
28068
28854
|
* console.log('Estimated fees:', estimate.fees)
|
|
28069
28855
|
* ```
|
|
28070
28856
|
*/
|
|
28857
|
+
estimateBridge(params: BridgeParams & {
|
|
28858
|
+
config: {
|
|
28859
|
+
feePayment: 'source';
|
|
28860
|
+
};
|
|
28861
|
+
}): Promise<ReceiveExactEstimateResult>;
|
|
28071
28862
|
estimateBridge(params: BridgeParams): Promise<EstimateResult$1>;
|
|
28072
28863
|
/**
|
|
28073
28864
|
* Execute a send operation for known token aliases (USDC, USDT, NATIVE) or custom ERC-20/SPL tokens.
|
|
@@ -28180,7 +28971,7 @@ declare class AppKit {
|
|
|
28180
28971
|
* config: {
|
|
28181
28972
|
* slippageBps: 300, // 3% slippage
|
|
28182
28973
|
* allowanceStrategy: 'permit',
|
|
28183
|
-
*
|
|
28974
|
+
* apiKey: 'TEST_API_KEY:id:secret'
|
|
28184
28975
|
* }
|
|
28185
28976
|
* })
|
|
28186
28977
|
*
|
|
@@ -28208,7 +28999,7 @@ declare class AppKit {
|
|
|
28208
28999
|
* amountIn: '100.50',
|
|
28209
29000
|
* config: {
|
|
28210
29001
|
* slippageBps: 300,
|
|
28211
|
-
*
|
|
29002
|
+
* apiKey: 'TEST_API_KEY:id:secret'
|
|
28212
29003
|
* }
|
|
28213
29004
|
* })
|
|
28214
29005
|
*
|
|
@@ -28231,7 +29022,7 @@ declare class AppKit {
|
|
|
28231
29022
|
* not write the polling loop yourself.
|
|
28232
29023
|
*
|
|
28233
29024
|
* @param params - `txHash` and `chainIn`, plus optional `chainOut` and
|
|
28234
|
-
* `
|
|
29025
|
+
* `apiKey`.
|
|
28235
29026
|
* @returns A snapshot of the swap's status at the time of the call.
|
|
28236
29027
|
* @throws \{KitError\} If `chainIn` or `chainOut` is malformed.
|
|
28237
29028
|
*
|
|
@@ -28244,7 +29035,7 @@ declare class AppKit {
|
|
|
28244
29035
|
* txHash: result.txHash,
|
|
28245
29036
|
* chainIn: result.chainIn,
|
|
28246
29037
|
* chainOut: result.chainOut,
|
|
28247
|
-
*
|
|
29038
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
28248
29039
|
* })
|
|
28249
29040
|
*
|
|
28250
29041
|
* console.log(status.progress.status, status.progress.substatus)
|
|
@@ -28257,7 +29048,7 @@ declare class AppKit {
|
|
|
28257
29048
|
* txHash: result.txHash,
|
|
28258
29049
|
* chainIn: result.chainIn,
|
|
28259
29050
|
* chainOut: result.chainOut,
|
|
28260
|
-
*
|
|
29051
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
28261
29052
|
* })
|
|
28262
29053
|
* while (status.progress.status === 'PENDING') {
|
|
28263
29054
|
* await new Promise((r) => setTimeout(r, 3_000))
|
|
@@ -28265,7 +29056,7 @@ declare class AppKit {
|
|
|
28265
29056
|
* txHash: result.txHash,
|
|
28266
29057
|
* chainIn: result.chainIn,
|
|
28267
29058
|
* chainOut: result.chainOut,
|
|
28268
|
-
*
|
|
29059
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
28269
29060
|
* })
|
|
28270
29061
|
* }
|
|
28271
29062
|
* ```
|
|
@@ -28283,7 +29074,7 @@ declare class AppKit {
|
|
|
28283
29074
|
* expires. Timeouts surface as a RETRYABLE `KitError` so callers can
|
|
28284
29075
|
* re-invoke with the same `txHash`.
|
|
28285
29076
|
*
|
|
28286
|
-
* @param params - Wait configuration: identifiers,
|
|
29077
|
+
* @param params - Wait configuration: identifiers, API key, and optional
|
|
28287
29078
|
* `timeoutMs` / `onProgress`.
|
|
28288
29079
|
* @returns The first terminal {@link SwapStatusResult} observed.
|
|
28289
29080
|
* @throws \{KitError\} (`NETWORK.TIMEOUT`, RETRYABLE) when the wait
|
|
@@ -28296,7 +29087,7 @@ declare class AppKit {
|
|
|
28296
29087
|
*
|
|
28297
29088
|
* const final = await kit.waitForSwap({
|
|
28298
29089
|
* result,
|
|
28299
|
-
*
|
|
29090
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
28300
29091
|
* onProgress: (snap) => console.log(snap.progress.status),
|
|
28301
29092
|
* })
|
|
28302
29093
|
*
|
|
@@ -28312,7 +29103,7 @@ declare class AppKit {
|
|
|
28312
29103
|
* txHash: persisted.txHash,
|
|
28313
29104
|
* chainIn: persisted.chainIn,
|
|
28314
29105
|
* chainOut: persisted.chainOut,
|
|
28315
|
-
*
|
|
29106
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
28316
29107
|
* })
|
|
28317
29108
|
* ```
|
|
28318
29109
|
*/
|
|
@@ -28343,7 +29134,7 @@ declare class AppKit {
|
|
|
28343
29134
|
* translates to the chain's native sentinel address — `0xEee…` for EVM,
|
|
28344
29135
|
* `1111…` for Solana — before querying the service.
|
|
28345
29136
|
*
|
|
28346
|
-
* @param params - `chain`, plus optional `tokens` and `
|
|
29137
|
+
* @param params - `chain`, plus optional `tokens` and `apiKey`.
|
|
28347
29138
|
* @returns A nested map of `[chain][address] → { priceUSD, fetchedAt }`.
|
|
28348
29139
|
* @throws \{KitError\} If `chain` is malformed, `tokens` exceeds 100
|
|
28349
29140
|
* entries, or any entry is neither a registered symbol nor a
|
|
@@ -28354,7 +29145,7 @@ declare class AppKit {
|
|
|
28354
29145
|
* const { rates } = await kit.getTokenRates({
|
|
28355
29146
|
* chain: 'Ethereum',
|
|
28356
29147
|
* tokens: ['USDC', 'EURC'],
|
|
28357
|
-
*
|
|
29148
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
28358
29149
|
* })
|
|
28359
29150
|
*
|
|
28360
29151
|
* const usdc = rates['Ethereum']?.['0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48']
|
|
@@ -28370,7 +29161,9 @@ declare class AppKit {
|
|
|
28370
29161
|
* operation (bridge, swap, earn, or unified balance).
|
|
28371
29162
|
*
|
|
28372
29163
|
* @param operationType - Optional operation type to filter chains ('bridge' | 'swap' | 'earn' | 'unifiedBalance')
|
|
29164
|
+
* @param options - Optional Bridge Kit chain filters when `operationType` is `'bridge'`.
|
|
28373
29165
|
* @returns Array of unique chain definitions supporting the specified operation(s)
|
|
29166
|
+
* @throws \{ValidationError\} If bridge filter options are invalid or used with another operation.
|
|
28374
29167
|
*
|
|
28375
29168
|
* @example Get all supported chains
|
|
28376
29169
|
* ```typescript
|
|
@@ -28392,8 +29185,17 @@ declare class AppKit {
|
|
|
28392
29185
|
*
|
|
28393
29186
|
* console.log('Chains supporting bridge:', bridgeChains.map(c => c.name))
|
|
28394
29187
|
* ```
|
|
29188
|
+
*
|
|
29189
|
+
* @example Get chains that support source-paid bridge fees
|
|
29190
|
+
* ```typescript
|
|
29191
|
+
* const kit = new AppKit()
|
|
29192
|
+
* const sourceFeeChains = kit.getSupportedChains('bridge', {
|
|
29193
|
+
* sourceFeeSupported: true,
|
|
29194
|
+
* })
|
|
29195
|
+
* ```
|
|
28395
29196
|
*/
|
|
28396
|
-
getSupportedChains(operationType?:
|
|
29197
|
+
getSupportedChains(operationType: 'bridge', options?: BridgeSupportedChainsOptions): ChainDefinition[];
|
|
29198
|
+
getSupportedChains(operationType?: Exclude<OperationType, 'bridge'>): ChainDefinition[];
|
|
28397
29199
|
/**
|
|
28398
29200
|
* Set operation-scoped custom fee policies.
|
|
28399
29201
|
*
|
|
@@ -28637,4 +29439,4 @@ declare function isTokenAddress(token: string, chain: ChainDefinition): token is
|
|
|
28637
29439
|
declare function validateToken(token: string, chain: ChainDefinition): TokenValidationResult;
|
|
28638
29440
|
|
|
28639
29441
|
export { AppKit, AppKitUnifiedBalance, BalanceError, Blockchain, BridgeChain, EARN_EXECUTE_REVIEW_KIND, EarnChain, EarnError, EarnKit, InputError, KitError, NetworkError, OnchainError, RateLimitError, RpcError, ServiceError, SwapChain, TOKEN_ALIASES, TransferSpeed, UnifiedBalanceChain, anyDepositParamsSchema, claimRewardsParamsSchema, createEarnKitContext, depositParamsSchema, claimRewards as earnClaimRewards, deposit as earnDeposit, exploreVaults as earnExploreVaults, exploreVaultsIterator as earnExploreVaultsIterator, getClaimRewardsQuote as earnGetClaimRewardsQuote, getCrossChainDepositStatus as earnGetCrossChainDepositStatus, getCrossChainDepositStatusOutcome as earnGetCrossChainDepositStatusOutcome, getDepositQuote as earnGetDepositQuote, getPosition as earnGetPosition, getSupportedChains as earnGetSupportedChains, getVaults as earnGetVaults, getWithdrawalQuote as earnGetWithdrawalQuote, waitForCrossChainDeposit as earnWaitForCrossChainDeposit, withdraw as earnWithdraw, exploreVaultsIteratorParamsSchema, exploreVaultsParamsSchema, getClaimRewardsQuoteParamsSchema, getCrossChainDepositStatusParamsSchema, getDepositQuoteParamsSchema, getErrorCode, getErrorMessage, getPositionParamsSchema, getTokenDecimals, getVaultsParamsSchema, getWithdrawalQuoteParamsSchema, isBalanceError, isEarnExecuteReview, isFatalError, isInputError, isKitError, isNetworkError, isOnchainError, isRateLimitError, isRetryableError, isRpcError, isServiceError, isTerminalCrossChainDepositStatus as isTerminalEarnCrossChainDepositStatus, isTokenAddress, isTokenAlias, isUserCancellationError, setExternalPrefix, validateToken, waitForCrossChainDepositParamsSchema, withdrawParamsSchema };
|
|
28640
|
-
export type { ActionHandler, AdapterContext, AllowanceStrategy$2 as AllowanceStrategy, AppKitActionName, AppKitActions, AppKitBridgeActions, AppKitConfig, AppKitContext, AppKitCustomFeePolicy, AppKitCustomFeePolicyScope, AppKitEarnActions, AppKitEarnOperations, AppKitUnifiedBalanceActions, BaseChainDefinition, BridgeConfig, CustomFeePolicy$2 as BridgeCustomFeePolicy, BridgeParams, BridgeResult, BridgeStep, CCTPConfig, CCTPMergedConfig, CCTPSplitConfig, ChainDefinition, Currency, DecodedEarnTx, DelegateStatus, DepositForParams, DepositParams, DepositResult, DeveloperFeeHooks, EVMChainDefinition, EarnAccruedRewardInfo, EarnAdapterContext, AnyDepositParams as EarnAnyDepositParams, EarnAssetAmount, EarnBridgeCctpStatus, EarnBridgeHopStatus, EarnBridgeQuoteExpiry, ClaimRewardsParams as EarnClaimRewardsParams, EarnClaimRewardsQuoteInfo, EarnClaimRewardsResult, EarnClaimedAmount, EarnClaimedRewardsResult, EarnConfig, EarnCrossChainDepositDestination, CrossChainDepositParams as EarnCrossChainDepositParams, EarnCrossChainDepositResult, EarnCrossChainDepositStatus, EarnCrossChainDepositWaitOutcome, EarnCrossChainDepositWaitResult, CrossChainGetDepositQuoteParams as EarnCrossChainGetDepositQuoteParams, EarnDepositOutcome, DepositParams$2 as EarnDepositParams, EarnDepositQuoteInfo, EarnDepositResult, EarnEncodedTransaction, EarnExecuteAuthorizationReview, EarnExecuteReview, ExploreVaultsIteratorParams as EarnExploreVaultsIteratorParams, ExploreVaultsPagination as EarnExploreVaultsPagination, ExploreVaultsParams as EarnExploreVaultsParams, EarnExploreVaultsResult, ExploreVaultsSortBy as EarnExploreVaultsSortBy, EarnGasFeeEstimate, EarnGasFeeEstimateBase, GetClaimRewardsQuoteParams as EarnGetClaimRewardsQuoteParams, GetCrossChainDepositStatusParams as EarnGetCrossChainDepositStatusParams, GetDepositQuoteParams as EarnGetDepositQuoteParams, GetPositionParams as EarnGetPositionParams, GetVaultsParams as EarnGetVaultsParams, EarnGetVaultsResult, GetWithdrawalQuoteParams as EarnGetWithdrawalQuoteParams, EarnKitConfig, EarnKitContext, EarnOperationParams, EarnPositionInfo, EarnPositionPnLInfo, EarningProvider as EarnProvider, SameChainDepositParams as EarnSameChainDepositParams, EarnSameChainDepositResult, SameChainGetDepositQuoteParams as EarnSameChainGetDepositQuoteParams, EarnServiceConfig, EarnVaultInfo, VaultQuery as EarnVaultQuery, WaitForCrossChainDepositParams as EarnWaitForCrossChainDepositParams, WithdrawParams as EarnWithdrawParams, EarnWithdrawResult, EarnWithdrawalQuoteInfo, ErrorDetails, EstimateResult$1 as EstimateResult, EstimateSpendResult, EstimatedGas, FeeOperationType, GetBalancesParams, GetBalancesResult, GetDelegateStatusParams, GetSupportedChainsOptions, GetSwapStatusParams, GetTokenRatesParams, GetTokenRatesResult, InitiateRemoveFundParams, InitiateRemoveFundResult, KitContractType, NonEVMChainDefinition, OperationParamsMap, OperationType, Recoverability, RemoveFundParams, RemoveFundResult, RetryContext, SendParams, SpendDestination, SpendParams, SpendResult, SwapConfig, CustomFeePolicy$1 as SwapCustomFeePolicy, SwapDestinationLeg, SwapEstimate, SwapFeeContext, SwapKitConfig, SwapKitContext, SwapParams, SwapProgress, SwapResult, SwapSourceLeg, SwapStatus, SwapStatusResult, SwapTerminalStatus, TokenInfo, TokenRate, UnifiedBalanceChainIdentifier, CustomFeePolicy as UnifiedBalanceCustomFeePolicy, FeeRecipientsConfig as UnifiedBalanceFeeRecipientsConfig, UnifiedBalanceKitConfig, SupportedToken as UnifiedBalanceSupportedToken, UpdateDelegateParams, UpdateDelegateResult, VersionConfig, WaitForSwapDiscreteParams, WaitForSwapParams, WaitForSwapResultParams };
|
|
29442
|
+
export type { ActionHandler, AdapterContext, AllowanceStrategy$2 as AllowanceStrategy, AppKitActionName, AppKitActions, AppKitBridgeActions, AppKitConfig, AppKitContext, AppKitCustomFeePolicy, AppKitCustomFeePolicyScope, AppKitEarnActions, AppKitEarnOperations, AppKitUnifiedBalanceActions, BaseChainDefinition, BridgeConfig, CustomFeePolicy$2 as BridgeCustomFeePolicy, BridgeEstimateResult, BridgeExecutionConfig, BridgeParams, BridgeResult, BridgeStep, BridgeSupportedChainsOptions, CCTPConfig, CCTPMergedConfig, CCTPSplitConfig, ChainDefinition, Currency, DecodedEarnTx, DelegateStatus, DepositForParams, DepositParams, DepositResult, DeveloperFeeHooks, EVMChainDefinition, EarnAccruedRewardInfo, EarnAdapterContext, AnyDepositParams as EarnAnyDepositParams, EarnAssetAmount, EarnBridgeCctpStatus, EarnBridgeHopStatus, EarnBridgeQuoteExpiry, ClaimRewardsParams as EarnClaimRewardsParams, EarnClaimRewardsQuoteInfo, EarnClaimRewardsResult, EarnClaimedAmount, EarnClaimedRewardsResult, EarnConfig, EarnCrossChainDepositDestination, CrossChainDepositParams as EarnCrossChainDepositParams, EarnCrossChainDepositResult, EarnCrossChainDepositStatus, EarnCrossChainDepositWaitOutcome, EarnCrossChainDepositWaitResult, CrossChainGetDepositQuoteParams as EarnCrossChainGetDepositQuoteParams, EarnDepositOutcome, DepositParams$2 as EarnDepositParams, EarnDepositQuoteInfo, EarnDepositResult, EarnEncodedTransaction, EarnExecuteAuthorizationReview, EarnExecuteReview, ExploreVaultsIteratorParams as EarnExploreVaultsIteratorParams, ExploreVaultsPagination as EarnExploreVaultsPagination, ExploreVaultsParams as EarnExploreVaultsParams, EarnExploreVaultsResult, ExploreVaultsSortBy as EarnExploreVaultsSortBy, EarnGasFeeEstimate, EarnGasFeeEstimateBase, GetClaimRewardsQuoteParams as EarnGetClaimRewardsQuoteParams, GetCrossChainDepositStatusParams as EarnGetCrossChainDepositStatusParams, GetDepositQuoteParams as EarnGetDepositQuoteParams, GetPositionParams as EarnGetPositionParams, GetVaultsParams as EarnGetVaultsParams, EarnGetVaultsResult, GetWithdrawalQuoteParams as EarnGetWithdrawalQuoteParams, EarnKitConfig, EarnKitContext, EarnOperationParams, EarnPositionInfo, EarnPositionPnLInfo, EarningProvider as EarnProvider, SameChainDepositParams as EarnSameChainDepositParams, EarnSameChainDepositResult, SameChainGetDepositQuoteParams as EarnSameChainGetDepositQuoteParams, EarnServiceConfig, EarnVaultInfo, VaultQuery as EarnVaultQuery, WaitForCrossChainDepositParams as EarnWaitForCrossChainDepositParams, WithdrawParams as EarnWithdrawParams, EarnWithdrawResult, EarnWithdrawalQuoteInfo, ErrorDetails, EstimateResult$1 as EstimateResult, EstimateSpendResult, EstimatedGas, FeeOperationType, GetBalancesParams, GetBalancesResult, GetDelegateStatusParams, GetSupportedChainsOptions, GetSwapStatusParams, GetTokenRatesParams, GetTokenRatesResult, InitiateRemoveFundParams, InitiateRemoveFundResult, KitContractType, NonEVMChainDefinition, OperationParamsMap, OperationType, ReceiveExactEstimateResult, ReceiveExactFeeItem, Recoverability, RemoveFundParams, RemoveFundResult, RetryContext, SendParams, SpendDestination, SpendParams, SpendResult, SwapConfig, CustomFeePolicy$1 as SwapCustomFeePolicy, SwapDestinationLeg, SwapEstimate, SwapFeeContext, SwapKitConfig, SwapKitContext, SwapParams, SwapProgress, SwapResult, SwapSourceLeg, SwapStatus, SwapStatusResult, SwapTerminalStatus, TokenInfo, TokenRate, UnifiedBalanceChainIdentifier, CustomFeePolicy as UnifiedBalanceCustomFeePolicy, FeeRecipientsConfig as UnifiedBalanceFeeRecipientsConfig, UnifiedBalanceKitConfig, SupportedToken as UnifiedBalanceSupportedToken, UpdateDelegateParams, UpdateDelegateResult, VersionConfig, WaitForSwapDiscreteParams, WaitForSwapParams, WaitForSwapResultParams };
|