-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update metaquity_nft_provenance_tracker.md
- Loading branch information
Showing
1 changed file
with
36 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,27 @@ | ||
| # NFT PROVENANCE TRACKER SDK | ||
|
|
||
| - **Team Name:** [Metaquity limited](https://www.metaquity.xyz) (Part of Substrate Builders Program) | ||
| - **Payment Address:** 0x26d5BD3B8AC9c38DfA5E2A29EEAC2573f7b0d10b | ||
| - **Payment Address:** Fiat payment (Bank account details will be emailed to [email protected] by [email protected]) | ||
| - **Level:** 2 | ||
|
|
||
| ## Project Overview :page_facing_up: | ||
|
|
||
| We propose to build an NFT Provenance Tracker SDK, a on-chain system capable of tracking and displaying the entire lifecycle of NFTs across multiple parachains in the Polkadot ecosystem. The tracker will collect data like NFT creation, past ownership history, price history, metadata, and locking/unlocking events. The data will be made accessible via SDK. | ||
| We propose to build an NFT Provenance Tracker SDK, an on-chain system capable of tracking and displaying the entire lifecycle of NFTs across multiple parachains in the Polkadot ecosystem. The tracker will collect data like NFT creation, past ownership history, price history, metadata, and locking/unlocking events. The data will be made accessible via SDK. | ||
|
|
||
| ### Project Context | ||
|
|
||
| The rise of NFTs has brought a new level of complexity to asset tracking in the blockchain space. The unique and non-interchangeable nature of NFTs, combined with the ability to fractionalize and trade them across multiple parachains, presents a pressing need for a tool that can track their provenance in a trustless and transparent manner. | ||
|
|
||
| Our research indicates that, while there are some solutions for tracking NFT provenance, none currently offer cross-parachain functionality combined with a on-chain model for scalability. By developing this tool, we can significantly enhance transparency and trust in the Polkadot NFT space, benefiting individual NFT owners, DEXs, parachain operators, and potential asset buyers. | ||
| Our research indicates that, while there are some solutions for tracking NFT provenance, none currently offer cross-parachain functionality combined with an on-chain model for scalability. By developing this tool, we can significantly enhance transparency and trust in the Polkadot NFT space, benefiting individual NFT owners, DEXs, parachain operators, and potential asset buyers. | ||
|
|
||
| ### Project Details | ||
|
|
||
| Architecture: | ||
|  | ||
|
|
||
|  | ||
|
|
||
| A standard asset tracking SDK will be built with the following layers: | ||
| - Blockchain layer: Access to the blockchain data source and crawl through the blocks from genesis block | ||
| A standard asset-tracking SDK will be built with the following layers: | ||
| - Blockchain layer: Access to the blockchain data source and crawl through the blocks from the genesis block | ||
| - Middleware layer: Contains the crawlers through which we can crawl the blockchain and collect information about NFTs and write into the database and index it using elastic search. | ||
| - SDK: This package will have all the necessary functions to fetch details about the NFT asset. | ||
|
|
||
|
|
@@ -34,7 +35,7 @@ Technology stack: | |
|
|
||
| ### Ecosystem Fit | ||
|
|
||
| There are quite a few projects in the Polkadot/Kusama ecosystem which are working with NFTs. And going forward with XCM v4 supporting cross chain transfer of NFT's, we believe tracking and tracing of the entire lifecycle of an NFT will not only be a need but a must have. | ||
| There are quite a few projects in the Polkadot/Kusama ecosystem that are working with NFTs. And going forward with XCM v4 supporting cross-chain transfer of NFT's, we believe tracking and tracing of the entire lifecycle of an NFT will not only be a need but a must have. | ||
|
|
||
| The NFT-Provenance-Tracker SDK built by Metaquity will be a great way for these projects to implement provenance for their projects and will save a lot of time and effort to build this from scratch. | ||
|
|
||
|
|
@@ -88,7 +89,7 @@ Team members GitHub: | |
| ### Overview | ||
|
|
||
| - **Total Estimated Duration:** 2,5 months | ||
| - **Full-Time Equivalent (FTE):** 2 FTE ( full time employees) | ||
| - **Full-Time Equivalent (FTE):** 2 FTE (full-time employees) | ||
| - **Total Costs:** 20,000 USD | ||
|
|
||
| ### Milestone 1 | ||
|
|
@@ -100,13 +101,10 @@ Team members GitHub: | |
|
|
||
| | Number | Deliverable | Specification | | ||
| | -----: | ----------- | ------------- | | ||
| | **0a.** | License | Apache 2.0 / GPLv3 / MIT / Unlicense | | ||
| | **0b.** | Documentation | We will provide both inline documentation of the code and a basic tutorial that run the code, which will show how the new functionality works. | | ||
| | **0c.** | Testing and Testing Guide | Core functions will be fully covered by comprehensive unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | | ||
| | **0d**. | Docker | | | ||
| | **0e**. | Article | | | ||
| | **0a.** | License | Apache 2.0 | | ||
| | **0b.** | Documentation | Architectural documentation of NFT-scanner | | ||
| | 1. | Data model definition | Designing and defining the architectural overview of the data model for this application | | ||
| | 2. | NFT scanner module | This module will scan the blockchain for any NFT related data from the genesis block and invoke indexer module | | ||
| | 2. | NFT scanner module | This module will scan the blockchain for any NFT-related data from the genesis block and invoke the indexer module | | ||
|
|
||
| ### Milestone 2 | ||
|
|
||
|
|
@@ -117,18 +115,34 @@ Team members GitHub: | |
|
|
||
| | Number | Deliverable | Specification | | ||
| | -----: | ----------- | ------------- | | ||
| | **0a.** | License | Apache 2.0 / GPLv3 / MIT / Unlicense | | ||
| | **0b.** | Documentation | We will provide both inline documentation of the code and a basic tutorial that run the code, which will show how the new functionality works. | | ||
| | **0c.** | Testing and Testing Guide | Core functions will be fully covered by comprehensive unit tests to ensure functionality and robustness. In the guide, we will describe how to run these tests. | | ||
| | **0d.** | Docker | | | ||
| | 0e. | Article | | | ||
| | 1. | NFT indexer module | Index all the data that is scanned by the scanner module and pass it to the database layer. | | ||
| | 2. | Design and development of the NFT provenance SDK | A typescript based SDK which consists of API calls to the database to fetch the NFT lifecycle. | | ||
| | 3. | Technical Documentation for the SDK | We will provide a technical doc outlining the process of integrating the SDK to other projects. | | ||
| | **0a.** | License | Apache 2.0 | | ||
| | **0b.** | Documentation | A detailed developer documentation of the SDK (will be in gitbook format) and integration guide for other projects. | | ||
| | 1. | NFT indexer module | Index all the data scanned by the scanner module and pass it to the database layer. | | ||
| | 2. | Design and development of the NFT provenance SDK | A typescript-based SDK which consists of API calls to the database to fetch the NFT lifecycle. | | ||
| | 3. | Technical Documentation for the SDK | We will provide a technical doc outlining integrating the SDK into other projects. | | ||
|
|
||
| ## Future Plans | ||
|
|
||
| - Support the NFTs of Statemint | ||
| - Support wasm based NFTs | ||
| - Adding capabilities for tracking and tracing fractional ownership of NFTs | ||
| - Adding capabilities for tracking locking/unlocking of NFTs | ||
| - | ||
|
|
||
| ## Additional information | ||
|
|
||
| > When you talk about NFTs, do you mean the NFTs pallet, PSP34s, uniques pallet, or EVM-compatible ones? | ||
| We will not be focusing currently on the EVM-compatible ones but stick to more Polkadot ecosystem NFT's which are powered mostly by the Uniques Pallet and going forward the NFT's pallet will be used. So this will be a tool for aggregation for NFTs created through both pallets. | ||
|
|
||
| > Your tech stack mentions Elasticsearch, AWS, and nginx, but none of your deliverables touches those. How will I be able to replicate your results? | ||
| I think there's some confusion related to this point. The deliverables are geared towards building and delivering the individual modules which will eventually be released as an SDK which other projects can integrate. This project will be a proof of concept (PoC) to demonstrate this particular use case and how this can be leveraged by other projects and parachains in the Polkadot ecosystem. Since this will be an SDK, anyone will be able to integrate this within their application. This acts as an enabler for this particular use case for provenance tracking of NFTs and fractional fungible tokens associated with those NFTs. This can extend to not only digital assets but also real-world assets (which is what is the primary focus of Metaquity Network). This grant application is in relation to taking this project to the proof of concept stage. The ancillary tech stack mentioned such as Elasticsearch, AWS, and others shall be implemented when we take this project to the production stage. | ||
|
|
||
| > Indexing NFT-related events seem to be a common indexer task. See, for example, https://github.com/emarai/squid-polkadot-psp34-nft-indexing. Why should we fund another, NFT-only indexer? | ||
| We have envisioned this project as a more generic use case for our larger project and other projects in the ecosystem. PSP34 and especially the ones mentioned in the link is focused on the Astar network but this SDK can be implemented by any parachain using NFTs in some form or the other. More importantly, this is not going to be just an NFT-only indexer module, we can extend this to re-fungible tokens built on top of these NFTs and to track provenance of the entire asset lifecycle, which includes extending this use case to track fractional ownership of assets in the future. | ||
|
|
||
| > Please expand the Ecosystem Fit section to explain who your target audience is and how this project compares to similar, existing ones. | ||
| Our target audience is basically the parachains and projects in the Polkadot ecosystem who are working with NFTs and possibly refungibility of NFT's to fungible tokens and make their lives simpler by providing an open source tool to track the entire lifecycle of their assets. Also upcoming parachains like Metaquity Network (ours) and others can use this to build these provenance use cases which will eventually give rise to more effective collaborations between the DeX's and the parachains. | ||