final case class SynchronizerParametersConfig(requiredSigningAlgorithmSpecs: Option[NonEmpty[Set[SigningAlgorithmSpec]]] = None, requiredSigningKeySpecs: Option[NonEmpty[Set[SigningKeySpec]]] = None, requiredEncryptionAlgorithmSpecs: Option[NonEmpty[Set[EncryptionAlgorithmSpec]]] = None, requiredEncryptionKeySpecs: Option[NonEmpty[Set[EncryptionKeySpec]]] = None, requiredSymmetricKeySchemes: Option[NonEmpty[Set[SymmetricKeyScheme]]] = None, requiredHashAlgorithms: Option[NonEmpty[Set[HashAlgorithm]]] = None, requiredCryptoKeyFormats: Option[NonEmpty[Set[CryptoKeyFormat]]] = None, requiredSignatureFormats: Option[NonEmpty[Set[SignatureFormat]]] = None, sessionSigningKeys: SessionSigningKeysConfig = SessionSigningKeysConfig.disabled, alphaVersionSupport: Boolean = false, betaVersionSupport: Boolean = false, dontWarnOnDeprecatedPV: Boolean = false) extends ProtocolConfig with PrettyPrinting with Product with Serializable
Configuration of synchronizer parameters that all members connecting to a synchronizer must adhere to.
To set these parameters, you need to be familiar with the Canton architecture. See <a href="https://docs.daml.com/canton/architecture/overview.html">the Canton architecture overview for further information.
- requiredSigningAlgorithmSpecs
The optional required signing algorithm specifications that a member has to support. If none is specified, all the allowed specifications are required.
- requiredSigningKeySpecs
The optional required signing key specifications that a member has to support. If none is specified, all the allowed specifications are required.
- requiredEncryptionAlgorithmSpecs
The optional required encryption algorithm specifications that a member has to support. If none is specified, all the allowed specifications are required.
- requiredEncryptionKeySpecs
The optional required encryption key specifications that a member has to support. If none is specified, all the allowed specifications are required.
- requiredSymmetricKeySchemes
The optional required symmetric key schemes that a member has to support. If none is specified, all the allowed schemes are required.
- requiredHashAlgorithms
The optional required hash algorithms that a member has to support. If none is specified, all the allowed algorithms are required.
- requiredCryptoKeyFormats
The optional required crypto key formats that a member has to support. If none is specified, all the supported algorithms are required.
- dontWarnOnDeprecatedPV
If true, then this synchronizer will not emit a warning when configured to use a deprecated protocol version (such as 2.0.0).
- Alphabetic
- By Inheritance
- SynchronizerParametersConfig
- Serializable
- Product
- Equals
- PrettyPrinting
- PrettyUtil
- ShowUtil
- ShowSyntax
- ToShowOps
- ProtocolConfig
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SynchronizerParametersConfig(requiredSigningAlgorithmSpecs: Option[NonEmpty[Set[SigningAlgorithmSpec]]] = None, requiredSigningKeySpecs: Option[NonEmpty[Set[SigningKeySpec]]] = None, requiredEncryptionAlgorithmSpecs: Option[NonEmpty[Set[EncryptionAlgorithmSpec]]] = None, requiredEncryptionKeySpecs: Option[NonEmpty[Set[EncryptionKeySpec]]] = None, requiredSymmetricKeySchemes: Option[NonEmpty[Set[SymmetricKeyScheme]]] = None, requiredHashAlgorithms: Option[NonEmpty[Set[HashAlgorithm]]] = None, requiredCryptoKeyFormats: Option[NonEmpty[Set[CryptoKeyFormat]]] = None, requiredSignatureFormats: Option[NonEmpty[Set[SignatureFormat]]] = None, sessionSigningKeys: SessionSigningKeysConfig = SessionSigningKeysConfig.disabled, alphaVersionSupport: Boolean = false, betaVersionSupport: Boolean = false, dontWarnOnDeprecatedPV: Boolean = false)
- requiredSigningAlgorithmSpecs
The optional required signing algorithm specifications that a member has to support. If none is specified, all the allowed specifications are required.
- requiredSigningKeySpecs
The optional required signing key specifications that a member has to support. If none is specified, all the allowed specifications are required.
- requiredEncryptionAlgorithmSpecs
The optional required encryption algorithm specifications that a member has to support. If none is specified, all the allowed specifications are required.
- requiredEncryptionKeySpecs
The optional required encryption key specifications that a member has to support. If none is specified, all the allowed specifications are required.
- requiredSymmetricKeySchemes
The optional required symmetric key schemes that a member has to support. If none is specified, all the allowed schemes are required.
- requiredHashAlgorithms
The optional required hash algorithms that a member has to support. If none is specified, all the allowed algorithms are required.
- requiredCryptoKeyFormats
The optional required crypto key formats that a member has to support. If none is specified, all the supported algorithms are required.
- dontWarnOnDeprecatedPV
If true, then this synchronizer will not emit a warning when configured to use a deprecated protocol version (such as 2.0.0).
Type Members
- implicit class ShowAnyRefSyntax extends AnyRef
- Definition Classes
- ShowUtil
- implicit class ShowEitherSyntax[L, R] extends AnyRef
Enables the syntax
show"${myEither.showMerged}".Enables the syntax
show"${myEither.showMerged}".- Definition Classes
- ShowUtil
- implicit class ShowLengthLimitedStringSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowOptionSyntax[T] extends AnyRef
- Definition Classes
- ShowUtil
- implicit class ShowProductSyntax extends AnyRef
- Definition Classes
- ShowUtil
- Annotations
- @SuppressWarnings()
- implicit class ShowStringSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowTraversableSyntax[T] extends AnyRef
Enables syntax like
show"Found several elements: ${myCollection.mkShow()}".Enables syntax like
show"Found several elements: ${myCollection.mkShow()}".- Definition Classes
- ShowUtil
- abstract class StringOperators extends AnyRef
Enables syntax like:
Enables syntax like:
show"This is a string: ${myString.doubleQuoted}"and:
show"This is a hash: ${myHash.readableHash}"- Definition Classes
- ShowUtil
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
- def adHocPrettyInstance[T <: Product](implicit c: ClassTag[T]): Pretty[T]
Use this as a temporary solution, to make the code compile during an ongoing migration.
Use this as a temporary solution, to make the code compile during an ongoing migration. Drawbacks:
- Instances of
Pretty[T]are ignored. - No parameter names
- Definition Classes
- PrettyUtil
- Instances of
- val alphaVersionSupport: Boolean
- Definition Classes
- SynchronizerParametersConfig → ProtocolConfig
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val betaVersionSupport: Boolean
- Definition Classes
- SynchronizerParametersConfig → ProtocolConfig
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def customParam[T](getValue: (T) => String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]
Use this if you need a custom representation of a parameter.
Use this if you need a custom representation of a parameter. Do not use this to create lengthy strings, as line wrapping is not supported.
- Definition Classes
- PrettyUtil
- val dontWarnOnDeprecatedPV: Boolean
- Definition Classes
- SynchronizerParametersConfig → ProtocolConfig
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def indicateOmittedFields[T]: (T) => Option[Tree]
Use this to indicate that you've omitted fields from pretty printing
Use this to indicate that you've omitted fields from pretty printing
- Definition Classes
- PrettyUtil
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- def param[T, V](name: String, getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]
A tree representing both parameter name and value.
A tree representing both parameter name and value.
- Definition Classes
- PrettyUtil
- def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def paramIfNotDefault[T, V](name: String, getValue: (T) => V, default: V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
A tree only written if not matching the default value
A tree only written if not matching the default value
- Definition Classes
- PrettyUtil
- def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def paramWithoutValue[T](name: String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]
A tree representing a parameter name without a parameter value.
A tree representing a parameter name without a parameter value. Use this for parameters storing confidential or binary data.
- Definition Classes
- PrettyUtil
- def pretty: Pretty[SynchronizerParametersConfig]
Indicates how to pretty print this instance.
Indicates how to pretty print this instance. See
PrettyPrintingTestfor examples on how to implement this method.- Attributes
- protected
- Definition Classes
- SynchronizerParametersConfig → PrettyPrinting
- def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
- Definition Classes
- PrettyUtil
- def prettyNode[T](label: String, children: (T) => Option[Tree]*): Pretty[T]
A tree consisting of a labelled node with the given children.
A tree consisting of a labelled node with the given children.
- Definition Classes
- PrettyUtil
- def prettyOfClass[T](getParamTrees: (T) => Option[Tree]*): Pretty[T]
A tree representing the type name and parameter trees.
A tree representing the type name and parameter trees.
- Definition Classes
- PrettyUtil
- def prettyOfClassWithName[T](name: String)(getParamTrees: (T) => Option[Tree]*): Pretty[T]
Like prettyOfClass, except takes an explicit name for the class.
Like prettyOfClass, except takes an explicit name for the class.
- Definition Classes
- PrettyUtil
- def prettyOfObject[T <: Product]: Pretty[T]
A tree presenting the type name only.
A tree presenting the type name only. (E.g., for case objects.)
- Definition Classes
- PrettyUtil
- def prettyOfParam[T, V](getValue: (T) => V)(implicit arg0: Pretty[V]): Pretty[T]
Use this to give a class with a singleton parameter the same pretty representation as the parameter.
Use this to give a class with a singleton parameter the same pretty representation as the parameter.
- Definition Classes
- PrettyUtil
- def prettyOfString[T](toString: (T) => String): Pretty[T]
Creates a pretty instance from a string function.
Creates a pretty instance from a string function. Do not use this with lengthy strings, as line wrapping is not supported.
- Definition Classes
- PrettyUtil
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val requiredCryptoKeyFormats: Option[NonEmpty[Set[CryptoKeyFormat]]]
- val requiredEncryptionAlgorithmSpecs: Option[NonEmpty[Set[EncryptionAlgorithmSpec]]]
- val requiredEncryptionKeySpecs: Option[NonEmpty[Set[EncryptionKeySpec]]]
- val requiredHashAlgorithms: Option[NonEmpty[Set[HashAlgorithm]]]
- val requiredSignatureFormats: Option[NonEmpty[Set[SignatureFormat]]]
- val requiredSigningAlgorithmSpecs: Option[NonEmpty[Set[SigningAlgorithmSpec]]]
- val requiredSigningKeySpecs: Option[NonEmpty[Set[SigningKeySpec]]]
- val requiredSymmetricKeySchemes: Option[NonEmpty[Set[SymmetricKeyScheme]]]
- val sessionSigningKeys: SessionSigningKeysConfig
- Definition Classes
- SynchronizerParametersConfig → ProtocolConfig
- implicit final def showInterpolator(sc: StringContext): ShowInterpolator
- Definition Classes
- ShowSyntax
- implicit def showPretty[T](implicit arg0: Pretty[T]): Show[T]
Enables the syntax
show"This object is pretty: $myPrettyType".Enables the syntax
show"This object is pretty: $myPrettyType".- Definition Classes
- ShowUtil
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
- Definition Classes
- ToShowOps
- def toStaticSynchronizerParameters(cryptoConfig: CryptoConfig = CryptoConfig(), protocolVersion: ProtocolVersion): Either[String, StaticSynchronizerParameters]
Converts the synchronizer parameters config into a synchronizer parameters protocol message.
Converts the synchronizer parameters config into a synchronizer parameters protocol message.
Sets the required crypto schemes based on the provided crypto config if they are unset in the config.
- final def toString(): String
Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter.
Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter.
Finalto avoid accidental overwriting.- Definition Classes
- PrettyPrinting → AnyRef → Any
- def unnamedParam[T, V](getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]
A tree representing a parameter value without a parameter name.
A tree representing a parameter value without a parameter name.
- Definition Classes
- PrettyUtil
- def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- 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])