Skip to content

Commit

Permalink
Merge #253: Final doc additions
Browse files Browse the repository at this point in the history
c9551ec README: mention the minimum supported Ledger Bitcoin app version (Antoine Poinsot)
75a26a7 README: add a small paragraph on recovery (Antoine Poinsot)
361367a doc: document the download of Liana binaries (Antoine Poinsot)

Pull request description:

  Some additions to the documentation that were missing or depending on other things.

ACKs for top commit:
  darosior:
    ACK c9551ec

Tree-SHA512: c78f952396afd489416936f883bf702e3b0703a20b13e0c48493b04d8fe9b51fc67bc396b8cc26cf061b7430a4cf0716de006858c7cfc894b0cd8a4c9abb0993
  • Loading branch information
darosior committed Dec 18, 2022
2 parents 805c8e1 + c9551ec commit aecb063
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 9 deletions.
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -85,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)! :)
Expand Down Expand Up @@ -119,7 +136,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
Expand Down
19 changes: 14 additions & 5 deletions doc/TRY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

TODO: download and sig verification details

Since you presumably never installed Liana, this will start the installer. Create a new wallet.
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.

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
Expand Down

0 comments on commit aecb063

Please sign in to comment.