feat: add cursor pagination to sc events #2351
Conversation
|
Vercel deployment URL: https://stacks-blockchain-1xeisooxq-hirosystems.vercel.app 🚀 |
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
|
@ASuciuX thanks for giving a shot at this pr. With this cursor based approach, will it be possible to got from event 1 (the first one that happened) to the last one? My use case would be to index all the events from the start to a specific block. |
|
Yes, with the cursor you can iterate forward from the very first event to the latest, page by page. It’s designed so you can start at genesis and stop at any specific block height. |
|
Amazing, looking forward to be able to use this approach 🙏 |
| // Validate cursor format if provided | ||
| if (cursor && !cursor.match(/^\d+-\d+-\d+$/)) { | ||
| throw new InvalidRequestError( | ||
| 'Invalid cursor format. Expected format: blockHeight-txIndex-eventIndex', |
There was a problem hiding this comment.
Instead of a block height, the cursor should use the index block hash so it is resistent to re-orgs. If you look at Matt's approach to cursors in the other endpoints, he uses this approach and also tests with different re-org scenarios.
This will change your queries a bit but you'll just need to transform from the index block hash into the block height before using your current filters.
[wip] to add prev_cursor
Fixes #2349 by adding cursor-based pagination for events. This provides stable iteration through results, unlike offset-based pagination where responses can shift as new events are added.