README.md 2.39 KB
Newer Older
1
2
[![GitLab Status](https://gitlab.parity.io/parity/jsonrpsee/badges/master/pipeline.svg)](https://gitlab.parity.io/parity/jsonrpsee/pipelines)

Pierre Krieger's avatar
Pierre Krieger committed
3
4
# jsonrpsee

5
6
JSON-RPC library designed for async/await in Rust.

Pierre Krieger's avatar
Pierre Krieger committed
7
Designed to be the successor to [ParityTech's JSONRPC crate](https://github.com/paritytech/jsonrpc/).
Pierre Krieger's avatar
Pierre Krieger committed
8

9
10
11
Support `WebSocket` and `HTTP` transports for both client and server.

## Sub-projects
12
- [jsonrpsee-http-client](./client/http-client) [![crates.io][http-client-image]][http-client-url]
13
- [jsonrpsee-http-server](./http-server) [![crates.io][http-server-image]][http-server-url]
14
- [jsonrpsee-proc-macros](./proc-macros) [![crates.io][proc-macros-image]][proc-macros-url]
15
- [jsonrpsee-ws-client](./client/ws-client) [![crates.io][ws-client-image]][ws-client-url]
16
- [jsonrpsee-ws-server](./ws-server) [![crates.io][ws-server-image]][ws-server-url]
17
18
19
20
21
22
23
24
25
26
27
28
29
30

[http-client-image]: https://img.shields.io/crates/v/jsonrpsee-http-client.svg
[http-client-url]: https://crates.io/crates/jsonrpsee-http-client
[http-server-image]: https://img.shields.io/crates/v/jsonrpsee-http-server.svg
[http-server-url]: https://crates.io/crates/jsonrpsee-http-server
[proc-macros-url]: https://crates.io/crates/jsonrpsee-proc-macros
[proc-macros-image]: https://img.shields.io/crates/v/jsonrpsee-proc-macros.svg
[ws-client-image]: https://img.shields.io/crates/v/jsonrpsee-ws-client.svg
[ws-client-url]: https://crates.io/crates/jsonrpsee-ws-client
[ws-server-image]: https://img.shields.io/crates/v/jsonrpsee-ws-server.svg
[ws-server-url]: https://crates.io/crates/jsonrpsee-ws-server

## Examples

31
32
33
34
- [HTTP](./examples/examples/http.rs)
- [WebSocket](./examples/examples/ws.rs)
- [WebSocket pubsub](./examples/examples/ws_pubsub_broadcast.rs)
- [API generation with proc macro](./examples/examples/proc_macro.rs)
35
- [Logger](./examples/examples/multi_logger.rs)
36
37
- [CORS server](./examples/examples/cors_server.rs)
- [Core client](./examples/examples/core_client.rs)
38
39
40

## Roadmap

41
See [our tracking milestone](https://github.com/paritytech/jsonrpsee/milestone/2) for the upcoming stable v1.0 release.
42
43
44
45

## Users

If your project uses `jsonrpsee` we would like to know. Please open a pull request and add your project to the list below:
James Wilson's avatar
James Wilson committed
46
- [subxt](https://github.com/paritytech/subxt)
47
48
- [parity bridges common](https://github.com/paritytech/parity-bridges-common)
- [remote externalities](https://github.com/paritytech/substrate/tree/master/utils/frame/remote-externalities)