Merge pull request #5868 from BitGo/coin-3613-generic-nft-statics

feat(sdk-coin-apt): add generic NFT collection statics

Author: bhavidhingra

modules/statics/src/account.ts

@@ -78,6 +78,10 @@ export interface Erc20ConstructorOptions extends AccountConstructorOptions {
   contractAddress: string;
 }
 
+export interface CollectionIdConstructorOptions extends AccountConstructorOptions {
+  collectionId: string;
+}
+
 export interface StellarCoinConstructorOptions extends AccountConstructorOptions {
   domain: string;
 }
@@ -180,6 +184,20 @@ export class ContractAddressDefinedToken extends AccountCoinToken {
   }
 }
 
+/**
+ * Used for blockchains that support NFT collections.
+ */
+export class CollectionIdDefinedToken extends AccountCoinToken {
+  public collectionId: string;
+
+  constructor(options: CollectionIdConstructorOptions) {
+    super({
+      ...options,
+    });
+    this.collectionId = options.collectionId;
+  }
+}
+
 /**
  * ERC20 token addresses are Base58 formatted on some blockchains.
  */
@@ -501,6 +519,12 @@ export class AptCoin extends AccountCoinToken {
   }
 }
 
+/**
+ * The Apt network supports non-fungible tokens (Digital Asset Standard)
+ * Every NFT belongs to an NFT collection.
+ */
+export class AptNFTCollection extends CollectionIdDefinedToken {}
+
 /**
  * Fiat currencies, such as USD, EUR, or YEN.
  */
@@ -2513,6 +2537,51 @@ export function aptToken(
   );
 }
 
+/**
+ * Factory function for Apt NFT collections.
+ *
+ * @param id uuid v4
+ * @param name unique identifier of the NFT collection
+ * @param fullName Complete human-readable name of the NFT collection
+ * @param collectionId collection ID of the non-fungible tokens (NFTs)
+ * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
+ * @param prefix Optional token prefix. Defaults to empty string
+ * @param suffix Optional token suffix. Defaults to token name.
+ * @param network Optional token network. Defaults to APT main network.
+ * @param features Features of this coin. Defaults to the DEFAULT_FEATURES and REQUIRES_RESERVE defined in `AccountCoin`
+ * @param primaryKeyCurve The elliptic curve for this chain/token
+ */
+export function aptNFTCollection(
+  id: string,
+  name: string,
+  fullName: string,
+  collectionId: string,
+  asset: UnderlyingAsset,
+  features: CoinFeature[] = AccountCoin.DEFAULT_FEATURES,
+  prefix = '',
+  suffix: string = name.toUpperCase(),
+  network: AccountNetwork = Networks.main.apt,
+  primaryKeyCurve: KeyCurve = KeyCurve.Ed25519
+) {
+  return Object.freeze(
+    new AptNFTCollection({
+      id,
+      name,
+      fullName,
+      network,
+      collectionId,
+      prefix,
+      suffix,
+      features,
+      decimalPlaces: 0,
+      asset,
+      isToken: true,
+      primaryKeyCurve,
+      baseUnit: BaseUnit.APT,
+    })
+  );
+}
+
 /**
  * Factory function for testnet apt token instances.
  *
@@ -2556,6 +2625,35 @@ export function taptToken(
   );
 }
 
+/**
+ * Factory function for testnet Apt NFT collections.
+ *
+ * @param id uuid v4
+ * @param name unique identifier of the NFT collection
+ * @param fullName Complete human-readable name of the NFT collection
+ * @param collectionId collection ID of the non-fungible tokens (NFTs)
+ * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
+ * @param prefix Optional token prefix. Defaults to empty string
+ * @param suffix Optional token suffix. Defaults to token name.
+ * @param network Optional token network. Defaults to APT test network.
+ * @param features Features of this coin. Defaults to the DEFAULT_FEATURES and REQUIRES_RESERVE defined in `AccountCoin`
+ * @param primaryKeyCurve The elliptic curve for this chain/token
+ */
+export function taptNFTCollection(
+  id: string,
+  name: string,
+  fullName: string,
+  collectionId: string,
+  asset: UnderlyingAsset,
+  features: CoinFeature[] = AccountCoin.DEFAULT_FEATURES,
+  prefix = '',
+  suffix: string = name.toUpperCase(),
+  network: AccountNetwork = Networks.test.apt,
+  primaryKeyCurve: KeyCurve = KeyCurve.Ed25519
+) {
+  return aptNFTCollection(id, name, fullName, collectionId, asset, features, prefix, suffix, network, primaryKeyCurve);
+}
+
 /**
  * Factory function for fiat coin instances.
  *

modules/statics/src/base.ts

@@ -2516,6 +2516,9 @@ export enum UnderlyingAsset {
   // Apt testnet tokens
   'tapt:usdt' = 'tapt:usdt',
 
+  // Apt testnet NFT collections
+  'tapt:nftcollection1' = 'tapt:nftcollection1',
+
   // Sip10 tokens
   'stx:sbtc' = 'stx:sbtc',
   'stx:ststx' = 'stx:ststx',

modules/statics/src/coins.ts

@@ -2,6 +2,8 @@ import {
   account,
   AccountCoin,
   algoToken,
+  aptNFTCollection,
+  aptToken,
   arbethErc20,
   avaxErc20,
   beraErc20,
@@ -23,7 +25,6 @@ import {
   solToken,
   stellarToken,
   suiToken,
-  aptToken,
   talgoToken,
   tarbethErc20,
   tberaErc20,
@@ -41,6 +42,7 @@ import {
   xrpToken,
   zkethErc20,
   taptToken,
+  taptNFTCollection,
 } from './account';
 import { ada } from './ada';
 import { avaxp } from './avaxp';
@@ -2902,6 +2904,15 @@ export const coins = CoinMap.fromCoins([
     UnderlyingAsset['tapt:usdt'],
     APT_FEATURES
   ),
+  // TODO: remove after APT NFTs are live on prod
+  taptNFTCollection(
+    '8f222afb-99b5-4811-b7d0-3a0753b8be74',
+    'tapt:nftcollection1',
+    'BitGo Apt NFT Collection (Test) #1',
+    '0xbbc561fbfa5d105efd8dfb06ae3e7e5be46331165b99d518f094c701e40603b5',
+    UnderlyingAsset['tapt:nftcollection1'],
+    APT_FEATURES
+  ),
   fiat('3f89b1f5-4ada-49c0-a613-15e484d42426', 'fiatusd', 'US Dollar', Networks.main.fiat, 2, UnderlyingAsset.USD),
   fiat(
     '8691cc4f-a425-4192-b6cb-3b0b6f646cbc',
@@ -3017,6 +3028,13 @@ function createToken(
       );
 
     case 'apt':
+      const { initFunc, objectId } = getAptTokenInitializer(token);
+      return initFunc(
+        ...commonArgs.slice(0, 4), // id, name, fullName, decimalPlaces
+        objectId,
+        ...commonArgs.slice(4) // asset, features, prefix, suffix, network, primaryKeyCurve
+      );
+
     case 'stx':
       return initializer(
         ...commonArgs.slice(0, 4), // id, name, fullName, decimalPlaces
@@ -3091,6 +3109,21 @@ function createToken(
   }
 }
 
+function getAptTokenInitializer(token: AmsTokenConfig) {
+  if (token.assetId) {
+    // used for fungible-assets / legacy coins etc.
+    return {
+      initFunc: aptToken as (...args: unknown[]) => Readonly<BaseCoin>,
+      objectId: token.assetId,
+    };
+  }
+  // used for non-fungible token (NFT) collections
+  return {
+    initFunc: aptNFTCollection as (...args: unknown[]) => Readonly<BaseCoin>,
+    objectId: token.collectionId,
+  };
+}
+
 export function createTokenMapUsingConfigDetails(tokenConfigMap: Record<string, AmsTokenConfig[]>): CoinMap {
   const BaseCoins: Map<string, Readonly<BaseCoin>> = new Map();
   const initializerMap: Record<string, unknown> = {

modules/statics/src/tokenConfig.ts

@@ -247,6 +247,7 @@ export interface AmsTokenConfig {
   primaryKeyCurve?: string;
   contractAddress?: string;
   tokenAddress?: string;
+  collectionId?: string;
   alias?: string;
   contractName?: string;
   tokenId?: string;