Packages

t

com.digitalasset.canton.console

LocalParticipantReferenceCommon

sealed trait LocalParticipantReferenceCommon extends LedgerApiCommandRunner with ParticipantReferenceCommon with LocalInstanceReferenceCommon

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LocalParticipantReferenceCommon
  2. LocalInstanceReferenceCommon
  3. ParticipantReferenceCommon
  4. InstanceReferenceCommon
  5. PrettyPrinting
  6. PrettyUtil
  7. ShowUtil
  8. ShowSyntax
  9. ToShowOps
  10. AdminCommandRunner
  11. LedgerApiAdministration
  12. BaseLedgerApiAdministration
  13. NoTracing
  14. ParticipantAdministration
  15. ConsoleCommandGroup
  16. FeatureFlagFilter
  17. NamedLogging
  18. Helpful
  19. LedgerApiCommandRunner
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type Status = ParticipantStatus
  2. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  3. implicit class ShowEitherSyntax[L, R] extends AnyRef

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

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

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

Abstract Value Members

  1. abstract def adminToken: Option[String]
  2. abstract def config: LocalParticipantConfig
  3. abstract val consoleEnvironment: ConsoleEnvironment
  4. abstract def crypto: Crypto
    Attributes
    protected[canton]
    Definition Classes
    LocalInstanceReferenceCommon
  5. abstract def health: HealthAdministrationCommon[Status]
    Definition Classes
    InstanceReferenceCommon
  6. abstract val instanceType: String
    Attributes
    protected
    Definition Classes
    InstanceReferenceCommon
  7. abstract val name: String
  8. abstract val nodes: Nodes[CantonNode, CantonNodeBootstrap[CantonNode]]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  9. abstract def participantIsActiveOnDomain(domainId: DomainId, participantId: ParticipantId): Boolean
    Attributes
    protected
    Definition Classes
    ParticipantAdministration
  10. abstract def repair: LocalParticipantRepairAdministration
    Definition Classes
    LocalParticipantReferenceCommonParticipantReferenceCommon
    Annotations
    @Summary(s = "Commands to repair the local participant contract state", flag = FeatureFlag.Repair) @Group(name = "Repair")
  11. abstract def runner: AdminCommandRunner
    Attributes
    protected
    Definition Classes
    ConsoleCommandGroup
  12. abstract def testing: ParticipantTestingGroup
    Definition Classes
    ParticipantReferenceCommon
    Annotations
    @Summary(s = "Commands used for development and testing", flag = FeatureFlag.Testing) @Group(name = "Testing")
  13. abstract def topology: TopologyAdministrationGroupCommon
    Definition Classes
    InstanceReferenceCommon
  14. abstract def vettedPackagesOfParticipant(): Set[PackageId]
    Attributes
    protected
    Definition Classes
    ParticipantAdministration

