common: cleanup; improve content extraction and event relays

client-web/src/components/event.tsx

@@ -23,7 +23,7 @@ import {
 } from "@chakra-ui/react";
 import {
   NEvent,
-  NEventWithUserBase,
+  ProcessedEvent,
   NewQuoteRepost,
   NewReaction,
   NewShortTextNoteResponse,
@@ -36,7 +36,7 @@ import { unixTimeToRelative } from "../lib/relative-time";
 import { excerpt } from "../lib/excerpt";
 import { UserIcon } from "./user-icon";
 
-export interface EventProps extends NEventWithUserBase {
+export interface EventProps extends ProcessedEvent {
   userComponent?: JSX.Element;
 }
 
@@ -430,6 +430,7 @@ export function Event({
                       showAbout: true,
                       showBanner: true,
                       relayUrls: eventRelayUrls,
+                      avatarSize: "xs",
                     }}
                   />
                 </Box>

client-web/src/components/events.tsx

@@ -81,7 +81,12 @@ export function Events(props: {
         <Text>Waiting for fresh content ... hold on.</Text>
       )}
       {events.length >= maxEvents && (
-        <Box display="flex" justifyContent="space-between" padding={2}>
+        <Box
+          display="flex"
+          justifyContent="space-between"
+          padding={2}
+          marginBottom={8}
+        >
           <Button flex="1" marginRight={2} onClick={moreEvents}>
             Load {MAX_EVENTS} more
           </Button>

client-web/src/components/user-info.tsx

@@ -39,7 +39,7 @@ export function UserInfo({
             <Avatar size="sm" src={picture} />
           </Link>
         </Box>
-        <Box>
+        <Box overflowWrap="anywhere">
           <Link to={profileLink}>
             <Heading size="sm">{displayName}</Heading>
             <Text fontSize="sm">{name}</Text>

client-web/src/state/base-types.ts

@@ -1,6 +1,6 @@
 import {
   Relay,
-  NEventWithUserBase,
+  ProcessedEvent,
   NUserBase,
   RelayAuth,
   RelayCount,
@@ -47,17 +47,17 @@ export interface NClientBase {
   subscribe: (
     payload: SubscriptionRequest
   ) => Promise<Subscription[] | undefined>;
-  eventsMap?: Map<string, NEventWithUserBase>;
+  eventsMap?: Map<string, ProcessedEvent>;
   /**
    * Add event to array or map
    * - In worker, must post message to main thread
    */
-  addEvent: (payload: NEventWithUserBase) => void;
+  addEvent: (payload: ProcessedEvent) => void;
   /**
    * Update event on array or map
    * - In worker, must post message to main thread
    */
-  updateEvent: (payload: NEventWithUserBase) => void;
+  updateEvent: (payload: ProcessedEvent) => void;
 
   eventsPublishingQueue: PublishingQueueItem[];
 

client-web/src/state/client-types.ts

@@ -1,6 +1,6 @@
 import {
   NEvent,
-  NEventWithUserBase,
+  ProcessedEvent,
   WebSocketClientInfo,
   WebSocketEvent,
   NFilters,
@@ -64,7 +64,7 @@ export interface NClient extends NClientBase {
   generateQueueItems: (
     request: PublishingRequest
   ) => Promise<PublishingQueueItem[]>;
-  events: NEventWithUserBase[];
+  events: ProcessedEvent[];
   /**
    * Track kind name like NewShortTextNote
    */

client-web/src/state/client.ts

@@ -1,6 +1,6 @@
 import { nanoid } from "nanoid";
 import {
-  NEventWithUserBase,
+  ProcessedEvent,
   WebSocketEvent,
   Relay,
   NEvent,
@@ -36,7 +36,7 @@ interface Event {
       | "relay:message"
       | "event:queue:new"
       | "event:queue:update";
-    data: NEventWithUserBase | WebSocketEvent | PublishingQueueItem;
+    data: ProcessedEvent | WebSocketEvent | PublishingQueueItem;
   };
 }
 
@@ -72,7 +72,7 @@ export const useNClient = create<NClient>((set, get) => ({
         const payload = event.data;
 
         if (payload.type === "event:new" || payload.type === "event:update") {
-          const data = payload.data as NEventWithUserBase;
+          const data = payload.data as ProcessedEvent;
           if (payload.type === "event:new") {
             get().addEvent(data);
           } else if (payload.type === "event:update") {
@@ -237,12 +237,12 @@ export const useNClient = create<NClient>((set, get) => ({
     return get().store.count(payload);
   },
   events: [],
-  addEvent: (payload: NEventWithUserBase) => {
+  addEvent: (payload: ProcessedEvent) => {
     set({
       events: [...get().events, payload],
     });
   },
-  updateEvent: (payload: NEventWithUserBase) => {
+  updateEvent: (payload: ProcessedEvent) => {
     const eventIndex = get().events.findIndex(
       (event) => event.event.id === payload.event.id
     );

client-web/src/state/worker.ts

@@ -1,7 +1,7 @@
 import {
   NEvent,
   RELAY_MESSAGE_TYPE,
-  NEventWithUserBase,
+  ProcessedEvent,
   EventBase,
   NFilters,
   NEVENT_KIND,
@@ -31,7 +31,7 @@ class WorkerClass implements NClientWorker {
   connected: boolean;
   db: IDBPDatabase<NClientDB> | null;
   client: RelayClient | null;
-  eventsMap: Map<string, NEventWithUserBase> = new Map();
+  eventsMap: Map<string, ProcessedEvent> = new Map();
   maxEvents: number;
   checkedUsers: string[] = [];
   checkedEvents: string[] = [];
@@ -145,7 +145,7 @@ class WorkerClass implements NClientWorker {
    * - Add event to map
    * - Post message to main thread
    */
-  addEvent(payload: NEventWithUserBase) {
+  addEvent(payload: ProcessedEvent) {
     this.eventsMap.set(payload.event.id, payload);
     postMessage({
       type: "event:new",
@@ -157,7 +157,7 @@ class WorkerClass implements NClientWorker {
    * - Update event on map
    * - Post message to main thread
    */
-  updateEvent(payload: NEventWithUserBase) {
+  updateEvent(payload: ProcessedEvent) {
     this.eventsMap.set(payload.event.id, payload);
     postMessage({
       type: "event:update",
@@ -357,7 +357,7 @@ class WorkerClass implements NClientWorker {
             return;
           }
 
-          const newEvent: NEventWithUserBase = {
+          const newEvent: ProcessedEvent = {
             event: new NEvent(event),
             eventRelayUrls: [payload.meta.url as string],
           };
@@ -440,13 +440,13 @@ class WorkerClass implements NClientWorker {
           if (hasRootTag) {
             const rootEvent = this.eventsMap.get(hasRootTag.eventId);
             if (rootEvent) {
-              if (rootEvent.lightningReceipts) {
-                rootEvent.lightningReceipts.push({
+              if (rootEvent.zapReceipt) {
+                rootEvent.zapReceipt.push({
                   event: ev,
                   user: user?.user,
                 });
               } else {
-                rootEvent.lightningReceipts = [
+                rootEvent.zapReceipt = [
                   {
                     event: ev,
                     user: user?.user,

packages/common/src/classes/event.ts

@@ -10,7 +10,7 @@ import {
   iNewShortTextNote,
   iNewShortTextNoteResponse,
   iNewUpdateUserMetadata,
-  Report,
+  EventReport,
   NEventContent,
   iNewLongFormContent,
   iNewZAPRequest,
@@ -49,12 +49,13 @@ import {
   makeEventAmountTag,
   eventHasAmountTags,
   makeEventCoordinatesTag,
-  countLeadingZeroes,
   eventAddNonceTag,
   eventReplaceNonceTag,
   eventHasEventTags,
   eventHasPositionalEventTag,
   eventHasPositionalEventTags,
+  proofOfWork,
+  EventRelayTag,
 } from "../utils";
 import {
   eventHasExternalIdentityClaim,
@@ -88,29 +89,49 @@ export class NEvent implements EventBase {
     this.sig = data.sig ? data.sig : "";
   }
 
+  /**
+   * Generate event ID
+   * - Public key should be set
+   */
   public generateId() {
     if (this.pubkey === "") {
-      throw new Error("Cannot generate event ID without a public key");
+      throw new Error(
+        "Cannot generate event ID without a public key. Set a public key first."
+      );
     }
     const serial = serializeEvent(this.ToObj());
     this.id = hash(serial);
   }
 
+  /**
+   * Sign event
+   * - Event ID should be set
+   */
   public sign(keyPair: { privateKey: string; publicKey: string }) {
+    if (this.id === "") {
+      throw new Error("Cannot sign event without an ID. Generate ID first.");
+    }
     this.pubkey = keyPair.publicKey;
     this.sig = sign(this.id, keyPair.privateKey);
   }
 
   /**
-   * 1. Sign the event (event.sig)
-   * 2. Generate the event ID (event.id)
+   * Sign event and generate ID
+   *
+   *
+   * 1. Generate the event ID (event.id)
+   * 2. Sign the event (event.sig)
    * @param privateKey
    */
   public signAndGenerateId(keyPair: { privateKey: string; publicKey: string }) {
-    this.sign(keyPair);
+    this.pubkey = keyPair.publicKey;
     this.generateId();
+    this.sign(keyPair);
   }
 
+  /**
+   * Event object for transmission and storage
+   */
   public ToObj(): any {
     const cleanObject = {};
     for (const [key, value] of Object.entries(this)) {
@@ -121,28 +142,25 @@ export class NEvent implements EventBase {
     return cleanObject;
   }
 
+  /**
+   * Event as URI
+   */
   public toURI() {
     return encodeURI(JSON.stringify(this.ToObj()));
   }
 
   /**
-   *
+   * Generate proof of work
    * @param difficulty bits required for proof of work
    */
-  public proofOfWork(targetDifficulty: number) {
-    let adjustmentValue = 0;
-
-    while (true) {
-      this.replaceNonceTag([targetDifficulty, adjustmentValue]);
-      this.generateId();
-      const leadingZeroes = countLeadingZeroes(this.id);
+  public proofOfWork(targetDifficulty: number, limitRounds?: number) {
+    const ev = proofOfWork(this, targetDifficulty, limitRounds);
 
-      if (leadingZeroes >= targetDifficulty) {
-        console.log("Proof of work complete");
-        break;
-      }
-
-      adjustmentValue++;
+    if (!ev) {
+      throw new Error("Failed to generate proof of work.");
+    } else {
+      this.id = ev.id;
+      this.tags = ev.tags;
     }
   }
 
@@ -268,7 +286,14 @@ export class NEvent implements EventBase {
     }
   }
 
-  public hasRelaysTag(): string[] | undefined {
+  /**
+   * Get event relay tags or undefined
+   * usually used on kind:10002
+   *
+   * Standard tag
+   * Spec: https://github.com/nostr-protocol/nips/blob/master/65.md#relay-list-metadata
+   */
+  public hasRelaysTag(): EventRelayTag[] | undefined {
     return eventHasRelaysTag(this);
   }
 
@@ -309,7 +334,9 @@ export class NEvent implements EventBase {
   }
 
   /**
+   * Create amount tag
    * Standard tag
+   * related to ZAP
    * https://github.com/nostr-protocol/nips/blob/master/README.md#standardized-tags
    *
    * @param amount millisats
@@ -318,6 +345,12 @@ export class NEvent implements EventBase {
     this.addTag(makeEventAmountTag(amount));
   }
 
+  /**
+   * Get event amount(s) or undefined
+   * Standard tag
+   * related to ZAP
+   * https://github.com/nostr-protocol/nips/blob/master/README.md#standardized-tags
+   */
   public hasAmountTags() {
     return eventHasAmountTags(this);
   }
@@ -414,7 +447,7 @@ export class NEvent implements EventBase {
   }
 
   /**
-   * Check if event has a content warning
+   * Get event content warning reason (may be "") or undefined
    */
   public hasContentWarningTag() {
     return eventHasContentWarning(this);
@@ -441,7 +474,7 @@ export class NEvent implements EventBase {
    * Standard tag
    * @param report
    */
-  public addReportTags(report: Report) {
+  public addReportTags(report: EventReport) {
     if (this.kind !== NEVENT_KIND.REPORTING) {
       throw new Error(
         `Event kind ${this.kind} should not have a report. Expected ${NEVENT_KIND.REPORTING}.`

packages/common/src/types/content.ts

@@ -1,6 +1,7 @@
 /**
  * Work with event content
  * - for ex. "Profile is impersonating nostr:<victim bech32 pubkey>"
+ * - supports npub and nprofile right now
  * https://github.com/nostr-protocol/nips/blob/master/56.md#example-events
  */
 export interface NEventContent {
@@ -10,5 +11,6 @@ export interface NEventContent {
     type?: "npub" | "nsec" | "note" | "lnurl" | "nprofile" | "nevent";
     // TODO: Not really accurate
     publicKeys?: string[];
+    relayUrls?: string[];
   }[];
 }