@bitgo/public-types 6.26.0 → 6.27.0

package/package.json

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

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

@@ -3,6 +3,16 @@ import { BaseIntent } from "./baseIntent";
 import { intentTypes } from "./intentType";
 import { RecipientEntry } from "./recipientEntry";
 
+/**
+ * @title Fee Address Transfer Intent
+ *
+ * @description Transfer funds from the wallet's IOTA fee address (gas tank) to one or
+ * more destinations. The fee address acts as the sender; use this intent to sweep
+ * gas-tank balances back to an operational address. Requires that a fee address is
+ * configured for the wallet's enterprise.
+ *
+ * @param {RecipientEntry[]} recipients - Destination addresses and amounts to transfer.
+ */
 export const FeeAddressTransferIntent = t.intersection([
   BaseIntent,
   t.type({

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

@@ -38,6 +38,8 @@ import { FeeAddressTransferIntent } from "./feeAddressTransferIntent";
 import { HbarUpdateAccountIntent } from "./hbarUpdateAccountIntent";
 import { HypeevmSpotTransferIntent } from "./hypeevmSpotTransferIntent";
 import { IcpPaymentIntent } from "./icpPaymentIntent";
+import { IotaConsolidateIntent } from "./iotaConsolidateIntent";
+import { IotaPaymentIntent } from "./iotaPaymentIntent";
 import { LightningPaymentIntent } from "./lightningPaymentIntent";
 import { MmiSignMessageIntent } from "./mmiSignMessageIntent";
 import { NearStakeIntent } from "./nearStakeIntent";
@@ -199,6 +201,8 @@ export const TransactionIntent = t.union([
   HypeevmSpotTransferIntent,
   HypeevmEnableBridgingIntent,
   IcpPaymentIntent,
+  IotaConsolidateIntent,
+  IotaPaymentIntent,
   LightningPaymentIntent,
   MmiSignMessageIntent,
   MmiSignTransactionIntent,

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

@@ -3,6 +3,17 @@ import { BaseIntent } from "./baseIntent";
 import { optionalString } from "../../../utils";
 import { IotaFeeOptions } from "./iotaFeeOptions";
 
+/**
+ * @title IOTA Build Options
+ *
+ * @description Shared IOTA-specific build configuration mixed into payment and consolidate
+ * intents.
+ *
+ * @param {IotaFeeOptions} feeOptions - Gas budget options for this transaction. Controls
+ * the maximum gas units the transaction may consume.
+ * @param {string} lockedAmount - Server-injected value from wallet.lockedAsset; client
+ * values are overwritten at request time.
+ */
 export const IotaBuildOptions = t.intersection([
   BaseIntent,
   t.type({

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

@@ -4,6 +4,10 @@ import { AccountBaseConsolidateIntent } from "./accountBaseConsolidateIntent";
 
 /**
  * @title IOTA Consolidate Intent
+ *
+ * @description Consolidate IOTA coins or tokens from the wallet's receive addresses into
+ * the specified destination address. Both native IOTA and token consolidation are handled
+ * by this intent. The destination must be a wallet-owned address.
  */
 export const IotaConsolidateIntent = t.intersection([
   AccountBaseConsolidateIntent,

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

@@ -1,5 +1,12 @@
 import * as t from "io-ts";
 
+/**
+ * @title IOTA Fee Options
+ *
+ * @description Gas budget configuration for an IOTA transaction.
+ *
+ * @param {number} gasLimit - Maximum gas units this transaction may consume.
+ */
 export const IotaFeeOptions = t.type({
   gasLimit: t.number,
 });

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

@@ -5,6 +5,13 @@ import { optionalStringArray } from "../../../utils";
 
 /**
  * @title IOTA Payment Intent
+ *
+ * @description Send IOTA or IOTA-based tokens from the wallet to one or more recipients.
+ * Specify recipients with address and amount; optionally provide specific object IDs to
+ * include as inputs via `unspents`.
+ *
+ * @param {string[]} unspents - Specific IOTA object IDs to use as inputs for this
+ * transaction. When omitted, the server selects inputs automatically.
  */
 export const IotaPaymentIntent = t.intersection([
   PaymentIntent,