Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 1.8 KB

README.md

File metadata and controls

83 lines (56 loc) · 1.8 KB

reckless-wrapper

A CLN plugin that exposes the reckless shell script functionality as CLN RPC methods.

Source Management

Add Trusted GPG Keys

TODO there needs to be a way to upload/identify GPG pubkey that is trusted. Then when adding source, logic will ensure that GPG signatures are checked on git tags.

List Source Repos

NOTE: advocate that we place this under lightning-cli plugin source list

lightning-cli.sh reckless-source list

{
   "sources": [
      "https://github.com/lightningd/plugins"
   ]
}

Add a source repo with CLN plugin code

NOTE: advocate that we place this under lightning-cli plugin source add

If you're developing a new plugin, you can add it as a source:

lightning-cli.sh reckless-source add https://github.com/userx/some-other-cln-plugin

{
   "sources": [
      "https://github.com/lightningd/plugins",
      "https://github.com/userx/some-other-cln-plugin"
   ]
}

Remove a source repo

NOTE: advocate that we place this under lightning-cli plugin source remove

You can remove the source:

lightning-cli.sh reckless-source remove https://github.com/userx/some-other-cln-plugin

{
   "sources": [
      "https://github.com/lightningd/plugins"
   ]
}

Installing a plugin

TODO adovcate that we move this under lightning-cli plugin install

Just having the source defined is not enough! You have to run the reckless install command before the plugin becomes available.

lightning-cli.sh reckless install bolt12-prism

TODO

Uninstalling a plugin

TODO adovcate that we move this under lightning-cli plugin uninstall

lightning-cli.sh reckless uninstall bolt12-prism

{
   "uninstall_output": [
      "bolt12-prism disabled",
      "bolt12-prism uninstalled successfully."
   ]
}