rpc refactor

[majestrate]

current rpc code is horrible

we want to:

• redefine rpc endpoints
• make endpoint documented and add tooling to auto generate docs for api.oxen.io
• define what the new interfaces from the endpoint layer will need to expose for rpc

[majestrate]

right now the RPC has to:

• add/remove/list exits
• get internal state dump
• get brief status overview
• get daemon version
• various plainquic related functions
• stop the daemon (right now it can be done from an unprivileged scope, this needs to be fixed)
• manipulate config and save it to disk

[majestrate]

open issues to inform how the new behavior would want to change:

https://github.com/oxen-io/lokinet/issues/2114

[majestrate]

we have one unprivileged category llarp which should be deprecated.

we want to define 2 new ones, a privileged category and an unprivileged category.

[majestrate]

easy endpoints to redo from old rpc:

• get daemon version / status
• get brief status
• dump debug info
• stop daemon

new rpc feature idea list:

• lookup ONS names (routing layer/dht)
• do a lookup for a .loki manually and return the introset (routing layer/dht)
• flush local ONS cache (flow layer)
• flush lokinet's internal dns cache (dns subsystem)
• list/add/swap/remove lokinet's selected edges (link layer)
• list/add/remove bootstrap nodes (nodedb/config)
• list/add/remove snode RCs from nodedb (nodedb)
• list all existing flows (flow layer)
• get info on an existing flow (flow layer)
• set path number, hop count, etc on existing flows (flow layer)
• remove existing flows (flow layer)
• list ip allocation map (endpoint layer)
• map/unmap ip allocations (endpoint layer)
• list/add/swap/remove exit node mappings (endpoint layer)

[majestrate]

first step would be to make the easy endpoints as a way to set up documentation generation in the build system to generate markdown for api.oxen.io

[majestrate]

the gui uses the llarp.get_status endpoint so that is a good first endpoint to create as the output is already defined and needs to be backward compatible.

[majestrate]

llarp.get_status is a very simple endpoint that introduces the concept of calling in the mainloop and using oxenmq's deferred calling.

[majestrate]

ideally we want all our new code in here to have a new category namespacing with proper permissions. this means anything in the llarp category will have to be some kind of "alias" for new handlers in the new rpc categories. (not an actual alias in the implementation but from the perspective of the user it would look like one)

[majestrate]

clarification:

generating documentation would be done by taking comments in the code from the build system and making cmake spit out markdown files.