fix: support not defined contractType for NFT types. (#673)

* support not defined contractType for NFT types.
MoralisWeb3 · Sep 22, 2022 · 6227567 · 6227567
1 parent 67a9984
commit 6227567
Show file tree

Hide file tree

Showing 10 changed files with 46 additions and 31 deletions.
diff --git a/.changeset/young-crews-dream.md b/.changeset/young-crews-dream.md
@@ -0,0 +1,6 @@
+---
+'@moralisweb3/evm-api': patch
+'@moralisweb3/evm-utils': patch
+---
+
+Support not defined `contractType` for NFT types.
diff --git a/packages/evmApi/src/resolvers/nft/getNFTContractMetadata.ts b/packages/evmApi/src/resolvers/nft/getNFTContractMetadata.ts
@@ -1,12 +1,12 @@
 import { createEndpoint, createEndpointFactory } from '@moralisweb3/api-utils';
-import { toCamelCase } from '@moralisweb3/core';
+import { maybe, toCamelCase } from '@moralisweb3/core';
 import {
   EvmAddress,
   EvmAddressish,
   EvmChain,
   EvmChainish,
   EvmNftMetadata,
-  validateValidEvmContractType,
+  normalizeEvmNftContractType,
 } from '@moralisweb3/evm-utils';
 import { operations } from '../../generated/types';
 import { EvmChainResolver } from '../EvmChainResolver';
@@ -36,7 +36,7 @@ export const getNFTContractMetadata = createEndpointFactory((core) =>
         chain: EvmChainResolver.resolve(params.chain, core),
         tokenAddress: EvmAddress.create(data.token_address, core),
         syncedAt: data.synced_at ? new Date(data.synced_at) : null,
-        contractType: data.contract_type ? validateValidEvmContractType(data.contract_type) : null,
+        contractType: maybe(data.contract_type, normalizeEvmNftContractType),
       }),
     resultToJson: (data) => data.toJSON(),
     parseParams: (params: Params): ApiParams => ({

diff --git a/packages/evmUtils/src/dataTypes/EvmNft/EvmNft.ts b/packages/evmUtils/src/dataTypes/EvmNft/EvmNft.ts
@@ -10,7 +10,7 @@ import MoralisCore, {
 } from '@moralisweb3/core';
 import { EvmAddress } from '../EvmAddress';
 import { EvmChain } from '../EvmChain';
-import { validateValidEvmContractType } from '../EvmNftContractType';
+import { normalizeEvmNftContractType } from '../EvmNftContractType';
 import { EvmNftData, EvmNftInput } from './types';
 
 /**
@@ -53,7 +53,7 @@ export class EvmNft implements MoralisDataObject {
   static parse = (data: EvmNftInput, core: MoralisCore): EvmNftData => ({
     ...data,
     chain: EvmChain.create(data.chain, core),
-    contractType: validateValidEvmContractType(data.contractType),
+    contractType: maybe(data.contractType, normalizeEvmNftContractType),
     tokenAddress: EvmAddress.create(data.tokenAddress, core),
     metadata: maybe(data.metadata, this.validateMetadata),
     tokenUri: maybe(data.tokenUri),

diff --git a/packages/evmUtils/src/dataTypes/EvmNft/types.ts b/packages/evmUtils/src/dataTypes/EvmNft/types.ts
@@ -51,7 +51,7 @@ export interface EvmNftInput {
  */
 export interface EvmNftData {
   tokenId: number | string;
-  contractType: EvmNftContractType;
+  contractType?: EvmNftContractType;
   chain: EvmChain;
   tokenUri?: string;
   tokenAddress: EvmAddress;

diff --git a/packages/evmUtils/src/dataTypes/EvmNftCollection/EvmNftCollection.test.ts b/packages/evmUtils/src/dataTypes/EvmNftCollection/EvmNftCollection.test.ts
@@ -36,9 +36,9 @@ describe('EvmNftCollection', () => {
   });
 
   it('should throw an error when creating with an invalid contractType', () => {
-    expect(() =>
-      EvmNftCollection.create({ ...exampleInput, contractType: 'ERC100' }),
-    ).toThrowErrorMatchingInlineSnapshot(`"[C0005] Invalid NFT contract type provided"`);
+    expect(() => EvmNftCollection.create({ ...exampleInput, contractType: 'ERC100' })).toThrowError(
+      '[C0005] Invalid NFT contract type provided',
+    );
   });
 
   /**

diff --git a/packages/evmUtils/src/dataTypes/EvmNftCollection/EvmNftCollection.ts b/packages/evmUtils/src/dataTypes/EvmNftCollection/EvmNftCollection.ts
@@ -1,7 +1,7 @@
-import MoralisCore, { MoralisDataObject, MoralisCoreProvider } from '@moralisweb3/core';
+import MoralisCore, { MoralisDataObject, MoralisCoreProvider, maybe } from '@moralisweb3/core';
 import { EvmAddress } from '../EvmAddress';
 import { EvmChain } from '../EvmChain';
-import { validateValidEvmContractType } from '../EvmNftContractType';
+import { normalizeEvmNftContractType } from '../EvmNftContractType';
 import { EvmNftCollectionData, EvmNftCollectionInput } from './types';
 
 /**
@@ -39,7 +39,7 @@ export class EvmNftCollection implements MoralisDataObject {
     ...data,
     tokenAddress: EvmAddress.create(data.tokenAddress, core),
     chain: EvmChain.create(data.chain, core),
-    contractType: validateValidEvmContractType(data.contractType),
+    contractType: maybe(data.contractType, normalizeEvmNftContractType),
   });
 
   /**

diff --git a/packages/evmUtils/src/dataTypes/EvmNftCollection/types.ts b/packages/evmUtils/src/dataTypes/EvmNftCollection/types.ts
@@ -28,7 +28,7 @@ export interface EvmNftCollectionInput {
  */
 export interface EvmNftCollectionData {
   chain: EvmChain;
-  contractType: EvmNftContractType;
+  contractType?: EvmNftContractType;
   name: string;
   symbol: string;
   tokenAddress: EvmAddress;

diff --git a/packages/evmUtils/src/dataTypes/EvmNftContractType.test.ts b/packages/evmUtils/src/dataTypes/EvmNftContractType.test.ts
@@ -0,0 +1,17 @@
+import { normalizeEvmNftContractType, EvmNftContractType } from './EvmNftContractType';
+
+describe('normalizeEvmNftContractType()', () => {
+  it('returns ERC721', () => {
+    expect(normalizeEvmNftContractType('erc721')).toEqual(EvmNftContractType.ERC721);
+    expect(normalizeEvmNftContractType('ERC721')).toEqual(EvmNftContractType.ERC721);
+  });
+
+  it('returns ERC1155', () => {
+    expect(normalizeEvmNftContractType('erc1155')).toEqual(EvmNftContractType.ERC1155);
+    expect(normalizeEvmNftContractType('ERC1155')).toEqual(EvmNftContractType.ERC1155);
+  });
+
+  it('throws error if value is undefined', () => {
+    expect(() => normalizeEvmNftContractType('wrongErc')).toThrowError('Invalid NFT contract type provided');
+  });
+});
diff --git a/packages/evmUtils/src/dataTypes/EvmNftContractType.ts b/packages/evmUtils/src/dataTypes/EvmNftContractType.ts
@@ -5,24 +5,16 @@ export enum EvmNftContractType {
   ERC1155 = 'ERC1155',
 }
 
-export const isValidEvmContractType = (value: string): value is EvmNftContractType => {
+export function normalizeEvmNftContractType(value: string): EvmNftContractType {
   switch (value.toUpperCase()) {
     case EvmNftContractType.ERC1155:
-      return true;
+      return EvmNftContractType.ERC1155;
     case EvmNftContractType.ERC721:
-      return true;
-    default:
-      return false;
+      return EvmNftContractType.ERC721;
   }
-};
 
-export const validateValidEvmContractType = (value: string) => {
-  if (!isValidEvmContractType(value)) {
-    throw new MoralisCoreError({
-      code: CoreErrorCode.INVALID_ARGUMENT,
-      message: 'Invalid NFT contract type provided',
-    });
-  }
-
-  return value;
-};
+  throw new MoralisCoreError({
+    code: CoreErrorCode.INVALID_ARGUMENT,
+    message: `Invalid NFT contract type provided: ${value}`,
+  });
+}
diff --git a/packages/evmUtils/src/dataTypes/EvmNftMetadata/types.ts b/packages/evmUtils/src/dataTypes/EvmNftMetadata/types.ts
@@ -22,7 +22,7 @@ export interface EvmNftMetadataInput {
   tokenAddress: EvmAddressish;
   name: string;
   symbol: string;
-  contractType: EvmNftContractType | null;
+  contractType?: EvmNftContractType;
   syncedAt: DateInput | null;
 }
 
@@ -34,6 +34,6 @@ export interface EvmNftMetadataData {
   tokenAddress: EvmAddress;
   name: string;
   symbol: string;
-  contractType: EvmNftContractType | null;
+  contractType?: EvmNftContractType;
   syncedAt?: Date;
 }