For maintainers

Building and testing

🧑‍💻 Local Development Setup

If you’re contributing to this plugin or running a local development instance of BTCPay Server with the Monero plugin, follow these steps.

1) Requirements

  • .NET 8.0 SDK or later
  • JetBrains Rider (recommended) or Visual Studio Code with C# support
  • Git
  • Docker and Docker Compose

2) Clone the Repositories

Create a working directory and clone both the BTCPay Server and Monero plugin repositories side by side: If you are a developer maintaining this plugin, in order to maintain this plugin, you need to clone this repository with --recurse-submodules:

git clone https://github.com/btcpayserver/btcpayserver
git clone --recurse-submodules https://github.com/btcpay-monero/btcpayserver-monero-plugin

3. Build the Plugin

Navigate to the plugin directory and restore/build the solution:

cd btcpayserver-monero-plugin
dotnet restore
dotnet build btcpay-monero-plugin.sln

To build and run unit tests, run the following commands:

dotnet build btcpay-monero-plugin.sln
dotnet test BTCPayServer.Plugins.Monero.UnitTests --verbosity normal

To run unit tests with coverage, install JetBrains dotCover CLI:

dotnet tool install --global JetBrains.dotCover.CommandLineTools

Then run the following command:

dotCover cover-dotnet --TargetArguments="test BTCPayServer.Plugins.UnitTests --no-build" --ReportType=HTML --Output=coverage/dotCover.UnitTests.output.html --ReportType=detailedXML --Output=coverage/dotCover.UnitTests.output.xml --filters="-:Assembly=BTCPayServer.Plugins.UnitTests;-:Assembly=testhost;-:Assembly=BTCPayServer;-:Class=AspNetCoreGeneratedDocument.*"

To build and run integration tests, run the following commands:

dotnet build btcpay-monero-plugin.sln
docker compose -f BTCPayServer.Plugins.IntegrationTests/docker-compose.yml run tests
BTCPAY_XMR_CASHCOW_WALLET_DAEMON_URI Optional. The URI of the monero-wallet-rpc interface for the cashcow wallet. This is used to create a second wallet for testing purposes in regtest mode. http://

4. Configure BTCPay Server to Load the Plugin

For vscode, open the launch.json file in the .vscode folder and set the launchSettingsProfile to Altcoins-HTTPS.

Then create the appsettings.dev.json file in btcpayserver/BTCPayServer, with the following content:

{
  "DEBUG_PLUGINS": "..\\..\\Plugins\\Monero\\bin\\Debug\\net8.0\\BTCPayServer.Plugins.Monero.dll",
  "XMR_DAEMON_URI": "http://127.0.0.1:18081",
  "XMR_WALLET_DAEMON_URI": "http://127.0.0.1:18082",
  "XMR_CASHCOW_WALLET_DAEMON_URI": "http://127.0.0.1:18092"
}

This will ensure that BTCPay Server loads the plugin when it starts.

5. Start Development Environment

Then start the development dependencies via docker-compose:

cd BTCPayServer.Plugins.IntegrationTests/
docker-compose up -d dev

Finally, set up BTCPay Server as the startup project in Rider or Visual Studio.

If you want to reset the environment you can run:

docker-compose down -v
docker-compose up -d dev

Note: Running or compiling the BTCPay Server project will not automatically recompile the plugin project. Therefore, if you make any changes to the project, do not forget to build it before running BTCPay Server in debug mode.

We recommend using Rider for plugin development, as it supports hot reload with plugins. You can edit .cshtml files, save, and refresh the page to see the changes.

Visual Studio does not support this feature.

When debugging in regtest, BTCPay Server will automatically create an configure two wallets. (cashcow and merchant) You can trigger payments or mine blocks on the invoice’s checkout page.

About docker-compose deployment

BTCPay Server maintains its own deployment stack project to enable users to easily update or deploy additional infrastructure (such as nodes).

Monero nodes are defined in this Docker Compose file.

The Monero images are also maintained in the dockerfile-deps repository. While using the dockerfile-deps for future versions of Monero Dockerfiles is optional, maintaining the Docker Compose Fragment is necessary.