Packages

class Setup extends Helpful

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Setup
  2. Helpful
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Setup()

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def authorize_mediator(mediatorId: MediatorId): Unit
    Annotations
    @Summary(s = "Authorize external Mediator node.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "Use this command to reinstigate an external mediator node that has been offboarded via offboard_mediator.")
  6. def bootstrap_domain(sequencers: Seq[SequencerNodeReference], mediators: Seq[MediatorReference]): Unit
    Annotations
    @Summary(s = "Bootstrap domain", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "Use this command to bootstrap the domain with an initial set of external sequencer(s) " +
    "and external mediator(s). Note that you only need to call this once, however it is safe to " +
    "call it again if necessary in case something went wrong and this needs to be retried."
    )
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. 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"))
  13. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  14. def init(sequencerConnection: SequencerConnection): Unit
    Annotations
    @Summary(s = "Initialize domain", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "This command triggers domain initialization and should be called once the initial topology data " +
    "has been authorized and sequenced. This is called as part of the setup.bootstrap command, so you " +
    "are unlikely to need to call this directly."
    )
  15. def init(sequencerConnections: SequencerConnections): Unit
    Annotations
    @Summary(s = "Initialize domain", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "This command triggers domain initialization and should be called once the initial topology data " +
    "has been authorized and sequenced. This is called as part of the setup.bootstrap command, so you " +
    "are unlikely to need to call this directly."
    )
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def offboard_mediator(mediatorId: MediatorId, force: Boolean = false): Unit
    Annotations
    @Summary(s = "Offboard external Mediator node.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Use this command to offboard an onboarded external mediator node.
    It removes the topology transaction that authorizes the given mediator ID to act as a mediator on the domain.
    If you afterwards want to authorize an offboarded mediator again, use authorize_mediator.
    You must apply force to offboard the last mediator of a domain."""
    )
  21. def onboard_mediator(mediator: MediatorReference, sequencerConnections: Seq[InstanceReferenceWithSequencerConnection]): Unit
    Annotations
    @Summary(s = "Onboard external Mediator node.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "Use this command to onboard an external mediator node. " +
    "If you're bootstrapping a domain with external sequencer(s) and this is the initial mediator, then use " +
    "setup.bootstrap_domain instead. For adding additional external mediators or onboard an external mediator with " +
    "a domain that runs a single embedded sequencer, use this command." +
    "Note that you only need to call this once."
    )
  22. def onboard_new_sequencer(initialSequencer: SequencerNodeReference, newSequencer: SequencerNodeReference): PublicKey
    Annotations
    @Summary(s = "Dynamically onboard new Sequencer node.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Use this command to dynamically onboard a new sequencer node that's not part of the initial set
    |of sequencer nodes. Do not use this for database sequencers."""
    )
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. object helper
    Annotations
    @Summary(s = """
    This is meant for use either only internally or as a helper in cases when the user is
    manually orchestrating the bootstrapping process.
    """
    , flag = console.this.Help.Summary.<init>$default$2)
    @Group(name = "Helper")

Deprecated Value Members

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

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped