com.digitalasset.canton.participant.config
ParticipantNodeConfig
Companion object ParticipantNodeConfig
final case class ParticipantNodeConfig(init: ParticipantInitConfig = ParticipantInitConfig(), crypto: CryptoConfig = CryptoConfig(), ledgerApi: LedgerApiServerConfig = LedgerApiServerConfig(), httpLedgerApi: Option[JsonApiConfig] = None, adminApi: AdminServerConfig = AdminServerConfig(), storage: StorageConfig = StorageConfig.Memory(), testingTime: Option[TestingTimeServiceConfig] = None, parameters: ParticipantNodeParameterConfig = ParticipantNodeParameterConfig(), sequencerClient: SequencerClientConfig = SequencerClientConfig(), replication: Option[ReplicationConfig] = None, features: EnterpriseParticipantFeaturesConfig = EnterpriseParticipantFeaturesConfig.default, monitoring: NodeMonitoringConfig = NodeMonitoringConfig(), topology: TopologyConfig = TopologyConfig(), alphaDynamic: DeclarativeParticipantConfig = DeclarativeParticipantConfig()) extends LocalNodeConfig with BaseParticipantConfig with ConfigDefaults[DefaultPorts, ParticipantNodeConfig] with UniformCantonConfigValidation with Product with Serializable
Configuration parameters for a single participant
Please note that any client connecting to the ledger-api of the respective participant must set his GRPC max inbound message size to 2x the value defined here, as we assume that a Canton transaction of N bytes will not be bigger than 2x N on the ledger-api. Though this is just an assumption. Please also note that the participant will refuse to connect to a synchronizer where its max inbound message size is not sufficient to guarantee the processing of all transactions.
- init
determines how this node is initialized
- crypto
determines the algorithms used for signing, hashing, and encryption
- ledgerApi
parameters of the interfaces that applications use to change and query the ledger
- httpLedgerApi
parameters for configuring the interaction with ledger via the HTTP JSON API. Configuring this key will enable the HTTP JSON API server.
- adminApi
parameters of the interface used to administrate the participant
- storage
determines how the participant stores the ledger
- testingTime
determines whether and how to support the ledger API time service
- parameters
general participant node parameters
- Alphabetic
- By Inheritance
- ParticipantNodeConfig
- UniformCantonConfigValidation
- CustomCantonConfigValidation
- CantonConfigValidation
- ConfigDefaults
- BaseParticipantConfig
- Serializable
- Product
- Equals
- LocalNodeConfig
- NodeConfig
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ParticipantNodeConfig(init: ParticipantInitConfig = ParticipantInitConfig(), crypto: CryptoConfig = CryptoConfig(), ledgerApi: LedgerApiServerConfig = LedgerApiServerConfig(), httpLedgerApi: Option[JsonApiConfig] = None, adminApi: AdminServerConfig = AdminServerConfig(), storage: StorageConfig = StorageConfig.Memory(), testingTime: Option[TestingTimeServiceConfig] = None, parameters: ParticipantNodeParameterConfig = ParticipantNodeParameterConfig(), sequencerClient: SequencerClientConfig = SequencerClientConfig(), replication: Option[ReplicationConfig] = None, features: EnterpriseParticipantFeaturesConfig = EnterpriseParticipantFeaturesConfig.default, monitoring: NodeMonitoringConfig = NodeMonitoringConfig(), topology: TopologyConfig = TopologyConfig(), alphaDynamic: DeclarativeParticipantConfig = DeclarativeParticipantConfig())
- init
determines how this node is initialized
- crypto
determines the algorithms used for signing, hashing, and encryption
- ledgerApi
parameters of the interfaces that applications use to change and query the ledger
- httpLedgerApi
parameters for configuring the interaction with ledger via the HTTP JSON API. Configuring this key will enable the HTTP JSON API server.
- adminApi
parameters of the interface used to administrate the participant
- storage
determines how the participant stores the ledger
- testingTime
determines whether and how to support the ledger API time service
- parameters
general participant node parameters
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 adminApi: AdminServerConfig
- Definition Classes
- ParticipantNodeConfig → LocalNodeConfig
- val alphaDynamic: DeclarativeParticipantConfig
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clientAdminApi: ClientConfig
- Definition Classes
- ParticipantNodeConfig → NodeConfig
- def clientLedgerApi: ClientConfig
- Definition Classes
- ParticipantNodeConfig → BaseParticipantConfig
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val crypto: CryptoConfig
- Definition Classes
- ParticipantNodeConfig → LocalNodeConfig
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val features: EnterpriseParticipantFeaturesConfig
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- val httpLedgerApi: Option[JsonApiConfig]
- val init: ParticipantInitConfig
- Definition Classes
- ParticipantNodeConfig → LocalNodeConfig
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val ledgerApi: LedgerApiServerConfig
- val monitoring: NodeMonitoringConfig
- Definition Classes
- ParticipantNodeConfig → LocalNodeConfig
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nodeTypeName: String
Human readable name for the type of node used for displaying config error messages
Human readable name for the type of node used for displaying config error messages
- Definition Classes
- ParticipantNodeConfig → LocalNodeConfig
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val parameters: ParticipantNodeParameterConfig
- Definition Classes
- ParticipantNodeConfig → LocalNodeConfig
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val replication: Option[ReplicationConfig]
- val sequencerClient: SequencerClientConfig
- Definition Classes
- ParticipantNodeConfig → LocalNodeConfig
- val storage: StorageConfig
- Definition Classes
- ParticipantNodeConfig → LocalNodeConfig
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val testingTime: Option[TestingTimeServiceConfig]
- def toRemoteConfig: RemoteParticipantConfig
- val topology: TopologyConfig
- Definition Classes
- ParticipantNodeConfig → LocalNodeConfig
- final def validate[T >: ParticipantNodeConfig.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])
- def withDefaults(ports: DefaultPorts, edition: CantonEdition): ParticipantNodeConfig
Returns this configuration with defaults set for the given edition if necessary.
Returns this configuration with defaults set for the given edition if necessary.
- Definition Classes
- ParticipantNodeConfig → ConfigDefaults