Skip to content

JSON RPC support over socket with OpenRPC docs #75

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 43 commits into
base: master
Choose a base branch
from
Open

JSON RPC support over socket with OpenRPC docs #75

wants to merge 43 commits into from

Conversation

maximevanhees
Copy link

No description provided.

maximevanhees and others added 26 commits April 7, 2025 17:59
@maximevanhees
integrated RPC calls, still a bug: client keeps hanging
95ae127
@maximevanhees
fixed bug where client kept hanging
4c5b668
@maximevanhees
changed fixed ID of RPC calls
829b8a5
@maximevanhees
fix lint issues
b939882
@maximevanhees
fix formatting
257d02a
@maximevanhees
fixed rpc tests
8f7b292
@maximevanhees
fixed rpc_tests formatting
e36aae1
@maximevanhees
removed wrong tests
d80091e
@Mahmoud-Emad
docs: Improve and expand Zinit API documentation
e18f35f 
- Added detailed documentation for the new JSON-RPC API, including
  OpenRPC specification, request/response formats, client example, and
  error codes.
- Updated documentation for the line-based API to clarify its role
  relative to the JSON-RPC API.
- Corrected a link in the main README.md file.
- Expanded the API documentation to include separate sections for the
  line-based protocol and the JSON-RPC API.
@maximevanhees
cargo clippy fixes
899c186
@maximevanhees
fix formatting errors
6043890
@maximevanhees
Merge pull request #74 from threefoldtech/json_rpc_docs
620d8e6 
docs: Improve and expand Zinit API documentation
@maximevanhees
updated openrpc spec + added rpc methods to create/get/delete service…
2435660 
… yaml files
@maximevanhees
fetching rpc specs + create/delete/get service over HTTP proxy works …
3d99e2e 
…(with curl command, not in playground)
@maximevanhees
fix formatting
962d83d
@maximevanhees
separated the http proxy and zinit itself. 2 separate binaries now
c86e96a
@maximevanhees
created zinit client library
8a6acfd
@maximevanhees
implemented missing fuction in zinit-http
fa53489
@maximevanhees
splitted api client and server + restructering plan + removed wrong t…
fe1efb0 
…ests
@maximevanhees
fix formatting
6552000
@maximevanhees
remove legacy protocol; only JSON-RPC support from now on
8227949
@maximevanhees
fixed path handling issue; looking for services only happens in passe…
b07c40e 
…d configuration directory
@maximevanhees
fix formatting
4b33604
@maximevanhees
updated docs + removed old docs
9f16507
@maximevanhees
removed old README.md
2c8e661
@maximevanhees
fix clippy warnings
67faa29
@maximevanhees
Copy link
Author

This pull request contains the following changes:

  • Replaced the protocol over Unix socket to JSON-RPC 2.0.
  • [NEW] zinit-http: a standalone HTTP-proxy that forwards RPC requests over the Unix socket
  • [NEW] zinit-client: client library to abstract the inner workings of Zinit
  • Updated documentation

@maximevanhees
refactoring: manual implementation of json_rpc. Removed legacy protocol
5d4be50
@maximevanhees
removed zinit instance from service-file CRUD operations
0513f62
@maximevanhees
temp save point: implemented RPC server and client struct using jsonr…
1f2f56d 
…psee
@maximevanhees
RPC over Unix socket with reth-ipc crate
30c6877
@maximevanhees
fixed logging + integration of RPC with jsonrpsee crate
dd3c23c
@maximevanhees
fixed bugs + rewritten docs + made zinit proxy available through `zin…
feeb34d 
…it proxy -a <ADDR> command`
@maximevanhees
fixed CORS issue for playground openrpc
12cc9bd
@maximevanhees
fixed issue wrong method for playground openrpc
a0bb600
@maximevanhees
try switching to ubuntu-latest gh runner to fix gh action
ebf2a68
@maximevanhees
try switching to ubuntu-latest gh runner to fix gh action - again
59ffb4c
@maximevanhees
apply cargo fmt
7776184
@maximevanhees
updated zinit-client to reflect new rpc crates
e2e6c80
@maximevanhees
applying cargo formatting
e6ba4d3
@maximevanhees
Copy link
Author

The zinit-http proxy has been removed and is now part of zinit itself. The proxy can be activated by providing the following command:

zinit proxy -a <address:port> to expose the proxy at said endpoint.

Exposing the proxy at e.g. 0.0.0.0:8080 and enabling port-forwarding when running zinit inside a Docker container:

  • First build with docker make
  • Then run with docker run -d -t --device=/dev/kmsg:/dev/kmsg:rw -p 8080:8080 zinit-ubuntu:18.04

Allows to access the OpenRPC spec on https://playground.open-rpc.org by supplying http://localhost:8080. This will automatically call the rpc.discover method and fetch the spec.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@maximevanhees @Mahmoud-Emad