ZipZap

Social media tipping using Lightning, BOLT 12, & Nostr

⚡️ Try it out ⚡️

You will need a BOLT 12 enabled wallet/node in order to zap on this site, but you can still see the zaps without a wallet.

Development

First, run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

To use the wallet features, you will need to run phoenixd on the same server (or local dev env) as the website. You will also need to set NEXT_PUBLIC_USE_WALLET to true and add the PHOENIX_API_PASSWORD in .env.

ZipZap Protocol

NIP-XX Draft - Work in Progress

ZipZap Request

Draft of a ZipZap request note

{
  "kind": 9912,
  "content": "ZipZap!",
  "tags": [
    ["relays", "wss://mynostrrelay.xyz"],
    ["lno", "{lno_from_profile_of_post_author}"],
    ["p", "{pubkey_of_author_of_the_post}"],
    ["e", "{id_of_the_post}"]
  ],
  "pubkey": "{my_pubkey}",
  "created_at": {current_unix_timestamp},
  "id": "{event_id}",
  "sig": "{event_signature}"
}

ZipZap Receipt

Draft of a ZipZap Receipt note

{
    "id": "{event_id}",
    "pubkey": "{my_pubkey_as_recipient}",
    "created_at": {invoice_paid_at},
    "kind": 9913,
    "tags": [
      ["p", "{my_pubkey_as_recipient}"],
      ["P", "{pubkey_of_zipzapsender (creator of the 9912 event)}"],
      ["e", "{id_of_my_post_that_was_zipzapped}"],
      ["lno", "{lno_from_profile_of_post_author}"],
      ["amount", {amount_of_payment}]
    ],
    "content": "",
    "sig": "{event_signature}"
  }

Sequence Diagram

sequenceDiagram
    participant Alice_Nostr as Alice's Nostr Client
    participant Alice_Lightning as Alice's Lightning Wallet
    participant Relays as Nostr Relays
    participant Bob_Nostr as Bob's Nostr Client
    participant Bob_Lightning as Bob's Lightning Wallet
    
    Note over Alice_Nostr: Alice adds 'lno' field to profile (kind 0)
    Alice_Nostr->>Relays: Publish updated profile with 'lno' field
    
    Note over Bob_Nostr: Bob sees Alice's post he wants to ZipZap
    
    Bob_Nostr->>Relays: Create & publish kind 9912 ZipZap Request
    Note over Bob_Nostr: References Alice's post ID<br>Includes Alice's offer
    
    Bob_Nostr->>Bob_Nostr: Generate bech32 'note...' of ZipZap Request
    
    Bob_Nostr->>Bob_Lightning: Send bech32 note ID
    
    Bob_Lightning->>Alice_Lightning: invoice_request with payerNote<br>containing note ID
    
    Alice_Lightning->>Alice_Lightning: Process payment
    
    Alice_Lightning->>Alice_Nostr: Signal payment with note ID in payerNote
    
    Alice_Nostr->>Relays: Query for 9912 ZipZap Request matching note ID
    Relays->>Alice_Nostr: Return matching ZipZap Request
    
    Note over Alice_Nostr: Alice learns Bob's pubkey ZipZapped her post
    
    Alice_Nostr->>Relays: Sign & broadcast kind 9913 ZipZap Receipt
    
    Note over Relays: Compatible clients will render ZipZap receipt in UI

Loading