-
Notifications
You must be signed in to change notification settings - Fork 114
New readme #1881
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kloaec
wants to merge
3
commits into
wizardsardine:master
Choose a base branch
from
kloaec:new-readme
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
New readme #1881
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,15 +5,15 @@ | |
|
|
||
| # Liana | ||
|
|
||
| *The missing safety net for your bitcoins*. | ||
| *A simple to use bitcoin wallet with advanced security features. Timelocked inheritance, multisig, disaster recovery, miniscript and more.*. | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
| ## About | ||
|
|
||
| Liana is a simple Bitcoin wallet. Like other Bitcoin wallets you have one key which can spend the | ||
| funds in the wallet immediately. Unlike other wallets, Liana lets you in addition specify one key | ||
| Liana is a simple to use, desktop Bitcoin wallet. Like other Bitcoin wallets you have one key which can spend the | ||
| funds in the wallet immediately, or a combination of keys if you prefer multisig. Unlike other wallets, Liana lets you in addition specify one or more keys | ||
| which can only spend the coins after the wallet has been inactive for some time. | ||
|
|
||
| We refer to these as the primary spending path (always accessible) and the recovery path (only | ||
|
|
@@ -27,21 +27,20 @@ Here is an example of a Liana wallet configuration: | |
| (after 1 year and 3 months) | ||
|
|
||
| The lockup period is enforced onchain by the Bitcoin network. This is achieved by leveraging | ||
| timelock capabilities of Bitcoin smart contracts (Script). | ||
| timelock capabilities of Bitcoin smart contracts (Script), with Miniscript. | ||
|
edouardparis marked this conversation as resolved.
Outdated
|
||
|
|
||
| Liana can be used for **trustless inheritance**, **loss protection** or **safer backups**. Visit | ||
| Liana can be used for **trustless inheritance**, **loss protection and disaster recovery**, and generally **safer wallets and backups**. Liana is built for both indiduals and organizations, it is already used to secure thousands of bitcoins. Visit | ||
|
edouardparis marked this conversation as resolved.
Outdated
|
||
| [our website](https://wizardsardine.com/liana) for more information. | ||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| Liana is available on Windows, Mac and Linux. To install and start using it see | ||
| [`doc/USAGE.md`](doc/USAGE.md). A more accessible version of Liana is also available as a web | ||
| application [here](https://lianalite.com/). | ||
| [`doc/USAGE.md`](doc/USAGE.md). A demo of a web | ||
| application is also available [here](https://lianalite.com/). | ||
|
|
||
| If you just want to quickly try out Liana on Bitcoin Signet, see [`doc/TRY.md`](doc/TRY.md). | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. maybe here we can hint user to ask us signet coins on TG? |
||
|
|
||
|
|
||
| ## Hacking on Liana | ||
|
|
||
| Liana is an open source project. It is [hosted at Github](https://github.com/wizardsardine/liana). | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,15 +7,17 @@ Bitcoin Signet, check out [this guide](TRY.md) instead. | |
| ### Installing the software | ||
|
|
||
| The recommended installation method for regular users is to download [an executable software release | ||
| from our website](https://wizardsardine.com/liana/). If you prefer to build the project from source, | ||
| from our website](https://wizardsardine.com/liana/). Liana is simple to use and should be straight-forward by just launching the executable on your computer, and following the in-app instructions. | ||
|
edouardparis marked this conversation as resolved.
Outdated
|
||
|
|
||
| If you prefer to build the project from source, | ||
| see [`BUILD.md`](BUILD.md) instead. | ||
|
|
||
| We recommend you verify the software you downloaded against a PGP signature made by Edouard Paris | ||
| using his key `5B63F3B97699C7EEF3B040B19B7F629A53E77B83`. For now the PGP signatures for the | ||
| binaries downloaded on our website are only available on the [Github release | ||
| page](https://github.com/wizardsardine/liana/releases). Find the `.asc` file in the list | ||
| corresponding to the binary you downloaded. Edouard's key is available elsewhere for cross-checking, | ||
| such as on [his personal website](https://edouard.paris). | ||
| page](https://github.com/wizardsardine/liana/releases). Find the shasums.txt and corresponding `.asc` file in the list | ||
| corresponding to the version you downloaded. Edouard's key is available elsewhere for cross-checking, | ||
| such as on [the Wizardsardine website](https://wizardsardine.com/pgp_security_ed.txt) or [his personal website](https://edouard.paris). | ||
|
|
||
| For Arch users, a `liana-bin` is also available at the [AUR](https://aur.archlinux.org/). You can | ||
| install it using your favourite wrapper (eg `paru -S liana-bin` or `yay -S liana-bin`), or manually: | ||
|
|
@@ -63,14 +65,15 @@ The installer will guide you through a few steps: | |
| - Making sure your backup your descriptor and register it on your signing device | ||
| - Configuring the connection to the Bitcoin network | ||
|
|
||
| Once you've been through these steps, your Liana wallet will open. | ||
| Once you've been through these steps, your Liana wallet will open and be ready to use. | ||
|
|
||
| You might have to wait for Bitcoin Core to perform its initial block download. When using Liana, the | ||
| connection to the Bitcoin network is established by using a full node. This means you are fully | ||
| sovereign: you are not trusting a third party to get your onchain data. This does come with a | ||
| drawback: you have to wait for Bitcoin Core to download and validate the historical block chain. But | ||
| fear not! This is just a one time cost. Also, the full node is pruned so it will not use more than | ||
| connection to the Bitcoin network is established by using a full node (recommended), connecting to an Electrum server you control, or using the Liana Connect service (fastest). This means you can be fully | ||
| sovereign: you are not trusting a third party to get your onchain data if you use your own node. This does come with a | ||
| drawback: you have to wait for Bitcoin Core to download and validate the historical block chain, or to have an Electrum server already set up. But | ||
| fear not! Liana offers you a one click option to install and configure a Bitcoin Core node, pruned so it will not use more than | ||
|
edouardparis marked this conversation as resolved.
Outdated
|
||
| 20GB of disk space. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 30GB |
||
| The Liana Connect option is great to be able to use the wallet right-away, without any syncronization time. It comes at reduced privacy compared to running your own node. | ||
|
edouardparis marked this conversation as resolved.
Outdated
|
||
|
|
||
| #### Using the daemon | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.