@circle-fin/provider-cctp-v2 1.8.5 → 1.9.0

package/index.d.cts

@@ -658,6 +658,8 @@ declare enum Blockchain {
     Celo_Alfajores_Testnet = "Celo_Alfajores_Testnet",
     Codex = "Codex",
     Codex_Testnet = "Codex_Testnet",
+    Cronos = "Cronos",
+    Cronos_Testnet = "Cronos_Testnet",
     Edge = "Edge",
     Edge_Testnet = "Edge_Testnet",
     Ethereum = "Ethereum",
@@ -6134,6 +6136,38 @@ interface ICCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> {
      * @returns A promise that resolves to the attestation message.
      */
     fetchAttestation<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities>(source: BridgeParams<TFromAdapterCapabilities, TToAdapterCapabilities>['source'], txHash: string, config?: Partial<ApiPollingConfig>): Promise<AttestationMessage>;
+    /**
+     * Polls attestation data until Circle's relayer mint transaction is confirmed.
+     *
+     * @param source - The source wallet context containing the chain definition and wallet address.
+     * @param txHash - The transaction hash of the deposit for burn transaction.
+     * @param config - Optional polling configuration overrides.
+     * @returns A promise that resolves to the relayer mint attestation message.
+     * @throws KitError If the source wallet context is invalid, the transaction hash is invalid,
+     *   the relayer forward fails, the response is invalid, or polling times out.
+     *
+     * @example
+     * ```typescript
+     * import { CCTPV2BridgingProvider } from '@circle-fin/provider-cctp-v2'
+     * import { Chains } from '@core/chains'
+     *
+     * const provider = new CCTPV2BridgingProvider({
+     *   headers: { 'X-Partner-UUID': '00000000-0000-0000-0000-000000000000' },
+     * })
+     *
+     * const attestation = await provider.fetchRelayerMint(
+     *   {
+     *     adapter,
+     *     chain: Chains.EthereumSepolia,
+     *     address: '0x1234...',
+     *   },
+     *   '0xabc123...',
+     * )
+     *
+     * console.log('Relayer mint tx:', attestation.forwardTxHash)
+     * ```
+     */
+    fetchRelayerMint<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities>(source: BridgeParams<TFromAdapterCapabilities, TToAdapterCapabilities>['source'], txHash: string, config?: Partial<ApiPollingConfig>): Promise<AttestationMessage>;
     /**
      * Requests a fresh attestation for an expired attestation.
      *
@@ -6165,10 +6199,28 @@ interface ICCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> {
  * @remarks
  * This interface defines all configurable aspects of the CCTP v2 provider:
  * - attestation: Settings for the attestation fetching process
+ * - headers: Custom HTTP headers sent with every Circle attestation API request
  */
 interface CCTPV2Config {
     /** Configuration for the attestation fetching process */
     attestation?: Partial<ApiPollingConfig>;
+    /**
+     * Custom HTTP headers sent with every Circle attestation (Iris) API request
+     * made by the provider (attestation fetch, re-attestation, and relayer mint
+     * status polling).
+     *
+     * @remarks
+     * Headers are merged on top of the defaults (such as `Content-Type`) without
+     * removing them. The header is forwarded as-is to Circle's API; the SDK does
+     * not interpret it.
+     *
+     * Precedence (lowest to highest): provider defaults, then these
+     * `config.headers`, then any per-call `config.headers` passed to
+     * {@link CCTPV2BridgingProvider.fetchAttestation},
+     * {@link CCTPV2BridgingProvider.fetchRelayerMint}, or
+     * {@link CCTPV2BridgingProvider.reAttest}.
+     */
+    headers?: Record<string, string>;
 }
 /**
  * Concrete implementation of BridgingProvider for Circle's Cross-Chain Transfer Protocol (CCTP) version 2.
@@ -6234,6 +6286,20 @@ declare class CCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> imp
      * @param config - Optional configuration overrides for the provider
      */
     constructor(config?: CCTPV2Config);
+    /**
+     * Resolves the effective polling configuration for an attestation request.
+     *
+     * Precedence (lowest to highest): provider `config.attestation`, then the
+     * per-call `config`. Headers merge independently across
+     * `config.attestation.headers`, the provider-level `config.headers`, and any
+     * per-call `config.headers`, so a more specific header augments rather than
+     * replaces the broader ones. The `headers` key is omitted entirely when no
+     * headers are configured, leaving the attestation fetchers' defaults intact.
+     *
+     * @param config - Optional per-call polling configuration overrides
+     * @returns The merged polling configuration passed to the attestation fetchers
+     */
+    private resolveAttestationConfig;
     /**
      * Execute a cross-chain USDC bridge operation using the CCTP v2 protocol.
      *
@@ -6476,6 +6542,43 @@ declare class CCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> imp
      * ```
      */
     fetchAttestation<TFromAdapterCapabilities extends AdapterCapabilities>(source: WalletContext<TFromAdapterCapabilities, ChainDefinitionWithCCTPv2>, transactionHash: string, config?: Partial<ApiPollingConfig>): Promise<AttestationMessage>;
+    /**
+     * Polls attestation data until Circle's relayer mint transaction is confirmed.
+     *
+     * This method is used by forwarded transfers. It polls the same Iris
+     * attestation endpoint as {@link CCTPV2BridgingProvider.fetchAttestation},
+     * but waits for a completed relayer forward state and returns the attestation
+     * message containing `forwardTxHash`.
+     *
+     * @typeParam TFromAdapterCapabilities - The type representing the capabilities of the source adapter
+     * @param source - The source wallet context containing the chain definition and wallet address
+     * @param transactionHash - The transaction hash of the burn operation
+     * @param config - Optional polling configuration overrides for timeout, retries, delay, and headers
+     * @returns A promise that resolves to the attestation message with `forwardTxHash`
+     * @throws KitError If the relayer forward fails, the response is invalid, or polling times out
+     *
+     * @example
+     * ```typescript
+     * import { CCTPV2BridgingProvider } from '@circle-fin/provider-cctp-v2'
+     * import { Chains } from '@core/chains'
+     *
+     * const provider = new CCTPV2BridgingProvider({
+     *   headers: { 'X-Partner-UUID': '00000000-0000-0000-0000-000000000000' },
+     * })
+     *
+     * const attestation = await provider.fetchRelayerMint(
+     *   {
+     *     adapter,
+     *     chain: Chains.EthereumSepolia,
+     *     address: '0x1234...',
+     *   },
+     *   '0xabc123...',
+     * )
+     *
+     * console.log('Relayer mint tx:', attestation.forwardTxHash)
+     * ```
+     */
+    fetchRelayerMint<TFromAdapterCapabilities extends AdapterCapabilities>(source: WalletContext<TFromAdapterCapabilities, ChainDefinitionWithCCTPv2>, transactionHash: string, config?: Partial<ApiPollingConfig>): Promise<AttestationMessage>;
     /**
      * Requests a fresh attestation for an expired attestation.
      *

package/index.d.mts

@@ -658,6 +658,8 @@ declare enum Blockchain {
     Celo_Alfajores_Testnet = "Celo_Alfajores_Testnet",
     Codex = "Codex",
     Codex_Testnet = "Codex_Testnet",
+    Cronos = "Cronos",
+    Cronos_Testnet = "Cronos_Testnet",
     Edge = "Edge",
     Edge_Testnet = "Edge_Testnet",
     Ethereum = "Ethereum",
@@ -6134,6 +6136,38 @@ interface ICCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> {
      * @returns A promise that resolves to the attestation message.
      */
     fetchAttestation<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities>(source: BridgeParams<TFromAdapterCapabilities, TToAdapterCapabilities>['source'], txHash: string, config?: Partial<ApiPollingConfig>): Promise<AttestationMessage>;
+    /**
+     * Polls attestation data until Circle's relayer mint transaction is confirmed.
+     *
+     * @param source - The source wallet context containing the chain definition and wallet address.
+     * @param txHash - The transaction hash of the deposit for burn transaction.
+     * @param config - Optional polling configuration overrides.
+     * @returns A promise that resolves to the relayer mint attestation message.
+     * @throws KitError If the source wallet context is invalid, the transaction hash is invalid,
+     *   the relayer forward fails, the response is invalid, or polling times out.
+     *
+     * @example
+     * ```typescript
+     * import { CCTPV2BridgingProvider } from '@circle-fin/provider-cctp-v2'
+     * import { Chains } from '@core/chains'
+     *
+     * const provider = new CCTPV2BridgingProvider({
+     *   headers: { 'X-Partner-UUID': '00000000-0000-0000-0000-000000000000' },
+     * })
+     *
+     * const attestation = await provider.fetchRelayerMint(
+     *   {
+     *     adapter,
+     *     chain: Chains.EthereumSepolia,
+     *     address: '0x1234...',
+     *   },
+     *   '0xabc123...',
+     * )
+     *
+     * console.log('Relayer mint tx:', attestation.forwardTxHash)
+     * ```
+     */
+    fetchRelayerMint<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities>(source: BridgeParams<TFromAdapterCapabilities, TToAdapterCapabilities>['source'], txHash: string, config?: Partial<ApiPollingConfig>): Promise<AttestationMessage>;
     /**
      * Requests a fresh attestation for an expired attestation.
      *
@@ -6165,10 +6199,28 @@ interface ICCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> {
  * @remarks
  * This interface defines all configurable aspects of the CCTP v2 provider:
  * - attestation: Settings for the attestation fetching process
+ * - headers: Custom HTTP headers sent with every Circle attestation API request
  */
 interface CCTPV2Config {
     /** Configuration for the attestation fetching process */
     attestation?: Partial<ApiPollingConfig>;
+    /**
+     * Custom HTTP headers sent with every Circle attestation (Iris) API request
+     * made by the provider (attestation fetch, re-attestation, and relayer mint
+     * status polling).
+     *
+     * @remarks
+     * Headers are merged on top of the defaults (such as `Content-Type`) without
+     * removing them. The header is forwarded as-is to Circle's API; the SDK does
+     * not interpret it.
+     *
+     * Precedence (lowest to highest): provider defaults, then these
+     * `config.headers`, then any per-call `config.headers` passed to
+     * {@link CCTPV2BridgingProvider.fetchAttestation},
+     * {@link CCTPV2BridgingProvider.fetchRelayerMint}, or
+     * {@link CCTPV2BridgingProvider.reAttest}.
+     */
+    headers?: Record<string, string>;
 }
 /**
  * Concrete implementation of BridgingProvider for Circle's Cross-Chain Transfer Protocol (CCTP) version 2.
@@ -6234,6 +6286,20 @@ declare class CCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> imp
      * @param config - Optional configuration overrides for the provider
      */
     constructor(config?: CCTPV2Config);
+    /**
+     * Resolves the effective polling configuration for an attestation request.
+     *
+     * Precedence (lowest to highest): provider `config.attestation`, then the
+     * per-call `config`. Headers merge independently across
+     * `config.attestation.headers`, the provider-level `config.headers`, and any
+     * per-call `config.headers`, so a more specific header augments rather than
+     * replaces the broader ones. The `headers` key is omitted entirely when no
+     * headers are configured, leaving the attestation fetchers' defaults intact.
+     *
+     * @param config - Optional per-call polling configuration overrides
+     * @returns The merged polling configuration passed to the attestation fetchers
+     */
+    private resolveAttestationConfig;
     /**
      * Execute a cross-chain USDC bridge operation using the CCTP v2 protocol.
      *
@@ -6476,6 +6542,43 @@ declare class CCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> imp
      * ```
      */
     fetchAttestation<TFromAdapterCapabilities extends AdapterCapabilities>(source: WalletContext<TFromAdapterCapabilities, ChainDefinitionWithCCTPv2>, transactionHash: string, config?: Partial<ApiPollingConfig>): Promise<AttestationMessage>;
+    /**
+     * Polls attestation data until Circle's relayer mint transaction is confirmed.
+     *
+     * This method is used by forwarded transfers. It polls the same Iris
+     * attestation endpoint as {@link CCTPV2BridgingProvider.fetchAttestation},
+     * but waits for a completed relayer forward state and returns the attestation
+     * message containing `forwardTxHash`.
+     *
+     * @typeParam TFromAdapterCapabilities - The type representing the capabilities of the source adapter
+     * @param source - The source wallet context containing the chain definition and wallet address
+     * @param transactionHash - The transaction hash of the burn operation
+     * @param config - Optional polling configuration overrides for timeout, retries, delay, and headers
+     * @returns A promise that resolves to the attestation message with `forwardTxHash`
+     * @throws KitError If the relayer forward fails, the response is invalid, or polling times out
+     *
+     * @example
+     * ```typescript
+     * import { CCTPV2BridgingProvider } from '@circle-fin/provider-cctp-v2'
+     * import { Chains } from '@core/chains'
+     *
+     * const provider = new CCTPV2BridgingProvider({
+     *   headers: { 'X-Partner-UUID': '00000000-0000-0000-0000-000000000000' },
+     * })
+     *
+     * const attestation = await provider.fetchRelayerMint(
+     *   {
+     *     adapter,
+     *     chain: Chains.EthereumSepolia,
+     *     address: '0x1234...',
+     *   },
+     *   '0xabc123...',
+     * )
+     *
+     * console.log('Relayer mint tx:', attestation.forwardTxHash)
+     * ```
+     */
+    fetchRelayerMint<TFromAdapterCapabilities extends AdapterCapabilities>(source: WalletContext<TFromAdapterCapabilities, ChainDefinitionWithCCTPv2>, transactionHash: string, config?: Partial<ApiPollingConfig>): Promise<AttestationMessage>;
     /**
      * Requests a fresh attestation for an expired attestation.
      *

package/index.d.ts

@@ -658,6 +658,8 @@ declare enum Blockchain {
     Celo_Alfajores_Testnet = "Celo_Alfajores_Testnet",
     Codex = "Codex",
     Codex_Testnet = "Codex_Testnet",
+    Cronos = "Cronos",
+    Cronos_Testnet = "Cronos_Testnet",
     Edge = "Edge",
     Edge_Testnet = "Edge_Testnet",
     Ethereum = "Ethereum",
@@ -6134,6 +6136,38 @@ interface ICCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> {
      * @returns A promise that resolves to the attestation message.
      */
     fetchAttestation<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities>(source: BridgeParams<TFromAdapterCapabilities, TToAdapterCapabilities>['source'], txHash: string, config?: Partial<ApiPollingConfig>): Promise<AttestationMessage>;
+    /**
+     * Polls attestation data until Circle's relayer mint transaction is confirmed.
+     *
+     * @param source - The source wallet context containing the chain definition and wallet address.
+     * @param txHash - The transaction hash of the deposit for burn transaction.
+     * @param config - Optional polling configuration overrides.
+     * @returns A promise that resolves to the relayer mint attestation message.
+     * @throws KitError If the source wallet context is invalid, the transaction hash is invalid,
+     *   the relayer forward fails, the response is invalid, or polling times out.
+     *
+     * @example
+     * ```typescript
+     * import { CCTPV2BridgingProvider } from '@circle-fin/provider-cctp-v2'
+     * import { Chains } from '@core/chains'
+     *
+     * const provider = new CCTPV2BridgingProvider({
+     *   headers: { 'X-Partner-UUID': '00000000-0000-0000-0000-000000000000' },
+     * })
+     *
+     * const attestation = await provider.fetchRelayerMint(
+     *   {
+     *     adapter,
+     *     chain: Chains.EthereumSepolia,
+     *     address: '0x1234...',
+     *   },
+     *   '0xabc123...',
+     * )
+     *
+     * console.log('Relayer mint tx:', attestation.forwardTxHash)
+     * ```
+     */
+    fetchRelayerMint<TFromAdapterCapabilities extends AdapterCapabilities, TToAdapterCapabilities extends AdapterCapabilities>(source: BridgeParams<TFromAdapterCapabilities, TToAdapterCapabilities>['source'], txHash: string, config?: Partial<ApiPollingConfig>): Promise<AttestationMessage>;
     /**
      * Requests a fresh attestation for an expired attestation.
      *
@@ -6165,10 +6199,28 @@ interface ICCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> {
  * @remarks
  * This interface defines all configurable aspects of the CCTP v2 provider:
  * - attestation: Settings for the attestation fetching process
+ * - headers: Custom HTTP headers sent with every Circle attestation API request
  */
 interface CCTPV2Config {
     /** Configuration for the attestation fetching process */
     attestation?: Partial<ApiPollingConfig>;
+    /**
+     * Custom HTTP headers sent with every Circle attestation (Iris) API request
+     * made by the provider (attestation fetch, re-attestation, and relayer mint
+     * status polling).
+     *
+     * @remarks
+     * Headers are merged on top of the defaults (such as `Content-Type`) without
+     * removing them. The header is forwarded as-is to Circle's API; the SDK does
+     * not interpret it.
+     *
+     * Precedence (lowest to highest): provider defaults, then these
+     * `config.headers`, then any per-call `config.headers` passed to
+     * {@link CCTPV2BridgingProvider.fetchAttestation},
+     * {@link CCTPV2BridgingProvider.fetchRelayerMint}, or
+     * {@link CCTPV2BridgingProvider.reAttest}.
+     */
+    headers?: Record<string, string>;
 }
 /**
  * Concrete implementation of BridgingProvider for Circle's Cross-Chain Transfer Protocol (CCTP) version 2.
@@ -6234,6 +6286,20 @@ declare class CCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> imp
      * @param config - Optional configuration overrides for the provider
      */
     constructor(config?: CCTPV2Config);
+    /**
+     * Resolves the effective polling configuration for an attestation request.
+     *
+     * Precedence (lowest to highest): provider `config.attestation`, then the
+     * per-call `config`. Headers merge independently across
+     * `config.attestation.headers`, the provider-level `config.headers`, and any
+     * per-call `config.headers`, so a more specific header augments rather than
+     * replaces the broader ones. The `headers` key is omitted entirely when no
+     * headers are configured, leaving the attestation fetchers' defaults intact.
+     *
+     * @param config - Optional per-call polling configuration overrides
+     * @returns The merged polling configuration passed to the attestation fetchers
+     */
+    private resolveAttestationConfig;
     /**
      * Execute a cross-chain USDC bridge operation using the CCTP v2 protocol.
      *
@@ -6476,6 +6542,43 @@ declare class CCTPV2BridgingProvider extends BridgingProvider<CCTPV2Actions> imp
      * ```
      */
     fetchAttestation<TFromAdapterCapabilities extends AdapterCapabilities>(source: WalletContext<TFromAdapterCapabilities, ChainDefinitionWithCCTPv2>, transactionHash: string, config?: Partial<ApiPollingConfig>): Promise<AttestationMessage>;
+    /**
+     * Polls attestation data until Circle's relayer mint transaction is confirmed.
+     *
+     * This method is used by forwarded transfers. It polls the same Iris
+     * attestation endpoint as {@link CCTPV2BridgingProvider.fetchAttestation},
+     * but waits for a completed relayer forward state and returns the attestation
+     * message containing `forwardTxHash`.
+     *
+     * @typeParam TFromAdapterCapabilities - The type representing the capabilities of the source adapter
+     * @param source - The source wallet context containing the chain definition and wallet address
+     * @param transactionHash - The transaction hash of the burn operation
+     * @param config - Optional polling configuration overrides for timeout, retries, delay, and headers
+     * @returns A promise that resolves to the attestation message with `forwardTxHash`
+     * @throws KitError If the relayer forward fails, the response is invalid, or polling times out
+     *
+     * @example
+     * ```typescript
+     * import { CCTPV2BridgingProvider } from '@circle-fin/provider-cctp-v2'
+     * import { Chains } from '@core/chains'
+     *
+     * const provider = new CCTPV2BridgingProvider({
+     *   headers: { 'X-Partner-UUID': '00000000-0000-0000-0000-000000000000' },
+     * })
+     *
+     * const attestation = await provider.fetchRelayerMint(
+     *   {
+     *     adapter,
+     *     chain: Chains.EthereumSepolia,
+     *     address: '0x1234...',
+     *   },
+     *   '0xabc123...',
+     * )
+     *
+     * console.log('Relayer mint tx:', attestation.forwardTxHash)
+     * ```
+     */
+    fetchRelayerMint<TFromAdapterCapabilities extends AdapterCapabilities>(source: WalletContext<TFromAdapterCapabilities, ChainDefinitionWithCCTPv2>, transactionHash: string, config?: Partial<ApiPollingConfig>): Promise<AttestationMessage>;
     /**
      * Requests a fresh attestation for an expired attestation.
      *