Merge pull request #6020 from BitGo/coin-3880-map-nft-collection-id

feat(statics): map NFT collection ID to BaseCoin

Author: bhavidhingra

.gitcommitscopes

@@ -1,2 +1,3 @@
 sdk-coin-rune
 sdk-coin-sui
+statics

modules/bitgo/test/v2/unit/wallet.ts

@@ -12,6 +12,7 @@ import {
   common,
   CustomSigningFunction,
   ECDSAUtils,
+  EDDSAUtils,
   RequestTracer,
   TokenType,
   TssUtils,
@@ -34,6 +35,7 @@ import {
   TxRequestVersion,
   WalletSignMessageOptions,
   WalletSignTypedDataOptions,
+  PrebuildTransactionWithIntentOptions,
 } from '@bitgo/sdk-core';
 
 import { TestBitGo } from '@bitgo/sdk-test';
@@ -4227,6 +4229,51 @@ describe('V2 Wallet:', function () {
       });
     });
 
+    describe('Transfer NFTs', function () {
+      it('should populate intent with NFT token details', async function () {
+        const params: PrebuildTransactionWithIntentOptions = {
+          reqId,
+          intentType: 'payment',
+          recipients: [
+            {
+              address: '0x9fef749050644625012a2c866973775e7123753b3eef0a1a4037453ac26d79bf',
+              amount: '1',
+              tokenData: {
+                tokenType: TokenType.DIGITAL_ASSET,
+                tokenQuantity: '1',
+                tokenContractAddress: '0xbbc561fbfa5d105efd8dfb06ae3e7e5be46331165b99d518f094c701e40603b5',
+                tokenId: '0x675b053d72c24dcc6bc7f38cdd45b4843cfb7af69a25ad21d002c376357e9d69',
+              },
+            },
+          ],
+        };
+
+        const baseCoin = bitgo.coin('tapt');
+        const mpcUtils = new EDDSAUtils.default(bitgo, baseCoin);
+        const intent = mpcUtils.populateIntent(baseCoin, params);
+
+        intent.should.have.property('intentType', 'payment');
+        intent.recipients!.should.deepEqual([
+          {
+            address: {
+              address: '0x9fef749050644625012a2c866973775e7123753b3eef0a1a4037453ac26d79bf',
+            },
+            amount: {
+              value: '1',
+              symbol: 'tapt:nftcollection1',
+            },
+            tokenData: {
+              tokenType: 'Digital Asset',
+              tokenQuantity: '1',
+              tokenContractAddress: '0xbbc561fbfa5d105efd8dfb06ae3e7e5be46331165b99d518f094c701e40603b5',
+              tokenId: '0x675b053d72c24dcc6bc7f38cdd45b4843cfb7af69a25ad21d002c376357e9d69',
+              tokenName: 'tapt:nftcollection1',
+            },
+          },
+        ]);
+      });
+    });
+
     describe('Wallet Sharing', function () {
       it('should use keychain pub to share tss wallet', async function () {
         const userId = '123';

modules/sdk-core/src/bitgo/utils/mpcUtils.ts

@@ -7,8 +7,14 @@ import { IBaseCoin, KeychainsTriplet } from '../baseCoin';
 import { BitGoBase } from '../bitgoBase';
 import { AddKeychainOptions, Keychain, KeyType } from '../keychain';
 import { encryptText, getBitgoGpgPubKey } from './opengpgUtils';
-import { IntentRecipient, PopulatedIntent, PrebuildTransactionWithIntentOptions } from './tss/baseTypes';
+import {
+  IntentRecipient,
+  PopulatedIntent,
+  PrebuildTransactionWithIntentOptions,
+  TokenTransferRecipientParams,
+} from './tss/baseTypes';
 import { envRequiresBitgoPubGpgKeyConfig, isBitgoMpcPubKey } from '../tss/bitgoPubKeys';
+import { coins, NetworkType } from '@bitgo/statics';
 
 export interface MpcKeyShare {
   publicShare: string;
@@ -132,6 +138,10 @@ export abstract class MpcUtils {
             'token type and quantity is required to request a transaction with intent to transfer a token'
           );
         }
+        tokenData.tokenName = this.getTokenName(baseCoin, tokenData);
+        if (tokenData.tokenName) {
+          formattedRecipient.amount.symbol = tokenData.tokenName;
+        }
         formattedRecipient.tokenData = tokenData;
       }
       return formattedRecipient;
@@ -191,4 +201,17 @@ export abstract class MpcUtils {
       enableTokens: params.enableTokens,
     };
   }
+
+  getTokenName(baseCoin: IBaseCoin, tokenData: TokenTransferRecipientParams): string | undefined {
+    if (tokenData.tokenName) {
+      return tokenData.tokenName;
+    }
+    const networkPrefix = baseCoin.getConfig().network.type === NetworkType.TESTNET ? 't' : '';
+    const tokenStaticsKey = `${networkPrefix}${baseCoin.getFamily()}:${tokenData.tokenContractAddress}`;
+    if (coins.has(tokenStaticsKey)) {
+      const tokenStatics = coins.get(tokenStaticsKey);
+      tokenData.tokenName = tokenStatics.name;
+    }
+    return tokenData.tokenName;
+  }
 }

modules/statics/src/account.ts

@@ -2646,7 +2646,7 @@ export function taptNFTCollection(
   nftCollectionId: string,
   asset: UnderlyingAsset,
   features: CoinFeature[] = AccountCoin.DEFAULT_FEATURES,
-  prefix = '',
+  prefix = 't',
   suffix: string = name.toUpperCase(),
   network: AccountNetwork = Networks.test.apt,
   primaryKeyCurve: KeyCurve = KeyCurve.Ed25519

modules/statics/src/map.ts

@@ -1,6 +1,6 @@
 import { BaseCoin } from './base';
 import { DuplicateCoinDefinitionError, CoinNotDefinedError, DuplicateCoinIdDefinitionError } from './errors';
-import { ContractAddressDefinedToken } from './account';
+import { ContractAddressDefinedToken, NFTCollectionIdDefinedToken } from './account';
 
 export class CoinMap {
   private readonly _map = new Map<string, Readonly<BaseCoin>>();
@@ -10,6 +10,8 @@ export class CoinMap {
   // map of coin by address -> the key is the family:contractAddress
   // the family is the where the coin is e.g l1 chains like eth, bsc etc. or l2 like arbeth, celo etc.
   private readonly _coinByContractAddress = new Map<string, Readonly<BaseCoin>>();
+  // map of coin by NFT collection ID -> the key is the (t)family:nftCollectionID
+  private readonly _coinByNftCollectionID = new Map<string, Readonly<BaseCoin>>();
 
   private constructor() {
     // Do not instantiate
@@ -34,8 +36,12 @@ export class CoinMap {
         }
         coinMap._coinByAliases.set(alias, coin);
       }
-      if (coin.isToken && coin instanceof ContractAddressDefinedToken) {
-        coinMap._coinByContractAddress.set(`${coin.family}:${coin.contractAddress}`, coin);
+      if (coin.isToken) {
+        if (coin instanceof ContractAddressDefinedToken) {
+          coinMap._coinByContractAddress.set(`${coin.family}:${coin.contractAddress}`, coin);
+        } else if (coin instanceof NFTCollectionIdDefinedToken) {
+          coinMap._coinByNftCollectionID.set(`${coin.prefix}${coin.family}:${coin.nftCollectionId}`, coin);
+        }
       }
       return coinMap;
     }, new CoinMap());
@@ -99,7 +105,8 @@ export class CoinMap {
       this._map.get(key) ||
       this._coinByIds.get(key) ||
       this._coinByAliases.get(key) ||
-      this._coinByContractAddress.get(key);
+      this._coinByContractAddress.get(key) ||
+      this._coinByNftCollectionID.get(key);
 
     if (coin) {
       return coin;
@@ -113,7 +120,8 @@ export class CoinMap {
       this._map.has(key) ||
       this._coinByIds.has(key) ||
       this._coinByAliases.has(key) ||
-      this._coinByContractAddress.has(key)
+      this._coinByContractAddress.has(key) ||
+      this._coinByNftCollectionID.has(key)
     );
   }
 

modules/statics/test/unit/coins.ts

@@ -637,6 +637,11 @@ describe('CoinMap', function () {
   it('should find coin by id', () => {
     coins.has(btc.id).should.be.true();
   });
+
+  it('should find coin by NFT collection ID', () => {
+    const nftCollectionStatics = coins.get('tapt:0xbbc561fbfa5d105efd8dfb06ae3e7e5be46331165b99d518f094c701e40603b5');
+    nftCollectionStatics.name.should.eql('tapt:nftcollection1');
+  });
 });
 
 coins.forEach((coin, coinName) => {