Add rpcclient pkg docs, examples, and tests #5890
Merged
Conversation
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation and test coverage to the rpcclient package. The changes include package-level documentation explaining the RPC client's purpose and usage patterns, godoc comments for all exported types and methods, example tests demonstrating each client method, and unit tests with mock HTTP servers validating all RPC client functionality.
Key Changes:
- Added package documentation (doc.go) with usage examples and API overview
- Added godoc comments to Client type and all exported methods
- Added example tests for all client methods showing typical usage patterns
- Added unit tests with mock JSON-RPC servers for complete method coverage
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
| clients/rpcclient/doc.go | New package documentation describing client creation, API methods, request/response types, and error handling |
| clients/rpcclient/main.go | Added godoc comments to Client type and all exported methods describing their purpose and behavior |
| clients/rpcclient/examples_test.go | New file with example tests demonstrating usage patterns for all client methods |
| clients/rpcclient/main_test.go | New file with unit tests using mock HTTP servers to validate all RPC client methods |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
leighmcculloch
changed the title
urvisavla
reviewed
Jan 9, 2026
urvisavla
approved these changes
Jan 9, 2026
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.
What
Add package-level documentation for clients/rpcclient explaining client creation, available API methods, request/response types, and error handling. Add example tests demonstrating usage patterns for all client methods. Add unit tests with mock HTTP servers for all RPC client methods. Add goc comments to the Client type and all exported methods.
Preview
To view the new docs, visit:
https://pkg.go.dev/github.com/stellar/[email protected]/clients/rpcclient
Why
Docs and examples make the rpcclient package 🎸.
Unit tests will increase confidence in the package and give us some fast failures on breakage.