@bitgo/public-types 6.5.1 → 6.6.0

package/package.json

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

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

@@ -2,13 +2,20 @@ import * as t from "io-ts";
 import { BaseIntent } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
+/**
+ * Base codec for acceleration intents. Replaces a stuck pending EVM transaction
+ * with a higher-fee version to accelerate confirmation (replace-by-fee).
+ */
 export const AccelerationIntent = t.intersection([
   BaseIntent,
   t.type({
+    /** Must be "acceleration". */
     intentType: intentTypes.acceleration,
+    /** Transaction hash (0x-prefixed) of the pending transaction to accelerate. */
     txid: t.string,
   }),
   t.partial({
+    /** Sender address of the original transaction. */
     senderAddress: t.string,
   }),
 ]);

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

@@ -2,6 +2,7 @@ import * as t from "io-ts";
 import { Optional } from "../../../utils";
 
 export const AccountBaseBuildOptions = t.partial({
+  /** Override the on-chain nonce for this transaction. */
   nonce: Optional(t.union([t.string, t.number])),
 });
 

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

@@ -12,13 +12,19 @@ import { TokenRecipientEntry } from "./tokenRecipientEntry";
 export const AccountBaseConsolidateIntent = t.intersection([
   AccountBaseBuildOptions,
   t.type({
+    /** Must be "consolidate". */
     intentType: intentTypes.consolidate,
+    /** Destination address for consolidated funds. Must be a wallet-owned address. */
     receiveAddress: t.string,
   }),
   t.partial({
+    /** Index of the wallet address to use as the sender. */
     senderAddressIndex: optionalNumber,
+    /** Opaque identifier used to correlate consolidation requests. */
     consolidateId: optionalString,
+    /** Token recipients for token consolidation flows. */
     recipients: Optional(t.array(TokenRecipientEntry)),
+    /** When true, leaves a small amount in the source address to keep it alive. */
     keepAlive: optionalBoolean,
   }),
 ]);

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

@@ -3,16 +3,15 @@ import { BaseIntent, BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 /**
- * @title Bridge Funds Intent
- * Intent for bridging assets across chains or protocols
+ * Base codec for bridge-funds intents across chains or protocols.
  *
- * The amount.symbol field identifies the asset to bridge (e.g., "ETH", "USDC")
- * The amount.value specifies how much to bridge
+ * @title Bridge Funds Intent
  */
 export const BaseBridgeFundsIntent = t.intersection([
   BaseIntent,
-  BaseIntentWithAmount, // Provides amount field with value + symbol (asset identifier)
+  BaseIntentWithAmount,
   t.type({
+    /** Must be "bridgeFunds". */
     intentType: intentTypes.bridgeFunds,
   }),
 ]);

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

@@ -13,8 +13,11 @@ export const BaseIntent = t.intersection([
     intentType: IntentType,
   }),
   t.partial({
+    /** Client-assigned sequence identifier for idempotency. */
     sequenceId: optionalString,
+    /** Human-readable memo attached to the transaction. */
     comment: optionalString,
+    /** Override the on-chain nonce for this transaction. */
     nonce: Optional(t.union([t.string, t.number])),
   }),
 ]);
@@ -26,7 +29,9 @@ export const BaseIntentWithoutNonce = t.intersection([
     intentType: IntentType,
   }),
   t.partial({
+    /** Client-assigned sequence identifier for idempotency. */
     sequenceId: optionalString,
+    /** Human-readable memo attached to the transaction. */
     comment: optionalString,
   }),
 ]);
@@ -63,6 +68,7 @@ export type BaseIntentWithoutNonce = t.TypeOf<typeof BaseIntentWithoutNonce>;
  * Asset extraction: Extracts `symbol` from each recipient's amount
  */
 export const BaseIntentWithRecipients = t.type({
+  /** Array of recipient addresses and amounts. */
   recipients: t.array(RecipientEntry),
 });
 
@@ -85,6 +91,7 @@ export type BaseIntentWithRecipients = t.TypeOf<
  * Note: This also matches BaseIntentWithRecipients since TokenRecipientEntry extends RecipientEntry
  */
 export const BaseIntentWithTokenRecipients = t.type({
+  /** Recipients of the token transfer. Each entry must include tokenData with tokenName and tokenContractAddress. */
   recipients: t.array(TokenRecipientEntry),
 });
 
