@circle-fin/app-kit 1.12.1 → 1.14.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 +115 -0
- package/README.md +31 -12
- package/bridge.cjs +3231 -340
- package/bridge.d.cts +141 -17
- package/bridge.d.mts +141 -17
- package/bridge.d.ts +141 -17
- package/bridge.mjs +3233 -342
- package/chains.cjs +261 -8
- package/chains.d.cts +135 -1
- package/chains.d.mts +135 -1
- package/chains.d.ts +135 -1
- package/chains.mjs +260 -9
- package/context.d.cts +141 -17
- package/context.d.mts +141 -17
- package/context.d.ts +141 -17
- package/earn.cjs +887 -63
- package/earn.d.cts +141 -17
- package/earn.d.mts +141 -17
- package/earn.d.ts +141 -17
- package/earn.mjs +883 -63
- package/estimateBridge.cjs +3231 -340
- package/estimateBridge.d.cts +257 -18
- package/estimateBridge.d.mts +257 -18
- package/estimateBridge.d.ts +257 -18
- package/estimateBridge.mjs +3233 -342
- package/estimateSwap.cjs +988 -146
- package/estimateSwap.d.cts +141 -17
- package/estimateSwap.d.mts +141 -17
- package/estimateSwap.d.ts +141 -17
- package/estimateSwap.mjs +987 -146
- package/index.cjs +6828 -894
- package/index.d.cts +1621 -258
- package/index.d.mts +1621 -258
- package/index.d.ts +1621 -258
- package/index.mjs +6830 -896
- package/package.json +6 -6
- package/swap.cjs +988 -146
- package/swap.d.cts +148 -18
- package/swap.d.mts +148 -18
- package/swap.d.ts +148 -18
- package/swap.mjs +987 -146
- package/unifiedBalance.cjs +22219 -9689
- package/unifiedBalance.d.cts +620 -162
- package/unifiedBalance.d.mts +620 -162
- package/unifiedBalance.d.ts +620 -162
- package/unifiedBalance.mjs +22348 -9819
package/index.d.ts
CHANGED
|
@@ -559,6 +559,19 @@ interface GatewayV1Contracts {
|
|
|
559
559
|
* @example "0xD05E7D2E7d30b92c5F17d7d0fC575fce231F1A48"
|
|
560
560
|
*/
|
|
561
561
|
depositForHandler?: string;
|
|
562
|
+
/**
|
|
563
|
+
* The address of the `GenericExecutor` contract.
|
|
564
|
+
*
|
|
565
|
+
* @description Optional. The contract that acts as `mintRecipient` and
|
|
566
|
+
* `destinationCaller` for the CCTP v2 prepaid FORWARD path. It receives the
|
|
567
|
+
* CCTP mint and calls {@link GatewayV1Contracts.depositForHandler} to
|
|
568
|
+
* complete the fast deposit into the {@link GatewayV1Contracts.wallet}.
|
|
569
|
+
* Present only on chains that are fast-deposit destinations; other Gateway
|
|
570
|
+
* chains omit it.
|
|
571
|
+
*
|
|
572
|
+
* @example "0xFa7be2f04F3Ad4ca969260729c6d45B5625984A7"
|
|
573
|
+
*/
|
|
574
|
+
genericExecutor?: string;
|
|
562
575
|
}
|
|
563
576
|
/**
|
|
564
577
|
* Versioned map of Gateway contract configurations.
|
|
@@ -718,6 +731,8 @@ declare enum Blockchain {
|
|
|
718
731
|
Optimism_Sepolia = "Optimism_Sepolia",
|
|
719
732
|
Pharos = "Pharos",
|
|
720
733
|
Pharos_Testnet = "Pharos_Testnet",
|
|
734
|
+
Plasma = "Plasma",
|
|
735
|
+
Plasma_Testnet = "Plasma_Testnet",
|
|
721
736
|
Polkadot_Asset_Hub = "Polkadot_Asset_Hub",
|
|
722
737
|
Polkadot_Westmint = "Polkadot_Westmint",
|
|
723
738
|
Plume = "Plume",
|
|
@@ -946,6 +961,7 @@ declare enum BridgeChain {
|
|
|
946
961
|
Morph = "Morph",
|
|
947
962
|
Optimism = "Optimism",
|
|
948
963
|
Pharos = "Pharos",
|
|
964
|
+
Plasma = "Plasma",
|
|
949
965
|
Plume = "Plume",
|
|
950
966
|
Polygon = "Polygon",
|
|
951
967
|
Sei = "Sei",
|
|
@@ -971,6 +987,7 @@ declare enum BridgeChain {
|
|
|
971
987
|
Morph_Testnet = "Morph_Testnet",
|
|
972
988
|
Optimism_Sepolia = "Optimism_Sepolia",
|
|
973
989
|
Pharos_Testnet = "Pharos_Testnet",
|
|
990
|
+
Plasma_Testnet = "Plasma_Testnet",
|
|
974
991
|
Plume_Testnet = "Plume_Testnet",
|
|
975
992
|
Polygon_Amoy_Testnet = "Polygon_Amoy_Testnet",
|
|
976
993
|
Sei_Testnet = "Sei_Testnet",
|
|
@@ -1377,6 +1394,7 @@ declare const ArcTestnet: {
|
|
|
1377
1394
|
readonly v2: {
|
|
1378
1395
|
readonly type: "split";
|
|
1379
1396
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
1397
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
1380
1398
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
1381
1399
|
readonly confirmations: 1;
|
|
1382
1400
|
readonly fastConfirmations: 1;
|
|
@@ -1398,6 +1416,7 @@ declare const ArcTestnet: {
|
|
|
1398
1416
|
readonly wallet: "0x0077777d7EBA4688BDeF3E311b846F25870A19B9";
|
|
1399
1417
|
readonly minter: "0x0022222ABE238Cc2C7Bb1f21003F0a260052475B";
|
|
1400
1418
|
readonly depositForHandler: "0xD05E7D2E7d30b92c5F17d7d0fC575fce231F1A48";
|
|
1419
|
+
readonly genericExecutor: "0xEdC81040756AcCfF070c21D37b265b9D0b5Ba45e";
|
|
1401
1420
|
};
|
|
1402
1421
|
};
|
|
1403
1422
|
readonly forwarderSupported: {
|
|
@@ -1441,6 +1460,7 @@ declare const Arbitrum: {
|
|
|
1441
1460
|
readonly v2: {
|
|
1442
1461
|
readonly type: "split";
|
|
1443
1462
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
1463
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
1444
1464
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
1445
1465
|
readonly confirmations: 65;
|
|
1446
1466
|
readonly fastConfirmations: 1;
|
|
@@ -1504,6 +1524,7 @@ declare const ArbitrumSepolia: {
|
|
|
1504
1524
|
readonly v2: {
|
|
1505
1525
|
readonly type: "split";
|
|
1506
1526
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
1527
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
1507
1528
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
1508
1529
|
readonly confirmations: 65;
|
|
1509
1530
|
readonly fastConfirmations: 1;
|
|
@@ -1567,6 +1588,7 @@ declare const Avalanche: {
|
|
|
1567
1588
|
readonly v2: {
|
|
1568
1589
|
readonly type: "split";
|
|
1569
1590
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
1591
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
1570
1592
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
1571
1593
|
readonly confirmations: 1;
|
|
1572
1594
|
readonly fastConfirmations: 1;
|
|
@@ -1587,6 +1609,8 @@ declare const Avalanche: {
|
|
|
1587
1609
|
readonly v1: {
|
|
1588
1610
|
readonly wallet: "0x77777777Dcc4d5A8B6E418Fd04D8997ef11000eE";
|
|
1589
1611
|
readonly minter: "0x2222222d7164433c4C09B0b0D809a9b52C04C205";
|
|
1612
|
+
readonly depositForHandler: "0x16529813203f77E036576666336554a1210dce4D";
|
|
1613
|
+
readonly genericExecutor: "0xFa7be2f04F3Ad4ca969260729c6d45B5625984A7";
|
|
1590
1614
|
};
|
|
1591
1615
|
};
|
|
1592
1616
|
readonly forwarderSupported: {
|
|
@@ -1629,6 +1653,7 @@ declare const AvalancheFuji: {
|
|
|
1629
1653
|
readonly v2: {
|
|
1630
1654
|
readonly type: "split";
|
|
1631
1655
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
1656
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
1632
1657
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
1633
1658
|
readonly confirmations: 1;
|
|
1634
1659
|
readonly fastConfirmations: 1;
|
|
@@ -1649,6 +1674,8 @@ declare const AvalancheFuji: {
|
|
|
1649
1674
|
readonly v1: {
|
|
1650
1675
|
readonly wallet: "0x0077777d7EBA4688BDeF3E311b846F25870A19B9";
|
|
1651
1676
|
readonly minter: "0x0022222ABE238Cc2C7Bb1f21003F0a260052475B";
|
|
1677
|
+
readonly depositForHandler: "0xD05E7D2E7d30b92c5F17d7d0fC575fce231F1A48";
|
|
1678
|
+
readonly genericExecutor: "0xEdC81040756AcCfF070c21D37b265b9D0b5Ba45e";
|
|
1652
1679
|
};
|
|
1653
1680
|
};
|
|
1654
1681
|
readonly forwarderSupported: {
|
|
@@ -1692,6 +1719,7 @@ declare const Base: {
|
|
|
1692
1719
|
readonly v2: {
|
|
1693
1720
|
readonly type: "split";
|
|
1694
1721
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
1722
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
1695
1723
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
1696
1724
|
readonly confirmations: 65;
|
|
1697
1725
|
readonly fastConfirmations: 1;
|
|
@@ -1755,6 +1783,7 @@ declare const BaseSepolia: {
|
|
|
1755
1783
|
readonly v2: {
|
|
1756
1784
|
readonly type: "split";
|
|
1757
1785
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
1786
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
1758
1787
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
1759
1788
|
readonly confirmations: 65;
|
|
1760
1789
|
readonly fastConfirmations: 1;
|
|
@@ -1862,6 +1891,7 @@ declare const Codex: {
|
|
|
1862
1891
|
readonly v2: {
|
|
1863
1892
|
readonly type: "split";
|
|
1864
1893
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
1894
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
1865
1895
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
1866
1896
|
readonly confirmations: 65;
|
|
1867
1897
|
readonly fastConfirmations: 1;
|
|
@@ -1905,6 +1935,7 @@ declare const CodexTestnet: {
|
|
|
1905
1935
|
readonly v2: {
|
|
1906
1936
|
readonly type: "split";
|
|
1907
1937
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
1938
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
1908
1939
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
1909
1940
|
readonly confirmations: 65;
|
|
1910
1941
|
readonly fastConfirmations: 1;
|
|
@@ -1949,6 +1980,7 @@ declare const Cronos: {
|
|
|
1949
1980
|
readonly v2: {
|
|
1950
1981
|
readonly type: "split";
|
|
1951
1982
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
1983
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
1952
1984
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
1953
1985
|
readonly confirmations: 1;
|
|
1954
1986
|
readonly fastConfirmations: 1;
|
|
@@ -1993,6 +2025,7 @@ declare const CronosTestnet: {
|
|
|
1993
2025
|
readonly v2: {
|
|
1994
2026
|
readonly type: "split";
|
|
1995
2027
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
2028
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
1996
2029
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
1997
2030
|
readonly confirmations: 1;
|
|
1998
2031
|
readonly fastConfirmations: 1;
|
|
@@ -2037,6 +2070,7 @@ declare const Edge: {
|
|
|
2037
2070
|
readonly v2: {
|
|
2038
2071
|
readonly type: "split";
|
|
2039
2072
|
readonly tokenMessenger: "0x98706A006bc632Df31CAdFCBD43F38887ce2ca5c";
|
|
2073
|
+
readonly tokenMessengerWithFees: "0x3Ac96675F9a3E6922713e041645D82f3561d3686";
|
|
2040
2074
|
readonly messageTransmitter: "0x5b61381Fc9e58E70EfC13a4A97516997019198ee";
|
|
2041
2075
|
readonly confirmations: 65;
|
|
2042
2076
|
readonly fastConfirmations: 1;
|
|
@@ -2081,6 +2115,7 @@ declare const EdgeTestnet: {
|
|
|
2081
2115
|
readonly v2: {
|
|
2082
2116
|
readonly type: "split";
|
|
2083
2117
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
2118
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
2084
2119
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
2085
2120
|
readonly confirmations: 65;
|
|
2086
2121
|
readonly fastConfirmations: 1;
|
|
@@ -2130,6 +2165,7 @@ declare const Ethereum: {
|
|
|
2130
2165
|
readonly v2: {
|
|
2131
2166
|
readonly type: "split";
|
|
2132
2167
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
2168
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2133
2169
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2134
2170
|
readonly confirmations: 65;
|
|
2135
2171
|
readonly fastConfirmations: 2;
|
|
@@ -2193,6 +2229,7 @@ declare const EthereumSepolia: {
|
|
|
2193
2229
|
readonly v2: {
|
|
2194
2230
|
readonly type: "split";
|
|
2195
2231
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
2232
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
2196
2233
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
2197
2234
|
readonly confirmations: 65;
|
|
2198
2235
|
readonly fastConfirmations: 2;
|
|
@@ -2300,6 +2337,7 @@ declare const HyperEVM: {
|
|
|
2300
2337
|
readonly v2: {
|
|
2301
2338
|
readonly type: "split";
|
|
2302
2339
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
2340
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2303
2341
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2304
2342
|
readonly confirmations: 1;
|
|
2305
2343
|
readonly fastConfirmations: 1;
|
|
@@ -2358,6 +2396,7 @@ declare const HyperEVMTestnet: {
|
|
|
2358
2396
|
readonly v2: {
|
|
2359
2397
|
readonly type: "split";
|
|
2360
2398
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
2399
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
2361
2400
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
2362
2401
|
readonly confirmations: 1;
|
|
2363
2402
|
readonly fastConfirmations: 1;
|
|
@@ -2417,6 +2456,7 @@ declare const Injective: {
|
|
|
2417
2456
|
readonly v2: {
|
|
2418
2457
|
readonly type: "split";
|
|
2419
2458
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
2459
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2420
2460
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2421
2461
|
readonly confirmations: 1;
|
|
2422
2462
|
readonly fastConfirmations: 1;
|
|
@@ -2463,6 +2503,7 @@ declare const InjectiveTestnet: {
|
|
|
2463
2503
|
readonly v2: {
|
|
2464
2504
|
readonly type: "split";
|
|
2465
2505
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
2506
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
2466
2507
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
2467
2508
|
readonly confirmations: 1;
|
|
2468
2509
|
readonly fastConfirmations: 1;
|
|
@@ -2508,6 +2549,7 @@ declare const Ink: {
|
|
|
2508
2549
|
readonly v2: {
|
|
2509
2550
|
readonly type: "split";
|
|
2510
2551
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
2552
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2511
2553
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2512
2554
|
readonly confirmations: 65;
|
|
2513
2555
|
readonly fastConfirmations: 1;
|
|
@@ -2553,6 +2595,7 @@ declare const InkTestnet: {
|
|
|
2553
2595
|
readonly v2: {
|
|
2554
2596
|
readonly type: "split";
|
|
2555
2597
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
2598
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
2556
2599
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
2557
2600
|
readonly confirmations: 65;
|
|
2558
2601
|
readonly fastConfirmations: 1;
|
|
@@ -2596,6 +2639,7 @@ declare const Linea: {
|
|
|
2596
2639
|
readonly v2: {
|
|
2597
2640
|
readonly type: "split";
|
|
2598
2641
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
2642
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2599
2643
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2600
2644
|
readonly confirmations: 1;
|
|
2601
2645
|
readonly fastConfirmations: 1;
|
|
@@ -2640,6 +2684,7 @@ declare const LineaSepolia: {
|
|
|
2640
2684
|
readonly v2: {
|
|
2641
2685
|
readonly type: "split";
|
|
2642
2686
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
2687
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
2643
2688
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
2644
2689
|
readonly confirmations: 1;
|
|
2645
2690
|
readonly fastConfirmations: 1;
|
|
@@ -2685,6 +2730,7 @@ declare const Monad: {
|
|
|
2685
2730
|
readonly v2: {
|
|
2686
2731
|
readonly type: "split";
|
|
2687
2732
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
2733
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2688
2734
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2689
2735
|
readonly confirmations: 1;
|
|
2690
2736
|
readonly fastConfirmations: 1;
|
|
@@ -2731,6 +2777,7 @@ declare const MonadTestnet: {
|
|
|
2731
2777
|
readonly v2: {
|
|
2732
2778
|
readonly type: "split";
|
|
2733
2779
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
2780
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
2734
2781
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
2735
2782
|
readonly confirmations: 1;
|
|
2736
2783
|
readonly fastConfirmations: 1;
|
|
@@ -2775,6 +2822,7 @@ declare const Morph: {
|
|
|
2775
2822
|
readonly v2: {
|
|
2776
2823
|
readonly type: "split";
|
|
2777
2824
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
2825
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2778
2826
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2779
2827
|
readonly confirmations: 64;
|
|
2780
2828
|
readonly fastConfirmations: 1;
|
|
@@ -2819,6 +2867,7 @@ declare const MorphTestnet: {
|
|
|
2819
2867
|
readonly v2: {
|
|
2820
2868
|
readonly type: "split";
|
|
2821
2869
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
2870
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
2822
2871
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
2823
2872
|
readonly confirmations: 64;
|
|
2824
2873
|
readonly fastConfirmations: 1;
|
|
@@ -2990,6 +3039,7 @@ declare const Optimism: {
|
|
|
2990
3039
|
readonly v2: {
|
|
2991
3040
|
readonly type: "split";
|
|
2992
3041
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
3042
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
2993
3043
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
2994
3044
|
readonly confirmations: 65;
|
|
2995
3045
|
readonly fastConfirmations: 1;
|
|
@@ -3053,6 +3103,7 @@ declare const OptimismSepolia: {
|
|
|
3053
3103
|
readonly v2: {
|
|
3054
3104
|
readonly type: "split";
|
|
3055
3105
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
3106
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
3056
3107
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
3057
3108
|
readonly confirmations: 65;
|
|
3058
3109
|
readonly fastConfirmations: 1;
|
|
@@ -3111,6 +3162,7 @@ declare const Pharos: {
|
|
|
3111
3162
|
readonly v2: {
|
|
3112
3163
|
readonly type: "split";
|
|
3113
3164
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
3165
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
3114
3166
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
3115
3167
|
readonly confirmations: 1;
|
|
3116
3168
|
readonly fastConfirmations: 1;
|
|
@@ -3156,6 +3208,7 @@ declare const PharosTestnet: {
|
|
|
3156
3208
|
readonly v2: {
|
|
3157
3209
|
readonly type: "split";
|
|
3158
3210
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
3211
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
3159
3212
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
3160
3213
|
readonly confirmations: 1;
|
|
3161
3214
|
readonly fastConfirmations: 1;
|
|
@@ -3171,6 +3224,96 @@ declare const PharosTestnet: {
|
|
|
3171
3224
|
};
|
|
3172
3225
|
};
|
|
3173
3226
|
|
|
3227
|
+
/**
|
|
3228
|
+
* Plasma Mainnet chain definition
|
|
3229
|
+
* @remarks
|
|
3230
|
+
* This represents the official production network for the Plasma blockchain.
|
|
3231
|
+
* Plasma is an EVM-equivalent Layer 1 blockchain purpose-built for global
|
|
3232
|
+
* stablecoin payments, with deterministic BFT finality (PlasmaBFT/Fast-HotStuff).
|
|
3233
|
+
*/
|
|
3234
|
+
declare const Plasma: {
|
|
3235
|
+
readonly type: "evm";
|
|
3236
|
+
readonly chain: Blockchain.Plasma;
|
|
3237
|
+
readonly name: "Plasma";
|
|
3238
|
+
readonly title: "Plasma Mainnet";
|
|
3239
|
+
readonly nativeCurrency: {
|
|
3240
|
+
readonly name: "Plasma";
|
|
3241
|
+
readonly symbol: "XPL";
|
|
3242
|
+
readonly decimals: 18;
|
|
3243
|
+
};
|
|
3244
|
+
readonly chainId: 9745;
|
|
3245
|
+
readonly isTestnet: false;
|
|
3246
|
+
readonly explorerUrl: "https://plasmascan.to/tx/{hash}";
|
|
3247
|
+
readonly rpcEndpoints: readonly ["https://rpc.plasma.to"];
|
|
3248
|
+
readonly eurcAddress: "0x3EE196E78d4d4248b849B8E1C7F44C5457FAFD2C";
|
|
3249
|
+
readonly usdcAddress: "0x2d661C89D812261039AF9764eceaAee884f5F67F";
|
|
3250
|
+
readonly usdtAddress: null;
|
|
3251
|
+
readonly cctp: {
|
|
3252
|
+
readonly domain: 33;
|
|
3253
|
+
readonly contracts: {
|
|
3254
|
+
readonly v2: {
|
|
3255
|
+
readonly type: "split";
|
|
3256
|
+
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
3257
|
+
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
3258
|
+
readonly confirmations: 3;
|
|
3259
|
+
readonly fastConfirmations: 1;
|
|
3260
|
+
};
|
|
3261
|
+
};
|
|
3262
|
+
readonly forwarderSupported: {
|
|
3263
|
+
readonly source: false;
|
|
3264
|
+
readonly destination: false;
|
|
3265
|
+
};
|
|
3266
|
+
};
|
|
3267
|
+
readonly kitContracts: {
|
|
3268
|
+
readonly bridge: "0xB3FA262d0fB521cc93bE83d87b322b8A23DAf3F0";
|
|
3269
|
+
};
|
|
3270
|
+
};
|
|
3271
|
+
|
|
3272
|
+
/**
|
|
3273
|
+
* Plasma Testnet chain definition
|
|
3274
|
+
* @remarks
|
|
3275
|
+
* This represents the official test network for the Plasma blockchain.
|
|
3276
|
+
* Plasma is an EVM-equivalent Layer 1 blockchain purpose-built for global
|
|
3277
|
+
* stablecoin payments, with deterministic BFT finality (PlasmaBFT/Fast-HotStuff).
|
|
3278
|
+
*/
|
|
3279
|
+
declare const PlasmaTestnet: {
|
|
3280
|
+
readonly type: "evm";
|
|
3281
|
+
readonly chain: Blockchain.Plasma_Testnet;
|
|
3282
|
+
readonly name: "Plasma Testnet";
|
|
3283
|
+
readonly title: "Plasma Testnet";
|
|
3284
|
+
readonly nativeCurrency: {
|
|
3285
|
+
readonly name: "Plasma";
|
|
3286
|
+
readonly symbol: "XPL";
|
|
3287
|
+
readonly decimals: 18;
|
|
3288
|
+
};
|
|
3289
|
+
readonly chainId: 9746;
|
|
3290
|
+
readonly isTestnet: true;
|
|
3291
|
+
readonly explorerUrl: "https://testnet.plasmascan.to/tx/{hash}";
|
|
3292
|
+
readonly rpcEndpoints: readonly ["https://testnet-rpc.plasma.to"];
|
|
3293
|
+
readonly eurcAddress: "0x98AfA0F93Dd993B736399f9074eDcEBD1985A330";
|
|
3294
|
+
readonly usdcAddress: "0xE67Fb267022cBA8064Dd388CC2FED724F3120D9D";
|
|
3295
|
+
readonly usdtAddress: null;
|
|
3296
|
+
readonly cctp: {
|
|
3297
|
+
readonly domain: 33;
|
|
3298
|
+
readonly contracts: {
|
|
3299
|
+
readonly v2: {
|
|
3300
|
+
readonly type: "split";
|
|
3301
|
+
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
3302
|
+
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
3303
|
+
readonly confirmations: 3;
|
|
3304
|
+
readonly fastConfirmations: 1;
|
|
3305
|
+
};
|
|
3306
|
+
};
|
|
3307
|
+
readonly forwarderSupported: {
|
|
3308
|
+
readonly source: false;
|
|
3309
|
+
readonly destination: false;
|
|
3310
|
+
};
|
|
3311
|
+
};
|
|
3312
|
+
readonly kitContracts: {
|
|
3313
|
+
readonly bridge: "0xC5567a5E3370d4DBfB0540025078e283e36A363d";
|
|
3314
|
+
};
|
|
3315
|
+
};
|
|
3316
|
+
|
|
3174
3317
|
/**
|
|
3175
3318
|
* Plume Mainnet chain definition
|
|
3176
3319
|
* @remarks
|
|
@@ -3201,6 +3344,7 @@ declare const Plume: {
|
|
|
3201
3344
|
readonly v2: {
|
|
3202
3345
|
readonly type: "split";
|
|
3203
3346
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
3347
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
3204
3348
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
3205
3349
|
readonly confirmations: 65;
|
|
3206
3350
|
readonly fastConfirmations: 1;
|
|
@@ -3246,6 +3390,7 @@ declare const PlumeTestnet: {
|
|
|
3246
3390
|
readonly v2: {
|
|
3247
3391
|
readonly type: "split";
|
|
3248
3392
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
3393
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
3249
3394
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
3250
3395
|
readonly confirmations: 65;
|
|
3251
3396
|
readonly fastConfirmations: 1;
|
|
@@ -3343,6 +3488,7 @@ declare const Polygon: {
|
|
|
3343
3488
|
readonly v2: {
|
|
3344
3489
|
readonly type: "split";
|
|
3345
3490
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
3491
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
3346
3492
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
3347
3493
|
readonly confirmations: 33;
|
|
3348
3494
|
readonly fastConfirmations: 13;
|
|
@@ -3363,6 +3509,8 @@ declare const Polygon: {
|
|
|
3363
3509
|
readonly v1: {
|
|
3364
3510
|
readonly wallet: "0x77777777Dcc4d5A8B6E418Fd04D8997ef11000eE";
|
|
3365
3511
|
readonly minter: "0x2222222d7164433c4C09B0b0D809a9b52C04C205";
|
|
3512
|
+
readonly depositForHandler: "0x16529813203f77E036576666336554a1210dce4D";
|
|
3513
|
+
readonly genericExecutor: "0xFa7be2f04F3Ad4ca969260729c6d45B5625984A7";
|
|
3366
3514
|
};
|
|
3367
3515
|
};
|
|
3368
3516
|
readonly forwarderSupported: {
|
|
@@ -3406,6 +3554,7 @@ declare const PolygonAmoy: {
|
|
|
3406
3554
|
readonly v2: {
|
|
3407
3555
|
readonly type: "split";
|
|
3408
3556
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
3557
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
3409
3558
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
3410
3559
|
readonly confirmations: 33;
|
|
3411
3560
|
readonly fastConfirmations: 13;
|
|
@@ -3425,6 +3574,8 @@ declare const PolygonAmoy: {
|
|
|
3425
3574
|
readonly v1: {
|
|
3426
3575
|
readonly wallet: "0x0077777d7EBA4688BDeF3E311b846F25870A19B9";
|
|
3427
3576
|
readonly minter: "0x0022222ABE238Cc2C7Bb1f21003F0a260052475B";
|
|
3577
|
+
readonly depositForHandler: "0xD05E7D2E7d30b92c5F17d7d0fC575fce231F1A48";
|
|
3578
|
+
readonly genericExecutor: "0xEdC81040756AcCfF070c21D37b265b9D0b5Ba45e";
|
|
3428
3579
|
};
|
|
3429
3580
|
};
|
|
3430
3581
|
readonly forwarderSupported: {
|
|
@@ -3464,6 +3615,7 @@ declare const Sei: {
|
|
|
3464
3615
|
readonly v2: {
|
|
3465
3616
|
readonly type: "split";
|
|
3466
3617
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
3618
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
3467
3619
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
3468
3620
|
readonly confirmations: 1;
|
|
3469
3621
|
readonly fastConfirmations: 1;
|
|
@@ -3522,6 +3674,7 @@ declare const SeiTestnet: {
|
|
|
3522
3674
|
readonly v2: {
|
|
3523
3675
|
readonly type: "split";
|
|
3524
3676
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
3677
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
3525
3678
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
3526
3679
|
readonly confirmations: 1;
|
|
3527
3680
|
readonly fastConfirmations: 1;
|
|
@@ -3578,6 +3731,7 @@ declare const Sonic: {
|
|
|
3578
3731
|
readonly v2: {
|
|
3579
3732
|
readonly type: "split";
|
|
3580
3733
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
3734
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
3581
3735
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
3582
3736
|
readonly confirmations: 1;
|
|
3583
3737
|
readonly fastConfirmations: 1;
|
|
@@ -3635,6 +3789,7 @@ declare const SonicTestnet: {
|
|
|
3635
3789
|
readonly v2: {
|
|
3636
3790
|
readonly type: "split";
|
|
3637
3791
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
3792
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
3638
3793
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
3639
3794
|
readonly confirmations: 1;
|
|
3640
3795
|
readonly fastConfirmations: 1;
|
|
@@ -3943,6 +4098,7 @@ declare const Unichain: {
|
|
|
3943
4098
|
readonly v2: {
|
|
3944
4099
|
readonly type: "split";
|
|
3945
4100
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
4101
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
3946
4102
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
3947
4103
|
readonly confirmations: 65;
|
|
3948
4104
|
readonly fastConfirmations: 1;
|
|
@@ -4006,6 +4162,7 @@ declare const UnichainSepolia: {
|
|
|
4006
4162
|
readonly v2: {
|
|
4007
4163
|
readonly type: "split";
|
|
4008
4164
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
4165
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
4009
4166
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
4010
4167
|
readonly confirmations: 65;
|
|
4011
4168
|
readonly fastConfirmations: 1;
|
|
@@ -4062,6 +4219,7 @@ declare const WorldChain: {
|
|
|
4062
4219
|
readonly v2: {
|
|
4063
4220
|
readonly type: "split";
|
|
4064
4221
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cF5d";
|
|
4222
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
4065
4223
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
4066
4224
|
readonly confirmations: 65;
|
|
4067
4225
|
readonly fastConfirmations: 1;
|
|
@@ -4119,6 +4277,7 @@ declare const WorldChainSepolia: {
|
|
|
4119
4277
|
readonly v2: {
|
|
4120
4278
|
readonly type: "split";
|
|
4121
4279
|
readonly tokenMessenger: "0x8fe6b999dc680ccfdd5bf7eb0974218be2542daa";
|
|
4280
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
4122
4281
|
readonly messageTransmitter: "0xe737e5cebeeba77efe34d4aa090756590b1ce275";
|
|
4123
4282
|
readonly confirmations: 65;
|
|
4124
4283
|
readonly fastConfirmations: 1;
|
|
@@ -4177,6 +4336,7 @@ declare const XDC: {
|
|
|
4177
4336
|
readonly v2: {
|
|
4178
4337
|
readonly type: "split";
|
|
4179
4338
|
readonly tokenMessenger: "0x28b5a0e9C621a5BadaA536219b3a228C8168cf5d";
|
|
4339
|
+
readonly tokenMessengerWithFees: "0x71f54F818671cD0D7ea140Da213e5C8b5C92a408";
|
|
4180
4340
|
readonly messageTransmitter: "0x81D40F21F12A8F0E3252Bccb954D722d4c464B64";
|
|
4181
4341
|
readonly confirmations: 3;
|
|
4182
4342
|
readonly fastConfirmations: 3;
|
|
@@ -4221,6 +4381,7 @@ declare const XDCApothem: {
|
|
|
4221
4381
|
readonly v2: {
|
|
4222
4382
|
readonly type: "split";
|
|
4223
4383
|
readonly tokenMessenger: "0x8FE6B999Dc680CcFDD5Bf7EB0974218be2542DAA";
|
|
4384
|
+
readonly tokenMessengerWithFees: "0x8745D906D67C346E5eb1aEEED38Eb87F34DF0C0A";
|
|
4224
4385
|
readonly messageTransmitter: "0xE737e5cEBEEBa77EFE34D4aa090756590b1CE275";
|
|
4225
4386
|
readonly confirmations: 3;
|
|
4226
4387
|
readonly fastConfirmations: 1;
|
|
@@ -4421,6 +4582,8 @@ declare const Chains_Optimism: typeof Optimism;
|
|
|
4421
4582
|
declare const Chains_OptimismSepolia: typeof OptimismSepolia;
|
|
4422
4583
|
declare const Chains_Pharos: typeof Pharos;
|
|
4423
4584
|
declare const Chains_PharosTestnet: typeof PharosTestnet;
|
|
4585
|
+
declare const Chains_Plasma: typeof Plasma;
|
|
4586
|
+
declare const Chains_PlasmaTestnet: typeof PlasmaTestnet;
|
|
4424
4587
|
declare const Chains_Plume: typeof Plume;
|
|
4425
4588
|
declare const Chains_PlumeTestnet: typeof PlumeTestnet;
|
|
4426
4589
|
declare const Chains_PolkadotAssetHub: typeof PolkadotAssetHub;
|
|
@@ -4492,6 +4655,8 @@ declare namespace Chains {
|
|
|
4492
4655
|
Chains_OptimismSepolia as OptimismSepolia,
|
|
4493
4656
|
Chains_Pharos as Pharos,
|
|
4494
4657
|
Chains_PharosTestnet as PharosTestnet,
|
|
4658
|
+
Chains_Plasma as Plasma,
|
|
4659
|
+
Chains_PlasmaTestnet as PlasmaTestnet,
|
|
4495
4660
|
Chains_Plume as Plume,
|
|
4496
4661
|
Chains_PlumeTestnet as PlumeTestnet,
|
|
4497
4662
|
Chains_PolkadotAssetHub as PolkadotAssetHub,
|
|
@@ -6044,7 +6209,7 @@ interface ExecuteParams {
|
|
|
6044
6209
|
* fromAddress: '0x...',
|
|
6045
6210
|
* toAddress: '0x...',
|
|
6046
6211
|
* amount: '1000000',
|
|
6047
|
-
* apiKey: '
|
|
6212
|
+
* apiKey: 'TEST_API_KEY:...',
|
|
6048
6213
|
* })
|
|
6049
6214
|
*
|
|
6050
6215
|
* // Build token inputs with permit
|
|
@@ -6188,7 +6353,7 @@ interface ExecuteSwapEVMParams extends ActionParameters {
|
|
|
6188
6353
|
* fromAddress: 'YubQzu18FDqJRyNfG8JqHmsdbxhnoQqcKUHBdUkN6tP',
|
|
6189
6354
|
* toAddress: 'YubQzu18FDqJRyNfG8JqHmsdbxhnoQqcKUHBdUkN6tP',
|
|
6190
6355
|
* amount: '1000000',
|
|
6191
|
-
* apiKey: '
|
|
6356
|
+
* apiKey: 'TEST_API_KEY:...',
|
|
6192
6357
|
* })
|
|
6193
6358
|
*
|
|
6194
6359
|
* // Prepare action parameters
|
|
@@ -10102,6 +10267,63 @@ interface InvocationMeta {
|
|
|
10102
10267
|
*/
|
|
10103
10268
|
readonly signal?: AbortSignal | undefined;
|
|
10104
10269
|
}
|
|
10270
|
+
/**
|
|
10271
|
+
* Resolved invocation context with guaranteed values.
|
|
10272
|
+
*
|
|
10273
|
+
* @remarks
|
|
10274
|
+
* Defines **WHO** called and **HOW** to observe. Contains the complete runtime
|
|
10275
|
+
* and guaranteed trace ID.
|
|
10276
|
+
*
|
|
10277
|
+
* Created by `resolveInvocationContext()` from `InvocationMeta`.
|
|
10278
|
+
*
|
|
10279
|
+
* @example
|
|
10280
|
+
* ```typescript
|
|
10281
|
+
* import type { InvocationContext } from '@core/runtime'
|
|
10282
|
+
*
|
|
10283
|
+
* const ctx: InvocationContext = {
|
|
10284
|
+
* traceId: 'abc-123',
|
|
10285
|
+
* runtime: completeRuntime,
|
|
10286
|
+
* callers: [{ type: 'app', name: 'MyDApp' }],
|
|
10287
|
+
* }
|
|
10288
|
+
* ```
|
|
10289
|
+
*/
|
|
10290
|
+
interface InvocationContext {
|
|
10291
|
+
/**
|
|
10292
|
+
* Trace ID for distributed tracing correlation.
|
|
10293
|
+
*
|
|
10294
|
+
* @remarks
|
|
10295
|
+
* Guaranteed to be present (generated if not provided in input).
|
|
10296
|
+
*/
|
|
10297
|
+
readonly traceId: string;
|
|
10298
|
+
/**
|
|
10299
|
+
* Complete runtime with all services.
|
|
10300
|
+
*
|
|
10301
|
+
* @remarks
|
|
10302
|
+
* All services (clock, logger, events, metrics) are guaranteed present.
|
|
10303
|
+
*/
|
|
10304
|
+
readonly runtime: Runtime;
|
|
10305
|
+
/**
|
|
10306
|
+
* Token registry for resolving token information.
|
|
10307
|
+
*
|
|
10308
|
+
* @remarks
|
|
10309
|
+
* Guaranteed to be present. Uses provided registry or falls back to default.
|
|
10310
|
+
*/
|
|
10311
|
+
readonly tokens: TokenRegistry;
|
|
10312
|
+
/**
|
|
10313
|
+
* Call chain (empty array if not provided).
|
|
10314
|
+
*/
|
|
10315
|
+
readonly callers: readonly Caller[];
|
|
10316
|
+
/**
|
|
10317
|
+
* Cooperative cancellation signal for the invocation.
|
|
10318
|
+
*
|
|
10319
|
+
* @remarks
|
|
10320
|
+
* Mirrors {@link InvocationMeta.signal}. Present only when the caller
|
|
10321
|
+
* supplied one — the runtime never fabricates a signal. Operations may
|
|
10322
|
+
* forward it to cancellable work; aborting remains the caller's
|
|
10323
|
+
* responsibility.
|
|
10324
|
+
*/
|
|
10325
|
+
readonly signal?: AbortSignal | undefined;
|
|
10326
|
+
}
|
|
10105
10327
|
|
|
10106
10328
|
/**
|
|
10107
10329
|
* Transfer speed options for cross-chain operations.
|
|
@@ -10211,6 +10433,48 @@ TChainDefinition extends ChainDefinition = ChainDefinition> extends WalletContex
|
|
|
10211
10433
|
* Must be a valid address format for the specified blockchain.
|
|
10212
10434
|
*/
|
|
10213
10435
|
recipientAddress?: string;
|
|
10436
|
+
/**
|
|
10437
|
+
* Optional destination dApp deposit action for a fast cross-chain transfer.
|
|
10438
|
+
*
|
|
10439
|
+
* When set, the burned USDC is minted to Circle's GenericExecutor on the
|
|
10440
|
+
* destination chain, which calls the registered dApp (for example, a Gateway
|
|
10441
|
+
* `depositFor`) in the same relayed flow. Consumed by the CCTP v2 provider's
|
|
10442
|
+
* executor-deposit path; requires `useForwarder: true`.
|
|
10443
|
+
*
|
|
10444
|
+
* @see {@link BridgeDepositAction}
|
|
10445
|
+
*/
|
|
10446
|
+
deposit?: BridgeDepositAction;
|
|
10447
|
+
}
|
|
10448
|
+
/**
|
|
10449
|
+
* Destination dApp deposit action for a fast cross-chain transfer.
|
|
10450
|
+
*
|
|
10451
|
+
* When present on a bridge destination, the CCTP v2 provider routes the
|
|
10452
|
+
* transfer through Circle's GenericExecutor: the burned USDC is minted to the
|
|
10453
|
+
* executor on the destination chain, which then calls the registered dApp (for
|
|
10454
|
+
* example, a Gateway `depositFor`) in the same relayed flow. Encoded into
|
|
10455
|
+
* executor hookData via `buildDepositForGenericExecutorPayload`.
|
|
10456
|
+
*
|
|
10457
|
+
* @example
|
|
10458
|
+
* ```typescript
|
|
10459
|
+
* import type { BridgeDepositAction } from '@core/provider'
|
|
10460
|
+
*
|
|
10461
|
+
* const deposit: BridgeDepositAction = {
|
|
10462
|
+
* dappId: 'gateway_deposit',
|
|
10463
|
+
* params: ['0xTokenMessengerWithFees', '0xDepositAccount', 0n],
|
|
10464
|
+
* }
|
|
10465
|
+
* ```
|
|
10466
|
+
*/
|
|
10467
|
+
interface BridgeDepositAction {
|
|
10468
|
+
/**
|
|
10469
|
+
* Registered dApp identifier the GenericExecutor invokes on the destination
|
|
10470
|
+
* chain (for example, `'gateway_deposit'`).
|
|
10471
|
+
*/
|
|
10472
|
+
dappId: string;
|
|
10473
|
+
/**
|
|
10474
|
+
* Positional arguments for the dApp function, in ABI order. Dynamic amount
|
|
10475
|
+
* slots are filled in by the executor from the minted amount.
|
|
10476
|
+
*/
|
|
10477
|
+
params: readonly unknown[];
|
|
10214
10478
|
}
|
|
10215
10479
|
/**
|
|
10216
10480
|
* Parameters for executing a cross-chain bridge operation.
|
|
@@ -11761,6 +12025,236 @@ declare abstract class BridgingProvider<TProviderActions = Record<string, unknow
|
|
|
11761
12025
|
analyzeStepsForRetry(steps: BridgeStep[]): StepAnalysisResult;
|
|
11762
12026
|
}
|
|
11763
12027
|
|
|
12028
|
+
/**
|
|
12029
|
+
* USD exchange-rate metadata.
|
|
12030
|
+
*
|
|
12031
|
+
* Non-binding, useful for USD-denominated fee estimates. `feeTokenUsd` prices
|
|
12032
|
+
* the source-chain fee token (the token `feeTotalAmount` is denominated in).
|
|
12033
|
+
*
|
|
12034
|
+
* @internal
|
|
12035
|
+
*/
|
|
12036
|
+
interface FeeQuoteExchangeRates {
|
|
12037
|
+
/** USD price of the fee token, as a decimal string. */
|
|
12038
|
+
readonly feeTokenUsd: string;
|
|
12039
|
+
/** USD price of the destination token, as a decimal string. */
|
|
12040
|
+
readonly destinationTokenUsd: string;
|
|
12041
|
+
}
|
|
12042
|
+
/**
|
|
12043
|
+
* The expiry window of a signed quote.
|
|
12044
|
+
*
|
|
12045
|
+
* A signed quote is short-lived; refresh it immediately before submitting
|
|
12046
|
+
* on-chain rather than caching it.
|
|
12047
|
+
*
|
|
12048
|
+
* The API uses different field names depending on `mode`:
|
|
12049
|
+
* - `TIMESTAMP` → `expiresAt` (unix seconds)
|
|
12050
|
+
* - `BLOCK_NUMBER` → `expiresAtBlock` (source-chain block number)
|
|
12051
|
+
*
|
|
12052
|
+
* @internal
|
|
12053
|
+
*/
|
|
12054
|
+
type FeeQuoteExpiry = {
|
|
12055
|
+
/** Identify an exact Unix timestamp expiry. */
|
|
12056
|
+
readonly mode: 'TIMESTAMP';
|
|
12057
|
+
/** Unix timestamp in seconds at which the quote expires. */
|
|
12058
|
+
readonly expiresAt: number;
|
|
12059
|
+
} | {
|
|
12060
|
+
/** Identify a source-chain block-number expiry. */
|
|
12061
|
+
readonly mode: 'BLOCK_NUMBER';
|
|
12062
|
+
/** Authoritative source-chain block at which the quote expires. */
|
|
12063
|
+
readonly expiresAtBlock: number;
|
|
12064
|
+
/** Optional advisory Unix timestamp estimate for the expiry block. */
|
|
12065
|
+
readonly blockEstimatedAt?: number;
|
|
12066
|
+
};
|
|
12067
|
+
|
|
12068
|
+
/**
|
|
12069
|
+
* Fee category describing the origin of a fee line item.
|
|
12070
|
+
*
|
|
12071
|
+
* - `'provider'` — Fee charged by the cross-chain provider (e.g. protocol fee).
|
|
12072
|
+
* - `'gasFee'` — On-chain gas cost denominated in the transfer token (e.g. USDC).
|
|
12073
|
+
* - `'kit'` — Fee charged by the kit / developer integration.
|
|
12074
|
+
* - `'forwarder'` — Fee charged by Circle's Forwarding Service for automatic mint.
|
|
12075
|
+
*/
|
|
12076
|
+
type FeeType = 'provider' | 'gasFee' | 'kit' | 'forwarder';
|
|
12077
|
+
/**
|
|
12078
|
+
* Per-chain breakdown of a fee amount.
|
|
12079
|
+
*
|
|
12080
|
+
* @example
|
|
12081
|
+
* ```typescript
|
|
12082
|
+
* import type { FeeAllocation } from '@core/types'
|
|
12083
|
+
* import { Blockchain } from '@core/chains'
|
|
12084
|
+
*
|
|
12085
|
+
* const allocation: FeeAllocation = {
|
|
12086
|
+
* chain: Blockchain.Ethereum,
|
|
12087
|
+
* amount: '0.00005',
|
|
12088
|
+
* }
|
|
12089
|
+
* ```
|
|
12090
|
+
*/
|
|
12091
|
+
interface FeeAllocation {
|
|
12092
|
+
/** The chain to which this portion of the fee applies. */
|
|
12093
|
+
chain: Blockchain;
|
|
12094
|
+
/** The fee amount on this chain (human-readable decimal string). */
|
|
12095
|
+
amount: string;
|
|
12096
|
+
}
|
|
12097
|
+
/**
|
|
12098
|
+
* A single fee line item within an estimate.
|
|
12099
|
+
*
|
|
12100
|
+
* @remarks
|
|
12101
|
+
* Each entry describes a fee category (`type`), the token it is
|
|
12102
|
+
* denominated in, the aggregate `amount`, and an optional per-chain
|
|
12103
|
+
* `allocations` breakdown.
|
|
12104
|
+
*
|
|
12105
|
+
* @example
|
|
12106
|
+
* ```typescript
|
|
12107
|
+
* import type { FeeEntry } from '@core/types'
|
|
12108
|
+
* import { Blockchain } from '@core/chains'
|
|
12109
|
+
*
|
|
12110
|
+
* // Fee with per-chain allocation breakdown
|
|
12111
|
+
* const providerFee: FeeEntry = {
|
|
12112
|
+
* type: 'provider',
|
|
12113
|
+
* token: 'USDC',
|
|
12114
|
+
* amount: '0.00011',
|
|
12115
|
+
* allocations: [
|
|
12116
|
+
* { chain: Blockchain.Ethereum, amount: '0.00005' },
|
|
12117
|
+
* { chain: Blockchain.Polygon, amount: '0.00006' },
|
|
12118
|
+
* ],
|
|
12119
|
+
* }
|
|
12120
|
+
*
|
|
12121
|
+
* // Flat fee without allocations (e.g. forwarder)
|
|
12122
|
+
* const forwarderFee: FeeEntry = {
|
|
12123
|
+
* type: 'forwarder',
|
|
12124
|
+
* token: 'USDC',
|
|
12125
|
+
* amount: '0.005',
|
|
12126
|
+
* }
|
|
12127
|
+
* ```
|
|
12128
|
+
*/
|
|
12129
|
+
interface FeeEntry {
|
|
12130
|
+
/** The category of this fee. */
|
|
12131
|
+
type: FeeType;
|
|
12132
|
+
/** The token in which this fee is denominated (e.g. `'USDC'`, `'ETH'`). */
|
|
12133
|
+
token: string;
|
|
12134
|
+
/** Aggregate fee amount (human-readable decimal string). */
|
|
12135
|
+
amount: string;
|
|
12136
|
+
/** Per-chain breakdown of the fee. Omitted for flat fees (e.g. forwarder). */
|
|
12137
|
+
allocations?: FeeAllocation[];
|
|
12138
|
+
/**
|
|
12139
|
+
* When `type === 'kit'`, the address that receives the kit fee.
|
|
12140
|
+
* Omitted for other fee types.
|
|
12141
|
+
*/
|
|
12142
|
+
recipientAddress?: string;
|
|
12143
|
+
}
|
|
12144
|
+
|
|
12145
|
+
/**
|
|
12146
|
+
* Configure how CCTP and forwarding fees are collected for a bridge.
|
|
12147
|
+
*
|
|
12148
|
+
* @remarks
|
|
12149
|
+
* Use `'source'` with `to.useForwarder: true` to treat `amount` as the exact
|
|
12150
|
+
* destination amount. Bridge Kit obtains a signed fee quote, collects the fee
|
|
12151
|
+
* in source-chain USDC, and leaves the destination mint unreduced. Omit the
|
|
12152
|
+
* option (or use `'destination'`) to preserve the existing max-fee behavior.
|
|
12153
|
+
*
|
|
12154
|
+
* @example
|
|
12155
|
+
* ```typescript
|
|
12156
|
+
* import type { BridgeExecutionConfig } from '@circle-fin/bridge-kit'
|
|
12157
|
+
*
|
|
12158
|
+
* const config: BridgeExecutionConfig = {
|
|
12159
|
+
* transferSpeed: 'FAST',
|
|
12160
|
+
* feePayment: 'source',
|
|
12161
|
+
* }
|
|
12162
|
+
* ```
|
|
12163
|
+
* @since 1.14.0
|
|
12164
|
+
*/
|
|
12165
|
+
interface BridgeExecutionConfig extends BridgeConfig {
|
|
12166
|
+
/** Select source-side signed fees or the legacy destination-side fee path. */
|
|
12167
|
+
feePayment?: 'source' | 'destination';
|
|
12168
|
+
}
|
|
12169
|
+
/**
|
|
12170
|
+
* Describe one signed Fee Service line item in human-readable USDC.
|
|
12171
|
+
*
|
|
12172
|
+
* @example
|
|
12173
|
+
* ```typescript
|
|
12174
|
+
* import type { ReceiveExactFeeItem } from '@circle-fin/bridge-kit'
|
|
12175
|
+
*
|
|
12176
|
+
* const item: ReceiveExactFeeItem = {
|
|
12177
|
+
* type: 'FORWARD',
|
|
12178
|
+
* amount: '0.25',
|
|
12179
|
+
* args: [],
|
|
12180
|
+
* argsHash: `0x${'00'.repeat(32)}`,
|
|
12181
|
+
* }
|
|
12182
|
+
* ```
|
|
12183
|
+
* @since 1.14.0
|
|
12184
|
+
*/
|
|
12185
|
+
interface ReceiveExactFeeItem {
|
|
12186
|
+
/** The Fee Service item type, such as `FORWARD` or `PRE_FINALITY`. */
|
|
12187
|
+
readonly type: string;
|
|
12188
|
+
/** The fee amount in human-readable USDC. */
|
|
12189
|
+
readonly amount: string;
|
|
12190
|
+
/** The ABI arguments covered by the signed quote. */
|
|
12191
|
+
readonly args: readonly string[];
|
|
12192
|
+
/** The hash of the ABI arguments covered by the signed quote. */
|
|
12193
|
+
readonly argsHash: string;
|
|
12194
|
+
}
|
|
12195
|
+
/**
|
|
12196
|
+
* Return a receive-exact bridge estimate backed by a short-lived signed quote.
|
|
12197
|
+
*
|
|
12198
|
+
* @remarks
|
|
12199
|
+
* Treat `quote` as opaque and sensitive. Pass it back to
|
|
12200
|
+
* {@link BridgeKit.bridge}; do not log or decode it. Bridge Kit validates a
|
|
12201
|
+
* supplied quote against the exact transfer parameters and rejects it when it
|
|
12202
|
+
* is invalid, mismatched, expired, or too close to expiry.
|
|
12203
|
+
*
|
|
12204
|
+
* @example
|
|
12205
|
+
* ```typescript
|
|
12206
|
+
* import { BridgeKit, type BridgeParams } from '@circle-fin/bridge-kit'
|
|
12207
|
+
*
|
|
12208
|
+
* declare const adapter: BridgeParams['from']['adapter']
|
|
12209
|
+
* const kit = new BridgeKit()
|
|
12210
|
+
*
|
|
12211
|
+
* const estimate = await kit.estimate({
|
|
12212
|
+
* from: { adapter, chain: 'Ethereum' },
|
|
12213
|
+
* to: {
|
|
12214
|
+
* chain: 'Base',
|
|
12215
|
+
* recipientAddress: '0x1234567890123456789012345678901234567890',
|
|
12216
|
+
* useForwarder: true,
|
|
12217
|
+
* },
|
|
12218
|
+
* amount: '100',
|
|
12219
|
+
* config: { feePayment: 'source' },
|
|
12220
|
+
* })
|
|
12221
|
+
* console.log(estimate.amountReceived, estimate.totalDebit)
|
|
12222
|
+
* ```
|
|
12223
|
+
* @since 1.14.0
|
|
12224
|
+
*/
|
|
12225
|
+
interface ReceiveExactEstimateResult extends EstimateResult$1 {
|
|
12226
|
+
/** The exact amount the destination recipient receives, in USDC. */
|
|
12227
|
+
readonly amountReceived: string;
|
|
12228
|
+
/** The total signed fee collected on the source chain, in USDC. */
|
|
12229
|
+
readonly feeTotal: string;
|
|
12230
|
+
/** The itemized signed fee quote, with amounts in human-readable USDC. */
|
|
12231
|
+
readonly feeItems: readonly ReceiveExactFeeItem[];
|
|
12232
|
+
/** The total source-wallet debit (`amountReceived + feeTotal`), in USDC. */
|
|
12233
|
+
readonly totalDebit: string;
|
|
12234
|
+
/** The authoritative expiry returned by the Fee Service. */
|
|
12235
|
+
readonly quoteExpiry: FeeQuoteExpiry;
|
|
12236
|
+
/** Opaque signed quote bytes to pass to {@link BridgeKit.bridge}. */
|
|
12237
|
+
readonly quote: string;
|
|
12238
|
+
}
|
|
12239
|
+
/**
|
|
12240
|
+
* Result returned by {@link BridgeKit.estimate} for legacy and source-fee modes.
|
|
12241
|
+
*
|
|
12242
|
+
* @example
|
|
12243
|
+
* ```typescript
|
|
12244
|
+
* import {
|
|
12245
|
+
* BridgeKit,
|
|
12246
|
+
* type BridgeEstimateResult,
|
|
12247
|
+
* type BridgeParams,
|
|
12248
|
+
* } from '@circle-fin/bridge-kit'
|
|
12249
|
+
*
|
|
12250
|
+
* declare const params: BridgeParams
|
|
12251
|
+
* const kit = new BridgeKit()
|
|
12252
|
+
* const result: BridgeEstimateResult = await kit.estimate(params)
|
|
12253
|
+
* if ('amountReceived' in result) console.log(result.totalDebit)
|
|
12254
|
+
* ```
|
|
12255
|
+
* @since 1.14.0
|
|
12256
|
+
*/
|
|
12257
|
+
type BridgeEstimateResult = EstimateResult$1 | ReceiveExactEstimateResult;
|
|
11764
12258
|
type FeeFunction<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities> = (params: BridgeParams$1<TFromAdapterCapabilities, TToAdapterCapabilities>) => Promise<string> | string;
|
|
11765
12259
|
type FeeRecipientFunction<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities> = (feePayoutChain: ChainDefinition, params: BridgeParams$1<TFromAdapterCapabilities, TToAdapterCapabilities>) => Promise<string> | string;
|
|
11766
12260
|
/**
|
|
@@ -11921,7 +12415,7 @@ interface BridgeParams<TFromAdapterCapabilities extends AdapterCapabilities = Ad
|
|
|
11921
12415
|
* Optional bridge configuration (e.g., transfer speed).
|
|
11922
12416
|
* If omitted, defaults will be used
|
|
11923
12417
|
*/
|
|
11924
|
-
config?:
|
|
12418
|
+
config?: BridgeExecutionConfig;
|
|
11925
12419
|
/**
|
|
11926
12420
|
* The token to transfer. Defaults to 'USDC'.
|
|
11927
12421
|
* If omitted, the provider will use 'USDC' by default.
|
|
@@ -11948,6 +12442,16 @@ interface BridgeParams<TFromAdapterCapabilities extends AdapterCapabilities = Ad
|
|
|
11948
12442
|
* ```
|
|
11949
12443
|
*/
|
|
11950
12444
|
invocationMeta?: InvocationMeta;
|
|
12445
|
+
/**
|
|
12446
|
+
* Reuse the opaque signed quote returned by a receive-exact estimate.
|
|
12447
|
+
*
|
|
12448
|
+
* @remarks
|
|
12449
|
+
* Bridge Kit validates a supplied quote against the exact transfer and fails
|
|
12450
|
+
* when it is invalid, mismatched, expired, or too close to expiry. Omit this
|
|
12451
|
+
* value to let Bridge Kit fetch a fresh quote automatically. Never log or
|
|
12452
|
+
* decode it.
|
|
12453
|
+
*/
|
|
12454
|
+
quote?: string;
|
|
11951
12455
|
}
|
|
11952
12456
|
/**
|
|
11953
12457
|
* Union of all chain definition types.
|
|
@@ -12010,6 +12514,9 @@ type CCTPV2SupportedChainType = FilterCCTPV2<AllChainDefinitions>['type'];
|
|
|
12010
12514
|
*
|
|
12011
12515
|
* // Get only chains that support forwarding
|
|
12012
12516
|
* const forwarderChains = kit.getSupportedChains({ forwarderSupported: true })
|
|
12517
|
+
*
|
|
12518
|
+
* // Get only chains that can pay fees on the source chain (receive-exact)
|
|
12519
|
+
* const sourceFeeChains = kit.getSupportedChains({ sourceFeeSupported: true })
|
|
12013
12520
|
* ```
|
|
12014
12521
|
*/
|
|
12015
12522
|
type GetSupportedChainsOptions$1 = {
|
|
@@ -12051,14 +12558,30 @@ type GetSupportedChainsOptions$1 = {
|
|
|
12051
12558
|
* - `undefined`: all chains (default)
|
|
12052
12559
|
*/
|
|
12053
12560
|
forwarderSupported?: boolean;
|
|
12561
|
+
/**
|
|
12562
|
+
* Filter chains by source-paid ("receive-exact") fee support.
|
|
12563
|
+
* A chain qualifies when it configures a `TokenMessengerWithFees` wrapper,
|
|
12564
|
+
* making it usable as a source for `config.feePayment: 'source'` transfers.
|
|
12565
|
+
* - `true`: only chains that support source-paid fees
|
|
12566
|
+
* - `false`: only chains that do not support source-paid fees
|
|
12567
|
+
* - `undefined`: all chains (default)
|
|
12568
|
+
*/
|
|
12569
|
+
sourceFeeSupported?: boolean;
|
|
12054
12570
|
} | {
|
|
12055
12571
|
chainType?: CCTPV2SupportedChainType | CCTPV2SupportedChainType[];
|
|
12056
12572
|
isTestnet: boolean;
|
|
12057
12573
|
forwarderSupported?: boolean;
|
|
12574
|
+
sourceFeeSupported?: boolean;
|
|
12058
12575
|
} | {
|
|
12059
12576
|
chainType?: CCTPV2SupportedChainType | CCTPV2SupportedChainType[];
|
|
12060
12577
|
isTestnet?: boolean;
|
|
12061
12578
|
forwarderSupported: boolean;
|
|
12579
|
+
sourceFeeSupported?: boolean;
|
|
12580
|
+
} | {
|
|
12581
|
+
chainType?: CCTPV2SupportedChainType | CCTPV2SupportedChainType[];
|
|
12582
|
+
isTestnet?: boolean;
|
|
12583
|
+
forwarderSupported?: boolean;
|
|
12584
|
+
sourceFeeSupported: boolean;
|
|
12062
12585
|
};
|
|
12063
12586
|
|
|
12064
12587
|
/**
|
|
@@ -12430,6 +12953,20 @@ interface CCTPV2Actions {
|
|
|
12430
12953
|
values: BridgeFetchAttestationStep;
|
|
12431
12954
|
};
|
|
12432
12955
|
}
|
|
12956
|
+
/**
|
|
12957
|
+
* Valid step names for CCTP v2 bridge operations.
|
|
12958
|
+
*
|
|
12959
|
+
* @remarks
|
|
12960
|
+
* Extracted from {@link CCTPV2Actions} to provide type-safe step name validation.
|
|
12961
|
+
* This ensures consistency across event dispatching, step analysis, and orchestration.
|
|
12962
|
+
*
|
|
12963
|
+
* @example
|
|
12964
|
+
* ```typescript
|
|
12965
|
+
* const stepName: CCTPV2StepName = 'approve' // Valid
|
|
12966
|
+
* const invalidStep: CCTPV2StepName = 'transfer' // TypeScript error
|
|
12967
|
+
* ```
|
|
12968
|
+
*/
|
|
12969
|
+
type CCTPV2StepName = keyof CCTPV2Actions;
|
|
12433
12970
|
/**
|
|
12434
12971
|
* CCTPv2 bridging provider interface.
|
|
12435
12972
|
*
|
|
@@ -12612,11 +13149,12 @@ interface CCTPV2Config {
|
|
|
12612
13149
|
headers?: Record<string, string>;
|
|
12613
13150
|
}
|
|
12614
13151
|
/**
|
|
12615
|
-
*
|
|
13152
|
+
* Common parameters for a prepaid-FORWARD burn via
|
|
13153
|
+
* {@link CCTPV2BridgingProvider.burnWithFees}.
|
|
12616
13154
|
*
|
|
12617
13155
|
* @typeParam TFromAdapterCapabilities - The source adapter's capabilities.
|
|
12618
13156
|
*/
|
|
12619
|
-
interface
|
|
13157
|
+
interface BurnWithFeesBaseParams<TFromAdapterCapabilities extends AdapterCapabilities = AdapterCapabilities> {
|
|
12620
13158
|
/**
|
|
12621
13159
|
* Source wallet context (adapter + CCTP v2 source chain).
|
|
12622
13160
|
*/
|
|
@@ -12629,14 +13167,6 @@ interface BurnWithFeesParams<TFromAdapterCapabilities extends AdapterCapabilitie
|
|
|
12629
13167
|
* Amount of USDC to burn, in minor units.
|
|
12630
13168
|
*/
|
|
12631
13169
|
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
13170
|
/**
|
|
12641
13171
|
* The `cctp-forward`-wrapped GenericExecutor hookData blob.
|
|
12642
13172
|
*
|
|
@@ -12663,6 +13193,75 @@ interface BurnWithFeesParams<TFromAdapterCapabilities extends AdapterCapabilitie
|
|
|
12663
13193
|
*/
|
|
12664
13194
|
feeTotalAmount: string | bigint;
|
|
12665
13195
|
}
|
|
13196
|
+
/**
|
|
13197
|
+
* Route a prepaid burn through a destination GenericExecutor.
|
|
13198
|
+
*
|
|
13199
|
+
* @example
|
|
13200
|
+
* ```typescript
|
|
13201
|
+
* const destination = { executor: '0x1234567890123456789012345678901234567890' }
|
|
13202
|
+
* ```
|
|
13203
|
+
*/
|
|
13204
|
+
interface ExecutorBurnDestination {
|
|
13205
|
+
/** Use this address for both the mint recipient and destination caller. */
|
|
13206
|
+
executor: string;
|
|
13207
|
+
/** Exclude a direct mint recipient when an executor is supplied. */
|
|
13208
|
+
mintRecipient?: never;
|
|
13209
|
+
/** Exclude a direct destination caller when an executor is supplied. */
|
|
13210
|
+
destinationCaller?: never;
|
|
13211
|
+
}
|
|
13212
|
+
/**
|
|
13213
|
+
* Route a prepaid forwarding burn directly to its final mint recipient.
|
|
13214
|
+
*
|
|
13215
|
+
* @example
|
|
13216
|
+
* ```typescript
|
|
13217
|
+
* const destination = {
|
|
13218
|
+
* mintRecipient: '0x1234567890123456789012345678901234567890',
|
|
13219
|
+
* destinationCaller: '0x0000000000000000000000000000000000000000',
|
|
13220
|
+
* }
|
|
13221
|
+
* ```
|
|
13222
|
+
*/
|
|
13223
|
+
interface DirectBurnDestination {
|
|
13224
|
+
/** The final destination account that receives the CCTP mint. */
|
|
13225
|
+
mintRecipient: string;
|
|
13226
|
+
/** The caller authorized to submit the mint; use the zero address for forwarding. */
|
|
13227
|
+
destinationCaller: string;
|
|
13228
|
+
/** Exclude the GenericExecutor shorthand for a direct mint. */
|
|
13229
|
+
executor?: never;
|
|
13230
|
+
}
|
|
13231
|
+
/**
|
|
13232
|
+
* Parameters for a source-paid signed-fee CCTP burn.
|
|
13233
|
+
*
|
|
13234
|
+
* @remarks
|
|
13235
|
+
* Supply `executor` for a GenericExecutor flow, or supply both
|
|
13236
|
+
* `mintRecipient` and `destinationCaller` for direct forwarding.
|
|
13237
|
+
*
|
|
13238
|
+
* @typeParam TFromAdapterCapabilities - The source adapter's capabilities.
|
|
13239
|
+
*
|
|
13240
|
+
* @example
|
|
13241
|
+
* ```typescript
|
|
13242
|
+
* import type { BurnWithFeesParams } from '@circle-fin/provider-cctp-v2'
|
|
13243
|
+
*
|
|
13244
|
+
* declare const source: BurnWithFeesParams['source']
|
|
13245
|
+
* declare const destinationChain: BurnWithFeesParams['destinationChain']
|
|
13246
|
+
* declare const recipient: string
|
|
13247
|
+
* declare const hookData: string
|
|
13248
|
+
* declare const claim: BurnWithFeesParams['claim']
|
|
13249
|
+
*
|
|
13250
|
+
* const params: BurnWithFeesParams = {
|
|
13251
|
+
* source,
|
|
13252
|
+
* destinationChain,
|
|
13253
|
+
* amount: 1_000_000n,
|
|
13254
|
+
* mintRecipient: recipient,
|
|
13255
|
+
* destinationCaller: '0x0000000000000000000000000000000000000000',
|
|
13256
|
+
* hookData,
|
|
13257
|
+
* claim,
|
|
13258
|
+
* feeToken: source.chain.usdcAddress,
|
|
13259
|
+
* feeTotalAmount: 10_000n,
|
|
13260
|
+
* }
|
|
13261
|
+
* ```
|
|
13262
|
+
* @since 1.11.0
|
|
13263
|
+
*/
|
|
13264
|
+
type BurnWithFeesParams<TFromAdapterCapabilities extends AdapterCapabilities = AdapterCapabilities> = BurnWithFeesBaseParams<TFromAdapterCapabilities> & (ExecutorBurnDestination | DirectBurnDestination);
|
|
12666
13265
|
/**
|
|
12667
13266
|
* Result of {@link CCTPV2BridgingProvider.burnWithFees}.
|
|
12668
13267
|
*
|
|
@@ -12750,6 +13349,33 @@ declare class CCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> imp
|
|
|
12750
13349
|
* @param config - Optional configuration overrides for the provider
|
|
12751
13350
|
*/
|
|
12752
13351
|
constructor(config?: CCTPV2Config);
|
|
13352
|
+
/**
|
|
13353
|
+
* Emit a bridge step event through the provider's registered action
|
|
13354
|
+
* dispatcher.
|
|
13355
|
+
*
|
|
13356
|
+
* Kit-level orchestration that drives the burn primitives directly instead
|
|
13357
|
+
* of {@link CCTPV2BridgingProvider.bridge} (for example the receive-exact
|
|
13358
|
+
* source-fee flow) uses this to surface the same `approve`/`burn`/`mint`
|
|
13359
|
+
* events as the standard bridge path. It is a no-op when no dispatcher is
|
|
13360
|
+
* registered.
|
|
13361
|
+
*
|
|
13362
|
+
* @param name - The step name (`approve`, `burn`, `mint`, ...).
|
|
13363
|
+
* @param step - The completed bridge step to broadcast.
|
|
13364
|
+
* @param invocation - Optional invocation context carrying a `traceId` for
|
|
13365
|
+
* end-to-end correlation.
|
|
13366
|
+
* @returns Nothing.
|
|
13367
|
+
*
|
|
13368
|
+
* @example
|
|
13369
|
+
* ```typescript
|
|
13370
|
+
* const provider = new CCTPV2BridgingProvider()
|
|
13371
|
+
* provider.emitBridgeStep('burn', {
|
|
13372
|
+
* name: 'burn',
|
|
13373
|
+
* state: 'success',
|
|
13374
|
+
* txHash: '0xabc...',
|
|
13375
|
+
* })
|
|
13376
|
+
* ```
|
|
13377
|
+
*/
|
|
13378
|
+
emitBridgeStep(name: CCTPV2StepName, step: BridgeStep, invocation?: InvocationContext): void;
|
|
12753
13379
|
/**
|
|
12754
13380
|
* Resolves the effective polling configuration for an attestation request.
|
|
12755
13381
|
*
|
|
@@ -12868,6 +13494,74 @@ declare class CCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> imp
|
|
|
12868
13494
|
* ```
|
|
12869
13495
|
*/
|
|
12870
13496
|
estimate<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities>(params: CCTPV2BridgeParams<TFromAdapterCapabilities, TToAdapterCapabilities>): Promise<EstimateResult$1>;
|
|
13497
|
+
/**
|
|
13498
|
+
* Estimate source-chain gas for a prepaid-FORWARD deposit burn via
|
|
13499
|
+
* `TokenMessengerWithFees.depositForBurnWithHookAndFees`.
|
|
13500
|
+
*
|
|
13501
|
+
* Builds a size-correct GenericExecutor hookData placeholder — using the
|
|
13502
|
+
* pre-validated `contracts.executor` and `contracts.depositForHandler` — so
|
|
13503
|
+
* the EVM calldata length matches production. Attempts a live
|
|
13504
|
+
* `eth_estimateGas` via the adapter's `cctp.v2.depositForBurnWithFees`
|
|
13505
|
+
* action and falls back to the static
|
|
13506
|
+
* {@link DEPOSIT_FOR_BURN_WITH_FEES_GAS_ESTIMATE_EVM} constant when the live
|
|
13507
|
+
* RPC call fails.
|
|
13508
|
+
*
|
|
13509
|
+
* Gateway eligibility is the caller's responsibility: validate the
|
|
13510
|
+
* destination chain with `resolveGatewayExecutorContracts` (UBK) before
|
|
13511
|
+
* calling this method.
|
|
13512
|
+
*
|
|
13513
|
+
* @param params - Estimation parameters including adapter, chains, amount,
|
|
13514
|
+
* the signed fee quote returned by the Quote API, and the pre-validated
|
|
13515
|
+
* Gateway executor contracts resolved by the caller.
|
|
13516
|
+
* @returns Promise resolving to the estimated (or fallback) gas cost.
|
|
13517
|
+
* @throws KitError `SERVICE_INTERNAL_ERROR` (FATAL) if `dstChain`'s
|
|
13518
|
+
* `usdcAddress` is `null`.
|
|
13519
|
+
*
|
|
13520
|
+
* @example
|
|
13521
|
+
* ```typescript
|
|
13522
|
+
* const contracts = resolveGatewayExecutorContracts(srcChain, dstChain)
|
|
13523
|
+
* const gasEstimate = await CCTPV2BridgingProvider.estimateDepositBurn({
|
|
13524
|
+
* adapter: evmAdapter,
|
|
13525
|
+
* srcChain: Ethereum,
|
|
13526
|
+
* dstChain: ArcTestnet,
|
|
13527
|
+
* amountMinorUnits: 100_000_000n,
|
|
13528
|
+
* refundAddress: '0xUserWallet',
|
|
13529
|
+
* signedQuote: quote.signedQuote,
|
|
13530
|
+
* feeToken: quote.feeToken,
|
|
13531
|
+
* feeTotalAmount: BigInt(quote.feeTotalAmount),
|
|
13532
|
+
* resolvedContext,
|
|
13533
|
+
* contracts,
|
|
13534
|
+
* })
|
|
13535
|
+
* ```
|
|
13536
|
+
*/
|
|
13537
|
+
static estimateDepositBurn<TAdapterCapabilities extends AdapterCapabilities>(params: {
|
|
13538
|
+
/** Source-chain adapter for gas estimation. */
|
|
13539
|
+
adapter: Adapter<TAdapterCapabilities>;
|
|
13540
|
+
/** CCTP v2-enabled source chain. */
|
|
13541
|
+
srcChain: ChainDefinitionWithCCTPv2;
|
|
13542
|
+
/** CCTP v2-enabled destination chain. */
|
|
13543
|
+
dstChain: ChainDefinitionWithCCTPv2;
|
|
13544
|
+
/** Transfer amount in USDC minor units (6 decimals). */
|
|
13545
|
+
amountMinorUnits: bigint;
|
|
13546
|
+
/** Signer address; used as depositor, GE recovery address, and fee refund address. */
|
|
13547
|
+
refundAddress: string;
|
|
13548
|
+
/** Signed quote bytes from the Fee Quote service. */
|
|
13549
|
+
signedQuote: string;
|
|
13550
|
+
/** Fee token address (zero address for native currency fees). */
|
|
13551
|
+
feeToken: string;
|
|
13552
|
+
/** Total fee amount in fee-token minor units. */
|
|
13553
|
+
feeTotalAmount: bigint;
|
|
13554
|
+
/** Resolved operation context for the source-chain adapter. */
|
|
13555
|
+
resolvedContext: OperationContext<TAdapterCapabilities>;
|
|
13556
|
+
/**
|
|
13557
|
+
* Pre-validated Gateway executor contracts for the destination chain.
|
|
13558
|
+
* Resolved by the caller (e.g. UBK) before invoking this method.
|
|
13559
|
+
*/
|
|
13560
|
+
contracts: {
|
|
13561
|
+
executor: string;
|
|
13562
|
+
depositForHandler: string;
|
|
13563
|
+
};
|
|
13564
|
+
}): Promise<EstimatedGas>;
|
|
12871
13565
|
/**
|
|
12872
13566
|
* Extracts OperationContext from bridge parameters for a given wallet context.
|
|
12873
13567
|
*
|
|
@@ -13194,16 +13888,75 @@ declare class CCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> imp
|
|
|
13194
13888
|
* ```
|
|
13195
13889
|
*/
|
|
13196
13890
|
burn<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities>(params: BridgeParams$1<TFromAdapterCapabilities, TToAdapterCapabilities>): Promise<PreparedChainRequest>;
|
|
13891
|
+
/**
|
|
13892
|
+
* Prepare the source-chain `depositForBurnWithHookAndFees` call for the
|
|
13893
|
+
* GenericExecutor FORWARD path.
|
|
13894
|
+
*
|
|
13895
|
+
* Exposed as a public static method so the UBK fast-deposit flow can invoke
|
|
13896
|
+
* it directly without holding a provider instance. The byte layout mirrors
|
|
13897
|
+
* {@link CCTPV2BridgingProvider.estimateDepositBurn} so gas estimates and the
|
|
13898
|
+
* executed call agree.
|
|
13899
|
+
*
|
|
13900
|
+
* @typeParam TFromAdapterCapabilities - The source adapter's capabilities.
|
|
13901
|
+
* @param params - Burn parameters including adapter, chains, deposit action,
|
|
13902
|
+
* amount, signer address, signed fee quote, and pre-resolved adapter context.
|
|
13903
|
+
* @returns The prepared `depositForBurnWithHookAndFees` burn transaction.
|
|
13904
|
+
* @throws {KitError} `UNSUPPORTED_ROUTE` when `dstChain` lacks a
|
|
13905
|
+
* GenericExecutor or DepositForHandler, or the `deposit.dappId` is unknown.
|
|
13906
|
+
*
|
|
13907
|
+
* @example
|
|
13908
|
+
* ```typescript
|
|
13909
|
+
* import { CCTPV2BridgingProvider } from '@circle-fin/provider-cctp-v2'
|
|
13910
|
+
* import { Ethereum, ArcTestnet } from '@core/chains'
|
|
13911
|
+
*
|
|
13912
|
+
* const prepared = await CCTPV2BridgingProvider.prepareDepositForBurn({
|
|
13913
|
+
* adapter,
|
|
13914
|
+
* srcChain: Ethereum,
|
|
13915
|
+
* dstChain: ArcTestnet,
|
|
13916
|
+
* deposit: { dappId: 'gateway_deposit', params: [usdcAddress, recipient, 0n] },
|
|
13917
|
+
* amountMinorUnits: 100_000_000n,
|
|
13918
|
+
* refundAddress: '0xSender...',
|
|
13919
|
+
* signedQuote: quote.signedQuote,
|
|
13920
|
+
* feeToken: quote.feeToken,
|
|
13921
|
+
* feeTotalAmount: BigInt(quote.feeTotalAmount),
|
|
13922
|
+
* resolvedContext,
|
|
13923
|
+
* })
|
|
13924
|
+
* const txHash = await prepared.execute()
|
|
13925
|
+
* ```
|
|
13926
|
+
*/
|
|
13927
|
+
static prepareDepositForBurn<TFromAdapterCapabilities extends AdapterCapabilities>(params: {
|
|
13928
|
+
/** Source-chain adapter for signing and submitting the burn. */
|
|
13929
|
+
adapter: Adapter<TFromAdapterCapabilities>;
|
|
13930
|
+
/** CCTP v2-enabled source chain. */
|
|
13931
|
+
srcChain: ChainDefinitionWithCCTPv2;
|
|
13932
|
+
/** CCTP v2-enabled destination chain (must have a GenericExecutor configured). */
|
|
13933
|
+
dstChain: ChainDefinitionWithCCTPv2;
|
|
13934
|
+
/** Destination dApp deposit action (`dappId` + encoded `params`). */
|
|
13935
|
+
deposit: BridgeDepositAction;
|
|
13936
|
+
/** Transfer amount in USDC minor units (6 decimals). */
|
|
13937
|
+
amountMinorUnits: bigint;
|
|
13938
|
+
/** Signer address; used as GenericExecutor recovery address and fee refund address. */
|
|
13939
|
+
refundAddress: string;
|
|
13940
|
+
/** Signed quote bytes from the Fee Quote service. */
|
|
13941
|
+
signedQuote: string;
|
|
13942
|
+
/** Fee token address (zero address for native-currency fees). */
|
|
13943
|
+
feeToken: string;
|
|
13944
|
+
/** Total fee amount in fee-token minor units. */
|
|
13945
|
+
feeTotalAmount: bigint;
|
|
13946
|
+
/** Resolved operation context for the source-chain adapter. */
|
|
13947
|
+
resolvedContext: OperationContext<TFromAdapterCapabilities>;
|
|
13948
|
+
}): Promise<PreparedChainRequest>;
|
|
13197
13949
|
/**
|
|
13198
13950
|
* Prepare a prepaid-FORWARD burn through the `TokenMessengerWithFees` wrapper.
|
|
13199
13951
|
*
|
|
13200
|
-
*
|
|
13201
|
-
*
|
|
13202
|
-
*
|
|
13203
|
-
*
|
|
13952
|
+
* Build the source-chain `depositForBurnWithHookAndFees` call. Fees are
|
|
13953
|
+
* collected up front on the source chain against a signed quote. The
|
|
13954
|
+
* destination may use the GenericExecutor shorthand, or an explicit mint
|
|
13955
|
+
* recipient and destination caller for direct forwarding.
|
|
13204
13956
|
*
|
|
13205
|
-
* This is the low-level on-chain primitive behind the
|
|
13206
|
-
*
|
|
13957
|
+
* This is the low-level on-chain primitive behind the Unified Balance Kit
|
|
13958
|
+
* `fastCrossChainDeposit` and the Bridge Kit source-fee
|
|
13959
|
+
* (`feePayment: 'source'`) flow. The `hookData` and signed-quote
|
|
13207
13960
|
* `claim` are produced elsewhere and passed in here:
|
|
13208
13961
|
* - `hookData`: `buildForwardingHookDataWithPayload(version,
|
|
13209
13962
|
* buildDepositForGenericExecutorPayload(...).hookData)` from `@core/utils`.
|
|
@@ -13220,25 +13973,38 @@ declare class CCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> imp
|
|
|
13220
13973
|
* approval covers both; the redundant second approval is skipped.
|
|
13221
13974
|
*
|
|
13222
13975
|
* @typeParam TFromAdapterCapabilities - The source adapter's capabilities.
|
|
13223
|
-
* @param params - The burn amount,
|
|
13976
|
+
* @param params - The burn amount, destination, hook data, signed quote, and fee.
|
|
13224
13977
|
* @returns The prepared approvals, the prepared burn, and the resolved fee plan.
|
|
13225
13978
|
* @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.
|
|
13979
|
+
* support CCTP v2, the destination fields are missing, `amount` or
|
|
13980
|
+
* `feeTotalAmount` is not a bigint or a numeric string coercible to bigint,
|
|
13981
|
+
* the hook data lacks a `cctp-forward` frame (guaranteed
|
|
13982
|
+
* `ForwardFeeWithoutHook`), or the operation context cannot be resolved.
|
|
13230
13983
|
*
|
|
13231
13984
|
* @example
|
|
13232
13985
|
* ```typescript
|
|
13986
|
+
* import {
|
|
13987
|
+
* CCTPV2BridgingProvider,
|
|
13988
|
+
* type BurnWithFeesParams,
|
|
13989
|
+
* } from '@circle-fin/provider-cctp-v2'
|
|
13990
|
+
*
|
|
13991
|
+
* declare const source: BurnWithFeesParams['source']
|
|
13992
|
+
* declare const destinationChain: BurnWithFeesParams['destinationChain']
|
|
13993
|
+
* declare const recipient: string
|
|
13994
|
+
* declare const hookData: string
|
|
13995
|
+
* declare const claim: BurnWithFeesParams['claim']
|
|
13996
|
+
*
|
|
13997
|
+
* const provider = new CCTPV2BridgingProvider()
|
|
13233
13998
|
* const { approvals, burn } = await provider.burnWithFees({
|
|
13234
13999
|
* source,
|
|
13235
|
-
* destinationChain
|
|
14000
|
+
* destinationChain,
|
|
13236
14001
|
* amount: 1_000_000n,
|
|
13237
|
-
*
|
|
13238
|
-
*
|
|
13239
|
-
*
|
|
13240
|
-
*
|
|
13241
|
-
*
|
|
14002
|
+
* mintRecipient: recipient,
|
|
14003
|
+
* destinationCaller: '0x0000000000000000000000000000000000000000',
|
|
14004
|
+
* hookData,
|
|
14005
|
+
* claim,
|
|
14006
|
+
* feeToken: source.chain.usdcAddress,
|
|
14007
|
+
* feeTotalAmount: 10_000n,
|
|
13242
14008
|
* })
|
|
13243
14009
|
* for (const approval of approvals) await approval.execute()
|
|
13244
14010
|
* const txHash = await burn.execute()
|
|
@@ -13762,6 +14528,11 @@ declare class BridgeKit<TExtraProviders extends FlexibleBridgingProvider[] = []>
|
|
|
13762
14528
|
* })
|
|
13763
14529
|
* ```
|
|
13764
14530
|
*/
|
|
14531
|
+
estimate<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities>(params: BridgeParams<TFromAdapterCapabilities, TToAdapterCapabilities> & {
|
|
14532
|
+
config: {
|
|
14533
|
+
feePayment: 'source';
|
|
14534
|
+
};
|
|
14535
|
+
}): Promise<ReceiveExactEstimateResult>;
|
|
13765
14536
|
estimate<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities>(params: BridgeParams<TFromAdapterCapabilities, TToAdapterCapabilities>): Promise<EstimateResult$1>;
|
|
13766
14537
|
/**
|
|
13767
14538
|
* Get all chains supported by any provider in the kit, with optional filtering.
|
|
@@ -13801,6 +14572,9 @@ declare class BridgeKit<TExtraProviders extends FlexibleBridgingProvider[] = []>
|
|
|
13801
14572
|
* // Get only chains that support forwarding
|
|
13802
14573
|
* const forwarderChains = kit.getSupportedChains({ forwarderSupported: true })
|
|
13803
14574
|
*
|
|
14575
|
+
* // Get only chains that can pay fees on the source chain (receive-exact)
|
|
14576
|
+
* const sourceFeeChains = kit.getSupportedChains({ sourceFeeSupported: true })
|
|
14577
|
+
*
|
|
13804
14578
|
* console.log('Supported chains:')
|
|
13805
14579
|
* allChains.forEach(chain => {
|
|
13806
14580
|
* console.log(`- ${chain.name} (${chain.type})`)
|
|
@@ -13831,6 +14605,15 @@ declare class BridgeKit<TExtraProviders extends FlexibleBridgingProvider[] = []>
|
|
|
13831
14605
|
* @throws Will throw an error if no provider supports the route
|
|
13832
14606
|
*/
|
|
13833
14607
|
private findProviderForRoute;
|
|
14608
|
+
/**
|
|
14609
|
+
* Find the default CCTP v2 provider for a source-fee forwarding route.
|
|
14610
|
+
*
|
|
14611
|
+
* @param params - The resolved provider parameters.
|
|
14612
|
+
* @returns The CCTP v2 provider that supports the forwarded route.
|
|
14613
|
+
* @throws {UnsupportedRouteError} When no source-fee provider supports the route.
|
|
14614
|
+
* @internal
|
|
14615
|
+
*/
|
|
14616
|
+
private findSourceFeeProvider;
|
|
13834
14617
|
/**
|
|
13835
14618
|
* Merge custom fee configuration into provider parameters.
|
|
13836
14619
|
*
|
|
@@ -14074,12 +14857,21 @@ interface ServiceSwapConfig {
|
|
|
14074
14857
|
recipientAddress?: string;
|
|
14075
14858
|
};
|
|
14076
14859
|
/**
|
|
14077
|
-
*
|
|
14078
|
-
*
|
|
14860
|
+
* Circle API key used to authenticate service-backed swap requests.
|
|
14861
|
+
*
|
|
14862
|
+
* Format: `<ENV>_API_KEY:<keyId>:<keySecret>`. A legacy
|
|
14863
|
+
* `KIT_KEY:<keyId>:<keySecret>` value is also accepted.
|
|
14079
14864
|
*
|
|
14080
14865
|
* Treat this value as a credential. Do not log it, embed it in client-side
|
|
14081
14866
|
* source, or expose it in telemetry.
|
|
14082
14867
|
*/
|
|
14868
|
+
apiKey?: string | undefined;
|
|
14869
|
+
/**
|
|
14870
|
+
* Circle API key used to authenticate service-backed swap requests.
|
|
14871
|
+
*
|
|
14872
|
+
* @deprecated Use {@link ServiceSwapConfig.apiKey} instead. Still honored
|
|
14873
|
+
* when `apiKey` is omitted, and `apiKey` takes precedence when both are set.
|
|
14874
|
+
*/
|
|
14083
14875
|
kitKey?: string;
|
|
14084
14876
|
/**
|
|
14085
14877
|
* DEX aggregator identifier used to source the swap route.
|
|
@@ -15077,12 +15869,21 @@ interface SwapConfig {
|
|
|
15077
15869
|
recipientAddress: string;
|
|
15078
15870
|
};
|
|
15079
15871
|
/**
|
|
15080
|
-
*
|
|
15081
|
-
*
|
|
15872
|
+
* Circle API key used to authenticate service-backed swap requests.
|
|
15873
|
+
*
|
|
15874
|
+
* Format: `<ENV>_API_KEY:<keyId>:<keySecret>`. A legacy
|
|
15875
|
+
* `KIT_KEY:<keyId>:<keySecret>` value is also accepted.
|
|
15082
15876
|
*
|
|
15083
15877
|
* Treat this value as a credential. Do not log it, embed it in client-side
|
|
15084
15878
|
* source, or expose it in telemetry.
|
|
15085
15879
|
*/
|
|
15880
|
+
apiKey?: string | undefined;
|
|
15881
|
+
/**
|
|
15882
|
+
* Circle API key used to authenticate service-backed swap requests.
|
|
15883
|
+
*
|
|
15884
|
+
* @deprecated Use {@link SwapConfig.apiKey} instead. Still honored when
|
|
15885
|
+
* `apiKey` is omitted, and `apiKey` takes precedence when both are set.
|
|
15886
|
+
*/
|
|
15086
15887
|
kitKey?: string;
|
|
15087
15888
|
}
|
|
15088
15889
|
/**
|
|
@@ -15234,7 +16035,13 @@ interface ResolvedSwapConfig extends Omit<SwapConfig, 'customFee'> {
|
|
|
15234
16035
|
recipientAddress?: string;
|
|
15235
16036
|
};
|
|
15236
16037
|
}
|
|
15237
|
-
|
|
16038
|
+
/**
|
|
16039
|
+
* Swap config as echoed back on a result, with credentials removed.
|
|
16040
|
+
*
|
|
16041
|
+
* Both credential fields are omitted so a returned {@link SwapResult} can be
|
|
16042
|
+
* logged or serialized without leaking the secret used to authenticate it.
|
|
16043
|
+
*/
|
|
16044
|
+
type SwapResultConfig = Omit<ResolvedSwapConfig, 'apiKey' | 'kitKey'>;
|
|
15238
16045
|
/**
|
|
15239
16046
|
* Result of an executed swap operation.
|
|
15240
16047
|
*
|
|
@@ -15555,9 +16362,9 @@ interface SwapDestinationLeg {
|
|
|
15555
16362
|
* Parameters for {@link SwapKit.getSwapStatus}.
|
|
15556
16363
|
*
|
|
15557
16364
|
* @remarks
|
|
15558
|
-
* Only `txHash` and `chainIn` are required; `chainOut` and `
|
|
16365
|
+
* Only `txHash` and `chainIn` are required; `chainOut` and `apiKey` are
|
|
15559
16366
|
* optional. Supply `chainOut` when the original swap was cross-chain
|
|
15560
|
-
* (source chain ≠ destination chain); omit `
|
|
16367
|
+
* (source chain ≠ destination chain); omit `apiKey` to call in
|
|
15561
16368
|
* permissionless mode.
|
|
15562
16369
|
*
|
|
15563
16370
|
* The field names mirror {@link SwapResult.chainIn} / {@link
|
|
@@ -15573,7 +16380,7 @@ interface SwapDestinationLeg {
|
|
|
15573
16380
|
* ```typescript
|
|
15574
16381
|
* const result = await kit.swap(params)
|
|
15575
16382
|
*
|
|
15576
|
-
* // Permissionless — no
|
|
16383
|
+
* // Permissionless — no credential needed. Pass `apiKey` to authenticate.
|
|
15577
16384
|
* let status = await kit.getSwapStatus({
|
|
15578
16385
|
* txHash: result.txHash,
|
|
15579
16386
|
* chainIn: result.chainIn,
|
|
@@ -15610,12 +16417,19 @@ interface GetSwapStatusParams {
|
|
|
15610
16417
|
*/
|
|
15611
16418
|
chainOut?: SwapChainIdentifier | Blockchain;
|
|
15612
16419
|
/**
|
|
15613
|
-
*
|
|
15614
|
-
*
|
|
16420
|
+
* Circle API key used as a bearer credential for the status request. Treat
|
|
16421
|
+
* this value as a secret and do not log it.
|
|
15615
16422
|
*
|
|
15616
16423
|
* Optional — when omitted, the request is made without an `Authorization`
|
|
15617
16424
|
* header (permissionless mode).
|
|
15618
16425
|
*/
|
|
16426
|
+
apiKey?: string | undefined;
|
|
16427
|
+
/**
|
|
16428
|
+
* Circle API key used as a bearer credential for the status request.
|
|
16429
|
+
*
|
|
16430
|
+
* @deprecated Use {@link GetSwapStatusParams.apiKey} instead. Still honored
|
|
16431
|
+
* when `apiKey` is omitted, and `apiKey` takes precedence when both are set.
|
|
16432
|
+
*/
|
|
15619
16433
|
kitKey?: string;
|
|
15620
16434
|
}
|
|
15621
16435
|
/**
|
|
@@ -15662,12 +16476,19 @@ interface SwapStatusResult {
|
|
|
15662
16476
|
*/
|
|
15663
16477
|
interface WaitForSwapCommonParams {
|
|
15664
16478
|
/**
|
|
15665
|
-
*
|
|
15666
|
-
*
|
|
16479
|
+
* Circle API key used as a bearer credential. Treat as a secret and do not
|
|
16480
|
+
* log it.
|
|
15667
16481
|
*
|
|
15668
16482
|
* Optional — when omitted, the request is made without an `Authorization`
|
|
15669
16483
|
* header (permissionless mode).
|
|
15670
16484
|
*/
|
|
16485
|
+
readonly apiKey?: string | undefined;
|
|
16486
|
+
/**
|
|
16487
|
+
* Circle API key used as a bearer credential.
|
|
16488
|
+
*
|
|
16489
|
+
* @deprecated Use `apiKey` instead. Still honored when `apiKey` is omitted,
|
|
16490
|
+
* and `apiKey` takes precedence when both are set.
|
|
16491
|
+
*/
|
|
15671
16492
|
readonly kitKey?: string;
|
|
15672
16493
|
/**
|
|
15673
16494
|
* Overall wait budget, in milliseconds. The promise rejects with a
|
|
@@ -15693,7 +16514,7 @@ interface WaitForSwapCommonParams {
|
|
|
15693
16514
|
* @example
|
|
15694
16515
|
* ```typescript
|
|
15695
16516
|
* const result = await kit.swap(params)
|
|
15696
|
-
* const final = await kit.waitForSwap({ result,
|
|
16517
|
+
* const final = await kit.waitForSwap({ result, apiKey })
|
|
15697
16518
|
* ```
|
|
15698
16519
|
*/
|
|
15699
16520
|
interface WaitForSwapResultParams extends WaitForSwapCommonParams {
|
|
@@ -15715,7 +16536,7 @@ interface WaitForSwapResultParams extends WaitForSwapCommonParams {
|
|
|
15715
16536
|
* txHash: '0x…',
|
|
15716
16537
|
* chainIn: 'Ethereum',
|
|
15717
16538
|
* chainOut: 'Base',
|
|
15718
|
-
*
|
|
16539
|
+
* apiKey,
|
|
15719
16540
|
* })
|
|
15720
16541
|
* ```
|
|
15721
16542
|
*/
|
|
@@ -15760,7 +16581,7 @@ interface WaitForSwapDiscreteParams extends WaitForSwapCommonParams {
|
|
|
15760
16581
|
*
|
|
15761
16582
|
* const final = await kit.waitForSwap({
|
|
15762
16583
|
* result,
|
|
15763
|
-
*
|
|
16584
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
15764
16585
|
* onProgress: (snapshot) => console.log(snapshot.progress.status),
|
|
15765
16586
|
* })
|
|
15766
16587
|
*
|
|
@@ -15776,7 +16597,7 @@ interface WaitForSwapDiscreteParams extends WaitForSwapCommonParams {
|
|
|
15776
16597
|
* txHash: persisted.txHash,
|
|
15777
16598
|
* chainIn: persisted.chainIn,
|
|
15778
16599
|
* chainOut: persisted.chainOut,
|
|
15779
|
-
*
|
|
16600
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
15780
16601
|
* })
|
|
15781
16602
|
* ```
|
|
15782
16603
|
*/
|
|
@@ -15795,7 +16616,7 @@ type WaitForSwapParams = WaitForSwapResultParams | WaitForSwapDiscreteParams;
|
|
|
15795
16616
|
* const params: GetTokenRatesParams = {
|
|
15796
16617
|
* chain: 'Ethereum',
|
|
15797
16618
|
* tokens: ['USDC', 'EURC'],
|
|
15798
|
-
*
|
|
16619
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
15799
16620
|
* }
|
|
15800
16621
|
* ```
|
|
15801
16622
|
*/
|
|
@@ -15827,12 +16648,19 @@ interface GetTokenRatesParams {
|
|
|
15827
16648
|
*/
|
|
15828
16649
|
tokens?: readonly TokenSymbol[];
|
|
15829
16650
|
/**
|
|
15830
|
-
*
|
|
15831
|
-
*
|
|
16651
|
+
* Circle API key used as a bearer credential for the rates request. Treat
|
|
16652
|
+
* this value as a secret and do not log it.
|
|
15832
16653
|
*
|
|
15833
16654
|
* Optional — when omitted, the request is made without an `Authorization`
|
|
15834
16655
|
* header (permissionless mode).
|
|
15835
16656
|
*/
|
|
16657
|
+
apiKey?: string | undefined;
|
|
16658
|
+
/**
|
|
16659
|
+
* Circle API key used as a bearer credential for the rates request.
|
|
16660
|
+
*
|
|
16661
|
+
* @deprecated Use {@link GetTokenRatesParams.apiKey} instead. Still honored
|
|
16662
|
+
* when `apiKey` is omitted, and `apiKey` takes precedence when both are set.
|
|
16663
|
+
*/
|
|
15836
16664
|
kitKey?: string;
|
|
15837
16665
|
}
|
|
15838
16666
|
/**
|
|
@@ -15848,7 +16676,7 @@ interface GetTokenRatesParams {
|
|
|
15848
16676
|
* const { rates } = await kit.getTokenRates({
|
|
15849
16677
|
* chain: 'Ethereum',
|
|
15850
16678
|
* tokens: ['USDC'],
|
|
15851
|
-
*
|
|
16679
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
15852
16680
|
* })
|
|
15853
16681
|
*
|
|
15854
16682
|
* const usdc = rates['Ethereum']?.['0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48']
|
|
@@ -16051,16 +16879,24 @@ declare const bridgeQuoteExpirySchema: z.ZodCatch<z.ZodOptional<z.ZodDiscriminat
|
|
|
16051
16879
|
* @example
|
|
16052
16880
|
* ```typescript
|
|
16053
16881
|
* const config: EarnServiceConfig = {
|
|
16054
|
-
*
|
|
16882
|
+
* apiKey: 'TEST_API_KEY:abc123:secret456',
|
|
16055
16883
|
* baseUrl: 'https://api.circle.com',
|
|
16056
16884
|
* }
|
|
16057
16885
|
* ```
|
|
16058
16886
|
*/
|
|
16059
16887
|
interface EarnServiceConfig {
|
|
16060
16888
|
/**
|
|
16061
|
-
* Optional
|
|
16889
|
+
* Optional Circle API key for permissioned access.
|
|
16890
|
+
*
|
|
16891
|
+
* When present, must match `<ENV>_API_KEY:<keyId>:<keySecret>`, or the legacy
|
|
16892
|
+
* `KIT_KEY:<keyId>:<keySecret>`.
|
|
16893
|
+
*/
|
|
16894
|
+
readonly apiKey?: string | undefined;
|
|
16895
|
+
/**
|
|
16896
|
+
* Optional Circle API key for permissioned access.
|
|
16062
16897
|
*
|
|
16063
|
-
*
|
|
16898
|
+
* @deprecated Use {@link EarnServiceConfig.apiKey} instead. Still honored
|
|
16899
|
+
* when `apiKey` is omitted, and `apiKey` takes precedence when both are set.
|
|
16064
16900
|
*/
|
|
16065
16901
|
readonly kitKey?: string | undefined;
|
|
16066
16902
|
/**
|
|
@@ -18213,9 +19049,9 @@ declare function isTerminalCrossChainDepositStatus(status: EarnCrossChainDeposit
|
|
|
18213
19049
|
* // Permissionless mode
|
|
18214
19050
|
* const provider = new EarnServiceProvider()
|
|
18215
19051
|
*
|
|
18216
|
-
* // Permissioned mode with
|
|
19052
|
+
* // Permissioned mode with an API key
|
|
18217
19053
|
* const provider = new EarnServiceProvider({
|
|
18218
|
-
*
|
|
19054
|
+
* apiKey: 'TEST_API_KEY:keyId:keySecret',
|
|
18219
19055
|
* })
|
|
18220
19056
|
*
|
|
18221
19057
|
* // Custom base URL for testing
|
|
@@ -18404,29 +19240,37 @@ type EarnAdapterContext<TAdapterCapabilities extends AdapterCapabilities = Adapt
|
|
|
18404
19240
|
* Configuration options for earn operations.
|
|
18405
19241
|
*
|
|
18406
19242
|
* EarnKit supports dual-mode authentication: operations work both with
|
|
18407
|
-
* and without
|
|
19243
|
+
* and without an API key. When present, the API key enables permissioned
|
|
18408
19244
|
* features like integrator attribution tracking.
|
|
18409
19245
|
*
|
|
18410
19246
|
* @example
|
|
18411
19247
|
* ```typescript
|
|
18412
|
-
* // Permissionless (no
|
|
19248
|
+
* // Permissionless (no API key)
|
|
18413
19249
|
* const config: EarnConfig = {}
|
|
18414
19250
|
*
|
|
18415
|
-
* // Permissioned (with
|
|
19251
|
+
* // Permissioned (with API key)
|
|
18416
19252
|
* const config: EarnConfig = {
|
|
18417
|
-
*
|
|
19253
|
+
* apiKey: 'TEST_API_KEY:keyId:keySecret',
|
|
18418
19254
|
* }
|
|
18419
19255
|
* ```
|
|
18420
19256
|
*/
|
|
18421
19257
|
interface EarnConfig {
|
|
18422
19258
|
/**
|
|
18423
|
-
* Optional
|
|
19259
|
+
* Optional Circle API key for permissioned access.
|
|
18424
19260
|
*
|
|
18425
19261
|
* When provided, enables integrator attribution tracking and
|
|
18426
19262
|
* higher rate limits. When omitted, the SDK operates in
|
|
18427
19263
|
* permissionless mode.
|
|
18428
19264
|
*
|
|
18429
|
-
* Format:
|
|
19265
|
+
* Format: `<ENV>_API_KEY:<keyId>:<keySecret>`. A legacy
|
|
19266
|
+
* `KIT_KEY:<keyId>:<keySecret>` value is also accepted.
|
|
19267
|
+
*/
|
|
19268
|
+
readonly apiKey?: string | undefined;
|
|
19269
|
+
/**
|
|
19270
|
+
* Optional Circle API key for permissioned access.
|
|
19271
|
+
*
|
|
19272
|
+
* @deprecated Use {@link EarnConfig.apiKey} instead. Still honored when
|
|
19273
|
+
* `apiKey` is omitted, and `apiKey` takes precedence when both are set.
|
|
18430
19274
|
*/
|
|
18431
19275
|
readonly kitKey?: string | undefined;
|
|
18432
19276
|
/**
|
|
@@ -20205,26 +21049,31 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20205
21049
|
wallet: z.ZodString;
|
|
20206
21050
|
minter: z.ZodString;
|
|
20207
21051
|
depositForHandler: z.ZodOptional<z.ZodString>;
|
|
21052
|
+
genericExecutor: z.ZodOptional<z.ZodString>;
|
|
20208
21053
|
}, "strict", z.ZodTypeAny, {
|
|
20209
21054
|
wallet: string;
|
|
20210
21055
|
minter: string;
|
|
20211
21056
|
depositForHandler?: string | undefined;
|
|
21057
|
+
genericExecutor?: string | undefined;
|
|
20212
21058
|
}, {
|
|
20213
21059
|
wallet: string;
|
|
20214
21060
|
minter: string;
|
|
20215
21061
|
depositForHandler?: string | undefined;
|
|
21062
|
+
genericExecutor?: string | undefined;
|
|
20216
21063
|
}>>;
|
|
20217
21064
|
}, "strict", z.ZodTypeAny, {
|
|
20218
21065
|
v1?: {
|
|
20219
21066
|
wallet: string;
|
|
20220
21067
|
minter: string;
|
|
20221
21068
|
depositForHandler?: string | undefined;
|
|
21069
|
+
genericExecutor?: string | undefined;
|
|
20222
21070
|
} | undefined;
|
|
20223
21071
|
}, {
|
|
20224
21072
|
v1?: {
|
|
20225
21073
|
wallet: string;
|
|
20226
21074
|
minter: string;
|
|
20227
21075
|
depositForHandler?: string | undefined;
|
|
21076
|
+
genericExecutor?: string | undefined;
|
|
20228
21077
|
} | undefined;
|
|
20229
21078
|
}>;
|
|
20230
21079
|
forwarderSupported: z.ZodObject<{
|
|
@@ -20244,6 +21093,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20244
21093
|
wallet: string;
|
|
20245
21094
|
minter: string;
|
|
20246
21095
|
depositForHandler?: string | undefined;
|
|
21096
|
+
genericExecutor?: string | undefined;
|
|
20247
21097
|
} | undefined;
|
|
20248
21098
|
};
|
|
20249
21099
|
forwarderSupported: {
|
|
@@ -20257,6 +21107,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20257
21107
|
wallet: string;
|
|
20258
21108
|
minter: string;
|
|
20259
21109
|
depositForHandler?: string | undefined;
|
|
21110
|
+
genericExecutor?: string | undefined;
|
|
20260
21111
|
} | undefined;
|
|
20261
21112
|
};
|
|
20262
21113
|
forwarderSupported: {
|
|
@@ -20291,6 +21142,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20291
21142
|
wallet: string;
|
|
20292
21143
|
minter: string;
|
|
20293
21144
|
depositForHandler?: string | undefined;
|
|
21145
|
+
genericExecutor?: string | undefined;
|
|
20294
21146
|
} | undefined;
|
|
20295
21147
|
};
|
|
20296
21148
|
forwarderSupported: {
|
|
@@ -20327,6 +21179,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20327
21179
|
wallet: string;
|
|
20328
21180
|
minter: string;
|
|
20329
21181
|
depositForHandler?: string | undefined;
|
|
21182
|
+
genericExecutor?: string | undefined;
|
|
20330
21183
|
} | undefined;
|
|
20331
21184
|
};
|
|
20332
21185
|
forwarderSupported: {
|
|
@@ -20380,26 +21233,31 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20380
21233
|
wallet: z.ZodString;
|
|
20381
21234
|
minter: z.ZodString;
|
|
20382
21235
|
depositForHandler: z.ZodOptional<z.ZodString>;
|
|
21236
|
+
genericExecutor: z.ZodOptional<z.ZodString>;
|
|
20383
21237
|
}, "strict", z.ZodTypeAny, {
|
|
20384
21238
|
wallet: string;
|
|
20385
21239
|
minter: string;
|
|
20386
21240
|
depositForHandler?: string | undefined;
|
|
21241
|
+
genericExecutor?: string | undefined;
|
|
20387
21242
|
}, {
|
|
20388
21243
|
wallet: string;
|
|
20389
21244
|
minter: string;
|
|
20390
21245
|
depositForHandler?: string | undefined;
|
|
21246
|
+
genericExecutor?: string | undefined;
|
|
20391
21247
|
}>>;
|
|
20392
21248
|
}, "strict", z.ZodTypeAny, {
|
|
20393
21249
|
v1?: {
|
|
20394
21250
|
wallet: string;
|
|
20395
21251
|
minter: string;
|
|
20396
21252
|
depositForHandler?: string | undefined;
|
|
21253
|
+
genericExecutor?: string | undefined;
|
|
20397
21254
|
} | undefined;
|
|
20398
21255
|
}, {
|
|
20399
21256
|
v1?: {
|
|
20400
21257
|
wallet: string;
|
|
20401
21258
|
minter: string;
|
|
20402
21259
|
depositForHandler?: string | undefined;
|
|
21260
|
+
genericExecutor?: string | undefined;
|
|
20403
21261
|
} | undefined;
|
|
20404
21262
|
}>;
|
|
20405
21263
|
forwarderSupported: z.ZodObject<{
|
|
@@ -20419,6 +21277,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20419
21277
|
wallet: string;
|
|
20420
21278
|
minter: string;
|
|
20421
21279
|
depositForHandler?: string | undefined;
|
|
21280
|
+
genericExecutor?: string | undefined;
|
|
20422
21281
|
} | undefined;
|
|
20423
21282
|
};
|
|
20424
21283
|
forwarderSupported: {
|
|
@@ -20432,6 +21291,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20432
21291
|
wallet: string;
|
|
20433
21292
|
minter: string;
|
|
20434
21293
|
depositForHandler?: string | undefined;
|
|
21294
|
+
genericExecutor?: string | undefined;
|
|
20435
21295
|
} | undefined;
|
|
20436
21296
|
};
|
|
20437
21297
|
forwarderSupported: {
|
|
@@ -20464,6 +21324,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20464
21324
|
wallet: string;
|
|
20465
21325
|
minter: string;
|
|
20466
21326
|
depositForHandler?: string | undefined;
|
|
21327
|
+
genericExecutor?: string | undefined;
|
|
20467
21328
|
} | undefined;
|
|
20468
21329
|
};
|
|
20469
21330
|
forwarderSupported: {
|
|
@@ -20499,6 +21360,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20499
21360
|
wallet: string;
|
|
20500
21361
|
minter: string;
|
|
20501
21362
|
depositForHandler?: string | undefined;
|
|
21363
|
+
genericExecutor?: string | undefined;
|
|
20502
21364
|
} | undefined;
|
|
20503
21365
|
};
|
|
20504
21366
|
forwarderSupported: {
|
|
@@ -20535,6 +21397,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20535
21397
|
wallet: string;
|
|
20536
21398
|
minter: string;
|
|
20537
21399
|
depositForHandler?: string | undefined;
|
|
21400
|
+
genericExecutor?: string | undefined;
|
|
20538
21401
|
} | undefined;
|
|
20539
21402
|
};
|
|
20540
21403
|
forwarderSupported: {
|
|
@@ -20570,6 +21433,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20570
21433
|
wallet: string;
|
|
20571
21434
|
minter: string;
|
|
20572
21435
|
depositForHandler?: string | undefined;
|
|
21436
|
+
genericExecutor?: string | undefined;
|
|
20573
21437
|
} | undefined;
|
|
20574
21438
|
};
|
|
20575
21439
|
forwarderSupported: {
|
|
@@ -20606,6 +21470,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20606
21470
|
wallet: string;
|
|
20607
21471
|
minter: string;
|
|
20608
21472
|
depositForHandler?: string | undefined;
|
|
21473
|
+
genericExecutor?: string | undefined;
|
|
20609
21474
|
} | undefined;
|
|
20610
21475
|
};
|
|
20611
21476
|
forwarderSupported: {
|
|
@@ -20641,6 +21506,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20641
21506
|
wallet: string;
|
|
20642
21507
|
minter: string;
|
|
20643
21508
|
depositForHandler?: string | undefined;
|
|
21509
|
+
genericExecutor?: string | undefined;
|
|
20644
21510
|
} | undefined;
|
|
20645
21511
|
};
|
|
20646
21512
|
forwarderSupported: {
|
|
@@ -20680,6 +21546,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20680
21546
|
wallet: string;
|
|
20681
21547
|
minter: string;
|
|
20682
21548
|
depositForHandler?: string | undefined;
|
|
21549
|
+
genericExecutor?: string | undefined;
|
|
20683
21550
|
} | undefined;
|
|
20684
21551
|
};
|
|
20685
21552
|
forwarderSupported: {
|
|
@@ -20715,6 +21582,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20715
21582
|
wallet: string;
|
|
20716
21583
|
minter: string;
|
|
20717
21584
|
depositForHandler?: string | undefined;
|
|
21585
|
+
genericExecutor?: string | undefined;
|
|
20718
21586
|
} | undefined;
|
|
20719
21587
|
};
|
|
20720
21588
|
forwarderSupported: {
|
|
@@ -20754,6 +21622,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20754
21622
|
wallet: string;
|
|
20755
21623
|
minter: string;
|
|
20756
21624
|
depositForHandler?: string | undefined;
|
|
21625
|
+
genericExecutor?: string | undefined;
|
|
20757
21626
|
} | undefined;
|
|
20758
21627
|
};
|
|
20759
21628
|
forwarderSupported: {
|
|
@@ -20789,6 +21658,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20789
21658
|
wallet: string;
|
|
20790
21659
|
minter: string;
|
|
20791
21660
|
depositForHandler?: string | undefined;
|
|
21661
|
+
genericExecutor?: string | undefined;
|
|
20792
21662
|
} | undefined;
|
|
20793
21663
|
};
|
|
20794
21664
|
forwarderSupported: {
|
|
@@ -20804,15 +21674,28 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20804
21674
|
};
|
|
20805
21675
|
vaultAddress: string;
|
|
20806
21676
|
}>, "many">;
|
|
20807
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
21677
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
21678
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
20808
21679
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
20809
21680
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
20810
21681
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
20811
21682
|
}, "strict", z.ZodTypeAny, {
|
|
21683
|
+
apiKey?: string | undefined;
|
|
20812
21684
|
kitKey?: string | undefined;
|
|
20813
21685
|
baseUrl?: string | undefined;
|
|
20814
21686
|
batchTransactions?: boolean | undefined;
|
|
20815
21687
|
}, {
|
|
21688
|
+
apiKey?: string | undefined;
|
|
21689
|
+
kitKey?: string | undefined;
|
|
21690
|
+
baseUrl?: string | undefined;
|
|
21691
|
+
batchTransactions?: boolean | undefined;
|
|
21692
|
+
}>, {
|
|
21693
|
+
apiKey?: string | undefined;
|
|
21694
|
+
kitKey?: string | undefined;
|
|
21695
|
+
baseUrl?: string | undefined;
|
|
21696
|
+
batchTransactions?: boolean | undefined;
|
|
21697
|
+
}, {
|
|
21698
|
+
apiKey?: string | undefined;
|
|
20816
21699
|
kitKey?: string | undefined;
|
|
20817
21700
|
baseUrl?: string | undefined;
|
|
20818
21701
|
batchTransactions?: boolean | undefined;
|
|
@@ -20843,6 +21726,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20843
21726
|
wallet: string;
|
|
20844
21727
|
minter: string;
|
|
20845
21728
|
depositForHandler?: string | undefined;
|
|
21729
|
+
genericExecutor?: string | undefined;
|
|
20846
21730
|
} | undefined;
|
|
20847
21731
|
};
|
|
20848
21732
|
forwarderSupported: {
|
|
@@ -20878,6 +21762,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20878
21762
|
wallet: string;
|
|
20879
21763
|
minter: string;
|
|
20880
21764
|
depositForHandler?: string | undefined;
|
|
21765
|
+
genericExecutor?: string | undefined;
|
|
20881
21766
|
} | undefined;
|
|
20882
21767
|
};
|
|
20883
21768
|
forwarderSupported: {
|
|
@@ -20894,6 +21779,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20894
21779
|
vaultAddress: `0x${string}`;
|
|
20895
21780
|
}[];
|
|
20896
21781
|
config?: {
|
|
21782
|
+
apiKey?: string | undefined;
|
|
20897
21783
|
kitKey?: string | undefined;
|
|
20898
21784
|
baseUrl?: string | undefined;
|
|
20899
21785
|
batchTransactions?: boolean | undefined;
|
|
@@ -20924,6 +21810,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20924
21810
|
wallet: string;
|
|
20925
21811
|
minter: string;
|
|
20926
21812
|
depositForHandler?: string | undefined;
|
|
21813
|
+
genericExecutor?: string | undefined;
|
|
20927
21814
|
} | undefined;
|
|
20928
21815
|
};
|
|
20929
21816
|
forwarderSupported: {
|
|
@@ -20959,6 +21846,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20959
21846
|
wallet: string;
|
|
20960
21847
|
minter: string;
|
|
20961
21848
|
depositForHandler?: string | undefined;
|
|
21849
|
+
genericExecutor?: string | undefined;
|
|
20962
21850
|
} | undefined;
|
|
20963
21851
|
};
|
|
20964
21852
|
forwarderSupported: {
|
|
@@ -20975,6 +21863,7 @@ declare const getVaultsParamsSchema: z.ZodObject<{
|
|
|
20975
21863
|
vaultAddress: string;
|
|
20976
21864
|
}[];
|
|
20977
21865
|
config?: {
|
|
21866
|
+
apiKey?: string | undefined;
|
|
20978
21867
|
kitKey?: string | undefined;
|
|
20979
21868
|
baseUrl?: string | undefined;
|
|
20980
21869
|
batchTransactions?: boolean | undefined;
|
|
@@ -21036,26 +21925,31 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21036
21925
|
wallet: z.ZodString;
|
|
21037
21926
|
minter: z.ZodString;
|
|
21038
21927
|
depositForHandler: z.ZodOptional<z.ZodString>;
|
|
21928
|
+
genericExecutor: z.ZodOptional<z.ZodString>;
|
|
21039
21929
|
}, "strict", z.ZodTypeAny, {
|
|
21040
21930
|
wallet: string;
|
|
21041
21931
|
minter: string;
|
|
21042
21932
|
depositForHandler?: string | undefined;
|
|
21933
|
+
genericExecutor?: string | undefined;
|
|
21043
21934
|
}, {
|
|
21044
21935
|
wallet: string;
|
|
21045
21936
|
minter: string;
|
|
21046
21937
|
depositForHandler?: string | undefined;
|
|
21938
|
+
genericExecutor?: string | undefined;
|
|
21047
21939
|
}>>;
|
|
21048
21940
|
}, "strict", z.ZodTypeAny, {
|
|
21049
21941
|
v1?: {
|
|
21050
21942
|
wallet: string;
|
|
21051
21943
|
minter: string;
|
|
21052
21944
|
depositForHandler?: string | undefined;
|
|
21945
|
+
genericExecutor?: string | undefined;
|
|
21053
21946
|
} | undefined;
|
|
21054
21947
|
}, {
|
|
21055
21948
|
v1?: {
|
|
21056
21949
|
wallet: string;
|
|
21057
21950
|
minter: string;
|
|
21058
21951
|
depositForHandler?: string | undefined;
|
|
21952
|
+
genericExecutor?: string | undefined;
|
|
21059
21953
|
} | undefined;
|
|
21060
21954
|
}>;
|
|
21061
21955
|
forwarderSupported: z.ZodObject<{
|
|
@@ -21075,6 +21969,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21075
21969
|
wallet: string;
|
|
21076
21970
|
minter: string;
|
|
21077
21971
|
depositForHandler?: string | undefined;
|
|
21972
|
+
genericExecutor?: string | undefined;
|
|
21078
21973
|
} | undefined;
|
|
21079
21974
|
};
|
|
21080
21975
|
forwarderSupported: {
|
|
@@ -21088,6 +21983,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21088
21983
|
wallet: string;
|
|
21089
21984
|
minter: string;
|
|
21090
21985
|
depositForHandler?: string | undefined;
|
|
21986
|
+
genericExecutor?: string | undefined;
|
|
21091
21987
|
} | undefined;
|
|
21092
21988
|
};
|
|
21093
21989
|
forwarderSupported: {
|
|
@@ -21122,6 +22018,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21122
22018
|
wallet: string;
|
|
21123
22019
|
minter: string;
|
|
21124
22020
|
depositForHandler?: string | undefined;
|
|
22021
|
+
genericExecutor?: string | undefined;
|
|
21125
22022
|
} | undefined;
|
|
21126
22023
|
};
|
|
21127
22024
|
forwarderSupported: {
|
|
@@ -21158,6 +22055,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21158
22055
|
wallet: string;
|
|
21159
22056
|
minter: string;
|
|
21160
22057
|
depositForHandler?: string | undefined;
|
|
22058
|
+
genericExecutor?: string | undefined;
|
|
21161
22059
|
} | undefined;
|
|
21162
22060
|
};
|
|
21163
22061
|
forwarderSupported: {
|
|
@@ -21211,26 +22109,31 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21211
22109
|
wallet: z.ZodString;
|
|
21212
22110
|
minter: z.ZodString;
|
|
21213
22111
|
depositForHandler: z.ZodOptional<z.ZodString>;
|
|
22112
|
+
genericExecutor: z.ZodOptional<z.ZodString>;
|
|
21214
22113
|
}, "strict", z.ZodTypeAny, {
|
|
21215
22114
|
wallet: string;
|
|
21216
22115
|
minter: string;
|
|
21217
22116
|
depositForHandler?: string | undefined;
|
|
22117
|
+
genericExecutor?: string | undefined;
|
|
21218
22118
|
}, {
|
|
21219
22119
|
wallet: string;
|
|
21220
22120
|
minter: string;
|
|
21221
22121
|
depositForHandler?: string | undefined;
|
|
22122
|
+
genericExecutor?: string | undefined;
|
|
21222
22123
|
}>>;
|
|
21223
22124
|
}, "strict", z.ZodTypeAny, {
|
|
21224
22125
|
v1?: {
|
|
21225
22126
|
wallet: string;
|
|
21226
22127
|
minter: string;
|
|
21227
22128
|
depositForHandler?: string | undefined;
|
|
22129
|
+
genericExecutor?: string | undefined;
|
|
21228
22130
|
} | undefined;
|
|
21229
22131
|
}, {
|
|
21230
22132
|
v1?: {
|
|
21231
22133
|
wallet: string;
|
|
21232
22134
|
minter: string;
|
|
21233
22135
|
depositForHandler?: string | undefined;
|
|
22136
|
+
genericExecutor?: string | undefined;
|
|
21234
22137
|
} | undefined;
|
|
21235
22138
|
}>;
|
|
21236
22139
|
forwarderSupported: z.ZodObject<{
|
|
@@ -21250,6 +22153,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21250
22153
|
wallet: string;
|
|
21251
22154
|
minter: string;
|
|
21252
22155
|
depositForHandler?: string | undefined;
|
|
22156
|
+
genericExecutor?: string | undefined;
|
|
21253
22157
|
} | undefined;
|
|
21254
22158
|
};
|
|
21255
22159
|
forwarderSupported: {
|
|
@@ -21263,6 +22167,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21263
22167
|
wallet: string;
|
|
21264
22168
|
minter: string;
|
|
21265
22169
|
depositForHandler?: string | undefined;
|
|
22170
|
+
genericExecutor?: string | undefined;
|
|
21266
22171
|
} | undefined;
|
|
21267
22172
|
};
|
|
21268
22173
|
forwarderSupported: {
|
|
@@ -21295,6 +22200,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21295
22200
|
wallet: string;
|
|
21296
22201
|
minter: string;
|
|
21297
22202
|
depositForHandler?: string | undefined;
|
|
22203
|
+
genericExecutor?: string | undefined;
|
|
21298
22204
|
} | undefined;
|
|
21299
22205
|
};
|
|
21300
22206
|
forwarderSupported: {
|
|
@@ -21330,6 +22236,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21330
22236
|
wallet: string;
|
|
21331
22237
|
minter: string;
|
|
21332
22238
|
depositForHandler?: string | undefined;
|
|
22239
|
+
genericExecutor?: string | undefined;
|
|
21333
22240
|
} | undefined;
|
|
21334
22241
|
};
|
|
21335
22242
|
forwarderSupported: {
|
|
@@ -21366,6 +22273,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21366
22273
|
wallet: string;
|
|
21367
22274
|
minter: string;
|
|
21368
22275
|
depositForHandler?: string | undefined;
|
|
22276
|
+
genericExecutor?: string | undefined;
|
|
21369
22277
|
} | undefined;
|
|
21370
22278
|
};
|
|
21371
22279
|
forwarderSupported: {
|
|
@@ -21401,6 +22309,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21401
22309
|
wallet: string;
|
|
21402
22310
|
minter: string;
|
|
21403
22311
|
depositForHandler?: string | undefined;
|
|
22312
|
+
genericExecutor?: string | undefined;
|
|
21404
22313
|
} | undefined;
|
|
21405
22314
|
};
|
|
21406
22315
|
forwarderSupported: {
|
|
@@ -21437,6 +22346,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21437
22346
|
wallet: string;
|
|
21438
22347
|
minter: string;
|
|
21439
22348
|
depositForHandler?: string | undefined;
|
|
22349
|
+
genericExecutor?: string | undefined;
|
|
21440
22350
|
} | undefined;
|
|
21441
22351
|
};
|
|
21442
22352
|
forwarderSupported: {
|
|
@@ -21472,6 +22382,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21472
22382
|
wallet: string;
|
|
21473
22383
|
minter: string;
|
|
21474
22384
|
depositForHandler?: string | undefined;
|
|
22385
|
+
genericExecutor?: string | undefined;
|
|
21475
22386
|
} | undefined;
|
|
21476
22387
|
};
|
|
21477
22388
|
forwarderSupported: {
|
|
@@ -21492,15 +22403,28 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21492
22403
|
sortBy: z.ZodOptional<z.ZodEnum<["apy", "tvl", "name"]>>;
|
|
21493
22404
|
page: z.ZodOptional<z.ZodNumber>;
|
|
21494
22405
|
pageSize: z.ZodOptional<z.ZodNumber>;
|
|
21495
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
22406
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
22407
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
21496
22408
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
21497
22409
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
21498
22410
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
21499
22411
|
}, "strict", z.ZodTypeAny, {
|
|
22412
|
+
apiKey?: string | undefined;
|
|
22413
|
+
kitKey?: string | undefined;
|
|
22414
|
+
baseUrl?: string | undefined;
|
|
22415
|
+
batchTransactions?: boolean | undefined;
|
|
22416
|
+
}, {
|
|
22417
|
+
apiKey?: string | undefined;
|
|
22418
|
+
kitKey?: string | undefined;
|
|
22419
|
+
baseUrl?: string | undefined;
|
|
22420
|
+
batchTransactions?: boolean | undefined;
|
|
22421
|
+
}>, {
|
|
22422
|
+
apiKey?: string | undefined;
|
|
21500
22423
|
kitKey?: string | undefined;
|
|
21501
22424
|
baseUrl?: string | undefined;
|
|
21502
22425
|
batchTransactions?: boolean | undefined;
|
|
21503
22426
|
}, {
|
|
22427
|
+
apiKey?: string | undefined;
|
|
21504
22428
|
kitKey?: string | undefined;
|
|
21505
22429
|
baseUrl?: string | undefined;
|
|
21506
22430
|
batchTransactions?: boolean | undefined;
|
|
@@ -21530,6 +22454,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21530
22454
|
wallet: string;
|
|
21531
22455
|
minter: string;
|
|
21532
22456
|
depositForHandler?: string | undefined;
|
|
22457
|
+
genericExecutor?: string | undefined;
|
|
21533
22458
|
} | undefined;
|
|
21534
22459
|
};
|
|
21535
22460
|
forwarderSupported: {
|
|
@@ -21565,6 +22490,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21565
22490
|
wallet: string;
|
|
21566
22491
|
minter: string;
|
|
21567
22492
|
depositForHandler?: string | undefined;
|
|
22493
|
+
genericExecutor?: string | undefined;
|
|
21568
22494
|
} | undefined;
|
|
21569
22495
|
};
|
|
21570
22496
|
forwarderSupported: {
|
|
@@ -21579,6 +22505,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21579
22505
|
} | undefined;
|
|
21580
22506
|
};
|
|
21581
22507
|
config?: {
|
|
22508
|
+
apiKey?: string | undefined;
|
|
21582
22509
|
kitKey?: string | undefined;
|
|
21583
22510
|
baseUrl?: string | undefined;
|
|
21584
22511
|
batchTransactions?: boolean | undefined;
|
|
@@ -21615,6 +22542,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21615
22542
|
wallet: string;
|
|
21616
22543
|
minter: string;
|
|
21617
22544
|
depositForHandler?: string | undefined;
|
|
22545
|
+
genericExecutor?: string | undefined;
|
|
21618
22546
|
} | undefined;
|
|
21619
22547
|
};
|
|
21620
22548
|
forwarderSupported: {
|
|
@@ -21650,6 +22578,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21650
22578
|
wallet: string;
|
|
21651
22579
|
minter: string;
|
|
21652
22580
|
depositForHandler?: string | undefined;
|
|
22581
|
+
genericExecutor?: string | undefined;
|
|
21653
22582
|
} | undefined;
|
|
21654
22583
|
};
|
|
21655
22584
|
forwarderSupported: {
|
|
@@ -21664,6 +22593,7 @@ declare const exploreVaultsParamsSchema: z.ZodObject<{
|
|
|
21664
22593
|
} | undefined;
|
|
21665
22594
|
};
|
|
21666
22595
|
config?: {
|
|
22596
|
+
apiKey?: string | undefined;
|
|
21667
22597
|
kitKey?: string | undefined;
|
|
21668
22598
|
baseUrl?: string | undefined;
|
|
21669
22599
|
batchTransactions?: boolean | undefined;
|
|
@@ -21734,26 +22664,31 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
21734
22664
|
wallet: z.ZodString;
|
|
21735
22665
|
minter: z.ZodString;
|
|
21736
22666
|
depositForHandler: z.ZodOptional<z.ZodString>;
|
|
22667
|
+
genericExecutor: z.ZodOptional<z.ZodString>;
|
|
21737
22668
|
}, "strict", z.ZodTypeAny, {
|
|
21738
22669
|
wallet: string;
|
|
21739
22670
|
minter: string;
|
|
21740
22671
|
depositForHandler?: string | undefined;
|
|
22672
|
+
genericExecutor?: string | undefined;
|
|
21741
22673
|
}, {
|
|
21742
22674
|
wallet: string;
|
|
21743
22675
|
minter: string;
|
|
21744
22676
|
depositForHandler?: string | undefined;
|
|
22677
|
+
genericExecutor?: string | undefined;
|
|
21745
22678
|
}>>;
|
|
21746
22679
|
}, "strict", z.ZodTypeAny, {
|
|
21747
22680
|
v1?: {
|
|
21748
22681
|
wallet: string;
|
|
21749
22682
|
minter: string;
|
|
21750
22683
|
depositForHandler?: string | undefined;
|
|
22684
|
+
genericExecutor?: string | undefined;
|
|
21751
22685
|
} | undefined;
|
|
21752
22686
|
}, {
|
|
21753
22687
|
v1?: {
|
|
21754
22688
|
wallet: string;
|
|
21755
22689
|
minter: string;
|
|
21756
22690
|
depositForHandler?: string | undefined;
|
|
22691
|
+
genericExecutor?: string | undefined;
|
|
21757
22692
|
} | undefined;
|
|
21758
22693
|
}>;
|
|
21759
22694
|
forwarderSupported: z.ZodObject<{
|
|
@@ -21773,6 +22708,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
21773
22708
|
wallet: string;
|
|
21774
22709
|
minter: string;
|
|
21775
22710
|
depositForHandler?: string | undefined;
|
|
22711
|
+
genericExecutor?: string | undefined;
|
|
21776
22712
|
} | undefined;
|
|
21777
22713
|
};
|
|
21778
22714
|
forwarderSupported: {
|
|
@@ -21786,6 +22722,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
21786
22722
|
wallet: string;
|
|
21787
22723
|
minter: string;
|
|
21788
22724
|
depositForHandler?: string | undefined;
|
|
22725
|
+
genericExecutor?: string | undefined;
|
|
21789
22726
|
} | undefined;
|
|
21790
22727
|
};
|
|
21791
22728
|
forwarderSupported: {
|
|
@@ -21820,6 +22757,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
21820
22757
|
wallet: string;
|
|
21821
22758
|
minter: string;
|
|
21822
22759
|
depositForHandler?: string | undefined;
|
|
22760
|
+
genericExecutor?: string | undefined;
|
|
21823
22761
|
} | undefined;
|
|
21824
22762
|
};
|
|
21825
22763
|
forwarderSupported: {
|
|
@@ -21856,6 +22794,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
21856
22794
|
wallet: string;
|
|
21857
22795
|
minter: string;
|
|
21858
22796
|
depositForHandler?: string | undefined;
|
|
22797
|
+
genericExecutor?: string | undefined;
|
|
21859
22798
|
} | undefined;
|
|
21860
22799
|
};
|
|
21861
22800
|
forwarderSupported: {
|
|
@@ -21909,26 +22848,31 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
21909
22848
|
wallet: z.ZodString;
|
|
21910
22849
|
minter: z.ZodString;
|
|
21911
22850
|
depositForHandler: z.ZodOptional<z.ZodString>;
|
|
22851
|
+
genericExecutor: z.ZodOptional<z.ZodString>;
|
|
21912
22852
|
}, "strict", z.ZodTypeAny, {
|
|
21913
22853
|
wallet: string;
|
|
21914
22854
|
minter: string;
|
|
21915
22855
|
depositForHandler?: string | undefined;
|
|
22856
|
+
genericExecutor?: string | undefined;
|
|
21916
22857
|
}, {
|
|
21917
22858
|
wallet: string;
|
|
21918
22859
|
minter: string;
|
|
21919
22860
|
depositForHandler?: string | undefined;
|
|
22861
|
+
genericExecutor?: string | undefined;
|
|
21920
22862
|
}>>;
|
|
21921
22863
|
}, "strict", z.ZodTypeAny, {
|
|
21922
22864
|
v1?: {
|
|
21923
22865
|
wallet: string;
|
|
21924
22866
|
minter: string;
|
|
21925
22867
|
depositForHandler?: string | undefined;
|
|
22868
|
+
genericExecutor?: string | undefined;
|
|
21926
22869
|
} | undefined;
|
|
21927
22870
|
}, {
|
|
21928
22871
|
v1?: {
|
|
21929
22872
|
wallet: string;
|
|
21930
22873
|
minter: string;
|
|
21931
22874
|
depositForHandler?: string | undefined;
|
|
22875
|
+
genericExecutor?: string | undefined;
|
|
21932
22876
|
} | undefined;
|
|
21933
22877
|
}>;
|
|
21934
22878
|
forwarderSupported: z.ZodObject<{
|
|
@@ -21948,6 +22892,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
21948
22892
|
wallet: string;
|
|
21949
22893
|
minter: string;
|
|
21950
22894
|
depositForHandler?: string | undefined;
|
|
22895
|
+
genericExecutor?: string | undefined;
|
|
21951
22896
|
} | undefined;
|
|
21952
22897
|
};
|
|
21953
22898
|
forwarderSupported: {
|
|
@@ -21961,6 +22906,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
21961
22906
|
wallet: string;
|
|
21962
22907
|
minter: string;
|
|
21963
22908
|
depositForHandler?: string | undefined;
|
|
22909
|
+
genericExecutor?: string | undefined;
|
|
21964
22910
|
} | undefined;
|
|
21965
22911
|
};
|
|
21966
22912
|
forwarderSupported: {
|
|
@@ -21993,6 +22939,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
21993
22939
|
wallet: string;
|
|
21994
22940
|
minter: string;
|
|
21995
22941
|
depositForHandler?: string | undefined;
|
|
22942
|
+
genericExecutor?: string | undefined;
|
|
21996
22943
|
} | undefined;
|
|
21997
22944
|
};
|
|
21998
22945
|
forwarderSupported: {
|
|
@@ -22028,6 +22975,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22028
22975
|
wallet: string;
|
|
22029
22976
|
minter: string;
|
|
22030
22977
|
depositForHandler?: string | undefined;
|
|
22978
|
+
genericExecutor?: string | undefined;
|
|
22031
22979
|
} | undefined;
|
|
22032
22980
|
};
|
|
22033
22981
|
forwarderSupported: {
|
|
@@ -22064,6 +23012,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22064
23012
|
wallet: string;
|
|
22065
23013
|
minter: string;
|
|
22066
23014
|
depositForHandler?: string | undefined;
|
|
23015
|
+
genericExecutor?: string | undefined;
|
|
22067
23016
|
} | undefined;
|
|
22068
23017
|
};
|
|
22069
23018
|
forwarderSupported: {
|
|
@@ -22099,6 +23048,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22099
23048
|
wallet: string;
|
|
22100
23049
|
minter: string;
|
|
22101
23050
|
depositForHandler?: string | undefined;
|
|
23051
|
+
genericExecutor?: string | undefined;
|
|
22102
23052
|
} | undefined;
|
|
22103
23053
|
};
|
|
22104
23054
|
forwarderSupported: {
|
|
@@ -22135,6 +23085,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22135
23085
|
wallet: string;
|
|
22136
23086
|
minter: string;
|
|
22137
23087
|
depositForHandler?: string | undefined;
|
|
23088
|
+
genericExecutor?: string | undefined;
|
|
22138
23089
|
} | undefined;
|
|
22139
23090
|
};
|
|
22140
23091
|
forwarderSupported: {
|
|
@@ -22170,6 +23121,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22170
23121
|
wallet: string;
|
|
22171
23122
|
minter: string;
|
|
22172
23123
|
depositForHandler?: string | undefined;
|
|
23124
|
+
genericExecutor?: string | undefined;
|
|
22173
23125
|
} | undefined;
|
|
22174
23126
|
};
|
|
22175
23127
|
forwarderSupported: {
|
|
@@ -22190,15 +23142,28 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22190
23142
|
sortBy: z.ZodOptional<z.ZodEnum<["apy", "tvl", "name"]>>;
|
|
22191
23143
|
page: z.ZodOptional<z.ZodNumber>;
|
|
22192
23144
|
pageSize: z.ZodOptional<z.ZodNumber>;
|
|
22193
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
23145
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
23146
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
22194
23147
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
22195
23148
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
22196
23149
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
22197
23150
|
}, "strict", z.ZodTypeAny, {
|
|
23151
|
+
apiKey?: string | undefined;
|
|
23152
|
+
kitKey?: string | undefined;
|
|
23153
|
+
baseUrl?: string | undefined;
|
|
23154
|
+
batchTransactions?: boolean | undefined;
|
|
23155
|
+
}, {
|
|
23156
|
+
apiKey?: string | undefined;
|
|
23157
|
+
kitKey?: string | undefined;
|
|
23158
|
+
baseUrl?: string | undefined;
|
|
23159
|
+
batchTransactions?: boolean | undefined;
|
|
23160
|
+
}>, {
|
|
23161
|
+
apiKey?: string | undefined;
|
|
22198
23162
|
kitKey?: string | undefined;
|
|
22199
23163
|
baseUrl?: string | undefined;
|
|
22200
23164
|
batchTransactions?: boolean | undefined;
|
|
22201
23165
|
}, {
|
|
23166
|
+
apiKey?: string | undefined;
|
|
22202
23167
|
kitKey?: string | undefined;
|
|
22203
23168
|
baseUrl?: string | undefined;
|
|
22204
23169
|
batchTransactions?: boolean | undefined;
|
|
@@ -22228,6 +23193,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22228
23193
|
wallet: string;
|
|
22229
23194
|
minter: string;
|
|
22230
23195
|
depositForHandler?: string | undefined;
|
|
23196
|
+
genericExecutor?: string | undefined;
|
|
22231
23197
|
} | undefined;
|
|
22232
23198
|
};
|
|
22233
23199
|
forwarderSupported: {
|
|
@@ -22263,6 +23229,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22263
23229
|
wallet: string;
|
|
22264
23230
|
minter: string;
|
|
22265
23231
|
depositForHandler?: string | undefined;
|
|
23232
|
+
genericExecutor?: string | undefined;
|
|
22266
23233
|
} | undefined;
|
|
22267
23234
|
};
|
|
22268
23235
|
forwarderSupported: {
|
|
@@ -22277,6 +23244,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22277
23244
|
} | undefined;
|
|
22278
23245
|
};
|
|
22279
23246
|
config?: {
|
|
23247
|
+
apiKey?: string | undefined;
|
|
22280
23248
|
kitKey?: string | undefined;
|
|
22281
23249
|
baseUrl?: string | undefined;
|
|
22282
23250
|
batchTransactions?: boolean | undefined;
|
|
@@ -22312,6 +23280,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22312
23280
|
wallet: string;
|
|
22313
23281
|
minter: string;
|
|
22314
23282
|
depositForHandler?: string | undefined;
|
|
23283
|
+
genericExecutor?: string | undefined;
|
|
22315
23284
|
} | undefined;
|
|
22316
23285
|
};
|
|
22317
23286
|
forwarderSupported: {
|
|
@@ -22347,6 +23316,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22347
23316
|
wallet: string;
|
|
22348
23317
|
minter: string;
|
|
22349
23318
|
depositForHandler?: string | undefined;
|
|
23319
|
+
genericExecutor?: string | undefined;
|
|
22350
23320
|
} | undefined;
|
|
22351
23321
|
};
|
|
22352
23322
|
forwarderSupported: {
|
|
@@ -22361,6 +23331,7 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22361
23331
|
} | undefined;
|
|
22362
23332
|
};
|
|
22363
23333
|
config?: {
|
|
23334
|
+
apiKey?: string | undefined;
|
|
22364
23335
|
kitKey?: string | undefined;
|
|
22365
23336
|
baseUrl?: string | undefined;
|
|
22366
23337
|
batchTransactions?: boolean | undefined;
|
|
@@ -22388,15 +23359,28 @@ declare const exploreVaultsIteratorParamsSchema: z.ZodObject<Omit<{
|
|
|
22388
23359
|
declare const getPositionParamsSchema: z.ZodObject<{
|
|
22389
23360
|
from: z.ZodType<any, z.ZodTypeDef, any>;
|
|
22390
23361
|
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<{
|
|
23362
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
23363
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
22392
23364
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
22393
23365
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
22394
23366
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
22395
23367
|
}, "strict", z.ZodTypeAny, {
|
|
23368
|
+
apiKey?: string | undefined;
|
|
23369
|
+
kitKey?: string | undefined;
|
|
23370
|
+
baseUrl?: string | undefined;
|
|
23371
|
+
batchTransactions?: boolean | undefined;
|
|
23372
|
+
}, {
|
|
23373
|
+
apiKey?: string | undefined;
|
|
23374
|
+
kitKey?: string | undefined;
|
|
23375
|
+
baseUrl?: string | undefined;
|
|
23376
|
+
batchTransactions?: boolean | undefined;
|
|
23377
|
+
}>, {
|
|
23378
|
+
apiKey?: string | undefined;
|
|
22396
23379
|
kitKey?: string | undefined;
|
|
22397
23380
|
baseUrl?: string | undefined;
|
|
22398
23381
|
batchTransactions?: boolean | undefined;
|
|
22399
23382
|
}, {
|
|
23383
|
+
apiKey?: string | undefined;
|
|
22400
23384
|
kitKey?: string | undefined;
|
|
22401
23385
|
baseUrl?: string | undefined;
|
|
22402
23386
|
batchTransactions?: boolean | undefined;
|
|
@@ -22405,6 +23389,7 @@ declare const getPositionParamsSchema: z.ZodObject<{
|
|
|
22405
23389
|
vaultAddress: `0x${string}`;
|
|
22406
23390
|
from?: any;
|
|
22407
23391
|
config?: {
|
|
23392
|
+
apiKey?: string | undefined;
|
|
22408
23393
|
kitKey?: string | undefined;
|
|
22409
23394
|
baseUrl?: string | undefined;
|
|
22410
23395
|
batchTransactions?: boolean | undefined;
|
|
@@ -22413,6 +23398,7 @@ declare const getPositionParamsSchema: z.ZodObject<{
|
|
|
22413
23398
|
vaultAddress: string;
|
|
22414
23399
|
from?: any;
|
|
22415
23400
|
config?: {
|
|
23401
|
+
apiKey?: string | undefined;
|
|
22416
23402
|
kitKey?: string | undefined;
|
|
22417
23403
|
baseUrl?: string | undefined;
|
|
22418
23404
|
batchTransactions?: boolean | undefined;
|
|
@@ -22486,26 +23472,31 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22486
23472
|
wallet: z.ZodString;
|
|
22487
23473
|
minter: z.ZodString;
|
|
22488
23474
|
depositForHandler: z.ZodOptional<z.ZodString>;
|
|
23475
|
+
genericExecutor: z.ZodOptional<z.ZodString>;
|
|
22489
23476
|
}, "strict", z.ZodTypeAny, {
|
|
22490
23477
|
wallet: string;
|
|
22491
23478
|
minter: string;
|
|
22492
23479
|
depositForHandler?: string | undefined;
|
|
23480
|
+
genericExecutor?: string | undefined;
|
|
22493
23481
|
}, {
|
|
22494
23482
|
wallet: string;
|
|
22495
23483
|
minter: string;
|
|
22496
23484
|
depositForHandler?: string | undefined;
|
|
23485
|
+
genericExecutor?: string | undefined;
|
|
22497
23486
|
}>>;
|
|
22498
23487
|
}, "strict", z.ZodTypeAny, {
|
|
22499
23488
|
v1?: {
|
|
22500
23489
|
wallet: string;
|
|
22501
23490
|
minter: string;
|
|
22502
23491
|
depositForHandler?: string | undefined;
|
|
23492
|
+
genericExecutor?: string | undefined;
|
|
22503
23493
|
} | undefined;
|
|
22504
23494
|
}, {
|
|
22505
23495
|
v1?: {
|
|
22506
23496
|
wallet: string;
|
|
22507
23497
|
minter: string;
|
|
22508
23498
|
depositForHandler?: string | undefined;
|
|
23499
|
+
genericExecutor?: string | undefined;
|
|
22509
23500
|
} | undefined;
|
|
22510
23501
|
}>;
|
|
22511
23502
|
forwarderSupported: z.ZodObject<{
|
|
@@ -22525,6 +23516,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22525
23516
|
wallet: string;
|
|
22526
23517
|
minter: string;
|
|
22527
23518
|
depositForHandler?: string | undefined;
|
|
23519
|
+
genericExecutor?: string | undefined;
|
|
22528
23520
|
} | undefined;
|
|
22529
23521
|
};
|
|
22530
23522
|
forwarderSupported: {
|
|
@@ -22538,6 +23530,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22538
23530
|
wallet: string;
|
|
22539
23531
|
minter: string;
|
|
22540
23532
|
depositForHandler?: string | undefined;
|
|
23533
|
+
genericExecutor?: string | undefined;
|
|
22541
23534
|
} | undefined;
|
|
22542
23535
|
};
|
|
22543
23536
|
forwarderSupported: {
|
|
@@ -22572,6 +23565,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22572
23565
|
wallet: string;
|
|
22573
23566
|
minter: string;
|
|
22574
23567
|
depositForHandler?: string | undefined;
|
|
23568
|
+
genericExecutor?: string | undefined;
|
|
22575
23569
|
} | undefined;
|
|
22576
23570
|
};
|
|
22577
23571
|
forwarderSupported: {
|
|
@@ -22608,6 +23602,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22608
23602
|
wallet: string;
|
|
22609
23603
|
minter: string;
|
|
22610
23604
|
depositForHandler?: string | undefined;
|
|
23605
|
+
genericExecutor?: string | undefined;
|
|
22611
23606
|
} | undefined;
|
|
22612
23607
|
};
|
|
22613
23608
|
forwarderSupported: {
|
|
@@ -22661,26 +23656,31 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22661
23656
|
wallet: z.ZodString;
|
|
22662
23657
|
minter: z.ZodString;
|
|
22663
23658
|
depositForHandler: z.ZodOptional<z.ZodString>;
|
|
23659
|
+
genericExecutor: z.ZodOptional<z.ZodString>;
|
|
22664
23660
|
}, "strict", z.ZodTypeAny, {
|
|
22665
23661
|
wallet: string;
|
|
22666
23662
|
minter: string;
|
|
22667
23663
|
depositForHandler?: string | undefined;
|
|
23664
|
+
genericExecutor?: string | undefined;
|
|
22668
23665
|
}, {
|
|
22669
23666
|
wallet: string;
|
|
22670
23667
|
minter: string;
|
|
22671
23668
|
depositForHandler?: string | undefined;
|
|
23669
|
+
genericExecutor?: string | undefined;
|
|
22672
23670
|
}>>;
|
|
22673
23671
|
}, "strict", z.ZodTypeAny, {
|
|
22674
23672
|
v1?: {
|
|
22675
23673
|
wallet: string;
|
|
22676
23674
|
minter: string;
|
|
22677
23675
|
depositForHandler?: string | undefined;
|
|
23676
|
+
genericExecutor?: string | undefined;
|
|
22678
23677
|
} | undefined;
|
|
22679
23678
|
}, {
|
|
22680
23679
|
v1?: {
|
|
22681
23680
|
wallet: string;
|
|
22682
23681
|
minter: string;
|
|
22683
23682
|
depositForHandler?: string | undefined;
|
|
23683
|
+
genericExecutor?: string | undefined;
|
|
22684
23684
|
} | undefined;
|
|
22685
23685
|
}>;
|
|
22686
23686
|
forwarderSupported: z.ZodObject<{
|
|
@@ -22700,6 +23700,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22700
23700
|
wallet: string;
|
|
22701
23701
|
minter: string;
|
|
22702
23702
|
depositForHandler?: string | undefined;
|
|
23703
|
+
genericExecutor?: string | undefined;
|
|
22703
23704
|
} | undefined;
|
|
22704
23705
|
};
|
|
22705
23706
|
forwarderSupported: {
|
|
@@ -22713,6 +23714,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22713
23714
|
wallet: string;
|
|
22714
23715
|
minter: string;
|
|
22715
23716
|
depositForHandler?: string | undefined;
|
|
23717
|
+
genericExecutor?: string | undefined;
|
|
22716
23718
|
} | undefined;
|
|
22717
23719
|
};
|
|
22718
23720
|
forwarderSupported: {
|
|
@@ -22745,6 +23747,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22745
23747
|
wallet: string;
|
|
22746
23748
|
minter: string;
|
|
22747
23749
|
depositForHandler?: string | undefined;
|
|
23750
|
+
genericExecutor?: string | undefined;
|
|
22748
23751
|
} | undefined;
|
|
22749
23752
|
};
|
|
22750
23753
|
forwarderSupported: {
|
|
@@ -22780,6 +23783,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22780
23783
|
wallet: string;
|
|
22781
23784
|
minter: string;
|
|
22782
23785
|
depositForHandler?: string | undefined;
|
|
23786
|
+
genericExecutor?: string | undefined;
|
|
22783
23787
|
} | undefined;
|
|
22784
23788
|
};
|
|
22785
23789
|
forwarderSupported: {
|
|
@@ -22816,6 +23820,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22816
23820
|
wallet: string;
|
|
22817
23821
|
minter: string;
|
|
22818
23822
|
depositForHandler?: string | undefined;
|
|
23823
|
+
genericExecutor?: string | undefined;
|
|
22819
23824
|
} | undefined;
|
|
22820
23825
|
};
|
|
22821
23826
|
forwarderSupported: {
|
|
@@ -22851,6 +23856,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22851
23856
|
wallet: string;
|
|
22852
23857
|
minter: string;
|
|
22853
23858
|
depositForHandler?: string | undefined;
|
|
23859
|
+
genericExecutor?: string | undefined;
|
|
22854
23860
|
} | undefined;
|
|
22855
23861
|
};
|
|
22856
23862
|
forwarderSupported: {
|
|
@@ -22887,6 +23893,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22887
23893
|
wallet: string;
|
|
22888
23894
|
minter: string;
|
|
22889
23895
|
depositForHandler?: string | undefined;
|
|
23896
|
+
genericExecutor?: string | undefined;
|
|
22890
23897
|
} | undefined;
|
|
22891
23898
|
};
|
|
22892
23899
|
forwarderSupported: {
|
|
@@ -22922,6 +23929,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22922
23929
|
wallet: string;
|
|
22923
23930
|
minter: string;
|
|
22924
23931
|
depositForHandler?: string | undefined;
|
|
23932
|
+
genericExecutor?: string | undefined;
|
|
22925
23933
|
} | undefined;
|
|
22926
23934
|
};
|
|
22927
23935
|
forwarderSupported: {
|
|
@@ -22961,6 +23969,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22961
23969
|
wallet: string;
|
|
22962
23970
|
minter: string;
|
|
22963
23971
|
depositForHandler?: string | undefined;
|
|
23972
|
+
genericExecutor?: string | undefined;
|
|
22964
23973
|
} | undefined;
|
|
22965
23974
|
};
|
|
22966
23975
|
forwarderSupported: {
|
|
@@ -22996,6 +24005,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
22996
24005
|
wallet: string;
|
|
22997
24006
|
minter: string;
|
|
22998
24007
|
depositForHandler?: string | undefined;
|
|
24008
|
+
genericExecutor?: string | undefined;
|
|
22999
24009
|
} | undefined;
|
|
23000
24010
|
};
|
|
23001
24011
|
forwarderSupported: {
|
|
@@ -23035,6 +24045,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23035
24045
|
wallet: string;
|
|
23036
24046
|
minter: string;
|
|
23037
24047
|
depositForHandler?: string | undefined;
|
|
24048
|
+
genericExecutor?: string | undefined;
|
|
23038
24049
|
} | undefined;
|
|
23039
24050
|
};
|
|
23040
24051
|
forwarderSupported: {
|
|
@@ -23070,6 +24081,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23070
24081
|
wallet: string;
|
|
23071
24082
|
minter: string;
|
|
23072
24083
|
depositForHandler?: string | undefined;
|
|
24084
|
+
genericExecutor?: string | undefined;
|
|
23073
24085
|
} | undefined;
|
|
23074
24086
|
};
|
|
23075
24087
|
forwarderSupported: {
|
|
@@ -23089,15 +24101,28 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23089
24101
|
amount: z.ZodEffects<z.ZodPipeline<z.ZodString, z.ZodType<string, z.ZodTypeDef, string>>, string, string>;
|
|
23090
24102
|
maxFee: z.ZodEffects<z.ZodPipeline<z.ZodString, z.ZodType<string, z.ZodTypeDef, string>>, string, string>;
|
|
23091
24103
|
transferSpeed: z.ZodOptional<z.ZodEnum<["FAST", "SLOW"]>>;
|
|
23092
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
24104
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24105
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23093
24106
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23094
24107
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23095
24108
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23096
24109
|
}, "strict", z.ZodTypeAny, {
|
|
24110
|
+
apiKey?: string | undefined;
|
|
24111
|
+
kitKey?: string | undefined;
|
|
24112
|
+
baseUrl?: string | undefined;
|
|
24113
|
+
batchTransactions?: boolean | undefined;
|
|
24114
|
+
}, {
|
|
24115
|
+
apiKey?: string | undefined;
|
|
24116
|
+
kitKey?: string | undefined;
|
|
24117
|
+
baseUrl?: string | undefined;
|
|
24118
|
+
batchTransactions?: boolean | undefined;
|
|
24119
|
+
}>, {
|
|
24120
|
+
apiKey?: string | undefined;
|
|
23097
24121
|
kitKey?: string | undefined;
|
|
23098
24122
|
baseUrl?: string | undefined;
|
|
23099
24123
|
batchTransactions?: boolean | undefined;
|
|
23100
24124
|
}, {
|
|
24125
|
+
apiKey?: string | undefined;
|
|
23101
24126
|
kitKey?: string | undefined;
|
|
23102
24127
|
baseUrl?: string | undefined;
|
|
23103
24128
|
batchTransactions?: boolean | undefined;
|
|
@@ -23130,6 +24155,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23130
24155
|
wallet: string;
|
|
23131
24156
|
minter: string;
|
|
23132
24157
|
depositForHandler?: string | undefined;
|
|
24158
|
+
genericExecutor?: string | undefined;
|
|
23133
24159
|
} | undefined;
|
|
23134
24160
|
};
|
|
23135
24161
|
forwarderSupported: {
|
|
@@ -23165,6 +24191,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23165
24191
|
wallet: string;
|
|
23166
24192
|
minter: string;
|
|
23167
24193
|
depositForHandler?: string | undefined;
|
|
24194
|
+
genericExecutor?: string | undefined;
|
|
23168
24195
|
} | undefined;
|
|
23169
24196
|
};
|
|
23170
24197
|
forwarderSupported: {
|
|
@@ -23183,6 +24210,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23183
24210
|
vaultAddress: `0x${string}`;
|
|
23184
24211
|
from?: any;
|
|
23185
24212
|
config?: {
|
|
24213
|
+
apiKey?: string | undefined;
|
|
23186
24214
|
kitKey?: string | undefined;
|
|
23187
24215
|
baseUrl?: string | undefined;
|
|
23188
24216
|
batchTransactions?: boolean | undefined;
|
|
@@ -23216,6 +24244,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23216
24244
|
wallet: string;
|
|
23217
24245
|
minter: string;
|
|
23218
24246
|
depositForHandler?: string | undefined;
|
|
24247
|
+
genericExecutor?: string | undefined;
|
|
23219
24248
|
} | undefined;
|
|
23220
24249
|
};
|
|
23221
24250
|
forwarderSupported: {
|
|
@@ -23251,6 +24280,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23251
24280
|
wallet: string;
|
|
23252
24281
|
minter: string;
|
|
23253
24282
|
depositForHandler?: string | undefined;
|
|
24283
|
+
genericExecutor?: string | undefined;
|
|
23254
24284
|
} | undefined;
|
|
23255
24285
|
};
|
|
23256
24286
|
forwarderSupported: {
|
|
@@ -23269,6 +24299,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23269
24299
|
vaultAddress: string;
|
|
23270
24300
|
from?: any;
|
|
23271
24301
|
config?: {
|
|
24302
|
+
apiKey?: string | undefined;
|
|
23272
24303
|
kitKey?: string | undefined;
|
|
23273
24304
|
baseUrl?: string | undefined;
|
|
23274
24305
|
batchTransactions?: boolean | undefined;
|
|
@@ -23279,15 +24310,28 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23279
24310
|
to: z.ZodOptional<z.ZodUndefined>;
|
|
23280
24311
|
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
24312
|
amount: z.ZodEffects<z.ZodPipeline<z.ZodString, z.ZodType<string, z.ZodTypeDef, string>>, string, string>;
|
|
23282
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
24313
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24314
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23283
24315
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23284
24316
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23285
24317
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23286
24318
|
}, "strict", z.ZodTypeAny, {
|
|
24319
|
+
apiKey?: string | undefined;
|
|
24320
|
+
kitKey?: string | undefined;
|
|
24321
|
+
baseUrl?: string | undefined;
|
|
24322
|
+
batchTransactions?: boolean | undefined;
|
|
24323
|
+
}, {
|
|
24324
|
+
apiKey?: string | undefined;
|
|
24325
|
+
kitKey?: string | undefined;
|
|
24326
|
+
baseUrl?: string | undefined;
|
|
24327
|
+
batchTransactions?: boolean | undefined;
|
|
24328
|
+
}>, {
|
|
24329
|
+
apiKey?: string | undefined;
|
|
23287
24330
|
kitKey?: string | undefined;
|
|
23288
24331
|
baseUrl?: string | undefined;
|
|
23289
24332
|
batchTransactions?: boolean | undefined;
|
|
23290
24333
|
}, {
|
|
24334
|
+
apiKey?: string | undefined;
|
|
23291
24335
|
kitKey?: string | undefined;
|
|
23292
24336
|
baseUrl?: string | undefined;
|
|
23293
24337
|
batchTransactions?: boolean | undefined;
|
|
@@ -23298,6 +24342,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23298
24342
|
to?: undefined;
|
|
23299
24343
|
from?: any;
|
|
23300
24344
|
config?: {
|
|
24345
|
+
apiKey?: string | undefined;
|
|
23301
24346
|
kitKey?: string | undefined;
|
|
23302
24347
|
baseUrl?: string | undefined;
|
|
23303
24348
|
batchTransactions?: boolean | undefined;
|
|
@@ -23308,6 +24353,7 @@ declare const anyDepositParamsSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
23308
24353
|
to?: undefined;
|
|
23309
24354
|
from?: any;
|
|
23310
24355
|
config?: {
|
|
24356
|
+
apiKey?: string | undefined;
|
|
23311
24357
|
kitKey?: string | undefined;
|
|
23312
24358
|
baseUrl?: string | undefined;
|
|
23313
24359
|
batchTransactions?: boolean | undefined;
|
|
@@ -23334,15 +24380,28 @@ declare const depositParamsSchema: z.ZodObject<{
|
|
|
23334
24380
|
from: z.ZodType<any, z.ZodTypeDef, any>;
|
|
23335
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>;
|
|
23336
24382
|
amount: z.ZodEffects<z.ZodPipeline<z.ZodString, z.ZodType<string, z.ZodTypeDef, string>>, string, string>;
|
|
23337
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
24383
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24384
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23338
24385
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23339
24386
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23340
24387
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23341
24388
|
}, "strict", z.ZodTypeAny, {
|
|
24389
|
+
apiKey?: string | undefined;
|
|
24390
|
+
kitKey?: string | undefined;
|
|
24391
|
+
baseUrl?: string | undefined;
|
|
24392
|
+
batchTransactions?: boolean | undefined;
|
|
24393
|
+
}, {
|
|
24394
|
+
apiKey?: string | undefined;
|
|
24395
|
+
kitKey?: string | undefined;
|
|
24396
|
+
baseUrl?: string | undefined;
|
|
24397
|
+
batchTransactions?: boolean | undefined;
|
|
24398
|
+
}>, {
|
|
24399
|
+
apiKey?: string | undefined;
|
|
23342
24400
|
kitKey?: string | undefined;
|
|
23343
24401
|
baseUrl?: string | undefined;
|
|
23344
24402
|
batchTransactions?: boolean | undefined;
|
|
23345
24403
|
}, {
|
|
24404
|
+
apiKey?: string | undefined;
|
|
23346
24405
|
kitKey?: string | undefined;
|
|
23347
24406
|
baseUrl?: string | undefined;
|
|
23348
24407
|
batchTransactions?: boolean | undefined;
|
|
@@ -23352,6 +24411,7 @@ declare const depositParamsSchema: z.ZodObject<{
|
|
|
23352
24411
|
vaultAddress: `0x${string}`;
|
|
23353
24412
|
from?: any;
|
|
23354
24413
|
config?: {
|
|
24414
|
+
apiKey?: string | undefined;
|
|
23355
24415
|
kitKey?: string | undefined;
|
|
23356
24416
|
baseUrl?: string | undefined;
|
|
23357
24417
|
batchTransactions?: boolean | undefined;
|
|
@@ -23361,6 +24421,7 @@ declare const depositParamsSchema: z.ZodObject<{
|
|
|
23361
24421
|
vaultAddress: string;
|
|
23362
24422
|
from?: any;
|
|
23363
24423
|
config?: {
|
|
24424
|
+
apiKey?: string | undefined;
|
|
23364
24425
|
kitKey?: string | undefined;
|
|
23365
24426
|
baseUrl?: string | undefined;
|
|
23366
24427
|
batchTransactions?: boolean | undefined;
|
|
@@ -23380,15 +24441,28 @@ declare const depositParamsSchema: z.ZodObject<{
|
|
|
23380
24441
|
*/
|
|
23381
24442
|
declare const getCrossChainDepositStatusParamsSchema: z.ZodObject<{
|
|
23382
24443
|
execId: z.ZodString;
|
|
23383
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
24444
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24445
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23384
24446
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23385
24447
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23386
24448
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23387
24449
|
}, "strict", z.ZodTypeAny, {
|
|
24450
|
+
apiKey?: string | undefined;
|
|
24451
|
+
kitKey?: string | undefined;
|
|
24452
|
+
baseUrl?: string | undefined;
|
|
24453
|
+
batchTransactions?: boolean | undefined;
|
|
24454
|
+
}, {
|
|
24455
|
+
apiKey?: string | undefined;
|
|
24456
|
+
kitKey?: string | undefined;
|
|
24457
|
+
baseUrl?: string | undefined;
|
|
24458
|
+
batchTransactions?: boolean | undefined;
|
|
24459
|
+
}>, {
|
|
24460
|
+
apiKey?: string | undefined;
|
|
23388
24461
|
kitKey?: string | undefined;
|
|
23389
24462
|
baseUrl?: string | undefined;
|
|
23390
24463
|
batchTransactions?: boolean | undefined;
|
|
23391
24464
|
}, {
|
|
24465
|
+
apiKey?: string | undefined;
|
|
23392
24466
|
kitKey?: string | undefined;
|
|
23393
24467
|
baseUrl?: string | undefined;
|
|
23394
24468
|
batchTransactions?: boolean | undefined;
|
|
@@ -23396,6 +24470,7 @@ declare const getCrossChainDepositStatusParamsSchema: z.ZodObject<{
|
|
|
23396
24470
|
}, "strip", z.ZodTypeAny, {
|
|
23397
24471
|
execId: string;
|
|
23398
24472
|
config?: {
|
|
24473
|
+
apiKey?: string | undefined;
|
|
23399
24474
|
kitKey?: string | undefined;
|
|
23400
24475
|
baseUrl?: string | undefined;
|
|
23401
24476
|
batchTransactions?: boolean | undefined;
|
|
@@ -23403,6 +24478,7 @@ declare const getCrossChainDepositStatusParamsSchema: z.ZodObject<{
|
|
|
23403
24478
|
}, {
|
|
23404
24479
|
execId: string;
|
|
23405
24480
|
config?: {
|
|
24481
|
+
apiKey?: string | undefined;
|
|
23406
24482
|
kitKey?: string | undefined;
|
|
23407
24483
|
baseUrl?: string | undefined;
|
|
23408
24484
|
batchTransactions?: boolean | undefined;
|
|
@@ -23424,15 +24500,28 @@ declare const getCrossChainDepositStatusParamsSchema: z.ZodObject<{
|
|
|
23424
24500
|
*/
|
|
23425
24501
|
declare const waitForCrossChainDepositParamsSchema: z.ZodObject<{
|
|
23426
24502
|
execId: z.ZodString;
|
|
23427
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
24503
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24504
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23428
24505
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23429
24506
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23430
24507
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23431
24508
|
}, "strict", z.ZodTypeAny, {
|
|
24509
|
+
apiKey?: string | undefined;
|
|
23432
24510
|
kitKey?: string | undefined;
|
|
23433
24511
|
baseUrl?: string | undefined;
|
|
23434
24512
|
batchTransactions?: boolean | undefined;
|
|
23435
24513
|
}, {
|
|
24514
|
+
apiKey?: string | undefined;
|
|
24515
|
+
kitKey?: string | undefined;
|
|
24516
|
+
baseUrl?: string | undefined;
|
|
24517
|
+
batchTransactions?: boolean | undefined;
|
|
24518
|
+
}>, {
|
|
24519
|
+
apiKey?: string | undefined;
|
|
24520
|
+
kitKey?: string | undefined;
|
|
24521
|
+
baseUrl?: string | undefined;
|
|
24522
|
+
batchTransactions?: boolean | undefined;
|
|
24523
|
+
}, {
|
|
24524
|
+
apiKey?: string | undefined;
|
|
23436
24525
|
kitKey?: string | undefined;
|
|
23437
24526
|
baseUrl?: string | undefined;
|
|
23438
24527
|
batchTransactions?: boolean | undefined;
|
|
@@ -23443,6 +24532,7 @@ declare const waitForCrossChainDepositParamsSchema: z.ZodObject<{
|
|
|
23443
24532
|
}, "strip", z.ZodTypeAny, {
|
|
23444
24533
|
execId: string;
|
|
23445
24534
|
config?: {
|
|
24535
|
+
apiKey?: string | undefined;
|
|
23446
24536
|
kitKey?: string | undefined;
|
|
23447
24537
|
baseUrl?: string | undefined;
|
|
23448
24538
|
batchTransactions?: boolean | undefined;
|
|
@@ -23453,6 +24543,7 @@ declare const waitForCrossChainDepositParamsSchema: z.ZodObject<{
|
|
|
23453
24543
|
}, {
|
|
23454
24544
|
execId: string;
|
|
23455
24545
|
config?: {
|
|
24546
|
+
apiKey?: string | undefined;
|
|
23456
24547
|
kitKey?: string | undefined;
|
|
23457
24548
|
baseUrl?: string | undefined;
|
|
23458
24549
|
batchTransactions?: boolean | undefined;
|
|
@@ -23479,15 +24570,28 @@ declare const withdrawParamsSchema: z.ZodObject<{
|
|
|
23479
24570
|
from: z.ZodType<any, z.ZodTypeDef, any>;
|
|
23480
24571
|
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
24572
|
amount: z.ZodEffects<z.ZodPipeline<z.ZodString, z.ZodType<string, z.ZodTypeDef, string>>, string, string>;
|
|
23482
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
24573
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24574
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23483
24575
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23484
24576
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23485
24577
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23486
24578
|
}, "strict", z.ZodTypeAny, {
|
|
24579
|
+
apiKey?: string | undefined;
|
|
24580
|
+
kitKey?: string | undefined;
|
|
24581
|
+
baseUrl?: string | undefined;
|
|
24582
|
+
batchTransactions?: boolean | undefined;
|
|
24583
|
+
}, {
|
|
24584
|
+
apiKey?: string | undefined;
|
|
24585
|
+
kitKey?: string | undefined;
|
|
24586
|
+
baseUrl?: string | undefined;
|
|
24587
|
+
batchTransactions?: boolean | undefined;
|
|
24588
|
+
}>, {
|
|
24589
|
+
apiKey?: string | undefined;
|
|
23487
24590
|
kitKey?: string | undefined;
|
|
23488
24591
|
baseUrl?: string | undefined;
|
|
23489
24592
|
batchTransactions?: boolean | undefined;
|
|
23490
24593
|
}, {
|
|
24594
|
+
apiKey?: string | undefined;
|
|
23491
24595
|
kitKey?: string | undefined;
|
|
23492
24596
|
baseUrl?: string | undefined;
|
|
23493
24597
|
batchTransactions?: boolean | undefined;
|
|
@@ -23497,6 +24601,7 @@ declare const withdrawParamsSchema: z.ZodObject<{
|
|
|
23497
24601
|
vaultAddress: `0x${string}`;
|
|
23498
24602
|
from?: any;
|
|
23499
24603
|
config?: {
|
|
24604
|
+
apiKey?: string | undefined;
|
|
23500
24605
|
kitKey?: string | undefined;
|
|
23501
24606
|
baseUrl?: string | undefined;
|
|
23502
24607
|
batchTransactions?: boolean | undefined;
|
|
@@ -23506,6 +24611,7 @@ declare const withdrawParamsSchema: z.ZodObject<{
|
|
|
23506
24611
|
vaultAddress: string;
|
|
23507
24612
|
from?: any;
|
|
23508
24613
|
config?: {
|
|
24614
|
+
apiKey?: string | undefined;
|
|
23509
24615
|
kitKey?: string | undefined;
|
|
23510
24616
|
baseUrl?: string | undefined;
|
|
23511
24617
|
batchTransactions?: boolean | undefined;
|
|
@@ -23529,15 +24635,28 @@ declare const withdrawParamsSchema: z.ZodObject<{
|
|
|
23529
24635
|
declare const claimRewardsParamsSchema: z.ZodObject<{
|
|
23530
24636
|
from: z.ZodType<any, z.ZodTypeDef, any>;
|
|
23531
24637
|
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<{
|
|
24638
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24639
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23533
24640
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23534
24641
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23535
24642
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23536
24643
|
}, "strict", z.ZodTypeAny, {
|
|
24644
|
+
apiKey?: string | undefined;
|
|
24645
|
+
kitKey?: string | undefined;
|
|
24646
|
+
baseUrl?: string | undefined;
|
|
24647
|
+
batchTransactions?: boolean | undefined;
|
|
24648
|
+
}, {
|
|
24649
|
+
apiKey?: string | undefined;
|
|
24650
|
+
kitKey?: string | undefined;
|
|
24651
|
+
baseUrl?: string | undefined;
|
|
24652
|
+
batchTransactions?: boolean | undefined;
|
|
24653
|
+
}>, {
|
|
24654
|
+
apiKey?: string | undefined;
|
|
23537
24655
|
kitKey?: string | undefined;
|
|
23538
24656
|
baseUrl?: string | undefined;
|
|
23539
24657
|
batchTransactions?: boolean | undefined;
|
|
23540
24658
|
}, {
|
|
24659
|
+
apiKey?: string | undefined;
|
|
23541
24660
|
kitKey?: string | undefined;
|
|
23542
24661
|
baseUrl?: string | undefined;
|
|
23543
24662
|
batchTransactions?: boolean | undefined;
|
|
@@ -23546,6 +24665,7 @@ declare const claimRewardsParamsSchema: z.ZodObject<{
|
|
|
23546
24665
|
vaultAddress: `0x${string}`;
|
|
23547
24666
|
from?: any;
|
|
23548
24667
|
config?: {
|
|
24668
|
+
apiKey?: string | undefined;
|
|
23549
24669
|
kitKey?: string | undefined;
|
|
23550
24670
|
baseUrl?: string | undefined;
|
|
23551
24671
|
batchTransactions?: boolean | undefined;
|
|
@@ -23554,6 +24674,7 @@ declare const claimRewardsParamsSchema: z.ZodObject<{
|
|
|
23554
24674
|
vaultAddress: string;
|
|
23555
24675
|
from?: any;
|
|
23556
24676
|
config?: {
|
|
24677
|
+
apiKey?: string | undefined;
|
|
23557
24678
|
kitKey?: string | undefined;
|
|
23558
24679
|
baseUrl?: string | undefined;
|
|
23559
24680
|
batchTransactions?: boolean | undefined;
|
|
@@ -23603,15 +24724,28 @@ declare const getWithdrawalQuoteParamsSchema: z.ZodObject<{
|
|
|
23603
24724
|
from: z.ZodType<any, z.ZodTypeDef, any>;
|
|
23604
24725
|
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
24726
|
amount: z.ZodEffects<z.ZodPipeline<z.ZodString, z.ZodType<string, z.ZodTypeDef, string>>, string, string>;
|
|
23606
|
-
config: z.ZodOptional<z.ZodObject<{
|
|
24727
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24728
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23607
24729
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23608
24730
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23609
24731
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23610
24732
|
}, "strict", z.ZodTypeAny, {
|
|
24733
|
+
apiKey?: string | undefined;
|
|
24734
|
+
kitKey?: string | undefined;
|
|
24735
|
+
baseUrl?: string | undefined;
|
|
24736
|
+
batchTransactions?: boolean | undefined;
|
|
24737
|
+
}, {
|
|
24738
|
+
apiKey?: string | undefined;
|
|
24739
|
+
kitKey?: string | undefined;
|
|
24740
|
+
baseUrl?: string | undefined;
|
|
24741
|
+
batchTransactions?: boolean | undefined;
|
|
24742
|
+
}>, {
|
|
24743
|
+
apiKey?: string | undefined;
|
|
23611
24744
|
kitKey?: string | undefined;
|
|
23612
24745
|
baseUrl?: string | undefined;
|
|
23613
24746
|
batchTransactions?: boolean | undefined;
|
|
23614
24747
|
}, {
|
|
24748
|
+
apiKey?: string | undefined;
|
|
23615
24749
|
kitKey?: string | undefined;
|
|
23616
24750
|
baseUrl?: string | undefined;
|
|
23617
24751
|
batchTransactions?: boolean | undefined;
|
|
@@ -23621,6 +24755,7 @@ declare const getWithdrawalQuoteParamsSchema: z.ZodObject<{
|
|
|
23621
24755
|
vaultAddress: `0x${string}`;
|
|
23622
24756
|
from?: any;
|
|
23623
24757
|
config?: {
|
|
24758
|
+
apiKey?: string | undefined;
|
|
23624
24759
|
kitKey?: string | undefined;
|
|
23625
24760
|
baseUrl?: string | undefined;
|
|
23626
24761
|
batchTransactions?: boolean | undefined;
|
|
@@ -23630,6 +24765,7 @@ declare const getWithdrawalQuoteParamsSchema: z.ZodObject<{
|
|
|
23630
24765
|
vaultAddress: string;
|
|
23631
24766
|
from?: any;
|
|
23632
24767
|
config?: {
|
|
24768
|
+
apiKey?: string | undefined;
|
|
23633
24769
|
kitKey?: string | undefined;
|
|
23634
24770
|
baseUrl?: string | undefined;
|
|
23635
24771
|
batchTransactions?: boolean | undefined;
|
|
@@ -23653,15 +24789,28 @@ declare const getWithdrawalQuoteParamsSchema: z.ZodObject<{
|
|
|
23653
24789
|
declare const getClaimRewardsQuoteParamsSchema: z.ZodObject<{
|
|
23654
24790
|
from: z.ZodType<any, z.ZodTypeDef, any>;
|
|
23655
24791
|
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<{
|
|
24792
|
+
config: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
24793
|
+
apiKey: z.ZodOptional<z.ZodString>;
|
|
23657
24794
|
kitKey: z.ZodOptional<z.ZodString>;
|
|
23658
24795
|
baseUrl: z.ZodOptional<z.ZodString>;
|
|
23659
24796
|
batchTransactions: z.ZodOptional<z.ZodBoolean>;
|
|
23660
24797
|
}, "strict", z.ZodTypeAny, {
|
|
24798
|
+
apiKey?: string | undefined;
|
|
24799
|
+
kitKey?: string | undefined;
|
|
24800
|
+
baseUrl?: string | undefined;
|
|
24801
|
+
batchTransactions?: boolean | undefined;
|
|
24802
|
+
}, {
|
|
24803
|
+
apiKey?: string | undefined;
|
|
24804
|
+
kitKey?: string | undefined;
|
|
24805
|
+
baseUrl?: string | undefined;
|
|
24806
|
+
batchTransactions?: boolean | undefined;
|
|
24807
|
+
}>, {
|
|
24808
|
+
apiKey?: string | undefined;
|
|
23661
24809
|
kitKey?: string | undefined;
|
|
23662
24810
|
baseUrl?: string | undefined;
|
|
23663
24811
|
batchTransactions?: boolean | undefined;
|
|
23664
24812
|
}, {
|
|
24813
|
+
apiKey?: string | undefined;
|
|
23665
24814
|
kitKey?: string | undefined;
|
|
23666
24815
|
baseUrl?: string | undefined;
|
|
23667
24816
|
batchTransactions?: boolean | undefined;
|
|
@@ -23670,6 +24819,7 @@ declare const getClaimRewardsQuoteParamsSchema: z.ZodObject<{
|
|
|
23670
24819
|
vaultAddress: `0x${string}`;
|
|
23671
24820
|
from?: any;
|
|
23672
24821
|
config?: {
|
|
24822
|
+
apiKey?: string | undefined;
|
|
23673
24823
|
kitKey?: string | undefined;
|
|
23674
24824
|
baseUrl?: string | undefined;
|
|
23675
24825
|
batchTransactions?: boolean | undefined;
|
|
@@ -23678,6 +24828,7 @@ declare const getClaimRewardsQuoteParamsSchema: z.ZodObject<{
|
|
|
23678
24828
|
vaultAddress: string;
|
|
23679
24829
|
from?: any;
|
|
23680
24830
|
config?: {
|
|
24831
|
+
apiKey?: string | undefined;
|
|
23681
24832
|
kitKey?: string | undefined;
|
|
23682
24833
|
baseUrl?: string | undefined;
|
|
23683
24834
|
batchTransactions?: boolean | undefined;
|
|
@@ -24148,6 +25299,15 @@ interface SpendOptions {
|
|
|
24148
25299
|
* @internal
|
|
24149
25300
|
*/
|
|
24150
25301
|
onBroadcast?: (txHash: string) => void;
|
|
25302
|
+
/**
|
|
25303
|
+
* Partial polling config forwarded to every Gateway API request the spend
|
|
25304
|
+
* makes (estimate, transfer, forwarder status, and the balance lookups on
|
|
25305
|
+
* the auto-allocation path). The provider factory populates this from its
|
|
25306
|
+
* `headers` config so a configured header reaches all spend-path calls.
|
|
25307
|
+
*
|
|
25308
|
+
* @internal
|
|
25309
|
+
*/
|
|
25310
|
+
requestConfig?: Partial<ApiPollingConfig>;
|
|
24151
25311
|
}
|
|
24152
25312
|
/**
|
|
24153
25313
|
* Result returned after a successful spend (mint) operation.
|
|
@@ -24197,7 +25357,7 @@ interface SpendResult$1 {
|
|
|
24197
25357
|
* executed spend. Same shape as {@link EstimateSpendResult.fees}.
|
|
24198
25358
|
* Omitted when using `config.retry` (no estimate was run).
|
|
24199
25359
|
*/
|
|
24200
|
-
fees?: FeeEntry
|
|
25360
|
+
fees?: FeeEntry[];
|
|
24201
25361
|
/**
|
|
24202
25362
|
* Gateway transfer identifier. Present when `useForwarder` is enabled
|
|
24203
25363
|
* and can be used to query transfer status via `GET /v1/transfer/{id}`.
|
|
@@ -24220,91 +25380,17 @@ interface SpendResult$1 {
|
|
|
24220
25380
|
steps?: SpendStep[];
|
|
24221
25381
|
}
|
|
24222
25382
|
/**
|
|
24223
|
-
*
|
|
25383
|
+
* Cost estimation for a spend (mint) operation.
|
|
24224
25384
|
*
|
|
24225
|
-
*
|
|
24226
|
-
*
|
|
24227
|
-
*
|
|
24228
|
-
*
|
|
24229
|
-
|
|
24230
|
-
type FeeType$1 = 'provider' | 'gasFee' | 'kit' | 'forwarder';
|
|
24231
|
-
/**
|
|
24232
|
-
* Per-chain breakdown of a fee amount.
|
|
25385
|
+
* @remarks
|
|
25386
|
+
* Returned by the provider's `estimateSpend` method to give callers
|
|
25387
|
+
* visibility into the expected fees *before* executing a spend.
|
|
25388
|
+
* Each entry in `fees` represents a distinct fee category with its
|
|
25389
|
+
* per-chain allocation breakdown.
|
|
24233
25390
|
*
|
|
24234
25391
|
* @example
|
|
24235
25392
|
* ```typescript
|
|
24236
|
-
* import type {
|
|
24237
|
-
*
|
|
24238
|
-
* const allocation: FeeAllocation = {
|
|
24239
|
-
* chain: 'Ethereum',
|
|
24240
|
-
* amount: '0.00005',
|
|
24241
|
-
* }
|
|
24242
|
-
* ```
|
|
24243
|
-
*/
|
|
24244
|
-
interface FeeAllocation$1 {
|
|
24245
|
-
/** The chain to which this portion of the fee applies. */
|
|
24246
|
-
chain: Blockchain;
|
|
24247
|
-
/** The fee amount on this chain (human-readable decimal string). */
|
|
24248
|
-
amount: string;
|
|
24249
|
-
}
|
|
24250
|
-
/**
|
|
24251
|
-
* A single fee line item within an estimate.
|
|
24252
|
-
*
|
|
24253
|
-
* @remarks
|
|
24254
|
-
* Each entry describes a fee category (`type`), the token it is
|
|
24255
|
-
* denominated in, the aggregate `amount`, and an optional per-chain
|
|
24256
|
-
* `allocations` breakdown.
|
|
24257
|
-
*
|
|
24258
|
-
* @example
|
|
24259
|
-
* ```typescript
|
|
24260
|
-
* import type { FeeEntry } from '@circle-fin/provider-gateway-v1'
|
|
24261
|
-
*
|
|
24262
|
-
* // Fee with per-chain allocation breakdown
|
|
24263
|
-
* const providerFee: FeeEntry = {
|
|
24264
|
-
* type: 'provider',
|
|
24265
|
-
* token: 'USDC',
|
|
24266
|
-
* amount: '0.00011',
|
|
24267
|
-
* allocations: [
|
|
24268
|
-
* { chain: 'Ethereum', amount: '0.00005' },
|
|
24269
|
-
* { chain: 'Polygon', amount: '0.00006' },
|
|
24270
|
-
* ],
|
|
24271
|
-
* }
|
|
24272
|
-
*
|
|
24273
|
-
* // Flat fee without allocations (e.g. forwarder)
|
|
24274
|
-
* const forwarderFee: FeeEntry = {
|
|
24275
|
-
* type: 'forwarder',
|
|
24276
|
-
* token: 'USDC',
|
|
24277
|
-
* amount: '0.005',
|
|
24278
|
-
* }
|
|
24279
|
-
* ```
|
|
24280
|
-
*/
|
|
24281
|
-
interface FeeEntry$1 {
|
|
24282
|
-
/** The category of this fee. */
|
|
24283
|
-
type: FeeType$1;
|
|
24284
|
-
/** The token in which this fee is denominated (e.g. `'USDC'`, `'ETH'`). */
|
|
24285
|
-
token: string;
|
|
24286
|
-
/** Aggregate fee amount (human-readable decimal string). */
|
|
24287
|
-
amount: string;
|
|
24288
|
-
/** Per-chain breakdown of the fee. Omitted for flat fees (e.g. forwarder). */
|
|
24289
|
-
allocations?: FeeAllocation$1[];
|
|
24290
|
-
/**
|
|
24291
|
-
* When `type === 'kit'`, the address that receives the kit fee.
|
|
24292
|
-
* Omitted for other fee types.
|
|
24293
|
-
*/
|
|
24294
|
-
recipientAddress?: string;
|
|
24295
|
-
}
|
|
24296
|
-
/**
|
|
24297
|
-
* Cost estimation for a spend (mint) operation.
|
|
24298
|
-
*
|
|
24299
|
-
* @remarks
|
|
24300
|
-
* Returned by the provider's `estimateSpend` method to give callers
|
|
24301
|
-
* visibility into the expected fees *before* executing a spend.
|
|
24302
|
-
* Each entry in `fees` represents a distinct fee category with its
|
|
24303
|
-
* per-chain allocation breakdown.
|
|
24304
|
-
*
|
|
24305
|
-
* @example
|
|
24306
|
-
* ```typescript
|
|
24307
|
-
* import type { EstimateSpendResult } from '@circle-fin/provider-gateway-v1'
|
|
25393
|
+
* import type { EstimateSpendResult } from '@circle-fin/provider-gateway-v1'
|
|
24308
25394
|
*
|
|
24309
25395
|
* const estimate: EstimateSpendResult = {
|
|
24310
25396
|
* fees: [
|
|
@@ -24340,7 +25426,7 @@ interface FeeEntry$1 {
|
|
|
24340
25426
|
*/
|
|
24341
25427
|
interface EstimateSpendResult$1 {
|
|
24342
25428
|
/** Itemised fee breakdown for the spend operation. */
|
|
24343
|
-
fees: FeeEntry
|
|
25429
|
+
fees: FeeEntry[];
|
|
24344
25430
|
}
|
|
24345
25431
|
|
|
24346
25432
|
/**
|
|
@@ -25727,80 +26813,7 @@ type FeeRecipientChainType = 'evm' | 'solana';
|
|
|
25727
26813
|
* ```
|
|
25728
26814
|
*/
|
|
25729
26815
|
type FeeRecipientsConfig = Partial<Record<FeeRecipientChainType, string>>;
|
|
25730
|
-
|
|
25731
|
-
* Fee category describing the origin of a fee line item.
|
|
25732
|
-
*
|
|
25733
|
-
* - `'provider'` — Fee charged by the cross-chain provider (e.g. protocol fee).
|
|
25734
|
-
* - `'gasFee'` — On-chain gas cost denominated in the transfer token (e.g. USDC).
|
|
25735
|
-
* - `'kit'` — Fee charged by the kit / developer integration.
|
|
25736
|
-
* - `'forwarder'` — Fee charged by Circle's Forwarding Service for automatic mint.
|
|
25737
|
-
*/
|
|
25738
|
-
type FeeType = 'provider' | 'gasFee' | 'kit' | 'forwarder';
|
|
25739
|
-
/**
|
|
25740
|
-
* Per-chain breakdown of a fee amount.
|
|
25741
|
-
*
|
|
25742
|
-
* @example
|
|
25743
|
-
* ```typescript
|
|
25744
|
-
* import type { FeeAllocation } from '@circle-fin/unified-balance-kit'
|
|
25745
|
-
*
|
|
25746
|
-
* const allocation: FeeAllocation = {
|
|
25747
|
-
* chain: 'Ethereum',
|
|
25748
|
-
* amount: '0.00005',
|
|
25749
|
-
* }
|
|
25750
|
-
* ```
|
|
25751
|
-
*/
|
|
25752
|
-
interface FeeAllocation {
|
|
25753
|
-
/** The chain to which this portion of the fee applies. */
|
|
25754
|
-
chain: Blockchain;
|
|
25755
|
-
/** The fee amount on this chain (human-readable decimal string). */
|
|
25756
|
-
amount: string;
|
|
25757
|
-
}
|
|
25758
|
-
/**
|
|
25759
|
-
* A single fee line item within an estimate.
|
|
25760
|
-
*
|
|
25761
|
-
* @remarks
|
|
25762
|
-
* Each entry describes a fee category (`type`), the token it is
|
|
25763
|
-
* denominated in, the aggregate `amount`, and an optional per-chain
|
|
25764
|
-
* `allocations` breakdown.
|
|
25765
|
-
*
|
|
25766
|
-
* @example
|
|
25767
|
-
* ```typescript
|
|
25768
|
-
* import type { FeeEntry } from '@circle-fin/unified-balance-kit'
|
|
25769
|
-
*
|
|
25770
|
-
* // Fee with per-chain allocation breakdown
|
|
25771
|
-
* const providerFee: FeeEntry = {
|
|
25772
|
-
* type: 'provider',
|
|
25773
|
-
* token: 'USDC',
|
|
25774
|
-
* amount: '0.00011',
|
|
25775
|
-
* allocations: [
|
|
25776
|
-
* { chain: 'Ethereum', amount: '0.00005' },
|
|
25777
|
-
* { chain: 'Polygon', amount: '0.00006' },
|
|
25778
|
-
* ],
|
|
25779
|
-
* }
|
|
25780
|
-
*
|
|
25781
|
-
* // Flat fee without allocations (e.g. forwarder)
|
|
25782
|
-
* const forwarderFee: FeeEntry = {
|
|
25783
|
-
* type: 'forwarder',
|
|
25784
|
-
* token: 'USDC',
|
|
25785
|
-
* amount: '0.005',
|
|
25786
|
-
* }
|
|
25787
|
-
* ```
|
|
25788
|
-
*/
|
|
25789
|
-
interface FeeEntry {
|
|
25790
|
-
/** The category of this fee. */
|
|
25791
|
-
type: FeeType;
|
|
25792
|
-
/** The token in which this fee is denominated (e.g. `'USDC'`, `'ETH'`). */
|
|
25793
|
-
token: string;
|
|
25794
|
-
/** Aggregate fee amount (human-readable decimal string). */
|
|
25795
|
-
amount: string;
|
|
25796
|
-
/** Per-chain breakdown of the fee. Omitted for flat fees (e.g. forwarder). */
|
|
25797
|
-
allocations?: FeeAllocation[];
|
|
25798
|
-
/**
|
|
25799
|
-
* When `type === 'kit'`, the address that receives the kit fee.
|
|
25800
|
-
* Omitted for other fee types.
|
|
25801
|
-
*/
|
|
25802
|
-
recipientAddress?: string;
|
|
25803
|
-
}
|
|
26816
|
+
|
|
25804
26817
|
/**
|
|
25805
26818
|
* Cost estimation for a spend (mint) operation.
|
|
25806
26819
|
*
|
|
@@ -25979,6 +26992,26 @@ interface UnifiedBalanceKitConfig<TExtraProviders extends FlexibleGatewayProvide
|
|
|
25979
26992
|
* @defaultValue false
|
|
25980
26993
|
*/
|
|
25981
26994
|
excludeDefaultProviders?: boolean;
|
|
26995
|
+
/**
|
|
26996
|
+
* Custom HTTP headers forwarded with every Circle Gateway API request the
|
|
26997
|
+
* default Gateway v1 provider makes (balances, deposits, spend estimate,
|
|
26998
|
+
* transfer, forwarder status, and `/v1/info`).
|
|
26999
|
+
*
|
|
27000
|
+
* @remarks
|
|
27001
|
+
* Headers are merged on top of the SDK defaults (such as `Content-Type`)
|
|
27002
|
+
* rather than replacing them. Each header is forwarded as-is to Circle's
|
|
27003
|
+
* API; the SDK does not interpret it. Only applies to the default provider —
|
|
27004
|
+
* has no effect when `excludeDefaultProviders` is `true` or on custom
|
|
27005
|
+
* providers supplied via `providers`.
|
|
27006
|
+
*
|
|
27007
|
+
* @example
|
|
27008
|
+
* ```typescript
|
|
27009
|
+
* const kit = new UnifiedBalanceKit({
|
|
27010
|
+
* headers: { 'X-Access-Key': process.env.GATEWAY_ACCESS_KEY! },
|
|
27011
|
+
* })
|
|
27012
|
+
* ```
|
|
27013
|
+
*/
|
|
27014
|
+
headers?: Record<string, string>;
|
|
25982
27015
|
}
|
|
25983
27016
|
|
|
25984
27017
|
/**
|
|
@@ -26020,7 +27053,7 @@ type AllowanceStrategy = 'approve' | 'permit' | 'authorize';
|
|
|
26020
27053
|
* }
|
|
26021
27054
|
* ```
|
|
26022
27055
|
*/
|
|
26023
|
-
interface DepositParams<TAdapterCapabilities extends AdapterCapabilities = AdapterCapabilities, TChainIdentifier extends
|
|
27056
|
+
interface DepositParams<TAdapterCapabilities extends AdapterCapabilities = AdapterCapabilities, TChainIdentifier extends BridgeChainIdentifier = BridgeChainIdentifier> {
|
|
26024
27057
|
/**
|
|
26025
27058
|
* The adapter context identifying the depositor and chain.
|
|
26026
27059
|
*/
|
|
@@ -26033,7 +27066,7 @@ interface DepositParams<TAdapterCapabilities extends AdapterCapabilities = Adapt
|
|
|
26033
27066
|
amount: string;
|
|
26034
27067
|
/**
|
|
26035
27068
|
* The token to deposit.
|
|
26036
|
-
* Accepts any case (e.g. `'usdc'`, `'Usdc'`);
|
|
27069
|
+
* Accepts any case (e.g. `'usdc'`, `'Usdc'`); normalized to uppercase internally.
|
|
26037
27070
|
*
|
|
26038
27071
|
* @defaultValue 'USDC'
|
|
26039
27072
|
*/
|
|
@@ -26041,9 +27074,40 @@ interface DepositParams<TAdapterCapabilities extends AdapterCapabilities = Adapt
|
|
|
26041
27074
|
/**
|
|
26042
27075
|
* The token allowance strategy to authorize the deposit.
|
|
26043
27076
|
*
|
|
27077
|
+
* Only valid for same-chain (STANDARD) deposits. Must not be set when
|
|
27078
|
+
* `to` is provided (FAST cross-chain deposits do not use an allowance
|
|
27079
|
+
* strategy).
|
|
27080
|
+
*
|
|
26044
27081
|
* @defaultValue 'authorize'
|
|
26045
27082
|
*/
|
|
26046
27083
|
allowanceStrategy?: AllowanceStrategy;
|
|
27084
|
+
/**
|
|
27085
|
+
* Destination chain for a FAST cross-chain deposit.
|
|
27086
|
+
*
|
|
27087
|
+
* When set, the deposit follows the prepaid-FORWARD CCTP v2 path:
|
|
27088
|
+
* the burned USDC is minted to the GenericExecutor on the destination
|
|
27089
|
+
* chain, which then calls Gateway `deposit` in a single relayed flow.
|
|
27090
|
+
*
|
|
27091
|
+
* Must not be set when `config.transferSpeed` is `'STANDARD'`.
|
|
27092
|
+
*/
|
|
27093
|
+
to?: {
|
|
27094
|
+
chain: UnifiedBalanceChainIdentifier;
|
|
27095
|
+
};
|
|
27096
|
+
/**
|
|
27097
|
+
* Transfer configuration for the deposit.
|
|
27098
|
+
*
|
|
27099
|
+
* @defaultValue `{ transferSpeed: 'STANDARD' }`. Set `transferSpeed: 'FAST'`
|
|
27100
|
+
* explicitly for cross-chain deposits (when `to` is provided).
|
|
27101
|
+
*/
|
|
27102
|
+
config?: DepositConfig;
|
|
27103
|
+
/**
|
|
27104
|
+
* Opaque signed fee-quote bytes from the Quote API.
|
|
27105
|
+
*
|
|
27106
|
+
* Pass this to commit to the fee price returned by a previous
|
|
27107
|
+
* {@link estimateDeposit} call (see {@link EstimateDepositResult.quote}).
|
|
27108
|
+
* When omitted a fresh quote is fetched automatically (FAST path only).
|
|
27109
|
+
*/
|
|
27110
|
+
quote?: string;
|
|
26047
27111
|
}
|
|
26048
27112
|
/**
|
|
26049
27113
|
* Parameters for depositing tokens into *another* Gateway account.
|
|
@@ -26070,7 +27134,7 @@ interface DepositParams<TAdapterCapabilities extends AdapterCapabilities = Adapt
|
|
|
26070
27134
|
* }
|
|
26071
27135
|
* ```
|
|
26072
27136
|
*/
|
|
26073
|
-
interface DepositForParams<TAdapterCapabilities extends AdapterCapabilities = AdapterCapabilities, TChainIdentifier extends
|
|
27137
|
+
interface DepositForParams<TAdapterCapabilities extends AdapterCapabilities = AdapterCapabilities, TChainIdentifier extends BridgeChainIdentifier = BridgeChainIdentifier> extends Omit<DepositParams<TAdapterCapabilities, TChainIdentifier>, 'allowanceStrategy'> {
|
|
26074
27138
|
/**
|
|
26075
27139
|
* The Gateway account address to credit with the deposit.
|
|
26076
27140
|
*
|
|
@@ -26079,6 +27143,34 @@ interface DepositForParams<TAdapterCapabilities extends AdapterCapabilities = Ad
|
|
|
26079
27143
|
*/
|
|
26080
27144
|
depositAccount: string;
|
|
26081
27145
|
}
|
|
27146
|
+
/**
|
|
27147
|
+
* Relay progress for a cross-chain (FAST) deposit.
|
|
27148
|
+
*
|
|
27149
|
+
* Set after `depositFastCrossChain` completes the ~60-second relay wait.
|
|
27150
|
+
* Always present on the FAST path; absent on same-chain STANDARD deposits.
|
|
27151
|
+
*
|
|
27152
|
+
* @example
|
|
27153
|
+
* ```typescript
|
|
27154
|
+
* if (result.progress?.status === 'DONE') {
|
|
27155
|
+
* console.log('Minted on destination:', result.txHash)
|
|
27156
|
+
* } else if (result.progress?.status === 'PENDING') {
|
|
27157
|
+
* console.log('Relay still in progress — poll getDepositStatus later')
|
|
27158
|
+
* } else if (result.progress?.status === 'FAILED') {
|
|
27159
|
+
* console.log('Relay failed — manual mint may be required')
|
|
27160
|
+
* }
|
|
27161
|
+
* ```
|
|
27162
|
+
*/
|
|
27163
|
+
interface DepositProgress {
|
|
27164
|
+
/**
|
|
27165
|
+
* Relay outcome after the burn is confirmed on the source chain.
|
|
27166
|
+
*
|
|
27167
|
+
* - `'DONE'` — Circle's relayer minted USDC on the destination chain.
|
|
27168
|
+
* - `'PENDING'` — Relay timed out (~60 s); the mint may still complete.
|
|
27169
|
+
* - `'FAILED'` — Relayer reported a permanent failure; manual mint may
|
|
27170
|
+
* be required.
|
|
27171
|
+
*/
|
|
27172
|
+
status: 'DONE' | 'PENDING' | 'FAILED';
|
|
27173
|
+
}
|
|
26082
27174
|
/**
|
|
26083
27175
|
* Result returned after a successful deposit operation.
|
|
26084
27176
|
*
|
|
@@ -26108,22 +27200,232 @@ interface DepositResult {
|
|
|
26108
27200
|
depositedTo: string;
|
|
26109
27201
|
/** The address that signed and funded the deposit. */
|
|
26110
27202
|
depositedBy: string;
|
|
26111
|
-
/**
|
|
27203
|
+
/**
|
|
27204
|
+
* The chain where the deposit balance lands.
|
|
27205
|
+
*
|
|
27206
|
+
* @remarks For cross-chain (FAST) deposits this is the destination chain
|
|
27207
|
+
* where the minted USDC is credited. For same-chain (STANDARD) deposits it
|
|
27208
|
+
* is the chain the deposit occurred on. Prefer `sourceChain` /
|
|
27209
|
+
* `destinationChain` for cross-chain flows.
|
|
27210
|
+
*/
|
|
26112
27211
|
chain: Blockchain;
|
|
26113
27212
|
/**
|
|
26114
|
-
*
|
|
26115
|
-
*
|
|
27213
|
+
* Transaction hash of the completed deposit.
|
|
27214
|
+
*
|
|
27215
|
+
* @remarks
|
|
27216
|
+
* For same-chain (STANDARD) deposits this is the on-chain deposit
|
|
27217
|
+
* transaction. For cross-chain (FAST) deposits with
|
|
27218
|
+
* `progress.status === 'DONE'` this is the Circle-relayed mint on the
|
|
27219
|
+
* destination chain; when the relay is still pending or has failed it
|
|
27220
|
+
* falls back to the source-chain burn hash.
|
|
26116
27221
|
*/
|
|
26117
27222
|
txHash: string;
|
|
26118
27223
|
/**
|
|
26119
|
-
* Link to view the transaction
|
|
26120
|
-
* blockchain explorer.
|
|
27224
|
+
* Link to view the transaction on a block explorer.
|
|
26121
27225
|
*
|
|
26122
27226
|
* @remarks
|
|
26123
|
-
*
|
|
26124
|
-
* for the chain.
|
|
27227
|
+
* Follows the same chain as {@link txHash}: points to the destination-chain
|
|
27228
|
+
* mint for a completed FAST deposit, or the source-chain burn otherwise.
|
|
27229
|
+
* May be `undefined` when the chain has no configured explorer URL.
|
|
26125
27230
|
*/
|
|
26126
27231
|
explorerUrl?: string;
|
|
27232
|
+
/**
|
|
27233
|
+
* Source chain of the cross-chain deposit (FAST path only).
|
|
27234
|
+
*
|
|
27235
|
+
* Present when `to` was specified in the deposit params.
|
|
27236
|
+
*/
|
|
27237
|
+
sourceChain?: Blockchain;
|
|
27238
|
+
/**
|
|
27239
|
+
* Destination chain of the cross-chain deposit (FAST path only).
|
|
27240
|
+
*
|
|
27241
|
+
* Present when `to` was specified in the deposit params.
|
|
27242
|
+
*/
|
|
27243
|
+
destinationChain?: Blockchain;
|
|
27244
|
+
/**
|
|
27245
|
+
* Itemised fee breakdown for the cross-chain deposit (FAST path only).
|
|
27246
|
+
*
|
|
27247
|
+
* Contains at least a `gasFee` entry and a `forwarder` entry (Circle
|
|
27248
|
+
* FORWARD fee). The `gasFee` covers the source-chain burn gas; when a
|
|
27249
|
+
* `usdc.approve` was required it also includes the actual on-chain approve
|
|
27250
|
+
* gas derived from the transaction receipt.
|
|
27251
|
+
*/
|
|
27252
|
+
fees?: FeeEntry[];
|
|
27253
|
+
/**
|
|
27254
|
+
* Relay progress after the source-chain burn (FAST path only).
|
|
27255
|
+
*
|
|
27256
|
+
* Present on every FAST deposit result. Use this to determine whether
|
|
27257
|
+
* the destination-chain mint completed within the ~60-second relay window.
|
|
27258
|
+
*/
|
|
27259
|
+
progress?: DepositProgress;
|
|
27260
|
+
}
|
|
27261
|
+
/**
|
|
27262
|
+
* Transfer-speed configuration for a deposit operation.
|
|
27263
|
+
*
|
|
27264
|
+
* @example
|
|
27265
|
+
* ```typescript
|
|
27266
|
+
* import type { DepositConfig } from '@circle-fin/unified-balance-kit'
|
|
27267
|
+
*
|
|
27268
|
+
* const config: DepositConfig = { transferSpeed: 'FAST' }
|
|
27269
|
+
* ```
|
|
27270
|
+
*/
|
|
27271
|
+
interface DepositConfig {
|
|
27272
|
+
/**
|
|
27273
|
+
* Requested transfer speed for a cross-chain fast deposit.
|
|
27274
|
+
*
|
|
27275
|
+
* @defaultValue `'STANDARD'`
|
|
27276
|
+
*/
|
|
27277
|
+
transferSpeed?: 'FAST' | 'STANDARD';
|
|
27278
|
+
}
|
|
27279
|
+
/**
|
|
27280
|
+
* Parameters for estimating the fees of a fast cross-chain deposit.
|
|
27281
|
+
*
|
|
27282
|
+
* The result is plain, serializable data — no live adapter reference is
|
|
27283
|
+
* included. Pass the result (plus `from`) directly to
|
|
27284
|
+
* {@link DepositParams} or {@link DepositForParams} for execution:
|
|
27285
|
+
*
|
|
27286
|
+
* ```typescript
|
|
27287
|
+
* const estimate = await kit.estimateDeposit({ from, amount, token, to })
|
|
27288
|
+
* const result = await kit.deposit({ ...estimate, from })
|
|
27289
|
+
* ```
|
|
27290
|
+
*
|
|
27291
|
+
* @typeParam TAdapterCapabilities - Adapter capability constraints.
|
|
27292
|
+
* @typeParam TChainIdentifier - Accepted chain identifier type.
|
|
27293
|
+
*
|
|
27294
|
+
* @example
|
|
27295
|
+
* ```typescript
|
|
27296
|
+
* import type { EstimateDepositParams } from '@circle-fin/unified-balance-kit'
|
|
27297
|
+
*
|
|
27298
|
+
* const params: EstimateDepositParams = {
|
|
27299
|
+
* from: { adapter: evmAdapter, chain: 'Ethereum' },
|
|
27300
|
+
* amount: '100',
|
|
27301
|
+
* to: { chain: 'Arc_Testnet' },
|
|
27302
|
+
* config: { transferSpeed: 'FAST' },
|
|
27303
|
+
* }
|
|
27304
|
+
* ```
|
|
27305
|
+
*/
|
|
27306
|
+
interface EstimateDepositParams<TAdapterCapabilities extends AdapterCapabilities = AdapterCapabilities, TChainIdentifier extends BridgeChainIdentifier = BridgeChainIdentifier> {
|
|
27307
|
+
/**
|
|
27308
|
+
* The adapter context identifying the depositor and source chain.
|
|
27309
|
+
* The adapter is used for source-chain gas estimation.
|
|
27310
|
+
*/
|
|
27311
|
+
from: AdapterContext<TAdapterCapabilities, TChainIdentifier>;
|
|
27312
|
+
/**
|
|
27313
|
+
* The amount of tokens to deposit (human-readable decimal string).
|
|
27314
|
+
*
|
|
27315
|
+
* @example "100", "0.5"
|
|
27316
|
+
*/
|
|
27317
|
+
amount: string;
|
|
27318
|
+
/**
|
|
27319
|
+
* The token to deposit.
|
|
27320
|
+
*
|
|
27321
|
+
* @defaultValue 'USDC'
|
|
27322
|
+
*/
|
|
27323
|
+
token?: SupportedTokenInput;
|
|
27324
|
+
/**
|
|
27325
|
+
* Destination chain for a FAST cross-chain deposit.
|
|
27326
|
+
*
|
|
27327
|
+
* Required when `config.transferSpeed` is `'FAST'`.
|
|
27328
|
+
* Must not be set when `config.transferSpeed` is `'STANDARD'` (the default).
|
|
27329
|
+
*/
|
|
27330
|
+
to?: {
|
|
27331
|
+
chain: UnifiedBalanceChainIdentifier;
|
|
27332
|
+
};
|
|
27333
|
+
/**
|
|
27334
|
+
* Transfer configuration.
|
|
27335
|
+
*
|
|
27336
|
+
* @defaultValue `{ transferSpeed: 'STANDARD' }`
|
|
27337
|
+
*/
|
|
27338
|
+
config?: DepositConfig;
|
|
27339
|
+
/**
|
|
27340
|
+
* Gateway account address to credit (for a `depositFor` round-trip).
|
|
27341
|
+
*
|
|
27342
|
+
* When provided, this value is echoed on the result so
|
|
27343
|
+
* `kit.depositFor({ ...estimate, from })` works without re-specifying it.
|
|
27344
|
+
*/
|
|
27345
|
+
depositAccount?: string;
|
|
27346
|
+
/**
|
|
27347
|
+
* Allowance strategy echoed to the result for round-trip convenience.
|
|
27348
|
+
*/
|
|
27349
|
+
allowanceStrategy?: AllowanceStrategy;
|
|
27350
|
+
}
|
|
27351
|
+
/**
|
|
27352
|
+
* Fee-preview result returned by `estimateDeposit`.
|
|
27353
|
+
*
|
|
27354
|
+
* Plain, serializable data — no live adapter reference. Pass the result
|
|
27355
|
+
* directly to `deposit` or `depositFor` (re-attaching only `from`):
|
|
27356
|
+
*
|
|
27357
|
+
* ```typescript
|
|
27358
|
+
* const estimate = await kit.estimateDeposit({ from, amount, token, to })
|
|
27359
|
+
* const result = await kit.deposit({ ...estimate, from })
|
|
27360
|
+
* ```
|
|
27361
|
+
*
|
|
27362
|
+
* @example
|
|
27363
|
+
* ```typescript
|
|
27364
|
+
* import type { EstimateDepositResult } from '@circle-fin/unified-balance-kit'
|
|
27365
|
+
*
|
|
27366
|
+
* const result: EstimateDepositResult = {
|
|
27367
|
+
* amount: '100',
|
|
27368
|
+
* token: 'USDC',
|
|
27369
|
+
* to: { chain: 'Arc_Testnet' },
|
|
27370
|
+
* config: { transferSpeed: 'FAST' },
|
|
27371
|
+
* fees: [
|
|
27372
|
+
* { type: 'gasFee', token: 'ETH', amount: '0.0002' },
|
|
27373
|
+
* { type: 'forwarder', token: 'USDC', amount: '0.12' },
|
|
27374
|
+
* ],
|
|
27375
|
+
* quote: '0x…',
|
|
27376
|
+
* }
|
|
27377
|
+
* ```
|
|
27378
|
+
*/
|
|
27379
|
+
interface EstimateDepositResult {
|
|
27380
|
+
/** Deposit amount (human-readable decimal string). */
|
|
27381
|
+
amount: string;
|
|
27382
|
+
/** Normalized token to deposit. */
|
|
27383
|
+
token: SupportedToken;
|
|
27384
|
+
/**
|
|
27385
|
+
* Destination chain (echoed from input).
|
|
27386
|
+
*
|
|
27387
|
+
* Present for FAST transfers; absent for STANDARD.
|
|
27388
|
+
*/
|
|
27389
|
+
to?: {
|
|
27390
|
+
chain: UnifiedBalanceChainIdentifier;
|
|
27391
|
+
};
|
|
27392
|
+
/** Transfer configuration (echoed with defaults applied). */
|
|
27393
|
+
config: Required<DepositConfig>;
|
|
27394
|
+
/**
|
|
27395
|
+
* Itemized fee breakdown.
|
|
27396
|
+
*
|
|
27397
|
+
* Always contains at least a `gasFee` entry. For FAST transfers the gas
|
|
27398
|
+
* cost includes the source-chain burn; when the current USDC allowance is
|
|
27399
|
+
* insufficient it also includes the `usdc.approve` transaction. For
|
|
27400
|
+
* STANDARD deposits on EVM with `allowanceStrategy: 'approve'`, or any
|
|
27401
|
+
* `depositFor` on EVM, the gas cost includes both the
|
|
27402
|
+
* `usdc.increaseAllowance` and the deposit transaction. A `forwarder`
|
|
27403
|
+
* entry is always present for FAST cross-chain transfers.
|
|
27404
|
+
*/
|
|
27405
|
+
fees: FeeEntry[];
|
|
27406
|
+
/**
|
|
27407
|
+
* Opaque signed fee-quote bytes from the Quote API.
|
|
27408
|
+
*
|
|
27409
|
+
* Present for FAST cross-chain deposits; absent for STANDARD or
|
|
27410
|
+
* same-chain. Pass this to {@link deposit} or {@link depositFor} to
|
|
27411
|
+
* commit to the quoted price.
|
|
27412
|
+
*/
|
|
27413
|
+
quote?: string;
|
|
27414
|
+
/**
|
|
27415
|
+
* Gateway account to credit (echoed from input for `depositFor` round-trip).
|
|
27416
|
+
*/
|
|
27417
|
+
depositAccount?: string;
|
|
27418
|
+
/**
|
|
27419
|
+
* Allowance strategy (echoed from input for `deposit` round-trip).
|
|
27420
|
+
*/
|
|
27421
|
+
allowanceStrategy?: AllowanceStrategy;
|
|
27422
|
+
/**
|
|
27423
|
+
* Optional USD exchange-rate metadata from the Quote API.
|
|
27424
|
+
*
|
|
27425
|
+
* Present when the Quote API returns exchange rates for the fee token
|
|
27426
|
+
* and destination token. Non-binding; useful for USD-denominated display.
|
|
27427
|
+
*/
|
|
27428
|
+
exchangeRates?: FeeQuoteExchangeRates;
|
|
26127
27429
|
}
|
|
26128
27430
|
|
|
26129
27431
|
/**
|
|
@@ -26778,6 +28080,17 @@ type FeeOperationType = 'bridge' | 'swap';
|
|
|
26778
28080
|
* proper parameter validation based on the selected operation.
|
|
26779
28081
|
*/
|
|
26780
28082
|
type OperationType = FeeOperationType | 'earn' | 'unifiedBalance';
|
|
28083
|
+
/**
|
|
28084
|
+
* Options for filtering chains supported by AppKit bridge operations.
|
|
28085
|
+
*
|
|
28086
|
+
* @example
|
|
28087
|
+
* ```typescript
|
|
28088
|
+
* const sourceFeeChains = kit.getSupportedChains('bridge', {
|
|
28089
|
+
* sourceFeeSupported: true,
|
|
28090
|
+
* })
|
|
28091
|
+
* ```
|
|
28092
|
+
*/
|
|
28093
|
+
type BridgeSupportedChainsOptions = GetSupportedChainsOptions$1;
|
|
26781
28094
|
/**
|
|
26782
28095
|
* Maps operation types to their corresponding parameter interfaces.
|
|
26783
28096
|
*
|
|
@@ -26981,13 +28294,18 @@ interface AppKitContext {
|
|
|
26981
28294
|
*/
|
|
26982
28295
|
disableErrorReporting?: boolean;
|
|
26983
28296
|
/**
|
|
26984
|
-
* Custom HTTP headers forwarded with
|
|
26985
|
-
* attestation (Iris)
|
|
28297
|
+
* Custom HTTP headers forwarded with Circle API requests made by the
|
|
28298
|
+
* underlying kits: the CCTP provider's attestation (Iris) requests for
|
|
28299
|
+
* bridge operations, and the Gateway API requests for unified-balance
|
|
28300
|
+
* operations.
|
|
26986
28301
|
*
|
|
26987
28302
|
* @remarks
|
|
26988
28303
|
* 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.
|
|
28304
|
+
* rather than replacing them. Each header is forwarded as-is to Circle's API;
|
|
28305
|
+
* the SDK does not interpret it. The same map is forwarded to every relevant
|
|
28306
|
+
* kit, so a header a given API ignores is simply a no-op there. A
|
|
28307
|
+
* `unifiedBalance.headers` value, if provided, takes precedence for the
|
|
28308
|
+
* unified-balance kit.
|
|
26991
28309
|
*/
|
|
26992
28310
|
headers?: Record<string, string>;
|
|
26993
28311
|
}
|
|
@@ -27592,6 +28910,35 @@ declare class AppKitUnifiedBalance {
|
|
|
27592
28910
|
* ```
|
|
27593
28911
|
*/
|
|
27594
28912
|
depositFor(params: DepositForParams): Promise<DepositResult>;
|
|
28913
|
+
/**
|
|
28914
|
+
* Estimate the fees for a deposit without executing it.
|
|
28915
|
+
*
|
|
28916
|
+
* Return plain, serializable data that can be spread directly into
|
|
28917
|
+
* {@link AppKitUnifiedBalance.deposit} or
|
|
28918
|
+
* {@link AppKitUnifiedBalance.depositFor}.
|
|
28919
|
+
*
|
|
28920
|
+
* @param params - Estimate details including the depositor context, amount,
|
|
28921
|
+
* destination chain, and optional transfer speed.
|
|
28922
|
+
* @returns Promise resolving to the itemised fee estimate.
|
|
28923
|
+
* @throws {KitError} If the estimate parameters are invalid or the route is
|
|
28924
|
+
* unsupported.
|
|
28925
|
+
*
|
|
28926
|
+
* @example
|
|
28927
|
+
* ```typescript
|
|
28928
|
+
* const estimate = await kit.unifiedBalance.estimateDeposit({
|
|
28929
|
+
* from: { adapter, chain: 'Ethereum' },
|
|
28930
|
+
* amount: '100',
|
|
28931
|
+
* to: { chain: 'Polygon' },
|
|
28932
|
+
* config: { transferSpeed: 'FAST' },
|
|
28933
|
+
* })
|
|
28934
|
+
*
|
|
28935
|
+
* const result = await kit.unifiedBalance.deposit({
|
|
28936
|
+
* ...estimate,
|
|
28937
|
+
* from: { adapter, chain: 'Ethereum' },
|
|
28938
|
+
* })
|
|
28939
|
+
* ```
|
|
28940
|
+
*/
|
|
28941
|
+
estimateDeposit(params: EstimateDepositParams): Promise<EstimateDepositResult>;
|
|
27595
28942
|
/**
|
|
27596
28943
|
* Spend (mint) USDC on a destination chain by pulling funds from one or
|
|
27597
28944
|
* more account sources.
|
|
@@ -28068,6 +29415,11 @@ declare class AppKit {
|
|
|
28068
29415
|
* console.log('Estimated fees:', estimate.fees)
|
|
28069
29416
|
* ```
|
|
28070
29417
|
*/
|
|
29418
|
+
estimateBridge(params: BridgeParams & {
|
|
29419
|
+
config: {
|
|
29420
|
+
feePayment: 'source';
|
|
29421
|
+
};
|
|
29422
|
+
}): Promise<ReceiveExactEstimateResult>;
|
|
28071
29423
|
estimateBridge(params: BridgeParams): Promise<EstimateResult$1>;
|
|
28072
29424
|
/**
|
|
28073
29425
|
* Execute a send operation for known token aliases (USDC, USDT, NATIVE) or custom ERC-20/SPL tokens.
|
|
@@ -28180,7 +29532,7 @@ declare class AppKit {
|
|
|
28180
29532
|
* config: {
|
|
28181
29533
|
* slippageBps: 300, // 3% slippage
|
|
28182
29534
|
* allowanceStrategy: 'permit',
|
|
28183
|
-
*
|
|
29535
|
+
* apiKey: 'TEST_API_KEY:id:secret'
|
|
28184
29536
|
* }
|
|
28185
29537
|
* })
|
|
28186
29538
|
*
|
|
@@ -28208,7 +29560,7 @@ declare class AppKit {
|
|
|
28208
29560
|
* amountIn: '100.50',
|
|
28209
29561
|
* config: {
|
|
28210
29562
|
* slippageBps: 300,
|
|
28211
|
-
*
|
|
29563
|
+
* apiKey: 'TEST_API_KEY:id:secret'
|
|
28212
29564
|
* }
|
|
28213
29565
|
* })
|
|
28214
29566
|
*
|
|
@@ -28231,7 +29583,7 @@ declare class AppKit {
|
|
|
28231
29583
|
* not write the polling loop yourself.
|
|
28232
29584
|
*
|
|
28233
29585
|
* @param params - `txHash` and `chainIn`, plus optional `chainOut` and
|
|
28234
|
-
* `
|
|
29586
|
+
* `apiKey`.
|
|
28235
29587
|
* @returns A snapshot of the swap's status at the time of the call.
|
|
28236
29588
|
* @throws \{KitError\} If `chainIn` or `chainOut` is malformed.
|
|
28237
29589
|
*
|
|
@@ -28244,7 +29596,7 @@ declare class AppKit {
|
|
|
28244
29596
|
* txHash: result.txHash,
|
|
28245
29597
|
* chainIn: result.chainIn,
|
|
28246
29598
|
* chainOut: result.chainOut,
|
|
28247
|
-
*
|
|
29599
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
28248
29600
|
* })
|
|
28249
29601
|
*
|
|
28250
29602
|
* console.log(status.progress.status, status.progress.substatus)
|
|
@@ -28257,7 +29609,7 @@ declare class AppKit {
|
|
|
28257
29609
|
* txHash: result.txHash,
|
|
28258
29610
|
* chainIn: result.chainIn,
|
|
28259
29611
|
* chainOut: result.chainOut,
|
|
28260
|
-
*
|
|
29612
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
28261
29613
|
* })
|
|
28262
29614
|
* while (status.progress.status === 'PENDING') {
|
|
28263
29615
|
* await new Promise((r) => setTimeout(r, 3_000))
|
|
@@ -28265,7 +29617,7 @@ declare class AppKit {
|
|
|
28265
29617
|
* txHash: result.txHash,
|
|
28266
29618
|
* chainIn: result.chainIn,
|
|
28267
29619
|
* chainOut: result.chainOut,
|
|
28268
|
-
*
|
|
29620
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
28269
29621
|
* })
|
|
28270
29622
|
* }
|
|
28271
29623
|
* ```
|
|
@@ -28283,7 +29635,7 @@ declare class AppKit {
|
|
|
28283
29635
|
* expires. Timeouts surface as a RETRYABLE `KitError` so callers can
|
|
28284
29636
|
* re-invoke with the same `txHash`.
|
|
28285
29637
|
*
|
|
28286
|
-
* @param params - Wait configuration: identifiers,
|
|
29638
|
+
* @param params - Wait configuration: identifiers, API key, and optional
|
|
28287
29639
|
* `timeoutMs` / `onProgress`.
|
|
28288
29640
|
* @returns The first terminal {@link SwapStatusResult} observed.
|
|
28289
29641
|
* @throws \{KitError\} (`NETWORK.TIMEOUT`, RETRYABLE) when the wait
|
|
@@ -28296,7 +29648,7 @@ declare class AppKit {
|
|
|
28296
29648
|
*
|
|
28297
29649
|
* const final = await kit.waitForSwap({
|
|
28298
29650
|
* result,
|
|
28299
|
-
*
|
|
29651
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
28300
29652
|
* onProgress: (snap) => console.log(snap.progress.status),
|
|
28301
29653
|
* })
|
|
28302
29654
|
*
|
|
@@ -28312,7 +29664,7 @@ declare class AppKit {
|
|
|
28312
29664
|
* txHash: persisted.txHash,
|
|
28313
29665
|
* chainIn: persisted.chainIn,
|
|
28314
29666
|
* chainOut: persisted.chainOut,
|
|
28315
|
-
*
|
|
29667
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
28316
29668
|
* })
|
|
28317
29669
|
* ```
|
|
28318
29670
|
*/
|
|
@@ -28343,7 +29695,7 @@ declare class AppKit {
|
|
|
28343
29695
|
* translates to the chain's native sentinel address — `0xEee…` for EVM,
|
|
28344
29696
|
* `1111…` for Solana — before querying the service.
|
|
28345
29697
|
*
|
|
28346
|
-
* @param params - `chain`, plus optional `tokens` and `
|
|
29698
|
+
* @param params - `chain`, plus optional `tokens` and `apiKey`.
|
|
28347
29699
|
* @returns A nested map of `[chain][address] → { priceUSD, fetchedAt }`.
|
|
28348
29700
|
* @throws \{KitError\} If `chain` is malformed, `tokens` exceeds 100
|
|
28349
29701
|
* entries, or any entry is neither a registered symbol nor a
|
|
@@ -28354,7 +29706,7 @@ declare class AppKit {
|
|
|
28354
29706
|
* const { rates } = await kit.getTokenRates({
|
|
28355
29707
|
* chain: 'Ethereum',
|
|
28356
29708
|
* tokens: ['USDC', 'EURC'],
|
|
28357
|
-
*
|
|
29709
|
+
* apiKey: process.env.CIRCLE_API_KEY,
|
|
28358
29710
|
* })
|
|
28359
29711
|
*
|
|
28360
29712
|
* const usdc = rates['Ethereum']?.['0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48']
|
|
@@ -28370,7 +29722,9 @@ declare class AppKit {
|
|
|
28370
29722
|
* operation (bridge, swap, earn, or unified balance).
|
|
28371
29723
|
*
|
|
28372
29724
|
* @param operationType - Optional operation type to filter chains ('bridge' | 'swap' | 'earn' | 'unifiedBalance')
|
|
29725
|
+
* @param options - Optional Bridge Kit chain filters when `operationType` is `'bridge'`.
|
|
28373
29726
|
* @returns Array of unique chain definitions supporting the specified operation(s)
|
|
29727
|
+
* @throws \{ValidationError\} If bridge filter options are invalid or used with another operation.
|
|
28374
29728
|
*
|
|
28375
29729
|
* @example Get all supported chains
|
|
28376
29730
|
* ```typescript
|
|
@@ -28392,8 +29746,17 @@ declare class AppKit {
|
|
|
28392
29746
|
*
|
|
28393
29747
|
* console.log('Chains supporting bridge:', bridgeChains.map(c => c.name))
|
|
28394
29748
|
* ```
|
|
29749
|
+
*
|
|
29750
|
+
* @example Get chains that support source-paid bridge fees
|
|
29751
|
+
* ```typescript
|
|
29752
|
+
* const kit = new AppKit()
|
|
29753
|
+
* const sourceFeeChains = kit.getSupportedChains('bridge', {
|
|
29754
|
+
* sourceFeeSupported: true,
|
|
29755
|
+
* })
|
|
29756
|
+
* ```
|
|
28395
29757
|
*/
|
|
28396
|
-
getSupportedChains(operationType?:
|
|
29758
|
+
getSupportedChains(operationType: 'bridge', options?: BridgeSupportedChainsOptions): ChainDefinition[];
|
|
29759
|
+
getSupportedChains(operationType?: Exclude<OperationType, 'bridge'>): ChainDefinition[];
|
|
28397
29760
|
/**
|
|
28398
29761
|
* Set operation-scoped custom fee policies.
|
|
28399
29762
|
*
|
|
@@ -28637,4 +30000,4 @@ declare function isTokenAddress(token: string, chain: ChainDefinition): token is
|
|
|
28637
30000
|
declare function validateToken(token: string, chain: ChainDefinition): TokenValidationResult;
|
|
28638
30001
|
|
|
28639
30002
|
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 };
|
|
30003
|
+
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 };
|