Packages

c

com.digitalasset.canton.console.commands

LocalParticipantTestingGroup

class LocalParticipantTestingGroup extends ParticipantTestingGroup with FeatureFlagFilter with NoTracing

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LocalParticipantTestingGroup
  2. NoTracing
  3. ParticipantTestingGroup
  4. Helpful
  5. FeatureFlagFilter
  6. NamedLogging
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LocalParticipantTestingGroup(participantRef: ParticipantReference with BaseInspection[ParticipantNode], consoleEnvironment: ConsoleEnvironment, loggerFactory: NamedLoggerFactory)

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 acs_search(domainAlias: DomainAlias, filterId: String = "", filterPackage: String = "", filterTemplate: String = "", filterStakeholder: Option[PartyId] = None, limit: PositiveInt = defaultLimit): List[SerializableContract]
    Annotations
    @Summary(s = "Lookup of active contracts", flag = FeatureFlag.Testing)
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def await_domain_time(domainId: DomainId, time: CantonTimestamp, timeout: NonNegativeDuration = consoleEnvironment.commandTimeouts.ledgerCommand): Unit
    Definition Classes
    ParticipantTestingGroup
    Annotations
    @Summary(s = "Await for the given time to be reached on the given domain", flag = FeatureFlag.Testing)
  7. def await_domain_time(domainAlias: DomainAlias, time: CantonTimestamp, timeout: NonNegativeDuration): Unit
    Definition Classes
    ParticipantTestingGroup
    Annotations
    @Summary(s = "Await for the given time to be reached on the given domain", flag = FeatureFlag.Testing)
  8. def bong(targets: Set[ParticipantId], validators: Set[ParticipantId] = Set(), timeout: NonNegativeDuration = consoleEnvironment.commandTimeouts.testingBong, levels: Long = 0, gracePeriodMillis: Long = 1000, workflowId: String = "", id: String = ""): Duration
    Definition Classes
    ParticipantTestingGroup
    Annotations
    @Summary(s = "Send a bong to a set of target parties over the ledger. Levels > 0 leads to an exploding ping with exponential number of contracts. " +
    "Throw a RuntimeException in case of failure."
    , flag = FeatureFlag.Testing)
    @Description(s = """Initiates a racy ping to multiple participants,
    measuring the roundtrip time of the fastest responder, with an optional timeout.
    Grace-period is the time the bong will wait for a duplicate spent (which would indicate an error in the system) before exiting.
    If levels > 0, the ping command will lead to a binary explosion and subsequent dilation of
    contracts, where ``level`` determines the number of levels we will explode. As a result, the system will create
    (2^(L+2) - 3) contracts (where L stands for ``level``).
    Normally, only the initiator is a validator. Additional validators can be added using the validators argument.
    The bong command comes handy to run a burst test against the system and quickly leads to an overloading state."""
    )
  9. def cantonConfig: CantonConfig
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  10. def check[T](flag: FeatureFlag)(command: => T): T
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  12. val consoleEnvironment: ConsoleEnvironment
  13. def crypto_api(): SyncCryptoApiProvider
    Annotations
    @Summary(s = "Return the sync crypto api provider, which provides access to all cryptographic methods", flag = FeatureFlag.Testing)
  14. def defaultLimit: PositiveInt
    Attributes
    protected
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  18. def event_search(domain: Option[DomainAlias] = None, from: Option[Instant] = None, to: Option[Instant] = None, limit: PositiveInt = defaultLimit): Seq[(String, TimestampedEvent)]
    Annotations
    @Summary(s = "Lookup of events", flag = FeatureFlag.Testing) @Description(s = """Show the event logs. To select only events from a particular domain, use the domain alias.
    Leave the domain empty to search the combined event log containing the events of all domains.
    Note that if the domain is left blank, the values of `from` and `to` cannot be set.
    This is because the combined event log isn't guaranteed to have increasing timestamps.
    """
    )
  19. def fetch_domain_time(domainId: DomainId, timeout: NonNegativeDuration = consoleEnvironment.commandTimeouts.ledgerCommand): CantonTimestamp
    Definition Classes
    ParticipantTestingGroup
    Annotations
    @Summary(s = "Fetch the current time from the given domain", flag = FeatureFlag.Testing)
  20. def fetch_domain_time(domainAlias: DomainAlias, timeout: NonNegativeDuration): CantonTimestamp
    Definition Classes
    ParticipantTestingGroup
    Annotations
    @Summary(s = "Fetch the current time from the given domain", flag = FeatureFlag.Testing)
  21. def fetch_domain_times(timeout: NonNegativeDuration = consoleEnvironment.commandTimeouts.ledgerCommand): Unit
    Definition Classes
    ParticipantTestingGroup
    Annotations
    @Summary(s = "Fetch the current time from all connected domains", flag = FeatureFlag.Testing)
  22. def find_clean_commitments_timestamp(domain: DomainAlias, beforeOrAt: CantonTimestamp = CantonTimestamp.now()): Option[CantonTimestamp]
    Annotations
    @Summary(s = "The latest timestamp before or at the given one for which no commitment is outstanding", flag = FeatureFlag.Testing) @Description(s = """The latest timestamp before or at the given one for which no commitment is outstanding.
    |Note that this doesn't imply that pruning is possible at this timestamp, as the system might require some
    |additional data for crash recovery. Thus, this is useful for testing commitments; use the commands in the pruning
    |group for pruning.
    |Additionally, the result needn't fall on a "commitment tick" as specified by the reconciliation interval."""
    )
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  25. def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
    Annotations
    @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
  26. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. val loggerFactory: NamedLoggerFactory
  30. def maybe_bong(targets: Set[ParticipantId], validators: Set[ParticipantId] = Set(), timeout: NonNegativeDuration = consoleEnvironment.commandTimeouts.testingBong, levels: Long = 0, gracePeriodMillis: Long = 1000, workflowId: String = "", id: String = ""): Option[Duration]
    Definition Classes
    ParticipantTestingGroup
    Annotations
    @Summary(s = "Like bong, but returns None in case of failure.", flag = FeatureFlag.Testing)
  31. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  36. def pcs_search(domainAlias: DomainAlias, filterId: String = "", filterPackage: String = "", filterTemplate: String = "", activeSet: Boolean = false, limit: PositiveInt = defaultLimit): List[(Boolean, SerializableContract)]
    Annotations
    @Summary(s = "Lookup contracts in the Private Contract Store", flag = FeatureFlag.Testing) @Description(s = """Get raw access to the PCS of the given domain sync controller.
    The filter commands will check if the target value ``contains`` the given string.
    The arguments can be started with ``^`` such that ``startsWith`` is used for comparison or ``!`` to use ``equals``.
    The ``activeSet`` argument allows to restrict the search to the active contract set.
    """
    )
  37. def sequencer_messages(domain: DomainAlias, from: Option[Instant] = None, to: Option[Instant] = None, limit: PositiveInt = defaultLimit): Seq[PossiblyIgnoredProtocolEvent]
    Annotations
    @Summary(s = "Retrieve all sequencer messages", flag = FeatureFlag.Testing) @Description(s = """Optionally allows filtering for sequencer from a certain time span (inclusive on both ends) and
    |limiting the number of displayed messages. The returned messages will be ordered on most domain ledger implementations
    |if a time span is given.
    |
    |Fails if the participant has never connected to the domain."""
    )
  38. def state_inspection: SyncStateInspection
    Annotations
    @Summary(s = "Obtain access to the state inspection interface. Use at your own risk.", flag = FeatureFlag.Testing) @Description(s = """The state inspection methods can fatally and permanently corrupt the state of a participant.
    |The API is subject to change in any way."""
    )
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  42. def transaction_search(domain: Option[DomainAlias] = None, from: Option[Instant] = None, to: Option[Instant] = None, limit: PositiveInt = defaultLimit): Seq[(String, LfCommittedTransaction)]
    Annotations
    @Summary(s = "Lookup of accepted transactions", flag = FeatureFlag.Testing) @Description(s = """Show the accepted transactions as they appear in the event logs.
    To select only transactions from a particular domain, use the domain alias.
    Leave the domain empty to search the combined event log containing the events of all domains.
    Note that if the domain is left blank, the values of `from` and `to` cannot be set.
    This is because the combined event log isn't guaranteed to have increasing timestamps.
    """
    )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from NoTracing

Inherited from Helpful

Inherited from FeatureFlagFilter

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped