Home

medusa-plugin-bitcoin-lightning-via-clink

Welcome to the medusa-plugin-bitcoin-lightning-via-clink wiki!

This plugin enables Bitcoin Lightning payments for MedusaJS eCommerce stores via the CLINK protocol.

Quick Links

• Getting Started - Installation and basic setup
• Configuration - All available options
• Guide for Merchants - Setting up your store
• Guide for Customers - How to pay
• Subscriptions - Auto-renewal with nDebit
• Currency Sources - Exchange rate providers
• Troubleshooting - Common issues and fixes
• Contributing - How to contribute
• Changelog - Version history
• FAQ - Frequently asked questions

What is CLINK?

CLINK (Common Lightning Interface for Nostr Keys) is a protocol for Lightning Network payments that uses Nostr for transport. Unlike traditional methods, it doesn't require a web server for your Lightning node.

Benefits

• ⚡ Instant payments - Settled in seconds
• 🔒 Self-custodial - Your node, your funds
• 🌐 No server required - Uses Nostr relays
• 🔐 Privacy-preserving - Ephemeral keys for requests

Getting Started in 3 Steps

1. Install

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

2. Configure

// medusa-config.ts
{
  resolve: "medusa-plugin-bitcoin-lightning-via-clink",
  id: "clink",
  options: {
    noffer: "noffer1...",  // Your CLINK offer
    currencySource: "coingecko"
  }
}

3. Enable

Go to Settings > Regions and enable Lightning (CLINK).

Architecture

┌─────────────┐     ┌─────────────┐     ┌─────────────┐
│  Customer   │────▶│  Storefront │────▶│   Medusa    │
│  (Wallet)   │◀────│  (QR Code)  │◀────│  (Plugin)   │
└─────────────┘     └─────────────┘     └─────────────┘
                           │                    │
                           │      Nostr         │
                           └────────────────────┘
                                    │
                           ┌────────────────────┐
                           │  Merchant's Node   │
                           │  (Lightning.Pub)   │
                           └────────────────────┘

Support

• GitHub Issues
• Discussions
• In Medusa GH forum: https://github.com/medusajs/medusa/discussions/16162
• In Medusa Discord: https://discord.com/channels/876835651130097704/1529853260276437123

License

GPL-3.0