Merge pull request #952 from multiversx/SERVICES-1431-move-scam-info-…

…calculation-in-nft-service

Services 1431 move scam info calculation in nft service

.github/workflows/node.js.yml

@@ -26,6 +26,5 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
-    - run: npm install
-    - run: npm run build --if-present
+    - run: npm ci
     - run: npm test

.gitignore

@@ -400,3 +400,4 @@ build.yaml
 
 # PEM file(s)
 *.pem
+/src/plugins

package.json

@@ -5,6 +5,8 @@
   "description": "Nest TypeScript starter repository",
   "license": "MIT",
   "scripts": {
+    "init": "run-script-os",
+    "init:nix": "rimraf src/plugins && mkdir src/plugins && cp src/plugins.template/plugin.module.ts.template src/plugins/plugin.module.ts",
     "prebuild": "rimraf dist",
     "build": "nest build && npm run copy-pem",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",

schema.gql

@@ -1211,6 +1211,7 @@ type ScamInfo {
 }
 
 enum ScamInfoTypeEnum {
+  none
   potentialScam
   scam
 }

src/common/pluggins/plugin.service.ts

@@ -0,0 +1,7 @@
+import { Injectable } from '@nestjs/common';
+import { Asset } from 'src/modules/assets/models/Asset.dto';
+
+@Injectable()
+export class PluginService {
+  async computeScamInfo(_nft: Asset[]): Promise<void> {}
+}

src/common/services/mx-communication/models/account.info.ts

@@ -0,0 +1,19 @@
+import { ScamInfo } from 'src/modules/assets/models/ScamInfo.dto';
+
+export class AccountInfo {
+  address: string = '';
+  nonce: number = 0;
+  balance: string = '';
+  username: string = '';
+  code: string = '';
+  codeHash: string | undefined;
+  rootHash: string = '';
+  codeMetadata: string = '';
+  developerReward: string = '';
+  ownerAddress: string = '';
+  scamInfo: ScamInfo | undefined = undefined;
+
+  constructor(init?: Partial<AccountInfo>) {
+    Object.assign(this, init);
+  }
+}

src/common/services/mx-communication/models/nft.dto.ts

@@ -31,6 +31,7 @@ export interface Nft {
   nonce: number;
   royalties: string;
   timestamp: number;
+  url: string;
   uris: string[];
   tags: string[];
   metadata: NftMetadata;

src/common/services/mx-communication/models/scam-info.dto.ts

@@ -4,6 +4,7 @@ export interface ScamInfoApi {
 }
 
 export enum ScamInfoTypeApiEnum {
+  none = 'none',
   scam = 'scam',
   potentialScam = 'potentialScam',
 }

src/common/services/mx-communication/mx-communication.module.ts

@@ -10,7 +10,6 @@ import { MxProxyService } from './mx-proxy.service';
 import { MxStatsService } from './mx-stats.service';
 import { SlackReportService } from './slack-report.service';
 import { ConfigService } from '@nestjs/config';
-import { MxExtrasApiService } from './mx-extras-api.service';
 import { ApiConfigService } from 'src/modules/common/api-config/api.config.service';
 
 @Module({
@@ -27,7 +26,6 @@ import { ApiConfigService } from 'src/modules/common/api-config/api.config.servi
     MxIdentityService,
     MxToolsService,
     MxFeedService,
-    MxExtrasApiService,
     SlackReportService,
   ],
   exports: [
@@ -40,7 +38,6 @@ import { ApiConfigService } from 'src/modules/common/api-config/api.config.servi
     MxIdentityService,
     MxToolsService,
     MxFeedService,
-    MxExtrasApiService,
     SlackReportService,
   ],
 })

src/document-db/document-db.service.ts

@@ -1,12 +1,12 @@
 import { PerformanceProfiler } from '@multiversx/sdk-nestjs';
 import { Injectable } from '@nestjs/common';
-import { Nft } from 'src/common';
 import { ScamInfo } from 'src/modules/assets/models/ScamInfo.dto';
 import { MetricsCollector } from 'src/modules/metrics/metrics.collector';
 import { NftScamInfoModel } from 'src/modules/scam/models/nft-scam-info.model';
 import { CollectionTraitSummary } from 'src/modules/nft-traits/models/collection-traits.model';
 import { NftScamInfoRepositoryService } from './repositories/nft-scam.repository';
 import { TraitRepositoryService } from './repositories/traits.repository';
+import { Asset } from 'src/modules/assets/models';
 
 @Injectable()
 export class DocumentDbService {
@@ -73,7 +73,7 @@ export class DocumentDbService {
   }
 
   async saveOrUpdateBulkNftScamInfo(
-    nfts: Nft[],
+    nfts: Asset[],
     version: string,
   ): Promise<void> {
     return await this.execute(

src/document-db/repositories/nft-scam.repository.ts

@@ -6,8 +6,8 @@ import {
   NftScamInfoModel,
   NftScamInfoDocument,
 } from 'src/modules/scam/models/nft-scam-info.model';
-import { Nft } from 'src/common';
 import { ScamInfo } from 'src/modules/assets/models/ScamInfo.dto';
+import { Asset } from 'src/modules/assets/models';
 
 @Injectable()
 export class NftScamInfoRepositoryService extends EntityRepository<NftScamInfoDocument> {
@@ -42,7 +42,7 @@ export class NftScamInfoRepositoryService extends EntityRepository<NftScamInfoDo
   }
 
   async saveOrUpdateBulkNftScamInfo(
-    nfts: Nft[],
+    nfts: Asset[],
     version: string,
   ): Promise<void> {
     if (!nfts || nfts.length === 0) {
@@ -70,7 +70,7 @@ export class NftScamInfoRepositoryService extends EntityRepository<NftScamInfoDo
   }
 
   private async saveOrUpdateBulk(
-    nfts: Nft[],
+    nfts: Asset[],
     scamEngineVersion: string,
   ): Promise<void> {
     const updates: any = nfts.map((nft) => {

src/modules/assets/models/NftTypes.enum.ts

@@ -10,6 +10,7 @@ registerEnumType(NftTypeEnum, {
 });
 
 export enum ScamInfoTypeEnum {
+  none = 'none',
   potentialScam = 'potentialScam',
   scam = 'scam',
 }

src/modules/assets/models/ScamInfo.dto.ts

@@ -1,9 +1,8 @@
 import { ObjectType, Field } from '@nestjs/graphql';
-import { Nft } from 'src/common';
 import { ScamInfoApi } from 'src/common/services/mx-communication/models/scam-info.dto';
 import { elasticDictionary } from 'src/config';
 import { NftScamInfoModel } from 'src/modules/scam/models/nft-scam-info.model';
-import { ScamInfoTypeEnum } from '.';
+import { Asset, ScamInfoTypeEnum } from '.';
 @ObjectType()
 export class ScamInfo {
   @Field(() => ScamInfoTypeEnum, { nullable: true })
@@ -25,7 +24,7 @@ export class ScamInfo {
   }
 
   static areApiAndElasticScamInfoDifferent(
-    nftFromApi: Nft,
+    nftFromApi: Asset,
     nftFromElastic: any,
   ): boolean {
     return (
@@ -37,7 +36,7 @@ export class ScamInfo {
   }
 
   static areApiAndDbScamInfoDifferent(
-    nftFromApi: Nft,
+    nftFromApi: Asset,
     nftFromDb: NftScamInfoModel,
     version: string,
   ): boolean {
@@ -59,4 +58,14 @@ export class ScamInfo {
       (!nftFromDb.type && nftFromElastic?.[elasticDictionary.scamInfo.typeKey])
     );
   }
+
+  static isScam(scamInfo: ScamInfo): boolean {
+    return scamInfo.type !== ScamInfoTypeEnum.none;
+  }
+
+  static none(): ScamInfo {
+    return new ScamInfo({
+      type: ScamInfoTypeEnum.none,
+    });
+  }
 }

src/modules/rabbitmq/blockchain-events/nft-events.module.ts

@@ -6,7 +6,6 @@ import { RevertEventsService } from './revert.events.service';
 import { MxCommunicationModule } from 'src/common';
 import { MinterEventsService } from './minter-events.service';
 import { CommonModule } from 'src/common.module';
-import { CacheModule } from 'src/common/services/caching/caching.module';
 import { RarityUpdaterService } from 'src/crons/elastic.updater/rarity.updater.service';
 import { NsfwUpdaterService } from 'src/crons/elastic.updater/nsfw.updater.service';
 import { FlagNftService } from 'src/modules/admins/flag-nft.service';
@@ -42,6 +41,7 @@ import { OffersModuleGraph } from 'src/modules/offers/offers.module';
 import { AcceptOfferEventHandler } from './handlers/acceptOffer-event.handler';
 import { WithdrawOfferEventHandler } from './handlers/withdrawOffer-event.handler';
 import { UpdateListingEventHandler } from './handlers/updateListing-event.handler';
+import { PluginModule } from 'src/plugins/plugin.module';
 
 @Module({
   imports: [
@@ -54,6 +54,7 @@ import { UpdateListingEventHandler } from './handlers/updateListing-event.handle
     forwardRef(() => MarketplacesModuleGraph),
     forwardRef(() => MxCommunicationModule),
     forwardRef(() => OffersModuleGraph),
+    forwardRef(() => PluginModule),
     UsdPriceModuleGraph,
     NftRarityModuleGraph,
     ScamModule,

src/modules/rabbitmq/elastic-updates/elastic-updates-events.service.ts

@@ -138,7 +138,7 @@ export class ElasticUpdatesEventsService {
   ): Promise<void> {
     await new Promise((resolve) => setTimeout(resolve, 5000));
 
-    let nftsToUpdate: string[] = [];
+    let nftsToUpdate: Asset[] = [];
     let nftsToDelete: string[] = [];
     let collectionTypes: { [key: string]: string } = {};
 
@@ -174,7 +174,7 @@ export class ElasticUpdatesEventsService {
       }
 
       collectionTypes[collection] = nft.type;
-      nftsToUpdate.push(identifier);
+      nftsToUpdate.push(nft);
     }
 
     nftsToUpdate = [...new Set(nftsToUpdate)];
@@ -183,10 +183,7 @@ export class ElasticUpdatesEventsService {
       return this.documentDbService.deleteNftScamInfo(n);
     });
 
-    nftsToUpdate.map(
-      async (collection) =>
-        await this.nftScamInfoService.validateOrUpdateNftScamInfo(collection),
-    );
+    await this.nftScamInfoService.validateOrUpdateNftsScamInfo(nftsToUpdate);
 
     await Promise.all(deletes);
   }

src/modules/scam/collection-scam.service.ts

@@ -1,6 +1,4 @@
 import { Injectable } from '@nestjs/common';
-import { MxApiService } from 'src/common';
-import { MxExtrasApiService } from 'src/common/services/mx-communication/mx-extras-api.service';
 import { CacheEventsPublisherService } from '../rabbitmq/cache-invalidation/cache-invalidation-publisher/change-events-publisher.service';
 import {
   CacheEventTypeEnum,
@@ -10,7 +8,6 @@ import {
 @Injectable()
 export class CollectionScamService {
   constructor(
-    private mxExtrasApiService: MxExtrasApiService,
     private readonly cacheEventsPublisher: CacheEventsPublisherService,
   ) {}
 

src/modules/scam/nft-scam.elastic.service.ts

@@ -1,7 +1,7 @@
 import { Injectable, Logger } from '@nestjs/common';
 import { MxElasticService, Nft } from 'src/common';
 import { elasticDictionary } from 'src/config';
-import { ScamInfoTypeEnum } from '../assets/models';
+import { Asset, ScamInfoTypeEnum } from '../assets/models';
 import { NftScamInfoModel } from './models/nft-scam-info.model';
 import {
   getAllCollectionsFromElasticQuery,
@@ -40,7 +40,7 @@ export class NftScamElasticService {
   }
 
   async setBulkNftScamInfoInElastic(
-    nfts: Nft[],
+    nfts: Asset[],
     clearScamInfoIfEmpty?: boolean,
   ): Promise<void> {
     if (nfts.length > 0) {
@@ -119,7 +119,7 @@ export class NftScamElasticService {
     return collections;
   }
 
-  buildNftScamInfoBulkUpdate(nfts: Nft[], clearScamInfo?: boolean): string[] {
+  buildNftScamInfoBulkUpdate(nfts: Asset[], clearScamInfo?: boolean): string[] {
     let updates: string[] = [];
     for (const nft of nfts) {
       if (nft.scamInfo) {

src/modules/scam/nft-scam.queries.ts

@@ -36,9 +36,7 @@ export const getAllCollectionsFromElasticQuery = (): ElasticQuery => {
     });
 };
 
-export const getAllCollectionNftsFromElasticQuery = (
-  collection: string,
-): ElasticQuery => {
+export const getCollectionNftsQuery = (collection: string): ElasticQuery => {
   return ElasticQuery.create()
     .withMustExistCondition('nonce')
     .withMustCondition(QueryType.Match('token', collection, QueryOperator.AND))