Packages

object dars extends Helpful

Annotations
@Summary(s = "Manage DAR packages", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "DAR Management")
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. dars
  2. Helpful
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. def download(darHash: String, directory: String): Unit
    Annotations
    @Summary(s = "Downloads the DAR file with the given hash to the given directory", flag = console.this.Help.Summary.<init>$default$2)
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. 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"))
  12. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def list(limit: PositiveInt = defaultLimit, filterName: String = ""): Seq[DarDescription]
    Annotations
    @Summary(s = "List installed DAR files", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """List DARs installed on this participant
    |The arguments are:
    | filterName: filter by name (source description)
    | limit: Limit number of results (default none)
    """
    )
  15. def list_contents(hash: String): DarMetadata
    Annotations
    @Summary(s = "List contents of DAR files", flag = console.this.Help.Summary.<init>$default$2)
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. def remove(darHash: String, synchronizeVetting: Boolean = true): Unit
    Annotations
    @Summary(s = "Remove a DAR from the participant", flag = FeatureFlag.Preview) @Description(s = """Can be used to remove a DAR from the participant, if the following conditions are satisfied:
    |1. The main package of the DAR must be unused -- there should be no active contract from this package
    |
    |2. All package dependencies of the DAR should either be unused or contained in another of the participant node's uploaded DARs. Canton uses this restriction to ensure that the package dependencies of the DAR don't become "stranded" if they're in use.
    |
    |3. The main package of the dar should not be vetted. If it is vetted, Canton will try to automatically
    | revoke the vetting for the main package of the DAR, but this automatic vetting revocation will only succeed if the
    | main package vetting originates from a standard ``dars.upload``. Even if the automatic revocation fails, you can
    | always manually revoke the package vetting.
    |
    |If synchronizeVetting is true (default), then the command will block until the participant has observed the vetting transactions to be registered with the domain.
    |"""
    )
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. def upload(path: String, vetAllPackages: Boolean = true, synchronizeVetting: Boolean = true): String
    Annotations
    @Summary(s = "Upload a Dar to Canton", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Daml code is normally shipped as a Dar archive and must explicitly be uploaded to a participant.
    |A Dar is a collection of LF-packages, the native binary representation of Daml smart contracts.
    |In order to use Daml templates on a participant, the Dar must first be uploaded and then
    |vetted by the participant. Vetting will ensure that other participants can check whether they
    |can actually send a transaction referring to a particular Daml package and participant.
    |Vetting is done by registering a VettedPackages topology transaction with the topology manager.
    |By default, vetting happens automatically and this command waits for
    |the vetting transaction to be successfully registered on all connected domains.
    |This is the safe default setting minimizing race conditions.
    |
    |If vetAllPackages is true (default), the packages will all be vetted on all domains the participant is registered.
    |If synchronizeVetting is true (default), then the command will block until the participant has observed the vetting transactions to be registered with the domain.
    |
    |Note that synchronize vetting might block on permissioned domains that do not just allow participants to update the topology state.
    |In such cases, synchronizeVetting should be turned off.
    |Synchronize vetting can be invoked manually using $participant.package.synchronize_vettings()
    |"""
    )
  23. def validate(path: String): String
    Annotations
    @Summary(s = "Validate DARs against the current participants' state", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Performs the same DAR and Daml package validation checks that the upload call performs,
    but with no effects on the target participants: the DAR is not persisted or vetted."""
    )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. object vetting extends Helpful
    Annotations
    @Summary(s = "Change DAR vetting status", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Vetting")

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