@distrohelena/canton-typescript-sdk 0.1.0

package/dist/transports/grpc/generated/canton/com/daml/ledger/api/v2/admin/package_management_service.client.js

@@ -0,0 +1,66 @@
+import { PackageManagementService } from "./package_management_service.js";
+import { stackIntercept } from "@protobuf-ts/runtime-rpc";
+/**
+ * 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.
+ *
+ * @generated from protobuf service com.daml.ledger.api.v2.admin.PackageManagementService
+ */
+export class PackageManagementServiceClient {
+    _transport;
+    typeName = PackageManagementService.typeName;
+    methods = PackageManagementService.methods;
+    options = PackageManagementService.options;
+    constructor(_transport) {
+        this._transport = _transport;
+    }
+    /**
+     * Returns the details of all Daml-LF packages known to the backing participant.
+     *
+     * @generated from protobuf rpc: ListKnownPackages
+     */
+    listKnownPackages(input, options) {
+        const method = this.methods[0], opt = this._transport.mergeOptions(options);
+        return stackIntercept("unary", this._transport, method, opt, input);
+    }
+    /**
+     * Upload a DAR file to the participant.
+     *
+     * If vetting is enabled in the request, the DAR is checked for upgrade compatibility
+     * with the set of the already vetted packages on the target vetting synchronizer
+     * See UploadDarFileRequest for details regarding vetting and the target vetting synchronizer.
+     *
+     * @generated from protobuf rpc: UploadDarFile
+     */
+    uploadDarFile(input, options) {
+        const method = this.methods[1], opt = this._transport.mergeOptions(options);
+        return stackIntercept("unary", this._transport, method, opt, input);
+    }
+    /**
+     * Validates the DAR and checks the upgrade compatibility of the DAR's packages
+     * with the set of the already vetted packages on the target vetting synchronizer.
+     * See ValidateDarFileRequest for details regarding the target vetting synchronizer.
+     *
+     * The operation has no effect on the state of the participant or the Canton ledger:
+     * the DAR payload and its packages are not persisted neither are the packages vetted.
+     *
+     * @generated from protobuf rpc: ValidateDarFile
+     */
+    validateDarFile(input, options) {
+        const method = this.methods[2], opt = this._transport.mergeOptions(options);
+        return stackIntercept("unary", this._transport, method, opt, input);
+    }
+    /**
+     * Update the vetted packages of this participant
+     *
+     * @generated from protobuf rpc: UpdateVettedPackages
+     */
+    updateVettedPackages(input, options) {
+        const method = this.methods[3], opt = this._transport.mergeOptions(options);
+        return stackIntercept("unary", this._transport, method, opt, input);
+    }
+}

package/dist/transports/grpc/generated/canton/com/daml/ledger/api/v2/admin/package_management_service.d.ts

