add `liana` support #708

plebhash · 2024-06-16T13:43:15Z

Liana is a simple Bitcoin wallet with built-in loss protection and inheritance.

Current status: draft.

Roadmap:

pkgs/liana/default.nix builds lianad + liana-cli
WIP modules/liana.nix + module integration tests (example)

storopoli · 2024-06-16T21:12:36Z

modules/liana.nix

+      default = "wsh(or_d(pk([0dd8c6f0/48'/1'/0'/2']tpubDFMbZ7U5k5hEfsttnZTKMmwrGMHnqUGxhShsvBjHimXBpmAp5KmxpyGsLx2toCaQgYq5TipBLhTUtA2pRSB9b14m5KwSohTDoCHkk1EnqtZ/<0;1>/*),and_v(v:pkh([d4ab66f1/48'/1'/0'/2']tpubDEXYN145WM4rVKtcWpySBYiVQ229pmrnyAGJT14BBh2QJr7ABJswchDicZfFaauLyXhDad1nCoCZQEwAW87JPotP93ykC9WJvoASnBjYBxW/<0;1>/*),older(65535))))#7nvn6ssc";
+      description = mdDoc "The wallet descriptor.";


Isn't it better to move these hardcoded defaults to example instead of default.
I can see easily an user shooting himself in the foot.

ideally this should come from options.services.lianad.*, and it definitely makes sense to remove this default value, but with the tradeoff that options.services.lianad.main_descriptor must become a mandatory option.

unfortunately lianad's CLI is still very limited, so everything needs to be written indo a config.toml, and lianad will not start unless there is a valid descriptor inside config.toml

so the challenge here is:

declare all options from this sample lianad_config_example.toml as options.services.lianad.* inside modules/liana.nix so they're available as systemd configurations (which seems to be the most common pattern across nix-bitcoin modules)

make sure these configurations are taken from options.services.lianad.* and used to generate a config.toml on the module's output (ideally placed somewhere like /var/lib/lianad)

I started doing a heredoc inside the preStart but still unsure whether that is the best approach. It feels a bit dirty tbh.

Also, while the variables are still hardcoded on the heredoc, the idea is to take their actual values from options.services.lianad.*. There heredoc includes some comments. But again: heredoc might not be the best approach.

Yes but still in a footgun for the user.
Check my comment below on how to interpolate TOML file contents into a string.

not really, this is a proposal to mitigate the footgun

the user MUST provide a options.services.lianad.main_descriptor on their configuration.nix, which in turn is used to dynamically generate a config.toml file on disk of the output's datadir

failing to do so blocks the module from ever launching a systemd service, because there's no valid config.toml in disk

the heredoc is still hardcoding things, but hopefully something along these lines will be a viable approach:

cat << EOF > lianad_config.toml # these should come from options.services.lianad - daemon = false - data_dir = "/var/lib/lianad" - log_level = "debug" - main_descriptor = "wsh(or_d(pk([0dd8c6f0/48'/1'/0'/2']tpubDFMbZ7U5k5hEfsttnZTKMmwrGMHnqUGxhShsvBjHimXBpmAp5KmxpyGsLx2toCaQgYq5TipBLhTUtA2pRSB9b14m5KwSohTDoCHkk1EnqtZ/<0;1>/*),and_v(v:pkh([d4ab66f1/48'/1'/0'/2']tpubDEXYN145WM4rVKtcWpySBYiVQ229pmrnyAGJT14BBh2QJr7ABJswchDicZfFaauLyXhDad1nCoCZQEwAW87JPotP93ykC9WJvoASnBjYBxW/<0;1>/*),older(65535))))#7nvn6ssc" + daemon = ${options.services.lianad.daemon} + data_dir = "${options.services.lianad.data_dir}" + log_level = "${options.services.lianad.log_level}" + main_descriptor = "${options.services.lianad.main_descriptor}"

I'll give it a try at some time later.

storopoli · 2024-06-17T11:36:26Z

modules/liana.nix

+      preStart = ''
+        cat << EOF > lianad_config.toml
+# these should come from options.services.lianad
+daemon = false
+data_dir = "/var/lib/lianad"
+log_level = "debug"
+main_descriptor = "wsh(or_d(pk([0dd8c6f0/48'/1'/0'/2']tpubDFMbZ7U5k5hEfsttnZTKMmwrGMHnqUGxhShsvBjHimXBpmAp5KmxpyGsLx2toCaQgYq5TipBLhTUtA2pRSB9b14m5KwSohTDoCHkk1EnqtZ/<0;1>/*),and_v(v:pkh([d4ab66f1/48'/1'/0'/2']tpubDEXYN145WM4rVKtcWpySBYiVQ229pmrnyAGJT14BBh2QJr7ABJswchDicZfFaauLyXhDad1nCoCZQEwAW87JPotP93ykC9WJvoASnBjYBxW/<0;1>/*),older(65535))))#7nvn6ssc"
+
+# these should come from options.services.lianad
+[bitcoin_config]
+network = "signet"
+poll_interval_secs = 30
+
+# these should come from options.services.bitcoind
+[bitcoind_config]
+addr = "127.0.0.1:38332"
+auth = "username:password"
+
+EOF
+        '';


This could be a builtins.fromTOML follwed by a toString, e.g.:

let tomlFile =./example.toml; tomlData = builtins.readFile tomlFile; tomlObj = builtins.fromTOML tomlData; tomlString = toString tomlObj; in tomlString

Then you can interpolate the hardcoded nastiness with options.services.lianad.*

Refs:

https://nix.dev/manual/nix/2.22/language/builtins.html#builtins-fromTOML

https://nix.dev/manual/nix/2.22/language/builtins.html#builtins-readFile

https://nix.dev/manual/nix/2.22/language/builtins.html#builtins-toString

will this allow me to dynamically generate the TOML file and write it into the output's datadir?

it seems like a convenient tool for reading configs that already exist on disk, but our use case is the opposite direction:

we need to generate a TOML file with values coming from options.services.lianad.*, because lianad only launches with a valid config.toml coming from disk

You can generate a static toml file from a set using pkgs.formats.toml. E.g:

mySet = { foo = "bar""; }; myTomlFile = (pkgs.formats.toml {}).generate mySet;

But this of course cannot contain secrets such as bitcoind credentials that are not going into the nix store. So then the preStart rule could execute a command that reads the generated TOML, and appends the additional secrets, writing it to the dataDir for liana.

The lnd module actually already does this:

preStart = '' install -m600 ${configFile} '${cfg.dataDir}/lnd.conf' { echo "bitcoind.rpcpass=$(cat ${secretsDir}/bitcoin-rpcpassword-${rpcUser})" ${optionalString (cfg.getPublicAddressCmd != "") '' echo "externalip=$(${cfg.getPublicAddressCmd})" ''} } >> '${cfg.dataDir}/lnd.conf'

storopoli · 2024-06-17T11:37:19Z

modules/liana.nix

+      default = "wsh(or_d(pk([0dd8c6f0/48'/1'/0'/2']tpubDFMbZ7U5k5hEfsttnZTKMmwrGMHnqUGxhShsvBjHimXBpmAp5KmxpyGsLx2toCaQgYq5TipBLhTUtA2pRSB9b14m5KwSohTDoCHkk1EnqtZ/<0;1>/*),and_v(v:pkh([d4ab66f1/48'/1'/0'/2']tpubDEXYN145WM4rVKtcWpySBYiVQ229pmrnyAGJT14BBh2QJr7ABJswchDicZfFaauLyXhDad1nCoCZQEwAW87JPotP93ykC9WJvoASnBjYBxW/<0;1>/*),older(65535))))#7nvn6ssc";
+      description = mdDoc "The wallet descriptor.";


Yes but still in a footgun for the user.
Check my comment below on how to interpolate TOML file contents into a string.

0xB10C · 2024-06-18T22:09:16Z

Would upstreaming this into nixpkgs make sense? There are a bunch of Bitcoin related packages and services in nixpkgs already.

dunxen · 2024-06-19T07:04:00Z

Would upstreaming this into nixpkgs make sense? There are a bunch of Bitcoin related packages and services in nixpkgs already.

I already maintain the liana package in nixpkgs. https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/li/liana/package.nix

plebhash · 2024-06-21T22:02:05Z

Would upstreaming this into nixpkgs make sense? There are a bunch of Bitcoin related packages and services in nixpkgs already.

I already maintain the liana package in nixpkgs. https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/li/liana/package.nix

that's awesome @dunxen thanks for sharing!

I actually went for different tradeoffs on the liana/default.nix currently living on this PR

nix-bitcoin is usually headless, so liana-cli + lianad are a 1st class citizen on the approach here

are you open to PRs expanding nixpkgs/tree/master/pkgs/by-name/liana/package.nix to include those two binaries + config file? that way, nix-bitcoin could simply consume nixpkgs

dunxen · 2024-06-23T21:15:53Z

are you open to PRs expanding nixpkgs/tree/master/pkgs/by-name/liana/package.nix to include those two binaries + config file? that way, nix-bitcoin could simply consume nixpkgs

Sure, thanks! It would be one package definition but with attributes to choose what to build. So I'd imagine that if you install lianad then it would result in the lianad and liana-cli binaries, else if you do liana then it is the GUI (only?).

Kind of how bitcoin does it in nixpkgs:

https://github.com/NixOS/nixpkgs/blob/a71e967ef3694799d0c418c98332f7ff4cc5f6af/pkgs/top-level/all-packages.nix#L35801-L35810

So we'd need to define liana and lianad in all-packages.nix again since we'd need to change those attributes.

jonasnick · 2024-06-30T19:54:58Z

Concept ACK on adding a liana module to nix-bitcoin. Thanks!

We should also mention the new service in README.md and in examples/configuration.nix and add a test checking that it runs.

plebhash · 2024-06-30T23:55:42Z

thanks @dunxen

So we'd need to define liana and lianad in all-packages.nix again since we'd need to change those attributes.

I can't find liana anywhere inside all-packages.nix? Did you write this starting from the assumption that it was there, or are you suggesting that we add it there for the first time?

dunxen · 2024-07-01T08:10:33Z

I can't find liana anywhere inside all-packages.nix? Did you write this starting from the assumption that it was there, or are you suggesting that we add it there for the first time?

Packages in by-name are automatically included at the top-level. Liana used to be there but when there was a refactor and the package definition was moved to by-name, it was removed from all-packages. It needs to go back there if you have attributes to set like in this scenario. I've left some comments on your nixpkgs PR. Thanks!

Apologies to all for the slightly off topic 🙏

bootstrap liana pkg

abdfec2

storopoli reviewed Jun 16, 2024

View reviewed changes

plebhash force-pushed the liana branch 2 times, most recently from b77d51f to a7ebed2 Compare June 17, 2024 11:29

liana module wip

939cdb1

plebhash force-pushed the liana branch from a7ebed2 to 939cdb1 Compare June 17, 2024 11:33

storopoli suggested changes Jun 17, 2024

View reviewed changes

plebhash mentioned this pull request Jul 1, 2024

lianad: init at 6.0 NixOS/nixpkgs#323696

Merged

13 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add `liana` support #708

add `liana` support #708

plebhash commented Jun 16, 2024 •

edited

Loading

storopoli Jun 16, 2024

plebhash Jun 17, 2024 •

edited

Loading

storopoli Jun 17, 2024

plebhash Jun 17, 2024 •

edited

Loading

storopoli Jun 17, 2024

storopoli Jun 17, 2024

plebhash Jun 17, 2024 •

edited

Loading

wskeele Jul 21, 2024

storopoli Jun 17, 2024

0xB10C commented Jun 18, 2024 •

edited

Loading

dunxen commented Jun 19, 2024 •

edited

Loading

plebhash commented Jun 21, 2024 •

edited

Loading

dunxen commented Jun 23, 2024 •

edited

Loading

jonasnick commented Jun 30, 2024

plebhash commented Jun 30, 2024

dunxen commented Jul 1, 2024

		default = "wsh(or_d(pk([0dd8c6f0/48'/1'/0'/2']tpubDFMbZ7U5k5hEfsttnZTKMmwrGMHnqUGxhShsvBjHimXBpmAp5KmxpyGsLx2toCaQgYq5TipBLhTUtA2pRSB9b14m5KwSohTDoCHkk1EnqtZ/<0;1>/),and_v(v:pkh([d4ab66f1/48'/1'/0'/2']tpubDEXYN145WM4rVKtcWpySBYiVQ229pmrnyAGJT14BBh2QJr7ABJswchDicZfFaauLyXhDad1nCoCZQEwAW87JPotP93ykC9WJvoASnBjYBxW/<0;1>/),older(65535))))#7nvn6ssc";
		description = mdDoc "The wallet descriptor.";

add liana support #708

Are you sure you want to change the base?

add liana support #708

Conversation

plebhash commented Jun 16, 2024 • edited Loading

storopoli Jun 16, 2024

Choose a reason for hiding this comment

plebhash Jun 17, 2024 • edited Loading

Choose a reason for hiding this comment

storopoli Jun 17, 2024

Choose a reason for hiding this comment

plebhash Jun 17, 2024 • edited Loading

Choose a reason for hiding this comment

storopoli Jun 17, 2024

Choose a reason for hiding this comment

storopoli Jun 17, 2024

Choose a reason for hiding this comment

plebhash Jun 17, 2024 • edited Loading

Choose a reason for hiding this comment

wskeele Jul 21, 2024

Choose a reason for hiding this comment

storopoli Jun 17, 2024

Choose a reason for hiding this comment

0xB10C commented Jun 18, 2024 • edited Loading

dunxen commented Jun 19, 2024 • edited Loading

plebhash commented Jun 21, 2024 • edited Loading

dunxen commented Jun 23, 2024 • edited Loading

jonasnick commented Jun 30, 2024

plebhash commented Jun 30, 2024

dunxen commented Jul 1, 2024

add `liana` support #708

add `liana` support #708

plebhash commented Jun 16, 2024 •

edited

Loading

plebhash Jun 17, 2024 •

edited

Loading

plebhash Jun 17, 2024 •

edited

Loading

plebhash Jun 17, 2024 •

edited

Loading

0xB10C commented Jun 18, 2024 •

edited

Loading

dunxen commented Jun 19, 2024 •

edited

Loading

plebhash commented Jun 21, 2024 •

edited

Loading

dunxen commented Jun 23, 2024 •

edited

Loading