@bitgo/public-types 6.29.0 → 6.31.0

package/package.json

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

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

@@ -0,0 +1,28 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * @title Canton Allocation Offer Withdrawn Intent
+ *
+ * Intent for cancelling the allocation offer that was sent out
+ * In canton, the allocation `offer` can be withdrawn by doing a cancellation of offer transaction
+ *
+ * @param {String} intentType - The type of intent (always set to allocationOfferWithdrawn)
+ * @param {string} transferOfferId - The offer transferOfferId that needs to be cancelled
+ * @param {String} [token] - The optional token
+ */
+export const CantonAllocationOfferWithdrawnIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: intentTypes.allocationOfferWithdrawn,
+    transferOfferId: t.string,
+  }),
+  t.partial({
+    token: t.string,
+  }),
+]);
+
+export type CantonAllocationOfferWithdrawnIntent = t.TypeOf<
+  typeof CantonAllocationOfferWithdrawnIntent
+>;

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

@@ -0,0 +1,26 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * @title Canton Allocation Reject Intent
+ *
+ * Intent for rejecting an allocation request as part of a Cash DvP (Delivery vs Payment) trade
+ * on the `Canton` chain. The user submits this intent referencing an existing
+ * `allocationRequest` txRequest created by the operator. Wallet-platform fetches
+ * the stored trade data and constructs the rejection transaction.
+ *
+ * @param {String} intentType  - The type of intent (always set to allocationReject)
+ * @param {String} txRequestId - The allocationRequest txRequestId to reject
+ */
+export const CantonAllocationRejectIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: intentTypes.allocationReject,
+    txRequestId: t.string,
+  }),
+]);
+
+export type CantonAllocationRejectIntent = t.TypeOf<
+  typeof CantonAllocationRejectIntent
+>;

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

@@ -0,0 +1,40 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * @title Canton Participant Onboarding Request Intent
+ *
+ * Intent for BitGo to create a ParticipantOnboardingRequest on the Canton ledger.
+ * Submits a CreateCommand for `Dtc.Registry.V1.Service.Participant:ParticipantOnboardingRequest`.
+ * DTCC (not BitGo) accepts the request — BitGo only submits the initial create.
+ *
+ * @param {String} intentType - The type of intent (always set to cantonParticipantOnboardingRequest)
+ * @param {string} operator - DTCC operator party ID
+ * @param {string} provider - DTCC provider party ID (typically same as operator on testnet)
+ * @param {string} compliance - DTCC compliance party ID
+ * @param {string} registrar - DTCC registrar party ID
+ * @param {string} clientOnboarder - DTCC client onboarder party ID
+ * @param {string} [expirationIso] - Optional ISO 8601 expiration timestamp; IMS defaults to 7 days if not provided
+ * @param {string} [comment] - Optional human-readable comment
+ */
+export const CantonParticipantOnboardingRequestIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: intentTypes.cantonParticipantOnboardingRequest,
+    // DTCC party IDs — passed from UI → WP → IMS; NOT hardcoded in IMS (vary per environment)
+    operator: t.string,
+    provider: t.string, // typically same value as operator on testnet
+    compliance: t.string,
+    registrar: t.string,
+    clientOnboarder: t.string,
+  }),
+  t.partial({
+    expirationIso: t.string, // IMS defaults to 7 days if not provided
+    comment: t.string,
+  }),
+]);
+
+export type CantonParticipantOnboardingRequestIntent = t.TypeOf<
+  typeof CantonParticipantOnboardingRequestIntent
+>;

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

@@ -34,6 +34,8 @@ export * from "./bscStakeClaimRewardsIntent";
 export * from "./bscUndelegateIntent";
 export * from "./bscWithdrawUndelegateIntent";
 export * from "./cantonAllocationAllocateIntent";
+export * from "./cantonAllocationOfferWithdrawnIntent";
+export * from "./cantonAllocationRejectIntent";
 export * from "./cantonAllocationRequestIntent";
 export * from "./cantonCommandIntent";
 export * from "./cantonCosignDelegationAcceptIntent";
@@ -46,6 +48,7 @@ export * from "./cantonTransferRejectIntent";
 export * from "./cantonEndInvestorOnboardingOfferIntent";
 export * from "./cantonEndInvestorOnboardingAcceptIntent";
 export * from "./cantonEndInvestorOnboardingRejectIntent";
+export * from "./cantonParticipantOnboardingRequestIntent";
 export * from "./claimIntent";
 export * from "./consolidateTokenIntent";
 export * from "./coredaoClaimIntent";

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

@@ -114,6 +114,8 @@ import { VetDecreaseStakeIntent } from "./vetDecreaseStakeIntent";
 import { VetSignalExitIntent } from "./vetSignalExitIntent";
 import { VetWithdrawStakeIntent } from "./vetWithdrawStakeIntent";
 import { CantonAllocationAllocateIntent } from "./cantonAllocationAllocateIntent";
+import { CantonAllocationOfferWithdrawnIntent } from "./cantonAllocationOfferWithdrawnIntent";
+import { CantonAllocationRejectIntent } from "./cantonAllocationRejectIntent";
 import { CantonAllocationRequestIntent } from "./cantonAllocationRequestIntent";
 import { CantonCosignDelegationAcceptIntent } from "./cantonCosignDelegationAcceptIntent";
 import { CantonCosignDelegationProposalIntent } from "./cantonCosignDelegationProposalIntent";
@@ -126,6 +128,7 @@ import { CantonTransferRejectIntent } from "./cantonTransferRejectIntent";
 import { CantonEndInvestorOnboardingOfferIntent } from "./cantonEndInvestorOnboardingOfferIntent";
 import { CantonEndInvestorOnboardingAcceptIntent } from "./cantonEndInvestorOnboardingAcceptIntent";
 import { CantonEndInvestorOnboardingRejectIntent } from "./cantonEndInvestorOnboardingRejectIntent";
+import { CantonParticipantOnboardingRequestIntent } from "./cantonParticipantOnboardingRequestIntent";
 import { TonWhalesDelegateIntent } from "./tonWhalesDelegateIntent";
 import { TonWhalesUndelegateIntent } from "./tonWhalesUndelegateIntent";
 import { TrxClaimRewardsIntent } from "./trxClaimRewardsIntent";
@@ -163,6 +166,8 @@ export const TransactionIntent = t.union([
   BscUnDelegateIntent,
   BscWithdrawUndelegateIntent,
   CantonAllocationAllocateIntent,
+  CantonAllocationOfferWithdrawnIntent,
+  CantonAllocationRejectIntent,
   CantonAllocationRequestIntent,
   CantonCosignDelegationAcceptIntent,
   CantonCosignDelegationProposalIntent,
@@ -175,6 +180,7 @@ export const TransactionIntent = t.union([
   CantonEndInvestorOnboardingOfferIntent,
   CantonEndInvestorOnboardingAcceptIntent,
   CantonEndInvestorOnboardingRejectIntent,
+  CantonParticipantOnboardingRequestIntent,
   ClaimIntent,
   CosmosContractCallIntent,
   CosmosPaymentIntent,

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

@@ -62,6 +62,8 @@ export const intentTypes = {
   allocationRequest: t.literal("allocationRequest"),
   cantonCommand: t.literal("cantonCommand"),
   allocationAllocate: t.literal("allocationAllocate"),
+  allocationOfferWithdrawn: t.literal("allocationOfferWithdrawn"),
+  allocationReject: t.literal("allocationReject"),
   cantonEndInvestorOnboardingOffer: t.literal(
     "cantonEndInvestorOnboardingOffer",
   ),
@@ -71,6 +73,9 @@ export const intentTypes = {
   cantonEndInvestorOnboardingReject: t.literal(
     "cantonEndInvestorOnboardingReject",
   ),
+  cantonParticipantOnboardingRequest: t.literal(
+    "cantonParticipantOnboardingRequest",
+  ),
   /**
    * Deposit assets into a DeFi protocol vault (e.g. Concrete USD1 → ctUSD1cx).
    */