Merge pull request #6409 from BitGo/WIN-5750-1

nvrakesh06 · web-flow · commit a152f42fd86a · 2025-07-08T13:48:57.000+05:30
fix(sdk-coin-polyx): add mainnet address format
diff --git a/modules/sdk-coin-polyx/src/lib/baseBuilder.ts b/modules/sdk-coin-polyx/src/lib/baseBuilder.ts
@@ -0,0 +1,40 @@
+import { TransactionBuilder } from '@bitgo/abstract-substrate';
+import { Transaction } from './transaction';
+import { BaseCoin as CoinConfig } from '@bitgo/statics';
+import { TransactionType } from '@bitgo/sdk-core';
+import { DecodedSignedTx, DecodedSigningPayload, UnsignedTransaction } from '@substrate/txwrapper-core';
+import { TxMethod } from './iface';
+import utils from './utils';
+
+/**
+ * Base builder class for Polyx transactions
+ * Extends the abstract-substrate TransactionBuilder with Polyx-specific functionality
+ */
+export abstract class PolyxBaseBuilder<M = TxMethod, T extends Transaction = Transaction> extends TransactionBuilder<
+  M,
+  T
+> {
+  constructor(_coinConfig: Readonly<CoinConfig>) {
+    super(_coinConfig);
+    // Override the transaction instance with our PolyX-specific Transaction
+    this._transaction = new Transaction(_coinConfig) as T;
+  }
+
+  /**
+   * Override the getAddressFormat method to return different values based on network type
+   * Returns 12 for mainnet and 42 for testnet
+   *
+   * @returns {number} The address format to use
+   */
+  protected getAddressFormat(): number {
+    return utils.getAddressFormat(this._coinConfig.name);
+  }
+
+  // These methods are abstract in the parent class and must be implemented by concrete subclasses
+  protected abstract buildTransaction(): UnsignedTransaction;
+  protected abstract get transactionType(): TransactionType;
+  abstract validateDecodedTransaction(
+    decodedTxn: DecodedSigningPayload | DecodedSignedTx,
+    rawTransaction?: string
+  ): void;
+}
diff --git a/modules/sdk-coin-polyx/src/lib/batchStakingBuilder.ts b/modules/sdk-coin-polyx/src/lib/batchStakingBuilder.ts
@@ -1,4 +1,5 @@
-import { TransactionBuilder, Transaction } from '@bitgo/abstract-substrate';
+import { Transaction } from './transaction';
+import { PolyxBaseBuilder } from './baseBuilder';
 import { DecodedSignedTx, DecodedSigningPayload, UnsignedTransaction } from '@substrate/txwrapper-core';
 import { methods } from '@substrate/txwrapper-polkadot';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
@@ -24,7 +25,7 @@ type ControllerValue = string | DecodedController;
 type PayeeValue = string | DecodedPayee;
 type AmountValue = string | number;
 
-export class BatchStakingBuilder extends TransactionBuilder {
+export class BatchStakingBuilder extends PolyxBaseBuilder {
   // For bond operation
   protected _amount: string;
   protected _controller: string;
diff --git a/modules/sdk-coin-polyx/src/lib/batchUnstakingBuilder.ts b/modules/sdk-coin-polyx/src/lib/batchUnstakingBuilder.ts
@@ -3,12 +3,13 @@ import { methods } from '@substrate/txwrapper-polkadot';
 import { UnsignedTransaction, DecodedSigningPayload, DecodedSignedTx } from '@substrate/txwrapper-core';
 import { InvalidTransactionError, TransactionType } from '@bitgo/sdk-core';
 import BigNumber from 'bignumber.js';
-import { TransactionBuilder, Transaction } from '@bitgo/abstract-substrate';
+import { Transaction } from './transaction';
+import { PolyxBaseBuilder } from './baseBuilder';
 import { BatchArgs } from './iface';
 import { BatchUnstakingTransactionSchema } from './txnSchema';
 import utils from './utils';
 
-export class BatchUnstakingBuilder extends TransactionBuilder {
+export class BatchUnstakingBuilder extends PolyxBaseBuilder {
   protected _amount: string;
 
   constructor(_coinConfig: Readonly<CoinConfig>) {
diff --git a/modules/sdk-coin-polyx/src/lib/bondExtraBuilder.ts b/modules/sdk-coin-polyx/src/lib/bondExtraBuilder.ts
@@ -1,4 +1,5 @@
-import { TransactionBuilder, Transaction } from '@bitgo/abstract-substrate';
+import { Transaction } from './transaction';
+import { PolyxBaseBuilder } from './baseBuilder';
 import { DecodedSignedTx, DecodedSigningPayload, UnsignedTransaction } from '@substrate/txwrapper-core';
 import { methods } from '@substrate/txwrapper-polkadot';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
@@ -8,7 +9,7 @@ import utils from './utils';
 import { BondExtraArgs } from './iface';
 import BigNumber from 'bignumber.js';
 
-export class BondExtraBuilder extends TransactionBuilder {
+export class BondExtraBuilder extends PolyxBaseBuilder {
   protected _amount: string;
 
   constructor(_coinConfig: Readonly<CoinConfig>) {
diff --git a/modules/sdk-coin-polyx/src/lib/index.ts b/modules/sdk-coin-polyx/src/lib/index.ts
@@ -9,6 +9,7 @@ export {
 } from '@bitgo/abstract-substrate';
 
 export { TransactionBuilderFactory } from './transactionBuilderFactory';
+export { PolyxBaseBuilder } from './baseBuilder';
 export { TransferBuilder } from './transferBuilder';
 export { RegisterDidWithCDDBuilder } from './registerDidWithCDDBuilder';
 export { Transaction as PolyxTransaction } from './transaction';
diff --git a/modules/sdk-coin-polyx/src/lib/registerDidWithCDDBuilder.ts b/modules/sdk-coin-polyx/src/lib/registerDidWithCDDBuilder.ts
@@ -1,12 +1,13 @@
-import { TransactionBuilder, Interface, utils } from '@bitgo/abstract-substrate';
+import { Interface, utils } from '@bitgo/abstract-substrate';
+import { PolyxBaseBuilder } from './baseBuilder';
 import { DecodedSignedTx, DecodedSigningPayload, defineMethod, UnsignedTransaction } from '@substrate/txwrapper-core';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { TransactionType, BaseAddress, InvalidTransactionError } from '@bitgo/sdk-core';
 import { RegisterDidWithCDDArgs, TxMethod } from './iface';
 import { RegisterDidWithCDDTransactionSchema } from './txnSchema';
 import { Transaction } from './transaction';
 
-export class RegisterDidWithCDDBuilder extends TransactionBuilder<TxMethod, Transaction> {
+export class RegisterDidWithCDDBuilder extends PolyxBaseBuilder<TxMethod, Transaction> {
   protected _to: string;
   protected _method: TxMethod;
 
diff --git a/modules/sdk-coin-polyx/src/lib/transaction.ts b/modules/sdk-coin-polyx/src/lib/transaction.ts
@@ -3,8 +3,20 @@ import { InvalidTransactionError, TransactionType } from '@bitgo/sdk-core';
 import { construct, decode } from '@substrate/txwrapper-polkadot';
 import { decodeAddress } from '@polkadot/keyring';
 import { DecodedTx, RegisterDidWithCDDArgs } from './iface';
+import polyxUtils from './utils';
 
 export class Transaction extends SubstrateTransaction {
+  /**
+   * Override the getAddressFormat method to return different values based on network type
+   * Returns 12 for mainnet and 42 for testnet
+   *
+   * @returns {number} The address format to use
+   * @override
+   */
+  protected getAddressFormat(): number {
+    return polyxUtils.getAddressFormat(this._coinConfig.name);
+  }
+
   /** @inheritdoc */
   toJson(): Interface.TxData {
     if (!this._substrateTransaction) {
@@ -40,7 +52,7 @@ export class Transaction extends SubstrateTransaction {
       result.to = keypairDest.getAddress(this.getAddressFormat());
       result.amount = '0'; // RegisterDidWithCDD does not transfer any value
     } else {
-      super.toJson();
+      return super.toJson();
     }
 
     return result;
diff --git a/modules/sdk-coin-polyx/src/lib/transferBuilder.ts b/modules/sdk-coin-polyx/src/lib/transferBuilder.ts
@@ -1,13 +1,16 @@
 import BigNumber from 'bignumber.js';
 
-import { TransactionBuilder, Transaction, Interface, Schema } from '@bitgo/abstract-substrate';
+import { Interface, Schema } from '@bitgo/abstract-substrate';
+import { Transaction } from './transaction';
+import { TxMethod } from './iface';
+import { PolyxBaseBuilder } from './baseBuilder';
 import { DecodedSignedTx, DecodedSigningPayload, defineMethod, UnsignedTransaction } from '@substrate/txwrapper-core';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import { BaseAddress, InvalidTransactionError, TransactionType } from '@bitgo/sdk-core';
 
 import utils from './utils';
 
-export class TransferBuilder extends TransactionBuilder {
+export class TransferBuilder extends PolyxBaseBuilder<TxMethod, Transaction> {
   protected _amount: string;
   protected _to: string;
   protected _memo: string;
@@ -98,7 +101,9 @@ export class TransferBuilder extends TransactionBuilder {
     if (this._method?.name === Interface.MethodNames.TransferWithMemo) {
       const txMethod = this._method.args as Interface.TransferWithMemoArgs;
       this.amount(txMethod.value);
-      this.to({ address: utils.decodeSubstrateAddress(txMethod.dest.id, this.getAddressFormat()) });
+      this.to({
+        address: utils.decodeSubstrateAddress(txMethod.dest.id, utils.getAddressFormat(this._coinConfig.name)),
+      });
       this.memo(txMethod.memo);
     } else {
       throw new InvalidTransactionError(`Invalid Transaction Type: ${this._method?.name}. Expected transferWithMemo`);
diff --git a/modules/sdk-coin-polyx/src/lib/unbondBuilder.ts b/modules/sdk-coin-polyx/src/lib/unbondBuilder.ts
@@ -1,4 +1,5 @@
-import { TransactionBuilder, Transaction } from '@bitgo/abstract-substrate';
+import { Transaction } from './transaction';
+import { PolyxBaseBuilder } from './baseBuilder';
 import { DecodedSignedTx, DecodedSigningPayload, UnsignedTransaction } from '@substrate/txwrapper-core';
 import { methods } from '@substrate/txwrapper-polkadot';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
@@ -8,7 +9,7 @@ import utils from './utils';
 import { UnbondArgs } from './iface';
 import BigNumber from 'bignumber.js';
 
-export class UnbondBuilder extends TransactionBuilder {
+export class UnbondBuilder extends PolyxBaseBuilder {
   protected _amount: string;
 
   constructor(_coinConfig: Readonly<CoinConfig>) {
diff --git a/modules/sdk-coin-polyx/src/lib/utils.ts b/modules/sdk-coin-polyx/src/lib/utils.ts
@@ -5,6 +5,18 @@ import { mainnetMaterial, testnetMaterial } from '../resources';
 import { BatchCallObject } from './iface';
 
 export class Utils extends SubstrateUtils {
+  /**
+   * Get the appropriate address format based on network type
+   * Returns 12 for mainnet and 42 for testnet
+   *
+   * @param coinName The name of the coin
+   * @returns The address format to use
+   */
+  getAddressFormat(coinName: string): number {
+    const isMainnet = coinName.toLowerCase() === 'polyx';
+    return isMainnet ? 12 : 42;
+  }
+
   getMaterial(networkType: NetworkType): Interface.Material {
     return (networkType === NetworkType.MAINNET ? mainnetMaterial : testnetMaterial) as unknown as Interface.Material;
   }
diff --git a/modules/sdk-coin-polyx/src/lib/withdrawUnbondedBuilder.ts b/modules/sdk-coin-polyx/src/lib/withdrawUnbondedBuilder.ts
@@ -3,11 +3,12 @@ import { methods } from '@substrate/txwrapper-polkadot';
 import { UnsignedTransaction, DecodedSigningPayload, DecodedSignedTx } from '@substrate/txwrapper-core';
 import { InvalidTransactionError, TransactionType } from '@bitgo/sdk-core';
 import BigNumber from 'bignumber.js';
-import { TransactionBuilder, Transaction } from '@bitgo/abstract-substrate';
+import { Transaction } from './transaction';
+import { PolyxBaseBuilder } from './baseBuilder';
 import { WithdrawUnbondedTransactionSchema } from './txnSchema';
 import { WithdrawUnbondedArgs } from './iface';
 
-export class WithdrawUnbondedBuilder extends TransactionBuilder {
+export class WithdrawUnbondedBuilder extends PolyxBaseBuilder {
   protected _slashingSpans = 0;
 
   constructor(_coinConfig: Readonly<CoinConfig>) {
diff --git a/modules/sdk-coin-polyx/test/resources/index.ts b/modules/sdk-coin-polyx/test/resources/index.ts
@@ -35,6 +35,18 @@ export const accounts = {
     publicKey: '8493ec2c20033def7f310c5670813ba09406100ad583d501ec299032a8352b32',
     address: '5F4Y7vKt46p6i2ZBeWTUgebJ4WHm2tLFmLzdicHebWzQ1U25',
   },
+  account5Mainnet: {
+    secretKey:
+      '52c596e8b3929ea0d98779c438ed5b5fb9377790e02d22f94169191015fcdc06e807800a3dd78c005e144f20df05dba7ffe20b4bcb29f158da3bc30f6d557991',
+    publicKey: 'e807800a3dd78c005e144f20df05dba7ffe20b4bcb29f158da3bc30f6d557991',
+    address: '2Hh9SU3wwGERBGp1T8BY1T8xp7krH7urC9FsNGSfsyTyED8D',
+  },
+  account6Mainnet: {
+    secretKey:
+      '13dcc892835e91ea9e0ed434660aefcea60d1e57187f31fc610a60977586c0bbb5dda9aad5129b4c77b84bb08e662fc1c863a6a16f557a734375edad6d3ccbf7',
+    publicKey: 'b5dda9aad5129b4c77b84bb08e662fc1c863a6a16f557a734375edad6d3ccbf7',
+    address: '2GZNcm36nErZD3mi619C2iqYWQBRMmeWky9cLnbd2DcAvdxm',
+  },
 };
 
 export const rawTx = {
@@ -100,3 +112,10 @@ export const stakingTx = {
 };
 
 export const { txVersion, specVersion, genesisHash, chainName, specName } = Networks.test.polyx;
+export const {
+  txVersion: mainTxVersion,
+  specVersion: mainSpecVersion,
+  genesisHash: mainGenesisHash,
+  chainName: mainChainName,
+  specName: mainSpecName,
+} = Networks.main.polyx;
diff --git a/modules/sdk-coin-polyx/test/resources/mainnet.ts b/modules/sdk-coin-polyx/test/resources/mainnet.ts
diff --git a/modules/sdk-coin-polyx/test/resources/mainnetMaterialData.json b/modules/sdk-coin-polyx/test/resources/mainnetMaterialData.json
diff --git a/modules/sdk-coin-polyx/test/unit/transactionBuilder/base.ts b/modules/sdk-coin-polyx/test/unit/transactionBuilder/base.ts
@@ -15,6 +15,10 @@ export const buildTestConfig = (): Readonly<CoinConfig> => {
   return coins.get('tpolyx');
 };
 
+export const buildMainnetConfig = (): Readonly<CoinConfig> => {
+  return coins.get('polyx');
+};
+
 class StubTransactionBuilder extends TransactionBuilder {
   constructor(_coinConfig: Readonly<CoinConfig>) {
     super(_coinConfig);
diff --git a/modules/sdk-coin-polyx/test/unit/transactionBuilder/registerDidWithCDDBuilder.ts b/modules/sdk-coin-polyx/test/unit/transactionBuilder/registerDidWithCDDBuilder.ts
diff --git a/modules/sdk-coin-polyx/test/unit/transactionBuilder/transferBuilder.ts b/modules/sdk-coin-polyx/test/unit/transactionBuilder/transferBuilder.ts
diff --git a/modules/statics/src/networks.ts b/modules/statics/src/networks.ts
