Skip to main content
Version: 1.5.0

Variable: LaneFeature

const LaneFeature: { FAST_RATE_LIMITS: "FAST_RATE_LIMITS"; FINALITY_FAST: "FINALITY_FAST"; FINALITY_SAFE: "FINALITY_SAFE"; RATE_LIMITS: "RATE_LIMITS"; }

Defined in: chain.ts:275

Available lane feature keys. These represent features or thresholds that can be configured per-lane.

Type Declaration

FAST_RATE_LIMITS

readonly FAST_RATE_LIMITS: "FAST_RATE_LIMITS" = 'FAST_RATE_LIMITS'

Rate limiter bucket state when using non-default finality (FTF or FCR). Only meaningful when FTF is supported on this lane, i.e. LaneFeature.FINALITY_FAST is present and \> 0. If absent, the default rate limits (LaneFeature.RATE_LIMITS) apply even when using custom finality.

FINALITY_FAST

readonly FINALITY_FAST: "FINALITY_FAST" = 'FINALITY_FAST'

Minimum block confirmations for Faster-Than-Finality (FTF).

  • absent: the lane does not support FTF (pre-v2.0 lane).
  • 0: the lane supports FTF, but it is not enabled for this token (e.g. the token pool predates FTF, or FTF is configured to use default finality only).
  • \> 0: FTF is enabled; this is the minimum number of block confirmations required to use it.

FINALITY_SAFE

readonly FINALITY_SAFE: "FINALITY_SAFE" = 'FINALITY_SAFE'

Token supports "safe" finality option, aka Fast Confirmation Rule

RATE_LIMITS

readonly RATE_LIMITS: "RATE_LIMITS" = 'RATE_LIMITS'

Rate limiter bucket state for the lane/token with default finality.