Packages

c

com.digitalasset.canton.console

LocalSequencerNodeReference

class LocalSequencerNodeReference extends SequencerNodeReference with LocalInstanceReference with BaseInspection[SequencerNode]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LocalSequencerNodeReference
  2. BaseInspection
  3. LocalInstanceReference
  4. NoTracing
  5. SequencerNodeReference
  6. InstanceReferenceWithSequencerConnection
  7. SequencerNodeAdministration
  8. InstanceReference
  9. CertificateAdministration
  10. PrettyPrinting
  11. PrettyUtil
  12. ShowUtil
  13. ShowSyntax
  14. ToShowOps
  15. FeatureFlagFilter
  16. NamedLogging
  17. Helpful
  18. AdminCommandRunner
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LocalSequencerNodeReference(consoleEnvironment: EnterpriseConsoleEnvironment, name: String)

Type Members

  1. type Status = SequencerNodeStatus
  2. class Initialization extends Helpful
    Definition Classes
    SequencerNodeAdministration
    Annotations
    @Summary(s = "Manage sequencer initialization", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "initialization")
  3. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  4. implicit class ShowEitherSyntax[L, R] extends AnyRef

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

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

    Definition Classes
    ShowUtil
  5. implicit class ShowLengthLimitedStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  6. implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
    Definition Classes
    ShowUtil
  7. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  8. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  9. implicit class ShowStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  10. 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
  11. 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: (SequencerNode) => 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]): 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
    LocalInstanceReferenceAdminCommandRunner
  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
    InstanceReference
    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 config: SequencerNodeConfig
    Definition Classes
    LocalSequencerNodeReferenceLocalInstanceReference
    Annotations
    @Summary(s = "Returns the sequencer configuration", flag = console.this.Help.Summary.<init>$default$2)
  14. val consoleEnvironment: EnterpriseConsoleEnvironment
  15. def crypto: Crypto
    Attributes
    protected[canton]
    Definition Classes
    BaseInspection
  16. 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
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(obj: Any): Boolean
    Definition Classes
    SequencerNodeReference → AnyRef → Any
  19. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  20. lazy val ethereum: EthereumCommands
    Annotations
    @Summary(s = """Methods specific to Ethereum sequencers""", flag = console.this.Help.Summary.<init>$default$2)
  21. lazy val ethereumDriverFactory: SequencerDriverFactory { type ConfigType = com.digitalasset.canton.domain.sequencing.config.EthereumLedgerNodeConfig[com.digitalasset.canton.domain.sequencing.config.EthereumLedgerNodeConfig.SequencerContractConfig] }
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def hashCode(): Int
    Definition Classes
    InstanceReference → AnyRef → Any
  24. def health: HealthAdministration[Status]
    Definition Classes
    SequencerNodeReferenceInstanceReference
    Annotations
    @Summary(s = "Health and diagnostic related commands", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Health")
  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. def id: SequencerId
    Definition Classes
    SequencerNodeReferenceInstanceReference
    Annotations
    @Summary(s = "Yields the globally unique id of this sequencer. " +
    "Throws an exception, if the id has not yet been allocated (e.g., the sequencer has not yet been started)."
    , flag = console.this.Help.Summary.<init>$default$2)
  28. def initialization: Initialization
    Definition Classes
    SequencerNodeAdministration
  29. val instanceType: String
    Attributes
    protected
    Definition Classes
    SequencerNodeReferenceInstanceReference
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. 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)
  32. 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)
  33. val keys: EnterpriseLocalKeyAdministrationGroup
  34. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  35. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    SequencerNodeReferenceNamedLogging
  36. def migrateInstanceDb(): Either[StartupError, _]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  37. val name: String
  38. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  41. val nodes: SequencerNodes[SequencerNodeConfig]
    Attributes
    protected
    Definition Classes
    LocalSequencerNodeReferenceLocalInstanceReference
  42. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  44. 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
  45. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  46. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  47. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  48. 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
  49. def parties: PartiesAdministrationGroup
  50. 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
  51. 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
  52. 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
  53. 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
  54. 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
  55. 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
  56. 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
  57. def repairMigrationOfInstance(force: Boolean): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  58. def runCommandIfRunning[Result](runner: => ConsoleCommandResult[Result]): ConsoleCommandResult[Result]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  59. def runningNode: Option[SequencerNodeBootstrap]
    Attributes
    protected[console]
    Definition Classes
    LocalSequencerNodeReferenceBaseInspection
  60. def sequencer: SequencerAdministrationGroup
    Definition Classes
    SequencerNodeReferenceInstanceReferenceWithSequencerConnection
    Annotations
    @Summary(s = "Manage the sequencer", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Sequencer")
  61. lazy val sequencerConnection: SequencerConnection
  62. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  63. 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
  64. def start(): Unit
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Start the instance", flag = console.this.Help.Summary.<init>$default$2)
  65. def startInstance(): Either[StartupError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  66. def startingNode: Option[SequencerNodeBootstrap]
    Attributes
    protected[console]
    Definition Classes
    LocalSequencerNodeReferenceBaseInspection
  67. def stop(): Unit
    Definition Classes
    LocalInstanceReference
    Annotations
    @Summary(s = "Stop the instance", flag = console.this.Help.Summary.<init>$default$2)
  68. def stopInstance(): Either[ShutdownError, Unit]
    Attributes
    protected
    Definition Classes
    LocalInstanceReference
  69. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  70. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  71. 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
  72. def topology: TopologyAdministrationGroup
  73. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  74. def tracedLogger: TracedLogger
    Attributes
    protected[console]
    Definition Classes
    InstanceReferenceAdminCommandRunner
  75. def underlying: Option[SequencerNode]
    Definition Classes
    BaseInspection
  76. 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
  77. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  78. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  79. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  80. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  81. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  82. object certs
    Definition Classes
    CertificateAdministration
    Annotations
    @Summary(s = "Manage your certificates", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Certificates")

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 NoTracing

Inherited from SequencerNodeReference

Inherited from InstanceReference

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from FeatureFlagFilter

Inherited from NamedLogging

Inherited from Helpful

Inherited from AdminCommandRunner

Inherited from AnyRef

Inherited from Any

Ungrouped