@@ -120,6 +127,7 @@ export type BaseIntentWithTokenData = t.TypeOf<typeof BaseIntentWithTokenData>;
  * Asset extraction: Extracts tokenName
  */
 export const BaseIntentWithTokenName = t.type({
+  /** Name of the ERC-20 token to approve (e.g. "usdc", "weth"). */
   tokenName: t.string,
 });
 
@@ -141,6 +149,7 @@ export type BaseIntentWithTokenName = t.TypeOf<typeof BaseIntentWithTokenName>;
  * Asset extraction: Extracts symbol from the amount field
  */
 export const BaseIntentWithAmount = t.type({
+  /** Transaction amount. amount.symbol identifies the asset (e.g. "hypeevm:eth"); amount.value is the quantity in base units. */
   amount: Amount,
 });
 

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

@@ -5,9 +5,11 @@ import { StakingRequestSource } from "./stakingRequestSource";
 export const BaseStakeIntent = t.intersection([
   BaseIntent,
   t.type({
+    /** ID of the staking request, obtained from the BitGo staking service. */
     stakingRequestId: t.string,
   }),
   t.partial({
+    /** Origin of the staking request: MANUAL (user-initiated), AUTO_STAKE, or EXTERNAL. */
     source: StakingRequestSource,
   }),
 ]);

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

@@ -11,6 +11,7 @@ import { BaseStakeIntent } from "./baseStakeIntent";
 export const BaseStakeIntentWithCalldata = t.intersection([
   BaseStakeIntent,
   t.type({
+    /** Pre-computed ABI-encoded calldata for the staking contract interaction, provided by the BitGo staking service. */
     calldata: t.string,
   }),
 ]);

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

@@ -0,0 +1,20 @@
+import * as t from "io-ts";
+import { BaseStakeIntent } from "./baseStakeIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * Claim unstaked or unbonded funds from an EVM validator after the
+ * undelegation cooldown period. Requires a staking request ID from the
+ * BitGo staking service.
+ *
+ * @title Claim Intent
+ */
+export const ClaimIntent = t.intersection([
+  BaseStakeIntent,
+  t.type({
+    /** Must be "claim". */
+    intentType: intentTypes.claim,
+  }),
+]);
+
+export type ClaimIntent = t.TypeOf<typeof ClaimIntent>;

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

@@ -2,9 +2,15 @@ import * as t from "io-ts";
 import { BaseStakeIntent } from "./baseStakeIntent";
 import { intentTypes } from "./intentType";
 
+/**
+ * Delegate staked assets to a validator on EVM-compatible chains that support
+ * delegated proof-of-stake (e.g. BSC). Requires a staking request ID from the
+ * BitGo staking service.
+ */
 export const DelegateIntent = t.intersection([
   BaseStakeIntent,
   t.type({
+    /** Must be "delegate". */
     intentType: intentTypes.delegate,
   }),
 ]);

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

@@ -5,12 +5,17 @@ import { FeeOption } from "./feeOption";
 import { EIP1559FeeOptions } from "./eip1559FeeOptions";
 
 /**
+ * Replace a stuck pending EVM transaction with a higher-fee version to
+ * accelerate confirmation. Supply the original transaction's txid and new
+ * feeOptions that exceed the original.
+ *
  * @title ETH Acceleration Intent
  */
 export const EthAccelerationIntent = t.intersection([
   AccelerationIntent,
   EthBuildOptionsWithoutFeeOptions,
   t.type({
+    /** New fee settings (must be higher than the original transaction). Use EIP1559FeeOptions for London-compatible chains. */
     feeOptions: t.union([FeeOption, EIP1559FeeOptions]),
   }),
 ]);

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

@@ -8,9 +8,13 @@ import { HopParams } from "./hopParams";
 export const EthBuildOptions = t.intersection([
   AccountBaseBuildOptions,
   t.partial({
+    /** Override gas estimation. Provide EIP1559FeeOptions for EIP-1559 chains or FeeOption for legacy. */
     feeOptions: Optional(t.union([FeeOption, EIP1559FeeOptions])),
+    /** Parameters for BitGo Hop transactions (cross-chain bridging via the Hop protocol). */
     hopParams: Optional(HopParams),
+    /** Target receive address override. Defaults to wallet's primary receive address. */
     receiveAddress: optionalString,
+    /** Index of the wallet address to use as the sender. */
     senderAddressIndex: optionalNumber,
   }),
 ]);
