f8cd37ac8c
Includes: API (Express/TypeScript), Astro site, Python workers, document generators, FCC compliance tools, Canada CRTC formation, Ansible infrastructure, and deployment scripts. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
42 lines
1.3 KiB
Markdown
42 lines
1.3 KiB
Markdown
# Crypto Payment Gateway (frappe_crypto)
|
|
|
|
SHKeeper-based cryptocurrency payment gateway for ERPNext.
|
|
|
|
Accepts BTC, ETH, USDC, USDT, MATIC, TRX, BNB, LTC, DOGE, and any coin supported by your SHKeeper instance.
|
|
|
|
## Requirements
|
|
|
|
- Frappe >= 15.0.0
|
|
- [payments](https://github.com/frappe/payments) app installed
|
|
- A running [SHKeeper](https://shkeeper.io/) instance
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
bench get-app https://github.com/performancewest/frappe_crypto.git
|
|
bench --site your-site install-app frappe_crypto
|
|
```
|
|
|
|
## Configuration
|
|
|
|
1. Go to **Crypto Payment Settings** in the sidebar
|
|
2. Set **Gateway Name** (e.g. "Crypto")
|
|
3. Enter your **SHKeeper URL** (e.g. `https://pay.performancewest.net`)
|
|
4. Enter your **API Key** from SHKeeper
|
|
5. Optionally set a **Default Crypto** (e.g. "BTC")
|
|
6. Click **Test Connection** to verify
|
|
|
|
## How It Works
|
|
|
|
1. Customer selects crypto payment at checkout
|
|
2. ERPNext creates a Payment Request and redirects to `/crypto_checkout`
|
|
3. The checkout page calls SHKeeper to create a crypto invoice
|
|
4. Customer sees the wallet address, QR code, and amount in crypto
|
|
5. Page auto-polls for payment confirmation every 5 seconds
|
|
6. SHKeeper sends a webhook when payment is received
|
|
7. Webhook handler creates a Payment Entry and marks the Payment Request as Paid
|
|
8. Customer sees a success message and is redirected
|
|
|
|
## License
|
|
|
|
MIT
|