@circle-fin/app-kit 1.8.0 → 1.9.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/earn.d.cts CHANGED
@@ -659,6 +659,8 @@ declare enum Blockchain {
659
659
  Celo_Alfajores_Testnet = "Celo_Alfajores_Testnet",
660
660
  Codex = "Codex",
661
661
  Codex_Testnet = "Codex_Testnet",
662
+ Cronos = "Cronos",
663
+ Cronos_Testnet = "Cronos_Testnet",
662
664
  Edge = "Edge",
663
665
  Edge_Testnet = "Edge_Testnet",
664
666
  Ethereum = "Ethereum",
@@ -900,6 +902,7 @@ declare enum BridgeChain {
900
902
  Avalanche = "Avalanche",
901
903
  Base = "Base",
902
904
  Codex = "Codex",
905
+ Cronos = "Cronos",
903
906
  Edge = "Edge",
904
907
  Ethereum = "Ethereum",
905
908
  HyperEVM = "HyperEVM",
@@ -923,6 +926,7 @@ declare enum BridgeChain {
923
926
  Avalanche_Fuji = "Avalanche_Fuji",
924
927
  Base_Sepolia = "Base_Sepolia",
925
928
  Codex_Testnet = "Codex_Testnet",
929
+ Cronos_Testnet = "Cronos_Testnet",
926
930
  Edge_Testnet = "Edge_Testnet",
927
931
  Ethereum_Sepolia = "Ethereum_Sepolia",
928
932
  HyperEVM_Testnet = "HyperEVM_Testnet",
@@ -6380,10 +6384,11 @@ interface AssetAmount {
6380
6384
  /**
6381
6385
  * Optional category tag for the amount.
6382
6386
  *
6383
- * Present on fee entries to identify the kind of fee for cross-chain
6384
- * deposit quotes this is the source-fee item type (e.g. `'FORWARD'`,
6385
- * `'PRE_FINALITY'`). Omitted when the amount has no meaningful category
6386
- * (plain deposit/withdrawal/share/reward amounts).
6387
+ * Present on fee entries to identify the kind of fee. For cross-chain deposit
6388
+ * quotes this is the source-fee item type (e.g. `'FORWARD'`,
6389
+ * `'PRE_FINALITY'`), and for withdrawal quotes this can identify Circle fees
6390
+ * (e.g. `'circle'`). Omitted when the amount has no meaningful
6391
+ * category (plain deposit/withdrawal/share/reward amounts).
6387
6392
  */
6388
6393
  readonly type?: string | undefined;
6389
6394
  /**
@@ -6744,12 +6749,12 @@ interface DepositQuoteInfo {
6744
6749
  /** Current annualized percentage yield. */
6745
6750
  readonly currentApy: number;
6746
6751
  /**
6747
- * Deposit fees charged in the deposit asset. For cross-chain quotes this
6748
- * carries one entry per source-fee item (e.g. `'FORWARD'`, `'PRE_FINALITY'`),
6749
- * each tagged with its own {@link AssetAmount.type} and
6750
- * {@link AssetAmount.status} (e.g. `'estimated'`). Empty when no such fee
6751
- * applies. Distinct from native gas estimates, which are reported separately
6752
- * as gas-fee fields.
6752
+ * Deposit fees charged by the quote. For cross-chain quotes this carries one
6753
+ * entry per source-fee item (e.g. `'FORWARD'`, `'PRE_FINALITY'`) in the
6754
+ * returned fee token and decimal precision, each tagged with its own
6755
+ * {@link AssetAmount.type} and {@link AssetAmount.status} (e.g.
6756
+ * `'estimated'`). Empty when no such fee applies. Distinct from native gas
6757
+ * estimates, which are reported separately as gas-fee fields.
6753
6758
  */
6754
6759
  readonly fees: readonly AssetAmount[];
6755
6760
  /**
@@ -6806,7 +6811,12 @@ interface WithdrawalQuoteInfo {
6806
6811
  * available balance and quoted withdrawal in a single round-trip.
6807
6812
  */
6808
6813
  readonly maxWithdrawable: AssetAmount;
6809
- /** Fees applied to the withdrawal. */
6814
+ /**
6815
+ * Fees applied to the withdrawal.
6816
+ *
6817
+ * Circle fees are returned with `type: 'circle'` so callers can distinguish
6818
+ * them from untyped plain fees and native gas estimates.
6819
+ */
6810
6820
  readonly fees: readonly AssetAmount[];
6811
6821
  /**
6812
6822
  * Estimated native gas fees for the transactions needed to withdraw.
@@ -7264,8 +7274,8 @@ interface CrossChainDepositParams<TFromAdapterCapabilities extends AdapterCapabi
7264
7274
  */
7265
7275
  readonly amount: string;
7266
7276
  /**
7267
- * Maximum source-collected bridge fee the caller is willing to sign for, in
7268
- * human-readable source token units.
7277
+ * Maximum source-collected bridge fee the caller is willing to accept, in
7278
+ * human-readable fee token units from the quote.
7269
7279
  *
7270
7280
  * Derive this from a recent cross-chain deposit quote by summing
7271
7281
  * `quote.fees[].amount`. The prepared bridge bundle must not exceed this cap
@@ -8064,6 +8074,16 @@ interface AppKitContext {
8064
8074
  * @defaultValue false
8065
8075
  */
8066
8076
  disableErrorReporting?: boolean;
8077
+ /**
8078
+ * Custom HTTP headers forwarded with the underlying CCTP provider's
8079
+ * attestation (Iris) API requests made by bridge operations.
8080
+ *
8081
+ * @remarks
8082
+ * Headers are merged on top of the SDK defaults (such as `Content-Type`)
8083
+ * rather than replacing them. The header is forwarded as-is to Circle's API;
8084
+ * the SDK does not interpret it.
8085
+ */
8086
+ headers?: Record<string, string>;
8067
8087
  }
8068
8088
 
8069
8089
  /**
package/earn.d.mts CHANGED
@@ -659,6 +659,8 @@ declare enum Blockchain {
659
659
  Celo_Alfajores_Testnet = "Celo_Alfajores_Testnet",
660
660
  Codex = "Codex",
661
661
  Codex_Testnet = "Codex_Testnet",
662
+ Cronos = "Cronos",
663
+ Cronos_Testnet = "Cronos_Testnet",
662
664
  Edge = "Edge",
663
665
  Edge_Testnet = "Edge_Testnet",
664
666
  Ethereum = "Ethereum",
@@ -900,6 +902,7 @@ declare enum BridgeChain {
900
902
  Avalanche = "Avalanche",
901
903
  Base = "Base",
902
904
  Codex = "Codex",
905
+ Cronos = "Cronos",
903
906
  Edge = "Edge",
904
907
  Ethereum = "Ethereum",
905
908
  HyperEVM = "HyperEVM",
@@ -923,6 +926,7 @@ declare enum BridgeChain {
923
926
  Avalanche_Fuji = "Avalanche_Fuji",
924
927
  Base_Sepolia = "Base_Sepolia",
925
928
  Codex_Testnet = "Codex_Testnet",
929
+ Cronos_Testnet = "Cronos_Testnet",
926
930
  Edge_Testnet = "Edge_Testnet",
927
931
  Ethereum_Sepolia = "Ethereum_Sepolia",
928
932
  HyperEVM_Testnet = "HyperEVM_Testnet",
@@ -6380,10 +6384,11 @@ interface AssetAmount {
6380
6384
  /**
6381
6385
  * Optional category tag for the amount.
6382
6386
  *
6383
- * Present on fee entries to identify the kind of fee for cross-chain
6384
- * deposit quotes this is the source-fee item type (e.g. `'FORWARD'`,
6385
- * `'PRE_FINALITY'`). Omitted when the amount has no meaningful category
6386
- * (plain deposit/withdrawal/share/reward amounts).
6387
+ * Present on fee entries to identify the kind of fee. For cross-chain deposit
6388
+ * quotes this is the source-fee item type (e.g. `'FORWARD'`,
6389
+ * `'PRE_FINALITY'`), and for withdrawal quotes this can identify Circle fees
6390
+ * (e.g. `'circle'`). Omitted when the amount has no meaningful
6391
+ * category (plain deposit/withdrawal/share/reward amounts).
6387
6392
  */
6388
6393
  readonly type?: string | undefined;
6389
6394
  /**
@@ -6744,12 +6749,12 @@ interface DepositQuoteInfo {
6744
6749
  /** Current annualized percentage yield. */
6745
6750
  readonly currentApy: number;
6746
6751
  /**
6747
- * Deposit fees charged in the deposit asset. For cross-chain quotes this
6748
- * carries one entry per source-fee item (e.g. `'FORWARD'`, `'PRE_FINALITY'`),
6749
- * each tagged with its own {@link AssetAmount.type} and
6750
- * {@link AssetAmount.status} (e.g. `'estimated'`). Empty when no such fee
6751
- * applies. Distinct from native gas estimates, which are reported separately
6752
- * as gas-fee fields.
6752
+ * Deposit fees charged by the quote. For cross-chain quotes this carries one
6753
+ * entry per source-fee item (e.g. `'FORWARD'`, `'PRE_FINALITY'`) in the
6754
+ * returned fee token and decimal precision, each tagged with its own
6755
+ * {@link AssetAmount.type} and {@link AssetAmount.status} (e.g.
6756
+ * `'estimated'`). Empty when no such fee applies. Distinct from native gas
6757
+ * estimates, which are reported separately as gas-fee fields.
6753
6758
  */
6754
6759
  readonly fees: readonly AssetAmount[];
6755
6760
  /**
@@ -6806,7 +6811,12 @@ interface WithdrawalQuoteInfo {
6806
6811
  * available balance and quoted withdrawal in a single round-trip.
6807
6812
  */
6808
6813
  readonly maxWithdrawable: AssetAmount;
6809
- /** Fees applied to the withdrawal. */
6814
+ /**
6815
+ * Fees applied to the withdrawal.
6816
+ *
6817
+ * Circle fees are returned with `type: 'circle'` so callers can distinguish
6818
+ * them from untyped plain fees and native gas estimates.
6819
+ */
6810
6820
  readonly fees: readonly AssetAmount[];
6811
6821
  /**
6812
6822
  * Estimated native gas fees for the transactions needed to withdraw.
@@ -7264,8 +7274,8 @@ interface CrossChainDepositParams<TFromAdapterCapabilities extends AdapterCapabi
7264
7274
  */
7265
7275
  readonly amount: string;
7266
7276
  /**
7267
- * Maximum source-collected bridge fee the caller is willing to sign for, in
7268
- * human-readable source token units.
7277
+ * Maximum source-collected bridge fee the caller is willing to accept, in
7278
+ * human-readable fee token units from the quote.
7269
7279
  *
7270
7280
  * Derive this from a recent cross-chain deposit quote by summing
7271
7281
  * `quote.fees[].amount`. The prepared bridge bundle must not exceed this cap
@@ -8064,6 +8074,16 @@ interface AppKitContext {
8064
8074
  * @defaultValue false
8065
8075
  */
8066
8076
  disableErrorReporting?: boolean;
8077
+ /**
8078
+ * Custom HTTP headers forwarded with the underlying CCTP provider's
8079
+ * attestation (Iris) API requests made by bridge operations.
8080
+ *
8081
+ * @remarks
8082
+ * Headers are merged on top of the SDK defaults (such as `Content-Type`)
8083
+ * rather than replacing them. The header is forwarded as-is to Circle's API;
8084
+ * the SDK does not interpret it.
8085
+ */
8086
+ headers?: Record<string, string>;
8067
8087
  }
8068
8088
 
8069
8089
  /**
package/earn.d.ts CHANGED
@@ -659,6 +659,8 @@ declare enum Blockchain {
659
659
  Celo_Alfajores_Testnet = "Celo_Alfajores_Testnet",
660
660
  Codex = "Codex",
661
661
  Codex_Testnet = "Codex_Testnet",
662
+ Cronos = "Cronos",
663
+ Cronos_Testnet = "Cronos_Testnet",
662
664
  Edge = "Edge",
663
665
  Edge_Testnet = "Edge_Testnet",
664
666
  Ethereum = "Ethereum",
@@ -900,6 +902,7 @@ declare enum BridgeChain {
900
902
  Avalanche = "Avalanche",
901
903
  Base = "Base",
902
904
  Codex = "Codex",
905
+ Cronos = "Cronos",
903
906
  Edge = "Edge",
904
907
  Ethereum = "Ethereum",
905
908
  HyperEVM = "HyperEVM",
@@ -923,6 +926,7 @@ declare enum BridgeChain {
923
926
  Avalanche_Fuji = "Avalanche_Fuji",
924
927
  Base_Sepolia = "Base_Sepolia",
925
928
  Codex_Testnet = "Codex_Testnet",
929
+ Cronos_Testnet = "Cronos_Testnet",
926
930
  Edge_Testnet = "Edge_Testnet",
927
931
  Ethereum_Sepolia = "Ethereum_Sepolia",
928
932
  HyperEVM_Testnet = "HyperEVM_Testnet",
@@ -6380,10 +6384,11 @@ interface AssetAmount {
6380
6384
  /**
6381
6385
  * Optional category tag for the amount.
6382
6386
  *
6383
- * Present on fee entries to identify the kind of fee for cross-chain
6384
- * deposit quotes this is the source-fee item type (e.g. `'FORWARD'`,
6385
- * `'PRE_FINALITY'`). Omitted when the amount has no meaningful category
6386
- * (plain deposit/withdrawal/share/reward amounts).
6387
+ * Present on fee entries to identify the kind of fee. For cross-chain deposit
6388
+ * quotes this is the source-fee item type (e.g. `'FORWARD'`,
6389
+ * `'PRE_FINALITY'`), and for withdrawal quotes this can identify Circle fees
6390
+ * (e.g. `'circle'`). Omitted when the amount has no meaningful
6391
+ * category (plain deposit/withdrawal/share/reward amounts).
6387
6392
  */
6388
6393
  readonly type?: string | undefined;
6389
6394
  /**
@@ -6744,12 +6749,12 @@ interface DepositQuoteInfo {
6744
6749
  /** Current annualized percentage yield. */
6745
6750
  readonly currentApy: number;
6746
6751
  /**
6747
- * Deposit fees charged in the deposit asset. For cross-chain quotes this
6748
- * carries one entry per source-fee item (e.g. `'FORWARD'`, `'PRE_FINALITY'`),
6749
- * each tagged with its own {@link AssetAmount.type} and
6750
- * {@link AssetAmount.status} (e.g. `'estimated'`). Empty when no such fee
6751
- * applies. Distinct from native gas estimates, which are reported separately
6752
- * as gas-fee fields.
6752
+ * Deposit fees charged by the quote. For cross-chain quotes this carries one
6753
+ * entry per source-fee item (e.g. `'FORWARD'`, `'PRE_FINALITY'`) in the
6754
+ * returned fee token and decimal precision, each tagged with its own
6755
+ * {@link AssetAmount.type} and {@link AssetAmount.status} (e.g.
6756
+ * `'estimated'`). Empty when no such fee applies. Distinct from native gas
6757
+ * estimates, which are reported separately as gas-fee fields.
6753
6758
  */
6754
6759
  readonly fees: readonly AssetAmount[];
6755
6760
  /**
@@ -6806,7 +6811,12 @@ interface WithdrawalQuoteInfo {
6806
6811
  * available balance and quoted withdrawal in a single round-trip.
6807
6812
  */
6808
6813
  readonly maxWithdrawable: AssetAmount;
6809
- /** Fees applied to the withdrawal. */
6814
+ /**
6815
+ * Fees applied to the withdrawal.
6816
+ *
6817
+ * Circle fees are returned with `type: 'circle'` so callers can distinguish
6818
+ * them from untyped plain fees and native gas estimates.
6819
+ */
6810
6820
  readonly fees: readonly AssetAmount[];
6811
6821
  /**
6812
6822
  * Estimated native gas fees for the transactions needed to withdraw.
@@ -7264,8 +7274,8 @@ interface CrossChainDepositParams<TFromAdapterCapabilities extends AdapterCapabi
7264
7274
  */
7265
7275
  readonly amount: string;
7266
7276
  /**
7267
- * Maximum source-collected bridge fee the caller is willing to sign for, in
7268
- * human-readable source token units.
7277
+ * Maximum source-collected bridge fee the caller is willing to accept, in
7278
+ * human-readable fee token units from the quote.
7269
7279
  *
7270
7280
  * Derive this from a recent cross-chain deposit quote by summing
7271
7281
  * `quote.fees[].amount`. The prepared bridge bundle must not exceed this cap
@@ -8064,6 +8074,16 @@ interface AppKitContext {
8064
8074
  * @defaultValue false
8065
8075
  */
8066
8076
  disableErrorReporting?: boolean;
8077
+ /**
8078
+ * Custom HTTP headers forwarded with the underlying CCTP provider's
8079
+ * attestation (Iris) API requests made by bridge operations.
8080
+ *
8081
+ * @remarks
8082
+ * Headers are merged on top of the SDK defaults (such as `Content-Type`)
8083
+ * rather than replacing them. The header is forwarded as-is to Circle's API;
8084
+ * the SDK does not interpret it.
8085
+ */
8086
+ headers?: Record<string, string>;
8067
8087
  }
8068
8088
 
8069
8089
  /**