JesCR/nft-service

Unified GraphQL for providing information regarding nfts in MultiversX Blockchain and indexing auctions on different marketplaces

GraphQl service to provide informations regarding nfts and auctions on MultiversX Blockchain

Dependencies

1. Node.js > @16.x.x is required to be installed docs
2. Redis Server is required to be installed docs.
3. MySQL Server is required to be installed docs.
4. MongoDB Server is required to be installed docs.

You can use docker-compose up in a separate terminal to use a local docker container for all these dependencies.

After running the sample, you can stop the Docker container with docker-compose down

Available Scripts

This is an MultiversX project built on Nest.js framework.

npm run start:prod

Runs the app in the production mode. Make requests to http://localhost:3005/graphql.

Running the app

1. At the root folder run (make sure you have node v16.x.x)

$ npm install

2. Create .env file from .env.example (all flags are disabled by default)

3. Start the app

# development debug mode
$ npm run start:debug
# development mode
$ npm run start:dev
# production mode
$ npm run start:prod

It depends on the following external systems:

• gateway:
  • interaction with the indexed marketplace
  • docs: https://docs.elrond.com/sdk-and-tools/proxy/
• index:
  • to gather information regarding nft history
  • docs: https://docs.elrond.com/sdk-and-tools/elastic-search/
• api:
  • to get information regarding nfts and collections
  • docs: https://docs.elrond.com/sdk-and-tools/rest-api/api-elrond-com It uses on the following internal systems:
• redis: used to cache various data, for performance purposes
• rabbitmq: pub/sub for sending mainly NFT process information

A service instance can be started with the following behavior:

• public API: provides graphQL queries for the consumers
• private API: used to report prometheus metrics & health checks
• rabbitMq: used to report prometheus metrics & health checks
• claimable auctions: update status for auctions in db for auctions that reached deadline
• cache warmer: used to proactively fetch data & pushes it to cache, to improve performance & scalability
• cache invalidation - uses rabbitMq to invalidate cache an multiple instances
• elastic updater: used to attach various extra information to items in the elasticsearch, for not having to fetch associated data from other external systems when performing listing requests
• multiple cronjobs: update data in elastic service for nsfw, rarity, traits, scam

It depends on the following optional external systems:

• events notifier rabbitmq: queue that pushes logs & events which are handled internally e.g. to trigger auctions indexing
• data: provides eGLD price information for transactions
• ipfs: ipfs gateway for uploading nft media and metadata
• AWS S3: used to upload nft media for faster performance

It uses the following optional internal systems:

• mysql database: used to store mainly auction information
• mongo database: used to store mainly NFT traits information