Skip to main content
Version: 1.16.0

Type Alias: TokenTransferFeeConfig

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

Defined in: chain.ts:500

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:504

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

destGasOverhead​

destGasOverhead: number

Defined in: chain.ts:502

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

fastFinalityFeeUSDCents​

fastFinalityFeeUSDCents: number

Defined in: chain.ts:508

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

fastFinalityTransferFeeBps​

fastFinalityTransferFeeBps: number

Defined in: chain.ts:512

BPS rate deducted under FTF (0..9999; 1 BPS = 0.01%, 10000 = 100% is invalid).

finalityFeeUSDCents​

finalityFeeUSDCents: number

Defined in: chain.ts:506

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

finalityTransferFeeBps​

finalityTransferFeeBps: number

Defined in: chain.ts:510

BPS rate deducted under standard finality (0..9999; 1 BPS = 0.01%, 10000 = 100% is invalid).

isEnabled​

isEnabled: boolean

Defined in: chain.ts:514

Whether token transfer fees are enabled for this pool.