https://github.com/btcpay-monero/btcpayserver-monero-plugin
This plugin extends BTCPay Server to enable users to receive payments via Monero.
https://github.com/btcpay-monero/btcpayserver-monero-plugin
btcpay btcpayserver crowdfunding monero monero-payment-gateway monero-payment-processor monero-plugin plugin point-of-sale selfhosted xmr
Last synced: about 1 month ago
JSON representation
This plugin extends BTCPay Server to enable users to receive payments via Monero.
- Host: GitHub
- URL: https://github.com/btcpay-monero/btcpayserver-monero-plugin
- Owner: btcpay-monero
- License: mit
- Created: 2025-01-08T09:27:58.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-05-10T18:37:03.000Z (about 1 month ago)
- Last Synced: 2025-05-10T19:31:41.217Z (about 1 month ago)
- Topics: btcpay, btcpayserver, crowdfunding, monero, monero-payment-gateway, monero-payment-processor, monero-plugin, plugin, point-of-sale, selfhosted, xmr
- Language: C#
- Homepage:
- Size: 149 KB
- Stars: 23
- Watchers: 3
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://matrix.to/#/#btcpay-monero:matrix.org)
# Monero BTCPay Server plugin
This plugin extends BTCPay Server to enable users to receive payments via Monero.
> [!WARNING]
> This plugin shares a single Monero wallet across all the stores in the BTCPay Server instance. Use this plugin only if you are not sharing your instance.
## Configuration
Configure this plugin using the following environment variables:
| Environment variable | Description | Example |
| --- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- |
**BTCPAY_XMR_DAEMON_URI** | **Required**. The URI of the [monerod](https://github.com/monero-project/monero) RPC interface. | http://127.0.0.1:18081 |
**BTCPAY_XMR_DAEMON_USERNAME** | **Optional**. The username for authenticating with the daemon. | john |
**BTCPAY_XMR_DAEMON_PASSWORD** | **Optional**. The password for authenticating with the daemon. | secret |
**BTCPAY_XMR_WALLET_DAEMON_URI** | **Required**. The URI of the [monero-wallet-rpc](https://getmonero.dev/interacting/monero-wallet-rpc.html) RPC interface. | http://127.0.0.1:18082 |
**BTCPAY_XMR_WALLET_DAEMON_WALLETDIR** | **Optional**. The directory where BTCPay Server saves wallet files uploaded via the UI ([See this blog post for more details](https://sethforprivacy.com/guides/accepting-monero-via-btcpay-server/#configure-the-bitcoin-wallet-of-choice)). | /home/cypherpunk/Monero/wallets/ |
BTCPay Server's Docker deployment simplifies the setup by automatically configuring these variables. For further details, refer to this [blog post](https://sethforprivacy.com/guides/accepting-monero-via-btcpay-server).
# For maintainers
## Building and testing
To build and run unit tests, run the following commands:
```bash
dotnet build btcpay-monero-plugin.sln
dotnet test BTCPayServer.Plugins.UnitTests --verbosity normal
```
This will build the plugin and run the unit tests.
If you are a developer maintaining this plugin, in order to maintain this plugin, you need to clone this repository with `--recurse-submodules`:
```bash
git clone --recurse-submodules https://github.com/btcpayserver/btcpayserver-monero-plugin
```
Then run the tests dependencies
```bash
docker-compose up -d dev
```
Then create the `appsettings.dev.json` file in `btcpayserver/BTCPayServer`, with the following content:
```json
{
"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.
Then start the development dependencies via docker-compose:
```bash
docker-compose up -d dev
```
Finally, set up BTCPay Server as the startup project in [Rider](https://www.jetbrains.com/rider/) or Visual Studio.
If you want to reset the environment you can run:
```bash
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](https://www.jetbrains.com/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](https://github.com/btcpayserver/btcpayserver-docker) to enable users to easily update or deploy additional infrastructure (such as nodes).
Monero nodes are defined in this [Docker Compose file](https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/monero.yml).
The Monero images are also maintained in the [dockerfile-deps repository](https://github.com/btcpayserver/dockerfile-deps/tree/master/Monero). While using the `dockerfile-deps` for future versions of Monero Dockerfiles is optional, maintaining [the Docker Compose Fragment](https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/monero.yml) is necessary.
Users can install Monero by configuring the `BTCPAYGEN_CRYPTOX` environment variables.
For example, after ensuring `BTCPAYGEN_CRYPTO2` is not already assigned to another cryptocurrency:
```bash
BTCPAYGEN_CRYPTO2="xmr"
. btcpay-setup.sh -i
```
This will automatically configure Monero in their deployment stack. Users can then run `btcpay-update.sh` to pull updates for the infrastructure.
Note: Adding Monero to the infrastructure is not recommended for non-advanced users. If the server specifications are insufficient, it may become unresponsive.
Lunanode, a VPS provider, offers an [easy way to provision the infrastructure](https://docs.btcpayserver.org/Deployment/LunaNode/) for BTCPay Server, then it installs the Docker Compose deployment on the provisioned VPS. The user can select Monero during provisioning, then the resulting VPS have a Monero deployed automatically, without the need for the user to use the command line. (But the user will still need to install this plugin manually)
# Licence
[MIT](LICENSE.md)