FunkPay

FunkPay is an innovative Python library designed to streamline Bitcoin on-chain payments, enabling a self-custodial experience without reliance on middlemen. Your keys, your coins.

Key Features

• Self-Custodial: Funds go directly to the user's wallet; private keys remain untouched by FunkPay.
• No Third-Party Involvement: Operate entirely on your own Bitcoin Core node, ensuring full data control.
• BIP84 Address Derivation: Uses pure Python standard libraries, eliminating the need for external cryptography dependencies.
• Embeddable JavaScript Widget: With just one <script> tag, integrate a payment widget seamlessly into any website.
• Multi-Currency Support: Display payments in various fiat currencies, including USD, EUR, GBP, JPY, CAD, CHF, and AUD.
• Reorg-Safe: Automatically handles blockchain reorganizations to ensure payment reliability.
• Async and Sync Compatibility: Functions effectively as a standalone service or within FastAPI and other asyncio applications.
• SQLite Storage: Simplifies setup with no requirement for an external database.

How FunkPay Works

FunkPay allows seamless payment processing by monitoring transactions through a user's Bitcoin Core node. It provides immediate feedback on transaction status:

• detected — Transaction is visible in the mempool, suitable for initiating user experiences such as unlocks for digital goods.
• confirmed — Transaction is settled after the required confirmations, ensuring safe delivery of physical goods or activation of services.

Simple Integration

Getting started requires minimal setup:

1. Setup the library: Clone the repository and install it in your environment.
2. Configure your Bitcoin settings in the provided configuration file to specify your extended public key and RPC URL.
3. Implement the Payment Processor in your Python application to start handling transactions. Below is an example of how to create an invoice:

   from btcfunkpay import PaymentProcessor, load_config
   
   cfg = load_config()
   proc = PaymentProcessor(xpub=cfg.xpub, rpc_url=cfg.rpc_url)
   inv = proc.create_invoice(amount_sat=50_000, label="order-123")
   print(inv.bip21_uri)  # Outputs the payment URI
   

4. Optionally, utilize the embeddable JavaScript widget for a user-friendly browser integration that allows for immediate payment interactions.

   <div id="funkpay" data-server="https://pay.example.com" data-currency="USD"></div>
   <script src="https://btcfunk.com/pay/funkpay.js"></script>
   

5. Webhook support is available for backend notifications to maintain a reliable payment processing experience, regardless of user interaction.

Live Demo

Explore FunkPay's live demo to see the process in action. The simplicity and elegance of FunkPay position it as a great choice for developers looking to implement secure and efficient Bitcoin payment solutions swiftly.