fix: defensive RPC response handling#2546
Open
al-munazzim wants to merge 1 commit intocryptoadvance:masterfrom
Open
fix: defensive RPC response handling#2546al-munazzim wants to merge 1 commit intocryptoadvance:masterfrom
al-munazzim wants to merge 1 commit intocryptoadvance:masterfrom
Conversation
Handle non-standard JSON-RPC responses that cause KeyError: - Error field as string instead of dict (e.g. from proxies) - Error dict missing 'message' key - Response missing 'result' key entirely - Single dict response instead of batch array Fixes cryptoadvance#2506
✅ Deploy Preview for specter-desktop-docs canceled.
|
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.
Problem
Fixes #2506. When Bitcoin Core (or an RPC proxy) returns a non-standard JSON-RPC response, the current error handling in
BitcoinRPC.__getattr__can crash withKeyError:r['error']['message']assumeserroris always a dict with amessagekeyr['result']assumes the response always contains aresultkeymulti()[0]assumes the response is always a listRoot Cause
The JSON-RPC spec says
errorshould be an object withcodeandmessage, but in practice:erroras a plain stringmessagefieldresultentirelyFix
__getattr__/fn(): Check iferroris a dict before accessing.get('message'); fall back tostr(error). Also check for missingresultkey explicitly.multi(): Wrap single-dict responses in a list so[0]indexing always works.Testing
Verified manually with mocked responses covering all 4 edge cases: