@bitgo/public-types 6.84.0 → 6.86.0

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

@@ -3,12 +3,23 @@ import { WithdrawIntent } from "./withdrawIntent";
 import { TaoStakingBaseIntent } from "./taoStakingBaseIntent";
 
 /**
+ * Remove staked TAO or alpha tokens from a hotkey on a specified subnet.
+ * Funds return to the wallet's root address (coldkey). Corresponds to the
+ * on-chain `remove_stake` extrinsic. Note: the `intentType` value for
+ * unstaking is "claim" (inherited from the generic withdraw/claim intent),
+ * not "unstake".
+ *
  * @title Tao Unstake Intent
  */
 export const TaoUnstakeIntent = t.intersection([
   WithdrawIntent,
   TaoStakingBaseIntent,
   t.type({
+    /**
+     * Amount to unstake, in base units (RAO for native TAO; raw alpha units
+     * for subnet tokens). Must not exceed the staked amount for the given
+     * hotkey and netuid.
+     */
     amountUnstaked: t.string,
   }),
 ]);

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

@@ -11,6 +11,10 @@ export const WithdrawIntent = t.intersection([
     intentType: intentTypes.claim,
   }),
   t.partial({
+    /**
+     * Optional amount override. amount.symbol identifies the asset;
+     * amount.value is the quantity in base units.
+     */
     amount: Optional(Amount),
   }),
 ]);