Socks5 proxy support for JsonRpsee
This Request for Proposals is closed, meaning we are not looking for any more proposals on this topic at the moment.
- Status: [Closed](https://github.com/paritytech/jsonrpsee/issues/870
- Proposer: flipchan
Project Description 📄
JsonRpsee is an opensource Rust library used by several para and relay chain client libraries to connect to chains over ws or rpc.
Background story
Tor is a anonymization project that has been active for several years. By utilizing a traffic obfusication protocol to route data, it enables users to anonymize their internet traffic. Several blockchain projects leverage this technology to allow users to connect to nodes over tor, inputting the .onion address of the rpc provider.
By providing a .onion address for a rpc/ws node, we can allow users to have more privacy by masking the origination of the request (the sender's ip address).
Gavin Wood mentioned onion-routing as an important future feature on Decoded 2023:
In february 2023, a small public rpc provider was launched in order to provide .onion rpc endpoints for handful of chains in the ecosystem.
Privhost was later listed on the awesome-substrate list.
In order to connect to a .onion site, a user must pass it's connection through a tor socks5 proxy in order to resolve the .onion domain and connect.
Several ecosystem projects want to add support for connecting to .onion, but are blocked due to JsonRpsee not having support for sock5 proxy.
Third party pr's that are waiting for JsonRpsee to support socks5:
Fedimint #391(Closed)- Uptest #15
On 4th of September of 2022 a pr was created to start the process of adding socks5 support for JsonRpsee.
Noone has had time to fix this issue and implement this feature, therefor this RFP. WsTransportClientBuilder has been refactored, GH issue was closed.
Motivation
- Enable client libraries to connect to .onion rpc nodes.
Ecosystem projects that rely on JsonRpsee
Deliverables 🔩
- Total Estimated Duration: 4 weeks
- Full-time equivalent (FTE): 4 weeks
- Total Costs: 9000 USD(may be changed by the future team)
Milestone 1
Please add additional milestones in the same way:
- Estimated Duration: Duration of milestone 1
- FTE: 4 weeks
- Costs: 9000 USD(may be changed by the future team)
| Number | Deliverable | Specification |
|---|---|---|
| 0a. | License | Apache 2.0 / MIT / Unlicense |
| 0b. | Documentation | Public documentation with implementation guides and sample code |
| 0c. | Testing Guide | Rust Unit tests |
| 0d. | Article | Article explaining how to utilize the socks5 support |
| 1. | Middleware layer | In order to enable socks5 support, several modifications of the WsTransportClientBuilder needs to be implemented, described in issue #1162 |
| 2. | Socks5 support | enable a jsonrpsee client to proxy connections using a socks5 proxy |
Demonstrations
- Connect to a .onion rpc node with jsonrpsee.