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

feat(api): add count query parameter #577

Merged
merged 3 commits into from
Sep 25, 2024
Merged

Conversation

PJColombo
Copy link
Member

@PJColombo PJColombo commented Sep 20, 2024

Checklist

  • My change requires a documentation update, and I have done it.
  • I have added tests to cover my changes.
  • I have filled out the description and linked the related issues.

Description

Resolves #573

It adds a new optional query parameter called count that allows consumers to enable item counting in blob, block and transaction getAll procedures.

Motivation and Context (Optional)

Related Issue (Optional)

#572

Screenshots (if appropriate):

Copy link

vercel bot commented Sep 20, 2024

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

Name Status Preview Comments Updated (UTC)
blobscan-staging ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 22, 2024 6:32pm
5 Skipped Deployments
Name Status Preview Comments Updated (UTC)
blobscan-docs ⬜️ Ignored (Inspect) Visit Preview Sep 22, 2024 6:32pm
blobscan-gnosis ⬜️ Ignored (Inspect) Visit Preview Sep 22, 2024 6:32pm
blobscan-holesky ⬜️ Ignored (Inspect) Visit Preview Sep 22, 2024 6:32pm
blobscan-mainnet ⬜️ Ignored (Inspect) Visit Preview Sep 22, 2024 6:32pm
blobscan-sepolia ⬜️ Ignored (Inspect) Visit Preview Sep 22, 2024 6:32pm

Copy link

changeset-bot bot commented Sep 20, 2024

🦋 Changeset detected

Latest commit: 62aa758

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@blobscan/api Minor
@blobscan/rest-api-server Patch
@blobscan/web Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link
Contributor

github-actions bot commented Sep 20, 2024

📦 Next.js Bundle Analysis for @blobscan/web

This analysis was generated by the Next.js Bundle Analysis action. 🤖

⚠️ Global Bundle Size Increased

Page Size (compressed)
global 283.79 KB (🟡 +38.17 KB)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

New Pages Added

The following pages were added to the bundle from the code in this PR:

Page Size (compressed) First Load % of Budget (350 KB)
/block_neighbor 251 B 284.04 KB 81.15%
/stats 347.54 KB 631.33 KB 180.38%

Eight Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load % of Budget (350 KB)
/ 351.83 KB 635.63 KB 181.61% (🟢 -5.00%)
/address/[address] 26.89 KB 310.69 KB 88.77% (🟢 -4.81%)
/blob/[hash] 27.63 KB 311.42 KB 88.98% (🟢 -4.23%)
/blobs 76.33 KB 360.12 KB 102.89% (🟡 +12.43%)
/block/[id] 14.31 KB 298.1 KB 85.17% (🟢 -4.16%)
/blocks 74.03 KB 357.82 KB 102.23% (🟡 +12.42%)
/tx/[hash] 16.31 KB 300.11 KB 85.74% (🟡 +0.88%)
/txs 73.51 KB 357.3 KB 102.09% (🟡 +10.40%)
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored.

Copy link

codecov bot commented Sep 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.37%. Comparing base (bbf5111) to head (62aa758).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #577   +/-   ##
=======================================
  Coverage   89.37%   89.37%           
=======================================
  Files         150      150           
  Lines        9916     9916           
  Branches     1029     1029           
=======================================
  Hits         8862     8862           
  Misses       1054     1054           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@PJColombo PJColombo merged commit dc3afe7 into main Sep 25, 2024
14 checks passed
@PJColombo PJColombo deleted the feat/add-count-query-param branch September 25, 2024 12:29
@github-actions github-actions bot mentioned this pull request Oct 6, 2024
luis-herasme pushed a commit that referenced this pull request Oct 13, 2024
* feat(api): add support for enabling item counting when requesting a list of blobs, blocks, or transactions

* chore: add changeset

* test(api): remove `only` calls
@PJColombo PJColombo restored the feat/add-count-query-param branch October 29, 2024 11:30
@PJColombo PJColombo deleted the feat/add-count-query-param branch October 29, 2024 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Optionally include elements count in REST API endpoints
4 participants