Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

NFT Schema Docs #7

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

NFT Schema Docs #7

wants to merge 3 commits into from

Conversation

yourbuddyconner
Copy link

@yourbuddyconner yourbuddyconner commented Jul 20, 2023

Added docs for Mirror NFT Data tables

@vercel
Copy link

vercel bot commented Jul 20, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 9, 2023 1:10am

@jeffling
Copy link
Contributor

AWESOME!

Some nits:

  • we're not live on all chains yet, just ethereum and polygon.

  • Would it be too much to condense everything into one page for now? we can split it back out if we need, but I think we can try to push everything into the same page for now.

  • If you have time (I can do this later too) we should probably try to paraphrase a bit more. worried it'll be too obvious that it's simplehash. It's not the end of the world but we don't want people to think we're plagiarizing

  • As the smallest nitpick, column type look better in a code block

@yourbuddyconner yourbuddyconner changed the title [WIP] quick and dirty pass over NFT Schema Docs NFT Schema Docs Aug 9, 2023
@hemaaanth
Copy link
Contributor

We should update with all the chains (not live with many but Jeff mentioned it's trivial to add them when a customer asks for them and it's private beta still anyways).

Few other nits:

  • title to "Enriched NFT Data (private beta)" to be consistent with sidebar name
  • Our schemas should not have metaplex since we're not consuming any Solana data from what I can tell. Can we reference-check these tables here (assumed pulled from Simplehash) with the actual data we have in house? Metaplex is referred to later on as well, we should clear throughout.
  • "Here are the details encapsulated in the Collection Table available within NFT responses and core Collection queries" - what does "core Collection queries" mean?
  • "The Goldsky platform presents detailed, normalized data related to NFTs in the form of the NFT Table. This table consists of the following fields" - we should be clear that this (NFT table) is token metadata
  • On bids - do we now have historical bid activity or is it still only top bid? Believe there might be a data update available here but I'm not 100% sure
  • The documentation also references the Spam Score API except we don't deliver any data through an API, should fix that mention. Overall need a manual read-through to make sure what's said is consistent with what we actually deliver through Mirror.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants