Skip to content

fix: fix update nft metadata when toggles off #4096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 26, 2024
Merged

fix: fix update nft metadata when toggles off #4096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9dcb3cf
fix: fix update nft metadata when toggles off
sahar-fehri Mar 21, 2024
560100b
fix: fix lint
sahar-fehri Mar 21, 2024
bde9d84
fix: add nft arg to updateNftMetadata
sahar-fehri Mar 25, 2024
3558248
fix: filter inside pref change
sahar-fehri Mar 26, 2024
6a1a8c6
fix: lint
sahar-fehri Mar 26, 2024
ec52f8a
Merge branch 'main' into fix/import-nft-when-toggles-off
sahar-fehri Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 121 additions & 1 deletion packages/assets-controllers/src/NftController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3408,6 +3408,7 @@ describe('NftController', () => {
nftMetadata: { name: '', description: '', image: '', standard: '' },
networkClientId: testNetworkClientId,
});

sinon
.stub(nftController, 'getNftInformation' as keyof typeof nftController)
.returns({
Expand Down Expand Up @@ -3464,6 +3465,7 @@ describe('NftController', () => {
},
networkClientId: testNetworkClientId,
});

sinon
.stub(nftController, 'getNftInformation' as keyof typeof nftController)
.rejects(new Error('Error'));
Expand Down Expand Up @@ -3500,7 +3502,7 @@ describe('NftController', () => {
});
});

it('should update metadata when some calls to fetch metadata succeed', async () => {
it('should update metadata when some calls to fetch metadata succeed', async () => {
const { nftController } = setupController();
const { selectedAddress } = nftController.config;
const spy = jest.spyOn(nftController, 'updateNft');
Expand All @@ -3515,6 +3517,7 @@ describe('NftController', () => {
},
networkClientId: testNetworkClientId,
});

await nftController.addNft('0xtest2', '2', {
nftMetadata: {
name: '',
Expand All @@ -3524,6 +3527,7 @@ describe('NftController', () => {
},
networkClientId: testNetworkClientId,
});

await nftController.addNft('0xtest3', '3', {
nftMetadata: {
name: '',
Expand All @@ -3533,6 +3537,7 @@ describe('NftController', () => {
},
networkClientId: testNetworkClientId,
});

sinon
.stub(nftController, 'getNftInformation' as keyof typeof nftController)
.onFirstCall()
Expand Down Expand Up @@ -3624,5 +3629,120 @@ describe('NftController', () => {
},
]);
});

it('should not update metadata when nfts has image/name/description already', async () => {
const { nftController, triggerPreferencesStateChange } =
setupController();
const spy = jest.spyOn(nftController, 'updateNftMetadata');
const testNetworkClientId = 'sepolia';

// Add nfts
await nftController.addNft('0xtest', '3', {
nftMetadata: {
name: 'test name',
description: 'test description',
image: 'test image',
standard: 'ERC721',
},
userAddress: OWNER_ADDRESS,
networkClientId: testNetworkClientId,
});

// trigger preference change
triggerPreferencesStateChange({
...getDefaultPreferencesState(),
isIpfsGatewayEnabled: false,
openSeaEnabled: true,
selectedAddress: OWNER_ADDRESS,
});

expect(spy).toHaveBeenCalledTimes(0);
});

it('should trigger calling updateNftMetadata when preferences change - openseaEnabled', async () => {
const { nftController, triggerPreferencesStateChange, changeNetwork } =
setupController();
changeNetwork(SEPOLIA);
const spy = jest.spyOn(nftController, 'updateNftMetadata');

const testNetworkClientId = 'sepolia';
// Add nfts
await nftController.addNft('0xtest', '1', {
nftMetadata: {
name: '',
description: '',
image: '',
standard: 'ERC721',
},
userAddress: OWNER_ADDRESS,
networkClientId: testNetworkClientId,
});

expect(
nftController.state.allNfts[OWNER_ADDRESS][SEPOLIA.chainId][0]
.isCurrentlyOwned,
).toBe(true);

sinon
.stub(nftController, 'getNftInformation' as keyof typeof nftController)
.returns({
name: 'name pudgy',
image: 'url pudgy',
description: 'description pudgy',
});

// trigger preference change
triggerPreferencesStateChange({
...getDefaultPreferencesState(),
isIpfsGatewayEnabled: false,
openSeaEnabled: true,
selectedAddress: OWNER_ADDRESS,
});

expect(spy).toHaveBeenCalledTimes(1);
});

it('should trigger calling updateNftMetadata when preferences change - ipfs enabled', async () => {
const { nftController, triggerPreferencesStateChange, changeNetwork } =
setupController();
changeNetwork(SEPOLIA);
const spy = jest.spyOn(nftController, 'updateNftMetadata');

const testNetworkClientId = 'sepolia';
// Add nfts
await nftController.addNft('0xtest', '1', {
nftMetadata: {
name: '',
description: '',
image: '',
standard: 'ERC721',
},
userAddress: OWNER_ADDRESS,
networkClientId: testNetworkClientId,
});

expect(
nftController.state.allNfts[OWNER_ADDRESS][SEPOLIA.chainId][0]
.isCurrentlyOwned,
).toBe(true);

sinon
.stub(nftController, 'getNftInformation' as keyof typeof nftController)
.returns({
name: 'name pudgy',
image: 'url pudgy',
description: 'description pudgy',
});

// trigger preference change
triggerPreferencesStateChange({
...getDefaultPreferencesState(),
isIpfsGatewayEnabled: true,
openSeaEnabled: false,
selectedAddress: OWNER_ADDRESS,
});

expect(spy).toHaveBeenCalledTimes(1);
});
});
});
33 changes: 26 additions & 7 deletions packages/assets-controllers/src/NftController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,6 @@ export class NftController extends BaseControllerV1<NftConfig, NftState> {
...oldState,
...{ [userAddress]: newAddressState },
};

