Packages

final case class DynamicDomainParameters(participantResponseTimeout: NonNegativeFiniteDuration, mediatorReactionTimeout: NonNegativeFiniteDuration, transferExclusivityTimeout: NonNegativeFiniteDuration, topologyChangeDelay: NonNegativeFiniteDuration, ledgerTimeRecordTimeTolerance: NonNegativeFiniteDuration) extends HasVersionedWrapper[VersionedDynamicDomainParameters] with HasProtoV0[protocol.v0.DynamicDomainParameters] with Product with Serializable

participantResponseTimeout

the amount of time (w.r.t. the sequencer clock) that a participant may take to validate a command and send a response. Once the timeout has elapsed for a request, the mediator will discard all responses for that request. Choose a lower value to reduce the time to reject a command in case one of the involved participants has high load / operational problems. Choose a higher value to reduce the likelihood of commands being rejected due to timeouts.

mediatorReactionTimeout

the maximum amount of time (w.r.t. the sequencer clock) that the mediator may take to validate the responses for a request and broadcast the result message. The mediator reaction timeout starts when the confirmation response timeout has elapsed. If the mediator does not send a result message within that timeout, participants must rollback the transaction underlying the request. Chooses a lower value to reduce the time to learn whether a command has been accepted. Choose a higher value to reduce the likelihood of commands being rejected due to timeouts.

transferExclusivityTimeout

this timeout affects who can initiate a transfer-in. Before the timeout, only the submitter of the transfer-out can initiate the corresponding transfer-in. After the timeout, every stakeholder of the contract can initiate a transfer-in, if it has not yet happened. Moreover, if this timeout is zero, no automatic transfer-ins will occur. Choose a low value, if you want to lower the time that contracts can be inactive due to ongoing transfers. TODO(andreas): Choosing a high value currently has no practical benefit, but will have benefits in a future version.

topologyChangeDelay

determines the offset applied to the topology transactions before they become active, in order to support parallel transaction processing

ledgerTimeRecordTimeTolerance

the maximum absolute difference between the ledger time and the record time of a command. If the absolute difference would be larger for a command, then the command must be rejected.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DynamicDomainParameters
  2. Serializable
  3. Product
  4. Equals
  5. HasProtoV0
  6. HasVersionedWrapper
  7. HasVersionedToByteString
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DynamicDomainParameters(participantResponseTimeout: NonNegativeFiniteDuration, mediatorReactionTimeout: NonNegativeFiniteDuration, transferExclusivityTimeout: NonNegativeFiniteDuration, topologyChangeDelay: NonNegativeFiniteDuration, ledgerTimeRecordTimeTolerance: NonNegativeFiniteDuration)

    participantResponseTimeout

    the amount of time (w.r.t. the sequencer clock) that a participant may take to validate a command and send a response. Once the timeout has elapsed for a request, the mediator will discard all responses for that request. Choose a lower value to reduce the time to reject a command in case one of the involved participants has high load / operational problems. Choose a higher value to reduce the likelihood of commands being rejected due to timeouts.

    mediatorReactionTimeout

    the maximum amount of time (w.r.t. the sequencer clock) that the mediator may take to validate the responses for a request and broadcast the result message. The mediator reaction timeout starts when the confirmation response timeout has elapsed. If the mediator does not send a result message within that timeout, participants must rollback the transaction underlying the request. Chooses a lower value to reduce the time to learn whether a command has been accepted. Choose a higher value to reduce the likelihood of commands being rejected due to timeouts.

    transferExclusivityTimeout

    this timeout affects who can initiate a transfer-in. Before the timeout, only the submitter of the transfer-out can initiate the corresponding transfer-in. After the timeout, every stakeholder of the contract can initiate a transfer-in, if it has not yet happened. Moreover, if this timeout is zero, no automatic transfer-ins will occur. Choose a low value, if you want to lower the time that contracts can be inactive due to ongoing transfers. TODO(andreas): Choosing a high value currently has no practical benefit, but will have benefits in a future version.

    topologyChangeDelay

    determines the offset applied to the topology transactions before they become active, in order to support parallel transaction processing

    ledgerTimeRecordTimeTolerance

    the maximum absolute difference between the ledger time and the record time of a command. If the absolute difference would be larger for a command, then the command must be rejected.

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 activenessTimeForDecisionTime(decisionTime: CantonTimestamp): CantonTimestamp

    Left inverse to decisionTimeFor.

    Left inverse to decisionTimeFor. Gives the minimum timestamp value if the activeness time would be below this value.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def automaticTransferInEnabled: Boolean
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def decisionTimeFor(activenessTime: CantonTimestamp): CantonTimestamp

    Computes the decision time for the given activeness time.

    Computes the decision time for the given activeness time.

    Right inverse to activenessTimeForDecisionTime.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val ledgerTimeRecordTimeTolerance: NonNegativeFiniteDuration
  13. val mediatorReactionTimeout: NonNegativeFiniteDuration
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def participantResponseDeadlineFor(timestamp: CantonTimestamp): CantonTimestamp
  18. val participantResponseTimeout: NonNegativeFiniteDuration
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. 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.

  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toByteArray(version: ProtocolVersion): Array[Byte]

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

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

    Definition Classes
    HasVersionedWrapper
  23. def toByteString(version: ProtocolVersion): ByteString

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

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

    Definition Classes
    HasVersionedWrapperHasVersionedToByteString
  24. def toProtoV0: v0.DynamicDomainParameters

    Yields the proto representation of the class.

    Yields the proto representation of the class.

    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.MemoizedEvidence).

    Definition Classes
    DynamicDomainParametersHasProtoV0
  25. def toProtoVersioned(version: ProtocolVersion): VersionedDynamicDomainParameters

    Yields the proto representation of the class inside a Versioned... wrapper.

    Yields the proto representation of the class inside a Versioned... 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.MemoizedEvidence).

    Definition Classes
    DynamicDomainParametersHasVersionedWrapper
  26. val topologyChangeDelay: NonNegativeFiniteDuration
  27. def transferExclusivityLimitFor(baseline: CantonTimestamp): CantonTimestamp
  28. val transferExclusivityTimeout: NonNegativeFiniteDuration
  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 writeToFile(outputFile: String, version: ProtocolVersion = ProtocolVersion.latest): Unit

    Writes the byte string representation of the corresponding Versioned... wrapper of this instance to a file.

    Writes the byte string representation of the corresponding Versioned... wrapper of this instance to a file.

    Definition Classes
    HasVersionedWrapper

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped