go.mod stuff

doc/events_queries.adoc

@@ -8,35 +8,99 @@ It is one of the guiding principles of the Unix philosophy to keep data in plain
 
 REALY protocol format is extremely simple and should be trivial to parse in any programming language with basic string slicing operators.
 
+---
+
+== Base64 Encoding
+
+To save space and eliminate the need for ugly `=` padding characters, we invoke  link:https://datatracker.ietf.org/doc/html/rfc4648#section-3.2[RFC 4648 section 3.2] for the case of using base64 URL encoding without padding because we know the data length. In this case, it is used for IDs and pubkeys (32 bytes payload each, 43 characters base64 raw URL encoded) and signatures (64 bytes payload, 86 characters base64 raw URL encoded) - the further benefit here is the exact same string can be used in HTTP GET parameters `?key=value&...` context. The standard `=` padding would break this usage as well.
+
+For ease of human usage, also, it is recommended when the value is printed in plain text that it be on its own line so triple click catches all of it including the normally word-wise separated `-` hyphen/minus character, as follows:
+
+    CF4I5dXYPZ_lu2pYRjey1QMDmgNJEyT-MM8Vvj6EnZM
+
+For those who can't find a "raw" codec for base64, the 32 byte length has 1`=` pad suffix and the 64 byte length has 2: `==` and this can be trimmed off and added back to conform to this requirement. Due to the fact that potentially there can be hundreds if not thousands of these in event content and tag fields the benefit can be quite great, as well as the benefit of being able to use these codes also in URL parameter values.
+
+== Sockets and HTTP
+
+Only subscriptions require server push messaging pattern, thus all other queries in REALY can be done with simple HTTP POST requests.
+
+A relay should respond to a `subscribe` request by upgrading from http to a websocket.
+
+It is unnecessary messages and work to use websockets for queries that match the HTTP request/response pattern, and by only requiring sockets for APIs that actually need server initiated messaging, the complexity of the relay is greatly reduced.
+
+There can be a separate subscription type also, where there is delivering the IDs only, or forwarding the whole event.
+
+=== HTTP Authentication
+
+For the most part, all queries and submissions must be authenticated in order to enable a REALY relay to allow access.
+
+To enable this, a suffix is added to messages with the following format:
+
+`<message payload>\n` // all messages must be terminated with a newline
+
+`<request URL>\n`
+
+`<unix timestamp in decimal ascii>\n`
+
+`<public key of signer>\n`
+
+`<signature>\n`
+
+For simplicity, the signature is on a separate line, just as it is in the event format, this avoids needing to have a separate codec, and for the same reason the timestamp and public key.
+
+For reasons of security, a relay should not allow a time skew in the timestamp of more than 15 seconds.
+
+The signature is upon the Blake 2b message hash of everything up to the semicolon preceding it, and only relates to the HTTP POST payload, not including the header.
+
+Even subscription messages should be signed the same way, to avoid needing a secondary protocol. "open" relays that have no access control (which is retarded, but just to be complete) must still require this authentication message, but simply the client can use one-shot keys to sign with, as it also serves as a HMAC to validate the consistency of the request data, since it is based on the hash.
+
 == Events
 
-So, this is how realy events look:
+The format of events is as follows - the monospace segments are the exact text, including the necessary linebreak characters, the rest is descriptive.
 
-----
-<type name>\n // can be anything, hierarchic names like note/html note/md are possible
-<pubkey>\n // encoded in URL-base64
-<unix second precision timestamp in decimal ascii>\n
-key:value;extra;...\n // zero or more line separated, fields cannot contain a semicolon, end with newline instead of semicolon, key lowercase alphanumeric, first alpha, no whitespace or symbols, only key is mandatory, only reserved is `content`
-content:\n // literally this word on one line *directly* after the newline of the previous
-<content>\n // any number of further line breaks, last line is signature, everything before signature line is part of the canonical hash
-<ed25519 signature encoded in URL-base64>\n
-----
+---
 
