@circle-fin/app-kit 1.13.0 → 1.15.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.
Files changed (53) hide show
  1. package/CHANGELOG.md +122 -0
  2. package/README.md +3 -3
  3. package/bridge.cjs +8388 -515
  4. package/bridge.d.cts +640 -61
  5. package/bridge.d.mts +640 -61
  6. package/bridge.d.ts +640 -61
  7. package/bridge.mjs +8389 -516
  8. package/chains.cjs +275 -15
  9. package/chains.d.cts +117 -2
  10. package/chains.d.mts +117 -2
  11. package/chains.d.ts +117 -2
  12. package/chains.mjs +275 -16
  13. package/context.d.cts +577 -57
  14. package/context.d.mts +577 -57
  15. package/context.d.ts +577 -57
  16. package/earn.cjs +973 -271
  17. package/earn.d.cts +577 -57
  18. package/earn.d.mts +577 -57
  19. package/earn.d.ts +577 -57
  20. package/earn.mjs +919 -221
  21. package/estimateBridge.cjs +8388 -518
  22. package/estimateBridge.d.cts +704 -82
  23. package/estimateBridge.d.mts +704 -82
  24. package/estimateBridge.d.ts +704 -82
  25. package/estimateBridge.mjs +8390 -520
  26. package/estimateSwap.cjs +982 -237
  27. package/estimateSwap.d.cts +577 -57
  28. package/estimateSwap.d.mts +577 -57
  29. package/estimateSwap.d.ts +577 -57
  30. package/estimateSwap.mjs +981 -237
  31. package/index.cjs +21401 -8522
  32. package/index.d.cts +6045 -2149
  33. package/index.d.mts +6045 -2149
  34. package/index.d.ts +6045 -2149
  35. package/index.mjs +21401 -8524
  36. package/package.json +17 -6
  37. package/server.cjs +10040 -0
  38. package/server.cjs.map +1 -0
  39. package/server.d.cts +2467 -0
  40. package/server.d.mts +2467 -0
  41. package/server.d.ts +2467 -0
  42. package/server.mjs +10028 -0
  43. package/server.mjs.map +1 -0
  44. package/swap.cjs +982 -237
  45. package/swap.d.cts +577 -57
  46. package/swap.d.mts +577 -57
  47. package/swap.d.ts +577 -57
  48. package/swap.mjs +981 -237
  49. package/unifiedBalance.cjs +20510 -7599
  50. package/unifiedBalance.d.cts +807 -201
  51. package/unifiedBalance.d.mts +807 -201
  52. package/unifiedBalance.d.ts +807 -201
  53. package/unifiedBalance.mjs +20513 -7603
