feat: flrp validators and delegator

yogeshwar-bitgo · yogeshwar-bitgo · commit f0baf64859d6 · 2025-09-18T16:40:35.000+05:30
TICKET: WIN-7084
diff --git a/modules/sdk-coin-flrp/src/lib/delegatorTxBuilder.ts b/modules/sdk-coin-flrp/src/lib/delegatorTxBuilder.ts
@@ -2,7 +2,7 @@ import { BuildTransactionError, TransactionType } from '@bitgo/sdk-core';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { AtomicTransactionBuilder } from './atomicTransactionBuilder';
 import { Tx } from './iface';
-import { RawTransactionData, TransactionWithExtensions, DelegatorRawTransactionData } from './types';
+import { RawTransactionData, StakingExtendedTransaction, DelegatorRawTransactionData } from './types';
 import {
   DELEGATOR_TRANSACTION_TYPE,
   PRIMARY_DELEGATOR_TYPE,
@@ -120,7 +120,7 @@ export class DelegatorTxBuilder extends AtomicTransactionBuilder {
       throw new BuildTransactionError('At least one reward address is required');
     }
     // Store reward addresses in the transaction (we'll need to extend the type)
-    (this.transaction as TransactionWithExtensions)._rewardAddresses = addresses;
+    (this.transaction as unknown as StakingExtendedTransaction)._rewardAddresses = addresses;
     return this;
   }
 
@@ -145,7 +145,7 @@ export class DelegatorTxBuilder extends AtomicTransactionBuilder {
       this._stakeAmount = BigInt(delegatorData.stakeAmount);
     }
     if (delegatorData.rewardAddresses) {
-      (this.transaction as TransactionWithExtensions)._rewardAddresses = delegatorData.rewardAddresses;
+      (this.transaction as unknown as StakingExtendedTransaction)._rewardAddresses = delegatorData.rewardAddresses;
     }
 
     return this;
@@ -184,7 +184,7 @@ export class DelegatorTxBuilder extends AtomicTransactionBuilder {
       throw new BuildTransactionError('Stake amount is required for delegator transaction');
     }
 
-    const rewardAddresses = (this.transaction as TransactionWithExtensions)._rewardAddresses;
+    const rewardAddresses = (this.transaction as unknown as StakingExtendedTransaction)._rewardAddresses;
     if (!rewardAddresses || rewardAddresses.length === ZERO_NUMBER) {
       throw new BuildTransactionError('Reward addresses are required for delegator transaction');
     }
diff --git a/modules/sdk-coin-flrp/src/lib/importInCTxBuilder.ts b/modules/sdk-coin-flrp/src/lib/importInCTxBuilder.ts
@@ -6,7 +6,7 @@ import { Buffer } from 'buffer';
 import utils, { createHexRegex } from './utils';
 import { Tx, DecodedUtxoObj } from './iface';
 import BigNumber from 'bignumber.js';
-import { TransactionWithExtensions } from './types';
+import { BaseExtendedTransaction } from './types';
 import {
   ASSET_ID_LENGTH,
   OUTPUT_INDEX_HEX_LENGTH,
@@ -118,7 +118,7 @@ export class ImportInCTxBuilder extends AtomicInCTransactionBuilder {
           // Extract amount if present
           if (firstOutput.amount) {
             // Store output amount for validation
-            (this.transaction as TransactionWithExtensions)._outputAmount = firstOutput.amount.toString();
+            (this.transaction as BaseExtendedTransaction)._outputAmount = firstOutput.amount.toString();
           }
         }
       }
