-
-
Notifications
You must be signed in to change notification settings - Fork 185
/
NftController.ts
1791 lines (1653 loc) · 55.5 KB
/
NftController.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { isAddress } from '@ethersproject/address';
import type { AddApprovalRequest } from '@metamask/approval-controller';
import type {
BaseConfig,
BaseState,
RestrictedControllerMessenger,
} from '@metamask/base-controller';
import { BaseControllerV1 } from '@metamask/base-controller';
import {
safelyExecute,
handleFetch,
toChecksumHexAddress,
BNToHex,
fetchWithErrorHandling,
IPFS_DEFAULT_GATEWAY_URL,
ERC721,
ERC1155,
ApprovalType,
NFT_API_BASE_URL,
} from '@metamask/controller-utils';
import type {
NetworkClientId,
NetworkController,
NetworkState,
} from '@metamask/network-controller';
import type { PreferencesState } from '@metamask/preferences-controller';
import { rpcErrors } from '@metamask/rpc-errors';
import type { Hex } from '@metamask/utils';
import { remove0x } from '@metamask/utils';
import { Mutex } from 'async-mutex';
import BN from 'bn.js';
import { EventEmitter } from 'events';
import { v4 as random } from 'uuid';
import type { AssetsContractController } from './AssetsContractController';
import { compareNftMetadata, getFormattedIpfsUrl } from './assetsUtil';
import { Source } from './constants';
import type {
ApiNftContract,
ReservoirResponse,
Collection,
Attributes,
LastSale,
} from './NftDetectionController';
type NFTStandardType = 'ERC721' | 'ERC1155';
type SuggestedNftMeta = {
asset: { address: string; tokenId: string } & NftMetadata;
id: string;
time: number;
type: NFTStandardType;
interactingAddress: string;
origin: string;
};
/**
* @type Nft
*
* NFT representation
* @property address - Hex address of a ERC721 contract
* @property description - The NFT description
* @property image - URI of custom NFT image associated with this tokenId
* @property name - Name associated with this tokenId and contract address
* @property tokenId - The NFT identifier
* @property numberOfSales - Number of sales
* @property backgroundColor - The background color to be displayed with the item
* @property imagePreview - URI of a smaller image associated with this NFT
* @property imageThumbnail - URI of a thumbnail image associated with this NFT
* @property imageOriginal - URI of the original image associated with this NFT
* @property animation - URI of a animation associated with this NFT
* @property animationOriginal - URI of the original animation associated with this NFT
* @property externalLink - External link containing additional information
* @property creator - The NFT owner information object
* @property isCurrentlyOwned - Boolean indicating whether the address/chainId combination where it's currently stored currently owns this NFT
* @property transactionId - Transaction Id associated with the NFT
*/
// This interface was created before this ESLint rule was added.
// Convert to a `type` in a future major version.
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
export interface Nft extends NftMetadata {
tokenId: string;
address: string;
isCurrentlyOwned?: boolean;
}
type NftUpdate = {
nft: Nft;
newMetadata: NftMetadata;
};
/**
* @type NftContract
*
* NFT contract information representation
* @property name - Contract name
* @property logo - Contract logo
* @property address - Contract address
* @property symbol - Contract symbol
* @property description - Contract description
* @property totalSupply - Total supply of NFTs
* @property assetContractType - The NFT type, it could be `semi-fungible` or `non-fungible`
* @property createdDate - Creation date
* @property schemaName - The schema followed by the contract, it could be `ERC721` or `ERC1155`
* @property externalLink - External link containing additional information
*/
// This interface was created before this ESLint rule was added.
// Convert to a `type` in a future major version.
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
export interface NftContract {
name?: string;
logo?: string;
address: string;
symbol?: string;
description?: string;
totalSupply?: string;
assetContractType?: string;
createdDate?: string;
schemaName?: string;
externalLink?: string;
}
/**
* @type NftMetadata
*
* NFT custom information
* @property name - NFT custom name
* @property description - The NFT description
* @property numberOfSales - Number of sales
* @property backgroundColor - The background color to be displayed with the item
* @property image - Image custom image URI
* @property imagePreview - URI of a smaller image associated with this NFT
* @property imageThumbnail - URI of a thumbnail image associated with this NFT
* @property imageOriginal - URI of the original image associated with this NFT
* @property animation - URI of a animation associated with this NFT
* @property animationOriginal - URI of the original animation associated with this NFT
* @property externalLink - External link containing additional information
* @property creator - The NFT owner information object
* @property standard - NFT standard name for the NFT, e.g., ERC-721 or ERC-1155
*/
// This interface was created before this ESLint rule was added.
// Convert to a `type` in a future major version.
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
export interface NftMetadata {
name: string | null;
description: string | null;
image: string | null;
standard: string | null;
favorite?: boolean;
numberOfSales?: number;
backgroundColor?: string;
imagePreview?: string;
imageThumbnail?: string;
imageOriginal?: string;
animation?: string;
animationOriginal?: string;
externalLink?: string;
creator?: string;
transactionId?: string;
tokenURI?: string | null;
collection?: Collection;
address?: string;
attributes?: Attributes;
lastSale?: LastSale;
rarityRank?: string;
}
/**
* @type NftConfig
*
* NFT controller configuration
* @property selectedAddress - Vault selected address
*/
// This interface was created before this ESLint rule was added.
// Convert to a `type` in a future major version.
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
export interface NftConfig extends BaseConfig {
selectedAddress: string;
chainId: Hex;
ipfsGateway: string;
openSeaEnabled: boolean;
useIPFSSubdomains: boolean;
isIpfsGatewayEnabled: boolean;
}
/**
* @type NftState
*
* NFT controller state
* @property allNftContracts - Object containing NFT contract information
* @property allNfts - Object containing NFTs per account and network
* @property ignoredNfts - List of NFTs that should be ignored
*/
// This interface was created before this ESLint rule was added.
// Convert to a `type` in a future major version.
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
export interface NftState extends BaseState {
allNftContracts: {
[key: string]: { [chainId: Hex]: NftContract[] };
};
allNfts: { [key: string]: { [chainId: Hex]: Nft[] } };
ignoredNfts: Nft[];
}
const ALL_NFTS_STATE_KEY = 'allNfts';
const ALL_NFTS_CONTRACTS_STATE_KEY = 'allNftContracts';
// This interface was created before this ESLint rule was added.
// Convert to a `type` in a future major version.
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
interface NftAsset {
address: string;
tokenId: string;
}
/**
* The name of the {@link NftController}.
*/
const controllerName = 'NftController';
/**
* The external actions available to the {@link NftController}.
*/
type AllowedActions = AddApprovalRequest;
/**
* The messenger of the {@link NftController}.
*/
export type NftControllerMessenger = RestrictedControllerMessenger<
typeof controllerName,
AllowedActions,
never,
AllowedActions['type'],
never
>;
export const getDefaultNftState = (): NftState => {
return {
allNftContracts: {},
allNfts: {},
ignoredNfts: [],
};
};
/**
* Controller that stores assets and exposes convenience methods
*/
export class NftController extends BaseControllerV1<NftConfig, NftState> {
private readonly mutex = new Mutex();
private readonly messagingSystem: NftControllerMessenger;
getNftApi() {
return `${NFT_API_BASE_URL}/tokens`;
}
/**
* Helper method to update nested state for allNfts and allNftContracts.
*
* @param newCollection - the modified piece of state to update in the controller's store
* @param baseStateKey - The root key in the store to update.
* @param passedConfig - An object containing the selectedAddress and chainId that are passed through the auto-detection flow.
* @param passedConfig.userAddress - the address passed through the NFT detection flow to ensure assets are stored to the correct account
* @param passedConfig.chainId - the chainId passed through the NFT detection flow to ensure assets are stored to the correct account
*/
private updateNestedNftState(
newCollection: Nft[] | NftContract[],
baseStateKey: 'allNfts' | 'allNftContracts',
{ userAddress, chainId }: { userAddress: string; chainId: Hex },
) {
const { [baseStateKey]: oldState } = this.state;
const addressState = oldState[userAddress];
const newAddressState = {
...addressState,
...{ [chainId]: newCollection },
};
const newState = {
...oldState,
...{ [userAddress]: newAddressState },
};
this.update({
[baseStateKey]: newState,
});
}
/**
* Request individual NFT information from NFT API.
*
* @param contractAddress - Hex address of the NFT contract.
* @param tokenId - The NFT identifier.
* @returns Promise resolving to the current NFT name and image.
*/
private async getNftInformationFromApi(
contractAddress: string,
tokenId: string,
): Promise<NftMetadata> {
// TODO Parameterize this by chainId for non-mainnet token detection
// Attempt to fetch the data with the nft-api
const urlParams = new URLSearchParams({
chainIds: '1',
tokens: `${contractAddress}:${tokenId}`,
includeTopBid: 'true',
includeAttributes: 'true',
includeLastSale: 'true',
}).toString();
const nftInformation: ReservoirResponse | undefined =
await fetchWithErrorHandling({
url: `${this.getNftApi()}?${urlParams}`,
options: {
headers: {
Version: '1',
},
},
});
// if we were still unable to fetch the data we return out the default/null of `NftMetadata`
if (!nftInformation?.tokens?.[0]?.token) {
return {
name: null,
description: null,
image: null,
standard: null,
};
}
// if we've reached this point, we have successfully fetched some data for nftInformation
// now we reconfigure the data to conform to the `NftMetadata` type for storage.
const {
image,
metadata: { imageOriginal } = {},
name,
description,
collection,
kind,
rarityRank,
rarity,
attributes,
lastSale,
imageSmall,
} = nftInformation.tokens[0].token;
/* istanbul ignore next */
const nftMetadata: NftMetadata = Object.assign(
{},
{ name: name || null },
{ description: description || null },
{ image: image || null },
collection?.creator && { creator: collection.creator },
imageOriginal && { imageOriginal },
imageSmall && { imageThumbnail: imageSmall },
kind && { standard: kind.toUpperCase() },
lastSale && { lastSale },
attributes && { attributes },
nftInformation.tokens[0].market?.topBid && {
topBid: nftInformation.tokens[0].market?.topBid,
},
rarityRank && { rarityRank },
rarity && { rarity },
collection && { collection },
);
return nftMetadata;
}
/**
* Request individual NFT information from contracts that follows Metadata Interface.
*
* @param contractAddress - Hex address of the NFT contract.
* @param tokenId - The NFT identifier.
* @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
* @returns Promise resolving to the current NFT name and image.
*/
private async getNftInformationFromTokenURI(
contractAddress: string,
tokenId: string,
networkClientId?: NetworkClientId,
): Promise<NftMetadata> {
const { ipfsGateway, useIPFSSubdomains, isIpfsGatewayEnabled } =
this.config;
const result = await this.getNftURIAndStandard(
contractAddress,
tokenId,
networkClientId,
);
let tokenURI = result[0];
const standard = result[1];
const hasIpfsTokenURI = tokenURI.startsWith('ipfs://');
if (hasIpfsTokenURI && !isIpfsGatewayEnabled) {
return {
image: null,
name: null,
description: null,
standard: standard || null,
favorite: false,
tokenURI: tokenURI ?? null,
};
}
const isDisplayNFTMediaToggleEnabled = this.config.openSeaEnabled;
if (!hasIpfsTokenURI && !isDisplayNFTMediaToggleEnabled) {
return {
image: null,
name: null,
description: null,
standard: standard || null,
favorite: false,
tokenURI: tokenURI ?? null,
};
}
if (hasIpfsTokenURI) {
tokenURI = getFormattedIpfsUrl(ipfsGateway, tokenURI, useIPFSSubdomains);
}
try {
const object = await handleFetch(tokenURI);
// TODO: Check image_url existence. This is not part of EIP721 nor EIP1155
const image = Object.prototype.hasOwnProperty.call(object, 'image')
? 'image'
: /* istanbul ignore next */ 'image_url';
return {
image: object[image],
name: object.name,
description: object.description,
standard,
favorite: false,
tokenURI: tokenURI ?? null,
};
} catch {
return {
image: null,
name: null,
description: null,
standard: standard || null,
favorite: false,
tokenURI: tokenURI ?? null,
};
}
}
/**
* Retrieve NFT uri with metadata. TODO Update method to use IPFS.
*
* @param contractAddress - NFT contract address.
* @param tokenId - NFT token id.
* @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
* @returns Promise resolving NFT uri and token standard.
*/
private async getNftURIAndStandard(
contractAddress: string,
tokenId: string,
networkClientId?: NetworkClientId,
): Promise<[string, string]> {
// try ERC721 uri
try {
const uri = await this.getERC721TokenURI(
contractAddress,
tokenId,
networkClientId,
);
return [uri, ERC721];
} catch {
// Ignore error
}
// try ERC1155 uri
try {
const tokenURI = await this.getERC1155TokenURI(
contractAddress,
tokenId,
networkClientId,
);
/**
* According to EIP1155 the URI value allows for ID substitution
* in case the string `{id}` exists.
* https://eips.ethereum.org/EIPS/eip-1155#metadata
*/
if (!tokenURI.includes('{id}')) {
return [tokenURI, ERC1155];
}
const hexTokenId = remove0x(BNToHex(new BN(tokenId)))
.padStart(64, '0')
.toLowerCase();
return [tokenURI.replace('{id}', hexTokenId), ERC1155];
} catch {
// Ignore error
}
return ['', ''];
}
/**
* Request individual NFT information (name, image url and description).
*
* @param contractAddress - Hex address of the NFT contract.
* @param tokenId - The NFT identifier.
* @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
* @returns Promise resolving to the current NFT name and image.
*/
private async getNftInformation(
contractAddress: string,
tokenId: string,
networkClientId?: NetworkClientId,
): Promise<NftMetadata> {
const chainId = this.getCorrectChainId({
networkClientId,
});
const [blockchainMetadata, nftApiMetadata] = await Promise.all([
safelyExecute(() =>
this.getNftInformationFromTokenURI(
contractAddress,
tokenId,
networkClientId,
),
),
this.config.openSeaEnabled && chainId === '0x1'
? safelyExecute(() =>
this.getNftInformationFromApi(contractAddress, tokenId),
)
: undefined,
]);
return {
...nftApiMetadata,
name: blockchainMetadata?.name ?? nftApiMetadata?.name ?? null,
description:
blockchainMetadata?.description ?? nftApiMetadata?.description ?? null,
image: blockchainMetadata?.image ?? nftApiMetadata?.image ?? null,
standard:
blockchainMetadata?.standard ?? nftApiMetadata?.standard ?? null,
tokenURI: blockchainMetadata?.tokenURI ?? null,
};
}
/**
* Request NFT contract information from the contract itself.
*
* @param contractAddress - Hex address of the NFT contract.
* @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
* @returns Promise resolving to the current NFT name and image.
*/
private async getNftContractInformationFromContract(
contractAddress: string,
networkClientId?: NetworkClientId,
): Promise<
Partial<ApiNftContract> &
Pick<ApiNftContract, 'address'> &
Pick<ApiNftContract, 'collection'>
> {
const [name, symbol] = await Promise.all([
this.getERC721AssetName(contractAddress, networkClientId),
this.getERC721AssetSymbol(contractAddress, networkClientId),
]);
return {
collection: { name },
symbol,
address: contractAddress,
};
}
/**
* Request NFT contract information from Blockchain and aggregate with received data from NFTMetadata.
*
* @param contractAddress - Hex address of the NFT contract.
* @param nftMetadataFromApi - Received NFT information to be aggregated with blockchain contract information.
* @param networkClientId - The networkClientId that can be used to identify the network client to use for this request.
* @returns Promise resolving to the NFT contract name, image and description.
*/
private async getNftContractInformation(
contractAddress: string,
nftMetadataFromApi: NftMetadata,
networkClientId?: NetworkClientId,
): Promise<
Partial<ApiNftContract> &
Pick<ApiNftContract, 'address'> &
Pick<ApiNftContract, 'collection'>
> {
const blockchainContractData = await safelyExecute(() =>
this.getNftContractInformationFromContract(
contractAddress,
networkClientId,
),
);
if (
blockchainContractData ||
!Object.values(nftMetadataFromApi).every((value) => value === null)
) {
return {
address: contractAddress,
...blockchainContractData,
schema_name: nftMetadataFromApi?.standard ?? null,
collection: {
name: null,
image_url:
nftMetadataFromApi?.collection?.image ??
nftMetadataFromApi?.collection?.imageUrl ??
null,
tokenCount: nftMetadataFromApi?.collection?.tokenCount ?? null,
...nftMetadataFromApi?.collection,
...blockchainContractData?.collection,
},
};
}
/* istanbul ignore next */
return {
address: contractAddress,
asset_contract_type: null,
created_date: null,
schema_name: null,
symbol: null,
total_supply: null,
description: null,
external_link: null,
collection: { name: null, image_url: null },
};
}
/**
* Adds an individual NFT to the stored NFT list.
*
* @param tokenAddress - Hex address of the NFT contract.
* @param tokenId - The NFT identifier.
* @param nftMetadata - NFT optional information (name, image and description).
* @param nftContract - An object containing contract data of the NFT being added.
* @param chainId - The chainId of the network where the NFT is being added.
* @param userAddress - The address of the account where the NFT is being added.
* @param source - Whether the NFT was detected, added manually or suggested by a dapp.
* @returns Promise resolving to the current NFT list.
*/
private async addIndividualNft(
tokenAddress: string,
tokenId: string,
nftMetadata: NftMetadata,
nftContract: NftContract,
chainId: Hex,
userAddress: string,
source: Source,
): Promise<Nft[]> {
// TODO: Remove unused return
const releaseLock = await this.mutex.acquire();
try {
tokenAddress = toChecksumHexAddress(tokenAddress);
const { allNfts } = this.state;
const nfts = allNfts[userAddress]?.[chainId] || [];
const existingEntry: Nft | undefined = nfts.find(
(nft) =>
nft.address.toLowerCase() === tokenAddress.toLowerCase() &&
nft.tokenId === tokenId,
);
if (existingEntry) {
const differentMetadata = compareNftMetadata(
nftMetadata,
existingEntry,
);
if (differentMetadata || !existingEntry.isCurrentlyOwned) {
// TODO: Switch to indexToUpdate
const indexToRemove = nfts.findIndex(
(nft) =>
nft.address.toLowerCase() === tokenAddress.toLowerCase() &&
nft.tokenId === tokenId,
);
/* istanbul ignore next */
if (indexToRemove !== -1) {
nfts.splice(indexToRemove, 1);
}
} else {
return nfts;
}
}
const newEntry: Nft = {
address: tokenAddress,
tokenId,
favorite: existingEntry?.favorite || false,
isCurrentlyOwned: true,
...nftMetadata,
};
const newNfts = [...nfts, newEntry];
this.updateNestedNftState(newNfts, ALL_NFTS_STATE_KEY, {
chainId,
userAddress,
});
if (this.onNftAdded) {
this.onNftAdded({
address: tokenAddress,
symbol: nftContract.symbol,
tokenId: tokenId.toString(),
standard: nftMetadata.standard,
source,
});
}
return newNfts;
} finally {
releaseLock();
}
}
/**
* Adds an NFT contract to the stored NFT contracts list.
*
* @param options - options.
* @param options.tokenAddress - Hex address of the NFT contract.
* @param options.userAddress - The address of the account where the NFT is being added.
* @param options.nftMetadata - The retrieved NFTMetadata from API.
* @param options.networkClientId - The networkClientId that can be used to identify the network client to use for this request.
* @param options.source - Whether the NFT was detected, added manually or suggested by a dapp.
* @returns Promise resolving to the current NFT contracts list.
*/
private async addNftContract({
tokenAddress,
userAddress,
networkClientId,
source,
nftMetadata,
}: {
tokenAddress: string;
userAddress: string;
nftMetadata: NftMetadata;
networkClientId?: NetworkClientId;
source?: Source;
}): Promise<NftContract[]> {
const releaseLock = await this.mutex.acquire();
try {
tokenAddress = toChecksumHexAddress(tokenAddress);
const { allNftContracts } = this.state;
const chainId = this.getCorrectChainId({
networkClientId,
});
const nftContracts = allNftContracts[userAddress]?.[chainId] || [];
const existingEntry = nftContracts.find(
(nftContract) =>
nftContract.address.toLowerCase() === tokenAddress.toLowerCase(),
);
if (existingEntry) {
return nftContracts;
}
// this doesn't work currently for detection if the user switches networks while the detection is processing
// will be fixed once detection uses networkClientIds
// get name and symbol if ERC721 then put together the metadata
const contractInformation = await this.getNftContractInformation(
tokenAddress,
nftMetadata,
networkClientId,
);
const {
asset_contract_type,
created_date,
symbol,
description,
external_link,
schema_name,
collection: { name, image_url, tokenCount },
} = contractInformation;
// If the nft is auto-detected we want some valid metadata to be present
if (
source === Source.Detected &&
'address' in contractInformation &&
typeof contractInformation.address === 'string' &&
'collection' in contractInformation &&
contractInformation.collection.name === null &&
'image_url' in contractInformation.collection &&
contractInformation.collection.image_url === null &&
Object.entries(contractInformation).every(([key, value]) => {
return key === 'address' || key === 'collection' || !value;
})
) {
return nftContracts;
}
/* istanbul ignore next */
const newEntry: NftContract = Object.assign(
{},
{ address: tokenAddress },
description && { description },
name && { name },
image_url && { logo: image_url },
symbol && { symbol },
tokenCount !== null &&
typeof tokenCount !== 'undefined' && { totalSupply: tokenCount },
asset_contract_type && { assetContractType: asset_contract_type },
created_date && { createdDate: created_date },
schema_name && { schemaName: schema_name },
external_link && { externalLink: external_link },
);
const newNftContracts = [...nftContracts, newEntry];
this.updateNestedNftState(newNftContracts, ALL_NFTS_CONTRACTS_STATE_KEY, {
chainId,
userAddress,
});
return newNftContracts;
} finally {
releaseLock();
}
}
/**
* Removes an individual NFT from the stored token list and saves it in ignored NFTs list.
*
* @param address - Hex address of the NFT contract.
* @param tokenId - Token identifier of the NFT.
* @param options - options.
* @param options.chainId - The chainId of the network where the NFT is being removed.
* @param options.userAddress - The address of the account where the NFT is being removed.
*/
private removeAndIgnoreIndividualNft(
address: string,
tokenId: string,
{
chainId,
userAddress,
}: {
chainId: Hex;
userAddress: string;
},
) {
address = toChecksumHexAddress(address);
const { allNfts, ignoredNfts } = this.state;
const newIgnoredNfts = [...ignoredNfts];
const nfts = allNfts[userAddress]?.[chainId] || [];
const newNfts = nfts.filter((nft) => {
if (
nft.address.toLowerCase() === address.toLowerCase() &&
nft.tokenId === tokenId
) {
const alreadyIgnored = newIgnoredNfts.find(
(c) => c.address === address && c.tokenId === tokenId,
);
!alreadyIgnored && newIgnoredNfts.push(nft);
return false;
}
return true;
});
this.updateNestedNftState(newNfts, ALL_NFTS_STATE_KEY, {
userAddress,
chainId,
});
this.update({
ignoredNfts: newIgnoredNfts,
});
}
/**
* Removes an individual NFT from the stored token list.
*
* @param address - Hex address of the NFT contract.
* @param tokenId - Token identifier of the NFT.
* @param options - options.
* @param options.chainId - The chainId of the network where the NFT is being removed.
* @param options.userAddress - The address of the account where the NFT is being removed.
*/
private removeIndividualNft(
address: string,
tokenId: string,
{ chainId, userAddress }: { chainId: Hex; userAddress: string },
) {
address = toChecksumHexAddress(address);
const { allNfts } = this.state;
const nfts = allNfts[userAddress]?.[chainId] || [];
const newNfts = nfts.filter(
(nft) =>
!(
nft.address.toLowerCase() === address.toLowerCase() &&
nft.tokenId === tokenId
),
);
this.updateNestedNftState(newNfts, ALL_NFTS_STATE_KEY, {
userAddress,
chainId,
});
}
/**
* Removes an NFT contract to the stored NFT contracts list.
*
* @param address - Hex address of the NFT contract.
* @param options - options.
* @param options.chainId - The chainId of the network where the NFT is being removed.
* @param options.userAddress - The address of the account where the NFT is being removed.
* @returns Promise resolving to the current NFT contracts list.
*/
private removeNftContract(
address: string,
{ chainId, userAddress }: { chainId: Hex; userAddress: string },
): NftContract[] {
address = toChecksumHexAddress(address);
const { allNftContracts } = this.state;
const nftContracts = allNftContracts[userAddress]?.[chainId] || [];
const newNftContracts = nftContracts.filter(
(nftContract) =>
!(nftContract.address.toLowerCase() === address.toLowerCase()),
);
this.updateNestedNftState(newNftContracts, ALL_NFTS_CONTRACTS_STATE_KEY, {
chainId,
userAddress,
});
return newNftContracts;
}
/**
* EventEmitter instance used to listen to specific EIP747 events
*/
hub = new EventEmitter();
/**
* Optional API key to use with opensea
*/
openSeaApiKey?: string;
/**
* Name of this controller used during composition
*/
override name = 'NftController';
private readonly getERC721AssetName: AssetsContractController['getERC721AssetName'];
private readonly getERC721AssetSymbol: AssetsContractController['getERC721AssetSymbol'];
private readonly getERC721TokenURI: AssetsContractController['getERC721TokenURI'];
private readonly getERC721OwnerOf: AssetsContractController['getERC721OwnerOf'];
private readonly getERC1155BalanceOf: AssetsContractController['getERC1155BalanceOf'];
private readonly getERC1155TokenURI: AssetsContractController['getERC1155TokenURI'];
private readonly getNetworkClientById: NetworkController['getNetworkClientById'];
private readonly onNftAdded?: (data: {
address: string;
symbol: string | undefined;
tokenId: string;
standard: string | null;
source: Source;
}) => void;
/**
* Creates an NftController instance.
*
* @param options - The controller options.
* @param options.chainId - The chain ID of the current network.
* @param options.onPreferencesStateChange - Allows subscribing to preference controller state changes.
* @param options.onNetworkStateChange - Allows subscribing to network controller state changes.
* @param options.getERC721AssetName - Gets the name of the asset at the given address.
* @param options.getERC721AssetSymbol - Gets the symbol of the asset at the given address.
* @param options.getERC721TokenURI - Gets the URI of the ERC721 token at the given address, with the given ID.
* @param options.getERC721OwnerOf - Get the owner of a ERC-721 NFT.
* @param options.getERC1155BalanceOf - Gets balance of a ERC-1155 NFT.
* @param options.getERC1155TokenURI - Gets the URI of the ERC1155 token at the given address, with the given ID.
* @param options.getNetworkClientById - Gets the network client for the given networkClientId.
* @param options.onNftAdded - Callback that is called when an NFT is added. Currently used pass data
* for tracking the NFT added event.
* @param options.messenger - The controller messenger.
* @param config - Initial options used to configure this controller.
* @param state - Initial state to set on this controller.
*/
constructor(
{
chainId: initialChainId,
onPreferencesStateChange,
onNetworkStateChange,
getERC721AssetName,
getERC721AssetSymbol,
getERC721TokenURI,
getERC721OwnerOf,
getERC1155BalanceOf,
getERC1155TokenURI,
getNetworkClientById,
onNftAdded,
messenger,
}: {
chainId: Hex;
onPreferencesStateChange: (
listener: (preferencesState: PreferencesState) => void,
) => void;
onNetworkStateChange: (
listener: (networkState: NetworkState) => void,
) => void;