-
Notifications
You must be signed in to change notification settings - Fork 117
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: cursor-based pagination on blocks endpoint #2060
Conversation
Vercel deployment URL: https://stacks-blockchain-q866qi2h7-hirosystems.vercel.app 🚀 |
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
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.
LGTM!
## [8.0.0-beta.6](v8.0.0-beta.5...v8.0.0-beta.6) (2024-08-27) ### ⚠ BREAKING CHANGES * refactor from express to fastify (#2045) ### Features * cursor-based pagination on blocks endpoint ([#2060](#2060)) ([bfdcce1](bfdcce1)) * export events tsv directly to postgres instance ([#2048](#2048)) ([f401a0f](f401a0f)) * export events tsv directly to postgres instance ([#2048](#2048)) ([#2058](#2058)) ([a1f5b12](a1f5b12)) * refactor from express to fastify ([#2045](#2045)) ([bd65fcf](bd65fcf)), closes [#2042](#2042) ### Bug Fixes * index on `principal_stx_txs` table for faster `/v1/address/{addr}/transactions` lookups ([#2059](#2059)) ([ab64ab7](ab64ab7))
🎉 This PR is included in version 8.0.0-beta.6 🎉 The release is available on: Your semantic-release bot 📦🚀 |
## [8.0.0](v7.14.1...v8.0.0) (2024-08-28) ### ⚠ BREAKING CHANGES * refactor from express to fastify (#2045) * refactor from Express to Fastify ### Features * cursor-based pagination on blocks endpoint ([#2060](#2060)) ([bfdcce1](bfdcce1)) * export events tsv directly to postgres instance ([#2048](#2048)) ([f401a0f](f401a0f)) * refactor from Express to Fastify ([aa0e51e](aa0e51e)), closes [#2042](#2042) * refactor from express to fastify ([#2045](#2045)) ([bd65fcf](bd65fcf)), closes [#2042](#2042) ### Bug Fixes * missing event limit max overrides on a few endpoints ([4f70930](4f70930)) * pagination and query param parsing bugs ([a382d2b](a382d2b)), closes [#2042](#2042) * perform status endpoint sql inside transactions ([b23445c](b23445c)) * tx event-limit default should be 100 ([32d0670](32d0670))
🎉 This PR is included in version 8.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Closes #2043
Supports a new
cursor
query param. Theoffset
param continues to work but with a max page limit. Page random-access is possible when using both together.This approach is generalizable and should work with other listing endpoints like transactions in future PRs.
Example usage:
GET /extended/v2/blocks?limit=3
GET /extended/v2/blocks?limit=3&cursor=0x0000000000000000000000000000000000000000000000000000000000000011
GET /extended/v2/blocks?limit=3&cursor=0x0000000000000000000000000000000000000000000000000000000000000011&offset=2
GET /extended/v2/blocks?limit=3&cursor=0x0000000000000000000000000000000000000000000000000000000000000008&offset=-2