Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add endpoint for retrieving principal’s NFTs and their metadata #1422

Closed
markmhendrickson opened this issue Nov 8, 2022 · 3 comments
Closed

Comments

@markmhendrickson
Copy link

The wallet team needs an ability to query for a principal's NFTs and their metadata for leather-io/extension#1028.

  • Option 1: New endpoint

    Suggested endpoint path,

    /extended/v1/address/{principal}/nfts

    Response,

    {
      "limit": 1,
      "offset": 0,
      "total": 500,
      "results": [
        {
          "token_uri": "https://pool.friedger.de/nft.json",
          "name": "Friedger Pool",
          "description": "Enjoying the stacking pool.",
          "image_uri": "https://pool.friedger.de/nft.webp",
          "image_canonical_uri": "https://pool.friedger.de/nft.webp",
          "tx_id": "0xef2ac1126e16f46843228b1dk4830e19eb7599129e4jf392cab9e65ae83a45c0",
          "sender_address": "ST399W7Z9WS0GMSNQGJGME5JAENKN56D65VGMGKGA"
        }
      ]
    }
  • Option 2: Add param to return NFT metadata to existing “Non-Fungible Token holdings”

    The Non-Fungible Token holdings endpoint returns NFTs held by a principal. However, it only returns the NFT’s hex and repr. Would be great to have an additional param to request the NFTs’ metadata too.

cc @edu-stx

@blockstack-devops blockstack-devops moved this to Recent issues in API Board Nov 8, 2022
@zone117x
Copy link
Member

zone117x commented Nov 8, 2022

Hey @markmhx! An NFT metadata indexing service has been deemed out-of-scope as a responsibility of the API, and is being implemented as a separate service. See issue #1222

The current WIP code for this service is in this repo: https://github.com/hirosystems/token-metadata-service
As Sarala mentioned, it's not yet production tested or deployed in Hiro infra. However, nothing stops someone else from running the service themselves.

@markmhendrickson
Copy link
Author

Thanks! Is there any sense on when Hiro might get this tested and deployed on its infrastructure?

@saralab saralab moved this from Recent issues to Backlog in API Board Nov 8, 2022
@rafaelcr
Copy link
Collaborator

This is now resolved

@github-project-automation github-project-automation bot moved this from Backlog to Done in API Board Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

3 participants