Make install-arch.sh idempotent

BTCPayServer.Hwi/BTCPayServer.Hwi.csproj

@@ -17,12 +17,12 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="10.0.203" PrivateAssets="All" />
   </ItemGroup>
 
 
   <ItemGroup>
-    <PackageReference Include="NBitcoin" Version="8.0.8" />
+    <PackageReference Include="NBitcoin" Version="10.0.3" />
   </ItemGroup>
 
 </Project>

BTCPayServer.Hwi/Deployment/HwiVersions.cs

@@ -102,30 +102,30 @@ namespace BTCPayServer.Hwi.Deployment
             }
         };
         
-        public static HwiVersion v3_1_0 { get; } = new HwiVersion()
+        public static HwiVersion v3_2_0 { get; } = new HwiVersion()
         {
-            Version = "3.1.0",
+            Version = "3.2.0",
             Windows = new HwiDownloadInfo()
             {
                 Link = "https://github.com/bitcoin-core/HWI/releases/download/{0}/hwi-{0}-windows-x86_64.zip",
-                Hash = "42b491941d26b41ca51a671eb8d533557ba7261d32a70f843bbe6a5af997fb25",
+                Hash = "e068d91b664597425a8ead02d7b86a02ad6c4b72746c42961f58a58b08f9fd79",
                 Extractor = new ZipExtractor()
             },
             Linux = new HwiDownloadInfo()
             {
                 Link = "https://github.com/bitcoin-core/HWI/releases/download/{0}/hwi-{0}-linux-x86_64.tar.gz",
-                Hash = "4732e06e879b51eb5b42ce334c54373d7901556227dca4a63d342190f04b22c9",
+                Hash = "d9cc65de95e3cf93fd3c953d589184a00180624ffc5ad17aade97616a8919fa6",
                 Extractor = new TarExtractor()
             },
             Mac = new HwiDownloadInfo()
             {
                 Link = "https://github.com/bitcoin-core/HWI/releases/download/{0}/hwi-{0}-mac-x86_64.tar.gz",
-                Hash = "bf5079c8899ca62bb9c48f78b53368cd43525e4900474db7d47f7c251eeaacde",
+                Hash = "b3764a530b635e7a7348c9185e09e74b389f5f585094fe316f700eec7c761875",
                 Extractor = new TarExtractor()
             }
         };
 
-        public static HwiVersion Latest => v3_1_0;
+        public static HwiVersion Latest => v3_2_0;
     }
 
     public class HwiVersion

BTCPayServer.Vault.Tests/BTCPayServer.Vault.Tests.csproj

@@ -1,23 +1,15 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net8.0</TargetFramework>
+    <TargetFramework>net10.0</TargetFramework>
     <LangVersion>12</LangVersion>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>
     <FrameworkReference Include="Microsoft.AspNetCore.App" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
-    <PackageReference Include="xunit" Version="2.6.6" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
-    <PackageReference Include="coverlet.collector" Version="1.1.0">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.5.1" />
+    <PackageReference Include="xunit.v3" Version="3.2.2" />
   </ItemGroup>
 
   <ItemGroup>

BTCPayServer.Vault.Tests/HwiTests.cs

@@ -5,15 +5,12 @@ using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.DependencyInjection;
 using NBitcoin;
 using Xunit;
-using Xunit.Abstractions;
 using BTCPayServer.Hwi;
 using BTCPayServer.Hwi.Transports;
 using System.Collections.Generic;
 using System.Net;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Hosting.Server.Features;