@@ -20,8 +24,11 @@ export type EthBuildOptions = t.TypeOf<typeof EthBuildOptions>;
 export const EthBuildOptionsWithoutFeeOptions = t.intersection([
   AccountBaseBuildOptions,
   t.partial({
+    /** Parameters for BitGo Hop transactions (cross-chain bridging via the Hop protocol). */
     hopParams: Optional(HopParams),
+    /** Target receive address override. Defaults to wallet's primary receive address. */
     receiveAddress: optionalString,
+    /** Index of the wallet address to use as the sender. */
     senderAddressIndex: optionalNumber,
   }),
 ]);
@@ -33,8 +40,11 @@ export type EthBuildOptionsWithoutFeeOptions = t.TypeOf<
 // This is the same as Omit<EthBuildOptions, 'hopParams' | 'nonce'>
 // but `omit` is not easily available in io-ts
 export const EthFillNonceBuildOptions = t.partial({
+  /** Override gas estimation for the fill-nonce transaction. */
   feeOptions: Optional(t.union([FeeOption, EIP1559FeeOptions])),
+  /** Target receive address override. Defaults to wallet's primary receive address. */
   receiveAddress: optionalString,
+  /** Index of the wallet address to use as the sender. */
   senderAddressIndex: optionalNumber,
 });
 

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

