From 361367a75a873a94352d44514278f8f70b89fa8d Mon Sep 17 00:00:00 2001 From: Antoine Poinsot Date: Sun, 18 Dec 2022 10:54:20 +0100 Subject: [PATCH 1/3] doc: document the download of Liana binaries --- README.md | 14 ++++++++++++-- doc/TRY.md | 15 ++++++++++++--- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 89e04733..129f5ef9 100644 --- a/README.md +++ b/README.md @@ -40,9 +40,19 @@ your machine yet, you can download it [there](https://bitcoincore.org/en/downloa ### Installing the software The recommended installation method for regular users is to download an executable software release. If you prefer to -build the project from source, see [`doc/BUILD.md`](doc/BUILD.md). +build the project from source, see [`doc/BUILD.md`](doc/BUILD.md) instead. -TODO: instructions for downloading a release and verifying the signatures. +Head to the [release page](https://github.com/revault/liana/releases) and download the right +executable for your platform. If you are not sure what is the "right" executable for your platform, +choose `liana-0.1.exe` if you are on Windows, `liana-0.1.dmg` if you are on MacOS and +`liana-0.1-x86_64-linux-gnu.tar.gz` if you are on Linux. + +For every file available on the release page, there is an accompanying `.asc` file with the same +name. This is a GPG signature made with Antoine Poinsot's key: +`590B7292695AFFA5B672CBB2E13FC145CD3F4304`. This key is available elsewhere for cross-checking, such +as on [his Twitter profile](https://twitter.com/darosior) or his [personal +website](http://download.darosior.ninja/darosior.pub). It is recommended you verify your download +against this key. Releases of Liana are reproducibly built. See [`contrib/reproducible`](contrib/reproducible) for details and instructions if you want to check a release. diff --git a/doc/TRY.md b/doc/TRY.md index ca14b292..5fe667a3 100644 --- a/doc/TRY.md +++ b/doc/TRY.md @@ -125,11 +125,20 @@ Keep the Specter simulator open and move on to the next step. ## Step 3: start Liana -Get the latest Liana software release and start it. +Head to the [release page](https://github.com/revault/liana/releases) and download the right +executable for your platform. If you are not sure what is the "right" executable for your platform, +choose `liana-0.1.exe` if you are on Windows, `liana-0.1.dmg` if you are on MacOS and +`liana-0.1-x86_64-linux-gnu.tar.gz` if you are on Linux. -TODO: download and sig verification details +For every file available on the release page, there is an accompanying `.asc` file with the same +name. This is a GPG signature made with Antoine Poinsot's key: +`590B7292695AFFA5B672CBB2E13FC145CD3F4304`. This key is available elsewhere for cross-checking, such +as on [his Twitter profile](https://twitter.com/darosior) or his [personal +website](http://download.darosior.ninja/darosior.pub). It is recommended you verify your download +against this key. -Since you presumably never installed Liana, this will start the installer. Create a new wallet. +At startup, you will have the choice between using an existing wallet or setting up a new one. Since +you presumably never installed Liana, choose to set up a new one. Choose network Signet. For the primary key we will use the one from the dummy signing device you just started. Do this by simply clicking on the "import" button next to the text input in the Liana installer. For the number of blocks before the recovery key becomes active, you can choose anything valid. Preferably something small to test the case where coins are soon to From 75a26a7f8eb6853c3ab77bb92fd31164d436bf20 Mon Sep 17 00:00:00 2001 From: Antoine Poinsot Date: Sun, 18 Dec 2022 11:10:57 +0100 Subject: [PATCH 2/3] README: add a small paragraph on recovery --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 129f5ef9..386f518d 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,15 @@ already running, it will plug to it and communicate through the JSONRPC API. ### Using the recovery path -TODO: have a longer form document on recovery through the recovery path. +You may sweep the coins whose timelocked recovery path is available. You will need to sign the +transaction using the recovery key, hence make sure to connect the appropriate signing device. + +In the GUI, this option is available in the "Settings" menu at the "Recovery" section. Click on the +"Recover funds" button, enter the destination for the sweep and the feerate you want to use for the +sweep transaction. Then sign it with the recovery key and broadcast it. + +For the daemon, see the [`createrecovery`](doc/API.md#createrecovery) command. It will create a +sweep PSBT to the requested address with the specified feerate, filled with all available coins. ## About the software project From c9551eca00f555bc486dcf3feac5c0184193c961 Mon Sep 17 00:00:00 2001 From: Antoine Poinsot Date: Sun, 18 Dec 2022 11:19:04 +0100 Subject: [PATCH 3/3] README: mention the minimum supported Ledger Bitcoin app version Fixes #203 --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 386f518d..a889a38d 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,14 @@ timelock (the only type of timelocks supported for now), time starts ticking whe payment. That is if you want the recovery path to never be available, each coin must be spent at least once every `N` blocks. (With `N` the configured value of the timelock.) -For now, only the Ledger and Specter DIY signing devices are supported, as Miniscript compatibility of the signer is a must. We expect more signing devices to implement Miniscript capability. We may add the possibility to use Liana as a "hot" wallet in the future (i.e. with a private key directly on the laptop). +For now, only the Ledger and Specter DIY signing devices are supported, as Miniscript compatibility +of the signer is a must. We expect more signing devices to implement Miniscript capability. We may +add the possibility to use Liana as a "hot" wallet in the future (i.e. with a private key directly +on the laptop). + +If you are using a Ledger device, make sure to install the currently latest version of the Bitcoin +application: `2.1.0`. This is the minimum supported version, as it's the first one to introduce +support for Miniscript. If you are using the GUI, it should be intuitive what menu to use depending on your intention. If it is not, bug report are very welcome so [feel free to report it](https://github.com/revault/liana/issues)! :)