https://github.com/samsamskies/lnurl-zap

Generate LNURLs for Nostr events.
https://github.com/samsamskies/lnurl-zap

Last synced: 6 months ago
JSON representation

Generate LNURLs for Nostr events.

• Host: GitHub
• URL: https://github.com/samsamskies/lnurl-zap
• Owner: SamSamskies
• License: mit
• Created: 2024-08-11T19:59:51.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-12T01:11:17.000Z (almost 2 years ago)
• Last Synced: 2025-10-21T20:08:49.002Z (9 months ago)
• Language: TypeScript
• Size: 68.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# nostr-build

[![NPM](https://img.shields.io/npm/v/lnurl-zap.svg)](https://www.npmjs.com/package/lnurl-zap)

Generate LNURLs for Nostr events.

## Installation

Install the package with:

```bash

npm i lnurl-zap

# or

yarn add lnurl-zap

```

## Usage

### encodeLnurl

Allows you to create LNULs for Nostr events.

```

id: string; // Any Nostr ID e.g. note ID, npub, nevent, etc.

lnurlZapServerBaseUrl?: string // Base URL for LNURL server endpoint that broadcasts anonymous zaps when LNURLs are paid. Defaults to https://lnurlzap.com/api/zap. 

@returns string // e.g. LNURL1DP68GURN8GHJ7MRWW4EXC7NPWQH8VETJVDJKCTNPWPCZ7CTSDYHH5CTS9AH8QATZX9M8QWRXV33HJET2VS68QUT209EX56EEWDNH5D3CWE6KSUFHWPUHVMN6DVUX5VR9DPKXC6NKWANHQWRWXEJHZUMJDEC8XACJW3JE6

```

Example:

```js

import { encodeLnurl } from "lnurl-zap";

console.log(encodeLnurl('npub1vp8fdcyejd4pqjyrjk9sgz68vuhq7pyvnzk8j0ehlljvwgp8n6eqsrnpsw'))

```