Skip to main content
Version: 1.2.0

Variable: LaneFeature

const LaneFeature: { CUSTOM_BLOCK_CONFIRMATIONS_RATE_LIMITS: "CUSTOM_BLOCK_CONFIRMATIONS_RATE_LIMITS"; MIN_BLOCK_CONFIRMATIONS: "MIN_BLOCK_CONFIRMATIONS"; RATE_LIMITS: "RATE_LIMITS"; }

Defined in: chain.ts:246

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

Type Declaration​

CUSTOM_BLOCK_CONFIRMATIONS_RATE_LIMITS​

readonly CUSTOM_BLOCK_CONFIRMATIONS_RATE_LIMITS: "CUSTOM_BLOCK_CONFIRMATIONS_RATE_LIMITS" = 'CUSTOM_BLOCK_CONFIRMATIONS_RATE_LIMITS'

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

MIN_BLOCK_CONFIRMATIONS​

readonly MIN_BLOCK_CONFIRMATIONS: "MIN_BLOCK_CONFIRMATIONS" = 'MIN_BLOCK_CONFIRMATIONS'

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.

RATE_LIMITS​

readonly RATE_LIMITS: "RATE_LIMITS" = 'RATE_LIMITS'

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