com.digitalasset.canton.participant.config
ParticipantNodeParameterConfig
Companion object ParticipantNodeParameterConfig
final case class ParticipantNodeParameterConfig(adminWorkflow: AdminWorkflowConfig = AdminWorkflowConfig(), maxUnzippedDarSize: Int = 1024 * 1024 * 1024, batching: BatchingConfig = BatchingConfig(), caching: CachingConfigs = CachingConfigs(), stores: ParticipantStoreConfig = ParticipantStoreConfig(), reassignmentTimeProofFreshnessProportion: NonNegativeInt = NonNegativeInt.tryCreate(3), minimumProtocolVersion: Option[ParticipantProtocolVersion] = Some( ParticipantProtocolVersion(ProtocolVersion.v33) ), initialProtocolVersion: ParticipantProtocolVersion = ParticipantProtocolVersion( ProtocolVersion.latest ), sessionSigningKeys: SessionSigningKeysConfig = SessionSigningKeysConfig.disabled, 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, watchdog: Option[WatchdogConfig] = None, packageMetadataView: PackageMetadataViewConfig = PackageMetadataViewConfig(), commandProgressTracker: CommandProgressTrackerConfig = CommandProgressTrackerConfig(), unsafeOnlinePartyReplication: Option[UnsafeOnlinePartyReplicationConfig] = None) 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
- reassignmentTimeProofFreshnessProportion
Proportion of the target synchronizer exclusivity timeout that is used as a freshness bound when requesting a time proof. Setting to 3 means we'll take a 1/3 of the target synchronizer exclusivity timeout and potentially we reuse a recent timeout if one exists within that bound, otherwise a new time proof will be requested. Setting to zero will disable reusing recent time proofs and will instead always fetch a new proof.
- 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
- packageMetadataView
Initialization parameters for the package metadata in-memory store.
- Alphabetic
- By Inheritance
- ParticipantNodeParameterConfig
- Serializable
- Product
- Equals
- UniformCantonConfigValidation
- CustomCantonConfigValidation
- CantonConfigValidation
- LocalNodeParametersConfig
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ParticipantNodeParameterConfig(adminWorkflow: AdminWorkflowConfig = AdminWorkflowConfig(), maxUnzippedDarSize: Int = 1024 * 1024 * 1024, batching: BatchingConfig = BatchingConfig(), caching: CachingConfigs = CachingConfigs(), stores: ParticipantStoreConfig = ParticipantStoreConfig(), reassignmentTimeProofFreshnessProportion: NonNegativeInt = NonNegativeInt.tryCreate(3), minimumProtocolVersion: Option[ParticipantProtocolVersion] = Some(
ParticipantProtocolVersion(ProtocolVersion.v33)
), initialProtocolVersion: ParticipantProtocolVersion = ParticipantProtocolVersion(
ProtocolVersion.latest
), sessionSigningKeys: SessionSigningKeysConfig = SessionSigningKeysConfig.disabled, 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, watchdog: Option[WatchdogConfig] = None, packageMetadataView: PackageMetadataViewConfig = PackageMetadataViewConfig(), commandProgressTracker: CommandProgressTrackerConfig = CommandProgressTrackerConfig(), unsafeOnlinePartyReplication: Option[UnsafeOnlinePartyReplicationConfig] = None)
- 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
- reassignmentTimeProofFreshnessProportion
Proportion of the target synchronizer exclusivity timeout that is used as a freshness bound when requesting a time proof. Setting to 3 means we'll take a 1/3 of the target synchronizer exclusivity timeout and potentially we reuse a recent timeout if one exists within that bound, otherwise a new time proof will be requested. Setting to zero will disable reusing recent time proofs and will instead always fetch a new proof.
- 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
- packageMetadataView
Initialization parameters for the package metadata in-memory store.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val adminWorkflow: AdminWorkflowConfig
- val alphaVersionSupport: Boolean
- Definition Classes
- ParticipantNodeParameterConfig → LocalNodeParametersConfig
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val batching: BatchingConfig
- Definition Classes
- ParticipantNodeParameterConfig → LocalNodeParametersConfig
- val betaVersionSupport: Boolean
- val caching: CachingConfigs
Various cache sizes
Various cache sizes
- Definition Classes
- ParticipantNodeParameterConfig → LocalNodeParametersConfig
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val commandProgressTracker: CommandProgressTrackerConfig
- val disableUpgradeValidation: Boolean
- 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
- UniformCantonConfigValidation → CustomCantonConfigValidation
- val dontWarnOnDeprecatedPV: Boolean
- val engine: CantonEngineConfig
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- val initialProtocolVersion: ParticipantProtocolVersion
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val journalGarbageCollectionDelay: NonNegativeFiniteDuration
- val ledgerApiServer: LedgerApiServerParametersConfig
- val maxUnzippedDarSize: Int
- val minimumProtocolVersion: Option[ParticipantProtocolVersion]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val packageMetadataView: PackageMetadataViewConfig
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val reassignmentTimeProofFreshnessProportion: NonNegativeInt
- val sessionSigningKeys: SessionSigningKeysConfig
- Definition Classes
- ParticipantNodeParameterConfig → LocalNodeParametersConfig
- val stores: ParticipantStoreConfig
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val unsafeOnlinePartyReplication: Option[UnsafeOnlinePartyReplicationConfig]
- final def validate[T >: ParticipantNodeParameterConfig.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
- Definition Classes
- CantonConfigValidation
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- val warnIfOverloadedFor: Option[NonNegativeFiniteDuration]
- val watchdog: Option[WatchdogConfig]
- Definition Classes
- ParticipantNodeParameterConfig → LocalNodeParametersConfig