@bitgo/public-types 5.72.0 → 5.74.0

package/package.json

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

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

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

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

@@ -35,6 +35,7 @@ export * from "./bscUndelegateIntent";
 export * from "./bscWithdrawUndelegateIntent";
 export * from "./cantonTransferAcceptIntent";
 export * from "./cantonTransferAcknowledgeIntent";
+export * from "./cantonTransferOfferWithdrawnIntent";
 export * from "./cantonTransferRejectIntent";
 export * from "./consolidateTokenIntent";
 export * from "./coredaoClaimIntent";
@@ -147,7 +148,11 @@ export * from "./tokenRecipientEntry";
 export * from "./tokenRecipientEntryItem";
 export * from "./tonConsolidateIntent";
 export * from "./tonDelegateIntent";
+export * from "./tonMultiNominatorDelegateIntent";
+export * from "./tonMultiNominatorUndelegateIntent";
 export * from "./tonPaymentIntent";
+export * from "./tonSingleNominatorDelegateIntent";
+export * from "./tonSingleNominatorUndelegateIntent";
 export * from "./tonStakingType";
 export * from "./tonUndelegateIntent";
 export * from "./tonWhalesDelegateIntent";

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

@@ -65,7 +65,11 @@ import { TaoTransferStakeIntent } from "./taoTransferStakeIntent";
 import { TaoUnstakeIntent } from "./taoUnstakeIntent";
 import { TokenApprovalIntent } from "./tokenApprovalIntent";
 import { TonDelegateIntent } from "./tonDelegateIntent";
+import { TonMultiNominatorDelegateIntent } from "./tonMultiNominatorDelegateIntent";
+import { TonMultiNominatorUndelegateIntent } from "./tonMultiNominatorUndelegateIntent";
 import { TonPaymentIntent } from "./tonPaymentIntent";
+import { TonSingleNominatorDelegateIntent } from "./tonSingleNominatorDelegateIntent";
+import { TonSingleNominatorUndelegateIntent } from "./tonSingleNominatorUndelegateIntent";
 import { TonUndelegateIntent } from "./tonUndelegateIntent";
 import { WalletRecoveryIntent } from "./walletRecoveryIntent";
 import { SolConsolidateIntent } from "./solConsolidateIntent";
@@ -97,8 +101,9 @@ import { VetDelegateIntent } from "./vetDelegateIntent";
 import { VetStakeClaimRewardsIntent } from "./vetStakeClaimRewardsIntent";
 import { VetValidatorRegistrationIntent } from "./vetValidatorRegistrationIntent";
 import { CantonTransferAcceptIntent } from "./cantonTransferAcceptIntent";
-import { CantonTransferRejectIntent } from "./cantonTransferRejectIntent";
 import { CantonTransferAcknowledgeIntent } from "./cantonTransferAcknowledgeIntent";
+import { CantonTransferOfferWithdrawnIntent } from "./cantonTransferOfferWithdrawnIntent";
+import { CantonTransferRejectIntent } from "./cantonTransferRejectIntent";
 import { TonWhalesDelegateIntent } from "./tonWhalesDelegateIntent";
 import { TonWhalesUndelegateIntent } from "./tonWhalesUndelegateIntent";
 import { XdcUploadKycIntent } from "./xdcStakingIntent";