@@ -167,6 +167,30 @@ interface BaseChainDefinition {
167
167
  * ```
168
168
  */
169
169
  kitContracts?: KitContracts;
170
+ /**
171
+ * Optional CCTPx configuration.
172
+ *
173
+ * @description When provided, the chain supports CCTPx (Cross-Chain Token Service).
174
+ * CCTPx is a service-level protocol layered on top of CCTP v2's message-passing layer
175
+ * that enables cross-chain transfers of registered tokens (Circle-issued or otherwise).
176
+ *
177
+ * The CCTS contract is deployed via CREATE3 so its address is deterministic and may
178
+ * be committed to chain config ahead of the on-chain deployment.
179
+ *
180
+ * Use the {@link isCCTPXSupported} type guard to check if a chain has CCTPx support
181
+ * before accessing this property.
182
+ *
183
+ * @example
184
+ * ```typescript
185
+ * if (isCCTPXSupported(chain)) {
186
+ * console.log('CCTS address:', chain.cctpx.serviceAddress)
187
+ * }
188
+ * ```
189
+ *
190
+ * @see {@link CCTPXChainConfig} for the structure of CCTPx configuration.
191
+ * @see {@link isCCTPXSupported} for checking CCTPx support.
192
+ */
193
+ cctpx?: CCTPXChainConfig;
170
194
  /**
171
195
  * Optional Gateway contract configuration for Gateway protocol support.
172
196
  *
@@ -486,6 +510,34 @@ interface CCTPConfig {
486
510
  destination: boolean;
487
511
  };
488
512
  }
513
+ /**
514
+ * Configuration for Circle's Cross-Chain Token Service (CCTS) — the CCTPx protocol.
515
+ *
516
+ * @category Types
517
+ *
518
+ * @description Contains the CCTS proxy contract address on a given chain. The CCTS
519
+ * contract is the service-level entry point for CCTPx cross-chain transfers of
520
+ * registered tokens (Circle-issued or otherwise). Addresses are deterministic via CREATE3
521
+ * and may be committed to chain config ahead of the on-chain deploy.
522
+ *
523
+ * @example
524
+ * ```typescript
525
+ * const cctpxConfig: CCTPXChainConfig = {
526
+ * serviceAddress: '0x1234567890abcdef1234567890abcdef12345678'
527
+ * }
528
+ * ```
529
+ */
530
+ interface CCTPXChainConfig {
531
+ /**
532
+ * The CrossChainTokenService (CCTS) proxy contract address on this chain.
533
+ *
534
+ * @description Deterministic CREATE3 address. Used by the SDK as the `to` field
535
+ * when calling `crossChainTransfer` and `resolveTokenManager`.
536
+ *
537
+ * @example "0x1234567890abcdef1234567890abcdef12345678"
538
+ */
539
+ serviceAddress: string;
540
+ }
489
541
  /**
490
542
  * Available kit contract types for enhanced chain functionality.
491
543
  *
@@ -559,6 +611,19 @@ interface GatewayV1Contracts {
559
611
  * @example "0xD05E7D2E7d30b92c5F17d7d0fC575fce231F1A48"
560
612
  */
561
613
  depositForHandler?: string;
614
+ /**
615
+ * The address of the `GenericExecutor` contract.
616
+ *
617
+ * @description Optional. The contract that acts as `mintRecipient` and
618
+ * `destinationCaller` for the CCTP v2 prepaid FORWARD path. It receives the
619
+ * CCTP mint and calls {@link GatewayV1Contracts.depositForHandler} to
620
+ * complete the fast deposit into the {@link GatewayV1Contracts.wallet}.
621
+ * Present only on chains that are fast-deposit destinations; other Gateway
622
+ * chains omit it.
623
+ *
624
+ * @example "0xFa7be2f04F3Ad4ca969260729c6d45B5625984A7"
625
+ */
626
+ genericExecutor?: string;
562
627
  }
563
628
  /**
564
629
  * Versioned map of Gateway contract configurations.
@@ -679,9 +744,10 @@ declare enum Blockchain {
679
744
  Algorand_Testnet = "Algorand_Testnet",
680
745
  Aptos = "Aptos",
681
746
  Aptos_Testnet = "Aptos_Testnet",
682
- Arc_Testnet = "Arc_Testnet",
683
747
  Arbitrum = "Arbitrum",
684
748
  Arbitrum_Sepolia = "Arbitrum_Sepolia",
749
+ Arc = "Arc",
750
+ Arc_Testnet = "Arc_Testnet",
685
751
  Avalanche = "Avalanche",
686
752
  Avalanche_Fuji = "Avalanche_Fuji",
687
753
  Base = "Base",
@@ -860,6 +926,7 @@ declare enum SwapChain {
860
926
  XDC = "XDC",
861
927
  HyperEVM = "HyperEVM",
862
928
  Monad = "Monad",
929
+ Arc = "Arc",
863
930
  Arc_Testnet = "Arc_Testnet"
864
931
  }
865
932
  /**
@@ -873,7 +940,7 @@ declare enum SwapChain {
873
940
  * Use `isSwapSupportedChain()` for runtime validation.
874
941
  */
875
942
  type SwapChainDefinition = ChainDefinition & {
876
- chain: Blockchain.Ethereum | Blockchain.Base | Blockchain.Polygon | Blockchain.Solana | Blockchain.Arbitrum | Blockchain.Optimism | Blockchain.Avalanche | Blockchain.Linea | Blockchain.Ink | Blockchain.World_Chain | Blockchain.Unichain | Blockchain.Plume | Blockchain.Sei | Blockchain.Sonic | Blockchain.XDC | Blockchain.HyperEVM | Blockchain.Monad | Blockchain.Arc_Testnet;
943
+ chain: Blockchain.Ethereum | Blockchain.Base | Blockchain.Polygon | Blockchain.Solana | Blockchain.Arbitrum | Blockchain.Optimism | Blockchain.Avalanche | Blockchain.Linea | Blockchain.Ink | Blockchain.World_Chain | Blockchain.Unichain | Blockchain.Plume | Blockchain.Sei | Blockchain.Sonic | Blockchain.XDC | Blockchain.HyperEVM | Blockchain.Monad | Blockchain.Arc | Blockchain.Arc_Testnet;
877
944
  };
878
945
  /**
879
946
  * Chain identifier accepted by swap operations.
@@ -934,6 +1001,7 @@ type SwapChainIdentifier = SwapChainDefinition | SwapChain | `${SwapChain}`;
934
1001
  */
935
1002
  declare enum BridgeChain {
936
1003
  Arbitrum = "Arbitrum",
1004
+ Arc = "Arc",
937
1005
  Avalanche = "Avalanche",
938
1006
  Base = "Base",
939
1007
  Codex = "Codex",
@@ -1030,6 +1098,7 @@ type BridgeChainIdentifier = ChainDefinition | BridgeChain | `${BridgeChain}`;
1030
1098
  * ```
1031
1099
  */
1032
1100
  declare enum EarnChain {
1101
+ Arc = "Arc",
1033
1102
  Arc_Testnet = "Arc_Testnet"
1034
1103
  }
1035
1104
  /**
@@ -1063,7 +1132,7 @@ type EarnChainIdentifier = EarnChainDefinition | EarnChain | `${EarnChain}`;
1063
1132
  * console.log(EARN_BRIDGE_SOURCE_BLOCKCHAINS.join(', '))
1064
1133
  * ```
1065
1134
  */
1066
- declare const EARN_BRIDGE_SOURCE_BLOCKCHAINS: readonly [Blockchain.Arbitrum_Sepolia, Blockchain.Base_Sepolia, Blockchain.Ethereum_Sepolia];
1135
+ declare const EARN_BRIDGE_SOURCE_BLOCKCHAINS: readonly [Blockchain.Arbitrum, Blockchain.Arbitrum_Sepolia, Blockchain.Base, Blockchain.Base_Sepolia, Blockchain.Ethereum, Blockchain.Ethereum_Sepolia];
1067
1136
  /**
1068
1137
  * Blockchains supported as the source chain for cross-chain Earn deposits.
1069
1138
  *
@@ -1103,13 +1172,13 @@ type EarnBridgeSourceChainIdentifier = EarnBridgeSourceChainDefinition | EarnBri
1103
1172
  * console.log(EARN_BRIDGE_DESTINATION_BLOCKCHAINS.join(', '))
1104
1173
  * ```
1105
1174
  */
1106
- declare const EARN_BRIDGE_DESTINATION_BLOCKCHAINS: readonly [Blockchain.Arc_Testnet];
1175
+ declare const EARN_BRIDGE_DESTINATION_BLOCKCHAINS: readonly [Blockchain.Arc, Blockchain.Arc_Testnet];
1107
1176
  /**
1108
1177
  * Blockchains supported as the destination (vault) chain for cross-chain Earn
1109
1178
  * deposits.
1110
1179
  *
1111
1180
  * Intentionally narrower than {@link EarnChain}: cross-chain deposits
1112
- * currently land only on Arc Testnet.
1181
+ * land on Arc (mainnet) or Arc Testnet.
1113
1182
  */
1114
1183
  type EarnBridgeDestinationBlockchain = (typeof EARN_BRIDGE_DESTINATION_BLOCKCHAINS)[number];
1115
1184
  /**
@@ -1122,13 +1191,13 @@ type EarnBridgeDestinationChainDefinition = ChainDefinition & {
1122
1191
  };
1123
1192
  /**
1124
1193
  * Chain identifier accepted for the destination (vault) side of a cross-chain
1125
- * Earn deposit. Constrains the destination to Arc Testnet.
1194
+ * Earn deposit. Constrains the destination to Arc or Arc Testnet.
1126
1195
  *
1127
1196
  * @example
1128
1197
  * ```typescript
1129
1198
  * import type { EarnBridgeDestinationChainIdentifier } from '@core/chains'
1130
1199
  *
1131
- * const destination: EarnBridgeDestinationChainIdentifier = 'Arc_Testnet'
1200
+ * const destination: EarnBridgeDestinationChainIdentifier = 'Arc'
1132
1201
  * ```
1133
1202
  */
1134
1203
  type EarnBridgeDestinationChainIdentifier = EarnBridgeDestinationChainDefinition | EarnBridgeDestinationBlockchain | `${EarnBridgeDestinationBlockchain}`;
@@ -2345,6 +2414,171 @@ interface CCTPActionMap {
2345
2414
  readonly v2: CCTPv2ActionMap;
2346
2415
  }
2347
2416
 
2417
+ /**
2418
+ * Action map for Circle's CCTPx protocol operations.
2419
+ *
2420
+ * Define the parameter schemas for CCTPx actions that enable cross-chain transfers
2421
+ * of registered tokens (Circle-issued or otherwise) through Circle's `CrossChainTokenService`
2422
+ * (CCTS) contract.
2423
+ *
2424
+ * @remarks
2425
+ * CCTPx is a service-level protocol layered on top of CCTP v2's message-passing layer.
2426
+ * The CCTS contract coordinates token locking/burning, fee collection, and cross-chain
2427
+ * message dispatch. The SDK obtains a signed fee quote from IRIS, then calls
2428
+ * `crossChainTransfer` on CCTS with the quote bytes verbatim and the native fee as
2429
+ * `msg.value`. The auto-relay flow handled by Circle's Orbit relayer (paid for via the
2430
+ * `FORWARD` fee component included in the signed quote) means no separate
2431
+ * `receiveMessage` step is required on the destination.
2432
+ *
2433
+ * USDC and EURC bridging continues to use CCTP v2 (`cctp.v2.*`) actions, not CCTPx.
2434
+ *
2435
+ * @example
2436
+ * ```typescript
2437
+ * import type { ActionPayload } from '@core/adapter'
2438
+ *
2439
+ * const transferParams: ActionPayload<'cctpx.crossChainTransfer'> = {
2440
+ * tokenId: '0xabc123...',
2441
+ * amount: 1_000_000n,
2442
+ * destinationDomain: 1,
2443
+ * destinationAddress: '0xRecipient',
2444
+ * destinationCaller: '0x0000000000000000000000000000000000000000000000000000000000000000',
2445
+ * minFinalityThreshold: 1000,
2446
+ * claim: { signedQuote: '0xdeadbeef...', refundAddress: '0xSenderEOA...' },
2447
+ * autoExecuteHookData: false,
2448
+ * hookData: '0x',
2449
+ * serviceAddress: '0xCCTSProxy...',
2450
+ * nativeFeeAmount: 100_000n,
2451
+ * fromChain,
2452
+ * }
2453
+ * ```
2454
+ */
2455
+ interface CCTPXActionMap {
2456
+ /**
2457
+ * Initiate a CCTPx cross-chain transfer through the `CrossChainTokenService` contract.
2458
+ *
2459
+ * Encode and submit a `crossChainTransfer(...)` call to the CCTS proxy on the source
2460
+ * chain, passing the IRIS-signed fee quote bytes verbatim and the native fee as
2461
+ * `msg.value`. The contract emits CCTP v2's `MessageSent` event, which IRIS attests
2462
+ * to before Circle's Orbit relayer auto-executes the destination mint.
2463
+ *
2464
+ * @remarks
2465
+ * The caller (typically `CCTPXBridgingProvider`) is responsible for:
2466
+ * - Resolving `tokenId` and the per-chain `tokenAddress` from the IRIS token registry
2467
+ * - Approving the per-token `TokenManager` for `amount` before this call
2468
+ * - Fetching `claim.signedQuote` and computing `nativeFeeAmount` from IRIS
2469
+ *
2470
+ * This action only encodes and submits the on-chain call; it does not perform any
2471
+ * off-chain orchestration.
2472
+ */
2473
+ crossChainTransfer: ActionParameters & {
2474
+ /**
2475
+ * The CCTPx tokenId for the asset being transferred.
2476
+ *
2477
+ * Provided as a 32-byte hex string assigned by CCTPx at registration time.
2478
+ * The same `tokenId` is used across all chains for a given token; per-chain
2479
+ * `tokenAddress` is resolved from the IRIS token registry separately.
2480
+ */
2481
+ tokenId: string;
2482
+ /**
2483
+ * Amount of the token to transfer, in the token's smallest units.
2484
+ */
2485
+ amount: bigint;
2486
+ /**
2487
+ * CCTP domain identifier of the destination chain.
2488
+ *
2489
+ * CCTPx reuses CCTP v2 domain numbering; pass `dstChain.cctp.domain`.
2490
+ */
2491
+ destinationDomain: number;
2492
+ /**
2493
+ * Recipient address on the destination chain, encoded as bytes.
2494
+ *
2495
+ * For EVM destinations this is a 20-byte address encoded as a hex string.
2496
+ */
2497
+ destinationAddress: string;
2498
+ /**
2499
+ * `bytes32` value restricting which address may execute on the destination.
2500
+ *
2501
+ * Omit (or pass the 32-byte zero hash) to allow permissionless relay — the
2502
+ * default for auto-relayed CCTPx transfers. When omitted, the handler
2503
+ * substitutes the zero hash.
2504
+ *
2505
+ * @defaultValue `ZERO_HASH` — permissionless relay
2506
+ */
2507
+ destinationCaller?: string;
2508
+ /**
2509
+ * Minimum finality threshold for attestation eligibility.
2510
+ *
2511
+ * Use `1000` for FAST transfers (pre-finality) or `2000` for SLOW transfers
2512
+ * (full finality). For FAST, the `claim.signedQuote` must include a
2513
+ * `PRE_FINALITY` item; otherwise the on-chain call reverts.
2514
+ */
2515
+ minFinalityThreshold: number;
2516
+ /**
2517
+ * The CCTS fee-quote claim — maps 1:1 to the on-chain
2518
+ * `IFeeManager.QuoteClaim` tuple.
2519
+ *
2520
+ * The contract requires a tuple here, not a flat bytes blob. Encoding the
2521
+ * signed quote without the tuple wrapper produces a different function
2522
+ * selector and the call will revert.
2523
+ */
2524
+ claim: {
2525
+ /**
2526
+ * IRIS-signed fee quote bytes, passed verbatim to the contract.
2527
+ *
2528
+ * Obtained from `POST /v1/quote/cctpx/{tokenId}/{src}/{dst}`. Contains the
2529
+ * version-prefixed ABI-encoded `Quote` struct and Circle's signature; the
2530
+ * `FeeManager` contract validates the signature against the quote items.
2531
+ */
2532
+ signedQuote: string;
2533
+ /**
2534
+ * Address that receives any native-fee refund from `FeeManager`.
2535
+ *
2536
+ * Forwarded verbatim to `FeeManager` for refund attribution. The contract
2537
+ * accepts `address(0)` (the zero address) to disable refunds, so omitting
2538
+ * this field is safe; the handler will substitute the zero address.
2539
+ *
2540
+ * @defaultValue `ZERO_ADDRESS` — refunds disabled
2541
+ */
2542
+ refundAddress?: string;
2543
+ };
2544
+ /**
2545
+ * Whether the destination chain should auto-execute the hook data.
2546
+ *
2547
+ * For basic transfers this is `false`. Reserved for advanced integrations
2548
+ * that bundle a post-mint hook on the destination.
2549
+ */
2550
+ autoExecuteHookData: boolean;
2551
+ /**
2552
+ * Optional hook data bytes passed through to the destination handler.
2553
+ *
2554
+ * Pass `'0x'` (empty bytes) for basic transfers.
2555
+ */
2556
+ hookData: string;
2557
+ /**
2558
+ * The `CrossChainTokenService` proxy address on the source chain.
2559
+ *
2560
+ * Used as the transaction `to` field. Typically sourced from
2561
+ * `srcChain.cctpx.serviceAddress` — but is passed as an explicit parameter
2562
+ * so the action does not depend on chain-config narrowing at the call site.
2563
+ */
2564
+ serviceAddress: string;
2565
+ /**
2566
+ * Native gas amount to send as `msg.value`.
2567
+ *
2568
+ * Must exactly equal `sum(quote.items[].amount)` when `feeToken` is the
2569
+ * native currency (the P0 default). The contract verifies the value against
2570
+ * the signed quote; do not over-send.
2571
+ */
2572
+ nativeFeeAmount: bigint;
2573
+ /**
2574
+ * Source chain definition.
2575
+ *
2576
+ * Provides the adapter with chain context (chainId, RPC, etc.) for the call.
2577
+ */
2578
+ fromChain: ChainDefinition;
2579
+ };
2580
+ }
2581
+
2348
2582
  /**
2349
2583
  * Permit signature standards for gasless token approvals.
2350
2584
  *
@@ -3440,6 +3674,8 @@ interface NativeActionMap {
3440
3674
  interface ActionMap {
3441
3675
  /** CCTP-specific operations with automatic address resolution. */
3442
3676
  readonly cctp: CCTPActionMap;
3677
+ /** CCTPx operations (CrossChainTokenService) for cross-chain transfers of registered tokens (Circle-issued or otherwise). */
3678
+ readonly cctpx: CCTPXActionMap;
3443
3679
  /** Gateway Wallet operations, versioned (e.g. gateway.v1.deposit). */
3444
3680
  readonly gateway: GatewayActionMap;
3445
3681
  /** Native token operations (ETH, SOL, MATIC, etc.). */
@@ -4564,29 +4800,15 @@ interface TokenSymbolRegistry {
4564
4800
  */
4565
4801
  type TokenSymbol = keyof TokenSymbolRegistry extends never ? string : LiteralUnion<Extract<keyof TokenSymbolRegistry, string>>;
4566
4802
  /**
4567
- * Selector for identifying a token.
4803
+ * Token selector accepted by adapters and the static
4804
+ * {@link TokenRegistry.resolve} method.
4568
4805
  *
4569
4806
  * @remarks
4570
- * Can be one of:
4571
- * - A symbol string (e.g., "USDC") - resolves from registry
4572
- * - A raw locator object with explicit decimals - for arbitrary tokens
4573
- *
4574
- * Using a symbol is preferred when the token is in the registry, as it
4575
- * automatically resolves decimals and the correct chain address.
4576
- *
4577
- * @example
4578
- * ```typescript
4579
- * // By symbol (preferred for known tokens)
4580
- * const selector1: TokenSelector = 'USDC'
4581
- *
4582
- * // By raw locator (for arbitrary tokens)
4583
- * const selector2: TokenSelector = {
4584
- * locator: '0x1234...',
4585
- * decimals: 18,
4586
- * }
4587
- * ```
4807
+ * Keep this alias at adapter and registry boundaries so their accepted token
4808
+ * forms remain explicit even when other product surfaces define narrower
4809
+ * token inputs.
4588
4810
  */
4589
- type TokenSelector = TokenSymbol | RawTokenSelector;
4811
+ type RegistryTokenSelector = TokenSymbol | RawTokenSelector;
4590
4812
  /**
4591
4813
  * The resolved token information after registry lookup.
4592
4814
  *
@@ -4636,12 +4858,12 @@ interface TokenRegistry {
4636
4858
  /**
4637
4859
  * Resolve a token selector to concrete token information for a chain.
4638
4860
  *
4639
- * @param selector - The token to resolve (symbol or raw locator).
4861
+ * @param selector - The token to resolve. Accepts a symbol or raw locator.
4640
4862
  * @param chainId - The chain identifier to resolve for.
4641
4863
  * @returns The resolved token information.
4642
4864
  * @throws When the token cannot be resolved (unknown symbol, missing decimals, etc.).
4643
4865
  */
4644
- resolve(selector: TokenSelector, chainId: ChainIdentifier): ResolvedToken;
4866
+ resolve(selector: RegistryTokenSelector, chainId: ChainIdentifier): ResolvedToken;
4645
4867
  /**
4646
4868
  * Resolve a token by chain-specific locator (address/program ID).
4647
4869
  *
@@ -5463,6 +5685,55 @@ TChainDefinition extends ChainDefinition = ChainDefinition> extends WalletContex
5463
5685
  * Must be a valid address format for the specified blockchain.
5464
5686
  */
5465
5687
  recipientAddress?: string;
5688
+ /**
5689
+ * Whether Circle's relayer submits the destination transaction.
5690
+ *
5691
+ * How an omitted value resolves, and whether an explicit `false` is accepted,
5692
+ * is provider-specific.
5693
+ */
5694
+ useForwarder?: boolean;
5695
+ /**
5696
+ * Optional destination dApp deposit action for a fast cross-chain transfer.
5697
+ *
5698
+ * When set, the burned USDC is minted to Circle's GenericExecutor on the
5699
+ * destination chain, which calls the registered dApp (for example, a Gateway
5700
+ * `depositFor`) in the same relayed flow. Consumed by the CCTP v2 provider's
5701
+ * executor-deposit path; requires `useForwarder: true`.
5702
+ *
5703
+ * @see {@link BridgeDepositAction}
5704
+ */
5705
+ deposit?: BridgeDepositAction;
5706
+ }
5707
+ /**
5708
+ * Destination dApp deposit action for a fast cross-chain transfer.
5709
+ *
5710
+ * When present on a bridge destination, the CCTP v2 provider routes the
5711
+ * transfer through Circle's GenericExecutor: the burned USDC is minted to the
5712
+ * executor on the destination chain, which then calls the registered dApp (for
5713
+ * example, a Gateway `depositFor`) in the same relayed flow. Encoded into
5714
+ * executor hookData via `buildDepositForGenericExecutorPayload`.
5715
+ *
5716
+ * @example
5717
+ * ```typescript
5718
+ * import type { BridgeDepositAction } from '@core/provider'
5719
+ *
5720
+ * const deposit: BridgeDepositAction = {
5721
+ * dappId: 'gateway_deposit',
5722
+ * params: ['0xTokenMessengerWithFees', '0xDepositAccount', 0n],
5723
+ * }
5724
+ * ```
5725
+ */
5726
+ interface BridgeDepositAction {
5727
+ /**
5728
+ * Registered dApp identifier the GenericExecutor invokes on the destination
5729
+ * chain (for example, `'gateway_deposit'`).
5730
+ */
5731
+ dappId: string;
5732
+ /**
5733
+ * Positional arguments for the dApp function, in ABI order. Dynamic amount
5734
+ * slots are filled in by the executor from the minted amount.
5735
+ */
5736
+ params: readonly unknown[];
5466
5737
  }
5467
5738
  /**
5468
5739
  * Parameters for executing a cross-chain bridge operation.
@@ -5473,17 +5744,70 @@ interface BridgeParams$1<TFromCapabilities extends AdapterCapabilities = Adapter
5473
5744
  *
5474
5745
  * @defaultValue ChainDefinition
5475
5746
  */
5476
- TChainDefinition extends ChainDefinition = ChainDefinition> {
5747
+ TChainDefinition extends ChainDefinition = ChainDefinition,
5748
+ /**
5749
+ * The token type the provider accepts.
5750
+ *
5751
+ * @defaultValue 'USDC'
5752
+ *
5753
+ * @remarks
5754
+ * The default preserves the original USDC-only contract for consumers that
5755
+ * omit the token type. Providers that accept a different token type pass
5756
+ * `TToken` explicitly.
5757
+ *
5758
+ * @example
5759
+ * ```typescript
5760
+ * // Default — TToken resolves to 'USDC'
5761
+ * type DefaultParams = BridgeParams // params.token is typed as 'USDC'
5762
+ *
5763
+ * // Provider that identifies tokens by a hex string template literal
5764
+ * type HexTokenParams = BridgeParams<
5765
+ * AdapterCapabilities,
5766
+ * AdapterCapabilities,
5767
+ * ChainDefinition,
5768
+ * `0x${string}`
5769
+ * > // params.token is typed as `0x${string}`
5770
+ * ```
5771
+ */
5772
+ TToken extends string = 'USDC'> {
5477
5773
  /** The source adapter containing wallet and chain information */
5478
5774
  source: WalletContext<TFromCapabilities, TChainDefinition>;
5479
5775
  /** The destination adapter containing wallet and chain information */
5480
5776
  destination: DestinationWalletContext<TToCapabilities, TChainDefinition>;
5481
5777
  /** The amount to transfer (as a string to avoid precision issues) */
5482
5778
  amount: string;
5483
- /** The token to transfer (currently only USDC is supported) */
5484
- token: 'USDC';
5779
+ /** The token to transfer (provider-defined; defaults to `'USDC'`) */
5780
+ token: TToken;
5485
5781
  /** Bridge configuration (e.g., fast burn settings) */
5486
5782
  config: BridgeConfig;
5783
+ /**
5784
+ * Optional server-signed quote to reuse, typically the
5785
+ * {@link EstimateResult.quote} returned by an earlier `estimate` call.
5786
+ *
5787
+ * When present and still valid, a provider with a server-signed quote
5788
+ * model may reuse it instead of fetching a fresh quote, so the fee the
5789
+ * caller was quoted is the fee they pay. Providers decide when a reused
5790
+ * quote is still valid (e.g. freshness, fee token, speed); an unusable or
5791
+ * mismatched quote is ignored and a fresh one is fetched. Transfer
5792
+ * parameters are validated by the provider's on-chain contract, so a quote
5793
+ * reused for a different transfer is rejected there rather than silently.
5794
+ * Providers without a quote model ignore this field entirely, and do so
5795
+ * silently — nothing verifies that a quote reached the provider that issued
5796
+ * it, because the route is matched to a provider only after these
5797
+ * parameters are validated. A quote is meaningful only on the route that
5798
+ * produced it.
5799
+ *
5800
+ * Typed `unknown`: a caller reaches `bridge` through a provider-agnostic
5801
+ * surface, so this shared type names no provider's shape. It is public
5802
+ * input in any case, and is validated before any field is read — by the
5803
+ * provider that serves the route, or by the kit for routes it prices
5804
+ * itself. Treat it as opaque and pass it back unmodified.
5805
+ *
5806
+ * This is a `bridge` input. A quote is an output of `estimate`, not an
5807
+ * input to it — `estimate` always returns a freshly-priced quote, and a
5808
+ * provider may reject a quote passed to `estimate` rather than ignore it.
5809
+ */
5810
+ quote?: unknown;
5487
5811
  /**
5488
5812
  * Optional invocation metadata for tracing and correlation.
5489
5813
  *
@@ -5593,6 +5917,14 @@ interface BridgeConfig {
5593
5917
  * ```
5594
5918
  */
5595
5919
  customFee?: CustomFee | undefined;
5920
+ /**
5921
+ * Which leg pays the protocol fee.
5922
+ *
5923
+ * `'source'` leaves the delivered amount unreduced; `'destination'` takes the
5924
+ * fee from it. Omit it to let the routed provider decide — a provider rejects
5925
+ * a value it cannot honour.
5926
+ */
5927
+ feePayment?: 'source' | 'destination' | undefined;
5596
5928
  }
5597
5929
  /**
5598
5930
  * Custom fee configuration charged by the integrator.
@@ -5789,13 +6121,14 @@ interface ForwarderDestination<TChainIdentifier extends ChainIdentifier$1 = Chai
5789
6121
  */
5790
6122
  type BridgeDestination<TAdapterCapabilities extends AdapterCapabilities = AdapterCapabilities, TChainIdentifier extends ChainIdentifier$1 = ChainIdentifier$1> = ((AdapterContext<TAdapterCapabilities, TChainIdentifier> | BridgeDestinationWithAddress<TAdapterCapabilities, TChainIdentifier>) & {
5791
6123
  /**
5792
- * Enable Circle's Forwarder to handle the mint transaction.
6124
+ * Enable Circle's relayer to submit the destination transaction.
5793
6125
  *
5794
- * When true, Circle's Orbit relayer will fetch the attestation and submit
5795
- * the mint transaction on the user's behalf. The relay fee is deducted from
5796
- * the minted USDC at mint time.
6126
+ * Where the relay fee is charged depends on the route and on
6127
+ * {@link BridgeConfig.feePayment}: it may be taken from the amount that
6128
+ * arrives, or priced into a quote the source transaction pays.
5797
6129
  *
5798
- * @defaultValue false
6130
+ * Whether the option is required, optional, or refused depends on the
6131
+ * routed provider and the rest of the config.
5799
6132
  */
5800
6133
  useForwarder?: boolean;
5801
6134
  }) | ForwarderDestination<TChainIdentifier>;
@@ -6713,13 +7046,82 @@ interface SwapParams<TFromAdapterCapabilities extends AdapterCapabilities = Adap
6713
7046
  }
6714
7047
 
6715
7048
  /**
6716
- * Configure how CCTP and forwarding fees are collected for a bridge.
7049
+ * Display symbols the provider recognizes as a convenience for callers.
7050
+ *
7051
+ * A consumer may pass one of these symbols instead of a raw bytes32 token
7052
+ * id; the provider resolves it to the symbol's canonical bytes32 id via
7053
+ * {@link KNOWN_TOKEN_IDS_BY_NETWORK} (a symbol can map to more than one
7054
+ * bridge, so the map pins the canonical one). This list does NOT gate
7055
+ * routability: any token the IRIS registry lists with deployments on both
7056
+ * endpoints routes when passed by its bytes32 id, whether listed here or
7057
+ * not.
7058
+ *
7059
+ * @example
7060
+ * ```typescript
7061
+ * for (const symbol of KNOWN_TOKEN_SYMBOLS) console.log(symbol)
7062
+ * ```
7063
+ */
7064
+ declare const KNOWN_TOKEN_SYMBOLS: readonly ["cirBTC", "wETH", "EURC"];
7065
+ /**
7066
+ * A known token symbol. Derived from {@link KNOWN_TOKEN_SYMBOLS} so the
7067
+ * type and the runtime set never drift.
7068
+ *
7069
+ * @example
7070
+ * ```typescript
7071
+ * const sym: KnownTokenSymbol = 'cirBTC'
7072
+ * ```
7073
+ */
7074
+ type KnownTokenSymbol = (typeof KNOWN_TOKEN_SYMBOLS)[number];
7075
+
7076
+ /**
7077
+ * CCTPx token identifier: a bytes32 hex string. Within one CrossChainTokenService
7078
+ * deployment it names the same registered token on every chain that deployment
7079
+ * spans, which is what makes a cross-chain transfer addressable by id alone. Passed verbatim to the
7080
+ * `CrossChainTokenService.crossChainTransfer` contract call and used as the
7081
+ * `tokenId` path segment on the IRIS fee-quote endpoint.
7082
+ */
7083
+ type CCTPXTokenId = `0x${string}`;
7084
+ /**
7085
+ * A token value accepted by {@link CCTPXTokenId}-keyed route checks.
7086
+ *
7087
+ * The provider's `supportsRoute` accepts either a {@link KnownTokenSymbol},
7088
+ * which it resolves to a bytes32 id via the per-network map, or a
7089
+ * {@link CCTPXTokenId} passed directly. This union is the honest type of what
7090
+ * the route check accepts, so callers and JSDoc examples never need an `as`
7091
+ * cast to pass a symbol.
7092
+ *
7093
+ * @example
7094
+ * ```typescript
7095
+ * const bySymbol: CCTPXRouteToken = 'cirBTC'
7096
+ * const byId: CCTPXRouteToken =
7097
+ * '0x0000000000000000000000000000000000000000000000000000000063697254'
7098
+ * ```
7099
+ */
7100
+ type CCTPXRouteToken = CCTPXTokenId | KnownTokenSymbol;
7101
+
7102
+ /**
7103
+ * Token string accepted by `bridge` / `estimate`.
7104
+ *
7105
+ * Use `'USDC'` for CCTP v2, a known CCTPx symbol (`'cirBTC'`, `'wETH'`,
7106
+ * `'EURC'`), or a 32-byte hex CCTPx token id.
7107
+ *
7108
+ * @example
7109
+ * ```typescript
7110
+ * import type { BridgeToken } from '@circle-fin/bridge-kit'
7111
+ *
7112
+ * const usdc: BridgeToken = 'USDC'
7113
+ * const eurc: BridgeToken = 'EURC'
7114
+ * const tokenId: BridgeToken =
7115
+ * '0x0000000000000000000000000000000000000000000000000000000063697254'
7116
+ * ```
7117
+ */
7118
+ type BridgeToken = 'USDC' | CCTPXRouteToken;
7119
+ /**
7120
+ * Configuration accepted by `bridge` and `estimate`.
6717
7121
  *
6718
7122
  * @remarks
6719
- * Use `'source'` with `to.useForwarder: true` to treat `amount` as the exact
6720
- * destination amount. Bridge Kit obtains a signed fee quote, collects the fee
6721
- * in source-chain USDC, and leaves the destination mint unreduced. Omit the
6722
- * option (or use `'destination'`) to preserve the existing max-fee behavior.
7123
+ * The kit's name for {@link BridgeConfig}, kept as the parameter type so a
7124
+ * kit-only option can be added here without touching the provider-facing config.
6723
7125
  *
6724
7126
  * @example
6725
7127
  * ```typescript
@@ -6732,10 +7134,7 @@ interface SwapParams<TFromAdapterCapabilities extends AdapterCapabilities = Adap
6732
7134
  * ```
6733
7135
  * @since 1.14.0
6734
7136
  */
6735
- interface BridgeExecutionConfig extends BridgeConfig {
6736
- /** Select source-side signed fees or the legacy destination-side fee path. */
6737
- feePayment?: 'source' | 'destination';
6738
- }
7137
+ type BridgeExecutionConfig = BridgeConfig;
6739
7138
  type FeeFunction<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities> = (params: BridgeParams$1<TFromAdapterCapabilities, TToAdapterCapabilities>) => Promise<string> | string;
6740
7139
  type FeeRecipientFunction<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities> = (feePayoutChain: ChainDefinition, params: BridgeParams$1<TFromAdapterCapabilities, TToAdapterCapabilities>) => Promise<string> | string;
6741
7140
  /**
@@ -6753,6 +7152,13 @@ type FeeRecipientFunction<TFromAdapterCapabilities extends AdapterCapabilities,
6753
7152
  * Use `computeFee` (recommended) for human-readable amounts, or `calculateFee` (deprecated)
6754
7153
  * for smallest-unit amounts. Only one should be provided.
6755
7154
  *
7155
+ * **USDC only.** Because the fee is collected on top of the transfer amount and
7156
+ * split through CCTPv2's USDC flow, this policy cannot apply to any other token.
7157
+ * Bridging a non-USDC token (for example CCTPx `cirBTC` or `wETH`)
7158
+ * is rejected with `INPUT_VALIDATION_FAILED` before anything is submitted —
7159
+ * on `bridge` and `estimate` alike — rather than proceeding without the fee.
7160
+ * A per-call `config.customFee` is rejected the same way.
7161
+ *
6756
7162
  * @example
6757
7163
  * ```typescript
6758
7164
  * import type { CustomFeePolicy, BridgeParams } from '@circle-fin/bridge-kit'
@@ -6830,7 +7236,8 @@ type CustomFeePolicy$1 = {
6830
7236
  * - The `from` field specifies the source adapter context (wallet and chain).
6831
7237
  * - The `to` field specifies the destination, supporting both explicit and derived recipient addresses.
6832
7238
  * - The `config` field allows customization of bridge behavior (e.g., transfer speed).
6833
- * - The `token` field is optional and defaults to 'USDC'; other tokens are not currently supported.
7239
+ * - The `token` field is optional and defaults to `'USDC'`. It accepts
7240
+ * `'USDC'`, a known CCTPx symbol, or a bytes32 CCTPx token id.
6834
7241
  *
6835
7242
  * @typeParam TFromAdapterCapabilities - The source adapter capabilities type.
6836
7243
  * @typeParam TToAdapterCapabilities - The destination adapter capabilities type.
@@ -6898,10 +7305,29 @@ interface BridgeParams<TFromAdapterCapabilities extends AdapterCapabilities = Ad
6898
7305
  */
6899
7306
  config?: BridgeExecutionConfig;
6900
7307
  /**
6901
- * The token to transfer. Defaults to 'USDC'.
6902
- * If omitted, the provider will use 'USDC' by default.
7308
+ * The token to transfer. Defaults to `'USDC'`.
7309
+ *
7310
+ * A known symbol is a convenience for a canonical CCTPx registration. A
7311
+ * symbol that maps to more than one bridge resolves to the registration
7312
+ * pinned by the provider. Pass the bridge's bytes32 token id directly when
7313
+ * an exact registration is required.
7314
+ *
7315
+ * If omitted, defaults to `'USDC'`.
7316
+ *
7317
+ * @example
7318
+ * ```typescript
7319
+ * // USDC via CCTPv2 (default)
7320
+ * const usdc: BridgeParams['token'] = 'USDC'
7321
+ *
7322
+ * // CCTPx by bare symbol — resolves via the known-symbol map
7323
+ * const bare: BridgeParams['token'] = 'wETH'
7324
+ *
7325
+ * // CCTPx by bytes32 token id
7326
+ * const explicit: BridgeParams['token'] =
7327
+ * '0x0000000000000000000000000000000000000000000000000000000063697254'
7328
+ * ```
6903
7329
  */
6904
- token?: 'USDC';
7330
+ token?: BridgeToken;
6905
7331
  /**
6906
7332
  * Optional invocation metadata for tracing and correlation.
6907
7333
  *
@@ -6924,15 +7350,68 @@ interface BridgeParams<TFromAdapterCapabilities extends AdapterCapabilities = Ad
6924
7350
  */
6925
7351
  invocationMeta?: InvocationMeta;
6926
7352
  /**
6927
- * Reuse the opaque signed quote returned by a receive-exact estimate.
7353
+ * Optional server-signed quote to reuse — pass the `quote` returned by an
7354
+ * earlier {@link BridgeKit.estimate | estimate} call straight back so the
7355
+ * fee you were quoted is the fee you pay.
7356
+ *
7357
+ * Treat the value as opaque, and never log or decode it. It belongs to
7358
+ * whichever provider issued it and carries that provider's own shape,
7359
+ * which is why it is typed `unknown` here: a route is matched to a
7360
+ * provider after these parameters are validated, so the kit cannot know
7361
+ * whose quote this is. The provider that serves the route validates it
7362
+ * before reading any field.
7363
+ *
7364
+ * An unusable quote is not handled the same way everywhere, so take the
7365
+ * value from an estimate result rather than constructing one:
7366
+ * - A provider with a reusable quote model (e.g. CCTPx) reuses it while it
7367
+ * is fresh and matches the requested fee token and speed; otherwise it
7368
+ * transparently fetches a fresh quote and flags a `QUOTE_NOT_REUSED`
7369
+ * result warning, so a stale quote is never worse than passing none.
7370
+ * - Receive-exact bridging (`config.feePayment: 'source'`) instead
7371
+ * **rejects** a quote that is invalid, mismatched, expired, or too close
7372
+ * to expiry, rather than repricing behind your back.
7373
+ * - Providers with no quote model (e.g. USDC via CCTP v2) ignore it —
7374
+ * **silently**. Route selection happens after these parameters are
7375
+ * validated, so the kit cannot tell whose quote this is, and nothing
7376
+ * checks that it reached the provider that issued it. In practice this
7377
+ * bites when the token changes between `estimate` and `bridge`: a quote
7378
+ * from a CCTPx token (`cirBTC`, `wETH`) passed to a plain USDC bridge is
7379
+ * dropped without an error or a warning, and the fee comes from CCTP v2
7380
+ * instead. Keeping the same token routes back to the same provider, so
7381
+ * the quote arrives. Re-estimate whenever the transfer changes.
7382
+ *
7383
+ * The transfer parameters (amount, recipient, chains) are validated
7384
+ * on-chain, so a quote reused for a different transfer is rejected by the
7385
+ * contract rather than silently — reuse a quote only for the transfer it
7386
+ * was estimated for.
7387
+ *
7388
+ * This field is for {@link BridgeKit.bridge | bridge} only. A quote is
7389
+ * produced by `estimate` and consumed by `bridge`, and `estimate` always
7390
+ * returns a freshly-priced one. Passing a quote back into `estimate` is a
7391
+ * usage error: CCTPx rejects it outright, while receive-exact ignores it and
7392
+ * prices afresh, so the quote you get back is never the one you sent. Take
7393
+ * the quote from the estimate result, not from your input.
6928
7394
  *
6929
- * @remarks
6930
- * Bridge Kit validates a supplied quote against the exact transfer and fails
6931
- * when it is invalid, mismatched, expired, or too close to expiry. Omit this
6932
- * value to let Bridge Kit fetch a fresh quote automatically. Never log or
6933
- * decode it.
7395
+ * @example
7396
+ * ```typescript
7397
+ * const estimate = await kit.estimate({
7398
+ * from: { adapter: sourceAdapter, chain: 'Ethereum' },
7399
+ * to: { adapter: destAdapter, chain: 'Base' },
7400
+ * amount: '100',
7401
+ * token: 'wETH',
7402
+ * })
7403
+ *
7404
+ * // Reuse the quoted fee for the bridge.
7405
+ * const result = await kit.bridge({
7406
+ * from: { adapter: sourceAdapter, chain: 'Ethereum' },
7407
+ * to: { adapter: destAdapter, chain: 'Base' },
7408
+ * amount: '100',
7409
+ * token: 'wETH',
7410
+ * quote: estimate.quote,
7411
+ * })
7412
+ * ```
6934
7413
  */
6935
- quote?: string;
7414
+ quote?: unknown;
6936
7415
  }
6937
7416
 
6938
7417
  /**
@@ -7718,6 +8197,18 @@ interface AppKitContext {
7718
8197
  chain: ChainDefinition;
7719
8198
  params: OperationParamsMap[T];
7720
8199
  }): Promise<string>;
8200
+ /**
8201
+ * Optional client-side configuration forwarded to the underlying
8202
+ * {@link createOnrampKit} factory when `kit.onramp` is accessed.
8203
+ *
8204
+ * @remarks
8205
+ * The onramp namespace on the client carries NO secret — the
8206
+ * long-lived `apiKey` lives exclusively on the server entry
8207
+ * (`@circle-fin/app-kit/server`). These options exist purely so
8208
+ * staging / SSR consumers can override the widget origin or
8209
+ * inject a host `Window`.
8210
+ */
8211
+ onramp?: AppKitOnrampClientConfig | undefined;
7721
8212
  /**
7722
8213
  * Operation-scoped custom fee policies.
7723
8214
  *
@@ -7789,6 +8280,35 @@ interface AppKitContext {
7789
8280
  */
7790
8281
  headers?: Record<string, string>;
7791
8282
  }
8283
+ /**
8284
+ * Client-side onramp configuration carried on {@link AppKitContext.onramp}.
8285
+ *
8286
+ * @remarks
8287
+ * No secret material lives here — the server-only `apiKey` is
8288
+ * configured on the matching `@circle-fin/app-kit/server` entry. Both
8289
+ * fields are optional with safe production defaults; the typical
8290
+ * application leaves them unset and instantiates `new AppKit()`.
8291
+ */
8292
+ interface AppKitOnrampClientConfig {
8293
+ /**
8294
+ * Override the hosted widget origin. Defaults to the onramp-kit
8295
+ * production origin.
8296
+ *
8297
+ * @remarks
8298
+ * Override for staging environments only — production traffic
8299
+ * should always use the default.
8300
+ */
8301
+ readonly widgetBaseUrl?: string | undefined;
8302
+ /**
8303
+ * Inject a host `Window` for testing or SSR-friendly bundles.
8304
+ *
8305
+ * @remarks
8306
+ * Production code leaves this unset and relies on the global
8307
+ * `window`. Exposed (not `@internal`) so SSR frameworks can
8308
+ * hand-feed the host window after hydration.
8309
+ */
8310
+ readonly window?: Window | undefined;
8311
+ }
7792
8312
 
7793
8313
  /**
7794
8314
  * Estimate the output and fees for a same-chain token swap operation.