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

docs: multichain queries #6375

Merged
merged 1 commit into from
Feb 28, 2025
Merged

Conversation

catalyst17
Copy link
Contributor

@catalyst17 catalyst17 commented Feb 28, 2025

[Portal] Feature: Add multichain queries documentation and examples

Notes for the reviewer

This PR introduces comprehensive documentation for multichain query functionality in Insight, including detailed examples, response formats, and best practices.

How to test

  • Review the new multichain queries documentation page
  • Verify the code examples work with the described response formats
  • Check that the sidebar navigation correctly links to the new documentation
  • Confirm the authentication methods and chain ID formats are accurately described

PR-Codex overview

This PR enhances the Insight docs by documenting multichain queries. It updates various documentation files to reflect new features, examples, and response formats related to multichain functionality.

Detailed summary

  • Added Multichain Queries section to the sidebar in sidebar.tsx.
  • Introduced examples for querying multiple chains in page.mdx files.
  • Updated chain ID handling examples in agents-and-llms/page.mdx and llmstxt/page.mdx.
  • Detailed multichain response structure added to documentation.
  • Explained authentication methods for multichain queries.
  • Provided best practices and use cases for multichain queries in multichain-queries/page.mdx.
  • Updated response format details for multichain queries, including metadata and data array structure.
  • Included examples for cross-chain portfolio tracking and activity monitoring.

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


PR-Codex overview

This PR introduces support for multichain queries in the thirdweb Insight API, allowing users to efficiently retrieve data across multiple blockchain networks in a single request. It enhances documentation and examples for querying events, transactions, and token balances across chains.

Detailed summary

  • Added a new entry for Multichain Queries in the sidebar.
  • Updated documentation to include multichain query examples for events and token balances.
  • Revised existing examples to demonstrate querying multiple chains using query parameters.
  • Enhanced metadata for the multichain-queries documentation page.
  • Clarified response formats and best practices for multichain queries.

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

Copy link

vercel bot commented Feb 28, 2025

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

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

@vercel vercel bot temporarily deployed to Preview – thirdweb_playground February 28, 2025 18:26 Inactive
@vercel vercel bot temporarily deployed to Preview – login February 28, 2025 18:26 Inactive
Copy link

changeset-bot bot commented Feb 28, 2025

⚠️ No Changeset found

Latest commit: c3ded8a

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

@vercel vercel bot temporarily deployed to Preview – wallet-ui February 28, 2025 18:26 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www February 28, 2025 18:26 Inactive
@github-actions github-actions bot added the Portal Involves changes to the Portal (docs) codebase. label Feb 28, 2025
Copy link
Contributor Author


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.

@catalyst17 catalyst17 requested review from saminacodes and a team February 28, 2025 18:26
@catalyst17 catalyst17 marked this pull request as ready for review February 28, 2025 18:28
@catalyst17 catalyst17 requested review from a team as code owners February 28, 2025 18:28
Copy link
Contributor

github-actions bot commented Feb 28, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 46.82 KB (0%) 937 ms (0%) 243 ms (+167.75% 🔺) 1.2 s
thirdweb (cjs) 127.18 KB (0%) 2.6 s (0%) 361 ms (+44.85% 🔺) 3 s
thirdweb (minimal + tree-shaking) 5.6 KB (0%) 112 ms (0%) 100 ms (+1265.2% 🔺) 212 ms
thirdweb/chains (tree-shaking) 506 B (0%) 10 ms (0%) 45 ms (+734.58% 🔺) 55 ms
thirdweb/react (minimal + tree-shaking) 19.38 KB (0%) 388 ms (0%) 96 ms (+395.22% 🔺) 483 ms

Copy link

codecov bot commented Feb 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.71%. Comparing base (257d0bd) to head (c3ded8a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6375   +/-   ##
=======================================
  Coverage   54.71%   54.71%           
=======================================
  Files         874      874           
  Lines       54617    54617           
  Branches     3717     3717           
=======================================
  Hits        29885    29885           
  Misses      24637    24637           
  Partials       95       95           
Flag Coverage Δ
packages 54.71% <ø> (ø)

@catalyst17 catalyst17 force-pushed the docs/add-multichain-queries-docs branch from bb83cbe to 3c15111 Compare February 28, 2025 18:36
@vercel vercel bot temporarily deployed to Preview – login February 28, 2025 18:36 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www February 28, 2025 18:36 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground February 28, 2025 18:36 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui February 28, 2025 18:36 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www February 28, 2025 18:36 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui February 28, 2025 18:36 Inactive
@vercel vercel bot temporarily deployed to Preview – login February 28, 2025 18:36 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground February 28, 2025 18:36 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www February 28, 2025 18:40 Inactive
Copy link

graphite-app bot commented Feb 28, 2025

Merge activity

[Portal] Feature: Add multichain queries documentation and examples

## Notes for the reviewer
This PR introduces comprehensive documentation for multichain query functionality in Insight, including detailed examples, response formats, and best practices.

## How to test
- Review the new multichain queries documentation page
- Verify the code examples work with the described response formats
- Check that the sidebar navigation correctly links to the new documentation
- Confirm the authentication methods and chain ID formats are accurately described

---

## PR-Codex overview
This PR enhances the `Insight` docs by documenting multichain queries. It updates various documentation files to reflect new features, examples, and response formats related to multichain functionality.

### Detailed summary
- Added `Multichain Queries` section to the sidebar in `sidebar.tsx`.
- Introduced examples for querying multiple chains in `page.mdx` files.
- Updated chain ID handling examples in `agents-and-llms/page.mdx` and `llmstxt/page.mdx`.
- Detailed multichain response structure added to documentation.
- Explained authentication methods for multichain queries.
- Provided best practices and use cases for multichain queries in `multichain-queries/page.mdx`.
- Updated response format details for multichain queries, including metadata and data array structure.
- Included examples for cross-chain portfolio tracking and activity monitoring.

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

<!-- start pr-codex -->

---

## PR-Codex overview
This PR introduces support for multichain queries in the `thirdweb Insight` API, enhancing the ability to retrieve data across multiple blockchain networks in a single API call.

### Detailed summary
- Added a new entry for "Multichain Queries" in the `sidebar`.
- Updated examples to illustrate querying multiple chains using query parameters.
- Enhanced documentation for multichain queries with examples and best practices.
- Modified response formats to include `chain_ids` and `limit_per_chain` for multichain queries.
- Updated existing examples to reflect multichain capabilities.

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

<!-- end pr-codex -->
@graphite-app graphite-app bot force-pushed the docs/add-multichain-queries-docs branch from e2ae1f1 to c3ded8a Compare February 28, 2025 23:32
@vercel vercel bot temporarily deployed to Preview – wallet-ui February 28, 2025 23:32 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground February 28, 2025 23:32 Inactive
@vercel vercel bot temporarily deployed to Preview – login February 28, 2025 23:32 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www February 28, 2025 23:32 Inactive
@graphite-app graphite-app bot merged commit c3ded8a into main Feb 28, 2025
32 checks passed
@graphite-app graphite-app bot deleted the docs/add-multichain-queries-docs branch February 28, 2025 23:40
@vercel vercel bot temporarily deployed to Production – thirdweb_playground February 28, 2025 23:40 Inactive
@vercel vercel bot temporarily deployed to Production – thirdweb-www February 28, 2025 23:40 Inactive
@vercel vercel bot temporarily deployed to Production – login February 28, 2025 23:40 Inactive
@vercel vercel bot temporarily deployed to Production – wallet-ui February 28, 2025 23:40 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Portal Involves changes to the Portal (docs) codebase.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants