Skip to content

Document the scripting RPC server protocol #815

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

wrybyte
Copy link
Contributor

@wrybyte wrybyte commented Mar 24, 2025

This PR partially addresses the goals of issue #718.

The document is an outline that aims to thoroughly describe the RPC protocol and how it should be interacted with.

There are some details in the RPC server implementation that may be easy to miss or misunderstand by reading the code on its own.

At the moment this is a rough draft that simply outlines 'what is out there.' It will need to be updated before being complete.

Things that may need to be done:

@OpenSauce04 OpenSauce04 added the documentation Improvements or additions to documentation label Mar 24, 2025
@OpenSauce04 OpenSauce04 force-pushed the docs/scripting-rpc-server branch 2 times, most recently from 556c7e3 to ea6b3e9 Compare April 12, 2025 13:03
@OpenSauce04 OpenSauce04 force-pushed the docs/scripting-rpc-server branch from ea6b3e9 to cc3a76f Compare May 16, 2025 16:15
This document is a rough outline that aims to thoroughly describe the
RPC protocol and how it should be interacted with.

There are some details in the RPC server implementation that may be easy
to miss or misunderstand by reading the code on its own.
@OpenSauce04 OpenSauce04 force-pushed the docs/scripting-rpc-server branch from cc3a76f to 80e8cb1 Compare June 9, 2025 18:52
@PabloMK7
Copy link
Member

@wrybyte any updates on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants