nixos/bitbox-bridge: init

[izelnakri]

This PR adds config.services.bitbox-bridge to NixOS.

Previous PR could be found here: #391415

Things done

• Adds the most basic service configuration for config.services.bitbox-bridge.

• Adds a nix test to check bitbox-bridge can be built & run.

• Adds config.services.bitbox-bridge.runOnMount to run the systemd service only on mount. It does proper systemd device unit registration when hardware wallet is plugged via udev.

• Built on platform(s)

  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin

• Tested basic functionality of all binary files (usually in ./result/bin/)

• Fits CONTRIBUTING.md.

[izelnakri]

@JohnRTitor @HeitorAugustoLN @ethancedwards8 @SuperSandro2000 This PR is ready for review.

I've specifically also manually tested services.bitbox-bridge.runOnMount feature on all possible cases. Let me know if there is anything else I should do ;)

[HeitorAugustoLN]

Suggested change

	runOnMount = lib.mkOption {
	type = lib.types.bool;
	default = false;
	description = ''
	Enable running bitbox-bridge.service only when hardware wallet is plugged, also registers the systemd device unit. When false, bitbox-bridge service runs all the time.
	'';
	};
	runOnMount = lib.mkEnableOption ''
	running bitbox-bridge.service only when hardware wallet is plugged, also registers the systemd device unit.
	When false, bitbox-bridge service runs all the time'';

[izelnakri]

I've changed the logic to make services.bitbox-bridge.runOnMount = true by default, seems like a better default to conserve power/battery. Let me know if you still think we should change it ;)

[JohnRTitor]

Rest LGTM:

Commit messages need updating though:

1. nixosTests/bitbox-bridge: init
2. This isn't really needed, AFAIK services.udev.package will still pickup the rules from lib fine. But don't just take my word for it, you can verify the path yourself.
3. nixos/bitbox-bridge: init
4. Can be merged with the above commit

[JohnRTitor]

I was typing a review comment for this, exactly when you updated :)

So as you can see using mkEnableOption auto appends stuff:

Whether to enable Run bitbox-bridge.service only.....

You want something like this instead:

Suggested change

	runOnMount = lib.mkOption {
	type = lib.types.bool;
	default = true;
	example = false;
	description = ''
	Run bitbox-bridge.service only when hardware wallet is plugged, also registers the systemd device unit.
	This option is enabled by default to save power, when false, bitbox-bridge service runs all the time instead.
	'';;
	};
	runOnMount = lib.mkEnableOption null // {
	default = true;
	description = ''
	Run bitbox-bridge.service only when hardware wallet is plugged, also registers the systemd device unit.
	This option is enabled by default to save power, when false, bitbox-bridge service runs all the time instead.
	'';
	};

You can check how it looks by downloading the artifact from our CI NixOS manal build then looking at the options.html.

Or you can build the manual yourself:

nix build --print-out-paths ".#htmlDocs.nixosManual.x86_64-linux"

[izelnakri]

I've changed the logic to make services.bitbox-bridge.runOnMount = true by default, seems like a better default to conserve power/battery. Let me know if you still think we should change it ;)

[JohnRTitor]

Please use mkEnableOption. You can still enable it by default by setting the override, just like how I did.

[izelnakri]

@HeitorAugustoLN @JohnRTitor requested changes are done.

This isn't really needed, AFAIK services.udev.package will still pickup the rules from lib fine. But don't just take my word for it, you can verify the path yourself.

@JohnRTitor I've specifically made this change after testing it on my NixOS machine and another archlinux machine that runs with nix. The other way created some issues as far as I remember. Please let me know below any other changes needed. Thanks! ;)

[JohnRTitor]

after testing it on my NixOS machine and another archlinux machine that runs with nix

Right. NixOS module system knows that we should install udev rules to /etc when installing the system, whereas Nix package manager on other distros may just install the rules to existing /lib if we don't explicitly tell it to.

[izelnakri]

after testing it on my NixOS machine and another archlinux machine that runs with nix

Right. NixOS module system knows that we should install udev rules to /etc when installing the system, whereas Nix package manager on other distros may just install the rules to existing /lib if we don't explicitly tell it to.

@JohnRTitor Yes I think I couldn't also get it working in NixOS because the /lib udev rules don't get copied to /etc/udev and applied as rules. So instead of duplicating the logic I decided to move it to /etc. I think this approach is good enough, let me know if you'd like a different specific solution and I'll do it. I'd like this PR to be approved & merged, after all ;)

[JohnRTitor]

Just add a release note and we are good.

[izelnakri]

Just add a release note and we are good.

Not sure if I added to the right release note(s), but I guess its done now! :) 🎉

[JohnRTitor]

LGTM, but looks like I forgot to tell you to add nixosTests.bitbox-bridge to the package's passthru.tests.

I'll do it myself and then merge.

[JohnRTitor]

nixpkgs-review result

Generated using nixpkgs-review-gha

Command: nixpkgs-review pr 392817

Logs: https://github.com/JohnRTitor/nixpkgs-review-gha/actions/runs/14134406559

---

x86_64-linux

✅ 2 packages built:

• bitbox-bridge
• bitbox-bridge.passthru.tests.basic

---

aarch64-linux

❌ 1 package failed to build:

• bitbox-bridge.passthru.tests.basic

✅ 1 package built:

• bitbox-bridge

---

x86_64-darwin

❌ 1 package failed to build:

• bitbox-bridge.passthru.tests.basic

✅ 1 package built:

• bitbox-bridge

---

aarch64-darwin

❌ 1 package failed to build:

• bitbox-bridge.passthru.tests.basic

✅ 1 package built:

• bitbox-bridge