Bitcoin lightning via clink

Bitcoin Lightning payment module for Medusa eCommerce via the CLINK protocol

npm install medusa-plugin-bitcoin-lightning-via-clink

Категория

Платежи

Создано

Woompaloompa

Версия

1.0.1

Последнее обновление

1 день назад

Ежемесячные загрузки

Звезды на Github

NPM Github

medusa-plugin-bitcoin-lightning-via-clink

Bitcoin Lightning payment module for MedusaJS eCommerce via the CLINK protocol.

Features

⚡ Lightning Payments - Accept Bitcoin Lightning payments via CLINK protocol
🔒 Self-Custodial - Your node, your funds, no third-party
🌐 Nostr-Native - All communication via Nostr relays, no web server needed
💱 Auto Conversion - CoinGecko, Kraken, Fixed rate, or Manual
🔄 Subscriptions - Auto-renewal via CLINK Debits (nDebit)
📱 QR + Copy - Beautiful QR codes with one-click copy for invoices
🔐 Privacy - Ephemeral Nostr keys for payment requests
🛡️ Dual Confirmation - Webhook (primary) + Polling (backup)
📊 Admin Dashboard - Configure everything from the Medusa admin panel

What's in the Box

Component	Description
	Core payment provider with CLINK SDK integration
	Fiat-to-sats conversion (CoinGecko, Kraken, Fixed, Manual)
	Recurring payments via nDebit protocol
Admin Settings Widget	Configure noffer, currency source, subscriptions, refunds
Storefront Component	QR code + copy + countdown timer + payment status polling
Webhook Endpoint	Real-time payment confirmations from CLINK relay
Status Endpoint	Backup polling for payment verification

Quick Start

1. Install

npm install medusa-plugin-bitcoin-lightning-via-clink

2. Configure

Add to your :

1import { Modules } from "@medusajs/framework/utils"
2
3module.exports = defineConfig({
modules: [
  {
    resolve: "@medusajs/medusa/payment",
    options: {
      providers: [
        {
          resolve: "medusa-plugin-bitcoin-lightning-via-clink",
          id: "clink",
          options: {
            noffer: "noffer1...", // Your CLINK offer string
            currencySource: "coingecko",
            invoiceTimeout: 600,
            debug: false
          }
        }
      ]
    }
  }
]
23})

3. Enable in Admin

Go to Settings > Regions
Edit your region
Enable Lightning (CLINK) as a payment provider

4. Accept Payments!

Customers can now pay with Lightning at checkout.

Documentation

Full documentation lives on the GitHub Wiki:

How It Works

1┌─────────────────────────────────────────────────────────────────┐
2│                        CHECKOUT FLOW                             │
3├─────────────────────────────────────────────────────────────────┤
4│                                                                  │
5│  Customer selects "Pay with Lightning"                           │
6│       │                                                          │
7│       ▼                                                          │
8│  Medusa requests invoice                                         │
9│       │                                                          │
10│       ▼                                                          │
11│  CLINK SDK decodes nOffer → requests BOLT11 from your node       │
12│       │                                                          │
13│       ▼                                                          │
14│  QR code + invoice displayed to customer                         │
15│       │                                                          │
16│       ▼                                                          │
17│  Customer scans QR with Lightning wallet                         │
18│       │                                                          │
19│       ▼                                                          │
20│  Payment confirmed via Webhook (primary) OR Polling (backup)     │
21│       │                                                          │
22│       ▼                                                          │
23│  Order confirmed! ⚡                                             │
24│                                                                  │
25└─────────────────────────────────────────────────────────────────┘

No web server needed for your Lightning node. All communication flows over Nostr. See the Wiki architecture page for the full data flow.

Requirements

Medusa v2.x
Node.js >= 18.0.0
A CLINK-compatible Lightning wallet/node:
- ShockWallet (iOS/Android/Desktop)
- Lightning.Pub (self-hosted)
- ZEUS (iOS/Android)
- Amethyst (Android)
- Electrum with CLINK plugin (Desktop)

Configuration Options

Type	Required	Default	Description
string	Yes	-	Your CLINK offer string
string	No		Exchange rate source
number	No	-	Fixed BTC rate (if using source)
number	No		Invoice expiry in seconds
number	No		Polling interval in ms
boolean	No		Enable nDebit subscriptions
string	No	-	Merchant email for refunds
string	No	-	Merchant Nostr for refunds
boolean	No		Enable debug logging

See the Configuration Wiki page for details on each option.

Supported Wallets

For Merchants (to get your ):

ShockWallet - Menu > Static Offer
Lightning.Pub - Dashboard > Offers
ZEUS - Settings > CLINK

For Customers (to pay):

Development

1# Install dependencies
2npm install
3
4# Run tests
5npm test
6
7# Build
8npm run build
9
10# Watch mode
11npm run dev

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details.

License

GPL-3.0 - See LICENSE for details.

Support

Еще в этой категории

Посмотреть все

Платежи

Braintree

От Lambda Curry

Поддержка платежей и 3D Secure через Braintree

Платежи

Pay.

От Webbers

Принимайте кредитные карты, цифровые платежи и купи сейчас — плати потом

Платежи

Mollie

От Variable Vic

Легко принимайте мультивалютные платежи через Mollie

