@bitgo/public-types 6.6.0 → 6.7.0

package/package.json

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

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

@@ -3,11 +3,16 @@ import { optionalString } from "../../../utils";
 import { PaymentIntent } from "./paymentIntent";
 
 /**
+ * Transfer tokens from a Cosmos-family wallet to one or more recipient
+ * addresses. Supported on all Cosmos-family chains. An optional memo may
+ * be included for exchange routing or identification.
+ *
  * @title Atom Payment Intent
  */
 export const AtomPaymentIntent = t.intersection([
   PaymentIntent,
   t.type({
+    /** Optional memo string attached to the transaction, used for routing or identification by exchanges. */
     memo: optionalString,
   }),
 ]);

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

@@ -5,15 +5,21 @@ import { StakeIntent } from "./stakeIntent";
 import { BaseIntentWithAmount } from "./baseIntent";
 
 /**
+ * Delegate (stake) tokens to one or more validators on ATOM. Use
+ * `validatorAddress` and `amount` for a single validator, or `recipients`
+ * for multi-validator delegation.
+ *
  * @title Atom Stake Intent
  */
 export const AtomStakeIntent = t.intersection([
   StakeIntent,
   BaseIntentWithAmount,
   t.type({
+    /** Bech32 validator address to delegate tokens to (e.g. cosmosvaloper1...). */
     validatorAddress: t.string,
   }),
   t.partial({
+    /** Optional list of validator–amount pairs for multi-validator delegation. When provided, overrides validatorAddress and amount. */
     recipients: Optional(t.array(RecipientEntry)),
   }),
 ]);

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

@@ -5,15 +5,21 @@ import { RecipientEntry } from "./recipientEntry";
 import { Optional } from "../../../utils";
 
 /**
+ * Undelegate (unstake) tokens from one or more validators on ATOM. Tokens
+ * enter the unbonding period. Use `validatorAddress` and `amount` for
+ * single validator or `recipients` for multi-validator.
+ *
  * @title Atom Unstake Intent
  */
 export const AtomUnstakeIntent = t.intersection([
   UnstakeIntent,
   BaseIntentWithAmount,
   t.type({
+    /** Bech32 validator address to undelegate tokens from (e.g. cosmosvaloper1...). */
     validatorAddress: t.string,
   }),
   t.partial({
+    /** Optional list of validator–amount pairs for multi-validator undelegation. When provided, overrides validatorAddress and amount. */
     recipients: Optional(t.array(RecipientEntry)),
   }),
 ]);

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

