From 858e0042ab29d8d8ddce12c9425b29e7123d8002 Mon Sep 17 00:00:00 2001 From: b0xxer Date: Sat, 20 Jan 2024 08:27:00 -0600 Subject: [PATCH] Update docs/liquid-part1.md --- docs/liquid-part1.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/liquid-part1.md b/docs/liquid-part1.md index 59d878f..748597e 100644 --- a/docs/liquid-part1.md +++ b/docs/liquid-part1.md @@ -59,4 +59,30 @@ These new opcodes have several use cases, including double-spent protection bond ### Installation of Elements Node and Peg-In +Liquid uses a variation of BTC Core program known as Elements, much of the setup and use are very similar to bitcoin. Please note that Elements **requires a fully functioning bitcoind daemon is available** (it is a sidechain, after all). Thus for this demonstration, I am using my Umbrel since it makes installing Bitcoin and Elements quite simple. + +*If you are intending to run Liquid on a bare-metal setup, please refer to this [getting started guide](https://elementsproject.org/elements-code-tutorial/working-environment) to setup your environment* + +### Running Elements on Umbrel +* Install Bitcoin 'App' +* Install Elements 'App' +* ssh into umbrel and install the elements-cli programs [^1] + - `ssh umbrel.local` + - `$ wget https://github.com/ElementsProject/elements/releases/download/elements-23.2.1/elements-23.2.1-x86_64-linux-gnu.tar.gz` + - `$ tar xf elements-23.2.1-x86_64-linux-gnu.tar.gz` + - `$ ln -s elements-23.2.1-x86_64 elements` +* Navigate to Elements 'App' web interface on Umbrel and copy `rpcuser` and `rpcpassword` values + - `$ export E_RPCUSER=elements` + - `$ export E_RPCPASS=XXXXXXXXXXXXXXXXXXXXXXX` +* You should now be able to issue commands against the elements daemon + - `$ /elements/bin/elements-cli -rpcuser=$E_RPCUSER -rpcpassword=$E_RPCPASS getblockcount` + - `25846` + +... Go take a break, it needs to download approx 20GB ... + + +Footnotes: +[^1]: It may be possible to run the `elements-cli` command without installing it separately, however I could not find it in the container. Anyway, the download of elements node is quite small and it communicates via localport on Umbrel, so this works fine. + +