Concrete Value Members

  1. object db extends Helpful
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Database related operations", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Database")
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. 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
  6. def adminCommand[Result](grpcCommand: GrpcAdminCommand[_, _, Result]): ConsoleCommandResult[Result]

    Run a GRPC admin command and return its result.

    Run a GRPC admin command and return its result. Most of the commands are only defined for the GRPC interface, so we default to showing an error message if the command is called for a node configured with an HTTP interface.

    Attributes
    protected[console]
    Definition Classes
    LocalInstanceReferenceCommonAdminCommandRunner
  7. lazy val applicationId: String
    Attributes
    protected
    Definition Classes
    BaseLedgerApiAdministration
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  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 clear_cache(): Unit
    Definition Classes
    InstanceReferenceCommon
    Annotations
    @Summary(s = "Clear locally cached variables", flag = FeatureFlag.Testing) @Description(s = "Some commands cache values on the client side. Use this command to explicitly clear the caches of these values.")
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  13. 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
  14. def defaultLimit: PositiveInt
    Attributes
    protected
    Definition Classes
    BaseLedgerApiAdministration
  15. def domainOfTransaction(transactionId: String): DomainId
    Attributes
    protected
    Definition Classes
    LedgerApiAdministrationBaseLedgerApiAdministration
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  19. implicit lazy val executionContext: ExecutionContext
    Attributes
    protected[canton]
    Definition Classes
    BaseLedgerApiAdministration
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def hashCode(): Int
    Definition Classes
    InstanceReferenceCommon → AnyRef → Any
  22. 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"))
  23. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  24. def id: ParticipantId
    Definition Classes
    ParticipantReferenceCommonInstanceReferenceCommonParticipantAdministration
    Annotations
    @Summary(s = "Yields the globally unique id of this participant. " +
    "Throws an exception, if the id has not yet been allocated (e.g., the participant has not yet been started)."
    , flag = console.this.Help.Summary.<init>$default$2)
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def is_initialized: Boolean
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Check if the local instance is running and is fully initialized", flag = console.this.Help.Summary.<init>$default$2)
  27. def is_running: Boolean
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Check if the local instance is running", flag = console.this.Help.Summary.<init>$default$2)
  28. def keys: LocalKeyAdministrationGroup
    Definition Classes
    LocalInstanceReferenceCommonInstanceReferenceCommon
    Annotations
    @Summary(s = "Manage public and secret keys", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Keys")
  29. def ledgerApiCommand[Result](command: GrpcAdminCommand[_, _, Result]): ConsoleCommandResult[Result]
    Attributes
    protected[console]
    Definition Classes
    LocalParticipantReferenceCommonLedgerApiCommandRunner
  30. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  31. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    ParticipantReferenceCommonNamedLogging
  32. def migrateInstanceDb(): Either[StartupError, _]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  33. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. def optionallyAwait[Tx](tx: Tx, txId: String, optTimeout: Option[NonNegativeDuration]): Tx
    Attributes
    protected
    Definition Classes
    LedgerApiAdministrationBaseLedgerApiAdministration
  39. 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
  40. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  41. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  42. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  43. 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
  44. def pretty: Pretty[InstanceReferenceCommon]

    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
    InstanceReferenceCommonPrettyPrinting
  45. def prettyInfix[T, U, V](first: (T) => U, infixOp: String, second: (T) => V)(implicit arg0: Pretty[U], arg1: Pretty[V]): Pretty[T]
    Definition Classes
    PrettyUtil
  46. 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
  47. 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
  48. 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
  49. 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
  50. 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
  51. def pruning: ParticipantPruningAdministrationGroup
    Definition Classes
    ParticipantReferenceCommon
    Annotations
    @Summary(s = "Commands to pruning the archive of the ledger", flag = FeatureFlag.Preview) @Group(name = "Ledger Pruning")
  52. def repairMigrationOfInstance(force: Boolean): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  53. def replication: ParticipantReplicationAdministrationGroup
    Definition Classes
    ParticipantReferenceCommon
    Annotations
    @Summary(s = "Manage participant replication", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Replication")
  54. def runCommandIfRunning[Result](runner: => ConsoleCommandResult[Result]): ConsoleCommandResult[Result]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  55. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  56. 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
  57. def start(): Unit
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Start the instance", flag = console.this.Help.Summary.<init>$default$2)
  58. def startInstance(): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  59. def stop(): Unit
    Definition Classes
    LocalInstanceReferenceCommon
    Annotations
    @Summary(s = "Stop the instance", flag = console.this.Help.Summary.<init>$default$2)
  60. def stopInstance(): Either[ShutdownError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReferenceCommon
  61. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  62. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  63. 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
  64. def token: Option[String]
    Attributes
    protected[console]
    Definition Classes
    LocalParticipantReferenceCommonLedgerApiCommandRunner
  65. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  66. def tracedLogger: TracedLogger
    Attributes
    protected[console]
    Definition Classes
    InstanceReferenceCommonAdminCommandRunner
  67. 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
  68. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  69. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  70. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  71. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  72. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  73. object ledger_api extends Helpful
    Definition Classes
    BaseLedgerApiAdministration
    Annotations
    @Summary(s = "Group of commands that access the ledger-api", flag = FeatureFlag.Testing) @Group(name = "Ledger Api")
  74. object ledger_api_v2 extends Helpful
    Definition Classes
    BaseLedgerApiAdministration
    Annotations
    @Summary(s = "Group of commands that access the ledger-api V2", flag = FeatureFlag.Testing) @Group(name = "Ledger Api")
  75. object dars extends Helpful
    Definition Classes
    ParticipantAdministration
    Annotations
    @Summary(s = "Manage DAR packages", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "DAR Management")
  76. object domains extends Helpful
    Definition Classes
    ParticipantAdministration
    Annotations
    @Summary(s = "Manage domain connections", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Domains")
  77. object packages extends Helpful
    Definition Classes
    ParticipantAdministration
    Annotations
    @Summary(s = "Manage raw Daml-LF packages", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Package Management")
  78. object resources extends Helpful
    Definition Classes
    ParticipantAdministration
    Annotations
    @Summary(s = "Functionality for managing resources", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Resource Management")
  79. object transfer extends Helpful
    Definition Classes
    ParticipantAdministration
    Annotations
    @Summary(s = "Composability related functionality", flag = FeatureFlag.Preview) @Group(name = "Transfer")

Deprecated Value Members

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

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from AdminCommandRunner

Inherited from NoTracing

Inherited from ConsoleCommandGroup

Inherited from FeatureFlagFilter

Inherited from NamedLogging

Inherited from Helpful

Inherited from LedgerApiCommandRunner

Inherited from AnyRef

Inherited from Any

Ungrouped