-using Microsoft.AspNetCore.Builder;
-using BTCPayServer.Vault;
 
 namespace BTCPayServer.Vault.Tests
 {

BTCPayServer.Vault.Tests/XUnitLogger.cs

@@ -1,19 +1,12 @@
 using System;
-using System.Collections.Generic;
-using System.Text;
 using Microsoft.Extensions.Logging;
-using Xunit.Abstractions;
+using Xunit;
 
 namespace BTCPayServer.Vault.Tests
 {
-    class XUnitLoggerFactory : ILoggerFactory
+    class XUnitLoggerFactory(ITestOutputHelper testOutput) : ILoggerFactory
     {
-        public XUnitLoggerFactory(ITestOutputHelper testOutput)
-        {
-            TestOutput = testOutput;
-        }
-
-        public ITestOutputHelper TestOutput { get; }
+        public ITestOutputHelper TestOutput { get; } = testOutput;
 
         public void AddProvider(ILoggerProvider provider)
         {

BTCPayServer.Vault/BTCPayServer.Vault.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <OutputType Condition=" '$(Configuration)' == 'Release' ">WinExe</OutputType>
-    <TargetFramework>net8.0</TargetFramework>
+    <TargetFramework>net10.0</TargetFramework>
     <LangVersion>12</LangVersion>
     <Company>The BTCPayServer Team</Company>
     <Title>BTCPayServer Vault</Title>
@@ -17,15 +17,15 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Avalonia.Desktop" Version="11.0.6" />
-    <PackageReference Include="Avalonia.Themes.Simple" Version="11.0.6" />
+    <PackageReference Include="Avalonia.Desktop" Version="11.3.14" />
+    <PackageReference Include="Avalonia.Themes.Simple" Version="11.3.14" />
     <PackageReference Include="BTCPayServer.NTag424.PCSC" Version="1.0.22" />
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="10.0.203" PrivateAssets="All" />
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Avalonia" Version="11.0.6" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="8.0.0" />
+    <PackageReference Include="Avalonia" Version="11.3.14" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="10.0.7" />
     <PackageReference Include="NicolasDorier.RateLimits" Version="1.1.0" />
   </ItemGroup>
 

BTCPayServer.Vault/Version.csproj

@@ -1,5 +1,5 @@
 <Project>
   <PropertyGroup>
-    <Version>2.0.14</Version>
+    <Version>3.0.0</Version>
   </PropertyGroup>
 </Project>

Build/RELEASE.md

@@ -1,5 +1,7 @@
 ## Changelog
 
-* Fix debian package for new distro (#90)
+* Update to HWI 3.2.0
+* Update to .NET 10.0
+* Simplify setup for arch linux
 
 You may want to follow the [documented](https://github.com/btcpayserver/BTCPayServer.Vault/blob/master/docs/HowToVerify.md) process to verify that the binaries are built by Nicolas Dorier.

Build/common/export-variables.sh

@@ -2,10 +2,11 @@
 
 DOTNET_RUNTIME=${DOTNET_RUNTIME:-$RUNTIME}
 BUILD_ARGS="--runtime $DOTNET_RUNTIME -p:Configuration=Release -p:GithubDistrib=true"
-FRAMEWORK="net8.0"
+FRAMEWORK="net10.0"
 DIST="/source/dist"
 RESOURCES="/source/Build/${RUNTIME}"
 RESOURCES_COMMON="/source/Build/common"
+RESOURCES_LINUX="/source/Build/linux-x64"
 PROJECT_FILE="/source/BTCPayServer.Vault/BTCPayServer.Vault.csproj"
 VERSION_FILE="/source/BTCPayServer.Vault/Version.csproj"
 LICENSE="$(cat $PROJECT_FILE | sed -n 's/.*<PackageLicenseExpression>\(.*\)<\/PackageLicenseExpression>.*/\1/p')"

Build/debian-x64/Dockerfile

@@ -1,13 +1,13 @@
-FROM mcr.microsoft.com/dotnet/sdk:8.0 AS builder
+FROM mcr.microsoft.com/dotnet/sdk:10.0 AS builder
 
 # Optimize docker cache, do not make it one layer
 RUN apt-get update
 RUN apt-get install -y --no-install-recommends imagemagick
 ###
 
-RUN wget -qO /tmp/hwi.tar.gz https://github.com/bitcoin-core/HWI/releases/download/3.1.0/hwi-3.1.0-linux-x86_64.tar.gz && \
+RUN wget -qO /tmp/hwi.tar.gz https://github.com/bitcoin-core/HWI/releases/download/3.2.0/hwi-3.2.0-linux-x86_64.tar.gz && \
     tar -zxvf /tmp/hwi.tar.gz -C /tmp hwi && \
-    echo "4732e06e879b51eb5b42ce334c54373d7901556227dca4a63d342190f04b22c9 /tmp/hwi" | sha256sum -c - && \
+    echo "d9cc65de95e3cf93fd3c953d589184a00180624ffc5ad17aade97616a8919fa6 /tmp/hwi" | sha256sum -c - && \
     rm /tmp/hwi.tar.gz
 
 SHELL ["/bin/bash", "-c"]
@@ -18,6 +18,7 @@ WORKDIR /source
 ENV DOTNET_RUNTIME "linux-x64"
 ENV RUNTIME "debian-x64"
 COPY "Build/common" "Build/common"
+COPY "Build/linux-x64" "Build/linux-x64"
 ENV EXPORT_VARIABLES "source Build/common/export-variables.sh"
 COPY BTCPayServer.Vault/BTCPayServer.Vault.csproj BTCPayServer.Vault/BTCPayServer.Vault.csproj
 COPY BTCPayServer.Hwi/BTCPayServer.Hwi.csproj BTCPayServer.Hwi/BTCPayServer.Hwi.csproj
@@ -29,6 +30,7 @@ RUN $EXPORT_VARIABLES && dotnet_publish && mv /tmp/hwi "$PUBLISH_FOLDER/"
 
 COPY "Build/${RUNTIME}" "Build/${RUNTIME}"
 COPY BTCPayServerVault.png BTCPayServerVault.png
+
 RUN $EXPORT_VARIABLES && \
     find "$PUBLISH_FOLDER" -type f -exec chmod 644 {} \; && \
     find "$PUBLISH_FOLDER" -type f \( -name 'hwi' -o -name "$EXECUTABLE" \) -exec chmod +x {} \; && \
@@ -50,7 +52,7 @@ RUN $EXPORT_VARIABLES && \
     cp "$RESOURCES/BTCPayServer.Vault.desktop" "$debiandir/usr/share/applications/" && \
     replaceProjectVariables "$debiandir/usr/share/applications/BTCPayServer.Vault.desktop" && \
     mkdir -p "$debiandir/lib/udev/rules.d" && \
-    cp $RESOURCES/udev/* "$debiandir/lib/udev/rules.d/" && \
+    cp $RESOURCES_LINUX/udev/* "$debiandir/lib/udev/rules.d/" && \
     sizeinkb="$(du -k --max-depth=0 $debiandir | cut -f 1)" && \
     sed -i "s/{SIZEINKB}/$sizeinkb/g" "$debiandir/DEBIAN/control" && \
     dpkg --build "$debiandir" && mv /tmp/debian.deb "$DIST/BTCPayServerVault-$VERSION.deb" && \

Build/linux-x64/BTCPayServerVault.desktop

@@ -0,0 +1,7 @@
+[Desktop Entry]
+
+Type=Application
+Name=BTCPayServer Vault
+Exec=/usr/local/bin/BTCPayServer.Vault
+Icon=BTCPayServerVault
+Categories=Utility;

Build/linux-x64/Dockerfile

@@ -1,13 +1,18 @@
-FROM mcr.microsoft.com/dotnet/sdk:8.0 AS builder
+FROM mcr.microsoft.com/dotnet/sdk:10.0 AS builder
 
-RUN wget -qO /tmp/hwi.tar.gz https://github.com/bitcoin-core/HWI/releases/download/3.1.0/hwi-3.1.0-linux-x86_64.tar.gz && \
+RUN wget -qO /tmp/hwi.tar.gz https://github.com/bitcoin-core/HWI/releases/download/3.2.0/hwi-3.2.0-linux-x86_64.tar.gz && \
     tar -zxvf /tmp/hwi.tar.gz -C /tmp hwi && \
-    echo "4732e06e879b51eb5b42ce334c54373d7901556227dca4a63d342190f04b22c9 /tmp/hwi" | sha256sum -c - && \
+    echo "d9cc65de95e3cf93fd3c953d589184a00180624ffc5ad17aade97616a8919fa6 /tmp/hwi" | sha256sum -c - && \
     rm /tmp/hwi.tar.gz
 
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends imagemagick && \
+    rm -rf /var/lib/apt/lists/*
+
 WORKDIR /source
 ENV RUNTIME "linux-x64"
 COPY "Build/common" "Build/common"
+COPY "Build/linux-x64" "Build/linux-x64"
 ENV EXPORT_VARIABLES "source Build/common/export-variables.sh"
 COPY BTCPayServer.Vault/BTCPayServer.Vault.csproj BTCPayServer.Vault/BTCPayServer.Vault.csproj
 COPY BTCPayServer.Hwi/BTCPayServer.Hwi.csproj BTCPayServer.Hwi/BTCPayServer.Hwi.csproj
@@ -18,10 +23,17 @@ COPY BTCPayServer.Hwi BTCPayServer.Hwi
 COPY BTCPayServer.Vault BTCPayServer.Vault
 RUN $EXPORT_VARIABLES && dotnet_publish && mv /tmp/hwi "$PUBLISH_FOLDER/"
 
+COPY "BTCPayServerVault.png" "BTCPayServerVault.png"
+
 RUN $EXPORT_VARIABLES && \
+    cp -r "$RESOURCES_LINUX/udev" "$PUBLISH_FOLDER/" && \
+    cp -r $RESOURCES_LINUX/install-*.sh "$PUBLISH_FOLDER/" && \
+    cp -r "$RESOURCES_LINUX/BTCPayServerVault.desktop" "$PUBLISH_FOLDER/" && \
+    convert -background none -resize "64x64" "BTCPayServerVault.png" "/tmp/BTCPayServerVault.png" && \
+    cp "/tmp/BTCPayServerVault.png" "$PUBLISH_FOLDER/" && \
     find "$PUBLISH_FOLDER" -type f -exec chmod 644 {} \; && \
-    find "$PUBLISH_FOLDER" -type f \( -name 'hwi' -o -name "$EXECUTABLE" \) -exec chmod +x {} \; && \
+    find "$PUBLISH_FOLDER" -type f \( -name 'hwi' -o -name "$EXECUTABLE" -o -name '*.sh' \) -exec chmod +x {} \; && \
     # We need to cd in "$PUBLISH_FOLDER", because tar's -C option always add a root folder to the tar otherwise
     cd "$PUBLISH_FOLDER" && tar -czf "$DIST/BTCPayServerVault-Linux-$VERSION.tar.gz" *
 
-ENTRYPOINT [ "/bin/bash", "-c", "$EXPORT_VARIABLES && cp $DIST/* /opt/dist/" ]
+ENTRYPOINT [ "/bin/bash", "-c", "$EXPORT_VARIABLES && cp -a $DIST/* /opt/dist/" ]

Build/linux-x64/install-arch.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+set -euo pipefail
+
+if [ "$(id -u)" -ne 0 ]; then
+    echo "This script must be run as root." >&2
+    exit 1
+fi
+
+SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd -P)"
+RULES_DIR="$SCRIPT_DIR/udev"
+
+install -Dm644 "$SCRIPT_DIR/BTCPayServerVault.desktop" /usr/share/applications/BTCPayServerVault.desktop
+install -Dm644 "$SCRIPT_DIR/BTCPayServerVault.png" /usr/share/icons/hicolor/64x64/apps/BTCPayServerVault.png
+
+rm -rf /opt/BTCPayServer.Vault 
+mkdir -p /opt/BTCPayServer.Vault
+cp -r "$SCRIPT_DIR"/. "/opt/BTCPayServer.Vault/"
+chmod +x /opt/BTCPayServer.Vault/BTCPayServer.Vault
+
+echo "/opt/BTCPayServer.Vault created"
+
+ln -sfnT /opt/BTCPayServer.Vault/BTCPayServer.Vault /usr/local/bin/BTCPayServer.Vault
+
+chmod +x /usr/local/bin/BTCPayServer.Vault
+echo "/usr/local/bin/BTCPayServer.Vault created"
+
+echo "If the Vault cannot access your hardware wallet, you may need to restart your computer."

Build/osx-x64/Dockerfile

@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/dotnet/sdk:8.0 AS builder
+FROM mcr.microsoft.com/dotnet/sdk:10.0 AS builder
 
 # Optimize docker cache, do not make it one layer
 RUN apt-get update
@@ -7,9 +7,9 @@ RUN apt-get install -y --no-install-recommends imagemagick
 
 RUN apt-get install -y --no-install-recommends git icnsutils
 
-RUN wget -qO /tmp/hwi.tar.gz https://github.com/bitcoin-core/HWI/releases/download/3.1.0/hwi-3.1.0-mac-x86_64.tar.gz && \
+RUN wget -qO /tmp/hwi.tar.gz https://github.com/bitcoin-core/HWI/releases/download/3.2.0/hwi-3.2.0-mac-x86_64.tar.gz && \
     tar -zxvf /tmp/hwi.tar.gz -C /tmp hwi && \
-    echo "bf5079c8899ca62bb9c48f78b53368cd43525e4900474db7d47f7c251eeaacde /tmp/hwi" | sha256sum -c - && \
+    echo "b3764a530b635e7a7348c9185e09e74b389f5f585094fe316f700eec7c761875 /tmp/hwi" | sha256sum -c - && \
     rm /tmp/hwi.tar.gz
 
 WORKDIR /source

Build/push-new-tag.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+version_file="$script_dir/../BTCPayServer.Vault/Version.csproj"
+
+ver="$(grep -oPm1 '(?<=<Version>)[^<]+' "$version_file")"
+tag="Vault/v$ver"
+
+git tag -a "$tag" -m "$tag"
+git push origin "$tag"

Build/win-x64/Dockerfile

@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/dotnet/sdk:8.0 AS builder
+FROM mcr.microsoft.com/dotnet/sdk:10.0 AS builder
 
 # Optimize docker cache, do not make it one layer
 RUN apt-get update
@@ -6,9 +6,9 @@ RUN apt-get install -y --no-install-recommends imagemagick
 ###
 
 RUN apt-get install -y --no-install-recommends nsis unzip wine xxd osslsigncode openssl
-RUN wget -qO "/tmp/hwi.zip" https://github.com/bitcoin-core/HWI/releases/download/3.1.0/hwi-3.1.0-windows-x86_64.zip && \
+RUN wget -qO "/tmp/hwi.zip" https://github.com/bitcoin-core/HWI/releases/download/3.2.0/hwi-3.2.0-windows-x86_64.zip && \
     unzip "/tmp/hwi.zip" -d "/tmp" && \
-    echo "42b491941d26b41ca51a671eb8d533557ba7261d32a70f843bbe6a5af997fb25 /tmp/hwi.exe" | sha256sum -c - && \
+    echo "e068d91b664597425a8ead02d7b86a02ad6c4b72746c42961f58a58b08f9fd79 /tmp/hwi.exe" | sha256sum -c - && \
     rm "/tmp/hwi.zip" && \
     # Need to setup with rcedit because https://github.com/dotnet/sdk/issues/3943
     # I prebuild the binaries with VS 2019 on commit b807b34a644c86c0b0d89c7f073967e79202731a

README.md

@@ -32,6 +32,37 @@ You can use brew:
 brew install btcpayserver-vault
 ```
 
+### On Arch Linux
+
+Download the tarball on our [release page](https://github.com/btcpayserver/BTCPayServer.Vault/releases/latest)
+
+```bash
+tar -xvf <tarball.tar.gz>
+sudo ./install-arch.sh
+```
+
+If BTCPay Server fails to detect your hardware wallet, you may need to restart.
+
+
+Check if you try to run the `hwi` executable. If not, install python9 dependencies, and run
+
+```bash
+ln -s /usr/lib/libcrypt.so.2 /usr/lib/libcrypt.so.1
+```
+
+### On Debian
+
+Download the `.deb` package on our [release page](https://github.com/btcpayserver/BTCPayServer.Vault/releases/latest)
+
+```bash
+sudo apt install <package.deb>
+```
+
+### Other linux
+
+Inspire you from [install-arch.sh](Build/linux-x64/install-arch.sh).
+We provide the udev rules and desktop entries in the tarball.
+
 ## How does BTCPayServer Vault work
 
 When running the BTCPayServer Vault, a local webserver is hosted on `http://127.0.0.1:65092` which web applications, via your local browser, can connect to in order to interact with your hardware wallet.