-
Notifications
You must be signed in to change notification settings - Fork 544
docs: add docs on aggregates #7201
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
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
""" WalkthroughNew sections and examples illustrating aggregation queries were added to the Insight API documentation across multiple pages. These additions include categorized aggregation examples, code snippets, preset function listings, and use-case scenarios for blockchain data analysis. No changes were made to application logic, exported entities, or control flow; all modifications are documentation-only. Changes
Sequence Diagram(s)No sequence diagram generated, as the changes are limited to documentation and do not affect control flow or introduce new features. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
♻️ Duplicate comments (3)
apps/portal/src/app/insight/agents-and-llms/llmstxt/page.mdx (3)
56-66
: The Wallet-Specific Aggregations block uses the same incorrect domain. Please update all examples.
71-80
: The Block Data Aggregations snippet also needs the correct Insight API base URL.
85-94
: The Filtering with Aggregations examples should be revised to useinsight.thirdweb.com
.
🧹 Nitpick comments (7)
apps/portal/src/app/insight/use-cases/page.mdx (4)
22-22
: Improve punctuation and markup in table cell
In the "Analyze token economics" row, add a comma after "any token," for clarity. Also, replace embedded<br/>
HTML tags with proper Markdown lists or fenced code blocks inside the table cell to make it more maintainable.🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...print to get transactions involving any token and then aggregate data based on timest...(AI_HYDRA_LEO_MISSING_COMMA)
23-23
: Refine HTML usage in table cell
The "Analyze gas consumption" use case mixes<br/>
tags for line breaks. Consider using Markdown list syntax or a fenced code block for the example aggregations instead of inline HTML.
25-25
: Refactor table cell markup
For the NFT collection tracking use case, avoid<br/>
tags. Use a multiline code fence or Markdown list within the table cell to present the example aggregations clearly.
27-27
: Refactor table cell markup
The multi-chain transactions use case also employs inline HTML<br/>
for structure. Switching to pure Markdown (nested lists or code blocks) will improve readability and consistency.apps/portal/src/app/insight/get-started/page.mdx (1)
149-162
: Well-structured transaction stats example
ThegetTransactionStats
snippet clearly demonstrates fetching aggregated metrics. To avoid runtime URL issues, mention that spaces in query parameters (e.g.,AS avg_gas
) should be URL-encoded (e.g.,%20
) or constructed viaURLSearchParams
.apps/portal/src/app/insight/agents-and-llms/page.mdx (1)
197-205
: Highlight URL encoding for aliases
The basic fetch example correctly showsaggregate=function(field) AS alias
, but in practice query parameters with spaces must be URL-encoded. Consider adding a callout or a sample usingencodeURIComponent
for the alias.apps/portal/src/app/insight/blueprints/page.mdx (1)
113-121
: Review: Inconsistent section title
In the Wallet Transactions Blueprint, the heading reads "### Aggregation Examples" (singular) while other blueprints use "### Aggregations Examples" (plural). Please standardize the section title for consistency across all pages.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
apps/portal/src/app/insight/agents-and-llms/llmstxt/page.mdx
(1 hunks)apps/portal/src/app/insight/agents-and-llms/page.mdx
(1 hunks)apps/portal/src/app/insight/blueprints/page.mdx
(2 hunks)apps/portal/src/app/insight/faqs/page.mdx
(1 hunks)apps/portal/src/app/insight/get-started/page.mdx
(1 hunks)apps/portal/src/app/insight/use-cases/page.mdx
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/portal/src/app/insight/use-cases/page.mdx
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...print to get transactions involving any token and then aggregate data based on timest...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Size
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Build Packages
- GitHub Check: Lint Packages
- GitHub Check: Unit Tests
- GitHub Check: Analyze (javascript)
🔇 Additional comments (13)
apps/portal/src/app/insight/get-started/page.mdx (3)
142-144
: Clear introduction to aggregation presets
The "Using Aggregation Presets" header and description effectively orient users to the new feature and tie into the Insight Playground.
170-182
: Accurate block metrics example
ThegetBlockMetrics
code is consistent with the preceding example and correctly illustrates multiple aggregation parameters.
188-195
: Playground usage instructions are clear
The bullet points under "Explore in the Playground" concisely outline key interactive features.apps/portal/src/app/insight/agents-and-llms/llmstxt/page.mdx (1)
37-40
: The "Aggregation Examples" header and intro text are straightforward and adhere to the existing style.apps/portal/src/app/insight/agents-and-llms/page.mdx (4)
193-196
: The "Aggregations" section header and intro align well with the rest of the page’s style.
217-254
: Preset functions are clearly listed
The grouped lists of default, events-specific, transactions-specific, wallet, and blocks presets comprehensively cover available options, improving discoverability.
255-263
: Common aggregation examples are useful
The snippet illustrating common fetch patterns reinforces earlier concepts and is well aligned with page conventions.
271-278
: Filtering examples align with patterns
The code demonstrates combining filters with aggregates consistently, matching the style of preceding sections.apps/portal/src/app/insight/blueprints/page.mdx (5)
38-63
: Great addition: Events Blueprint aggregation examples
The new "### Aggregations Examples" section under the Events Blueprint clearly demonstrates count, min/max, and custom aggregation use cases with real-world fetch snippets. Examples are accurate, properly formatted, and align with the API surface.
91-99
: Nice: Transactions Blueprint aggregation examples
The "### Aggregations Examples" block for transactions provides concise fetch samples for total transaction count and total value transferred. Endpoint usage and query syntax look correct.
101-107
: Approve: Analyze Gas Usage example
The gas usage snippet (avg and max) is accurate and clearly demonstrates how to query gas metrics.
123-129
: Approve: Wallet summary and fees snippets
These wallet transaction examples correctly illustrate how to fetch total counts, values, and fees for a given address. They align with the API and follow the established pattern.
135-143
: Approve: Blocks Blueprint aggregation examples
The block statistics and metrics examples are clear, with correct endpoints and aggregate functions for block count, transactions, and gas usage. Great job.
size-limit report 📦
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7201 +/- ##
=======================================
Coverage 55.67% 55.67%
=======================================
Files 904 904
Lines 58392 58392
Branches 4118 4118
=======================================
Hits 32510 32510
Misses 25776 25776
Partials 106 106
🚀 New features to boost your workflow:
|
e6ab11b
to
31adf21
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (5)
apps/portal/src/app/insight/page.mdx (1)
4-4
: Import ofFunctionSquareIcon
for new FeatureCard
The addition ofFunctionSquareIcon
aligns with the new “Powerful Aggregations” card. Make sure the SVG icon is accessible (e.g., aria-hidden or aria-label) and matches the design system.apps/portal/src/app/insight/agents-and-llms/page.mdx (4)
197-215
: Code samples for basic, multiple, and filtered aggregations
The examples are clear, but string quoting differs from other snippets that use backticks. Consider standardizing on backticks (```) to allow interpolation and match the rest of the documentation.
233-240
: Transactions-specific aggregation presets
Good coverage of transaction metrics. Consider adding a brief note on when to chooseavg(value)
vs.avg(gas_used)
in analyses.
255-269
: Common Aggregation Examples code snippet
These examples illustrate usage well. To improve consistency, switch the URL strings to backticks and add a short snippet showing how to parse and log the JSON response.
273-285
: Filtering with Aggregations code snippet
Solid demonstration of combining filters and aggregates. Optionally, include a sample JSON response to show the structure of the returned data.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
apps/portal/src/app/insight/agents-and-llms/llmstxt/page.mdx
(1 hunks)apps/portal/src/app/insight/agents-and-llms/page.mdx
(1 hunks)apps/portal/src/app/insight/blueprints/page.mdx
(2 hunks)apps/portal/src/app/insight/faqs/page.mdx
(1 hunks)apps/portal/src/app/insight/get-started/page.mdx
(1 hunks)apps/portal/src/app/insight/page.mdx
(3 hunks)apps/portal/src/app/insight/use-cases/page.mdx
(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- apps/portal/src/app/insight/use-cases/page.mdx
🚧 Files skipped from review as they are similar to previous changes (4)
- apps/portal/src/app/insight/agents-and-llms/llmstxt/page.mdx
- apps/portal/src/app/insight/get-started/page.mdx
- apps/portal/src/app/insight/faqs/page.mdx
- apps/portal/src/app/insight/blueprints/page.mdx
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Size
- GitHub Check: Lint Packages
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Build Packages
- GitHub Check: Unit Tests
- GitHub Check: Analyze (javascript)
🔇 Additional comments (8)
apps/portal/src/app/insight/page.mdx (3)
25-25
: Updated grid layout to three columns on large screens
Moving fromlg:grid-cols-2
tolg:grid-cols-3
ensures the new card fits alongside existing ones. Verify this change across breakpoints (mobile/tablet/desktop) to maintain responsive consistency.
39-44
: Add “Powerful Aggregations” FeatureCard
Excellent callout for the aggregation docs. Please confirm that the target anchor#using-aggregations
exists in the “Get Started” page and that the link flows as expected.
52-56
: Shift “Lightning-Fast Queries” card position
The card has moved to accommodate the new grid. Reviewers should verify that the description still accurately represents the feature and that spacing is consistent with other cards.apps/portal/src/app/insight/agents-and-llms/page.mdx (5)
193-196
: Introduce “### Aggregations” section
Great addition of the aggregation overview. Ensure the heading level matches the surrounding TOC and that it’s included in any generated navigation links.
217-225
: List of Default Aggregation Presets
The default presets are well organized. As a refinement, you might link back to the Playground examples for live testing.
227-232
: Events-specific aggregation presets
Clear listing of event-centric functions. All aliases follow a consistent naming scheme.
242-247
: Wallet Transactions-specific aggregation presets
This block covers key wallet transaction stats. No concerns here.
248-254
: Blocks-specific aggregation presets
The block-level metrics are comprehensive. Confirm thattransaction_count
is documented in the API reference for block responses.
31adf21
to
7eae0e2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
apps/portal/src/app/insight/use-cases/page.mdx (1)
22-22
: Improve clarity and consistency in the sentence.Consider removing the article "the" and adding a comma after "token" for better readability and to align with other entries:
- Use the Transactions Blueprint to get transactions involving any token and then aggregate data based on timestamps to calculate 24-hour transaction volumes. + Use Transactions Blueprint to get transactions involving any token, and then aggregate data based on timestamps to calculate 24-hour transaction volumes.🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...print to get transactions involving any token and then aggregate data based on timest...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
apps/portal/src/app/insight/agents-and-llms/llmstxt/page.mdx
(1 hunks)apps/portal/src/app/insight/agents-and-llms/page.mdx
(1 hunks)apps/portal/src/app/insight/blueprints/page.mdx
(2 hunks)apps/portal/src/app/insight/faqs/page.mdx
(1 hunks)apps/portal/src/app/insight/get-started/page.mdx
(1 hunks)apps/portal/src/app/insight/page.mdx
(3 hunks)apps/portal/src/app/insight/use-cases/page.mdx
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (6)
- apps/portal/src/app/insight/blueprints/page.mdx
- apps/portal/src/app/insight/get-started/page.mdx
- apps/portal/src/app/insight/faqs/page.mdx
- apps/portal/src/app/insight/page.mdx
- apps/portal/src/app/insight/agents-and-llms/llmstxt/page.mdx
- apps/portal/src/app/insight/agents-and-llms/page.mdx
🧰 Additional context used
🪛 LanguageTool
apps/portal/src/app/insight/use-cases/page.mdx
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...print to get transactions involving any token and then aggregate data based on timest...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ 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: Size
- GitHub Check: Build Packages
- GitHub Check: Lint Packages
- GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
apps/portal/src/app/insight/use-cases/page.mdx (3)
23-23
: Verify API field names for gas metrics.The examples using
avg(gas_used)
,max(gas_used)
, andsum(gas_used * gas_price)
are clear. Please confirm thatgas_used
andgas_price
are the exact field names exposed by the Transactions Blueprint and that the multiplication returns a fee in wei as intended.
25-25
: Well-structured NFT aggregation examples.The use of
countDistinct(from_address)
,countDistinct(to_address)
, andcount()
perfectly illustrates unique seller/buyer counts and total transfers. Great clarity.
27-27
: Approve cross-chain transaction aggregations; verify filter syntax.The
count()
andsum(value) AS total_value_transferred
examples neatly demonstrate cross-chain wallet queries. Ensure that the filter parameterchain_ids
correctly reflects the API’s naming (e.g.,chainIds
if camelCase) and supports multi-chain input.
7eae0e2
to
d913fcf
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
apps/portal/src/app/insight/use-cases/page.mdx (3)
22-22
: Add punctuation for readability in transaction aggregation description.Insert a comma before “and then” to improve the sentence flow:
-| Use the Transactions Blueprint to get transactions involving any token and then aggregate data based on timestamps to calculate 24-hour transaction volumes. +| Use the Transactions Blueprint to get transactions involving any token, and then aggregate data based on timestamps to calculate 24-hour transaction volumes.🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...print to get transactions involving any token and then aggregate data based on timest...(AI_HYDRA_LEO_MISSING_COMMA)
23-23
: Maintain consistent article usage for blueprint references.For grammatical consistency, consider prefixing with “the” to match other sections:
- Use Transactions Blueprint to summarize gas usage... + Use the Transactions Blueprint to summarize gas usage...
27-27
: Refine use-case wording and validate schema fields.
- Consider shortening the use-case title to “Fetch cross-chain transactions for a wallet” for brevity.
- Ensure the field
value
insum(value) AS total_value_transferred
correctly maps to the transaction amount in the schema.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
apps/portal/src/app/insight/agents-and-llms/llmstxt/page.mdx
(1 hunks)apps/portal/src/app/insight/agents-and-llms/page.mdx
(1 hunks)apps/portal/src/app/insight/blueprints/page.mdx
(2 hunks)apps/portal/src/app/insight/faqs/page.mdx
(1 hunks)apps/portal/src/app/insight/get-started/page.mdx
(1 hunks)apps/portal/src/app/insight/page.mdx
(3 hunks)apps/portal/src/app/insight/use-cases/page.mdx
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (6)
- apps/portal/src/app/insight/faqs/page.mdx
- apps/portal/src/app/insight/page.mdx
- apps/portal/src/app/insight/blueprints/page.mdx
- apps/portal/src/app/insight/get-started/page.mdx
- apps/portal/src/app/insight/agents-and-llms/llmstxt/page.mdx
- apps/portal/src/app/insight/agents-and-llms/page.mdx
🧰 Additional context used
🪛 LanguageTool
apps/portal/src/app/insight/use-cases/page.mdx
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...print to get transactions involving any token and then aggregate data based on timest...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: Size
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Lint Packages
- GitHub Check: Unit Tests
- GitHub Check: Build Packages
- GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
apps/portal/src/app/insight/use-cases/page.mdx (1)
25-25
: Verify aggregation function names against the API.Confirm that the Insight API uses
countDistinct
(not something likedistinctCount
) for distinct counts. If the function name differs, update these examples to match the actual API.
Merge activity
|
# [Portal] Feature: Add Aggregation Examples and Documentation to Insight ## Notes for the reviewer This PR adds comprehensive documentation for the Insight aggregation functionality across multiple pages: - Added an "Aggregation Examples" section to the LLMs page with code samples - Added detailed aggregation documentation to the Agents and LLMs page - Added aggregation examples to the Blueprints page for Events, Transactions, Wallet Transactions, and Blocks - Added FAQs about aggregation queries - Added "Using Aggregation Presets" section to the Get Started page - Enhanced Use Cases page with example aggregations for relevant scenarios ## How to test Review the documentation for clarity and accuracy. The examples should be consistent with the actual API functionality. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Added comprehensive examples and explanations for using aggregation functions in Insight API queries across multiple documentation sections, including blueprints, use cases, FAQs, and getting started guides. - Introduced new sections detailing aggregation presets, usage patterns, and code snippets for blockchain data analysis. - Enhanced clarity on performing statistical and summary queries, with guidance on leveraging the Insight Playground for interactive exploration. - Updated the Insight landing page with a new feature card highlighting powerful aggregation capabilities and improved layout for feature cards. <!-- end of auto-generated comment: release notes by coderabbit.ai --> <!-- start pr-codex --> --- ## PR-Codex overview This PR enhances the documentation for the `Insight` tool by adding new aggregation features, examples, and updating existing content to clarify how to utilize these functionalities effectively. ### Detailed summary - Added `FunctionSquareIcon` to the import statement in `page.mdx`. - Updated grid layout class from `lg:grid-cols-2` to `lg:grid-cols-3` in `page.mdx`. - Introduced a new `FeatureCard` titled "Powerful Aggregations" in `page.mdx`. - Added sections on aggregation queries and examples in `faqs/page.mdx`, `get-started/page.mdx`, and `agents-and-llms/page.mdx`. - Provided aggregation examples in `use-cases/page.mdx` and `blueprints/page.mdx`. - Enhanced documentation for wallet transactions and blocks, including aggregation examples in `agents-and-llms/page.mdx`. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
d913fcf
to
b345cc1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
apps/portal/src/app/insight/use-cases/page.mdx (2)
22-22
: Add comma for clarity in sentence.The narrative reads “…involving any token and then aggregate…”. Consider adding a comma after “any token” to improve readability:
Use the Transactions Blueprint to get transactions involving any token, and then aggregate data…🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...print to get transactions involving any token and then aggregate data based on timest...(AI_HYDRA_LEO_MISSING_COMMA)
27-27
: Enclose parameter name in backticks for consistency.The narrative mentions
chain_ids
inline. Wrap it in backticks to highlight it as a parameter and confirm the correct key name (chain_id
vschain_ids
):…filter transactions by wallet address across different `chain_id`s…apps/portal/src/app/insight/blueprints/page.mdx (1)
38-63
: Event Blueprint aggregation examples are well structured.The “### Aggregations Examples” section and its three code snippets clearly demonstrate how to fetch event statistics, track collection activity, and run custom aggregations. For consistency with other sections, consider renaming the heading to singular:
- ### Aggregations Examples + ### Aggregation Examples
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
apps/portal/src/app/insight/agents-and-llms/llmstxt/page.mdx
(1 hunks)apps/portal/src/app/insight/agents-and-llms/page.mdx
(1 hunks)apps/portal/src/app/insight/blueprints/page.mdx
(2 hunks)apps/portal/src/app/insight/faqs/page.mdx
(1 hunks)apps/portal/src/app/insight/get-started/page.mdx
(1 hunks)apps/portal/src/app/insight/page.mdx
(3 hunks)apps/portal/src/app/insight/use-cases/page.mdx
(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- apps/portal/src/app/insight/agents-and-llms/llmstxt/page.mdx
🚧 Files skipped from review as they are similar to previous changes (4)
- apps/portal/src/app/insight/faqs/page.mdx
- apps/portal/src/app/insight/get-started/page.mdx
- apps/portal/src/app/insight/agents-and-llms/page.mdx
- apps/portal/src/app/insight/page.mdx
🧰 Additional context used
🪛 LanguageTool
apps/portal/src/app/insight/use-cases/page.mdx
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...print to get transactions involving any token and then aggregate data based on timest...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: Unit Tests
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Build Packages
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Size
- GitHub Check: Lint Packages
- GitHub Check: Analyze (javascript)
🔇 Additional comments (5)
apps/portal/src/app/insight/use-cases/page.mdx (2)
23-23
: Gas consumption use case addition looks good.The example aggregation details for analyzing gas usage are clear and well formatted. No concerns here.
25-25
: NFT collection movement example is clear.The new row with aggregation snippets for tracking an NFT collection’s transfers is concise and properly formatted.
apps/portal/src/app/insight/blueprints/page.mdx (3)
91-107
: Transactions Blueprint aggregation examples are correct.The snippets for total transaction count, total value, and gas usage follow a consistent pattern and accurately illustrate aggregation queries.
113-129
: Wallet Transactions Blueprint examples are accurate.The “Get Wallet Summary” and “Calculate Total Fees Paid” code blocks correctly show how to filter by wallet and aggregate transaction data.
137-151
: Blocks Blueprint aggregation examples are accurate.The snippets for fetching block statistics and analyzing block metrics use clear labels and consistent query syntax.
[Portal] Feature: Add Aggregation Examples and Documentation to Insight
Notes for the reviewer
This PR adds comprehensive documentation for the Insight aggregation functionality across multiple pages:
How to test
Review the documentation for clarity and accuracy. The examples should be consistent with the actual API functionality.
Summary by CodeRabbit
PR-Codex overview
This PR introduces new aggregation features and examples to enhance the documentation of the
Insight
tool, including the addition of a new icon and updates to existing content regarding aggregation queries.Detailed summary
FunctionSquareIcon
to the imports inpage.mdx
.faqs/page.mdx
with examples.get-started/page.mdx
.agents-and-llms/llmstxt/page.mdx
.use-cases/page.mdx
to include aggregation examples.blueprints/page.mdx
for events and transactions.agents-and-llms/page.mdx
for various scenarios.