@bitgo/public-types 5.51.0 → 5.53.0

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

@@ -1,6 +1,6 @@
 import * as t from "io-ts";
 import { BaseStakeIntentWithCalldata } from "./baseStakeIntentWithCalldata";
-import { Amount } from "./amount";
+import { BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 /**
@@ -14,10 +14,10 @@ import { intentTypes } from "./intentType";
  */
 export const CoreDaoUndelegateIntent = t.intersection([
   BaseStakeIntentWithCalldata,
+  BaseIntentWithAmount,
   t.type({
     intentType: intentTypes.undelegate,
     validatorAddress: t.string,
-    amount: Amount,
   }),
 ]);
 

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts";
 import { BaseStakeIntent } from "./baseStakeIntent";
+import { BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
-import { Amount } from "./amount";
 import { RecipientEntry } from "./recipientEntry";
 import { Optional } from "../../../utils";
 
@@ -10,10 +10,10 @@ import { Optional } from "../../../utils";
  */
 export const CosmosStakeIntent = t.intersection([
   BaseStakeIntent,
+  BaseIntentWithAmount,
   t.type({
     intentType: intentTypes.delegate,
     validatorAddress: t.string,
-    amount: Amount,
   }),
   t.partial({
     recipients: Optional(t.array(RecipientEntry)),

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts";
 import { BaseStakeIntent } from "./baseStakeIntent";
+import { BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
-import { Amount } from "./amount";
 import { RecipientEntry } from "./recipientEntry";
 import { Optional } from "../../../utils";
 
@@ -10,10 +10,10 @@ import { Optional } from "../../../utils";
  */
 export const CosmosUnstakeIntent = t.intersection([
   BaseStakeIntent,
+  BaseIntentWithAmount,
   t.type({
     intentType: intentTypes.undelegate,
     validatorAddress: t.string,
-    amount: Amount,
   }),
   t.partial({
     recipients: Optional(t.array(RecipientEntry)),

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts";
 import { DotAccountBaseBuildOptions } from "./dotAccountBaseBuildOptions";
-import { Amount } from "./amount";
 import { StakeIntent } from "./stakeIntent";
+import { BaseIntentWithAmount } from "./baseIntent";
 import { optionalBoolean } from "../../../utils";
 
 /**
@@ -10,8 +10,8 @@ import { optionalBoolean } from "../../../utils";
 export const DotStakingIntent = t.intersection([
   StakeIntent,
   DotAccountBaseBuildOptions,
+  BaseIntentWithAmount,
   t.type({
-    amount: Amount,
     stakingProxy: t.string,
   }),
   t.partial({

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts";
 import { UnstakeIntent } from "./unstakeIntent";
 import { DotAccountBaseBuildOptions } from "./dotAccountBaseBuildOptions";
-import { Amount } from "./amount";
+import { BaseIntentWithAmount } from "./baseIntent";
 import { optionalBoolean } from "../../../utils";
 
 /**
@@ -10,8 +10,8 @@ import { optionalBoolean } from "../../../utils";
 export const DotUnstakingIntent = t.intersection([
   UnstakeIntent,
   DotAccountBaseBuildOptions,
+  BaseIntentWithAmount,
   t.type({
-    amount: Amount,
     stakingProxy: t.string,
   }),
   t.partial({

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

@@ -1,18 +1,16 @@
 import * as t from "io-ts";
-import { BaseIntent } from "./baseIntent";
+import { BaseIntent, BaseIntentWithRecipients } from "./baseIntent";
 import { intentTypes } from "./intentType";
-import { RecipientEntry } from "./recipientEntry";
 
 export const PaymentIntent = t.intersection([
   BaseIntent,
+  BaseIntentWithRecipients,
   t.union([
     t.type({
       intentType: intentTypes.payment,
-      recipients: t.array(RecipientEntry),
     }),
     t.type({
       intentType: intentTypes.payment,
-      recipients: t.array(RecipientEntry),
       isTestTransaction: t.boolean,
     }),
   ]),

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts";
 import { SolBuildOptions } from "./solBuildOptions";
-import { Amount } from "./amount";
 import { WithdrawIntent } from "./withdrawIntent";
+import { BaseIntentWithAmount } from "./baseIntent";
 
 /**
  * @title SOL Claim Intent
@@ -9,9 +9,9 @@ import { WithdrawIntent } from "./withdrawIntent";
 export const SolClaimIntent = t.intersection([
   WithdrawIntent,
   SolBuildOptions,
+  BaseIntentWithAmount,
   t.type({
     stakingAddress: t.string,
-    amount: Amount,
   }),
 ]);
 

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

@@ -1,7 +1,7 @@
 import * as t from "io-ts";
 import { SolBuildOptions } from "./solBuildOptions";
 import { StakeIntent } from "./stakeIntent";
-import { Amount } from "./amount";
+import { BaseIntentWithAmount } from "./baseIntent";
 import { Optional } from "../../../utils";
 import { SolStakingType } from "./solStakingType";
 
@@ -11,9 +11,9 @@ import { SolStakingType } from "./solStakingType";
 export const SolStakeIntent = t.intersection([
   StakeIntent,
   SolBuildOptions,
+  BaseIntentWithAmount,
   t.type({
     validatorAddress: t.string,
-    amount: Amount,
     /**
      * @deprecated Use `stakingType` instead.
      */

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

@@ -1,13 +1,13 @@
 import * as t from "io-ts";
 import { intentTypes } from "./intentType";
 import { BaseStakeIntent } from "./baseStakeIntent";
-import { Amount } from "./amount";
+import { BaseIntentWithAmount } from "./baseIntent";
 
 export const StakeClaimRewardsIntent = t.intersection([
   BaseStakeIntent,
+  BaseIntentWithAmount,
   t.type({
     intentType: intentTypes.stakeClaimRewards,
-    amount: Amount,
   }),
 ]);
 

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

@@ -1,13 +1,13 @@
 import * as t from "io-ts";
 import { BaseStakeIntent } from "./baseStakeIntent";
+import { BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
-import { Amount } from "./amount";
 
 export const StakeSwitchValidatorIntent = t.intersection([
   BaseStakeIntent,
+  BaseIntentWithAmount,
   t.type({
     intentType: intentTypes.switchValidator,
-    amount: Amount,
     validatorAddress: t.string,
     destValidatorAddress: t.string,
   }),

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

@@ -1,5 +1,5 @@
 import * as t from "io-ts";
-import { BaseIntent } from "./baseIntent";
+import { BaseIntent, BaseIntentWithTokenName } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 /**
@@ -8,9 +8,9 @@ import { intentTypes } from "./intentType";
  */
 export const TokenApprovalIntent = t.intersection([
   BaseIntent,
+  BaseIntentWithTokenName,
   t.type({
     intentType: intentTypes.tokenApproval,
-    tokenName: t.string,
   }),
 ]);
 

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

@@ -1,6 +1,5 @@
 import * as t from "io-ts";
-import { BaseIntent } from "./baseIntent";
-import { Amount } from "./amount";
+import { BaseIntent, BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
 import { optionalString } from "../../../utils";
 
@@ -17,10 +16,10 @@ import { optionalString } from "../../../utils";
  */
 export const TonDelegateIntent = t.intersection([
   BaseIntent,
+  BaseIntentWithAmount,
   t.type({
     intentType: intentTypes.delegate,
     validatorAddress: t.string,
-    amount: Amount,
     useSingleNominator: t.boolean,
   }),
   t.partial({

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

@@ -1,13 +1,12 @@
 import * as t from "io-ts";
-import { BaseIntent } from "./baseIntent";
-import { TokenRecipientEntry } from "./tokenRecipientEntry";
+import { BaseIntent, BaseIntentWithTokenRecipients } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 export const TransferTokenIntent = t.intersection([
   BaseIntent,
+  BaseIntentWithTokenRecipients,
   t.type({
     intentType: intentTypes.transferToken,
-    recipients: t.array(TokenRecipientEntry),
   }),
 ]);
 

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

@@ -1,6 +1,6 @@
 import * as t from "io-ts";
 import { StakeIntent } from "./stakeIntent";
-import { Amount } from "./amount";
+import { BaseIntentWithAmount } from "./baseIntent";
 import { NonEmptyString } from "io-ts-types";
 
 /**
@@ -14,8 +14,8 @@ import { NonEmptyString } from "io-ts-types";
  */
 export const VetStakingIntent = t.intersection([
   StakeIntent,
+  BaseIntentWithAmount,
   t.type({
-    amount: Amount,
     stakingContractAddress: NonEmptyString,
     levelId: NonEmptyString,
   }),

package/src/schema/wallet/freeze.ts

@@ -0,0 +1,20 @@
+import * as t from "io-ts";
+
+/**
+ * Token transfer recipient params used in freeze metadata.
+ */
+export const TokenTransferRecipientParams = t.intersection([
+  t.type({
+    tokenType: t.string,
+    tokenQuantity: t.string,
+  }),
+  t.partial({
+    tokenContractAddress: t.string,
+    tokenName: t.string,
+    tokenId: t.string,
+    decimalPlaces: t.number,
+  }),
+]);
+export type TokenTransferRecipientParams = t.TypeOf<
+  typeof TokenTransferRecipientParams
+>;

package/src/schema/wallet/index.ts

@@ -2,3 +2,4 @@ export * from "./wallet";
 export * from "./multisigTypeVersion";
 export * from "./walletTypes";
 export * from "./address";
+export * from "./freeze";

package/src/utils/getAssetsFromIntent.ts

@@ -0,0 +1,81 @@
+import { isRight } from "fp-ts/lib/Either";
+import {
+  BaseIntentWithRecipients,
+  BaseIntentWithTokenData,
+  BaseIntentWithTokenName,
+  BaseIntentWithAmount,
+} from "../schema/transactionRequest/intents/baseIntent";
+
+/**
+ * Extracts all asset-related strings from a transaction intent
+ *
+ * This utility function analyzes any transaction intent object and returns
+ * all asset identifiers it references using a schema-driven approach.
+ *
+ * Assets are defined as:
+ * - Symbol names (from amount.symbol fields in recipients) - e.g., 'eth', 'btc', 'ada'
+ * - Token names (from tokenName or tokenData.tokenName fields) - e.g., 'USDC', 'DAI'
+ *
+ * Note: Technical fields like tokenType, tokenContractAddress, and tokenId are NOT
+ * considered assets - they are implementation details, not asset identifiers.
+ *
+ * @param intent - An unknown object that may be a transaction intent
+ * @returns An array of unique asset strings referenced in the intent
+ */
+export function getAssetsFromIntent(intent: unknown): string[] {
+  if (!intent || typeof intent !== "object") {
+    return [];
+  }
+
+  const assetStrings = new Set<string>();
+
+  // Pattern 1: Intents with recipients containing amounts
+  // Examples: PaymentIntent, AdaPaymentIntent, EthPaymentIntent, etc.
+  // Extracts: symbol from amount field
+  const recipientsDecoded = BaseIntentWithRecipients.decode(intent);
+  if (isRight(recipientsDecoded)) {
+    const data = recipientsDecoded.right;
+    for (const recipient of data.recipients) {
+      if (recipient.amount?.symbol) {
+        assetStrings.add(recipient.amount.symbol);
+      }
+    }
+  }
+
+  // Pattern 2: Intents with token data in recipients
+  // Examples: TransferTokenIntent, EthTransferTokenIntent, EthConsolidateTokenIntent, etc.
+  // Extracts: tokenName (the asset identifier, e.g., 'USDC', 'DAI')
+  const tokenDataDecoded = BaseIntentWithTokenData.decode(intent);
+  if (isRight(tokenDataDecoded)) {
+    const data = tokenDataDecoded.right;
+    for (const recipient of data.recipients) {
+      if (recipient.tokenData?.tokenName) {
+        assetStrings.add(recipient.tokenData.tokenName);
+      }
+    }
+  }
+
+  // Pattern 3: Intents with direct tokenName field
+  // Examples: TokenApprovalIntent
+  // Extracts: tokenName
+  const tokenNameDecoded = BaseIntentWithTokenName.decode(intent);
+  if (isRight(tokenNameDecoded)) {
+    const data = tokenNameDecoded.right;
+    if (data.tokenName) {
+      assetStrings.add(data.tokenName);
+    }
+  }
+
+  // Pattern 4: Intents with direct amount field
+  // Examples: StakeIntent, UnstakeIntent, DelegateIntent, ClaimRewardsIntent, WithdrawIntent
+  // Extracts: symbol from amount field
+  const amountDecoded = BaseIntentWithAmount.decode(intent);
+  if (isRight(amountDecoded)) {
+    const data = amountDecoded.right;
+    if (data.amount?.symbol) {
+      assetStrings.add(data.amount.symbol);
+    }
+  }
+
+  return Array.from(assetStrings).sort();
+}

package/src/utils/index.ts

@@ -2,3 +2,4 @@ export * from "./optional";
 export * from "./primitives";
 export * from "./arrayFromSingle";
 export * from "./minMaxArray";
+export * from "./getAssetsFromIntent";