feat: add Apt NFT collection skeleton

TICKET: COIN-4036

Author: bhavidhingra

modules/sdk-coin-apt/src/aptNFTCollection.ts

@@ -0,0 +1,62 @@
+import { Apt } from './apt';
+import { BitGoBase, CoinConstructor, NamedCoinConstructor } from '@bitgo/sdk-core';
+import { AptNFTCollectionConfig, coins, tokens } from '@bitgo/statics';
+
+export class AptNFTCollection extends Apt {
+  public readonly nftCollectionConfig: AptNFTCollectionConfig;
+
+  constructor(bitgo: BitGoBase, nftCollectionConfig: AptNFTCollectionConfig) {
+    const staticsCoin = nftCollectionConfig.network === 'Mainnet' ? coins.get('apt') : coins.get('tapt');
+    super(bitgo, staticsCoin);
+    this.nftCollectionConfig = nftCollectionConfig;
+  }
+
+  static createNFTCollectionConstructor(config: AptNFTCollectionConfig): CoinConstructor {
+    return (bitgo: BitGoBase) => new AptNFTCollection(bitgo, config);
+  }
+  static createNFTCollectionConstructors(
+    nftCollectionConfigs: AptNFTCollectionConfig[] = [
+      ...tokens.bitcoin.apt.nftCollections,
+      ...tokens.testnet.apt.nftCollections,
+    ]
+  ): NamedCoinConstructor[] {
+    const nftCollectionCtors: NamedCoinConstructor[] = [];
+    for (const config of nftCollectionConfigs) {
+      const nftCollectionConstructor = AptNFTCollection.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 'Apt NFT Collection';
+  }
+
+  getBaseFactor(): number {
+    return Math.pow(10, this.nftCollectionConfig.decimalPlaces);
+  }
+}

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

@@ -3,3 +3,4 @@ export * from './register';
 export * from './apt';
 export * from './tapt';
 export * from './aptToken';
+export * from './aptNFTCollection';

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

@@ -2,11 +2,15 @@ import { BitGoBase } from '@bitgo/sdk-core';
 import { Apt } from './apt';
 import { Tapt } from './tapt';
 import { AptToken } from './aptToken';
+import { AptNFTCollection } from './aptNFTCollection';
 
 export const register = (sdk: BitGoBase): void => {
   sdk.register('apt', Apt.createInstance);
   sdk.register('tapt', Tapt.createInstance);
   AptToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
     sdk.register(name, coinConstructor);
   });
+  AptNFTCollection.createNFTCollectionConstructors().forEach(({ name, coinConstructor }) => {
+    sdk.register(name, coinConstructor);
+  });
 };

modules/statics/src/index.ts

@@ -23,6 +23,7 @@ export {
   SuiCoin,
   XrpCoin,
   AptCoin,
+  AptNFTCollection,
   Sip10Token,
 } from './account';
 export { CoinMap } from './map';

modules/statics/src/tokenConfig.ts

@@ -2,6 +2,7 @@ import {
   AdaCoin,
   AlgoCoin,
   AptCoin,
+  AptNFTCollection,
   ArbethERC20Token,
   AvaxERC20Token,
   BeraERC20Token,
@@ -96,6 +97,10 @@ export type AptTokenConfig = BaseNetworkConfig & {
   assetId: string;
 };
 
+export type AptNFTCollectionConfig = BaseNetworkConfig & {
+  nftCollectionId: string;
+};
+
 export type Sip10TokenConfig = BaseNetworkConfig & {
   assetId: string;
 };
@@ -161,6 +166,7 @@ export interface Tokens {
     };
     apt: {
       tokens: AptTokenConfig[];
+      nftCollections: AptNFTCollectionConfig[];
     };
     stx: {
       tokens: Sip10TokenConfig[];
@@ -226,6 +232,7 @@ export interface Tokens {
     };
     apt: {
       tokens: AptTokenConfig[];
+      nftCollections: AptNFTCollectionConfig[];
     };
     stx: {
       tokens: Sip10TokenConfig[];
@@ -618,6 +625,21 @@ const getFormattedAptTokens = (customCoinMap = coins) =>
     return acc;
   }, []);
 
+const getFormattedAptNFTCollections = (customCoinMap = coins) =>
+  customCoinMap.reduce((acc: AptNFTCollectionConfig[], coin) => {
+    if (coin instanceof AptNFTCollection) {
+      acc.push({
+        type: coin.name,
+        coin: coin.network.type === NetworkType.MAINNET ? 'apt' : 'tapt',
+        network: coin.network.type === NetworkType.MAINNET ? 'Mainnet' : 'Testnet',
+        name: coin.fullName,
+        nftCollectionId: coin.nftCollectionId,
+        decimalPlaces: coin.decimalPlaces,
+      });
+    }
+    return acc;
+  }, []);
+
 const getFormattedSip10Tokens = (customCoinMap = coins) =>
   customCoinMap.reduce((acc: Sip10TokenConfig[], coin) => {
     if (coin instanceof Sip10Token) {
@@ -634,6 +656,7 @@ const getFormattedSip10Tokens = (customCoinMap = coins) =>
   }, []);
 
 export const getFormattedTokens = (coinMap = coins): Tokens => {
+  const formattedAptNFTCollections = getFormattedAptNFTCollections(coinMap);
   return {
     bitcoin: {
       eth: {
@@ -697,6 +720,9 @@ export const getFormattedTokens = (coinMap = coins): Tokens => {
       },
       apt: {
         tokens: getFormattedAptTokens(coinMap).filter((token) => token.network === 'Mainnet'),
+        nftCollections: formattedAptNFTCollections.filter(
+          (nftCollection: AptNFTCollectionConfig) => nftCollection.network === 'Mainnet'
+        ),
       },
       stx: {
         tokens: getFormattedSip10Tokens(coinMap).filter((token) => token.network === 'Mainnet'),
@@ -764,6 +790,9 @@ export const getFormattedTokens = (coinMap = coins): Tokens => {
       },
       apt: {
         tokens: getFormattedAptTokens(coinMap).filter((token) => token.network === 'Testnet'),
+        nftCollections: formattedAptNFTCollections.filter(
+          (nftCollection: AptNFTCollectionConfig) => nftCollection.network === 'Testnet'
+        ),
       },
       stx: {
         tokens: getFormattedSip10Tokens(coinMap).filter((token) => token.network === 'Testnet'),