this.update({
[baseStateKey]: newState,
});
Expand Down Expand Up @@ -1041,7 +1040,7 @@ export class NftController extends BaseControllerV1<NftConfig, NftState> {
this.messagingSystem = messenger;

onPreferencesStateChange(
({
async ({
selectedAddress,
ipfsGateway,
openSeaEnabled,
Expand All @@ -1053,6 +1052,26 @@ export class NftController extends BaseControllerV1<NftConfig, NftState> {
openSeaEnabled,
isIpfsGatewayEnabled,
});

const needsUpdateNftMetadata =
(isIpfsGatewayEnabled && ipfsGateway !== '') || openSeaEnabled;

if (needsUpdateNftMetadata) {
const { chainId } = this.config;
const nfts: Nft[] =
this.state.allNfts[selectedAddress]?.[chainId] ?? [];
// filter only nfts
const nftsToUpdate = nfts.filter(
(singleNft) =>
!singleNft.name && !singleNft.description && !singleNft.image,
);
if (nftsToUpdate.length !== 0) {
await this.updateNftMetadata({
nfts: nftsToUpdate,
userAddress: selectedAddress,
});
}
}
},
);

Expand Down Expand Up @@ -1363,20 +1382,21 @@ export class NftController extends BaseControllerV1<NftConfig, NftState> {
* Refetches NFT metadata and updates the state
*
* @param options - Options for refetching NFT metadata
* @param options.nfts - Array of nfts
* @param options.networkClientId - The networkClientId that can be used to identify the network client to use for this request.
* @param options.nfts - nfts to update metadata for.
* @param options.userAddress - The current user address
* @param options.networkClientId - The networkClientId that can be used to identify the network client to use for this request.
*/
async updateNftMetadata({
nfts,
networkClientId,
userAddress = this.config.selectedAddress,
networkClientId,
}: {
nfts: Nft[];
networkClientId?: NetworkClientId;
userAddress?: string;
networkClientId?: NetworkClientId;
}) {
const chainId = this.getCorrectChainId({ networkClientId });

const nftsWithChecksumAdr = nfts.map((nft) => {
return {
...nft,
Expand Down Expand Up @@ -1696,7 +1716,6 @@ export class NftController extends BaseControllerV1<NftConfig, NftState> {
updatedNft,
...nfts.slice(nftInfo.index + 1),
];

this.updateNestedNftState(newNfts, ALL_NFTS_STATE_KEY, {
chainId,
userAddress: selectedAddress,
Expand Down