c

com.digitalasset.canton.participant.config

CommunityParticipantConfig

final case class CommunityParticipantConfig(init: ParticipantInitConfig = ParticipantInitConfig(), crypto: CommunityCryptoConfig = CommunityCryptoConfig(), ledgerApi: LedgerApiServerConfig = LedgerApiServerConfig(), httpLedgerApiExperimental: Option[HttpApiConfig] = None, adminApi: CommunityAdminServerConfig = CommunityAdminServerConfig(), storage: CommunityStorageConfig = CommunityStorageConfig.Memory(), testingTime: Option[TestingTimeServiceConfig] = None, parameters: ParticipantNodeParameterConfig = ParticipantNodeParameterConfig(), sequencerClient: SequencerClientConfig = SequencerClientConfig(), caching: CachingConfigs = CachingConfigs(), monitoring: NodeMonitoringConfig = NodeMonitoringConfig()) extends LocalParticipantConfig with CommunityLocalNodeConfig with ConfigDefaults[DefaultPorts, CommunityParticipantConfig] 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 domain where its max inbound message size is not sufficient to guarantee the processing of all transactions.

Linear Supertypes
Serializable, Product, Equals, ConfigDefaults[DefaultPorts, CommunityParticipantConfig], CommunityLocalNodeConfig, LocalParticipantConfig, LocalNodeConfig, BaseParticipantConfig, NodeConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommunityParticipantConfig
  2. Serializable
  3. Product
  4. Equals
  5. ConfigDefaults
  6. CommunityLocalNodeConfig
  7. LocalParticipantConfig
  8. LocalNodeConfig
  9. BaseParticipantConfig
  10. NodeConfig
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 adminApi: CommunityAdminServerConfig

    parameters of the interface used to administrate the participant

    parameters of the interface used to administrate the participant

    Definition Classes
    CommunityParticipantConfig → LocalParticipantConfig → LocalNodeConfig
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val caching: CachingConfigs

    Various cache sizes

    Various cache sizes

    Definition Classes
    CommunityParticipantConfig → LocalNodeConfig
  7. def clientAdminApi: ClientConfig
    Definition Classes
    CommunityParticipantConfig → NodeConfig
  8. def clientLedgerApi: ClientConfig
    Definition Classes
    CommunityParticipantConfig → BaseParticipantConfig
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  10. val crypto: CommunityCryptoConfig

    determines the algorithms used for signing, hashing, and encryption

    determines the algorithms used for signing, hashing, and encryption

    Definition Classes
    CommunityParticipantConfig → LocalParticipantConfig → LocalNodeConfig
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. val httpLedgerApiExperimental: Option[HttpApiConfig]

    parameters for configuring the interaction with ledger via the HTTP JSON API.

    parameters for configuring the interaction with ledger via the HTTP JSON API. Configuring this key will enable the HTTP JSON API server. NOTE: This feature is experimental and MUST NOT be used in production code.

    Definition Classes
    CommunityParticipantConfig → LocalParticipantConfig
  14. val init: ParticipantInitConfig

    determines how this node is initialized

    determines how this node is initialized

    Definition Classes
    CommunityParticipantConfig → LocalParticipantConfig → LocalNodeConfig
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val ledgerApi: LedgerApiServerConfig

    parameters of the interfaces that applications use to change and query the ledger

    parameters of the interfaces that applications use to change and query the ledger

    Definition Classes
    CommunityParticipantConfig → LocalParticipantConfig
  17. val monitoring: NodeMonitoringConfig
    Definition Classes
    CommunityParticipantConfig → LocalNodeConfig
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. val 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
    LocalParticipantConfig → LocalNodeConfig
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  22. val parameters: ParticipantNodeParameterConfig

    general participant node parameters

    general participant node parameters

    Definition Classes
    CommunityParticipantConfig → LocalParticipantConfig → LocalNodeConfig
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val sequencerClient: SequencerClientConfig
    Definition Classes
    CommunityParticipantConfig → LocalNodeConfig
  25. val storage: CommunityStorageConfig

    determines how the participant stores the ledger

    determines how the participant stores the ledger

    Definition Classes
    CommunityParticipantConfig → CommunityLocalNodeConfig → LocalParticipantConfig → LocalNodeConfig
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. val testingTime: Option[TestingTimeServiceConfig]

    determines whether and how to support the ledger API time service

    determines whether and how to support the ledger API time service

    Definition Classes
    CommunityParticipantConfig → LocalParticipantConfig
  28. def toRemoteConfig: RemoteParticipantConfig
    Definition Classes
    CommunityParticipantConfig → LocalParticipantConfig
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. def withDefaults(ports: DefaultPorts): CommunityParticipantConfig

    Returns this configuration with defaults set if necessary.

    Returns this configuration with defaults set if necessary.

    Definition Classes
    CommunityParticipantConfig → ConfigDefaults

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 ConfigDefaults[DefaultPorts, CommunityParticipantConfig]

Inherited from CommunityLocalNodeConfig

Inherited from LocalParticipantConfig

Inherited from LocalNodeConfig

Inherited from BaseParticipantConfig

Inherited from NodeConfig

Inherited from AnyRef

Inherited from Any

Ungrouped