Skip to main content
Version: 1.3.1

Type Alias: TokenTransferFeeConfig

TokenTransferFeeConfig = { customBlockConfirmationsFeeUSDCents: number; customBlockConfirmationsTransferFeeBps: number; defaultBlockConfirmationsFeeUSDCents: number; defaultBlockConfirmationsTransferFeeBps: number; destBytesOverhead: number; destGasOverhead: number; isEnabled: boolean; }

Defined in: chain.ts:240

Token transfer fee configuration returned by TokenPool v2.0 contracts.

Remarks

Contains two fee dimensions per finality mode (default vs custom/FTF):

  • A flat USD surcharge (in cents) added to the CCIP fee via FeeQuoter
  • A BPS rate deducted directly from the transferred token amount by the pool

"Default" fields apply when blockConfirmations = 0 (standard finality). "Custom" fields apply when blockConfirmations > 0 (Faster-Than-Finality).

Properties

customBlockConfirmationsFeeUSDCents

customBlockConfirmationsFeeUSDCents: number

Defined in: chain.ts:248

USD surcharge (in cents) added to the CCIP fee under FTF (blockConfirmations > 0).


customBlockConfirmationsTransferFeeBps

customBlockConfirmationsTransferFeeBps: number

Defined in: chain.ts:252

BPS rate deducted from the transferred token amount under FTF.


defaultBlockConfirmationsFeeUSDCents

defaultBlockConfirmationsFeeUSDCents: number

Defined in: chain.ts:246

USD surcharge (in cents) added to the CCIP fee under standard finality (blockConfirmations = 0).


defaultBlockConfirmationsTransferFeeBps

defaultBlockConfirmationsTransferFeeBps: number

Defined in: chain.ts:250

BPS rate deducted from the transferred token amount under standard finality.


destBytesOverhead

destBytesOverhead: number

Defined in: chain.ts:244

Byte overhead added to the data availability cost estimate for token transfers.


destGasOverhead

destGasOverhead: number

Defined in: chain.ts:242

Gas overhead added to the execution cost estimate for token transfers on the destination chain.


isEnabled

isEnabled: boolean

Defined in: chain.ts:254

Whether token transfer fees are enabled for this pool.