@bitgo/public-types 5.53.0 → 5.55.0

package/package.json

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

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

@@ -147,10 +147,12 @@ export * from "./tonUndelegateIntent";
 export * from "./transferTokenIntent";
 export * from "./unstakeIntent";
 export * from "./unsupportedTokenRecipientEntryItem";
+export * from "./validatorRegistrationIntent";
 export * from "./vetDelegateIntent";
 export * from "./vetStakeClaimRewardsIntent";
 export * from "./vetStakingIntent";
 export * from "./vetUnstakingIntent";
+export * from "./vetValidatorRegistrationIntent";
 export * from "./voteDelegationIntent";
 export * from "./walletRecoveryIntent";
 export * from "./walrusStakingIntent";

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

@@ -94,9 +94,11 @@ import { SuiGoUnstakeIntent } from "./suiGoUnstakeIntent";
 import { VetStakingIntent } from "./vetStakingIntent";
 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 { TonWhalesDelegateIntent } from "./tonWhalesDelegateIntent";
 
 export const TransactionIntent = t.union([
   AdaConsolidateIntent,
@@ -179,11 +181,13 @@ export const TransactionIntent = t.union([
   TonDelegateIntent,
   TonPaymentIntent,
   TonUndelegateIntent,
+  TonWhalesDelegateIntent,
   VetStakingIntent,
   VetDelegateIntent,
   VetExitDelegationIntent,
   VetBurnNFTIntent,
   VetStakeClaimRewardsIntent,
+  VetValidatorRegistrationIntent,
   WalletRecoveryIntent,
   BaseStakeIntentWithCalldata,
   CoreDaoDelegateIntent,

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

@@ -37,6 +37,7 @@ export const intentTypes = {
   feeAddressTransfer: t.literal("feeAddressTransfer"),
   tokenApproval: t.literal("tokenApproval"),
   transferStake: t.literal("transferStake"),
+  validatorRegistration: t.literal("validatorRegistration"),
   /**
    * Unstake and transfer funds from a staking wallet to a go account.
    */

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

@@ -2,6 +2,7 @@ import * as t from "io-ts";
 import { BaseIntent, BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
 import { optionalString } from "../../../utils";
+import { TonStakingType } from "./tonStakingType";
 
 /**
  * @title TON Delegate Intent
@@ -20,10 +21,14 @@ export const TonDelegateIntent = t.intersection([
   t.type({
     intentType: intentTypes.delegate,
     validatorAddress: t.string,
+    // TODO SC-4508: deprecate useSingleNominator in favor of tonStakingType
     useSingleNominator: t.boolean,
   }),
   t.partial({
+    // TODO SC-4508: move this to the TonSingleNominatorDelegateIntent
     ownerAddress: optionalString,
+    // TODO SC-4509: Make tonStakingType required by moving from partial to type
+    tonStakingType: TonStakingType,
   }),
 ]);
 

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

@@ -0,0 +1,11 @@
+import * as t from "io-ts";
+
+export enum TonStakingTypeEnum {
+  SINGLE_NOMINATOR = "SINGLE_NOMINATOR",
+  MULTI_NOMINATOR = "MULTI_NOMINATOR",
+  TON_WHALES = "TON_WHALES",
+}
+
+export const TonStakingType = t.keyof(TonStakingTypeEnum);
+
+export type TonStakingType = t.TypeOf<typeof TonStakingType>;

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

@@ -0,0 +1,26 @@
+import * as t from "io-ts";
+import { intentTypes } from "./intentType";
+import { TonStakingTypeEnum } from "./tonStakingType";
+import { BaseIntent, BaseIntentWithAmount } from "./baseIntent";
+
+/**
+ * @title TON Whales Delegate Intent
+ *
+ * @description The intent for delegate/stake requests to TON Whales validators
+ *
+ * @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 TON_WHALES)
+ */
+export const TonWhalesDelegateIntent = t.intersection([
+  // TODO SC-4508: Update to extend from TonDelegateIntent once deprecation is done
+  BaseIntent,
+  BaseIntentWithAmount,
+  t.type({
+    intentType: intentTypes.delegate,
+    validatorAddress: t.string,
+    tonStakingType: t.literal(TonStakingTypeEnum.TON_WHALES),
+  }),
+]);
+
+export type TonWhalesDelegateIntent = t.TypeOf<typeof TonWhalesDelegateIntent>;

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

@@ -0,0 +1,14 @@
+import * as t from "io-ts";
+import { BaseStakeIntent } from "./baseStakeIntent";
+import { intentTypes } from "./intentType";
+
+export const ValidatorRegistrationIntent = t.intersection([
+  BaseStakeIntent,
+  t.type({
+    intentType: intentTypes.validatorRegistration,
+  }),
+]);
+
+export type ValidatorRegistrationIntent = t.TypeOf<
+  typeof ValidatorRegistrationIntent
+>;

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

@@ -0,0 +1,23 @@
+import * as t from "io-ts";
+import { ValidatorRegistrationIntent } from "./validatorRegistrationIntent";
+import { NonEmptyString } from "io-ts-types";
+
+/**
+ * @title VET Validator Registration Intent
+ *
+ * Intent for adding validator with stake amount from endorser
+ *
+ * @param {string} validatorAddress - The address of the validator
+ * @param {number} stakingPeriod - The staking period which can be one of the three -- 60480 (7 days), 129600 (15 days) or 259200 (30 days).
+ */
+export const VetValidatorRegistrationIntent = t.intersection([
+  ValidatorRegistrationIntent,
+  t.type({
+    validatorAddress: NonEmptyString,
+    stakingPeriod: t.number,
+  }),
+]);
+
+export type VetValidatorRegistrationIntent = t.TypeOf<
+  typeof VetValidatorRegistrationIntent
+>;