feat: Fetch and add the utility property (#375)

* feat: Fetch and add the utility property

* fix: Remove double quotes

.env.defaults

@@ -1,5 +1,6 @@
 CORS_ORIGIN=^http:\/\/localhost:[0-9]{1,10}$
 CORS_METHOD=*
+BUILDER_SERVER_URL=https://builder-api.decentraland.org
 MARKETPLACE_SUBGRAPH_URL=https://api.thegraph.com/subgraphs/name/decentraland/marketplace
 COLLECTIONS_SUBGRAPH_URL=https://api.thegraph.com/subgraphs/name/decentraland/collections-matic-mainnet
 RENTALS_SUBGRAPH_URL=https://api.thegraph.com/subgraphs/name/decentraland/rentals-ethereum-mainnet

.env.spec

@@ -1,5 +1,6 @@
 CORS_ORIGIN=*
 CORS_METHOD=*
+BUILDER_SERVER_URL=https://builder-api.decentraland.org
 MARKETPLACE_SUBGRAPH_URL=https://api.thegraph.com/subgraphs/name/decentraland/marketplace
 COLLECTIONS_SUBGRAPH_URL=https://api.thegraph.com/subgraphs/name/decentraland/collections-matic-mainnet
 RENTALS_SUBGRAPH_URL=https://api.thegraph.com/subgraphs/name/decentraland/rentals-ethereum-mainnet

package.json

@@ -26,7 +26,7 @@
     "printWidth": 80
   },
   "dependencies": {
-    "@dcl/schemas": "^11.4.0",
+    "@dcl/schemas": "^11.7.0",
     "@well-known-components/env-config-provider": "^1.2.0",
     "@well-known-components/http-requests-logger-component": "^2.1.0",
     "@well-known-components/http-server": "^1.1.6",

src/index.ts

@@ -170,6 +170,7 @@ import { createOwnersComponent } from './ports/owner/component'
 import { createFavoritesComponent } from './ports/favorites/components'
 import { ItemOptions } from './ports/items/types'
 import { createCatalogComponent } from './ports/catalog/component'
+import { createBuilderComponent } from './ports/builder'
 
 async function initComponents(): Promise<AppComponents> {
   // Default config
@@ -231,6 +232,13 @@ async function initComponents(): Promise<AppComponents> {
   const marketplaceChainId = getMarketplaceChainId()
   const collectionsChainId = getCollectionsChainId()
 
+  // Builder component
+  const builder = createBuilderComponent({
+    url: await config.requireString('BUILDER_SERVER_URL'),
+    logs,
+    fetcher: fetch,
+  })
+
   // subgraphs
   const marketplaceSubgraph = await createSubgraphComponent(
     { logs, config, fetch, metrics },
@@ -375,6 +383,7 @@ async function initComponents(): Promise<AppComponents> {
   })
 
   const collectionsNFTs = createNFTComponent({
+    builder,
     subgraph: collectionsSubgraph,
     fragmentName: 'collectionsFragment',
     getFragment: getCollectionsFragment,
@@ -446,7 +455,7 @@ async function initComponents(): Promise<AppComponents> {
   )
 
   // items
-  const collectionsItems = createItemsComponent([
+  const collectionsItems = createItemsComponent({ builder }, [
     {
       subgraph: collectionsSubgraph,
       network: Network.MATIC,
@@ -732,6 +741,7 @@ async function initComponents(): Promise<AppComponents> {
 
   return {
     config,
+    builder,
     logs,
     server,
     statusChecks,

src/ports/builder/component.ts

@@ -0,0 +1,42 @@
+import { URL } from 'url'
+import {
+  IFetchComponent,
+  ILoggerComponent,
+} from '@well-known-components/interfaces'
+import { IBuilderComponent } from './types'
+
+export function createBuilderComponent(options: {
+  url: string
+  logs: ILoggerComponent
+  fetcher: IFetchComponent
+}): IBuilderComponent {
+  const { fetcher, url, logs } = options
+  const logger = logs.getLogger('builder-component')
+
+  return {
+    async getItemUtility(
+      collectionAddress: string,
+      itemId: string
+    ): Promise<string | undefined> {
+      try {
+        const baseUrl = new URL(url)
+        baseUrl.pathname = `/v1/published-collections/${collectionAddress}/items/${itemId}/utility`
+        const response = await fetcher.fetch(baseUrl.toString())
+        if (!response.ok) {
+          throw new Error(
+            `Failed to fetch utility for item: ${response.status}`
+          )
+        }
+        const utility = (await response.json()) as {
+          data: { utility: string | null }
+        }
+        return utility.data.utility ?? undefined
+      } catch (_e) {
+        logger.info(
+          `Failed looking for the utility of the item: ${collectionAddress} - ${itemId}.`
+        )
+        return undefined
+      }
+    },
+  }
+}

src/ports/builder/index.ts

@@ -0,0 +1,2 @@
+export * from './component'
+export * from './types'

src/ports/builder/types.ts

@@ -0,0 +1,6 @@
+export interface IBuilderComponent {
+  getItemUtility(
+    collectionAddress: string,
+    itemId: string
+  ): Promise<string | undefined>
+}

src/ports/items/component.ts

@@ -1,20 +1,22 @@
 import { ChainId, ItemFilters, Network } from '@dcl/schemas'
 import { ISubgraphComponent } from '@well-known-components/thegraph-component'
-import { AssetsNetworks } from '../../types'
+import { AppComponents, AssetsNetworks } from '../../types'
 import { IItemsComponent, ItemFragment } from './types'
 import { fromItemFragment, getItemsQuery, getSubgraph } from './utils'
 
 export function createItemsComponent(
+  components: Pick<AppComponents, 'builder'>,
   options: {
     subgraph: ISubgraphComponent
     network: AssetsNetworks
     chainId: ChainId
   }[]
 ): IItemsComponent {
+  const { builder } = components
+
   async function fetch(filters: ItemFilters) {
     const option = getSubgraph(filters, options)
     if (!option) return []
-
     const { subgraph, network, chainId } = option
 
     if (filters.network && filters.network !== network) {
@@ -25,13 +27,25 @@ export function createItemsComponent(
     const { items: fragments } = await subgraph.query<{
       items: ItemFragment[]
     }>(query)
+
+    const isFetchingASingleItem =
+      filters.contractAddresses?.length === 1 && filters.itemId
+
     const items = fragments.map((fragment) =>
       fromItemFragment(
         fragment,
         network as Network.ETHEREUM | Network.MATIC,
         chainId
       )
     )
+
+    if (items.length > 0 && isFetchingASingleItem) {
+      items[0].utility = await builder.getItemUtility(
+        items[0].contractAddress,
+        items[0].itemId
+      )
+    }
+
     return items
   }
 

src/ports/items/index.ts

@@ -0,0 +1,2 @@
+export * from './component'
+export * from './types'

src/ports/nfts/component.ts

@@ -3,6 +3,12 @@ import { PoolClient } from 'pg'
 import { NFTCategory, NFTFilters, NFTSortBy } from '@dcl/schemas'
 import { IPgComponent } from '@well-known-components/pg-component'
 import { ISubgraphComponent } from '@well-known-components/thegraph-component'
+import { getMarketplaceChainId } from '../../logic/chainIds'
+import {
+  getLatestSubgraphSchema,
+  getMarketplaceSubgraphNameChain,
+} from '../../subgraphUtils'
+import { IBuilderComponent } from '../builder'
 import { INFTsComponent, NFTResult } from './types'
 import {
   getByTokenIdQuery,
@@ -11,14 +17,10 @@ import {
   getFuzzySearchQueryForENS,
   getQueryVariables,
 } from './utils'
-import { getMarketplaceChainId } from '../../logic/chainIds'
-import {
-  getLatestSubgraphSchema,
-  getMarketplaceSubgraphNameChain,
-} from '../../subgraphUtils'
 
 export function createNFTComponent<T extends { id: string }>(options: {
   subgraph: ISubgraphComponent
+  builder?: IBuilderComponent
   db?: IPgComponent
   listsServer?: string
   fragmentName: string
@@ -31,6 +33,7 @@ export function createNFTComponent<T extends { id: string }>(options: {
 }): INFTsComponent {
   const {
     subgraph,
+    builder,
     db,
     fragmentName,
     getFragment,
@@ -163,7 +166,14 @@ export function createNFTComponent<T extends { id: string }>(options: {
     if (fragments.length === 0) {
       return null
     } else {
-      return fromFragment(fragments[0], caller)
+      const nftResult = fromFragment(fragments[0], caller)
+      if (builder && nftResult.nft.itemId) {
+        nftResult.nft.utility = await builder.getItemUtility(
+          contractAddress,
+          nftResult.nft.itemId
+        )
+      }
+      return nftResult
     }
   }
 

src/tests/components.ts

@@ -149,6 +149,7 @@ import {
 import { createOwnersComponent } from '../ports/owner/component'
 import { createFavoritesComponent } from '../ports/favorites/components'
 import { createCatalogComponent } from '../ports/catalog/component'
+import { createBuilderComponent } from '../ports/builder'
 
 // start TCP port for listeners
 let lastUsedPort = 19000 + parseInt(process.env.JEST_WORKER_ID || '1') * 1000
@@ -375,14 +376,27 @@ export async function initComponents(): Promise<AppComponents> {
     MARKETPLACE_FAVORITES_SERVER_URL
   )
 
+  // Builder component
+  const BUILDER_SERVER_URL = await config.requireString('BUILDER_SERVER_URL')
+  const builder = createBuilderComponent({
+    fetcher: fetchComponent,
+    logs,
+    url: BUILDER_SERVER_URL,
+  })
+
   // items
-  const collectionsItems = createItemsComponent([
+  const collectionsItems = createItemsComponent(
     {
-      subgraph: collectionsSubgraph,
-      network: Network.MATIC,
-      chainId: collectionsChainId,
+      builder,
     },
-  ])
+    [
+      {
+        subgraph: collectionsSubgraph,
+        network: Network.MATIC,
+        chainId: collectionsChainId,
+      },
+    ]
+  )
 
   const items = createMergerComponent<Item, ItemFilters, ItemSortBy>({
     sources: [
@@ -579,7 +593,7 @@ export async function initComponents(): Promise<AppComponents> {
   const marketplacePrices = createPricesComponent({
     subgraph: marketplaceSubgraph,
     queryGetter: getMarketplacePricesQuery,
-    customValidation: getMarketplacePriceFiltersValidation
+    customValidation: getMarketplacePriceFiltersValidation,
   })
 
   const collectionsPrices = createPricesComponent({
@@ -625,6 +639,7 @@ export async function initComponents(): Promise<AppComponents> {
   return {
     config,
     logs,
+    builder,
     tracer,
     server,
     statusChecks,