@@ -3,7 +3,13 @@ import { WithdrawIntent } from "./withdrawIntent";
 import { BaseIntentWithAmount } from "./baseIntent";
 
 /**
+ * Internal codec for ATOM staking reward claims. The `claim` intentType
+ * discriminant is not dispatched by the server — do not use directly. Use
+ * `CosmosStakeClaimRewardsIntent` with `intentType: stakeClaimRewards`
+ * instead.
+ *
  * @title Atom Withdraw Intent
+ * @deprecated
  */
 export const AtomWithdrawIntent = t.intersection([
   WithdrawIntent,

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

@@ -0,0 +1,30 @@
+import * as t from "io-ts";
+import { BaseIntent } from "./baseIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * Execute a Wasm smart contract on a Cosmos-family chain. Supported on all
+ * Cosmos-family chains. The hash chain additionally supports fee-grant via
+ * the optional feeGranter field.
+ *
+ * @title Cosmos Contract Call Intent
+ */
+export const CosmosContractCallIntent = t.intersection([
+  BaseIntent,
+  t.type({
+    /** Must be "contractCall" */
+    intentType: intentTypes.contractCall,
+    /** Bech32 contract address to execute */
+    contract: t.string,
+    /** Hex-encoded binary message to pass to the contract Execute entrypoint */
+    msgHex: t.string,
+  }),
+  t.partial({
+    /** Optional Bech32 address paying transaction fees on behalf of the submitter (fee-grant). Supported on hash chain; passed through for any chain. */
+    feeGranter: t.string,
+  }),
+]);
+
+export type CosmosContractCallIntent = t.TypeOf<
+  typeof CosmosContractCallIntent
+>;

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

@@ -3,11 +3,16 @@ import { PaymentIntent } from "./paymentIntent";
 import { optionalString } from "../../../utils";
 
 /**
+ * Transfer tokens from a Cosmos-family wallet to one or more recipient
+ * addresses. Supported on all Cosmos-family chains. An optional memo may
+ * be included for exchange routing or identification.
+ *
  * @title Cosmos Payment Intent
  */
 export const CosmosPaymentIntent = t.intersection([
   PaymentIntent,
   t.type({
+    /** Optional memo string attached to the transaction, used for routing or identification by exchanges. */
     memo: optionalString,
   }),
 ]);

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

@@ -0,0 +1,23 @@
+import * as t from "io-ts";
+import { BaseStakeIntent } from "./baseStakeIntent";
+import { intentTypes } from "./intentType";
+
+/**
+ * Claim accumulated staking rewards from a validator on a Cosmos-family chain.
+ * Supported on all Cosmos-family chains. Submit with intentType stakeClaimRewards.
+ *
+ * @title Cosmos Stake Claim Rewards Intent
+ */
+export const CosmosStakeClaimRewardsIntent = t.intersection([
+  BaseStakeIntent,
+  t.type({
+    /** Must be "stakeClaimRewards" */
+    intentType: intentTypes.stakeClaimRewards,
+    /** Bech32 validator address to withdraw accumulated staking rewards from (e.g. cosmosvaloper1...) */
+    validatorAddress: t.string,
+  }),
+]);
+
+export type CosmosStakeClaimRewardsIntent = t.TypeOf<
+  typeof CosmosStakeClaimRewardsIntent
+>;

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

@@ -6,6 +6,10 @@ import { RecipientEntry } from "./recipientEntry";
 import { Optional } from "../../../utils";
 
 /**
+ * Delegate (stake) tokens to one or more validators on a Cosmos-family
+ * chain. Use `validatorAddress` and `amount` for a single validator, or
+ * `recipients` for multi-validator delegation in a single transaction.
+ *
  * @title Cosmos Stake Intent
  */
 export const CosmosStakeIntent = t.intersection([
@@ -13,9 +17,11 @@ export const CosmosStakeIntent = t.intersection([
   BaseIntentWithAmount,
   t.type({
     intentType: intentTypes.delegate,
+    /** Bech32 validator address to delegate tokens to (e.g. cosmosvaloper1...). */
     validatorAddress: t.string,
   }),
   t.partial({
+    /** Optional list of validator–amount pairs for multi-validator delegation. When provided, overrides validatorAddress and amount. */
     recipients: Optional(t.array(RecipientEntry)),
   }),
 ]);

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

@@ -2,6 +2,10 @@ import * as t from "io-ts";
 import { StakeSwitchValidatorIntent } from "./stakeSwitchValidatorIntent";
 
 /**
+ * Atomically move a delegation from one validator to another (redelegate)
+ * on a Cosmos-family chain. The redelegation is subject to the chain's
+ * redelegation cooldown rules.
+ *
  * @title Cosmos Switch Validator Intent
  */
 export const CosmosSwitchValidatorIntent = StakeSwitchValidatorIntent;

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

@@ -6,6 +6,11 @@ import { RecipientEntry } from "./recipientEntry";
 import { Optional } from "../../../utils";
 
 /**
+ * Undelegate (unstake) tokens from one or more validators on a
+ * Cosmos-family chain. Tokens enter the chain's unbonding period and are
+ * not immediately available. Use `validatorAddress` and `amount` for a
+ * single validator, or `recipients` for multi-validator undelegation.
+ *
  * @title Cosmos Unstake Intent
  */
 export const CosmosUnstakeIntent = t.intersection([
@@ -13,9 +18,11 @@ export const CosmosUnstakeIntent = t.intersection([
   BaseIntentWithAmount,
   t.type({
     intentType: intentTypes.undelegate,
+    /** Bech32 validator address to undelegate tokens from (e.g. cosmosvaloper1...). */
     validatorAddress: t.string,
   }),
   t.partial({
+    /** Optional list of validator–amount pairs for multi-validator undelegation. When provided, overrides validatorAddress and amount. */
     recipients: Optional(t.array(RecipientEntry)),
   }),
 ]);

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

@@ -2,7 +2,13 @@ import * as t from "io-ts";
 import { WithdrawIntent } from "./withdrawIntent";
 
 /**
+ * Internal codec for cosmos-family staking reward claims. The `claim`
+ * intentType discriminant is not dispatched by the server — do not use
+ * directly. Use `CosmosStakeClaimRewardsIntent` with
+ * `intentType: stakeClaimRewards` instead.
+ *
  * @title Cosmos Withdraw Intent
+ * @deprecated
  */
 export const CosmosWithdrawIntent = t.intersection([
   WithdrawIntent,

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

@@ -43,7 +43,9 @@ 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";

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

@@ -7,7 +7,6 @@ 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";
@@ -20,11 +19,12 @@ import {
 } 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";
@@ -130,6 +130,7 @@ 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";
@@ -147,7 +148,6 @@ export const TransactionIntent = t.union([
   AtomPaymentIntent,
   AtomStakeIntent,
   AtomUnstakeIntent,
-  AtomWithdrawIntent,
   BabyCreateBtcDelegationIntent,
   BabyWithdrawRewardIntent,
   BscDelegateIntent,
@@ -159,11 +159,12 @@ export const TransactionIntent = t.union([
   CantonTransferOfferWithdrawnIntent,
   CantonTransferRejectIntent,
   ClaimIntent,
+  CosmosContractCallIntent,
   CosmosPaymentIntent,
+  CosmosStakeClaimRewardsIntent,
   CosmosStakeIntent,
   CosmosSwitchValidatorIntent,
   CosmosUnstakeIntent,
-  CosmosWithdrawIntent,
   DefiDepositIntent,
   DefiRedeemIntent,
   DotConsolidateIntent,
@@ -177,6 +178,7 @@ export const TransactionIntent = t.union([
   EthConsolidateIntent,
   EthConsolidateTokenIntent,
   EthFillNonceIntent,
+  FillNonceIntent,
   EthPaymentIntent,
   EthStakingIntent,
   EthTransferTokenIntent,

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