Packages

c

com.digitalasset.canton.console

LocalParticipantReference

class LocalParticipantReference extends ParticipantReference with LocalInstanceReference with BaseInspection[ParticipantNode]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LocalParticipantReference
  2. BaseInspection
  3. LocalInstanceReference
  4. ParticipantReference
  5. LedgerApiCommandRunner
  6. LedgerApiAdministration
  7. BaseLedgerApiAdministration
  8. BaseLedgerApiClient
  9. ParticipantAdministration
  10. InstanceReference
  11. CertificateAdministration
  12. PrettyPrinting
  13. PrettyUtil
  14. ShowUtil
  15. ShowSyntax
  16. ToShowOps
  17. FeatureFlagFilter
  18. NoTracing
  19. NamedLogging
  20. Helpful
  21. AdminCommandRunner
  22. AnyRef
  23. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LocalParticipantReference(consoleEnvironment: ConsoleEnvironment, name: String)

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

Value Members

  1. object db extends Helpful
    Definition Classes
    LocalInstanceReference
    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 access[T](ops: (ParticipantNode) => T): T
    Attributes
    protected[console]
    Definition Classes
    BaseInspection
  6. 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
  7. def adminCommand[Result](grpcCommand: GrpcAdminCommand[_, _, Result], httpCommand: HttpAdminCommand[_, _, Result]): ConsoleCommandResult[Result]

    Run an admin command and return its result.

    Run an admin command and return its result. Depending on the admin client config details, it will either run the GRPC or the HTTP admin command.

    Attributes
    protected[console]
    Definition Classes
    LocalInstanceReferenceAdminCommandRunner
  8. def adminCommand[Result](command: 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
    AdminCommandRunner
  9. def adminToken: Option[String]

    secret, not publicly documented way to get the admin token

  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def cantonConfig: CantonConfig
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  12. def check[T](flag: FeatureFlag)(command: => T): T
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  13. def clearLedgerId(): Unit
    Attributes
    protected
    Definition Classes
    BaseLedgerApiClient
  14. def clear_cache(): Unit
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  16. def commitments: LocalCommitmentsAdministrationGroup
    Annotations
    @Summary(s = "Commands to inspect and extract bilateral commitments", flag = FeatureFlag.Preview) @Group(name = "Commitments")
  17. def config: LocalParticipantConfig
    Definition Classes
    LocalParticipantReferenceLocalInstanceReferenceParticipantReference
    Annotations
    @Summary(s = "Return participant config", flag = console.this.Help.Summary.<init>$default$2)
  18. val consoleEnvironment: ConsoleEnvironment
  19. def crypto: Crypto
    Attributes
    protected[canton]
    Definition Classes
    BaseInspection
  20. 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
  21. def domainOfTransaction(transactionId: String): DomainId
    Attributes
    protected
    Definition Classes
    LedgerApiAdministrationBaseLedgerApiAdministration
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(obj: Any): Boolean
    Definition Classes
    LocalParticipantReference → AnyRef → Any
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def hashCode(): Int
    Definition Classes
    InstanceReference → AnyRef → Any
  26. def health: ParticipantHealthAdministration
    Definition Classes
    ParticipantReferenceInstanceReference
    Annotations
    @Summary(s = "Health and diagnostic related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Health")
  27. 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"))
  28. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  29. def id: ParticipantId
    Definition Classes
    ParticipantReferenceParticipantAdministration
    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)
  30. val instanceType: String
    Attributes
    protected
    Definition Classes
    ParticipantReferenceInstanceReference
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def is_initialized: Boolean
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Check if the local instance is running and is fully initialized", flag = console.this.Help.Summary.<init>$default$2)
  33. def is_running: Boolean
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Check if the local instance is running", flag = console.this.Help.Summary.<init>$default$2)
  34. val keys: LocalKeyAdministrationGroup
    Definition Classes
    LocalInstanceReferenceInstanceReference
    Annotations
    @Summary(s = "Manage public and secret keys", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Keys")
  35. def ledgerApiCommand[Result](command: GrpcAdminCommand[_, _, Result]): ConsoleCommandResult[Result]
    Attributes
    protected[console]
    Definition Classes
    LocalParticipantReferenceLedgerApiCommandRunner
  36. def ledgerApiCommand[Result](command: (LedgerId) => GrpcAdminCommand[_, _, Result]): ConsoleCommandResult[Result]
    Attributes
    protected[console]
    Definition Classes
    BaseLedgerApiClient
  37. def ledgerId(): Either[CommandError, LedgerId]
    Attributes
    protected[console]
    Definition Classes
    BaseLedgerApiClient
  38. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  39. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    ParticipantReferenceNamedLogging
  40. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  41. def migrateInstanceDb(): Either[StartupError, _]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  42. val name: String
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  45. val nodes: ParticipantNodes[environment.Environment.Config.ParticipantConfigType]
    Attributes
    protected
    Definition Classes
    LocalParticipantReferenceLocalInstanceReference
  46. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  48. def optionallyAwait[Tx](tx: Tx, txId: String, optTimeout: Option[TimeoutDuration]): Tx
    Attributes
    protected
    Definition Classes
    LedgerApiAdministrationBaseLedgerApiAdministration
  49. 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
  50. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  51. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  52. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  53. 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
  54. def parties: LocalParticipantPartiesAdministrationGroup
    Definition Classes
    LocalParticipantReferenceParticipantReferenceInstanceReference
    Annotations
    @Summary(s = "Inspect and manage parties", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Parties")
  55. def pretty: Pretty[InstanceReference]

    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
    InstanceReferencePrettyPrinting
  56. 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
  57. 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
  58. 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
  59. 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
  60. 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
  61. 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
  62. def pruning: LocalParticipantPruningAdministrationGroup
    Definition Classes
    LocalParticipantReferenceParticipantReference
    Annotations
    @Summary(s = "Commands to truncate the archive of the ledger", flag = FeatureFlag.Preview) @Group(name = "Ledger Pruning")
  63. def repairMigrationOfInstance(force: Boolean): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  64. def replication: ParticipantReplicationAdministrationGroup
    Annotations
    @Summary(s = "Manage participant replication", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Replication")
  65. def runCommandIfRunning[Result](runner: => ConsoleCommandResult[Result]): ConsoleCommandResult[Result]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  66. def runningNode: Option[CantonNodeBootstrap[ParticipantNode]]
  67. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  68. 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
  69. def start(): Unit
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Start the instance", flag = console.this.Help.Summary.<init>$default$2)
  70. def startInstance(): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  71. def stop(): Unit
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Stop the instance", flag = console.this.Help.Summary.<init>$default$2)
  72. def stopInstance(): Either[ShutdownError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  73. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  74. def testing: LocalParticipantTestingGroup
    Definition Classes
    LocalParticipantReferenceParticipantReference
    Annotations
    @Summary(s = "Commands used for development and testing", flag = FeatureFlag.Testing)
  75. def timeouts: ConsoleCommandTimeout
    Attributes
    protected
    Definition Classes
    BaseLedgerApiAdministration
  76. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  77. 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
  78. def topology: TopologyAdministrationGroup
    Definition Classes
    ParticipantReferenceParticipantAdministrationInstanceReference
    Annotations
    @Summary(s = "Topology management related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Topology") @Description(s = "This group contains access to the full set of topology management commands.")
  79. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  80. def tracedLogger: TracedLogger
    Attributes
    protected[console]
    Definition Classes
    InstanceReferenceAdminCommandRunner
  81. def underlying: Option[ParticipantNode]
    Definition Classes
    BaseInspection
  82. 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
  83. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  84. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  85. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  86. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  87. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  88. object repair extends Helpful
    Annotations
    @Summary(s = "Commands to repair the local participant contract state", flag = FeatureFlag.Repair) @Group(name = "Repair")
  89. 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")
  90. object certs
    Definition Classes
    CertificateAdministration
    Annotations
    @Summary(s = "Manage your certificates", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Certificates")
  91. 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")
  92. object domains extends Helpful
    Definition Classes
    ParticipantAdministration
    Annotations
    @Summary(s = "Manage domain connections", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Domains")
  93. 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")
  94. 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")
  95. 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 LocalInstanceReference

Inherited from ParticipantReference

Inherited from LedgerApiCommandRunner

Inherited from BaseLedgerApiClient

Inherited from InstanceReference

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from FeatureFlagFilter

Inherited from NoTracing

Inherited from NamedLogging

Inherited from Helpful

Inherited from AdminCommandRunner

Inherited from AnyRef

Inherited from Any

Ungrouped