@bitgo/public-types 6.12.0 → 6.14.0

package/package.json

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

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

@@ -0,0 +1,58 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * @title Canton Allocation Request Intent
+ *
+ * Intent for a dummy (internally created) txRequest on the `Canton` chain that surfaces
+ * all the information the user needs to allocate their asset as part of a Cash DvP
+ * (Delivery vs Payment) trade. The operator emits an AllocationRequest instructing both
+ * parties to lock their respective assets before atomic settlement can proceed.
+ *
+ * Each intent covers one party's allocation leg. The `receiveToken` / `receiveAmount` fields
+ * show what the allocating party will receive upon successful settlement, giving the user full
+ * visibility into the trade terms before acting.
+ *
+ * @param {String}  intentType      - The type of intent (always set to allocationRequest)
+ * @param {String}  updateId        - The transaction update id of the AllocationRequest event
+ * @param {String}  operatorId      - The settlement executor (operator / TradeWeb party)
+ * @param {String}  contractId      - The settlement batch contract id (settlementRef.cid)
+ * @param {String}  tradeId         - The trade identifier (settlementRef.id)
+ * @param {String}  transferLegId   - The specific leg being allocated (e.g. "${tradeId}-security-leg")
+ * @param {String}  senderPartyId   - The party performing this allocation (sender of this leg)
+ * @param {String}  receiverPartyId - The counterparty receiving the allocated asset
+ * @param {String}  amount          - Quantity to allocate (decimal string, e.g. "70.0000000000")
+ * @param {String}  token           - BitGo token identifier for the asset being allocated
+ * @param {String}  receiveToken    - BitGo token identifier the allocating party will receive on settlement
+ * @param {String}  receiveAmount   - Quantity the allocating party will receive on settlement
+ * @param {String}  allocateBefore  - ISO 8601 deadline by which allocation must be submitted
+ * @param {String}  settleBefore    - ISO 8601 deadline by which settlement must complete
+ * @param {String}  [comment]       - Optional free-form note
+ */
+export const CantonAllocationRequestIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: intentTypes.allocationRequest,
+    updateId: t.string,
+    operatorId: t.string,
+    contractId: t.string,
+    tradeId: t.string,
+    transferLegId: t.string,
+    senderPartyId: t.string,
+    receiverPartyId: t.string,
+    amount: t.string,
+    token: t.string,
+    receiveToken: t.string,
+    receiveAmount: t.string,
+    allocateBefore: t.string,
+    settleBefore: t.string,
+  }),
+  t.partial({
+    comment: t.string,
+  }),
+]);
+
+export type CantonAllocationRequestIntent = t.TypeOf<
+  typeof CantonAllocationRequestIntent
+>;

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

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

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

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

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

@@ -13,6 +13,7 @@ export const PolyxStakeIntent = t.intersection([
   }),
   t.partial({
     addToStake: optionalBoolean,
+    validators: t.array(t.string),
   }),
 ]);