LNbits Docs

Appearance

Nostr NIP-5

Nostr NIP-5

GitHub stars

Sell Nostr NIP-05 verification identifiers.

Social & NostrOpen Source
Source API Docs

Allow users to NIP-05 verify themselves at a domain you control ​

This extension allows users to sell NIP-05 verification to other nostr users on a domain they control.

Usage ​

  1. Create a Domain by clicking "NEW DOMAIN"\
  2. Fill the options for your DOMAIN
    • select the wallet
    • select the fiat currency the invoice will be denominated in
    • select an amount in fiat to charge users for verification
    • enter the domain (or subdomain) you want to provide verification for
      • Note, you must own this domain and have access to a web server
  3. You can then use share your signup link with your users to allow them to sign up

Pricing strategies ​

On top of the base price per year, each domain supports three optional rules you can combine:

  • Length-based — charge more for short, memorable names (e.g. ≤3 chars at 8×, ≤4 at 4×).
  • Popularity — charge more for names that appear in the Cloudflare top-domains list. Requires a read-only Cloudflare API token in the extension settings.
  • Promo codes — offer buyer discounts and/or reward referrers at checkout.

The highest matching premium is used, multiplied by the selected years, then any promo code is applied. Use the live preview on the domain page to test what a buyer would pay.

Refunds ​

If a buyer pays but their handle can't be activated (for example, two buyers race for the same name), the extension records what you owe them on that identity row.

The orange "Refund owed" chip is your to-do list of payments you owe back because their handle couldn't be activated. Click it, scan the QR with your admin wallet to pay it, and the buyer gets their sats back.

Note: automatic refunds only work when the buyer paid from an LNbits wallet — direct-Lightning-only buyers have no wallet to credit back to. In that case you still hold the sats, so the alternative is to use "Issue identity manually" and "Activate without payment" to deliver the handle they paid for.

Installation ​

In order for this to work, you need to have ownership of a domain name, and access to a web server that this domain is pointed to.

Then, you'll need to set up a proxy that points https://{your_domain}/.well-known/nostr.json to https://{your_lnbits}/nostrnip5/api/v1/domain/{domain_id}/nostr.json

Example nginx configuration

## Proxy Server Caching
proxy_cache_path /tmp/nginx_cache keys_zone=nip5_cache:5m levels=1:2 inactive=300s max_size=100m use_temp_path=off;

location /.well-known/nostr.json {
   proxy_pass https://{your_lnbits}/nostrnip5/api/v1/domain/{domain_id}/nostr.json;
   proxy_set_header Host {your_lnbits};
   proxy_ssl_server_name on;

   expires 5m;
   add_header Cache-Control "public, no-transform";

   proxy_cache nip5_cache;
   proxy_cache_lock on;
   proxy_cache_valid 200 300s;
   proxy_cache_use_stale error timeout invalid_header updating http_500 http_502 http_503 http_504;
}

Example Caddy configuration ​

my.lnbits.instance {
    reverse_proxy {your_lnbits}
}

nip.5.domain {
    route /.well-known/nostr.json {
        rewrite * /nostrnip5/api/v1/domain/{domain_id}/nostr.json
        reverse_proxy {your_lnbits}
    }
}

API Reference ​

See the Nostr NIP-5 API documentation for endpoint details.