Tooling
This README describe some useful tooling that you may need during development and testing. To learn how to get started with your local development environment, read our documentation.
How to manually test payments
Using the test bitcoin-cli
You can call bitcoin-cli inside the container with docker exec.
For example, if you want to send 0.23111090 to mohu16LH66ptoWGEL1GtP6KHTBJYXMWhEf:
./docker-bitcoin-cli.sh sendtoaddress "mohu16LH66ptoWGEL1GtP6KHTBJYXMWhEf" 0.23111090
If you are using Powershell:
.\docker-bitcoin-cli.ps1 sendtoaddress "mohu16LH66ptoWGEL1GtP6KHTBJYXMWhEf" 0.23111090
You can also generate blocks:
.\docker-bitcoin-generate.ps1 3
Using Polar to test Lightning payments
- Install and run Polar. Setup a small network of nodes.
- Go to your store's General Settings and enable Lightning.
- Build your connection string using the Connect information in the Polar app.
LND Connection string example: type=lnd-rest;server=https://127.0.0.1:8084/;macaroonfilepath="local path to admin.macaroon on your computer, without these quotes";allowinsecure=true
Now you can create a Lightning invoice on BTCPay Server regtest and make a payment through Polar.
PLEASE NOTE: You may get an exception break in Visual Studio. You must quickly click "Continue" in VS so the invoice is generated. Or, uncheck the box that says, "Break when this exception type is thrown".
Using the test litecoin-cli
Same as bitcoin-cli, but with .\docker-litecoin-cli.ps1 and .\docker-litecoin-cli.sh instead.
Using the test lightning-cli
If you are using Linux:
./docker-customer-lightning-cli.sh pay lnbcrt100u1pd2e6uspp5ajnadvhazjrz55twd5k6yeg9u87wpw0q2fdr7g960yl5asv5fmnqdq9d3hkccqpxmedyrk0ehw5ueqx5e0r4qrrv74cewddfcvsxaawqz7634cmjj39sqwy5tvhz0hasktkk6t9pqfdh3edmf3z09zst5y7khv3rvxh8ctqqw6mwhh
If you are using Powershell:
.\docker-customer-lightning-cli.ps1 pay lnbcrt100u1pd2e6uspp5ajnadvhazjrz55twd5k6yeg9u87wpw0q2fdr7g960yl5asv5fmnqdq9d3hkccqpxmedyrk0ehw5ueqx5e0r4qrrv74cewddfcvsxaawqz7634cmjj39sqwy5tvhz0hasktkk6t9pqfdh3edmf3z09zst5y7khv3rvxh8ctqqw6mwhh
If you get this message:
{ "code" : 205, "message" : "Could not find a route", "data" : { "getroute_tries" : 1, "sendpay_tries" : 0 } }
Please, run the test CanSetLightningServer, this will establish a channel between the customer and the merchant, then, retry.
Alternatively you can run the ./docker-lightning-channel-setup.sh script to establish the channel connection.
The ./docker-lightning-channel-teardown.sh script closes any existing lightning channels.
Alternative Lightning testing: Using Polar to test Lightning payments
- Install and run Polar. Setup a small network of nodes.
- Go to your store's General Settings and enable Lightning.
- Build your connection string using the Connect information in the Polar app.
LND Connection string example: type=lnd-rest;server=https://127.0.0.1:8084/;macaroonfilepath="local path to admin.macaroon on your computer, without these quotes";allowinsecure=true
Now you can create a lightning invoice on BTCPay Server regtest and make a payment through Polar.
PLEASE NOTE: You may get an exception break in Visual Studio. You must quickly click "Continue" in VS so the invoice is generated. Or, uncheck the box that says, "Break when this exception type is thrown".
FAQ
docker-compose up dev failed or tests are not passing, what should I do?
- Run
docker-compose down --volumes(this will reset your test environment) - Run
docker-compose pull(this will ensure you have the latest images) - Run again with
docker-compose up dev
How to run the Altcoin environment?
docker-compose -f docker-compose.altcoins.yml up dev
If you still have issues, try to restart docker.
How to run the Selenium test with a browser?
Run dotnet user-secrets set RunSeleniumInBrowser true to run tests in browser.
To switch back to headless mode (recommended) you can run dotnet user-secrets remove RunSeleniumInBrowser.
Session not created: This version of ChromeDriver only supports Chrome version 88
When you run tests for selenium, you may end up with this error. This happen when we update the selenium packages on BTCPay Server while you did not update your chrome version.
If you want to use a older chrome driver on this page then point to it with
dotnet user-secrets set ChromeDriverDirectory "path/to/the/driver/directory"