-The canonical form is exactly this, except for the signature and following linebreak, hashed with Blake2b.
+`<type name>\n` // can be anything, hierarchic names like note/html note/md are possible, or type.subtype or whatever
 
-The binary data - Event Ids, Pubkeys and Signatures are encoded in raw base64 URL encoding (without padding), Signatures are 86 characters, Ids and Pubkeys are 43 characters long.
+`<pubkey>\n` // encoded in URL-base64 with the padding `=` elided
 
-The database stored form of this event should make use of an event ID hash to monotonic collision free serial table and an event table.
+`<unix second precision timestamp in decimal ascii>\n`
+
+`tags:\n`
+
+`key:value;extra;...\n` // zero or more line separated, fields cannot contain a semicolon, end with newline instead of semicolon, key lowercase alphanumeric, first alpha, no whitespace or symbols, only key and following `:` are mandatory
+
+`\n` // tags end with a double linebreak
+
+`content:\n` // literally this word on one line *directly* after the newline of the previous
+
+`<content>\n` // any number of further line breaks, last line is signature, everything before signature line is part of the canonical hash
+
+-> The canonical form is the above, creating the message hash that is generated with Blake 2b <-
+
+---
+
+`<ed25519 signature encoded in URL-base64>\n` // this field would have two padding chars `==`, these should be elided
+
+---
+
+The binary data - Event Ids, Pubkeys and Signatures are encoded in raw base64 URL encoding (without padding), Signatures are 86 characters long, with the two padding characters elided `==`, Ids and Pubkeys are 43 characters long, with a single padding character elided `=`.
+
+The database stored form of this event should make use of an event ID hash to monotonic serial ID number as the key to associating the filter indexes of an event store.
 
 Event ID hashes will be encoded in URL-base64 where used in tags or mentioned in content with the prefix `e:`. Public keys must be prefixed with `p:` Tag keys should be intelligible words and a specification for their structure should be defined by users of them and shared with other REALY devs.
 
-Indexing tags should be done with a truncated Blake2b hash cut at 8 bytes in the event store.
+Indexing tag keys should be done with a truncated Blake2b hash cut at 8 bytes in the event store, keys should be short and thus the chances of collisions are practically zero.
+
+== Publishing
 
 Submitting an event to be stored is the same as a result sent from an Event Id query except with the type of operation inteded: `store\n` to store an event, `replace:<Event Id>\n` to replace an existing event and `relay\n` to not store but send to subscribers with open matching filters. Replace will not be accepted if the message type and pubkey are different to the original that is specified.
 
+The use of specific different types of store requests eliminates the complexity of defining event types as replaceable, by making this intent explicit. A relay can also only allow one kind, such as a pure relay, which only accepts `relay` requests but neither `store` nor `replace`.
+
 An event is then acknowledged to be stored or rejected with a message `ok:<true/false>;<Event Id>;<reason type>:human readable part` where the reason type is one of a set of common types to indicate the reason for the false
 
-Events that are returned have the `<subscription Id>:<Event Id>\n` as the first line.
+Events that are returned have the `<subscription Id>:<Event Id>\n` as the first line, and then the event in the format described above afterwards.
 
 == Queries
 
@@ -61,7 +125,11 @@ The results must be in reverse chronological order so the client knows it can pa
 
 If instead of `filter\n` at the top there is `subscribe:<subscription Id>\n` the relay should return any events it finds the Id for and then subsequently will forward the Event Id of any new matching event that comes in until the client sends a `close:<subscription Id>\n` message.
 
-Once all stored events are returned, the relay will send `end:<subscription Id>\n` to notify the client the query is finished. If the client wants a subscription it must use `subscribe`. The client should end subscriptions with `close:<subscription Id>\n` or if the socket is closed.
+Once all stored events are returned, the relay will send `end:<subscription Id>\n` to notify the client that here after will only be events that just arrived.
+
+`subscribe_full:<subscription Id>` should be used to request the events be directly delivered instead of just the event IDs associated with the subscription filter.
+
+In the case of events that are published via the `relay` command, it is necessary that therefore there must be one or more "chanserv" style relays also connected to the relay to whom the clients know they can request such events, and a "nickserv" type specialized relay would need to exist also for creating access whitelists - by compiling singular edits to these lists and using a subscription mechanism to notify such clients of the need to update their ACL.
 
 === Text
 
