Packages

object interactive_submission extends Helpful

Annotations
@Summary(s = "Interactive submission", flag = FeatureFlag.Testing) @Group(name = "Interactive Submission")
Linear Supertypes
Helpful, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. interactive_submission
  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]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def execute(preparedTransaction: PreparedTransaction, transactionSignatures: Map[PartyId, Seq[Signature]], submissionId: String, hashingSchemeVersion: HashingSchemeVersion, userId: String = userId, deduplicationPeriod: Option[DeduplicationPeriod] = None, minLedgerTimeAbs: Option[Instant] = None): ExecuteSubmissionResponse
    Annotations
    @Summary(s = "Execute a prepared submission", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """
    preparedTransaction: the prepared transaction bytestring, typically obtained from the preparedTransaction field of the [[prepare]] response.
    transactionSignatures: the signatures of the hash of the transaction. The hash is typically obtained from the preparedTransactionHash field of the [[prepare]] response.
    Note however that the caller should re-compute the hash and ensure it matches the one provided in [[prepare]], to be certain they're signing a hash that correctly represents
    the transaction they want to submit.
    """    )
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  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. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. def preferred_package_version(parties: Set[PartyId], packageName: LfPackageName, synchronizerId: Option[SynchronizerId] = None, vettingValidAt: Option[CantonTimestamp] = None): Option[PackagePreference]
    Annotations
    @Summary(s = "Get the preferred package version for constructing a command submission", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """A preferred package is the highest-versioned package for a provided package-name
    that is vetted by all the participants hosting the provided parties.
    Ledger API clients should use this endpoint for constructing command submissions
    that are compatible with the provided preferred package, by making informed decisions on:
    - which are the compatible packages that can be used to create contracts
    - which contract or exercise choice argument version can be used in the command
    - which choices can be executed on a template or interface of a contract
    parties: The parties whose vetting state should be considered when computing the preferred package
    packageName: The package name for which the preferred package is requested
    synchronizerId: The synchronizer whose topology state to use for resolving this query.
    If not specified. the topology state of all the synchronizers the participant is connected to will be used.
    vettingValidAt: The timestamp at which the package vetting validity should be computed
    If not provided, the participant's current clock time is used.
    """    )
  18. def preferred_packages(packageVettingRequirements: Map[LfPackageName, Set[PartyId]], synchronizerId: Option[SynchronizerId] = None, vettingValidAt: Option[CantonTimestamp] = None): GetPreferredPackagesResponse
    Annotations
    @Summary(s = "Get the preferred packages for constructing a command submission", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """A preferred package is the highest-versioned package for a provided package-name
    that is vetted by all the participants hosting the provided parties.
    Ledger API clients should use this endpoint for constructing command submissions
    that are compatible with the provided preferred package, by making informed decisions on:
    - which are the compatible packages that can be used to create contracts
    - which contract or exercise choice argument version can be used in the command
    - which choices can be executed on a template or interface of a contract

    Generally it is enough to provide the requirements for the command's root package-names.
    Additional package-name requirements can be provided when additional informees need to use
    package dependencies of the command's root packages.

    parties: The parties whose vetting state should be considered when computing the preferred package
    packageName: The package name for which the preferred package is requested
    synchronizerId: The synchronizer whose topology state to use for resolving this query.
    If not specified. the topology state of all the synchronizers the participant is connected to will be used.
    vettingValidAt: The timestamp at which the package vetting validity should be computed
    If not provided, the participant's current clock time is used.
    """    )
  19. def prepare(actAs: Seq[PartyId], commands: Seq[Command], synchronizerId: Option[SynchronizerId] = None, commandId: String = UUID.randomUUID().toString, minLedgerTimeAbs: Option[Instant] = None, readAs: Seq[PartyId] = Seq.empty, disclosedContracts: Seq[DisclosedContract] = Seq.empty, userId: String = userId, userPackageSelectionPreference: Seq[LfPackageId] = Seq.empty, verboseHashing: Boolean = false, prefetchContractKeys: Seq[PrefetchContractKey] = Seq.empty, maxRecordTime: Option[CantonTimestamp] = None): PrepareSubmissionResponse
    Annotations
    @Summary(s = """Prepare a transaction for interactive submission
    Note that the hash in the response is provided for convenience. Callers should re-compute the hash
    of the transactions (and possibly compare it to the provided one) before signing it.
    """    , flag = console.this.Help.Summary.<init>$default$2)     @Description(s = """Prepare a transaction for interactive submission.
    |Similar to submit, except instead of submitting the transaction to the network,
    |a serialized version of the transaction will be returned, along with a hash.
    |This allows non-hosted parties to sign the hash with they private key before submitting it via the
    |execute command. If you wish to directly submit a command instead without the external signing step,
    |use submit instead."""    )
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped