Merge pull request #6773 from BitGo/coin-5348

feat: add vetNFTCollection skeleton

Author: at31416

modules/sdk-coin-vet/src/index.ts

@@ -3,3 +3,4 @@ export * from './vet';
 export * from './tvet';
 export * from './register';
 export * from './vetToken';
+export * from './vetNFTCollection';

modules/sdk-coin-vet/src/register.ts

@@ -2,11 +2,15 @@ import { BitGoBase } from '@bitgo/sdk-core';
 import { Vet } from './vet';
 import { Tvet } from './tvet';
 import { VetToken } from './vetToken';
+import { VetNFTCollection } from './vetNFTCollection';
 
 export const register = (sdk: BitGoBase): void => {
   sdk.register('vet', Vet.createInstance);
   sdk.register('tvet', Tvet.createInstance);
   VetToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
     sdk.register(name, coinConstructor);
   });
+  VetNFTCollection.createNFTCollectionConstructors().forEach(({ name, coinConstructor }) => {
+    sdk.register(name, coinConstructor);
+  });
 };

modules/sdk-coin-vet/src/vetNFTCollection.ts

@@ -0,0 +1,62 @@
+import { Vet } from './vet';
+import { coins, tokens, VetNFTCollectionConfig } from '@bitgo/statics';
+import { BitGoBase, CoinConstructor, NamedCoinConstructor } from '@bitgo/sdk-core';
+
+export class VetNFTCollection extends Vet {
+  public readonly nftCollectionConfig: VetNFTCollectionConfig;
+
+  constructor(bitgo: BitGoBase, nftCollectionConfig: VetNFTCollectionConfig) {
+    const staticsCoin = nftCollectionConfig.network === 'Mainnet' ? coins.get('vet') : coins.get('tvet');
+    super(bitgo, staticsCoin);
+    this.nftCollectionConfig = nftCollectionConfig;
+  }
+
+  static createNFTCollectionConstructor(config: VetNFTCollectionConfig): CoinConstructor {
+    return (bitgo: BitGoBase) => new VetNFTCollection(bitgo, config);
+  }
+  static createNFTCollectionConstructors(
+    nftCollectionConfigs: VetNFTCollectionConfig[] = [
+      ...tokens.bitcoin.vet.nftCollections,
+      ...tokens.testnet.vet.nftCollections,
+    ]
+  ): NamedCoinConstructor[] {
+    const nftCollectionCtors: NamedCoinConstructor[] = [];
+    for (const config of nftCollectionConfigs) {
+      const nftCollectionConstructor = VetNFTCollection.createNFTCollectionConstructor(config);
+      nftCollectionCtors.push({ name: config.type, coinConstructor: nftCollectionConstructor });
+    }
+    return nftCollectionCtors;
+  }
+
+  get name(): string {
+    return this.nftCollectionConfig.name;
+  }
+
+  get coin(): string {
+    return this.nftCollectionConfig.coin;
+  }
+
+  get network(): string {
+    return this.nftCollectionConfig.network;
+  }
+
+  get nftCollectionId(): string {
+    return this.nftCollectionConfig.nftCollectionId;
+  }
+
+  getChain(): string {
+    return this.nftCollectionConfig.type;
+  }
+
+  getBaseChain(): string {
+    return this.coin;
+  }
+
+  getFullName(): string {
+    return 'Vet NFT Collection';
+  }
+
+  getBaseFactor(): number {
+    return Math.pow(10, this.nftCollectionConfig.decimalPlaces);
+  }
+}

modules/statics/src/index.ts

@@ -29,6 +29,7 @@ export {
   Sip10Token,
   Nep141Token,
   VetToken,
+  VetNFTCollection,
   CosmosChainToken,
 } from './account';
 export { CoinMap } from './map';

modules/statics/src/tokenConfig.ts

@@ -29,6 +29,7 @@ import {
   WorldERC20Token,
   XrpCoin,
   ZkethERC20Token,
+  VetNFTCollection,
 } from './account';
 import { CoinFamily, CoinKind, BaseCoin } from './base';
 import { coins } from './coins';
@@ -130,6 +131,10 @@ export type VetTokenConfig = BaseNetworkConfig & {
   contractAddress: string;
 };
 
+export type VetNFTCollectionConfig = BaseNetworkConfig & {
+  nftCollectionId: string;
+};
+
 export type CosmosTokenConfig = BaseNetworkConfig & {
   denom: string;
 };
@@ -155,6 +160,7 @@ export type TokenConfig =
   | Nep141TokenConfig
   | CosmosTokenConfig
   | VetTokenConfig
+  | VetNFTCollectionConfig
   | TaoTokenConfig
   | PolyxTokenConfig;
 
@@ -245,6 +251,7 @@ export interface Tokens {
     };
     vet: {
       tokens: VetTokenConfig[];
+      nftCollections: VetNFTCollectionConfig[];
     };
     cosmos: {
       tokens: CosmosTokenConfig[];
@@ -336,6 +343,7 @@ export interface Tokens {
     };
     vet: {
       tokens: VetTokenConfig[];
+      nftCollections: VetNFTCollectionConfig[];
     };
     cosmos: {
       tokens: CosmosTokenConfig[];
@@ -912,6 +920,17 @@ function getAptNFTCollectionConfig(coin: AptNFTCollection): AptNFTCollectionConf
     decimalPlaces: coin.decimalPlaces,
   };
 }
+
+function getVetNFTCollectionConfig(coin: VetNFTCollection): VetNFTCollectionConfig {
+  return {
+    type: coin.name,
+    coin: coin.network.type === NetworkType.MAINNET ? 'vet' : 'tvet',
+    network: coin.network.type === NetworkType.MAINNET ? 'Mainnet' : 'Testnet',
+    name: coin.fullName,
+    nftCollectionId: coin.nftCollectionId,
+    decimalPlaces: coin.decimalPlaces,
+  };
+}
 const getFormattedAptNFTCollections = (customCoinMap = coins) =>
   customCoinMap.reduce((acc: AptNFTCollectionConfig[], coin) => {
     if (coin instanceof AptNFTCollection) {
@@ -920,6 +939,14 @@ const getFormattedAptNFTCollections = (customCoinMap = coins) =>
     return acc;
   }, []);
 
+const getFormattedVetNFTCollections = (customCoinMap = coins) =>
+  customCoinMap.reduce((acc: VetNFTCollectionConfig[], coin) => {
+    if (coin instanceof VetNFTCollection) {
+      acc.push(getVetNFTCollectionConfig(coin));
+    }
+    return acc;
+  }, []);
+
 function getSip10TokenConfig(coin: Sip10Token): Sip10TokenConfig {
   return {
     type: coin.name,
@@ -997,6 +1024,7 @@ function getCosmosTokenConfig(coin: CosmosChainToken): CosmosTokenConfig {
 
 export const getFormattedTokens = (coinMap = coins): Tokens => {
   const formattedAptNFTCollections = getFormattedAptNFTCollections(coinMap);
+  const formattedVetNFTCollections = getFormattedVetNFTCollections(coinMap);
   return {
     bitcoin: {
       eth: {
@@ -1088,6 +1116,9 @@ export const getFormattedTokens = (coinMap = coins): Tokens => {
       },
       vet: {
         tokens: getFormattedVetTokens(coinMap).filter((token) => token.network === 'Mainnet'),
+        nftCollections: formattedVetNFTCollections.filter(
+          (nftCollection: VetNFTCollectionConfig) => nftCollection.network === 'Mainnet'
+        ),
       },
       cosmos: {
         tokens: getFormattedCosmosChainTokens(coinMap).filter((token) => token.network === 'Mainnet'),
@@ -1183,6 +1214,9 @@ export const getFormattedTokens = (coinMap = coins): Tokens => {
       },
       vet: {
         tokens: getFormattedVetTokens(coinMap).filter((token) => token.network === 'Testnet'),
+        nftCollections: formattedVetNFTCollections.filter(
+          (nftCollection: VetNFTCollectionConfig) => nftCollection.network === 'Testnet'
+        ),
       },
       cosmos: {
         tokens: getFormattedCosmosChainTokens(coinMap).filter((token) => token.network === 'Testnet'),
@@ -1294,6 +1328,8 @@ export function getFormattedTokenConfigForCoin(coin: Readonly<BaseCoin>): TokenC
     return getCosmosTokenConfig(coin);
   } else if (coin instanceof VetToken) {
     return getVetTokenConfig(coin);
+  } else if (coin instanceof VetNFTCollection) {
+    return getVetNFTCollectionConfig(coin);
   }
   return undefined;
 }