Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/multiversx/mx-nft-service
Unified GraphQL for providing information regarding nfts in MultiversX Blockchain and indexing auctions on different marketplaces
https://github.com/multiversx/mx-nft-service
blockchain graphql nft
Last synced: 16 days ago
JSON representation
Unified GraphQL for providing information regarding nfts in MultiversX Blockchain and indexing auctions on different marketplaces
- Host: GitHub
- URL: https://github.com/multiversx/mx-nft-service
- Owner: multiversx
- License: gpl-3.0
- Created: 2021-03-30T11:17:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T12:37:19.000Z (26 days ago)
- Last Synced: 2024-10-18T11:56:06.215Z (24 days ago)
- Topics: blockchain, graphql, nft
- Language: TypeScript
- Homepage:
- Size: 8.13 MB
- Stars: 14
- Watchers: 18
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-multiversx-dev-resources - NFT service - GraphQl service to provide information regarding NFTs and auctions on MultiversX Blockchain (MultiversX official / Dev dApps)
README
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](https://nodejs.org/en/)
1. Redis Server is required to be installed [docs](https://redis.io/).
1. MySQL Server is required to be installed [docs](https://dev.mysql.com/doc/refman/8.0/en/installing.html).
1. MongoDB Server is required to be installed [docs](https://www.mongodb.com/docs/manual/installation).
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](http://localhost:3005/graphql).
## Running the app
1. At the root folder run (make sure you have node v16.x.x)
```bash
$ npm install
```
2. Create .env file from .env.example (all flags are disabled by default)
3. Start the app
```bash
# 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.multiversx.com/sdk-and-tools/proxy/](https://docs.multiversx.com/sdk-and-tools/proxy/)
- index:
- to gather information regarding nft history
- docs: [https://docs.multiversx.com/sdk-and-tools/elastic-search/)
- api:
- to get information regarding nfts and collections
- docs: [https://docs.multiversx.com/sdk-and-tools/rest-api/multiversx-api/](https://docs.multiversx.com/sdk-and-tools/rest-api/multiversx-api/)
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