update readme.

README.md

@@ -2,10 +2,12 @@
 
 this repository contains two things:
 
-## a command-line tool for decoding and encoding nostr entities
+## a command-line tool for decoding and encoding nostr entities and talking to relays
 
 Install with `go install github.com/fiatjaf/nak`.
 
+It pairs nicely with https://github.com/blakejakopovic/nostcat using unix pipes.
+
 ### examples
 
 ```
@@ -41,7 +43,7 @@ USAGE:
    nak [global options] command [command options] [arguments...]
 
 COMMANDS:
-   req      generates an encoded REQ message to be sent to a relay
+   req      generates encoded REQ messages and optionally use them to talk to relays
    event    generates an encoded event
    decode   decodes nip19, nip21, nip05 or hex entities
    help, h  Shows a list of commands or help for one command
@@ -75,17 +77,23 @@ OPTIONS:
 
 ~> nak req --help
 NAME:
-   nak req - generates an encoded REQ message to be sent to a relay
+   nak req - generates encoded REQ messages and optionally use them to talk to relays
 
 USAGE:
-   nak req [command options] [arguments...]
+   nak req [command options] [relay...]
 
 DESCRIPTION:
+   outputs a NIP-01 Nostr filter. when a relay is not given, will print the filter, otherwise will connect to the given relay and send the filter.
+
    example usage (with 'nostcat'):
        nak req -k 1 -a 3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d | nostcat wss://nos.lol
 
+   standalone:
+       nak req -k 1 wss://nos.lol
+
 OPTIONS:
-   --bare  print just the filter, not enveloped in a ["REQ", ...] array (default: false)
+   --bare    when printing the filter, print just the filter, not enveloped in a ["REQ", ...] array (default: false)
+   --stream  keep the subscription open, printing all events as they are returned (default: false, will close on EOSE)
 
    FILTER ATTRIBUTES
 
@@ -99,6 +107,24 @@ OPTIONS:
    -e value [ -e value ]                                  shortcut for --tag e=<value>
    -p value [ -p value ]                                  shortcut for --tag p=<value>
 
+
+OPTIONS:
+   --bare    when printing the filter, print just the filter, not enveloped in a ["REQ", ...] array (default: false)
+   --stream  keep the subscription open, printing all events as they are returned (default: false, will close on EOSE)
+
+   FILTER ATTRIBUTES
+
+   --author value, -a value [ --author value, -a value ]  only accept events from these authors (pubkey as hex)
+   --id value, -i value [ --id value, -i value ]          only accept events with these ids (hex)
+   --kind value, -k value [ --kind value, -k value ]      only accept events with these kind numbers
+   --limit value, -l value                                only accept up to this number of events (default: 0)
+   --since value, -s value                                only accept events newer than this (unix timestamp) (default: 0)
+   --tag value, -t value [ --tag value, -t value ]        takes a tag like -t e=<id>, only accept events with these tags
+   --until value, -u value                                only accept events older than this (unix timestamp) (default: 0)
+   -e value [ -e value ]                                  shortcut for --tag e=<value>
+   -p value [ -p value ]                                  shortcut for --tag p=<value>
+
+
 ~> nak decode --help
 NAME:
    nak decode - decodes nip19, nip21, nip05 or hex entities
@@ -119,7 +145,7 @@ OPTIONS:
    --help, -h    show help
 ```
 
-written in go using [go-nostr](https://github.com/nbd-wtf/go-nostr) and distributed as a single binary.
+written in go using [go-nostr](https://github.com/nbd-wtf/go-nostr), heavily inspired by [nostril](http://git.jb55.com/nostril/).
 
 ## a toolkit for debugging all things nostr as a webpage:
 

decode.go

@@ -58,7 +58,7 @@ var decode = &cli.Command{
 			}
 		} else if evp := sdk.InputToEventPointer(input); evp != nil {
 			decodeResult = DecodeResult{EventPointer: evp}
-		} else if pp := sdk.InputToProfile(input); pp != nil {
+		} else if pp := sdk.InputToProfile(c.Context, input); pp != nil {
 			decodeResult = DecodeResult{ProfilePointer: pp}
 		} else if prefix, value, err := nip19.Decode(input); err == nil && prefix == "naddr" {
 			ep := value.(nostr.EntityPointer)

go.mod

@@ -3,7 +3,7 @@ module github.com/fiatjaf/nak
 go 1.20
 
 require (
-	github.com/nbd-wtf/go-nostr v0.17.3
+	github.com/nbd-wtf/go-nostr v0.18.3
 	github.com/urfave/cli/v2 v2.25.3
 )
 
@@ -15,10 +15,16 @@ require (
 	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
 	github.com/decred/dcrd/crypto/blake256 v1.0.0 // indirect
 	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.0.1 // indirect
-	github.com/gorilla/websocket v1.4.2 // indirect
+	github.com/gobwas/httphead v0.1.0 // indirect
+	github.com/gobwas/pool v0.2.1 // indirect
+	github.com/gobwas/ws v1.2.0 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
+	github.com/tidwall/gjson v1.14.4 // indirect
+	github.com/tidwall/match v1.1.1 // indirect
+	github.com/tidwall/pretty v1.2.0 // indirect
 	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
 	golang.org/x/exp v0.0.0-20221106115401-f9659909a136 // indirect
+	golang.org/x/sys v0.6.0 // indirect
 )

go.sum

@@ -37,6 +37,12 @@ github.com/decred/dcrd/dcrec/secp256k1/v4 v4.0.1/go.mod h1:hyedUtir6IdtD/7lIxGeC
 github.com/decred/dcrd/lru v1.0.0/go.mod h1:mxKOwFd7lFjN2GZYsiz/ecgqR6kkYAl+0pz0tEMk218=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
 github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ=
+github.com/gobwas/httphead v0.1.0 h1:exrUm0f4YX0L7EBwZHuCF4GDp8aJfVeBrlLQrs6NqWU=
+github.com/gobwas/httphead v0.1.0/go.mod h1:O/RXo79gxV8G+RqlR/otEwx4Q36zl9rqC5u12GKvMCM=
+github.com/gobwas/pool v0.2.1 h1:xfeeEhW7pwmX8nuLVlqbzVc7udMDrwetjEv+TZIz1og=
+github.com/gobwas/pool v0.2.1/go.mod h1:q8bcK0KcYlCgd9e7WYLm9LpyS+YeLd8JVDW6WezmKEw=
+github.com/gobwas/ws v1.2.0 h1:u0p9s3xLYpZCA1z5JgCkMeB34CKCMMQbM+G8Ii7YD0I=
+github.com/gobwas/ws v1.2.0/go.mod h1:hRKAFb8wOxFROYNsT1bqfWnhX+b5MFeJM9r2ZSwg/KY=
 github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
 github.com/golang/protobuf v1.4.0-rc.1/go.mod h1:ceaxUfeHdC40wWswd/P6IGgMaK3YpKi5j83Wpe3EHw8=
 github.com/golang/protobuf v1.4.0-rc.1.0.20200221234624-67d41d38c208/go.mod h1:xKAWHe0F5eneWXFV3EuXVDTCmh+JuBKY0li0aMyXATA=
@@ -48,8 +54,6 @@ github.com/golang/snappy v0.0.4/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEW
 github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
 github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
 github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc=
-github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
 github.com/jessevdk/go-flags v0.0.0-20141203071132-1679536dcc89/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
 github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
@@ -59,8 +63,8 @@ github.com/jrick/logrotate v1.0.0/go.mod h1:LNinyqDIJnpAur+b8yyulnQw/wDuN1+BYKlT
 github.com/kkdai/bstream v0.0.0-20161212061736-f391b8402d23/go.mod h1:J+Gs4SYgM6CZQHDETBtE9HaSEkGmuNXF86RwHhHUvq4=
 github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0=
 github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
-github.com/nbd-wtf/go-nostr v0.17.3 h1:OG/85OgjandmHfnVZmr/qsnMPbkVaIaJyXHMBI3ywIE=
-github.com/nbd-wtf/go-nostr v0.17.3/go.mod h1:YCDHJtaFQE76d1ZkcUsTkz3dYNP+bldo5CIQwXPPcbk=
+github.com/nbd-wtf/go-nostr v0.18.3 h1:ofMYxlFAptyoErlOGOCUk7zGHQNJ8/ZkIXXOsveFZ+c=
+github.com/nbd-wtf/go-nostr v0.18.3/go.mod h1:GPJOOK8US38kz+bfb9nWe873Xu0e6bXlThejOs1LTkc=
 github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A=
 github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=
 github.com/onsi/ginkgo v1.7.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=
@@ -76,6 +80,12 @@ github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQD
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7/go.mod h1:q4W45IWZaF22tdD+VEXcAWRA037jwmWEB5VWYORlTpc=
+github.com/tidwall/gjson v1.14.4 h1:uo0p8EbA09J7RQaflQ1aBRffTR7xedD2bcIVSYxLnkM=
+github.com/tidwall/gjson v1.14.4/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
+github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
+github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
+github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs=
+github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
 github.com/urfave/cli/v2 v2.25.3 h1:VJkt6wvEBOoSjPFQvOkv6iWIrsJyCrKGtCtxXWwmGeY=
 github.com/urfave/cli/v2 v2.25.3/go.mod h1:GHupkWPMM0M/sj1a2b4wUrWBPzazNrIjouW6fmdJLxc=
 github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU=
@@ -101,6 +111,8 @@ golang.org/x/sys v0.0.0-20191120155948-bd437916bb0e/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200519105757-fe76b779f299/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20200814200057-3d37ad5750ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.6.0 h1:MVltZSvRTcU2ljQOhs94SXPftV6DCNnZViHeQps87pQ=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=

req.go

@@ -13,9 +13,14 @@ const CATEGORY_FILTER_ATTRIBUTES = "FILTER ATTRIBUTES"
 
 var req = &cli.Command{
 	Name:  "req",
-	Usage: "generates an encoded REQ message to be sent to a relay",
-	Description: `example usage (with 'nostcat'):
-		nak req -k 1 -a 3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d | nostcat wss://nos.lol`,
+	Usage: "generates encoded REQ messages and optionally use them to talk to relays",
+	Description: `outputs a NIP-01 Nostr filter. when a relay is not given, will print the filter, otherwise will connect to the given relay and send the filter.
+
+example usage (with 'nostcat'):
+		nak req -k 1 -a 3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d | nostcat wss://nos.lol
+
+standalone:
+		nak req -k 1 wss://nos.lol`,
 	Flags: []cli.Flag{
 		&cli.StringSliceFlag{
 			Name:     "author",
@@ -71,9 +76,15 @@ var req = &cli.Command{
 		},
 		&cli.BoolFlag{
 			Name:  "bare",
-			Usage: "print just the filter, not enveloped in a [\"REQ\", ...] array",
+			Usage: "when printing the filter, print just the filter, not enveloped in a [\"REQ\", ...] array",
+		},
+		&cli.BoolFlag{
+			Name:        "stream",
+			Usage:       "keep the subscription open, printing all events as they are returned",
+			DefaultText: "false, will close on EOSE",
 		},
 	},
+	ArgsUsage: "[relay...]",
 	Action: func(c *cli.Context) error {
 		filter := nostr.Filter{}
 
@@ -124,15 +135,29 @@ var req = &cli.Command{
 			filter.Limit = limit
 		}
 
-		var result string
-		if c.Bool("bare") {
-			result = filter.String()
+		relays := c.Args().Slice()
+		if len(relays) > 0 {
+			pool := nostr.NewSimplePool(c.Context)
+			fn := pool.SubManyEose
+			if c.Bool("stream") {
+				fn = pool.SubMany
+			}
+			for evt := range fn(c.Context, relays, nostr.Filters{filter}) {
+				fmt.Println(evt)
+			}
 		} else {
-			j, _ := json.Marshal([]any{"REQ", "nak", filter})
-			result = string(j)
+			// no relays given, will just print the filter
+			var result string
+			if c.Bool("bare") {
+				result = filter.String()
+			} else {
+				j, _ := json.Marshal([]any{"REQ", "nak", filter})
+				result = string(j)
+			}
+
+			fmt.Println(result)
 		}
 
-		fmt.Println(result)
 		return nil
 	},
 }

src/main/scala/Main.scala

@@ -28,7 +28,7 @@ object Main extends IOWebApp {
               src := "/favicon.ico"
             ),
             a(
-              href := "https://github.com/fiatjaf/nostr-army-knife",
+              href := "/",
               "nostr army knife"
             )
           ),
@@ -38,6 +38,18 @@ object Main extends IOWebApp {
             actions(store)
           ),
           result(store)
+        ),
+        div(
+          cls := "flex justify-end mr-5 mt-10 text-xs w-4/5",
+          a(
+            href := "https://github.com/fiatjaf/nak",
+            "source code"
+          ),
+          a(
+            cls := "ml-4",
+            href := "https://github.com/fiatjaf/nak",
+            "get the command-line tool"
+          )
         )
       )
   }