@@ -73,15 +141,18 @@ Event requests are as follows:
 
 ----
 events:<subscription Id>\n
-<one>\n
+<event ID one>\n
 ...
 ----
 
+Unlike in event tags and content, the `e:` prefix is unnecessary. The previous two query types only have lists of events in return, and to fetch the event a client then must send an `events` request.
+
 Normally clients will gather a potentially longer list of events and then send Event Id queries in segments according to the requirements of the user interface.
 
 The results are returned as a series as follows, for each item returned:
 
 ----
 event:<subscription Id>:<Event Id>\n
-<event>
-----
+<event>\n
+...
+----

go.mod

@@ -6,6 +6,8 @@ require (
 	github.com/davecgh/go-spew v1.1.1
 	github.com/fatih/color v1.18.0
 	go.uber.org/atomic v1.11.0
+	golang.org/x/exp v0.0.0-20250128182459-e0ece0dbea4c
+	lukechampine.com/frand v1.5.1
 )
 
 require (

go.sum

@@ -12,8 +12,12 @@ github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOf
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 go.uber.org/atomic v1.11.0 h1:ZvwS0R+56ePWxUNi+Atn9dWONBPp/AUETXlHW0DxSjE=
 go.uber.org/atomic v1.11.0/go.mod h1:LUxbIzbOniOlMKjJjyPfpl4v+PKK2cNJn91OQbhoJI0=
+golang.org/x/exp v0.0.0-20250128182459-e0ece0dbea4c h1:KL/ZBHXgKGVmuZBZ01Lt57yE5ws8ZPSkkihmEyq7FXc=
+golang.org/x/exp v0.0.0-20250128182459-e0ece0dbea4c/go.mod h1:tujkw807nyEEAamNbDrEGzRav+ilXA7PCRAd6xsmwiU=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU=
 golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+lukechampine.com/frand v1.5.1 h1:fg0eRtdmGFIxhP5zQJzM1lFDbD6CUfu/f+7WgAZd5/w=
+lukechampine.com/frand v1.5.1/go.mod h1:4VstaWc2plN4Mjr10chUD46RAVGWhpkZ5Nja8+Azp0Q=

pkg/content/content_test.go

@@ -13,7 +13,6 @@ func TestC_Marshal_Unmarshal(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	log.I.S(c)
 	c1 := new(C)
 	c1.Content = c
 	var res []byte
@@ -22,7 +21,6 @@ func TestC_Marshal_Unmarshal(t *testing.T) {
 	}
 	// append a fake zero length signature
 	res = append(res, '\n')
-	log.I.S(res)
 	c2 := new(C)
 	var rem []byte
 	if rem, err = c2.Unmarshal(res); chk.E(err) {

pkg/event/event.go

@@ -5,13 +5,15 @@ import (
 	"protocol.realy.lol/pkg/event/types"
 	"protocol.realy.lol/pkg/pubkey"
 	"protocol.realy.lol/pkg/signature"
+	"protocol.realy.lol/pkg/tags"
+	"protocol.realy.lol/pkg/timestamp"
 )
 
 type Event struct {
 	Type      *types.T
 	Pubkey    *pubkey.P
-	Timestamp int64
-	Tags      [][]byte
+	Timestamp *timestamp.T
+	Tags      *tags.T
 	Content   *content.C
 	Signature *signature.S
 }

pkg/event/types/types_test.go

@@ -12,7 +12,6 @@ func TestT_Marshal_Unmarshal(t *testing.T) {
 	if res, err = typ.Marshal(nil); chk.E(err) {
 		t.Fatal(err)
 	}
-	log.I.S(res)
 	t2 := new(T)
 	var rem []byte
 	if rem, err = t2.Unmarshal(res); chk.E(err) {
@@ -21,7 +20,6 @@ func TestT_Marshal_Unmarshal(t *testing.T) {
 	if len(rem) > 0 {
 		log.I.S(rem)
 	}
-	log.I.S(t2)
 	if !bytes.Equal(typ, *t2) {
 		t.Fatal("types.T did not encode/decode faithfully")
 	}

pkg/id/id_test.go

@@ -7,14 +7,13 @@ import (
 	"testing"
 )
 
-func TestP_Marshal_Unmarshal(t *testing.T) {
+func TestT_Marshal_Unmarshal(t *testing.T) {
 	var err error
 	for range 10 {
 		pk := make([]byte, ed25519.PublicKeySize)
 		if _, err = rand.Read(pk); chk.E(err) {
 			t.Fatal(err)
 		}
-		log.I.S(pk)
 		var p *P
 		if p, err = New(pk); chk.E(err) {
 			t.Fatal(err)
@@ -23,7 +22,6 @@ func TestP_Marshal_Unmarshal(t *testing.T) {
 		if o, err = p.Marshal(nil); chk.E(err) {
 			t.Fatal(err)
 		}
-		log.I.F("%d %s", len(o), o)
 		p2 := &P{}
 		var rem []byte
 		if rem, err = p2.Unmarshal(o); chk.E(err) {
@@ -32,7 +30,6 @@ func TestP_Marshal_Unmarshal(t *testing.T) {
 		if len(rem) > 0 {
 			log.I.F("%d %s", len(rem), rem)
 		}
-		log.I.S(p2.b)
 		if !bytes.Equal(pk, p2.b) {
 			t.Fatal("public key did not encode/decode faithfully")
 		}

pkg/pubkey/pubkey_test.go

@@ -14,7 +14,6 @@ func TestP_Marshal_Unmarshal(t *testing.T) {
 		if _, err = rand.Read(pk); chk.E(err) {
 			t.Fatal(err)
 		}
-		log.I.S(pk)
 		var p *P
 		if p, err = New(pk); chk.E(err) {
 			t.Fatal(err)
@@ -23,7 +22,6 @@ func TestP_Marshal_Unmarshal(t *testing.T) {
 		if o, err = p.Marshal(nil); chk.E(err) {
 			t.Fatal(err)
 		}
-		log.I.F("%d %s", len(o), o)
 		p2 := &P{}
 		var rem []byte
 		if rem, err = p2.Unmarshal(o); chk.E(err) {
@@ -32,7 +30,6 @@ func TestP_Marshal_Unmarshal(t *testing.T) {
 		if len(rem) > 0 {
 			log.I.F("%d %s", len(rem), rem)
 		}
-		log.I.S(p2.PublicKey)
 		if !bytes.Equal(pk, p2.PublicKey) {
 			t.Fatal("public key did not encode/decode faithfully")
 		}

pkg/signature/signature_test.go

@@ -14,7 +14,6 @@ func TestS_Marshal_Unmarshal(t *testing.T) {
 		if _, err = rand.Read(sig); chk.E(err) {
 			t.Fatal(err)
 		}
-		log.I.S(sig)
 		var s *S
 		if s, err = New(sig); chk.E(err) {
 			t.Fatal(err)
@@ -23,7 +22,6 @@ func TestS_Marshal_Unmarshal(t *testing.T) {
 		if o, err = s.Marshal(nil); chk.E(err) {
 			t.Fatal(err)
 		}
-		log.I.F("%d %s", len(o), o)
 		p2 := &S{}
 		var rem []byte
 		if rem, err = p2.Unmarshal(o); chk.E(err) {
@@ -32,7 +30,6 @@ func TestS_Marshal_Unmarshal(t *testing.T) {
 		if len(rem) > 0 {
 			log.I.F("%d %s", len(rem), rem)
 		}
-		log.I.S(p2.Signature)
 		if !bytes.Equal(sig, p2.Signature) {
 			t.Fatal("signature did not encode/decode faithfully")
 		}

pkg/tag/tag_test.go

@@ -15,7 +15,6 @@ func TestT_Marshal_Unmarshal(t *testing.T) {
 	if tb, err = t1.Marshal(nil); chk.E(err) {
 		t.Fatal(err)
 	}
-	log.I.S(tb)
 	t2 := new(T)
 	var rem []byte
 	if rem, err = t2.Unmarshal(tb); chk.E(err) {
@@ -25,5 +24,4 @@ func TestT_Marshal_Unmarshal(t *testing.T) {
 		log.I.F("%s", rem)
 		t.Fatal("remainder after tag should have been nothing")
 	}
-	log.I.S(t2)
 }

pkg/timestamp/gen/log.go

@@ -0,0 +1,9 @@
+package main
+
+import (
+	"protocol.realy.lol/pkg/lol"
+)
+
+var (
+	log, chk, errorf = lol.Main.Log, lol.Main.Check, lol.Main.Errorf
+)

pkg/timestamp/gen/pregen.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+)
+
+func main() {
+	var err error
+	var fh *os.File
+	if fh, err = os.Create("base10k.txt"); chk.E(err) {
+		panic(err)
+	}
+	for i := range 10000 {
+		fmt.Fprintf(fh, "%04d", i)
+	}
+}

pkg/timestamp/log.go

@@ -0,0 +1,9 @@
+package timestamp
+
+import (
+	"protocol.realy.lol/pkg/lol"
+)
+
+var (
+	log, chk, errorf = lol.Main.Log, lol.Main.Check, lol.Main.Errorf
+)

pkg/timestamp/timestamp.go

@@ -0,0 +1,109 @@
+package timestamp
+
+import (
+	_ "embed"
+
+	"golang.org/x/exp/constraints"
+)
+
+// run this to regenerate (pointlessly) the base 10 array of 4 places per entry
+//go:generate go run ./gen/.
+
+//go:embed base10k.txt
+var base10k []byte
+
+const base = 10000
+
+type T struct {
+	N uint64
+}
+
+func New[V constraints.Integer](n V) *T { return &T{uint64(n)} }
+
+func (n *T) Uint64() uint64 { return n.N }
+func (n *T) Int64() int64   { return int64(n.N) }
+func (n *T) Uint16() uint16 { return uint16(n.N) }
+
+var powers = []*T{
+	{1},
+	{1_0000},
+	{1_0000_0000},
+	{1_0000_0000_0000},
+	{1_0000_0000_0000_0000},
+}
+
+const zero = '0'
+const nine = '9'
+
+func (n *T) Marshal(dst []byte) (b []byte) {
+	nn := n.N
+	b = dst
+	if n.N == 0 {
+		b = append(b, '0')
+		return
+	}
+	var i int
+	var trimmed bool
+	k := len(powers)
+	for k > 0 {
+		k--
+		q := n.N / powers[k].N
+		if !trimmed && q == 0 {
+			continue
+		}
+		offset := q * 4
+		bb := base10k[offset : offset+4]
+		if !trimmed {
+			for i = range bb {
+				if bb[i] != '0' {
+					bb = bb[i:]
+					trimmed = true
+					break
+				}
+			}
+		}
+		b = append(b, bb...)
+		n.N = n.N - q*powers[k].N
+	}
+	n.N = nn
+	return
+}
+
+// Unmarshal reads a string, which must be a positive integer int larger than math.MaxUint64,
+// skipping any non-numeric content before it.
+//
+// Note that leading zeros are not considered valid, but basically int such thing as machine
+// generated JSON integers with leading zeroes. Until this is disproven, this is the fastest way
+// to read a positive json integer, and a leading zero is decoded as a zero, and the remainder
+// returned.
+func (n *T) Unmarshal(b []byte) (r []byte, err error) {
+	if len(b) < 1 {
+		err = errorf.E("zero length number")
+		return
+	}
+	var sLen int
+	if b[0] == zero {
+		r = b[1:]
+		n.N = 0
+		return
+	}
+	// count the digits
+	for ; sLen < len(b) && b[sLen] >= zero && b[sLen] <= nine && b[sLen] != ','; sLen++ {
+	}
+	if sLen == 0 {
+		err = errorf.E("zero length number")
+		return
+	}
+	if sLen > 20 {
+		err = errorf.E("too big number for uint64")
+		return
+	}
+	// the length of the string found
+	r = b[sLen:]
+	b = b[:sLen]
+	for _, ch := range b {
+		ch -= zero
+		n.N = n.N*10 + uint64(ch)
+	}
+	return
+}

pkg/timestamp/timestamp_test.go

@@ -0,0 +1,77 @@
+package timestamp
+
+import (
+	"math"
+	"strconv"
+	"testing"
+
+	"lukechampine.com/frand"
+)
+
+func TestMarshalUnmarshal(t *testing.T) {
+	b := make([]byte, 0, 8)
+	var rem []byte
+	var n *T
+	var err error
+	for _ = range 10000000 {
+		n = New(uint64(frand.Intn(math.MaxInt64)))
+		b = n.Marshal(b)
+		m := New(0)
+		if rem, err = m.Unmarshal(b); chk.E(err) {
+			t.Fatal(err)
+		}
+		if n.N != m.N {
+			t.Fatalf("failed to convert to int64 at %d %s %d", n.N, b, m.N)
+		}
+		if len(rem) > 0 {
+			t.Fatalf("leftover bytes after converting back: '%s'", rem)
+		}
+		b = b[:0]
+	}
+}
+
+func BenchmarkByteStringToInt64(bb *testing.B) {
+	b := make([]byte, 0, 19)
+	var i int
+	const nTests = 10000000
+	testInts := make([]*T, nTests)
+	for i = range nTests {
+		testInts[i] = New(frand.Intn(math.MaxInt64))
+	}
+	bb.Run("Marshal", func(bb *testing.B) {
+		bb.ReportAllocs()
+		for i = 0; i < bb.N; i++ {
+			n := testInts[i%10000]
+			b = n.Marshal(b)
+			b = b[:0]
+		}
+	})
+	bb.Run("Itoa", func(bb *testing.B) {
+		bb.ReportAllocs()
+		var s string
+		for i = 0; i < bb.N; i++ {
+			n := testInts[i%10000]
+			s = strconv.Itoa(int(n.N))
+			_ = s
+		}
+	})
+	bb.Run("MarshalUnmarshal", func(bb *testing.B) {
+		bb.ReportAllocs()
+		m := New(0)
+		for i = 0; i < bb.N; i++ {
+			n := testInts[i%10000]
+			b = m.Marshal(b)
+			_, _ = n.Unmarshal(b)
+			b = b[:0]
+		}
+	})
+	bb.Run("ItoaAtoi", func(bb *testing.B) {
+		bb.ReportAllocs()
+		var s string
+		for i = 0; i < bb.N; i++ {
+			n := testInts[i%10000]
+			s = strconv.Itoa(int(n.N))
+			_, _ = strconv.Atoi(s)
+		}
+	})
+}

readme.adoc

@@ -1,9 +1,7 @@
 = REALY Protocol
 
 ____
-
-relay events and like… yeah
-
+relay, events and like… yeah
 ____
 
 image:https://img.shields.io/badge/godoc-documentation-blue.svg[Documentation,link=https://pkg.go.dev/protocol.realy.lol]
@@ -14,9 +12,9 @@ zap mleku: ⚡️mleku@getalby.com
 Inspired by the event bus architecture of https://github.com/nostr-protocol[nostr] but redesigned to avoid the
 serious deficiencies of that protocol for both developers and users.
 
-* link:./doc/why.md[why]
-* link:./doc/events_queries.md[events and queries]
-* link:./doc/relays.md[relays]
+* link:./doc/why.adoc[why]
+* link:./doc/events_queries.adoc[events and queries]
+* link:./doc/relays.adoc[relays]
 * link:./relays/readme.md[reference relays]
 * link:./clients/readme.md[reference clients]
-* link:./pkg/readme.md[GO libraries]
+* link:./pkg/readme.md[_GO⌯_ libraries]