diff --git a/content/medusajs/plugins/_meta.js b/content/medusajs/plugins/_meta.js index 3585991..7a9d256 100644 --- a/content/medusajs/plugins/_meta.js +++ b/content/medusajs/plugins/_meta.js @@ -2,6 +2,7 @@ export default { "get-started": "Get started", "available": "Available plugins", "automations": "Automations", - "notifications": "Notifications" + "notifications": "Notifications", + "bitcoin-lightning-clink": "Bitcoin Lightning (CLINK)" } \ No newline at end of file diff --git a/content/medusajs/plugins/available/index.mdx b/content/medusajs/plugins/available/index.mdx index a32581c..a8924dd 100644 --- a/content/medusajs/plugins/available/index.mdx +++ b/content/medusajs/plugins/available/index.mdx @@ -11,3 +11,4 @@ sidebarTitle: Available plugins | [Notifications](/medusajs/plugins/notifications/get-started) | Codee Team | Reviewed | Transactional notifications with template system, admin builder, and rendering workflows for email and Slack | | [Reorder](/medusajs/plugins/reorder/get-started) | Reorder | In Review | Subscription management plugin — billing cycles, automated renewals, dunning, retention flows, and analytics | | [Avalara](/medusajs/plugins/avalara/get-started) | Avalara | In Review | Official Avalara-certified tax automation plugin for Medusa — real-time tax calculations, order transaction management, and address validation powered by AvaTax API. | +| [Bitcoin Lightning (CLINK)](/medusajs/plugins/bitcoin-lightning-clink/get-started) | WoompaLoompa | In Review | Accept Bitcoin Lightning payments via the CLINK protocol. Self-custodial, instant settlement, subscriptions via nDebit. | diff --git a/content/medusajs/plugins/bitcoin-lightning-clink/get-started/index.mdx b/content/medusajs/plugins/bitcoin-lightning-clink/get-started/index.mdx new file mode 100644 index 0000000..e290551 --- /dev/null +++ b/content/medusajs/plugins/bitcoin-lightning-clink/get-started/index.mdx @@ -0,0 +1,91 @@ +--- +title: Get started +sidebarTitle: Get started +--- + +# Bitcoin Lightning (CLINK) + +Accept Bitcoin Lightning payments for your Medusa store via the CLINK protocol. Self-custodial, instant settlement, with subscription support via nDebit. + +| Field | Details | +|-------|---------| +| **Status** | In Review | +| **Repository** | [github.com/WoompaLoompa/medusa-clink](https://github.com/WoompaLoompa/medusa-clink) | +| **Version** | | +| **Author** | [WoompaLoompa](https://github.com/WoompaLoompa) | + +## Features + +- **Self-Custodial** — Merchant runs their own Lightning node, no third-party custody +- **Instant Settlement** — Payments settle in seconds via Lightning Network +- **No Server Required** — Uses Nostr relays for transport, no web server needed +- **Auto Currency Conversion** — Real-time rates from CoinGecko, Kraken, Fixed, or Manual +- **QR Code + Copy** — Both QR code display and one-click copy for invoices +- **Dual Confirmation** — Webhook (primary) + Polling (backup) for reliable payment detection +- **Subscriptions** — Recurring payments via nDebit (CLINK Debits) +- **Privacy-Preserving** — Ephemeral keys for payment requests + +## Compatibility + +- **Medusa Version**: `>= 2.0.0` +- **Node Version**: `>= 20` +- **Lightning Node**: Any CLINK-compatible node (e.g., [Lightning.Pub](https://github.com/nicokosi/lightning-pub)) + +## Installation + +### 1. Install the package + +```bash +npm install medusa-plugin-bitcoin-lightning-via-clink +# or +yarn add medusa-plugin-bitcoin-lightning-via-clink +``` + +### 2. Register the plugin + +Add to your `medusa-config.ts`: + +```typescript +module.exports = defineConfig({ + plugins: [ + { + resolve: "medusa-plugin-bitcoin-lightning-via-clink", + id: "clink", + options: { + noffer: "noffer1...", // Your CLINK offer string + currencySource: "coingecko", // or "kraken", "fixed", "manual" + }, + }, + ], +}) +``` + +### 3. Configure + +1. Go to **Settings > Regions** in your Medusa admin +2. Enable **Lightning (CLINK)** as a payment provider +3. Set your `noffer` string (found in your CLINK-compatible wallet) + +## Configuration Options + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `noffer` | `string` | required | Your CLINK offer string (`noffer1...`) | +| `currencySource` | `string` | `"coingecko"` | Exchange rate provider: `coingecko`, `kraken`, `fixed`, `manual` | +| `fixedRate` | `number` | `null` | Fixed exchange rate (satoshis per unit) when using `fixed` source | +| `enableSubscriptions` | `boolean` | `false` | Enable subscription support via nDebit | + +## Links + +- [GitHub Repository](https://github.com/WoompaLoompa/medusa-clink) +- [npm package](https://www.npmjs.com/package/medusa-plugin-bitcoin-lightning-via-clink) +- [Wiki & Documentation](https://github.com/WoompaLoompa/medusa-clink/wiki) + +## License + +GPL-3.0 + +## Links + +- [GitHub Repository](https://github.com/WoompaLoompa/medusa-clink) +- [npm package](https://www.npmjs.com/package/medusa-plugin-bitcoin-lightning-via-clink)