@bitgo/public-types 6.5.2 → 6.7.0

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

@@ -38,11 +38,14 @@ export * from "./cantonTransferAcceptIntent";
 export * from "./cantonTransferAcknowledgeIntent";
 export * from "./cantonTransferOfferWithdrawnIntent";
 export * from "./cantonTransferRejectIntent";
+export * from "./claimIntent";
 export * from "./consolidateTokenIntent";
 export * from "./coredaoClaimIntent";
 export * from "./coredaoDelegateIntent";
 export * from "./coredaoUndelegateIntent";
+export * from "./cosmosContractCallIntent";
 export * from "./cosmosPaymentIntent";
+export * from "./cosmosStakeClaimRewardsIntent";
 export * from "./cosmosStakeIntent";
 export * from "./cosmosSwitchValidatorIntent";
 export * from "./cosmosUnstakeIntent";
@@ -128,6 +131,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

@@ -7,23 +7,24 @@ import { AptCustomTxIntent } from "./aptCustomTxIntent";
 import { AtomPaymentIntent } from "./atomPaymentIntent";
 import { AtomStakeIntent } from "./atomStakeIntent";
 import { AtomUnstakeIntent } from "./atomUnstakeIntent";
-import { AtomWithdrawIntent } from "./atomWithdrawIntent";
 import { BabyCreateBtcDelegationIntent } from "./babyCreateBtcDelegationIntent";
 import { BabyWithdrawRewardIntent } from "./babyWithdrawRewardIntent";
 import { BscDelegateIntent } from "./bscDelegateIntent";
 import { BscUnDelegateIntent } from "./bscUndelegateIntent";
 import { BscWithdrawUndelegateIntent } from "./bscWithdrawUndelegateIntent";
+import { ClaimIntent } from "./claimIntent";
 import {
   VetExitDelegationIntent,
   VetBurnNFTIntent,
 } from "./vetUnstakingIntent";
 import { DefiDepositIntent } from "./defiDepositIntent";
 import { DefiRedeemIntent } from "./defiRedeemIntent";
+import { CosmosContractCallIntent } from "./cosmosContractCallIntent";
 import { CosmosPaymentIntent } from "./cosmosPaymentIntent";
+import { CosmosStakeClaimRewardsIntent } from "./cosmosStakeClaimRewardsIntent";
 import { CosmosStakeIntent } from "./cosmosStakeIntent";
 import { CosmosSwitchValidatorIntent } from "./cosmosSwitchValidatorIntent";
 import { CosmosUnstakeIntent } from "./cosmosUnstakeIntent";
-import { CosmosWithdrawIntent } from "./cosmosWithdrawIntent";
 import { DotCreateAccountIntent } from "./dotCreateAccountIntent";
 import { DotPaymentIntent } from "./dotPaymentIntent";
 import { DotStakingIntent } from "./dotStakingIntent";
@@ -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";
@@ -127,8 +130,12 @@ import { XdcUploadKycIntent } from "./xdcStakingIntent";
 import { XdcProposeIntent } from "./xdcStakingIntent";
 import { XdcResignIntent } from "./xdcUnstakingIntent";
 import { XdcWithdrawIntent } from "./xdcUnstakingIntent";
+import { FillNonceIntent } from "./fillNonceIntent";
 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,
@@ -141,7 +148,6 @@ export const TransactionIntent = t.union([
   AtomPaymentIntent,
   AtomStakeIntent,
   AtomUnstakeIntent,
-  AtomWithdrawIntent,
   BabyCreateBtcDelegationIntent,
   BabyWithdrawRewardIntent,
   BscDelegateIntent,
@@ -152,11 +158,13 @@ export const TransactionIntent = t.union([
   CantonTransferAcknowledgeIntent,
   CantonTransferOfferWithdrawnIntent,
   CantonTransferRejectIntent,
+  ClaimIntent,
+  CosmosContractCallIntent,
   CosmosPaymentIntent,
+  CosmosStakeClaimRewardsIntent,
   CosmosStakeIntent,
   CosmosSwitchValidatorIntent,
   CosmosUnstakeIntent,
-  CosmosWithdrawIntent,
   DefiDepositIntent,
   DefiRedeemIntent,
   DotConsolidateIntent,
@@ -165,13 +173,17 @@ export const TransactionIntent = t.union([
   DotStakingIntent,
   DotUnstakingIntent,
   DotWithdrawStakeIntent,
+  DelegateIntent,
   EthAccelerationIntent,
   EthConsolidateIntent,
   EthConsolidateTokenIntent,
   EthFillNonceIntent,
+  FillNonceIntent,
   EthPaymentIntent,
   EthStakingIntent,
   EthTransferTokenIntent,
+  StakeClaimRewardsIntent,
+  UndelegateIntent,
   FeeAddressTransferIntent,
   HbarUpdateAccountIntent,
   HypeevmBridgeFundsIntent,
@@ -246,6 +258,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/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/stakeSwitchValidatorIntent.ts

@@ -8,7 +8,9 @@ export const StakeSwitchValidatorIntent = t.intersection([
   BaseIntentWithAmount,
   t.type({
     intentType: intentTypes.switchValidator,
+    /** Bech32 source validator address to redelegate from (e.g. cosmosvaloper1...). */
     validatorAddress: t.string,
+    /** Bech32 destination validator address to redelegate to (e.g. cosmosvaloper1...). */
     destValidatorAddress: t.string,
   }),
 ]);

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,
   }),
 ]);

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

@@ -2,9 +2,15 @@ import * as t from "io-ts";
 import { BaseStakeIntent } from "./baseStakeIntent";
 import { intentTypes } from "./intentType";
 
+/**
+ * Remove delegation of staked assets from a validator on EVM-compatible chains.
+ * Initiates the unbonding period. Requires a staking request ID from the BitGo
+ * staking service.
+ */
 export const UndelegateIntent = t.intersection([
   BaseStakeIntent,
   t.type({
+    /** Must be "undelegate". */
     intentType: intentTypes.undelegate,
   }),
 ]);