@bitgo/public-types 6.15.0 → 6.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitgo/public-types",
-  "version": "6.15.0",
+  "version": "6.16.0",
   "description": "Collection of types exposed externally as part of the BitGo public API",
   "license": "UNLICENSED",
   "author": "",

package/src/schema/transactionRequest/intents/cantonCommandIntent.ts

@@ -0,0 +1,80 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * @title Canton Command Intent
+ *
+ * Generic intent for executing any allowlisted DAML command on Canton.
+ *
+ * All command-specific fields are grouped under {@link cantonCommandParams} to keep the
+ * top-level intent shape lean
+ *
+ * @param {String} intentType                          - The type of intent (always set to cantonCommand)
+ * @param {Object} cantonCommandParams                 - Canton-specific command payload
+ * @param {Object} cantonCommandParams.command         - The DAML command to execute (CreateCommand or ExerciseCommand)
+ * @param {Array}  cantonCommandParams.actAs           - Canton parties that must sign the transaction
+ * @param {Array}  [cantonCommandParams.readAs]        - Canton parties used for read-only ACS visibility
+ * @param {Array}  [cantonCommandParams.resolveContracts] - ACS resolution specs; each entry resolves a contractId and injects it at injectAs path
+ *
+ * For ExerciseCommand, either supply `contractId` directly or provide `resolveContracts` to inject it via ACS — enforced by IMS at build time, not the codec.
+ * `CantonCommand` uses open codecs per intents layer convention; one-of is enforced by Canton's API at execution time.
+ */
+
+const CreateCommand = t.type({
+  CreateCommand: t.type({
+    templateId: t.string,
+    createArguments: t.record(t.string, t.unknown),
+  }),
+});
+
+const ExerciseCommand = t.type({
+  ExerciseCommand: t.intersection([
+    t.type({
+      templateId: t.string,
+      choice: t.string,
+      choiceArgument: t.record(t.string, t.unknown),
+    }),
+    t.partial({
+      // omit when contractId will be injected via resolveContracts at build time
+      contractId: t.string,
+    }),
+  ]),
+});
+
+const CantonCommand = t.union([CreateCommand, ExerciseCommand]);
+
+const ResolveContractSpec = t.intersection([
+  t.type({
+    templateId: t.string,
+    actAs: t.array(t.string),
+    // dot-notation path where the resolved contractId is written, e.g. "command.ExerciseCommand.contractId"
+    injectAs: t.string,
+  }),
+  t.partial({
+    readAs: t.array(t.string),
+    // if true, resolves all active contracts for the templateId instead of just the first match
+    resolveAll: t.boolean,
+  }),
+]);
+
+const CantonCommandParams = t.intersection([
+  t.type({
+    command: CantonCommand,
+    actAs: t.array(t.string),
+  }),
+  t.partial({
+    readAs: t.array(t.string),
+    resolveContracts: t.array(ResolveContractSpec),
+  }),
+]);
+
+export const CantonCommandIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: intentTypes.cantonCommand,
+    cantonCommandParams: CantonCommandParams,
+  }),
+]);
+
+export type CantonCommandIntent = t.TypeOf<typeof CantonCommandIntent>;

package/src/schema/transactionRequest/intents/index.ts

@@ -34,6 +34,7 @@ export * from "./bscStakeClaimRewardsIntent";
 export * from "./bscUndelegateIntent";
 export * from "./bscWithdrawUndelegateIntent";
 export * from "./cantonAllocationRequestIntent";
+export * from "./cantonCommandIntent";
 export * from "./cantonCosignDelegationAcceptIntent";
 export * from "./cantonCosignDelegationProposalIntent";
 export * from "./cantonPaymentIntent";

package/src/schema/transactionRequest/intents/intent.ts

@@ -114,6 +114,7 @@ import { VetSignalExitIntent } from "./vetSignalExitIntent";
 import { VetWithdrawStakeIntent } from "./vetWithdrawStakeIntent";
 import { CantonCosignDelegationAcceptIntent } from "./cantonCosignDelegationAcceptIntent";
 import { CantonCosignDelegationProposalIntent } from "./cantonCosignDelegationProposalIntent";
+import { CantonCommandIntent } from "./cantonCommandIntent";
 import { CantonPaymentIntent } from "./cantonPaymentIntent";
 import { CantonTransferAcceptIntent } from "./cantonTransferAcceptIntent";
 import { CantonTransferAcknowledgeIntent } from "./cantonTransferAcknowledgeIntent";
@@ -157,6 +158,7 @@ export const TransactionIntent = t.union([
   BscWithdrawUndelegateIntent,
   CantonCosignDelegationAcceptIntent,
   CantonCosignDelegationProposalIntent,
+  CantonCommandIntent,
   CantonPaymentIntent,
   CantonTransferAcceptIntent,
   CantonTransferAcknowledgeIntent,

package/src/schema/transactionRequest/intents/intentType.ts

@@ -60,6 +60,7 @@ export const intentTypes = {
   cosignDelegationProposal: t.literal("cosignDelegationProposal"),
   cosignDelegationAccept: t.literal("cosignDelegationAccept"),
   allocationRequest: t.literal("allocationRequest"),
+  cantonCommand: t.literal("cantonCommand"),
   /**
    * Deposit assets into a DeFi protocol vault (e.g. Concrete USD1 → ctUSD1cx).
    */