Skip to main content
Version: 1.5.0

Type Alias: TokenTransferFeeConfig

TokenTransferFeeConfig = { destBytesOverhead: number; destGasOverhead: number; fastFinalityFeeUSDCents: number; fastFinalityTransferFeeBps: number; finalityFeeUSDCents: number; finalityTransferFeeBps: number; isEnabled: boolean; }

Defined in: chain.ts:242

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 finality is 0 or 'finalized' (standard finality). "Custom" fields apply when finality is a block depth \> 0 (Faster-Than-Finality).

Properties

destBytesOverhead

destBytesOverhead: number

Defined in: chain.ts:246

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


destGasOverhead

destGasOverhead: number

Defined in: chain.ts:244

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


fastFinalityFeeUSDCents

fastFinalityFeeUSDCents: number

Defined in: chain.ts:250

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


fastFinalityTransferFeeBps

fastFinalityTransferFeeBps: number

Defined in: chain.ts:254

BPS rate deducted from the transferred token amount under FTF.


finalityFeeUSDCents

finalityFeeUSDCents: number

Defined in: chain.ts:248

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


finalityTransferFeeBps

finalityTransferFeeBps: number

Defined in: chain.ts:252

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


isEnabled

isEnabled: boolean

Defined in: chain.ts:256

Whether token transfer fees are enabled for this pool.