summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 77eea61974bda21dbd0dfbff58e8aea2541ce766 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# nostr

A zero-dependency Go library for the [Nostr protocol](https://github.com/nostr-protocol/nostr).

```bash
go get code.northwest.io/nostr
```

## Why This Library?

You probably shouldn't use it.

This library rolls its own secp256k1 cryptography in pure Go. No CGO, no external dependencies, no nothing. I built it to see if it was possible to implement Nostr with truly zero dependencies. It is. But that doesn't mean it's a good idea.

**What you get:**
- Zero external dependencies
- Fully auditable pure-Go crypto
- Passes all BIP-340 test vectors
- Works fine for normal Nostr usage

**What you're giving up:**
- Constant-time operations (timing attacks are theoretically possible)
- Performance (~10x slower than btcec)
- Battle-tested crypto code

If you're building something serious, use a library backed by btcec. If you're hacking on a side project or just want to read the code, welcome.

## What's Included

- **Keys** — Generate, parse, sign, verify (hex and bech32/npub/nsec)
- **Events** — Create, serialize, sign NIP-01 events  
- **Filters** — Build and match subscription filters
- **Relay** — WebSocket pub/sub (stdlib only)
- **Tags** — Parse and build event tags
- **Envelopes** — Protocol message parsing

## Usage

```go
package main

import (
    "context"
    "fmt"
    "code.northwest.io/nostr"
)

func main() {
    // Generate a key pair
    key, _ := nostr.GenerateKey()
    fmt.Println("npub:", key.Npub())

    // Create and sign an event
    event := &nostr.Event{
        Kind:    nostr.KindTextNote,
        Content: "Hello Nostr!",
    }
    key.Sign(event)

    // Connect and publish
    ctx := context.Background()
    relay, _ := nostr.Connect(ctx, "wss://relay.damus.io")
    defer relay.Close()
    
    relay.Publish(ctx, event)
}
```

## Examples

See [examples/basic](examples/basic) for a runnable example.

## License

MIT