WebSocket API
Open
Nobody has claimed this yet.
area: api
Tom's Wishlist
type: new feature
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 493
- PR merge metrics
- No merged PRs in 30d
Description
Expose all of the current daemon commands via an asynchronous WebSocket API. Essentially this will be almost identical to the current HTTP based JSON-RPC API but over WebSockets where it can be truly asynchronous.
All this already exists in new sdk, so this is just a matter of porting it over to old sdk
- make it so all current commands work over websockets (est. 3 days)
- new events we want
- wallet balance changed
- add an event for
getdownload progress - hub connection changes (connected to a hub, disconnected from a hub)
- new support/tip
- publish is confirmed
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked new-sdk implementation in lbry/service/daemon.py at line 116, then compare it with the old SDK's daemon API. Port the current commands over WebSockets and implement the listed wallet, download, hub, support/tip, and publish events; done means those commands and events work asynchronously over the WebSocket API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100