@bitgo/public-types 6.84.0 → 6.85.0

package/dist/src/schema/transactionRequest/intents/taoClaimRootIntent.js.map

@@ -1 +1 @@
-{"version":3,"file":"taoClaimRootIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/taoClaimRootIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,uDAAoD;AACpD,yFAAsF;AACtF,6CAA2C;AAU9B,QAAA,kBAAkB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC/C,iCAAe;IACf,mEAAgC;IAChC,CAAC,CAAC,IAAI,CAAC;QACL,UAAU,EAAE,wBAAW,CAAC,iBAAiB;QACzC,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,MAAM,EAAE,CAAC,CAAC,MAAM;KACjB,CAAC;CACH,CAAC,CAAC"}
+{"version":3,"file":"taoClaimRootIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/taoClaimRootIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,uDAAoD;AACpD,yFAAsF;AACtF,6CAA2C;AAU9B,QAAA,kBAAkB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC/C,iCAAe;IACf,mEAAgC;IAChC,CAAC,CAAC,IAAI,CAAC;QAEL,UAAU,EAAE,wBAAW,CAAC,iBAAiB;QAKzC,MAAM,EAAE,CAAC,CAAC,MAAM;QAKhB,MAAM,EAAE,CAAC,CAAC,MAAM;KACjB,CAAC;CACH,CAAC,CAAC"}

package/dist/src/schema/transactionRequest/intents/taoStakeIntent.js.map

@@ -1 +1 @@
-{"version":3,"file":"taoStakeIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/taoStakeIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,+CAA4C;AAC5C,iEAA8D;AAKjD,QAAA,cAAc,GAAG,CAAC,CAAC,YAAY,CAAC;IAC3C,yBAAW;IACX,2CAAoB;IACpB,CAAC,CAAC,IAAI,CAAC;QACL,YAAY,EAAE,CAAC,CAAC,MAAM;KACvB,CAAC;CACH,CAAC,CAAC"}
+{"version":3,"file":"taoStakeIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/taoStakeIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,+CAA4C;AAC5C,iEAA8D;AAUjD,QAAA,cAAc,GAAG,CAAC,CAAC,YAAY,CAAC;IAC3C,yBAAW;IACX,2CAAoB;IACpB,CAAC,CAAC,IAAI,CAAC;QAEL,YAAY,EAAE,CAAC,CAAC,MAAM;KACvB,CAAC;CACH,CAAC,CAAC"}

package/dist/src/schema/transactionRequest/intents/taoStakingBaseIntent.js.map

@@ -1 +1 @@
-{"version":3,"file":"taoStakingBaseIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/taoStakingBaseIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,uDAAoD;AACpD,yFAAsF;AAKzE,QAAA,oBAAoB,GAAG,CAAC,CAAC,YAAY,CAAC;IACjD,iCAAe;IACf,mEAAgC;IAChC,CAAC,CAAC,IAAI,CAAC;QACL,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,MAAM,EAAE,CAAC,CAAC,MAAM;KACjB,CAAC;CACH,CAAC,CAAC"}
+{"version":3,"file":"taoStakingBaseIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/taoStakingBaseIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,uDAAoD;AACpD,yFAAsF;AASzE,QAAA,oBAAoB,GAAG,CAAC,CAAC,YAAY,CAAC;IACjD,iCAAe;IACf,mEAAgC;IAChC,CAAC,CAAC,IAAI,CAAC;QAKL,MAAM,EAAE,CAAC,CAAC,MAAM;QAKhB,MAAM,EAAE,CAAC,CAAC,MAAM;KACjB,CAAC;CACH,CAAC,CAAC"}

package/dist/src/schema/transactionRequest/intents/taoSwitchValidatorIntent.js.map

