consolidator

A core lightning plugin to automatically consolidate your UTXO's.

• Installation
• Building
• Command documentation
• Important notes
• Options

Installation

For general plugin installation instructions see the plugins repo README.md

Release binaries for

• x86_64-linux
• armv7-linux (Raspberry Pi 32bit)
• aarch64-linux (Raspberry Pi 64bit)

can be found on the release page. If you are unsure about your architecture you can run uname -m.

They require glibc>=2.31, which you can check with ldd --version.

Building

You can build the plugin yourself instead of using the release binaries. First clone the repo:

git clone https://github.com/daywalker90/consolidator.git

Install a recent rust version (rustup is recommended) and cd into the consolidator folder, then:

cargo build --release

After that the binary will be here: target/release/consolidator

Note: Release binaries are built using cross and the optimized profile.

Command documentation

⚠️ All feerates used in this plugin are perkb aka (sat/vbyte)*1000

• consolidate feerate [min_utxos]

Consolidate UTXO's NOW with the given feerate (in perkb). Optionally specify the minimum amount of UTXO's to consolidate with min_utxos (Default: 10). Returns a json object with num_utxos_consolidating, tx and txid

• consolidate-below feerate [min_utxos]

Spawn a background task to check if CLN's blockcount:6 feerate dropped below the given feerate (in perkb) and execute a consolidation once with CLN's blockcount:6 feerate. Optionally specify the minimum amount of UTXO's to consolidate with min_utxos (Default: 10). Feerate is checked every consolidator-interval seconds (Defaults to 3600, aka 1 hour). Returns result:OK if the task was spawned, watch your logs for any problems or status updates

• consolidate-cancel

Cancel the running background task started by consolidate-below

Important notes

• Consolidator only considers UTXO's that are:
• • CONFIRMED
• • NOT RESERVED
• • Greater in value than the fee they would cause (using 70 bytes for input size).
• Consolidator will leave the smallest available UTXO that is greater than CLN's min-emergency-msat value untouched (this is because the withdraw command used by the plugin would just create an extra UTXO for the emergency reserve again)

Options

• consolidator-interval interval_secs
• • Interval the background task from consolidate-below uses to check the feerate. Defaults to 3600 (1 hour)
• consolidator-feemulti
• • Fee multiplier used for the feerate of the actual tx of consolidate-below. Is only applied to the actual tx, not during the feerate check. Use this to adjust your time preference of the consolidation tx confirmation. Keep in mind that CLN likes to naturally overshoot the actual feerate a little. Defaults to 1.1
• consolidator-persist
• • Set this for consolidate-below to be persistent through plugin/node restarts. Default is false