Packages

final case class DynamicDomainParameters extends HasProtocolVersionedWrapper[DynamicDomainParameters] with PrettyPrinting with Product with Serializable

Exceptions thrown

DynamicDomainParameters$.InvalidDynamicDomainParameters if mediatorDeduplicationTimeout is less than twice of ledgerTimeRecordTimeTolerance.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DynamicDomainParameters
  2. Serializable
  3. Product
  4. Equals
  5. PrettyPrinting
  6. PrettyUtil
  7. ShowUtil
  8. ShowSyntax
  9. ToShowOps
  10. HasProtocolVersionedWrapper
  11. HasToByteString
  12. HasRepresentativeProtocolVersion
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  2. implicit class ShowEitherSyntax[L, R] extends AnyRef

    Enables the syntax show"${myEither.showMerged}".

    Enables the syntax show"${myEither.showMerged}".

    Definition Classes
    ShowUtil
  3. implicit class ShowLengthLimitedStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  4. implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
    Definition Classes
    ShowUtil
  5. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  6. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  7. implicit class ShowStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  8. 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
  9. abstract class StringOperators extends AnyRef

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Definition Classes
    ShowUtil

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. 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
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def automaticTransferInEnabled: Boolean
  7. def castRepresentativeProtocolVersion[T <: HasSupportedProtoVersions[_]](target: T): Either[String, RepresentativeProtocolVersion[T]]

    Casts this instance's representative protocol version to one for the target type.

    Casts this instance's representative protocol version to one for the target type. This only succeeds if the versioning schemes are the same.

    Definition Classes
    HasProtocolVersionedWrapper
    Annotations
    @SuppressWarnings()
  8. val catchUpConfig: Option[CatchUpConfig]
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  10. lazy val companionObj: DynamicDomainParameters.type
    Attributes
    protected
    Definition Classes
    DynamicDomainParametersHasProtocolVersionedWrapperHasRepresentativeProtocolVersion
    Annotations
    @transient()
  11. 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
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. 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
  15. def isEquivalentTo(protocolVersion: ProtocolVersion): Boolean
    Definition Classes
    HasProtocolVersionedWrapper
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def isSmallerOrEqualThan(protocolVersion: ProtocolVersion): Boolean
    Definition Classes
    HasProtocolVersionedWrapper
  18. val ledgerTimeRecordTimeTolerance: NonNegativeFiniteDuration
  19. val maxRatePerParticipant: NonNegativeInt
  20. val maxRequestSize: MaxRequestSize
  21. val mediatorDeduplicationTimeout: NonNegativeFiniteDuration
  22. val mediatorReactionTimeout: NonNegativeFiniteDuration
  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. 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
  27. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  28. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  29. 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
  30. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  31. 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
  32. val participantResponseTimeout: NonNegativeFiniteDuration
  33. def pretty: Pretty[DynamicDomainParameters]

    Indicates how to pretty print this instance.

    Indicates how to pretty print this instance. See PrettyPrintingTest for examples on how to implement this method.

    Definition Classes
    DynamicDomainParametersPrettyPrinting
  34. def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
    Definition Classes
    PrettyUtil
  35. 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
  36. 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
  37. 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
  38. 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
  39. 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
  40. def productElementNames: Iterator[String]
    Definition Classes
    Product
  41. def protoVersion: ProtoVersion

    Yields the Proto version that this class will be serialized to

    Yields the Proto version that this class will be serialized to

    Definition Classes
    HasProtocolVersionedWrapper
  42. val reconciliationInterval: PositiveSeconds
  43. val representativeProtocolVersion: RepresentativeProtocolVersion[DynamicDomainParameters.type]

    We have a correspondence {Proto version} <-> {[protocol version]}: each proto version correspond to a list of consecutive protocol versions.

    We have a correspondence {Proto version} <-> {[protocol version]}: each proto version correspond to a list of consecutive protocol versions. The representative is one instance of this list, usually the smallest value. In other words, the Proto versions induce an equivalence relation on the list of protocol version, thus use of representative.

    The method protocolVersionRepresentativeFor below allows to query the representative for an equivalence class.

    Definition Classes
    DynamicDomainParametersHasRepresentativeProtocolVersion
  44. val sequencerAggregateSubmissionTimeout: NonNegativeFiniteDuration
  45. def sequencerSigningTolerance: NonNegativeFiniteDuration

    In some situations, the sequencer signs transaction with slightly outdated keys.

    In some situations, the sequencer signs transaction with slightly outdated keys. This is to allow recipients to verify sequencer signatures when the sequencer keys have been rolled over and they have not yet received the new keys. This parameter determines how much outdated a signing key can be. Choose a higher value to avoid that the sequencer refuses to sign and send messages. Choose a lower value to reduce the latency of sequencer key rollovers. The sequencer signing tolerance must be at least participantResponseTimeout + mediatorReactionTimeout.

  46. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  47. 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
  48. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  49. def toByteArray: Array[Byte]

    Yields a byte array representation of the corresponding UntypedVersionedMessage wrapper of this instance.

    Yields a byte array representation of the corresponding UntypedVersionedMessage wrapper of this instance.

    Definition Classes
    HasProtocolVersionedWrapper
  50. def toByteString: ByteString

    Yields a byte string representation of the corresponding UntypedVersionedMessage wrapper of this instance.

    Yields a byte string representation of the corresponding UntypedVersionedMessage wrapper of this instance.

    Definition Classes
    HasProtocolVersionedWrapperHasToByteString
  51. def toProtoV0: v0.DynamicDomainParameters
  52. def toProtoV1: v1.DynamicDomainParameters
  53. def toProtoV2: v2.DynamicDomainParameters
  54. def toProtoVersioned: VersionedMessage[DynamicDomainParameters]

    Yields the proto representation of the class inside an UntypedVersionedMessage wrapper.

    Yields the proto representation of the class inside an UntypedVersionedMessage wrapper.

    Subclasses should make this method public by default, as this supports composing proto serializations. Keep it protected, if there are good reasons for it (e.g. com.digitalasset.canton.serialization.ProtocolVersionedMemoizedEvidence).

    Be aware that if calling on a class that defines a LegacyProtoConverter, this method will still return a VersionedMessage. If the current protocol version maps to the legacy converter, deserialization will then fail (as it will try to deserialize to the raw protobuf instead of the VersionedMessage wrapper this was serialized to. Prefer using toByteString which handles this use case correctly.

    Definition Classes
    HasProtocolVersionedWrapper
  55. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  56. 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. Final to avoid accidental overwriting.

    Definition Classes
    PrettyPrinting → AnyRef → Any
  57. val topologyChangeDelay: NonNegativeFiniteDuration
  58. val transferExclusivityTimeout: NonNegativeFiniteDuration
  59. def tryUpdate(participantResponseTimeout: NonNegativeFiniteDuration = participantResponseTimeout, mediatorReactionTimeout: NonNegativeFiniteDuration = mediatorReactionTimeout, transferExclusivityTimeout: NonNegativeFiniteDuration = transferExclusivityTimeout, topologyChangeDelay: NonNegativeFiniteDuration = topologyChangeDelay, ledgerTimeRecordTimeTolerance: NonNegativeFiniteDuration = ledgerTimeRecordTimeTolerance, mediatorDeduplicationTimeout: NonNegativeFiniteDuration = mediatorDeduplicationTimeout, reconciliationInterval: PositiveSeconds = reconciliationInterval, maxRatePerParticipant: NonNegativeInt = maxRatePerParticipant, sequencerAggregateSubmissionTimeout: NonNegativeFiniteDuration = sequencerAggregateSubmissionTimeout, catchUpConfig: Option[CatchUpConfig] = catchUpConfig): DynamicDomainParameters
  60. 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
  61. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  62. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  63. def update(transferExclusivityTimeout: NonNegativeFiniteDuration = transferExclusivityTimeout): DynamicDomainParameters
  64. def validateInstance(): Either[String, Unit]

    Will check that default value rules defined in companionObj.defaultValues hold.

    Will check that default value rules defined in companionObj.defaultValues hold.

    Definition Classes
    HasProtocolVersionedWrapper
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  67. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  68. def writeDelimitedTo(output: OutputStream): Either[String, Unit]

    Serializes this instance to a message together with a delimiter (the message length) to the given output stream.

    Serializes this instance to a message together with a delimiter (the message length) to the given output stream.

    This method works in conjunction with com.digitalasset.canton.version.HasProtocolVersionedCompanion2.parseDelimitedFromUnsafe which deserializes the message again. It is useful for serializing multiple messages to a single output stream through multiple invocations.

    Serialization is only supported for com.digitalasset.canton.version.HasSupportedProtoVersions.VersionedProtoConverter, an error message is returned otherwise.

    output

    the sink to which this message is serialized to

    returns

    an Either where left represents an error message, and right represents a successful message serialization

    Definition Classes
    HasProtocolVersionedWrapper
  69. def writeToFile(outputFile: String): Unit
    Definition Classes
    HasProtocolVersionedWrapper

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 PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from HasToByteString

Inherited from AnyRef

Inherited from Any

Ungrouped