@bitgo/public-types 6.23.0 → 6.24.0

package/dist/src/schema/transactionRequest/transactionRequest.d.ts

@@ -5241,173 +5241,6 @@ export declare const TransactionRequestLite: t.IntersectionC<[t.IntersectionC<[t
         isTestTransaction: t.BooleanC;
     }>]>]>, t.PartialC<{
         memo: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
-    }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
-        intentType: t.KeyofC<{
-            payment: t.LiteralC<"payment">;
-            transferToken: t.LiteralC<"transferToken">;
-            consolidate: t.LiteralC<"consolidate">;
-            consolidateToken: t.LiteralC<"consolidateToken">;
-            fanout: t.LiteralC<"fanout">;
-            stake: t.LiteralC<"stake">;
-            unstake: t.LiteralC<"unstake">;
-            delegate: t.LiteralC<"delegate">;
-            undelegate: t.LiteralC<"undelegate">;
-            switchValidator: t.LiteralC<"switchValidator">;
-            claim: t.LiteralC<"claim">;
-            stakeClaimRewards: t.LiteralC<"stakeClaimRewards">;
-            pledge: t.LiteralC<"pledge">;
-            voteDelegation: t.LiteralC<"voteDelegation">;
-            vote: t.LiteralC<"vote">;
-            createAccount: t.LiteralC<"createAccount">;
-            updateAccount: t.LiteralC<"updateAccount">;
-            addTrustLine: t.LiteralC<"addTrustLine">;
-            removeTrustLine: t.LiteralC<"removeTrustLine">;
-            signMessage: t.LiteralC<"signMessage">;
-            signTypedStructuredData: t.LiteralC<"signTypedStructuredData">;
-            enableToken: t.LiteralC<"enableToken">;
-            authorize: t.LiteralC<"authorize">;
-            acceleration: t.LiteralC<"acceleration">;
-            fillNonce: t.LiteralC<"fillNonce">;
-            walletRecovery: t.LiteralC<"walletRecovery">;
-            contractCall: t.LiteralC<"contractCall">;
-            deactivate: t.LiteralC<"deactivate">;
-            customTx: t.LiteralC<"customTx">;
-            closeAssociatedTokenAccount: t.LiteralC<"closeAssociatedTokenAccount">;
-            stakeWithCallData: t.LiteralC<"stakeWithCallData">;
-            unstakeWithCallData: t.LiteralC<"unstakeWithCallData">;
-            switchValidatorWithCallData: t.LiteralC<"switchValidatorWithCallData">;
-            feeAddressTransfer: t.LiteralC<"feeAddressTransfer">;
-            tokenApproval: t.LiteralC<"tokenApproval">;
-            transferStake: t.LiteralC<"transferStake">;
-            validatorRegistration: t.LiteralC<"validatorRegistration">;
-            increaseStake: t.LiteralC<"increaseStake">;
-            decreaseStake: t.LiteralC<"decreaseStake">;
-            signalExit: t.LiteralC<"signalExit">;
-            withdrawStake: t.LiteralC<"withdrawStake">;
-            spotTransfer: t.LiteralC<"spotTransfer">;
-            bridgeFunds: t.LiteralC<"bridgeFunds">;
-            enableBridging: t.LiteralC<"enableBridging">;
-            goUnstake: t.LiteralC<"goUnstake">;
-            createBtcDelegation: t.LiteralC<"createBtcDelegation">;
-            transferAccept: t.LiteralC<"transferAccept">;
-            transferReject: t.LiteralC<"transferReject">;
-            transferAcknowledge: t.LiteralC<"transferAcknowledge">;
-            transferOfferWithdrawn: t.LiteralC<"transferOfferWithdrawn">;
-            cosignDelegationProposal: t.LiteralC<"cosignDelegationProposal">;
-            cosignDelegationAccept: t.LiteralC<"cosignDelegationAccept">;
-            allocationRequest: t.LiteralC<"allocationRequest">;
-            cantonCommand: t.LiteralC<"cantonCommand">;
-            allocationAllocate: t.LiteralC<"allocationAllocate">;
-            "defi-deposit": t.LiteralC<"defi-deposit">;
-            "defi-redeem": t.LiteralC<"defi-redeem">;
-            "defi-approve": t.LiteralC<"defi-approve">;
-            delegateResource: t.LiteralC<"delegateResource">;
-            undelegateResource: t.LiteralC<"undelegateResource">;
-            export: t.LiteralC<"export">;
-            import: t.LiteralC<"import">;
-            importtoc: t.LiteralC<"importtoc">;
-        }>;
-    }>, t.PartialC<{
-        sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
-        comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
-        nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
-    }>]>, t.TypeC<{
-        stakingRequestId: t.StringC;
-    }>, t.PartialC<{
-        source: t.KeyofC<typeof import(".").StakingRequestSourceEnum>;
-    }>]>, t.TypeC<{
-        intentType: t.LiteralC<"pledge">;
-        commitmentParams: t.IntersectionC<[t.TypeC<{
-            commitmentFee: t.StringC;
-            commitmentValue: t.StringC;
-            signerAddress: t.StringC;
-            chainId: t.NumberC;
-        }>, t.TypeC<{
-            pledgeCount: t.NumberC;
-        }>]>;
-    }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
-        intentType: t.KeyofC<{
-            payment: t.LiteralC<"payment">;
-            transferToken: t.LiteralC<"transferToken">;
-            consolidate: t.LiteralC<"consolidate">;
-            consolidateToken: t.LiteralC<"consolidateToken">;
-            fanout: t.LiteralC<"fanout">;
-            stake: t.LiteralC<"stake">;
-            unstake: t.LiteralC<"unstake">;
-            delegate: t.LiteralC<"delegate">;
-            undelegate: t.LiteralC<"undelegate">;
-            switchValidator: t.LiteralC<"switchValidator">;
-            claim: t.LiteralC<"claim">;
-            stakeClaimRewards: t.LiteralC<"stakeClaimRewards">;
-            pledge: t.LiteralC<"pledge">;
-            voteDelegation: t.LiteralC<"voteDelegation">;
-            vote: t.LiteralC<"vote">;
-            createAccount: t.LiteralC<"createAccount">;
-            updateAccount: t.LiteralC<"updateAccount">;
-            addTrustLine: t.LiteralC<"addTrustLine">;
-            removeTrustLine: t.LiteralC<"removeTrustLine">;
-            signMessage: t.LiteralC<"signMessage">;
-            signTypedStructuredData: t.LiteralC<"signTypedStructuredData">;
-            enableToken: t.LiteralC<"enableToken">;
-            authorize: t.LiteralC<"authorize">;
-            acceleration: t.LiteralC<"acceleration">;
-            fillNonce: t.LiteralC<"fillNonce">;
-            walletRecovery: t.LiteralC<"walletRecovery">;
-            contractCall: t.LiteralC<"contractCall">;
-            deactivate: t.LiteralC<"deactivate">;
-            customTx: t.LiteralC<"customTx">;
-            closeAssociatedTokenAccount: t.LiteralC<"closeAssociatedTokenAccount">;
-            stakeWithCallData: t.LiteralC<"stakeWithCallData">;
-            unstakeWithCallData: t.LiteralC<"unstakeWithCallData">;
-            switchValidatorWithCallData: t.LiteralC<"switchValidatorWithCallData">;
-            feeAddressTransfer: t.LiteralC<"feeAddressTransfer">;
-            tokenApproval: t.LiteralC<"tokenApproval">;
-            transferStake: t.LiteralC<"transferStake">;
-            validatorRegistration: t.LiteralC<"validatorRegistration">;
-            increaseStake: t.LiteralC<"increaseStake">;
-            decreaseStake: t.LiteralC<"decreaseStake">;
-            signalExit: t.LiteralC<"signalExit">;
-            withdrawStake: t.LiteralC<"withdrawStake">;
-            spotTransfer: t.LiteralC<"spotTransfer">;
-            bridgeFunds: t.LiteralC<"bridgeFunds">;
-            enableBridging: t.LiteralC<"enableBridging">;
-            goUnstake: t.LiteralC<"goUnstake">;
-            createBtcDelegation: t.LiteralC<"createBtcDelegation">;
-            transferAccept: t.LiteralC<"transferAccept">;
-            transferReject: t.LiteralC<"transferReject">;
-            transferAcknowledge: t.LiteralC<"transferAcknowledge">;
-            transferOfferWithdrawn: t.LiteralC<"transferOfferWithdrawn">;
-            cosignDelegationProposal: t.LiteralC<"cosignDelegationProposal">;
-            cosignDelegationAccept: t.LiteralC<"cosignDelegationAccept">;
-            allocationRequest: t.LiteralC<"allocationRequest">;
-            cantonCommand: t.LiteralC<"cantonCommand">;
-            allocationAllocate: t.LiteralC<"allocationAllocate">;
-            "defi-deposit": t.LiteralC<"defi-deposit">;
-            "defi-redeem": t.LiteralC<"defi-redeem">;
-            "defi-approve": t.LiteralC<"defi-approve">;
-            delegateResource: t.LiteralC<"delegateResource">;
-            undelegateResource: t.LiteralC<"undelegateResource">;
-            export: t.LiteralC<"export">;
-            import: t.LiteralC<"import">;
-            importtoc: t.LiteralC<"importtoc">;
-        }>;
-    }>, t.PartialC<{
-        sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
-        comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
-        nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
-    }>]>, t.TypeC<{
-        stakingRequestId: t.StringC;
-    }>, t.PartialC<{
-        source: t.KeyofC<typeof import(".").StakingRequestSourceEnum>;
-    }>]>, t.TypeC<{
-        intentType: t.LiteralC<"stake">;
-    }>]>, t.TypeC<{
-        commitmentParams: t.TypeC<{
-            commitmentFee: t.StringC;
-            commitmentValue: t.StringC;
-            signerAddress: t.StringC;
-            chainId: t.NumberC;
-        }>;
     }>]>, t.UnionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
         intentType: t.KeyofC<{
             payment: t.LiteralC<"payment">;
@@ -11302,7 +11135,7 @@ export declare const TransactionRequestLite: t.IntersectionC<[t.IntersectionC<[t
         }>;
     }>, t.TypeC<{
         validatorAddress: import("io-ts-types").NonEmptyStringC;
-        stakingPeriod: t.NumberC;
+        stakingPeriod: t.UnionC<[t.LiteralC<60480>, t.LiteralC<129600>, t.LiteralC<259200>]>;
         stakingContractAddress: import("io-ts-types").NonEmptyStringC;
     }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
         intentType: t.KeyofC<{
@@ -18670,173 +18503,6 @@ export declare const TransactionRequest: t.UnionC<[t.IntersectionC<[t.Intersecti
         isTestTransaction: t.BooleanC;
     }>]>]>, t.PartialC<{
         memo: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
-    }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
-        intentType: t.KeyofC<{
-            payment: t.LiteralC<"payment">;
-            transferToken: t.LiteralC<"transferToken">;
-            consolidate: t.LiteralC<"consolidate">;
-            consolidateToken: t.LiteralC<"consolidateToken">;
-            fanout: t.LiteralC<"fanout">;
-            stake: t.LiteralC<"stake">;
-            unstake: t.LiteralC<"unstake">;
-            delegate: t.LiteralC<"delegate">;
-            undelegate: t.LiteralC<"undelegate">;
-            switchValidator: t.LiteralC<"switchValidator">;
-            claim: t.LiteralC<"claim">;
-            stakeClaimRewards: t.LiteralC<"stakeClaimRewards">;
-            pledge: t.LiteralC<"pledge">;
-            voteDelegation: t.LiteralC<"voteDelegation">;
-            vote: t.LiteralC<"vote">;
-            createAccount: t.LiteralC<"createAccount">;
-            updateAccount: t.LiteralC<"updateAccount">;
-            addTrustLine: t.LiteralC<"addTrustLine">;
-            removeTrustLine: t.LiteralC<"removeTrustLine">;
-            signMessage: t.LiteralC<"signMessage">;
-            signTypedStructuredData: t.LiteralC<"signTypedStructuredData">;
-            enableToken: t.LiteralC<"enableToken">;
-            authorize: t.LiteralC<"authorize">;
-            acceleration: t.LiteralC<"acceleration">;
-            fillNonce: t.LiteralC<"fillNonce">;
-            walletRecovery: t.LiteralC<"walletRecovery">;
-            contractCall: t.LiteralC<"contractCall">;
-            deactivate: t.LiteralC<"deactivate">;
-            customTx: t.LiteralC<"customTx">;
-            closeAssociatedTokenAccount: t.LiteralC<"closeAssociatedTokenAccount">;
-            stakeWithCallData: t.LiteralC<"stakeWithCallData">;
-            unstakeWithCallData: t.LiteralC<"unstakeWithCallData">;
-            switchValidatorWithCallData: t.LiteralC<"switchValidatorWithCallData">;
-            feeAddressTransfer: t.LiteralC<"feeAddressTransfer">;
-            tokenApproval: t.LiteralC<"tokenApproval">;
-            transferStake: t.LiteralC<"transferStake">;
-            validatorRegistration: t.LiteralC<"validatorRegistration">;
-            increaseStake: t.LiteralC<"increaseStake">;
-            decreaseStake: t.LiteralC<"decreaseStake">;
-            signalExit: t.LiteralC<"signalExit">;
-            withdrawStake: t.LiteralC<"withdrawStake">;
-            spotTransfer: t.LiteralC<"spotTransfer">;
-            bridgeFunds: t.LiteralC<"bridgeFunds">;
-            enableBridging: t.LiteralC<"enableBridging">;
-            goUnstake: t.LiteralC<"goUnstake">;
-            createBtcDelegation: t.LiteralC<"createBtcDelegation">;
-            transferAccept: t.LiteralC<"transferAccept">;
-            transferReject: t.LiteralC<"transferReject">;
-            transferAcknowledge: t.LiteralC<"transferAcknowledge">;
-            transferOfferWithdrawn: t.LiteralC<"transferOfferWithdrawn">;
-            cosignDelegationProposal: t.LiteralC<"cosignDelegationProposal">;
-            cosignDelegationAccept: t.LiteralC<"cosignDelegationAccept">;
-            allocationRequest: t.LiteralC<"allocationRequest">;
-            cantonCommand: t.LiteralC<"cantonCommand">;
-            allocationAllocate: t.LiteralC<"allocationAllocate">;
-            "defi-deposit": t.LiteralC<"defi-deposit">;
-            "defi-redeem": t.LiteralC<"defi-redeem">;
-            "defi-approve": t.LiteralC<"defi-approve">;
-            delegateResource: t.LiteralC<"delegateResource">;
-            undelegateResource: t.LiteralC<"undelegateResource">;
-            export: t.LiteralC<"export">;
-            import: t.LiteralC<"import">;
-            importtoc: t.LiteralC<"importtoc">;
-        }>;
-    }>, t.PartialC<{
-        sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
-        comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
-        nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
-    }>]>, t.TypeC<{
-        stakingRequestId: t.StringC;
-    }>, t.PartialC<{
-        source: t.KeyofC<typeof import(".").StakingRequestSourceEnum>;
-    }>]>, t.TypeC<{
-        intentType: t.LiteralC<"pledge">;
-        commitmentParams: t.IntersectionC<[t.TypeC<{
-            commitmentFee: t.StringC;
-            commitmentValue: t.StringC;
-            signerAddress: t.StringC;
-            chainId: t.NumberC;
-        }>, t.TypeC<{
-            pledgeCount: t.NumberC;
-        }>]>;
-    }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
-        intentType: t.KeyofC<{
-            payment: t.LiteralC<"payment">;
-            transferToken: t.LiteralC<"transferToken">;
-            consolidate: t.LiteralC<"consolidate">;
-            consolidateToken: t.LiteralC<"consolidateToken">;
-            fanout: t.LiteralC<"fanout">;
-            stake: t.LiteralC<"stake">;
-            unstake: t.LiteralC<"unstake">;
-            delegate: t.LiteralC<"delegate">;
-            undelegate: t.LiteralC<"undelegate">;
-            switchValidator: t.LiteralC<"switchValidator">;
-            claim: t.LiteralC<"claim">;
-            stakeClaimRewards: t.LiteralC<"stakeClaimRewards">;
-            pledge: t.LiteralC<"pledge">;
-            voteDelegation: t.LiteralC<"voteDelegation">;
-            vote: t.LiteralC<"vote">;
-            createAccount: t.LiteralC<"createAccount">;
-            updateAccount: t.LiteralC<"updateAccount">;
-            addTrustLine: t.LiteralC<"addTrustLine">;
-            removeTrustLine: t.LiteralC<"removeTrustLine">;
-            signMessage: t.LiteralC<"signMessage">;
-            signTypedStructuredData: t.LiteralC<"signTypedStructuredData">;
-            enableToken: t.LiteralC<"enableToken">;
-            authorize: t.LiteralC<"authorize">;
-            acceleration: t.LiteralC<"acceleration">;
-            fillNonce: t.LiteralC<"fillNonce">;
-            walletRecovery: t.LiteralC<"walletRecovery">;
-            contractCall: t.LiteralC<"contractCall">;
-            deactivate: t.LiteralC<"deactivate">;
-            customTx: t.LiteralC<"customTx">;
-            closeAssociatedTokenAccount: t.LiteralC<"closeAssociatedTokenAccount">;
-            stakeWithCallData: t.LiteralC<"stakeWithCallData">;
-            unstakeWithCallData: t.LiteralC<"unstakeWithCallData">;
-            switchValidatorWithCallData: t.LiteralC<"switchValidatorWithCallData">;
-            feeAddressTransfer: t.LiteralC<"feeAddressTransfer">;
-            tokenApproval: t.LiteralC<"tokenApproval">;
-            transferStake: t.LiteralC<"transferStake">;
-            validatorRegistration: t.LiteralC<"validatorRegistration">;
-            increaseStake: t.LiteralC<"increaseStake">;
-            decreaseStake: t.LiteralC<"decreaseStake">;
-            signalExit: t.LiteralC<"signalExit">;
-            withdrawStake: t.LiteralC<"withdrawStake">;
-            spotTransfer: t.LiteralC<"spotTransfer">;
-            bridgeFunds: t.LiteralC<"bridgeFunds">;
-            enableBridging: t.LiteralC<"enableBridging">;
-            goUnstake: t.LiteralC<"goUnstake">;
-            createBtcDelegation: t.LiteralC<"createBtcDelegation">;
-            transferAccept: t.LiteralC<"transferAccept">;
-            transferReject: t.LiteralC<"transferReject">;
-            transferAcknowledge: t.LiteralC<"transferAcknowledge">;
-            transferOfferWithdrawn: t.LiteralC<"transferOfferWithdrawn">;
-            cosignDelegationProposal: t.LiteralC<"cosignDelegationProposal">;
-            cosignDelegationAccept: t.LiteralC<"cosignDelegationAccept">;
-            allocationRequest: t.LiteralC<"allocationRequest">;
-            cantonCommand: t.LiteralC<"cantonCommand">;
-            allocationAllocate: t.LiteralC<"allocationAllocate">;
-            "defi-deposit": t.LiteralC<"defi-deposit">;
-            "defi-redeem": t.LiteralC<"defi-redeem">;
-            "defi-approve": t.LiteralC<"defi-approve">;
-            delegateResource: t.LiteralC<"delegateResource">;
-            undelegateResource: t.LiteralC<"undelegateResource">;
-            export: t.LiteralC<"export">;
-            import: t.LiteralC<"import">;
-            importtoc: t.LiteralC<"importtoc">;
-        }>;
-    }>, t.PartialC<{
-        sequenceId: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
-        comment: t.UnionC<[t.Type<string, string, unknown>, t.UndefinedC]>;
-        nonce: t.UnionC<[t.Type<string | number, string | number, unknown>, t.UndefinedC]>;
-    }>]>, t.TypeC<{
-        stakingRequestId: t.StringC;
-    }>, t.PartialC<{
-        source: t.KeyofC<typeof import(".").StakingRequestSourceEnum>;
-    }>]>, t.TypeC<{
-        intentType: t.LiteralC<"stake">;
-    }>]>, t.TypeC<{
-        commitmentParams: t.TypeC<{
-            commitmentFee: t.StringC;
-            commitmentValue: t.StringC;
-            signerAddress: t.StringC;
-            chainId: t.NumberC;
-        }>;
     }>]>, t.UnionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
         intentType: t.KeyofC<{
             payment: t.LiteralC<"payment">;
@@ -24731,7 +24397,7 @@ export declare const TransactionRequest: t.UnionC<[t.IntersectionC<[t.Intersecti
         }>;
     }>, t.TypeC<{
         validatorAddress: import("io-ts-types").NonEmptyStringC;
-        stakingPeriod: t.NumberC;
+        stakingPeriod: t.UnionC<[t.LiteralC<60480>, t.LiteralC<129600>, t.LiteralC<259200>]>;
         stakingContractAddress: import("io-ts-types").NonEmptyStringC;
     }>]>, t.IntersectionC<[t.IntersectionC<[t.IntersectionC<[t.TypeC<{
         intentType: t.KeyofC<{

package/package.json

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

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

@@ -102,8 +102,6 @@ export * from "./iotaBuildOptions";
 export * from "./iotaConsolidateIntent";
 export * from "./iotaFeeOptions";
 export * from "./iotaPaymentIntent";
-export * from "./irysPledgeIntent";
-export * from "./irysStakeIntent";
 export * from "./lightningPaymentIntent";
 export * from "./mmiSignMessageIntent";
 export * from "./mmiSignTransactionIntent";

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

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

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

@@ -4,13 +4,19 @@ import { BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 /**
+ * Claim accumulated Tron staking rewards (WithdrawBalance) to the owner's
+ * address. The reward balance must be non-zero; the handler does not verify
+ * the amount before submitting the transaction. Valid on TRX and TTRX.
+ *
  * @title TRX Claim Rewards Intent
  */
 export const TrxClaimRewardsIntent = t.intersection([
   BaseStakeIntent,
   BaseIntentWithAmount,
   t.type({
+    /** Must be `"stakeClaimRewards"`. */
     intentType: intentTypes.stakeClaimRewards,
+    /** Tron address of the wallet owner; must match the wallet's root address. */
     ownerAddress: t.string,
   }),
 ]);

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

@@ -4,15 +4,24 @@ import { BaseStakeIntent } from "./baseStakeIntent";
 import { intentTypes } from "./intentType";
 
 /**
+ * Delegate staked BANDWIDTH or ENERGY resources to another Tron address
+ * (DelegateResourceContract). The owner must have sufficient staked
+ * resources; the receiver address must be an active Tron account; and the
+ * amount must be at least 1 TRX (1,000,000 sun). Valid on TRX and TTRX.
+ *
  * @title TRX Delegate Resource Intent
  */
 export const TrxDelegateResourceIntent = t.intersection([
   BaseStakeIntent,
   BaseIntentWithAmount,
   t.type({
+    /** Must be `"delegateResource"`. */
     intentType: intentTypes.delegateResource,
+    /** Tron address of the resource owner delegating their staked resources. */
     ownerAddress: t.string,
+    /** Tron address of the account receiving the delegated resources; must be an active Tron account. */
     receiverAddress: t.string,
+    /** The resource type to delegate: `BANDWIDTH` or `ENERGY`. */
     resource: t.union([t.literal("BANDWIDTH"), t.literal("ENERGY")]),
   }),
 ]);

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

@@ -4,15 +4,24 @@ import { BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 /**
+ * Stake (freeze) TRX to obtain BANDWIDTH or ENERGY using the Tron Stake V2
+ * protocol (FreezeBalanceV2). The spendable balance must be greater than or
+ * equal to the freeze amount plus the transaction fee.
+ * Valid on TRX and TTRX.
+ *
  * @title TRX Freeze Intent
  */
 export const TrxFreezeIntent = t.intersection([
   BaseStakeIntent,
   BaseIntentWithAmount,
   t.type({
+    /** Must be `"stake"`. */
     intentType: intentTypes.stake,
+    /** Tron address of the Super Representative the user intends to vote for after freezing. Stored by the staking service to auto-construct the subsequent vote intent; not consumed by wallet-platform's freeze transaction builder. */
     validatorAddress: t.string,
+    /** Tron address of the wallet owner staking the TRX. */
     ownerAddress: t.string,
+    /** The resource type to obtain by staking: `BANDWIDTH` or `ENERGY`. */
     resource: t.union([t.literal("BANDWIDTH"), t.literal("ENERGY")]),
   }),
 ]);

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

@@ -4,15 +4,24 @@ import { BaseStakeIntent } from "./baseStakeIntent";
 import { intentTypes } from "./intentType";
 
 /**
+ * Reclaim previously delegated BANDWIDTH or ENERGY resources from a
+ * receiver address (UnDelegateResourceContract). The undelegatable balance
+ * must be sufficient to cover the requested amount.
+ * Valid on TRX and TTRX.
+ *
  * @title TRX Undelegate Resource Intent
  */
 export const TrxUndelegateResourceIntent = t.intersection([
   BaseStakeIntent,
   BaseIntentWithAmount,
   t.type({
+    /** Must be `"undelegateResource"`. */
     intentType: intentTypes.undelegateResource,
+    /** Tron address of the resource owner reclaiming the delegated resources. */
     ownerAddress: t.string,
+    /** Tron address of the account from which the resources are being reclaimed. */
     receiverAddress: t.string,
+    /** The resource type to reclaim: `BANDWIDTH` or `ENERGY`. */
     resource: t.union([t.literal("BANDWIDTH"), t.literal("ENERGY")]),
   }),
 ]);

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

@@ -4,14 +4,22 @@ import { BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 /**
+ * Unstake (unfreeze) previously staked TRX using the Tron Stake V2
+ * protocol (UnfreezeBalanceV2). Initiates the unstaking waiting period;
+ * use the `claim` intent to withdraw the TRX after the waiting period
+ * has elapsed. Valid on TRX and TTRX.
+ *
  * @title TRX Unfreeze Intent
  */
 export const TrxUnfreezeIntent = t.intersection([
   BaseStakeIntent,
   BaseIntentWithAmount,
   t.type({
+    /** Must be `"unstake"`. */
     intentType: intentTypes.unstake,
+    /** Tron address of the wallet owner unstaking the TRX. */
     ownerAddress: t.string,
+    /** The resource type to unstake: `BANDWIDTH` or `ENERGY`. */
     resource: t.union([t.literal("BANDWIDTH"), t.literal("ENERGY")]),
   }),
 ]);

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

@@ -4,22 +4,33 @@ import { BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 export const TrxVote = t.type({
+  /** Tron address of the Super Representative (SR) receiving the votes. */
   vote_address: t.string,
+  /** Number of votes to allocate to this SR, as a decimal string. */
   vote_count: t.string,
 });
 
 export type TrxVote = t.TypeOf<typeof TrxVote>;
 
 /**
+ * Cast votes for Tron Super Representatives (SR) using accumulated Tron
+ * Power (VoteWitnessContract). The total vote count across all entries must
+ * not exceed the available Tron Power. Each staked TRX provides 1 unit of
+ * Tron Power. Valid on TRX and TTRX.
+ *
  * @title TRX Vote Intent
  */
 export const TrxVoteIntent = t.intersection([
   BaseStakeIntent,
   BaseIntentWithAmount,
   t.type({
+    /** Must be `"voteDelegation"`. */
     intentType: intentTypes.voteDelegation,
+    /** Tron address of the Super Representative selected during the freeze step. Carried forward by the staking service so the user does not need to re-select a validator; not consumed by wallet-platform's vote transaction builder (which reads the `votes` array instead). */
     validatorAddress: t.string,
+    /** Tron address of the wallet owner casting the votes. */
     ownerAddress: t.string,
+    /** List of vote allocations. Each entry specifies a Super Representative address and the number of votes to assign. Total votes must not exceed available Tron Power. */
     votes: t.array(TrxVote),
   }),
 ]);

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

@@ -4,13 +4,20 @@ import { BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 /**
+ * Withdraw previously unstaked TRX after the Tron unstaking waiting period
+ * has elapsed (WithdrawExpireUnfreeze). The handler does not verify that
+ * the waiting period has passed before submitting the transaction. Use the
+ * `unstake` intent to begin the unstaking process. Valid on TRX and TTRX.
+ *
  * @title TRX Withdraw Expire Unfreeze Intent
  */
 export const TrxWithdrawExpireUnfreezeIntent = t.intersection([
   BaseStakeIntent,
   BaseIntentWithAmount,
   t.type({
+    /** Must be `"claim"`. */
     intentType: intentTypes.claim,
+    /** Tron address of the wallet owner withdrawing the unstaked TRX. */
     ownerAddress: t.string,
   }),
 ]);

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

@@ -5,19 +5,19 @@ import { BaseIntentWithAmount } from "./baseIntent";
 import { intentTypes } from "./intentType";
 
 /**
- * @title VET Decrease Stake Intent
- *
- * Intent for decreasing (partially unstaking) the stake amount for an existing validator
- * @param {Amount} amount - The amount of VET to remove from the existing stake
- * @param {string} validatorAddress - The address of the validator
- * @param {string} stakingContractAddress - The address of the staking contract
+ * Withdraw a portion of VET staked with a VeChain validator, reducing the
+ * position size. The specified amount is returned to the sender's wallet. No
+ * VET is spent — gas is paid by the enterprise gas tank (VTHO).
  */
 export const VetDecreaseStakeIntent = t.intersection([
   BaseStakeIntent,
   BaseIntentWithAmount,
   t.type({
+    /** Must be "decreaseStake". */
     intentType: intentTypes.decreaseStake,
+    /** Address of the validator whose staked position is being reduced. */
     validatorAddress: NonEmptyString,
+    /** Address of the VeChain staking contract holding the position. */
     stakingContractAddress: NonEmptyString,
   }),
 ]);

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

@@ -3,17 +3,19 @@ import { DelegateIntent } from "./delegateIntent";
 import { NonEmptyString } from "io-ts-types";
 
 /**
- * @title VET Delegate Intent
- *
- * @param {string} tokenId - The ID of the NFT token to delegate
- * @param {string} stakingContractAddress - The address of the stargate contract
- * @param {string} validatorAddress - address of the validator to delegate to
+ * Delegate a VeChain staking NFT to a validator, granting the validator voting
+ * and reward rights for that position. No VET is spent — this is an NFT
+ * assignment operation, not a financial transfer. Gas is paid by the enterprise
+ * gas tank (VTHO).
  */
 export const VetDelegateIntent = t.intersection([
   DelegateIntent,
   t.type({
+    /** ID of the staking NFT to delegate to the validator. */
     tokenId: NonEmptyString,
+    /** Address of the VeChain staking (Stargate) contract that holds the NFT. */
     stakingContractAddress: NonEmptyString,
+    /** Address of the validator to delegate the staking NFT to. */
     validatorAddress: NonEmptyString,
   }),
 ]);