@@ -0,0 +1,524 @@
+import { ServiceType } from "@protobuf-ts/runtime-rpc";
+import { MessageType } from "@protobuf-ts/runtime";
+import { VettedPackages } from "../package_reference.js";
+import { PriorTopologySerial } from "../package_reference.js";
+import { Timestamp } from "../../../../../../google/protobuf/timestamp.js";
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.admin.ListKnownPackagesRequest
+ */
+export interface ListKnownPackagesRequest {
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.admin.ListKnownPackagesResponse
+ */
+export interface ListKnownPackagesResponse {
+    /**
+     * The details of all Daml-LF packages known to backing participant.
+     *
+     * Required: must be non-empty
+     *
+     * @generated from protobuf field: repeated com.daml.ledger.api.v2.admin.PackageDetails package_details = 1
+     */
+    packageDetails: PackageDetails[];
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.admin.PackageDetails
+ */
+export interface PackageDetails {
+    /**
+     * The identity of the Daml-LF package.
+     * Must be a valid PackageIdString (as describe in ``value.proto``).
+     *
+     * Required
+     *
+     * @generated from protobuf field: string package_id = 1
+     */
+    packageId: string;
+    /**
+     * Size of the package in bytes.
+     * The size of the package is given by the size of the ``daml_lf``
+     * ArchivePayload. See further details in ``daml_lf.proto``.
+     *
+     * Required
+     *
+     * @generated from protobuf field: uint64 package_size = 2
+     */
+    packageSize: string;
+    /**
+     * Indicates since when the package is known to the backing participant.
+     * Required
+     *
+     * @generated from protobuf field: google.protobuf.Timestamp known_since = 3
+     */
+    knownSince?: Timestamp;
+    /**
+     * Name of the package as defined by the package metadata
+     *
+     * Required
+     *
+     * @generated from protobuf field: string name = 4
+     */
+    name: string;
+    /**
+     * Version of the package as defined by the package metadata
+     *
+     * Required
+     *
+     * @generated from protobuf field: string version = 5
+     */
+    version: string;
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.admin.UploadDarFileRequest
+ */
+export interface UploadDarFileRequest {
+    /**
+     * Contains a Daml archive DAR file, which in turn is a jar like zipped
+     * container for ``daml_lf`` archives. See further details in
+     * ``daml_lf.proto``.
+     *
+     * Required: must be non-empty
+     *
+     * @generated from protobuf field: bytes dar_file = 1
+     */
+    darFile: Uint8Array;
+    /**
+     * Unique submission identifier.
+     * If not populated, a random identifier will be generated.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: string submission_id = 2
+     */
+    submissionId: string;
+    /**
+     * How to vet packages in the DAR being uploaded
+     *
+     * Optional
+     *
+     * @generated from protobuf field: com.daml.ledger.api.v2.admin.UploadDarFileRequest.VettingChange vetting_change = 3
+     */
+    vettingChange: UploadDarFileRequest_VettingChange;
+    /**
+     * Only used if VettingChange is set to VETTING_CHANGE_VET_ALL_PACKAGES, in
+     * order to specify which synchronizer to vet on.
+     *
+     * If synchronizer_id is set, the synchronizer with this ID will be used. If
+     * synchronizer_id is unset and the participant is only connected to a single
+     * synchronizer, that synchronizer will be used by default. If synchronizer_id
+     * is unset and the participant is connected to multiple synchronizers, the
+     * request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: string synchronizer_id = 4
+     */
+    synchronizerId: string;
+}
+/**
+ * @generated from protobuf enum com.daml.ledger.api.v2.admin.UploadDarFileRequest.VettingChange
+ */
+export declare enum UploadDarFileRequest_VettingChange {
+    /**
+     * Vetting change field left unspecified, defaults to vetting all the
+     * packages in the DAR.
+     *
+     * @generated from protobuf enum value: VETTING_CHANGE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * Vet all the packages in the DAR.
+     *
+     * @generated from protobuf enum value: VETTING_CHANGE_VET_ALL_PACKAGES = 1;
+     */
+    VET_ALL_PACKAGES = 1,
+    /**
+     * Do not vet any packages in the DAR.
+     *
+     * @generated from protobuf enum value: VETTING_CHANGE_DONT_VET_ANY_PACKAGES = 2;
+     */
+    DONT_VET_ANY_PACKAGES = 2
+}
+/**
+ * A message that is received when the upload operation succeeded.
+ *
+ * @generated from protobuf message com.daml.ledger.api.v2.admin.UploadDarFileResponse
+ */
+export interface UploadDarFileResponse {
+}
+/**
+ * Performs the same checks that UploadDarFileRequest would perform, but doesn't
+ * upload the DAR.
+ *
+ * @generated from protobuf message com.daml.ledger.api.v2.admin.ValidateDarFileRequest
+ */
+export interface ValidateDarFileRequest {
+    /**
+     * Contains a Daml archive DAR file, which in turn is a jar like zipped
+     * container for ``daml_lf`` archives. See further details in
+     * ``daml_lf.proto``.
+     *
+     * Required: must be non-empty
+     *
+     * @generated from protobuf field: bytes dar_file = 1
+     */
+    darFile: Uint8Array;
+    /**
+     * Unique submission identifier. If not defined, defaults to a random identifier.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: string submission_id = 2
+     */
+    submissionId: string;
+    /**
+     * If synchronizer_id is set, the synchronizer with this ID will be used. If
+     * synchronizer_id is unset and the participant is only connected to a single
+     * synchronizer, that synchronizer will be used by default. If synchronizer_id
+     * is unset and the participant is connected to multiple synchronizers, the
+     * request will error out with PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: string synchronizer_id = 4
+     */
+    synchronizerId: string;
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.admin.ValidateDarFileResponse
+ */
+export interface ValidateDarFileResponse {
+}
+/**
+ * A change to the set of vetted packages.
+ *
+ * @generated from protobuf message com.daml.ledger.api.v2.admin.VettedPackagesChange
+ */
+export interface VettedPackagesChange {
+    /**
+     * Required
+     *
+     * @generated from protobuf oneof: operation
+     */
+    operation: {
+        oneofKind: "vet";
+        /**
+         * Add packages to or update packages in the set of vetted packages.
+         *
+         * @generated from protobuf field: com.daml.ledger.api.v2.admin.VettedPackagesChange.Vet vet = 1
+         */
+        vet: VettedPackagesChange_Vet;
+    } | {
+        oneofKind: "unvet";
+        /**
+         * Remove packages from the set of vetted packages.
+         *
+         * @generated from protobuf field: com.daml.ledger.api.v2.admin.VettedPackagesChange.Unvet unvet = 2
+         */
+        unvet: VettedPackagesChange_Unvet;
+    } | {
+        oneofKind: undefined;
+    };
+}
+/**
+ * Remove packages from the set of vetted packages
+ *
+ * @generated from protobuf message com.daml.ledger.api.v2.admin.VettedPackagesChange.Unvet
+ */
+export interface VettedPackagesChange_Unvet {
+    /**
+     * Packages to be unvetted.
+     *
+     * If a reference in this list matches multiple packages, they are all
+     * unvetted.
+     *
+     * Required: must be non-empty
+     *
+     * @generated from protobuf field: repeated com.daml.ledger.api.v2.admin.VettedPackagesRef packages = 1
+     */
+    packages: VettedPackagesRef[];
+}
+/**
+ * Set vetting bounds of a list of packages. Packages that were not previously
+ * vetted have their bounds added, previous vetting bounds are overwritten.
+ *
+ * @generated from protobuf message com.daml.ledger.api.v2.admin.VettedPackagesChange.Vet
+ */
+export interface VettedPackagesChange_Vet {
+    /**
+     * Packages to be vetted.
+     *
+     * If a reference in this list matches more than one package, the change is
+     * considered ambiguous and the entire update request is rejected. In other
+     * words, every reference must match exactly one package.
+     *
+     * Required: must be non-empty
+     *
+     * @generated from protobuf field: repeated com.daml.ledger.api.v2.admin.VettedPackagesRef packages = 1
+     */
+    packages: VettedPackagesRef[];
+    /**
+     * The time from which these packages should be vetted, prior lower bounds
+     * are overwritten.
+     * Optional
+     *
+     * @generated from protobuf field: google.protobuf.Timestamp new_valid_from_inclusive = 2
+     */
+    newValidFromInclusive?: Timestamp;
+    /**
+     * The time until which these packages should be vetted, prior upper bounds
+     * are overwritten.
+     * Optional
+     *
+     * @generated from protobuf field: google.protobuf.Timestamp new_valid_until_exclusive = 3
+     */
+    newValidUntilExclusive?: Timestamp;
+}
+/**
+ * A reference to identify one or more packages.
+ *
+ * A reference matches a package if its ``package_id`` matches the package's ID,
+ * its ``package_name`` matches the package's name, and its ``package_version``
+ * matches the package's version. If an attribute in the reference is left
+ * unspecified (i.e. as an empty string), that attribute is treated as a
+ * wildcard. At a minimum, ``package_id`` or the ``package_name`` must be
+ * specified.
+ *
+ * If a reference does not match any package, the reference is considered
+ * unresolved and the entire update request is rejected.
+ *
+ * @generated from protobuf message com.daml.ledger.api.v2.admin.VettedPackagesRef
+ */
+export interface VettedPackagesRef {
+    /**
+     * Package's package id must be the same as this field.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: string package_id = 1
+     */
+    packageId: string;
+    /**
+     * Package's name must be the same as this field.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: string package_name = 2
+     */
+    packageName: string;
+    /**
+     * Package's version must be the same as this field.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: string package_version = 3
+     */
+    packageVersion: string;
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.admin.UpdateVettedPackagesRequest
+ */
+export interface UpdateVettedPackagesRequest {
+    /**
+     * Changes to apply to the current vetting state of the participant on the
+     * specified synchronizer. The changes are applied in order.
+     * Any package not changed will keep their previous vetting state.
+     *
+     * Required: must be non-empty
+     *
+     * @generated from protobuf field: repeated com.daml.ledger.api.v2.admin.VettedPackagesChange changes = 1
+     */
+    changes: VettedPackagesChange[];
+    /**
+     * If dry_run is true, then the changes are only prepared, but not applied. If
+     * a request would trigger an error when run (e.g. TOPOLOGY_DEPENDENCIES_NOT_VETTED),
+     * it will also trigger an error when dry_run.
+     *
+     * Use this flag to preview a change before applying it.
+     * Defaults to false.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: bool dry_run = 2
+     */
+    dryRun: boolean;
+    /**
+     * If set, the requested changes will take place on the specified
+     * synchronizer. If synchronizer_id is unset and the participant is only
+     * connected to a single synchronizer, that synchronizer will be used by
+     * default. If synchronizer_id is unset and the participant is connected to
+     * multiple synchronizers, the request will error out with
+     * PACKAGE_SERVICE_CANNOT_AUTODETECT_SYNCHRONIZER.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: string synchronizer_id = 3
+     */
+    synchronizerId: string;
+    /**
+     * The serial of the last ``VettedPackages`` topology transaction of this
+     * participant and on this synchronizer.
+     *
+     * Execution of the request fails if this is not correct. Use this to guard
+     * against concurrent changes.
+     *
+     * If left unspecified, no validation is done against the last transaction's
+     * serial.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: com.daml.ledger.api.v2.PriorTopologySerial expected_topology_serial = 4
+     */
+    expectedTopologySerial?: PriorTopologySerial;
+    /**
+     * Controls whether potentially unsafe vetting updates are allowed.
+     *
+     * Optional: can be empty
+     *
+     * @generated from protobuf field: repeated com.daml.ledger.api.v2.admin.UpdateVettedPackagesForceFlag update_vetted_packages_force_flags = 5
+     */
+    updateVettedPackagesForceFlags: UpdateVettedPackagesForceFlag[];
+}
+/**
+ * @generated from protobuf message com.daml.ledger.api.v2.admin.UpdateVettedPackagesResponse
+ */
+export interface UpdateVettedPackagesResponse {
+    /**
+     * All vetted packages on this participant and synchronizer, before the
+     * specified changes. Empty if no vetting state existed beforehand.
+     *
+     * Not populated if no vetted topology state exists prior to the update.
+     *
+     * Optional
+     *
+     * @generated from protobuf field: com.daml.ledger.api.v2.VettedPackages past_vetted_packages = 1
+     */
+    pastVettedPackages?: VettedPackages;
+    /**
+     * All vetted packages on this participant and synchronizer, after the specified changes.
+     *
+     * Required
+     *
+     * @generated from protobuf field: com.daml.ledger.api.v2.VettedPackages new_vetted_packages = 2
+     */
+    newVettedPackages?: VettedPackages;
+}
+/**
+ * @generated from protobuf enum com.daml.ledger.api.v2.admin.UpdateVettedPackagesForceFlag
+ */
+export declare enum UpdateVettedPackagesForceFlag {
+    /**
+     * Force flag left unspecified, defaults to no force flag used in the backend.
+     *
+     * @generated from protobuf enum value: UPDATE_VETTED_PACKAGES_FORCE_FLAG_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * * Allow vetting a package that is upgrade-incompatible with other vetted packages
+     *
+     * @generated from protobuf enum value: UPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_VET_INCOMPATIBLE_UPGRADES = 2;
+     */
+    ALLOW_VET_INCOMPATIBLE_UPGRADES = 2,
+    /**
+     * * Allow vetting a package without vetting one or more of its dependencies
+     *
+     * @generated from protobuf enum value: UPDATE_VETTED_PACKAGES_FORCE_FLAG_ALLOW_UNVETTED_DEPENDENCIES = 3;
+     */
+    ALLOW_UNVETTED_DEPENDENCIES = 3
+}
+declare class ListKnownPackagesRequest$Type extends MessageType<ListKnownPackagesRequest> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.admin.ListKnownPackagesRequest
+ */
+export declare const ListKnownPackagesRequest: ListKnownPackagesRequest$Type;
+declare class ListKnownPackagesResponse$Type extends MessageType<ListKnownPackagesResponse> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.admin.ListKnownPackagesResponse
+ */
+export declare const ListKnownPackagesResponse: ListKnownPackagesResponse$Type;
+declare class PackageDetails$Type extends MessageType<PackageDetails> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.admin.PackageDetails
+ */
+export declare const PackageDetails: PackageDetails$Type;
+declare class UploadDarFileRequest$Type extends MessageType<UploadDarFileRequest> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.admin.UploadDarFileRequest
+ */
+export declare const UploadDarFileRequest: UploadDarFileRequest$Type;
+declare class UploadDarFileResponse$Type extends MessageType<UploadDarFileResponse> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.admin.UploadDarFileResponse
+ */
+export declare const UploadDarFileResponse: UploadDarFileResponse$Type;
+declare class ValidateDarFileRequest$Type extends MessageType<ValidateDarFileRequest> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.admin.ValidateDarFileRequest
+ */
+export declare const ValidateDarFileRequest: ValidateDarFileRequest$Type;
+declare class ValidateDarFileResponse$Type extends MessageType<ValidateDarFileResponse> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.admin.ValidateDarFileResponse
+ */
+export declare const ValidateDarFileResponse: ValidateDarFileResponse$Type;
+declare class VettedPackagesChange$Type extends MessageType<VettedPackagesChange> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.admin.VettedPackagesChange
+ */
+export declare const VettedPackagesChange: VettedPackagesChange$Type;
+declare class VettedPackagesChange_Unvet$Type extends MessageType<VettedPackagesChange_Unvet> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.admin.VettedPackagesChange.Unvet
+ */
+export declare const VettedPackagesChange_Unvet: VettedPackagesChange_Unvet$Type;
+declare class VettedPackagesChange_Vet$Type extends MessageType<VettedPackagesChange_Vet> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.admin.VettedPackagesChange.Vet
+ */
+export declare const VettedPackagesChange_Vet: VettedPackagesChange_Vet$Type;
+declare class VettedPackagesRef$Type extends MessageType<VettedPackagesRef> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.admin.VettedPackagesRef
+ */
+export declare const VettedPackagesRef: VettedPackagesRef$Type;
+declare class UpdateVettedPackagesRequest$Type extends MessageType<UpdateVettedPackagesRequest> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.admin.UpdateVettedPackagesRequest
+ */
+export declare const UpdateVettedPackagesRequest: UpdateVettedPackagesRequest$Type;
+declare class UpdateVettedPackagesResponse$Type extends MessageType<UpdateVettedPackagesResponse> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message com.daml.ledger.api.v2.admin.UpdateVettedPackagesResponse
+ */
+export declare const UpdateVettedPackagesResponse: UpdateVettedPackagesResponse$Type;
+/**
+ * @generated ServiceType for protobuf service com.daml.ledger.api.v2.admin.PackageManagementService
+ */
+export declare const PackageManagementService: ServiceType;
+export {};