Type Members

1.  trait AdminCommandRunner extends AnyRef

   Support for running an admin command

2.  trait AmmoniteCacheLock extends AnyRef
3.  final case class AmmoniteConsoleConfig(cacheDir: Option[File] = AmmoniteConsoleConfig.defaultCacheDir, workingDir: Option[File] = None, colors: Boolean = true, verbose: Boolean = false, defaultLimit: PositiveInt = PositiveInt.tryCreate(1000)) extends UniformCantonConfigValidation with Product with Serializable

   Configure behaviour of ammonite

   Configure behaviour of ammonite

   cacheDir

   cache dir, defaults to ~/.ammonite. If none is given, in-memory is used. If you specify a cache dir, the Canton repl will startup faster. In our tests, we have very rarely observed unexpected compile errors when the cache was enabled; if you want to avoid that, set the cache dir to None (i.e. cache-dir = null in the config file).

   workingDir

   working directory. if none is given, we'll use the working directory of the Canton process

   colors

   if true (default), we'll use color output

   verbose

   if true (not default), we'll emit verbose ammonite output

   defaultLimit

   default limit parameter for commands that can potentially return many results

4.  trait BaseInspection[+I <: CantonNode] extends AnyRef

   Support for inspecting the instance

5.  final case class BindingsHolder(bindings: IndexedSeq[Bind[_]]) extends Product with Serializable

   ammonite requires a ApiHolder in this pattern to make items through bindings available within the dynamic Console environment.

6.  class BootstrapScriptException extends RuntimeException

   Thrown when the bootstrap script fails to execute

7.  class CantonHealthAdministration extends Helpful with NamedLogging with NoTracing
8.  final class CantonInternalError extends Throwable with NoStackTrace
9.  final class CommandFailure extends Throwable with NoStackTrace
10.  final case class CommandSuccessful[+A](value: A) extends ConsoleCommandResult[A] with Product with Serializable

    Successful command result

    Successful command result

    value

    The value returned from the command

11.  sealed trait ConsoleCommandResult[+A] extends AnyRef

    Response from a console command.

12.  class ConsoleEnvironment extends NamedLogging with FlagCloseable with NoTracing

    The environment in which console commands are evaluated.

    The environment in which console commands are evaluated.

    Annotations

    @SuppressWarnings()

13.  trait ConsoleErrorHandler extends AnyRef

    Handle an error from a console.

    Handle an error from a console. We expect this implementation will either throw or exit, hence the scala.Nothing return type.

14.  trait ConsoleMacros extends NamedLogging with NoTracing
15.  trait ConsoleOutput extends AnyRef

    Interface for output to the Console user.

16.  implicit class EitherToCommandResultExtensions[A, B] extends AnyRef

    Turn a either into a command result.

    Turn a either into a command result. Left is considered an error, Right is successful.

17.  class ExternalLedgerApiClient extends BaseLedgerApiAdministration with LedgerApiCommandRunner with FeatureFlagFilter with NamedLogging

    Bare, Canton agnostic parts of the ledger-api client

    Bare, Canton agnostic parts of the ledger-api client

    This implementation allows to access any kind of ledger-api client, which does not need to be Canton based. However, this comes at some cost, as some of the synchronization between nodes during transaction submission is not supported

18.  sealed trait FeatureFlag extends AnyRef
19.  trait FeatureFlagFilter extends NamedLogging
20.  class GrpcAdminCommandRunner extends NamedLogging with AutoCloseable with OnShutdownRunner with Spanning

    Attempt to run a grpc admin-api command against whatever is pointed at in the config

21.  class HeadlessConsole extends AutoCloseable
22.  class HealthDumpGenerator extends AnyRef

    Generates a health dump zip file containing information about the current Canton process This is the core of the implementation of the HealthDump gRPC endpoint.

23.  trait Helpful extends AnyRef

    Implementors will have a help method available that will be callable from the Console.

    Implementors will have a help method available that will be callable from the Console. Implementors should annotate appropriate methods with @Help.Summary to have them included.

24.  trait InstanceReference extends AdminCommandRunner with HasUniqueIdentifier with Helpful with NamedLogging with FeatureFlagFilter with PrettyPrinting
25.  trait LedgerApiCommandRunner extends AnyRef

    Support for running ledgerApi commands

26.  trait LocalInstanceReference extends InstanceReference with NoTracing

    Pointer for a potentially running instance by instance type (sequencer/mediator/participant) and its id.

    Pointer for a potentially running instance by instance type (sequencer/mediator/participant) and its id. These methods define the REPL interface for these instances (e.g. participant1 start)

27.  trait LocalInstancesExtensions[LocalInstanceRef <: LocalInstanceReference] extends Helpful

    Aliases to manage a sequence of instances in a REPL environment

28.  class LocalMediatorReference extends MediatorReference with LocalInstanceReference with SequencerConnectionAdministration with BaseInspection[MediatorNode]
29.  class LocalParticipantReference extends ParticipantReference with LocalInstanceReference with BaseInspection[ParticipantNode]
30.  class LocalParticipantReferencesExtensions extends ParticipantReferencesExtensions with LocalInstancesExtensions[LocalParticipantReference]
31.  class LocalSequencerReference extends SequencerReference with LocalInstanceReference with BaseInspection[SequencerNode]
32.  abstract class MediatorReference extends InstanceReference with ConsoleCommandGroup
33.  final case class NodeReferences[A, R <: A, L <: A](local: Seq[L], remote: Seq[R]) extends Product with Serializable
34.  abstract class ParticipantReference extends InstanceReference with ConsoleCommandGroup with ParticipantAdministration with LedgerApiAdministration with LedgerApiCommandRunner
35.  class ParticipantReferencesExtensions extends Helpful with NamedLogging with FeatureFlagFilter
36.  trait PublicApiCommandRunner extends AnyRef
37.  trait RemoteInstanceReference extends InstanceReference
38.  class RemoteMediatorReference extends MediatorReference with RemoteInstanceReference with SequencerConnectionAdministration
39.  class RemoteParticipantReference extends ParticipantReference with RemoteInstanceReference
40.  class RemoteSequencerReference extends SequencerReference with RemoteInstanceReference
41.  class RepairMacros extends NamedLogging with Helpful
42.  class SequencerPublicApiClient extends PublicApiCommandRunner with NamedLogging

    Allows to query the public api of a sequencer (e.g., sequencer connect service).

43.  abstract class SequencerReference extends InstanceReference with ConsoleCommandGroup
44.  class SimClockCommand extends AnyRef
45.  implicit class StringErrorEitherToCommandResultExtensions[A] extends AnyRef

    Turn an either where Left is a error message into a ConsoleCommandResult.