c

com.digitalasset.canton.participant.config

ParticipantNodeParameterConfig

final case class ParticipantNodeParameterConfig(adminWorkflow: AdminWorkflowConfig = AdminWorkflowConfig(), partyChangeNotification: PartyNotificationConfig = PartyNotificationConfig.ViaDomain, maxUnzippedDarSize: Int = 1024 * 1024 * 1024, batching: BatchingConfig = BatchingConfig(), stores: ParticipantStoreConfig = ParticipantStoreConfig(), transferTimeProofFreshnessProportion: NonNegativeInt = NonNegativeInt.tryCreate(3), minimumProtocolVersion: Option[ParticipantProtocolVersion] = Some( ParticipantProtocolVersion( ProtocolVersion.v5 ) ), initialProtocolVersion: ParticipantProtocolVersion = ParticipantProtocolVersion( ProtocolVersion.latestStable ), devVersionSupport: Boolean = false, betaVersionSupport: Boolean = false, dontWarnOnDeprecatedPV: Boolean = false, warnIfOverloadedFor: Option[NonNegativeFiniteDuration] = Some( config.NonNegativeFiniteDuration.ofSeconds(20) ), ledgerApiServerParameters: LedgerApiServerParametersConfig = LedgerApiServerParametersConfig(), excludeInfrastructureTransactions: Boolean = true, engine: CantonEngineConfig = CantonEngineConfig(), allowForUnauthenticatedContractIds: Boolean = false, disableUpgradeValidation: Boolean = false, watchdog: Option[WatchdogConfig] = None, commandProgressTracker: CommandProgressTrackerConfig = CommandProgressTrackerConfig()) extends LocalNodeParametersConfig with Product with Serializable

General participant node parameters

adminWorkflow

Configuration options for Canton admin workflows

partyChangeNotification

Determines how eagerly the participant nodes notify the ledger api of party changes. By default ensure that parties are added via at least one domain before ACKing party creation to ledger api server indexer. This not only avoids flakiness in tests, but reflects that a party is not actually usable in canton until it's available through at least one domain.

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

transferTimeProofFreshnessProportion

Proportion of the target domain 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 domain 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 domain

initialProtocolVersion

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

devVersionSupport

If set to true, will allow the participant to connect to a domain 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.

ledgerApiServerParameters

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

excludeInfrastructureTransactions

If set, infrastructure transactions (i.e. ping, bong and dar distribution) will be excluded from participant metering.

allowForUnauthenticatedContractIds

Skip contract id authentication check, if the contract id scheme does not support authentication. You should enable this only if all participants on a domain mutually trust each other. Otherwise, an attacker may compromise integrity of the ledger.

disableUpgradeValidation

Disable the package upgrade verification on DAR upload

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

Instance Constructors

  1. new ParticipantNodeParameterConfig(adminWorkflow: AdminWorkflowConfig = AdminWorkflowConfig(), partyChangeNotification: PartyNotificationConfig = PartyNotificationConfig.ViaDomain, maxUnzippedDarSize: Int = 1024 * 1024 * 1024, batching: BatchingConfig = BatchingConfig(), stores: ParticipantStoreConfig = ParticipantStoreConfig(), transferTimeProofFreshnessProportion: NonNegativeInt = NonNegativeInt.tryCreate(3), minimumProtocolVersion: Option[ParticipantProtocolVersion] = Some( ParticipantProtocolVersion( ProtocolVersion.v5 ) ), initialProtocolVersion: ParticipantProtocolVersion = ParticipantProtocolVersion( ProtocolVersion.latestStable ), devVersionSupport: Boolean = false, betaVersionSupport: Boolean = false, dontWarnOnDeprecatedPV: Boolean = false, warnIfOverloadedFor: Option[NonNegativeFiniteDuration] = Some( config.NonNegativeFiniteDuration.ofSeconds(20) ), ledgerApiServerParameters: LedgerApiServerParametersConfig = LedgerApiServerParametersConfig(), excludeInfrastructureTransactions: Boolean = true, engine: CantonEngineConfig = CantonEngineConfig(), allowForUnauthenticatedContractIds: Boolean = false, disableUpgradeValidation: Boolean = false, watchdog: Option[WatchdogConfig] = None, commandProgressTracker: CommandProgressTrackerConfig = CommandProgressTrackerConfig())

    adminWorkflow

    Configuration options for Canton admin workflows

    partyChangeNotification

    Determines how eagerly the participant nodes notify the ledger api of party changes. By default ensure that parties are added via at least one domain before ACKing party creation to ledger api server indexer. This not only avoids flakiness in tests, but reflects that a party is not actually usable in canton until it's available through at least one domain.

    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

    transferTimeProofFreshnessProportion

    Proportion of the target domain 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 domain 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 domain

    initialProtocolVersion

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

    devVersionSupport

    If set to true, will allow the participant to connect to a domain 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.

    ledgerApiServerParameters

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

    excludeInfrastructureTransactions

    If set, infrastructure transactions (i.e. ping, bong and dar distribution) will be excluded from participant metering.

    allowForUnauthenticatedContractIds

    Skip contract id authentication check, if the contract id scheme does not support authentication. You should enable this only if all participants on a domain mutually trust each other. Otherwise, an attacker may compromise integrity of the ledger.

    disableUpgradeValidation

    Disable the package upgrade verification on DAR upload

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 adminWorkflow: AdminWorkflowConfig
  5. val allowForUnauthenticatedContractIds: Boolean
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val batching: BatchingConfig
  8. val betaVersionSupport: Boolean
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  10. val commandProgressTracker: CommandProgressTrackerConfig
  11. val devVersionSupport: Boolean
  12. val disableUpgradeValidation: Boolean
  13. val dontWarnOnDeprecatedPV: Boolean
  14. val engine: CantonEngineConfig
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. val excludeInfrastructureTransactions: Boolean
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  18. val initialProtocolVersion: ParticipantProtocolVersion
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val ledgerApiServerParameters: LedgerApiServerParametersConfig
  21. val maxUnzippedDarSize: Int
  22. val minimumProtocolVersion: Option[ParticipantProtocolVersion]
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  26. val partyChangeNotification: PartyNotificationConfig
  27. def productElementNames: Iterator[String]
    Definition Classes
    Product
  28. val stores: ParticipantStoreConfig
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. val transferTimeProofFreshnessProportion: NonNegativeInt
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. val warnIfOverloadedFor: Option[NonNegativeFiniteDuration]
  35. 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
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped