@distrohelena/canton-typescript-sdk 0.1.7 → 0.1.8

package/dist/core/transports/transport.interface.d.ts

@@ -186,6 +186,8 @@ import { CommitmentChunkObserver } from "../../services/participant-inspection/c
 import { ContractObserver } from "../../services/contracts/contract-observer.interface.js";
 import { TransactionObserver } from "../../services/events/transaction-observer.interface.js";
 import { CommandSigners, ICommandSigner } from "../signing/command-signer.interface.js";
+import { SignCommandResult } from "../signing/sign-command-result.js";
+import { PreparedCommandSubmission } from "../types/prepared-command-submission.js";
 import { RequestOptions } from "../types/request-options.js";
 import { SubmitCommandRequest } from "../types/requests/submit-command-request.js";
 export interface ITransport {
@@ -381,4 +383,6 @@ export interface ITransport {
      * Supported on JSON and gRPC. External signing is gRPC-only.
      */
     submitCommandAsync(request: SubmitCommandRequest, signer?: ICommandSigner | CommandSigners, options?: RequestOptions): Promise<SubmitCommandResponse>;
+    prepareCommandAsync?(request: SubmitCommandRequest, options?: RequestOptions): Promise<PreparedCommandSubmission>;
+    executePreparedCommandAndWaitAsync?(prepared: PreparedCommandSubmission, signatures: Readonly<Record<string, SignCommandResult>>, options?: RequestOptions): Promise<SubmitCommandResponse>;
 }

package/dist/core/types/prepared-command-submission.d.ts

@@ -0,0 +1,9 @@
+import { SubmitCommandRequest } from "./requests/submit-command-request.js";
+/** Opaque result of interactive command preparation, suitable for detached signing. */
+export declare class PreparedCommandSubmission {
+    readonly request: SubmitCommandRequest;
+    readonly transaction: unknown;
+    readonly transactionHash: Uint8Array;
+    readonly hashingSchemeVersion: number;
+    constructor(request: SubmitCommandRequest, transaction: unknown, transactionHash: Uint8Array, hashingSchemeVersion: number);
+}

package/dist/core/types/prepared-command-submission.js

@@ -0,0 +1,13 @@
+/** Opaque result of interactive command preparation, suitable for detached signing. */
+export class PreparedCommandSubmission {
+    request;
+    transaction;
+    transactionHash;
+    hashingSchemeVersion;
+    constructor(request, transaction, transactionHash, hashingSchemeVersion) {
+        this.request = request;
+        this.transaction = transaction;
+        this.transactionHash = transactionHash;
+        this.hashingSchemeVersion = hashingSchemeVersion;
+    }
+}

package/dist/index.d.ts

@@ -207,6 +207,7 @@ export { CreateExternalPartyRequest, } from "./core/types/requests/create-extern
 export type { ExternalPartySigner, ExternalPartySigningRequest, ExternalPartySigningResult, ExternalPartySigningPayloadKind, } from "./core/types/requests/create-external-party-request.js";
 export { AllocatePartyRequest } from "./core/types/requests/allocate-party-request.js";
 export { DisclosedContract } from "./core/types/disclosed-contract.js";
+export { PreparedCommandSubmission } from "./core/types/prepared-command-submission.js";
 export { AddPartyAsyncArguments } from "./core/types/requests/add-party-async-request.js";
 export { AddPartyAsyncRequest } from "./core/types/requests/add-party-async-request.js";
 export { AssembleSignedTopologyTransactionsRequest } from "./core/types/requests/assemble-signed-topology-transactions-request.js";

package/dist/index.js

@@ -194,6 +194,7 @@ export { AllocateExternalPartyRequest } from "./core/types/requests/allocate-ext
 export { CreateExternalPartyRequest, } from "./core/types/requests/create-external-party-request.js";
 export { AllocatePartyRequest } from "./core/types/requests/allocate-party-request.js";
 export { DisclosedContract } from "./core/types/disclosed-contract.js";
+export { PreparedCommandSubmission } from "./core/types/prepared-command-submission.js";
 export { AddPartyAsyncArguments } from "./core/types/requests/add-party-async-request.js";
 export { AddPartyAsyncRequest } from "./core/types/requests/add-party-async-request.js";
 export { AssembleSignedTopologyTransactionsRequest } from "./core/types/requests/assemble-signed-topology-transactions-request.js";

package/dist/services/command/command-service-client.d.ts

@@ -3,9 +3,13 @@ import { RequestOptions } from "../../core/types/request-options.js";
 import { ITransport } from "../../core/transports/transport.interface.js";
 import { SubmitCommandRequest } from "../../core/types/requests/submit-command-request.js";
 import { SubmitCommandResponse } from "../../core/types/responses/submit-command-response.js";
+import { PreparedCommandSubmission } from "../../core/types/prepared-command-submission.js";
+import { SignCommandResult } from "../../core/signing/sign-command-result.js";
 export declare class CommandServiceClient {
     private readonly pipeline;
     constructor(transport: ITransport, signer?: ICommandSigner | CommandSigners);
     /** Submits a command and waits for the result. Supported on JSON and gRPC. */
     submitAndWaitAsync(request: SubmitCommandRequest, options?: RequestOptions): Promise<SubmitCommandResponse>;
+    prepareAsync(request: SubmitCommandRequest, options?: RequestOptions): Promise<PreparedCommandSubmission>;
+    executeAndWaitAsync(prepared: PreparedCommandSubmission, signatures: Readonly<Record<string, SignCommandResult>>, options?: RequestOptions): Promise<SubmitCommandResponse>;
 }

package/dist/services/command/command-service-client.js

@@ -11,4 +11,6 @@ export class CommandServiceClient {
     submitAndWaitAsync(request, options) {
         return this.pipeline.submitAsync(request, options);
     }
+    prepareAsync(request, options) { return this.pipeline.prepareAsync(request, options); }
+    executeAndWaitAsync(prepared, signatures, options) { return this.pipeline.executeAsync(prepared, signatures, options); }
 }

package/dist/services/commands/command-submission-pipeline.d.ts

@@ -3,6 +3,8 @@ import { ITransport } from "../../core/transports/transport.interface.js";
 import { RequestOptions } from "../../core/types/request-options.js";
 import { SubmitCommandRequest } from "../../core/types/requests/submit-command-request.js";
 import { SubmitCommandResponse } from "../../core/types/responses/submit-command-response.js";
+import { PreparedCommandSubmission } from "../../core/types/prepared-command-submission.js";
+import { SignCommandResult } from "../../core/signing/sign-command-result.js";
 export declare class CommandSubmissionPipeline {
     private readonly dependencies;
     constructor(dependencies: {
@@ -10,4 +12,6 @@ export declare class CommandSubmissionPipeline {
         signer?: ICommandSigner | CommandSigners;
     });
     submitAsync(request: SubmitCommandRequest, options?: RequestOptions): Promise<SubmitCommandResponse>;
+    prepareAsync(request: SubmitCommandRequest, options?: RequestOptions): Promise<PreparedCommandSubmission>;
+    executeAsync(prepared: PreparedCommandSubmission, signatures: Readonly<Record<string, SignCommandResult>>, options?: RequestOptions): Promise<SubmitCommandResponse>;
 }

package/dist/services/commands/command-submission-pipeline.js

@@ -12,4 +12,8 @@ export class CommandSubmissionPipeline {
         }
         return this.dependencies.transport.submitCommandAsync(request, this.dependencies.signer, options);
     }
+    prepareAsync(request, options) { if (!this.dependencies.transport.prepareCommandAsync)
+        throw new NotSupportedError("interactive command preparation is not supported by the selected transport"); return this.dependencies.transport.prepareCommandAsync(request, options); }
+    executeAsync(prepared, signatures, options) { if (!this.dependencies.transport.executePreparedCommandAndWaitAsync)
+        throw new NotSupportedError("interactive command execution is not supported by the selected transport"); return this.dependencies.transport.executePreparedCommandAndWaitAsync(prepared, signatures, options); }
 }

package/dist/transports/grpc/grpc-transport.d.ts

@@ -85,6 +85,8 @@ import { TopologyListVettedPackagesRequest } from "../../core/types/requests/top
 import { TrafficControlStateRequest } from "../../core/types/requests/traffic-control-state-request.js";
 import { UploadDarFileRequest } from "../../core/types/requests/upload-dar-file-request.js";
 import { CommandSigners, ICommandSigner } from "../../core/signing/command-signer.interface.js";
+import { SignCommandResult } from "../../core/signing/sign-command-result.js";
+import { PreparedCommandSubmission } from "../../core/types/prepared-command-submission.js";
 import { AllocatePartyResponse as SdkAllocatePartyResponse } from "../../core/types/responses/allocate-party-response.js";
 import { AllocateExternalPartyResponse } from "../../core/types/responses/allocate-external-party-response.js";
 import { AddPartyAsyncResponse } from "../../core/types/responses/add-party-async-response.js";
@@ -276,6 +278,8 @@ export declare class GrpcTransport implements ITransport {
     getUpdatesPageAsync(request: GetUpdatesPageRequest, options?: RequestOptions): Promise<GetUpdatesPageResponse>;
     getCompletionsAsync(request: GetCompletionsRequest, observer: CompletionObserver, options?: RequestOptions): Promise<void>;
     submitCommandAsync(request: SubmitCommandRequest, signer?: ICommandSigner | CommandSigners, options?: RequestOptions): Promise<SubmitCommandResponse>;
+    prepareCommandAsync(request: SubmitCommandRequest, options?: RequestOptions): Promise<PreparedCommandSubmission>;
+    executePreparedCommandAndWaitAsync(prepared: PreparedCommandSubmission, signatures: Readonly<Record<string, SignCommandResult>>, options?: RequestOptions): Promise<SubmitCommandResponse>;
     private throwIfDisposed;
     private throwPartyTopologyReadCompatibilityError;
     private isProtobufDeserializationFailure;

package/dist/transports/grpc/grpc-transport.js

@@ -1,6 +1,7 @@
 import { randomUUID } from "node:crypto";
 import { ValidationError } from "../../core/errors/validation-error.js";
 import { SignCommandRequest } from "../../core/signing/sign-command-request.js";
+import { PreparedCommandSubmission } from "../../core/types/prepared-command-submission.js";
 import { AllocatePartyResponse as SdkAllocatePartyResponse } from "../../core/types/responses/allocate-party-response.js";
 import { GetActiveContractsPageResponse } from "../../core/types/responses/get-active-contracts-page-response.js";
 import { GetLedgerApiVersionResponse as SdkGetLedgerApiVersionResponse } from "../../core/types/responses/get-ledger-api-version-response.js";
@@ -616,6 +617,22 @@ export class GrpcTransport {
         }), options);
         return mapGrpcInteractiveSubmitCommand(executed);
     }
+    async prepareCommandAsync(request, options) {
+        if (!this.operations.prepareSubmissionAsync)
+            throw new NotSupportedError("interactive gRPC command signing is not available on this transport");
+        const prepared = await this.operations.prepareSubmissionAsync(mapGrpcPrepareSubmissionRequest(request, randomUUID()), options);
+        if (!prepared.preparedTransaction || prepared.preparedTransactionHash.length === 0)
+            throw new ValidationError("interactive prepare submission returned an incomplete result");
+        return new PreparedCommandSubmission(request, prepared.preparedTransaction, prepared.preparedTransactionHash, prepared.hashingSchemeVersion);
+    }
+    async executePreparedCommandAndWaitAsync(prepared, signatures, options) {
+        if (!this.operations.executeSubmissionAndWaitAsync)
+            throw new NotSupportedError("interactive gRPC command signing is not available on this transport");
+        const signerResults = prepared.request.actAs.map((party) => { const result = signatures[party]; if (!result)
+            throw new ValidationError(`interactive command signing requires a signature for ${party}`); return { party, result }; });
+        const result = await this.operations.executeSubmissionAndWaitAsync(mapGrpcExecuteSubmissionAndWaitRequest({ request: prepared.request, preparedTransaction: prepared.transaction, hashingSchemeVersion: prepared.hashingSchemeVersion, submissionId: randomUUID(), signerResults }), options);
+        return mapGrpcInteractiveSubmitCommand(result);
+    }
     throwIfDisposed() {
         if (this.disposed) {
             throw new ObjectDisposedError("The client or transport has been disposed.");

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@distrohelena/canton-typescript-sdk",
-    "version": "0.1.7",
+    "version": "0.1.8",
     "license": "Apache-2.0",
     "type": "module",
     "main": "./dist/index.js",