@@ -1 +1 @@
-{"version":3,"file":"taoSwitchValidatorIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/taoSwitchValidatorIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,uDAAoD;AACpD,yFAAsF;AACtF,6CAA2C;AAK9B,QAAA,wBAAwB,GAAG,CAAC,CAAC,YAAY,CAAC;IACrD,iCAAe;IACf,mEAAgC;IAChC,CAAC,CAAC,IAAI,CAAC;QACL,UAAU,EAAE,wBAAW,CAAC,eAAe;QACvC,YAAY,EAAE,CAAC,CAAC,MAAM;QACtB,iBAAiB,EAAE,CAAC,CAAC,MAAM;QAC3B,YAAY,EAAE,CAAC,CAAC,MAAM;QACtB,iBAAiB,EAAE,CAAC,CAAC,MAAM;QAC3B,WAAW,EAAE,CAAC,CAAC,MAAM;KACtB,CAAC;CACH,CAAC,CAAC"}
+{"version":3,"file":"taoSwitchValidatorIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/taoSwitchValidatorIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,uDAAoD;AACpD,yFAAsF;AACtF,6CAA2C;AAS9B,QAAA,wBAAwB,GAAG,CAAC,CAAC,YAAY,CAAC;IACrD,iCAAe;IACf,mEAAgC;IAChC,CAAC,CAAC,IAAI,CAAC;QAEL,UAAU,EAAE,wBAAW,CAAC,eAAe;QAKvC,YAAY,EAAE,CAAC,CAAC,MAAM;QAKtB,iBAAiB,EAAE,CAAC,CAAC,MAAM;QAK3B,YAAY,EAAE,CAAC,CAAC,MAAM;QAKtB,iBAAiB,EAAE,CAAC,CAAC,MAAM;QAK3B,WAAW,EAAE,CAAC,CAAC,MAAM;KACtB,CAAC;CACH,CAAC,CAAC"}

package/dist/src/schema/transactionRequest/intents/taoTransferStakeIntent.js.map

@@ -1 +1 @@
-{"version":3,"file":"taoTransferStakeIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/taoTransferStakeIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,uDAAoD;AACpD,yFAAsF;AACtF,6CAA2C;AAC3C,0CAAgD;AAKnC,QAAA,sBAAsB,GAAG,CAAC,CAAC,YAAY,CAAC;IACnD,iCAAe;IACf,mEAAgC;IAChC,CAAC,CAAC,IAAI,CAAC;QACL,UAAU,EAAE,wBAAW,CAAC,aAAa;QACrC,aAAa,EAAE,sBAAc;QAC7B,kBAAkB,EAAE,CAAC,CAAC,MAAM;QAC5B,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,YAAY,EAAE,CAAC,CAAC,MAAM;QACtB,iBAAiB,EAAE,CAAC,CAAC,MAAM;QAC3B,WAAW,EAAE,CAAC,CAAC,MAAM;KACtB,CAAC;CACH,CAAC,CAAC"}
+{"version":3,"file":"taoTransferStakeIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/taoTransferStakeIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,uDAAoD;AACpD,yFAAsF;AACtF,6CAA2C;AAC3C,0CAAgD;AAWnC,QAAA,sBAAsB,GAAG,CAAC,CAAC,YAAY,CAAC;IACnD,iCAAe;IACf,mEAAgC;IAChC,CAAC,CAAC,IAAI,CAAC;QAEL,UAAU,EAAE,wBAAW,CAAC,aAAa;QAOrC,aAAa,EAAE,sBAAc;QAK7B,kBAAkB,EAAE,CAAC,CAAC,MAAM;QAK5B,MAAM,EAAE,CAAC,CAAC,MAAM;QAKhB,YAAY,EAAE,CAAC,CAAC,MAAM;QAKtB,iBAAiB,EAAE,CAAC,CAAC,MAAM;QAK3B,WAAW,EAAE,CAAC,CAAC,MAAM;KACtB,CAAC;CACH,CAAC,CAAC"}

package/dist/src/schema/transactionRequest/intents/taoUnstakeIntent.js.map

