fix(sdk-coin-vet): add stake amount in the validator registration txn

Ticket: SC-4409

Author: Vijay-Jagannathan

modules/sdk-coin-vet/src/lib/transaction/validatorRegistrationTransaction.ts

@@ -7,12 +7,12 @@ import EthereumAbi from 'ethereumjs-abi';
 import utils from '../utils';
 import BigNumber from 'bignumber.js';
 import { addHexPrefix, BN } from 'ethereumjs-util';
-import { ZERO_VALUE_AMOUNT } from '../constants';
 
 export class ValidatorRegistrationTransaction extends Transaction {
   private _stakingContractAddress: string;
   private _validator: string;
   private _stakingPeriod: number;
+  private _amountToStake: string;
 
   constructor(_coinConfig: Readonly<CoinConfig>) {
     super(_coinConfig);
@@ -35,6 +35,14 @@ export class ValidatorRegistrationTransaction extends Transaction {
     this._stakingPeriod = period;
   }
 
+  get amountToStake(): string {
+    return this._amountToStake;
+  }
+
+  set amountToStake(amount: string) {
+    this._amountToStake = amount;
+  }
+
   get stakingContractAddress(): string {
     return this._stakingContractAddress;
   }
@@ -63,7 +71,7 @@ export class ValidatorRegistrationTransaction extends Transaction {
     this._clauses = [
       {
         to: this.stakingContractAddress,
-        value: ZERO_VALUE_AMOUNT,
+        value: this.amountToStake,
         data: addValidationData,
       },
     ];
@@ -72,7 +80,7 @@ export class ValidatorRegistrationTransaction extends Transaction {
     this._recipients = [
       {
         address: this.stakingContractAddress,
-        amount: ZERO_VALUE_AMOUNT,
+        amount: this.amountToStake,
       },
     ];
   }
@@ -107,11 +115,11 @@ locking their VET into the built-in staker contract. Allowed values are 60480 (7
       dependsOn: this.dependsOn,
       nonce: this.nonce,
       data: this.transactionData,
-      value: ZERO_VALUE_AMOUNT,
+      value: this.amountToStake,
       sender: this.sender,
       to: this.stakingContractAddress,
       stakingContractAddress: this.stakingContractAddress,
-      amountToStake: ZERO_VALUE_AMOUNT,
+      amountToStake: this.amountToStake,
       validatorAddress: this.validator,
       stakingPeriod: this.stakingPeriod,
     };

modules/sdk-coin-vet/src/lib/transactionBuilder/validatorRegistrationBuilder.ts

@@ -2,6 +2,7 @@ import assert from 'assert';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { TransactionType } from '@bitgo/sdk-core';
 import { TransactionClause } from '@vechain/sdk-core';
+import BigNumber from 'bignumber.js';
 
 import { TransactionBuilder } from './transactionBuilder';
 import { Transaction } from '../transaction/transaction';
@@ -96,6 +97,25 @@ export class ValidatorRegistrationBuilder extends TransactionBuilder {
     return this;
   }
 
+  /**
+   * Sets the amount to stake for this validator registration tx (VET amount being sent).
+   *
+   * @param {string} amount - The amount to stake in wei
+   * @returns {ValidatorRegistrationBuilder} This transaction builder
+   */
+  amountToStake(amount: string): this {
+    // Convert amount from wei to VET for validation (1 VET = 10^18 wei)
+    const amountInVET = new BigNumber(amount).dividedBy(new BigNumber(10).pow(18));
+
+    // Validate amount is between 25M and 600M VET
+    if (amountInVET.isLessThan(25_000_000) || amountInVET.isGreaterThan(600_000_000)) {
+      throw new Error('Staking amount must be between 25M and 600M VET');
+    }
+
+    this.validatorRegistrationTransaction.amountToStake = amount;
+    return this;
+  }
+
   /**
    * Sets the validator address for this validator registration tx.
    * @param {string} address - The validator address
@@ -127,9 +147,16 @@ export class ValidatorRegistrationBuilder extends TransactionBuilder {
       throw new Error('transaction not defined');
     }
     assert(transaction.stakingContractAddress, 'Staking contract address is required');
-
     assert(transaction.stakingPeriod, 'Staking period is required');
     assert(transaction.validator, 'Validator address is required');
+    assert(transaction.amountToStake, 'Staking amount is required');
+
+    // Validate staking amount is within allowed range
+    const amountInVET = new BigNumber(transaction.amountToStake).dividedBy(new BigNumber(10).pow(18));
+    if (amountInVET.isLessThan(25_000_000) || amountInVET.isGreaterThan(600_000_000)) {
+      throw new Error('Staking amount must be between 25M and 600M VET');
+    }
+
     this.validateAddress({ address: transaction.stakingContractAddress });
   }
 

modules/sdk-coin-vet/test/transactionBuilder/validatorRegistrationTxnBuilder.ts

@@ -14,6 +14,9 @@ describe('VET Validator Registration Transaction', function () {
   const factory = new TransactionBuilderFactory(coins.get('tvet'));
   const stakingPeriod = 60480;
   const validatorAddress = '0x9a7aFCACc88c106f3bbD6B213CD0821D9224d945';
+  const amountToStake = '25000000000000000000000000'; // 25000000 VET
+  const amountLessThanMinStake = '24000000000000000000000000'; // 24000000 VET
+  const amountGreaterThanMaxStake = '650000000000000000000000000'; // 650000000 VET
 
   // Helper function to create a basic transaction builder with common properties
   const createBasicTxBuilder = () => {
@@ -32,6 +35,7 @@ describe('VET Validator Registration Transaction', function () {
     const txBuilder = factory.getValidatorRegistrationBuilder();
     txBuilder.stakingContractAddress(VALIDATOR_REGISTRATION_STAKER_CONTRACT_ADDRESS_TESTNET);
     txBuilder.stakingPeriod(stakingPeriod);
+    txBuilder.amountToStake(amountToStake);
     txBuilder.sender('0x9378c12BD7502A11F770a5C1F223c959B2805dA9');
     txBuilder.chainTag(0x27); // Testnet chain tag
     txBuilder.blockRef('0x0000000000000000');
@@ -88,6 +92,7 @@ describe('VET Validator Registration Transaction', function () {
       const txBuilder = createBasicTxBuilder();
       txBuilder.stakingPeriod(stakingPeriod);
       txBuilder.validator(validatorAddress);
+      txBuilder.amountToStake(amountToStake);
 
       await txBuilder.build().should.be.rejectedWith('Staking contract address is required');
     });
@@ -96,6 +101,7 @@ describe('VET Validator Registration Transaction', function () {
       const txBuilder = createBasicTxBuilder();
       txBuilder.stakingContractAddress(VALIDATOR_REGISTRATION_STAKER_CONTRACT_ADDRESS_TESTNET);
       txBuilder.validator(validatorAddress);
+      txBuilder.amountToStake(amountToStake);
 
       await txBuilder.build().should.be.rejectedWith('Staking period is required');
     });
@@ -104,6 +110,34 @@ describe('VET Validator Registration Transaction', function () {
       const txBuilder = createBasicTxBuilder();
       txBuilder.stakingContractAddress(VALIDATOR_REGISTRATION_STAKER_CONTRACT_ADDRESS_TESTNET);
       txBuilder.stakingPeriod(stakingPeriod);
+      txBuilder.amountToStake(amountToStake);
+
+      await txBuilder.build().should.be.rejectedWith('Validator address is required');
+    });
+
+    it('should throw error when amount is missing', async function () {
+      const txBuilder = createBasicTxBuilder();
+      txBuilder.stakingContractAddress(VALIDATOR_REGISTRATION_STAKER_CONTRACT_ADDRESS_TESTNET);
+      txBuilder.stakingPeriod(stakingPeriod);
+      txBuilder.validator(validatorAddress);
+
+      await txBuilder.build().should.be.rejectedWith('Validator address is required');
+    });
+
+    it('should throw error when amount is less than minimum', async function () {
+      const txBuilder = createBasicTxBuilder();
+      txBuilder.stakingContractAddress(VALIDATOR_REGISTRATION_STAKER_CONTRACT_ADDRESS_TESTNET);
+      txBuilder.stakingPeriod(stakingPeriod);
+      txBuilder.amountToStake(amountLessThanMinStake);
+
+      await txBuilder.build().should.be.rejectedWith('Validator address is required');
+    });
+
+    it('should throw error when amount is greater than maximum', async function () {
+      const txBuilder = createBasicTxBuilder();
+      txBuilder.stakingContractAddress(VALIDATOR_REGISTRATION_STAKER_CONTRACT_ADDRESS_TESTNET);
+      txBuilder.stakingPeriod(stakingPeriod);
+      txBuilder.amountToStake(amountGreaterThanMaxStake);
 
       await txBuilder.build().should.be.rejectedWith('Validator address is required');
     });