nik/liana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update TRY.md

Browse Source 
done
This commit is contained in:
Kevin Loaec 2023-09-12 15:17:46 +00:00 committed by GitHub
parent e1451fc2af
commit 02a1839262
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 37 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
doc/TRY.md
View File

@ -6,27 +6,25 @@
This document is a short set of instructions for trying out Liana on Bitcoin signet, a test network using value-less bitcoins. It does not attempt to
give any nuance, details or describe alternative configurations.
This guide will make use Liana as a "hot wallet".
You can also connect your Ledger or SpecterDIY hardware signer, (and maybe by the time you read this guide, Bitbox, Coldcard and Jade - integration is coming soon).
This guide will make use Liana as a "hot wallet", and use the "Liana managed" *bitcoind* option.
You can also connect your Ledger or SpecterDIY hardware signer if you have some at hand (and maybe by the time you read this guide, Bitbox, Coldcard and Jade - integration is coming soon).
If you'd like to try out Liana using emulators of
hardware signing device you can use the [Specter
simulator](https://github.com/cryptoadvance/specter-diy/blob/master/docs/simulator.md) or the
[Ledger "Speculos" emulator](https://github.com/LedgerHQ/speculos).
(emulators of the other hardware signers will work too when we finish their integration)
## Step 0: preparation
### System dependencies
*If you are using Windows or MacOS, you can skip this step.*
*If you are using a somewhat recent Debian/Ubuntu, Arch/Manjaro/Endeavor, NixOS distribution or similar, you can skip this step.*
Here is a list of the system dependencies: the tools and libraries you need to have installed on
your system to follow the guide if you are running Linux.
your system to follow the guide if you are running a Linux that isn't Debian- or Arch- based.
- Debian/Ubuntu: dependencies are handled by the .deb package, you can skip this step
- Arch Linux/Manjaro/Endeavor: The [AUR package](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=liana-bin) handles the dependencies, you can skip this step.
- NixOS: The Liana package handles the dependencies, you can skip this step.
- Other distribution: see the link to projects below to search for the name of your distribution's packages.
- GUI requirements, see the link to projects below to search for the name of your distribution's packages.
- [`fontconfig`](https://www.freedesktop.org/wiki/Software/fontconfig/)
- [Libudev](https://www.freedesktop.org/software/systemd/man/libudev.html)
- Running binaries requires GLIBC >= 2.33 (Ubuntu >= 22.04 or Debian >= 12)
@ -35,12 +33,9 @@ We'll use basic tools which should already be present on your system, such as:
- `shasum`
- `tar`
To download and verify binaries you will also need:
- `curl` (On Debian/Ubuntu `apt install curl`)
To verify binaries you will also need:
- `gpg` (On Debian/Ubuntu `apt install gpg`)
To run the GUI you will need some additional libraries:
### Throwaway folder
You can follow the guide from any folder of your choice. We recommend creating a new dedicated folder you
@ -53,40 +48,28 @@ cd liana_quicktry
```
## Step 1: setup `bitcoind`
## Step 1: Liana installer
Liana needs `bitcoind` to communicate with the Bitcoin network. Minimum supported version is 24.0.1.
```
If it is the first time you start a signet Bitcoin on this machine it will take a few minutes to
synchronize (depends on your connection and hardware of course, but it shouldn't take longer than a
handful of minutes). You can track the progress using the `getblockchaininfo` command. On Linux:
```
./bitcoin-25.0/bin/bitcoin-cli -signet getblockchaininfo
```
**You do not need to wait for full synchronisation before moving on to the next step.**
## Step 2: start Liana
Head to the [release page](https://github.com/wizardsardine/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.zip` if you are on MacOS, `liana-1.0.exe` if you are on Windows, and
`liana-1.0-x86_64-linux-gnu.tar.gz` if you are on Linux.
Get the Liana software for your system on the [Wizardsardine website](https://wizardsardine.com/liana).
A note for **Linux users only**: released binaries may not be working on your system if it is
running a too old glibc. In this case you may have to build from source. See the [short section
about this in the README](../README.md#a-note-on-linux-binaries-and-glibc-version).
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:
For every file available on the website, there is an accompanying `.asc` file with the same
name on our [Github release page](https://github.com/wizardsardine/liana/releases). 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/antoine_poinsot_0xE13FC145CD3F4304.txt). It is recommended
you verify your download against this key.
Example for Linux (replace the signature name with the one corresponding to your download):
```
gpg --keyserver hkps://keys.openpgp.org --receive 590B7292695AFFA5B672CBB2E13FC145CD3F4304
gpg --verify liana_2.0-1_amd64.deb.asc
```
GPG should tell you the signature is valid for Antoine's key.
If all is good, you can run Liana!
At startup, you will have the choice between starting Liana using an existing configuration or to
set up a new one. Choose to install Liana on a new Bitcoin network.
@ -95,7 +78,7 @@ The next screen allows you to either configure a new wallet, participate in the
new wallet (if you are taking part in a multisig for instance), or to recover a wallet from backup.
Choose to create a new wallet.
Choose Bitcoin Signet as network. Now you will need to configure the primary key(s), the recovery
Choose **Bitcoin Signet** as network. Now you will need to configure the primary key(s), the recovery
key(s), and the time delay before the recovery keys become available (in # of blocks). We'll use
only one key for both the primary and recovery paths. We'll derive both keys from a "hot signer", a
HD wallet whose seed is stored on the laptop.
@ -113,24 +96,20 @@ or the simulator of any of them (see the links at the top of this document).
Click on next. If you want to try restoring from wallet backup later on, make sure to backup the
mnemonic as well as the descriptor in the next two screens. Otherwise just make them happy by
ticking the boxes. If you are using a signing device simulator you'll have a step for registering
ticking the boxes. If you are using a signing device or its simulator you'll have a step for registering
the descriptor on it.
You can then decide whether you would like to manage `bitcoind` yourself or let Liana configure
and start/stop it while the GUI is being used:
- If you choose to manage `bitcoind` yourself, the next step will be to configure the connection.
The default should work for what we did in this guide.
- If you choose to let Liana manage `bitcoind`, the next step will search for a `bitcoind`
executable on your computer and start it, using `<Liana data directory>/bitcoind_datadir` as the
data directory and creating a `bitcoin.conf` file therein.
For the purpose of this guide, we will use the simpler option: to let Liana download and managed Bitcoin Core for us. It will get the software on Bitcoincore.org and configure it in Pruned mode with about 20GB of disk usage.
A full Initial Blocks Download (Bitcoin network syncronization, from the beginning of the chain) will take place, as we are using Signet it will be pretty quick.
Click on continue and finalize the installation.
Click on continue until we finalize the installation.
In the case of a Liana-managed `bitcoind`, it will be automatically started the next time you
start Liana for the given network.
## Step 3: have fun
Once synchronized, Liana will open the wallet.
You can generate a receive address in the "Receive" menu. You can get signet coins from the signet
faucet at https://signet.bc-2.jp/.
@ -140,22 +119,30 @@ my own configuration, but it depends on what you configured previously). Then yo
Keep in mind that signet coins have no value!
Signet is a network, so you can send coins to other people on signet, receive from them, etc. Feel free to explore Liana!
## Cleanup
You need to remove:
- The Bitcoin Core archive, binary and data directory
- The Liana binary and data directory
- The Liana binary
- its data directory
For a user Alice the default Liana data directory is:
- /Users/Alice/Library/Application Support/Liana on MacOS
- C:\Users\Alice\AppData\Roaming\Liana on Windows
- /home/Alice/.liana on Linux
Assuming you used the throwaway folder as advised in step 0 and did not use custom `bitcoind` or
Liana data directories you can wipe everything using these commands:
Liana data directories you can wipe everything using these commands on Linux:
```
cd ..
rm -rf liana_quicktry
rm -rf ~/.bitcoin/signet
rm -rf ~/.liana/signet
```
## Tips & Tricks
### Simulating multiple wallets