docs: document getSignatureStatuses searchTransactionHistory requirement#59
Open
gamandeepsingh wants to merge 1 commit into
Conversation
getSignatureStatuses only checks historical ClickHouse-backed status data when the request sets searchTransactionHistory: true. Without it, a signature already indexed in the signatures table still returns null, matching mainline Solana JSON-RPC semantics but easy to miss since it wasn't called out in the method list. Fixes solana-rpc#57
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
1 participant
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.
Problem
Calling
getSignatureStatuseswith a real, indexed signature (confirmedpresent in the
signaturestable) returnsnull:{"jsonrpc":"2.0","id":1,"result":{"context":{"slot":...},"value":[null]}}Adding
{"searchTransactionHistory": true}as the second param returnsthe full status correctly.
This matches standard Solana JSON-RPC semantics exactly (mainline
getSignatureStatusesalso requires this flag to look beyond ashort-lived recent-status cache — see
crates/superbank-rpc/src/handlers/signatures.rs, where theClickHouse-backed historical lookup is skipped entirely unless
search_transaction_historyistrue). Not a bug, but it wasn'tobvious from
crates/superbank-rpc/README.md's method list, so a newintegrator coming from a different RPC provider could reasonably
assume a signature known to exist would resolve without the flag.
Fix
Add a line to the notes in
crates/superbank-rpc/README.mdcalling outthe
searchTransactionHistoryrequirement next to the existinggetSignatureStatusesreferences.Fixes #57