@@ -124,6 +129,7 @@ export const TransactionIntent = t.union([
   BscWithdrawUndelegateIntent,
   CantonTransferAcceptIntent,
   CantonTransferAcknowledgeIntent,
+  CantonTransferOfferWithdrawnIntent,
   CantonTransferRejectIntent,
   CosmosPaymentIntent,
   CosmosStakeIntent,
@@ -186,7 +192,11 @@ export const TransactionIntent = t.union([
   TokenApprovalIntent,
   TonConsolidateIntent,
   TonDelegateIntent,
+  TonMultiNominatorDelegateIntent,
+  TonMultiNominatorUndelegateIntent,
   TonPaymentIntent,
+  TonSingleNominatorDelegateIntent,
+  TonSingleNominatorUndelegateIntent,
   TonUndelegateIntent,
   TonWhalesDelegateIntent,
   TonWhalesUndelegateIntent,

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

@@ -51,6 +51,7 @@ export const intentTypes = {
   transferAccept: t.literal("transferAccept"),
   transferReject: t.literal("transferReject"),
   transferAcknowledge: t.literal("transferAcknowledge"),
+  transferOfferWithdrawn: t.literal("transferOfferWithdrawn"),
 };
 
 export const IntentType = t.keyof(intentTypes);

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

@@ -0,0 +1,27 @@
+import * as t from "io-ts";
+import { intentTypes } from "./intentType";
+import { TonStakingTypeEnum } from "./tonStakingType";
+import { BaseIntent, BaseIntentWithAmount } from "./baseIntent";
+
+/**
+ * @title TON Multi Nominator Delegate Intent
+ *
+ * @description The intent for delegate/stake requests to TON Multi-Nominator pools
+ *
+ * @param {string} intentType The type of intent (always set to delegate)
+ * @param {string} validatorAddress The address of the validator
+ * @param {string} tonStakingType The type of TON staking (always set to MULTI_NOMINATOR)
+ */
+export const TonMultiNominatorDelegateIntent = t.intersection([
+  BaseIntent,
+  BaseIntentWithAmount,
+  t.type({
+    intentType: intentTypes.delegate,
+    validatorAddress: t.string,
+    tonStakingType: t.literal(TonStakingTypeEnum.MULTI_NOMINATOR),
+  }),
+]);
+
+export type TonMultiNominatorDelegateIntent = t.TypeOf<
+  typeof TonMultiNominatorDelegateIntent
+>;

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

@@ -0,0 +1,26 @@
+import * as t from "io-ts";
+import { intentTypes } from "./intentType";
+import { TonStakingTypeEnum } from "./tonStakingType";
+import { BaseIntent } from "./baseIntent";
+
+/**
+ * @title TON Multi Nominator Undelegate Intent
+ *
+ * @description The intent for undelegate/unstake requests from TON Multi-Nominator pools
+ *
+ * @param {string} intentType The type of intent (always set to undelegate)
+ * @param {string} validatorAddress The address of the validator
+ * @param {string} tonStakingType The type of TON staking (always set to MULTI_NOMINATOR)
+ */
+export const TonMultiNominatorUndelegateIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    intentType: intentTypes.undelegate,
+    validatorAddress: t.string,
+    tonStakingType: t.literal(TonStakingTypeEnum.MULTI_NOMINATOR),
+  }),
+]);
+
+export type TonMultiNominatorUndelegateIntent = t.TypeOf<
+  typeof TonMultiNominatorUndelegateIntent
+>;

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

@@ -0,0 +1,29 @@
+import * as t from "io-ts";
+import { intentTypes } from "./intentType";
+import { TonStakingTypeEnum } from "./tonStakingType";
+import { BaseIntent, BaseIntentWithAmount } from "./baseIntent";
+
+/**
+ * @title TON Single Nominator Delegate Intent
+ *
+ * @description The intent for delegate/stake requests to TON Single Nominator pools
+ *
+ * @param {string} intentType The type of intent (always set to delegate)
+ * @param {string} validatorAddress The address of the validator
+ * @param {string} ownerAddress The owner wallet address of the single nominator pool
+ * @param {string} tonStakingType The type of TON staking (always set to SINGLE_NOMINATOR)
+ */
+export const TonSingleNominatorDelegateIntent = t.intersection([
+  BaseIntent,
+  BaseIntentWithAmount,
+  t.type({
+    intentType: intentTypes.delegate,
+    validatorAddress: t.string,
+    ownerAddress: t.string,
+    tonStakingType: t.literal(TonStakingTypeEnum.SINGLE_NOMINATOR),
+  }),
+]);
+
+export type TonSingleNominatorDelegateIntent = t.TypeOf<
+  typeof TonSingleNominatorDelegateIntent
+>;

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

@@ -0,0 +1,27 @@
+import * as t from "io-ts";
+import { intentTypes } from "./intentType";
+import { TonStakingTypeEnum } from "./tonStakingType";
+import { BaseIntent, BaseIntentWithAmount } from "./baseIntent";
+
+/**
+ * @title TON Single Nominator Undelegate Intent
+ *
+ * @description The intent for undelegate/unstake requests from TON Single Nominator pools
+ *
+ * @param {string} intentType The type of intent (always set to undelegate)
+ * @param {string} validatorAddress The address of the validator
+ * @param {string} tonStakingType The type of TON staking (always set to SINGLE_NOMINATOR)
+ */
+export const TonSingleNominatorUndelegateIntent = t.intersection([
+  BaseIntent,
+  BaseIntentWithAmount,
+  t.type({
+    intentType: intentTypes.undelegate,
+    validatorAddress: t.string,
+    tonStakingType: t.literal(TonStakingTypeEnum.SINGLE_NOMINATOR),
+  }),
+]);
+
+export type TonSingleNominatorUndelegateIntent = t.TypeOf<
+  typeof TonSingleNominatorUndelegateIntent
+>;