Package com.daml.ledger.api.v2.admin

Interface PackageManagementServiceGrpc.AsyncService

All Known Implementing Classes:

PackageManagementServiceGrpc.PackageManagementServiceImplBase

Enclosing class:

PackageManagementServiceGrpc

public static interface PackageManagementServiceGrpc.AsyncService

 Status: experimental interface, will change before it is deemed production
 ready
 Query the Daml-LF packages supported by the ledger participant and upload
 DAR files. We use 'backing participant' to refer to this specific participant
 in the methods of this API.
 

Method Summary

Modifier and Type	Method	Description
default void	listKnownPackages(PackageManagementServiceOuterClass.ListKnownPackagesRequest request, io.grpc.stub.StreamObserver<PackageManagementServiceOuterClass.ListKnownPackagesResponse> responseObserver)	Returns the details of all Daml-LF packages known to the backing participant.
default void	uploadDarFile(PackageManagementServiceOuterClass.UploadDarFileRequest request, io.grpc.stub.StreamObserver<PackageManagementServiceOuterClass.UploadDarFileResponse> responseObserver)	Upload a DAR file to the backing participant.
default void	validateDarFile(PackageManagementServiceOuterClass.ValidateDarFileRequest request, io.grpc.stub.StreamObserver<PackageManagementServiceOuterClass.ValidateDarFileResponse> responseObserver)	Performs the same checks that UploadDarFile call perform, but doesn't upload the DAR and does not make it available on the whole ledger.

Method Details

listKnownPackages

default void listKnownPackages(PackageManagementServiceOuterClass.ListKnownPackagesRequest request,
 io.grpc.stub.StreamObserver<PackageManagementServiceOuterClass.ListKnownPackagesResponse> responseObserver)

 Returns the details of all Daml-LF packages known to the backing participant.
 

uploadDarFile

default void uploadDarFile(PackageManagementServiceOuterClass.UploadDarFileRequest request,
 io.grpc.stub.StreamObserver<PackageManagementServiceOuterClass.UploadDarFileResponse> responseObserver)

 Upload a DAR file to the backing participant.
 Depending on the ledger implementation this might also make the package
 available on the whole ledger. This call might not be supported by some
 ledger implementations. Canton could be an example, where uploading a DAR
 is not sufficient to render it usable, it must be activated first.
 This call may:
 - Succeed, if the package was successfully uploaded, or if the same package
   was already uploaded before.
 - Respond with a gRPC error
 

validateDarFile

default void validateDarFile(PackageManagementServiceOuterClass.ValidateDarFileRequest request,
 io.grpc.stub.StreamObserver<PackageManagementServiceOuterClass.ValidateDarFileResponse> responseObserver)

 Performs the same checks that UploadDarFile call perform, but doesn't
 upload the DAR and does not make it available on the whole ledger.
 This call may:
 - Succeed if the package is valid
 - Respond with a gRPC error if the package is not valid