@@ -1 +1 @@
-{"version":3,"file":"taoUnstakeIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/taoUnstakeIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,qDAAkD;AAClD,iEAA8D;AAKjD,QAAA,gBAAgB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC7C,+BAAc;IACd,2CAAoB;IACpB,CAAC,CAAC,IAAI,CAAC;QACL,cAAc,EAAE,CAAC,CAAC,MAAM;KACzB,CAAC;CACH,CAAC,CAAC"}
+{"version":3,"file":"taoUnstakeIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/taoUnstakeIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,qDAAkD;AAClD,iEAA8D;AAWjD,QAAA,gBAAgB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC7C,+BAAc;IACd,2CAAoB;IACpB,CAAC,CAAC,IAAI,CAAC;QAML,cAAc,EAAE,CAAC,CAAC,MAAM;KACzB,CAAC;CACH,CAAC,CAAC"}

package/dist/src/schema/transactionRequest/intents/withdrawIntent.js.map

@@ -1 +1 @@
-{"version":3,"file":"withdrawIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/withdrawIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,uDAAoD;AACpD,6CAA2C;AAC3C,qCAAkC;AAClC,0CAA0C;AAE7B,QAAA,cAAc,GAAG,CAAC,CAAC,YAAY,CAAC;IAC3C,iCAAe;IACf,CAAC,CAAC,IAAI,CAAC;QAEL,UAAU,EAAE,wBAAW,CAAC,KAAK;KAC9B,CAAC;IACF,CAAC,CAAC,OAAO,CAAC;QACR,MAAM,EAAE,IAAA,gBAAQ,EAAC,eAAM,CAAC;KACzB,CAAC;CACH,CAAC,CAAC"}
+{"version":3,"file":"withdrawIntent.js","sourceRoot":"","sources":["../../../../../src/schema/transactionRequest/intents/withdrawIntent.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,uDAAoD;AACpD,6CAA2C;AAC3C,qCAAkC;AAClC,0CAA0C;AAE7B,QAAA,cAAc,GAAG,CAAC,CAAC,YAAY,CAAC;IAC3C,iCAAe;IACf,CAAC,CAAC,IAAI,CAAC;QAEL,UAAU,EAAE,wBAAW,CAAC,KAAK;KAC9B,CAAC;IACF,CAAC,CAAC,OAAO,CAAC;QAKR,MAAM,EAAE,IAAA,gBAAQ,EAAC,eAAM,CAAC;KACzB,CAAC;CACH,CAAC,CAAC"}

package/package.json

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

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

@@ -15,8 +15,17 @@ export const TaoClaimRootIntent = t.intersection([
   BaseStakeIntent,
   SubstrateAccountBaseBuildOptions,
   t.type({
+    /** Must be "stakeClaimRewards". */
     intentType: intentTypes.stakeClaimRewards,
+    /**
+     * SS58-encoded public key of the hotkey whose accrued root-network basket
+     * rewards are being claimed.
+     */
     hotkey: t.string,
+    /**
+     * Must be "0" — the root network identifier. The underlying
+     * claimRootWithHotkey extrinsic only exists for the root network.
+     */
     netuid: t.string,
   }),
 ]);

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

@@ -3,12 +3,18 @@ import { StakeIntent } from "./stakeIntent";
 import { TaoStakingBaseIntent } from "./taoStakingBaseIntent";
 
 /**
+ * Stake TAO from the wallet's root address (coldkey) to a hotkey (validator)
+ * on a specified Bittensor subnet. Corresponds to the on-chain `add_stake`
+ * extrinsic. Requires a staking request ID from the BitGo staking service,
+ * and requires the enterprise to have staking permissions.
+ *
  * @title Tao Stake Intent
  */
 export const TaoStakeIntent = t.intersection([
   StakeIntent,
   TaoStakingBaseIntent,
   t.type({
+    /** Amount to stake, in base units (RAO for native TAO). */
     amountStaked: t.string,
   }),
 ]);

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

@@ -3,13 +3,25 @@ import { BaseStakeIntent } from "./baseStakeIntent";
 import { SubstrateAccountBaseBuildOptions } from "./substrateAccountBaseBuildOptions";
 
 /**
+ * Base fields shared by the TAO staking intents (`stake` and `claim`): the
+ * hotkey (validator) and Bittensor subnet to operate on. All TAO staking
+ * operations are submitted by the wallet's root address (coldkey).
+ *
  * @title Tao Staking Base Intent
  */
 export const TaoStakingBaseIntent = t.intersection([
   BaseStakeIntent,
   SubstrateAccountBaseBuildOptions,
   t.type({
+    /**
+     * SS58-encoded public key of the hotkey (validator) to stake to or
+     * remove stake from on the specified subnet.
+     */
     hotkey: t.string,
+    /**
+     * Numeric identifier of the Bittensor subnet to stake on or remove stake
+     * from, as a string. Use "0" for the root network.
+     */
     netuid: t.string,
   }),
 ]);

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

@@ -4,17 +4,42 @@ import { SubstrateAccountBaseBuildOptions } from "./substrateAccountBaseBuildOpt
 import { intentTypes } from "./intentType";
 
 /**
+ * Move staked alpha tokens from one hotkey (validator) or subnet to another
+ * within the same wallet coldkey — no unstaking and re-staking required.
+ * Corresponds to the on-chain `move_stake` extrinsic.
+ *
  * @title Tao Switch Validator Intent
  */
 export const TaoSwitchValidatorIntent = t.intersection([
   BaseStakeIntent,
   SubstrateAccountBaseBuildOptions,
   t.type({
+    /** Must be "switchValidator". */
     intentType: intentTypes.switchValidator,
+    /**
+     * SS58-encoded public key of the source hotkey (validator) currently
+     * holding the stake.
+     */
     originHotkey: t.string,
+    /**
+     * SS58-encoded public key of the target hotkey (validator) to move the
+     * stake to.
+     */
     destinationHotkey: t.string,
+    /**
+     * Numeric identifier of the source subnet where the stake currently
+     * resides, as a string.
+     */
     originNetuid: t.string,
+    /**
+     * Numeric identifier of the destination subnet to move the stake to,
+     * as a string. May equal originNetuid when changing hotkeys only.
+     */
     destinationNetuid: t.string,
+    /**
+     * Amount of alpha tokens to move, in raw alpha units. Must not exceed
+     * the staked balance for originHotkey on originNetuid.
+     */
     alphaAmount: t.string,
   }),
 ]);

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

@@ -5,18 +5,51 @@ import { intentTypes } from "./intentType";
 import { optionalString } from "../../../utils";
 
 /**
+ * Transfer staked alpha tokens from this wallet's coldkey to another coldkey
+ * on a specified subnet. This cross-coldkey operation transfers ownership of
+ * the stake without unstaking; it is distinct from switchValidator, which
+ * moves stake within the same coldkey. Corresponds to the on-chain
+ * `transfer_stake` extrinsic.
+ *
  * @title Tao Transfer Stake Intent
  */
 export const TaoTransferStakeIntent = t.intersection([
   BaseStakeIntent,
   SubstrateAccountBaseBuildOptions,
   t.type({
+    /** Must be "transferStake". */
     intentType: intentTypes.transferStake,
+    /**
+     * Optional SS58-encoded coldkey address within this wallet to send the
+     * stake from. Defaults to the wallet's root address when omitted. Must
+     * be a wallet-owned address; otherwise the request fails with an
+     * AddressNotFound error.
+     */
     originColdkey: optionalString,
+    /**
+     * SS58-encoded coldkey address of the recipient who will own the stake
+     * after the transfer. May belong to any wallet.
+     */
     destinationColdkey: t.string,
+    /**
+     * SS58-encoded public key of the hotkey (validator) whose stake position
+     * is being transferred. Must have an active stake on originNetuid.
+     */
     hotkey: t.string,
+    /**
+     * Numeric identifier of the source subnet where the stake currently
+     * resides, as a string.
+     */
     originNetuid: t.string,
+    /**
+     * Numeric identifier of the destination subnet where the transferred
+     * stake will be registered, as a string. May differ from originNetuid.
+     */
     destinationNetuid: t.string,
+    /**
+     * Amount of alpha tokens to transfer, in raw alpha units. Must not
+     * exceed the staked alpha balance for hotkey on originNetuid.
+     */
     alphaAmount: t.string,
   }),
 ]);

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