BTCPay Server Async Payjoin Plugin

A BTCPay Server plugin that adds Async Payjoin (BIP 77) support to the checkout flow. The plugin uses C# bindings to the Rust Payjoin Dev Kit generated via UniFFI.

Warning

This plugin is under active development and is intended for demo/testing purposes. Do not use in production with real funds.

Prerequisites

• .NET 8.0 SDK
• Rust 1.85+
• Git

Getting Started

Cloning the Project

git clone --recurse-submodules https://github.com/ValeraFinebits/btcpayserver-payjoin-plugin
cd btcpayserver-payjoin-plugin

Building

Generate the C# bindings from the Rust FFI crate, then build the .NET solution:

cd rust-payjoin/payjoin-ffi/csharp
bash ./scripts/generate_bindings.sh
cd ../../..

dotnet restore BTCPayServer.Plugins.Payjoin.sln
dotnet build BTCPayServer.Plugins.Payjoin.sln -c Release

Running Tests

dotnet test BTCPayServer.Plugins.Payjoin.sln -c Release

Managing EF Migrations

Entity Framework migrations for the plugin use the dedicated design-time startup project at BTCPayServer.Plugins.Payjoin.Migrations.

List migrations:

dotnet ef migrations list --project BTCPayServer.Plugins.Payjoin/BTCPayServer.Plugins.Payjoin.csproj --startup-project BTCPayServer.Plugins.Payjoin.Migrations/BTCPayServer.Plugins.Payjoin.Migrations.csproj

Add a migration:

dotnet ef migrations add <MigrationName> --project BTCPayServer.Plugins.Payjoin/BTCPayServer.Plugins.Payjoin.csproj --startup-project BTCPayServer.Plugins.Payjoin.Migrations/BTCPayServer.Plugins.Payjoin.Migrations.csproj --output-dir Migrations

Remove the latest migration:

dotnet ef migrations remove --project BTCPayServer.Plugins.Payjoin/BTCPayServer.Plugins.Payjoin.csproj --startup-project BTCPayServer.Plugins.Payjoin.Migrations/BTCPayServer.Plugins.Payjoin.Migrations.csproj --force

Related Links

• Async Payjoin Rust implementation: https://github.com/payjoin/rust-payjoin
• BTCPay Server plugin development docs: https://docs.btcpayserver.org/Development/Plugins/

Licence

MIT