Packages

c

com.digitalasset.canton.console.commands

TopologyAdministrationGroup

class TopologyAdministrationGroup extends Helpful with FeatureFlagFilter

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TopologyAdministrationGroup
  2. FeatureFlagFilter
  3. NamedLogging
  4. Helpful
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TopologyAdministrationGroup(instance: InstanceReference, topologyQueueStatus: => Option[TopologyQueueStatus], consoleEnvironment: ConsoleEnvironment, loggerFactory: NamedLoggerFactory)

Value Members

  1. val consoleEnvironment: ConsoleEnvironment
    Definition Classes
    TopologyAdministrationGroup → FeatureFlagFilter
  2. 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"))
  3. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  4. def init_id(identifier: Identifier, fingerprint: Fingerprint): UniqueIdentifier
    Annotations
    @Summary(s = "Initialize the node with a unique identifier", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Every node in Canton is identified using a unique identifier, which is composed
    |of a user-chosen string and the fingerprint of a signing key. The signing key is the root key of
    |said namespace.
    |During initialisation, we have to pick such a unique identifier.
    |By default, initialisation happens automatically, but it can be turned off by setting the auto-init
    |option to false.
    |Automatic node initialisation is usually turned off to preserve the identity of a participant or domain
    |node (during major version upgrades) or if the topology transactions are managed through
    |a different topology manager than the one integrated into this node."""    )
  5. def load_transaction(bytes: ByteString): Unit
    Annotations
    @Summary(s = "Upload signed topology transaction", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Topology transactions can be issued with any topology manager. In some cases, such
    |transactions need to be copied manually between nodes. This function allows for
    |uploading previously exported topology transaction into the authorized store (which is
    |the name of the topology managers transaction store."""    )
  6. val loggerFactory: NamedLoggerFactory
    Definition Classes
    TopologyAdministrationGroup → NamedLogging
  7. object all extends Helpful
    Annotations
    @Summary(s = "Inspect all topology transactions at once", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "All Transactions")
  8. object domain_parameters_changes extends Helpful
    Annotations
    @Summary(s = "Manage domain parameters changes", flag = FeatureFlag.Preview) @Group(name = "Domain Parameters Changes")
  9. object identifier_delegations extends Helpful
    Annotations
    @Summary(s = "Manage identifier delegations", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Identifier delegations")
  10. object legal_identities
    Annotations
    @Summary(s = "Inspect legal identities", flag = FeatureFlag.Preview) @Group(name = "Legal Identities")
  11. object mediator_domain_states extends Helpful
    Annotations
    @Summary(s = "Inspect mediator domain states", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Mediator Domain States")
  12. object namespace_delegations extends Helpful
    Annotations
    @Summary(s = "Manage namespace delegations", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Namespace delegations")
  13. object owner_to_key_mappings extends Helpful
    Annotations
    @Summary(s = "Manage owner to key mappings", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Owner to key mappings")
  14. object participant_domain_states extends Helpful
    Annotations
    @Summary(s = "Inspect participant domain states", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Participant Domain States")
  15. object party_to_participant_mappings extends Helpful
    Annotations
    @Summary(s = "Manage party to participant mappings", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Party to participant mappings")
  16. object stores extends Helpful
    Annotations
    @Summary(s = "Inspect topology stores", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Topology stores")
  17. object synchronisation
    Annotations
    @Summary(s = "Topology synchronisation helpers", flag = FeatureFlag.Preview) @Group(name = "Synchronisation Helpers")
  18. object vetted_packages extends Helpful
    Annotations
    @Summary(s = "Manage package vettings", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Vetted Packages")