swentel
commented
1 year ago Very good question. Not an easy answer :)
https://github.com/swentel/nostr-php/pull/13 shows that we need to starting thinking about this now already as there's a huge possibility we are going to confuse ourselves, especially with terminology.
I do think an interface will probably help us making sense of all the event / kinds - just brainstorming here a bit:
$note = new PublicEvent(); // implements EventInterface, extends EventBase;
$note->setContent('Hello I am public '); // Base method on EventBase
$note->addTag(k, v);
$dm = new DirectMessageEvent(); // implements EventIterface, extends EventBase or PublicMessage?)
$dm->setContent('hello, I will be encrypted'); // Overrides to encrypt
$zap = new ZapEvent(); // implements eventInterface and ZapInterface
$zap->addBollt1('value'); // on the zapInterface, calls addTag internally.Re: the generateEvent() method which now is on the Sign class: that doesn't belong there, but it doesn't belong on the Event class either. My personal opinion at this moment is a Message class, taking inspiration from https://github.com/nostr-protocol/nips/blob/master/01.md#from-client-to-relay-sending-events-and-creating-subscriptions
Eventually, sending something to the network could become something like this, which kind of makes sense to me, at this moment at least :)
$event = new PublicEvent();
$event->setContent('Well hello');
// Or
$event = new DirectMessageEvent();
// Or
$event = new IHaveMyOwnRelayWhichAcceptsUnicornEvent();
// Signing, only needed for an EventMessage
// Note, maybe signEvent() just becomes sign() and doesn't return either, it's an object now.
// We can also add a 'isSigned()' method on the event base class which can be used
// in the EventMessage() class
$signer = new Sign();
$event = $signer->signEvent($event, $private_key);
// The messages classes probably don't need a base class as the contructor will be different,
// e.g. Req and Close would set the subscription id?
// or pass that one along in the constructor?
// Also this could throw an exception in case the event is not signed
$message = new EventMessage($event); // wraps into [EVENT, ...]; eventually
// Or
$message = new ReqMessage(); // wraps INTO [REQ] implements MessageInterface and ReqInterface
$message->addFilter(); // from the ReqInterface
// Or
$message = new CloseMessage(); // wraps INTO [CLOSE] eventually.
// Or
$message new WhateverSomeoneElseThinksOfClass(); // Let them wrap themselve
$relay = new Relay($relay);
// not the publish() method, but simply send().
// in this method we call $message->getContent() (or getData())
$relay->send($message);
Feedback very much welcome!
eko2one
Sebastix
What do you think, is it too early to refactor
event? It might be more difficult to refactor later. On the other hand the code complexity could increase now a bit.I am not sure what makes more sense at this time: class, interface or trait? A nice thing would be to cover the different event types that result from the spec.