@bitgo/public-types 6.28.0 → 6.29.0

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

@@ -4,37 +4,55 @@ import { BaseIntent } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 /**
+ * Submit a custom Solana versioned (v0) transaction with optional address lookup tables. Use this intent for versioned transactions; for legacy instruction-based transactions use the customTx intent with solInstructions instead. When recentBlockhash is provided, the platform uses it directly without fetching a durable nonce. Wallets without the enableSolCustomTx flag require a second admin approval before the transaction is processed.
+ *
  * @title SOL Versioned Custom Transaction Intent
  */
 export const SolVersionedCustomTxIntent = t.intersection([
   BaseIntent,
   SolBuildOptions,
   t.type({
+    /** Must be "customTx". Presence of solVersionedTransactionData distinguishes this from legacy SolCustomTxIntent at runtime. */
     intentType: intentTypes.customTx,
+    /** Versioned transaction data in Solana v0 message format. Presence of this field indicates a versioned transaction. */
     solVersionedTransactionData: t.intersection([
       t.type({
+        /** The program instructions for this versioned transaction. */
         versionedInstructions: t.array(
           t.type({
+            /** Index into the staticAccountKeys array identifying the program to invoke. */
             programIdIndex: t.number,
+            /** Indexes into the combined account keys (static + lookup) for this instruction. */
             accountKeyIndexes: t.array(t.number),
+            /** Instruction data encoded as base58 or hex. */
             data: t.string,
           }),
         ),
+        /** Address lookup tables to extend the number of accounts beyond the static limit. Required when using account lookup tables in a v0 transaction. */
         addressLookupTables: t.array(
           t.type({
+            /** The on-chain address of the lookup table account. */
             accountKey: t.string,
+            /** Indexes of writable accounts in the lookup table. */
             writableIndexes: t.array(t.number),
+            /** Indexes of read-only accounts in the lookup table. */
             readonlyIndexes: t.array(t.number),
           }),
         ),
+        /** The static account keys referenced by this transaction. */
         staticAccountKeys: t.array(t.string),
+        /** Solana message header specifying the number of required signers and read-only accounts. */
         messageHeader: t.type({
+          /** Number of signatures required for this transaction. */
           numRequiredSignatures: t.number,
+          /** Number of read-only accounts that require signatures. */
           numReadonlySignedAccounts: t.number,
+          /** Number of read-only accounts that do not require signatures. */
           numReadonlyUnsignedAccounts: t.number,
         }),
       }),
       t.partial({
+        /** Optional recent blockhash; when provided the platform uses it instead of fetching a durable nonce. */
         recentBlockhash: t.string,
       }),
     ]),

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

@@ -1,15 +1,18 @@
 import * as t from "io-ts";
 import { SuiBuildOptions } from "./suiBuildOptions";
 import { GoUnstakeIntent } from "./goUnstakeIntent";
+import { BaseGoStakeIntent } from "./baseGoStakeIntent";
 
 /**
  * @title SuiGoUnstakeIntent
  *
- * @description Unstake intent for GO wallets for the Solana blockchain.
+ * @description Unstake intent for GO wallets for the Sui blockchain.
  *
  */
 export const SuiGoUnstakeIntent = t.intersection([
   GoUnstakeIntent,
+  // Sui go-unstake is an admin/internal flow that requires goStakingRequestId.
+  BaseGoStakeIntent,
   SuiBuildOptions,
 ]);
 

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

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

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

@@ -7,6 +7,7 @@ import { Optional } from "../../../utils";
 export const WithdrawIntent = t.intersection([
   BaseStakeIntent,
   t.type({
+    /** Must be "claim". */
     intentType: intentTypes.claim,
   }),
   t.partial({