Merge pull request #5852 from BitGo/WIN-4974-add-new-type-of-coin-factory-that-takes-use-custom-coin-map

veetragjain · web-flow · commit 082f0713302a · 2025-03-31T12:17:45.000+05:30
refactor(sdk): change createTokenConstructors function to accept custom token config
diff --git a/modules/abstract-eth/src/ethLikeToken.ts b/modules/abstract-eth/src/ethLikeToken.ts
@@ -40,10 +40,15 @@ export class EthLikeToken extends AbstractEthLikeNewCoins {
     return (bitgo: BitGoBase) => new this(bitgo, config, coinNames);
   }
 
-  static createTokenConstructors(coinNames: CoinNames): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    coinNames: CoinNames,
+    tokenConfigs: EthLikeTokenConfig[] = [
+      ...tokens.bitcoin[coinNames.Mainnet].tokens,
+      ...tokens.testnet[coinNames.Mainnet].tokens,
+    ]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    const chain = coinNames.Mainnet;
-    for (const token of [...tokens.bitcoin[chain].tokens, ...tokens.testnet[chain].tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = this.createTokenConstructor(token, coinNames);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
       tokensCtors.push({ name: token.tokenContractAddress, coinConstructor: tokenConstructor });
diff --git a/modules/sdk-coin-ada/src/adaToken.ts b/modules/sdk-coin-ada/src/adaToken.ts
@@ -25,9 +25,11 @@ export class AdaToken extends Ada {
     return (bitgo: BitGoBase) => new AdaToken(bitgo, config);
   }
 
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    tokenConfigs: AdaTokenConfig[] = [...tokens.bitcoin.ada.tokens, ...tokens.testnet.ada.tokens]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    for (const token of [...tokens.bitcoin.ada.tokens, ...tokens.testnet.ada.tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = AdaToken.createTokenConstructor(token);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
     }
diff --git a/modules/sdk-coin-algo/src/algoToken.ts b/modules/sdk-coin-algo/src/algoToken.ts
@@ -33,9 +33,9 @@ export class AlgoToken extends Algo {
     return (bitgo: BitGoBase) => new AlgoToken(bitgo, config);
   }
 
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(tokenConfigs: AlgoTokenConfig[] = formattedAlgoTokens): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    formattedAlgoTokens.forEach((config) => {
+    tokenConfigs.forEach((config) => {
       tokensCtors.push({ name: config.type, coinConstructor: AlgoToken.createTokenConstructor(config) });
       if (config.alias) {
         tokensCtors.push({ name: config.alias, coinConstructor: AlgoToken.createTokenConstructor(config) });
diff --git a/modules/sdk-coin-apt/src/aptToken.ts b/modules/sdk-coin-apt/src/aptToken.ts
@@ -15,9 +15,11 @@ export class AptToken extends Apt {
   static createTokenConstructor(config: AptTokenConfig): CoinConstructor {
     return (bitgo: BitGoBase) => new AptToken(bitgo, config);
   }
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    tokenConfigs: AptTokenConfig[] = [...tokens.bitcoin.apt.tokens, ...tokens.testnet.apt.tokens]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    for (const token of [...tokens.bitcoin.apt.tokens, ...tokens.testnet.apt.tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = AptToken.createTokenConstructor(token);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
     }
diff --git a/modules/sdk-coin-avaxc/src/avaxcToken.ts b/modules/sdk-coin-avaxc/src/avaxcToken.ts
@@ -21,9 +21,11 @@ export class AvaxCToken extends AvaxC {
     return (bitgo: BitGoBase) => new AvaxCToken(bitgo, config);
   }
 
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    tokenConfigs: AvaxcTokenConfig[] = [...tokens.bitcoin.avaxc.tokens, ...tokens.testnet.avaxc.tokens]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    for (const token of [...tokens.bitcoin.avaxc.tokens, ...tokens.testnet.avaxc.tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = AvaxCToken.createTokenConstructor(token);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
       tokensCtors.push({ name: token.tokenContractAddress, coinConstructor: tokenConstructor });
diff --git a/modules/sdk-coin-celo/src/celoToken.ts b/modules/sdk-coin-celo/src/celoToken.ts
@@ -20,9 +20,11 @@ export class CeloToken extends Celo {
     return (bitgo: BitGoBase) => new CeloToken(bitgo, config);
   }
 
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    tokenConfigs: CeloTokenConfig[] = [...tokens.bitcoin.celo.tokens, ...tokens.testnet.celo.tokens]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    for (const token of [...tokens.bitcoin.celo.tokens, ...tokens.testnet.celo.tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = CeloToken.createTokenConstructor(token);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
       tokensCtors.push({ name: token.tokenContractAddress, coinConstructor: tokenConstructor });
diff --git a/modules/sdk-coin-eos/src/eosToken.ts b/modules/sdk-coin-eos/src/eosToken.ts
@@ -19,9 +19,11 @@ export class EosToken extends Eos {
     return (bitgo: BitGoBase) => new EosToken(bitgo, config);
   }
 
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    tokenConfigs: EosTokenConfig[] = [...tokens.bitcoin.eos.tokens, ...tokens.testnet.eos.tokens]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    for (const token of [...tokens.bitcoin.eos.tokens, ...tokens.testnet.eos.tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = EosToken.createTokenConstructor(token);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
     }
diff --git a/modules/sdk-coin-eth/src/erc20Token.ts b/modules/sdk-coin-eth/src/erc20Token.ts
@@ -41,9 +41,11 @@ export class Erc20Token extends Eth {
     return (bitgo: BitGoBase) => new Erc20Token(bitgo, config);
   }
 
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    tokenConfigs: Erc20TokenConfig[] = [...tokens.bitcoin.eth.tokens, ...tokens.testnet.eth.tokens]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    for (const token of [...tokens.bitcoin.eth.tokens, ...tokens.testnet.eth.tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = Erc20Token.createTokenConstructor(token);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
       tokensCtors.push({ name: token.tokenContractAddress, coinConstructor: tokenConstructor });
diff --git a/modules/sdk-coin-hbar/src/hbarToken.ts b/modules/sdk-coin-hbar/src/hbarToken.ts
@@ -15,9 +15,11 @@ export class HbarToken extends Hbar {
     return (bitgo: BitGoBase) => new HbarToken(bitgo, config);
   }
 
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    tokenConfigs: HbarTokenConfig[] = [...tokens.bitcoin.hbar.tokens, ...tokens.testnet.hbar.tokens]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    for (const token of [...tokens.bitcoin.hbar.tokens, ...tokens.testnet.hbar.tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = HbarToken.createTokenConstructor(token);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
     }
diff --git a/modules/sdk-coin-sol/src/solToken.ts b/modules/sdk-coin-sol/src/solToken.ts
@@ -24,9 +24,11 @@ export class SolToken extends Sol {
     return (bitgo: BitGoBase) => new SolToken(bitgo, config);
   }
 
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    tokenConfigs: SolTokenConfig[] = [...tokens.bitcoin.sol.tokens, ...tokens.testnet.sol.tokens]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    for (const token of [...tokens.bitcoin.sol.tokens, ...tokens.testnet.sol.tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = SolToken.createTokenConstructor(token);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
     }
diff --git a/modules/sdk-coin-stx/src/sip10Token.ts b/modules/sdk-coin-stx/src/sip10Token.ts
@@ -21,9 +21,11 @@ export class Sip10Token extends Stx {
     return (bitgo: BitGoBase) => new Sip10Token(bitgo, config);
   }
 
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    tokenConfigs: Sip10TokenConfig[] = [...tokens.bitcoin.stx.tokens, ...tokens.testnet.stx.tokens]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    for (const token of [...tokens.bitcoin.stx.tokens, ...tokens.testnet.stx.tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = Sip10Token.createTokenConstructor(token);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
     }
diff --git a/modules/sdk-coin-sui/src/suiToken.ts b/modules/sdk-coin-sui/src/suiToken.ts
@@ -15,9 +15,11 @@ export class SuiToken extends Sui {
     return (bitgo: BitGoBase) => new SuiToken(bitgo, config);
   }
 
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    tokenConfigs: SuiTokenConfig[] = [...tokens.bitcoin.sui.tokens, ...tokens.testnet.sui.tokens]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    for (const token of [...tokens.bitcoin.sui.tokens, ...tokens.testnet.sui.tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = SuiToken.createTokenConstructor(token);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
     }
diff --git a/modules/sdk-coin-trx/src/trxToken.ts b/modules/sdk-coin-trx/src/trxToken.ts
@@ -26,9 +26,11 @@ export class TrxToken extends Trx {
     return (bitgo: BitGoBase) => new TrxToken(bitgo, config);
   }
 
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    tokenConfigs: TrxTokenConfig[] = [...tokens.bitcoin.trx.tokens, ...tokens.testnet.trx.tokens]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    for (const token of [...tokens.bitcoin.trx.tokens, ...tokens.testnet.trx.tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = TrxToken.createTokenConstructor(token);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
     }
diff --git a/modules/sdk-coin-xlm/src/stellarToken.ts b/modules/sdk-coin-xlm/src/stellarToken.ts
@@ -33,9 +33,11 @@ export class StellarToken extends Xlm {
     return (bitgo: BitGoBase) => new StellarToken(bitgo, config);
   }
 
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    tokenConfigs: StellarTokenConfig[] = [...tokens.bitcoin.xlm.tokens, ...tokens.testnet.xlm.tokens]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    for (const token of [...tokens.bitcoin.xlm.tokens, ...tokens.testnet.xlm.tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = StellarToken.createTokenConstructor(token);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
     }
diff --git a/modules/sdk-coin-xrp/src/xrpToken.ts b/modules/sdk-coin-xrp/src/xrpToken.ts
@@ -15,9 +15,11 @@ export class XrpToken extends Xrp {
     return (bitgo: BitGoBase) => new XrpToken(bitgo, config);
   }
 
-  static createTokenConstructors(): NamedCoinConstructor[] {
+  static createTokenConstructors(
+    tokenConfigs: XrpTokenConfig[] = [...tokens.bitcoin.xrp.tokens, ...tokens.testnet.xrp.tokens]
+  ): NamedCoinConstructor[] {
     const tokensCtors: NamedCoinConstructor[] = [];
-    for (const token of [...tokens.bitcoin.xrp.tokens, ...tokens.testnet.xrp.tokens]) {
+    for (const token of tokenConfigs) {
       const tokenConstructor = XrpToken.createTokenConstructor(token);
       tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
     }

Original file line number	Diff line number	Diff line change
`@@ -25,9 +25,11 @@ export class AdaToken extends Ada {`
`25`	`25`	`return (bitgo: BitGoBase) => new AdaToken(bitgo, config);`
`26`	`26`	`}`
`27`	`27`
`28`		`- static createTokenConstructors(): NamedCoinConstructor[] {`
	`28`	`+ static createTokenConstructors(`
	`29`	`+ tokenConfigs: AdaTokenConfig[] = [...tokens.bitcoin.ada.tokens, ...tokens.testnet.ada.tokens]`
	`30`	`+ ): NamedCoinConstructor[] {`
`29`	`31`	`const tokensCtors: NamedCoinConstructor[] = [];`
`30`		`- for (const token of [...tokens.bitcoin.ada.tokens, ...tokens.testnet.ada.tokens]) {`
	`32`	`+ for (const token of tokenConfigs) {`
`31`	`33`	`const tokenConstructor = AdaToken.createTokenConstructor(token);`
`32`	`34`	`tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });`
`33`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,9 +15,11 @@ export class AptToken extends Apt {`
`15`	`15`	`static createTokenConstructor(config: AptTokenConfig): CoinConstructor {`
`16`	`16`	`return (bitgo: BitGoBase) => new AptToken(bitgo, config);`
`17`	`17`	`}`
`18`		`- static createTokenConstructors(): NamedCoinConstructor[] {`
	`18`	`+ static createTokenConstructors(`
	`19`	`+ tokenConfigs: AptTokenConfig[] = [...tokens.bitcoin.apt.tokens, ...tokens.testnet.apt.tokens]`
	`20`	`+ ): NamedCoinConstructor[] {`
`19`	`21`	`const tokensCtors: NamedCoinConstructor[] = [];`
`20`		`- for (const token of [...tokens.bitcoin.apt.tokens, ...tokens.testnet.apt.tokens]) {`
	`22`	`+ for (const token of tokenConfigs) {`
`21`	`23`	`const tokenConstructor = AptToken.createTokenConstructor(token);`
`22`	`24`	`tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });`
`23`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,11 @@ export class EosToken extends Eos {`
`19`	`19`	`return (bitgo: BitGoBase) => new EosToken(bitgo, config);`
`20`	`20`	`}`
`21`	`21`
`22`		`- static createTokenConstructors(): NamedCoinConstructor[] {`
	`22`	`+ static createTokenConstructors(`
	`23`	`+ tokenConfigs: EosTokenConfig[] = [...tokens.bitcoin.eos.tokens, ...tokens.testnet.eos.tokens]`
	`24`	`+ ): NamedCoinConstructor[] {`
`23`	`25`	`const tokensCtors: NamedCoinConstructor[] = [];`
`24`		`- for (const token of [...tokens.bitcoin.eos.tokens, ...tokens.testnet.eos.tokens]) {`
	`26`	`+ for (const token of tokenConfigs) {`
`25`	`27`	`const tokenConstructor = EosToken.createTokenConstructor(token);`
`26`	`28`	`tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });`
`27`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,9 +15,11 @@ export class HbarToken extends Hbar {`
`15`	`15`	`return (bitgo: BitGoBase) => new HbarToken(bitgo, config);`
`16`	`16`	`}`
`17`	`17`
`18`		`- static createTokenConstructors(): NamedCoinConstructor[] {`
	`18`	`+ static createTokenConstructors(`
	`19`	`+ tokenConfigs: HbarTokenConfig[] = [...tokens.bitcoin.hbar.tokens, ...tokens.testnet.hbar.tokens]`
	`20`	`+ ): NamedCoinConstructor[] {`
`19`	`21`	`const tokensCtors: NamedCoinConstructor[] = [];`
`20`		`- for (const token of [...tokens.bitcoin.hbar.tokens, ...tokens.testnet.hbar.tokens]) {`
	`22`	`+ for (const token of tokenConfigs) {`
`21`	`23`	`const tokenConstructor = HbarToken.createTokenConstructor(token);`
`22`	`24`	`tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });`
`23`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,11 @@ export class SolToken extends Sol {`
`24`	`24`	`return (bitgo: BitGoBase) => new SolToken(bitgo, config);`
`25`	`25`	`}`
`26`	`26`
`27`		`- static createTokenConstructors(): NamedCoinConstructor[] {`
	`27`	`+ static createTokenConstructors(`
	`28`	`+ tokenConfigs: SolTokenConfig[] = [...tokens.bitcoin.sol.tokens, ...tokens.testnet.sol.tokens]`
	`29`	`+ ): NamedCoinConstructor[] {`
`28`	`30`	`const tokensCtors: NamedCoinConstructor[] = [];`
`29`		`- for (const token of [...tokens.bitcoin.sol.tokens, ...tokens.testnet.sol.tokens]) {`
	`31`	`+ for (const token of tokenConfigs) {`
`30`	`32`	`const tokenConstructor = SolToken.createTokenConstructor(token);`
`31`	`33`	`tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });`
`32`	`34`	`}`