@@ -3,6 +3,10 @@ import { AccountBaseConsolidateIntent } from "./accountBaseConsolidateIntent";
 import { EthBuildOptions } from "./ethBuildOptions";
 
 /**
+ * Consolidate ETH from multiple receive addresses into the wallet's main
+ * address on EVM-compatible chains. Used for wallet housekeeping. Provide
+ * receiveAddress as the sweep destination.
+ *
  * @title ETH Consolidate Intent
  */
 export const EthConsolidateIntent = t.intersection([

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

@@ -6,15 +6,23 @@ import { TokenRecipientEntry } from "./tokenRecipientEntry";
 import { EthBuildOptions } from "./ethBuildOptions";
 
 /**
+ * Consolidate ERC-20 tokens from receive addresses into the wallet's main
+ * address on EVM-compatible chains. Supply token details in the
+ * recipients[].tokenData field.
+ *
  * @title ETH Consolidate Token Intent
  */
 export const EthConsolidateTokenIntent = t.intersection([
   BaseIntent,
   EthBuildOptions,
   t.type({
+    /** Must be "consolidateToken". */
     intentType: intentTypes.consolidateToken,
+    /** Array of token recipients. Each entry specifies the token contract and amount via tokenData. */
     recipients: t.array(TokenRecipientEntry),
+    /** Opaque identifier to correlate consolidation requests. */
     consolidateId: optionalString,
+    /** When true, leaves a minimal token balance in the source address. */
     keepAlive: optionalBoolean,
   }),
 ]);

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

@@ -3,6 +3,10 @@ import { FillNonceIntent } from "./fillNonceIntent";
 import { EthFillNonceBuildOptions } from "./ethBuildOptions";
 
 /**
+ * Submit a zero-value self-send to consume a specific nonce on
+ * EVM-compatible chains. Used to unblock transaction queues when a nonce gap
+ * has formed.
+ *
  * @title ETH Fill Nonce Intent
  */
 export const EthFillNonceIntent = t.intersection([

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

@@ -4,12 +4,17 @@ import { EthBuildOptions } from "./ethBuildOptions";
 import { optionalBoolean } from "../../../utils";
 
 /**
+ * Transfer ETH or ERC-20 tokens to one or more recipients on EVM-compatible
+ * chains. Specify recipients with their address and amount. Optionally
+ * override fee settings via feeOptions.
+ *
  * @title ETH Payment Intent
  */
 export const EthPaymentIntent = t.intersection([
   PaymentIntent,
   EthBuildOptions,
   t.type({
+    /** When true, sends to the wallet's own receive address. */
     selfSend: optionalBoolean,
   }),
 ]);

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

@@ -3,15 +3,24 @@ import { StakeIntent } from "./stakeIntent";
 import { EthBuildOptions } from "./ethBuildOptions";
 
 /**
+ * Submit an ETH 2.0 validator staking deposit on Ethereum. Requires a
+ * pre-created staking request from the BitGo staking service. All validator
+ * fields (pubkey, withdrawalCredentials, signature, depositDataRoot) are
+ * provided by the staking service.
+ *
  * @title ETH Staking Intent
  */
 export const EthStakingIntent = t.intersection([
   StakeIntent,
   EthBuildOptions,
   t.type({
+    /** BLS public key of the validator (hex-encoded, provided by the staking service). */
     pubkey: t.string,
+    /** Withdrawal credentials for the validator (provided by the staking service). */
     withdrawalCredentials: t.string,
+    /** BLS signature over the deposit data (provided by the staking service). */
     signature: t.string,
+    /** SHA-256 hash of the deposit data (provided by the staking service). */
     depositDataRoot: t.string,
   }),
 ]);

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

@@ -3,6 +3,10 @@ import { EthBuildOptions } from "./ethBuildOptions";
 import { TransferTokenIntent } from "./transferTokenIntent";
 
 /**
+ * Transfer ERC-20 tokens to one or more recipients on EVM-compatible chains.
+ * Each recipient entry must include tokenData specifying the token contract
+ * and amount.
+ *
  * @title ETH Transfer Token Intent
  */
 export const EthTransferTokenIntent = t.intersection([

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

@@ -2,13 +2,21 @@ import * as t from "io-ts";
 import { BaseIntentWithoutNonce } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
+/**
+ * Base codec for fill-nonce intents. Submits a zero-value self-send to consume
+ * a specific nonce on EVM-compatible chains. Used to unblock transaction queues
+ * when a nonce gap has formed.
+ */
 export const FillNonceIntent = t.intersection([
   BaseIntentWithoutNonce,
   t.type({
+    /** Must be "fillNonce". */
     intentType: intentTypes.fillNonce,
+    /** The nonce value to fill. The transaction will be a self-send that consumes this nonce. */
     nonce: t.union([t.string, t.number]),
   }),
   t.partial({
+    /** Sender address with the stuck nonce. Defaults to the wallet's base address. */
     senderAddress: t.string,
   }),
 ]);

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

@@ -6,15 +6,15 @@ import { FeeOption } from "./feeOption";
 import { EIP1559FeeOptions } from "./eip1559FeeOptions";
 
 /**
- * @title Hypeevm Bridge Funds Intent
- * Intent for bridging assets from HyperCore to HyperEVM
+ * Bridge funds between HypeEVM L2 and L1. Specify the amount and asset via
+ * the amount field. Used exclusively on the HypeEVM chain.
  *
- * The amount.symbol field identifies the asset to bridge (e.g., "HYPE", "USDC")
- * The amount.value specifies how much to bridge
+ * @title Hypeevm Bridge Funds Intent
  */
 export const HypeevmBridgeFundsIntent = t.intersection([
   BaseBridgeFundsIntent,
   t.partial({
+    /** Override gas estimation for the bridge transaction. */
     feeOptions: Optional(t.union([FeeOption, EIP1559FeeOptions])),
   }),
 ]);

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

@@ -3,12 +3,16 @@ import { BaseIntent, BaseIntentWithRecipients } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 /**
+ * Transfer assets via the HypeEVM spot trading mechanism. Provide recipients
+ * with their address and amount. Used exclusively on the HypeEVM chain.
+ *
  * @title Hypeevm Spot Transfer Intent
  */
 export const HypeevmSpotTransferIntent = t.intersection([
   BaseIntent,
   BaseIntentWithRecipients,
   t.type({
+    /** Must be "spotTransfer". */
     intentType: intentTypes.spotTransfer,
   }),
 ]);

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

@@ -38,6 +38,7 @@ export * from "./cantonTransferAcceptIntent";
 export * from "./cantonTransferAcknowledgeIntent";
 export * from "./cantonTransferOfferWithdrawnIntent";
 export * from "./cantonTransferRejectIntent";
+export * from "./claimIntent";
 export * from "./consolidateTokenIntent";
 export * from "./coredaoClaimIntent";
 export * from "./coredaoDelegateIntent";
@@ -128,6 +129,8 @@ export * from "./solVersionedCustomTxIntent";
 export * from "./stakeClaimRewardsIntent";
 export * from "./stakeIntent";
 export * from "./stakeSwitchValidatorIntent";
+export * from "./stakeWithCallDataIntent";
+export * from "./switchValidatorWithCallDataIntent";
 export * from "./stakingRequestSource";
 export * from "./substrateAccountBaseBuildOptions";
 export * from "./substrateBaseIntent";

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

@@ -13,6 +13,7 @@ import { BabyWithdrawRewardIntent } from "./babyWithdrawRewardIntent";
 import { BscDelegateIntent } from "./bscDelegateIntent";
 import { BscUnDelegateIntent } from "./bscUndelegateIntent";
 import { BscWithdrawUndelegateIntent } from "./bscWithdrawUndelegateIntent";
+import { ClaimIntent } from "./claimIntent";
 import {
   VetExitDelegationIntent,
   VetBurnNFTIntent,
@@ -91,6 +92,8 @@ import { BaseIntent } from "./baseIntent";
 import { DotConsolidateIntent } from "./dotConsolidateIntent";
 import { SolCloseAssociatedTokenAccountIntent } from "./solCloseAssociatedTokenAccountIntent";
 import { BaseStakeIntentWithCalldata } from "./baseStakeIntentWithCalldata";
+import { StakeWithCallDataIntent } from "./stakeWithCallDataIntent";
+import { SwitchValidatorWithCallDataIntent } from "./switchValidatorWithCallDataIntent";
 import { CoreDaoDelegateIntent } from "./coredaoDelegateIntent";
 import { CoreDaoUndelegateIntent } from "./coredaoUndelegateIntent";
 import { CoreDaoClaimIntent } from "./coredaoClaimIntent";
@@ -129,6 +132,9 @@ import { XdcResignIntent } from "./xdcUnstakingIntent";
 import { XdcWithdrawIntent } from "./xdcUnstakingIntent";
 import { HypeevmBridgeFundsIntent } from "./hypeevmBridgeFundsIntent";
 import { HypeevmEnableBridgingIntent } from "./hypeevmEnableBridgingIntent";
+import { DelegateIntent } from "./delegateIntent";
+import { UndelegateIntent } from "./undelegateIntent";
+import { StakeClaimRewardsIntent } from "./stakeClaimRewardsIntent";
 
 export const TransactionIntent = t.union([
   AdaConsolidateIntent,
@@ -152,6 +158,7 @@ export const TransactionIntent = t.union([
   CantonTransferAcknowledgeIntent,
   CantonTransferOfferWithdrawnIntent,
   CantonTransferRejectIntent,
+  ClaimIntent,
   CosmosPaymentIntent,
   CosmosStakeIntent,
   CosmosSwitchValidatorIntent,
@@ -165,6 +172,7 @@ export const TransactionIntent = t.union([
   DotStakingIntent,
   DotUnstakingIntent,
   DotWithdrawStakeIntent,
+  DelegateIntent,
   EthAccelerationIntent,
   EthConsolidateIntent,
   EthConsolidateTokenIntent,
@@ -172,6 +180,8 @@ export const TransactionIntent = t.union([
   EthPaymentIntent,
   EthStakingIntent,
   EthTransferTokenIntent,
+  StakeClaimRewardsIntent,
+  UndelegateIntent,
   FeeAddressTransferIntent,
   HbarUpdateAccountIntent,
   HypeevmBridgeFundsIntent,
@@ -246,6 +256,8 @@ export const TransactionIntent = t.union([
   VetWithdrawStakeIntent,
   WalletRecoveryIntent,
   BaseStakeIntentWithCalldata,
+  StakeWithCallDataIntent,
+  SwitchValidatorWithCallDataIntent,
   CoreDaoDelegateIntent,
   CoreDaoUndelegateIntent,
   CoreDaoClaimIntent,

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

@@ -7,10 +7,13 @@ export const PaymentIntent = t.intersection([
   BaseIntentWithRecipients,
   t.union([
     t.type({
+      /** Must be "payment". */
       intentType: intentTypes.payment,
     }),
     t.type({
+      /** Must be "payment". */
       intentType: intentTypes.payment,
+      /** When true, marks this as a test transaction (not broadcast to the network). */
       isTestTransaction: t.boolean,
     }),
   ]),

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

@@ -74,17 +74,24 @@ type RecipientEntryDecoded = t.TypeOf<typeof RecipientEntry>;
  * Internal io-ts brand for one close-ATA recipient row (not exported).
  *
  * Uses {@link t.brand} instead of `t.refinement` so OpenAPI generation does not
- * emit an unresolvable `#/components/schemas/refinement`. The predicate is cast via
- * `unknown` to satisfy `t.brand`'s `Branded<…>` predicate type because runtime checks
- * match the brand, while
- * `SolCloseAssociatedTokenAccountRecipient` is a plain structural alias. For the
+ * emit an unresolvable `#/components/schemas/refinement`. The brand predicate must be
+ * an inline function expression (not a bare identifier) so `@api-ts/openapi-generator`
+ * does not try to resolve it as a codec. The predicate is cast via `unknown` to
+ * satisfy `t.brand`'s `Branded<…>` predicate type because runtime checks match the
+ * brand, while `SolCloseAssociatedTokenAccountRecipient` is a plain structural alias.
+ * For the
  * narrowed row shape after validation, use {@link SolCloseAssociatedTokenAccountRecipient}
  * (see {@link SolCloseAssociatedTokenAccountIntent}’s exported type, which overrides
  * `recipients` accordingly).
  */
 const solCloseAssociatedTokenAccountRecipientEntry = t.brand(
   RecipientEntry,
-  isSolCloseAssociatedTokenAccountRecipient as unknown as (
+  ((
+    recipient: RecipientEntryDecoded,
+  ): recipient is t.Branded<
+    RecipientEntryDecoded,
+    SolCloseAssociatedTokenAccountRecipientEntryBrand
+  > => isSolCloseAssociatedTokenAccountRecipient(recipient)) as unknown as (
     recipient: RecipientEntryDecoded,
   ) => recipient is t.Branded<
     RecipientEntryDecoded,

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

@@ -3,10 +3,16 @@ import { intentTypes } from "./intentType";
 import { BaseStakeIntent } from "./baseStakeIntent";
 import { BaseIntentWithAmount } from "./baseIntent";
 
+/**
+ * Claim accumulated staking rewards on EVM-compatible chains. Specify the
+ * amount of rewards to claim. Requires a staking request ID from the BitGo
+ * staking service.
+ */
 export const StakeClaimRewardsIntent = t.intersection([
   BaseStakeIntent,
   BaseIntentWithAmount,
   t.type({
+    /** Must be "stakeClaimRewards". */
     intentType: intentTypes.stakeClaimRewards,
   }),
 ]);

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

@@ -5,6 +5,7 @@ import { intentTypes } from "./intentType";
 export const StakeIntent = t.intersection([
   BaseStakeIntent,
   t.type({
+    /** Must be "stake". */
     intentType: intentTypes.stake,
   }),
 ]);

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

@@ -0,0 +1,20 @@
+import * as t from "io-ts";
+import { BaseStakeIntentWithCalldata } from "./baseStakeIntentWithCalldata";
+import { intentTypes } from "./intentType";
+
+/**
+ * Submit an EVM staking transaction using pre-computed calldata provided by
+ * the BitGo staking service. Used when the staking protocol requires custom
+ * calldata that cannot be derived from standard deposit parameters.
+ *
+ * @title Stake With CallData Intent
+ */
+export const StakeWithCallDataIntent = t.intersection([
+  BaseStakeIntentWithCalldata,
+  t.type({
+    /** Must be "stakeWithCallData". */
+    intentType: intentTypes.stakeWithCallData,
+  }),
+]);
+
+export type StakeWithCallDataIntent = t.TypeOf<typeof StakeWithCallDataIntent>;

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

@@ -0,0 +1,22 @@
+import * as t from "io-ts";
+import { BaseStakeIntentWithCalldata } from "./baseStakeIntentWithCalldata";
+import { intentTypes } from "./intentType";
+
+/**
+ * Switch validators on EVM-compatible chains using pre-computed calldata.
+ * Supply the staking service's stakingRequestId and the pre-computed calldata
+ * for the validator switch.
+ *
+ * @title Switch Validator With CallData Intent
+ */
+export const SwitchValidatorWithCallDataIntent = t.intersection([
+  BaseStakeIntentWithCalldata,
+  t.type({
+    /** Must be "switchValidatorWithCallData". */
+    intentType: intentTypes.switchValidatorWithCallData,
+  }),
+]);
+
+export type SwitchValidatorWithCallDataIntent = t.TypeOf<
+  typeof SwitchValidatorWithCallDataIntent
+>;

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

@@ -3,13 +3,17 @@ import { BaseIntent, BaseIntentWithTokenName } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 /**
+ * Approve an ERC-20 token for spending by the BitGo batcher contract on
+ * EVM-compatible chains. Required before sending a token that has not been
+ * previously approved. Provide tokenName to identify the token.
+ *
  * @title Intent for approving tokens for spending by a batcher contract
- * The server will determine the spender address and approval amount
  */
 export const TokenApprovalIntent = t.intersection([
   BaseIntent,
   BaseIntentWithTokenName,
   t.type({
+    /** Must be "tokenApproval". */
     intentType: intentTypes.tokenApproval,
   }),
 ]);

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

@@ -6,6 +6,7 @@ export const TransferTokenIntent = t.intersection([
   BaseIntent,
   BaseIntentWithTokenRecipients,
   t.type({
+    /** Must be "transferToken". */
     intentType: intentTypes.transferToken,
   }),
 ]);