Skip to content

token owners endpoint in insight playground #7184

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

Merged

Conversation

iuwqyir
Copy link
Contributor

@iuwqyir iuwqyir commented May 28, 2025

[Dashboard] Feature: Update Token and NFT API Endpoints

Notes for the reviewer

This PR adds a new token endpoint and updates the name of an existing NFT endpoint:

  1. Added a new endpoint for getting token owners by contract: /v1/tokens/owners
  2. Renamed the "Get NFTs by owner" endpoint to simply "Get NFTs" to better reflect its functionality

How to test

Verify the updated endpoint names appear correctly in the Insight section of the playground.

Summary by CodeRabbit

  • New Features

    • Added a new API endpoint for retrieving token owners by contract.
  • Refactor

    • Renamed the "Get NFTs by owner" endpoint to "Get NFTs" for improved clarity.

PR-Codex overview

This PR focuses on updating the insightBlueprints in the insightBlueprints.ts file by adding a new API endpoint for retrieving token owners and renaming an existing endpoint for NFTs.

Detailed summary

  • Added a new API endpoint:
    • Name: Get token owners by contract
    • Path: /v1/tokens/owners
    • Deprecated: false
  • Renamed existing API endpoint:
    • From: Get NFTs by owner
    • To: Get NFTs
    • Path remains: /v1/nfts
    • Deprecated: false

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

vercel bot commented May 28, 2025

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

Name Status Preview Comments Updated (UTC)
thirdweb_playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 28, 2025 11:28pm
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Skipped (Inspect) May 28, 2025 11:28pm
login ⬜️ Skipped (Inspect) May 28, 2025 11:28pm
thirdweb-www ⬜️ Skipped (Inspect) May 28, 2025 11:28pm
wallet-ui ⬜️ Skipped (Inspect) May 28, 2025 11:28pm

@vercel vercel bot temporarily deployed to Preview – docs-v2 May 28, 2025 10:39 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 28, 2025 10:39 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www May 28, 2025 10:39 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 28, 2025 10:39 Inactive
Copy link

changeset-bot bot commented May 28, 2025

⚠️ No Changeset found

Latest commit: 2fc083f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented May 28, 2025

Walkthrough

This change updates the insightBlueprints configuration by adding a new API endpoint for retrieving token owners under the "Tokens" blueprint and renames an existing endpoint in the "Nfts" blueprint from "Get NFTs by owner" to "Get NFTs". No other endpoints or properties are modified.

Changes

File Change Summary
apps/playground-web/src/app/insight/insightBlueprints.ts Added "Get token owners by contract" endpoint under "Tokens"; renamed "Get NFTs by owner" to "Get NFTs" in "Nfts".

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant InsightBlueprints

    User->>InsightBlueprints: Request list of available endpoints
    InsightBlueprints-->>User: Return endpoints including new "Get token owners by contract" and updated "Get NFTs"
Loading

Possibly related PRs

  • new tokens route #7170: Both PRs modify the insightBlueprints object in insightBlueprints.ts by adding new API endpoint entries under the "Tokens" blueprint, indicating related changes to the API route definitions for tokens.

Suggested reviewers

  • joaquim-verges
  • jnsdls
  • catalyst17
  • MananTank

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d0e26a8 and 2fc083f.

📒 Files selected for processing (1)
  • apps/playground-web/src/app/insight/insightBlueprints.ts (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • apps/playground-web/src/app/insight/insightBlueprints.ts
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: E2E Tests (pnpm, esbuild)
  • GitHub Check: E2E Tests (pnpm, webpack)
  • GitHub Check: Unit Tests
  • GitHub Check: E2E Tests (pnpm, vite)
  • GitHub Check: Lint Packages
  • GitHub Check: Size
  • GitHub Check: Build Packages
  • GitHub Check: Analyze (javascript)
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor Author

iuwqyir commented May 28, 2025


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions github-actions bot added the Playground Changes involving the Playground codebase. label May 28, 2025
@iuwqyir iuwqyir marked this pull request as ready for review May 28, 2025 10:39
@iuwqyir iuwqyir requested review from a team as code owners May 28, 2025 10:39
Copy link

codecov bot commented May 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.68%. Comparing base (75ae536) to head (2fc083f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7184   +/-   ##
=======================================
  Coverage   55.68%   55.68%           
=======================================
  Files         904      904           
  Lines       58404    58404           
  Branches     4126     4126           
=======================================
  Hits        32522    32522           
  Misses      25776    25776           
  Partials      106      106           
Flag Coverage Δ
packages 55.68% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

github-actions bot commented May 28, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 61.7 KB (0%) 1.3 s (0%) 187 ms (+151.97% 🔺) 1.5 s
thirdweb (cjs) 344.53 KB (0%) 6.9 s (0%) 840 ms (+37.03% 🔺) 7.8 s
thirdweb (minimal + tree-shaking) 5.69 KB (0%) 114 ms (0%) 52 ms (+892.78% 🔺) 166 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 27 ms (+1458.92% 🔺) 38 ms
thirdweb/react (minimal + tree-shaking) 19.54 KB (0%) 391 ms (0%) 70 ms (+457.81% 🔺) 460 ms

Copy link
Contributor

graphite-app bot commented May 28, 2025

Merge activity

@iuwqyir iuwqyir added the merge-queue Adds the pull request to Graphite's merge queue. label May 28, 2025 — with Graphite App
## [Dashboard] Feature: Update Token and NFT API Endpoints

## Notes for the reviewer

This PR adds a new token endpoint and updates the name of an existing NFT endpoint:

1. Added a new endpoint for getting token owners by contract: `/v1/tokens/owners`
2. Renamed the "Get NFTs by owner" endpoint to simply "Get NFTs" to better reflect its functionality

## How to test

Verify the updated endpoint names appear correctly in the Insight section of the playground.

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

## Summary by CodeRabbit

- **New Features**
  - Added a new API endpoint for retrieving token owners by contract.

- **Refactor**
  - Renamed the "Get NFTs by owner" endpoint to "Get NFTs" for improved clarity.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
@graphite-app graphite-app bot force-pushed the 05-28-token_owners_endpoint_in_insight_playground branch from d0e26a8 to 2fc083f Compare May 28, 2025 23:26
@vercel vercel bot temporarily deployed to Preview – login May 28, 2025 23:26 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 28, 2025 23:26 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www May 28, 2025 23:26 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 28, 2025 23:26 Inactive
@graphite-app graphite-app bot merged commit 2fc083f into main May 28, 2025
23 checks passed
@graphite-app graphite-app bot deleted the 05-28-token_owners_endpoint_in_insight_playground branch May 28, 2025 23:30
@vercel vercel bot temporarily deployed to Production – wallet-ui May 28, 2025 23:30 Inactive
@vercel vercel bot temporarily deployed to Production – login May 28, 2025 23:30 Inactive
@vercel vercel bot temporarily deployed to Production – docs-v2 May 28, 2025 23:30 Inactive
@vercel vercel bot temporarily deployed to Production – thirdweb-www May 28, 2025 23:30 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-queue Adds the pull request to Graphite's merge queue. Playground Changes involving the Playground codebase.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants