Merge pull request #6863 from BitGo/COIN-5419-ylds

feat: add ofc tokens for hash

Author: MohammedRyaan786

modules/bitgo/test/v2/unit/coins/ofcToken.ts

@@ -474,4 +474,25 @@ describe('OFC:', function () {
       });
     });
   });
+
+  describe('check ofc tokens for hash tokens', function () {
+    const tokenMain = 'ofchash:ylds';
+    const tokenTest = 'ofcthash:ylds';
+    describe('for main network', function () {
+      it(`should have the correct values for ${tokenMain}`, function () {
+        const ofcCoin = bitgo.coin(tokenMain);
+        ofcCoin.getChain().should.equal(tokenMain);
+        ofcCoin.getFullName().should.equal('YLDS Token');
+        ofcCoin.getBaseFactor().should.equal(PRECISION_6);
+      });
+    });
+    describe('for test network', function () {
+      it(`should have the correct values for ${tokenTest}`, function () {
+        const ofcCoin = bitgo.coin(tokenTest);
+        ofcCoin.getChain().should.equal(tokenTest);
+        ofcCoin.getFullName().should.equal('Testnet YLDS Token');
+        ofcCoin.getBaseFactor().should.equal(PRECISION_6);
+      });
+    });
+  });
 });

modules/statics/src/coins/ofcCoins.ts

@@ -33,6 +33,8 @@ import {
   tofcCoredaoErc20,
   ofcVetToken,
   tofcVetToken,
+  ofcHashToken,
+  tofcHashToken,
 } from '../ofc';
 import { UnderlyingAsset, CoinKind } from '../base';
 
@@ -3086,4 +3088,12 @@ export const ofcCoins = [
     18,
     UnderlyingAsset['tvet:vtho']
   ),
+  ofcHashToken('705402cb-b92f-4b32-8899-1f3f4dec1406', 'ofchash:ylds', 'YLDS Token', 6, UnderlyingAsset['hash:ylds']),
+  tofcHashToken(
+    'd2277bf2-0f95-4ede-9b38-aebac7ae9962',
+    'ofcthash:ylds',
+    'Testnet YLDS Token',
+    6,
+    UnderlyingAsset['thash:ylds']
+  ),
 ];

modules/statics/src/ofc.ts

@@ -2183,3 +2183,106 @@ export function tofcVetToken(
     })
   );
 }
+
+/**
+ * Factory function for ofc hash token instances.
+ *
+ * @param id uuid v4
+ * @param name unique identifier of the coin
+ * @param fullName Complete human-readable name of the coin
+ * @param network Network object for this coin
+ * @param decimalPlaces Number of decimal places this coin supports (divisibility exponent)
+ * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
+ * @param kind Differentiates coins which represent fiat assets from those which represent crypto assets
+ * @param prefix? Optional coin prefix. Defaults to empty string
+ * @param suffix? Optional coin suffix. Defaults to coin name.
+ * @param isToken? Whether or not this account coin is a token of another coin
+ * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `OfcCoin`
+ * @param primaryKeyCurve The elliptic curve for this chain/token
+ */
+export function ofcHashToken(
+  id: string,
+  name: string,
+  fullName: string,
+  decimalPlaces: number,
+  asset: UnderlyingAsset,
+  kind: CoinKind = CoinKind.CRYPTO,
+  features: CoinFeature[] = OfcCoin.DEFAULT_FEATURES,
+  prefix = '',
+  suffix: string = name.replace(/^ofc/, '').toUpperCase(),
+  network: OfcNetwork = Networks.main.ofc,
+  isToken = true,
+  addressCoin = 'hash',
+  primaryKeyCurve: KeyCurve = KeyCurve.Secp256k1
+) {
+  const filteredFeatures = getFilteredFeatures(suffix);
+  if (filteredFeatures.length > 0) {
+    features = filteredFeatures;
+  }
+  return Object.freeze(
+    new OfcCoin({
+      id,
+      name,
+      fullName,
+      network,
+      prefix,
+      suffix,
+      features,
+      decimalPlaces,
+      isToken,
+      asset,
+      kind,
+      addressCoin,
+      primaryKeyCurve,
+      baseUnit: BaseUnit.HASH,
+    })
+  );
+}
+
+/**
+ * Factory function for testnet ofc hash token instances.
+ *
+ * @param id uuid v4
+ * @param name unique identifier of the coin
+ * @param fullName Complete human-readable name of the coin
+ * @param network Network object for this coin
+ * @param decimalPlaces Number of decimal places this coin supports (divisibility exponent)
+ * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
+ * @param kind Differentiates coins which represent fiat assets from those which represent crypto assets
+ * @param prefix? Optional coin prefix. Defaults to empty string
+ * @param suffix? Optional coin suffix. Defaults to coin name.
+ * @param isToken? Whether or not this account coin is a token of another coin
+ * @param features? Features of this coin. Defaults to the DEFAULT_FEATURES defined in `OfcCoin`
+ * @param primaryKeyCurve The elliptic curve for this chain/token
+ */
+export function tofcHashToken(
+  id: string,
+  name: string,
+  fullName: string,
+  decimalPlaces: number,
+  asset: UnderlyingAsset,
+  kind: CoinKind = CoinKind.CRYPTO,
+  features: CoinFeature[] = OfcCoin.DEFAULT_FEATURES,
+  prefix = '',
+  suffix: string = name.replace(/^ofc/, '').toUpperCase(),
+  network: OfcNetwork = Networks.test.ofc,
+  isToken = true,
+  addressCoin = 'thash',
+  primaryKeyCurve: KeyCurve = KeyCurve.Secp256k1
+) {
+  return ofcHashToken(
+    id,
+    name,
+    fullName,
+    decimalPlaces,
+    asset,
+    kind,
+    features,
+    prefix,
+    suffix,
+    network,
+    isToken,
+    addressCoin,
+    primaryKeyCurve
+  );
+}