Плагины

Bitcoin lightning via clink

Bitcoin Lightning payment module for Medusa eCommerce via the CLINK protocol

npm install medusa-plugin-bitcoin-lightning-via-clink

Категория

Платежи

Создано

Woompaloompa

Версия

1.0.1

Последнее обновление

1 день назад

Ежемесячные загрузки

Звезды на Github

NPM Github

medusa-plugin-bitcoin-lightning-via-clink

Bitcoin Lightning payment module for MedusaJS eCommerce via the CLINK protocol.

Features

⚡ Lightning Payments - Accept Bitcoin Lightning payments via CLINK protocol
🔒 Self-Custodial - Your node, your funds, no third-party
🌐 Nostr-Native - All communication via Nostr relays, no web server needed
💱 Auto Conversion - CoinGecko, Kraken, Fixed rate, or Manual
🔄 Subscriptions - Auto-renewal via CLINK Debits (nDebit)
📱 QR + Copy - Beautiful QR codes with one-click copy for invoices
🔐 Privacy - Ephemeral Nostr keys for payment requests
🛡️ Dual Confirmation - Webhook (primary) + Polling (backup)
📊 Admin Dashboard - Configure everything from the Medusa admin panel

What's in the Box

Component	Description
	Core payment provider with CLINK SDK integration
	Fiat-to-sats conversion (CoinGecko, Kraken, Fixed, Manual)
	Recurring payments via nDebit protocol
Admin Settings Widget	Configure noffer, currency source, subscriptions, refunds
Storefront Component	QR code + copy + countdown timer + payment status polling
Webhook Endpoint	Real-time payment confirmations from CLINK relay
Status Endpoint	Backup polling for payment verification

Quick Start

1. Install

npm install medusa-plugin-bitcoin-lightning-via-clink

2. Configure

Add to your :

1import { Modules } from "@medusajs/framework/utils"
2
3module.exports = defineConfig({
modules: [
  {
    resolve: "@medusajs/medusa/payment",
    options: {
      providers: [
        {
          resolve: "medusa-plugin-bitcoin-lightning-via-clink",
          id: "clink",
          options: {
            noffer: "noffer1...", // Your CLINK offer string
            currencySource: "coingecko",
            invoiceTimeout: 600,
            debug: false
          }
        }
      ]
    }
  }
]
23})

3. Enable in Admin

Go to Settings > Regions
Edit your region
Enable Lightning (CLINK) as a payment provider

4. Accept Payments!

Customers can now pay with Lightning at checkout.

Documentation

Full documentation lives on the GitHub Wiki:

How It Works

1┌─────────────────────────────────────────────────────────────────┐
2│                        CHECKOUT FLOW                             │
3├─────────────────────────────────────────────────────────────────┤
4│                                                                  │
5│  Customer selects "Pay with Lightning"                           │
6│       │                                                          │
7│       ▼                                                          │
8│  Medusa requests invoice                                         │
9│       │                                                          │
10│       ▼                                                          │
11│  CLINK SDK decodes nOffer → requests BOLT11 from your node       │
12│       │                                                          │
13│       ▼                                                          │
14│  QR code + invoice displayed to customer                         │
15│       │                                                          │
16│       ▼                                                          │
17│  Customer scans QR with Lightning wallet                         │
18│       │                                                          │
19│       ▼                                                          │
20│  Payment confirmed via Webhook (primary) OR Polling (backup)     │
21│       │                                                          │
22│       ▼                                                          │
23│  Order confirmed! ⚡                                             │
24│                                                                  │
25└─────────────────────────────────────────────────────────────────┘

No web server needed for your Lightning node. All communication flows over Nostr. See the Wiki architecture page for the full data flow.

Requirements

Medusa v2.x
Node.js >= 18.0.0
A CLINK-compatible Lightning wallet/node:
- ShockWallet (iOS/Android/Desktop)
- Lightning.Pub (self-hosted)
- ZEUS (iOS/Android)
- Amethyst (Android)
- Electrum with CLINK plugin (Desktop)

Configuration Options

Type	Required	Default	Description
string	Yes	-	Your CLINK offer string
string	No		Exchange rate source
number	No	-	Fixed BTC rate (if using source)
number	No		Invoice expiry in seconds
number	No		Polling interval in ms
boolean	No		Enable nDebit subscriptions
string	No	-	Merchant email for refunds
string	No	-	Merchant Nostr for refunds
boolean	No		Enable debug logging

See the Configuration Wiki page for details on each option.

Supported Wallets

For Merchants (to get your ):

ShockWallet - Menu > Static Offer
Lightning.Pub - Dashboard > Offers
ZEUS - Settings > CLINK

For Customers (to pay):

Development

1# Install dependencies
2npm install
3
4# Run tests
5npm test
6
7# Build
8npm run build
9
10# Watch mode
11npm run dev

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details.

License

GPL-3.0 - See LICENSE for details.

Support

Еще в этой категории

Посмотреть все

Платежи

Braintree

От Lambda Curry

Поддержка платежей и 3D Secure через Braintree

Платежи

Pay.

От Webbers

Принимайте кредитные карты, цифровые платежи и купи сейчас — плати потом

Платежи

Mollie

От Variable Vic

Легко принимайте мультивалютные платежи через Mollie