@bitgo/public-types 6.27.0 → 6.28.0

package/package.json

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

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

@@ -0,0 +1,24 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * @title Canton End Investor Onboarding Accept Intent
+ *
+ * Intent for an end investor to accept an onboarding offer on the Canton ledger.
+ * Exercises `EndInvestorOnboardingOffer_Accept` on-chain.
+ *
+ * @param {String} intentType - The type of intent (always set to cantonEndInvestorOnboardingAccept)
+ * @param {string} txRequestId - The txRequestId of the corresponding onboarding offer
+ */
+export const CantonEndInvestorOnboardingAcceptIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: intentTypes.cantonEndInvestorOnboardingAccept,
+    txRequestId: t.string,
+  }),
+]);
+
+export type CantonEndInvestorOnboardingAcceptIntent = t.TypeOf<
+  typeof CantonEndInvestorOnboardingAcceptIntent
+>;

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

@@ -0,0 +1,28 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * @title Canton End Investor Onboarding Offer Intent
+ *
+ * Intent for a DTCC participant to offer end investor onboarding on the Canton ledger.
+ * Exercises `ParticipantService_OfferEndInvestorOnboarding` on-chain.
+ *
+ * @param {String} intentType - The type of intent (always set to cantonEndInvestorOnboardingOffer)
+ * @param {string} endInvestorPartyId - The Canton party ID of the end investor to onboard
+ * @param {string} [comment] - Optional human-readable comment
+ */
+export const CantonEndInvestorOnboardingOfferIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: intentTypes.cantonEndInvestorOnboardingOffer,
+    endInvestorPartyId: t.string,
+  }),
+  t.partial({
+    comment: t.string,
+  }),
+]);
+
+export type CantonEndInvestorOnboardingOfferIntent = t.TypeOf<
+  typeof CantonEndInvestorOnboardingOfferIntent
+>;

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

@@ -0,0 +1,26 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * @title Canton End Investor Onboarding Reject Intent
+ *
+ * Intent for an end investor to reject an onboarding offer on the Canton ledger.
+ * Exercises `EndInvestorOnboardingOffer_Reject` on-chain.
+ *
+ * @param {String} intentType - The type of intent (always set to cantonEndInvestorOnboardingReject)
+ * @param {string} txRequestId - The txRequestId of the corresponding onboarding offer
+ * @param {string} reason - The reason for rejecting the onboarding offer
+ */
+export const CantonEndInvestorOnboardingRejectIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: intentTypes.cantonEndInvestorOnboardingReject,
+    txRequestId: t.string,
+    reason: t.string,
+  }),
+]);
+
+export type CantonEndInvestorOnboardingRejectIntent = t.TypeOf<
+  typeof CantonEndInvestorOnboardingRejectIntent
+>;

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

@@ -43,6 +43,9 @@ export * from "./cantonTransferAcceptIntent";
 export * from "./cantonTransferAcknowledgeIntent";
 export * from "./cantonTransferOfferWithdrawnIntent";
 export * from "./cantonTransferRejectIntent";
+export * from "./cantonEndInvestorOnboardingOfferIntent";
+export * from "./cantonEndInvestorOnboardingAcceptIntent";
+export * from "./cantonEndInvestorOnboardingRejectIntent";
 export * from "./claimIntent";
 export * from "./consolidateTokenIntent";
 export * from "./coredaoClaimIntent";

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

@@ -123,6 +123,9 @@ import { CantonTransferAcceptIntent } from "./cantonTransferAcceptIntent";
 import { CantonTransferAcknowledgeIntent } from "./cantonTransferAcknowledgeIntent";
 import { CantonTransferOfferWithdrawnIntent } from "./cantonTransferOfferWithdrawnIntent";
 import { CantonTransferRejectIntent } from "./cantonTransferRejectIntent";
+import { CantonEndInvestorOnboardingOfferIntent } from "./cantonEndInvestorOnboardingOfferIntent";
+import { CantonEndInvestorOnboardingAcceptIntent } from "./cantonEndInvestorOnboardingAcceptIntent";
+import { CantonEndInvestorOnboardingRejectIntent } from "./cantonEndInvestorOnboardingRejectIntent";
 import { TonWhalesDelegateIntent } from "./tonWhalesDelegateIntent";
 import { TonWhalesUndelegateIntent } from "./tonWhalesUndelegateIntent";
 import { TrxClaimRewardsIntent } from "./trxClaimRewardsIntent";
@@ -169,6 +172,9 @@ export const TransactionIntent = t.union([
   CantonTransferAcknowledgeIntent,
   CantonTransferOfferWithdrawnIntent,
   CantonTransferRejectIntent,
+  CantonEndInvestorOnboardingOfferIntent,
+  CantonEndInvestorOnboardingAcceptIntent,
+  CantonEndInvestorOnboardingRejectIntent,
   ClaimIntent,
   CosmosContractCallIntent,
   CosmosPaymentIntent,

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

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