Initial commit

Author: andrewtoth

.gitignore

@@ -0,0 +1,3 @@
+/target
+/Cargo.lock
+/tests/__pycache__

Cargo.toml

@@ -0,0 +1,30 @@
+[package]
+name = "rust-bcli"
+version = "0.1.0"
+edition = "2021"
+
+[features]
+default = []
+nogetchaininfo = []
+noestimatefees = []
+nogetrawblockbyheight = []
+nogetutxout = []
+nosendrawtransaction = []
+
+
+[dependencies]
+anyhow = "1.0"
+log = "0.4"
+cln-plugin = "0.1.0"
+tokio = { version = "1", features = ["rt-multi-thread"] }
+bitcoin = { version = "0.28.1", features = [ "use-serde" ] }
+bitcoin_hashes = { version = "0.10.0", features = [ "serde" ] }
+bitcoincore-rpc = "0.15.0"
+serde = "1.0.130"
+serde_json = "1.0"
+home = "0.5.3"
+jsonrpc = "0.12.0"
+cfg-if = "1.0.0"
+
+[dev-dependencies]
+tokio-test = "0.4.2"

README.md

@@ -0,0 +1,47 @@
+# Rust BCLI
+
+A CoreLightning bitcoin backend plugin written in rust to replace the built-in 
+bcli.
+
+This plugin implements all five required bitcoin backend methods:
+- `getchaininfo`
+- `estimatefees`
+- `getrawblockbyheight`
+- `getutxout`
+- `sendrawtransaction`
+
+However, unlike bcli they can be compiled out optionally so only a subset will
+be implemented. This allows other plugins which only need to implement one of
+the five required methods to be used in conjunction with this plugin.
+
+For instance, using plugin to perform a different sendrawtransaction 
+implementation to send over tor. Or substitute estimatefees to use mempool.space
+for fee estimation.
+
+## Installation
+
+The following commands build the plugin binary:
+
+```
+git clone https://github.com/andrewtoth/rust-bcli
+cd rust-bcli
+cargo install --path .
+```
+
+The binary will now be at `$HOME/.cargo/bin/rust-bcli`. You can now place this
+binary into the plugins folder, add it to the conf file with
+`plugin=$HOME/.cargo/bin/rust-bcli` (replace `$HOME` with your home directory),
+or add it as a command line option via 
+`lightningd --plugin=$HOME/.cargo/bin/rust-bcli --disable-plugin=bcli`. You must
+also disable bcli with the `--disable-plugin=bcli` command line option or put
+`disable-plugin=bcli` in the conf file.
+
+To remove a specific backend method, install with features specifying which 
+methods to disable. For example, the following command will remove estimatefees
+from the binary installing:
+```
+cargo install --path . --features noestimatefees
+```
+In order to use this binary now, another plugin that only implements
+`estimatefees` must be used.
+