Skip to content

vinnyhoward/clonex-subgraph

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LinkedIn


Logo

CloneX Subgraph: Insights Made Easy

View Site · Project · Discord

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. License
  6. Contact
  7. Links

About The Project

Product Name Screen Shot

For a detailed view of the design, visit the Figma project.

The CloneX subgraph indexes blockchain data for the CloneX NFT collection, a collaboration between RTFKT and Takashi Murakami, featuring 20,000 next-gen Avatars. This ambitious project marks the beginning of a comprehensive ecosystem designed for our community. Focused on quality and sophistication, these high-end avatars are meticulously crafted, ready to make their mark in the metaverse.

Built With

The Graph: Utilizing both @graphprotocol/graph-cli and @graphprotocol/graph-ts for creating, building, and deploying subgraphs to interact with blockchain data efficiently.

Google Cloud Storage: Integrated via @google-cloud/storage for scalable and secure object storage.

Sharp: A powerful Node.js module sharp for image processing to manage media within the subgraph.

AssemblyScript: Leveraged for smart contract development, as indicated by the dependency on matchstick-as for testing AssemblyScript mappings.

Docker: Used for local development and testing, facilitating an environment where subgraphs can be deployed and removed with ease.

Node.js: The runtime environment enabling the execution of your project's code, scripts, and dependencies.

(back to top)

Getting Started

To set up this project locally and explore the CloneX subgraph, follow these steps.

Prerequisites

Ensure you have either Node.js or Bun installed on your system to manage project dependencies and run the development server.

  • For Node.js, download and install it from nodejs.org.
  • For Bun, you can install it by running the following in your terminal (visit bun.sh for more details):
curl https://bun.sh/install | bash

Installation

  1. Clone the repository to get a local copy of the project:
git clone hhttps://github.com/vinnyhoward/clonex-subgraph.git
cd clonex-subgraph
  1. Install dependencies using either npm (Node.js) or Bun. Choose the command based on your preference:

Using npm:

npm install

Using Bun:

bun install
  1. Set up your environment variables:

Create a .env file in the root of the project and fill it with your Alchemy API key. You can get an API key by creating an account on alchemy.com.

ALCHEMY_API_KEY=your_api_key_here

Replace your_api_key_here with your actual Alchemy API key.

  1. Compile the subgraph:
npm run codegen
npm run build
  1. Deploy the subgraph to your local node:
npm run create-local
npm run deploy-local
  1. For deploying your subgraph to the hosted service:
npm run deploy --node https://api.studio.thegraph.com/deploy/ clonexsubgraph

Make sure to replace clonexsubgraph with your subgraph name on The Graph's hosted service.

(back to top)

Usage

This subgraph provides comprehensive access to data from the CloneX NFT collection. It is designed for various stakeholders in the NFT space, including developers, data analysts, collectors, and enthusiasts. Here are some of the possible key use cases:

  • Market Analysis: Developers and analysts can leverage the subgraph to extract insights into market trends, such as price movements, popular traits, and sales volume over time. This can help in forecasting future trends and making informed investment decisions.

  • Portfolio Tracking: Collectors and investors can use the subgraph to track the performance of their CloneX holdings. This includes monitoring the value of individual NFTs, historical transaction data, and overall portfolio value against the market.

  • Integration with NFT Platforms: Platforms focusing on NFT analytics, trading, and showcasing can integrate this subgraph to provide enriched content to their users. This includes detailed information about each CloneX NFT, such as its metadata, ownership history, and current market status.

  • Research and Reporting: Academics and market researchers can utilize the subgraph for comprehensive data analysis, contributing to reports, studies, and insights into the NFT market dynamics, specifically focusing on the CloneX collection.

  • Community Engagement: Community managers and content creators can use the subgraph to generate interesting content for social media, forums, and newsletters. This can include highlighting rare finds, significant sales, and trending NFTs within the CloneX collection.

  • Event Tracking: Users can track significant events in the lifecycle of CloneX NFTs, such as minting, sales, transfers, and listings. This is crucial for those looking to capture market momentum or understand the impact of specific events on the NFT market.

  • Custom App Development: With the data available through this subgraph, developers can build custom applications tailored to the needs of the NFT community. This could range from investment tools and advisory services to interactive galleries and virtual exhibitions.

By providing easy access to detailed data on the CloneX collection, this subgraph empowers users to explore, analyze, and innovate in the NFT space. Whether you're developing a new application, analyzing market trends, or simply curious about your NFT portfolio's performance, this subgraph offers the tools you need to dive deep into the CloneX ecosystem. A list of complete example queries you can make can be found here: Queries.md

(back to top)

Roadmap

  • Query token metadata

  • Query sales for the last 30 days

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Vincent Howard - @NiftyDeveloper - [email protected]

Project Link: https://github.com/vinnyhoward/clonex-subgraph

(back to top)

Links

About

📈 A subgraph for the CloneX NFT collection

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published