Package com.daml.ledger.api.v2.interactive

Class InteractiveSubmissionServiceGrpc.InteractiveSubmissionServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<InteractiveSubmissionServiceGrpc.InteractiveSubmissionServiceBlockingStub>

com.daml.ledger.api.v2.interactive.InteractiveSubmissionServiceGrpc.InteractiveSubmissionServiceBlockingStub

Enclosing class:

InteractiveSubmissionServiceGrpc

public static final class InteractiveSubmissionServiceGrpc.InteractiveSubmissionServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<InteractiveSubmissionServiceGrpc.InteractiveSubmissionServiceBlockingStub>

A stub to allow clients to do synchronous rpc calls to service InteractiveSubmissionService.

 Service allowing interactive construction of command submissions
 The prepare and execute endpoints allow to submit commands in 2-steps:
 1. prepare transaction from commands,
 2. submit the prepared transaction
 This gives callers the ability to sign the daml transaction with their own signing keys
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
protected InteractiveSubmissionServiceGrpc.InteractiveSubmissionServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
InteractiveSubmissionServiceOuterClass.ExecuteSubmissionResponse	executeSubmission(InteractiveSubmissionServiceOuterClass.ExecuteSubmissionRequest request)	Execute a prepared submission _asynchronously_ on the ledger.
InteractiveSubmissionServiceOuterClass.ExecuteSubmissionAndWaitResponse	executeSubmissionAndWait(InteractiveSubmissionServiceOuterClass.ExecuteSubmissionAndWaitRequest request)	Similar to ExecuteSubmission but _synchronously_ wait for the completion of the transaction IMPORTANT: Relying on the response from this endpoint requires trusting the Participant Node to be honest.
InteractiveSubmissionServiceOuterClass.ExecuteSubmissionAndWaitForTransactionResponse	executeSubmissionAndWaitForTransaction(InteractiveSubmissionServiceOuterClass.ExecuteSubmissionAndWaitForTransactionRequest request)	Similar to ExecuteSubmissionAndWait but additionally returns the transaction IMPORTANT: Relying on the response from this endpoint requires trusting the Participant Node to be honest.
InteractiveSubmissionServiceOuterClass.GetPreferredPackagesResponse	getPreferredPackages(InteractiveSubmissionServiceOuterClass.GetPreferredPackagesRequest request)	Compute the preferred packages for the vetting requirements in the request.
InteractiveSubmissionServiceOuterClass.GetPreferredPackageVersionResponse	getPreferredPackageVersion(InteractiveSubmissionServiceOuterClass.GetPreferredPackageVersionRequest request)	A preferred package is the highest-versioned package for a provided package-name that is vetted by all the participants hosting the provided parties.
InteractiveSubmissionServiceOuterClass.PrepareSubmissionResponse	prepareSubmission(InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest request)	Requires `readAs` scope for the submitting party when LAPI User authorization is enabled

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

build

protected InteractiveSubmissionServiceGrpc.InteractiveSubmissionServiceBlockingStub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<InteractiveSubmissionServiceGrpc.InteractiveSubmissionServiceBlockingStub>

prepareSubmission

public InteractiveSubmissionServiceOuterClass.PrepareSubmissionResponse prepareSubmission(InteractiveSubmissionServiceOuterClass.PrepareSubmissionRequest request)

 Requires `readAs` scope for the submitting party when LAPI User authorization is enabled
 

executeSubmission

public InteractiveSubmissionServiceOuterClass.ExecuteSubmissionResponse executeSubmission(InteractiveSubmissionServiceOuterClass.ExecuteSubmissionRequest request)

 Execute a prepared submission _asynchronously_ on the ledger.
 Requires a signature of the transaction from the submitting external party.
 

executeSubmissionAndWait

public InteractiveSubmissionServiceOuterClass.ExecuteSubmissionAndWaitResponse executeSubmissionAndWait(InteractiveSubmissionServiceOuterClass.ExecuteSubmissionAndWaitRequest request)

 Similar to ExecuteSubmission but _synchronously_ wait for the completion of the transaction
 IMPORTANT: Relying on the response from this endpoint requires trusting the Participant Node to be honest.
 A malicious node could make a successfully committed request appeared failed and vice versa
 

executeSubmissionAndWaitForTransaction

public InteractiveSubmissionServiceOuterClass.ExecuteSubmissionAndWaitForTransactionResponse executeSubmissionAndWaitForTransaction(InteractiveSubmissionServiceOuterClass.ExecuteSubmissionAndWaitForTransactionRequest request)

 Similar to ExecuteSubmissionAndWait but additionally returns the transaction
 IMPORTANT: Relying on the response from this endpoint requires trusting the Participant Node to be honest.
 A malicious node could make a successfully committed request appear as failed and vice versa
 

getPreferredPackageVersion

public InteractiveSubmissionServiceOuterClass.GetPreferredPackageVersionResponse getPreferredPackageVersion(InteractiveSubmissionServiceOuterClass.GetPreferredPackageVersionRequest request)

 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
 Can be accessed by any Ledger API client with a valid token when Ledger API authorization is enabled.
 Provided for backwards compatibility, it will be removed in the Canton version 3.4.0
 

getPreferredPackages

public InteractiveSubmissionServiceOuterClass.GetPreferredPackagesResponse getPreferredPackages(InteractiveSubmissionServiceOuterClass.GetPreferredPackagesRequest request)

 Compute the preferred packages for the vetting requirements in the request.
 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 packages, 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
 If the package preferences could not be computed due to no selection satisfying the requirements,
 a `FAILED_PRECONDITION` error will be returned.
 Can be accessed by any Ledger API client with a valid token when Ledger API authorization is enabled.
 Experimental API: this endpoint is not guaranteed to provide backwards compatibility in future releases