fix: correct pagination limits for getLedgers and getTransactions in OpenRPC spec#2290
Open
miguelnietoa wants to merge 1 commit intostellar:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR corrects the pagination limit parameter descriptions in the Stellar RPC OpenRPC specification so they match the actual server-enforced defaults and maximums for getLedgers and getTransactions.
Changes:
- Update
getLedgerspaginationlimitdescription to max 200 / default 50. - Update
getTransactionspaginationlimitdescription to max 200 / default 50.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The pagination limit descriptions for
getLedgersandgetTransactionsreference a maximum of10,000, but the actual defaults in https://github.com/stellar/stellar-rpc/blob/1a9a97b3f533f91c509661094e71b269d33b735a/cmd/stellar-rpc/internal/config/options.go are:getEvents: max 10,000, default 100 (correct in docs)getLedgers: max 200, default 50getTransactions: max 200, default 50Confirmed empirically against both testnet (
soroban-testnet.stellar.org) and mainnet (soroban-rpc.mainnet.stellar.gateway.fm) - requesting limit=201 returns "limit must not exceed 200".