Skip to content
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

Delete old python plugin clnrest directory #8068

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ members = [
"cln-grpc",
"plugins",
"plugins/grpc-plugin",
"plugins/cln-rest"
"plugins/rest-plugin"
]
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ ifneq ($(FUZZING),0)
endif
ifneq ($(RUST),0)
include cln-rpc/Makefile
include plugins/cln-rest/Makefile
include plugins/rest-plugin/Makefile
endif
include cln-grpc/Makefile

Expand Down
5 changes: 1 addition & 4 deletions doc/developers-guide/app-development/rest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ updatedAt: "2023-10-13T09:54:01.784Z"

# CLNRest

CLNRest is a lightweight Python-based built-in Core Lightning plugin (from v23.08) that transforms RPC calls into a REST service.
CLNRest is a lightweight Rust-based built-in Core Lightning plugin (from v23.08) that transforms RPC calls into a REST service.
It also broadcasts Core Lightning notifications to listeners connected to its websocket server. By generating REST API endpoints,
it enables the execution of Core Lightning's RPC methods behind the scenes and provides responses in JSON format.

Expand All @@ -35,9 +35,6 @@ An online demo for the REST interface is available at [REST API REFERENCE](ref:g

## Installation

The plugin is built-in with Core Lightning but its python dependencies are not, and must be installed separately.
Detailed installation instructions can be found [here](https://docs.corelightning.org/docs/installation#clnrest).

Note: if you have the older c-lightning-REST plugin, you can configure Core Lightning with `disable-plugin=clnrest`
option to avoid confusion with this one. You can also run both plugins simultaneously till all your applications
are not migrated to `clnrest`.
Expand Down
7 changes: 5 additions & 2 deletions plugins/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,9 @@ endif
# This is non-python plugins (PY_PLUGINS need their whole directory!)
PLUGINS := $(C_PLUGINS)

# Remove clnrest directory if exists which is the old python plugin code
$(shell test -d plugins/clnrest && $(RM) -r plugins/clnrest || true)

ifneq ($(RUST),0)
# Builtin plugins must be in this plugins dir to work when we're executed
# *without* make install.
Expand Down Expand Up @@ -296,11 +299,11 @@ CLN_PLUGIN_EXAMPLES := \

CLN_PLUGIN_SRC = $(shell find plugins/src -name "*.rs")
CLN_GRPC_PLUGIN_SRC = $(shell find plugins/grpc-plugin/src -name "*.rs")
CLNREST_PLUGIN_SRC = $(shell find plugins/cln-rest/src -name "*.rs")
CLN_REST_PLUGIN_SRC = $(shell find plugins/rest-plugin/src -name "*.rs")

target/${RUST_PROFILE}/cln-grpc: ${CLN_PLUGIN_SRC} ${CLN_GRPC_PLUGIN_SRC} $(MSGGEN_GENALL) $(MSGGEN_GEN_ALL)
cargo build ${CARGO_OPTS} --bin cln-grpc
target/${RUST_PROFILE}/clnrest: ${CLNREST_PLUGIN_SRC}
target/${RUST_PROFILE}/clnrest: ${CLN_REST_PLUGIN_SRC}
cargo build ${CARGO_OPTS} --bin clnrest

ifneq ($(RUST),0)
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.