Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rpc: Rename WebSocketSubscriptionClient #566

Merged
merged 2 commits into from
Sep 16, 2020
Merged

Conversation

thanethomson
Copy link
Contributor

@thanethomson thanethomson commented Sep 16, 2020

This is a follow-on PR from #516.

To prevent future API breakage when we implement Client for the WebSocket-based client (i.e. all the non-subscription-related RPC calls), I'd recommend we rename WebSocketSubscriptionClient to just WebSocketClient.

Then developers can simply import whichever trait they'd like implemented for the client to get the relevant functionality.

  • Referenced an issue explaining the need for the change
  • Updated all relevant documentation in docs
  • Updated all code comments where relevant
  • Wrote tests
  • Updated CHANGELOG.md

To prevent future API breakage when we implement `Client` for the
WebSocket-based client (i.e. all the non-subscription-related RPC
calls), I'd recommend we rename `WebSocketSubscriptionClient` to just
`WebSocketClient`.

Then developers can simply import whichever trait they'd like
implemented for the client to get the relevant functionality.

Signed-off-by: Thane Thomson <[email protected]>
@thanethomson thanethomson changed the title Rename WebSocketSubscriptionClient rpc: Rename WebSocketSubscriptionClient Sep 16, 2020
@ebuchman ebuchman merged commit 0e63faf into master Sep 16, 2020
@ebuchman ebuchman deleted the rpc/rename-websocket-client branch September 16, 2020 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants