final case class ParticipantNodeParameterConfig(adminWorkflow: AdminWorkflowConfig = AdminWorkflowConfig(), maxUnzippedDarSize: Int = 1024 * 1024 * 1024, batching: BatchingConfig = BatchingConfig(), caching: CachingConfigs = CachingConfigs(), stores: ParticipantStoreConfig = ParticipantStoreConfig(), minimumProtocolVersion: Option[ParticipantProtocolVersion] = Some( ParticipantProtocolVersion(ProtocolVersion.v34) ), initialProtocolVersion: ParticipantProtocolVersion = ParticipantProtocolVersion( ProtocolVersion.latest ), alphaVersionSupport: Boolean = false, betaVersionSupport: Boolean = false, dontWarnOnDeprecatedPV: Boolean = false, warnIfOverloadedFor: Option[NonNegativeFiniteDuration] = Some( config.NonNegativeFiniteDuration.ofSeconds(20) ), ledgerApiServer: LedgerApiServerParametersConfig = LedgerApiServerParametersConfig(), engine: CantonEngineConfig = CantonEngineConfig(), journalGarbageCollectionDelay: NonNegativeFiniteDuration = config.NonNegativeFiniteDuration.ofSeconds(0), disableUpgradeValidation: Boolean = false, enableStrictDarValidation: Boolean = true, watchdog: Option[WatchdogConfig] = None, packageMetadataView: PackageMetadataViewConfig = PackageMetadataViewConfig(), commandProgressTracker: CommandProgressTrackerConfig = CommandProgressTrackerConfig(), unsafeOnlinePartyReplication: Option[UnsafeOnlinePartyReplicationConfig] = None, automaticallyPerformLogicalSynchronizerUpgrade: Boolean = true, activationFrequencyForWarnAboutConsistencyChecks: Long = 1000, reassignmentsConfig: ReassignmentsConfig = ReassignmentsConfig(), doNotAwaitOnCheckingIncomingCommitments: Boolean = false, commitmentCheckpointInterval: PositiveDurationSeconds = config.PositiveDurationSeconds.ofMinutes(1)) extends LocalNodeParametersConfig with UniformCantonConfigValidation with Product with Serializable

General participant node parameters

adminWorkflow

Configuration options for Canton admin workflows

maxUnzippedDarSize

maximum allowed size of unzipped DAR files (in bytes) the participant can accept for uploading. Defaults to 1GB.

batching

Various parameters that control batching related behavior

minimumProtocolVersion

The minimum protocol version that this participant will speak when connecting to a synchronizer

initialProtocolVersion

The initial protocol version used by the participant (default latest), e.g., used to create the initial topology transactions.

alphaVersionSupport

If set to true, will allow the participant to connect to a synchronizer with dev protocol version and will turn on unsafe Daml LF versions.

dontWarnOnDeprecatedPV

If true, then this participant will not emit a warning when connecting to a sequencer using a deprecated protocol version (such as 2.0.0).

warnIfOverloadedFor

If all incoming commands have been rejected due to PARTICIPANT_BACKPRESSURE during this interval, the participant will log a warning.

ledgerApiServer

ledger api server parameters The following specialized participant node performance tuning parameters may be grouped once a more final set of configs emerges.

journalGarbageCollectionDelay

How much time to delay the canton journal garbage collection

disableUpgradeValidation

Disable the package upgrade verification on DAR upload

enableStrictDarValidation

Enables the throwing of an error if lf>2.2 and the dar is not self-sufficient (i.e. throw an error if the set of included packages does not equal the set of imported packages). Normally, packages produced by damlc targeting 2.2 or above are self-sufficient. If set to false, errors are logged as warning instead.

packageMetadataView

Initialization parameters for the package metadata in-memory store.

automaticallyPerformLogicalSynchronizerUpgrade

Whether the participant automatically performs a handshake with the upgraded synchronizer after receiving enough sequencer connections, and whether the participants automatically connects to the synchronizer after the upgrade time.

activationFrequencyForWarnAboutConsistencyChecks

controls how often warning messages about com.digitalasset.canton.config.CantonParameters.enableAdditionalConsistencyChecks being enabled are logged, measured in the number of contract activations during a single connection to a synchronizer. Used only for database storage.

doNotAwaitOnCheckingIncomingCommitments

Enable fully asynchronous checking of incoming commitments. This may result in some incoming commitments not being checked in case of crashes or HA failovers.

commitmentCheckpointInterval

Checkpoint interval for commitments. Smaller intervals lead to less resource-intensive crash recovery, at the cost of more frequent DB writing of checkpoints. Regardless of this checkpoint interval, checkpointing is also performed at reconciliation interval boundaries.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParticipantNodeParameterConfig
  2. Serializable
  3. Product
  4. Equals
  5. UniformCantonConfigValidation
  6. CustomCantonConfigValidation
  7. CantonConfigValidation
  8. LocalNodeParametersConfig
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ParticipantNodeParameterConfig(adminWorkflow: AdminWorkflowConfig = AdminWorkflowConfig(), maxUnzippedDarSize: Int = 1024 * 1024 * 1024, batching: BatchingConfig = BatchingConfig(), caching: CachingConfigs = CachingConfigs(), stores: ParticipantStoreConfig = ParticipantStoreConfig(), minimumProtocolVersion: Option[ParticipantProtocolVersion] = Some( ParticipantProtocolVersion(ProtocolVersion.v34) ), initialProtocolVersion: ParticipantProtocolVersion = ParticipantProtocolVersion( ProtocolVersion.latest ), alphaVersionSupport: Boolean = false, betaVersionSupport: Boolean = false, dontWarnOnDeprecatedPV: Boolean = false, warnIfOverloadedFor: Option[NonNegativeFiniteDuration] = Some( config.NonNegativeFiniteDuration.ofSeconds(20) ), ledgerApiServer: LedgerApiServerParametersConfig = LedgerApiServerParametersConfig(), engine: CantonEngineConfig = CantonEngineConfig(), journalGarbageCollectionDelay: NonNegativeFiniteDuration = config.NonNegativeFiniteDuration.ofSeconds(0), disableUpgradeValidation: Boolean = false, enableStrictDarValidation: Boolean = true, watchdog: Option[WatchdogConfig] = None, packageMetadataView: PackageMetadataViewConfig = PackageMetadataViewConfig(), commandProgressTracker: CommandProgressTrackerConfig = CommandProgressTrackerConfig(), unsafeOnlinePartyReplication: Option[UnsafeOnlinePartyReplicationConfig] = None, automaticallyPerformLogicalSynchronizerUpgrade: Boolean = true, activationFrequencyForWarnAboutConsistencyChecks: Long = 1000, reassignmentsConfig: ReassignmentsConfig = ReassignmentsConfig(), doNotAwaitOnCheckingIncomingCommitments: Boolean = false, commitmentCheckpointInterval: PositiveDurationSeconds = config.PositiveDurationSeconds.ofMinutes(1))

    adminWorkflow

    Configuration options for Canton admin workflows

    maxUnzippedDarSize

    maximum allowed size of unzipped DAR files (in bytes) the participant can accept for uploading. Defaults to 1GB.

    batching

    Various parameters that control batching related behavior

    minimumProtocolVersion

    The minimum protocol version that this participant will speak when connecting to a synchronizer

    initialProtocolVersion

    The initial protocol version used by the participant (default latest), e.g., used to create the initial topology transactions.

    alphaVersionSupport

    If set to true, will allow the participant to connect to a synchronizer with dev protocol version and will turn on unsafe Daml LF versions.

    dontWarnOnDeprecatedPV

    If true, then this participant will not emit a warning when connecting to a sequencer using a deprecated protocol version (such as 2.0.0).

    warnIfOverloadedFor

    If all incoming commands have been rejected due to PARTICIPANT_BACKPRESSURE during this interval, the participant will log a warning.

    ledgerApiServer

    ledger api server parameters The following specialized participant node performance tuning parameters may be grouped once a more final set of configs emerges.

    journalGarbageCollectionDelay

    How much time to delay the canton journal garbage collection

    disableUpgradeValidation

    Disable the package upgrade verification on DAR upload

    enableStrictDarValidation

    Enables the throwing of an error if lf>2.2 and the dar is not self-sufficient (i.e. throw an error if the set of included packages does not equal the set of imported packages). Normally, packages produced by damlc targeting 2.2 or above are self-sufficient. If set to false, errors are logged as warning instead.

    packageMetadataView

    Initialization parameters for the package metadata in-memory store.

    automaticallyPerformLogicalSynchronizerUpgrade

    Whether the participant automatically performs a handshake with the upgraded synchronizer after receiving enough sequencer connections, and whether the participants automatically connects to the synchronizer after the upgrade time.

    activationFrequencyForWarnAboutConsistencyChecks

    controls how often warning messages about com.digitalasset.canton.config.CantonParameters.enableAdditionalConsistencyChecks being enabled are logged, measured in the number of contract activations during a single connection to a synchronizer. Used only for database storage.

    doNotAwaitOnCheckingIncomingCommitments

    Enable fully asynchronous checking of incoming commitments. This may result in some incoming commitments not being checked in case of crashes or HA failovers.

    commitmentCheckpointInterval

    Checkpoint interval for commitments. Smaller intervals lead to less resource-intensive crash recovery, at the cost of more frequent DB writing of checkpoints. Regardless of this checkpoint interval, checkpointing is also performed at reconciliation interval boundaries.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val activationFrequencyForWarnAboutConsistencyChecks: Long
  5. val adminWorkflow: AdminWorkflowConfig
  6. val alphaVersionSupport: Boolean
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val automaticallyPerformLogicalSynchronizerUpgrade: Boolean
  9. val batching: BatchingConfig
  10. val betaVersionSupport: Boolean
  11. val caching: CachingConfigs

    Various cache sizes

    Various cache sizes

    Definition Classes
    ParticipantNodeParameterConfigLocalNodeParametersConfig
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. val commandProgressTracker: CommandProgressTrackerConfig
  14. val commitmentCheckpointInterval: PositiveDurationSeconds
  15. val disableUpgradeValidation: Boolean
  16. val doNotAwaitOnCheckingIncomingCommitments: Boolean
  17. final def doValidate(edition: CantonEdition): Seq[CantonConfigValidationError]

    Returns all validation errors that are specific to this Canton configuration class.

    Returns all validation errors that are specific to this Canton configuration class. Successful validation should return an empty sequence.

    Validation errors of subconfigurations should not be reported by this method, but via the type class derivation.

    Attributes
    protected
    Definition Classes
    UniformCantonConfigValidationCustomCantonConfigValidation
  18. val dontWarnOnDeprecatedPV: Boolean
  19. val enableStrictDarValidation: Boolean
  20. val engine: CantonEngineConfig
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. val initialProtocolVersion: ParticipantProtocolVersion
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. val journalGarbageCollectionDelay: NonNegativeFiniteDuration
  26. val ledgerApiServer: LedgerApiServerParametersConfig
  27. val maxUnzippedDarSize: Int
  28. val minimumProtocolVersion: Option[ParticipantProtocolVersion]
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. val packageMetadataView: PackageMetadataViewConfig
  33. def productElementNames: Iterator[String]
    Definition Classes
    Product
  34. val reassignmentsConfig: ReassignmentsConfig
  35. val stores: ParticipantStoreConfig
  36. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  37. val unsafeOnlinePartyReplication: Option[UnsafeOnlinePartyReplicationConfig]
  38. final def validate[T >: ParticipantNodeParameterConfig.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
    Definition Classes
    CantonConfigValidation
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  42. val warnIfOverloadedFor: Option[NonNegativeFiniteDuration]
  43. val watchdog: Option[WatchdogConfig]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CantonConfigValidation

Inherited from AnyRef

Inherited from Any

Ungrouped