CypherpunkPay is a modern self-hosted software for accepting Bitcoin donations or Bitcoin payments as a merchant.

Being a single, self-contained Linux daemon, it is uniquely easy to install, with no dependencies, near-zero configuration and low hardware requirements.

See the official website (Tor onion).

All docs are available on the official website (Tor onion).

• Linux
• Python 3.9

After cloning this repo, review and run:

bin/dev-setup

This will update pip, install poetry and then use poetry to install dependencies.

To run the app in development environment, start the server:

bin/dev-server

...then go to http://127.0.0.1:6543/

Admin panel: http://127.0.0.1:6543/cypherpunkpay/admin/eeec6kyl2rqhys72b6encxxrte/

Dummy store: http://127.0.0.1:6543/cypherpunkpay/dummystore/

To run just the unit tests:

bin/test-unit

The database for tests is separate from development and gets reset on each test run.

To run the full test suite you need on your development laptop:

• testnet bitcoind running
  • unpruned
  • synced-up
  • with default settings
  • with ZMQ notifications enabled for LND:

    zmqpubrawblock=tcp://127.0.0.1:28332
    zmqpubrawtx=tcp://127.0.0.1:28333
    

• testnet lnd running
  • connected and synced-up against your bitcoind
  • TODO: this probably needs more guidance

Then:

bin/test

Just remove database file:

rm /tmp/cypherpunkpay_dev.sqlite3

CypherpunkPay is "dual-licensed" under Unlicense OR MIT. The Unlicense attempts to explicitly put CypherpunkPay in the public domain, while MIT is an alternative or fallback if you need it for legal reasons.

SPDX-License-Identifier: Unlicense OR MIT