@@ -138,7 +138,7 @@ export class ImportInCTxBuilder extends AtomicInCTransactionBuilder {
       // Extract memo if present
       if (unsignedTx.memo && unsignedTx.memo.length > 0) {
         // Store memo data for later use
-        (this.transaction as TransactionWithExtensions)._memo = unsignedTx.memo;
+        (this.transaction as BaseExtendedTransaction)._memo = unsignedTx.memo;
       }
 
       // Set the transaction
diff --git a/modules/sdk-coin-flrp/src/lib/importInPTxBuilder.ts b/modules/sdk-coin-flrp/src/lib/importInPTxBuilder.ts
@@ -7,7 +7,7 @@ import { Buffer } from 'buffer';
 import utils, { createFlexibleHexRegex } from './utils';
 import { Tx, DecodedUtxoObj } from './iface';
 import BigNumber from 'bignumber.js';
-import { TransactionWithExtensions } from './types';
+import { BaseExtendedTransaction } from './types';
 import {
   ASSET_ID_LENGTH,
   DEFAULT_BASE_FEE,
@@ -120,7 +120,7 @@ export class ImportInPTxBuilder extends AtomicTransactionBuilder {
       // Extract memo if present
       if (unsignedTx.memo && unsignedTx.memo.length > 0) {
         // Store memo data for later use
-        (this.transaction as TransactionWithExtensions)._memo = unsignedTx.memo;
+        (this.transaction as BaseExtendedTransaction)._memo = unsignedTx.memo;
       }
 
       // Set the transaction
diff --git a/modules/sdk-coin-flrp/src/lib/permissionlessValidatorTxBuilder.ts b/modules/sdk-coin-flrp/src/lib/permissionlessValidatorTxBuilder.ts
@@ -2,7 +2,7 @@ import { BuildTransactionError, TransactionType } from '@bitgo/sdk-core';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { AtomicTransactionBuilder } from './atomicTransactionBuilder';
 import { Tx } from './iface';
-import { TransactionWithExtensions } from './types';
+import { PermissionlessValidatorExtendedTransaction } from './types';
 import {
   ADD_PERMISSIONLESS_VALIDATOR_TYPE,
   BASIS_POINTS_DIVISOR,
@@ -154,7 +154,7 @@ export class PermissionlessValidatorTxBuilder extends AtomicTransactionBuilder {
       throw new BuildTransactionError('At least one reward address is required');
     }
     // Store reward addresses in the transaction (we'll need to extend the type)
-    (this.transaction as TransactionWithExtensions)._rewardAddresses = addresses;
+    (this.transaction as unknown as PermissionlessValidatorExtendedTransaction)._rewardAddresses = addresses;
     return this;
   }
 
@@ -201,7 +201,8 @@ export class PermissionlessValidatorTxBuilder extends AtomicTransactionBuilder {
       this._delegationFeeRate = txData.delegationFeeRate;
     }
     if (txData.rewardAddresses) {
-      (this.transaction as TransactionWithExtensions)._rewardAddresses = txData.rewardAddresses;
+      (this.transaction as unknown as PermissionlessValidatorExtendedTransaction)._rewardAddresses =
+        txData.rewardAddresses;
     }
 
     return this;
@@ -250,7 +251,8 @@ export class PermissionlessValidatorTxBuilder extends AtomicTransactionBuilder {
       throw new BuildTransactionError('Delegation fee rate is required for permissionless validator transaction');
     }
 
-    const rewardAddresses = (this.transaction as TransactionWithExtensions)._rewardAddresses;
+    const rewardAddresses = (this.transaction as unknown as PermissionlessValidatorExtendedTransaction)
+      ._rewardAddresses;
     if (!rewardAddresses || rewardAddresses.length === 0) {
       throw new BuildTransactionError('Reward addresses are required for permissionless validator transaction');
     }
diff --git a/modules/sdk-coin-flrp/src/lib/types.ts b/modules/sdk-coin-flrp/src/lib/types.ts
@@ -4,21 +4,38 @@
 import { DecodedUtxoObj } from './iface';
 
 /**
- * Extended transaction interface with additional properties
- * used by transaction builders
+ * Base extended transaction interface with common optional properties
  */
-export interface ExtendedTransaction {
-  _rewardAddresses?: string[];
-  _outputAmount?: string;
+export interface BaseExtendedTransaction {
   _memo?: Uint8Array;
-  _delegationFeeRate?: number;
-  _blsPublicKey?: string;
-  _blsSignature?: string;
+  _outputAmount?: string;
+  _utxos?: DecodedUtxoObj[];
+}
+
+/**
+ * Extended transaction for staking transactions (delegator/validator)
+ */
+export interface StakingExtendedTransaction extends BaseExtendedTransaction {
+  _rewardAddresses: string[]; // Required for all staking transactions
   _nodeID?: string;
   _startTime?: bigint;
   _endTime?: bigint;
   _stakeAmount?: bigint;
-  _utxos?: DecodedUtxoObj[];
+}
+
+/**
+ * Extended transaction for validator transactions
+ */
+export interface ValidatorExtendedTransaction extends StakingExtendedTransaction {
+  _delegationFeeRate?: number;
+}
+
+/**
+ * Extended transaction for permissionless validator transactions
+ */
+export interface PermissionlessValidatorExtendedTransaction extends ValidatorExtendedTransaction {
+  _blsPublicKey?: string;
+  _blsSignature?: string;
 }
 
 /**
@@ -73,6 +90,10 @@ export type RawTransactionData =
   | PermissionlessValidatorRawTransactionData;
 
 /**
- * Transaction with extended properties type assertion helper
+ * Specific transaction extension types for better type safety
  */
-export type TransactionWithExtensions = ExtendedTransaction & Record<string, unknown>;
+export type TransactionWithBaseExtensions = BaseExtendedTransaction & Record<string, unknown>;
+export type TransactionWithStakingExtensions = StakingExtendedTransaction & Record<string, unknown>;
+export type TransactionWithValidatorExtensions = ValidatorExtendedTransaction & Record<string, unknown>;
+export type TransactionWithPermissionlessValidatorExtensions = PermissionlessValidatorExtendedTransaction &
+  Record<string, unknown>;
diff --git a/modules/sdk-coin-flrp/src/lib/validatorTxBuilder.ts b/modules/sdk-coin-flrp/src/lib/validatorTxBuilder.ts
@@ -2,7 +2,7 @@ import { BuildTransactionError, TransactionType } from '@bitgo/sdk-core';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { DelegatorTxBuilder } from './delegatorTxBuilder';
 import { Tx } from './iface';
-import { RawTransactionData, TransactionWithExtensions, ValidatorRawTransactionData } from './types';
+import { RawTransactionData, ValidatorExtendedTransaction, ValidatorRawTransactionData } from './types';
 import {
   MIN_DELEGATION_FEE_BASIS_POINTS,
   OBJECT_TYPE_STRING,
@@ -137,7 +137,7 @@ export class ValidatorTxBuilder extends DelegatorTxBuilder {
       throw new BuildTransactionError('Delegation fee rate is required for validator transaction');
     }
 
-    const rewardAddresses = (this.transaction as TransactionWithExtensions)._rewardAddresses;
+    const rewardAddresses = (this.transaction as unknown as ValidatorExtendedTransaction)._rewardAddresses;
     if (!rewardAddresses || rewardAddresses.length === 0) {
       throw new BuildTransactionError('Reward addresses are required for validator transaction');
     }

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ import { BuildTransactionError, TransactionType } from '@bitgo/sdk-core';`
`2`	`2`	`import { BaseCoin as CoinConfig } from '@bitgo/statics';`
`3`	`3`	`import { AtomicTransactionBuilder } from './atomicTransactionBuilder';`
`4`	`4`	`import { Tx } from './iface';`
`5`		`-import { RawTransactionData, TransactionWithExtensions, DelegatorRawTransactionData } from './types';`
	`5`	`+import { RawTransactionData, StakingExtendedTransaction, DelegatorRawTransactionData } from './types';`
`6`	`6`	`import {`
`7`	`7`	`DELEGATOR_TRANSACTION_TYPE,`
`8`	`8`	`PRIMARY_DELEGATOR_TYPE,`
`@@ -120,7 +120,7 @@ export class DelegatorTxBuilder extends AtomicTransactionBuilder {`
`120`	`120`	`throw new BuildTransactionError('At least one reward address is required');`
`121`	`121`	`}`
`122`	`122`	`// Store reward addresses in the transaction (we'll need to extend the type)`
`123`		`- (this.transaction as TransactionWithExtensions)._rewardAddresses = addresses;`
	`123`	`+ (this.transaction as unknown as StakingExtendedTransaction)._rewardAddresses = addresses;`
`124`	`124`	`return this;`
`125`	`125`	`}`
`126`	`126`
`@@ -145,7 +145,7 @@ export class DelegatorTxBuilder extends AtomicTransactionBuilder {`
`145`	`145`	`this._stakeAmount = BigInt(delegatorData.stakeAmount);`
`146`	`146`	`}`
`147`	`147`	`if (delegatorData.rewardAddresses) {`
`148`		`- (this.transaction as TransactionWithExtensions)._rewardAddresses = delegatorData.rewardAddresses;`
	`148`	`+ (this.transaction as unknown as StakingExtendedTransaction)._rewardAddresses = delegatorData.rewardAddresses;`
`149`	`149`	`}`
`150`	`150`
`151`	`151`	`return this;`
`@@ -184,7 +184,7 @@ export class DelegatorTxBuilder extends AtomicTransactionBuilder {`
`184`	`184`	`throw new BuildTransactionError('Stake amount is required for delegator transaction');`
`185`	`185`	`}`
`186`	`186`
`187`		`- const rewardAddresses = (this.transaction as TransactionWithExtensions)._rewardAddresses;`
	`187`	`+ const rewardAddresses = (this.transaction as unknown as StakingExtendedTransaction)._rewardAddresses;`
`188`	`188`	`if (!rewardAddresses \|\| rewardAddresses.length === ZERO_NUMBER) {`
`189`	`189`	`throw new BuildTransactionError('Reward addresses are required for delegator transaction');`
`190`	`190`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import { Buffer } from 'buffer';`
`6`	`6`	`import utils, { createHexRegex } from './utils';`
`7`	`7`	`import { Tx, DecodedUtxoObj } from './iface';`
`8`	`8`	`import BigNumber from 'bignumber.js';`
`9`		`-import { TransactionWithExtensions } from './types';`
	`9`	`+import { BaseExtendedTransaction } from './types';`
`10`	`10`	`import {`
`11`	`11`	`ASSET_ID_LENGTH,`
`12`	`12`	`OUTPUT_INDEX_HEX_LENGTH,`
`@@ -118,7 +118,7 @@ export class ImportInCTxBuilder extends AtomicInCTransactionBuilder {`
`118`	`118`	`// Extract amount if present`
`119`	`119`	`if (firstOutput.amount) {`
`120`	`120`	`// Store output amount for validation`
`121`		`- (this.transaction as TransactionWithExtensions)._outputAmount = firstOutput.amount.toString();`
	`121`	`+ (this.transaction as BaseExtendedTransaction)._outputAmount = firstOutput.amount.toString();`
`122`	`122`	`}`
`123`	`123`	`}`
`124`	`124`	`}`
`@@ -138,7 +138,7 @@ export class ImportInCTxBuilder extends AtomicInCTransactionBuilder {`
`138`	`138`	`// Extract memo if present`
`139`	`139`	`if (unsignedTx.memo && unsignedTx.memo.length > 0) {`
`140`	`140`	`// Store memo data for later use`
`141`		`- (this.transaction as TransactionWithExtensions)._memo = unsignedTx.memo;`
	`141`	`+ (this.transaction as BaseExtendedTransaction)._memo = unsignedTx.memo;`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`// Set the transaction`